Conventions in syntax explanations

Business Continuity Manager Web API Reference Guide

Version
9.9.1
Audience
anonymous
Part Number
MK-96HC137-03

The following table shows the conventions used in syntax explanations.

Table. Conventions in syntax explanations

Example font or symbol

Convention

| (stroke)

Indicates delimiters between multiple items and represents the word "or".

Example:

"A|B|C" means "A, B, or C".

[ ]

Items enclosed by these brackets can be omitted.

If multiple items are described, all the items are omitted or only one of them is selected.

Example:

[A] means either "specify nothing" or "specify A".

{ } (curly brackets)

One of items must be selected from among the multiple items enclosed by these brackets. Delimiters between items are indicated as |.

Example:

{A|B|C} means you must specify A, B, or C.

... (dotted line)

The item indicated immediately before this symbol can be repeated and specified multiple times.

Example:

"A, ..." means you can specify the items after A as many times as necessary.

Italics

This indicates that the item is an optional value specified by the user.

_ (underscore)

Indicates the assumed value for the system when the items enclosed in the selection symbol are omitted.

Indicates exactly one space character.

n

Indicates n or more space characters.

~

This indicates that the item before this symbol should be described according to the syntax enclosed by < >, << >>, or (( )) following this symbol.

< >

Indicates a syntax element that must be used when specifying the item.

<< >>

Indicates a default value used by the system if the item is omitted.

(( ))

Indicates the range of values that can be specified.

The following table shows the syntax elements that are used.

Table. Syntax elements

Syntax element

Valid value

Example

numeric characters

0|1|2|3|4|5|6|7|8|9

--

alphabetic characters

A|B|C|D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z|

a|b|c|d|e|f|g|h|i|j|k|l|m|n|o|p|q|r|s|t|u|v|w|x|y|z

--

alphanumeric characters

alphabetic-characters and numeric-characters

A123

hexadecimal number

0|1|2|3|4|5|6|7|8|9|A|B|C|D|E|F

--

symbolic name

A string of 8 or fewer uppercase alphanumeric characters and numbers beginning with an uppercase alphabetic character

A1234567

REXX start symbol

alphabetic-characters|!|?|_|@|#|$

--

REXX simple symbol

A string consisting of REXX start symbols or numeric characters. The first character must be a REXX start symbol. This string is not case sensitive.

A?

REXX prefix

A string consisting of one or more parts, joined by periods (.). The last character must be a period (.). Each part consists of REXX start symbols or numeric characters. The first character must be a REXX start symbol.

A?.A123.!12.

REXX variable name string

A string consisting of one or more parts, joined by periods (.), or REXX simple symbol. Each part consists of REXX start symbols or numeric characters. The first character must be a REXX start symbol. This string is not case sensitive.

A?.A123.!12.A

DAD string

GROUP string

PATH string

PREFIX string

ROUTE string

ROUTELABEL string

A string consisting of one or more parts, joined by periods (.). Each part consists of uppercase alphabetic characters or numeric characters. The first character of each part must be an uppercase alphabetic character. Each part consists of 1 to 8 characters.

ABC.DEF

user ID string

A string consisting of alphanumeric characters. This string must start with an alphabetic character.

a123

console name string

A string consisting of alphanumeric characters. This string must start with an alphabetic character.

a123

command parameter string

A string consisting of one or more parts, joined by spaces. Each part consists of uppercase alphabetic characters, numeric characters, or parentheses (( and )). The first and last characters of the string must both be a single quotation mark (').

'AAA B(C)'

label string

alphabetic-characters and numeric-characters

Ab123

message string

A string consisting of alphanumeric characters, spaces, or parentheses (( and )). The first and last characters of the string must both be a single quotation mark (').

'A b'

storage class string

A string consisting of one to eight alphanumeric characters, at marks (@), hash marks (#), and dollar signs ($).

A1234567

volume serial number string

A string consisting of one to six alphanumeric characters, at marks (@), hash marks (#), dollar signs ($), and hyphens (-).

A12345

device type string

A string consisting of one to eight alphanumeric characters, at marks (@), hash marks (#), dollar signs ($), hyphens (-), and forward slashes (/). Forward slashes can be used only as the first character of the string.

SYSDA

3390

/1234