Hitachi

JP1 Version 12 JP1/Performance Management Reference


Command specification method and the notations used in explaining the command syntax

This section describes the command descriptive format, including the command specification method and the notations used in explaining the command syntax.

Organization of this page

Command specification method

The command specification format is shown as follows:

[Figure]

The items indicated by (1) and (2) are called options and arguments, respectively.

Notations used in command syntax explanations

The following table shows the notations used in the command syntax explanations:

Table 3‒1: Notations used in command syntax explanations

Notation

Explanation and example

|

(stroke)

Separates multiple items, any of which can be selected.

Example:

A|B|C means A or B or C.

{ }

(curly braces)

Indicates that one of the items enclosed in the curly braces must be selected. The items are separated by the stroke (|)

Example:

{A|B|C} means that either A or B or C must be specified.

[ ]

(square brackets)

Indicates optional items (items whose specification may be omitted).

Example:

[A] means that A may be specified if needed (A may be omitted if not required).

[B|C] means that B or C may be specified as needed or that B and C may both be omitted.

...

(ellipsis)

The item preceding the ellipsis can be specified as many times as needed. When an item is specified multiple times, the blank is used as the delimiter.

Example:

A B... means that B may be specified as many times as necessary following A.

_

(underline)

Indicates the default value that is assumed by the system if all of the items surrounded by square brackets are omitted.

Example:

[A|B] means that the system will use A if neither A nor B is specified.

Wildcard characters

You can use wildcard characters in a command to specify multiple services or host names. The following two wildcard characters are supported:

In UNIX, a wildcard character must be enclosed in double-quotation marks (such as "*"), so that it will not be analyzed by the shell.

About service IDs specified in commands

For details about service IDs specified in commands, see the appendix that describes service naming conventions in the JP1/Performance Management Planning and Configuration Guide.