Preface
This manual is primarily intended for following engineers.
- Network administrator responsible for network configuration and maintenance
This Book Stipulations
Section titled “This Book Stipulations”To increase readability and convenience, the following conventions are made.
- The commands are introduced in a fixed format of [Command],[Purpose],[Parameters], [Options], [Notes] and [Use Cases].
- [Command] indicates the only legal format that can be executed in the terminal.
- [Parameters] lists all available options for the COMMAND,SUBCOMMAND fields in [Command].
- [Purpose] briefly describes what the command does.
- [Notes] is mainly used to provide additional information on the function of the command and to list special cases.
- For security reasons, all commands beginning with the config character require administrator privileges, which are not reflected in [Command].
- You can enter
?to get help information in any view.
Command Line Formatting Conventions
Section titled “Command Line Formatting Conventions”| Format | Significance |
|---|---|
| Bold | Command line keywords (which remain unchanged on the command line and are entered directly as given) are indicated in bold font. |
| italic | Command line parameters (the part of the command that must be replaced by the actual value) are italicised. |
| ( ) | Indicates additional notes, examples of parameters |
| [ ] | Indicates that the part enclosed in ”[ ]” is optional when the command is configured. |
| {x|y|…} | Indicates that only one of the multiple options is selected. |
| [x|y|…] | Indicates that one or none of the multiple options is selected. |
| {x|y|…}* | Indicates the selection of one, more than one, from multiple options. |
| {x|y|…}*n | Indicates the selection of n options from several options, n is a positive integer. |
| [x|y|…]* | Indicates one, more than one or no choice from several options. |
| [x|y|…]*n | Indicates n or no choices from several options, n is a positive integer. |
| &<1-n> | Indicates that the parameter preceding the symbol & can be repeated 1 ~ n times. |
Composite Command Line Formatting Conventions
Section titled “Composite Command Line Formatting Conventions”| Format | Significance |
|---|---|
| [x|y [z]] | | has the highest priority, | first before [ ] |