FortiGate Voice - CLI Command Syntax

Introduction Document conventions
FortiGate Voice Version 4.0 Administration Guide
01-400-112851-20100127 9
http://docs.fortinet.com/ • Feedback
CLI command syntax
This guide uses the following conventions to describe syntax to use when entering
commands in the Command Line Interface (CLI).
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.
For more information, see the FortiGate CLI Reference.
Table 2: Command syntax
Convention Description
Square brackets [] A non-required word or series of words. For example:
[verbose {1 | 2 | 3}]
indicates that you may either omit or type both the verbose word and
its accompanying option, such as:
verbose 3
Angle brackets <> A word constrained by data type.
To define acceptable input, the angled brackets contain a descriptive
name followed by an underscore ( _ ) and suffix that indicates the
valid data type. For example:
<retries_int>
indicates that you should enter a number of retries, such as 5.
Data types include:
• <xxx_name>: A name referring to another part of the
configuration, such as policy_A.
• <xxx_index>: An index number referring to another part of the
configuration, such as 0 for the first static route.
• <xxx_pattern>: A regular expression or word with wild cards
that matches possible variations, such as *@example.com to
match all email addresses ending in @example.com.
• <xxx_fqdn>: A fully qualified domain name (FQDN), such as
mail.example.com.
• <xxx_email>: An email address, such as
admin@mail.example.com.
• <xxx_ipv4>: An IPv4 address, such as 192.168.1.99.
• <xxx_ipv4range>: An IPv4 address range.
• <xxx_v4mask>: A dotted decimal IPv4 netmask, such as
255.255.255.0.
• <xxx_ipv4mask>: A dotted decimal IPv4 address and netmask
separated by a space, such as
192.168.1.99 255.255.255.0.
• <xxx_ipv4/mask>: A dotted decimal IPv4 address and CIDR-
notation netmask separated by a slash, such as such as
192.168.1.99/24.
• <xxx_ipv6>: An IPv6 address.
• <xxx_v6mask>: A dotted decimal IPv6 netmask.
• <xxx_ipv6mask>: A dotted decimal IPv6 address and netmask
separated by a space.
• <xxx_str>: A string of characters that is not another data type,
such as P@ssw0rd. Strings containing spaces or special
characters must be surrounded in quotes or use escape
sequences
•
<xxx_int>: An integer number that is not another data type,
such as 15 for the number of minutes.
Curly braces {} 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 [ ].