CLI command syntax
This guide uses the following conventions to describe command syntax.
- Angle brackets
< >
indicate variables. - Vertical bar and curly brackets
{|}
separate alternative, mutually exclusive required keywords.For example:
execute {reboot | shutdown | ping <host> | traceroute <host>}
You can enter
execute reboot
orexecute shutdown
. - Square brackets
[ ]
indicate that a variable is optional.For example:
set [ip] [<ip_address/netmask>]
To show the current setting, you can enter
set ip
. To edit the setting, you can enterset ip 192.168.1.100/24
. - A space separates options that must be separated by spaces and must be entered in that specific order.
For example:
config system route
- Special characters:
- The single quotation mark ' and the double quotation mark “ are supported, but must be used in matching pairs.
- If there are spaces in a string, you must put the string in a pair of quotation marks.