Fortinet FortiVoice 200D User manual

FortiVoice
™
200D/200D-T v2.0 MR1
CLI Reference

FortiVoice 200D/200D-T v2.0 MR1 CLI Reference
March 18, 2013
1st Edition
Copyright© 2013 Fortinet, Inc. All rights reserved. Fortinet®, FortiGate®, and FortiGuard®, are
registered trademarks of Fortinet, Inc., and other Fortinet names herein may also be trademarks
of Fortinet. All other product or company names may be trademarks of their respective owners.
Performance metrics contained herein were attained in internal lab tests under ideal conditions,
and performance may vary. Network variables, different network environments and other
conditions may affect performance results. Nothing herein represents any binding commitment
by Fortinet, and Fortinet disclaims all warranties, whether express or implied, except to the
extent Fortinet enters a binding written contract, signed by Fortinet’s General Counsel, with a
purchaser that expressly warrants that the identified product will perform according to the
performance metrics herein. For absolute clarity, any such warranty will be limited to
performance in the same ideal conditions as in Fortinet’s internal lab tests. Fortinet disclaims in
full any guarantees. Fortinet reserves the right to change, modify, transfer, or otherwise revise
this publication without notice, and the most current version of the publication shall be
applicable.
Technical Documentation docs.fortinet.com
Knowledge Base kb.fortinet.com
Customer Service & Support support.fortinet.com
Training Services training.fortinet.com
FortiGuard fortiguard.com
Document Feedback [email protected]

Fortinet Technologies Inc. Page 3 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference
Contents
Contents............................................................................................................ 3
Using the CLI .................................................................................................... 6
Connecting to the CLI.............................................................................................. 6
Connecting to the CLI using a local console ..................................................... 6
Enabling access to the CLI through the network (SSH or Telnet) ..................... 7
Connecting to the CLI using SSH...................................................................... 9
Connecting to the CLI using Telnet ................................................................. 10
Command syntax................................................................................................... 10
Terminology ..................................................................................................... 11
Indentation ....................................................................................................... 12
Notation ........................................................................................................... 12
Sub-commands ..................................................................................................... 14
Permissions ........................................................................................................... 17
Tips and tricks ....................................................................................................... 18
Help.................................................................................................................. 18
Shortcuts and key commands......................................................................... 18
Command abbreviation ................................................................................... 19
Special characters ........................................................................................... 19
Language support............................................................................................ 20
Baud rate ......................................................................................................... 20
Editing the configuration file on an external host............................................. 20
config............................................................................................................... 22
customized-message............................................................................................. 23
Syntax .............................................................................................................. 23
email-template-notify-generic.......................................................................... 23
fv-missed-call-notify ........................................................................................ 24
fv-voicemail-notify............................................................................................ 25
login-disclaimer................................................................................................ 25
dialplan did-mapping............................................................................................. 27
dialplan inbound .................................................................................................... 29
config dialplan outbound ....................................................................................... 32
extension group ..................................................................................................... 34
extension paging.................................................................................................... 35
extension preference ............................................................................................. 36
extension remote ................................................................................................... 41
extension ring-group.............................................................................................. 42
extension user........................................................................................................ 43
log setting remote.................................................................................................. 45
log setting local...................................................................................................... 47
log alertemail recipient........................................................................................... 49

