When entering a command, the CLI requires that you use valid syntax and conform to expected input constraints. It will reject invalid commands.
For example, if you do not type the entire object that will receive the action of a command operator such as
config, the CLI will return an error message such as:
Command fail. CLI parsing error
Fortinet documentation uses the following conventions to describe valid command syntax.
Each command line consists of a command word followed by words for the configuration data or other specific item that the command uses or affects, for example:
get system admin
Fortinet documentation uses the terms in Figure 1 to describe the function of each word in the command line.
The syntax uses the following terms:
- command — A word that begins the command line and indicates an action that the FortiADC appliance should perform on a part of the configuration or host on the network, such as
execute. Together with other words, such as fields or values, that you terminate by pressing the Enter key, it forms a command line. Exceptions include multi-line command lines, which can be entered using an escape sequence.
- subcommand — A kind of command that is available only when nested within the scope of another command. After entering a command, its applicable subcommands are available to you until you exit the scope of the command, or until you descend an additional level into another subcommand. Indentation is used to indicate levels of nested commands.
- object — A part of the configuration that contains tables and/or fields. Valid command lines must be specific enough to indicate an individual object.
- table — A set of fields that is one of possibly multiple similar sets that each have a name or number, such as an administrator account, policy, or network interface. These named or numbered sets are sometimes referenced by other parts of the configuration that use them.
- field — The name of a setting, such as
hostname. Fields in some tables must be configured with values. Failure to configure a required field will result in an invalid object configuration error message, and the FortiADC appliance will discard the invalid table.
- value — A number, letter, IP address, or other type of input that is usually the configuration setting held by a field. Some commands, however, require multiple input values which may not be named but are simply entered in sequential order in the same command line. Valid input types are indicated by constraint notation.
- option — A kind of value that must be one or more words from a fixed set of options.
Valid command lines must be unambiguous if abbreviated. Optional words or other command line permutations are indicated by syntax notation.
If you do not enter a known command, the CLI will return an error message such as:
Unknown action 0
Not all top-level commands have subcommands. Available subcommands vary by their containing scope.
Indentation indicates levels of nested commands, which indicate what other subcommands are available from within the scope.
For example, the
edit subcommand is available only within a command that affects tables, and the
next subcommand is available only from within the
config system interface
set status up
For information about available subcommands, see Subcommands.
Brackets, braces, and pipes are used to denote valid permutations of the syntax. Constraint notations, such as
<address_ipv4>, indicate which data types or string patterns are acceptable value input.
If you do not use the expected data type, the CLI returns an error message such as:
It might reject or discard your settings instead of saving them when you type
A non-required (optional) word or words. For example:
indicates that you may either omit or type both the
A word or series of words that is constrained to a set of options delimited by either vertical bars or spaces.
You must enter at least one of the options, unless the set of options is surrounded by square brackets [ ].
Options delimited by vertical bars
Mutually exclusive options. For example:
indicates that you must enter either
Options delimited by spaces
Non-mutually exclusive options. For example:
indicates that you may enter all or a subset of those options, in any order, in a space-delimited list, such as:
Note: To change the options, you must re-type the entire list. For example, to add
If the option adds to or subtracts from the existing list of options, instead of replacing it, or if the list is comma-delimited, the exception will be noted.
A word constrained by data type.
To define acceptable input, the angled brackets contain a descriptive name followed by an underscore (
indicates that you should enter a number of retries, such as
Data types include: