HP XP Command View Advanced Edition Software - Manual (Page 36)

Command line interface syntax and parameters
36
3 Command line interface syntax and
parameters
This chapter discusses the following:
•
Command line syntax
•
CLI return responses
•
Displaying CLI help
•
Guidelines for executing CLI commands
3-1 Command line syntax
To execute the Device Manager CLI, move to the folder or directory in which the Device Manager
CLI is installed, then execute hdvmcli.bat or hdvmcli.sh. The general format for the command
line values is:
•
For Windows:
c:\hdvmcli>hdvmcli.bat [URL] [command] [options] [parameters]
•
For Solaris, Linux, or HP-UX:
# ./hdvmcli.sh [URL] [command] [options] [parameters]
NOTE: The Device Manager CLI supports only ASCII characters. If a request to the Device
Manager server contains a character other than an ASCII character, an unexpected error might
occur because the request cannot be processed correctly.
TIP: You can set the URL, options, and parameters arguments in the properties file. For details
about the properties file, see chapter 5 .
The URL indicates the location of the Device server in the network. The URL is specified in a form
such as http://localhost:2001/service. The URL must include the following items:
•
Http protocol: http:// or https:// (see section 2-3 )
•
Host name or IP address of the Device Manager server (enclose IPv6 IP addresses in square
brackets ([ ]))
•
Port number of the Device Manager server (default configuration is 2001)
•
Base address of the Device Manager server (default is service, unless the server has been
configured with a nonstandard servlet alias)
NOTE: When the URL is specified in the properties file, you can omit the URL argument on the
command line. For details about how to specify the URL, see section 5-4-4 .
Commands make processing requests to the server, such as GetStorageArray or
AddLogicalGroup
. The command names specified as arguments to the are not case-sensitive.
These are not required when reading the request from an XML file. For details about commands,
see chapter
4 .
Options control the behavior of the Device Manager CLI application. This is case sensitive. Each
option has a single character and an alternate word representation. A single character has a single
dash as a prefix. A word has two dashes as a prefix. Some options require an argument, which
follows the option. For example, the -u option is followed by a user ID. For details about the options
that can be used with the Device Manager CLI, see
Table 3-1 .