Fortinet Technologies Inc. Page 4 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference
log alertemail setting.............................................................................................. 50
mailsetting relayserver ........................................................................................... 51
pbx account-code ................................................................................................. 52
pbx call-parking ..................................................................................................... 53
pbx feature-access-code....................................................................................... 54
pbx location ........................................................................................................... 55
pbx number-management ..................................................................................... 57
pbx rating-table ..................................................................................................... 59
pbx schedule ......................................................................................................... 60
pbx storage-capacity............................................................................................. 61
pbx system-speed-dial .......................................................................................... 62
pbx user-privilege .................................................................................................. 63
profile caller-id-translate........................................................................................ 66
profile sip-setting ................................................................................................... 68
report ..................................................................................................................... 70
service auto-attendant........................................................................................... 73
service conference................................................................................................. 76
service recording ................................................................................................... 77
system accprofile................................................................................................... 78
system admin......................................................................................................... 79
system appearance ............................................................................................... 81
system auto-provisioning ...................................................................................... 82
system certificate ca.............................................................................................. 84
system certificate crl.............................................................................................. 85
system certificate local .......................................................................................... 86
system certificate remote ...................................................................................... 87
system ddns .......................................................................................................... 88
system dhcp server ............................................................................................... 90
system dns............................................................................................................. 93
system global......................................................................................................... 94
system interface..................................................................................................... 95
system mailserver .................................................................................................. 97
system password-policy........................................................................................ 98
system port-forwarding ......................................................................................... 99
system route ........................................................................................................ 100
system sip-setting................................................................................................ 101
system time manual............................................................................................. 103
system time ntp ................................................................................................... 104
system voicemail ................................................................................................. 105
trunk office-peer .................................................................................................. 106

Fortinet Technologies Inc. Page 5 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference
trunk pstn............................................................................................................. 107
trunk sip-peer....................................................................................................... 109
voice music-on-hold ............................................................................................ 112
voice sound-file.................................................................................................... 113
execute .......................................................................................................... 114
backup ................................................................................................................. 115
certificate ............................................................................................................. 116
checklogdisk........................................................................................................ 118
date...................................................................................................................... 119
db......................................................................................................................... 120
dhcp lease-clear .................................................................................................. 121
dhcp lease-list...................................................................................................... 122
factoryreset.......................................................................................................... 123
nslookup .............................................................................................................. 124
partitionlogdisk .................................................................................................... 125
phone................................................................................................................... 126
ping ...................................................................................................................... 127
ping-option .......................................................................................................... 128
ping6 .................................................................................................................... 129
ping6-option ........................................................................................................ 130
reboot................................................................................................................... 131
reload ................................................................................................................... 132
restore config....................................................................................................... 133
restore image ....................................................................................................... 134
shutdown ............................................................................................................. 135
smtptest............................................................................................................... 136
storage................................................................................................................. 137
telnettest .............................................................................................................. 138
traceroute............................................................................................................. 139
user-config........................................................................................................... 140
get .................................................................................................................. 141
system performance ............................................................................................ 143
system status....................................................................................................... 144
show & show full-configuration .................................................................. 145
Index .............................................................................................................. 147

Fortinet Technologies Inc. Page 6 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference
Using the CLI
The command line interface (CLI) is an alternative to the web-based manager.
Both can be used to configure the FortiVoice unit. However, to perform the configuration, in the
web-based manager, you would use buttons, icons, and forms, while, in the CLI, you would
either type lines of text that are commands, or upload batches of commands from a text file, like
a configuration script.
If you are new to Fortinet products, or if you are new to the CLI, this section can help you to
become familiar.
This section contains the following topics:
•Connecting to the CLI
•Command syntax
•Sub-commands
•Permissions
•Tips and tricks
Connecting to the CLI
You can access the CLI in two ways:
•Locally — Connect your computer directly to the FortiVoice unit’s console port.
•Through the network — Connect your computer through any network attached to one of
the FortiVoice unit’s network ports. The network interface must have enabled Telnet or SSH
administrative access.
Local access is required in some cases.
• If you are installing your FortiVoice unit for the first time and it is not yet configured to
connect to your network, unless you reconfigure your computer’s network settings for a peer
connection, you may only be able to connect to the CLI using a local serial console
connection. See the FortiVoice Setup and Administration Guide.
• Restoring the firmware utilizes a boot interrupt. Network access to the CLI is not available
until after the boot process has completed, and therefore local CLI access is the only viable
option.
Before you can access the CLI through the network, you usually must enable SSH and/or Telnet
on the network interface through which you will access the CLI.
This section includes:
•Connecting to the CLI using a local console
•Enabling access to the CLI through the network (SSH or Telnet)
•Connecting to the CLI using SSH
•Connecting to the CLI using Telnet
Connecting to the CLI using a local console
Local console connections to the CLI are formed by directly connecting your management
computer or console to the FortiVoice unit, using its DB-9 or RJ-45 console port.

