Supported Unified Manager CLI commands

As a storage administrator you can use the CLI commands to perform queries on the storage objects; for example, on clusters, aggregates, volumes, qtrees, and LUNs. You can use the CLI commands to query the Unified Manager internal database and the ONTAP database. You can also use CLI commands in scripts that are executed at the beginning or end of an operation or are executed when an alert is triggered.

All commands must be preceded with the command um cli login and a valid user name and password for authentication.

CLI command Description Output
um run cmd [ -t <timeout> ] <cluster> <command> The simplest way to run a command on one or more hosts. Mainly used for alert scripting to get or perform an operation on 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 ONTAP.
um run query <sql command> Executes an SQL query. Only queries that read from the database are allowed. Any update, insert, or delete operations are not supported. Results are displayed in a tabular form. If an empty set is returned, or if there is any syntax error or bad request, it displays the appropriate error message.
um datasource add -u <username> -P <password> [ -t <protocol> ] [ -p <port> ] <hostname-or-ip> 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. Prompts for the user accept the certificate and prints the corresponding message.
um datasource list [ <datasource-id>] 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> Modifies one or more datasource options. Can be executed only by the storage admin. Displays the corresponding message.
um datasource remove <datasource-id> Removes the datasource from Unified Manager. Displays the corresponding message.
um option list [ <option> .. ] Lists 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> ... ] Sets one or more options. The command can be executed only by the storage admin. Displays the corresponding message.
um version Displays the Unified Manager software version . Version ("7.0")
um lun list [-q] [ -ObjectType <object-id>] Lists the LUNs after filtering on the specified object. -q is applicable for all commands to show no header. ObjectType can be lun, qtree, cluster, volume, quota, svm.

For example: um lun list -cluster 1

In this example, "-cluster" is the objectType and "1" is the objectId. The command lists all the LUNs 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 SVMs 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 SVMs 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 qtrees after filtering on the specified object. -q is applicable for all commands to show no header. 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: 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 format Volume 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 format ID, 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 format Aggr ID, and Aggr Name.
um event ack <event-ids> Acknowledges one or more events. Displays the corresponding message.
um event resolve <event-ids> Resolves one or more events. Displays the corresponding message.
um event assign -u <username> <event-id> Assigns an event to a user. Displays the corresponding message.
um event list [ -s <source> ] [ -S <event-state-filter-list>.. ] [ <event-id> .. ] Lists 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> Logs in to the CLI. The session expires after three hours from the time of login, after which the user must login again. Displays the corresponding message.
um cli logout Logs out of the CLI. Displays the corresponding message.
um backup restore -f <backup_file_path_and_name> Restores a database backup using .7z files. Displays the corresponding message.
um help Displays all first level subcommands. Displays all first level subcommands.