
Using the Tiered Storage Manager CLI 27
Table 3-2 Description of CLI Command Elements
Command Element Description
options Options contain information for controlling the CLI operation.
Use the general UNIX format when entering options. There are two kinds of such expressions:
one-character expressions and one-word expressions. Insert one hyphen before one-character
expressions, and two hyphens before one-word expressions. For example, a one-character
expression should be specified like –u, and a one-word expression should be specified like –-
username.
Some options require an argument to be specified after the option.
• Specify arguments as command line parameter strings. Arguments that contain space
characters should be enclosed in quotation marks (such as in --output "C:\My
Documents\redirect.txt"), or whatever is appropriate for the command execution
environment.
• Options are case-sensitive.
• Options can be specified in any order.
IMPORTANT: Not all options are valid for all commands. Refer to the detailed command descriptions in 4 to determine
which options are valid for each command.
parameters Parameters contain information passed to the server as part of a request. The parameters
required depend on the command requested. Each parameter consists of a name and a value,
such as in name=value.
• Specify parameters as command line parameter strings. Parameters that contain space
characters should be enclosed in quotation marks (such as in "filtercondition =
capacity < '1024GB'"), or whatever is appropriate for the command execution
environment.
• Names are not case-sensitive.
• Values are case-sensitive. As such, xp and XP are considered two different values.
• Parameters can be specified in any order.
• Parameters can be omitted from the command line if they are set in the properties file.
IMPORTANT: Refer to Table 3-3 to determine the range of valid parameter values for each parameter.
3-3 CLI Command Syntax
Using the command line interface, you can initiate requests to the Tiered Storage Manager server and review
responses from the server. CLI commands are executed from the command line. The syntax of Tiered Storage
Manager CLI commands is:
htsmcli [server-location] command [options]... [parameters]...
NOTE: When commands are entered from the command line, shell escaping must be performed in
accordance with the platform used.
3-3-1 CLI Command Parameters
Command parameters are specified as a combination of a name and a value. Specify a parameter as follows,
with the name of the parameter first, followed by an equal sign, and then the value of the parameter:
controllerserialnumber=14011
Parameters can be specified in any order. Specify parameters as a single command line parameter character
string. Parameters that contain space characters should suit the command execution environment. For
example, enclose such parameters in quotation marks as follows:
"filtercondition = capacity < '1024GB'"
NOTE: The parameter name is not case sensitive. The parameter value is case sensitive. For example, xp
and XP are considered two different values.
Parameters can be set in the command line when the command is issued or the parameters can be set in the
CLI properties file. Parameters that are set in the command line take precedence over parameters that were
set in the properties file. For details about the Tiered Storage Manager CLIproperties file, see
5 .
Using the Tiered Storage
Manager CLI
Comentários a estes Manuais