Fortinet Technologies Inc. Page 7 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference
Requirements
• a computer with an available serial communications (COM) port
• the RJ-45-to-DB-9 or null modem cable included in your FortiVoice package
• terminal emulation software such as PuTTY
To connect to the CLI using a local serial console connection
1. Using the null modem or RJ-45-to-DB-9 cable, connect the FortiVoice unit’s console port to
the serial communications (COM) port on your management computer.
2. On your management computer, start PuTTY.
3. In the Category tree on the left, go to Connection > Serial and configure the following:
4. In the Category tree on the left, go to Session (not the sub-node, Logging) and from
Connection type, select Serial.
5. Click Open.
6. Press the Enter key to initiate a connection.
The login prompt appears.
7. Type a valid administrator account name (such as admin) and press Enter.
8. Type the password for that administrator account then press Enter. (In its default state, there
is no password for the admin account.)
The CLI displays the following text, followed by a command line prompt:
Welcome!
You can now enter CLI commands, including configuring access to the CLI through SSH or
Telnet. For details, see “Enabling access to the CLI through the network (SSH or Telnet)” on
page 7.
Enabling access to the CLI through the network (SSH or Telnet)
SSH or Telnet access to the CLI requires connecting your computer to the FortiVoice unit using
one of its RJ-45 network ports. You can either connect directly, using a peer connection
between the two, or through any intermediary network.
You must enable SSH and/or Telnet on the network interface associated with that physical
network port. If your computer is not connected directly or through a switch, you must also
configure the FortiVoice unit with a static route to a router that can forward packets from the
FortiVoice unit to your computer.
The following procedure describes connection using PuTTY software; steps may vary with
other terminal emulators.
Serial line to connect
to
COM1 (or, if your computer has multiple serial ports, the
name of the connected serial port)
Speed (baud) 9600
Data bits 8
Stop bits 1
Parity None
Flow control None

Fortinet Technologies Inc. Page 8 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference
You can do this using either:
• a local console connection (see the following procedure)
• the web-based manager (see the FortiVoice Setup and Administration Guide)
Requirements
• a computer with an available serial communications (COM) port and RJ-45 port
• terminal emulation software such as PuTTY
• the RJ-45-to-DB-9 or null modem cable included in your FortiVoice package
• a network cable
• prior configuration of the network interface and static route (for details, see the FortiVoice
Setup and Administration Guide)
To enable SSH or Telnet access to the CLI using a local console connection
1. Using the network cable, connect the FortiVoice unit’s network port either directly to your
computer’s network port, or to a network through which your computer can reach the
FortiVoice unit.
2. Note the number of the physical network port.
3. Using a local console connection, connect and log into the CLI. For details, see “Connecting
to the CLI using a local console” on page 6.
4. Enter the following commands:
config system interface
edit <interface_name>
set allowaccess {http https ping snmp ssh telnet}
end
where:
•<interface_str> is the name of the network interface associated with the physical
network port, such as port1
•{aggregator http https ping ssh telnet webservice} is the complete,
space-delimited list of permitted administrative access protocols, such as https ssh
telnet; omit protocols that you do not want to permit
For example, to exclude HTTP, SNMP, and Telnet, and allow only HTTPS, ICMP ECHO (ping),
and SSH administrative access on port1:
config system interface
edit "port1"
set allowaccess ping https ssh
next
end
Telnet is not a secure access method. SSH should be used to access the CLI from the Internet
or any other untrusted network.

