Command entry

Edit online

You are guided through how to enter commands in a valid format.

Order of parameters

Parameters can be entered in any order, with the following exceptions:
  • The first argument that follows the command name must be the action that is to be performed.
  • If you are performing an action on a specific object, the object ID or name must be the last argument in the line.

Multiple values

For any commands that accept multiple input values of the same type, delimit the values with a comma with no spaces in the input string. For example, -vol 3,5,8,9).

For any commands that require multiple value types in one string, delimit the value types with a period. For example, if a volume requires a device number and a volume number, you might specify -vol FCA86.3,FCA78.5,FCA96.8. When input values are of different types but specified in the same flag, use a colon. For example, to specify a minimum and maximum value in the same flag, you would type –size min:max.

Multiple arguments

Copy Services Manager supports multiple arguments for the chsess, lsdevice, lssess, lssessactions, lsvol, and rmsess commands. If you use a command with multiple arguments, the command is applied for each of the arguments. For example, you might issue the following command to remove session_a, session_b, and session_c.

#rmsess session_a session_b session_c

When a command runs on more than one argument, the CLI program establishes a single security session to run the command on each of the multiple arguments.

Volumes and locations

The following volume values are valid:
ESS devices
Valid volume values include the device type, component type, device ID, subsystem ID, logical subsystem ID, and volume ID, with each separated by a period or colon. For example:
ESS single volume
ESS:2105.65312:VOL:202F (ESS:ELEMENTTYPE.DEVICEID:VOL:LSSVOLNUM)

User-defined objects

The requirements for valid user-defined object names are listed:
  • User-defined object names can be 250 characters or fewer, unless otherwise noted.
  • Valid characters are A-Z, a-z, 0 - 9, dash (-), underscore (_), period (.), and colon (:).
  • Object names must start with an alphanumeric character.
  • Most object names cannot contain any blank spaces. However, you can include blanks in session names and location names.
  • Do not translate user-defined objects or otherwise modify them from the user's entry. These objects are to remain case-sensitive.

User-defined descriptions

The requirements for valid user-defined descriptions are listed:
  • If a description contains spaces, it must be enclosed in matching double quotation marks or single quotation marks.
  • If a description that is already enclosed in matching quotation marks includes an asterisk, the asterisk must be preceded by an escape character, for example, -desc "This is the \* pool".
  • If a description that is already enclosed in matching quotation marks includes double quotation marks or single quotation marks within the actual text string, these characters must be escaped. For example, -desc "This is Hanna\'s description" or –desc "This is the pool I call \"Foo\".'
  • User-defined descriptions can be 250 characters or fewer. They cannot contain any leading blank spaces.
  • User-defined descriptions should not be translated or otherwise modified from the user's entry. The user-defined descriptions should remain case-sensitive.
  • The CLI is sensitive to case when it interprets user-defined object names that are given as input. For example, object FOO is different from object foo.