-clientType

This argument forces the creation of an appropriate script engine. Use this optional parameter with one of the following values:

-u

Follow this parameter with the username variable. The username is only required for the https client type. This argument is not applicable to the symbol client type and will be silently ignored.

If the username argument is specified, device discovery is performed to determine the correct client type (https vs. symbol).

-P

This argument requires one of two arguments:

Note that the addition of this argument is applicable to all controllers, regardless of whether the https client type or symbol client type is used.

-k

This optional argument allows an https client to operate in insecure mode. This means that the storage system’s certificate will not be validated. By default, if omitted, the proper authentication will be performed. This argument is not applicable to the symbol client type and will be silently ignored.

host-name-or-IP-address

Specifies either the host name or the Internet Protocol (IP) address (xxx.xxx.xxx.xxx) of an in-band managed storage system or an out-of-band managed storage system.

-A

Adds a storage system to the configuration file. If you do not follow the -A parameter with a host-name-or-IP-address, auto-discovery scans the local subnet for storage systems.

-c

Indicates that you are entering one or more script commands to run on the specified storage system. End each command with a semicolon (;). You cannot place more than one -c parameter on the same command line. You can include more than one script command after the -c parameter.

-d

Shows the contents of the script configuration file. The file content has this format: storage-system-name host-name1 host-name2

-e

Runs the commands without performing a syntax check first.

-F (uppercase)

Specifies the email address from which all alerts will be sent.

-f (lowercase)

Specifies a file name that contains script commands that you want to run on the specified storage system. The -f parameter is similar to the -c parameter in that both parameters are intended for running script commands. The -c parameter runs individual script commands. The -f parameter runs a file of script commands. By default, any errors that are encountered when running the script commands in a file are ignored, and the file continues to run. To override this behavior, use the set session errorAction=stop command in the script file.

-g

Specifies an ASCII file that contains email sender contact information that will be included in all email alert notifications. The CLI assumes that the ASCII file is text only, without delimiters or any expected format. Do not use the -g parameter if a userdata.txt file exists.

-h

Specifies the host name that is running the SNMP agent to which the storage system is connected. Use the -h parameter with these parameters:

-I (uppercase)

Specifies the type of information to be included in the email alert notifications. You can select these values:

You can specify the frequency for the email deliveries using the -q parameter.

-i (lowercase)

Shows the IP address of the known storage systems. Use the -i parameter with the -d parameter. The file content has this format: storage-system-name IP-address1 IPaddress2

-n

Specifies the name of the storage system on which you want to run the script commands. This name is optional when you use a host-name-or-IP-address. If you are using the in-band method for managing the storage system, you must use the -n parameter if more than one storage system is connected to the host at the specified address. The storage system name is required when the host-name-or-IP-address is not used.

-o

Specifies a file name for all output text that is a result of running the script commands. Use the -o parameter with these parameters:

If you do not specify an output file, the output text goes to standard output (stdout). All output from commands that are not script commands is sent to stdout, regardless of whether this parameter is set.

-p

Defines the password for the storage system on which you want to run commands. When using special characters in passwords, enclose the password in double quotation marks ("` `"). A password is not necessary under these conditions:

-P

This argument requires one of two arguments:

Note that the addition of this argument is applicable to all controllers, regardless of whether the https client type or symbol client type is used.

-q

Specifies the frequency that you want to receive event notifications and the type of information returned in the event notifications. An email alert notification containing at least the basic event information is always generated for every critical event. These values are valid for the -q parameter:

Using the -I parameter you can specify the type of information in the email alert notifications.

-quick

Reduces the amount of time that is required to run a single-line operation. An example of a single-line operation is the recreate snapshot volume command. This parameter reduces time by not running background processes for the duration of the command. Do not use this parameter for operations that involve more than one single-line operation. Extensive use of this command can overrun the controller with more commands than the controller can process, which causes operational failure. Also, status updates and configuration updates that are collected usually from background processes will not be available to the CLI. This parameter causes operations that depend on background information to fail.

-S (uppercase)

Suppresses informational messages describing the command progress that appear when you run script commands. (Suppressing informational messages is also called silent mode.) This parameter suppresses these messages:

-useLegacyTransferPort

Used to set the transfer port to 8443 instead of the default 443.

-v

Shows the current global status of the known devices in a configuration file when used with the -d parameter.

-w

Specifies the WWID of the storage system. This parameter is an alternate to the -n parameter. Use the -w parameter with the -d parameter to show the WWIDs of the known storage systems. The file content has this format: storage-system-name world-wide-ID IP-address1 IP-address2

-X (uppercase)

Deletes a storage system from a configuration.

-?

Shows usage information about the CLI commands.