Fortinet Technologies Inc. Page 9 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference
5. To confirm the configuration, enter the command to view the access settings for the
interface.
show system interface <interface_name>
The CLI displays the settings, including the management access settings, for the interface.
To connect to the CLI through the network interface, see “Connecting to the CLI using SSH”
on page 9or “Connecting to the CLI using Telnet” on page 10.
Connecting to the CLI using SSH
Once the FortiVoice unit is configured to accept SSH connections, you can use an SSH client
on your management computer to connect to the CLI.
Secure Shell (SSH) provides both secure authentication and secure communications to the CLI.
Supported SSH protocol versions, ciphers, and bit strengths vary by whether or not you have
enabled FIPS-CC mode, but generally include SSH version 2 with AES-128, 3DES, Blowfish,
and SHA-1.
Requirements
• a FortiVoice network interface configured to accept SSH connections (see “Enabling access
to the CLI through the network (SSH or Telnet)” on page 7)
• terminal emulation software such as PuTTY
To connect to the CLI using SSH
1. On your management computer, start PuTTY.
2. In Host Name (or IP Address), type the IP address of a network interface on which you have
enabled SSH administrative access.
3. In Port, type 22.
4. From Connection type, select SSH.
5. Click Open.
The SSH client connects to the FortiVoice unit.
The SSH client may display a warning if this is the first time you are connecting to the
FortiVoice unit and its SSH key is not yet recognized by your SSH client, or if you have
previously connected to the FortiVoice unit but it used a different IP address or SSH key. If
your management computer is directly connected to the FortiVoice unit with no network
hosts between them, this is normal.
6. Click Yes to verify the fingerprint and accept the FortiVoice unit’s SSH key. You will not be
able to log in until you have accepted the key.
7. The CLI displays a login prompt.
8. Type a valid administrator account name (such as admin) and press Enter.
You can alternatively log in using an SSH key. For details, see “system admin” on page 79.

