Table of ContentsView in Frames

Unified Manager CLI commands

As a storage administrator you can use the CLI commands to perform queries on the storage inventories like cluster, aggregate, volumes, QTrees, and LUNs. You can use the CLI commands to query the Unified Manager internal database and Data ONTAP database.

CLI commands supported in Unified Manager 6.3

CLI command Description Output
um run cmd [ -t <timeout> ] <cluster> <command> This is the simplest way to run a command on one or more hosts. Mainly used for alert script to get or do an operation on the Data ONTAP. The optional timeout argument sets a maximum time limit (in seconds) for the command to complete on the client. The default is 0 (wait forever). As received from Data ONTAP.
um run query <sql command> Command to execute SQL queries. Only the queries which reads from the database is allowed. Any updation, insertion or deletion operation is not supported. Tabular form- if a non-empty set is returned. Prints String "Empty Set" - if an empty set is returned or prints the appropriate error message, if there is any syntax error or bad request.
um datasource add -U <username> -P <password> [ -t <protocol> ] [ -p <port> ] <hostname-or-ip> The "datasource add" command adds a datasource to the list of managed storage systems. A datasource describes how connections to storage systems are made. The options -U (username) and -P (password) must be specified when adding a datasource. The option -t (protocol) specifies the protocol used to communicate with the cluster (http or https). If the protocol is not specified, then both protocols will be attempted The option -p (port) specifies the port used to communicate with the cluster. If the port is not specified, then the default value of the appropriate protocol will be attempted. This command can be executed only by the storage admin. Will have user accept the certificate & prints the corresponding message.
um datasource list [ <datasource-id>] The "datasource list" command displays the datasources for managed storage systems. Displays the following values in tabular format:ID Address Port, Protocol Acquisition Status, Analysis Status, Communication status, Acquisition Message, and Analysis Message.
um datasource modify [ -h <hostname-or-ip> ] [ -U <username> ] [ -P <password> ] [ -t <protocol> ] [ -p <port> ] <datasource-id> Command to set one or more options. Can be executed only by the storage admin. Displays the corresponding message.
um datasource remove <datasource-id> Command to remove the datasource from UM Displays the corresponding message.
um option list [ <option> .. ] Command to list options. Displays the following values in tabular format:Name, Value, Default Value, and Requires Restart.
um option set <option-name>=<option-value> [ <option-name>=<option-value> ... ] Command to set one or more options. The command can be executed only by the storage admin. Displays the corresponding message.
um version Displays the software version Version ("6.3")
um lun list [-q] [ -ObjectType <object-id>] -q is applicable for all commands to show no header. Lists the qtrees after filtering on the specified object. ObjectType can be lun, qtree, cluster, volume, quota, svm. For example : um qtree list -cluster 1 In this example, "-cluster" is the objectType and "1" is the objectId. The command lists all the qtrees within the cluster with ID 1. Displays the following values in tabular format: ID and LUN path.
um svm list [-q] [ -ObjectType <object-id>] Lists the storage virtual machines after filtering on the specified object. ObjectType can be lun, qtree, cluster, volume, quota, svm. For example : um svm list -cluster 1 In this example, "-cluster" is the objectType and "1" is the objectId. The command lists all the storage virtual machines within the cluster with ID 1. Displays the following values in tabular format: Name and Cluster ID.
um qtree list [-q] [ -ObjectType'<object-id>] Lists the disks after filtering on the specified object. ObjectType can be disk, aggr, node, cluster. For example : um disk list -cluster 1 In this example, "-cluster" is the objectType and "1" is the objectId. The command lists all the disks within the cluster with ID 1 Displays the following values in tabular format: Qtree ID and Qtree Name.
um disk list [-q] [-ObjectType <object-id>] Lists the disks after filtering on the specified object. ObjectType can be disk, aggr, node, cluster. For example : um disk list -cluster 1 In this example, "-cluster" is the objectType and "1" is the objectId. The command lists all the disks within the cluster with ID 1. Displays the following values in tabular format ObjectType and object-id.
um cluster list [-q] [-ObjectType <object-id>] Lists the clusters after filtering on the specified object. ObjectType can be disk, aggr, node, cluster, lun, qtree, volume, quota, svm. For example : um cluster list -aggr 1 In this example, "-aggr" is the objectType and "1" is the objectId. The command lists the cluster to which the aggregate with ID 1 belongs. Displays the following values in tabular format:Name, Full Name, Serial Number, Datasource Id, Last Refresh Time, and Resource Key.
um cluster node list [-q] [-ObjectType <object-id>] Lists the cluster nodes after filtering on the specified object. ObjectType can be disk, aggr, node, cluster. For example : um cluster node list -cluster 1 In this example, "-cluster" is the objectType and "1" is the objectId. The command lists all the nodes within the cluster with ID 1. Displays the following values in tabular format Name and Cluster ID.
um volume list [-q] [-ObjectType <object-id>] Lists the volumes after filtering on the specified object. ObjectType can be lun, qtree, cluster, volume, quota, svm, aggregate. For example : um volume list -cluster 1 In this example, "-cluster" is the objectType and "1" is the objectId. The command lists all the volumes within the cluster with ID 1. Displays the following values in tabular formatVolume ID and Volume Name.
um quota user list [-q] [-ObjectType <object-id>] Lists the quota users after filtering on the specified object. ObjectType can be qtree, cluster, volume, quota, svm. For example : um quota user list -cluster 1 In this example, "-cluster" is the objectType and "1" is the objectId. The command lists all the quota users within the cluster with ID 1. Displays the following values in tabular formatID, Name, SID and Email.
um aggr list [-q] [-ObjectType <object-id>] Lists the aggregates after filtering on the specified object. ObjectType can be disk, aggr, node, cluster, volume. For example : um aggr list -cluster 1 In this example, "-cluster" is the objectType and "1" is the objectId. The command lists all the aggregates within the cluster with ID 1. Displays the following values in tabular formatAggr ID, and Aggr Name.
um event ack <event-ids> Command to acknowledge one or more events Displays the corresponding message.
um event resolve <event-ids> Command to resolve one or more events Displays the corresponding message.
um event assign -U <user id> <event-id> Command to assign a event to a user Displays the corresponding message.
um event list [ -s <source> ] [ -S <event-state-filter-list>.. ] [ <event-id> .. ] Command to list the events generated by the system or user. Filters events based on source , state , and IDs. Displays the following values in tabular format Source, Source type, Name, Severity, State, User and Timestamp.
um cli login -u <username> [-p <password> Command to login to the CLI. The session expires after 3 hours from the time of login after which the user has to login again. Displays the corresponding message.
um cli logout Command to logout of the CLI. Displays the corresponding message.
um backup restore -f <path of .7z file> The backup restore command enables user to perform restore operation using a .7z file. Displays the corresponding message.
um help Displays all first level sub commands Displays all first level sub commands