Owner's Manual
4
Command Line Interface
All of the commands supported by the command line interface (CLI) have the following format:
ompc_cli [COMMAND] [GENERIC_OPTIONS] [COMMAND_OPTIONS] [COMMAND_TARGET]
The operation must start with a valid [COMMAND]. Options can be entered anywhere after [COMMAND]. For each
option that has a value, the value must be supplied immediately after the option.
NOTE: If a duplicate or incorrect option value is supplied with a command, the CLI will exit with an error. For
example, when both the –profile and –protocol options are supplied at the same time in a command, the CLI will
exit with an error.
GENERIC_OPTIONS is used to run a generic job for this command line.
In Windows
, user authentication credentials are specified as follows:
• user_auth <POWER_CENTER|WINDOWS_LOCAL|WINDOWS_DOMAIN>
• user_name <user_name>: If user_type is WINDOWS_DOMAIN, then the user_name must be in domain
\user format.
• user_password <password>
In Linux
, user authentication credentials are specified as follows:
• user_auth <power_center|linux_local|ldap>
• user_name <user_name>
• user_password <password>
The COMMAND_TARGET specifies the targets on which the command will operate. For example, the
COMMAND_TARGET for add_profile is a profile name to be added. For a specific command, the COMMAND_TARGET
cannot have the same value with the name of a generic option or an option supported by this command. For example,
the COMMAND_TARGET cannot be –protocol or –user_name for the command add_profile.
For COMMAND_TARGET, the order of its content must be kept as defined in the specific command definition section.
Any valid option can be mixed with the content of COMMAND_TARGET. For example, the order of COMMAND_TARGET
of the move_device command must be supplied FROM_GROUP_PATH first, then TO_GROUP_PATH.
Command Line Interface Error Handling
In Windows
, when the command is successful, the CLI exit code is 0. If the command is not successful, an error code
displays. For more information, refer to Command Line Interface Error Codes.
In Linux
, when a command is successful, the CLI exit code is 0. If a command is not successful, a generic error code, 1,
displays. Use stderr to get a more specific error code, and to find more information on that code, see Command Line
Interface Error Codes.
23