Siemens SCALANCE XR-300WG - Symbols of the CLI Commands

2.7 Symbols of the CLI commands
Symbols for representing CLI commands
When setting parameters for CLI commands, the following characters are used:
Charac‐
ter
Meaning
< ... > mandatory parameter Instead of the expression in parenthesis, you must enter a value
[ ... ] optional parameter Instead of the expression in parenthesis, you can enter a value
( ... ) Value or range of values Enter a value to replace the expression in parenthesis
( ... - ... ) Range of values Enter a value from this range
{ ... } Selection list Select one more elements from the list
{ ... | ... } exclusive selection Select exactly one element from this list
These characters are used in combinations to describe mandatory and optional entries.
There is a general description of some of these combinations below:
Character combinations Meaning
< variable > Instead of the expression in parentheses<>, enter a
permitted value
< variable (a - b) > Instead of the expression in parentheses <>, enter a
value from the range "a" to "b"
[< variable 1 >< variable 2 >] The parameter pair is optional.
If you use the parameter assignment, you need to en‐
ter a permitted value to replace both expressions in
parenthesis <>
[ keyword < variable (a - b)>] The parameter assignment is optional.
If you use the keyword, you need to enter a value from
the range "a" to "b" to replace the expression in paren‐
thesis <>
[ keyword < variable (a - b) unit >] The parameter assignment is optional.
If you use the keyword, you need to enter a value from
the range "a" to "b" to replace the expression in paren‐
thesis <>.
"Unit" is one of the variables and is also replaced by
the entry.
[keyword { A | B | C }] The parameter assignment is optional.
If you use the keyword, you need to specify exactly one
of the values "A", "B" or "C"
keyword { [A] [B] [C] } After the keyword, enter one or more of the values "A",
"B" or "C"
General information
2.7 Symbols of the CLI commands
SCALANCE XB-200/XC-200/XF-200BA/XP-200/XR-300WG Command Line Interface
Configuration Manual, 07/2017, C79000-G8976-C361-06 35