HP StorageWorks XP10000 Disk Array - Manual (Page 14)

Command Line Interface Syntax and Parameters 14
3 Command Line Interface Syntax and Parameters
This chapter describes the command syntax and command parameters.
• Command Line Values Syntax (section 3-1 )
• CLI Return Responses (section 3-2 )
• Displaying CLI Help (section 3-3 )
• Guidelines for Executing CLI Commands (section 3-4 )
3-1 Command Line Syntax
Device Manager CLI only supports ASCII characters. The general format for the command line values is:
C:\hdvmcli [server-location] [command] [options] [parameters]
• Server-location indicates the complete URL of the Device Manager server, e.g.,
http://localhost:2001/service . This includes the service address, unless the server has been configured
with a non-standard servlet alias. If you use a property file, you can omit the URL. For details about how
to specify the URL, see section
5-3-3 .
• Commands make processing requests to the server, e.g., GetStorageArray or AddLogicalGroup.
These are not required when reading the request from an XML file.
• Options control the behavior of Device Manager CLI application. Each option has a single character and
an alternate word representation. A single character will have a single dash as a prefix. A word will have
two dashes as a prefix. Most options require a following argument. See
Table 3-1 for a list and
description of Device Manager CLI options. Specifying an option in the properties file enables you to omit
the option when you execute the command. For details about how to specify options, see section
5-1 .
• Parameters are passed to the server as part of a request. Depending on the command, some are
required and some are optional. Each parameter is represented as a name/value pair, e.g., name=value.
Table 3-1 hdvmcli Options
Option Argument Description
-i or --input filename Takes input from the specified file, which must contain the
server request as a complete XML document, and outputs it
as an XML-formatted document.
-o or --output filename Send output to the specified file, instead of the console.
-p
or –password (see Note ) password or @password Either a valid password for the server or a file containing the
login password (when preceded by a '@'). See Note . This
option is essential if you do not specify it in the properties file.
-s
or --secure no argument Uses a secure connection (https) to communicate with the
server.
-u
or --user
userid
A valid user ID for the server. This option is essential if you do
not specify it in the properties file.
-t
or --messagetrace no argument Outputs the request and the response in the
MessageTrace.log
file.
NOTE: A password can be contained in a text file. This file generally has restricted access, but that must
include the user. The file path is specified either relative to the location where the application is run or as an
absolute path, and is preceded by an "@" character. The text of the first line is the password.
The parameters that form the input to a command are specified on the command line as name/value pairs. The
parameter name is specified first, then the equal sign and the parameter value, as follows:
ipaddress=192.168.2.2
Whenever a parameter value requires one or more space characters, double quotes can be used to enclose
the parameter value, as follows:
NOTE: When you are performing this command, do not shut down the hosts that are using storage
subsystem volumes, or the host for the Device Manager agent, or execution might take longer.