Fortinet Technologies Inc. Page 10 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference
9Type the password for this administrator account and press Enter.
The CLI displays a command line prompt (by default, its host name followed by a #). You can
now enter CLI commands.
Connecting to the CLI using Telnet
Once the FortiVoice unit is configured to accept Telnet connections, you can use a Telnet client
on your management computer to connect to the CLI.
Requirements
• a FortiVoice network interface configured to accept Telnet connections (see “Enabling
access to the CLI through the network (SSH or Telnet)” on page 7)
• terminal emulation software such as PuTTY
To connect to the CLI using Telnet
1. On your management computer, start PuTTY.
2. In Host Name (or IP Address), type the IP address of a network interface on which you have
enabled Telnet administrative access.
3. In Port, type 23.
4. From Connection type, select Telnet.
5. Click Open.
The CLI displays a login prompt.
6. Type a valid administrator account name (such as admin) and press Enter.
7. Type the password for this administrator account and press Enter.
The CLI displays a command line prompt (by default, its host name followed by a #). You can
now enter CLI commands.
Command syntax
When entering a command, the command line interface (CLI) requires that you use valid syntax,
and conform to expected input constraints. It will reject invalid commands.
If four incorrect login or password attempts occur in a row, you will be disconnected. Wait one
minute, then reconnect to attempt the login again.
Telnet is not a secure access method. SSH should be used to access the CLI from the Internet
or any other untrusted network.
If three incorrect login or password attempts occur in a row, you will be disconnected. Wait
one minute, then reconnect to attempt the login again.

Fortinet Technologies Inc. Page 11 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference
Fortinet documentation uses the following conventions to describe valid command syntax.
Terminology
Each command line consists of a command word that is usually followed by words for the
configuration data or other specific item that the command uses or affects:
get system admin
To describe the function of each word in the command line, especially if that nature has
changed between firmware versions, Fortinet uses terms with the following definitions.
Figure 1: Command syntax terminology
•command — A word that begins the command line and indicates an action that the
FortiVoice unit should perform on a part of the configuration or host on the network, such as
config or execute. Together with other words, such as fields or values, that end when you
press the Enter key, it forms a command line.
Valid command lines must be unambiguous if abbreviated. (See “Command abbreviation”
on page 19.) Optional words or other command line permutations are indicated by syntax
notation. (See “Notation” on page 12.)
•sub-command — A kind of command that is available only when nested within the scope of
another command. After entering a command, its applicable sub-commands are available to
you until you exit the scope of the command, or until you descend an additional level into
another sub-command. Indentation is used to indicate levels of nested commands. (See
“Indentation” on page 12.)
Not all top-level commands have sub-commands. Available sub-commands vary by their
containing scope. (See “Sub-commands” on page 14.)
•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 which each have a name
or number, such as an administrator account, policy, or network interface. These named or
Option
Value
Field
Command Subcommand
Table
set ip <interface_ipv4mask>
config system interface
edit <port_name>
set status {up | down}
next
end
Object
This guide is organized alphabetically by object for the config command, and by the name
of the command for remaining top-level commands.

Fortinet Technologies Inc. Page 12 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference
numbered sets are sometimes referenced by other parts of the configuration that use them.
(See “Notation” on page 12.)
•field — The name of a setting, such as ip or 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 FortiVoice unit will discard the invalid table.
•value — A number, letter, IP address, or other type of input that is usually your 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. (See “Notation” on page 12.)
•option — A kind of value that must be one or more words from of a fixed set of options. (See
“Notation” on page 12.)
Indentation
Indentation indicates levels of nested commands, which indicate what other sub-commands
are available from within the scope.
For example, the edit sub-command is available only within a command that affects tables,
and the next sub-command is available only from within the edit sub-command:
config system interface
edit port1
set status up
next
end
For information about available sub-commands, see “Sub-commands” on page 14.
Notation
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.
Table 1: Command syntax notation
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

Fortinet Technologies Inc. Page 13 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference
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 0for 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
[email protected].
•<xxx_url>: A uniform resource locator (URL) and its associated
protocol and host name prefix, which together form a uniform
resource identifier (URI), such as
http://www.fortinet./com/.
•<xxx_ipv4>: An IPv4 address, such as 192.168.1.99.
•<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_ipv4range>: A hyphen ( -)-delimited inclusive range of
IPv4 addresses, such as 192.168.1.1-192.168.1.255.
•<xxx_ipv6>: A colon( :)-delimited hexadecimal IPv6 address,
such as 3f2e:6a8b:78a3:0d82:1725:6a2f:0370:6234.
•<xxx_v6mask>: An IPv6 netmask, such as /96.
•<xxx_ipv6mask>: An 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. See “Special characters” on page 19.
•<xxx_int>: An integer number that is not another data type,
such as 15 for the number of minutes.
Table 1: Command syntax notation

Fortinet Technologies Inc. Page 14 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference
Sub-commands
Once you have connected to the CLI, you can enter commands.
Each command line consists of a command word that is usually followed by words for the
configuration data or other specific item that the command uses or affects:
get system admin
Sub-commands are available from within the scope of some commands.When you enter a
sub-command level, the command prompt changes to indicate the name of the current
command scope. For example, after entering:
config system admin
the command prompt becomes:
(admin)#
Applicable sub-commands are available to you until you exit the scope of the command, or until
you descend an additional level into another sub-command.
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 [ ].
Options
delimited by
vertical bars |
Mutually exclusive options. For example:
{enable | disable}
indicates that you must enter either enable or disable, but must
not enter both.
Options
delimited by
spaces
Non-mutually exclusive options. For example:
{http https ping snmp ssh telnet}
indicates that you may enter all or a subset of those options, in any
order, in a space-delimited list, such as:
ping https ssh
Note: To change the options, you must re-type the entire list. For
example, to add snmp to the previous example, you would type:
ping https snmp ssh
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.
Table 1: Command syntax notation

Fortinet Technologies Inc. Page 15 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference
For example, the edit sub-command is available only within a command that affects tables;
the next sub-command is available only from within the edit sub-command:
config system interface
edit port1
set status up
next
end
Available sub-commands vary by command.From a command prompt within config, two
types of sub-commands might become available:
• commands affecting fields
• commands affecting tables
Sub-command scope is indicated in this guide by indentation. See “Indentation” on page 12.
Syntax examples for each top-level command in this CLI Reference do not show all available
sub-commands. However, when nested scope is demonstrated, you should assume that
sub-commands applicable for that level of scope are available.
Table 2: Commands for tables
delete
<table_name> Remove a table from the current object.
For example, in config system admin, you could delete an
administrator account named newadmin by typing delete newadmin
and pressing Enter. This deletes newadmin and all its fields, such as
newadmin’s name and email-address.
delete is only available within objects containing tables.
edit
<table_name> Create or edit a table in the current object.
For example, in config system admin:
• edit the settings for the default admin administrator account by
typing edit admin.
• add a new administrator account with the name newadmin and edit
newadmin‘s settings by typing edit newadmin.
edit is an interactive sub-command: further sub-commands are
available from within edit.
edit changes the prompt to reflect the table you are currently editing.
edit is only available within objects containing tables.
end Save the changes to the current object and exit the config command. This
returns you to the top-level command prompt.

Fortinet Technologies Inc. Page 16 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference
Example of table commands
From within the system admin object, you might enter:
edit admin_1
The CLI acknowledges the new table, and changes the command prompt to show that you are
now within the admin_1 table:
new entry 'admin_1' added
(admin_1)#
get List the configuration of the current object or table.
• In objects, get lists the table names (if present), or fields and their
values.
• In a table, get lists the fields and their values.
purge Remove all tables in the current object.
For example, in config forensic user, you could type get to see
the list of user names, then type purge and then yto confirm that you
want to delete all users.
purge is only available for objects containing tables.
Caution: Back up the FortiVoice unit before performing a purge. purge
cannot be undone. To restore purged tables, the configuration must be
restored from a backup. For details, see backup.
Caution: Do not purge system interface or system admin tables.
purge does not provide default tables. This can result in being unable to
connect or log in, requiring the FortiVoice unit to be formatted and
restored.
rename
<table_name>
to
<table_name>
Rename a table.
For example, in config system admin, you could rename admin3 to
fwadmin by typing rename admin3 to fwadmin.
rename is only available within objects containing tables.
show Display changes to the default configuration. Changes are listed in the
form of configuration commands.
Table 3: Commands for fields
abort Exit both the edit and/or config commands without saving
the fields.
end Save the changes made to the current table or object fields,
and exit the config command. (To exit without saving, use
abort instead.)
get List the configuration of the current object or table.
• In objects, get lists the table names (if present), or fields
and their values.
• In a table, get lists the fields and their values.
Table 2: Commands for tables

Fortinet Technologies Inc. Page 17 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference
Example of field commands
From within the admin_1 table, you might enter:
set passwd my1stExamplePassword
to assign the value my1stExamplePassword to the passwd field. You might then enter the
next command to save the changes and edit the next administrator’s table.
Permissions
Depending on the account that you use to log in to the FortiVoice unit, you may not have
complete access to all CLI commands or areas of the web-based manager.
Access profiles control which commands and areas an administrator account can access.
Access profiles assign either read, write, or no access to each area of the FortiVoice software.
To view configurations, you must have read access. To make changes, you must have write
access. For more information on configuring an access profile that administrator accounts can
use, see “system accprofile” on page 78.
Unlike other administrator accounts whose Access profile is super_admin_prof, the admin
administrator account exists by default and cannot be deleted. The admin administrator
account is similar to a root administrator account. This administrator account always has full
permission to view and change all FortiVoice configuration options, including viewing and
changing all other administrator accounts. It is the only administrator account that can reset
another administrator’s password without being required to enter the existing password. As
next Save the changes you have made in the current table’s fields,
and exit the edit command to the object prompt. (To save and
exit completely to the root prompt, use end instead.)
next is useful when you want to create or edit several tables in
the same object, without leaving and re-entering the config
command each time.
next is only available from a table prompt; it is not available
from an object prompt.
set
<field_nam
e> <value>
Set a field’s value.
For example, in config system admin, after typing edit
admin, you could type set passwd newpass to change the
password of the admin administrator to newpass.
Note: When using set to change a field containing a
space-delimited list, type the whole new list. For example, set
<field> <new-value> will replace the list with the
<new-value> rather than appending <new-value> to the list.
show Display changes to the default configuration. Changes are
listed in the form of configuration commands.
unset
<field_nam
e>
Reset the table or object’s fields to default values.
For example, in config system admin, after typing edit
admin, typing unset passwd resets the password of the
admin administrator account to the default (in this case, no
password).
Table 3: Commands for fields

Fortinet Technologies Inc. Page 18 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference
such, it is the only account that can reset another administrator’s password if that administrator
forgets his or her password.
Tips and tricks
Basic features and characteristics of the CLI environment provide support and ease of use for
many CLI tasks.
This section includes:
•Help
•Shortcuts and key commands
•Command abbreviation
•Special characters
•Language support
•Baud rate
•Editing the configuration file on an external host
Help
To display brief help during command entry, press the question mark (?) key.
• Press the question mark (?) key at the command prompt to display a list of the commands
available and a description of each command.
• Type a word or part of a word, then press the question mark (?) key to display a list of valid
word completions or subsequent words, and to display a description of each.
Shortcuts and key commands
Set a strong password for the admin administrator account, and change the password
regularly. By default, this administrator account has no password. Failure to maintain the
password of the admin administrator account could compromise the security of your FortiVoice
unit.
Table 4: Shortcuts and key commands
Action Keys
List valid word completions or subsequent words.
If multiple words could complete your entry, display all possible
completions with helpful descriptions of each.
?
Recall the previous command.
Command memory is limited to the current session.
Up arrow, or
Ctrl + P
Recall the next command. Down arrow,
or
Ctrl + N
Move the cursor left or right within the command line. Left or Right
arrow

Fortinet Technologies Inc. Page 19 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference
Command abbreviation
In most cases, you can abbreviate words in the command line to their smallest number of
non-ambiguous characters. For example, the command get system status could be
abbreviated to g sy st.
Some commands may not be abbreviated. See the notes in the specific commands.
Special characters
The characters <, >, (,), #, ', and “ are not permitted in most CLI fields. These characters are
special characters, sometimes also called reserved characters.
You may be able to enter a special character as part of a string’s value by using a special
command, enclosing it in quotes, or preceding it with an escape sequence — in this case, a
backslash ( \ ) character.
Move the cursor to the beginning of the command line. Ctrl + A
Move the cursor to the end of the command line. Ctrl + E
Move the cursor backwards one word. Ctrl + B
Move the cursor forwards one word. Ctrl + F
Delete the current character. Ctrl + D
Abort current interactive commands, such as when entering
multiple lines.
Ctrl + C
Table 4: Shortcuts and key commands
Table 5: Entering special characters
Character Keys
? Ctrl + V then ?
Tab Ctrl + V then Tab
Space
(to be
interpreted as
part of a string
value, not to
end the string)
Enclose the string in quotation marks: "Security
Administrator".
Enclose the string in single quotes: 'Security
Administrator'.
Precede the space with a backslash: Security\
Administrator.
'
(to be
interpreted as
part of a string
value, not to
end the string)
\'

Fortinet Technologies Inc. Page 20 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference
Language support
Characters such as ñ, é, symbols, and ideographs are sometimes acceptable input. Support
varies by the nature of the item being configured.
For example, the host name must not contain special characters, and so the web-based
manager and CLI will not accept most symbols and non-ASCII encoded characters as input
when configuring the host name. This means that languages other than English often are not
supported. But dictionary profiles support terms encoded in UTF-8, and therefore support a
number of languages.
It is simplest to use only US-ASCII characters when configuring the FortiVoice unit using the
web-based manager or CLI. Using only ASCII, you do not need to worry about:
• web browser language support
• Telnet and/or SSH client support
• font availability
• compatibility of your input’s encoding with the encoding/language setting of the web UI
• switching input methods when entering a command word such as get in ASCII but a setting
that uses a different encoding
Baud rate
You can change the default baud rate of the local console connection. For more information,
see the FortiVoice Setup and Administration Guide.
Editing the configuration file on an external host
You can edit the FortiVoice configuration on an external host by first backing up the
configuration file to a TFTP server. Then edit the configuration file and restore it to the FortiVoice
unit.
Editing the configuration on an external host can be time-saving if you have many changes to
make, especially if your plain text editor provides advanced features such as batch changes.
To edit the configuration on your computer
1. Use backup to download the configuration file to a TFTP server, such as your management
computer.
"
(to be
interpreted as
part of a string
value, not to
end the string)
\"
\\\
Table 5: Entering special characters
If you choose to configure parts of the FortiVoice unit using non-ASCII characters, verify that
all systems interacting with the FortiVoice unit also support the same encodings. You should
also use the same encoding throughout the configuration if possible in order to avoid needing
to switch the language settings of the web-based manager and your web browser or
Telnet/SSH client while you work.