8.2.2 Conventions used in the definitions

This subsection explains the conventions used in the explanations of the definitions.

The syntax symbols, attribute symbols, and component symbols explained here are not actually specified in the definitions.

Organization of this subsection

(1) Syntax symbols
(2) Component symbols

(1) Syntax symbols

The syntax symbols explain the syntax of the definition statements and operands. The following table explains the syntax symbols.

Table 8‒1: Syntax symbols for definition statements
Syntax symbol	Meaning
`[ ]`	Square brackets indicate that specification of the enclosed item or items are optional. Example: `[:TCP/IP-LAN-host-name]` In this example, you specify a TCP/IP LAN host name or nothing.
`...`	An ellipsis (`...`) indicates that one or more lines of code are not shown for purposes of brevity. Example: `TCP/IP-LAN-host-name...` In this example, you can specify one or more TCP/IP LAN host names.
`\|`	A vertical bar separates multiple items, and has the meaning of OR. Example: `online\|standby` In this example, the item `online` or `standby` is shown.
`{ }`	Curly brackets indicate that one of the enclosed items must be selected for specification. The items are separated by a vertical bar (`\|`). Example: `{online\|standby}` In this example, you specify either the string `online` or `standby`.
underline	An underlined item is assumed if the operand is omitted. Example: `[{online\|standby}]` In this example, if the operand is omitted, the system assumes that `online` is specified.
bold type	Bold type indicates a value that must be the same on all hosts in the hot-standby configuration. Example: `TCP/IP-LAN-service-name` In this example, the same TCP/IP LAN service name must be specified on all hosts in the hot-standby switchover configuration.

To Page Top

(2) Component symbols

Of the attribute symbols, the component symbols explain the lexical elements for the user values. HA Monitor does not support invalid characters (such as control codes). The following table explains the component symbols.

Table 8‒2: Component symbols
Component symbol	Meaning
<alphanumeric>	Alphabetic characters (`A` to `Z` and `a` to `z`) and numeric characters (`0` to `9`)^#
<unsigned integer>	Numeric characters (`0` to `9`)
<path name>	Alphabetic characters (`A` to `Z` and `a` to `z`), numeric characters (`0` to `9`), forward slash (`/`), hyphen (`-`), underscore (`_`), and period (`.`)
<server path name>	Any characters other than a colon (`:`), semicolon (`;`), comma (`,`), space, tab, or end-of-line code

#: The first character must be an alphabetic character.

To Page Top