Command syntax

When entering a command, the CLI console requires that you use valid syntax and conform to expected input constraints. It rejects invalid commands. Indentation is used to indicate the levels of nested commands.

Each command line consists of a command word, usually followed by configuration data or a specific item that the command uses or affects.


Brackets, vertical bars, and spaces are used to denote valid syntax. Constraint notations, such as <address_ipv4>, indicate which data types or string patterns are acceptable value input.

All syntax uses the following conventions:

Angle brackets < >

Indicate a variable of the specified data type.

Curly brackets { }

Indicate that a variable or variables are mandatory.

Square brackets [ ]

Indicate that the variable or variables are optional.

For example:

show system interface [<name_str>]

To show the settings for all interfaces, you can enter show system interface

To show the settings for the Port1 interface, you can enter show system interface port1.

Vertical bar |

A vertical bar separates alternative, mutually exclusive options.

For example:

set protocol {ftp | sftp}

You can enter either set protocol ftp or set protocol sftp.