Hitachi

uCosminexus Service Platform Reference Guide


5.2 Command input format

The input format of the commands is as follows:

Command-name [argument ...]

The following is a description of each of these items. Note that $ indicates a command prompt and cmd indicates a command name.

Command-name

Specifies the file name of the command to be executed.

To execute a command by specifying a path containing spaces, the entire path must be enclosed within double quotation marks (" ").

  • Example of incorrect specification: $ C:\Program Files\Hitachi\Cosminexus\CC\server\bin\cmd

  • Example of correct specification: $ "C:\Program Files\Hitachi\Cosminexus\CC\server\bin\cmd"

Arguments

An argument also includes options. The input format and the rules for specifying the options are as follows:

Input format for options

An option is a string beginning with a hyphen (-). The option input formats include a format where no option argument is specified and a format where one option argument is specified.

  • Format without an option argument

    $ cmd -option-flag

  • Format with one option argument

    $ cmd -option-flag option-argument

Legend:
  • option-flag

    This represents a case-sensitive, single-byte alphanumeric character.

  • option-argument

    This represents an argument corresponding to the option flag.

Rules for specifying options
  • Multiple option flags cannot be combined with a single hyphen (-).

    Example of incorrect specification: $ cmd -abc

    Example of correct specification: $ cmd -a -b -c

  • The option argument of an option flag that requires an option argument cannot be omitted.

  • A space or a tab must be specified between an option flag and an option argument.

    Example of incorrect specification: $ cmd -afile

    Example of correct specification: $ cmd -a file

  • The same option flag cannot be specified more than once.

    Example of incorrect specification: $ cmd -a 1 -a 2

  • To include spaces in an option argument, the entire option argument must be enclosed within double quotation marks (" ").

    Example of incorrect specification: $ cmd -a file 1

    Example of correct specification: $ cmd -a "file 1"

  • To include a special character (escape character) in an option argument, the special character must be enclosed within double quotation marks (" ").

    Example of incorrect specification: $ cmd -a xyz;12

    Example of correct specification: $ cmd -a "xyz;12"

Priority of options
  • A few options of each command can be omitted if they are coded in the HCSC-Manager command definition file. The following priority applies to the HCSC-Manager command definition file and to the command arguments:

    - When an option is specified in both the HCSC-Manager command definition file and the command argument:

    The option specified in the command argument is valid.

    - When an option is not specified in both the HCSC-Manager command definition file and the command argument:

    The command terminates abnormally.

For details about the HCSC-Manager command definition file, see 6.5.2 HCSC-Manager command definition file.

  • There are no rules for the order of the options. The following examples 1 and 2 are treated as the same command:

    Example 1: $ cmd -a file -b option

    Example 2: $ cmd -b option -a file