FortiManager 5.2 CLI Reference

FortiManager - CLI Reference
VERSION 5.2.3
FORTINET DOCUMENT LIBRARY
http://docs.fortinet.com
FORTINET VIDEO GUIDE
http://video.fortinet.com
FORTINET BLOG
https://blog.fortinet.com
CUSTOMER SERVICE & SUPPORT
https://support.fortinet.com FORTIGATE COOKBOOK
http://cookbook.fortinet.com
FORTINET TRAINING SERVICES
http://www.fortinet.com/training
FORTIGUARD CENTER
http://www.fortiguard.com
END USER LICENSE AGREEMENT
http://www.fortinet.com/doc/legal/EULA.pdf
FEEDBACK
Email: techdocs@fortinet.com
July 31, 2015
FortiManager 5.2.3 CLI Reference
02-523-232152-20150731
TABLE OF CONTENTS
Change Log
Introduction
12
13
About the FortiManager system
FortiManager feature set
FortiAnalyzer feature set
FortiManager documentation
13
13
13
13
What’s New in FortiManager 5.2
15
FortiManager 5.2.3
FortiManager 5.2.2
FortiManager 5.2.1
FortiManager 5.2.0
Using the Command Line Interface
CLI command syntax
Connecting to the CLI
Connecting to the FortiManager console
Setting administrative access on an interface
Connecting to the FortiManager CLI using SSH
Connecting to the FortiManager CLI using the GUI
CLI objects
CLI command branches
config branch
get branch
show branch
execute branch
diagnose branch
Example command sequences
CLI basics
Command help
Command tree
Command completion
Recalling commands
Editing commands
Line continuation
Command abbreviation
15
15
17
19
21
21
21
22
22
23
23
24
24
24
26
28
29
29
29
30
30
30
31
31
31
31
31
Environment variables
Encrypted password support
Entering spaces in strings
Entering quotation marks in strings
Entering a question mark (?) in a string
International characters
Special characters
IPv4 address formats
Editing the configuration file
Changing the baud rate
Debug log levels
Administrative Domains
ADOMs overview
Configuring ADOMs
Concurrent ADOM Access
system
admin
admin group
admin ldap
admin profile
admin radius
admin setting
admin tacacs
admin user
alert-console
alert-event
alertemail
auto-delete
backup all-settings
certificate
certificate ca
certificate crl
certificate local
certificate oftp
certificate ssh
dm
dns
fips
fortiview
global
Time zones
ha
32
32
33
33
33
33
33
33
33
34
34
35
35
36
37
38
38
38
38
40
47
48
54
55
62
63
66
67
68
69
69
69
70
71
71
72
73
74
75
75
80
81
General FortiManager HA configuration steps
interface
locallog
locallog setting
locallog disk setting
locallog filter
locallog fortianalyzer (fortianalyzer2, fortianalyzer3) setting
locallog memory setting
locallog syslogd (syslogd2, syslogd3) setting
log
log alert
log mail-domain
log settings
mail
metadata
ntp
password-policy
report
report auto-cache
report est-browse-time
report group
report setting
route
route6
snmp
snmp community
snmp sysinfo
snmp user
sql
syslog
workflow approval-matrix
fmupdate
analyzer virusreport
av-ips
av-ips advanced-log
av-ips fct server-override
av-ips fgt server-override
av-ips push-override
av-ips push-override-to-client
av-ips update-schedule
av-ips web-proxy
custom-url-list
84
85
86
86
87
89
91
92
93
95
95
95
96
98
99
100
101
101
101
102
102
103
104
104
105
105
108
109
111
114
115
116
116
116
116
117
118
119
119
120
121
122
device-version
disk-quota
fct-services
fds-setting
multilayer
publicnetwork
server-access-priorities
server-override-status
service
support-pre-fgt43
web-spam
web-spam fct server-override
web-spam fgd-log
web-spam fgd-setting
web-spam fgt server-override
web-spam fsa server-override
web-spam poll-frequency
web-spam web-proxy
execute
add-vm-license
backup
bootimage
certificate
certificate ca
certificate local
chassis
console baudrate
date
device
dmserver
dmserver delrev
dmserver revlist
dmserver showconfig
dmserver showdev
dmserver showrev
factory-license
fgfm reclaim-dev-tunnel
fmpolicy
fmpolicy check-upgrade-object
fmpolicy copy-adom-object
fmpolicy install-config
fmpolicy print-adom-database
122
123
124
124
125
125
126
127
127
128
128
128
129
130
132
133
133
133
135
135
135
137
137
137
138
139
140
140
141
141
141
142
142
142
142
143
143
143
143
144
144
145
fmpolicy print-adom-object
fmpolicy print-adom-package
fmpolicy print-device-database
fmpolicy print-device-object
fmpolicy print-prov-templates
fmprofile
fmprofile copy-to-device
fmprofile export-profile
fmprofile import-from-device
fmprofile import-profile
fmprofile list-profiles
fmscript
fmscript clean-sched
fmscript copy
fmscript delete
fmscript import
fmscript list
fmscript run
fmscript showlog
fmupdate
fmupdate cdrom
format
log
log device disk_quota
log device permissions
log device vdom
log dlp-files clear
log import
log ips-pkt clear
log quarantine-files clear
log-integrity
lvm
ping
ping6
raid
reboot
remove
reset
reset-sqllog-transfer
restore
shutdown
sql-local
145
145
146
146
146
147
147
147
148
148
148
149
149
149
149
150
151
151
151
152
153
153
154
154
155
155
155
156
156
157
157
157
158
158
159
159
159
160
160
160
162
162
sql-local rebuild-adom
sql-local rebuild-db
sql-local remove-db
sql-local remove-logs
sql-local remove-logtype
sql-query-dataset
sql-query-generic
sql-report
ssh
ssh-known-hosts
tac
time
top
traceroute
traceroute6
diagnose
auto-delete
cdb check
debug
debug application
debug cli
debug console
debug crashlog
debug disable
debug dpm
debug enable
debug info
debug reset
debug service
debug sysinfo
debug sysinfo-log
debug sysinfo-log-backup
debug sysinfo-log-list
debug timestamp
debug vminfo
dlp-archives
dvm
dvm adom
dvm capability
dvm chassis
dvm check-integrity
dvm debug
163
163
163
163
163
164
165
165
166
167
167
167
167
168
169
170
170
171
171
171
174
174
174
175
175
175
175
176
176
176
176
177
177
177
177
178
178
178
179
179
179
179
dvm device
dvm device-tree-update
dvm extender
dvm group
dvm lock
dvm proc
dvm supported-platforms
dvm task
dvm transaction-flag
dvm workflow
fgfm
fmnetwork
fmnetwork arp
fmnetwork interface
fmnetwork netstat
fmupdate
fortilogd
fwmanager
ha
hardware
log
log device
pm2
report
sniffer
sql
system
system admin-session
system disk
system export
system flash
system fsck
system geoip
system ntp
system print
system process
system raid
system route
system route6
system server
test
test application
180
180
180
181
181
181
181
182
182
182
183
183
183
183
184
184
188
189
190
191
191
191
191
192
192
196
197
198
198
198
199
199
200
200
200
201
201
202
202
202
203
203
test connection
test deploymanager
test policy-check
test search
test sftp
upload
upload clear
upload force-retry
upload status
vpn
get
fmupdate analyzer
fmupdate av-ips
fmupdate custom-url-list
fmupdate device-version
fmupdate disk-quota
fmupdate fct-services
fmupdate fds-setting
fmupdate multilayer
fmupdate publicnetwork
fmupdate server-access-priorities
fmupdate server-override-status
fmupdate service
fmupdate support-pre-fgt43
fmupdate web-spam
system admin
system alert-event
system alertemail
system auto-delete
system backup
system certificate
system dm
system dns
system fips
system global
system ha
system interface
system locallog
system log
system mail
system metadata
system ntp
206
206
206
207
207
207
207
208
208
208
209
209
209
210
210
210
210
211
211
211
211
212
212
212
212
213
214
214
215
215
215
215
216
216
216
217
217
218
219
219
219
219
system password-policy
system performance
system report
system route
system route6
system snmp
system sql
system status
system syslog
system workflow
show
220
220
220
221
221
221
222
223
223
224
225
Change Log
Change Log
12
Date
Change Description
2015-04-15
Initial release.
2015-07-31
Updated to FortiManager 5.2.3.
2015-09-15
rpc-permit default value updated to read-write.
CLI Reference
Fortinet Technologies Inc.
Introduction
FortiManager is designed for medium to large enterprises and managed security service providers. FortiManager
system architecture emphasizes reliability, scalability, ease of use, and easy integration with third-party systems.
FortiManager centralized management appliances deliver the essential tools needed to effectively manage your
Fortinet-based security infrastructure.
About the FortiManager system
The FortiManager system is a security-hardened appliance with simplified installation, and improved system
reliability and security. You can install a second peer FortiManager system for database backups.
The FortiManager system manages communication between the managed devices and the FortiManager GUI.
The FortiManager system stores and manages all managed devices’ configurations.
It can also act as a local FDS server for the managed devices to download virus and attack signatures, and to use
the web filtering and email filtering service. This will reduce network delay and usage, compared with the
managed devices’ connection to an FDS server over the Internet.
FortiManager feature set
The FortiManager feature set includes the following modules:
l
Device Manager
l
Policy & Objects
l
FortiGuard
l
System Settings
FortiAnalyzer feature set
The FortiAnalyzer feature set can be enabled in FortiManager. The FortiAnalyzer feature set includes the
following modules:
l
FortiView
l
Event Management
l
Reports
FortiManager documentation
The following FortiManager product documentation is available:
l
FortiManager Administration Guide
This document describes how to set up the FortiManager system and use it to manage supported Fortinet
units. It includes information on how to configure multiple Fortinet units, configuring and managing the
CLI Reference
Fortinet Technologies Inc.
13
Introduction
FortiManager documentation
FortiGate VPN policies, monitoring the status of the managed devices, viewing and analyzing the FortiGate
logs, updating the virus and attack signatures, providing web filtering and email filter service to the licensed
FortiGate units as a local FDS, firmware revision control and updating the firmware images of the managed
units.
l
l
l
l
l
14
FortiManager device QuickStart Guides
These documents are included with your FortiManager system package. Use this document to install and
begin working with the FortiManager system and FortiManager GUI.
FortiManager Online Help
You can get online help from the FortiManager GUI. FortiManager online help contains detailed procedures
for using the FortiManager GUI to configure and manage FortiGate units.
FortiManager CLI Reference
This document describes how to use the FortiManager Command Line Interface (CLI) and contains references
for all FortiManager CLI commands.
FortiManager Release Notes
This document describes new features and enhancements in the FortiManager system for the release, and
lists resolved and known issues. This document also defines supported platforms and firmware versions.
FortiManager VM Install Guide
This document describes installing FortiManager VM in your virtual environment.
CLI Reference
Fortinet Technologies Inc.
What’s New in FortiManager 5.2
The following sections list commands that have been added, removed, or changed in the CLI.
FortiManager 5.2.3
The table below lists commands which have changed in version 5.2.3.
Command
config fmupdate fds-settings
Change
Variable added:
User-Agent
config system admin ldap
Variables added:
secondary-server
tertiary-server
config system locallog setting
Command added.
config system log settings
Variable added:
sync-search-timeout
config system snmp community
Command added:
hosts6
config system snmp user
Variable added:
notify-hosts6
execute log device vdom
Commands added: add
delete
delete-by-id
list
execute reset
Variable added:
all-except-ip
execute sql-report
Commands added: del-font
import-font
list-fonts
FortiManager 5.2.2
The table below lists commands which have changed in version 5.2.2.
CLI Reference
Fortinet Technologies Inc.
15
What’s New in FortiManager 5.2
Command
config system admin user
FortiManager 5.2.2
Change
Variable added:
time-period
config system fortiview setting
Variable added:
resolve-ip
config system locallog ... filter
Variable added:
devops
config system log mail-domain
Command added
config system log settings
Variable added:
log-file-archive-name
config system mail
Variable added:
secure-option
config system report group
Command added
config system report setting
Variables added:
hcache-lossless
report-priority
config system report settings
Variable added:
show-checkbox-in-table
config system sql
Variable added:
fct-table-partition-time
config system sql
Variable added:
background-rebuild
diagnose cdb check
Variable added:
reference-integrity
diagnose debug application
Variables added:
fazmaild
sqllogd
diagnose sql config
Variable added:
auto-cache-delay
diagnose sql status
Variables added:
sql-hcache-chk
rebuild-adom
diagnose test application
Variable added:
fazmaild
execute sql-local rebuild-adom
16
Command added
CLI Reference
Fortinet Technologies Inc.
FortiManager 5.2.1
Command
execute sql-report
What’s New in FortiManager 5.2
Change
Variables added:
hcache-check
list
list-schedule
view
execute tac report
Command added
FortiManager 5.2.1
The table below lists commands which have changed in version 5.2.1.
Command
Change
config fmupdate av-ips fct server-override
config servlist
Variable added
config fmupdate av-ips fgt server-override
config servlist Variable added
config fmupdate av-ips push-override
Variable added
ip6
ip6
ip6
config fmupdate av-ips push-override-toclient
config announce-ip
Variable added
config fmupdate av-ips web-proxy
Variable added
ip6
ip6
config fmupdate server-access-priorities
config private-server
Variable added
config fmupdate web-spam fct serveroverride
config servlist
Variable added
config fmupdate web-spam fgt serveroverride
config servlist
Variable added
config fmupdate web-spam fsa serveroverride
config servlist
Variable added
config fmupdate web-spam web-proxy
Variable added
ip6
ip6
ip6
ip6
ip6
CLI Reference
Fortinet Technologies Inc.
17
What’s New in FortiManager 5.2
Command
config system admin setting
FortiManager 5.2.1
Change
Variable added
admin-login-max
config system admin settings
Variable removed
show-adom-web-portal
config system admin user
Variable added:
rpc-permit
config system dns
Variables added
ip6-primary
ip6-secondary
config system fortiview setting
Variable added.
not-scanned apps
config system global
Variable removed
max-concurrent-users
Variable added
create-revision
config system global
Variable removed
admintimeout
config system global
Variable added:
workflow-max-session
config system global
Variable added
ssl-protocol
config system ha
config peer
Variable added
config system locallog {fortianalyzer |
fortianalyzer2 | fortianalyzer3}
setting
Variables added:
config system report auto-cache
Variables added:
ip6
server-ip
secure-connection
upload-time
aggressive-schedule
drilldown-status
order
config system report settings
Variable added
max-table-rows
config system sql
Variable removed:
auto-table-upgrade
18
CLI Reference
Fortinet Technologies Inc.
FortiManager 5.2.0
Command
config system sql
What’s New in FortiManager 5.2
Change
Variables added:
device-count-high
event-table-partitiontime
traffic-table-partitiontime
utm-table-partition-time
config system workflow approval-matrix
Command added
diagnose debug application
Variable added:
dns
diagnose debug application vmtools
Command added.
diagnose dvm workflow
Command added
Variables added
log-list
session-list
diagnose fmupdate fgd-asdevice-stat
Command added.
diagnose fmupdate fgd-asserver-stat
Command added.
diagnose sniffer packet
Variable added
Timestamp
diagnose sql config top-dev set
Variables added
log-thres
max-num
diagnose sql rebuild-report-hcache
Command added
diagnose test connection fortianalyzer <ip>
Command added.
execute devicelog clear
Command removed.
execute fmpolicy check-upgrade-object
Command added.
execute format
Variable added
deep-erase
FortiManager 5.2.0
The table below lists commands which have changed in version 5.2.0.
CLI Reference
Fortinet Technologies Inc.
19
What’s New in FortiManager 5.2
Command
config system admin profile
FortiManager 5.2.0
Change
Variable added: change-password
Variables removed: global-objects
adom-policy-objects
faz-management
network
admin
system
devices
alerts
dlp
reports
logs
quar
net-monitor
vuln-mgmt
config system admin user
Variable added: change-password
config system admin setting
Variable removed: demo-mode
Variable added: admin-https-redirect
config system ha
Variable added: file-quota
config system log settings
Variable added: FSA-custom-field1
config system report est-browse-time
Variables added: compensate-read-time
max-read-time
20
config fmupdate service
Variable added: webfilter-httpstraversal
execute fmscript copy
Command added:
diagnose debug reset
Command added
CLI Reference
Fortinet Technologies Inc.
Using the Command Line Interface
This chapter explains how to connect to the CLI and describes the basics of using the CLI. You can use CLI
commands to view all system information and to change all system configuration settings.
CLI command syntax
This guide uses the following conventions to describe command syntax.
l
Angle brackets < > indicate variables.
l
Vertical bar and curly brackets {|} separate alternative, mutually exclusive required keywords.
For example:
set protocol {ftp | sftp}
You can enter set protocol ftp or set protocol sftp.
l
Square brackets [ ] indicate that a variable is 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.
l
A space separates options that can be entered in any combination and must be separated by spaces.
For example:
set allowaccess {https ping}
You can enter any of the following:
set allowaccess ping
set allowaccess https ping
set allowaccess http https ping snmp ssh telnet webservice
In most cases to make changes to lists that contain options separated by spaces, you need to retype the whole
list including all the options you want to apply and excluding all the options you want to remove.
l
Special characters:
l
The \ is supported to escape spaces or as a line continuation character.
l
The single quotation mark ' and the double quotation mark “ are supported, but must be used in pairs.
l
If there are spaces in a string, you must precede the spaces with the \ escape character or put the string in a pair
of quotation marks.
Connecting to the CLI
You can use a direct console connection or SSH to connect to the FortiManager CLI.
CLI Reference
Fortinet Technologies Inc.
21
Using the Command Line Interface
Connecting to the CLI
Connecting to the FortiManager console
To connect to the FortiManager console, you need:
l
l
l
a computer with an available communications port
a console cable, provided with your FortiManager unit, to connect the FortiManager console port and a
communications port on your computer
terminal emulation software, such as HyperTerminal for Windows.
The following procedure describes how to connect to the FortiManager CLI using Windows HyperTerminal software. You can use any terminal emulation program.
To connect to the CLI:
1. Connect the FortiManager console port to the available communications port on your computer.
2. Make sure the FortiManager unit is powered on.
3. Start HyperTerminal, enter a name for the connection, and select OK.
4. Configure HyperTerminal to connect directly to the communications port on the computer to which you have
connected the FortiManager console port.
5. Select OK.
6. Select the following port settings and select OK.
COM port
COM1
Bits per second
115200
Data bits
8
Parity
None
Stop bits
1
Flow control
None
7. Press Enter to connect to the FortiManager CLI.
The login prompt appears.
8. Enter a valid administrator name and press Enter.
9. Enter the password for this administrator and press Enter.
You have connected to the FortiManager CLI, and you can enter CLI commands.
Setting administrative access on an interface
To perform administrative functions through a FortiManager network interface, you must enable the required
types of administrative access on the interface to which your management computer connects. Access to the CLI
requires Secure Shell (SSH) access. If you want to use the GUI, you need HTTPS access.
To use the GUI to configure FortiManager interfaces for SSH access, see the FortiManager Administration
Guide.
22
CLI Reference
Fortinet Technologies Inc.
Connecting to the CLI
Using the Command Line Interface
To use the CLI to configure SSH access:
1. Connect and log into the CLI using the FortiManager console port and your terminal emulation software.
2. Use the following command to configure an interface to accept SSH connections:
config system interface
edit <interface_name>
set allowaccess <access_types>
end
Where <interface_name> is the name of the FortiManager interface to be configured to allow
administrative access, and <access_types> is a whitespace-separated list of access types to enable.
For example, to configure port1 to accept HTTPS and SSH connections, enter:
config system interface
edit port1
set allowaccess https ssh
end
Remember to press Enter at the end of each line in the command example. Also,
type end and press Enter to commit the changes to the FortiManager configuration.
3. To confirm that you have configured SSH access correctly, enter the following command to view the access
settings for the interface:
get system interface
<interface_name>
The CLI displays the settings, including the management access settings, for the named interface.
Connecting to the FortiManager CLI using SSH
SSH provides strong secure authentication and secure communications to the FortiManager CLI from your
internal network or the internet. Once the FortiManager unit is configured to accept SSH connections, you can run
an SSH client on your management computer and use this client to connect to the FortiManager CLI.
A maximum of 5 SSH connections can be open at the same time.
To connect to the CLI using SSH:
1. Install and start an SSH client.
2. Connect to a FortiManager interface that is configured for SSH connections.
3. Enter a valid administrator name and press Enter.
4. Enter the password for this administrator and press Enter.
The FortiManager model name followed by a # is displayed.
You have connected to the FortiManager CLI, and you can enter CLI commands.
Connecting to the FortiManager CLI using the GUI
The GUI also provides a CLI console window.
CLI Reference
Fortinet Technologies Inc.
23
Using the Command Line Interface
CLI objects
To connect to the CLI using the GUI:
1. Connect to the GUI and log in.
For information about how to do this, see the FortiManager Administration Guide.
2. Go to System Settings > Dashboard
3. Click inside the CLI Console widget. If the widget is not available, select Add Widget to add the widget to the
dashboard.
CLI objects
The FortiManager CLI is based on configurable objects. The top-level objects are the basic components of
FortiManager functionality. Each has its own chapter in this guide.
fmupdate
Configures settings related to FortiGuard service updates and the FortiManager unit’s
built-in FDS. See fmupdate on page 116.
system
Configures options related to the overall operation of the FortiManager unit, such as
interfaces, virtual domains, and administrators. See system on page 38.
There is a chapter in this manual for each of these top-level objects. Each of these objects contains more specific
lower level objects. For example, the system object contains objects for administrators, dns, interfaces, and so
on.
CLI command branches
The FortiManager CLI consists of the following command branches:
config branch
execute branch
get branch
diagnose branch
show branch
Examples showing how to enter command sequences within each branch are provided in the following sections.
config branch
The config commands configure objects of FortiManager functionality. Top-level objects are not configurable,
they are containers for more specific lower level objects. For example, the system object contains administrators,
DNS addresses, interfaces, routes, and so on. When these objects have multiple sub-objects, such as
administrators or routes, they are organized in the form of a table. You can add, delete, or edit the entries in the
table. Table entries each consist of keywords that you can set to particular values. Simpler objects, such as
system DNS, are a single set of keywords.
To configure an object, you use the config command to navigate to the object’s command “shell”. For example,
to configure administrators, you enter the command
config system admin user
24
CLI Reference
Fortinet Technologies Inc.
CLI command branches
Using the Command Line Interface
The command prompt changes to show that you are in the admin shell.
(user)#
This is a table shell. You can use any of the following commands:
delete
Remove an entry from the FortiManager configuration. For example in the config
system admin shell, type delete newadmin and press Enter to delete the
administrator account named newadmin.
edit
Add an entry to the FortiManager configuration or edit an existing entry. For example
in the config system admin shell: l
type edit admin and press Enter to edit the settings for the default admin
administrator account.
l
type edit newadmin and press Enter to create a new administrator
account with the name newadmin and to edit the default settings for the new
administrator account.
end
Save the changes you have made in the current shell and leave the shell. Every config command must be paired with an end command. You return to the root FortiManager CLI prompt.
The end command is also used to save set command changes and leave the shell.
get
List the configuration. In a table shell, get lists the table members. In an edit shell,
get lists the keywords and their values.
purge
Remove all entries configured in the current shell. For example in the config user
local shell: l
type get to see the list of user names added to the FortiManager
configuration,
show
l
type purge and then y to confirm that you want to purge all the user names,
l
type get again to confirm that no user names are displayed.
Show changes to the default configuration as configuration commands.
If you enter the get command, you see a list of the entries in the table of administrators. To add a new
administrator, you enter the edit command with a new administrator name:
edit admin_1
The FortiManager unit acknowledges the new table entry and changes the command prompt to show that you are
now editing the new entry:
new entry 'admin_1' added
(admin_1)#
From this prompt, you can use any of the following commands:
abort
Exit an edit shell without saving the configuration.
config
In a few cases, there are subcommands that you access using a second config command while editing a table entry. An example of this is the command to add host definitions to an SNMP community.
CLI Reference
Fortinet Technologies Inc.
25
Using the Command Line Interface
CLI command branches
end
Save the changes you have made in the current shell and leave the shell. Every config command must be paired with an end command.
The end command is also used to save set command changes and leave the shell.
get
List the configuration. In a table shell, get lists the table members. In an edit shell,
get lists the keywords and their values.
next
Save the changes you have made in the current shell and continue working in the shell.
For example if you want to add several new admin user accounts enter the config
system admin user shell.
Enter edit User1 and press Enter.
Use the set commands to configure the values for the new admin account.
Enter next to save the configuration for User1 without leaving the config system
admin user shell.
Continue using the edit, set, and next commands to continue adding admin user
accounts.
Type end then press Enter to save the last configuration and leave the shell.
set
Assign values. For example from the edit admin command shell, typing set
passwd newpass changes the password of the admin administrator account to newpass.
Note: When using a set command to make changes to lists that contain options separated by spaces, you need to retype the whole list including all the options you want to
apply and excluding all the options you want to remove.
show
Show changes to the default configuration in the form of configuration commands.
unset
Reset values to defaults. For example from the edit admin command shell, typing
unset passwd resets the password of the admin administrator account to the
default of no password.
The config branch is organized into configuration shells. You can complete and save the configuration within
each shell for that shell, or you can leave the shell without saving the configuration. You can only use the
configuration commands for the shell that you are working in. To use the configuration commands for another
shell you must leave the shell you are working in and enter the other shell.
The root prompt is the FortiManager host or model name followed by a #.
get branch
Use get to display settings. You can use get within a config shell to display the settings for that shell, or you
can use get with a full path to display the settings for the specified shell.
To use get from the root prompt, you must include a path to a shell.
Example
When you type get in the config system admin user shell, the list of administrators is displayed.
At the (user)# prompt, type:
get
The screen displays:
26
CLI Reference
Fortinet Technologies Inc.
CLI command branches
Using the Command Line Interface
== [ admin ]
userid: admin
== [ admin2 ]
userid: admin2
== [ admin3 ]
userid: admin3
Example
When you type get in the admin user shell, the configuration values for the admin administrator account are
displayed.
edit admin
At the (admin)# prompt, type:
get
The screen displays:
userid : admin
password : *
trusthost1 : 0.0.0.0 0.0.0.0
trusthost2 : 0.0.0.0 0.0.0.0
trusthost3 : 0.0.0.0 0.0.0.0
trusthost4 : 0.0.0.0 0.0.0.0
trusthost5 : 0.0.0.0 0.0.0.0
trusthost6 : 0.0.0.0 0.0.0.0
trusthost7 : 0.0.0.0 0.0.0.0
trusthost8 : 0.0.0.0 0.0.0.0
trusthost9 : 0.0.0.0 0.0.0.0
trusthost10 : 127.0.0.1 255.255.255.255
ipv6_trusthost1 : ::/0
ipv6_trusthost2 : ::/0
ipv6_trusthost3 : ::/0
ipv6_trusthost4 : ::/0
ipv6_trusthost5 : ::/0
ipv6_trusthost6 : ::/0
ipv6_trusthost7 : ::/0
ipv6_trusthost8 : ::/0
ipv6_trusthost9 : ::/0
ipv6_trusthost10 : ::1/128
profileid : Super_User
adom:
== [ all_adoms ]
adom-name: all_adoms
policy-package:
== [ all_policy_packages ]
policy-package-name: all_policy_packages
restrict-access : disable
restrict-dev-vdom:
description : (null)
user_type : local
ssh-public-key1 :
ssh-public-key2 :
ssh-public-key3 :
meta-data:
last-name : (null)
first-name : (null)
email-address : (null)
CLI Reference
Fortinet Technologies Inc.
27
Using the Command Line Interface
CLI command branches
phone-number : (null)
mobile-number : (null)
pager-number : (null)
hidden : 0
dashboard-tabs:
dashboard:
== [ 6 ]
moduleid: 6
== [ 1 ]
moduleid: 1
== [ 2 ]
moduleid: 2
== [ 3 ]
moduleid: 3
== [ 4 ]
moduleid: 4
== [ 5 ]
moduleid: 5
Example
You want to confirm the IPv4 address and netmask of the port1 interface from the root prompt.
At the # prompt, type:
get system interface port1
The screen displays:
name : port1
status : up
ip : 10.2.115.5 255.255.0.0
allowaccess : ping https ssh snmp telnet http webservice
serviceaccess : fgtupdates webfilter-antispam webfilter antispam
speed : auto
description : (null)
alias : (null)
ipv6:
ip6-address: ::/0 ip6-allowaccess:
show branch
Use show to display the FortiManager unit configuration. Only changes to the default configuration are
displayed. You can use show within a config shell to display the configuration of that shell, or you can use
show with a full path to display the configuration of the specified shell.
To display the configuration of all config shells, you can use show from the root prompt.
Example
When you type show and press Enter within the port1 interface shell, the changes to the default interface
configuration are displayed.
At the (port1)# prompt, type:
show
The screen displays:
config system interface
28
CLI Reference
Fortinet Technologies Inc.
CLI command branches
Using the Command Line Interface
edit "port1"
set ip 10.2.115.5 255.255.0.0
set allowaccess ping https ssh snmp telnet http webservice
set serviceaccess fgtupdates webfilter-antispam webfilter antispam
next
end
Example
You are working in the port1 interface shell and want to see the system dns configuration. At the (port1)#
prompt, type:
show system dns
The screen displays:
config system dns
set primary 172.39.139.53
set secondary 172.39.139.63
end
execute branch
Use execute to run static commands, to reset the FortiManager unit to factory defaults, or to back up or restore
the FortiManager configuration. The execute commands are available only from the root prompt.
Example
At the root prompt, type:
execute reboot
and press Enter to restart the FortiManager unit.
diagnose branch
Commands in the diagnose branch are used for debugging the operation of the FortiManager unit and to set
parameters for displaying different levels of diagnostic information. The diagnose commands are not
documented in this CLI Reference.
diagnose commands are intended for advanced users only. Contact Fortinet Customer Support before using these commands.
Example command sequences
The command prompt changes for each shell.
To configure the primary and secondary DNS server addresses:
1. Starting at the root prompt, type:
config system dns
and press Enter. The prompt changes to (dns)#.
CLI Reference
Fortinet Technologies Inc.
29
Using the Command Line Interface
CLI basics
2. At the (dns)# prompt, type ?
The following options are displayed.
set
unset
get
show
abort
end
3. Enter set ?
The following options are displayed:
primary
secondary
4. To set the primary DNS server address to 172.16.100.100, type:
set primary 172.16.100.100
and press Enter.
5. To set the secondary DNS server address to 207.104.200.1, type:
set secondary 207.104.200.1
and press Enter.
6. To restore the primary DNS server address to the default address, type unset primary and press Enter.
If you want to leave the config system dns shell without saving your changes, type abort and press
Enter.
7. To save your changes and exit the dns sub-shell, type end and press Enter.
8. To confirm your changes have taken effect after leaving the dns sub-shell, type get system dns and press
Enter.
CLI basics
This section covers command line interface basic information.
Command help
You can press the question mark (?) key to display command help.
l
l
l
Press the question mark (?) key at the command prompt to display a list of the commands available and a
description of each command.
Enter a command followed by a space and press the question mark (?) key to display a list of the options available
for that command and a description of each option.
Enter a command followed by an option and press the question mark (?) key to display a list of additional options
available for that command option combination and a description of each option.
Command tree
Enter tree to display the FortiManager CLI command tree. To capture the full output, connect to your device
using a terminal emulation program, such as PuTTY, and capture the output to a log file. For config
commands, use the tree command to view all available variables and sub-commands.
30
CLI Reference
Fortinet Technologies Inc.
CLI basics
Using the Command Line Interface
Command completion
You can use the tab key or the question mark (?) key to complete commands.
l
l
l
You can press the tab key at any prompt to scroll through the options available for that prompt.
You can type the first characters of any command and press the tab key or the question mark (?) key to complete
the command or to scroll through the options that are available at the current cursor position.
After completing the first word of a command, you can press the space bar and then the tab key to scroll through the
options available at the current cursor position.
Recalling commands
You can recall previously entered commands by using the Up and Down arrow keys to scroll through commands
you have entered.
Editing commands
Use the left and right arrow keys to move the cursor back and forth in a recalled command. You can also use
Backspace and Delete keys, and the control keys listed in the following table to edit the command.
Function
Key combination
Beginning of line
Control key + A
End of line
Control key + E
Back one character
Control key + B
Forward one character
Control key + F
Delete current character
Control key + D
Previous command
Control key + P
Next command
Control key + N
Abort the command
Control key + C
If used at the root prompt, exit the CLI
Control key + C
Line continuation
To break a long command over multiple lines, use a \ at the end of each line.
Command abbreviation
You can abbreviate commands and command options to the smallest number of non-ambiguous characters. For
example, the command get system status can be abbreviated to g sy st.
CLI Reference
Fortinet Technologies Inc.
31
Using the Command Line Interface
CLI basics
Environment variables
The FortiManager CLI supports several environment variables.
$USERFROM
The management access type (SSH, Telnet and so on) and the IPv4
address of the logged in administrator.
$USERNAME
The user account name of the logged in administrator.
$SerialNum
The serial number of the FortiManager unit.
Variable names are case sensitive. In the following example, when entering the variable, you can type $ followed
by a tab to auto-complete the variable to ensure that you have the exact spelling and case. Continue pressing tab
until the variable you want to use is displayed.
config system global
set hostname $SerialNum
end
Encrypted password support
After you enter a clear text password using the CLI, the FortiManager unit encrypts the password and stores it in
the configuration file with the prefix ENC. For example:
show system admin user user1
config system admin user
edit "user1"
set password ENC
UAGUDZ1yEaG30620s6afD3Gac1FnOT0BC1rVJmMFc9ubLlW4wEvHcqGVq+ZnrgbudK7aryyf1scXc
XdnQxskRcU3E9XqOit82PgScwzGzGuJ5a9f
set profileid "Standard_User"
next
end
It is also possible to enter an already encrypted password. For example, type:
config system admin
then press Enter.
Enter:
edit user1
then press Enter.
Enter:
set password ENC
UAGUDZ1yEaG30620s6afD3Gac1FnOT0BC1rVJmMFc9ubLlW4wEvHcqGVq+ZnrgbudK7aryyf1scXcXdnQxs
kRcU3E9XqOit82PgScwzGzGuJ5a9f
then press Enter.
Enter:
end
then press Enter.
32
CLI Reference
Fortinet Technologies Inc.
CLI basics
Using the Command Line Interface
Entering spaces in strings
When a string value contains a space, do one of the following:
l
Enclose the string in quotation marks, "Security Administrator", for example.
l
Enclose the string in single quotes, 'Security Administrator', for example.
l
Use a backslash (“\”) preceding the space, Security\ Administrator, for example.
Entering quotation marks in strings
If you want to include a quotation mark, single quote or apostrophe in a string, you must precede the character
with a backslash character. To include a backslash, enter two backslashes.
Entering a question mark (?) in a string
If you want to include a question mark (?) in a string, you must precede the question mark with CTRL-V. Entering
a question mark without first entering CTRL-V causes the CLI to display possible command completions,
terminating the string.
International characters
The CLI supports international characters in strings.
Special characters
The characters <, >, (, ), #, ’, and " are not permitted in most CLI fields, but you can use them in passwords. If you
use the apostrophe (‘) or quote (") character, you must precede it with a backslash (\) character when entering it in
the CLI set command.
IPv4 address formats
You can enter an IPv4 address and subnet using either dotted decimal or slash-bit format. For example you can
type either:
set ip 192.168.1.1 255.255.255.0
or
set ip 192.168.1.1/24
The IPv4 address is displayed in the configuration file in dotted decimal format.
Editing the configuration file
You can change the FortiManager configuration by backing up the configuration file to an FTP, SCP, or SFTP
server. You can then make changes to the file and restore it to the FortiManager unit.
Use the execute backup all-settings command to back up the configuration file to a TFTP server. For
example:
execute backup all-settings ftp 10.10.0.1 mybackup.cfg myid mypass
Edit the configuration file using a text editor.
CLI Reference
Fortinet Technologies Inc.
33
Using the Command Line Interface
CLI basics
Related commands are listed together in the configuration file. You can edit the configuration by adding,
changing, or deleting the CLI commands in the configuration file.
The first line of the configuration file contains information about the firmware version and FortiManager model.
Do not edit this line. If you change this information the FortiManager unit will reject the configuration file when
you attempt to restore it.
Use the execute restore all-settings command to copy the edited configuration file back to the
FortiManager unit. For example:
execute restore all-settings ftp 10.10.0.1 mybackup.cfg myid mypass
The FortiManager unit receives the configuration file and checks to make sure the firmware version and model
information is correct. If it is, the FortiManager unit loads the configuration file and checks each command for
errors. If the FortiManager unit finds an error, an error message is displayed after the command and the
command is rejected. The FortiManager unit then restarts and loads the new configuration.
Changing the baud rate
Using execute console baudrate, you can change the default console connection baud rate.
Changing the default baud rate is not available on all models.
Debug log levels
The following table lists available debug log levels on your FortiManager.
34
0
Emergency
The system has become unusable.
1
Alert
Immediate action is required.
2
Critical
Functionality is affected.
3
Error
An erroneous condition exists and functionality is probably affected.
4
Warning
Function might be affected.
5
Notice
Notification of normal events.
6
Information
General information about system operations.
7
Debug
Detailed information useful for debugging purposes.
8
Maximum
Maximum log level.
CLI Reference
Fortinet Technologies Inc.
Administrative Domains
This chapter provides information about the ADOM functionality in FortiManager .
ADOMs overview
FortiManager can manage a large number of Fortinet devices. ADOMs enable administrators to manage only
those devices that are specific to their geographic location or business division. This also includes FortiGate units
with multiple configured VDOMs.
If ADOMs are enabled, each administrator account is tied to an administrative domain. When a particular
administrator logs in, they see only those devices or VDOMs that have been enabled for their account. The one
exception is the admin administrator account which can see and maintain all administrative domains and the
devices within those domains.
Administrative domains are not enabled by default, and enabling and configuring the domains can only be
performed by the admin administrator. For more information, see Configuring ADOMs on page 36.
The default and maximum number of administrative domains you can add depends on the FortiManager system
model. The table below outlines these limits.
FortiManager Model
Administrative Domain / Network Devices
FMG-100C
30 / 30
FMG-200D
30 / 30
FMG-300D
300 / 300
FMG-400C
300 / 300
FMG-1000C
800 / 800
FMG-1000D
1000 / 1000
FMG-3000C
5000 / 5000
FMG-3900E
5000 / 5000
FMG-4000D
4000 / 4000
FMG-4000E
4000 / 4000
FMG-VM-Base
10 / 10
FMG-VM-10-UG
+10 / +10
CLI Reference
Fortinet Technologies Inc.
35
Administrative Domains
Configuring ADOMs
FortiManager Model
Administrative Domain / Network Devices
FMG-VM-100-UG
+100 / +100
FMG-VM-1000-UG
+1000 / +1000
FMG-VM-5000-UG
+5000 / +5000
FMG-VM-U-UG
+10000 / +10000
Configuring ADOMs
To use administrative domains, the admin administrator must first enable the feature, create ADOMs, and
assign existing FortiManager administrators to ADOMs.
Enabling ADOMs moves non-global configuration items to the root ADOM. Back up
the FortiManager unit configuration before enabling ADOMs.
ADOMs must be enabled before adding FortiMail, FortiWeb, and FortiCarrier devices
to the FortiManager system. FortiMail and FortiWeb devices are added to their
respective pre-configured ADOMs.
In FortiManager 5.0.3 and later, FortiGate and FortiCarrier devices can no longer be
grouped into the same ADOM. FortiCarrier devices should be grouped into a dedicated FortiCarrier ADOM.
Within the CLI, you can enable ADOMs and set the administrator ADOM. To configure the ADOMs, you must use
the GUI.
To Enable/disable ADOMs:
Enter the following CLI command:
config system global
set adom-status {enable | disable}
end
An administrative domain has two modes: normal and advanced. Normal mode is the default device mode. In
normal mode, a FortiGate unit can only be added to a single administrative domain. In advanced mode, you can
assign different VDOMs from the same FortiGate to multiple administrative domains.
Enabling the advanced mode option will result in a reduced operation mode and more
complicated management scenarios. It is recommended only for advanced users.
To change ADOM device modes:
Enter the following CLI command:
config system global
36
CLI Reference
Fortinet Technologies Inc.
Configuring ADOMs
Administrative Domains
set adom-mode {advanced | normal}
end
To assign an administrator to an ADOM:
Enter the following CLI command:
config system admin user
edit <name>
set adom <adom_name>
next
end
where <name> is the administrator user name and <adom_name> is the ADOM name.
Concurrent ADOM Access
System administrators can Enable/disable concurrent access to the same ADOM if multiple administrators are
responsible for managing a single ADOM. When enabled, multiple administrators can log in to the same ADOM
concurrently. When disabled, only a single administrator has read/write access to the ADOM, while all other
administrators have read-only access.
Concurrent ADOM access can be enabled or disabled using the CLI.
Concurrent ADOM access is enabled by default. This can cause conflicts if two administrators attempt to make configuration changes to the same ADOM concurrently.
To enable ADOM locking and disable concurrent ADOM access:
config system global
set workspace-mode normal
end
To disable ADOM locking and enable concurrent ADOM access:
config system global
set workspace-mode disable
Warning: disabling workspaces may cause some logged in users to lose their
unsaved data. Do you want to continue? (y/n) y
end
To enable workspace workflow mode:
config system global
set workspace-mode workflow
end
When workflow mode is enabled then the admin will have and extra option in the
admin page under profile to allow the admin to approve or reject workflow requests.
CLI Reference
Fortinet Technologies Inc.
37
system
Use system commands to configure options related to the overall operation of the FortiManager unit.
FortiManager CLI commands and variables are case sensitive.
admin
Use the following commands to configure admin related settings.
admin group
Use this command to add, edit, and delete admin user groups.
Syntax
config system admin group
edit <name>
set <member>
end
Variable
Description
<name>
Enter the name of the group you are editing or enter a new name to create
an entry. Character limit: 63
<member>
Add group members.
admin ldap
Use this command to add, edit, and delete Lightweight Directory Access Protocol (LDAP) users.
Syntax
config system admin ldap
edit <name>
set server <string>
set secondary-server <string>
set tertiary-server <string>
set cnid <string>
set dn <string>
set port <integer>
set type {anonymous | regular | simple}
set username <string>
set password <passwd>
set group <string>
set filter <string>
38
CLI Reference
Fortinet Technologies Inc.
admin
system
set
set
set
set
set
attributes <filter>
secure {disable | ldaps | starttls}
ca-cert <string>
connect-timeout <integer>
adom <adom-name>
end
Variable
Description
<name>
Enter the name of the LDAP server or enter a new name to create an entry.
Character limit: 63
server <string>
Enter the LDAP server domain name or IPv4 address. Enter a new name to
create a new entry.
secondary-server <string>
Enter the secondary LDAP server domain name or IPv4 address. Enter a
new name to create a new entry.
tertiary-server <string>
Enter the tertiary LDAP server domain name or IPv4 address. Enter a new
name to create a new entry.
cnid <string>
Enter the common name identifier. Default: cn. Character limit: 20
dn <string>
Enter the distinguished name.
port <integer>
Enter the port number for LDAP server communication. Default: 389.
Range: 1 to 65535
type {anonymous | regular |
simple}
Set a binding type. The following options are available: l
anonymous: Bind using anonymous user search
l
regular: Bind using username/password and then search
l
simple: Simple password authentication without search (default)
username <string>
Enter a username. This variable appears only when type is set to regular.
password <passwd>
Enter a password for the username above. This variable appears only when
type is set to regular.
group <string>
Enter an authorization group. The authentication user must be a member of
this group (full DN) on the server.
filter <string>
Enter content for group searching. For example:
l
(&(objectcategory=group)(member=*))
CLI Reference
Fortinet Technologies Inc.
l
(&(objectclass=groupofnames)(member=*))
l
(&(objectclass=groupofuniquenames)
(uniquemember=*))
l
(&(objectclass=posixgroup)(memberuid=*))
39
system
admin
Variable
Description
attributes <filter>
Attributes used for group searching (for multi-attributes, a use comma as a
separator). For example:
l
member
secure {disable | ldaps |
starttls}
l
uniquemember
l
member,uniquemember
Set the SSL connection type. The following options are available:
l
disable: no SSL
l
ldaps: use LDAPS
l
starttls: use STARTTLS
ca-cert <string>
CA certificate name. This variable appears only when secure is set to
ldaps or starttls.
connect-timeout <integer>
Set the LDAP connection timeout (msec).
adom <adom-name>
Set the ADOM name to link to the LDAP configuration.
Example
This example shows how to add the LDAP user user1 at the IPv4 address 206.205.204.203.
config system admin ldap
edit user1
set server 206.205.204.203
set dn techdoc
set type regular
set username auth1
set password auth1_pwd
set group techdoc
end
admin profile
Use this command to configure access profiles. In a newly-created access profile, no access is enabled.
Syntax
config system admin profile
edit <profile>
set adom-policy-packages {none | read | read-write}
set adom-switch {none | read | read-write}
set app-filter {enable | disable}
set assignment {none | read | read-write}
set change-password {enable | disable}
set config-retrieve {none | read | read-write}
set consistency-check {none | read | read-write}
set deploy-management {none | read | read-write}
set description <string>
set device-config {none | read | read-write}
set device-manager {none | read | read-write}
set device-op {none | read | read-write}
40
CLI Reference
Fortinet Technologies Inc.
admin
system
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
end
device-profile {none | read | read-write}
event-management {none | read | read-write}
fgd_center {none | read | read-write}
global-policy-packages {none | read | read-write}
ips-filter {enable | disable}
log-viewer {none | read | read-write}
policy-objects {none | read | read-write}
read-passwd {none | read | read-write}
realtime-monitor {none | read | read-write}
report-viewer {none | read | read-write}
scope (Not Applicable)
system-setting {none | read | read-write}
term-access {none | read | read-write}
type {restricted | system}
vpn-manager {none | read | read-write}
web-filter {enable | disable}
workflow-approve {none | read | read-write}
Variable
Description
<profile>
Edit the access profile. Enter a new name to create a new profile. The predefined access profiles are Super_User, Standard_User, Restricted_
User, and Package_User.
Character limit: 35
adom-policy-packages {none |
read | read-write}
Enter the level of access to ADOM policy packages for this profile. Select
none to hide this option from the administrator in the GUI. The following
options are available:
l
none: No permission.
l
read: Read permission.
l
read-write: Read-write permission.
This command corresponds to the Policy Packages & Objects option in the
GUI administrator profile. This is a sub-setting of policy-objects.
Controlled functions: All the operations in ADOMs
Dependencies: Install and re-install depends on Install to Devices in DVM
settings, type must be set to system.
adom-switch {none | read |
read-write}
Configure administrative domain (ADOM) permissions for this profile.
Select none to hide this option from the administrator in the GUI. The following options are available:
l
none: No permission.
l
read: Read permission.
l
read-write: Read-write permission.
Controlled functions: ADOM settings in DVM, ADOM settings in All
ADOMs page (under System Settings tab)
Dependencies: If system-setting is none, the All ADOMs page is not
accessible, type must be set to system.
app-filter {enable | disable}
CLI Reference
Fortinet Technologies Inc.
Enable/disable IPS Sensor permission for the restricted admin profile.
Dependencies: type must be set to restricted.
41
system
Variable
admin
Description
assignment {none | read | read- Configure assignment permissions for this profile. Select none to hide this
write}
option from the administrator in the GUI. The following options are available:
l
none: No permission.
l
read: Read permission.
l
read-write: Read-write permission.
This command corresponds to the Assignment option in the GUI administrator profile. This is a sub-setting of policy-objects.
Controlled functions: Global assignment in Global ADOM.
Dependencies: type must be set to system.
change-password {enable | dis- Enable/disable allowing restricted users to change their password
able}
config-retrieve {none | read |
read-write}
Set the configuration retrieve settings for this profile. Select none to hide
this option from the administrator in the GUI. The following options are
available:
l
none: No permission.
l
read: Read permission.
l
read-write: Read-write permission.
This command corresponds to the Retrieve Configuration from Devices
option in the GUI administrator profile. This is a sub-setting of devicemanager.
Controlled functions: Retrieve configuration from devices
Dependencies: deploy-management must be set to read-write for
config-retrieve to be set to read-write, and type must be set to
system.
consistency-check {none |
read | read-write}
Configure Policy Check permissions for this profile. Select none to hide this
option from the administrator in the GUI. The following options are available:
l
none: No permission.
l
read: Read permission.
l
read-write: Read-write permission.
This command corresponds to the Policy Check option in the GUI administrator profile. This is a sub-setting of policy-objects.
Controlled functions: Policy check.
Dependencies: type must be set to system.
42
CLI Reference
Fortinet Technologies Inc.
admin
system
Variable
Description
deploy-management {none |
read | read-write}
Enter the level of access to the deployment management configuration settings for this profile. Select none to hide this option from the administrator
in the GUI. The following options are available:
l
none: No permission.
l
read: Read permission.
l
read-write: Read-write permission.
This command corresponds to the Install to Devices option in the GUI
administrator profile. This is a sub-setting of device-manager.
Controlled functions: Install to devices.
Dependencies: type must be set to system.
description <string>
Enter a description for this access profile. Enclose the description in quotes
if it contains spaces. Character limit: 1023
device-config {none | read |
read-write}
Enter the level of access to device configuration settings for this profile.
Select none to hide this option from the administrator in the GUI. The following options are available:
l
none: No permission.
l
read: Read permission.
l
read-write: Read-write permission.
This command corresponds to the Manage Device Configuration option in
the GUI administrator profile. This is a sub-setting of device-manager.
Controlled functions: Edit devices, All settings under Menu in Dashboard.
Dependencies: type must be set to system.
device-manager {none | read |
read-write}
Enter the level of access to Device Manager settings for this profile. Select
none to hide this option from the administrator in the GUI. The following
options are available:
l
none: No permission.
l
read: Read permission.
l
read-write: Read-write permission.
This command corresponds to the Device Manager option in the GUI
administrator profile.
Controlled functions: Device Manager tab.
Dependencies: type must be set to system.
device-op {none | read | readwrite}
Add the capability to add, delete, and edit devices to this profile. Select
none to hide this option from the administrator in the GUI. The following
options are available:
l
none: No permission.
l
read: Read permission.
l
read-write: Read-write permission.
This command corresponds to the Add/Delete Devices/Groups option in
the GUI administrator profile. This is a sub-setting of device-manager.
Controlled functions: Add or delete devices or groups.
Dependencies: type must be set to system.
CLI Reference
Fortinet Technologies Inc.
43
system
admin
Variable
Description
device-profile {none | read |
read-write}
Configure device profile permissions for this profile. Select none to hide
this option from the administrator in the GUI. The following options are
available:
l
none: No permission.
l
read: Read permission.
l
read-write: Read-write permission.
This command corresponds to the System Templates option in the GUI
administrator profile. This is a sub-setting of device-manager.
Controlled functions: Provisioning Templates.
Dependencies: type must be set to system.
event-management {none |
read | read-write}
Set the Event Management permission. Select none to hide this option
from the administrator in the GUI. The following options are available:
l
none: No permission.
l
read: Read permission.
read-write: Read-write permission.
This command corresponds to the Event Management option in the GUI
administrator profile.
Controlled functions: Event Management tab and all its operations.
Dependencies: faz-status must be set to enable in system global,
type must be set to system.
l
fgd_center {none | read | readwrite}
Set the FortiGuard Center permission. Select none to hide this option from
the administrator in the GUI. The following options are available:
l
none: No permission.
l
read: Read permission.
l
read-write: Read-write permission.
This command corresponds to the FortiGuard Center option in the GUI
administrator profile.
Controlled functions: FortiGuard tab, All the settings under FortiGuard.
Dependencies: type must be set to system.
global-policy-packages {none |
read | read-write}
Configure global policy package permissions for this profile. Select none to
hide this option from the administrator in the GUI. The following options are
available:
l
none: No permission.
l
read: Read permission.
l
read-write: Read-write permission.
This command corresponds to the Global Policy Packages & Objects
option in the GUI administrator profile. This is a sub-setting of policyobjects.
Controlled functions: All operations in Global ADOM.
Dependencies: type must be set to system.
44
CLI Reference
Fortinet Technologies Inc.
admin
system
Variable
Description
ips-filter {enable | disable}
Enable/disable Application Sensor permission for the restricted admin profile. Enter one of the following settings:
l
disable: Disable setting.
l
enable: Enable setting.
Dependencies: type must be set to restricted
log-viewer {none | read | readwrite}
Set the Log View permission. Select none to hide this option from the
administrator in the GUI. Enter one of the following settings:
l
none: No permission.
l
read: Read permission.
l
read-write: Read-write permission.
This command corresponds to the Log View option in the GUI administrator profile.
Controlled functions: Log View and all its operations.
Dependencies: faz-status must be set to enable in system global,
type must be set to system.
policy-objects {none | read |
read-write}
This command corresponds to the Policy & Objects option in the GUI administrator profile. Enter one of the following settings:
l
none: No permission.
l
read: Read permission.
read-write: Read-write permission.
Controlled functions: Policy & Objects tab
Dependencies: type must be set to system
l
read-passwd {none | read |
read-write}
Add the capability to view the authentication password in clear text to this
profile. Enter one of the following settings:
l
none: No permission.
l
read: Read permission.
read-write: Read-write permission.
Dependencies: type must be set to system.
l
realtime-monitor {none | read |
read-write}
Enter the level of access to the Drill Down configuration settings for this profile. Select none to hide this option from the administrator in the GUI.
Enter one of the following settings:
l
none: No permission.
l
read: Read permission.
l
read-write: Read-write permission.
This command corresponds to the Drill Down option in the GUI administrator profile.
Controlled functions: Drill Down tab and all its operations.
Dependencies: faz-status must be set to enable in system global,
type must be set to system.
CLI Reference
Fortinet Technologies Inc.
45
system
admin
Variable
Description
report-viewer {none | read |
read-write}
Set the Reports permission. Select none to hide this option from the administrator in the GUI. Enter one of the following settings:
l
none: No permission.
l
read: Read permission.
l
read-write: Read-write permission.
This command corresponds to the Reports option in the GUI administrator
profile.
Controlled functions: Reports tab and all its operations.
Dependencies: faz-status must be set to enable in system global,
type must be set to system.
scope (Not Applicable)
CLI command is not in use.
system-setting {none | read |
read-write}
Configure System Settings permissions for this profile. Select none to hide
this option from the administrator in the GUI. Enter one of the following settings:
l
none: No permission.
l
read: Read permission.
l
read-write: Read-write permission.
This command corresponds to the System Settings option in the GUI
administrator profile.
Controlled functions: System Settings tab, All the settings under System
setting.
Dependencies: type must be set to system.
term-access {none | read |
read-write}
Set the terminal access permissions for this profile. Select none to hide
this option from the administrator in the GUI. Enter one of the following settings:
l
none: No permission.
l
read: Read permission.
l
read-write: Read-write permission.
This command corresponds to the Terminal Access option in the GUI
administrator profile. This is a sub-setting of device-manager.
Controlled functions: Connect to the CLI via Telnet or SSH.
Dependencies: Depends on device-config option, type must be set
to system.
type {restricted | system}
Enter the admin profile type. One of:
l
restricted: Restricted admin profile
l
46
system: System admin profile
CLI Reference
Fortinet Technologies Inc.
admin
system
Variable
Description
vpn-manager {none | read |
read-write}
Enter the level of access to VPN console configuration settings for this profile. Select none to hide this option from the administrator in the GUI.
Enter one of the following settings:
l
none: No permission.
l
read: Read permission.
l
read-write: Read-write permission.
This command corresponds to the VPN Manager option in the GUI administrator profile. This is a sub-setting of policy-objects.
Controlled functions: VPN Console.
Dependencies: VPN Management must be configured as Central VPN Console at ADOM level, and must be enabled in System Settings > Admin settings, type must be set to system.
web-filter {enable | disable}
Enable/disable Web Filter Profile permission for the restricted admin profile. Enter one of the following settings:
l
disable: Disable setting.
l
enable: Enable setting.
Dependencies: type must be set to restricted.
workflow-approve {none | read | Set the workspace workflow permission to approve workflow session
read-write}
requests. Enter one of the following settings:
l
none: No permission.
l
read: Read permission.
read-write: Read-write permission.
Dependencies: type must be set to system.
l
admin radius
Use this command to add, edit, and delete administration RADIUS servers.
Syntax
config system admin radius
edit <server>
set auth-type {any | chap | mschap2 | pap}
set nas-ip <ipv4_address>
set port <integer>
set secondary-secret <passwd>
set secondary-server <string>
set secret <passwd>
set server <string>
end
Variable
Description
<server>
Enter the name of the RADIUS server or enter a new name to create an
entry. Character limit: 63
CLI Reference
Fortinet Technologies Inc.
47
system
admin
Variable
Description
auth-type {any | chap |
mschap2 | pap}
Enter the authentication protocol the RADIUS server will use.
l
any: Use any supported authentication protocol.
l
mschap2: Microsoft Challenge Handshake Authentication Protocol
version 2(MS-CHAPv2).
l
chap: Challenge Handshake Authentication Protocol (CHAP)
l
pap: Password Authentication Protocol (PAP).
nas-ip <ipv4_address>
Enter the network access server (NAS) IPv4 address and called station ID.
port <integer>
Enter the RADIUS server port number.Default: 1812. Range: 1 to 65535
secondary-secret <passwd>
Enter the password to access the RADIUS secondary-server. Character
limit: 64
secondary-server <string>
Enter the RADIUS secondary-server DNS resolvable domain name or IPv4
address.
secret <passwd>
Enter the password to access the RADIUS server. Character limit: 64
server <string>
Enter the RADIUS server DNS resolvable domain name or IPv4 address.
Example
This example shows how to add the RADIUS server RAID1 at the IPv4 address 206.205.204.203 and set the
shared secret as R1a2D3i4U5s.
config system admin radius
edit RAID1
set server 206.205.204.203
set secret R1a2D3i4U5s
end
admin setting
Use this command to configure system administration settings, including web administration ports, timeout, and
language.
Syntax
config
set
set
set
set
set
set
set
set
set
set
set
set
48
system admin setting
access-banner {enable | disable}
admin-https-redirect {enable | disable}
admin-login-max <integer>
admin_server_cert <admin_server_cert>
allow_register {enable | disable}
auto-update {enable | disable}
banner-message <string>
chassis-mgmt {enable | disable}
chassis-update-interval <integer>
device_sync_status {enable | disable}
http_port <integer>
https_port <integer>
CLI Reference
Fortinet Technologies Inc.
admin
system
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
idle_timeout <integer>
install-ifpolicy-only {enable | disable}
mgmt-addr <string>
mgmt-fqdn <string>
offline_mode {enable | disable}
register_passwd <passwd>
show-add-multiple {enable | disable}
show-adom-central-nat-policies {enable | disable}
show-adom-devman {enable | disable}
show-adom-dos-policies {enable | disable}
show-adom-dynamic-objects {enable | disable}
show-adom-icap-policies {enable | disable}
show-adom-implicit-policy {enable | disable}
show-adom-implicit-id-based-policy {enable | disable}
show-adom-ipv6-settings {enable | disable}
show-adom-policy-consistency-button {enable | disable}
show-adom-rtmlog {enable | disable}
show-adom-sniffer-policies {enable | disable}
show-adom-taskmon-button {enable | disable}
show-adom-terminal-button {enable | disable}
show-adom-voip-policies {enable | disable}
show-adom-vpnman {enable | disable}
show-device-import-export {enable | disable}
show-foc-settings {enable | disable}
show-fortimail-settings {enable | disable}
show-fsw-settings {enable | disable}
show-global-object-settings {enable | disable}
show-global-policy-settings {enable | disable}
show_automatic_script {enable | disable}
show-checkbox-in-table {enable | disable}
show_grouping_script {enable | disable}
show_schedule_script {enable | disable}
show_tcl_script {enable | disable}
unreg_dev_opt {add_allow_service | add_no_service | ignore}
webadmin_language {auto_detect | english | japanese | korean | simplified_
chinese | traditional_chinese}
end
Variable
Description
access-banner {enable | disable}
Enable/disable the access banner. Default: disable
admin-https-redirect {enable |
disable}
Enable/disable redirection of HTTP admin traffic to HTTPS.
admin-login-max <integer>
Set the maximum number of admin users that be logged in at one time.
Range: 1 to 256 (users)
admin_server_cert <admin_
server_cert>
Enter the name of an https server certificate to use for secure connections.
Default: server.crt
allow_register {enable | disable}
Enable/disable the ability an unregistered device to be registered. Default:
disable
CLI Reference
Fortinet Technologies Inc.
49
system
admin
Variable
Description
auto-update {enable | disable}
Enable/disable device config automatic update.
banner-message <string>
Set the banner messages.
Default: none
Character limit: 255
chassis-mgmt {enable | disable}
Enable/disable chassis management. Default: disable
chassis-update-interval
<integer>
Set the chassis background update interval. Range: 4 to 1440 minutes.
Default: 15
device_sync_status {enable |
disable}
Enable/disable device synchronization status indication. Default: enable
http_port <integer>
Enter the HTTP port number for web administration. Default: 80. Range: 1
to 65535
https_port <integer>
Enter the HTTPS port number for web administration. Default: 443.
Range: 1 to 65535
idle_timeout <integer>
Enter the idle timeout value. Range: 1 to 480 (minutes). Default: 5
install-ifpolicy-only {enable |
disable}
Enable to allow only the interface policy to be installed. The following
options are available:
l
disable: Disable setting.
l
enable: Enable setting.
Default: disable
mgmt-addr <string>
FQDN/IPv4 of FortiManager used by FGFM.
mgmt-fqdn <string>
FQDN of FortiManager used by FGFM.
offline_mode {enable | disable} Enable offline mode to shut down the protocol used to communicate with
managed devices. The following options are available:
l
disable: Disable offline mode.
l
enable: Enable offline mode.
Default: disable
register_passwd <passwd>
Enter the password to use when registering a device.
Character limit: 19
show-add-multiple {enable |
disable}
Show the add multiple button. The following options are available:
l
disable: Disable setting.
l
50
enable: Enable setting.
CLI Reference
Fortinet Technologies Inc.
admin
system
Variable
Description
show-adom-central-natpolicies {enable | disable}
Show central NAT policy settings on the GUI. The following options are
available:
l
disable: Hide central NAT policy settings on GUI.
l
enable: Show central NAT policy settings on GUI.
Default: disable
show-adom-devman
{enable | disable}
Show device manager tools on the GUI. The following options are available:
l
disable: Hide device manager tools on GUI.
l
enable: Show device manager tools on GUI.
Default: disable
show-adom-dos-policies
{enable | disable}
Show DOS policy settings on the GUI. The following options are available:
l
disable: Hide DoS policy settings on GUI.
l
enable: Show DoS policy settings on GUI.
Default: disable
show-adom-dynamic-objects
{enable | disable}
Show dynamic object settings on the GUI. The following options are available:
l
disable: Hide dynamic object settings on GUI.
l
enable: Show dynamic object settings on GUI.
Default: enable
show-adom-icap-policies
{enable | disable}
Show the ICAP policy settings in the GUI. The following options are available:
l
disable: Hide ICAP policy settings on GUI.
l
show-adom-implicit-policy
{enable | disable}
enable: Show ICAP policy settings on GUI.
Show the implicit policy settings in the GUI. The following options are available:
l
disable: Hide implicit policy settings on GUI.
l
enable: Show implicit policy settings on GUI.
show-adom-implicit-id-basedpolicy {enable | disable}
Show the implicit ID based policy settings in the GUI.
show-adom-ipv6-settings
{enable | disable}
Show IPv6 settings in the GUI. The following options are available:
l
disable: Hide IPv6 settings on GUI.
l
enable: Show IPv6 settings on GUI.
Default: disable
show-adom-policy-consistency-button {enable | disable}
Show banner button Policy Consistency in the GUI. The following options
are available:
l
disable: Hide banner button policy consistency on GUI.
l
enable: Show banner button policy consistency on GUI.
Default: disable
CLI Reference
Fortinet Technologies Inc.
51
system
admin
Variable
Description
show-adom-rtmlog {enable |
disable}
Show RTM device log in the GUI. The following options are available:
l
disable: Hide RTM device log on GUI.
l
enable: Show RTM device log on GUI.
Default: disable
show-adom-sniffer-policies
{enable | disable}
Show sniffer policy settings in the GUI. The following options are available:
l
disable: Hide sniffer policy settings on GUI.
l
enable: Show sniffer policy settings on GUI.
Default: disable
show-adom-taskmon-button
{enable | disable}
Show banner button Task Monitor in the GUI. The following options are
available:
l
disable: Hide banner button task monitor on GUI.
l
enable: Show banner button task monitor on GUI.
Default: enable
show-adom-terminal-button
{enable | disable}
Show banner button Terminal in the GUI. The following options are available:
l
disable: Hide banner button terminal on GUI.
l
enable: Show banner button terminal on GUI.
Default: enable
show-adom-voip-policies
{enable | disable}
Show VoIP policy settings in the GUI. The following options are available:
l
disable: Hide VoIP policy settings on GUI.
l
show-adom-vpnman {enable |
disable}
enable: Show VoIP policy settings on GUI.
Show VPN manager in the GUI. The following options are available:
l
disable: Hide VPN manager on GUI.
l
enable: Show VPN manager on GUI.
Default: enable
show-checkbox-in-table
{enable | disable}
Show checkboxes in tables in the GUI.
show-device-import-export
{enable | disable}
Enable import/export of ADOM, device, and group lists. The following
options are available:
l
disable: Disable setting.
l
enable: Enable setting.
show-foc-settings {enable | dis- Show FortiCarrier settings in the GUI. The following options are available:
l
disable: Hide FortiCarrier settings on GUI.
able}
l
enable: Show FortiCarrier settings on GUI.
Default: disable
show-fortimail-settings
{enable | disable}
Show FortiMail settings in the GUI. The following options are available:
l
disable: Hide FortiMail settings on GUI.
l
enable: Show FortiMail settings on GUI.
Default: disable
52
CLI Reference
Fortinet Technologies Inc.
admin
Variable
system
Description
show-fsw-settings {enable | dis- Show FortiSwitch settings in the GUI. The following options are available:
l
disable: Hide FortiSwitch settings on GUI.
able}
l
enable: Show FortiSwitch settings on GUI.
Default: disable
show-global-object-settings
{enable | disable}
Show global object settings in the GUI. The following options are available:
l
disable: Hide global objects settings on GUI.
l
enable: Show global objects settings on GUI.
Default: enable
show-global-policy-settings
{enable | disable}
Show global policy settings in the GUI. The following options are available:
l
disable: Hide global policy settings on GUI.
l
enable: Show global policy settings on GUI.
Default: enable
show_automatic_script
{enable | disable}
Enable/disable automatic script. The following options are available:
l
disable: Disable script option.
l
enable: Enable script option.
show_grouping_script {enable | Enable/disable grouping script. The following options are available:
l
disable: Disable script option.
disable}
l
show_schedule_script
{enable | disable}
Enable/disable schedule script. The following options are available:
l
disable: Disable script option.
l
show_tcl_script {enable | disable}
enable: Enable script option.
Select action to take when an unregistered device connects to FortiManager. The following options are available:
l
add_allow_service: Add unregistered devices and allow
service requests (default value).
l
l
webadmin_language {auto_
detect | english | japanese |
korean | simplified_chinese |
traditional_chinese}
enable: Enable script option.
Enable/disable TCL script. The following options are available:
l
disable: Disable script option.
l
unreg_dev_opt {add_allow_
service | add_no_service |
ignore}
enable: Enable script option.
add_no_service: Add unregistered devices and deny service
requests.
ignore: Ignore unregistered devices.
Select the language to be used for web administration. The following
options are available:
l
auto_detect: Automatically detect language.
l
english: English.
l
japanese: Japanese.
l
korean: Korean.
l
simplified_chinese: Simplified Chinese.
l
traditional_chinese: Traditional Chinese.
Default: auto_detect
CLI Reference
Fortinet Technologies Inc.
53
system
admin
admin tacacs
Use this command to add, edit, and delete administration TACACS+ servers.
Syntax
config system admin tacacs
edit <name>
set authen-type {ascii | auto |chap | mschap | pap}
set authorization {enable | disable}
set key <passwd>
set port <integer>
set secondary-key <passwd>
set secondary-server <string>
set server <string>
set tertiary-key <passwd>
set tertiary-server <string>
end
Variable
Description
<name>
Enter the name of the TACACS+ server or enter a new name to create an
entry. Character limit: 63
authen-type {ascii | auto |chap | Choose which authentication type to use. The following options are availmschap | pap}
able:
l
ascii: ASCII
l
auto: Uses PAP, MSCHAP, and CHAP (in that order) (default).
l
chap: Challenge Handshake Authentication Protocol (CHAP)
l
l
authorization {enable | disable}
pap: Password Authentication Protocol (PAP).
Enable/disable TACACS+ authorization. The following options are available:
l
disable: Disable TACACS+ authorization.
l
54
mschap: Microsoft Challenge Handshake Authentication Protocol
(MS-CHAP)
enable: Enable TACACS+ authorization (service = FortiGate).
key <passwd>
Key to access the server. Character limit: 128
port <integer>
Port number of the TACACS+ server. Range: 1 to 65535
secondary-key <passwd>
Key to access the secondary server. Character limit: 128
secondary-server <string>
Secondary server domain name or IPv4 address.
server <string>
The server domain name or IPv4 address.
tertiary-key <passwd>
Key to access the tertiary server. Character limit: 128
tertiary-server <string>
Tertiary server domain name or IPv4 address.
CLI Reference
Fortinet Technologies Inc.
admin
system
Example
This example shows how to add the TACACS+ server TAC1 at the IPv4 address 206.205.204.203 and set the
key as R1a2D3i4U5s.
config system admin tacacs
edit TAC1
set server 206.205.204.203
set key R1a2D3i4U5s
end
admin user
Use this command to add, edit, and delete administrator accounts.
Use the admin account or an account with System Settings read and write privileges to add new administrator
accounts and control their permission levels. Each administrator account must include a minimum of an access
profile. The access profile list is ordered alphabetically, capitals first. If custom profiles are defined, it may change
the default profile from Restricted_User. You cannot delete the admin administrator account. You cannot delete
an administrator account if that user is logged on.
You can create meta-data fields for administrator accounts. These objects must be created using the FortiManager GUI. The only information you can add to the object is
the value of the field (pre-determined text/numbers). For more information, see System Settings in the FortiManager Administration Guide.
Syntax
config system admin user
edit <name_str>
set password <passwd>
set change-password {enable | disable}
set trusthost1 <ipv4_mask>
set trusthost2 <ipv4_mask>
set trusthost3 <ipv4_mask>
...
set trusthost10 <ipv4_mask>
set ipv6_trusthost1 <ipv6_mask>
set ipv6_trusthost2 <ipv6_mask>
set ipv6_trusthost3 <ipv6_mask>
...
set ipv6_trusthost10 <ipv6_mask>
set profileid <profile-name>
set adom <adom_name(s)>
set web-filter <Web Filter profile name>
set ips-filter <IPS Sensor name>
set app-filter <Application Sensor name>
set policy-package {<adom name>: <policy package id> <adom policy folder name>/
<package name> | all_policy_packages}
set restrict-access {enable | disable}
set rpc-permit {none | read-only | read-write}
set description <string>
set user_type {group | ldap | local | pki-auth | radius | tacacs-plus}
set group <string>
set ldap-server <string>
set radius_server <string>
CLI Reference
Fortinet Technologies Inc.
55
system
admin
set tacacs-plus-server <string>
set ssh-public-key1 <key-type> <key-value>
set ssh-public-key2 <key-type>, <key-value>
set ssh-public-key3 <key-type> <key-value>
set wildcard <enable | disable>
set radius-accprofile-override <enable | disable>
set radius-adom-override <enable | disable>
set radius-group-match <string>
set password-expire <yyyy-mm-dd>
set force-password-change {enable | disable}
set subject <string>
set ca <string>
set two-factor-auth {enable | disable}
set last-name <string>
set first-name <string>
set email-address <string>
set phone-number <string>
set mobile-number <string>
set pager-number <string>
end
config meta-data
edit <fieldname>
set fieldlength
set fieldvalue <string>
set importance
set status
end
end
config dashboard-tabs
edit tabid <integer>
set name <string>
end
end
config dashboard
edit moduleid
set name <string>
set column <column_pos>
set refresh-inverval <integer>
set status {close | open}
set tabid <integer>
set widget-type <string>
set log-rate-type {device | log}
set log-rate-topn {1 | 2 | 3 | 4 | 5}
set log-rate-period {1hour | 2min | 6hours}
set res-view-type {history | real-time}
set res-period {10min | day | hour}
set res-cpu-display {average | each}
set num-entries <integer>
set time-period
end
end
config restrict-dev-vdom
edit dev-vdom <string>
end
end
56
CLI Reference
Fortinet Technologies Inc.
admin
system
Variable
Description
<name_string>
Enter the name of the admin user or enter a new name to create a new
user. Character limit: 35
password <passwd>
Enter a password for the administrator account. For improved security, the
password should be at least 6 characters long. This variable is available
only if user_type is local. Character limit: 128
change-password {enable | dis- Enable/disable allowing restricted users to change their password.
able}
trusthost1 <ipv4_mask>
trusthost2 <ipv4_mask>
trusthost3 <ipv4_mask>
...
trusthost10 <ipv4_mask>
Optionally, type the trusted host IPv4 address and network mask from
which the administrator can log in to the FortiManager system. You can specify up to ten trusted hosts. Setting trusted hosts for all of your administrators can enhance the security of your system. .
Defaults:
trusthost1: 0.0.0.0 0.0.0.0 for all
others: 255.255.255.255 255.255.255.255 for none
ipv6_trusthost1 <ipv6_mask>
ipv6_trusthost2 <ipv6_mask>
ipv6_trusthost3 <ipv6_mask>
...
ipv6_trusthost10 <ipv6_mask>
Optionally, type the trusted host IPv6 address from which the administrator
can log in to the FortiManager system. You can specify up to ten trusted
hosts. Setting trusted hosts for all of your administrators can enhance the
security of your system.
Defaults:
ipv6_trusthost1: ::/0 for all
others: ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for
none
profileid <profile-name>
Enter the name of the access profile to assign to this administrator account.
Access profiles control administrator access to FortiManager features.
Default: Restricted_User. Character limit: 35
adom <adom_name(s)>
Enter the name(s) of the ADOM(s) the administrator belongs to. Any configuration of ADOMs takes place via the FortiManager GUI.
web-filter <Web Filter profile
name>
Enter the Web Filter profile to associate with the restricted admin profile.
Dependencies: admin user must be associated with a restricted admin profile.
ips-filter <IPS Sensor name>
Enter the IPS Sensor to associate with the restricted admin profile.
Dependencies: The admin user must be associated with a restricted admin
profile.
app-filter <Application Sensor
name>
Enter the Application Sensor to associate with the restricted admin profile.
Dependencies: The admin user must be associated with a restricted admin
profile.
CLI Reference
Fortinet Technologies Inc.
57
system
admin
Variable
Description
policy-package
{<adom name>: <policy package id> <adom policy folder
name>/ <package name> | all_
policy_packages}
Policy package access
restrict-access {enable | disable}
Enable/disable restricted access to the development VDOM (dev-vdom).
Default: disable
rpc-permit {none | read-only |
read-write}
Set the permission level for login via Remote Procedure Call (RPC). The following options are available:
l
none: No permission.
l
read-only: Read-only permission.
l
read-write: Read-write permission (default).
description <string>
Enter a description for this administrator account. When using spaces,
enclose description in quotes.
Character limit: 127
user_type {group | ldap | local |
pki-auth | radius | tacacs-plus}
Enter local if the FortiManager system verifies the administrator’s password. Enter radius if a RADIUS server verifies the administrator’s password. Enter of the following:
l
group: Group user.
l
ldap: LDAP user.
l
local: Local user.
l
pki-auth: PKI user.
l
radius: RADIUS user.
l
tacacs-plus: TACACS+ user.
Default: local
set group <string>
Enter the group name.
ldap-server <string>
Enter the LDAP server name if the user type is set to LDAP.
radius_server <string>
Enter the RADIUS server name if the user type is set t o RADIUS.
tacacs-plus-server <string>
Enter the TACACS+ server name if the user type is set to TACACS+.
ssh-public-key1 <key-type>
<key-value>
You can specify the public keys of up to three SSH clients. These clients are
authenticated without being asked for the administrator password. You
must create the public-private key pair in the SSH client application.
<key type> is ssh-dss for a DSA key, ssh-rsa for an RSA key.
<key-value> is the public key string of the SSH client.
ssh-public-key2 <key-type>,
<key-value>
ssh-public-key3 <key-type>
<key-value>
58
CLI Reference
Fortinet Technologies Inc.
admin
system
Variable
Description
wildcard <enable | disable>
Enable/disable wildcard remote authentication. The following options are
available:
l
disable: Disable username wildcard.
l
radius-accprofile-override
<enable | disable>
Allow access profile to be overridden from RADIUS. The following options
are available:
l
disable: Disable access profile override.
l
radius-adom-override
<enable | disable>
enable: Enable username wildcard.
enable: Enable access profile override.
Enable/disable the ADOM to be overridden from RADIUS. The following
options are available:
l
disable: Disable ADOM override.
l
enable: Enable ADOM override.
In order to support vendor specific attributes (VSA), the RADIUS server
requires a dictionary to define which VSAs to support. The Fortinet RADIUS
vendor ID is 12365. The Fortinet-Vdom-Name attribute is used by this
command.
radius-group-match <string>
Only admin that belong to this group are allowed to login.
password-expire <yyyy-mmdd>
When enforcing the password policy, enter the date that the current password will expire.
force-password-change
{enable | disable}
Enable/disable force password change on next login.
subject <string>
PKI user certificate name constraints. This command is available when a
PKI administrator account is configured.
ca <string>
PKI user certificate CA (CA name in local). This command is available when
a PKI administrator account is configured.
two-factor-auth {enable | disable}
Enable/disable two-factor authentication (certificate + password). The following options are available:
l
disable: Disable 2-factor authentication.
l
enable: Enable 2-factor authentication.
This command is available when a PKI administrator account is configured.
last-name <string>
Administrators last name. Character limit: 63
first-name <string>
Administrators first name. Character limit: 63
email-address <string>
Administrators email address.
phone-number <string>
Administrators phone number.
mobile-number <string>
Administrators mobile phone number.
CLI Reference
Fortinet Technologies Inc.
59
system
admin
Variable
Description
pager-number <string>
Administrators pager number.
Variables for config meta-data subcommand:
This subcommand can only change the value of an existing field. To create a new metadata field,
use the config metadata command.
fieldname
The label/name of the field. Read-only. Default: 50
fieldlength
The maximum number of characters allowed for this field. Read-only.
fieldvalue <string>
Enter a pre-determined value for the field. This is the only value that can be
changed with the config meta-data subcommand. Character limit:
255
importance
Indicates whether the field is compulsory (required) or optional
(optional). Read-only. Default: optional
status
For display only. Value cannot be changed. Default: enable
Variables for config dashboard-tabs subcommand:
tabid <integer>
Tab ID.
name <string>
Tab name.
Variables for config dashboard subcommand:
moduleid
60
Widget ID.
l
1: System Information
l
2: System Resources
l
3: License Information
l
4: Unit Operation
l
5: Log Receive Monitor
l
6: Logs/Data Received
l
7: Statistics
l
8: Insert Rate vs Receive Rate
l
9: Log Insert Lag Time
l
10: Alert Message Console
l
11: CLI Console
name <string>
Widget name. Character limit: 63
column <column_pos>
Widget’s column ID.
refresh-inverval <integer>
Widget’s refresh interval. Default: 300
status {close | open}
Widget’s opened/closed status. Default: open
CLI Reference
Fortinet Technologies Inc.
admin
system
Variable
Description
tabid <integer>
ID of the tab where the widget is displayed. Default: 0
widget-type <string>
Widget type. The following options are available:
l
alert: Alert Message Console.
l
devsummary: Device Summary.
l
jsconsole: CLI Console.
l
licinfo: License Information.
l
logdb-lag: Log Database Lag Time.
l
logdb-perf: Log Database Performance Monitor.
l
logrecv: Logs/Data Received.
l
raid: Disk Monitor.
l
rpteng: Report Engine.
l
statistics: Statistics.
l
sysinfo: System Information.
l
sysop: Unit Operation.
l
sysres: System resources.
l
top-lograte: Log Receive Monitor.
log-rate-type {device | log}
Log receive monitor widget’s statistics breakdown options.
log-rate-topn {1 | 2 | 3 | 4 | 5}
Log receive monitor widgets’s number of top items to display.
log-rate-period {1hour | 2min |
6hours}
Log receive monitor widget’s data period.
res-view-type {history | realtime}
Widget’s data view type. The following options are available:
l
history: History view.
l
res-period {10min | day | hour}
res-cpu-display {average |
each}
real-time: Real-time view.
Widget’s data period. The following options are available:
l
10min: Last 10 minutes.
l
day: Last day.
l
hour: Last hour.
Widget’s CPU display type. The following options are available:
l
average: Average usage of CPU.
l
each: Each usage of CPU.
num-entries <integer>
Number of entries.
time-period {1hour | 24hour |
8hour}
Set the Log Database Monitor widget's data period. One of 1 hour, 8 hours,
or 24 hours.
Variable for config restrict-dev-vdom subcommand:
dev-vdom <string>
CLI Reference
Fortinet Technologies Inc.
Enter device or VDOM to edit.
61
system
alert-console
Using trusted hosts
Setting trusted hosts for all of your administrators increases the security of your network by further restricting
administrative access. In addition to knowing the password, an administrator must connect only through the
subnet or subnets you specify. You can even restrict an administrator to a single IPv4 address if you define only
one trusted host IPv4 address with a netmask of 255.255.255.255.
When you set trusted hosts for all administrators, the FortiManager system does not respond to administrative
access attempts from any other hosts. This provides the highest security. If you leave even one administrator
unrestricted, the unit accepts administrative access attempts on any interface that has administrative access
enabled, potentially exposing the unit to attempts to gain unauthorized access.
The trusted hosts you define apply both to the GUI and to the CLI when accessed through SSH. CLI access
through the console connector is not affected.
Example
Use the following commands to add a new administrator account named admin_2 with the password set to
p8ssw0rd and the Super_User access profile. Administrators that log in to this account will have
administrator access to the FortiManager system from any IPv4 address.
config system admin user
edit admin_2
set description "Backup administrator"
set password p8ssw0rd
set profileid Super_User
end
alert-console
Use this command to configure the alert console options. The alert console appears on the dashboard in the GUI.
Syntax
config system alert-console
set period {1 | 2 | 3 | 4 | 5 | 6 | 7}>
set severity-level {information | notify | warning | error | critical | alert |
emergency}
end
62
Variable
Description
period {1 | 2 | 3 | 4 | 5 | 6 | 7}>
Enter the number of days to keep the alert console information on the dashboard.
l
1: 1 day.
l
2: 2 days.
l
3: 3 days.
l
4: 4 days.
l
5: 5 days.
l
6: 6 days.
l
7: 7 days (default).
CLI Reference
Fortinet Technologies Inc.
alert-event
system
Variable
Description
severity-level {information |
notify | warning | error | critical |
alert | emergency}
Enter the severity level to display on the alert console on the dashboard.
The following options are available:
l
emergency: The unit is unusable.
l
alert: Immediate action is required.
l
critical: Functionality is affected.
l
error: Functionality is probably affected.
l
warning: Functionality might be affected.
l
notification: Information about normal events.
l
information: General information about unit operations.
Example
This example sets the alert console message display to warning for a duration of three days.
config system alert-console
set period 3
set severity-level warning
end
alert-event
Use alert-event commands to configure the FortiManager unit to monitor logs for log messages with certain
severity levels, or information within the logs. If the message appears in the logs, the FortiManager unit sends an
email or SNMP trap to a predefined recipient(s) of the log message encountered. Alert event messages provide
immediate notification of issues occurring on the FortiManager unit.
When configuring an alert email, you must configure at least one DNS server. The FortiGate unit uses the SMTP
server name to connect to the mail server and must look up this name on your DNS server.
alert-event was removed from the GUI in FortiManager version 5.0.3. This command has been kept in the CLI for customers who previously configured this function.
Syntax
config system alert-event
edit <name_string>
config alert-destination
edit destination_id <integer>
set type {mail | snmp | syslog}
set from <email_address>
set to <email_address>
set smtp-name <server_name>
set snmp-name <server_name>
set syslog-name <server_name>
end
set enable-generic-text {enable | disable}
set enable-severity-filter {enable | disable}
set event-time-period {0.5 | 1 | 3 | 6 | 12 | 24 | 72 | 168}
set generic-text <string>
CLI Reference
Fortinet Technologies Inc.
63
system
alert-event
set
set
set
set
num-events {1 | 5 | 10 | 50 | 100}
severity-filter {high | low | medium | medium-high | medium-low}
severity-level-comp {>= | = | <=}
severity-level-logs {no-check | information | notify | warning |error |
critical | alert | emergency}
end
64
Variable
Description
<name_string>
Enter a name for the alert event. Character limit: 63
destination_id <integer>
Enter the table sequence number, beginning at 1.
type {mail | snmp | syslog}
Select the alert event message method of delivery. The following options
are available:
l
mail: Send email alert (default).
l
snmp: Send SNMP trap.
l
syslog: Send syslog message.
from <email_address>
Enter the email address of the sender of the message. This is available
when the type is set to mail.
to <email_address>
Enter the recipient of the alert message. This is available when the type is
set to mail.
smtp-name <server_name>
Enter the name of the mail server. This is available when the type is set to
mail.
snmp-name <server_name>
Enter the snmp server name. This is available when the type is set to
snmp.
syslog-name <server_name>
Enter the syslog server name or IPv4 address. This is available when the
type is set to syslog.
enable-generic-text {enable |
disable}
Enable the text alert option. Default: disable
enable-severity-filter {enable |
disable}
Enable the severity filter option. Default: disable
event-time-period {0.5 | 1 | 3 |
6 | 12 | 24 | 72 | 168}
The period of time in hours during which if the threshold number is
exceeded, the event will be reported. The following options are available:
l
0.5: 30 minutes.
l
1: 1 hour.
l
3: 3 hours.
l
6: 6 hours.
l
12: 12 hours.
l
24: 1 day.
l
72: 3 days.
l
168: 1 week.
CLI Reference
Fortinet Technologies Inc.
alert-event
system
Variable
Description
generic-text <string>
Enter the text the alert looks for in the log messages. Character limit: 255
num-events {1 | 5 | 10 | 50 |
100}
Set the number of events that must occur in the given interval before it is
reported.
severity-filter {high | low |
medium | medium-high |
medium-low}
Set the alert severity indicator for the alert message the FortiManager unit
sends to the recipient. The following options are available:
l
high: High level alert.
l
low: Low level alert.
l
medium: Medium level alert.
l
medium-high: Medium-high level alert.
l
medium-low: Medium-low level alert.
severity-level-comp {>= | = | <=} Set the severity level in relation to the log level. Log messages are monitored based on the log level. For example, alerts may be monitored if the
messages are greater than, and equal to (>=) the Warning log level. The following options are available:
l
>=: Greater than or equal to.
severity-level-logs {no-check |
information | notify |
warning |error | critical | alert |
emergency}
l
=: Equal to.
l
<=: Less than or equal to.
Set the log level the FortiManager looks for when monitoring for alert messages. The following options are available:
l
no-check: Do not check severity level for this log type.
l
emergency: The unit is unusable.
l
alert: Immediate action is required.
l
critical: Functionality is affected.
l
error: Functionality is probably affected.
l
warning: Functionality might be affected.
l
notification: Information about normal events.
l
information: General information about unit operations.
Example
In the following example, the alert message is set to send an email to the administrator when 5 warning log
messages appear over the span of three hours.
config system alert-event
edit warning
config alert-destination
edit 1
set type mail
set from fmgr@exmample.com
set to admin@example.com
set smtp-name mail.example.com
end
set enable-severity-filter enable
set event-time-period 3
set severity-level-log warning
CLI Reference
Fortinet Technologies Inc.
65
system
alertemail
set severity-level-comp =
set severity-filter medium
end
alertemail
Use this command to configure alert email settings for your FortiManager unit.
All variables are required if authentication is enabled.
Syntax
config
set
set
set
set
set
set
set
end
system alertemail
authentication {enable | disable}
fromaddress <email-address_string>
fromname <string>
smtppassword <passwd>
smtpport <integer>
smtpserver {<ipv4_address>|<fqdn_string>}
smtpuser <username>
Variable
Description
authentication {enable | disable}
Enable/disable alert email authentication. Default: enable
fromaddress <email-address_
string>
The email address the alertmessage is from. This is a required variable.
fromname <string>
The SMTP name associated with the email address. To enter a name that
includes spaces, enclose the whole name in quotes.
smtppassword <passwd>
Set the SMTP server password. Character limit: 39
smtpport <integer>
The SMTP server port. Default: 25. Range: 1 to 65535
smtpserver {<ipv4_
address>|<fqdn_string>}
The SMTP server address. Enter either a DNS resolvable host name or an
IPv4 address.
smtpuser <username>
Set the SMTP server username. Character limit: 63
Example
Here is an example of configuring alertemail. Enable authentication, the alert is set in Mr. Customer’s name
and from his email address, the SMTP server port is the default port(25), and the SMTP server is at IPv4 address
of 192.168.10.10.
config
set
set
set
set
set
end
66
system alertemail
authentication enable
fromaddress customer@example.com
fromname “Mr. Customer”
smtpport 25
smtpserver 192.168.10.10
CLI Reference
Fortinet Technologies Inc.
auto-delete
system
auto-delete
Use this command to automatically delete policies for logs, reports, and archived and quarantined files.
Syntax
config system auto-delete
config dlp-files-auto-deletion
set status {enable | disable}
set value <integer>
set when {days | hours | months | weeks}
end
config quarantine-files-auto-deletion
set status {enable | disable}
set value <integer>
set when {days | hours | months | weeks}
end
config log-auto-deletion
set status {enable | disable}
set value <integer>
set when {days | hours | months | weeks}
end
config report-auto-deletion
set status {enable | disable}
set value <integer>
set when {days | hours | months | weeks}
end
end
Variable
Description
dlp-files-auto-deletion
Automatic deletion policy for DLP archives.
quarantine-files-auto-deletion
Automatic deletion policy for quarantined files.
log-auto-deletion
Automatic deletion policy for device logs.
report-auto-deletion
Automatic deletion policy for reports.
status {enable | disable}
Enable/disable automatic deletion.
value <integer>
Set the value integer. Range: 1 to 999
when {days | hours | months |
weeks}
Auto-delete data older that <value> days, hours, months, weeks. The following options are available:
l
days: Auto-delete data older than <value> days.
CLI Reference
Fortinet Technologies Inc.
l
hours: Auto-delete data older than <value> hours.
l
months: Auto-delete data older than <value> months.
l
weeks: Auto-delete data older than <value> weeks.
67
system
backup all-settings
backup all-settings
Use this command to set or check the settings for scheduled backups.
Syntax
config
set
set
set
set
set
set
set
set
set
set
end
system backup all-settings
status {enable | disable}
server {<ipv4_address>|<fqdn_str>}
user <username>
directory <string>
week_days {monday tuesday wednesday thursday friday saturday sunday}
time <hh:mm:ss>
protocol {ftp | scp | sftp}
passwd <passwd>
cert <string>
crptpasswd <passwd>
Variable
Description
status {enable | disable}
Enable/disable scheduled backups. Default: disable
server {<ipv4_address>|<fqdn_
str>}
Enter the IPv4 address or DNS resolvable host name of the backup server.
user <username>
Enter the user account name for the backup server. Character limit: 63
directory <string>
Enter the name of the directory on the backup server in which to save the
backup file.
week_days {monday tuesday
Enter the days of the week on which to perform backups. You may enter
wednesday thursday friday sat- multiple days.
urday sunday}
time <hh:mm:ss>
Enter the time of day to perform the backup. Time is required in the form
<hh:mm:ss>.
protocol {ftp | scp | sftp}
Enter the transfer protocol: ftp, scp, or sftp (default).
passwd <passwd>
Enter the password for the backup server. Character limit: 63
cert <string>
SSH certificate for authentication. Only available if the protocol is set to
scp.
crptpasswd <passwd>
Optional password to protect backup content. Character limit: 63
Example
This example shows a whack where backup server is 172.20.120.11 using the admin account with no password,
saving to the /usr/local/backup directory. Backups are done on Mondays at 1:00pm using ftp.
config system backup all-settings
set status enable
68
CLI Reference
Fortinet Technologies Inc.
certificate
system
set
set
set
set
set
set
end
server 172.20.120.11
user admin
directory /usr/local/backup
week_days monday
time 13:00:00
protocol ftp
certificate
Use the following commands to configure certificate related settings.
certificate ca
Use this command to install Certificate Authority (CA) root certificates.
When a CA processes your Certificate Signing Request (CSR), it sends you the CA certificate, the signed local
certificate and the Certificate Revocation List (CRL).
The process for obtaining and installing certificates is as follows:
1. Use the execute certificate local generate command to generate a CSR.
2. Send the CSR to a CA. he CA sends you the CA certificate, the signed local certificate and the CRL.
3. Use the system certificate local command to install the signed local certificate.
4. Use the system certificate ca command to install the CA certificate. Depending on your terminal
software, you can copy the certificate and paste it into the command.
Syntax
config system certificate ca
edit <ca_name>
set ca <certificate>
set comment <string>
end
To view all of the information about the certificate, use the get command:
get system certificate ca <ca_name>
Variable
Description
<ca_name>
Enter a name for the CA certificate. Character limit: 35
ca <certificate>
Enter or retrieve the CA certificate in PEM format.
comment <string>
Optionally, enter a descriptive comment. Character limit: 127
certificate crl
Use this command to configure CRLs.
CLI Reference
Fortinet Technologies Inc.
69
system
certificate
Syntax
config system certificate crl
edit <name>
set crl <crl>
set comment <string>
end
Variable
Description
<name>
Enter a name for the CRL. Character limit: 35
crl <crl>
Enter or retrieve the CRL in PEM format.
comment <string>
Optionally, enter a descriptive comment for this CRL. Character limit: 127
certificate local
Use this command to install local certificates. When a CA processes your CSR, it sends you the CA certificate,
the signed local certificate and the CRL.
The process for obtaining and installing certificates is as follows:
1. Use the execute certificate local generate command to generate a CSR.
2. Send the CSR to a CA. The CA sends you the CA certificate, the signed local certificate and the CRL.
3. Use the system certificate local command to install the signed local certificate.
4. Use the system certificate ca command to install the CA certificate. Depending on your terminal
software, you can copy the certificate and paste it into the command.
Syntax
config system certificate local
edit <cert_name>
set password <passwd>
set comment <string>
set certificate <certificate_PEM>
set private-key <prkey>
set csr <csr_PEM>
end
To view all of the information about the certificate, use the get command:
get system certificate local [cert_name]
70
Variable
Description
<cert_name>
Enter the local certificate name. Character limit: 35
password <passwd>
Enter the local certificate password. Character limit: 67
comment <string>
Enter any relevant information about the certificate. Character length: 127
certificate <certificate_PEM>
Enter the signed local certificate in PEM format.
CLI Reference
Fortinet Technologies Inc.
certificate
system
Variable
Description
You should not modify the following variables if you generated the CSR on this unit.
private-key <prkey>
The private key in PEM format.
csr <csr_PEM>
The CSR in PEM format.
certificate oftp
Use this command to install OFTP certificates and keys.
Syntax
config system certificate oftp
set certificate <certificate>
set comment <string>
set custom {enable | disable}
set private-key <key>
end
Variable
Description
certificate <certificate>
PEM format certificate.
comment <string>
OFTP certificate comment. Character limit: 127
custom {enable | disable}
Enable/disable custom certificates.
private-key <key>
PEM format private key.
certificate ssh
Use this command to install SSH certificates and keys.
The process for obtaining and installing certificates is as follows:
1. Use the execute certificate local generate command to generate a CSR.
2. Send the CSR to a CA. The CA sends you the CA certificate, the signed local certificate and the CRL.
3. Use the system certificate local command to install the signed local certificate.
4. Use the system certificate ca command to install the CA certificate.
5. Use the system certificate SSH command to install the SSH certificate. Depending on your terminal
software, you can copy the certificate and paste it into the command.
Syntax
config system certificate ssh
edit <name>
set comment <comment_text>
set certificate <certificate>
set private-key <key>
end
CLI Reference
Fortinet Technologies Inc.
71
system
dm
To view all of the information about the certificate, use the get command:
get system certificate ssh [cert_name]
Variable
Description
<name>
Enter the SSH certificate name. Character limit: 63
comment <comment_text>
Enter any relevant information about the certificate. Character limit: 127
certificate <certificate>
Enter the signed SSH certificate in PEM format.
You should not modify the following variables if you generated the CSR on this unit.
private-key <key>
The private key in PEM format.
dm
Use this command to configure Deployment Manager (DM) settings.
Syntax
config
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
end
72
system dm
concurrent-install-limit <integer>
concurrent-install-script-limit <integer>
discover-timeout <integer>
dpm-logsize <integer>
fgfm-sock-timeout <integer>
fgfm_keepalive_itvl <integer>
force-remote-diff {enable | disable}
fortiap-refresh-itvl <integer>
max-revs <integer>
nr-retry <integer>
retry {enable | disable}
retry-intvl <integer>
rollback-allow-reboot {enable | disable}
script-logsize <integer>
verify-install {enable | disable | optimal}
Variable
Description
concurrent-install-limit
<integer>
The maximum number of concurrent installs. Range: 5 to 500 . Default: 60
concurrent-install-script-limit
<integer>
The maximum number of concurrent install scripts. Range: 5 to 100 .
Default: 60
discover-timeout <integer>
Check connection timeout when discovering a device. Range: 3 to 15
dpm-logsize <integer>
The maximum DPM log size per device. Range: 1 to 10000 (kB). Default:
10000
CLI Reference
Fortinet Technologies Inc.
dns
system
Variable
Description
fgfm-sock-timeout <integer>
The maximum FortiManager /FortiGate communication socket idle time.
Range: 90 to 1800 (seconds). Default: 900
fgfm_keepalive_itvl <integer>
The interval at which the FortiManager will send a keepalive signal to a
FortiGate unit to keep the FortiManager /FortiGate communication protocol active. Range: 30 to 600 (seconds). Default: 300
force-remote-diff {enable | disable}
Enable to always use remote diff when installing. Default: disable
fortiap-refresh-itvl <integer>
Auto refresh FortiAP status interval. Range: 1 to 1440 (minutes)
max-revs <integer>
The maximum number of revisions saved. Range: 1 to 250. Default: 100
nr-retry <integer>
The number of times the FortiManager unit will retry. Default: 1
retry {enable | disable}
Enable/disable configuration installation retries. Default: enable
retry-intvl <integer>
The interval between attempting another configuration installation following a failed attempt. Default: 15
rollback-allow-reboot {enable |
disable}
Enable/disable allowing a FortiGate unit to reboot when installing a script or
configuration. Default: disable
script-logsize <integer>
Enter the maximum script log size per device. Range: 1 to 10000 (kB.
verify-install {enable | disable |
optimal}
Enable/disable verify install against remote configuration. The following
options are available:
l
disable: Disable.
l
enable: Always verify installation (default).
l
optimal: Verify installation for command errors.
Example
This example shows how to set up configuration installations. It shows how to set 5 attempts to install a
configuration on a FortiGate device, waiting 30 seconds between attempts.
config
set
set
set
end
system dm
retry enable
nr-retry 5
retry-intvl 30
dns
Use these commands to set the DNS server addresses. Several FortiManager functions, including sending alert
email, use DNS. In FortiManager v5.2.1 or later, you can configure both IPv4 and IPv6 DNS server addresses.
CLI Reference
Fortinet Technologies Inc.
73
system
fips
Syntax
config
set
set
set
set
end
system dns
primary <ipv4_address>
secondary <ipv4_address>
ip6-primary <ipv6_address>
ip6-secondary <ipv6_address>
Variable
Description
primary <ipv4_address>
Enter the primary DNS server IPv4 address.
secondary <ipv4_address>
Enter the secondary DNS IPv4 server address.
ip6-primary <ipv6_address>
Enter the primary DNS server IPv6 address.
ip6-secondary <ipv6_address>
Enter the secondary DNS IPv6 server address.
Example
This example shows how to set the primary FortiManager DNS server IPv4 address to 172.20.120.99 and the
secondary FortiManager DNS server IPv4 address to 192.168.1.199.
config system dns
set primary 172.20.120.99
set secondary 192.168.1.199
end
fips
Use this command to set the Federal Information Processing Standards (FIPS) status. FIPS mode is an
enhanced security option for some FortiManager models. Installation of FIPS firmware is required only if the unit
was not ordered with this firmware pre-installed.
Syntax
config
set
set
set
end
74
system fips
status {enable | disable}
entropy-token {enable | disable | dynamic}
re-seed-interval <integer>
Variable
Description
Default
status {enable | disable}
Enable/disable the FIPS-CC mode of operation.
enable
CLI Reference
Fortinet Technologies Inc.
fortiview
system
Variable
Description
Default
entropy-token {enable |
disable | dynamic}
Configure support for the FortiTRNG entropy token:
l
enable: The token must be present during boot up and
reseeding. If the token is not present, the boot up or
reseeding is interrupted until the token is inserted.
disable
l
l
re-seed-interval <integer>
disable: The current entropy implementation is used
to seed the Random Number Generator (RNG).
dynamic: The token is used to seed or reseed the RNG
if it is present. If the token is not present, the boot
process is not blocked and the old entropy
implementation is used.
The amount of time, in minutes, between RNG reseeding.
1440
fortiview
Use this command to configure FortiView settings.
Syntax
config system fortiview setting
set not-scanned apps {exclude | include}
set resolve-ip {enable | disable}
end
Variable
Description
not-scanned apps {exclude |
include}
Include/exclude ‘Not.Scanned’ applications in FortiView.
resolve-ip {enable | disable}
Enable or disable resolving the IP address to the hostname in FortiView.
global
Use this command to configure global settings that affect miscellaneous FortiManager features.
Syntax
config
set
set
set
set
set
set
set
set
set
set
system global
admin-https-pki-required {disable | enable}
admin-lockout-duration <integer>
admin-lockout-threshold <integer>
admin-maintainer {disable | enable}
adom-mode {advanced | normal}sh
adom-rev-auto-delete {by-days | by-revisions | disable}
adom-rev-max-days <integer>
adom-rev-max-revisions <integer>
adom-status {enable | disable}
clt-cert-req {disable | enable}
CLI Reference
Fortinet Technologies Inc.
75
system
global
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
end
console-output {more | standard}
create-revision {disable | enable}
daylightsavetime {enable | disable}
default-disk-quota <integer>
faz-status {enable | disable}
enc-algorithm {default | high | low}
hostname <string>
language {english | japanese | simch | trach}
ldapconntimeout <integer>
lcdpin <integer>
lock-preempt {enable | disable}
log-checksum {md5 | md5-auth | none}
max-running-reports <integer>
partial-install {enable | disable}
pre-login-banner {disable | enable}
pre-login-banner-message <string>
remoteauthtimeout <integer>
search-all-adoms {enable | disable}
ssl-low-encryption {enable | disable}
ssl-protocol {tlsv1 | sslv3}
swapmem {enable | disable}
task-list-size <integer>
timezone <integer>
vdom-mirror {enable | disable}
webservice-proto {tlsv1 | sslv3 | sslv2}
workflow-max-sessions <integer>
workspace-mode {disabled | normal | workflow}
Variable
Description
admin-https-pki-required
{disable | enable}
Enable/disable HTTPS login page when PKI is enabled. The following
options are available:
l
disable: Admin users can login by providing a valid certificate or
password.
enable: Admin users have to provide a valid certificate when PKI
is enabled for HTTPS admin access.
When both set clt-cert-req and set admin-https-pkirequired are enabled, only PKI administrators can connect to the
FortiManager GUI.
l
76
admin-lockout-duration
<integer>
Set the lockout duration (seconds) for FortiManager administration.
Default: 60
admin-lockout-threshold
<integer>
Set the lockout threshold for FortiManager administration. Range: 1 to 10.
Default: 3
admin-maintainer {disable |
enable}
Enable/disable the special user maintainer account
adom-mode
{advanced | normal}
Set the ADOM mode: advanced or normal.
CLI Reference
Fortinet Technologies Inc.
global
system
Variable
Description
adom-rev-auto-delete {bydays | by-revisions | disable}
Auto delete features for old ADOM revisions:
l
by-days: Auto delete ADOM revisions by maximum days.
l
l
by-revisions: Auto delete ADOM revisions by maximum
number of revisions.
disable: Disable auto delete function for ADOM revision.
adom-rev-max-days <integer>
The maximum number of days to keep old ADOM revisions.
adom-rev-max-revisions
<integer>
The maximum number of ADOM revisions to keep.
adom-status {enable | disable}
Enable/disable administrative domains (ADOMs). Default: disable
clt-cert-req {disable | enable}
Enable/disable requiring a client certificate for GUI login. The following
options are available:
l
disable: Disable setting.
l
enable: Require client certificate for GUI login.
When both set clt-cert-req and set admin-https-pkirequired are enabled, only PKI administrators can connect to the
FortiManager GUI.
console-output {more | standard}
Select how the output is displayed on the console. Select more to pause
the output at each full screen until keypress. Select standard for continuous output without pauses. The following options are available:
l
more: More page output.
l
create-revision {disable |
enable}
standard: Standard output (default)
Enable/disable create revision by default. The following options are available:
l
disable: Disable create revision by default.
l
enable: Enable create revision by default.
daylightsavetime
{enable | disable}
Enable/disable daylight saving time.
If you enable daylight saving time, the FortiManager unit automatically
adjusts the system time when daylight saving time begins or ends.
Default: enable
default-disk-quota <integer>
Default disk quota (MB) for registered device. Range: 100 to 100 000 (MB).
faz-status {enable | disable}
Enable/disable FortiAnalyzer features in FortiManager. This command is
not available on the FMG-100C.
CLI Reference
Fortinet Technologies Inc.
77
system
global
Variable
Description
enc-algorithm {default | high |
low}
Set SSL communication encryption algorithms. The following options are
available:
l
high: SSL communication using high encryption algorithms.
l
low: SSL communication using all available encryption algorithms.
medium: SSL communication using high and medium encryption
algorithms.
Default: default
l
hostname <string>
FortiManager host name.
language {english | japanese |
simch | trach}
GUI language. The following options are available:
l
english: English
l
japanese: Japanese
l
simch: Simplified Chinese
l
trach: Traditional Chinese
Default: English
ldapconntimeout <integer>
LDAP connection timeout (in milliseconds). Default: 60000
lcdpin <integer>
Set the 6-digit PIN administrators must enter to use the LCD panel.
lock-preempt {enable | disable}
Enable/disable the ADOM lock override.
log-checksum {md5 | md5auth | none}
Record log file hash value, timestamp, and authentication code at transmission or rolling. The following options are available:
l
md5: Record log file’s MD5 hash value only
l
l
78
md5-auth: Record log file’s MD5 hash value and authentication
code
none: Do not record the log file checksum
max-running-reports <integer>
Maximum running reports number. Range: 1 to 10
partial-install {enable | disable}
Enable/disable partial install (install only some objects).
Use this command to enable pushing individual objects of the policy package down to all FortiGates in the Policy Package.
Once enabled, in the GUI you can right-click an object and choose to install
it.
pre-login-banner {disable |
enable}
Enable/disable pre-login banner.
pre-login-banner-message
<string>
Set the pre-login banner message.
remoteauthtimeout <integer>
Remote authentication (RADIUS/LDAP) timeout (in seconds). Default: 10
search-all-adoms {enable | disable}
Enable/disable search all ADOMs for where-used queries.
CLI Reference
Fortinet Technologies Inc.
global
system
Variable
Description
ssl-low-encryption {enable | dis- Enable/disable SSL low-grade (40-bit) encryption. Default: enable
able}
ssl-protocol {tlsv1 | sslv3}
Set the SSL protocols: tlsv1 or sslv3.
swapmem {enable | disable}
Enable/disable virtual memory.
task-list-size <integer>
Set the maximum number of completed tasks to keep. Default: 2000
timezone <integer>
The time zone for the FortiManager unit. Default: (GMT-8)Pacific
Time(US & Canada)
vdom-mirror {enable | disable}
Enable/disable VDOM mirror. Once enabled in the CLI, you can select to
enable VDOM Mirror when editing a virtual domain in the System > Virtual
Domain device tab in Device Manager. You can then add devices and
VDOMs to the list so they may be mirrored. A icon is displayed in the Mirror
column of this page to indicate that the VDOM is being mirrored to another
device/VDOM.
When changes are made to the master device’s VDOM database, a copy is
applied to the mirror device’s VDOM database. A revision is created and
then installed to the devices.
Default: disable
VDOM mirror is intended to be used by MSSP or enterprise companies who
need to provide a backup VDOM for their customers.
webservice-proto {tlsv1 | sslv3 |
sslv2}
Web Service connection: tlsv1, sslv3, or sslv2.
workflow-max-sessions
<integer>
Maximum number of workflow sessions per ADOM. Range: 100 to 1000.
Default: 500
workspace-mode {disabled |
normal | workflow}
Enable/disable Workspace and Workflow (ADOM locking). The following
options are available:
l
disabled: Workspace is disabled.
l
normal: Workspace lock mode enabled.
l
workspace: Workspace workflow mode enabled.
Example
The following command turns on daylight saving time, sets the FortiManager unit name to FMG3k, and chooses
the Eastern time zone for US & Canada.
config
set
set
set
end
system global
daylightsavetime enable
hostname FMG3k
timezone 12
CLI Reference
Fortinet Technologies Inc.
79
system
global
Time zones
80
Integer Time zone
Integer Time zone
00
(GMT-12:00) Eniwetak, Kwajalein
40
(GMT+3:00) Nairobi
01
(GMT-11:00) Midway Island, Samoa
41
(GMT+3:30) Tehran
02
(GMT-10:00) Hawaii
42
(GMT+4:00) Abu Dhabi, Muscat
03
(GMT-9:00) Alaska
43
(GMT+4:00) Baku
04
(GMT-8:00) Pacific Time (US & Canada)
44
(GMT+4:30) Kabul
05
(GMT-7:00) Arizona
45
(GMT+5:00) Ekaterinburg
06
(GMT-7:00) Mountain Time (US & Canada)
46
(GMT+5:00) Islamabad, Karachi,Tashkent
07
(GMT-6:00) Central America
47
(GMT+5:30) Calcutta, Chennai, Mumbai,
New Delhi
08
(GMT-6:00) Central Time (US & Canada)
48
(GMT+5:45) Kathmandu
09
(GMT-6:00) Mexico City
49
(GMT+6:00) Almaty, Novosibirsk
10
(GMT-6:00) Saskatchewan
50
(GMT+6:00) Astana, Dhaka
11
(GMT-5:00) Bogota, Lima, Quito
51
(GMT+6:00) Sri Jayawardenapura
12
(GMT-5:00) Eastern Time (US & Canada)
52
(GMT+6:30) Rangoon
13
(GMT-5:00) Indiana (East)
53
(GMT+7:00) Bangkok, Hanoi, Jakarta
14
(GMT-4:00) Atlantic Time (Canada)
54
(GMT+7:00) Krasnoyarsk
15
(GMT-4:00) La Paz
55
(GMT+8:00) Beijing,ChongQing,
HongKong,Urumqi
16
(GMT-4:00) Santiago
56
(GMT+8:00) Irkutsk, Ulaanbaatar
17
(GMT-3:30) Newfoundland
57
(GMT+8:00) Kuala Lumpur, Singapore
18
(GMT-3:00) Brasilia
58
(GMT+8:00) Perth
19
(GMT-3:00) Buenos Aires, Georgetown
59
(GMT+8:00) Taipei
20
(GMT-3:00) Nuuk (Greenland)
60
(GMT+9:00) Osaka, Sapporo, Tokyo, Seoul
21
(GMT-2:00) Mid-Atlantic
61
(GMT+9:00) Yakutsk
22
(GMT-1:00) Azores
62
(GMT+9:30) Adelaide
CLI Reference
Fortinet Technologies Inc.
ha
system
Integer Time zone
Integer Time zone
23
(GMT-1:00) Cape Verde Is
63
(GMT+9:30) Darwin
24
(GMT) Casablanca, Monrovia
64
(GMT+10:00) Brisbane
25
(GMT) Greenwich Mean Time:Dublin, Edinburgh, Lisbon, London
65
(GMT+10:00) Canberra, Melbourne,
Sydney
26
(GMT+1:00) Amsterdam, Berlin, Bern,
Rome, Stockholm, Vienna
66
(GMT+10:00) Guam, Port Moresby
27
(GMT+1:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague
67
(GMT+10:00) Hobart
28
(GMT+1:00) Brussels, Copenhagen, Madrid, Paris
68
(GMT+10:00) Vladivostok
29
(GMT+1:00) Sarajevo, Skopje, Sofija, Vilnius, Warsaw, Zagreb
69
(GMT+11:00) Magadan
30
(GMT+1:00) West Central Africa
70
(GMT+11:00) Solomon Is., New Caledonia
31
(GMT+2:00) Athens, Istanbul, Minsk
71
(GMT+12:00) Auckland, Wellington
32
(GMT+2:00) Bucharest
72
(GMT+12:00) Fiji, Kamchatka, Marshall Is
33
(GMT+2:00) Cairo
73
(GMT+13:00) Nuku'alofa
34
(GMT+2:00) Harare, Pretoria
74
(GMT-4:30) Caracas
35
(GMT+2:00) Helsinki, Riga,Tallinn
75
(GMT+1:00) Namibia
36
(GMT+2:00) Jerusalem
76
(GMT-5:00) Brazil-Acre)
37
(GMT+3:00) Baghdad
77
(GMT-4:00) Brazil-West
38
(GMT+3:00) Kuwait, Riyadh
78
(GMT-3:00) Brazil-East
39
(GMT+3:00) Moscow, St.Petersburg, Volgograd
79
(GMT-2:00) Brazil-DeNoronha
ha
Use the config system ha command to enable and configure FortiManager high availability (HA).
FortiManager HA provides a solution for a key requirement of critical enterprise management and networking
components: enhanced reliability.
A FortiManager HA cluster consists of up five FortiManager units of the same FortiManager model. One of the
FortiManager units in the cluster operates as a primary or master unit and the other one to four units operate as
backup units. All of the units are visible on the network. The primary unit and the backup units can be at the same
CLI Reference
Fortinet Technologies Inc.
81
system
ha
location. FortiManager HA also supports geographic redundancy so the primary unit and backup units can be in
different locations attached to different networks as long as communication is possible between them (for
example over the Internet, over a WAN, or through a private network).
Administrators connect to the primary unit GUI or CLI to perform FortiManager operations. The primary unit also
interacts with managed FortiGate devices, and FortiSwitch devices. Managed devices connect with the primary
unit for configuration backup and restore. If FortiManager is being used to distribute firmware updates and
FortiGuard updates to managed devices, the managed devices can connect to the primary unit or one of the
backup units.
If the primary FortiManager unit fails you must manually configure one of the backup units to become the primary
unit. The new primary unit will have the same IPv4 addresses as it did when it was the backup unit. For the
managed devices to automatically start using the new primary unit, you should add all of the FortiManager units
in the cluster to the managed devices.
To configure a cluster, use the config system ha command to set the HA operation mode (mode) to ha and
set the local IP1 (local-ip1), peer IP1 (peer-ip1) and the first synchronization interface (also called
synchronization port) (synchport1) of both FortiManager units in the cluster. The local IP1 IPv4 address of
both FortiManager units must match the peer IP1 IPv4 address of the other FortiManager unit. Both units should
also have the same first synchronization interface.
Syntax
config system ha
set clusterid <clusert_ID_int>
set file-quota <integer>
set hb-interval <integer>
set hb-lost-threshold <integer>
set mode {master | slave | standalone}
set password <passwd>
config peer
edit <peer_id_int>
set ip <peer_ipv4_address>
set ip6 <peer_ipv6_address>
set serial-number <string>
set status <peer_status>
end
end
82
Variable
Description
clusterid <clusert_ID_int>
A number between 0 and 64 that identifies the HA cluster. All members of
the HA cluster must have the same clusterid. If you have more than
one FortiManager HA cluster on the same network, each HA cluster must
have a different group ID.
file-quota <integer>
Set the HA file quota, in MB (2048 - 20480).
CLI Reference
Fortinet Technologies Inc.
ha
system
Variable
Description
hb-interval <integer>
The time in seconds that a cluster unit waits between sending heartbeat
packets. The heartbeat interval is also the amount of time that a cluster
unit waits before expecting to receive a heartbeat packet from the other
cluster unit.
Range: 1 to 255 (seconds)
Default: 5 (seconds)
hb-lost-threshold <integer>
The number of heartbeat intervals that one of the cluster units waits to
receive HA heartbeat packets from other cluster units before assuming that
the other cluster units have failed.
Range: 1 to 255
Default: 3
In most cases you do not have to change the heartbeat interval or failover
threshold. The default settings mean that if the a unit fails, the failure is
detected after 3 x 5 or 15 seconds; resulting in a failure detection time of 15
seconds.
If the failure detection time is too short the HA cluster may detect a failure
when none has occurred. For example, if the primary unit is very busy it
may not respond to HA heartbeat packets in time. In this situation, the
backup unit may assume that the primary unit has failed when the primary
unit is actually just busy. Increase the failure detection time to prevent the
backup unit from detecting a failure when none has occurred.
If the failure detection time is too long, administrators will be delayed in
learning that the cluster has failed. In most cases, a relatively long failure
detection time will not have a major effect on operations. But if the failure
detection time is too long for your network conditions, then you can reduce
the heartbeat interval or failover threshold.
mode {master | slave | standalone}
Select master to configure the FortiManager unit to be the primary unit in
a cluster. Select slave to configure the FortiManager unit to be a backup
unit in a cluster. Select standalone to stop operating in HA mode.
password <passwd>
A group password for the HA cluster. All members of the HA cluster must
have the same group password. If you have more than one FortiManager
HA cluster on the same network, each HA cluster must have a different
password. Character limit: 19
peer
Add peers to the HA configuration of the FortiManager unit. You add all of
the backup units as peers to the primary unit (up to four). For each backup
unit you add the primary unit.
Variables for config peer subcommand:
<peer_id_int>
Add a peer and add the peer’s IPv4 or IPv6 address and serial number.
ip <peer_ipv4_address>
Enter the IPv4 address of the peer FortiManager unit.
ip6 <peer_ipv6_address>
Enter the IPv6 address of the peer FortiManager unit.
CLI Reference
Fortinet Technologies Inc.
83
system
ha
Variable
Description
serial-number <string>
Enter the serial number of the peer FortiManager unit.
status <peer_status>
Enter the status of the peer FortiManager unit.
General FortiManager HA configuration steps
The following steps assume that you are starting with four FortiManager units running the same firmware build
and are set to the factory default configuration. The primary unit and the first backup unit are connected to the
same network. The second and third backup units are connected to a remote network and communicate with the
primary unit over the Internet.
1. Enter the following command to configure the primary unit for HA operation.
config system ha
set mode master
set password <password_str>
set clusterid 10
config peer
edit 1
set ip <peer_ip_ipv4>
set serial-number <peer_serial_str>
next
edit 2
set ip <peer_ip_ipv4>
set serial-number <peer_serial_str>
next
edit 3
set ip <peer_ip_ipv4>
set serial-number <peer_serial_str>
next
end
This command configures the FortiManager unit to operate as the primary unit, adds a password, sets the
clusterid to 10, and accepts defaults for the other HA settings. This command also adds the three
backup units to the primary unit as peers.
2. Enter the following command to configure the backup units for HA operation.
config system ha
set mode slave
set password <password_str>
set clusterid 10
config peer
edit 1
set ip <peer_ip_ipv4>
set serial-number <peer_serial_str>
next
end
This command configures the FortiManager unit to operate as a backup unit, adds the same password, and
clusterid as the primary unit, and accepts defaults for the other HA settings. This command also adds
the primary unit to the backup unit as a peer.
3. Repeat step 2 to configure each backup unit.
84
CLI Reference
Fortinet Technologies Inc.
interface
system
interface
Use this command to edit the configuration of a FortiManager network interface.
Syntax
config system interface
edit <port>
set status {up | down}
set ip <ipv4_mask>
set allowaccess {http https ping snmp ssh telnet webservice}
set serviceaccess {fclupdates fgtupdates webfilter-antispam}
set speed {1000full 100full 100half 10full 10half auto}
set description <string>
set alias <string>
config <ipv6>
set ip6-address <ipv6 prefix>
set ip6-allowaccess {http https ping snmp ssh telnet webservice}
end
end
Variable
Description
<port>
<port> can be set to a port number such as port1, port2, port3, or port4.
Different FortiManager models have different numbers of ports.
status {up | down}
Start or stop the interface. If the interface is stopped it does not accept or
send packets. If you stop a physical interface, VLAN interfaces associated
with it also stop. Default: up
ip <ipv4_mask>
Enter the interface IPv4 address and netmask. The IPv4 address cannot be
on the same subnet as any other interface.
allowaccess {http https ping
snmp ssh telnet webservice}
Enter the types of management access permitted on this interface. Separate multiple selected types with spaces.
If you want to add or remove an option from the list, retype the list as
required.
Options include: http, https, ping, snmp, ssh, telnet, and webservice.
serviceaccess {fclupdates
fgtupdates webfilter-antispam}
Enter the types of service access permitted on this interface. Separate multiple selected types with spaces. If you want to add or remove an option
from the list, retype the list as required. The following options are available:
l
fclupdates: FortiClient updates access.
CLI Reference
Fortinet Technologies Inc.
l
fgtupdates: FortiGate updates access.
l
webfilter-antispam: Web filtering and antispam access.
85
system
locallog
Variable
Description
speed {1000full 100full 100half Enter the speed and duplexing the network port uses. Enter auto to auto10full 10half auto}
matically negotiate the fastest common speed. The following options are
available:
l
100full: 100M full-duplex.
l
100half: 100M half-duplex.
l
10full: 10M full-duplex.
l
10half: 10M half-duplex.
l
auto: Auto adjust speed default).
description <string>
Enter a description of the interface. Character limit: 63
alias <string>
Enter an alias for the interface.
<ipv6>
Configure the interface IPv6 settings.
ip6-address <ipv6 prefix>
IPv6 address/prefix of interface.
ip6-allowaccess {http https
ping snmp ssh telnet webservice}
Allow management access to the interface.
Options include: http, https, ping, snmp, ssh, telnet, and webservice.
Example
This example shows how to set the FortiManager port1 interface IPv4 address and network mask to
192.168.100.159 and 255.255.255.0, and the management access to ping, https, and ssh.
config system interface
edit port1
set allowaccess ping https ssh
set ip 192.168.110.26 255.255.255.0
set status up
end
locallog
Use the following commands to configure local log settings.
locallog setting
Use this command to configure locallog logging settings.
Syntax
config
set
set
set
end
86
system locallog setting
log-interval-dev-no-logging <integer>
log-interval-disk-full <integer>
log-interval-gbday-exceeded <integer>
CLI Reference
Fortinet Technologies Inc.
locallog
system
Variable
Description
log-interval-dev-no-logging
<integer>
Interval in minute for logging the event of no logs received from a device.
Default: 5.
log-interval-disk-full <integer>
Interval in minute for logging the event of disk full. Default: 5.
log-interval-gbday-exceeded
<integer>
Interval in minute for logging the event of the GB/Day license exceeded.
Default: 1440.
locallog disk setting
Use this command to configure the disk settings for uploading log files, including configuring the severity of log
levels.
l
status must be enabled to view diskfull, max-log-file-size and upload variables.
l
upload must be enabled to view/set other upload* variables.
Syntax
config system locallog disk setting
set status {enable | disable}
set severity {alert | critical | debug | emergency | error | information |
notification | warning}
set max-log-file-size <integer>
set roll-schedule {none | daily | weekly}
set roll-day <string>
set roll-time <hh:mm>
set diskfull {nolog | overwrite}
set log-disk-full-percentage <integer>
set upload {disable | enable}
set uploadip <ipv4_address>
set server-type {FAZ | FTP | SCP | SFTP}
set uploadport <integer>
set uploaduser <string>
set uploadpass <passwd>
set uploaddir <string>
set uploadtype <event>
set uploadzip {disable | enable}
set uploadsched {disable | enable}
set upload-time <hh:mm>
set upload-delete-files {disable | enable}
end
Variable
Description
status {enable | disable}
Enable or disable logging to the local disk. Default: disable
CLI Reference
Fortinet Technologies Inc.
87
system
locallog
Variable
Description
severity {alert | critical | debug |
emergency | error |
information | notification | warning}
Select the logging severity level. The FortiManager unit logs all messages
at and above the logging severity level you select. For example, if you
select critical, the unit logs critical, alert and emergency level
messages.
The logging levels in descending order are:
l
emergency: The unit is unusable.
l
alert: Immediate action is required (default).
l
critical: Functionality is affected.
l
error: Functionality is probably affected.
l
warning: Functionality might be affected.
l
notification: Information about normal events.
l
information: General information about unit operations.
l
debug: Information used for diagnosis or debugging.
max-log-file-size <integer>
Enter the size at which the log is rolled.
Range: 1 to 1024 (MB)
Default: 100
roll-schedule {none | daily |
weekly}
Enter the period for the scheduled rolling of a log file. If roll-schedule
is none, the log rolls when max-log-file-size is reached. The following options are available:
l
none: Not scheduled (default).
l
daily: Every day.
l
weekly: Every week.
roll-day <string>
Enter the day for the scheduled rolling of a log file.
roll-time <hh:mm>
Enter the time for the scheduled rolling of a log file.
diskfull {nolog | overwrite}
Enter action to take when the disk is full:
l
nolog: stop logging
l
88
overwrite: overwrites oldest log entries (default)
log-disk-full-percentage
<integer>
Enter the percentage at which the log disk will be considered full (50-90%).
upload {disable | enable}
Enable or disable uploading of logs when rolling log files. Default: disable
uploadip <ipv4_address>
Enter IPv4 address of the destination server. Default: 0.0.0.0
server-type {FAZ | FTP | SCP |
SFTP}
Enter the server type to use to store the logs:
l
FAZ: Upload to FortiAnalyzer.
l
FTP: Upload via FTP.
l
SCP: Upload via SCP.
l
SFTP: Upload via SFTP.
CLI Reference
Fortinet Technologies Inc.
locallog
system
Variable
Description
uploadport <integer>
Enter the port to use when communicating with the destination server.
Default: 21. Range: 1 to 65535
uploaduser <string>
Enter the user account on the destination server.
uploadpass <passwd>
Enter the password of the user account on the destination server. Character
limit: 127
uploaddir <string>
Enter the destination directory on the remote server.
uploadtype <event>
Enter to upload the event log files. Default: event
uploadzip {disable | enable}
Enable to compress uploaded log files. Default: disable
uploadsched {disable | enable}
Enable to schedule log uploads. The following options are available:
l
disable: Upload when rolling.
l
enable: Scheduled upload.
upload-time <hh:mm>
Enter to configure when to schedule an upload.
upload-delete-files {disable |
enable}
Enable or disable deleting log files after uploading. Default: enable
Example
In this example, the logs are uploaded to an upload server and are not deleted after they are uploaded.
config
set
set
set
set
set
set
set
set
set
set
set
set
set
set
end
system locallog disk setting
status enable
severity information
max-log-file-size 1000MB
roll-schedule daily
upload enable
uploadip 10.10.10.1
uploadport port 443
uploaduser myname2
uploadpass 12345
uploadtype event
uploadzip enable
uploadsched enable
upload-time 06:45
upload-delete-file disable
locallog filter
Use this command to configure filters for local logs. All keywords are visible only when event is enabled.
Syntax
config system locallog [memory | disk | fortianalyzer | fortianalyzer2 |
fortianalyzer3 | syslogd | syslogd2 | syslogd3] filter
set devcfg {disable | enable}
CLI Reference
Fortinet Technologies Inc.
89
system
locallog
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
end
90
devops {disable | enable}
dm {disable | enable}
dvm {disable | enable}
epmgr {disable | enable}
event {disable | enable}
faz {enable | disable|
fgd {disable | enable}
fgfm {disable | enable}
fips {disable | enable}
fmgws {disable | enable}
fmlmgr {disable | enable}
fmwmgr {disable | enable}
glbcfg {disable | enable}
ha {disable | enable}
iolog {disable | enable}
logd {disable | enable}
lrmgr {disable | enable}
objcfg {disable | enable}
rev {disable | enable}
rtmon {disable | enable}
scfw {disable | enable}
scply {disable | enable}
scrmgr {disable | enable}
scvpn {disable | enable}
system {disable | enable}
webport {disable | enable}
Variable
Description
devcfg {disable | enable}
Enable to log device configuration messages.
devops {disable | enable}
Enable managed devices operations messages.
dm {disable | enable}
Enable to log deployment manager messages. Default: disable
dvm {disable | enable}
Enable to log device manager messages. Default: disable
epmgr {disable | enable}
Enable to log endpoint manager messages. Default: disable
event {disable | enable}
Enable to configure log filter messages. Default: disable
faz {enable | disable|
Enable to log FortiAnalyzer messages. Default: disable
fgd {disable | enable}
Enable to log FortiGuard service messages. Default: disable
fgfm {disable | enable}
Enable to log FortiGate/FortiManager communication protocol messages.
Default: disable
fips {disable | enable}
Enable to log FIPS messages. Default: disable
fmgws {disable | enable}
Enable to log web service messages. Default: disable
fmlmgr {disable | enable}
Enable to log FortiMail manager messages. Default: disable
CLI Reference
Fortinet Technologies Inc.
locallog
system
Variable
Description
fmwmgr {disable | enable}
Enable to log firmware manager messages. Default: disable
glbcfg {disable | enable}
Enable to log global database messages. Default: disable
ha {disable | enable}
Enable to log high availability activity messages. Default: disable
iolog {disable | enable}
Enable input/output log activity messages. Default: disable
logd {disable | enable}
Enable logd messages. Default: disable
lrmgr {disable | enable}
Enable to log log and report manager messages. Default: disable
objcfg {disable | enable}
Enable to log object configuration. Default: disable
rev {disable | enable}
Enable to log revision history messages. Default: disable
rtmon {disable | enable}
Enable to log real-time monitor messages. Default: disable
scfw {disable | enable}
Enable to log firewall objects messages. Default: disable
scply {disable | enable}
Enable to log policy console messages. Default: disable
scrmgr {disable | enable}
Enable to log script manager messages. Default: disable
scvpn {disable | enable}
Enable to log VPN console messages. Default: disable
system {disable | enable}
Enable to log system manager messages. Default: disable
webport {disable | enable}
Enable to log web portal messages. Default: disable
Example
In this example, the local log filters are log and report manager, and system settings. Events in these areas of the
FortiManager unit will be logged.
config
set
set
set
end
system locallog filter
event enable
lrmgr enable
system enable
locallog fortianalyzer (fortianalyzer2, fortianalyzer3) setting
Use this command to enable or disable, and select the severity threshold of, remote logging to the FortiAnalyzer
units. You can configure up to three FortiAnalyzer devices.
The severity threshold required to forward a log message to the FortiAnalyzer unit is separate from event, syslog,
and local logging severity thresholds.
Syntax
config system locallog {fortianalyzer | fortianalyzer2 | fortianalyzer3} setting
CLI Reference
Fortinet Technologies Inc.
91
system
locallog
set severity {emergency | alert | critical | error | warning | notification |
information | debug}
set server-ip <ip>
ser secure-connection {enable | disable}
set status {disable | realtime | upload}
set upload-time <hh:mm>
end
Variable
Description
severity {emergency | alert |
critical | error | warning |
notification | information |
debug}
Enter the severity threshold that a log message must meet or exceed to be
logged to the unit. The following options are available:
l
emergency: The unit is unusable.
server-ip <ip>
l
alert: Immediate action is required (default).
l
critical: Functionality is affected.
l
error: Functionality is probably affected.
l
warning: Functionality might be affected.
l
notification: Information about normal events.
l
information: General information about unit operations.
l
debug: Information used for diagnosis or debugging.
Set the remote FortiAnalyzer server IP address.
secure-connection {enable | dis- Enable/disable connection secured by TLS/SSL.
able}
status {disable | realtime |
upload}
Set the log to FortiAnalyzer status. The following options are available:
l
disable: Do not log to FortiAnalyzer.
l
realtime: Log to FortiAnalyzer in realtime.
l
upload: Log to FortiAnalyzer at a scheduled time.
Default: disable
upload-time <hh:mm>
Set the time to upload local log files.
Example
You might enable remote logging to the FortiAnalyzer unit configured. Events at the information level and higher,
which is everything except debug level events, would be sent to the FortiAnalyzer unit.
config system locallog fortianalyzer setting
set status enable
set severity information
end
locallog memory setting
Use this command to configure memory settings for local logging purposes.
Syntax
config system locallog memory setting
set diskfull {nolog | overwrite}
set severity {emergency | alert | critical | error | warning | notification |
information | debug}
92
CLI Reference
Fortinet Technologies Inc.
locallog
system
set status <disable | enable>
end
Variable
Description
diskfull {nolog | overwrite}
Enter the action to take when the disk is full:
l
nolog: Stop logging when disk full
l
severity {emergency | alert |
critical | error | warning |
notification | information |
debug}
status <disable | enable>
overwrite: Overwrites oldest log entries
Enter the log severity level to log files. The following options are available:
l
emergency: The unit is unusable.
l
alert: Immediate action is required (default).
l
critical: Functionality is affected.
l
error: Functionality is probably affected.
l
warning: Functionality might be affected.
l
notification: Information about normal events.
l
information: General information about unit operations.
l
debug: Information used for diagnosis or debugging.
Enable or disable logging to the memory buffer. Default: disable
Example
This example shows how to enable logging to memory for all events at the notification level and above. At this
level of logging, only information and debug events will not be logged.
config system locallog memory
set severity notification
set status enable
end
locallog syslogd (syslogd2, syslogd3) setting
Use this command to configure the settings for logging to a syslog server. You can configure up to three syslog
servers; syslogd, syslogd2 and syslogd3.
Syntax
config system locallog {syslogd | syslogd2 | syslogd3} setting
set csv {disable | enable}
set facility {alert | audit | auth | authpriv | clock | cron | daemon | ftp |
kernel | local0 | local1 | local2 | local3 | local4 | local5 | local6 | local7 |
lpr | mail | news | ntp | syslog | user | uucp}
set severity {emergency | alert | critical | error | warning | notification |
information | debug}
set status {enable | disable}
set syslog-name <string>
end
CLI Reference
Fortinet Technologies Inc.
93
system
Variable
Description
csv {disable | enable}
Enable to produce the log in comma separated value (CSV) format. If you
do not enable CSV format the FortiManager unit produces space separated
log files. Default: disable
facility {alert | audit | auth |
authpriv | clock | cron | daemon
| ftp | kernel | local0 | local1 |
local2 | local3 | local4 | local5 |
local6 | local7 | lpr | mail | news
| ntp | syslog | user | uucp}
Enter the facility type. facility identifies the source of the log message
to syslog. Change facility to distinguish log messages from different
FortiManager units so you can determine the source of the log messages.
Available facility types are:
l
alert: Log alert.
severity {emergency | alert |
critical | error | warning |
notification | information |
debug}
94
locallog
l
audit: Log audit.
l
auth: Security/authorization messages.
l
authpriv: Security/authorization messages (private).
l
clock: Clock daemon
l
cron: Clock daemon.
l
daemon: System daemons.
l
ftp: File Transfer Protocol (FTP) daemon
l
kernel: Kernel messages.
l
local0 tolocal7: reserved for local use (default)
l
lpr: Line printer subsystem.
l
mail: Mail system.
l
news: Network news subsystem.
l
ntp: Network Time Protocol (NTP) daemon
l
syslog: Messages generated internally by the syslog daemon.
l
user: Random user-level messages.
l
uucp: Network news subsystem.
Select the logging severity level. The FortiManager unit logs all messages
at and above the logging severity level you select. For example, if you
select critical, the unit logs critical, alert and emergency level
messages.
The logging levels in descending order are:
l
emergency: The unit is unusable.
l
alert: Immediate action is required.
l
critical: Functionality is affected.
l
error: Functionality is probably affected.
l
warning: Functionality might be affected.
l
notification: Information about normal events.
l
information: General information about unit operations.
l
debug: Information used for diagnosis or debugging.
status {enable | disable}
Enable or disable logging to the remote syslog server.
syslog-name <string>
Enter the remote syslog server name.
CLI Reference
Fortinet Technologies Inc.
log
system
Example
In this example, the logs are uploaded to a syslog server at IPv4 address 10.10.10.8. The FortiManager unit is
identified as facility local0.
config
set
set
set
end
system locallog syslogd setting
facility local0
status enable
severity information
log
Use the following commands to configure log settings.
log alert
Use this command to configure log based alert settings.
Syntax
config system log alert
set max-alert-count <integer>
end
Variable
Description
max-alert-count <integer>
Maximum number of alerts supported. Range: 100 to 1000
log mail-domain
Use this command to configure FortiMail domain settings.
Syntax
config system log mail-domain
edit <id>
set devices <string>
set domain <string>
set vdom <string>
end
Variable
Description
<id>
The ID of the FortiMail domain.
devices <string>
The device IDs seperated by commas, or All_FortiMails,for domain to
VDOM mapping.
For example:
'FEVM020000000000,FEVM020000000001'
domain <string>
CLI Reference
Fortinet Technologies Inc.
The FortiMail domain.
95
system
log
Variable
Description
vdom <string>
The VDOM name that is mapping to the FortiMail domain.
log settings
Use this command to configure settings for logs.
Syntax
config system log settings
set log-file-archive-name {basic | extended}
set FCH-custom-field1 <string>
set FCT-custom-field1 <string>
set FGT-custom-field1 <string>
set FML-custom-field1 <string>
set FWB-custom-field1 <string>
set FAZ-custom-field1 <string>
set FSA-custom-field1 <string>
set sync-search-timeout <integer>
config rolling-regular
set days {fri | mon| sat | sun | thu | tue | wed}
set del-files {disable | enable}
set directory <string>
set file-size <integer>
set gzip-format {disable | enable}
set hour <integer>
set ip <ipv4_address>
set ip2 <ipv4_address>
set ip3 <ipv4_address>
set log-format {csv | native | text}
set min <integer>
set password <passwd>
set password2 <passwd>
set password3 <passwd>
set server-type {ftp | scp | sftp}
set upload {disable | enable}
set upload-hour <integer>
set upload-mode {backup | mirror}
set upload-trigger {on-roll | on-schedule}
set username <string>
set username2 <string>
set username3 <string>
set when {daily | none | weekly}
end
end
96
CLI Reference
Fortinet Technologies Inc.
log
system
Variable
Description
log-file-archive-name {basic |
extended}
Log file name format for archiving.
l
basic: Basic format for log archive file name, for example:
FGT20C0000000001.tlog.1417797247.log.
l
extended: Extended format for log archive file name, for
example:
FGT20C0000000001.2014-12-0508:34:58.tlog.1417797247.log.
FCH-custom-field1 <string>
Enter a name of the custom log field to index. Character limit: 31
FCT-custom-field1 <string>
Enter a name of the custom log field to index. Character limit: 31
FGT-custom-field1 <string>
Enter a name of the custom log field to index. Character limit: 31
FML-custom-field1 <string>
Enter a name of the custom log field to index. Character limit: 31
FWB-custom-field1 <string>
Enter a name of the custom log field to index. Character limit: 31
FAZ-custom-field1 <string>
Enter a name of the custom log field to index. Character limit: 31
FSA-custom-field1 <string>
Enter a name of the custom log field to index. Character limit: 31
sync-search-timeout <integer>
The maximum number of seconds that a log search session can run in synchronous mode.
Variables for config rolling-regular subcommand:
days {fri | mon| sat | sun | thu
| tue | wed}
Log files rolling schedule (days of the week). When when is set to weekly,
you can configure days, hour, and min values. the following options are
available:
l
fri: Friday.
l
mon: Monday.
l
sat: Saturday.
l
sun: Sunday.
l
thu: Thursday.
l
tue: Tuesday.
l
wed: Wednesday.
del-files {disable | enable}
Enable/disable log file deletion after uploading.
directory <string>
The upload server directory. Character limit: 127
file-size <integer>
Roll log files when they reach this size (MB). Range: 10 to 500 (MB).
Default: 200 (MB)
gzip-format {disable | enable}
Enable/disable compression of uploaded log files.
hour <integer>
Log files rolling schedule (hour).
CLI Reference
Fortinet Technologies Inc.
97
system
mail
Variable
Description
ip <ipv4_address>
ip2 <ipv4_address>
ip3 <ipv4_address>
Upload server IPv4 addresses. Configure up to three servers.
log-format {csv | native | text}
Format of uploaded log files. The following options are available:
l
csv: CSV (comma-separated value) format.
l
native: Native format (text or compact).
l
text: Text format (convert if necessary).
min <integer>
Log files rolling schedule (minutes).
password <passwd>
password2 <passwd>
password3 <passwd>
Upload server login passwords. Character limit: 128
server-type {ftp | scp | sftp}
Upload server type: ftp, scp, or sftp.
upload {disable | enable}
Enable/disable log file uploads.
upload-hour <integer>
Log files upload schedule (hour).
upload-mode {backup | mirror}
Configure upload mode with multiple servers. Servers are attempted and
used one after the other upon failure to connect. The following options are
available:
l
backup: Servers are attempted and used one after the other upon
failure to connect.
l
upload-trigger {on-roll | onschedule}
mirror: All configured servers are attempted and used.
Event triggering log files upload:
l
on-roll: Upload log files after they are rolled.
l
on-schedule: Upload log files daily.
username <string>
username2 <string>
username3 <string>
Upload server login usernames. Character limit: 35
when {daily | none | weekly}
Roll log files periodically. The following options are available:
l
daily: Roll log files daily.
l
none: Do not roll log files periodically.
l
weekly: Roll log files on certain days of week.
mail
Use this command to configure mail servers on your FortiManager unit.
Syntax
config system mail
98
CLI Reference
Fortinet Technologies Inc.
metadata
system
edit <id>
set auth {enable | disable}
set passwd <passwd>
set port <integer>
set secure-option {default | none | smtps | starttls}
set server <string>
set user <string>
end
Variable
Description
<id>
Enter the mail service ID of the entry you would like to edit or type a new
name to create an entry. Character limit: 63
<server>
Enter the name of the mail server.
auth {enable | disable}
Enable/disable authentication.
passwd <passwd>
Enter the SMTP account password value. Character limit: 63
port <integer>
Enter the SMTP server port. Range: 1 to 65535
secure-option {default | none |
smtps | starttls}
Select the communication secure option. One of:
l
default:Try STARTTLS, proceed as plain text communication
otherwise.
l
none: Communication will be in plain text format.
l
smtps: Communication will be protected by SMTPS.
l
starttls: Communication will be protected by STARTTLS.
server <string>
Enter the SMTP server name.
user <string>
Enter the SMTP account user name.
metadata
Use this command to add additional information fields to the administrator accounts of your FortiManager unit.
This command creates the metadata fields. Use config system admin user to
add data to the metadata fields.
Syntax
config system metadata admins
edit <fieldname>
set field_length {20 | 50 | 255}
set importance {optional | required}
set status {enabled | disabled}
end
CLI Reference
Fortinet Technologies Inc.
99
system
ntp
Variable
Description
<fieldname>
Enter the name of the field.
field_length {20 | 50 | 255}
Select the maximum number of characters allowed in this field. Default: 50
importance {optional |
required}
Select if this field is required or optional when entering standard information. Default: optional
status {enabled | disabled}
Enable/disable the metadata. Default: disable
ntp
Use this command to configure automatic time setting using a network time protocol (NTP) server.
Syntax
config system ntp
set status {enable | disable}
set sync_interval <string>
config ntpserver
edit <id>
set ntpv3 {disable | enable}
set server <string>}
set authentication {disable | enable}
set key <passwd>
set key-id <integer>
end
end
Variable
Description
status {enable | disable}
Enable/disable NTP time setting. Default: disable
sync_interval <string>
Enter the time, in minutes, how often the FortiManager unit synchronizes
its time with the NTP server. Range: 1 to 1440 (minutes). Default: 60
Variables for config ntpserver subcommand:
100
ntpv3 {disable | enable}
Enable/disable NTPv3. Default: disable
server <string>}
Enter the IPv4 address or fully qualified domain name of the NTP server.
authentication {disable |
enable}
Enable/disable MD5 authentication. Default: disable
key <passwd>
The authentication key. String maximum: 63 characters
key-id <integer>
The key ID for authentication. Default: 0
CLI Reference
Fortinet Technologies Inc.
password-policy
system
password-policy
Use this command to configure access password policies.
Syntax
config
set
set
set
set
set
end
system password-policy
status {disable | enable}
minimum-length <integer>
must-contain <lower-case-letter | non-alphanumeric | number | upper-case-letter>
change-4-characters {disable | enable}
expire <integer>
Variable
Description
status {disable | enable}
Enable/disable the password policy. Default: enable
minimum-length <integer>
Set the password’s minimum length.
Range: 8 to 256 (characters)
Default: 8
must-contain <lower-case-letter | non-alphanumeric | number | upper-case-letter>
Characters that a password must contain.
l
lower-case-letter: the password must contain at least one
lower case letter
l
l
l
non-alphanumeric: the password must contain at least one
non-alphanumeric characters
number: the password must contain at least one number
upper-case-letter: the password must contain at least one
upper case letter.
change-4-characters {disable |
enable}
Enable/disable changing at least 4 characters for a new password. Default:
disable
expire <integer>
Set the number of days after which admin users' password will expire; 0
means never. Default: 0
report
Use the following command to configure report related settings.
report auto-cache
Use this command to view or configure report auto-cache settings.
Syntax
config system report auto-cache
set aggressive-drilldown {enable | disable}
set aggressive-schedule {enable | disable}
CLI Reference
Fortinet Technologies Inc.
101
system
report
set
set
set
set
end
drilldown-interval <integer>
drilldown-status {enable | disable}
order {latest-first | oldest-first}
status {enable | disable}
Variable
Description
aggressive-drilldown {enable |
disable}
Enable/disable the aggressive drill-down auto-cache.
aggressive-schedule {enable |
disable}
Enable/disable auto-cache on schedule reports aggressively.
drilldown-interval <integer>
The time interval in hours for drill-down auto-cache. Range: 1 to 8784
(hours)
drilldown-status {enable | disable}
Enable/disable drill-down auto-cache.
order {latest-first | oldest-first}
The order of which SQL log table is processed first.
l
latest-first: The latest SQL log table is processed first.
l
status {enable | disable}
oldest-first: The oldest SQL log table is processed first.
Enable/disable the SQL report auto-cache.
report est-browse-time
Use this command to view or configure report settings.
Syntax
config
set
set
set
set
end
system report est-browse-time
compensate-read-time <integer>
max-num-user <integer>
max-read-time <integer>
status {enable | disable}
Variable
Description
compensate-read-time
<integer>
Set the compensate read time for last page view. Range: 1 to 3600
max-num-user <integer>
Set the maximum number of users to estimate browse time. Range: 100 to
1 000 000
max-read-time <integer>
Set the read time threshold for each page view. Range: 1 to 3600
status {enable | disable}
Enable/disable estimating browse time.
report group
Use these commands to configure report groups.
102
CLI Reference
Fortinet Technologies Inc.
report
system
Syntax
config system report group
edit <group-id>
set adom <adom-name>
set case-insensitive {enable | disable}
set report-like <string>
config chart-alternative
edit <chart-name>
set chart-replace <string>
end
config group-by
edit <var-name>
set var-expression <string>
end
end
Variable
Description
<group-id>
The identification number of the group to be edited or created.
adom <adom-name>
The ADOM that conatins the report group.
case-insensitive {enable
| disable}
Enable or diable case sensitivity.
report-like <string>
Report pattern
Variables for config chart-alternative subcommand:
<chart-name>
The chart name.
chart-replace <string>
Chart replacement.
Variables for config group-by subcommand:
<var-name>
The variable name.
var-expression <string>
Variable expression..
report setting
Use these commands to view or configure report settings.
Syntax
config
set
set
set
set
end
system report setting
hcache-lossless {enable | disable}
max-table-rows <integer>
report-priority {low | normal}
week-start {mon | sun}
CLI Reference
Fortinet Technologies Inc.
103
system
route
Variable
Description
hcache-lossless {enable | disable}
Enable or disable ready-with-loss hcaches.
max-table-rows <integer>
Set the maximum number of rows that can be generated in a single table.
Range: 10 000 to 100 000
report-priority {low | normal}
Set the Priority of the SQL report.
week-start {mon | sun}
Set the day that the week starts on, either Sunday or Monday. The following options are available:
l
mon: Monday.
l
sun: Sunday.
Use the show command to display the current configuration if it has been changed from its default value:
show system report settings
route
Use this command to view or configure static routing table entries on your FortiManager unit.
Syntax
config system route
edit <seq_int>
set device <port>
set dst <dst_ipv4mask>
set gateway <gateway_ipv4_address>
end
Variable
Description
<seq_int>
Enter an unused routing sequence number to create a new route. Enter an
existing route number to edit that route.
device <port>
Enter the port (interface) used for this route.
dst <dst_ipv4mask>
Enter the IPv4 address and mask for the destination network.
gateway <gateway_ipv4_
address>
Enter the default gateway IPv4 address for this network.
route6
Use this command to view or configure static IPv6 routing table entries on your FortiManager unit.
Syntax
config system route6
104
CLI Reference
Fortinet Technologies Inc.
snmp
system
edit <seq_int>
set device <string>
set dst <ipv6_prefix>
set gateway <ipv6_address>
end
Variable
Description
<seq_int>
Enter an unused routing sequence number to create a new route. Enter an
existing route number to edit that route.
device <string>
Enter the port (interface) used for this route.
dst <ipv6_prefix>
Enter the IPv4 address and mask for the destination network.
gateway <ipv6_address>
Enter the default gateway IPv6 address for this network.
snmp
Use the following commands to configure SNMP related settings.
snmp community
Use this command to configure SNMP communities on your FortiManager unit.
You add SNMP communities so that SNMP managers, typically applications running on computers to monitor
SNMP status information, can connect to the FortiManager unit (the SNMP agent) to view system information
and receive SNMP traps. SNMP traps are triggered when system events happen such as when there is a system
restart, or when the log disk is almost full.
You can add up to three SNMP communities, and each community can have a different configuration for SNMP
queries and traps. Each community can be configured to monitor the FortiManager unit for a different set of
events.
Hosts are the SNMP managers that make up this SNMP community. Host information includes the IPv4 address
and interface that connects it to the FortiManager unit.
For more information on SNMP traps and variables, see the Fortinet Document Library.
Part of configuring an SNMP manager is to list it as a host in a community on the
FortiManager unit that it will be monitoring. Otherwise that SNMP manager will not
receive any traps or events from the FortiManager unit, and will be unable to query the
FortiManager unit as well.
Syntax
config system snmp community
edit <index_number>
set events <events_list>
set name <community_name>
set query-v1-port <integer>
set query-v1-status {enable | disable}
set query-v2c-port <integer>
CLI Reference
Fortinet Technologies Inc.
105
system
snmp
set query-v2c-status {enable | disable}
set status {enable | disable}
set trap-v1-rport <integer>
set trap-v1-status {enable | disable}
set trap-v2c-rport <integer>
set trap-v2c-status {enable | disable}
config hosts
edit <host_number>
set interface <interface_name>
set ip <ipv4_address>
next
config hosts6
edit <host_number>
set interface <interface_name>
set ip <ipv6_address>
end
end
Variable
Description
<index_number>
Enter the index number of the community in the SNMP communities table.
Enter an unused index number to create a new SNMP community.
events <events_list>
Enable the events for which the FortiManager unit should send traps to the
SNMP managers in this community. The raid_changed event is only
available for devices which support RAID.
cpu-high-exclude-nice: CPU usage exclude NICE threshold.
l
cpu_high: CPU usage too high.
l
disk_low: Disk usage too high.
l
ha_switch: HA switch.
l
intf_ip_chg: Interface IP address changed.
l
lic-dev-quota: High licensed device quota detected.
l
lic-gbday: High licensed log GB/day detected.
l
log-alert: Log base alert message.
l
log-data-rate: High incoming log data rate detected.
l
log-rate: High incoming log rate detected.
l
mem_low: Available memory is low.
l
raid_changed: RAID status changed.
l
sys_reboot: System reboot.
Default: All events enabled
106
name <community_name>
Enter the name of the SNMP community. Names can be used to distinguish
between the roles of the hosts in the groups.
For example the Logging and Reporting group would be interested in the
disk_low events, but likely not the other events.
The name is included in SNMPv2c trap packets to the SNMP manager, and
is also present in query packets from, the SNMP manager.
query-v1-port <integer>
Enter the SNMPv1 query port number used when SNMP managers query
the FortiManager unit. Default: 161. Range: 1 to 65535
CLI Reference
Fortinet Technologies Inc.
snmp
system
Variable
Description
query-v1-status {enable | disable}
Enable/disable SNMPv1 queries for this SNMP community. Default:
enable
query-v2c-port <integer>
Enter the SNMP v2c query port number used when SNMP managers query
the FortiManager unit. SNMP v2c queries will include the name of the community. Default: 161. Range: 1 to 65535
query-v2c-status {enable | disable}
Enable/disable SNMPv2c queries for this SNMP community. Default:
enable
status {enable | disable}
Enable/disable this SNMP community. Default: enable
trap-v1-rport <integer>
Enter the SNMPv1 remote port number used for sending traps to the SNMP
managers. Default: 162. Range: 1 to 65535
trap-v1-status {enable | disable}
Enable/disable SNMPv1 traps for this SNMP community. Default: enable
trap-v2c-rport <integer>
Enter the SNMPv2c remote port number used for sending traps to the
SNMP managers. Default: 162. Range: 1 to 65535
trap-v2c-status {enable | disable}
Enable/disable SNMPv2c traps for this SNMP community. SNMP v2c traps
sent out to SNMP managers include the community name. Default:
enable
Variables for config hosts subcommand:
<host_number>
Enter the index number of the host in the table. Enter an unused index number to create a new host.
interface <interface_name>
Enter the name of the FortiManager unit that connects to the SNMP manager.
ip <ipv4_address>
Enter the IPv4 address of the SNMP manager. Default: 0.0.0.0
Variables for config hosts6subcommand:
<host_number>
Enter the index number of the host in the table. Enter an unused index number to create a new host.
interface <interface_name>
Enter the name of the FortiManager unit that connects to the SNMP manager.
ip <ipv6_address>
Enter the IPv6 address of the SNMP manager.
Example
This example shows how to add a new SNMP community named SNMP_Com1. The default configuration can be
used in most cases with only a few modifications. In the example below the community is added, given a name,
and then because this community is for an SNMP manager that is SNMP v1 compatible, all v2c functionality is
CLI Reference
Fortinet Technologies Inc.
107
system
snmp
disabled. After the community is configured the SNMP manager, or host, is added. The SNMP manager IPv4
address is 192.168.20.34 and it connects to the FortiManager unit internal interface.
config system snmp community
edit 1
set name SNMP_Com1
set query-v2c-status disable
set trap-v2c-status disable
config hosts
edit 1
set interface internal
set ip 192.168.10.34
end
end
snmp sysinfo
Use this command to enable the FortiManager SNMP agent and to enter basic system information used by the
SNMP agent. Enter information about the FortiManager unit to identify it. When your SNMP manager receives
traps from the FortiManager unit, you will know which unit sent the information. Some SNMP traps indicate high
CPU usage, log full, or low memory.
For more information on SNMP traps and variables, see the Fortinet Document Library.
Syntax
config
set
set
set
set
set
set
set
set
end
108
system snmp sysinfo
contact-info <string>
description <description>
engine-id <string>
location <location>
status {enable | disable}
trap-high-cpu-threshold <percentage>
trap-low-memory-threshold <percentage>
trap-cpu-high-exclude-nice-threshold <percentage>
Variable
Description
contact-info <string>
Add the contact information for the person responsible for this FortiManager unit. Character limit: 35
description <description>
Add a name or description of the FortiManager unit. Character limit: 35
engine-id <string>
Local SNMP engine ID string. Character limit: 24
location <location>
Describe the physical location of the FortiManager unit. Character limit: 35
status {enable | disable}
Enable/disable the FortiManager SNMP agent. Default: disable
trap-high-cpu-threshold <percentage>
CPU usage when trap is set. Default: 80
CLI Reference
Fortinet Technologies Inc.
snmp
system
Variable
Description
trap-low-memory-threshold
<percentage>
Memory usage when trap is set. Default: 80
trap-cpu-high-exclude-nicethreshold <percentage>
CPU high usage excludes nice when the trap is sent.
Example
This example shows how to enable the FortiManager SNMP agent and add basic SNMP information.
config
set
set
set
set
end
system snmp sysinfo
status enable
contact-info 'System Admin ext 245'
description 'Internal network unit'
location 'Server Room A121'
snmp user
Use this command to configure SNMPv3 users on your FortiManager unit. To use SNMPv3, you will first need to
enable the FortiManager SNMP agent. For more information, see snmp sysinfo. There should be a
corresponding configuration on the SNMP server in order to query to or receive traps from FortiManager .
For more information on SNMP traps and variables, see the Fortinet Document Library.
Syntax
config system snmp user
edit <name>
set auth-proto {md5 | sha}
set auth-pwd <passwd>
set events <events_list>
set notify-hosts <ipv4_address>
set notify-hosts6 <ipv6_address>
set priv-proto {aes | des}
set priv-pwd <passwd>
set queries {enable | disable}
set query-port <integer>
set security-level {auth-no-priv | auth-priv | no-auth-no-priv}
end
end
Variable
Description
<name>
Enter a SNMPv3 user name to add, edit, or delete.
auth-proto {md5 | sha}
Authentication protocol. The security level must be set to auth-no-priv
or auth-priv to use this variable. The following options are available:
l
md5: HMAC-MD5-96 authentication protocol
l
CLI Reference
Fortinet Technologies Inc.
sha: HMAC-SHA-96 authentication protocol
109
system
snmp
Variable
Description
auth-pwd <passwd>
Password for the authentication protocol. The security level must be set to
auth-no-priv or auth-priv to use this variable.
events <events_list>
Enable the events for which the FortiManager unit should send traps to the
SNMPv3 managers in this community. The raid_changed event is only
available for devices which support RAID.
l
cpu-high-exclude-nice: CPU usage exclude nice threshold.
l
cpu_high: The CPU usage is too high.
l
disk_low: The log disk is getting close to being full.
l
ha_switch: A new unit has become the HA master.
l
intf_ip_chg: An interface IP address has changed.
l
lic-dev-quota: High licensed device quota detected.
l
lic-gbday: High licensed log GB/Day detected.
l
log-alert: Log base alert message.
l
log-data-rate: High incoming log data rate detected.
l
log-rate: High incoming log rate detected.
l
mem_low: The available memory is low.
l
raid_changed: RAID status changed.
l
sys_reboot: The FortiManager unit has rebooted.
Default: All events enabled.
notify-hosts <ipv4_address>
Hosts to send notifications (traps) to.
notify-hosts6 <ipv6_address>
Hosts to send notifications (traps) to.
priv-proto {aes | des}
Privacy (encryption) protocol. The security level must be set to auth-nopriv or auth-priv to use this variable. The following options are available:
l
aes: CFB128-AES-128 symmetric encryption protocol
l
priv-pwd <passwd>
Password for the privacy (encryption) protocol. The security level must be
set to auth-no-priv or auth-priv to use this variable.
queries {enable | disable}
Enable/disable queries for this user. Default: enable
query-port <integer>
SNMPv3 query port. Default: 161. Range: 1 to 65535
security-level {auth-no-priv |
auth-priv | no-auth-no-priv}
Security level for message authentication and encryption. The following
options are available:
l
auth-no-priv: Message with authentication but no privacy
(encryption).
l
l
110
des: CBC-DES symmetric encryption protocol
auth-priv: Message with authentication and privacy
(encryption).
no-auth-no-priv: Message with no authentication and no
privacy (encryption) (default).
CLI Reference
Fortinet Technologies Inc.
sql
system
sql
Configure Structured Query Language (SQL) settings.
Syntax
config
set
set
set
set
set
set
set
system sql
background-rebuild {enable | disable}
database-name <string>
database-type <postgres>
device-count-high {enable | disable}
event-table-partition-time <integer>
fct-table-partition-time <integer>
logtype {none | app-ctrl | attack | content | dlp | emailfilter | event |
generic | history | traffic | virus | voip | webfilter | netscan}
set password <passwd>
set prompt-sql-upgrade {enable | disable}
set rebuild-event {enable | disable}
set rebuild-event-start-time <hh:mm> <yyyy/mm/dd>
set reset {enable | disable}
set server <string>
set start-time <hh>:<mm> <yyyy>/<mm>/<dd>
set status {disable | local | remote}
set text-search-index {disable | enable}
set traffic-table-partition-time <integer>
set utm-table-partition-time <integer>
set username <string>
config custom-index
edit <id>
set device-type {FortiCache | FortiGate | FortiMail | FortiManager |
FortiSandbox | FortiWeb}
set index-field <Field-Name>
set log-type <Log-Enter>
end
config ts-index-field
edit <category>
set <value> <string>
end
end
Variable
Description
background-rebuild {enable |
disable}
Disable or enable rebuilding the SQL database in the background.
database-name <string>
Database name. Command only available when status is set to remote.
database-type <postgres>
Database type. Command only available when status is set to local or
remote.
CLI Reference
Fortinet Technologies Inc.
111
system
Variable
sql
Description
device-count-high {enable | dis- You must set to enable if the count of registered devices is greater than
able}
8000. The following options are available:
l
disable: Set to disable if device count is less than 8000.
enable: Set to enable if device count is equal to or greater than
8000.
Caution: Enabling or disabling this command will result in an SQL database
rebuild. The time required to rebuild the database is dependent on the size
of the database. Please plan a maintenance window to complete the database rebuild. This operation will also result in a device reboot.
l
event-table-partition-time
<integer>
Maximum SQL database table partitioning time range, in minutes, for
event logs. 0 to 525600 (minutes), or Enter 0 for unlimited.
fct-table-partition-time
<integer>
Maximum SQL database table partitioning time range, in minute, for
FortiClient logs. 0 to 525600 (minutes), or Enter 0 for unlimited.
logtype {none | app-ctrl | attack
| content | dlp | emailfilter |
event | generic | history | traffic
| virus | voip | webfilter
| netscan}
Log type. Command only available when status is set to local or
remote.
password <passwd>
The password that the Fortinet unit will use to authenticate with the remote
database. Command only available when status is set to remote.
prompt-sql-upgrade {enable |
disable}
Prompt to convert log database into SQL database at start time on GUI.
rebuild-event {enable | disable}
Enable/disable a rebuild event during SQL database rebuilding.
rebuild-event-start-time
<hh:mm> <yyyy/mm/dd>
The rebuild event starting date and time.
reset {enable | disable}
This command is hidden. The following options are available:
l
disable: Do not resend logs to database.
l
server <string>
Set the database ip or hostname.
start-time <hh>:<mm>
<yyyy>/<mm>/<dd>
Start date and time <hh:mm yyyy/mm/dd>. Command only available when
status is set to local or remote.
status {disable | local | remote}
SQL database status. The following options are available:
l
disable: Disable SQL database.
text-search-index {disable |
enable}
112
enable: Resend logs to database.
l
local: Enable local database.
l
remote: Enable remote database.
Disable or enable the creation of a text search index.
CLI Reference
Fortinet Technologies Inc.
sql
system
Variable
Description
traffic-table-partition-time
<integer>
Maximum SQL database table partitioning time range for traffic logs.
Range: 0 to 525 600 (minutes) enter 0 for unlimited
utm-table-partition-time
<integer>
Maximum SQL database table partitioning time range in minutes for UTM
logs. Range: 0 to 525600 (minutes).
Enter 0 for unlimited
username <string>
User name for login remote database.
Variables for config custom-index subcommand:
device-type {FortiCache |
FortiGate | FortiMail |
FortiManager | FortiSandbox |
FortiWeb}
Set the device type. The following options are available:
l
FortiCache: Set device type to FortiCache
l
FortiGate: Set device type to FortiGate.
l
FortiMail: Set device type to FortiMail.
l
FortiManager: Set device type to FortiManager.
l
FortiSandbox: Set device type to FortiSandbox
l
FortiWeb: Set device type to FortiWeb.
index-field <Field-Name>
Enter a valid field name. Select one of the available field names. The available options for index-field is dependent on the device-type entry.
log-type <Log-Enter>
Enter the log type. The available options for log-type is dependent on
the device-type entry. Enter one of the available log types.
l
FortiCache: N/A
l
CLI Reference
Fortinet Technologies Inc.
FortiGate: app-ctrl, content, dlp, emailfilter, event,
netscan, traffic, virus, voip, webfilter
l
FortiMail: emailfilter, event, history, virus
l
FortiManager: N/A
l
FortiSandbox: N/A
l
FortiWeb: attack, event, traffic
113
system
syslog
Variable
Description
Variables for config ts-index-field subcommand:
<category>
Category of the text search index fields. The following is the list of categories and their default fields. The following options are available:
l
FGT-app-ctrl: user, group, srcip, dstip, dstport,
service, app, action, status, hostname
l
FGT-attack: severity, srcip, proto, user, attackname
l
FGT-content: from, to, subject, action, srcip, dstip,
hostname, status
l
FGT-dlp: user, srcip, service, action, file
l
FGT-emailfilter: user, srcip, from, to, subject
l
FGT-event: subtype, ui, action, msg
l
FGT-traffic: user, srcip, dstip, service, app,
utmaction, utmevent
l
FGT-virus: service, srcip, file, virus, user
l
FGT-voip: action, user, src, dst, from, to
l
FGT-webfilter: user, srcip, status, catdesc
l
FGT-netscan: user, dstip, vuln, severity, os
l
FGT-fct-event
l
FGT-fct-traffic
l
FGT-fct-netscan
l
FML-emailfilter: client_name, dst_ip, from, to,
subject
l
FML-event: subtype, msg
l
FML-history: classifier, disposition, from, to,
client_name, direction, domain, virus
l
FML-virus: src, msg, from, to
l
FWB-attack: http_host, http_url, src, dst, msg,
action
l
FWB-event: ui, action, msg
l
FWB-traffic: src, dst, service, http_method, msg
<value>
Fields of the text search filter.
<string>
Select one or more field names separated with a comma. The available
field names is dependent on the category selected.
syslog
Use this command to configure syslog servers.
Syntax
config system syslog
114
CLI Reference
Fortinet Technologies Inc.
workflow approval-matrix
system
edit <name>
set ip <string>
set port <integer>
end
end
Variable
Description
ip <string>
Enter the syslog server IPv4 address or hostname.
port <integer>
Enter the syslog server port. Range: 1 to 65535
workflow approval-matrix
Use this command to configure workflow settings.
Syntax
config system workflow approval-matrix
edit <ADOM_name>
set mail-server <string>
set notify <string>
config approver
edit <sequence_number>
set member <string>
end
end
Variable
Description
mail-server <string>
Enter the mail server IPv4 address or hostname.
notify <string>
Enter the notified users. Use a comma as a separator.
Variables for config approver subcommand:
<sequence_number>
Enter the entry number.
member <string>
Enter the member of the approval group. Use a comma as a separator.
CLI Reference
Fortinet Technologies Inc.
115
fmupdate
Use fmupdate to configure settings related to FortiGuard service updates and the FortiManager unit’s built-in
FDS.
CLI commands and variables are case sensitive.
analyzer virusreport
Use this command to Enable/disable notification of virus detection to FortiGuard.
Syntax
config fmupdate analyzer virusreport
set status {enable | disable}
end
Variable
Description
status {enable | disable}
Enable/disable sending virus detection notification to FortiGuard. Default:
enable
Example
This example enables virus detection notifications to FortiGuard.
config fmupdate analyzer virusreport
set status enable
end
av-ips
Use the following commands to configure antivirus and IPS related settings.
av-ips advanced-log
Use this command to enable logging of FortiGuard antivirus and IPS update packages received by the
FortiManager unit’s built-in FDS from the external FDS.
Syntax
config fmupdate av-ips advanced-log
set log-fortigate {enable | disable}
set log-server {enable | disable}
end
116
CLI Reference
Fortinet Technologies Inc.
av-ips
fmupdate
Variable
Description
log-fortigate {enable | disable}
Enable/disable logging of FortiGuard antivirus and IPS service updates of
FortiGate devices. Default: disable
log-server {enable | disable}
Enable/disable logging of update packages received by the built-in FDS
server. Default: disable
Example
You could enable logging of FortiGuard antivirus updates to FortiClient installations and update packages
downloaded by the built-in FDS from the FDS.
config fmupdate av-ips advanced-log
set log-forticlient enable
set log-server enable
end
av-ips fct server-override
Use this command to override the default IPv4 or IPv6 address and port that the built-in FDS contacts when
requesting FortiGuard antivirus updates for FortiClient from the FDS.
Syntax
config fmupdate av-ips fct server-override
set status {enable | disable}
config servlist
edit <id>
set ip <ipv4_address>
set ip6 <ipv6_address>
set port <integer>
end
end
Variable
Description
status {enable | disable}
Enable/disable the override. Default: disable
Variables for config servlist subcommand:
<id>
Override server ID (1-10).
ip <ipv4_address>
Enter the IPv4 address of the override server. Default: 0.0.0.0
ip6 <ipv6_address>
Enter the IPv6 address of the override server.
port <integer>
Enter the port number to use when contacting the FDS. Default: 443.
Range: 1 to 65535
Example
You could configure the FortiManager unit’s built-in FDS to use a specific FDN server and a different port when
retrieving FortiGuard antivirus updates for FortiClient from the FDS.
config fmupdate av-ips fct server-override
CLI Reference
Fortinet Technologies Inc.
117
fmupdate
av-ips
set status enable
config servlist
edit 1
set ip 192.168.25.152
set port 80
end
end
av-ips fgt server-override
Use this command to override the default IPv4 or IPv6 address and port that the built-in FDS contacts when
requesting FortiGuard antivirus and IPS updates for FortiGate units from the FDS.
Syntax
config fmupdate av-ips fgt server-override
set status {enable | disable}
config servlist
edit <id>
set ip <ipv4_address>
set ip6 <ipv6_address>
set port <integer>
end
end
Variable
Description
status {enable | disable}
Enable/disable the override. Default: disable
Variable for config servlist subcommand:
<id>
Override server ID (1-10).
ip <ipv4_address>
Enter the IPv4 address of the override server. Default: 0.0.0.0
ip6 <ipv6_address>
Enter the IPv6 address of the override server.
port <integer>
Enter the port number to use when contacting the FDS. Default: 443.
Range: 1 to 65535
Example
You could configure the FortiManager unit’s built-in FDS to use a specific FDS server and a different port when
retrieving FortiGuard antivirus and IPS updates for FortiGate units from the FDS.
config fmupdate av-ips fgt server-override
set status enable
config servlist
edit 1
set ip 172.27.152.144
set port 8890
end
end
118
CLI Reference
Fortinet Technologies Inc.
av-ips
fmupdate
av-ips push-override
Use this command to Enable/disable push updates, and to override the default IP address and port to which the
FDS sends FortiGuard antivirus and IPS push messages.
This is useful if push notifications must be sent to an IP address and/or port other than the FortiManager unit,
such as the external or virtual IP address of a NAT device that forwards traffic to the FortiManager unit.
Syntax
config
set
set
set
set
end
fmupdate av-ips push-override
ip <ipv4_address>
ip6 <ipv6_address>
port <integer>
status {enable | disable}
Variable
Description
ip <ipv4_address>
Enter the external or virtual IPv4 address of the NAT device that will forward
push messages to the FortiManager unit. Default: 0.0.0.0
ip6 <ipv6_address>
Enter the external or virtual IPv6 address of the NAT device that will forward
push messages to the FortiManager unit.
port <integer>
Enter the receiving port number on the NAT device. Default: 9443. Range:
1 to 65535
status {enable | disable}
Enable/disable the push updates. Default: disable
Example
You could enable the FortiManager unit’s built-in FDS to receive push messages.
If there is a NAT device or firewall between the FortiManager unit and the FDS, you could also notify the FDS to
send push messages to the external IP address of the NAT device, instead of the FortiManager unit’s private
network IP address.
config
set
set
set
end
fmupdate av-ips push-override
status enable
ip 172.16.124.135
port 9000
You would then configure port forwarding on the NAT device, forwarding push messages received on User
Datagram Protocol (UDP) port 9000 to the FortiManager unit on UDP port 9443.
av-ips push-override-to-client
Use this command to enable/disable push updates, and to override the default IP address and port to which the
FDS sends FortiGuard antivirus and IPS push messages.
This command is useful if push notifications must be sent to an IP address and/or port other than the
FortiManager unit, such as the external or virtual IP address of a NAT device that forwards traffic to the
FortiManager unit.
CLI Reference
Fortinet Technologies Inc.
119
fmupdate
av-ips
Syntax
config fmupdate av-ips push-override-to-client
set status {enable | disable}
config <announce-ip>
edit <id>
set ip <ipv4_address>
set ip6 <ipv6_address>
set port <integer>
end
end
Variable
Description
status {enable | disable}
Enable/disable the push updates. Default: disable
<announce-ip>
Configure the IP address information of the device.
Variables for config announce-ip subcommand:
<id>
Edit the announce IP address ID.
ip <ipv4_address>
Enter the announce IPv4 address. Default: 0.0.0.0
ip6 <ipv6_address>
Enter the announce IPv6 address.
port <integer>
Enter the announce IP port. Default: 9443. Range: 1 to 65535
av-ips update-schedule
Use this command to configure the built-in FDS to retrieve FortiGuard antivirus and IPS updates at a specified
day and time.
Syntax
config
set
set
set
set
end
120
fmupdate av-ips update-schedule
day {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}
frequency {every | daily | weekly}
status {enable | disable}
time <hh:mm>
Variable
Description
day {Sunday | Monday | Tuesday | Wednesday | Thursday |
Friday | Saturday}
Enter the day of the week when the update will begin.
This option only appears when the frequency is weekly.
frequency
{every | daily | weekly}
Enter to configure the frequency of the updates. The following options are
available: l
every: Time interval (default)
l
daily: Every day
l
weekly: Every week
CLI Reference
Fortinet Technologies Inc.
av-ips
fmupdate
Variable
Description
status {enable | disable}
Enable/disable regularly scheduled updates. Default: enable
time <hh:mm>
Enter to configure the time or interval when the update will begin. For
example, if you want to schedule an update every day at 6:00 PM, enter
18:00.
The time period format is the 24-hour clock: hh=0-23, mm=0-59. If the
minute is 60, the updates will begin at a random minute within the hour.
If the frequency is every, the time is interpreted as an hour and minute
interval, rather than a time of day.
Default: 01:60
Example
You could schedule the built-in FDS to request the latest FortiGuard antivirus and IPS updates every five hours,
at a random minute within the hour.
config
set
set
set
end
fmupdate av-ips udpate-schedule
status enable
frequency every
time 05:60
av-ips web-proxy
Use this command to configure a web proxy if FortiGuard antivirus and IPS updates must be retrieved through a
web proxy.
Syntax
config
set
set
set
set
set
set
set
end
fmupdate av-ips web-proxy
ip <ipv4_address>
ip6 <ipv6_address>
mode {proxy | tunnel}
password <passwd>
port <integer>
status {enable | disable}
username <string>
Variable
Description
ip <ipv4_address>
Enter the IPv4 address of the web proxy. Default: 0.0.0.0
ip6 <ipv6_address>
Enter the IPv6 address of the web proxy.
mode {proxy | tunnel}
Enter the web proxy mode. The following options are available: l
proxy: HTTP proxy.
l
password <passwd>
CLI Reference
Fortinet Technologies Inc.
tunnel: HTTP tunnel.
If the web proxy requires authentication, enter the password for the user
name. Character limit: 63
121
fmupdate
custom-url-list
Variable
Description
port <integer>
Enter the port number of the web proxy. Default: 80. Range: 1 to 65535
status {enable | disable}
Enable/disable connections through the web proxy. Default: disable
username <string>
If the web proxy requires authentication, enter the user name. Character
limit: 63
Example
You could enable a connection through a non-transparent web proxy on an alternate port.
config
set
set
set
set
set
set
end
fmupdate av-ips web-proxy
status enable
mode proxy
ip 10.10.30.1
port 8890
username avipsupdater
password cvhk3rf3u9jvsYU
custom-url-list
Use this command to configure the URL database for rating and filtering. You can select to use the FortiGuard
URL database, a custom URL database, or both. When selecting to use a custom URL database, use the
fmupdate {ftp | scp | tftp} import command to import the custom URL list. When FortiManager performs the URL
rating, it will check the custom URL first. If a match is found, the custom rating is returned. If there is no match,
then FortiManager will check the FortiGuard database.
Syntax
config fmupdate custom-url-list
set db_selection {both | custom-url | fortiguard-db}
end
Variable
Description
db_selection {both | customurl | fortiguard-db}
Manage the FortiGuard URL database. The following options are available: l
both: Support both custom URL database and the FortiGuard
database
l
custom-url: Customer imported URL list.
l
fortiguard-db: Fortinet’s FortiGuard database
Default setting: both
device-version
Use this command to configure the correct firmware version of the device or devices connected or will be
connecting to the FortiManager unit. You should verify what firmware version is currently running on the device
122
CLI Reference
Fortinet Technologies Inc.
disk-quota
fmupdate
before using this command.
Syntax
config
set
set
set
set
set
set
end
fmupdate device-version
faz <firmware_version>
fct <firmware_version>
fgt <firmware_version>
fml <firmware_version>
fsa <firmware_version>
fsw <firmware_version>
Variable
Description
faz <firmware_version>
Enter the correct firmware version that is currently running on the FortiAnalyzer units. The following options are available: l
3.0: Support version 3.0
l
4.0: Support version 4.0
l
5.0: Support version 5.0
l
6.0: Support version greater than 5.0
fct <firmware_version>
Enter the firmware version that is currently running for FortiClient agents:
3.0, 4.0, 5.0, or 6.0.
fgt <firmware_version>
Enter the firmware version that is currently running for FortiGate units: 3.0,
4.0, 5.0, or 6.0.
fml <firmware_version>
Enter the firmware version that is currently running for the FortiMail units:
3.0, 4.0, 5.0, or 6.0.
fsa <firmware_version>
Enter the firmware version that is currently running for the FortiSandbox
units. The following options are available: l
1.0: Support version 1.0. (FortiSandbox)
l
fsw <firmware_version>
2.0: Support version greater than 1.0.
Enter the firmware version that is currently running for the FortiSwitch units:
3.0, 4.0, 5.0, or 6.0.
Example
In the following example, the FortiGate units, including FortiClient agents, are configured with the firmware
version 5.0.
config
set
set
set
end
fmupdate device-version
faz 4.0
fct 5.0
fgt 5.0
disk-quota
Use this command to configure the disk space available for use by the Upgrade Manager.
CLI Reference
Fortinet Technologies Inc.
123
fmupdate
fct-services
If the Upgrade Manager disk space is full or if there is insufficient space to save an update package to disk, the
package will not download and an alert will be sent to notify you.
Syntax
config fmupdate disk-quota
set value <size_int>
end
Use value to set the size of the Upgrade Manager disk quota in megabytes (MB). The default size is 10
gigabytes (GB). If you set the disk-quota smaller than the size of an update package, the update package will not
download and you will get a disk full alert.
fct-services
Use this command to configure the built-in FDS to provide FortiGuard services to FortiClient installations.
Syntax
config fmupdate fct-services
set status {enable | disable}
set port <integer>
end
Variable
Description
status {enable | disable}
Enable/disable built-in FDS service to FortiClient installations. Default:
enable
port <integer>
Enter the port number on which the built-in FDS should provide updates to
FortiClient installations. Default: 80. Range: 1 to 65535
Example
You could configure the built-in FDS to accommodate older versions of FortiClient installations by providing
service on their required port.
config fmupdate fct-services
set status enable
set port 80
end
fds-setting
Use this command to set FDS settings.
Syntax
config
set
set
set
end
124
fmupdate fds-settings
fds-pull-interval <integer>
max-av-ips-version <integer>
User-Agent <text>
CLI Reference
Fortinet Technologies Inc.
multilayer
fmupdate
Variable
Description
fds-pull-interval <integer>
Time interval FortiManager may pull updates from FDS. Range: 1 to 120
(minutes)
max-av-ips-version <integer>
The maximum number of AV/IPS full version downloadable packages.
Range: 1 to 1000
User-Agent <text>
Configure the User-Agent string.
multilayer
Use this command to set multilayer mode configuration.
Syntax
config fmupdate multilayer
set webspam-rating {disable | enable}
end
Variable
Description
webspam-rating {disable |
enable}
URL/Antispam rating service. Default: enable
publicnetwork
Use this command to enable access to the public FDS. If this function is disabled, the service packages, updates,
and license upgrades must be imported manually.
Syntax
config fmupdate publicnetwork
set status {disable | enable}
end
Variable
Description
status {disable | enable}
Enable/disable the public network. Default: enable
Example
The following example shows how to enable public network.
config fmupdate publicnetwork
(publicnetwork) # set status enable
end
CLI Reference
Fortinet Technologies Inc.
125
fmupdate
server-access-priorities
server-access-priorities
Use this command to configure how a FortiGate unit may download antivirus updates and request web filtering
services from multiple FortiManager units and private FDS servers.
Use the private-server subcommand to configure multiple FortiManager units and private servers.
By default, the FortiGate unit receives updates from the FortiManager unit if the FortiGate
unit is managed by the FortiManager unit and the FortiGate unit was configured to receive
updates from the FortiManager unit.
Syntax
config fmupdate server-access-priorities
set access-public {disable | enable}
set av-ips {disable | enable}
set web-spam {disable | enable}
config private-server
edit <id>
set ip <ipv4_address>
set ip6 <ipv6_address>
set time_zone <integer>
end
end
Variable
Description
access-public {disable | enable} Disable to prevent FortiManager default connectivity to public FDS and
FortiGuard servers. Default: enable
av-ips {disable | enable}
Enable to allow the FortiGate unit to get antivirus updates from other
FortiManager units or private FDS servers. Default: disable
web-spam {disable | enable}
Enable/disable private server in web-spam.
Variables for config private-server subcommand:
<id>
Enter a number to identify the FortiManager unit or private server. Range: 1
to 10
ip <ipv4_address>
Enter the IPv4 address of the FortiManager unit or private server.
ip6 <ipv6_address>
Enter the IPv6 address of the FortiManager unit or private server.
time_zone <integer>
Enter the correct time zone of the private server. Using -24 indicates that
the server is using the local time zone.
Example
The following example configures access to public FDS servers and allows FortiGate units to receive antivirus
updates from other FortiManager units and private FDS servers. This example also configures three private
servers.
config fmupdate server-access-priorities
126
CLI Reference
Fortinet Technologies Inc.
server-override-status
fmupdate
set access-public enable
set av-ips enable
config private-server
edit 1
set ip 172.16.130.252
next
edit 2
set ip 172.31.145.201
next
edit 3
set ip 172.27.122.99
end
end
server-override-status
Syntax
config fmupdate server-override-status
set mode {loose | strict}
end
Variable
Description
mode {loose | strict}
Set the server override mode. The following options are available: l
loose: Allow access other servers (default).
l
strict: Access override server only.
service
Use this command to Enable/disable the services provided by the built-in FDS.
Syntax
config
set
set
set
set
set
set
set
end
fmupdate service
avips {enable | disable}
query-antispam {disable | enable}
query-antivirus {disable | enable}
query-filequery {disable | enable}
query-webfilter {disable | enable}
use-cert {BIOS | FortiGuard}
webfilter-https-traversal {disable | enable}
Variable
Description
avips {enable | disable}
Enable/disable the built-in FDS to provide FortiGuard antivirus and IPS
updates. Default: disable
query-antispam {disable |
enable}
Enable/disable antispam service.
CLI Reference
Fortinet Technologies Inc.
127
fmupdate
support-pre-fgt43
Variable
Description
query-antivirus {disable |
enable}
Enable/disable antivirus service.
query-filequery {disable |
enable}
Enable/disable file query service.
query-webfilter {disable |
enable}
Enable/disable web filter service.
use-cert {BIOS | FortiGuard}
Choose local certificate. The following options are available: l
BIOS: Use default certificate in BIOS (default).
l
webfilter-https-traversal
{disable | enable}
FortiGuard: Use default certificate as FortiGuard.
Enable/disable Web Filter HTTPS traversal.
Example
config fmupdate service
set avips enable
end
support-pre-fgt43
Use this command to support FortiMail 4.2 devices for FortiGuard Center updates.
Syntax
config fmupdate support-pre-fgt43
set status {enable | disable}
end
end
Variable
Description
status {enable | disable}
Enable/disable update support. Default: disable
web-spam
Use the following commands to configure FortiGuard antispam related settings.
web-spam fct server-override
Use this command to override the default IP address and port that the built-in FDS contacts when requesting
FortiGuard antispam updates for FortiClient from the FDS.
128
CLI Reference
Fortinet Technologies Inc.
web-spam
fmupdate
Syntax
config fmupdate web-spam fct server-override
set status {enable | disable}
config servlist
edit <id>
set ip <ipv4_address>
set ip6 <ipv6_address>
set port <integer>
end
end
Variable
Description
status {enable | disable}
Enable/disable the override. Default: disable
Variable for config servlistsubcommand:
<id>
Override server ID. Range: 1 to 10
ip <ipv4_address>
Enter the IPv4 address of the override server. Default: 0.0.0.0
ip6 <ipv6_address>
Enter the IPv6 address of the override server.
port <integer>
Enter the port number to use when contacting the FDS. Default: 443.
Range: 1 to 65535
web-spam fgd-log
Use this command to configure the FortiGuard web-spam log settings.
Syntax
config
set
set
set
end
fmupdate web-spam fgd-log
spamlog {all | disable | nospam}
status {disable | enable}
urllog {all | disable | miss}
Variable
Description
spamlog {all | disable |
nospam}
Configure the anti spam log settings. The following options are available: l
all: Log all Spam lookups
l
disable: Disable Spam log
l
nospam: Log Non-spam events.
status {disable | enable}
Enable/disable the FortiGuard server event log status.
urllog {all | disable | miss}
Configure the web filter log setting. The following options are available: l
all: Log all URL lookups
CLI Reference
Fortinet Technologies Inc.
l
disable: Disable URL log
l
miss: Log URL rating misses.
129
fmupdate
web-spam
web-spam fgd-setting
Use this command to configure FortiGuard run parameters.
Syntax
config
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
end
130
fmupdate web-spam fgd-setting
as-cache <integer>
as-log {all | disable | nospam}
as-preload {disable | enable}
av-cache <integer>
av-log {all | disable | novirus}
av-preload {disable | enable}
eventlog-query {disable | enable}
fq-cache <integer>
fq-log {all | disable | nofilequery}
fq-preload {disable | enable}
linkd-log {disable | enable}
max-log-quota <integer>
max-unrated-size <integer>
restrict-as1-dbver <string>
restrict-as2-dbver <string>
restrict-as4-dbver <string>
restrict-av-dbver <string>
restrict-fq-dbver <string>
restrict-wf-dbver <string>
stat-log-interval <integer>
stat-sync-interval <integer>
update-interval <integer>
update-log {disable | enable}
wf-cache <integer>
wf-log {all | disable | nourl}
wf-preload {disable | enable}
Variable
Description
as-cache <integer>
Set the antispam service maximum memory usage. Range: 100 to 2800
(MB)
as-log {all | disable | nospam}
Antispam log setting. The following options are available: l
all: Log all spam lookups.
l
disable: Disable spam log.
l
nospam: Log non-spam events.
as-preload {disable | enable}
Enable/disable preloading the antispam database into memory.
av-cache <integer>
Set the web filter service maximum memory usage. Range: 100 to 500
(MB)
CLI Reference
Fortinet Technologies Inc.
web-spam
fmupdate
Variable
Description
av-log {all | disable | novirus}
Antivirus log settings. The following options are available: l
all: Log all virus lookups.
l
disable: Disable virus log.
l
novirus: Log non-virus events.
av-preload {disable | enable}
Enable/disable preloading the antivirus database into memory.
eventlog-query {disable |
enable}
Enable or disable record query to event-log besides fgd-log.
fq-cache <integer>
Set the file query service maximum memory usage. Range: 100 to 500MB
fq-log
{all | disable | nofilequery}
Filequery log settings. The following options are available: l
all: Log all file query.
l
disable: Disable file query log.
l
nofilequery: Log non-file query events.
fq-preload {disable | enable}
Enable/disable preloading the filequery database to memory.
linkd-log {disable | enable}
Enable/disable the linkd log.
max-log-quota <integer>
Maximum log quota setting. Range: 100 to 20480MB
max-unrated-size <integer>
Maximum number of unrated site in memory.
Range: 10 to 5120K
Default: 500K
restrict-as1-dbver <string>
Restrict the system update to the indicated antispam(1) database version.
Character limit: 127
restrict-as2-dbver <string>
Restrict the system update to the indicated antispam(2) database version.
Character limit: 127
restrict-as4-dbver <string>
Restrict the system update to the indicated antispam(4) database version.
Character limit: 127
restrict-av-dbver <string>
Restrict the system update to the indicated antivirus database version.
Character limit: 127
restrict-fq-dbver <string>
Restrict the system update to the indicated filequery database version.
Character limit: 127
restrict-wf-dbver <string>
Restrict the system update to the indicated webfilter database version.
Character limit: 127
stat-log-interval <integer>
Statistic log interval setting. Range: 1 to 1440 (minutes)
stat-sync-interval <integer>
Synchronization interval for statistics of unrated sites. Range: 1 to 60
(minutes)
CLI Reference
Fortinet Technologies Inc.
131
fmupdate
web-spam
Variable
Description
update-interval <integer>
Enter the FortiGuard database update wait time if there are not enough
delta files. Range: 2 to 24 (hours)
update-log {disable | enable}
Enable/disable update log setting.
wf-cache <integer>
Enter the web filter service maximum memory usage. Range: 100 to 2800
(MB)
wf-log {all | disable | nourl}
Web filter log setting. The following options are available: l
all: Log all URL lookups.
wf-preload {disable | enable}
l
disable: Disable URL log.
l
nourl: Log non-URL events.
Enable/disable preloading the web filter database into memory.
web-spam fgt server-override
Use this command to override the default IP address and port that the built-in FDS contacts when requesting
FortiGuard spam updates for FortiGate from the FDS.
Syntax
config fmupdate web-spam fgt server-override
set status {enable | disable}
config servlist
edit <id>
set ip <ipv4_address>
set ip6 <ipv6_address>
set port <integer>
end
end
Variable
Description
status {enable | disable}
Enable/disable the override. Default: disable
Variable for config servlistsubcommand:
132
<id>
Enter the override server ID. Range: 1 to 10
ip <ipv4_address>
Enter the IPv4 address of the override server address. Default: 0.0.0.0
ip6 <ipv6_address>
Enter the IPv6 address of the override server address.
port <integer>
Enter the port number to use when contacting the FDS. Default: 443.
Range: 1 to 65535
CLI Reference
Fortinet Technologies Inc.
web-spam
fmupdate
web-spam fsa server-override
Use this command to override the default IP address and port that the built-in FDS contacts when requesting
FortiGuard spam updates for FortiSandbox from the FDS.
Syntax
config fmupdate web-spam fsa server-override
set status {enable | disable}
config servlist
edit <id>
set ip <ipv4_address>
set ip6 <ipv6_address>
set port <integer>
end
end
Variable
Description
status {enable | disable}
Enable/disable the override. Default: disable
Variable for config servlistsubcommand:
<id>
Override server ID. Range: 1 to 10
ip <ipv4_address>
Enter the IPv4 address of the override server. Default: 0.0.0.0
ip6 <ipv6_address>
Enter the IPv6 address of the override server.
port <integer>
Enter the port number to use when contacting the FDS. Default: 443.
Range: 1 to 65535
web-spam poll-frequency
Use this command to configure the web-spam poll frequency.
Syntax
config fmupdate web-spam poll-frequency
set time <hh:mm>
end
Variable
Description
time <hh:mm>
Enter the poll frequency time interval
web-spam web-proxy
Use this command to configure the web-spam web-proxy.
Syntax
config fmupdate web-spam web-proxy
set time <hh:mm>
CLI Reference
Fortinet Technologies Inc.
133
fmupdate
web-spam
set
set
set
set
set
set
end
ip <proxy_ipv4_address>
ip6 <proxy_ipv6_address>
mode {proxy | tunnel}
password <passwd>
port <integer>
status {disable | enable}
Variable
Description
ip <proxy_ipv4_address>
Enter the IPv4 address of the web proxy. Default: 0.0.0.0
ip6 <proxy_ipv6_address>
Enter the IPv6 address of the web proxy.
mode {proxy | tunnel}
Enter the web proxy mode. The following options are available: l
proxy: HTTP proxy.
l
134
tunnel: HTTP tunnel.
password <passwd>
If the web proxy requires authentication, type the password for the user
name.
port <integer>
Enter the port number of the web proxy. Default: 80. Range: 1 to 65535
status {disable | enable}
Enable/disable connections through the web proxy. Default: disable
username <string>
If the web proxy requires authentication, enter the user name.
CLI Reference
Fortinet Technologies Inc.
execute
The execute commands perform immediate operations on the FortiManager unit. You can:
l
Back up and restore the system settings, or reset the unit to factory settings.
l
Set the unit date and time.
l
Use ping to diagnose network problems.
l
View the processes running on the FortiManager unit.
l
Start and stop the FortiManager unit.
l
Reset or shut down the FortiManager unit.
FortiManager CLI commands and variables are case sensitive.
add-vm-license
Add a VM license to the FortiManager.
Syntax
execute add-vm-license <vm_license>
Variable
Description
<vm_license>
The VM license string.
This command is only available on FortiManager VM models.
backup
Use this command to backup the configuration or database to a file.
When you back up the unit settings from the vdom_admin account, the backup file contains global settings and
the settings for each VDOM. When you back up the unit settings from a regular administrator account, the backup
file contains the global settings and only the settings for the VDOM to which the administrator belongs.
Syntax
execute backup all-settings {ftp | scp | sftp} <ip> <string> <username> <passwd> <sshcert> <crptpasswd>
execute backup logs <device name(s)> {ftp | scp | sftp} <ip> <username> <passwd>
<directory>
execute backup logs-only <device name(s)> {ftp | scp | sftp} <ip> <username> <passwd>
<directory>
CLI Reference
Fortinet Technologies Inc.
135
execute
backup
execute backup logs-rescue <device serial number(s)> {ftp | scp | sftp} <ip> <username>
<passwd> <directory>
execute backup reports <report schedule name(s)> {ftp | scp | sftp} <ip> <username>
<passwd> <directory>
execute backup reports-config <adom name(s)> {ftp | scp | sftp} <ip> <username> <passwd>
<directory>
136
Variable
Description
all-settings
Backup all FortiManager settings to a file on a server.
logs
Backup the device logs to a specified server.
logs-only
Backup device logs only to a specified server.
logs-rescue
Use this hidden command to backup logs regardless of DVM database for
emergency reasons. This command will scan folders under /Storage/Logs/
for possible device logs to backup.
reports
Backup the reports to a specified server.
reports-config
Backup reports configuration to a specified server.
<device name(s)>
Enter the device name(s) separated by a comma, or enter all for all
devices.
<device serial number(s)>
Enter the device serial number(s) separated by a comma, or enter all for
all devices.
<report schedule name(s)>
Enter the report schedule name(s) separated by a comma, or enter all for
all reports schedules.
<adom name(s)>
Enter the ADOM name(s) separated by a comma, or enter all for all
ADOMs.
{ftp | scp | sftp}
Enter the server type: ftp, scp, or sftp.
<ip>
Enter the server IP address.
<string>
Enter the path and file name for the backup.
<username>
Enter username to use to log on the backup server.
<passwd>
Enter the password for the username on the backup server.
<ssh-cert>
Enter the SSH certification for the server. This option is only available for
backup operations to SCP servers.
<crptpasswd>
Optional password to protect backup content. Use any for no password.
<directory>
Enter the path to where the file will be backed up to on the backup server.
CLI Reference
Fortinet Technologies Inc.
bootimage
execute
Example
This example shows how to backup the FortiManager unit system settings to a file named fmg.cfg on a server
at IP address 192.168.1.23 using the admin username, a password of 123456.
execute backup all-settings ftp 192.168.1.23 fmd.cfg admin 123456
Starting backup all settings...
Starting transfer the backup file to FTP server...
bootimage
Use this command to set the boot image partition.
Syntax
execute bootimage <primary | secondary>
This command is only available on FortiManager hardware models.
certificate
Use these commands to manage certificates.
certificate ca
Use these commands to list CA certificates, and to import or export CA certificates.
Syntax
To list the CA certificates installed on the FortiManager unit:
execute certificate ca list
To export or import CA certificates:
execute certificate ca {<export>|<import>} <cert_name> <tftp_ip>
Variable
Description
list
Generate a list of CA certificates on the FortiManager system.
<export>
Export CA certificate to TFTP server.
<import>
Import CA certificate from a TFTP server.
<cert_name>
Name of the certificate.
<tftp_ip>
IP address of the TFTP server.
CLI Reference
Fortinet Technologies Inc.
137
execute
certificate
certificate local
Use these commands to list local certificates, and to import or export local certificates. To generate a certificate
request, see “certificate local generate” on page 170.
Syntax
To list the local certificates installed on the FortiManager unit:
execute certificate local list
To export or import local certificates:
execute certificate local {<export>|<import>} <cert_name> <tftp_ip>
Variable
Description
list
Generate a list of CA certificates on the FortiManager system.
<export>
Export CA certificate to TFTP server.
<import>
Import CA certificate from a TFTP server.
<cert_name>
Name of the certificate.
<tftp_ip>
IP address of the TFTP server.
certificate local generate
Use this command to generate a certificate request.
Syntax
execute certificate local generate <certificate-name_str> <subject> <number> [<optional_
information>]
138
Variable
Description
<certificate-name_str>
Enter a name for the certificate. The name can contain numbers (0-9),
uppercase and lowercase letters (A-Z, a-z), and the special characters - and
_. Other special characters and spaces are not allowed.
<number>
Enter 512, 1024, 1536, or 2048 for the size, in bits, of the encryption key.
<subject>
Enter one of the following pieces of information to identify the FortiManager unit being certified:
l
The FortiManager unit IP address
l
The fully qualified domain name of the FortiManager unit
l
An email address that identifies the FortiManager unit
l
An IP address or domain name is preferable to an email address.
CLI Reference
Fortinet Technologies Inc.
chassis
execute
Variable
Description
[<optional_information>]
Enter optional_information as required to further identify the unit.
See the below table for the list of optional information variables. You must
enter the optional variables in the order that they are listed in the table.
To enter any optional variable you must enter all of the variables that come
before it in the list.
For example, to enter the organization_name_str, you must first
enter the country_code_str, state_name_str, and city_name_
str.
While entering optional variables, you can type? for help on the next
required variable.
Optional information variables
Variable
Description
<country_code_str>
Enter the two-character country code.
<state_name_str>
Enter the name of the state or province where the FortiManager unit is located.
<city_name_str>
Enter the name of the city, or town, where the person or organization certifying the FortiManager unit resides.
<organization-name_str>
Enter the name of the organization that is requesting the certificate for the
FortiManager unit.
<organization-unit_name_str>
Enter a name that identifies the department or unit within the organization
that is requesting the certificate for the FortiManager unit.
<email_address_str>
Enter a contact email address for the FortiManager unit.
<ca_server_url>
Enter the URL of the CA (SCEP) certificate server that allows auto-signing
of the request.
<challenge_password>
Enter the challenge password for the SCEP certificate server.
chassis
Use this command to replace a chassis device password on your device.
Syntax
execute chassis replace <pw>
Variable
Description
<pw>
Replace the chassis password.
CLI Reference
Fortinet Technologies Inc.
139
execute
console baudrate
This command is only available on devices that support chassis management.
console baudrate
Use this command to get or set the console baudrate.
Syntax
execute console baudrate [9600 | 19200 | 38400 | 57600 | 115200]
If you do not specify a baudrate, the command returns the current baudrate.
Setting the baudrate will disconnect your console session.
Example
Get the baudrate:
execute console baudrate
The response is displayed:
current baud rate is: 115200
Set the baudrate to 9600:
execute console baudrate 9600
date
Get or set the FortiManagersystem date.
Syntax
execute date [<date_str>]
date_str has the form mm/dd/yyyy, where
l
mm is the month and can be 01 to 12
l
dd is the day of the month and can be 01 to 31
l
yyyy is the year and can be 2001 to 2100
If you do not specify a date, the command returns the current system date.
Dates entered will be validated - mm and dd require 2 digits, and yyyy requires 4 digits. Entering fewer digits will
result in an error.
Example
This example sets the date to 17 September 2010:
execute date 09/17/2010
140
CLI Reference
Fortinet Technologies Inc.
device
execute
device
Use this command to change a device password or serial number when changing devices due to a hardware
issue.
Syntax
execute device replace pw <device_name> <password>
execute device replace sn <device_name> <serial_number>
Variable
Description
<device_name>
The name of the device.
<password>
The device password.
<device_name>
The name of the device.
<serial_number>
The new serial number.
Example
execute device replace pw FGT600C2805030002
This operation will clear the password of the device.
Do you want to continue? (y/n)y
dmserver
Use these commands to manage devices and revisions.
dmserver
dmserver showdev
dmserver revlist
dmserver showrev
dmserver showconfig
dmserver delrev
Use this command to delete configuration revisions. The device name will be kept.
Syntax
execute dmserver delrev <device_name> <startrev> <endrev>
Variable
Description
<device_name>
The name of the device.
<startrev>
The starting configuration revision number that you want to delete.
<endrev>
The ending configuration revision number that you want to delete.
CLI Reference
Fortinet Technologies Inc.
141
execute
dmserver
dmserver revlist
Use this command to show a list of revisions for a device.
Syntax
execute dmserver revlist <device_name>
Variable
Description
<device_name>
The name of the device.
dmserver showconfig
Use this command to show a specific configuration type and revision. You cannot use this command with readonly permission.
Syntax
execute dmserver showconfig <device_name>
Variable
Description
<device_name>
The name of the device.
dmserver showdev
Use this command to show a list of available devices. For each listed device, this command lists the device ID,
device name, and serial number.
Syntax
execute dmserver showdev
dmserver showrev
Use this command to display a device’s configuration revision. You cannot use this command with read-only
permission.
Syntax
execute dmserver showrev <device_name> <revision>
142
Variable
Description
<device_name>
The name of the device.
<revision>
The configuration revision you want to display.
CLI Reference
Fortinet Technologies Inc.
factory-license
execute
factory-license
Use this command to enter a factory license key. This command is hidden.
Syntax
execute factory-license <key>
The following table lists command variables, description, and default values where applicable.
Variables
Description
<key>
Enter the factory license key.
fgfm reclaim-dev-tunnel
Use this command to reclaim a management tunnel. The device name is optional.
Syntax
execute fgfm reclaim-dev-tunnel <device_name>
Variable
Description
<device_name>
Enter the device name.
fmpolicy
Use these commands to perform policy and object related actions:
fmpolicy
fmpolicy print-adom-package
fmpolicy copy-adom-object
fmpolicy print-device-database
fmpolicy install-config
fmpolicy print-device-object
fmpolicy print-adom-database
fmpolicy print-prov-templates
fmpolicy print-adom-object
fmpolicy check-upgrade-object
Use this command to check/upgrade objects by syntax.
Syntax
execute fmpolicy check-upgrade-object manual {checking | fixing} {basic | auto | misc |
full}
execute fmpolicy check-upgrade-object report
execute fmpolicy check-upgrade-object reset
CLI Reference
Fortinet Technologies Inc.
143
execute
fmpolicy
Variable
Description
<action>
Enter the auto upgrade action. The following options are available:
l
manual: run auto-upgrade manually.
{checking | fixing}
l
report: show checking/upgrade report.
l
reset: cleanup saved checking/upgrade status
The following options are available:
l
checking: only do checking.
l
{basic | auto | misc | full}
fixing: checking and fixing.
The following options are available:
l
basic: only do basic (know cases) checking/fixing.
l
auto: only do auto (syntax based) checking/fixing.
l
misc: only do misc (know cases) checking/fixing.
l
full: do a full basic/auto/misc checking/fixing.
fmpolicy copy-adom-object
Use this command to set the policy to copy an ADOM object.
Syntax
execute fmpolicy copy-adom-object <adom> <category> <key> <device> <vdom>
Variable
Description
<adom>
Enter the name of the ADOM.
<category>
Enter the name of the category in the ADOM.
<key>
Enter the name of the object key.
<device>
Enter the name of the device.
<vdom>
Enter the name of the VDOM.
fmpolicy install-config
Use this command to install the configuration for an ADOM.
Syntax
execute fmpolicy install-config <adom> <device_id> <revname>
144
Variable
Description
<adom>
Enter the name of the ADOM.
<device_id>
Enter the device id of the ADOM.
<revname>
Enter the revision name.
CLI Reference
Fortinet Technologies Inc.
fmpolicy
execute
fmpolicy print-adom-database
Use this command to display the device database configuration for an ADOM.
Syntax
execute fmpolicy print-adom-database <adom_name> <output_filename>
fmpolicy print-adom-object
Use this command to display the device objects.
Syntax
execute fmpolicy print-adom-object <adom_name>
execute fmpolicy print-adom-object <adom_name> <category> {all | list} <output>
execute fmpolicy print-adom-object Global <category> {all | list} <output>
Variable
Description
<adom_name>
Enter the name of the ADOM or “Global”.
<category>
Enter the category name.
{all | list}
The following options are available:
l
all: Show all objects.
l
<output>
list: Get all objects.
Output file name (output dump to file: [/tmp/pl]).
fmpolicy print-adom-package
Use this command to display the package for an ADOM.
Syntax
execute fmpolicy print-adom-package <adom> <package_name> <category_name> <object_name>
<output>
execute fmpolicy print-adom-package Global <package_name> <category_name> {all | list}
<output>
Variable
Description
<adom>
Enter the name of the ADOM or “Global”.
<package_name>
Enter the package name ID.
<category_name>
Enter the category name.
{all | list}
The following options are available:
l
all: Show all objects.
l
CLI Reference
Fortinet Technologies Inc.
list: Get all objects.
145
execute
fmpolicy
Variable
Description
<object_name>
Show object by name. Enter all to show all objects, or enter list to get
all objects.
<output>
Output file name (output dump to file: [/tmp/pl]).
fmpolicy print-device-database
Use this command to print the device database configuration.
Syntax
execute fmpolicy print-device-database <device_name> <output>
Variable
Description
<device_name>
Enter the name of the device.
<output>
Output file name (output dump to file: [/tmp/pl]).
fmpolicy print-device-object
Use this command to display the device objects.
Syntax
execute fmpolicy print-device-object <device_name> <vdom> <category> {<key> | list | all}
<output>
Variable
Description
<device_name>
Enter the name of the device.
<vdom>
Enter the VDOM name.
<category>
Enter the category name.
{<key> | list | all}
The following options are available:
l
all: Show all objects.
l
<output>
list: Get all objects.
Output file name (output dump to file: [/tmp/pl]).
fmpolicy print-prov-templates
Use this command to print provisioing templates.
Syntax
execute fmpolicy print-prov-templates <adom> <prov> <package> <category> {<key> | list |
all} <output>
146
CLI Reference
Fortinet Technologies Inc.
fmprofile
execute
Variable
Description
<adom>
Enter the name of the ADOM.
<prov>
Enter the provisioning template name. The following options are available:
l
5: System Templates
l
8: FortiClient Templates
l
9: Threat Weight Templates
l
10: WiFi Templates
<package>
Enter the package name.
<category>
Enter the category name.
{<key> | list | all}
The following options are available:
l
all: Show all objects.
l
<output>
list: Get all objects.
Output file name (output dump to file: [/tmp/pl]).
fmprofile
Use these commands to perform profile related actions:
fmprofile copy-to-device
fmprofile import-profile
fmprofile export-profile
fmprofile list-profiles
fmprofile import-from-device
fmprofile copy-to-device
Use this command to copy profile settings from a profile to a device.
Syntax
execute fmprofile copy-to-device <adom> <profile-id> <device_name>
Variable
Description
<adom>
Enter the name of the ADOM.
<profile-id>
Enter the profile ID.
<device_name>
Enter the device ID.
fmprofile export-profile
Use this command to export profile configurations.
CLI Reference
Fortinet Technologies Inc.
147
execute
fmprofile
Syntax
execute fmprofile export-profile <adom> <profile-id> <output>
Variable
Description
<adom>
Enter the name of the ADOM.
<profile-id>
Enter the profile ID.
<output>
Enter the output file name.
fmprofile import-from-device
Use this command to import profile settings from a device to a profile.
Syntax
execute fmprofile import-from-device <adom> <device_name> <profile-id>
Variable
Description
<adom>
Enter the name of the ADOM.
<device_name>
Enter the device ID.
<profile-id>
Enter the profile ID.
fmprofile import-profile
Use this command to import profile configurations.
Syntax
execute fmprofile import-profile <adom> <profile_id> <filename>
Variable
Description
<adom>
Enter the name of the ADOM.
<profile-id>
Enter the profile ID.
<filename>
Enter the full path to the input file containing CLI configuration.
fmprofile list-profiles
Use this command to list all profiles in an ADOM.
Syntax
execute fmprofile list-profiles <adom_name>
148
CLI Reference
Fortinet Technologies Inc.
fmscript
execute
Variable
Description
<adom_name>
Enter the name of the ADOM.
fmscript
Use these commands to perform script related actions:
fmscript clean-sched
fmscript list
fmscript copy
fmscript run
fmscript delete
fmscript
fmscript import
fmscript clean-sched
Clean the script schedule table for all non-existing devices.
Syntax
execute fmscript clean-sched
fmscript copy
Copy a script or scripts between ADOMs.
Syntax
execute fmscript copy <adom_name> <script ID> <adom> [<prefix>]
Variable
Description
<adom_name>
The source ADOM name.
<script ID>
The name of the script to copy. Use 0000 to copy all scripts.
<adom>
The destination ADOM name.
[<prefix>]
Assign the conflict prefix. The default is the ADOM name.
fmscript delete
Delete a script from FortiManager.
Syntax
execute fmscript delete <scriptid>
CLI Reference
Fortinet Technologies Inc.
149
execute
fmscript
Variable
Description
<scriptid>
The name of the script to delete.
fmscript import
Import a script from an FTP server to FortiManager.
Syntax
execute fmscript import <ftpserver_ipv4> <filename> <username> <password> <scriptname>
<scripttype> <comment> <adom_name> <os_type> <os_version> <platform> <device_name>
<build_number> <hostname> <serial_number>
150
Variable
Description
<ftpserver_ipv4>
The IPv4 address of the FTP server.
<filename>
The filename of the script to be imported to the FortiManager system.
<username>
The user name used to access the FTP server.
<password>
The password used to access the FTP server.
<scriptname>
The name of the script to import.
<scripttype>
The type of script as one of CLI or TCL.
<comment>
A comment about the script being imported, such as a brief description.
<adom_name>
Name of the administrative domain.
<os_type>
The operating system type, such as FortiOS. Options include any,
FortiOS, and others.
<os_version>
The operating system version, such as FortiOS. Options include any, 400,
and 500.
<platform>
The hardware platform this script can be run on. Options include any, or
the model of the device such as Fortigate 60C.
<device_name>
The device name to run this script on. Options include any, or the specific
device name as it is displayed on the FortiManager system
<build_number>
The specific build number this script can be run on. Options include any, or
the three digit build number. Build numbers can be found in the firmware
name for the device.
<hostname>
The host name of the device this script can be run on. Options include any,
or the specific host name.
<serial_number>
The serial number of the device this script can be run on. Options include
any, or the specific serial number of the device, such as
FGT60C3G28033042.
CLI Reference
Fortinet Technologies Inc.
fmscript
execute
fmscript list
List the scripts on the FortiManager device.
Syntax
execute fmscript list
Example
This is a sample output of the execute fmscript list command.
FMG400C # execute fmscript list
scriptid=8,name=new account profile,type=CLI
scriptid=7,name=import_script,type=CLI
scriptid=6,name=group1,type=CLIGROUP
scriptid=5,name=basic_test,type=CLI
scriptid=3,name=interface info,type=CLI
scriptid=1,name=xml_script1,type=CLI
fmscript run
Run a script on a device, the device’s object database, or on the global database. Only CLI scripts can be run on
databases, and they must contain only complete commands. Any scripts that use shortened CLI commands will
generate errors.
When a script is run on the database, the device will be updated with any configuration changes the next time the
configuration is uploaded from the FortiManager system to the device.
Syntax
execute fmscript run <scriptid_int> <run_on> <device_name> <adom_name>
Variable
Description
<scriptid_int>
The ID number of the script to run.
<run_on>
Select where to run the script. The following options are available:
l
device: on the device
l
group: on a group
l
devicedb: on the device’s object database
l
globaldb: on the global database
<device_name>
Enter the device name to run the script on.
This is required if device or devicedb were chosen for where to run the
script.
<adom_name>
Name of the administrative domain.
fmscript showlog
Display the log of scripts that have run on the selected device.
CLI Reference
Fortinet Technologies Inc.
151
execute
fmupdate
Syntax
execute fmscript showlog <device_name>
Variable
Description
<device_name>
The name of a managed FortiGate device.
Example
This example shows the output of execute fmscript showlog Dev3 that displays the output from a CLI
script called xml_script1 that was run on the object database.
execute fmscript showlog Dev3
Starting log
config firewall address
edit 33
set subnet 33.33.33.33 255.255.255.0
config firewall address
edit 33
Running script(xml_script1) on DB success
cdb_find_entry_by_canon,52:parent=1,category=2,key=(null)
fmupdate
Import or export packages using the FTP, SCP, or FTFP servers, and import database files from a CD-ROM
Syntax
execute fmupdate
path> <user>
execute fmupdate
path> <user>
152
{ftp | scp | tftp} import <type> <remote_file> <ip> <port> <remote_
<password>
{ftp | scp | tftp} export <type> <remote_file> <ip> <port> <remote_
<password>
Variables
Description
{ftp | scp | tftp}
Select the file transfer protocol to use: ftp, scp, or tftp.
<type>
Select the type of file to export or import. The following options are available: av-ips, fct-av, url, spam, file-query, license-fgt,
license-fct, custom-url, or domp.
<remote_file>
Update manager packet file name on the server or host.
<ip>
Enter the FQDN or the IP address of the server.
<port>
Enter the port to connect to on the remote SCP host. Range: 1 to 65535
<remote_path>
Enter the name of the directory of the file to download from the FTP server
or SCP host. If the directory name has spaces, use quotes instead.
<user>
Enter the user name to log into the FTP server or SCP host
<password>
Enter the password to log into the FTP server or SCP host
CLI Reference
Fortinet Technologies Inc.
format
execute
fmupdate cdrom
Import database files from a CD-ROM. The CD-ROM must be mounted first.
Syntax
execute
execute
execute
execute
fmupdate
fmupdate
fmupdate
fmupdate
cdrom
cdrom
cdrom
cdrom
import <type> <string>
list <folder>
mount
unmount
Variables
Description
import
Import database files.
<type>
Set the packet type: url, spam, or file-query.
<string>
The FortiGuard packet file name on the CD TFTP driver.
list
List the packets in a specific folder.
<folder>
The name of the folder to list.
mount
Mount the CD-ROM.
unmount
Unmount the CD-ROM.
This command is only available on FortiManager hardware models that have CD-ROM
drives.
format
Format the hard disk on the FortiManager system. You can select to perform a secure (deep-erase) format which
overwrites the hard disk with random data. You can also specify the number of time to erase the disks.
Syntax
execute format <disk | disk-ext4> <RAID level> deep-erase <erase-times>
When you run this command, you will be prompted to confirm the request.
Executing this command will erase all device settings/images, VPN & Update Manager
databases, and log data on the FortiManager system’s hard drive. The FortiManager
device’s IP address, and routing information will be preserved.
Variable
Description
<disk | disk-ext4>
Select to format the hard disk or format the hard disk with ext4 file system.
CLI Reference
Fortinet Technologies Inc.
153
execute
log
Variable
Description
<disk_partition_2>
Format hard disk partition 2 (static)
<disk_partition_2-ext4>
Format hard disk partition 2 (static) with ext4 file system.
<disk_partition_3>
Format hard disk partition 3 (dynamic)
<disk_partition_3-ext4>
Format hard disk partition 3 (dynamic) with ext4 file system.
<disk_partition_4>
Format hard disk partition 4 (misc)
<disk_partition_4-ext4>
Format hard disk partition 4 (misc) with ext4 file system.
deep-erase
Overwrite the hard disk with random data. Selecting this option will take
longer than a standard format.
<erase-times>
Number of times to overwrite the hard disk with random data. Range: 1 to
35. Default: 1
<RAID level>
Enter the RAID level to be set on the device. This option is only available on
FortiManager models that support RAID. Press the Enter key to show available RAID levels.
log
Use these commands to manage device logs:
log device disk_quota
log import
log device permissions
log ips-pkt clear
log device vdom
log quarantine-files clear
log dlp-files clear
log device disk_quota
Set the log device disk quota.
Syntax
execute log device disk_quota <device_id> <value>
154
Variable
Description
<device_id>
Enter the log device ID number, or All for all devices.
<value>
Enter the disk quota value, in MB. Range: 100 to 5655 (MB)
CLI Reference
Fortinet Technologies Inc.
log
execute
log device permissions
Set or view the log device permissions.
Syntax
execute log device permissions <device_id> <permission> {enable | disable}
Variable
Description
<device_id>
Enter the log device ID number, or All for all devices.
<permission>
The following options are available:
l
all: All permissions
{enable | disable}
l
logs: Log permission
l
content: Content permission
l
quar: Quarantine permission
l
ips: IPS permission
Enable/disable the option.
log device vdom
Use this command to add, delete, or list VDOMs.
Syntax
execute
execute
execute
execute
log
log
log
log
device
device
device
device
vdom
vdom
vdom
vdom
add <Device Name> <ADOM> <VDOM>
delete <Device Name> <VDOM>
delete-by-id <Device Name> <Id>
list <Device Name>
Variable
Description
add <Device Name> <ADOM>
<VDOM>
Add a new VDOM to a device with the device name, the ADOM that contains the device, and the name of the new VDOM.
delete <Device Name>
<VDOM>
Delete a VDOM from a device.
delete-by-id <Device Name>
<Id>
Delete a VDOM from a device using its ID number.
list <Device Name>
List all the VDOMs on a device.
log dlp-files clear
Delete log DLP files.
CLI Reference
Fortinet Technologies Inc.
155
execute
log
Syntax
execute log dlp-files clear <string> <string>
Variable
Description
<string>
Enter the device name.
<string>
Enter the device archive type. The following options are available:
l
all
l
email
l
im
l
ftp
l
http
l
mms
log import
Use this command to import log files from another device and replace the device ID on imported logs.
Syntax
execute log import <service> <ip_address> <user-name> <password> <file-name> <device-id>
Variable
Description
<service>
Select the file transfer protocol to use: ftp, sftp, scp, or tftp.
<ip_address>
Enter the server IP address.
<user-name>
Enter the username.
<password>
Enter the password or - for no password.
The <password> field is not required when <service> is tftp.
<file-name>
The file name (e.g. dir/fgt.alog.log) or directory name (e.g.
dir/subdir/).
<device-id>
Replace the device ID on imported logs. Enter a device serial number of
one of your log devices.
For example: FG100A2104400006.
log ips-pkt clear
Delete IPS packet files.
Syntax
execute log ips-pkt clear <string>
156
CLI Reference
Fortinet Technologies Inc.
log-integrity
execute
Variable
Description
<string>
Enter the device name.
log quarantine-files clear
Delete log quarantine files.
Syntax
execute log quarantine-files clear <string>
Variable
Description
<string>
Enter the device name.
log-integrity
Query the log file’s MD5 checksum and timestamp.
Syntax
execute log-integrity <device_name> <string>
Variable
Description
<device_name>
Enter the name of the log device. Example: FWF40C3911000061
<string>
The log file name
lvm
With Logical Volume Manager (LVM), a FortiManager VM device can have up to twelve total log disks added to
an instance. More space can be added by adding another disk and running the LVM extend command.
This command is only available on FortiManager VM models.
Syntax
execute lvm extend [Disk1 Disk2 ...]
execute lvm info
execute lvm start
The following table lists command variables, description, and default values where applicable.
CLI Reference
Fortinet Technologies Inc.
157
execute
ping
Variables
Description
extend
Extend the LVM logical volume.
[Disk1 Disk2 ...]
Disk(s).
info
Get system LVM information.
start
Start using LVM.
Example
View LVM information:
execute
Disk
Disk
Disk
Disk
Disk
Disk
Disk
Disk
Disk
Disk
Disk
Disk
lvm info
1: Used 62GB
2: Used 20GB
3: Unavailable 0GB
4: Unavailable 0GB
5: Unavailable 0GB
6: Unavailable 0GB
7: Unavailable 0GB
8: Unavailable 0GB
9: Unavailable 0GB
10: Unavailable 0GB
11: Unavailable 0GB
12: Unavailable 0GB
ping
Send an ICMP echo request (ping) to test the network connection between the FortiManager system and another
network device.
Syntax
execute ping <ipv4_address | hostname>
Variable
Description
<ipv4_address | hostname>
IPv4 address or DNS resolvable hostname of network device to contact.
Example
This example shows how to ping a host with the IPv4 address 192.168.1.23:
execute ping 192.168.1.23
ping6
Send an ICMP echo request (ping) to test the network connection between the FortiManager system and another
network device.
158
CLI Reference
Fortinet Technologies Inc.
raid
execute
Syntax
execute ping6 <ipv6_address | hostname>
Variable
Description
<ipv6_address | hostname>
Enter the IPv6 address or DNS resolvable hostname of network device to
contact.
Example
This example shows how to ping a host with the IPv6 address 8001:0DB8:AC10:FE01:0:0:0:0:
execute ping6 8001:0DB8:AC10:FE01:0:0:0:0:
raid
Use these commands to add or delete a hard disk to RAID.
Syntax
execute raid add-disk <disk index>
execute raid delete-disk <disk index>
This command is only available on FortiManager models that support RAID.
reboot
Restart the FortiManager system. This command will disconnect all sessions on the FortiManager system.
Syntax
execute reboot
Example
execute reboot
The system will be rebooted.
Do you want to continue? (y/n)
remove
Use this command to remove all reports for a specific device from the FortiManager system.
Syntax
execute remove reports <device-id>
CLI Reference
Fortinet Technologies Inc.
159
execute
reset
Variable
Description
<device-id>
Enter the device identifier
Example
execute remove reports FGT60C3G00000002
This operation will ERASE ALL reports that include FGT60C3G00000002!
Do you want to continue? (y/n)y
All reports that include FGT60C3G00000002 were removed.
reset
Use this command to reset the FortiManager unit to factory defaults. Use the all-except-ip command to
reset to factory defaults while maintaining the current IP address and route information. This command will
disconnect all sessions and restart the FortiManager unit.
Syntax
execute reset all-settings
execute reset all-except-ip
Example
execute reset all-settings
This operation will reset all settings to factory defaults
Do you want to continue? (y/n)
reset-sqllog-transfer
Use this command to resend SQL logs to the database.
Syntax
execute reset-sqllog-transfer <enter>
restore
Use this command to restore the configuration or database from a file and change the FortiManager unit image.
These commands will disconnect all sessions and restart the FortiManager unit.
Syntax
execute restore all-settings {ftp | scp | sftp} <ip_address> <string> <username>
<password> <ssh-cert> <crpt_password> [option1+option2+...]
execute restore image {ftp | tftp} <filepath> <ip_address> <username> <password>
execute restore logs <device name(s)> {ftp | scp | sftp} <ip_address> <username>
<password> <directory>
160
CLI Reference
Fortinet Technologies Inc.
restore
execute
execute restore logs-only <device name(s)> {ftp | scp | sftp} <ip_address> <username>
<password> <directory>
execute restore reports <report schedule name(s)> {ftp | scp | sftp} <ip_address>
<username> <password> <directory>
execute restore reports-config <adom name(s)> {ftp | scp | sftp} <ip_address> <username>
<password> <directory>
Variable
Description
all-settings
Restore all FortiManager settings from a file on a server. The new settings
replace the existing settings, including administrator accounts and passwords.
image
Upload a firmware image from a TFTP server to the FortiManager unit. The
FortiManager unit reboots, loading the new firmware.
logs
Restore the device logs.
logs-only
Restore only the device logs.
reports
Restore device reports.
reports-config
Restore the reports configuration.
{ftp | tftp}
Enter the type of server to retrieve the image from: ftp or tftp.
{ftp | scp | sftp}
Enter the type of server: ftp, scp, or sftp.
<device name(s)>
Enter the device name(s) separated by a comma, or enter all for all
devices.
<report schedule name(s)>
Enter the report schedule name(s) separated by a comma, or enter all for
all reports schedules.
<adom name(s)>
Enter the ADOM name(s) separated by a comma, or enter all for all
ADOMs.
<filepath>
Enter the file to get from the server. You can enter a path with the filename,
if required.
<ip_address>
Enter the IP address of the server to get the file from.
<string>
The file to get from the server. You can enter a path with the filename, if
required.
<username>
The username to log on to the server. This option is not available for restore
operations from TFTP servers.
<password>
The password for username on the server. This option is not available for
restore operations from TFTP servers.
<ssh-cert>
The SSH certification for the server. This option is only available for restore
operations from SCP servers.
CLI Reference
Fortinet Technologies Inc.
161
execute
shutdown
Variable
Description
<crpt_password>
Optional password to protect backup content. Use any for no password.
<directory>
Enter the directory.
[option1+option2+...]
Select whether to keep IP, routing, and HA info on the original unit.
Example
This example shows how to upload a configuration file from a FTP server to the FortiManager unit. The name of
the configuration file on the FTP server is backupconfig. The IP address of the FTP server is 192.168.1.23.
The user is admin with a password of mypassword. The configuration file is located in the
/usr/local/backups/ directory on the TFTP server.
execute restore all-settings 192.168.1.23 /usr/local/backups/backupconfig admin mypasword
shutdown
Shut down the FortiManager system. This command will disconnect all sessions.
Syntax
execute shutdown
Example
execute shutdown
The system will be halted.
Do you want to continue? (y/n)
sql-local
Use these commands to remove the SQL database and logs from the FortiManager system and to rebuild the
database and devices:
sql-local rebuild-adom
sql-local remove-logs
sql-local rebuild-adom
sql-local remove-logtype
sql-local remove-db
When rebuilding the SQL database, new logs will not be available until the rebuild is
complete. The time required to rebuild the database is dependent on the size of the
database. Please plan a maintenance window to complete the database rebuild. You
can use the diagnose sql status rebuild-db command to display the SQL
log database rebuild status.
The following features will not be available until after the SQL database rebuild has
completed: FortiView, Log View, Event Management, and Reports.
162
CLI Reference
Fortinet Technologies Inc.
sql-local
execute
sql-local rebuild-adom
Rebuild the log SQL database from log data for particular ADOMs.
Syntax
execute sql-local rebuild-adom
Variable
Description
<adom>
The ADOM name. Multiple ADOM names can be entered.
sql-local rebuild-db
Rebuild the entire local SQL database. This operation will remove the SQL database and rebuild from log data.
This operation will also reboot the device.
Syntax
execute sql-local rebuild-db
sql-local remove-db
Remove entire local SQL database.
Syntax
execute sql-local remove-db
sql-local remove-logs
Remove SQL logs within a time period.
Syntax
execute sql-local remove-logs <Device ID>
Variable
Description
<Device ID>
Enter the device ID. Example: FG300A3907552101
sql-local remove-logtype
Remove all log entries of the designated log type.
Syntax
execute sql-local remove-logtype <log type>
CLI Reference
Fortinet Technologies Inc.
163
execute
sql-query-dataset
Variable
Description
<log type>
Enter the log type from available log types. The following options are available:
l
app-ctrl
l
attack
l
content
l
dlp
l
emailfilter
l
event
l
generic
l
history
l
traffic
l
virus
l
voip
l
webfilter
l
netscan
l
fct-event
l
fct-traffic
l
fct-netscan
Example
execute sql-local remove-logtype app-ctrl
All SQL logs with log type 'app-ctrl' will be erased!
Do you want to continue? (y/n)
sql-query-dataset
Use this command to execute a SQL dataset against the FortiManager system.
Syntax
execute sql-query-dataset <adom_name> <dataset-name> <device/group name> <faz/dev> <starttime> <end-time>
164
Variable
Description
<adom_name>
Enter the ADOM name.
<dataset-name>
Enter the dataset name.
<device/group name>
Enter the name of the device or device group.
<faz/dev>
Enter the name of the FortiAnalyzer.
<start-time>
Enter the log start time.
<end-time>
Enter the log end time.
CLI Reference
Fortinet Technologies Inc.
sql-query-generic
execute
sql-query-generic
Use this command to execute a SQL statement against the FortiManager system.
Syntax
execute sql-query-generic <string>
Variable
Description
<string>
Enter the SQL statement to run.
sql-report
Use these commands to import and display language translation files and run a SQL report once against the
FortiManager system.
Syntax
execute
execute
execute
execute
3>
execute
execute
execute
execute
execute
execute
sql-report
sql-report
sql-report
sql-report
del-font <font-name>
hcache-check <adom> <schedule-name> <start-time> <end-time>
import-font <service> <ip> <argument 1> <argument 2> <argument 3>
import-lang <name> <service> <ip> <argument 1> <argument 2> <argument
sql-report
sql-report
sql-report
sql-report
sql-report
sql-report
list <adom> [days-range] [layout-name]
list-fonts
list-lang
list-schedule <adom>
run <adom> <schedule-name> <num-threads>
view <data-type> <adom> <report-name>
Variable
Description
<font-name>
The name of a font.
<name>
Enter the new language name to import a new language translation file or
select one of the following options:
l
English
<service>
CLI Reference
Fortinet Technologies Inc.
l
French
l
Japanese
l
Korean
l
Portuguese
l
Simplified_Chinese
l
Spanish
l
Traditional_Chinese
Enter the transfer protocol: ftp, sftp, scp, or tftp.
165
execute
ssh
Variable
Description
<ip>
Enter the server IP address.
<argument 1>
For FTP, SFTP, or SCP, type a user name. For TFTP, enter a file name.
<argument 2>
For FTP, SFTP, or SCP, type a password or ‘-’. For TFTP, press <enter>.
<argument 3>
Enter a filename and press <enter>.
<adom>
Enter the ADOM name to run the report.
<data-type>
The data type to view. Must be report-data.
<report-name>
The name of the report to view.
<schedule-name>
Select one of the available report schedule names.
<num-threads>
Select the number of threads.
<start-time>
The start date and time of the report schedule, in the format: "HH:MM
yyyy/mm/dd"
<end-time>
The enddate and time of the report schedule, in the format: "HH:MM
yyyy/mm/dd"
[days-range]
The recent n days to list reports, from 1 to 99.
[layout-name]
One of the available SQL report layout names.
ssh
Use this command to establish an SSH session with another system.
Syntax
execute ssh <destination> <username>
Variable
Description
<destination>
Enter the IP address or fully qualified DNS resolvable hostname of the system you are connecting to.
<username>
Enter the user name to use to log on to the remote system.
To leave the SSH session type exit.
To confirm you are connected or disconnected from the SSH session, verify the command prompt has changed.
166
CLI Reference
Fortinet Technologies Inc.
ssh-known-hosts
execute
ssh-known-hosts
Use these commands to remove all known SSH hosts.
Syntax
execute ssh-known-hosts remove-all
execute ssh-known-hosts remove-host <host/ip>
Variable
Description
<host/ip>
Enter the hostname or IP address of the SSH host to remove.
tac
Use this command to run a TAC report.
Syntax
execute tac report <file_name>
Variable
Description
<file_name>
Optional output file name.
time
Get or set the system time.
Syntax
execute time [<time_str>]
time_str has the form hh:mm:ss, where
l
hh is the hour and can be 00 to 23
l
mm is the minutes and can be 00 to 59
l
ss is the seconds and can be 00 to 59
All parts of the time are required. Single digits are allowed for each of hh, mm, and ss.
If you do not specify a time, the command returns the current system time.
execute time <enter>
current time is: 12:54:22
top
Use this command to view the processes running on the FortiManager system.
CLI Reference
Fortinet Technologies Inc.
167
execute
traceroute
Syntax
execute top
execute top help menu
Command
Description
Z,B
Global: 'Z' change color mappings; 'B' disable/enable bold.
l,t,m
Toggle Summaries: 'l' load average; 't' task/cpu statistics; 'm' memory information.
1,I
Toggle SMP view: '1' single/separate states; 'I' Irix/Solaris mode.
f,o
Fields/Columns: 'f' add or remove; 'o' change display order.
F or O
Select sort field.
<,>
Move sort field: '<' next column left; '>' next column right.
R,H
Toggle: 'R' normal/reverse sort; 'H' show threads.
c,i,S
Toggle: 'c' command name/line; 'i' idle tasks; 'S' cumulative time.
x,y
Toggle highlights: 'x' sort field; 'y' running tasks.
z,b
Toggle: 'z' color/mono; 'b' bold/reverse (only if 'x' or 'y').
u
Show specific user only.
n or #
Set maximum tasks displayed.
k,r
Manipulate tasks: 'k' kill; 'r' renice.
d or s
Set update interval.
W
Write configuration file.
q
Quit.
traceroute
Test the connection between the FortiManager system and another network device, and display information
about the network hops between the device and the FortiManager system.
Syntax
execute traceroute <host>
168
Variable
Description
<host>
Enter the IPv4 address or hostname of network device.
CLI Reference
Fortinet Technologies Inc.
traceroute6
execute
traceroute6
Test the connection between the FortiManager system and another network device, and display information
about the network hops between the device and the FortiManager system.
Syntax
execute traceroute6 <host>
Variable
Description
<host>
Enter the IPv6 address or hostname of network device.
CLI Reference
Fortinet Technologies Inc.
169
diagnose
The diagnose commands display diagnostic information that help you to troubleshoot problems.
CLI commands and variables are case sensitive.
auto-delete
Use this command to diagnose auto deletion of DLP files, log files, quarantine files, and report files.
Syntax
diagnose
diagnose
diagnose
diagnose
auto-delete
auto-delete
auto-delete
auto-delete
dlp-files {delete-now | list}
log-files {delete-now | list}
quar-files {delete-now | list}
report-files {delete-now | list}
Variable
Description
dlp-files {delete-now | list}
Delete DLP files right now according to the system automatic deletion
policy or list DLP files. The following options are available: l
delete-now: Delete DLP files right now according to system
automatic deletion policy.
l
log-files {delete-now | list}
Delete log files right now according to the system automatic deletion policy
or list log files. The following options are available: l
delete-now: Delete log files right now according to system
automatic deletion policy.
l
quar-files {delete-now | list}
list: List quarantine files according to system automatic deletion
policy.
Delete report files right now according to the system automatic deletion
policy or list report files. The following options are available: l
delete-now: Delete report files right now according to system
automatic deletion policy.
l
170
list: List log files according to system automatic deletion policy.
Delete quarantine files right now according to the system automatic deletion policy or list quarantine files. The following options are available: l
delete-now: Delete quarantine files right now according to
system automatic deletion policy.
l
report-files {delete-now | list}
list: List DLP files according to system automatic deletion policy.
list: List report files according to system automatic deletion
policy.
CLI Reference
Fortinet Technologies Inc.
cdb check
diagnose
cdb check
Use this command to check the object configuration database integrity, the global policy assignment table, and
repair configuration database.
Syntax
diagnose
diagnose
diagnose
diagnose
cdb
cdb
cdb
cdb
check
check
check
check
objcfg-integrity
policy-assignment
reference-integrity
update-devinfo <item> <new value> {0 | 1) <model-name>
Variable
Description
objcfg-integrity
Check object configuration database integrity.
policy-assignment
Check the global policy assignment table.
reference-integrity
Check the ADOM reference table integrity.
update-devinfo
Update device information by directly changing the database.
<item>
Device info item.
<new value>
Item new value. Default sump summary only.
{0 | 1)
The following options are available: l
0: default only update empty value (0)
l
<model-name>
1: always update
Only update on model name. Default: all models
debug
Use the following commands to debug the FortiManager.
debug application
Use this command to set the debug levels for the FortiManager applications.
The diagnose debug application vmtools command is only available on
FortiManager VM for VMware environments.
Syntax
diagnose
diagnose
diagnose
diagnose
diagnose
debug
debug
debug
debug
debug
CLI Reference
Fortinet Technologies Inc.
application
application
application
application
application
alertmail <integer>
curl <integer>
ddmd <integer> [deviceName]
depmanager <integer>
dmapi <integer>
171
diagnose
debug
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
172
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
debug
application
application
application
application
application
application
application
application
application
application
application
application
application
application
application
application
application
application
application
application
application
application
application
application
application
application
application
application
application
application
application
application
application
application
dns <integer>
fazcfgd <integer>
fazmaild <integer>
fazsvcd <integer>
fgdsvr <integer>
fgdupd <integer>
fgfmsd <integer> [deviceName]
fnbam <integer>
fortilogd <integer>
FortiManagerws <integer>
gui <integer>
ha <integer>
ipsec <integer>
localmod <integer>
logd <integer>
logfiled <integer>
lrm <integer>
ntpd <integer>
oftpd <integer> [IP/deviceSerial/deviceName]
ptmgr <integer>
ptsessionmgr <integer>
securityconsole <integer>
snmpd <integer>
sql_dashboard_rpt <integer>
sql-integration <integer>
sqllogd <integer>
sqlplugind <integer>
sqlrptcached <integer>
srchd <integer>
ssh <integer>
sshd <integer>
storaged <integer>
uploadd <integer>
vmtools <integer>
Variable
Description
Default
alertmail <integer>
Set the debug level of the alert email daemon.
0
curl <integer>
Set the debug level of the curl daemon. Use this CLI command
to enable debug for monitoring progress when performing a
backup/restore of a large database via FTP.
ddmd <integer> [deviceName]
Set the debug level of the dynamic data monitor. Enter a device
name to only show messages related to that device.
0
depmanager <integer>
Set the debug level of the deployment manager.
0
dmworker <integer>
Set the debug level of the deployment manager worker.
dmapi <integer>
Set the debug level of the dmapi daemon.
dns <integer>
Set the debug level of the DNS daemon
fazcfgd <integer>
Set the debug level of the fazcfgd daemon.
0
0
CLI Reference
Fortinet Technologies Inc.
debug
diagnose
Variable
Description
fazmaild <integer>
Set the debug level of the fazmaild daemon.
fazsvcd <integer>
Set the debug level of the fazsvcd daemon.
0
fgdsvr <integer>
Set the debug level of the FortiGuard query daemon.
0
fgdupd <integer>
Set the debug level of the FortiGuard update daemon.
0
fgfmsd <integer>
[deviceName]
Set the debug level of FGFM daemon. Enter a device name to
only show messages related to that device.
0
fnbam <integer>
Set the debug level of the Fortinet authentication module.
0
fortilogd <integer>
Set the debug level of the fortilogd daemon.
0
fortimanagerws <integer>
Set the debug level of the FortiManager Web Service.
0
gui <integer>
Set the debug level of the GUI.
0
ha <integer>
Set the debug level of high availability daemon.
0
ipsec <integer>
Set the debug level of the IPsec daemon.
0
localmod <integer>
Set the debug level of the localmod daemon.
0
logd <integer>
Set the debug level of the log daemon.
0
logfiled <integer>
Set the debug level of the logfilled daemon.
0
lrm <integer>
Set the debug level of the Log and Report Manager.
0
ntpd <integer>
Set the debug level of the NTP daemon.
0
oftpd <integer> [IP/deviceSerial/deviceName]
Set the debug level of the oftpd daemon. Enter an IPv4 address,
device serial number, or device name to only show messages
related to that device or IPv4 address.
0
ptmgr <integer>
Set the debug level of the Portal Manager.
0
ptsessionmgr <integer>
Set the debug level of the Portal Session Manager.
0
securityconsole <integer>
Set the debug level of the security console daemon.
0
snmpd <integer>
Set the debug level of the SNMP daemon.
0
sql_dashboard_rpt <integer>
Set the debug level of the SQL dashboard report daemon.
0
sql-integration <integer>
Set the debug level of SQL applications.
0
sqllogd <integer>
Set the debug level of SQL log daemon..
CLI Reference
Fortinet Technologies Inc.
Default
173
diagnose
debug
Variable
Description
Default
sqlplugind <integer>
Set the debug level of the SQL plugin daemon.
0
sqlrptcached <integer>
Set the debug level of the SQL report caching daemon.
0
srchd <integer>
Set the debug level of the SRCHD.
0
ssh <integer>
Set the debug level of SSH protocol transactions.
0
sshd <integer>
Set the debug level of the SSH daemon.
storaged <integer>
Set the debug level of communication with java clients.
0
uploadd <integer>
Set the debug level of the upload daemon.
0
vmtools <integer>
Set the debug level for vmtools.
0
Example
This example shows how to set the debug level to 7 for the upload daemon:
diagnose debug application uploadd 7
debug cli
Use this command to set the debug level of CLI.
Syntax
diagnose debug cli <integer>
Variable
Description
<integer>
Set the debug level of the CLI. Range: 0 to 8. Default: 3
debug console
Use this command to Enable/disable console debugging.
Syntax
diagnose debug console {enable | disable}
Variable
Description
{enable | disable}
Enable or disable console debugging.
debug crashlog
Use this command to manage crash logs.
174
CLI Reference
Fortinet Technologies Inc.
debug
diagnose
Syntax
diagnose debug crashlog clear
diagnose debug crashlog read
Variable
Description
clear
Delete backtrace and core files.
read
Show the crash logs. This command is hidden.
debug disable
Use this command to disable debug.
Syntax
diagnose debug disable
debug dpm
Use this command to manage the deployment manager.
Syntax
diagnose debug dpm comm-trace {enable | disable | status}
diagnose debug dpm conf-trace {enable | disable | status}
diagnose debug dpm probe-device <ip>
Variable
Description
comm-trace {enable | disable |
status}
Enable a DPM to FortiGate communication trace: enable, disable, or
status.
conf-trace {enable | disable |
status}
Enable a DPM to FortiGate configuration trace: enable, disable, or
status.
probe-device <ip>
Check device status.
debug enable
Use this command to enable debug.
Syntax
diagnose debug enable
debug info
Use this command to show active debug level settings.
Syntax
diagnose debug info
CLI Reference
Fortinet Technologies Inc.
175
diagnose
debug
debug reset
Use this command reset the debug level settings. All debug settings will be reset.
Syntax
diagnose debug reset
debug service
Use this command to debug services.
Syntax
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
debug
debug
debug
debug
debug
debug
debug
debug
service
service
service
service
service
service
service
service
cdb <integer>
cmdb <integer>
dvmcmd <integer>
dvmdb <integer>
fazconf <integer>
main <integer>
sys <integer>
task <integer>
Variable
Description
cdb <integer>
Debug the CDB daemon service. Enter the debug level.
cmdb <integer>
Debug the CMDB daemon service. Enter the debug level.
dvmcmd <integer>
Debug the DVMCMD daemon service. Enter the debug level.
dvmdb <integer>
Debug the DVMDB (Device Manager Database) daemon service. Enter the
debug level.
fazconf <integer>
Debug the NCMDB daemon service. Enter the debug level.
main <integer>
Debug the Main daemon service. Enter the debug level.
sys <integer>
Debug the SYS daemon service. Enter the debug level.
task <integer>
Debug the Task daemon service. Enter the debug level.
debug sysinfo
Use this command to show system information.
Syntax
diagnose debug sysinfo
debug sysinfo-log
Use this command to generate one system log information log file every two minutes.
176
CLI Reference
Fortinet Technologies Inc.
debug
diagnose
Syntax
diagnose debug sysinfo-log {on | off}
debug sysinfo-log-backup
Use this command to backup all system information log files to an FTP server.
Syntax
diagnose debug sysinfo-log-backup <ip> <string> <username> <password>
Variable
Description
<ip>
Enter the FTP server IPv4 address.
<string>
Enter the path or filename to save to the FTP server.
<username>
Enter the user name for the FTP server.
<password>
Enter the password for the FTP server.
debug sysinfo-log-list
Use this command to show system information elogs.
Syntax
diagnose debug sysinfo-log-list <integer>
Variable
Description
<integer>
Display the last n elogs. Default: The default value of n is 10.
debug timestamp
Use this command to enable/disable debug timestamp.
Syntax
diagnose debug timestamp {enable | disable}
debug vminfo
Use this command to show VM license information.
Syntax
diagnose debug vminfo
This command is only available on FortiManager VM models.
CLI Reference
Fortinet Technologies Inc.
177
diagnose
dlp-archives
dlp-archives
Use this command to manage the DLP archives.
Syntax
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
dlp-archives
dlp-archives
dlp-archives
dlp-archives
dlp-archives
dlp-archives
dlp-archives
quar-cache list-all-process
quar-cache kill-process <pid>
rebuild-quar-db
remove
statistics {show | flush}
status
upgrade
Variable
Description
quar-cache list-all-process
List all processes that are using the quarantine cache.
quar-cache kill-process <pid>
Kill a process that is using the quarantine cache.
rebuild-quar-db
Rebuild Quarantine Cache DB
remove
Remove all upgrading DLP archives.
statistics {show | flush}
Display or flush the quarantined and DLP archived file statistics. The following options are available: l
flush: Flush quarantined and DLP archived file statistics.
l
show: Display quarantined and DLP archived file statistics.
status
Running status.
upgrade
Upgrade the DLP archives.
dvm
Use the following commands for DVM related settings.
dvm adom
Use this command to list ADOMs.
Syntax
diagnose dvm adom list
178
Variable
Description
list
List ADOMs, state, product, OS version (OSVER), major release (MR),
name, mode, and VPN management.
CLI Reference
Fortinet Technologies Inc.
dvm
diagnose
dvm capability
Use this command to set the DVM capability.
Syntax
diagnose dvm capability set {all | standard}
diagnose dvm capability show
Variable
Description
set {all | standard}
Set the capability to all or standard: all or standard.
show
Show what the capability is set to.
dvm chassis
Use this command to list chassis.
Syntax
diagnose dvm chassis list
Variable
Description
list
List chassis.
dvm check-integrity
Use this command to check the DVM database integrity.
Syntax
diagnose dvm check-integrity
dvm debug
Use this command to enable/disable debug channels.
Syntax
diagnose dvm debug {enable | disable} <channel> <channel> <channel>
Variable
Description
{enable | disable}
Enable or disable debug channels.
CLI Reference
Fortinet Technologies Inc.
179
diagnose
dvm
Variable
Description
<channel>
The following options are available: l
All
l
dvm_db
l
dvm_dev
l
shelfmgr
l
ipmi
l
lib
l
dvmcmd
l
dvmcore
l
gui
l
monitor
dvm device
Use this command to list devices or objects referencing a device.
Syntax
diagnose dvm device dynobj <device>
diagnose dvm device list <device> <vdom>
diagnose dvm device delete <adom> <device>
Variable
Description
dynobj <device>
List dynamic objects on this device.
list <device> <vdom>
List devices. Optionally, enter a device or VDOM name.
delete <adom> <device>
Delete devices for a specific ADOM.
dvm device-tree-update
Use this command to enable/disable device tree automatic updates.
Syntax
diagnose dvm device-tree-update {enable | disable}
Variable
Description
{enable | disable}
Enable or disable device tree autoupdate.
dvm extender
Use these commands to list FortiExtender devices and synchronize FortiExtender data via JSON.
180
CLI Reference
Fortinet Technologies Inc.
dvm
diagnose
Syntax
diagnose dvm extender list
diagnose dvm extender sync-extender-data <device>
diagnose dvm extender get-extender-modem-ip <device> <id>
Variable
Description
list
List FortiExtender devices.
sync-extender-data
Synchronize FortiExtender data by JSON.
get-extender-modem-ip
Get the FortiExtender modem IPv4 address by JSON.
<device>
Enter the device name.
<id>
Enter the FortiExtender ID.
dvm group
Use this command to list groups.
Syntax
diagnose dvm group list
Variable
Description
list
List groups.
dvm lock
Use this command to print the DVM lock states.
Syntax
diagnose dvm lock
dvm proc
Use this command to list DVM processes.
Syntax
diagnose dvm proc list
Variable
Description
list
List processes.
dvm supported-platforms
Use this command to list supported platforms and firmware versions.
CLI Reference
Fortinet Technologies Inc.
181
diagnose
dvm
Syntax
diagnose dvm supported-platforms list detail
Variable
Description
list
List support platforms.
detail
Show detail with syntax support.
dvm task
Use this command to repair or reset the task database.
Syntax
diagnose dvm task list <adom> <type>
diagnose dvm task repair
diagnose dvm task reset
Variable
Description
list <adom> <type>
List task database information.
repair
Repair the task database while preserving existing data where possible.
The FortiManager will reboot after the repairs.
reset
Reset the task database to its factory default state. All existing tasks and
the task history will be erased. The FortiManager will reboot after the reset.
dvm transaction-flag
Use this command to edit or display DVM transaction flags.
Syntax
diagnose dvm transaction-flag {abort | debug | none}
Variable
Description
{abort | debug | none}
The following options are available: abort, debug, or none.
dvm workflow
Use this command to edit or display workflow information.
Syntax
diagnose dvm workflow log-list <ADOM_name> <workflow_session_ID>
diagnose dvm workflow session-list <ADOM_name>
182
CLI Reference
Fortinet Technologies Inc.
fgfm
diagnose
Variable
Description
{log-list | session-list}
The following options are available: l
log-list: List workflow session log.
l
session-list: List workflow session.
fgfm
Use this command to get installation session, object, and session lists.
Syntax
diagnose fgfm install-session
diagnose fgfm object-list
diagnose fgfm session-list <device ID>
Variable
Description
install-session
Get installations session lists.
object-list
Get object lists.
session-list <device ID>
Get session lists.
fmnetwork
Use the following commands for network related settings.
fmnetwork arp
Use this command to manage ARP.
Syntax
diagnose fmnetwork arp del <intf-name> <IP>
diagnose fmnetwork arp list
Variable
Description
del <intf-name> <IP>
Delete an ARP entry.
list
List ARP entries.
fmnetwork interface
Use this command to view interface information.
CLI Reference
Fortinet Technologies Inc.
183
diagnose
fmupdate
Syntax
diagnose fmnetwork interface detail <portX>
diagnose fmnetwork interface list <portX>
Variable
Description
detail <portX>
View a specific interface’s details. For example: port1.
list <portX>
List all interface details. For example: port1.
fmnetwork netstat
Use this command to view network statistics.
Syntax
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
fmnetwork
fmnetwork
fmnetwork
fmnetwork
fmnetwork
fmnetwork
netstat
netstat
netstat
netstat
netstat
netstat
list
list [-r]
tcp
tcp [-r]
udp
udp [-r]
Variable
Description
list
List all connections.
list [-r]
Use -r to list only resolved IPv4 addresses.
tcp
List all TCP connections.
tcp [-r]
Use -r to list only resolved IPv4 addresses.
udp
List all UDP connections.
udp [-r]
Use -r to list only resolved IPv4 addresses.
fmupdate
Use this command to diagnose update services.
Syntax
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
184
fmupdate
fmupdate
fmupdate
fmupdate
fmupdate
fmupdate
fmupdate
fmupdate
fmupdate
fmupdate
add-device <serial> <ip> <firmware> <build>
deldevice {fct | fds | fgd | fgc} <serialnum> <uid>
dellog
fct-configure
fct-dbcontract
fct-delserverlist
fct-getobject
fct-serverlist
fct-update-status
fct-updatenow
CLI Reference
Fortinet Technologies Inc.
fmupdate
diagnose
diagnose fmupdate fds-configure
diagnose fmupdate fds-dbcontract
diagnose fmupdate fds-delserverlist
diagnose fmupdate fds-dump-breg
diagnose fmupdate fds-dump-srul
diagnose fmupdate fds-get-downstream-device <serialnum>
diagnose fmupdate fds-getobject
diagnose fmupdate fds-serverlist
diagnose fmupdate fds-service-info
diagnose fmupdate fds-update-status
diagnose fmupdate fds-updatenow
diagnose fmupdate fgc-configure
diagnose fmupdate fgc-delserverlist
diagnose fmupdate fgc-serverlist
diagnose fmupdate fgc-update-status
diagnose fmupdate fgd-asdevice-stat {10m | 30m | 1h | 6h | 12h | 24h | 7d} {all |
<serial>} <integer>
diagnose fmupdate fgd-asserver-stat {10m | 30m | 1h | 6h | 12h | 24h | 7d}
diagnose fmupdate fgd-bandwidth {1h | 6h | 12h | 24h | 7d | 30d}
diagnose fmupdate fgd-configure
diagnose fmupdate fgd-dbcontract
diagnose fmupdate fgd-dbver {wf | as | av-query}
diagnose fmupdate fgd-delserverlist
diagnose fmupdate fgd-get-downstream-device
diagnose fmupdate fgd-serverlist
diagnose fmupdate fgd-service-info
diagnose fmupdate fgd-test-client <ip> <serialnum> <string>
diagnose fmupdate fgd-update-status
diagnose fmupdate fgd-updatenow
diagnose fmupdate fgd-url-rating <serialnum> <version> <url>
diagnose fmupdate fgd-wfas-clear-log
diagnose fmupdate fgd-wfas-log {name | ip} <string>
diagnose fmupdate fgd-wfas-rate {wf | av | as_ip | as_url | as_hash}
diagnose fmupdate fgd-wfdevice-stat {10m | 30m | 1h | 6h | 12h | 24h | 7d} <serialnum>
diagnose fmupdate fgd-wfserver-stat {top10sites | top10devices} {10m | 30m | 1h | 6h |
12h | 24h | 7d}
diagnose fmupdate fgt-del-statistics
diagnose fmupdate fgt-del-um-db
diagnose fmupdate fmg-statistic-info
diagnose fmupdate fortitoken {seriallist | add | del} {add | del | required}
diagnose fmupdate getdevice {fct | fds | fgd | fgc} <serialnum>
diagnose fmupdate service-restart {fds | fct | fgd | fgc}
diagnose fmupdate show-bandwidth {fct | fgt | fml | faz} <string>
diagnose fmupdate show-dev-obj <serialnum>
diagnose fmupdate view-linkd-log {fct | fds | fgd | fgc}
diagnose fmupdate vm-license
Variable
Description
add-device <serial> <ip> <firmware> <build>
Add an unregistered device. The build number is optional.
deldevice {fct | fds | fgd | fgc}
<serialnum> <uid>
Delete a device. The UID applies only to FortiClient devices.
CLI Reference
Fortinet Technologies Inc.
185
diagnose
186
fmupdate
Variable
Description
dellog
Delete log for FDS and FortiGuard update events.
fct-configure
Dump the FortiClient running configuration.
fct-dbcontract
Dump the FortiClient subscriber contract.
fct-delserverlist
Dump the FortiClient server list file fdni.dat.
fct-getobject
Get the version of all FortiClient objects.
fct-serverlist
Dump the FortiClient server list.
fct-update-status
Display the FortiClient update status.
fct-updatenow
Update the FortiClient antivirus/IPS immediately.
fds-configure
Dump the FDS running configuration.
fds-dbcontract
Dump the FDS subscriber contract
fds-delserverlist
Delete the FDS server list file fdni.dat.
fds-dump-breg
Dump the FDS beta serial numbers.
fds-dump-srul
Dump the FDS select filtering rules.
fds-get-downstream-device
<serialnum>
Get information of all downstream FortiGate antivirus-IPS devices. Optionally, enter the device serial number.
fds-getobject
Get the version of all FortiGate objects.
fds-serverlist
Dump the FDS server list.
fds-service-info
Display FDS service information.
fds-update-status
Display the FDS update status.
fds-updatenow
Update the FortiGate antivirus/IPS immediately.
fgc-configure
Dump the FGC running configuration.
fgc-delserverlist
Delete the FGC server list file fdni.dat.
fgc-serverlist
Dump the FGC server list.
fgc-update-status
Display the FGC update status.
fgd-asdevice-stat {10m | 30m |
1h | 6h | 12h | 24h | 7d} {all |
<serial>} <integer>
Display antispam device statistics for single or all devices.
<integer>: Number of time periods to display (optional, default is 1).
CLI Reference
Fortinet Technologies Inc.
fmupdate
diagnose
Variable
Description
fgd-asserver-stat {10m | 30m |
1h | 6h | 12h | 24h | 7d}
Display antispam server statistics.
fgd-bandwidth {1h | 6h | 12h |
24h | 7d | 30d}
Display the download bandwidth.
fgd-configure
Dump the FortiGuard running configuration.
fgd-dbcontract
Dump the FortiGuard subscriber contract.
fgd-dbver {wf | as | av-query}
Get the version of the database. Optionally, enter the database type.
fgd-delserverlist
Delete the FortiGuard server list file fdni.dat.
fgd-get-downstream-device
Get information on all downstream FortiGate web filter and spam devices.
fgd-serverlist
Dump the FortiGuard server list.
fgd-service-info
Display FortiGuard service information.
fgd-test-client <ip> <serialnum> <string>
Execute FortiGuard test client. Optionally, enter the hostname or IPv4
address of the FGD server, the serial number of the device, and the query
number per second or URL.
fgd-update-status
Display the Fortiguard update status.
fgd-updatenow
Update the FortiGate web filter / antispam immediately.
fgd-url-rating <serialnum> <ver- Rate URLs within the FortiManager database using the FortiGate serial
sion> <url>
number. Optionally, enter the category version and URL.
fgd-wfas-clear-log
Clear the FortiGuard service log file.
fgd-wfas-log {name | ip}
<string>
View the FortiGuard service log file. Optionally, enter the device filter type,
and device name or IPv4 address.
fgd-wfas-rate {wf | av | as_ip |
as_url | as_hash}
Get the web filter / antispam rating speed. Optionally, enter the server type.
fgd-wfdevice-stat {10m | 30m |
1h | 6h | 12h | 24h | 7d} <serialnum>
Display web filter device statistics. Optionally, enter a specific device’s
serial number.
fgd-wfserver-stat {top10sites | Display web filter server statistics for the top 10 sites or devices. Optionally,
top10devices} {10m | 30m | 1h | enter the time frame to cover.
6h | 12h | 24h | 7d}
fgt-del-statistics
CLI Reference
Fortinet Technologies Inc.
Remove all statistics (antivirus / IPS and web filter / antispam). This command requires a reboot.
187
diagnose
fortilogd
Variable
Description
fgt-del-um-db
Remove UM and UM-GUI databases. This command requires a reboot.
Note: um.db is a sqlite3 database that update manager uses internally. It
will store AV/IPS package information of downloaded packages. This command removed the database file information. The package is not removed.
After the reboot, the database will be recreated. Use this command if you
suspect the database file is corrupted.
fmg-statistic-info
Display statistic information for FortiManager and Java Client.
fortitoken {seriallist | add | del}
{add | del | required}
FortiToken related operations.
getdevice {fct | fds | fgd | fgc}
<serialnum>
Get device information. Optionally, enter a serial number.
service-restart {fds | fct | fgd |
fgc}
Restart linkd service.
show-bandwidth {fct | fgt | fml |
faz} <string>
Display download bandwidth. Enter the device type and type a value for
<string>. The following options are available:
l
1h: 1 hours
l
6h: 6 hours
l
12h: 12 hours
l
24h: 24 hours
l
7d: 7 days
l
30d: 30 days
show-dev-obj <serialnum>
Display an objects version of a device. Optionally, enter a serial number.
view-linkd-log {fct | fds | fgd |
fgc}
View the linkd log file.
vm-license
Dump the FortiGate VM license.
fortilogd
Use this command to view FortiLog daemon information.
Syntax
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
188
fortilogd
fortilogd
fortilogd
fortilogd
fortilogd
fortilogd
fortilogd
msgrate
msgrate-device
msgrate-total
msgrate-type
msgstat <flush>
lograte
status
CLI Reference
Fortinet Technologies Inc.
fwmanager
diagnose
Variable
Description
msgrate
Display log message rate.
msgrate-device
Display log message rate devices.
msgrate-total
Display log message rate totals.
msgrate-type
Display log message rate types.
msgstat
Display log message status.
lograte
Display the log rate.
<flush>
Reset the log message status.
status
Running status.
fwmanager
Use this command to manage firmware.
Syntax
diagnose fwmanager cancel-devsched <string> <firmware_version> <release_type> <build_
num> <date_time>
diagnose fwmanager cancel-grpsched <string> <firmware_version> <release_type> <build_
num> <date_time>
diagnose fwmanager delete-all
diagnose fwmanager delete-imported-images
diagnose fwmanager delete-offical-images
diagnose fwmanager delete-serverlist
diagnose fwmanager fwm-log
diagnose fwmanager getall-schedule
diagnose fwmanager getdev-schedule <string>
diagnose fwmanager getgrp-schedule <string>
diagnose fwmanager imported-imagelist
diagnose fwmanager official-imagelist
diagnose fwmanager reset-schedule-database
diagnose fwmanager set-devsched <string> <firmware_version> <release_type> <build_num>
<date_time>
diagnose fwmanager set-grpsched <string> <firmware_version> <release_type> <build_num>
<date_time>
Variable
Description
cancel-devsched <string>
<firmware_version> <release_
type> <build_num> <date_
time>
Cancel an upgrade schedule for a device. For special branches, the release
type is the branch point. The build number for official releases is always -1,
for special releases it is the build number.
The date and time format is: YYYY/MM/DD_hh:mm:ss
CLI Reference
Fortinet Technologies Inc.
189
diagnose
ha
Variable
Description
cancel-grpsched <string> <firm- Cancel an upgrade schedule for a group. For special branches, the release
ware_version> <release_type> type is the branch point. The build number for official releases is always -1,
<build_num> <date_time>
for special releases it is the build number.
The date and time format is: YYYY/MM/DD_hh:mm:ss
delete-all
Remove everything in the firmware manager folder. This command
requires a reboot.
delete-imported-images
Remove all imported images. This command requires a reboot.
delete-offical-images
Remove all official images. This command requires a reboot.
delete-serverlist
Remove the server list file (fdni.dat). This command requires a reboot.
fwm-log
View the firmware manager log file.
getall-schedule
Display all upgrade schedules recorded.
getdev-schedule <string>
Get scheduled upgrades for the device.
getgrp-schedule <string>
Get scheduled upgrades for this group.
imported-imagelist
Get the imported firmware image list
official-imagelist
Get the official firmware image list.
reset-schedule-database
Cleanup and initialize the schedule database and restart the server.
set-devsched <string> <firmware_version> <release_type>
<build_num> <date_time>
Create an upgrade schedule for a device.
set-grpsched <string> <firmware_version> <release_type>
<build_num> <date_time>
Create an upgrade schedule for a group.
ha
Use this command to manage high availability.
Syntax
diagnose
diagnose
diagnose
diagnose
190
ha
ha
ha
ha
debug-sync {on | off}
dump-datalog
force-resync
stats
Variable
Description
debug-sync {on | off}
Turn on synchronized data debug.
CLI Reference
Fortinet Technologies Inc.
hardware
diagnose
Variable
Description
dump-datalog
Dump the HA data log.
force-resync
Force re-synchronization.
stats
Get HA statistics.
hardware
Use this command to view hardware information.
Syntax
diagnose hardware info
Variable
Description
info
Show hardware related information.
log
Use this command to view and manage device logging.
log device
Use this command to manage device logging.
Syntax
diagnose log device
pm2
Use this command to print from and check the integrity of the policy manager database.
Syntax
diagnose pm2 check-integrity {all
diagnose pm2 print <log-type>
adom
device
global
ips
task
ncmdb}
Variable
Description
check-integrity {all adom
device global ips task
ncmdb}
Check policy manager database integrity. Multiple database categories can
be checked at once.
print <log-type>
Print policy manager database log messages.
CLI Reference
Fortinet Technologies Inc.
191
diagnose
report
report
Use these commands to check the SQL database.
Syntax
diagnose report clean
diagnose report status {pending | running}
Variable
Description
clean
Cleanup the SQL report queue.
status {pending | running}
Check status information on pending and running reports list. The following
options are available: l
pending: Pending reports list.
l
running: Running reports list.
sniffer
Use this command to perform a packet trace on one or more network interfaces.
Packet capture, also known as sniffing, records some or all of the packets seen by a network interface. By
recording packets, you can trace connection states to the exact point at which they fail, which may help you to
diagnose some types of problems that are otherwise difficult to detect.
FortiManager units have a built-in sniffer. Packet capture on FortiManager units is similar to that of FortiGate
units. Packet capture is displayed on the CLI, which you may be able to save to a file for later analysis, depending
on your CLI client.
Packet capture output is printed to your CLI display until you stop it by pressing Control key + C, or until it reaches
the number of packets that you have specified to capture.
Packet capture can be very resource intensive. To minimize the performance impact
on your FortiManager unit, use packet capture only during periods of minimal traffic,
with a serial console CLI connection rather than a Telnet or SSH CLI connection, and
be sure to stop the command when you are finished.
Syntax
diagnose sniffer packet <interface_name> <filter_str> <verbose> <count> <Timestamp
format>
192
Variable
Description
<interface_name>
Enter the name of a network interface whose packets you want to capture,
such as port1, or type any to capture packets on all network interfaces.
CLI Reference
Fortinet Technologies Inc.
sniffer
diagnose
Variable
Description
<filter_str>
Enter either none to capture all packets, or type a filter that specifies which
protocols and port numbers that you do or do not want to capture, such as
'tcp port 25'. Surround the filter string in quotes.
The filter uses the following syntax: '[[src|dst] host {<host1_fqdn> | <host1_ipv4>}]
[and|or] [[src|dst] host {<host2_fqdn> | <host2_
ipv4>}] [and|or] [[arp|ip|gre|esp|udp|tcp] port
<port1_int>] [and|or] [[arp|ip|gre|esp|udp|tcp]
port <port2_int>]'
To display only the traffic between two hosts, specify the IPv4 addresses of
both hosts. To display only forward or only reply packets, indicate which
host is the source, and which is the destination.
For example, to display UDP port 1812 traffic between 1.example.com and
either 2.example.com or 3.example.com, you would enter: 'udp and port 1812 and src host 1.example.com
and dst \( 2.example.com or 2.example.com
\)'
<verbose>
Enter one of the following numbers indicating the depth of packet headers
and payloads to capture:
l
1: print header of packets (default)
l
2: print header and data from IP of packets
l
3: print header and data from ethernet of packets (if available)
l
4: print header of packets with interface name
l
5: print header and data from IP of packets with interface name
6: print header and data from ethernet of packets (if available) with
intf name
For troubleshooting purposes, Fortinet Technical Support may request the
most verbose level (3).
l
<count>
Enter the number of packets to capture before stopping.
If you do not specify a number, the command will continue to capture packets until you press the control key + C.
<Timestamp format>
Enter the timestamp format. l
a: absolute UTC time, yyyy-mm-dd hh:mm:ss.ms
l
l: absolute LOCAL time, yyyy-mm-dd hh:mm:ss.ms
l
otherwise: relative to the start of sniffing, ss.ms
Example 1
The following example captures the first three packets’ worth of traffic, of any port number or protocol and
between any source and destination (a filter of none), that passes through the network interface named port1.
The capture uses a low level of verbosity (indicated by 1).
Commands that you would type are highlighted in bold; responses from the Fortinet unit are not in bold.
Packet capture can be very resource intensive. To minimize the performance impact on
your FortiManager unit, use packet capture only during periods of minimal traffic,
with a serial console CLI connection rather than a Telnet or SSH CLI connection,
and be sure to stop the command when you are finished.# diag sniffer packet port1
none 1 3
CLI Reference
Fortinet Technologies Inc.
193
diagnose
sniffer
interfaces=[port1]
filters=[none]
0.918957 192.168.0.1.36701 -> 192.168.0.2.22: ack 2598697710
0.919024 192.168.0.2.22 -> 192.168.0.1.36701: psh 2598697710 ack 2587945850
0.919061 192.168.0.2.22 -> 192.168.0.1.36701: psh 2598697826 ack 2587945850
If you are familiar with the TCP protocol, you may notice that the packets are from the middle of a TCP
connection. Because port 22 is used (highlighted above in bold), which is the standard port number for SSH, the
packets might be from an SSH session.
Example 2
The following example captures packets traffic on TCP port 80 (typically HTTP) between two hosts, 192.168.0.1
and 192.168.0.2. The capture uses a low level of verbosity (indicated by 1). Because the filter does not specify
either host as the source or destination in the IPv4 header (src or dst), the sniffer captures both forward and
reply traffic.
A specific number of packets to capture is not specified. As a result, the packet capture continues until the
administrator presses the control key + C. The sniffer then confirms that five packets were seen by that network
interface.
Commands that you would type are highlighted in bold; responses from the Fortinet unit are not in bold.
Packet capture can be very resource intensive. To minimize the performance impact on
your FortiManager unit, use packet capture only during periods of minimal traffic,
with a serial console CLI connection rather than a Telnet or SSH CLI connection,
and be sure to stop the command when you are finished.# diag sniffer packet port1
'host 192.168.0.2 or host 192.168.0.1 and tcp port 80' 1
192.168.0.2.3625 -> 192.168.0.1.80: syn 2057246590
192.168.0.1.80 -> 192.168.0.2.3625: syn 3291168205 ack 2057246591
192.168.0.2.3625 -> 192.168.0.1.80: ack 3291168206
192.168.0.2.3625 -> 192.168.0.1.80: psh 2057246591 ack 3291168206
192.168.0.1.80 -> 192.168.0.2.3625: ack 2057247265
5 packets received by filter
0 packets dropped by kernel
Example 3
The following example captures all TCP port 443 (typically HTTPS) traffic occurring through port1, regardless of
its source or destination IPv4 address. The capture uses a high level of verbosity (indicated by 3).
A specific number of packets to capture is not specified. As a result, the packet capture continues until the
administrator presses the control key + C. The sniffer then confirms that five packets were seen by that network
interface.
Verbose output can be very long. As a result, output shown below is truncated after only one packet.
Commands that you would type are highlighted in bold; responses from the Fortinet unit are not in bold.
Packet capture can be very resource intensive. To minimize the performance impact on
your FortiManager unit, use packet capture only during periods of minimal traffic,
with a serial console CLI connection rather than a Telnet or SSH CLI connection,
and be sure to stop the command when you are finished. # diag sniffer port1 'tcp
port 443' 3
interfaces=[port1]
filters=[tcp port 443]
10.651905 192.168.0.1.50242 -> 192.168.0.2.443: syn 761714898
0x0000 0009 0f09 0001 0009 0f89 2914 0800 4500 ..........)...E.
0x0010 003c 73d1 4000 4006 3bc6 d157 fede ac16 .<s.@.@.;..W....
194
CLI Reference
Fortinet Technologies Inc.
sniffer
diagnose
0x0020 0ed8 c442 01bb 2d66 d8d2 0000 0000 a002 ...B..-f........
0x0030 16d0 4f72 0000 0204 05b4 0402 080a 03ab ..Or............
0x0040 86bb 0000 0000 0103 0303 ..........
Instead of reading packet capture output directly in your CLI display, you usually should save the output to a plain
text file using your CLI client. Saving the output provides several advantages. Packets can arrive more rapidly
than you may be able to read them in the buffer of your CLI display, and many protocols transfer data using
encoding other than US-ASCII. It is usually preferable to analyze the output by loading it into in a network
protocol analyzer application such as Wireshark (http://www.wireshark.org/).
For example, you could use PuTTY or Microsoft HyperTerminal to save the sniffer output. Methods may vary.
See the documentation for your CLI client.
Requirements
l
terminal emulation software such as PuTTY
l
a plain text editor such as Notepad
l
a Perl interpreter
l
network protocol analyzer software such as Wireshark
To view packet capture output using PuTTY and Wireshark:
1. On your management computer, start PuTTY.
2. Use PuTTY to connect to the Fortinet appliance using either a local serial console, SSH, or Telnet connection.
3. Enter the packet capture command, such as:
diagnose sniffer packet port1 'tcp port 541' 3 100
but do not press Enter yet.
4. In the upper left corner of the window, click the PuTTY icon to open its drop-down menu, then select
Change Settings. A dialog appears where you can configure PuTTY to save output to a plain text file.
5. In the Category tree on the left, go to Session > Logging.
6. In Session logging, select Printable output.
7. In Log file name, click the Browse button, then choose a directory path and file name such as
C:\Users\MyAccount\packet_capture.txt to save the packet capture to a plain text file. (You do not
need to save it with the .log file extension.)
8. Click Apply.
9. Press Enter to send the CLI command to the FortiMail unit, beginning packet capture.
10. If you have not specified a number of packets to capture, when you have captured all packets that you want to
analyze, press the control key + C to stop the capture.
11. Close the PuTTY window.
12. Open the packet capture file using a plain text editor such as Notepad.
13. Delete the first and last lines, which look like this:
=~=~=~=~=~=~=~=~= PuTTY log 2015-09-15.07.25 11:34:40 =~=~=~=~=~=~=~=~=
Fortinet-2000 #
These lines are a PuTTY timestamp and a command prompt, which are not part of the packet capture. If you
do not delete them, they could interfere with the script in the next step.
14. Convert the plain text file to a format recognizable by your network protocol analyzer application.
You can convert the plain text file to a format (.pcap) recognizable by Wireshark (formerly called Ethereal)
using the fgt2eth.pl Perl script.
CLI Reference
Fortinet Technologies Inc.
195
diagnose
sql
The fgt2eth.pl script is provided as-is, without any implied warranty or technical
support, and requires that you first install a Perl module compatible with your
operating system.
To use fgt2eth.pl, open a command prompt, then enter a command such as the following:
fgt2eth.pl -in packet_capture.txt -out packet_capture.pcap
where:
l
l
l
fgt2eth.pl is the name of the conversion script; include the path relative to the current directory, which is
indicated by the command prompt
packet_capture.txt is the name of the packet capture’s output file; include the directory path relative to
your current directory
packet_capture.pcap is the name of the conversion script’s output file; include the directory path relative
to your current directory where you want the converted output to be saved
15. Open the converted file in your network protocol analyzer application. For further instructions, see the
documentation for that application.
sql
Use these commands to diagnose the SQL database.
Syntax
diagnose sql config auto-cache-delay [set <integer>]
diagnose sql config debug-filter [{set | test} <string>]
diagnose sql config deferred-index-timespan [set <value>]
diagnose sql config top-dev set [{log-thres | num-max}] <integer>
diagnose sql gui-rpt-shm {list-all | clear} <num>
diagnose sql process list [full]
diagnose sql process kill <pid>
diagnose sql rebuild-report-hcache <start-time> <end-time>
diagnose sql remove hcache <device-id>
diagnose sql remove query-cache
diagnose sql remove tmp-table
diagnose sql show {db-size | hcache-size | log-filters | log-stfile}
diagnose sql show log-filters
diagnose sql status {rebuild-adom <adom>| rebuild-db | run_sql_rpt | sqlplugind |
sqlreportd | sql_hcache_chk}
diagnose sql upload <host> <directory> <username> <password>
196
Variable
Description
auto-cache-delay [set
<integer>]
Show or set the auto-cache delay, in seconds.
debug-filter [{set | test}
<string>]
Set or test the sqlplugin debug filter.
CLI Reference
Fortinet Technologies Inc.
system
diagnose
Variable
Description
deferred-index-timespan [set
<value>]
Set the timespan for the deferred index.
top-dev set [{log-thres | nummax}] <integer>
Show SQL plugin top-dev settings: l
log-thres: Log threshold of top devices.
l
num-max: Maximum number of top devices. Select a number
between 0 and 1000.
gui-rpt-shm {list-all | clear}
<num>
List or clear all asynchronous GUI report shared memory slot information.
process list [full]
List running query processes.
process kill <pid>
Kill a running query.
rebuild-report-hcache <starttime> <end-time>
Rebuild hcache for report. Enter the start time/end time in the format
“yyyy-mm-dd hh:mm:ss”.
remove hcache <device-id>
Remove hcache.
remove query-cache
Remove SQL query cache for log search.
remove tmp-table
Remove temporary tables.
show {db-size | hcache-size |
log-filters | log-stfile}
The following options are available: l
db-size: Show database size.
l
hcache-size: Show hcache size.
l
log-filters: Show log view searching filters.
l
log-stfile: Show logstatus file.
show log-filters
Show log view searching filters.
status {rebuild-adom | rebuilddb | run-sql-rpt | sqlplugind |
sqlreportd | sql-hcache-chk}
The following options are available: l
rebuild-adom: Show SQL log database rebuild status of
ADOMs..
upload <host> <directory>
<username> <password>
l
rebuild-db: Show SQL log database rebuild status.
l
run-sql-rpt: Show run_sql_rpt status.
l
sqlplugind: Show sqlplugind status.
l
sqlreportd: Show sqlreportd status.
l
sql-hcache-chk: Show report hcache check status
Upload sqlplugind messages or pgsvr logs via FTP.
system
Use the following commands for system related settings.
CLI Reference
Fortinet Technologies Inc.
197
diagnose
system
system admin-session
Use this command to view login session information.
Syntax
diagnose system admin-session kill <sid>
diagnose system admin-session list
diagnose system admin-session status
Variable
Description
kill <sid>
Kill a current session.
list
List login sessions.
status
Show the current session.
system disk
Use this command to view disk diagnostic information.
Syntax
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
system
system
system
system
system
system
disk
disk
disk
disk
disk
disk
attributes
disable
enable
health
info
errors
Variable
Description
attributes
Show vendor specific SMART attributes.
disable
Disable SMART support.
enable
Enable SMART support.
health
Show the SMART health status.
info
Show the SMART information.
errors
Show the SMART error logs.
This command is only available on FortiManager hardware models.
system export
Use this command to export logs.
198
CLI Reference
Fortinet Technologies Inc.
system
diagnose
Syntax
diagnose system export crashlog <ftp server> <user> <password> [remote path] [filename]
diagnose system export dminstallog <devid> <server> <user> <password> [remote path]
[filename]
diagnose system export fmwslog <sftp | ftp> <type> <ftp server> <username> <password>
<directory> <filename>
diagnose system export umlog {ftp | sftp} <type> <server> <user> <password>
[remote path] [filename]
diagnose system export upgradelog <ftp server>
Variable
Description
crashlog <ftp server> <user> <password>
[remote path] [filename]
Export the crash log.
dminstallog <devid> <server> <user>
<password> [remote path] [filename]
Export deployment manager install log.
fmwslog <sftp | ftp> <type> <ftp server>
Export web service log files.
<username> <password> <directory> <filename>
umlog {ftp | sftp} <type> <server> <user>
<password> [remote path] [filename]
Export the update manager and firmware manager log files.
The type options are: fdslinkd, fctlinkd, fgdlinkd,
usvr, update, service, misc, umad, and fwmlinkd
upgradelog <ftp server>
Export the upgrade error log.
system flash
Use this command to diagnose the flash memory.
Syntax
diagnose system flash list
Variable
Description
list
List flash images.
system fsck
Use this command to check and repair the filesystem.
Syntax
diagnose system fsck harddisk
Variable
Description
harddisk
Check and repair the file system, then reboot the system.
CLI Reference
Fortinet Technologies Inc.
199
diagnose
system
system geoip
Use these commands to obtain geoip information. FortiManager uses a MaxMind GeoLite database of mappings
between geographic regions and all public IPv4 addresses that are known to originate from them.
Syntax
diagnose system geoip {dump | info | ip}
Variable
Description
{dump | info | ip}
The following options are available:
l
dump: All geography IP information.
l
info: Brief geography IP information.
l
ip: Find IP's country.
system ntp
Use this command to list NTP server information.
Syntax
diagnose system ntp status
Variable
Description
status
List NTP servers’ information.
system print
Use this command to print server information.
Syntax
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
200
system
system
system
system
system
system
system
system
system
system
system
system
system
print
print
print
print
print
print
print
print
print
print
print
print
print
certificate
cpuinfo
df
hosts
interface <interface>
loadavg
netstat
partitions
route
rtcache
slabinfo
sockets
uptime
Variable
Description
certificate
Print the IPsec certificate.
CLI Reference
Fortinet Technologies Inc.
system
diagnose
Variable
Description
cpuinfo
Print the CPU information.
df
Print the file system disk space usage.
hosts
Print the static table lookup for host names.
interface <interface>
Print the information of the interface
loadavg
Print the average load of the system.
netstat
Print the network statistics.
partitions
Print the partition information of the system.
route
Print the main route list.
rtcache
Print the contents of the routing cache.
slabinfo
Print the slab allocator statistics.
sockets
Print the currently used socket ports.
uptime
Print how long the system has been running.
system process
Use this command to view and kill processes.
Syntax
diagnose system process kill <-signal> <pid>
diagnose system process killall <module>
diagnose system process list
Variable
Description
kill <-signal> <pid>
Kill a process.
killall <module>
Kill all the related processes.
list
List all processes.
system raid
Use this command to view RAID information.
Syntax
diagnose system raid alarms
diagnose system raid hwinfo
diagnose system raid status
CLI Reference
Fortinet Technologies Inc.
201
diagnose
system
Variable
Description
alarms
Show RAID alarm logs.
hwinfo
Show RAID controller hardware information.
status
Show RAID status. This command displays the following information: RAID
level, RAID status, RAID size, and hard disk information.
This command is only available on FortiManager models that support RAID.
system route
Use this command to diagnose routes.
Syntax
diagnose system route list
Variable
Description
list
List routes.
system route6
Use this command to diagnose IPv6 routes.
Syntax
diagnose system route6 list
Variable
Description
list
List routes.
system server
Use this command to start the FortiManager server.
Syntax
diagnose system server start
202
Variable
Description
start
Start system.
CLI Reference
Fortinet Technologies Inc.
test
diagnose
test
Use the following commands to test the FortiManager.
test application
Use this command to test applications. Leave the integer value blank to see the available options for each
command.
Syntax
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
diagnose
test
test
test
test
test
test
test
test
test
test
test
application
application
application
application
application
application
application
application
application
application
application
fazcfgd <integer>
fazmaild <integer>
fazsvcg <integer>
fortilogd <integer>
logfiled <integer>
miglogd <integer>
oftpd <integer>
snmpd <integer>
sqllogd <integer>
sqlrptcached <integer>
fazautormd <integer>
Variable
Description
fazcfgd <integer>
Config Daemon Test Usage: l
1: show PID
fazmaild <integer>
CLI Reference
Fortinet Technologies Inc.
l
2: show statistics
l
50: test get app icon
l
51: test download app logo files
l
52: dvm call stats
l
53: dvm call stats clear
l
54: check ips/app meta-data update
l
55: log disk readahead get
l
56: log disk readahead toggle
l
99: restart daemon
Fazmail Daemon test.
203
diagnose
Variable
Description
fazsvcg <integer>
Service Daemon Test Usage: l
1: show PID
fortilogd <integer>
logfiled <integer>
miglogd <integer>
oftpd <integer>
204
test
l
2: list async search threads
l
3: dump async search slot info
l
4: show cache builder stats
l
5: dump cache builder playlist
l
6: dump log search filters
l
50: enable or disable cache builder
l
60: rawlog idx cache test
l
51: enable or disable auto custom index
l
99: restart daemon
Fortilogd Diag Test Usage: l
0: usage information
l
1: show fortilogd pid
l
2: dump message status
l
3: logstat status test
l
4: log forwarding status
l
5: client devices status
l
6: print log received
l
10: pdfv2 debug enable/disable
l
99: restart fortilogd
Logfile Daemon Test Usage: l
1: show PID
l
2: show statistics and state
l
90: reset statistics and state
l
99: restart daemon
Miglogd Daemon Test Usage: l
1: show PID
l
2: dump memory pool
l
99: restart daemon
Oftpd Daemon Test Usage: l
1: show PID
l
2: show statistics and state
l
3: show connected device name and IP
l
4: show detailed session state
l
5: show oftp request statistics
l
6: show cmdb device cache
l
99: restart daemon
CLI Reference
Fortinet Technologies Inc.
test
diagnose
Variable
Description
snmpd <integer>
SNMP Daemon Test Usage l
1: display daemon pid
sqllogd <integer>
sqlrptcached <integer>
CLI Reference
Fortinet Technologies Inc.
l
2: display snmp statistics
l
3: clear snmp statistics
l
4: generate test trap (cpu high)
l
5: generate test traps (log alert, rate, data rate)
l
6: generate test traps (licensed gb/day, device quota)
l
99: restart daemon
SqlLog Daemon Test Usage: l
1: show PID
l
2: show statistics and state
l
3: show worker init state
l
4: show worker thread info
l
5: show log device scan info, optionally filter by <devid>
l
6: worker control setting
l
7: show ADOM device list by <adom-name>
l
8: show dev to sID bitmap
l
41: show worker 1 info
l
42: show worker 2 info
l
43: show worker 3 info
l
44: show worker 4 info
l
45: show worker 5 info
l
70: show SQL database building progress
l
80: show daemon status flags
l
82: show IPsec up tunnels
l
84: show all unreg logdevs
l
90: reset statistics and state
l
91: backup all log status files
l
99: restart daemon
l
200: log based alert tests
l
201: utmref cache tests
l
221: estimated browsing time stats
l
222: estimated browsing time cleanup
l
223: estimated browsing time debug on/off
Sqlrptcache Daemon Test Usage: l
1: show PID
l
2: show statistics and state
l
3: reset statistics and state
l
99: restart daemon
205
diagnose
test
Variable
Description
fazautormd <integer>
Autodelete Daemon Test Usage: l
1: show PID
l
2: show statistics
l
3: show processing device
l
99: restart daemon
test connection
Use this command to test connections.
Syntax
diagnose test connection fortianalyzer <ip>
diagnose test connection mailserver <server-name> <mail-from> <mail-to>
diagnose test connection syslogserver <server-name>
Variable
Description
fortianalyzer <ip>
Test the connection to the FortiAnalyzer.
mailserver <server-name> <mail-from>
<mail-to>
Test the connection to the mail server.
syslogserver <server-name>
Test the connection to the syslog server.
test deploymanager
Use this command to test the deployment manager.
Syntax
diagnose test deploymanager getcheckin <devid>
diagnose test deploymanager reloadconf <devid>
Variable
Description
getcheckin <devid>
Get configuration check-in information from the FortiGate.
reloadconf <devid>
Reload configuration from the FortiGate.
test policy-check
Use this command to test applications.
Syntax
diagnose test policy-check flush
diagnose test policy-check list
206
CLI Reference
Fortinet Technologies Inc.
upload
diagnose
Variable
Description
flush
Flush all policy check sessions.
list
List all policy check sessions.
test search
Use this command to test the search daemon.
Syntax
diagnose test search flush
diagnose test search list
Variable
Description
flush
Flush all search sessions.
list
List all search sessions.
test sftp
Use this command to test the secure file transfer protocol (SFTP).
Syntax
diagnose test sftp auth <sftp server> <username> <password> <directory>
Variable
Description
auth <sftp server> <username> Test the scheduled backup.
<password> <directory>
The directory variable represents the directory on the SFTP server where
you want to put the file. The default directory is "/".
upload
Use these commands to perform request related actions.
upload clear
Use this command to clear the upload request.
Syntax
diagnose upload clear all
diagnose upload clear failed
CLI Reference
Fortinet Technologies Inc.
207
diagnose
vpn
Variable
Description
all
Clear all upload requests.
failed
Clear the failed upload requests.
upload force-retry
Use this command to retry the last failed upload request.
Syntax
diagnose upload force-entry
upload status
Use this command to get the running status.
Syntax
diagnose upload status
vpn
Use this command to flush SAD entries and list tunnel information.
Syntax
diagnose vpn tunnel flush-SAD
diagnose vpn tunnel list
208
Variable
Description
flush-SAD
Flush the SAD entries.
list
List tunnel information.
CLI Reference
Fortinet Technologies Inc.
get
The get command displays all settings, even if they are still in their default state.
Although not explicitly shown in this section, for all config commands, there are
related get and show commands that display that part of the configuration. Get and
show commands use the same syntax as their related config command, unless otherwise specified.
CLI commands and variables are case sensitive.
Unlike the show command, get requires that the object or table whose settings you want to display are specified,
unless the command is being used from within an object or table.
For example, at the root prompt, this command would be valid:
get system status
and this command would not:
get
fmupdate analyzer
Use this command to view forward virus report to FDS.
Syntax
get fmupdate analyzer virusreport
fmupdate av-ips
Use these commands to view AV/IPS update settings.
Syntax
get
get
get
get
get
get
get
fmupdate
fmupdate
fmupdate
fmupdate
fmupdate
fmupdate
fmupdate
av-ips
av-ips
av-ips
av-ips
av-ips
av-ips
av-ips
advanced-log
fct server-override
fgt server-override
push-override
push-override-to-client
update-schedule
web-proxy
Example
This example shows the output for get fmupdate av-ips web-proxy:
CLI Reference
Fortinet Technologies Inc.
209
get
fmupdate custom-url-list
ip : 0.0.0.0
mode : proxy
password : *
port : 80
status : disable
username : (null)
fmupdate custom-url-list
Use this command to view the custom URL database.
Syntax
get fmupdate custom-url-list
fmupdate device-version
Use this command to view device version objects.
Syntax
get fmupdate device-version
Example
This example shows the output for get fmupdate device-version:
faz
fct
fgt
fml
fsa
fsw
:
:
:
:
:
:
4.0
4.0
3.0
3.0
5.0
5.0
4.0 5.0
4.0 5.0
fmupdate disk-quota
Use this command to view the disk quota for the update manager.
Syntax
get fmupdate disk-quota
fmupdate fct-services
Use this command to view FortiClient update services configuration.
210
CLI Reference
Fortinet Technologies Inc.
fmupdate fds-setting
get
Syntax
get fmupdate fct-services
Example
This example shows the output for get fmupdate fct-services:
status : enable
port : 80
fmupdate fds-setting
Use this command to view FDS parameters.
Syntax
get fmupdate fds-setting
Example
This example shows the output for get fmupdate fds-setting:
fds-pull-interval : 10
max-av-ips-version : 20
fmupdate multilayer
Use this command to view multilayer mode configuration.
Syntax
get fmupdate multilayer
fmupdate publicnetwork
Use this command to view public network configuration.
Syntax
get fmupdate publicnetwork
fmupdate server-access-priorities
Use this command to view server access priorities.
Syntax
get fmupdate server-access-priorities
CLI Reference
Fortinet Technologies Inc.
211
get
fmupdate server-override-status
Example
This example shows the output for get fmupdate server-access-priorities:
access-public : disable
av-ips : disable
private-server:
web-spam : enable
fmupdate server-override-status
Use this command to view server override status configuration.
Syntax
get fmupdate server-override status
fmupdate service
Use this command to view update manager service configuration.
Syntax
get fmupdate service
Example
This example shows the output for get fmupdate service:
avips : disable
query-antispam : disable
query-antivirus : disable
query-filequery : disable
query-webfilter : disable
use-cert : BIOS
fmupdate support-pre-fgt43
Use this command to view support for pre-fgt43 configuration.
Syntax
get fmupdate support-pre-fgt43
fmupdate web-spam
Use these commands to view web spam configuration.
212
CLI Reference
Fortinet Technologies Inc.
system admin
get
Syntax
get
get
get
get
get
get
fmupdate
fmupdate
fmupdate
fmupdate
fmupdate
fmupdate
web-spam
web-spam
web-spam
web-spam
web-spam
web-spam
fct server-override
fgd-log
fgd-setting
fgt server-override
poll-frequency
web-proxy
Example
This example shows the output for get fmupdate web-spam web-proxy:
ip : 0.0.0.0
mode : proxy
password : *
port : 80
status : disable
username : (null)
system admin
Use these commands to view admin configuration.
Syntax
get
get
get
get
get
get
get
system
system
system
system
system
system
system
admin
admin
admin
admin
admin
admin
admin
group <group name>
ldap <server entry name>
profile <profile ID>
radius <server entry name>
setting
tacacs <server entry name>
user <username>
Example
This example shows the output for get system admin setting:
access-banner : disable
admin-https-redirect: enable
admin_server_cert : server.crt
allow_register : disable
auto-update : enable
banner-message : (null)
chassis-mgmt : enable
chassis-update-interval: 15
device_sync_status : enable
http_port : 80
https_port : 443
idle_timeout : 480
install-ifpolicy-only: enable
mgmt-addr : (null)
mgmt-fqdn : (null)
offline_mode : disable
register_passwd : *
show-add-multiple : disable
CLI Reference
Fortinet Technologies Inc.
213
get
system alert-event
show-adom-central-nat-policies: disable
show-adom-devman : enable
show-adom-dos-policies: disable
show-adom-dynamic-objects: enable
show-adom-icap-policies: disable
show-adom-implicit-policy: disable
show-adom-ipv6-settings: enable
show-adom-policy-consistency-button: disable
show-adom-rtmlog : disable
show-adom-sniffer-policies: disable
show-adom-taskmon-button: disable
show-adom-terminal-button: disable
show-adom-voip-policies: disable
show-adom-vpnman : enable
show-device-import-export: disable
show-foc-settings : disable
show-fortimail-settings: disable
show-fsw-settings : disable
show-global-object-settings: enable
show-global-policy-settings: enable
show_automatic_script: disable
show_grouping_script: disable
show_schedule_script: disable
show_tcl_script : disable
unreg_dev_opt : add_allow_service
webadmin_language : auto_detect
system alert-event
Use this command to view alert event information.
Syntax
get system alert-event <alert name>
system alertemail
Use this command to view alert email configuration.
Syntax
get system alertemail
Example
This example shows the output for get system alertemail:
authentication : enable
fromaddress : (null)
fromname : (null)
smtppassword : *
smtpport : 25
smtpserver : (null)
214
CLI Reference
Fortinet Technologies Inc.
system auto-delete
get
smtpuser : (null)
system auto-delete
Use this command to view automatic deletion policies for logs, reports, archived and quarantined files.
Syntax
get system auto-delete
system backup
Use the following commands to view backups:
Syntax
get system backup all-settings
get system backup status
Example
This example shows the output for get system backup status:
All-Settings Backup
Last Backup: Tue Jan 15 16:55:35 2013
Next Backup: N/A
system certificate
Use these commands to view certificate configuration.
Syntax
get
get
get
get
get
system
system
system
system
system
certificate
certificate
certificate
certificate
certificate
ca <certificate name>
crl <crl name>
local <certificate name>
oftp <certificate name>
ssh <certificate name>
system dm
Use this command to view device manager information on your FortiManager unit.
Syntax
get system dm
CLI Reference
Fortinet Technologies Inc.
215
get
system dns
Example
This example shows the output for get system dm:
concurrent-install-limit: 480
concurrent-install-script-limit: 480
discover-timeout : 6
dpm-logsize : 10000
fgfm-sock-timeout : 360
fgfm_keepalive_itvl : 120
force-remote-diff : disable
fortiap-refresh-itvl: 60
max-revs : 100
nr-retry : 1
retry : enable
retry-intvl : 15
rollback-allow-reboot: disable
script-logsize : 100
verify-install : enable
system dns
Use this command to view DNS configuration.
Syntax
get system dns
system fips
Use this command to view FIPS configuration.
Syntax
get system fips
system global
Use this command to view global configuration.
Syntax
get system global
Example
This example shows the output for get system global:
admin-https-pki-required: disable
admin-lockout-duration: 60
admin-lockout-threshold: 3
216
CLI Reference
Fortinet Technologies Inc.
system ha
get
admin-maintainer : enable
adom-mode : normal
adom-rev-auto-delete: disable
adom-status : enable
auto-register-device: enable
clt-cert-req : disable
console-output : standard
daylightsavetime : enable
default-disk-quota : 1000
enc-algorithm : low
faz-status : enable
hostname : FMG-VM64-HV
language : english
ldapconntimeout : 60000
log-checksum : none
max-concurrent-users: 20
max-running-reports : 1
partial-install : disable
pre-login-banner : disable
remoteauthtimeout : 10
search-all-adoms : disable
ssl-low-encryption : enable
task-list-size : 2000
timezone : (GMT-8:00) Pacific Time (US & Canada).
vdom-mirror : disable
webservice-proto : tlsv1
workspace-mode : disabled
system ha
Use this command to view HA configuration.
Syntax
get system ha
Example
This example shows the output for get system ha:
clusterid : 1
hb-interval : 5
hb-lost-threshold : 3
mode : standalone
password : *
peer:
system interface
Use this command to view interface configuration.
CLI Reference
Fortinet Technologies Inc.
217
get
system locallog
Syntax
get system interface
Example
This example shows the output for get system interface:
== [ port1 ]
name: port1 status:
== [ port2 ]
name: port2 status:
== [ port3 ]
name: port3 status:
== [ port4 ]
name: port4 status:
up ip: 10.2.115.82 255.255.0.0 speed: auto
up ip: 0.0.0.0 0.0.0.0 speed: auto
up ip: 0.0.0.0 0.0.0.0 speed: auto
up ip: 1.1.1.1 255.255.255.255 speed: auto
This example shows the output for get system interface port1:
name : port1
status : up
ip : 172.16.81.70 255.255.255.0
allowaccess : ping https ssh snmp telnet http
speed : auto
description : (null)
alias : (null)
ipv6:
ip6-address: ::/0 ip6-allowaccess:
system locallog
Use these commands to view local log configuration.
Syntax
get
get
get
get
get
get
get
get
system
system
system
system
system
system
system
system
locallog
locallog
locallog
locallog
locallog
locallog
locallog
locallog
disk filter
disk setting
fortianalyzer filter
fortianalyzer setting
memory filter
memory setting
[syslogd | syslogd2 | syslogd3] filter
[syslogd | syslogd2 | syslogd3] setting
Example
This example shows the output for get system locallog disk setting:
status : enable
severity : debug
upload : disable
server-type : FTP
max-log-file-size : 100
roll-schedule : none
diskfull : overwrite
log-disk-full-percentage: 80
218
CLI Reference
Fortinet Technologies Inc.
system log
get
system log
Use these commands to view log configuration.
Syntax
get system log alert
get system log fortianalyzer
get system log settings
Example
This example shows the output for get system log settings:
FAZ-custom-field1
FCH-custom-field1
FCT-custom-field1
FGT-custom-field1
FML-custom-field1
FSA-custom-field1
FWB-custom-field1
rolling-regular:
:
:
:
:
:
:
:
(null)
(null)
(null)
(null)
(null)
(null)
(null)
system mail
Use this command to view alert email configuration.
Syntax
get system mail <server name>
system metadata
Use this command to view metadata configuration.
Syntax
get system metadata <admin name>
system ntp
Use this command to view NTP configuration.
Syntax
get system ntp
CLI Reference
Fortinet Technologies Inc.
219
get
system password-policy
system password-policy
Use this command to view the password policy setting on your FortiAnalyzer.
Syntax
get system password-policy
Example
This example shows the output for get system password-policy:
status : enable
minimum-length : 11
must-contain : upper-case-letter lower-case-letter number non-alphanumeric
change-4-characters : disable
expire : 30
system performance
Use this command to view performance statistics on your FortiManager unit.
Syntax
get system performance
Example
This example shows the output for get system performance:
CPU:
Used: 2.2%
Used(Excluded NICE): 1.6%
CPU_num: 1.
CPU[0] usage: 4.72%
Usage: %user %nice %sys %idle %iowait %irq %softirq
1.18 1.77 0.79 95.28 0.98 0.00 0.00
Memory:
Total: 4,136,736 KB
Used: 608,908 KB 14.7%
Hard Disk:
Total: 61,923,324 KB
Used: 2,965,900 KB 4.8%
Flash Disk:
Total: 253,871 KB
Used: 46,426 KB 18.3%
system report
Use this command to view report configuration.
220
CLI Reference
Fortinet Technologies Inc.
system route
get
Syntax
get system report auto-cache
get system report est-browse-time
get system report setting
Example
This example shows the output for get system report auto-cache:
aggressive-drilldown: disable
aggressive-schedule : disable
drilldown-interval : 168
drilldown-status : enable
order : latest-first
status : enable
system route
Use this command to view IPv4 routing table configuration.
Syntax
get system route <entry number>
system route6
Use this command to view IPv6 routing table configuration.
Syntax
get system route6 <entry number>
system snmp
Use these commands to view SNMP configuration.
Syntax
get system snmp community <community ID>
get system snmp sysinfo
get system snmp user <SNMP user name>
Example
This example shows the output for get system snmp sysinfo:
contact_info : (null)
description : (null)
engine-id : (null)
location : (null)
CLI Reference
Fortinet Technologies Inc.
221
get
system sql
status : disable
trap-cpu-high-exclude-nice-threshold: 80
trap-high-cpu-threshold: 80
trap-low-memory-threshold: 80
system sql
Use this command to view SQL configuration.
Syntax
get system sql
Example
This example shows the output for get system sql:
custom-index:
prompt-sql-upgrade : enable
status : local
text-search-index : disable
ts-index-field:
== [ FGT-app-ctrl ]
category: FGT-app-ctrl value:
user,group,srcip,dstip,dstport,service,app,action,hostname
== [ FGT-attack ]
category: FGT-attack value: severity,srcip,dstip,action,user,attack
== [ FGT-content ]
category: FGT-content value: from,to,subject,action,srcip,dstip,hostname,status
== [ FGT-dlp ]
category: FGT-dlp value: user,srcip,service,action,filename
== [ FGT-emailfilter ]
category: FGT-emailfilter value: user,srcip,from,to,subject
== [ FGT-event ]
category: FGT-event value: subtype,ui,action,msg
== [ FGT-traffic ]
category: FGT-traffic value: user,srcip,dstip,service,app,utmaction
== [ FGT-virus ]
category: FGT-virus value: service,srcip,dstip,action,filename,virus,user
== [ FGT-voip ]
category: FGT-voip value: action,user,src,dst,from,to
== [ FGT-webfilter ]
category: FGT-webfilter value: user,srcip,dstip,service,action,catdesc,hostname
== [ FGT-netscan ]
category: FGT-netscan value: user,dstip,vuln,severity,os
== [ FML-emailfilter ]
category: FML-emailfilter value: client_name,dst_ip,from,to,subject
== [ FML-event ]
category: FML-event value: subtype,msg
== [ FML-history ]
category: FML-history value: classifier,disposition,from,to,client_
name,direction,domain,virus
== [ FML-virus ]
category: FML-virus value: src,msg,from,to
== [ FWB-attack ]
222
CLI Reference
Fortinet Technologies Inc.
system status
get
category: FWB-attack value: http_host,http_url,src,dst,msg,action
== [ FWB-event ]
category: FWB-event value: ui,action,msg
== [ FWB-traffic ]
category: FWB-traffic value: src,dst,service,http_method,msg
auto-table-upgrade : disable
database-type : postgres
logtype : app-ctrl attack content dlp emailfilter event generic history traffic virus
voip webfilter netscan
rebuild-event : enable
rebuild-event-start-time: 00:00 2000/01/01
start-time : 00:00 2000/01/01
table-partition-time-max: 0
system status
Use this command to view the status of your FortiManager unit.
Syntax
get system status
Example
This example shows the output for get system status:
Platform Enter : FMG-VM64-HV
Platform Full Name : FortiManager-VM64-HV
Version : v5.2.0-build0631 141003 (Interim)
Serial Number : FMG-VM0A11000XXX
BIOS version : 04000002
Hostname : FMG-VM64-HV
Max Number of Admin Domains : 1120
Max Number of Device Groups : 1120
Admin Domain Configuration : Enabled
HA Mode : HA Master
Branch Point : 631
Release Version Information : Interim
Current Time : Mon Oct 06 12:54:54 PDT 2014
Daylight Time Saving : Yes
Time Zone : (GMT-8:00) Pacific Time (US & Canada).
64-bit Applications : Yes
Disk Usage : Free 64.78GB, Total 78.74GB
License Status : Valid
system syslog
Use this command to view syslog information.
Syntax
get system syslog <syslog server name>
CLI Reference
Fortinet Technologies Inc.
223
get
system workflow
system workflow
Use this command to view workflow information.
Syntax
get system workflow approal-matrix <ADOM_name>
224
CLI Reference
Fortinet Technologies Inc.
show
The show commands display a part of your Fortinet unit’s configuration in the form of commands that are
required to achieve that configuration from the firmware’s default state.
Although not explicitly shown in this section, for all config commands, there are
related show commands that display that part of the configuration.The show commands use the same syntax as their related config command.
CLI commands and variables are case sensitive.
Unlike the get command, show does not display settings that are assumed to remain in their default state.
CLI Reference
Fortinet Technologies Inc.
225
Copyright© 2015 Fortinet, Inc. All rights reserved. Fortinet®, FortiGate®, FortiCare® and FortiGuard®, and certain other marks are registered trademarks of Fortinet,
Inc., in the U.S. and other jurisdictions, and other Fortinet names herein may also be registered and/or common law trademarks of Fortinet. All other product or company
names may be trademarks of their respective owners. Performance and other metrics contained herein were attained in internal lab tests under ideal conditions, and
actual performance and other results 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 certain expressly-identified
performance metrics and, in such event, only the specific performance metrics expressly identified in such binding written contract shall be binding on Fortinet. For
absolute clarity, any such warranty will be limited to performance in the same ideal conditions as in Fortinet’s internal lab tests. In no event does Fortinet make any
commitment related to future deliverables, features or development, and circumstances may change such that any forward-looking statements herein are not accurate.
Fortinet disclaims in full any covenants, representations, and guarantees pursuant hereto, whether express or implied. 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.