REFERENCE

FortiGate CLI
Version 3.0 MR6
Preliminary version: This version of the FortiGate CLI Reference was
completed shortly before the FortiOS v3.0 MR6 GA release. Consult the
most recent FortiOS 3.0 MR6 release notes and the Upgrade Guide for
FortiOS v3.0 MR6 for up-to-date information about all new MR6 features.
Fortinet Tech Docs will publish an updated version of the FortiGate CLI
Reference before the end of March 2008. Contact [email protected]
if you have any questions or comments about this preliminary version of
the FortiGate CLI Reference.
Note: This version of the FortiGate CLI Reference also contains CLI
commands for FortiOS Carrier 3.0 MR3

Visit http://support.fortinet.com to register your FortiGate CLI product. By registering you can receive product
updates, technical support, and FortiGuard services.

www.fortinet.com
FortiGate CLI Reference
Version 3.0 MR6
5 February 2008
01-30006-0015-20080205

© Copyright 2008 Fortinet, Inc. All rights reserved. No part of this

publication including text, examples, diagrams or illustrations may be
reproduced, transmitted, or translated in any form or by any means,
electronic, mechanical, manual, optical or otherwise, for any purpose,
without prior written permission of Fortinet, Inc.

Trademarks
Dynamic Threat Prevention System (DTPS), APSecure, FortiASIC,
FortiBIOS, FortiBridge, FortiClient, FortiGate, FortiGate Unified Threat
Management System, FortiGuard, FortiGuard Antispam, FortiGuard
Antivirus, FortiGuard Intrusion Prevention, FortiGuard Web Filtering,
FortiLog, FortiAnalyzer, FortiManager, Fortinet, FortiOS, FortiPartner,
FortiProtect, FortiReporter, FortiResponse, FortiShield, FortiVoIP, and
FortiWiFi are trademarks of Fortinet, Inc. in the United States and/or other
countries. The names of actual companies and products mentioned
herein may be the trademarks of their respective owners.
Contents

Contents
Introduction ....................................................................................... 15
About the FortiGate Unified Threat Management System ............................ 15
About this document........................................................................................ 15
FortiGate documentation ................................................................................. 16
Related documentation .................................................................................... 18
FortiManager documentation ....................................................................... 18
FortiClient documentation ............................................................................ 18
FortiMail documentation ............................................................................... 18
FortiAnalyzer documentation ....................................................................... 18
Fortinet Tools and Documentation CD ......................................................... 19
Fortinet Knowledge Center .......................................................................... 19
Comments on Fortinet technical documentation .......................................... 19
Customer service and technical support ....................................................... 19
Register your Fortinet product........................................................................ 19

What’s new ........................................................................................ 21

Using the CLI ..................................................................................... 27
CLI command syntax........................................................................................ 27
Administrator access ....................................................................................... 28
Connecting to the CLI ...................................................................................... 30
Connecting to the FortiGate console............................................................ 30
Setting administrative access on an interface .............................................. 31
Connecting to the FortiGate CLI using SSH ................................................ 31
Connecting to the FortiGate CLI using Telnet .............................................. 32
Connecting to the FortiGate CLI using the web-based manager ................. 32
CLI objects ........................................................................................................ 33
CLI command branches ................................................................................... 33
config branch................................................................................................ 34
get branch .................................................................................................... 36
show branch................................................................................................. 38
execute branch............................................................................................. 39
diagnose branch........................................................................................... 39
Example command sequences .................................................................... 39
CLI basics.......................................................................................................... 43
Command help ............................................................................................. 43
Command completion .................................................................................. 43
Recalling commands .................................................................................... 44
Editing commands........................................................................................ 44
Line continuation .......................................................................................... 44
Command abbreviation ................................................................................ 44

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 3
 Contents

Environment variables ................................................................................. 44

Encrypted password support ....................................................................... 45
Entering spaces in strings ............................................................................ 45
Entering quotation marks in strings.............................................................. 45
Entering a question mark (?) in a string ....................................................... 45
International characters ............................................................................... 46
Special characters ....................................................................................... 46
IP address formats....................................................................................... 46
Editing the configuration file ......................................................................... 46
Setting screen paging .................................................................................. 47
Changing the baud rate ............................................................................... 47
Using Perl regular expressions .................................................................... 48

Working with virtual domains.......................................................... 51

Enabling virtual domain configuration........................................................... 51
Accessing commands in virtual domain configuration................................ 51
Creating and configuring VDOMs ................................................................... 52
Creating a VDOM......................................................................................... 52
Assigning interfaces to a VDOM .................................................................. 52
Setting VDOM operating mode .................................................................... 52
Changing back to NAT/Route mode ............................................................ 53
Configuring inter-VDOM routing ..................................................................... 53
Changing the management VDOM.................................................................. 54
Creating VDOM administrators ....................................................................... 54
Troubleshooting ARP traffic on VDOMs ........................................................ 55
Duplicate ARP packets ................................................................................ 55
Multiple VDOMs solution.............................................................................. 55
Forward-domain solution ............................................................................. 55
global ................................................................................................................. 57
vdom .................................................................................................................. 60

alertemail ........................................................................................... 63
setting................................................................................................................ 64

antivirus ............................................................................................. 69
filepattern .......................................................................................................... 70
grayware............................................................................................................ 72
heuristic............................................................................................................. 74
quarantine ......................................................................................................... 75
quarfilepattern .................................................................................................. 78
service ............................................................................................................... 79

FortiGate CLI Version 3.0 MR6 Reference

4 01-30006-0015-20080205
Contents

firewall................................................................................................ 81
address, address6 ............................................................................................ 82
addrgrp, addrgrp6............................................................................................. 84
dnstranslation ................................................................................................... 85
gtp (FortiOS Carrier)......................................................................................... 87
ipmacbinding setting........................................................................................ 95
ipmacbinding table ........................................................................................... 97
ippool ................................................................................................................. 99
ldb-monitor...................................................................................................... 100
multicast-policy .............................................................................................. 102
policy, policy6 ................................................................................................. 104
profile............................................................................................................... 114
schedule onetime ........................................................................................... 149
schedule recurring ......................................................................................... 150
service custom................................................................................................ 152
service group .................................................................................................. 154
vip..................................................................................................................... 155
vipgrp............................................................................................................... 164

gui..................................................................................................... 165
console ............................................................................................................ 166
topology........................................................................................................... 167

imp2p................................................................................................ 169
aim-user........................................................................................................... 170
icq-user............................................................................................................ 171
msn-user.......................................................................................................... 172
old-version ...................................................................................................... 173
policy ............................................................................................................... 174
yahoo-user ...................................................................................................... 175

ips ..................................................................................................... 177

DoS................................................................................................................... 178
custom ............................................................................................................. 181
decoder............................................................................................................ 182
global ............................................................................................................... 183
rule ................................................................................................................... 185
sensor .............................................................................................................. 186

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 5
 Contents

log..................................................................................................... 189
custom-field .................................................................................................... 190
{disk | fortianalyzer | memory | syslogd | webtrends | fortiguard} filter.... 191
disk setting...................................................................................................... 196
fortianalyzer setting ....................................................................................... 199
fortiguard setting............................................................................................ 201
memory setting............................................................................................... 202
memory global setting ................................................................................... 203
report customization ...................................................................................... 204
report definition .............................................................................................. 205
report filter ...................................................................................................... 206
report output ................................................................................................... 207
report period ................................................................................................... 209
report schedule............................................................................................... 210
report scope.................................................................................................... 211
report selection............................................................................................... 213
report summary-layout .................................................................................. 214
syslogd setting ............................................................................................... 216
trafficfilter........................................................................................................ 218
config rule .................................................................................................. 218
webtrends setting........................................................................................... 220

notification (FortiOS Carrier) ......................................................... 221

notification ...................................................................................................... 222

router................................................................................................ 223
access-list ....................................................................................................... 224
aspath-list........................................................................................................ 226
auth-path ......................................................................................................... 228
bgp ................................................................................................................... 229
config router bgp ........................................................................................ 231
config admin-distance ................................................................................ 234
config aggregate-address .......................................................................... 235
config neighbor .......................................................................................... 235
config network............................................................................................ 239
config redistribute....................................................................................... 240
community-list ................................................................................................ 242
key-chain ......................................................................................................... 245

FortiGate CLI Version 3.0 MR6 Reference

6 01-30006-0015-20080205
Contents

multicast .......................................................................................................... 247

Sparse mode .............................................................................................. 247
Dense mode............................................................................................... 248
Syntax ........................................................................................................ 248
config router multicast ................................................................................ 249
config interface ........................................................................................... 251
config pim-sm-global .................................................................................. 253
ospf .................................................................................................................. 257
Syntax ........................................................................................................ 257
config router ospf ....................................................................................... 259
config area ................................................................................................. 261
config distribute-list .................................................................................... 265
config neighbor........................................................................................... 266
config network ............................................................................................ 266
config ospf-interface ................................................................................... 267
config redistribute ....................................................................................... 269
config summary-address ............................................................................ 270
policy ............................................................................................................... 272
prefix-list.......................................................................................................... 275
rip ..................................................................................................................... 278
config router rip .......................................................................................... 279
config distance ........................................................................................... 280
config distribute-list .................................................................................... 281
config interface ........................................................................................... 281
config neighbor........................................................................................... 283
config network ............................................................................................ 283
config offset-list .......................................................................................... 284
config redistribute ....................................................................................... 284
route-map ........................................................................................................ 286
Using route maps with BGP ....................................................................... 288
static ................................................................................................................ 292
static6 .............................................................................................................. 294

spamfilter ......................................................................................... 295

bword ............................................................................................................... 296
emailbwl........................................................................................................... 299
fortishield ........................................................................................................ 301
ipbwl................................................................................................................. 303
iptrust............................................................................................................... 305
mheader........................................................................................................... 306
options............................................................................................................. 308
DNSBL ............................................................................................................. 309

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 7
 Contents

system.............................................................................................. 311
accprofile......................................................................................................... 312
admin ............................................................................................................... 316
alertemail......................................................................................................... 321
arp-table .......................................................................................................... 322
auto-install ...................................................................................................... 323
autoupdate clientoverride.............................................................................. 324
autoupdate override ....................................................................................... 325
autoupdate push-update................................................................................ 326
autoupdate schedule...................................................................................... 328
autoupdate tunneling ..................................................................................... 330
aux ................................................................................................................... 332
bug-report ....................................................................................................... 333
console ............................................................................................................ 334
dhcp reserved-address .................................................................................. 335
dhcp server ..................................................................................................... 336
dns ................................................................................................................... 339
fortianalyzer, fortianalyzer2, fortianalyzer3 ................................................. 340
fortiguard......................................................................................................... 342
fortiguard-log .................................................................................................. 346
fortimanager.................................................................................................... 347
gi-gk (FortiOS Carrier).................................................................................... 349
global ............................................................................................................... 350
gre-tunnel ........................................................................................................ 358
ha ..................................................................................................................... 360
interface........................................................................................................... 373
ipv6-tunnel ...................................................................................................... 389
mac-address-table.......................................................................................... 390
management-tunnel ....................................................................................... 391
modem............................................................................................................. 393
npu ................................................................................................................... 396
proxy-arp ......................................................................................................... 397
replacemsg admin .......................................................................................... 398
replacemsg alertmail...................................................................................... 399
replacemsg auth ............................................................................................. 401
replacemsg fortiguard-wf .............................................................................. 404

FortiGate CLI Version 3.0 MR6 Reference

8 01-30006-0015-20080205
Contents

replacemsg ftp ................................................................................................ 406

replacemsg http .............................................................................................. 408
replacemsg im................................................................................................. 410
replacemsg mail.............................................................................................. 412
replacemsg mm1 (FortiOS Carrier) ............................................................... 414
replacemsg mm3 (FortiOS Carrier) ............................................................... 417
replacemsg mm4 (FortiOS Carrier) ............................................................... 419
replacemsg mm7 (FortiOS Carrier) ............................................................... 421
replacemsg nntp ............................................................................................. 424
replacemsg spam ........................................................................................... 426
replacemsg sslvpn ......................................................................................... 428
replacemsg-group (FortiOS Carrier) ............................................................. 429
replacemsg-image (FortiOS Carrier)............................................................. 432
session-helper ................................................................................................ 433
session-sync ................................................................................................... 434
Notes and limitations.................................................................................. 435
Configuring session synchronization.......................................................... 435
Configuring the session synchronization link ............................................. 436
session-ttl........................................................................................................ 439
settings ............................................................................................................ 440
snmp community ............................................................................................ 443
snmp sysinfo................................................................................................... 446
switch-interface .............................................................................................. 447
tos-based-priority ........................................................................................... 448
vdom-link......................................................................................................... 449
wireless mac-filter .......................................................................................... 451
wireless settings............................................................................................. 452
zone.................................................................................................................. 455

user................................................................................................... 457
Configuring users for authentication ........................................................... 458
Configuring users for password authentication .......................................... 458
Configuring peers for certificate authentication .......................................... 458
adgrp................................................................................................................ 459
dynamic-profile (FortiOS Carrier).................................................................. 460
msisdn-bwl (FortiOS Carrier)......................................................................... 462
msisdn-ip-filter (FortiOS Carrier) .................................................................. 464
msisdn-translation (FortiOS Carrier) ............................................................ 465

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 9
 Contents

fsae .................................................................................................................. 467

group ............................................................................................................... 469
ldap .................................................................................................................. 473
local ................................................................................................................. 476
peer .................................................................................................................. 478
peergrp ............................................................................................................ 480
radius............................................................................................................... 481
settings............................................................................................................ 483
tacacs+ ............................................................................................................ 484

vpn.................................................................................................... 487
certificate ca.................................................................................................... 488
certificate crl ................................................................................................... 489
certificate local ............................................................................................... 491
certificate ocsp ............................................................................................... 492
certificate remote............................................................................................ 493
ipsec concentrator ......................................................................................... 494
ipsec forticlient ............................................................................................... 495
ipsec manualkey............................................................................................. 496
ipsec manualkey-interface............................................................................. 499
ipsec phase1 ................................................................................................... 502
ipsec phase1-interface................................................................................... 510
ipsec phase2 ................................................................................................... 519
ipsec phase2-interface................................................................................... 526
l2tp ................................................................................................................... 533
pptp.................................................................................................................. 535
ssl monitor ...................................................................................................... 537
ssl settings...................................................................................................... 538
ssl web bookmarks ........................................................................................ 541
ssl web bookmarks-group ............................................................................. 543
ssl web favorite............................................................................................... 544

webfilter ........................................................................................... 547

bword............................................................................................................... 548
exmword.......................................................................................................... 550
fortiguard......................................................................................................... 552
FortiGuard-Web category blocking ............................................................ 552
ftgd-local-cat ................................................................................................... 555

FortiGate CLI Version 3.0 MR6 Reference

10 01-30006-0015-20080205
Contents

ftgd-local-rating .............................................................................................. 556

ftgd-ovrd .......................................................................................................... 557
urlfilter ............................................................................................................. 559

execute............................................................................................. 561
backup ............................................................................................................. 562
batch ................................................................................................................ 564
central-mgmt ................................................................................................... 565
cfg reload......................................................................................................... 566
cfg save ........................................................................................................... 567
clear system arp table .................................................................................... 568
cli status-msg-only ......................................................................................... 569
cli check-template-status............................................................................... 570
date .................................................................................................................. 571
deploy .............................................................................................................. 572
dhcp lease-clear.............................................................................................. 573
dhcp lease-list................................................................................................. 574
disconnect-admin-session ............................................................................ 575
factoryreset ..................................................................................................... 576
formatlogdisk .................................................................................................. 577
fortiguard-log update ..................................................................................... 578
fsae refresh ..................................................................................................... 579
ha disconnect.................................................................................................. 580
ha manage ....................................................................................................... 581
ha synchronize................................................................................................ 583
interface dhcpclient-renew ............................................................................ 585
interface pppoe-reconnect............................................................................. 586
log delete-all.................................................................................................... 587
log delete-filtered............................................................................................ 588
log delete-rolled .............................................................................................. 589
log display ....................................................................................................... 590
log filter............................................................................................................ 591
log fortianalzyer test-connectivity ................................................................ 593
log list .............................................................................................................. 594
log roll.............................................................................................................. 595
modem dial...................................................................................................... 596
modem hangup ............................................................................................... 597

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 11
 Contents

mrouter clear................................................................................................... 598

ping .................................................................................................................. 599
ping-options.................................................................................................... 600
ping6 ................................................................................................................ 602
reboot .............................................................................................................. 603
restore ............................................................................................................. 604
router clear bgp .............................................................................................. 606
router clear bfd ............................................................................................... 607
router clear ospf process .............................................................................. 608
router restart ................................................................................................... 609
send-fds-statistics.......................................................................................... 610
set-next-reboot ............................................................................................... 611
shutdown......................................................................................................... 612
ssh ................................................................................................................... 613
telnet ................................................................................................................ 614
time .................................................................................................................. 615
traceroute ........................................................................................................ 616
update-av......................................................................................................... 617
update-ips ....................................................................................................... 618
update-now ..................................................................................................... 619
upd-vd-license ................................................................................................ 620
usb-disk........................................................................................................... 621
vpn certificate ca ............................................................................................ 622
vpn certificate crl............................................................................................ 624
vpn certificate local ........................................................................................ 625
vpn certificate remote .................................................................................... 628
vpn sslvpn del-tunnel..................................................................................... 629
vpn sslvpn del-web ........................................................................................ 630

get..................................................................................................... 631
chassis status................................................................................................. 632
firewall service predefined ............................................................................ 635
gui console status .......................................................................................... 636
gui topology status ........................................................................................ 637
hardware status .............................................................................................. 638
ips decoder ..................................................................................................... 639
ips rule............................................................................................................. 640

FortiGate CLI Version 3.0 MR6 Reference

12 01-30006-0015-20080205
Contents

ipsec tunnel list............................................................................................... 641

router info bgp ................................................................................................ 642
router info bfd ................................................................................................. 644
router info multicast ....................................................................................... 645
router info ospf ............................................................................................... 647
router info protocols ...................................................................................... 649
router info rip .................................................................................................. 650
router info routing-table ................................................................................ 651
system admin list............................................................................................ 652
system admin status ...................................................................................... 653
system arp....................................................................................................... 654
system central-mgmt status .......................................................................... 655
system checksum........................................................................................... 656
system cmdb status ....................................................................................... 657
system dashboard .......................................................................................... 658
system fortianalyzer-connectivity................................................................. 659
system fortiguard-log-service status............................................................ 660
system fortiguard-service status .................................................................. 661
system ha status............................................................................................. 662
About the HA cluster index and the execute ha manage command .......... 664
system info admin ssh ................................................................................... 668
system info admin status............................................................................... 669
system performance status ........................................................................... 670
system session list......................................................................................... 672
system session status ................................................................................... 673
system status.................................................................................................. 674

Index................................................................................................. 675

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 13
 Contents

FortiGate CLI Version 3.0 MR6 Reference

14 01-30006-0015-20080205
Introduction About the FortiGate Unified Threat Management System

Introduction
This chapter introduces you to the FortiGate Unified Threat Management System
and the following topics:
• About the FortiGate Unified Threat Management System
• About this document
• FortiGate documentation
• Related documentation
• Customer service and technical support
• Register your Fortinet product

About the FortiGate Unified Threat Management System

The FortiGate Unified Threat Management System supports network-based
deployment of application-level services, including virus protection and full-scan
content filtering. FortiGate units improve network security, reduce network misuse
and abuse, and help you use communications resources more efficiently without
compromising the performance of your network.
The FortiGate unit is a dedicated easily managed security device that delivers a
full suite of capabilities that include:
• application-level services such as virus protection and content filtering,
• network-level services such as firewall, intrusion detection, VPN, and traffic
shaping.
The FortiGate unit employs Fortinet’s Accelerated Behavior and Content Analysis
System (ABACAS™) technology, which leverages breakthroughs in chip design,
networking, security, and content analysis. The unique ASIC-based architecture
analyzes content and behavior in real-time, enabling key applications to be
deployed right at the network edge where they are most effective at protecting
your networks. The FortiGate series complements existing solutions, such as
host-based antivirus protection, and enables new applications and services while
greatly lowering costs for equipment, administration, and maintenance.

About this document

This document describes how to use the FortiGate Command Line Interface
(CLI). This document contains the following chapters:
• Using the CLI describes how to connect to and use the FortiGate CLI.
• Working with virtual domains describes how to create and administer multiple
VDOMs. It also explains how enabling vdom-admin changes the way you work
with the CLI.
• alertemail is an alphabetic reference to the commands used to configure
alertemail.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 15
FortiGate documentation Introduction

• antivirus is an alphabetic reference to the commands used to configure

antivirus features.
• firewall is an alphabetic reference to the commands used to configure firewall
policies and settings.
• gui is an alphabetic reference to the commands used to set preferences for the
web-based manager CLI console and topology viewer.
• imp2p is an alphabetic reference to the commands used to configure user
access to Instant Messaging and Person-to-Person applications.
• ips is an alphabetic reference to the commands used to configure intrusion
detection and prevention features.
• log is an alphabetic reference to the commands used to configure logging.
• notification (FortiOS Carrier) is an alphabetic reference to the commands used
to configure FortiOS Carrier event notification.
• router is an alphabetic reference to the commands used to configure routing.
• spamfilter is an alphabetic reference to the commands used to configure spam
filtering features.
• system is an alphabetic reference to the commands used to configure the
FortiGate system settings.
• user is an alphabetic reference to the commands used to configure authorized
user accounts and groups.
• vpn is an alphabetic reference to the commands used to configure FortiGate
VPNs.
• webfilter is an alphabetic reference to the commands used to configure web
content filtering.
• execute is an alphabetic reference to the execute commands, which provide
some useful utilities such as ping and traceroute, and some commands used
for maintenance tasks.
• get is an alphabetic reference to commands that retrieve status information
about the FortiGate unit.

Note: Diagnose commands are also available from the FortiGate CLI. These commands
are used to display system information and for debugging. Diagnose commands are
intended for advanced users only, and they are not covered in this document. Contact
Fortinet technical support before using these commands.

FortiGate documentation
Information about FortiGate products is available from the following guides:
• FortiGate QuickStart Guide
Provides basic information about connecting and installing a FortiGate unit.
• FortiGate Installation Guide
Describes how to install a FortiGate unit. Includes a hardware reference,
default configuration information, installation procedures, connection
procedures, and basic configuration procedures. Choose the guide for your
product model number.

FortiGate CLI Version 3.0 MR6 Reference

16 01-30006-0015-20080205
Introduction FortiGate documentation

• FortiGate Administration Guide

Provides basic information about how to configure a FortiGate unit, including
how to define FortiGate protection profiles and firewall policies; how to apply
intrusion prevention, antivirus protection, web content filtering, and spam
filtering; and how to configure a VPN.
• FortiGate online help
Provides a context-sensitive and searchable version of the Administration
Guide in HTML format. You can access online help from the web-based
manager as you work.
• FortiGate CLI Reference
Describes how to use the FortiGate CLI and contains a reference to all
FortiGate CLI commands.
• FortiGate Log Message Reference
Describes the structure of FortiGate log messages and provides information
about the log messages that are generated by FortiGate units.
• FortiGate High Availability User Guide
Contains in-depth information about the FortiGate high availability feature and
the FortiGate clustering protocol.
• FortiGate IPS User Guide
Describes how to configure the FortiGate Intrusion Prevention System settings
and how the FortiGate IPS deals with some common attacks.
• FortiGate IPSec VPN User Guide
Provides step-by-step instructions for configuring IPSec VPNs using the web-
based manager.
• FortiGate SSL VPN User Guide
Compares FortiGate IPSec VPN and FortiGate SSL VPN technology, and
describes how to configure web-only mode and tunnel-mode SSL VPN access
for remote users through the web-based manager.
• FortiGate PPTP VPN User Guide
Explains how to configure a PPTP VPN using the web-based manager.
• FortiGate Certificate Management User Guide
Contains procedures for managing digital certificates including generating
certificate requests, installing signed certificates, importing CA root certificates
and certificate revocation lists, and backing up and restoring installed
certificates and private keys.
• FortiGate VLANs and VDOMs User Guide
Describes how to configure VLANs and VDOMS in both NAT/Route and
Transparent mode. Includes detailed examples.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 17
Related documentation Introduction

Related documentation
Additional information about Fortinet products is available from the following
related documentation.
FortiManager documentation
• FortiManager QuickStart Guide
Explains how to install the FortiManager Console, set up the FortiManager
Server, and configure basic settings.
• FortiManager System Administration Guide
Describes how to use the FortiManager System to manage FortiGate devices.
• FortiManager System online help
Provides a searchable version of the Administration Guide in HTML format.
You can access online help from the FortiManager Console as you work.

FortiClient documentation
• FortiClient Host Security User Guide
Describes how to use FortiClient Host Security software to set up a VPN
connection from your computer to remote networks, scan your computer for
viruses, and restrict access to your computer and applications by setting up
firewall policies.
• FortiClient Host Security online help
Provides information and procedures for using and configuring the FortiClient
software.

FortiMail documentation
• FortiMail Administration Guide
Describes how to install, configure, and manage a FortiMail unit in gateway
mode and server mode, including how to configure the unit; create profiles and
policies; configure antispam and antivirus filters; create user accounts; and set
up logging and reporting.
• FortiMail online help
Provides a searchable version of the Administration Guide in HTML format.
You can access online help from the web-based manager as you work.
• FortiMail Web Mail Online Help
Describes how to use the FortiMail web-based email client, including how to
send and receive email; how to add, import, and export addresses; and how to
configure message display preferences.

FortiAnalyzer documentation
• FortiAnalyzer Administration Guide
Describes how to install and configure a FortiAnalyzer unit to collect FortiGate
and FortiMail log files. It also describes how to view FortiGate and FortiMail log
files, generate and view log reports, and use the FortiAnalyzer unit as a NAS
server.
• FortiAnalyzer online help
Provides a searchable version of the Administration Guide in HTML format.
You can access online help from the web-based manager as you work.

FortiGate CLI Version 3.0 MR6 Reference

18 01-30006-0015-20080205
Introduction Customer service and technical support

Fortinet Tools and Documentation CD

All Fortinet documentation is available on the Fortinet Tools and Documentation
CD shipped with your Fortinet product. The documents on this CD are current at
shipping time. For up-to-date versions of Fortinet documentation visit the Fortinet
Technical Documentation web site at http://docs.forticare.com.

Fortinet Knowledge Center

Additional Fortinet technical documentation is available from the Fortinet
Knowledge Center. The knowledge center contains troubleshooting and how-to
articles, FAQs, technical notes, a glossary, and more. Visit the Fortinet Knowledge
Center at http://kc.forticare.com.

Comments on Fortinet technical documentation

Please send information about any errors or omissions in this document, or any
Fortinet technical documentation, to [email protected].

Customer service and technical support

Fortinet Technical Support provides services designed to make sure that your
Fortinet systems install quickly, configure easily, and operate reliably in your
network.
Please visit the Fortinet Technical Support web site at http://support.fortinet.com
to learn about the technical support services that Fortinet provides.

Register your Fortinet product

Register your Fortinet product to receive Fortinet customer services such as
product updates and technical support. You must also register your product for
FortiGuard services such as FortiGuard Antivirus and Intrusion Prevention
updates and for FortiGuard Web Filtering and AntiSpam.
Register your product by visiting http://support.fortinet.com and selecting Product
Registration.
To register, enter your contact information and the serial numbers of the Fortinet
products that you or your organization have purchased. You can register multiple
Fortinet products in a single session without re-entering your contact information.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 19
Register your Fortinet product Introduction

FortiGate CLI Version 3.0 MR6 Reference

20 01-30006-0015-20080205
What’s new

What’s new
The table below lists commands which have changed since the previous release, MR5.

Command Change
config firewall ldb-monitor New command. Configures health check settings which
can be used when enabling health checks for load
balanced real servers associated with a virtual IP.
config firewall policy, policy6
edit <index_int>
set auth-path New keyword. Enables authentication-based routing.
set auth-redirect-addr New keyword. Specifies address used in URL when
performing HTTP-to-HTTPS redirects for policy
authentication.
set custom-log-fields New keyword. Selects custom log fields to append to
the policy’s log message.
set sslvpn-auth tacacs+ New SSL VPN client authentication option. Selects
TACACS+ authentication method when the firewall
policy action is set to ssl-vpn.
config firewall profile Removed filetype option for all protocol variables
(smtp, pop3, etc.). Instead, the block option is now
used in conjunction with file-pat-table.
edit <profile_str>
set aim block-long-chat New option. Blocks oversize chat messages.
set ftgd-wf-options redir-block New option redir-block. Blocks HTTP redirects.
set ftgd-wf-ovrd-group Keyword removed.
set ftp scanextended New option scanextended. Scans for viruses and
worms using the extended database of virus definitions.
set http scanextended New option scanextended. Scans for viruses and
worms using the extended database of virus definitions.
set icq archive-full Option archive-full renamed from
content-full.
set icq archive-summary Option archive-summary renamed from
content-meta.
set ips-anomaly Keyword removed. IPS sensors, formerly signatures,
are now configured by selecting a sensor name.
set icq content-full Option content-full renamed to archive-full.
set icq content-meta Option content-meta renamed to
archive-summary.
set ips-log Keyword renamed to log-ips.
set ips-signature Keyword removed. Denial of service (DoS) sensors,
formerly anomalies, are no longer configured in
protection profiles.
set ips-sensor New keyword. Selects the IPS sensor name.
set ips-sensor-status New keyword. Enables use of IPS sensors.
set log-ips Keyword renamed from ips-log.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 21
 What’s new

Command Change
config firewall profile (continued)
set msn archive-full Option archive-full renamed from
content-full.
set msn archive-summary Option archive-summary renamed from
content-meta.
set msn content-full Option content-full renamed to archive-full.
set msn content-meta Option content-meta renamed to
archive-summary.
set yahoo archive-full Option archive-full renamed from
content-full.
set yahoo archive-summary Option archive-summary renamed from
content-meta.
set yahoo content-full Option content-full renamed to archive-full.
set yahoo content-meta Option content-meta renamed to
archive-summary.
config firewall vip
edit <name_str>
set http New keyword. Enables multiplexing of port forwarded
HTTP connections into a few connections to the
destination.
set http-ip-header New keyword. Preserves the original client’s IP address
in the X-Forwarded-For HTTP header line when
using HTTP multiplexing.
set max-embryonic-connections New keyword. Specifies the maximum number of
partially established SSL or HTTP connections when
the virtual IP is performing HTTP multiplexing or SSL
offloading.
set ssl New keywords. These keywords configure SSL
acceleration that offloads SSL operations from the
set ssl-certificate destination to the FortiGate unit.
set ssl-client-session-state-max
set ssl-client-session-state-timeout
set ssl-client-session-state-type
set ssl-dh-bits
set ssl-http-location-conversion
set ssl-http-match-host
set ssl-max-version
set ssl-min-version
set ssl-send-empty-frags
set ssl-server-session-state-max
set ssl-server-session-state-timeout
set ssl-server-session-state-type
config realservers
edit <table_int>
set healthcheck New keyword. Enables check of server responsiveness
before forwarding traffic. You must also configure
monitor.
set monitor New keyword. Sets name(s) of healthcheck monitor
settings to use.

FortiGate CLI Version 3.0 MR6 Reference

22 01-30006-0015-20080205
What’s new

Command Change
config fortianalyzer Removed.
config global
config system session-sync New command is global in scope.
execute vpn sslvpn del-tunnel Command is now per-VDOM.
execute vpn sslvpn del-web Command is now per-VDOM.
config ips anomaly Command renamed to config ips DoS and
extensively revised.
config ips decoder New command. Modifies ports on which IPS expects
particular traffic types.
config ips DoS Command renamed from config ips anomaly and
extensively revised. Anomalies are now defined in DoS
sensors.
config ips global
set ip-protocol Keyword removed.
config ips group Command removed.
config ips rule New command. Displays IPS settings for each
signature.
config ips sensor New command. Configures IPS sensors to detect
attacks. IPS sensors are made up of filters that specify
signature attributes and rules to override individual
sensors.
config log custom-field New command. Customizes the log fields with a name
and/or value that appears in log messages.
config log disk setting
set full-first-warning threshold New keywords. Define percentage thresholds for
warnings as the available disk space for logs fills up.
set full-second-warning threshold
set full-final-warning threshold
config log memory setting
set diskfull overwrite The nolog and blocktraffic options are removed.
config log memory global setting New command. Configures percentage thresholds for
warnings as memory allocated to logs fills up. Also
configures maximum number of lines in memory buffer
log.
config router auth-path New command. Configures authentication-based
routing.
config system accprofile
edit <profile-name>
set <access-group> <access-level> New option for <access-group>: imp2pgrp
config system admin
edit <name_str>
set schedule New keyword. Selects schedule that determines when
an administrator can log in.
set radius-auth Keyword renamed to remote-auth.
set radius-group Keyword renamed to remote-group.
set remote-auth Keyword renamed from radius-auth.
set remote-group Keyword renamed from radius-group.
config dashboard New subcommand. Configures web-based manager
dashboard for this administrator.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 23
 What’s new

Command Change
config dhcp server
set ipsec-lease-hold New keyword. Sets time to wait before expiring DHCP-
over-IPSec lease after IPSec tunnel goes down.
config system fm Command replaced by config system
fortimanager.
config system fortimanager New command. Replaces config system fm.
Configures central management on the FortiGate unit.
config system global
set auth-secure-http Keyword moved to config user settings.
set auth-type Keyword moved to config user settings.
set authtimeout Keyword moved to config user settings.
set fds-statistics-period New keyword. Sets the number of minutes in the FDS
report period when fds-statistics is enabled.
set local-anomaly Keyword removed.
config system interface
edit <interface name>
set gateway_address Keyword renamed to gwaddr.
set gwaddr Keyword renamed from gwaddr.
set ha-priority New keyword. Sets the HA priority to assign to the ping
servers configured on an interface when the interface is
added to an HA remote IP monitoring configuration.
set l2tp-client Keyword removed.
set lcp-max-echo-failures Keyword renamed to lcp-max-echo-fail.
set lcp-max-echo-fail Keyword renamed from lcp-max-echo-failures.
set pptp-client New keyword. Enables PPTP client on interface.
set pptp-user New keyword. Sets the name of the PPTP user.
set pptp-password New keyword. Sets the password for the PPTP user.
set pptp-server-ip New keyword. Sets the IP address of the PPTP server.
set pptp-auth-type New keyword. Sets the authentication type for the
PPTP user.
set pptp-timeout New keyword. Sets the PPTP idle timeout in minutes.
config l2tp-client Subcommand and all of its variables removed.
config system management-tunnel New command. Configures the remote management
tunnel and permitted remote management actions from
either the FortiManager unit or FortiGuard Management
Service.
config system session-sync New command. Configures TCP session
synchronization with another FortiGate unit.
config system settings
set p2p-rate-limit New keyword. Sets whether P2P bandwidth limit is
per-profile or per-policy.
set sip-nat-trace New keyword. Enables recording the original IP
address of the phone.
set status New keyword. Enables or disables this VDOM.
set utf8-spam-tagging New keyword. Enable conversion of spam tags to UTF8
for better non-ascii character support.
config system switch-interface New command. Groups interfaces as a virtual switch.

FortiGate CLI Version 3.0 MR6 Reference

24 01-30006-0015-20080205
What’s new

Command Change
config user fsae
edit <server_name>
set ldap_server New keyword. Sets the name of the LDAP server used
to access Windows AD user and group information.
config user radius
edit <server_name>
set auth-type New keyword. Set authentication type to CHAP, PAP,
MS-CHAP, MS-CHAPv2 or Auto.
set radius-port New keyword. Changes RADIUS port for this server.
config user settings New command. Replaces system global keywords
authtimeout, auth-type, and auth-secure-
http.
config user tacacs+ New command. Configures TACACS+ authentication.
config vpn certificate local
edit <cert_name>
set comments New keyword. Enters descriptive comment about the
certificate.
config vpn ipsec phase1-interface
set default-gw New keyword. Configures a default route for this IPSec
interface.
set default-gw-priority New keyword. Sets priority of default route defined with
set default-gw.
config vpn ssl settings
set auth-timeout You can set a value of 0 for no timeout.
set idle-timeout You can set a value of 0 for no timeout.
execute cli check-template-status New command. Reports the status of the SCP script
template.
execute fortiguard-log delete Command removed.
execute log list Removed category ids.
execute log stats display Command removed.
execute log stats reset Command removed.
execute send-fds-statistics New command. Sends an FDS statistics report
immediately.
firewall service predefined New command. Retrieves information about predefined
services.
get ips anomaly status Command removed. Replaced by get ips rule
status.
get ips custom status Command removed.
get ips decoder status New command.
get ips group status Command removed.
get ips rule status New command. Replaces get ips anomaly
status.
get system session list Command now applies per-VDOM.
get system session status New command. Returns the number of active sessions
in this VDOM. If VDOMs are not enabled, returns
number of active sessions on FortiGate unit.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 25
 What’s new

FortiGate CLI Version 3.0 MR6 Reference

26 01-30006-0015-20080205
Using the CLI CLI command syntax

Using the CLI

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.
This chapter describes:
• CLI command syntax
• Administrator access
• Connecting to the CLI
• CLI objects
• CLI command branches
• CLI basics

CLI command syntax

This guide uses the following conventions to describe command syntax.
• Angle brackets < > to indicate variables.
For example:
execute restore config <filename_str>
You enter:
execute restore config myfile.bak
<xxx_ipv4> indicates a dotted decimal IPv4 address.
<xxx_v4mask> indicates a dotted decimal IPv4 netmask.
<xxx_ipv4mask> indicates a dotted decimal IPv4 address followed by a
dotted decimal IPv4 netmask.
<xxx_ipv6> indicates an IPv6 address.
<xxx_v6mask> indicates an IPv6 netmask.
<xxx_ipv6mask> indicates an IPv6 address followed by an IPv6 netmask.
• Vertical bar and curly brackets {|} to separate alternative, mutually exclusive
required keywords.
For example:
set opmode {nat | transparent}
You can enter set opmode nat or set opmode transparent.
• Square brackets [ ] to indicate that a keyword or 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 internal interface, you can enter
show system interface internal.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 27
Administrator access Using the CLI

• A space to separate options that can be entered in any combination and must
be separated by spaces.
For example:
set allowaccess {ping https ssh snmp http telnet}
You can enter any of the following:
set allowaccess ping
set allowaccess ping https ssh
set allowaccess https ping ssh
set allowaccess snmp
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.

Administrator access
The access profile you are assigned in your administrator account controls which
CLI commands you can access. You need read access to view configurations and
write access to make changes. Access control in access profiles is divided into
groups, as follows:
Table 1: Access profile control of access to CLI commands

Access control group Available CLI commands

Admin Users (admingrp) system admin
system accprofile
Antivirus Configuration (avgrp) antivirus
Auth Users (authgrp) user
Firewall Configuration (fwgrp) firewall
FortiProtect Update (updategrp) system autoupdate
execute update-av
execute update-ips
execute update-now
IM, P2P & VoIP Configuration (imp2pgrp) imp2p
IPS Configuration (ipsgrp) ips
Log & Report (loggrp) alertemail
log
system fortianalyzer
execute log
Maintenance (mntgrp) execute backup
execute batch
execute formatlogdisk
execute restore
execute usb-disk

FortiGate CLI Version 3.0 MR6 Reference

28 01-30006-0015-20080205
Using the CLI Administrator access

Table 1: Access profile control of access to CLI commands

Network Configuration (netgrp) system arp-table

system dhcp
system interface
system zone
execute clear system arp
table
execute dhcp lease-clear
execute dhcp lease-list
execute interface
Router Configuration (routegrp) router
execute mrouter
execute router
Spamfilter Configuration (spamgrp) spamfilter
System Configuration (sysgrp) system except accprofile,
admin, arp-table,
autoupdate fortianalyzer,
interface and zone.
execute cfg
execute date
execute deploy
execute disconnect-admin-
session
execute factoryreset
execute ha
execute ping
execute ping6
execute ping-options
execute reboot
execute set-next-reboot
execute shutdown
execute ssh
execute telnet
execute time
execute traceroute
VPN Configuration (vpngrp) vpn
execute vpn
Webfilter Configuration (webgrp) webfilter

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 29
Connecting to the CLI Using the CLI

Connecting to the CLI

You can use a direct console connection, SSH, Telnet or the web-based manager
to connect to the FortiGate CLI.
• Connecting to the FortiGate console
• Setting administrative access on an interface
• Connecting to the FortiGate CLI using SSH
• Connecting to the FortiGate CLI using Telnet
• Connecting to the FortiGate CLI using the web-based manager

Connecting to the FortiGate console

Only the admin administrator or a regular administrator of the root domain can log
in by connecting to the console interface. You need:
• a computer with an available communications port
• a null modem cable, provided with your FortiGate unit, to connect the FortiGate
console port and a communications port on your computer
• terminal emulation software such as HyperTerminal for Windows

Note: The following procedure describes how to connect to the FortiGate CLI using
Windows HyperTerminal software. You can use any terminal emulation program.

To connect to the CLI

1 Connect the FortiGate console port to the available communications port on your
computer.
2 Make sure the FortiGate 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 FortiGate console port.
5 Select OK.
6 Select the following port settings and select OK.

Bits per second 9600 (115200 for the FortiGate-300)

Data bits 8
Parity None
Stop bits 1
Flow control None

7 Press Enter to connect to the FortiGate CLI.

A prompt similar to the following appears (shown for the FortiGate-300):
FortiGate-300 login:
8 Type a valid administrator name and press Enter.
9 Type the password for this administrator and press Enter.
The following prompt appears:
Welcome!
You have connected to the FortiGate CLI, and you can enter CLI commands.

FortiGate CLI Version 3.0 MR6 Reference

30 01-30006-0015-20080205
Using the CLI Connecting to the CLI

Setting administrative access on an interface

To perform administrative functions through a FortiGate 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 SSH or Telnet
access. If you want to use the web-based manager, you need HTTPS or HTTP
access.
To use the web-based manager to configure FortiGate interfaces for SSH or
Telnet access, see the FortiGate Administration Guide.

To use the CLI to configure SSH or Telnet access

1 Connect and log into the CLI using the FortiGate 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 FortiGate 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 the internal interface to accept HTTPS (web-based
manager), SSH and Telnet connections, enter:
config system interface
edit <name_str>
set allowaccess https ssh telnet
end

Note: 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 FortiGate configuration.

3 To confirm that you have configured SSH or Telnet access correctly, enter the
following command to view the access settings for the interface:
get system interface <name_str>
The CLI displays the settings, including allowaccess, for the named interface.

Other access methods

The procedure above shows how to allow access only for Telnet or only for SSH.
If you want to allow both or any of the other management access types you must
include all the options you want to apply. For example to allow PING, HTTPS and
SSH access to an interface, the set portion of the command is set
allowaccess ping https ssh.

Connecting to the FortiGate CLI using SSH

Secure Shell (SSH) provides strong secure authentication and secure
communications to the FortiGate CLI from your internal network or the internet.
Once the FortiGate 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
FortiGate CLI.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 31
Connecting to the CLI Using the CLI

Note: 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 FortiGate interface that is configured for SSH connections.
3 Type a valid administrator name and press Enter.
4 Type the password for this administrator and press Enter.
The FortiGate model name followed by a # is displayed.
You have connected to the FortiGate CLI, and you can enter CLI commands.

Connecting to the FortiGate CLI using Telnet

You can use Telnet to connect to the FortiGate CLI from your internal network or
the Internet. Once the FortiGate unit is configured to accept Telnet connections,
you can run a Telnet client on your management computer and use this client to
connect to the FortiGate CLI.

Caution: Telnet is not a secure access method. SSH should be used to access the
! FortiGate CLI from the Internet or any other unprotected network.

Note: A maximum of 5 Telnet connections can be open at the same time.

To connect to the CLI using Telnet

1 Install and start a Telnet client.
2 Connect to a FortiGate interface that is configured for Telnet connections.
3 Type a valid administrator name and press Enter.
4 Type the password for this administrator and press Enter.
The following prompt appears:
Welcome!
You have connected to the FortiGate CLI, and you can enter CLI commands.

Connecting to the FortiGate CLI using the web-based manager

The web-based manager also provides a CLI console that can be detached as a
separate window.

To connect to the CLI using the web-based manager

1 Connect to the web-based manager and log in.
For information about how to do this, see the FortiGate Administration Guide.
2 Go to System > Status.
3 If you do not see the CLI Console display, select Add Content > CLI Console.
4 Click in the CLI Console display to connect.

FortiGate CLI Version 3.0 MR6 Reference

32 01-30006-0015-20080205
Using the CLI CLI objects

CLI objects
The FortiGate CLI is based on configurable objects. The top-level objects are the
basic components of FortiGate functionality.

Table 2: CLI objects

alertemail sends email to designated recipients when it detects log messages of a

defined severity level
antivirus scans services for viruses and grayware, optionally providing quarantine
of infected files
firewall controls connections between interfaces according to policies based on
IP addresses and type of service, applies protection profiles
gui controls preferences for the web-based manager CLI console and
topology viewer
imp2p controls user access to Internet Messaging and Person-to-Person
applications
ips intrusion prevention system
log configures logging
notification configures event notification in FortiOS Carrier.
router moves packets from one network segment to another towards a network
destination, based on packet headers
spamfilter filters email based on MIME headers, a banned word list, lists of banned
email and ip addresses
system configures options related to the overall operation of the FortiGate unit,
such as interfaces, virtual domains, and administrators
user authenticates users to use firewall policies or VPNs
vpn provides Virtual Private Network access through the FortiGate unit
webfilter blocks or passes web traffic based on a banned word list, filter URLs, and
FortiGuard-Web category filtering

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 firewall object
contains objects for addresses, address groups, policies and protection profiles.

CLI command branches

The FortiGate CLI consists of the following command branches:
• config branch
• get branch
• show branch
• execute branch
• diagnose branch
Examples showing how to enter command sequences within each branch are
provided in the following sections. See also “Example command sequences” on
page 39.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 33
CLI command branches Using the CLI

config branch
The config commands configure CLI objects, such as the firewall, the router,
antivirus protection, and so on. For more information about CLI objects, see “CLI
objects” on page 33.
Top-level objects are containers for more specific lower level objects that are each
in the form of a table. For example, the firewall object contains tables of
addresses, address groups, policies and protection profiles. You can add, delete
or edit the entries in the table. Table entries consist of keywords that you can set
to particular values.
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
The command prompt changes to show that you are now in the admin shell.
(admin)#
This is a table shell. You can use any of the following commands:

delete Remove an entry from the FortiGate 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 FortiGate configuration or edit an existing entry. For
example in the config system admin shell:
• type edit admin and press Enter to edit the settings for the default
admin administrator account.
• 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 FortiGate 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.
move Change the position of an entry in an ordered table. For example in the
config firewall policy shell:
• type move 3 after 1 and press Enter to move the policy in the third
position in the table to the second position in the table.
• type move 3 before 1 and press Enter to move the policy in the
third position in the table to the first position in the table.
purge Remove all entries configured in the current shell. For example in the
config user local shell:
• type get to see the list of user names added to the FortiGate
configuration,
• type purge and then y to confirm that you want to purge all the user
names,
• type get again to confirm that no user names are displayed.
rename Rename a table entry. For example, in the config system admin
shell, you could rename “admin3” to “fwadmin” like this:
rename admin3 to fwadmin
show Show changes to the default configuration in the form of configuration
commands.

FortiGate CLI Version 3.0 MR6 Reference

34 01-30006-0015-20080205
Using the CLI CLI command branches

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 FortiGate 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 a secondary IP address to a network interface. See the
example “To add two secondary IP addresses to the internal interface”
on page 40.
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 user
accounts enter the config user local shell.
• Type edit User1 and press Enter.
• Use the set commands to configure the values for the new user
account.
• Type next to save the configuration for User1 without leaving the
config user local shell.
• Continue using the edit, set, and next commands to continue
adding user accounts.
• Type end and 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 password 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.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 35
CLI command branches Using the CLI

get branch
Use get to display system status information. For information about these
commands, see “get” on page 631.
You can also 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 a particular object.
To use get from the root prompt, you must include a path to a shell. The root
prompt is the FortiGate host name followed by a #.

Example
The command get hardware status provides information about various
physical components of the FortiGate unit.
# get hardware status
Model name: Fortigate-300
ASIC version: CP
SRAM: 64M
CPU: Pentium III (Coppermine)
RAM: 250 MB
Compact Flash: 122 MB /dev/hda
Hard disk: 38154 MB /dev/hdc
Network Card chipset: Intel(R) 8255x-based Ethernet Adapter
(rev.0x0009)

Note: Interface names vary for different FortiGate models. The following examples use the
interface names for a FortiGate-300 unit.

Example
When you type get in the config system interface shell, information about
all of the interfaces is displayed.
At the (interface)# prompt, type:
get
The screen displays:
== [ internal ]
name: internal mode: static ip: 192.168.20.200
255.255.255.0 status: up netbios-forward:
disable type: physical ip6-address: ::/0 ip6-send-adv:
disable
== [ external ]
name: external mode: static ip: 192.168.100.99
255.255.255.0 status: up netbios-forward:
disable type: physical ip6-address: ::/0 ip6-send-adv:
disable
...

FortiGate CLI Version 3.0 MR6 Reference

36 01-30006-0015-20080205
Using the CLI CLI command branches

Example
When you type get in the internal interface shell, the configuration values for
the internal interface are displayed.
edit internal
At the (internal)# prompt, type:
get
The screen displays:
name : internal
allowaccess : ping https ssh
arpforword : enable
cli_conn_status : 0
detectserver : (null)
gwdetect : disable
ip : 192.168.20.200 255.255.255.0
and so on.

Example
You are working in the config system global shell and want to see
information about the FortiGate interfaces.
At the (global)# prompt, type:
get system interface
The screen displays:
== [ internal ]
name: internal mode: static ip: 192.168.20.200
255.255.255.0 status: up netbios-forward:
disable type: physical ip6-address: ::/0 ip6-send-adv:
disable
== [ external ]
name: external mode: static ip: 192.168.100.99
255.255.255.0 status: up netbios-forward:
disable type: physical ip6-address: ::/0 ip6-send-adv:
disable
...

Example
You want to confirm the IP address and netmask of the internal interface from the
root prompt.
At the # prompt, type:
get system interface internal

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 37
CLI command branches Using the CLI

The screen displays:

name : internal
allowaccess : ping https ssh
arpforword : enable
cli_conn_status : 0
detectserver : (null)
gwdetect : disable
ip : 192.168.20.200 255.255.255.0
ip6-address : ::/0
ip6-default-life : 1800
...

show branch
Use show to display the FortiGate unit configuration. By default, only changes to
the default configuration are displayed. Use show full-configuration to
display the complete configuration.
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
object.
To display the configuration of all objects, you can use show from the root prompt.
The root prompt is the FortiGate host or model name followed by a #.

Example
When you type show and press Enter within the internal interface shell, the
changes to the default internal interface configuration are displayed.
At the (internal)# prompt, type:
show
The screen displays:
config system interface
edit internal
set allowaccess ssh ping https
set ip 192.168.20.200 255.255.255.0
next
end

Example
You are working in the internal interface shell and want to see the system
global configuration. At the (internal)# prompt, type:
show system global

FortiGate CLI Version 3.0 MR6 Reference

38 01-30006-0015-20080205
Using the CLI CLI command branches

The screen displays:

config system global
set admintimeout 5
set authtimeout 15
set failtime 5
set hostname 'Fortigate-300'
set interval 5
set lcdpin 123456
set ntpserver '132.246.168.148'
set syncinterval 60
set timezone 04
end

execute branch
Use execute to run static commands, to reset the FortiGate unit to factory
defaults, to back up or restore FortiGate configuration files. The execute
commands are available only from the root prompt.
The root prompt is the FortiGate host or model name followed by a #.

Example
At the root prompt, type:
execute reboot
and press Enter to restart the FortiGate unit.

diagnose branch
Commands in the diagnose branch are used for debugging the operation of the
FortiGate unit and to set parameters for displaying different levels of diagnostic
information. The diagnose commands are not documented in this CLI Reference
Guide.

Caution: Diagnose commands are intended for advanced users only. Contact Fortinet
! technical support before using these commands.

Example command sequences

Note: Interface names vary for different FortiGate models. The following examples use the
interface names for a FortiGate_300 unit.

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)#.
2 At the (dns)# prompt, type ?

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 39
CLI command branches Using the CLI

The following options are displayed.

set
unset
get
show
abort
end
3 Type set ?
The following options are displayed.
primary
secondary
domain
dns-cache-limit
cache-not-found-responses
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.
7 To restore the secondary DNS server address to the default address, type unset
secondary and press Enter.
8 If you want to leave the config system dns shell without saving your changes,
type abort and press Enter.
9 To save your changes and exit the dns sub-shell, type end and press Enter.
10 To confirm your changes have taken effect after leaving the dns sub-shell, type
get system dns and press Enter.

To add two secondary IP addresses to the internal interface

1 Starting at the root prompt, type:
config system interface
and press Enter. The prompt changes to (interface)#.
2 At the (interface)# prompt, type ?
The following options are displayed.
edit
delete
purge
rename
get
show
end

FortiGate CLI Version 3.0 MR6 Reference

40 01-30006-0015-20080205
Using the CLI CLI command branches

3 At the (interface)# prompt, type:

edit internal
and press Enter. The prompt changes to (internal)#.
4 At the (internal)# prompt, type ?
The following options are displayed.
config
set
unset
get
show
next
abort
end
5 At the (internal)# prompt, type:
config secondaryip
and press Enter. The prompt changes to (secondaryip)#.
6 At the (secondaryip)# prompt, type ?
The following options are displayed.
edit
delete
purge
rename
get
show
end
7 To add a secondary IP address with the ID number 0, type:
edit 0
and press Enter. The prompt changes to (0)#.
8 At the (0)# prompt, type ?
The following options are displayed.
set
unset
get
show
next
abort
end
9 Type set ?
The following options are displayed.
allowaccess
detectserver
gwdetect
ip

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 41
CLI command branches Using the CLI

10 To set the secondary IP address with the ID number 0 to 192.168.100.100 and

the netmask to 255.255.255.0, type:
set ip 192.168.100.100 255.255.255.0
and press Enter.
11 To add another secondary IP address to the internal interface, type next and
press Enter.
The prompt changes to (secondaryip)#.
12 To add a secondary IP address with the ID number 1, type:
edit 1
and press Enter. The prompt changes to (1)#.
13 To set the secondary IP address with the ID number 1 to 192.168.100.90 and
the netmask to 255.255.255.0, type:
set ip 192.168.100.90 255.255.255.0
and press Enter.
14 To restore the secondary IP address with the ID number 1 to the default, type
unset ip and press Enter.
15 If you want to leave the secondary IP address 1 shell without saving your
changes, type abort and press Enter.
16 To save your changes and exit the secondary IP address 1 shell, type end and
press Enter.
The prompt changes to (internal)#.
17 To delete the secondary IP address with the ID number 1, type delete 1 and
press Enter.
18 To save your changes and exit the internal interface shell, type end and press
Enter.
19 To confirm your changes have taken effect after using the end command, type
get system interface internal and press Enter.

FortiGate CLI Version 3.0 MR6 Reference

42 01-30006-0015-20080205
Using the CLI CLI basics

CLI basics
This section includes:
• Command help
• Command completion
• Recalling commands
• Editing commands
• Line continuation
• Command abbreviation
• 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
• IP address formats
• Editing the configuration file
• Setting screen paging
• Changing the baud rate
• Using Perl regular expressions

Command help
You can press the question mark (?) key to display command help.
• Press the question mark (?) key at the command prompt to display a list of the
commands available and a description of each command.
• Type a 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.
• Type 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 completion
You can use the tab key or the question mark (?) key to complete commands.
• 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.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 43
CLI basics Using the CLI

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 the Backspace and Delete keys and the control keys
listed in Table 3 to edit the command.

Table 3: Control keys for editing commands

Function Key combination

Beginning of line CTRL+A

End of line CTRL+E

Back one character CTRL+B

Forward one character CTRL+F

Delete current character CTRL+D

Previous command CTRL+P

Next command CTRL+N

Abort the command CTRL+C

If used at the root prompt, exit the CLI CTRL+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.

Environment variables
The FortiGate CLI supports the following environment variables.

$USERFROM The management access type (SSH, Telnet and so on) and the IP
address of the logged in administrator.
$USERNAME The user account name of the logged in administrator.
$SerialNum The serial number of the FortiGate unit.

Variable names are case sensitive. In the following example, the unit hostname is
set to the serial number.
config system global
set hostname $SerialNum
end

FortiGate CLI Version 3.0 MR6 Reference

44 01-30006-0015-20080205
Using the CLI CLI basics

Encrypted password support

After you enter a clear text password using the CLI, the FortiGate unit encrypts
the password and stores it in the configuration file with the prefix ENC. For
example:
show system admin user1
lists the user1 administrator password as follows:
config system admin
edit "user1"
set accprofile "prof_admin"
set password ENC XXNFKpSV3oIVk
next
end
It is also possible to enter an already encrypted password. For example, type:
config system admin
and press Enter.
Type:
edit user1
and press Enter.
Type:
set password ENC XXNFKpSV3oIVk
and press Enter.
Type:
end
and press Enter.

Entering spaces in strings

When a string value contains a space, do one of the following:
• Enclose the string in quotation marks, "Security Administrator", for
example.
• Enclose the string in single quotes, 'Security Administrator', for
example.
• 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.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 45
CLI basics Using the CLI

International characters
The CLI supports international characters in strings.The web-based manager
dashboard CLI Console applet supports the appropriate character set for the
current administration language. If you want to enter strings that contain Asian
characters, configure the CLI Console to use the external command input box.
International character support with external applications such as SSH clients
depends on the capabilities and settings of the application.

Special characters
The characters <, >, (, ), #, ’, and ” are not permitted in most CLI fields. The
exceptions are:
• passwords
• replacemsg buffer
• firewall policy comments
• ips custom signature
• antivirus filepattern
• antivirus exemptfilepattern
• webfilter bword
• spamfilter bword pattern
• system interface username (PPPoE mode)
• system modem phone numbers or account user names
• firewall profile comment
• spamfilter mheader fieldbody
• spamfilter mheader fieldbody
• spamfilter emailbwl email_pattern
• router info bgp regular expressions
• router aspath-list rule regular expressions

IP address formats
You can enter an IP 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 IP address is displayed in the configuration file in dotted decimal format.

Editing the configuration file

You can change the FortiGate configuration by backing up the configuration file to
a TFTP server. Then you can make changes to the file and restore it to the
FortiGate unit.
1 Use the execute backup config command to back up the configuration file to
a TFTP server.

FortiGate CLI Version 3.0 MR6 Reference

46 01-30006-0015-20080205
Using the CLI CLI basics

2 Edit the configuration file using a text editor.

Related commands are listed together in the configuration file. For instance, all
the system commands are grouped together, all the antivirus commands are
grouped together and so on. 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 FortiGate model. Do not edit this line. If you change this information
the FortiGate unit will reject the configuration file when you attempt to restore it.
3 Use the execute restore config command to copy the edited configuration
file back to the FortiGate unit.
The FortiGate unit receives the configuration file and checks to make sure the
firmware version and model information is correct. If it is, the FortiGate unit loads
the configuration file and checks each command for errors. If the FortiGate unit
finds an error, an error message is displayed after the command and the
command is rejected. Then the FortiGate unit restarts and loads the new
configuration.

Setting screen paging

Using the config system console command, you can configure the display to
pause when the screen is full. This is convenient for viewing the lengthy output of
a command such as get system global.
When the display pauses, the bottom line of the console displays --More--. You
can then do one of the following:
• Press the spacebar to continue.
• Press Q to end the display. One more line of output is displayed, followed by
the shell prompt.
To set paged output, enter the following command:
config system console
set output more
end

Changing the baud rate

Using set baudrate in the config system console shell, you can change
the default console connection baud rate.

Note: Changing the default baud rate is available for FortiGate units with BIOS 3.03 and
higher and FortiOS version 2.50 and higher.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 47
CLI basics Using the CLI

Using Perl regular expressions

Some FortiGate features, such as spam filtering and web content filtering can use
either wildcards or Perl regular expressions.
See http://perldoc.perl.org/perlretut.html for detailed information about using Perl
regular expressions.

Some differences between regular expression and wildcard

pattern matching
In Perl regular expressions, ‘.’ character refers to any single character. It is similar
to the ‘?’ character in wildcard pattern matching. As a result:
• fortinet.com not only matches fortinet.com but also matches
fortinetacom, fortinetbcom, fortinetccom and so on.
To match a special character such as '.' and ‘*’, regular expressions use the ‘\’
escape character. For example:
• To match fortinet.com, the regular expression should be
fortinet\.com.
In Perl regular expressions, ‘*’ means match 0 or more times of the character
before it, not 0 or more times of any character. For example:
• forti*\.com matches fortiiii.com but does not match fortinet.com.
To match any character 0 or more times, use ‘.*’ where ‘.’ means any character
and the ‘*’ means 0 or more times. For example:
• the wildcard match pattern forti*.com is equivalent to the regular
expression forti.*\.com.

Word boundary
In Perl regular expressions, the pattern does not have an implicit word boundary.
For example, the regular expression “test” not only matches the word “test” but
also matches any word that contains the word “test” such as “atest”, “mytest”,
“testimony”, “atestb”. The notation “\b” specifies the word boundary. To match
exactly the word “test”, the expression should be \btest\b.

Case sensitivity
Regular expression pattern matching is case sensitive in the Web and Spam
filters. To make a word or phrase case insensitive, use the regular expression /i.
For example, /bad language/i will block all instances of “bad language”
regardless of case.

Table 4: Perl regular expression examples

Expression Matches
abc abc (that exact character sequence, but anywhere in the string)
^abc abc at the beginning of the string
abc$ abc at the end of the string
a|b either of a and b
^abc|abc$ the string abc at the beginning or at the end of the string
ab{2,4}c an a followed by two, three or four b's followed by a c

FortiGate CLI Version 3.0 MR6 Reference

48 01-30006-0015-20080205
Using the CLI CLI basics

Table 4: Perl regular expression examples

ab{2,}c an a followed by at least two b's followed by a c
ab*c an a followed by any number (zero or more) of b's followed by a c
ab+c an a followed by one or more b's followed by a c
ab?c an a followed by an optional b followed by a c; that is, either abc or ac
a.c an a followed by any single character (not newline) followed by a c
a\.c a.c exactly
[abc] any one of a, b and c
[Aa]bc either of Abc and abc
[abc]+ any (nonempty) string of a's, b's and c's (such as a, abba, acbabcacaa)
[^abc]+ any (nonempty) string which does not contain any of a, b and c (such as
defg)
\d\d any two decimal digits, such as 42; same as \d{2}
/i makes the pattern case insensitive. For example, /bad language/i
blocks any instance of “bad language” regardless of case.
\w+ a "word": a nonempty sequence of alphanumeric characters and low
lines (underscores), such as foo and 12bar8 and foo_1
100\s*mk the strings 100 and mk optionally separated by any amount of white
space (spaces, tabs, newlines)
abc\b abc when followed by a word boundary (e.g. in abc! but not in abcd)
perl\B perl when not followed by a word boundary (e.g. in perlert but not in perl
stuff)
\x tells the regular expression parser to ignore white space that is neither
backslashed nor within a character class. You can use this to break up
your regular expression into (slightly) more readable parts.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 49
CLI basics Using the CLI

FortiGate CLI Version 3.0 MR6 Reference

50 01-30006-0015-20080205
Working with virtual domains Enabling virtual domain configuration

Working with virtual domains

By default, the FortiGate unit has one virtual domain (root) and one administrator (admin) with
unrestricted access to the system configuration. If you enable virtual domain configuration, the super
admin account can also:
• Use the vdom command to create and configure additional virtual domains.
• Use the global command to create and assign administrators to each virtual domain.
• Use the global command to configure features that apply to all virtual domains.
This section contains the following topics:

Enabling virtual domain configuration Creating VDOM administrators

Accessing commands in virtual domain configuration Troubleshooting ARP traffic on VDOMs
Creating and configuring VDOMs global
Configuring inter-VDOM routing vdom
Changing the management VDOM

Enabling virtual domain configuration

The administrators with the super_admin profile can enable virtual domain configuration through either
the web-based manager or the CLI. In the CLI, use the following command:
config system global
set vdom-admin enable
end
Log off and then log on again with a super_admin admin account. By default, there is no password for
the default admin account.

Accessing commands in virtual domain configuration

When you log in as admin with virtual domain configuration enabled, you have only four top-level
commands:

config global Enter config global to access global commands.

In the global shell, you can execute commands that affect all virtual domains, such as
config system autoupdate.
For a list of the global commands, see “global” on page 57.
config vdom Enter config vdom to access VDOM-specific commands.
In the vdom shell, use the edit <vdom_name> command to create a new VDOM or to
edit the configuration of an existing VDOM.
In the <vdom_name> shell, you can execute commands to configure options that apply
only within the VDOM, such as config firewall policy.
For a list of VDOM-specific commands, see “vdom” on page 60.
When you have finished, enter next to edit another vdom, or end.
get system status System status. See “vdom-link” on page 449.
exit Log off.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 51
Creating and configuring VDOMs Working with virtual domains

Creating and configuring VDOMs

When virtual domain configuration is enabled, admin has full access to the global FortiGate unit
configuration and to the configuration of each VDOM. All of the commands described in this Reference
are available to admin, but they are accessed through a special top-level command shell.

Creating a VDOM
You create a new VDOM using the config vdom command. For example, to create a new VDOM
called vdomain2, you enter the following:
config vdom
edit vdomain2
end
This creates a new VDOM operating in NAT/Route mode. You can have up to 10 VDOMs on your
FortiGate unit by default.
For this VDOM to be useful, you need to assign interfaces or VLAN subinterfaces to it.

Assigning interfaces to a VDOM

By default, all interfaces belong to the root domain. You can reassign an interface or VLAN
subinterface to another VDOM if the interface is not already used in a VDOM-specific configuration
such as a firewall policy. Interfaces are part of the global configuration of the FortiGate unit, so only the
admin account can configure them.
For example, to assign port3 and port4 to vdomain2, log on as admin and enter the following
commands:
config global
config system interface
edit port3
set vdom vdomain2
next
edit port4
set vdom vdomain2
end
end

Setting VDOM operating mode

When you create a VDOM, its default operating mode is NAT/Route. You can change the operating
mode of each VDOM independently.

Changing to Transparent mode

When you change the operating mode of a VDOM from NAT/Route to Transparent mode, you must
specify the management IP address and the default gateway IP address. The following example
shows how to change vdomain2 to Transparent mode. The management IP address is
192.168.10.100, and the default gateway is 192.168.10.1:
config vdom
edit vdomain3
config system settings
set opmode transparent
set manageip 192.168.10.100 255.255.255.0
set gateway 192.168.10.1
end

FortiGate CLI Version 3.0 MR6 Reference

52 01-30006-0015-20080205
Working with virtual domains Configuring inter-VDOM routing

For more information, see “system settings” on page 440.

Changing back to NAT/Route mode

If you change a Transparent mode VDOM back to NAT/Route mode, you must specify which interface
you will use for administrative access and the IP address for that interface. This ensures that
administrative access is configured on the interface. You must also specify the default gateway IP
address and the interface that connects to the gateway. For example,
config vdom
edit vdomain3
config system settings
set opmode nat
end
config system interface
edit port1
set ip 192.168.10.100 255.255.255.0
end
For more information, see “system settings” on page 440.

Configuring inter-VDOM routing

By default, VDOMs are independent of each other and to communicate they need to use physical
interfaces that are externally connected. By using the vdom-link command that was added in
FortiOS v3.0, this connection can be moved inside the FortiGate unit, freeing up the physical
interfaces. This feature also allows you to determine the level of inter-VDOM routing you want - only 2
VDOMs inter-connected, or interconnect all VDOMs. The vdom-link command creates virtual
interfaces, so you have access to all the security available to physical interface connections. These
internal interfaces have the added bonus of being faster the physical interfaces unless the CPU load is
very heavy. As of FortiOS v3.0 MR3, BGP is supported over inter-VDOM links.
In this example you already have configured two VDOMs called v1 and v2. You want to set up a link
between them. The following command creates the VDOM link called v12_link. Once you have the link
in place, you need to bind the two ends of the link to the VDOMs it will be connecting. Then you are
free to apply firewall policies or other security measures. t.
config global
config system vdom-link
edit v12_link
end
config system interface
edit v12_link0
set vdom v1
next
edit v12_link1
set vdom v2
next
end
Note: When you are naming VDOM links you are limited to 8 characters for the base name. In the
example below the link name v12_link that is used is correct, but a link name of v12_verylongname is too
long.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 53
Changing the management VDOM Working with virtual domains

To remove the vdom-link, delete the vdom-link. You will not be able to delete the ends of the vdom-link
by themselves. To delete the above set up, enter:
config global
config system vdom-link
delete v12_link
end
Note: In an HA setup with virtual clusters, inter-VDOM routing must be entirely within one cluster. You
cannot create links between virtual clusters, and you cannot move a VDOM that is linked into another
virtual cluster. In HA mode, with multiple vclusters when you create the vdom-link in system vdom-link
there is an option to set which vcluster the link will be in.

Before inter-VDOM routing, VDOMs were completely separate entities. Now, many new configurations
are available such as a service provider configuration (a number of VDOMS that go through one main
VDOM to access the internet) or a mesh configuration (where some or all VDOMs are connected to
some or all other VDOMs). These configurations are discussed in-depth in the FortiGate VLANs and
VDOMs Guide.

Changing the management VDOM

All management traffic leaves the FortiGate unit through the management VDOM. Management traffic
includes all external logging, remote management, and other Fortinet services. By default the
management VDOM is root. You can change this to another VDOM so that the traffic will leave your
FortiGate unit over the new VDOM.
You cannot change the management VDOM if any administrators are using RADIUS authentication.
If you want to change the management VDOM to vdomain2, you enter:
config global
config system global
set management-vdom vdomain2
end

Creating VDOM administrators

The super_admin admin accounts can create regular administrators and assign them to VDOMs. The
system admin command, when accessed by admin, includes a VDOM assignment.
For example, to create an administrator, admin2, for VDOM vdomain2 with the default profile
prof_admin, you enter:
config global
config system admin
edit admin2
set accprofile prof_admin
set password hardtoguess
set vdom vdomain2
end
The admin2 administrator account can only access the vdomain2 VDOM and can connect only through
an interface that belongs to that VDOM. The VDOM administrator can access only VDOM-specific
commands, not global commands.

FortiGate CLI Version 3.0 MR6 Reference

54 01-30006-0015-20080205
Working with virtual domains Troubleshooting ARP traffic on VDOMs

Troubleshooting ARP traffic on VDOMs

Address Resolution Protocol (ARP) traffic is vital to communication on a network and is enabled on
FortiGate interfaces by default. Normally you want ARP packets to pass through the FortiGate unit,
especially if it is sitting between a client and a server or between a client and a router.

Duplicate ARP packets

ARP traffic can cause problems, especially in Transparent mode where ARP packets arriving on one
interface are sent to all other interfaces, including VLAN subinterfaces. Some Layer 2 switches
become unstable when they detect the same MAC address originating on more than one switch
interface or from more than one VLAN. This instability can occur if the Layer 2 switch does not
maintain separate MAC address tables for each VLAN. Unstable switches may reset causing network
traffic to slow down.

Multiple VDOMs solution

One solution is to configure multiple VDOMs on the FortiGate unit, one for each VLAN. This means
one inbound and one outbound VLAN interface in each virtual domain. ARP packets are not forwarded
between VDOMs.
By default, physical interfaces are in the root domain. Do not configure any of your VLANs in the root
domain.
As a result of this VDOM configuration, the switches do not receive multiple ARP packets with the
same source MAC but different VLAN IDs, and the instability does not occur.

Forward-domain solution
You may run into problems using the multiple VDOMs solution. It is possible that you have more
VLANs than licensed VDOMs, not enough physical interfaces or your configuration may work better by
grouping some VLANs together. In these situations the separate VDOMs solution may not work for
you.
In these cases, the solution is to use the forward-domain <collision_group_number> command. This
command tags VLAN traffic as belonging to a particular forward-domain collision group, and only
VLANs tagged as part of that collision group receive that traffic. By default ports and VLANs are part of
forward-domain collision group 0. For more information, see the FortiGate VLANs and VDOMs Guide.
There are many benefits for this solution from reduced administration, to using fewer physical
interfaces to being able to allowing you more flexible network solutions.
In the following example, forward-domain collision group 340 includes VLAN 340 traffic on Port1 and
untagged traffic on Port2. Forward-domain collision group 341 includes VLAN 341 traffic on Port1 and
untagged traffic on Port3. All other ports are part of forward-domain collision group 0 by default.
These are the CLI commands to accomplish this setup.
config system interface
edit “port1”
next
edit "port2"
set forward_domain 340
next
edit “port3”
set forward_domain 341
next

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 55
Troubleshooting ARP traffic on VDOMs Working with virtual domains

edit "port1-340"
set forward_domain 340
set interface "port1"
set vlanid 340
next
edit "port1-341"
set forward_domain 341
set interface "port1"
set vlanid 341
next
end
There is a more detailed discussion of this issue in the Asymmetric Routing and Other FortiGate Layer-
2 Installation Issues technical note.

FortiGate CLI Version 3.0 MR6 Reference

56 01-30006-0015-20080205
Working with virtual domains global

global
From the super_admin accounts, use this command to configure features that apply to all virtual
domains. Virtual domain configuration (vdom-admin) must be enabled. See “system global” on
page 350.

Syntax
This command syntax shows how you access the commands within config global. For information on
these commands, refer to the relevant sections in this Reference.
config global
config antivirus ...
config firewall service
config gui console
config imp2p ...
config ips ...
config log fortianalyzer setting
config log report definition
config log report filter
config log report output
config log report period
config log report schedule
config log report scope
config log report selection
config log syslogd setting
config log webtrends setting
config spamfilter ...
config system accprofile
config system admin
config system alertemail
config system auto-install
config system autoupdate clientoverride
config system autoupdate override
config system autoupdate override
config system autoupdate push-update
config system autoupdate schedule
config system autoupdate tunneling
config system bug-report
config system console
config system dns
config system fortiguard
config system fortianalyzer, fortianalyzer2, fortianalyzer3
config system fortiguard
config system gi-gk (FortiOS Carrier)
config system global
config system ha
config system interface
config system replacemsg admin
config system replacemsg alertmail
config system replacemsg auth
config system replacemsg fortiguard-wf
config system replacemsg ftp
config system replacemsg http

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 57
global Working with virtual domains

config system replacemsg im

config system replacemsg mail
config system replacemsg mm1 (FortiOS Carrier)
config system replacemsg mm3 (FortiOS Carrier)
config system replacemsg mm4 (FortiOS Carrier)
config system replacemsg mm7 (FortiOS Carrier)
config system replacemsg nntp
config system replacemsg spam
config system replacemsg sslvpn
config system replacemsg-group (FortiOS Carrier)
config system replacemsg-image (FortiOS Carrier)
config system session-helper
config system session-sync
config system snmp community
config system snmp sysinfo
config system vdom-link
config user dynamic-profile (FortiOS Carrier)
config vpn certificate ca
config vpn certificate crl
config vpn certificate local
config vpn certificate remote
config webfilter fortiguard
execute backup
execute batch
execute central-mgmt
execute cfg reload
execute cfg save
execute cli
execute date
execute deploy
execute dhcp lease-list
execute disconnect-admin-session
execute factoryreset
execute formatlogdisk
execute fsae refresh
execute ha disconnect
execute ha manage
execute ha synchronize
execute log delete-all
execute log delete-filtered
execute log delete-rolled
execute log display
execute log filter
execute log list
execute log roll
execute reboot
execute restore
execute set-next-reboot
execute shutdown
execute time
execute update-av
execute update-ips
execute update-now
execute usb-disk

FortiGate CLI Version 3.0 MR6 Reference

58 01-30006-0015-20080205
Working with virtual domains global

execute vpn certificate ...

get firewall vip ...
end

History
FortiOS v3.0 New.
FortiOS v3.0 MR1 Added vdom-link, vpn, webfilter, execute backup, batch, dhcp lease-client, dhcp lease-
list, fsae refresh, restore, telnet, and traceroute.
FortiOS v3.0 MR5 Added config firewall service, gui console, system console, system fortiguard, system
replacemsg admin/alertemail/auth/nntp, vpn certificate crl/local/remote, execute
central-mgmt, execute cfg ..., execute update-ips, and execute update-now.
FortiOS v3.0 MR6 Added config system session-sync, expanded command to vpn
certificate ... .Removed vpn sslvpn.

Related topics
• vdom

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 59
vdom Working with virtual domains

vdom
From the super admin account, use this command to add and configure virtual domains. The number
of virtual domains you can add is dependent on the FortiGate model. Virtual domain configuration
(vdom-admin) must be enabled. See “system global” on page 350.
Once you add a virtual domain you can configure it by adding zones, firewall policies, routing settings,
and VPN settings. You can also move physical interfaces from the root virtual domain to other virtual
domains and move VLAN subinterfaces from one virtual domain to another.
By default all physical interfaces are in the root virtual domain. You cannot remove an interface from a
virtual domain if the interface is part of any of the following configurations:
• routing
• proxy arp
• DHCP server
• zone
• firewall policy
• IP pool
• redundant pair
• link aggregate (802.3ad) group
Delete these items or modify them to remove the interface first.
You cannot delete the default root virtual domain and you cannot delete a virtual domain that is used
for system management.

Syntax
This command syntax shows how you access the commands within config global. Refer to the relevant
sections in this Reference for information on these commands.
config vdom
edit <vdom_name>
config antivirus
config firewall address, address6
config firewall addrgrp, addrgrp6
config firewall dnstranslation
config firewall ipmacbinding setting
config firewall ipmacbinding table
config firewall ippool
config firewall multicast-policy
config firewall policy, policy6
config firewall schedule onetime
config firewall schedule recurring
config firewall service custom
config firewall service group
config firewall vip
config gui
config log {disk | fortianalyzer | memory | syslogd | webtrends |
fortiguard} filter
config log fortianalyzer setting
config log memory setting
config log trafficfilter
config router ...
config system admin

FortiGate CLI Version 3.0 MR6 Reference

60 01-30006-0015-20080205
Working with virtual domains vdom

config system arp-table

config system dhcp reserved-address
config system dhcp server
config system gre-tunnel
config system interface
config system ipv6-tunnel
config system proxy-arp
config system session-ttl
config system settings
config system zone
config user adgrp
config user fsae
config user group
config user ldap
config user local
config user msisdn-bwl (FortiOS Carrier)
config user msisdn-translation (FortiOS Carrier)
config user peer
config user peergrp
config user radius
config vpn ...
execute backup
execute date
execute deploy
execute dhcp lease-list
execute disconnect-admin-session
execute fsae refresh
execute ha disconnect
execute ha manage
execute ha synchronize
execute log delete-all
execute log delete-filtered
execute log delete-rolled
execute log display
execute log filter
execute log list
execute log roll
execute ping
execute ping-options
execute ping6
execute reboot
execute restore
execute router clear bgp
execute router clear ospf process
execute router restart
execute set-next-reboot
execute traceroute
execute usb-disk
execute vpn sslvpn del-tunnel
next
edit <another_vdom>
config ...
execute ...
end

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 61
vdom Working with virtual domains

end
Variable Description Default
edit <vdom_name> Enter a new name to create a new VDOM. Enter an existing
VDOM name to configure that VDOM.
The VDOM you enter becomes the current VDOM.
A VDOM cannot have the same name as a VLAN.
A VDOM name cannot exceed 11 characters in length.

Note: The VDOM names vsys_ha and vsys_fgfm are in use by the FortiGate unit. If you attempt to
name a new VDOM vsys_ha or vsys_fgfm it will generate an error.

Note: Use config system settings set opmode {nat | transparent} to set the operation
mode for this VDOM to nat (NAT/Route) or transparent.

Example
This example shows how to add a virtual domain called Test1.
config system vdom
edit Test1
end

History
FortiOS v3.0 New.
FortiOS v3.0 MR1 Added system admin, interface, ipv6-tunnel commands.
Added batch, date, reboot, execute router clear ospf process
commands.
Removed log fortianalyzer, log syslogd, log webtrends, router
graceful-restart commands.
FortiOS v3.0 MR1 Added system setting multicast-forward and multicast-ttl-notchange.
FortiOS v3.0 MR5 Removed config alertemail, and execute batch.
Added config gui, system arp-table, system proxy-arp, all of system settings.

Related topics
• global

FortiGate CLI Version 3.0 MR6 Reference

62 01-30006-0015-20080205
alertemail

alertemail
Use alertemail commands to configure the FortiGate unit to monitor logs for log messages with
certain severity levels. If the message appears in the logs, the FortiGate unit sends an email to a
predefined recipient(s) of the log message encountered. Alert emails provide immediate notification of
issues occurring on the FortiGate unit, such as system failures or network attacks.
By default, the alertemail commands do not appear if no SMTP server is configured. An SMTP
server is configured using the system alertemail commands. See “system alertemail” on page 321 for
more information.
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.
See “dns” on page 339 for more information about configuring DNS servers.
This chapter contains the following section:

setting

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 63
setting alertemail

setting
Use this command to configure the FortiGate unit to send an alert email to up to three recipients. This
command can also be configured to send an alert email a certain number of days before the FDS
license expires and/or when the disk usage exceeds a certain threshold amount. You need to configure
an SMTP server before configuring alert email settings. See “system alertemail” on page 321 for more
information.

Note: The FortiGate unit must be able to look up the SMTP server name on your DNS server because the
FortiGate unit uses the SMTP server to connect to the mail server. See “system dns” on page 339 for more
information.

Syntax
config alertemail setting
set username <user-name-str>
set mailto1 <email-address-str>
set mailto2 <email-address-str>
set mailto3 <email-address-str>
set filter-mode <category> <threshold>
set email-interval <minutes-integer>
set severity {alert | critical | debug | emergency | error |
information | notification | warning}
set emergency-interval <minutes-integer>
set alert-interval <minutes-integer>
set critical-interval <minutes-integer>
set error-interval <minutes-integer>
set warning-interval <minutes-integer>
set notification-interval <minutes-integer>
set information-interval <minutes-integer>
set debug-interval <minutes-integer>
set IPS-logs {disable | enable}
set firewall-authentication-failure-logs {disable | enable}
set HA-logs {enable | disable}
set IPsec-error-logs {disable | enable}
set FDS-update-logs {disable | enable}
set PPP-errors-logs {disable | enable}
set sslvpn-authentication-errors-logs {disable | enable}
set antivirus-logs {disable | enable}
set webfilter-logs {disable | enable}
set configuration-changes-logs {disable | enable}
set violation-traffic-logs {disable | enable}
set admin-login-logs {disable | enable}
set local-disk-usage-warning {disable | enable}
set FDS-license-expiring-warning {disable | enable}
set FDS-license-expiring-days <integer>
set local-disk-usage <percentage>
set fortiguard-log-quota-warning
end

FortiGate CLI Version 3.0 MR6 Reference

64 01-30006-0015-20080205
alertemail setting

Keywords and variables Description Default

username Enter a valid email address in the format [email protected]. No default.
<user-name-str> This address appears in the From header of the alert email.
mailto1 Enter an email address. This is one of the email addresses where No default.
<email-address-str> the FortiGate unit sends an alert email.
mailto2 Enter an email address. This is one of the email addresses where No default.
<email-address-str> the FortiGate unit sends an alert email.
mailto3 Enter an email address. This is one of the email addresses where No default.
<email-address-str> the FortiGate unit sends an alert email.
filter-mode Enter to set the filter mode of the alert email.The following only category
<category> displays when threshold is entered:
<threshold> • emergency-interval
• alert-interval
• critical-interval
• error-interval
• warning-interval
• notification-interval
• information-interval
• debug-interval
email-interval Enter the number of minutes the FortiGate unit should wait before 5
<minutes-integer> sending out an alert email. This is not available when filter-
mode threshold is enabled.
emergency-interval Enter the number of minutes the FortiGate unit should wait before 1
<minutes-integer> sending out alert email for emergency level messages. Only
available when filter-mode threshold is entered.
alert-interval Enter the number of minutes the FortiGate unit should wait before 2
<minutes-integer> sending out an alert email for alert level messages. Only available
when filter-mode threshold is entered.
critical-interval Enter the number of minutes the FortiGate unit should wait before 3
<minutes-integer> sending out an alert email for critical level messages. Only
available when filter-mode threshold is entered.
error-interval Enter the number of minutes the FortiGate unit should wait before 5
<minutes-integer> sending out an alert email for error level messages. Only available
when filter-mode threshold is entered.
warning-interval Enter the number of minutes the FortiGate unit should wait before 10
<minutes-integer> sending out an alert email for warning level messages. Only
available when filter-mode threshold is entered.
notification-interval Enter the number of minutes the FortiGate unit should wait before 20
<minutes-integer> sending out an alert email for notification level messages. Only
available when filter-mode threshold is entered.
information-interval Enter the number of minutes the FortiGate unit should wait before 30
<minutes-integer> sending out an alert email for information level messages. Only
available when filter-mode threshold is entered.
debug-interval Enter the number of minutes the FortiGate unit should wait before 60
<minutes-integer> sending out an alert email for debug level messages. Only
available when filter-mode threshold is entered.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 65
setting alertemail

Keywords and variables Description Default

severity Select the logging severity level. This is only available when alert
{alert | critical | filter-mode threshold is entered. The FortiGate unit logs all
debug | emergency | messages at and above the logging severity level you select. For
example, if you error, the unit logs error, critical, alert,
error | information | and emergency level messages.
notification | warning} alert – Immediate action is required.
critical – Functionality is affected.
debug – Information used for diagnosing or debugging the
FortiGate unit.
emergency – The system is unusable.
error – An erroneous condition exists and functionality is
probably affected.
information – General information about system operations
notification – Information about normal events.
warning – Functionality might be affected.
IPS-logs Enable or disable IPS logs. disable
{disable | enable}
firewall- Enable or disable firewall authentication failure logs. disable
authentication-failure-
logs
{disable | enable}
HA-logs Enable or disable high availability (HA) logs. disable
{enable | disable}
IPsec-error-logs Enable or disable IPSec error logs disable
{disable | enable}
FDS-update-logs Enable or disable FDS update logs. disable
{disable | enable}
PPP-errors-logs Enable or disable PPP error logs. disable
{disable | enable}
sslvpn-authentication- Enable or disable SSL VPN authentication error logs. disable
errors-logs
{disable | enable}
antivirus-logs Enable or disable antivirus logs. disable
{disable | enable}
webfilter-logs Enable or disable web filter logs. disable
{disable | enable}
configuration-changes- Enable or disable configuration changes logs. disable
logs
{disable | enable}
violation-traffic-logs Enable or disable traffic violation logs. disable
{disable | enable}
admin-login-logs Enable or disable admin login logs disable
{disable | enable}
local-disk-usage- Enable or disable local disk usage warning in percent. For disable
warning example enter the number 15 for a warning when the local disk
{disable | enable} usage is at 15 percent. The number cannot be 0 or 100.

FDS-license-expiring- Enable or disable to receive an email notification of the expire date disable
warning of the FDS license.
{disable | enable}
FDS-license-expiring- Enter the number of days to be notified by email when the FDS 15
days license expires. For example, if you want notification five days in
<integer> advance, enter 5.

FortiGate CLI Version 3.0 MR6 Reference

66 01-30006-0015-20080205
alertemail setting

Keywords and variables Description Default

local-disk-usage Enter a number for when the local disk’s usage exceeds that 75
<percentage> number.
fortiguard-log-quota- Enter to receive an alert email when the FortiGuard Log & disable
warning Analysis server reaches its quota.

Examples
This example shows how to configure the user name, add three email addresses for sending alerts to,
and what type of emails will contain which log messages, such as HA and antivirus.
config alertemail setting
set username [email protected]
set mail1 [email protected]
set mail2 [email protected]
set mail3 [email protected]
set filter-mode category
set HA-logs enable
set FDS-update-logs enable
set antivirus-logs enable
set webfilter-logs enable
set admin-login-logs enable
set violation-traffic-logs enable
end

History

FortiOS v2.80 Substantially revised and expanded.

FortiOS v3.0 Moved authentication, server and password to config
system alertemail.
FortiOS v3.0MR2 New keywords added for:
• IPS-logs
• firewall-authentication-failure-logs
• HA-logs
• IPSec-errors-logs
• FDS-update-logs
• PPP-errors-logs
• sslvpn-authentication-errors-logs
• antivirus-logs
• webfilter-logs
• configuration-changes-logs
• violation-traffic-logs
• admin-login-logs
• FDS-license-expiring-warning
• local-disk-usage-warning
• FDS-license-expiring-days
• local-disk-usage
FortiOS 3.0MR4 Added fortiguard-log-quota-warning keyword.

Related topics
• system alertemail
• system dns

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 67
setting alertemail

FortiGate CLI Version 3.0 MR6 Reference

68 01-30006-0015-20080205
antivirus

antivirus
Use antivirus commands to configure antivirus scanning for services, quarantine options, and to
enable or disable grayware and heuristic scanning.
This chapter contains the following sections:

filepattern
grayware
heuristic
quarantine
quarfilepattern
service

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 69
filepattern antivirus

filepattern
Use this command to add, edit or delete the file patterns used for virus blocking and to set which
protocols to check for files to block.
If you need to add configuration via CLI that requires ? as part of config, you need to input CTRL-V
first. If you enter the question mark (?) without first using CTRL-V, the question mark has a different
meaning in CLI: it will show available command options in that section.
For example, if you enter ? without CTRL-V:
edit "*.xe
token line: Unmatched double quote.
If you enter ? with CTRL-V:
edit "*.xe?"
new entry '*.xe?' added

Syntax
config antivirus filepattern
edit <filepattern_list_integer>
set name <filepattern_list>
set comment <filepattern_list_comment>
config entries
edit <filepattern_string>
set action <allow | block | intercept>
set active {ftp http im imap mm1 mm3 mm4 mm7 nntp pop3 smtp}
set file-type {unknown | ignored | activemime | arj | aspack |
base64 | bat | binhex | bzip | bzip2 | cab | com | elf | exe |
fsg | genscript | gzip | hlp | hta | html | javascript | lzh |
mime | msc | msoffice | perlscript | petite | rar | shellscript
| sis | tar | upx | uue | vbs | zip} (FortiOS Carrier)
set filter-type {pattern | type} (FortiOS Carrier)
end
Keywords and variables Description Default
<filepattern_list_integer> A unique number to identify the file pattern list.
<filepattern_list> The name of the file pattern header list.
<filepattern_list_comment> The comment attached to the file pattern header list.
<filepattern_string> The name of the file pattern being configured. This can be any
character string.
action <allow | block | The action taken when a matching file is being transferred via a block
intercept> set active protocol.
• Select allow to have the FortiGate unit allow matching files.
• Select block to have the FortiGate unit block matching files.
• Select intercept to allow matching files, with a copy sent to
a quarantine. Note that the store-intercepted command
in config antivirus quarantine must also be
configured to quarantine intercepted files.
The intercept action is supported in FortiOS Carrier.
active The action specified will affect the file pattern in the selected Varies.
{ftp http im imap mm1 mm3 protocols.
mm4 mm7 nntp pop3 smtp} NNTP support for this keyword will be added in the future.
MM1, MM3, MM4, and MM7 traffic types supported in FortiOS
Carrier.

FortiGate CLI Version 3.0 MR6 Reference

70 01-30006-0015-20080205
antivirus filepattern

Keywords and variables Description Default

file-type This command is only available and valid when filter-type unknown
{unknown | ignored | is set to type.
activemime | arj | aspack Select the type of file the file filter will search for. Note that
unlike the file pattern filter, this file type filter will examine the file
| base64 | bat | binhex | contents to determine the what type of file it is. The file name
bzip | bzip2 | cab | com | and file extension is ignored.
elf | exe | fsg | genscript Because of the way the file type filter works, renaming files to
| gzip | hlp | hta | html | make them appear to be of a different type will not allow them
javascript | lzh | mime | past the FortiGate unit without detection.
msc | msoffice | Two of the available options are not file types:
perlscript | petite | rar • Select unknown to configure a rule affecting every file format
the file type filter unit does not recognize. Unknown includes
| shellscript | sis | tar | every file format not available in the file-type command.
upx | uue | vbs | zip} • Select ignored to configure a rule affecting traffic the
(FortiOS Carrier) FortiGate unit typically does not scan. This includes primarily
streaming audio and video.
filter-type {pattern | Select the file filter detection method. pattern
type} • Enter pattern to examine files only by their names. For
(FortiOS Carrier) example, if filter-type is set to pattern, and the pattern
is *.zip, all files ending in .zip will trigger this file filter. Even
files ending in .zip that are not actually ZIP archives will trigger
this filter.
• Enter type to examine files only by their contents. Using the
above example, if filter-type is set to type, and the type
is zip, all ZIP archives will trigger this file filter. Even files
renamed with non-zip file extensions will trigger this filter.

History

FortiOS v2.80 Substantially revised.

FortiOS v3.0 Added IM. Added multiple-list capability for models 800 and above.

Related topics
• antivirus heuristic
• antivirus grayware
• antivirus quarantine
• antivirus quarfilepattern
• antivirus service

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 71
grayware antivirus

grayware
Use this command to enable or disable grayware scanning for the specified category.
Grayware programs are unsolicited commercial software programs that get installed on computers,
often without the user’s consent or knowledge. Grayware programs are generally considered an
annoyance, but these programs can cause system performance problems or be used for malicious
purposes.
The FortiGate unit scans for known grayware executable programs in each category enabled. The
category list and contents are added or updated whenever the FortiGate unit receives a virus update
package. New categories may be added at any time and are loaded with virus updates. By default, all
new categories are disabled.

Adware Adware is usually embedded in freeware programs and causes ads to

pop up whenever the program is opened or used.
BHO BHOs (Browser Helper Objects) are DLL files that are often installed
as part of a software package so the software can control the behavior
of Internet Explorer 4.x and higher. Not all BHOs are malicious, but the
potential exists to track surfing habits and gather other information.
Dial Dialers allow others to use the PC modem to call premium numbers or
make long distance calls.
Download Download components are usually run at Windows startup and are
designed to install or download other software, especially advertising
and dial software.
Game Games are usually joke or nuisance games that may be blocked from
network users.
HackerTool
Hijacker Browser hijacking occurs when a ‘spyware’ type program changes
web browser settings, including favorites or bookmarks, start pages,
and menu options.
Joke Joke programs can include custom cursors and programs that appear
to affect the system.
Keylog Keylogger programs can record every keystroke made on a keyboard
including passwords, chat, and instant messages.
Misc The miscellaneous grayware category.
NMT Network management tools can be installed and used maliciously to
change settings and disrupt network security.
P2P P2P, while a legitimate protocol, is synonymous with file sharing
programs that are used to swap music, movies, and other files, often
illegally.
Plugin Browser plugins can often be harmless Internet browsing tools that are
installed and operate directly from the browser window. Some toolbars
and plugins can attempt to control or record and send browsing
preferences.
RAT Remote administration tools allow outside users to remotely change
and monitor a computer on a network.
Spy Spyware, like adware, is often included with freeware. Spyware is a
tracking and analysis program that can report users’ activities, such as
web browsing habits, to the advertiser’s web site where it may be
recorded and analyzed.
Toolbar While some toolbars are harmless, spyware developers can use these
toolbars to monitor web habits and send information back to the
developer.

Grayware scanning is enabled in a protection profile when Virus Scan is enabled.

FortiGate CLI Version 3.0 MR6 Reference

72 01-30006-0015-20080205
antivirus grayware

Syntax
config antivirus grayware <category_name_str>
set status {enable | disable}
end

Note: The FortiGate CLI is case sensitive and the first letter of all grayware category names is uppercase.

Keywords and variables Description Default

<category_name_str> The grayware category being configured.
status {enable | disable} Enable or disable grayware scanning for the specified category. disable

Example
This example shows how to enable grayware scanning for Adware programs.
config antivirus grayware Adware
set status enable
end

History

FortiOS v2.80 New.

Related topics
• antivirus filepattern
• antivirus heuristic
• antivirus quarantine
• antivirus quarfilepattern
• antivirus service
• system autoupdate schedule
• execute update-av

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 73
heuristic antivirus

heuristic
Use this command to configure heuristic scanning for viruses in binary files.

Syntax
config antivirus heuristic
set mode {pass | block | disable}
end
Keywords and variables Description Default
mode Enter pass to enable heuristics but pass detected files to the pass
{pass | block | disable} recipient. Suspicious files are quarantined if quarantine is
enabled.
Enter block to enable heuristics and block detected files. A
replacement message is forwarded to the recipient. Blocked files
are quarantined if quarantine is enabled.
Enter disable to disable heuristics.

Example
This example shows how to disable heuristic scanning.
config antivirus heuristic
set mode disable
end

History

FortiOS v2.80 New.

Related topics
• antivirus filepattern
• antivirus quarantine
• antivirus quarfilepattern
• antivirus service

FortiGate CLI Version 3.0 MR6 Reference

74 01-30006-0015-20080205
antivirus quarantine

quarantine
Use this command to set file quarantine options.
FortiGate units with a local disk can quarantine blocked and infected files. The quarantined files are
removed from the content stream and stored on the FortiGate local disk. Users receive a message
informing them that the removed files have been quarantined.
FortiGate units that do not have a local disk can quarantine blocked and infected files to a
FortiAnalyzer unit.
View the file names and status information about the file in the quarantined file list. Submit specific files
and add file patterns to the autoupload list so they are automatically uploaded to Fortinet for analysis.

Syntax
config antivirus quarantine
set agelimit <hours_integer>
set drop-blocked {ftp http im imap mm1 mm3 mm4 mm7 nntp pop3 smtp}
set drop-heuristic {ftp http im imap mm1 mm3 mm4 mm7 nntp pop3 smtp}
set drop-infected {ftp http im imap mm1 mm3 mm4 mm7 nntp pop3 smtp}
set drop-intercepted {ftp http imap mm1 mm3 mm4 mm7 pop3 smtp} (FortiOS
Carrier)
set lowspace {drop-new | ovrw-old}
set maxfilesize <MB_integer>
set quar-to-fortianalyzer {enable | disable}
set store-blocked {ftp http im imap mm1 mm3 mm4 mm7 nntp pop3 smtp}
set store-heuristic {ftp http im imap mm1 mm3 mm4 mm7 nntp pop3 smtp}
set store-infected {ftp http im imap mm1 mm3 mm4 mm7 nntp pop3 smtp}
set store-intercepted {ftp http imap mm1 mm3 mm4 mm7 pop3 smtp}
(FortiOS Carrier)
end
Keywords and variables Description Default
agelimit <hours_integer> Specify how long files are kept in quarantine to a maximum of 479 0
hours. The age limit is used to formulate the value in the TTL
column of the quarantined files list. When the limit is reached the
TTL column displays EXP and the file is deleted (although a
record is maintained in the quarantined files list). Entering an age
limit of 0 (zero) means files are stored on disk indefinitely
depending on low disk space action.
drop-blocked Do not quarantine blocked files found in traffic for the specified imap
{ftp http im imap mm1 mm3 protocols. The files are deleted. nntp
mm4 mm7 nntp pop3 smtp} NNTP support for this keyword will be added in the future.
HTTP, FTP, MM1, MM3, MM4, and MM7 traffic types supported in
FortiOS Carrier.
drop-heuristic Do not quarantine files found by heuristic scanning in traffic for the http
{ftp http im imap mm1 mm3 specified protocols. im
mm4 mm7 nntp pop3 smtp} NNTP support for this keyword will be added in the future. imap
MM1, MM3, MM4, and MM7 traffic types supported in FortiOS nntp
Carrier. pop3
smtp
drop-infected Do not quarantine virus infected files found in traffic for the im
{ftp http im imap mm1 mm3 specified protocols. imap
mm4 mm7 nntp pop3 smtp} NNTP support for this keyword will be added in the future. nntp
MM1, MM3, MM4, and MM7 traffic types supported in FortiOS
Carrier.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 75
quarantine antivirus

Keywords and variables Description Default

drop-intercepted Do not quarantine intercepted files found in traffic for the specified imap
{ftp http imap mm1 mm3 protocols. The files are deleted. smtp
mm4 mm7 pop3 smtp} pop3
http
(FortiOS Carrier) ftp mm1
mm3 mm4
mm7
lowspace Select the method for handling additional files when the FortiGate ovrw-old
{drop-new | ovrw-old} hard disk is running out of space.
Enter ovwr-old to drop the oldest file (lowest TTL), or
drop-new to drop new quarantine files.
maxfilesize <MB_integer> Specify, in MB, the maximum file size to quarantine. 0
The FortiGate unit keeps any existing quarantined files over the
limit. The FortiGate unit does not quarantine any new files larger
than this value. The file size range is 0-499 MB. Enter 0 for
unlimited file size.
quar-to-fortianalyzer For FortiGate units that do not have a local disc, send infected disable
{enable | disable} files to a FortiAnalyzer unit.
store-blocked Quarantine blocked files found in traffic for the specified protocols. No
{ftp http im imap mm1 mm3 NNTP support for this keyword will be added in the future. default.
mm4 mm7 nntp pop3 smtp} HTTP, FTP, MM1, MM3, MM4, and MM7 traffic types supported in
FortiOS Carrier.
store-heuristic Quarantine files found by heuristic scanning in traffic for the No
{ftp http im imap mm1 mm3 specified protocols. default.
mm4 mm7 nntp pop3 smtp} NNTP support for this keyword will be added in the future.
MM1, MM3, MM4, and MM7 traffic types supported in FortiOS
Carrier.
store-infected Quarantine virus infected files found in traffic for the specified No
{ftp http im imap mm1 mm3 protocols. default.
mm4 mm7 nntp pop3 smtp} NNTP support for this keyword will be added in the future.
MM1, MM3, MM4, and MM7 traffic types supported in FortiOS
Carrier.
store-intercepted Quarantine intercepted files found in traffic for the specified imap
{ftp http imap mm1 mm3 protocols. smtp
mm4 mm7 pop3 smtp} pop3
http
(FortiOS Carrier) ftp mm1
mm3 mm4
mm7

Example
This example shows how to set the quarantine age limit to 100 hours, not quarantine blocked files
from SMTP and POP3 traffic, not quarantine heuristic tagged files from SMTP and POP3 traffic,
set the quarantine to drop new files if the memory is full, set the maximum file size to quarantine
at 2 MB, quarantine files from IMAP traffic with blocked status, quarantine files with heuristic
status in IMAP, HTTP, and FTP traffic.config antivirus quarantine
set agelimit 100
set drop-blocked smtp pop3
set drop-heuristic smtp pop3
set lowspace drop-new
set maxfilesize 2
set store-blocked imap
set store-heuristic imap http ftp
end

FortiGate CLI Version 3.0 MR6 Reference

76 01-30006-0015-20080205
antivirus quarantine

History

FortiOS v2.80 Substantially revised.

FortiOS v2.80 MR2 The enable_auto_upload keyword was changed to
enable-auto-submit.
FortiOS v3.0 Added IM and NNTP options.
FortiOS v3.0 MR5 Removed set enable-auto-submit, set sel-status, set
use-fpat, set use-status.

Related topics
• antivirus filepattern
• antivirus heuristic
• antivirus quarfilepattern
• antivirus service

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 77
quarfilepattern antivirus

quarfilepattern
Use this command to configure the file patterns used by automatic file uploading. This command is
only available on FortiGate units with a hard drive.
Configure the FortiGate unit to upload suspicious files automatically to Fortinet for analysis. Add file
patterns to be uploaded to the autoupload list using the * wildcard character. File patterns are applied
for autoupload regardless of file blocking settings.
Also upload files to Fortinet based on status (blocked or heuristics) or submit individual files directly
from the quarantined files list. For more information, see antivirus quarantine.

Syntax
config antivirus quarfilepattern
edit pattern_str
set status {enable | disable}
end

Keywords and variables Description Default

pattern_str The file pattern to be quarantined.
status {enable | disable} Enable or disable using a file pattern. disable

Example
Use the following commands to enable automatic upload of *.bat files.
config antivirus quarfilepattern
edit *.bat
set status enable
end

History

FortiOS v2.80 New.

FortiOS v3.0 Entire command removed.
MR5

Related topics
• antivirus filepattern
• antivirus heuristic
• antivirus quarantine
• antivirus service

FortiGate CLI Version 3.0 MR6 Reference

78 01-30006-0015-20080205
antivirus service

service
Use this command to configure how the FortiGate unit handles antivirus scanning of large files in
HTTP, HTTPS, FTP, POP3, IMAP, and SMTP traffic and what ports the FortiGate unit scans for these
services.
For HTTPS, you can only configure the ports.

Syntax
config antivirus service <service_str>
set port <port_integer>
set scan-bzip2 {enable | disable}
set uncompnestlimit <depth_integer>
set uncompsizelimit <MB_integer>
end
Keywords and variables Description Default
<service_str> The service being configured: HTTP, HTTPS, FTP, IM, IMAP,
NNTP, POP3, SMTP.
port <port_integer> Configure antivirus scanning on a nonstandard port number or HTTP: 80
multiple port numbers for the service. Use ports from the HTTPS: 443
range 1-65535. Add up to 20 ports. FTP: 21
IMAP: 143
NNTP: 119
POP3: 110
SMTP: 25
scan-bzip2 {enable | Enable to allow the antivirus engine to scan the contents of disable
disable} bzip2 compressed files. Requires antivirus engine 1.90 for full
functionality. Bzip2 scanning is extemely CPU intensive.
Unless this feature is required, leave scan-bzip2 disabled.
uncompnestlimit Set the maximum number of archives in depth the AV engine 12
<depth_integer> will scan with nested archives. The limit is from 2 to 100. The
supported compression formats are arj, bzip2, cab, gzip, lha,
lzh, msc, rar, tar, and zip. Bzip2 support is disabled by default.
uncompsizelimit Set the maximum uncompressed file size that can be buffered 10 (MB)
<MB_integer> to memory for virus scanning. Enter a value in megabytes
between 1 and the maximum oversize threshold. Enter “?” to
display the range for your FortiGate unit. Enter 0 for no limit
(not recommended).

Note: If the file in uncompnestlimit has more levels than the limit you set, or if the file in
uncompsizelimit is larger than the limit you set, the file will pass through without being virus scanned.

How file size limits work

The uncompsizelimit applies to the uncompressed size of the file. If other files are included within the
file, the uncompressed size of each one is checked against the uncompsizelimit value. If any one of
the uncompressed files is larger than the limit, the file is passed without scanning, but the total size of
all uncompressed files within the original file can be greater than the uncompsizelimit.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 79
service antivirus

Example
This example shows how to set the maximum uncompressed file size that can be buffered to memory
for scanning at 15 MB, and how to enable antivirus scanning on ports 70, 80, and 443 for HTTP traffic.
config antivirus service http
set uncompsizelimit 15
set port 70
set port 80
set port 443
end

History

FortiOS v2.80 Substantially revised.

FortiOS v2.80 MR6 Removed diskfilesizelimit keyword.
FortiOS v2.80 MR7 Added uncompsizelimit keyword.
FortiOS v3.0 Combined all services into one section. Added IM. Added
scan_bzip2. Removed client comforting and file size limit
commands.
FortiOS v3.0 MR3 Added support for HTTPS. But only ports can be configured.

Related topics
• antivirus filepattern
• antivirus heuristic
• antivirus quarantine
• antivirus quarfilepattern

FortiGate CLI Version 3.0 MR6 Reference

80 01-30006-0015-20080205
firewall

firewall
Use firewall commands to configure firewall policies and the data they use, including protection
profiles, IP addresses and virtual IP addresses, schedules, and services. You can also configure DNS
translation, IP/MAC binding, and multicast policies.
This chapter contains the following sections:

address, address6
addrgrp, addrgrp6
dnstranslation
gtp (FortiOS Carrier)
ipmacbinding setting
ipmacbinding table
ippool
ldb-monitor
multicast-policy
policy, policy6
profile
schedule onetime
schedule recurring
service custom
service group
vip
vipgrp

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 81
address, address6 firewall

address, address6
Use this command to configure firewall addresses used in firewall policies. An IPv4 firewall address is
a set of one or more IP addresses, represented as a domain name, an IP address and a subnet mask,
or an IP address range. An IPv6 firewall address is an IPv6 6-to-4 address prefix.
By default, FortiGate units have the firewall address All, which represents any IP address.
Addresses, address groups, and virtual IPs must have unique names to avoid confusion in firewall
policies. If an address is selected in a policy, it cannot be deleted until it is deselected from the policy.

Syntax
config firewall address
edit <name_str>
set associated-interface <interface_str>
set end-ip <address_ipv4>
set fqdn <domainname_str>
set start-ip <address_ipv4>
set subnet <address_ipv4mask>
set type {ipmask | iprange | fqdn}
end
config firewall address6
edit <name_str>
set ip6 <address_ipv6prefix>
end
Keywords and variables Description Default
The following commands are for config firewall address.
<name_str> Enter the name of the address. No default.
associated-interface Enter the name of the associated interface. No default.
<interface_str> If not configured, the firewall address is bound to an interface
during firewall policy configuration.
end-ip <address_ipv4> If type is iprange, enter the last IP address in the range. 0.0.0.0
fqdn <domainname_str> If type is fqdn, enter the fully qualified domain name (FQDN). No default.
start-ip <address_ipv4> If type is iprange, enter the first IP address in the range. 0.0.0.0
subnet <address_ipv4mask> If type is ipmask, enter an IP address then its subnet mask, in 0.0.0.0
dotted decimal format and separated by a space, or in CIDR 0.0.0.0
format with no separation. For example, you could enter either:
• 172.168.2.5/32
• 172.168.2.5 255.255.255.255
The IP address can be for a single computer or a subnetwork.
The subnet mask corresponds to the class of the IP address
being added.
• A single computer’s subnet mask is 255.255.255.255 or
/32.
• A class A subnet mask is 255.0.0.0 or /8.
• A class B subnet mask is 255.255.0.0 or /26.
• A class C subnet mask is 255.255.255.0 or /24.
type {ipmask | iprange | Select whether this firewall address is a subnet address, an ipmask
fqdn} address range, or fully qualified domain name.
The following command is for config firewall address6.
<name_str> Enter the name of the IPv6 address prefix. No default.
ip6 <address_ipv6prefix> If the IP address is IPv6, enter an IPv6 IP address prefix. ::/0

FortiGate CLI Version 3.0 MR6 Reference

82 01-30006-0015-20080205
firewall address, address6

Example
This example shows how to add one IPv4 address of each type: ipmask, iprange, and fqdn. It also
shows how to configure an IPv6 address prefix.
config firewall address
edit Example_Subnet
set type ipmask
set subnet 192.168.1.0 255.255.255.0
next
edit Example_Range
set type iprange
set start-ip 10.10.1.10
set end-ip 10.10.1.30
next
edit Example_Domain
set type fqdn
set fqdn www.example.com
end
config firewall address6
edit Example_ipv6_Prefix
set ip6 2002:CF8E:83CA::/48
end

History

FortiOS v2.80 Substantially revised. IP address range option added. Requiring that an address be added
to an interface removed.
FortiOS v3.0 Added fqdn.
FortiOS v3.0 MR4 Added option associated-interface.

Related topics
• firewall addrgrp, addrgrp6
• firewall policy, policy6

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 83
addrgrp, addrgrp6 firewall

addrgrp, addrgrp6
Use this command to configure firewall address groups used in firewall policies.
You can organize related firewall addresses into firewall address groups to simplify firewall policy
configuration. For example, rather than creating three separate firewall policies for three firewall
addresses, you could create a firewall address group consisting of the three firewall addresses, then
create one firewall policy using that firewall address group.
Addresses, address groups, and virtual IPs must all have unique names to avoid confusion in firewall
policies. If an address group is selected in a policy, it cannot be deleted unless it is first deselected in
the policy.

Syntax
config firewall addrgrp, addrgrp6
edit <name_str>
set member <name_str>
end

Keywords and variables Description Default

<name_str> Enter the name of the address group. No default.
member <name_str> Enter one or more names of firewall addresses to add to the No default.
address group. Separate multiple names with a space. To
remove an address name from the group, retype the entire new
list, omitting the address name.

Example
This example shows how to add two firewall addresses to a firewall address group.
config firewall addrgrp
edit Group1
set Example_Subnet Example_Range
end

History

FortiOS v2.80 Revised.

Related topics
• firewall address, address6
• firewall policy, policy6

FortiGate CLI Version 3.0 MR6 Reference

84 01-30006-0015-20080205
firewall dnstranslation

dnstranslation
Use this command to add, edit or delete a DNS translation entry.
If DNS translation is configured, the FortiGate unit rewrites the payload of outbound DNS query replies
from internal DNS servers, replacing the resolved names’ internal network IP addresses with external
network IP address equivalents, such as a virtual IP address on a FortiGate unit’s external network
interface. This allows external network hosts to use an internal network DNS server for domain name
resolution of hosts located on the internal network.
For example, if a virtual IP provided network address translation (NAT) between a public network, such
as the Internet, and a private network containing a web server, hosts on the public network could
access the web server by using its virtual IP address. However, if hosts attempted to access the web
server by domain name, and the DNS server performing name resolution for that domain name was
also located on the private network, the DNS query reply would contain a private network IP address,
which is not routable from the external network. To solve this, you might configure DNS translation,
and substitute the web server’s private network IP address with the virtual IP address in DNS query
replies to the public network.
DNS translation mappings between src and dst must be one-to-one; you cannot create one-to-many
or many-to-one mappings. For example, if src is a single IP address, it cannot be DNS translated into
a dst subnet; dst must be a single IP address, like src. If src is a subnet, dst must also be a
subnet.

Syntax
config firewall dnstranslation
edit <index_int>
set dst <destination_ipv4>
set netmask <address_ipv4mask>
set src <source_ipv4>
end

Keywords and variables Description Default

<index_int> Enter the unique ID number of the DNS translation entry. No default.
dst <destination_ipv4> Enter the IP address or subnet on the external network to 0.0.0.0
substitute for the resolved address in DNS query replies.
dst can be either a single IP address or a subnet on the
external network, but must be equal in number to the number
of mapped IP addresses in src.
netmask If src and dst are subnets rather than single IP addresses, 0.0.0.0
<address_ipv4mask> enter the netmask for both src and dst.
src <source_ipv4> Enter the IP address or subnet on the internal network to 0.0.0.0
compare with the resolved address in DNS query replies. If the
resolved address matches, the resolved address is substituted
with dst.

Example
This example shows how to translate the resolved addresses in DNS query replies, from an internal
(source) subnet to an external (destination) subnet.
config firewall dnstranslation
edit 1
set src 192.168.100.12
set dst 172.16.200.190
set netmask 255.255.255.0
end

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 85
dnstranslation firewall

History
FortiOS v2.80 Revised.

Related topics
• firewall vip

FortiGate CLI Version 3.0 MR6 Reference

86 01-30006-0015-20080205
firewall gtp (FortiOS Carrier)

gtp (FortiOS Carrier)

Use this command to configure GTP (GPRS Tunneling Protocol) profiles.

Syntax
config firewall gtp
edit <name_str>
config apn
edit index_int
set action {allow | deny}
set selection-mode {ms net vrf}
set value <networkid_str>
end
config ie-remove-policy
edit <index_int>
set remove-ies {apn-restriction rat-type rai uli imei}
set sgsn-addr <addr/group_str>
end
config imsi
edit <index_int>
set action {allow | deny}
set apn <networkid_str>
set mcc-mnc <mccmnc_str>
set selection-mode {ms net vrf}
end
config ip-policy
edit <index_int>
set action {allow | deny}
set dstaddr <address_str>
set srcaddr <address_str>
end
config noip-policy
edit <index_int>
set action {allow | deny}
set start <protocol_int>
set end <protocol_int>
set type {etsi | ietf}
end
config policy
edit <index_int>
set action {allow | deny}
set apn <apn_str>
set imei <imei_str>
set imsi <imsi_str>
set max-apn-restriction {all | private-1 | private-2 | public-1 |
public-2}
set messages {create-req create-res update-req update-res}
set rai <rai_str>
set rat-type {any geran utran wlan}
set uli <uli_str>
end
set addr-notify <Gi_ipv4>
set apn-filter {enable | disable}

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 87
gtp (FortiOS Carrier) firewall

set authorized-sgsns <addr/grp_str>

set context-id <id_int>
set control-plane-message-rate-limit <limit_int>
set create-aa-pdp {allow | deny}
set create-pdp {allow | deny}
set data-record {allow | deny}
set default-apn-action {allow | deny}
set default-imsi-action {allow | deny}
set default-ip-action {allow | deny}
set default-noip-action {allow | deny}
set default-policy-action {allow | deny}
set delete-aa-pdp {allow | deny}
set delete-pdp {allow | deny}
set denied-log {enable | disable}
set echo {allow | deny}
set error-indication {allow | deny}
set extension-log {enable | disable}
set failure-report {allow | deny}
set forwarded-log {enable | disable}
set fwd-relocation {allow | deny}
set fwd-srns-context {allow | deny}
set gtp-in-gtp {allow | deny}
set gtp-pdu {allow | deny}
set handover-group
set identification {allow | deny}
set ie-remover {enable | disable}
set imsi-filter {enable | disable}
set interface-notify <interface_str>
set invalid-reserved-field {allow | deny}
set ip-filter {enable | disable}
set log-freq <drop_int>
set max-message-length <bytes_int>
set min-message-length <bytes_int>
set miss-must-ie {allow | deny}
set node-alive {allow | deny}
set noip-filter {enable | disable}
set note-ms-present {allow | deny}
set out-of-state-ie {allow | deny}
set out-of-state-message {allow | deny}
set pdu-notification {allow | deny}
set policy-filter {enable | disable}
set port-notify <port_int>
set ran-info {allow | deny}
set rate-limited-log {enable | disable}
set redirection {allow | deny}
set relocation-cancel {allow | deny}
set reserved-ie {allow | deny}
set send-route {allow | deny}
set seq-number-validate {enable | disable}
set sgsn-context {allow | deny}
set spoof-src-addr {allow | deny}

FortiGate CLI Version 3.0 MR6 Reference

88 01-30006-0015-20080205
firewall gtp (FortiOS Carrier)

set state-invalid-log {enable | disable}

set support-extension {allow | deny}
set traffic-count-log {enable | disable}
set tunnel-limit <limit_int>
set tunnel-limit-log {enable | disable}
set tunnel-timeout <time_int>
set unknown-message-action {allow | deny}
set update-pdp {allow | deny}
set version-not-support {allow | deny}
end

Keywords and variables Description Default

<name_str> Enter the name of this GTP profile. No default.
apn
The following commands are the options for config apn.
index_int Enter the unique ID number of the APN filter profile. No default.
action {allow | deny} Select to allow or deny traffic matching both the APN and allow
Selection Mode specified for this APN filter profile.
selection-mode {ms net Select the selection mode or modes required for the APN. ms net vrf
vrf} The selection mode indicates where the APN originated
and whether the Home Location Register (HLR) has
verified the user subscription.
• Enter ms to specify a mobile station provided APN,
subscription not verified. This Selection Mode indicates
that the mobile station (MS) provided the APN and that
the HLR did not verify the user's subscription to the
network.
• Enter net to specify a network-provided APN,
subscription not verified. This Selection Mode indicates
that the network provided a default APN because the
MS did not specify one, and that the HLR did not verify
the user's subscription to the network.
• Enter vrf to specify a mobile station or network-
provided APN, subscription verified. This Selection
Mode indicates that the MS or the network provided the
APN and that the HLR verified the user's subscription to
the network.
value <networkid_str> Enter the network ID and operator ID of the APN. No default.
ie-remove-policy
The following commands are the set options for config ie-remove-policy.
<index_int> Enter the unique ID number of the IE removal policy. No default.
remove-ies Select the information elements to be removed from apn-
{apn-restriction rat-type messages prior to being forwarding to the HGGSN. Any restriction
rai uli imei} combination of R6 information elements (RAT, RAI, ULI, rat-type
IMEI-SV and APN restrictions) may be specified. rai uli imei
sgsn-addr Enter an SGSN address or group the IE removal policy all
<addr/group_str> will be applied to.
imsi
The following commands are the options for config imsi.
<index_int> Enter the unique ID number of the IMSI filtering policy. No default.
action {allow | deny} Select to allow or deny traffic matching both the APN and allow
Selection Mode specified for this APN filter profile
apn <networkid_str> Enter the network ID and operator ID of the APN. No default.
mcc-mnc <mccmnc_str> Enter the MCC and MNC. No default.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 89
gtp (FortiOS Carrier) firewall

Keywords and variables Description Default

selection-mode {ms net Select the selection mode or modes. The selection mode ms net vrf
vrf} indicates where the APN originated and whether the
Home Location Register (HLR) has verified the user
subscription.
• Enter ms to specify a mobile station provided APN,
subscription not verified. This Selection Mode indicates
that the mobile station (MS) provided the APN and that
the HLR did not verify the user's subscription to the
network.
• Enter net to specify a network-provided APN,
subscription not verified. This Selection Mode indicates
that the network provided a default APN because the
MS did not specify one, and that the HLR did not verify
the user's subscription to the network.
• Enter vrf to specify a mobile station or network-
provided APN, subscription verified. This Selection
Mode indicates that the MS or the network provided the
APN and that the HLR verified the user's subscription to
the network.
ip-policy
The following commands are the options for config ip-policy.
<index_int> Enter the unique ID number of the encapsulated IP traffic No default.
filtering policy.
action {allow | deny} Select to allow or deny traffic matching both the source allow
and destination addresses specified for this APN filter
profile
dstaddr <address_str> Enter the name of a destination address or address No default.
group.
srcaddr <address_str> Enter the name of a source address or address group. No default.
noip-policy
The following commands are the options for config noip-policy.
<index_int> Enter the unique ID number of the encapsulated non-IP No default.
traffic filtering policy.
action {allow | deny} Select to allow or deny traffic matching the message allow
protocol specified for this APN filter profile
start <protocol_int> Enter the number of the start protocol. Acceptable rate 0
values range from 0 to 255.
end <protocol_int> Enter the number of the end protocol. Acceptable rate 0
values range from 0 to 255.
type {etsi | ietf} Select an ETSI or IETF protocol type. etsi
policy
The following commands are the options for config policy.
<index_int> Enter the unique ID number of the advanced filtering No default.
policy.
action {allow | deny} Select to allow or deny traffic matching the message allow
attributes specified for this advanced filtering policy
apn <apn_str> Enter the APN suffix, if required. No default.
imei <imei_str> Enter the IMEI (SV) pattern, if required. No default.
imsi <imsi_str> Enter the IMSI prefix, if required. No default.
max-apn-restriction Select the maximum APN restriction. all
{all | private-1 |
private-2 | public-1 |
public-2}

FortiGate CLI Version 3.0 MR6 Reference

90 01-30006-0015-20080205
firewall gtp (FortiOS Carrier)

Keywords and variables Description Default

messages {create-req Enter the type or types of GTP messages. create-req
create-res update-req
update-res}
rai <rai_str> Enter the RAI pattern. No default.
rat-type {any geran utran Enter the RAT type or types. any
wlan}
uli <uli_str> Enter the ULI pattern. No default.
The following commands are the options for edit <profile_str>.
addr-notify <Gi_ipv4> Enter the IP address of the Gi firewall. 0.0.0.0
apn-filter {enable | Select to apply APN filter policies. disable
disable}
authorized-sgsns Enter authorized SSGN addresses or groups. Any SSGN all
<addr/grp_str> groups not specified will not be able to send packets to
the GGSN. All firewall addresses and groups defined on
the FortiGate unit are available for use with this
command.
context-id <id_int> Enter the security context ID. This ID must match the ID 696
entered on the server Gi firewall.
control-plane-message- Enter the control plane message rate limit. Acceptable 0
rate-limit <limit_int> rate values range from 0 (no limiting) to 2147483674
packets per second.
FortiGate units can limit the packet rate to protect the
GSNs from possible Denial of Service (DoS) attacks,
such as Border gateway bandwidth saturation or a GTP
flood.
create-aa-pdp {allow | Select to allow or deny all create AA pop messages. allow
deny}
create-pdp {allow | deny} Select to allow or deny all create pop messages. allow
data-record {allow | Select to allow or deny all data record messages. allow
deny}
default-apn-action {allow Select to allow or deny any APN that is not explicitly allow
| deny} defined with in an APN policy.
default-imsi-action Select to allow or deny any IMSI that is not explicitly allow
{allow | deny} defined in an IMSI policy.
default-ip-action {allow Select to allow or deny any encapsulated IP address allow
| deny} traffic that is not explicitly defined in an IP policy.
default-noip-action Select to allow or deny any encapsulated non-IP protocol allow
{allow | deny} that is not explicitly defined in a non-IP policy.
default-policy-action Select to allow or deny any traffic that is not explicitly allow
{allow | deny} defined in an advanced filtering policy.
delete-aa-pdp {allow | Select to allow or deny all delete AA pop messages. allow
deny}
delete-pdp {allow | deny} Select to allow or deny all delete pop messages. allow
denied-log {enable | Select to log denied GTP packets. disable
disable}
echo {allow | deny} Select to allow or deny all echo messages. allow
error-indication {allow | Select to allow or deny all error indication messages. allow
deny}

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 91
gtp (FortiOS Carrier) firewall

Keywords and variables Description Default

extension-log {enable | Select to log extended information about GTP packets. disable
disable} When enabled, this additional information will be included
in log entries:
• IMSI
• MSISDN
• APN
• Selection Mode
• SGSN address for signaling
• SGSN address for user data
• GGSN address for signaling
• GGSN address for user data
failure-report {allow | Select to allow or deny all failure report messages. allow
deny}
forwarded-log {enable | Select to log forwarded GTP packets. disable
disable}
fwd-relocation {allow | Select to allow or deny all forward relocation messages. allow
deny}
fwd-srns-context {allow | Select to allow or deny all forward SRNS messages. allow
deny}
gtp-in-gtp {allow | deny} Select to allow or deny GTP packets that contains allow
another GTP packet in its message body.
gtp-pdu {allow | deny} Select to allow or deny all G-PDU messages. allow
handover-group Endeavor requests will be honored only from the
addresses listed in the specified address group. This way,
an entrusted GSN cannot high-jack a GTP tunnel with a
endeavor request.
identification {allow | Select to allow or deny all identification messages. allow
deny}
ie-remover {enable | Select whether to use information element removal disable
disable} policies.
imsi-filter {enable | Select whether to use IMSI filter policies. disable
disable}
interface-notify Enter any local interface of the FortiGate unit. The
<interface_str> interface IP address will be used to send the “clear
session” message.
invalid-reserved-field Select to allow or deny GTP packets with invalid reserved deny
{allow | deny} fields. Depending on the GTP version, a varying number
of header fields are reserved and should contain specific
values. If the reserved fields contain incorrect values, the
packet will be blocked if this keyword is set to deny.
ip-filter {enable | Select whether to use encapsulated IP traffic filtering disable
disable} policies.
log-freq <drop_int> Enter the number of messages to drop between logged 0
messages.
An overflow of log messages can sometimes occur when
logging rate-limited GTP packets exceed their defined
threshold. To conserve resources on the syslog server
and the FortiGate unit, you can specify that some log
messages are dropped. For example, if you want only
every twentieth message to be logged, set a logging
frequency of 19. This way, 19 messages are skipped and
the next logged.
Acceptable frequency values range from 0 to
2147483674. When set to ‘0’, no messages are skipped.

FortiGate CLI Version 3.0 MR6 Reference

92 01-30006-0015-20080205
firewall gtp (FortiOS Carrier)

Keywords and variables Description Default

max-message-length Enter the maximum GTP message size, in bytes, that the 1452
<bytes_int> FortiGate unit will allows to pass.
Acceptable values range from 0 to 2147483674 bytes.
When set to ‘0’, the maximum size restriction is disabled.
min-message-length Enter the minimum GTP message size, in bytes, that the 0
<bytes_int> FortiGate unit will allows to pass.
Acceptable values range from 0 to 2147483674 bytes.
When set to ‘0’, the minimum size restriction is disabled.
miss-must-ie {allow | Select to allow or deny passage of GTP packets with deny
deny} missing mandatory information elements to the GGSN.
node-alive {allow | deny} Select to allow or deny all node alive messages. allow
noip-filter {enable | Enable or disable the configured encapsulated non-IP disable
disable} traffic filtering policies.
note-ms-present {allow | Select to allow or deny all note MS GPRS present allow
deny} messages.
out-of-state-ie {allow | Select to allow or deny passage of GTP Packets with out deny
deny} of sequence information elements.
out-of-state-message Select to allow or deny out of state messages. deny
{allow | deny} The GTP protocol requires a certain state to be kept by
both the GGSN and SGSN. Since the GTP has a state,
some message types can only be sent when in specific
states. Packets that do not make sense in the current
state should be filtered or rejected
pdu-notification {allow | Select to allow or deny all pdu notification messages. allow
deny}
policy-filter {enable | Enable or disable the configured advanced filtering disable
disable} policies.
port-notify <port_int> Enter the server firewall’s listening port number. 21123
ran-info {allow | deny} Select to allow or deny all RAN info relay messages. allow
rate-limited-log {enable Enable or disable the logging of rate-limited GTP packets. disable
| disable}
redirection {allow | Select to allow or deny all redirection messages. allow
deny}
relocation-cancel {allow Select to allow or deny all relocation cancel messages. allow
| deny}
reserved-ie {allow | Select to allow or deny GTP messages with reserved or deny
deny} undefined information elements.
send-route {allow | deny} Select to allow or deny all send route messages. allow
seq-number-validate Enable or disable sequence number validation disable
{enable | disable} The GTP packet header contains a sequence number.
The receiving GGSN and the sending GGSN use this
number to ensure the packets are in sequence. The
FortiGate unit can assume this task and save GGSN
resources.
sgsn-context {allow | Select to allow or deny all SGSN context messages. allow
deny}
spoof-src-addr {allow | Select to allow or deny packets containing spoofed MS deny
deny} addresses.
As the MS address is negotiated within the PDP Context
creation handshake, any packets originating from the MS
that contain a different source address will be detected
and dropped if this keyword is set to deny.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 93
gtp (FortiOS Carrier) firewall

Keywords and variables Description Default

state-invalid-log {enable Enable or disable the logging of GTP packets that have disable
| disable} failed stateful inspection.
support-extension {allow Select to allow or deny all support extension messages. allow
| deny}
traffic-count-log {enable Enable or disable logging the total number of control and disable
| disable} user data messages received from and forwarded to the
GGSNs and SGSNs the FortiGate unit protects.
tunnel-limit <limit_int> Enter the maximum number of GTP tunnels according to 0
the GSN capacity.
tunnel-limit-log {enable Enable or disable packets dropped because the disable
| disable} maximum limit of GTP tunnels for the destination GSN is
reached.
tunnel-timeout <time_int> Enter a tunnel timeout value, in seconds. By setting a 86400
timeout value, you can configure the FortiGate unit to
remove hanging tunnels.
Acceptable values range from 0 to 2147483674 seconds.
When set to ‘0’, the timeout is disabled.
unknown-message-action Select to allow or deny all unknown message types. allow
{allow | deny}
update-pdp {allow | deny} Select to allow or deny all update pdp messages. allow
version-not-support Select to allow or deny all version not supported allow
{allow | deny} messages.

History
FortiOS v3.00 Revised.

Related topics
• firewall vip

FortiGate CLI Version 3.0 MR6 Reference

94 01-30006-0015-20080205
firewall ipmacbinding setting

ipmacbinding setting
Use this command to configure IP to MAC address binding settings.
IP/MAC binding protects the FortiGate unit and/or the network from IP address spoofing attacks. IP
spoofing attacks attempt to use the IP address of a trusted computer to connect to, or through, the
FortiGate unit from a different computer. It is simple to change a computer’s IP address to mimic that of
a trusted host, but MAC addresses are often added to Ethernet cards at the factory, and are more
difficult to change. By requiring that traffic from trusted hosts reflect both the IP address and MAC
address known for that host, fraudulent connections are more difficult to construct.
To configure the table of IP addresses and the MAC addresses bound to them, see “ipmacbinding
table” on page 97. To enable or disable IP/MAC binding for an individual FortiGate unit network
interface, see ipmac in “system interface” on page 373.

Note: If IP/MAC binding is enabled, and the IP address of a host with an IP or MAC address in the IP/MAC table is
changed, or a new computer is added to the network, update the IP/MAC table. If you do not update the IP/MAC
binding list, the new or changed hosts will not have access to or through the FortiGate unit. For details on updating
the IP/MAC binding table, see “ipmacbinding table” on page 97.

Caution: If a client receives an IP address from the FortiGate unit’s DHCP server, the client’s MAC
! address is automatically registered in the IP/MAC binding table. This can simplify IP/MAC binding
configuration, but can also neutralize protection offered by IP/MAC binding if untrusted hosts are
allowed to access the DHCP server. Use caution when enabling and providing access to the DHCP
server.

Syntax
config firewall ipmacbinding setting
set bindthroughfw {enable | disable}
set bindtofw {enable | disable}
set undefinedhost {allow | block}
end
Keywords and variables Description Default
bindthroughfw Select to use IP/MAC binding to filter packets that a firewall policy disable
{enable | disable} would normally allow through the FortiGate unit.
bindtofw Select to use IP/MAC binding to filter packets that would normally disable
{enable | disable} connect to the FortiGate unit.
undefinedhost Select how IP/MAC binding handles packets with IP and MAC block
{allow | block} addresses that are not defined in the IP/MAC list for traffic going
through or to the FortiGate unit.
• allow: Allow packets with IP and MAC address pairs that are not in
the IP/MAC binding list.
• block: Block packets with IP and MAC address pairs that are not in
the IP/MAC binding list.
This option is available only when either or both bindthroughfw and
bindtofw are enable.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 95
ipmacbinding setting firewall

Example
This example shows how to enable IP/MAC binding for traffic both going to and through the FortiGate
unit, and block undefined hosts (IP/MAC address pairs).
config firewall ipmacbinding setting
set bindthroughfw enable
set bindtofw enable
set undefinedhost block
end

History

FortiOS v2.80 Revised.

Related topics
• firewall ipmacbinding table

FortiGate CLI Version 3.0 MR6 Reference

96 01-30006-0015-20080205
firewall ipmacbinding table

ipmacbinding table
Use this command to configure IP and MAC address pairs in the IP/MAC binding table. You can bind
multiple IP addresses to the same MAC address, but you cannot bind multiple MAC addresses to the
same IP address.
To configure the IP/MAC binding settings, see “ipmacbinding setting” on page 95. To enable or disable
IP/MAC binding for an individual FortiGate unit network interface, see ipmac in “system interface” on
page 373.

Note: If IP/MAC binding is enabled, and the IP address of a host with an IP or MAC address in the IP/MAC table is
changed, or a new computer is added to the network, update the IP/MAC table. If you do not update the IP/MAC
binding list, the new or changed hosts will not have access to or through the FortiGate unit.

Caution: If a client receives an IP address from the FortiGate unit’s DHCP server, the client’s MAC
! address is automatically registered in the IP/MAC binding table. This can simplify IP/MAC binding
configuration, but can also neutralize protection offered by IP/MAC binding if untrusted hosts are
allowed to access the DHCP server. Use caution when enabling and providing access to the DHCP
server.

Syntax
config firewall ipmacbinding table
edit <index_int>
set ip <address_ipv4>
set mac <address_hex>
set name <name_str>
set status {enable | disable}
end

Keywords and variables Description Default

<index_int> Enter the unique ID number of this IP/MAC pair. No default.
ip <address_ipv4> Enter the IP address to bind to the MAC address. 0.0.0.0
To allow all packets with the MAC address, regardless of the IP
address, set the IP address to 0.0.0.0.
mac <address_hex> Enter the MAC address. 00:00:00:
To allow all packets with the IP address, regardless of the MAC 00:00:00
address, set the MAC address to 00:00:00:00:00:00.
name <name_str> Enter a name for this entry on the IP/MAC address table. noname
(Optional.)
status {enable | disable} Select to enable this IP/MAC address pair. disable
Packets not matching any IP/MAC binding will be dropped.
Packets matching an IP/MAC binding will be matched against
the firewall policy list.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 97
ipmacbinding table firewall

Example
This example shows how to add and enable an IP/MAC entry to the IP/MAC binding table.
config firewall ipmacbinding table
edit 1
set ip 172.16.44.55
set mac 00:10:F3:04:7A:4C
set name RemoteAdmin
set status enable
end

History

FortiOS v2.80 Revised.

Related topics
• firewall ipmacbinding setting

FortiGate CLI Version 3.0 MR6 Reference

98 01-30006-0015-20080205
firewall ippool

ippool
Use this command to configure IP address pools that you can use to configure NAT mode firewall
policies. An IP pool, also called a dynamic IP pool, is a range of IP addresses added to a firewall
interface. You can enable Dynamic IP Pool in a firewall policy to translate the source address to an
address randomly selected from the IP pool. To use IP pools, the IP pool interface must be the same
as the firewall policy destination interface.
Add an IP pool if in order to add NAT mode policies that translate source addresses to addresses
randomly selected from the IP pool rather than being limited to the IP address of the destination
interface. IP pools are only available in NAT/Route mode. Add multiple IP pools to any interface and
configure the firewall policy to select the IP pool to use for that firewall policy.

Syntax
config firewall ippool
edit <index_int>
set endip <address_ipv4>
set interface <name_str>
set startip <address_ipv4>
end

Keywords and variables Description Default

<index_int> The unique ID number of this IP pool. No default.
endip <address_ipv4> The end IP of the address range. The end IP must be higher 0.0.0.0
than the start IP. The end IP does not have to be on the same
subnet as the IP address of the interface for which you are
adding the IP pool.
interface <name_str> Enter the name of a network interface, binding the IP pool to No default.
that interface. On FortiGate-200 models and greater, the
network interface can also be a VLAN subinterface.
startip <address_ipv4> The start IP of the address range. The start IP does not have to 0.0.0.0
be on the same subnet as the IP address of the interface for
which you are adding the IP pool.

Example
You might use the following commands to add an IP pool to the internal network interface. The IP pool
would then be available when configuring firewall policies.
config firewall ippool
edit 1
set startip 192.168.1.100
set endip 192.168.1.200
set interface internal
end

History
FortiOS v2.80 Revised.

Related topics
• firewall policy, policy6

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 99
ldb-monitor firewall

ldb-monitor
Use this command to configure health check settings.
Health check settings can be used by load balancing VIPs to determine if a real server is currently
responsive before forwarding traffic. One health check is sent per interval using the specified protocol,
port and HTTP-GET, where applicable to the protocol. If the server does not respond during the
timeout period, the health check fails and, if retries are configured, another health check is performed.
If all health checks fail, the server is deemed unavailable, and another real server is selected to receive
the traffic according to the selected load balancing algorithm.
Health check settings can be re-used by multiple real servers. For details on enabling health checking
and using configured health check settings, see “firewall vip” on page 155.

Syntax
config firewall ldb-monitor
edit <name_str>
set http-get <httprequest_str>
set http-match <contentmatch_str>
set interval <seconds_int>
set port <port_int>
set retry <retries_int>
set timeout <seconds_int>
set type {http | ping | tcp}
end

Keywords and variables Description Default

<name_str> Enter the name of the health check monitor. No default.
http-get Enter the path (URI) of the HTTP-GET request to use when No default.
<httprequest_str> testing the responsivity of the server.
This option appears only if type is http.
http-match Enter the content of the server’s reply to the HTTP request that No default.
<contentmatch_str> must be matched for the health check to succeed. If the
FortiGate unit does not receive a reply from the server, or its
reply does not contain matching content, the health check fails.
This option appears only if type is http.
interval <seconds_int> Enter the interval time in seconds between health checks. 10
port <port_int> Enter the port number that will be used by the health check. 0
This option does not appear if type is ping.
retry <retries_int> Enter the number of times that the FortiGate unit should retry 3
the health check if a health check fails. If all health checks,
including retries, fail, the server is deemed unavailable.
timeout <seconds_int> Enter the timeout in seconds. If the FortiGate unit does not 2
receive a response to the health check in this period of time, the
the health check fails.
type {http | ping | tcp} Select the protocol used by the health check monitor. No default.

Example
You might configure a health check for a server using the HTTP protocol to retrieve a web page. To
ensure that a web page reply containing an error message, such as an HTTP 404 page, does not
inadvertently cause the health check to succeed, you might search the reply for text that does not
occur in any web server error page, such as unique text on a main page.

FortiGate CLI Version 3.0 MR6 Reference

100 01-30006-0015-20080205
firewall ldb-monitor

config firewall ldp-monitor

edit httphealthchecksettings
set type http
set port 8080
set http-get “/index.php”
set http-match “Welcome to Example, Inc.”
set interval 5
set timeout 2
set retry 2
end

History
FortiOS v3.0 MR6 New command. Configures health check settings which can be used when enabling
health checks for load balanced real servers associated with a virtual IP. This extends and
replaces deprecated commands in config realserver for health check by ICMP
ECHO (ping).

Related topics
• firewall vip

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 101
multicast-policy firewall

multicast-policy
Use this command to configure a source NAT IP. This command can also be used in Transparent
mode to enable multicast forwarding by adding a multicast policy.
The matched forwarded (outgoing) IP multicast source IP address is translated to the configured IP
address.

Syntax
config firewall multicast-policy
edit <index_int>
set action {accept | deny}
set dnat <address_ipv4>
set dstaddr <address_ipv4mask>
set dstintf <name_str>
set nat <address_ipv4>
set srcaddr <address_ipv4mask>
set srcintf <name_str>
set protocol <multicastlimit_int>
set start-port <port_int>
set end-port <port_int>
end

Keywords and variables Description Default

<index_int> Enter the unique ID number of this multicast policy. No default.
action {accept | deny} Enter the policy action. accept
dnat <address_ipv4> Enter an IP address to destination network address translate 0.0.0.0
(DNAT) externally received multicast destination addresses to
addresses that conform to your organization's internal
addressing policy.
dstaddr Enter the destination IP address and netmask, separated by a 0.0.0.0
<address_ipv4mask> space, to match against multicast NAT packets. 0.0.0.0
dstintf <name_str> Enter the destination interface name to match against multicast No default.
NAT packets.
nat <address_ipv4> Enter the IP address to substitute for the original source IP 0.0.0.0
address.
srcaddr Enter the source IP address and netmask to match against 0.0.0.0
<address_ipv4mask> multicast NAT packets. 0.0.0.0
srcintf <name_str> Enter the source interface name to match against multicast No default.
NAT packets.
protocol Limit the number of protocols (services) sent out via multicast 0
<multicastlimit_int> using the FortiGate unit.
start-port <port_int> The beginning of the port range used for multicast. No default.
end-port <port_int> The end of the port range used for multicast. 65535

FortiGate CLI Version 3.0 MR6 Reference

102 01-30006-0015-20080205
firewall multicast-policy

Example
This example shows how to configure a multicast NAT policy.
config firewall multicast-policy
edit 1
set dstaddr 10.0.0.1 255.255.255.0
set dstintf dmz
set nat 10.0.1.1
set srcaddr 192.168.100.12 255.255.255.0
set srcintf internal
end

History

FortiOS v2.80 Revised.

FortiOS v3.0 MR4 Added protocol, start-port, and end-port to multicast-policy.
FortiOS v3.0 MR5 Added dnat.

Related topics
• system global

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 103
policy, policy6 firewall

policy, policy6
Use this command to add, edit, or delete firewall policies.
Firewall policies control all traffic passing through the FortiGate unit. Firewall policies are instructions
used by the FortiGate unit to decide what to do with a connection request. The policy directs the
firewall to allow the connection, deny the connection, require authentication before the connection is
allowed, or apply IPSec or SSL VPN processing.

Note: If you are creating an IPv6 policy, some of the IPv4 options, such as NAT and VPN settings, are not
applicable.

Syntax
config firewall policy, policy6
edit <index_int>
set action {accept | deny | ipsec | ssl-vpn}
set auth-cert <certificate_str>
set auth-path {enable | disable}
set auth-redirect-addr <domainname_str>
set comments <comment_str>
set custom-log-fields <fieldid_int>
set diffserv-forward {enable | disable}
set diffserv-reverse {enable | disable}
set diffservcode-forward <dscp_bin>
set diffservcode-rev <dscp_bin>
set disclaimer {enable | disable}
set dstaddr <name_str>
set dstintf <name_str>
set fixedport {enable | disable}
set forticlient-check {enable | disable}
set forticlient-ra-notinstalled {enable | disable}
set forticlient-ra-notlicensed {enable | disable}
set forticlient-ra-db-outdated {enable | disable}
set forticlient-ra-no-av {enable | disable}
set forticlient-ra-no-fw {enable | disable}
set forticlient-ra-no-wf {enable | disable}
set forticlient-redir-portal {enable | disable}
set fsae {enable | disable}
set fsae-guest-profile <profile_str>
set gbandwidth <limit_int>
set groups <name_str>
set gtp_profile <name_str> (FortiOS Carrier)
set inbound {enable | disable}
set ippool {enable | disable}
set logtraffic {enable | disable}
set maxbandwidth <limit_int>
set nat {enable | disable}
set natinbound {enable | disable}
set natip <address_ipv4mask>
set natoutbound {enable | disable}
set ntlm {enable | disable}
set outbound {enable | disable}
set poolname <name_str>

FortiGate CLI Version 3.0 MR6 Reference

104 01-30006-0015-20080205
firewall policy, policy6

set priority {high | low | medium}

set profile <name_str>
set profile-status {enable | disable}
set redirect-url <name_str>
set schedule <name_str>
set service <name_str>
set srcaddr <name_str>
set srcintf <name_str>
set sslvpn-auth {any | ldap | local | radius | tacacs+}
set sslvpn-ccert {enable | disable}
set sslvpn-cipher {0 | 1 | 2}
set status {enable | disable}
set tcp-mss-sender <maximumsize_int>
set tcp-mss-receiver <maximumsize_int>
set trafficshaping {enable | disable}
set vpntunnel <name_str>
end
Keywords and variables Description Default
<index_int> Enter the unique ID number of this policy. No default.
action Select the action that the FortiGate unit will perform on traffic deny
{accept | deny | ipsec | matching this firewall policy.
ssl-vpn} • accept: Allow packets that match the firewall policy. Also
enable or disable nat to make this a NAT policy (NAT/Route
mode only), enable or disable ippool so that the NAT policy
selects a source address for packets from a pool of IP
addresses added to the destination interface, and enable or
disable fixedport so that the NAT policy does not translate
the packet source port.
• deny: Deny packets that match the firewall policy.
• ipsec: Allow and apply IPSec VPN. When action is set to
ipsec, you must specify the vpntunnel attribute. You may
also enable or disable the inbound, outbound,
natoutbound, and natinbound attributes and/or specify a
natip value.
• ssl-vpn: Allow and apply SSL VPN. When action is set to
ssl-vpn, you may specify values for the sslvpn-auth,
sslvpn-ccert, and sslvpn-cipher attributes.
For IPv6 policies, only accept and deny options are
available.
auth-cert Select a HTTPS server certificate for policy authentication. No default.
<certificate_str> self-sign is the built-in, self-signed certificate; if you have
added other certificates, you may select them instead.
auth-path {enable | Select to apply authentication-based routing. You must also disable
disable} specify a RADIUS server, and the RADIUS server must be
configured to supply the name of an object specified in config
router auth-path. For details on configuring
authentication-based routes, see “router auth-path” on
page 228.
auth-redirect-addr Enter the IP address or domain name that the FortiGate unit will No default.
<domainname_str> use when performing an HTTP-to-HTTPS URL redirects for
firewall policy authentication.
To prevent web browser security warnings, this should match
the CN field of the specified auth-cert, which is usually a
fully qualified domain name (FQDN).
This option appears only if groups is configured.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 105
policy, policy6 firewall

Keywords and variables Description Default

comments <comment_str> Enter a description or other information about the policy. No default.
(Optional)
comment_str is limited to 63 characters. Enclose the string in
single quotes to enter special characters or spaces. For more
information, see “Entering spaces in strings” on page 45
custom-log-fields Enter custom log field index numbers to append one or more No default.
<fieldid_int> custom log fields to the log message for this policy. Separate
multiple log custom log field indices with a space. (Optional.)
This option takes effect only if logging is enabled for the policy,
and requires that you first define custom log fields. For details,
see “log custom-field” on page 190.
diffserv-forward Enable or disable application of the differentiated services code disable
{enable | disable} point (DSCP) value to the DSCP field of forward (original)
traffic. If enabled, also configure diffservcode-forward.
diffserv-reverse Enable or disable application of the differentiated services code disable
{enable | disable} point (DSCP) value to the DSCP field of reverse (reply) traffic. If
enabled, also configure diffservcode-rev.
diffservcode-forward Enter the differentiated services code point (DSCP) value that 000000
<dscp_bin> the FortiGate unit will apply to the field of originating (forward)
packets. The value is 6 bits binary. The valid range is 000000-
111111.
This option appears only if diffserv-forward is enable.
For details and DSCP configuration examples, see the
Knowledge Center article Differentiated Services Code Point
(DSCP) behavior.
diffservcode-rev Enter the differentiated services code point (DSCP) value that 000000
<dscp_bin> the FortiGate unit will apply to the field of reply (reverse)
packets. The value is 6 bits binary. The valid range is 000000-
111111.
This option appears only if diffserv-rev is enable
For details and DSCP configuration examples, see the
Knowledge Center article Differentiated Services Code Point
(DSCP) behavior.
disclaimer {enable | Enable to display the authentication disclaimer page, which is disable
disable} configured with other replacement messages. The user must
accept the disclaimer to connect to the destination.
This option appears only if profile or groups
(authentication) is configured, and only appears on some
models.
dstaddr <name_str> Enter one or more destination firewall addresses, or a virtual IP, No default.
if creating a NAT policy. Separate multiple firewall addresses
with a space.
If action is set to ipsec, enter the name of the IP address to
which IP packets may be delivered at the remote end of the
IPSec VPN tunnel. For details, see “Defining IP source and
destination addresses” in the FortiGate IPSec VPN User Guide.
If action is set to ssl-vpn, enter the name of the IP address
that corresponds to the host, server, or network that remote
clients need to access behind the FortiGate unit.
For details on configuring virtual IPs, see “vip” on page 155.
dstintf <name_str> Enter the destination interface for the policy. The interface can No default.
be a physical interface, a VLAN subinterface, or a zone.
If action is set to ipsec, enter the name of the interface to
the external (public) network.
If action is set to ssl-vpn, enter the name of the interface to
the local (private) network.
Note: If a interface or VLAN subinterface has been added to a
zone, the interface or VLAN subinterface cannot be used for
dstintf.

FortiGate CLI Version 3.0 MR6 Reference

106 01-30006-0015-20080205
firewall policy, policy6

Keywords and variables Description Default

fixedport Enable to preserve packets’ source port number, which may disable
{enable | disable} otherwise be changed by a NAT policy. Some applications do
not function correctly if the source port number is changed, and
may require this option.
If fixedport is enable, you should usually also enable IP
pools; if you do not configure an IP pool for the policy, only one
connection can occur at a time for this port.
forticlient-check Enable to perform FortiClient Host Security software disable
{enable | disable} verifications. To specify the action that the FortiGate unit takes
if a verification fails, also configure:
• forticlient-ra-notinstalled
• forticlient-ra-notlicensed
• forticlient-ra-db-outdated
• forticlient-ra-no-av
• forticlient-ra-no-fw
• forticlient-ra-no-wf
• forticlient-redir-portal
This feature is available only on FortiGate-1000A, FortiGate-
3600A and FortiGate-5005FA2 models, and can detect
FortiClient Host Security software version 3.0 MR2 or later.
forticlient-ra- Deny access to this firewall policy if the host does not have disable
notinstalled FortiClient Host Security software installed. This option is
{enable | disable} available only if forticlient-check is enable.

forticlient-ra- Deny access to this firewall policy if the host does not have a disable
notlicensed licensed copy of FortiClient Host Security software installed.
{enable | disable} This option is available only if forticlient-check is
enable.
forticlient-ra- Deny access to this firewall policy if the FortiClient Host disable
db-outdated Security antivirus database on the host is out of date. This
{enable | disable} option is available only if forticlient-check is enable.

forticlient-ra-no-av Deny access to this firewall policy if the FortiClient Host disable
{enable | disable} Security antivirus feature is not enabled on the host. This option
is available only if forticlient-check is enable.
forticlient-ra-no-fw Deny access to this firewall policy if the FortiClient Host disable
{enable | disable} Security firewall is not enabled on the host. This option is
available only if forticlient-check is enable.
forticlient-ra-no-wf Deny access to this firewall policy if FortiClient Host Security disable
{enable | disable} web filtering is not enabled on the host. This option is available
only if forticlient-check is enable.
forticlient-redir-portal Redirect denied users to the internal web portal. The portal disable
{enable | disable} page displays the reason the user was denied access. If a
FortiClient installation package is stored on the FortiGate unit,
the user can download FortiClient Host Security software from
the portal. You can change the TCP port for the portal using the
forticlient-portal-port keyword. For details, see
“system global” on page 350.
fsae {enable | disable} Enable or disable Active Directory authentication. disable
If you enable this option, you must also define the user groups
and the guest account protection profile. For details, see “fsae-
guest-profile <profile_str>” on page 107 and “groups
<name_str>” on page 108.
fsae-guest-profile Enter the name of the protection profile used when a guest No default.
<profile_str> account authenticates using FSAE.
gbandwidth <limit_int> Enter the amount of bandwidth guaranteed to be available for 0
traffic controlled by the policy. bandwidth_int can be 0 to
100000 Kbytes/second.
This option appears only if trafficshaping is enable.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 107
policy, policy6 firewall

Keywords and variables Description Default

groups <name_str> Enter one or more user group names for users that authenticate No default.
to use this policy. When user groups are created, they are
paired with protection profiles.
This option appears only if action is accept.
gtp_profile <name_str> When a GTP profile is being used, enter the name of a profile to No default.
(FortiOS Carrier) add the GTP profile to the policy. The name_str variable is
case-sensitive. For details on configuring GTP profiles, see “gtp
(FortiOS Carrier)” on page 87.
inbound When action is set to ipsec, enable or disable traffic from disable
{enable | disable} computers on the remote private network to initiate an IPSec
VPN tunnel.
ippool When the action is set to accept and NAT is enabled, configure disable
{enable | disable} a NAT policy to translate the source address to an address
randomly selected from the first IP pool added to the
destination interface of the policy. If fixedport is specified for
a service or for dynamic NAT, use IP pools.
logtraffic Enable or disable recording traffic log messages for this policy. disable
{enable | disable}
maxbandwidth <limit_int> Enter the maximum amount of bandwidth available for traffic 0
controlled by the policy. bandwidth_int can be 0 to 100000
Kbytes/second. If maximum bandwidth is set to 0 no traffic is
allowed by the policy.
This option appears only if trafficshaping is enable.
nat {enable | disable} Enable or disable network address translation (NAT). NAT disable
translates the address and the port of packets accepted by the
policy. When NAT is enabled, ippool and fixedport can
also be enabled or disabled.
FortiOS v3.0 also supports NAT in transparent mode. For
details see “Example Two: Adding a NAT policy in transparent
mode” on page 111.
This option appears only if action is accept or ssl-vpn.
natinbound Enable or disable translating the source addresses IP packets disable
{enable | disable} emerging from the tunnel into the IP address of the FortiGate
unit’s network interface to the local private network.
This option appears only if action is ipsec.
natip <address_ipv4mask> When action is set to ipsec and natoutbound is enabled, 0.0.0.0
specify the source IP address and subnet mask to apply to 0.0.0.0
outbound clear text packets before they are sent through the
tunnel.
If you do not specify a natip value when natoutbound is
enabled, the source addresses of outbound encrypted packets
are translated into the IP address of the FortiGate unit’s
external interface. When a natip value is specified, the
FortiGate unit uses a static subnetwork-to-subnetwork mapping
scheme to translate the source addresses of outbound IP
packets into corresponding IP addresses on the subnetwork
that you specify. For example, if the source address in the
firewall encryption policy is 192.168.1.0/24 and the natip
value is 172.16.2.0/24, a source address of 192.168.1.7 will be
translated to 172.16.2.7.
natoutbound When action is set to ipsec, enable or disable translating the disable
{enable | disable} source addresses of outbound encrypted packets into the IP
address of the FortiGate unit’s outbound interface. Enable this
attribute in combination with the natip attribute to change the
source addresses of IP packets before they go into the tunnel.
ntlm {enable | disable} Enable or disable Active Directory authentication via NTLM. disable
If you enable this option, you must also define the user groups.
For details, see “groups <name_str>” on page 108.

FortiGate CLI Version 3.0 MR6 Reference

108 01-30006-0015-20080205
firewall policy, policy6

Keywords and variables Description Default

outbound When action is set to ipsec, enable or disable traffic from disable
{enable | disable} computers on the local private network to initiate an IPSec VPN
tunnel.
poolname <name_str> Enter the name of the IP pool. No default.
This variable appears only if nat and ippool are enable and
when dstintf is the network interface bound to the IP pool.
priority Select the priority level for traffic controlled by the policy. high
{high | low | medium} This option appears only if trafficshaping is enable.
profile <name_str> Enter the name of a protection profile to use with the policy. No default.
This option appears only if profile-status is enable.
profile-status Enable or disable using a protection profile with the policy. If disable
{enable | disable} enabled, also configure profile.
This is automatically disabled if a user group with an associated
protection profile has been configured in groups. In that case,
the protection profile is determined by the user group, rather
than the firewall policy.
redirect-url <name_str> Enter a URL, if any, that the user is redirected to after No default.
authenticating and/or accepting the user authentication
disclaimer. This option is available on some models, and only
appears if disclaimer is enable.
schedule <name_str> Enter the name of the one-time or recurring schedule to use for No default.
the policy.
service <name_str> Enter the name of one or more services, or a service group, to No default.
match with the firewall policy. Separate multiple services with a
space.
srcaddr <name_str> Enter one or more source firewall addresses for the policy. No default.
Separate multiple firewall addresses with a space.
If action is set to ipsec, enter the private IP address of the
host, server, or network behind the FortiGate unit.
If action is set to ssl-vpn and the firewall encryption policy
is for web-only mode clients, type all.
If action is set to ssl-vpn and the firewall encryption policy
is for tunnel mode clients, enter the name of the IP address
range that you reserved for tunnel mode clients. To define an
address range for tunnel mode clients, see “ssl settings” on
page 538.
srcintf <name_str> Enter the source interface for the policy. The interface can be a No default.
physical interface, a VLAN subinterface or a zone.
If the interface or VLAN subinterface has been added to a zone,
interface or VLAN subinterface cannot be used for srcintf.
If action is set to ipsec, enter the name of the interface to
the local (private) network.
If action is set to ssl-vpn, enter the name of the interface
that accepts connections from remote clients.
sslvpn-auth If action is set to ssl-vpn, enter one of the following client any
{any | ldap | local | authentication options:
radius | tacacs+} • If you want the FortiGate unit to authenticate remote clients
using any local user group, a RADIUS server, or LDAP
server, type any.
• If the user group is a local user group, type local.
• If the remote clients are authenticated by an external RADIUS
server, type radius.
• If the remote clients are authenticated by an external LDAP
server, type ldap.
• If the remote clients are authenticated by an external
TACACS+ server, type tacacs+.
You must also set the name of the group which will use the
authentication method. For details, see “groups <name_str>”
on page 108.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 109
policy, policy6 firewall

Keywords and variables Description Default

sslvpn-ccert If action is set to ssl-vpn, enable or disable the use of disable
{enable | disable} security certificates to authenticate remote clients.
sslvpn-cipher {0 | 1 | 2} If action is set to ssl-vpn, enter one of the following options 0
to determine the level of SSL encryption to use. The web
browser on the remote client must be capable of matching the
level that you select:
• To use any cipher suite, type 0.
• To use a 164-bit or greater cipher suite (high), type 1.
• To use a 128-bit or greater cipher suite (medium), type 2.
status Enable or disable the policy. enable
{enable | disable}
tcp-mss-sender Enter a TCP Maximum Sending Size number for the sender. 0
<maximumsize_int> When a FortiGate unit is configured to use PPPoE to connect to
an ISP, certain web sites may not be accessible to users. This
occurs because a PPPoE frame takes an extra 8 bytes off the
standard Ethernet MTU of 1500.
When the server sends the large packet with DF bit set to 1, the
ADSL provider’s router either does not send an “ICMP
fragmentation needed” packet or the packet is dropped along
the path to the web server. In either case, the web server never
knows fragmentation is required to reach the client.
In this case, configure the tcp-mss-sender option to enable
access to all web sites. For more information, see the article
Cannot view some web sites when using PPPoE on the Fortinet
Knowledge Center.
tcp-mss-receiver Enter a TCP MSS number for the receiver. 0
<maximumsize_int>
trafficshaping Enable or disable traffic shaping. Also configure gbandwidth, disable
{enable | disable} maxbandwidth, and priority.
vpntunnel <name_str> Enter the name of a Phase 1 IPSec VPN configuration to apply No default.
to the tunnel.
This option appears only if action is ipsec.

Example One: Adding a policy in NAT/Route mode

On a FortiGate-100, FortiGate-200, or FortiGate-300, use the following example to add policy number
2 that allows users on the external network to access a web server on a DMZ network. The policy:
• Is for connections from the external interface (srcintf is external) to the DMZ interface
(dstintf is dmz)
• Is enabled
• Allows users from any IP address on the Internet to access the web server (srcaddr is all)
• Allows access to an address on the DMZ network (dstaddr is dmz_web_server)
• Sets the schedule to Always so that users can access the web server 24 hours a day, seven
days a week
• Sets the service to HTTP to limit access to the web server to HTTP connections
• Sets action to accept to allow connections
• Applies network address translation (nat is enabled)
• Applies traffic shaping to guarantee 100 KBytes/s of bandwidth is available, to limit the maximum
bandwidth to 500 KBytes/second, and to set the priority for the traffic accepted by this policy to
medium (trafficshaping enabled, gbandwidth set to 100, maxbandwidth set to 500,
priority set to medium)

FortiGate CLI Version 3.0 MR6 Reference

110 01-30006-0015-20080205
firewall policy, policy6

config firewall policy

edit 2
set srcintf external
set dstintf dmz
set status enable
set srcaddr all
set dstaddr dmz_web_server
set schedule Always
set service HTTP
set action accept
set nat enable
set trafficshaping enable
set gbandwidth 100
set maxbandwidth 500
set priority medium
end

Example Two: Adding a NAT policy in transparent mode

For NAT firewall policies to work in NAT/Route mode you must have two interfaces on two different
networks with two different subnet addresses. Then you can create firewall policies to translate source
or destination addresses for packets as they are relayed by the FortiGate unit from one interface to the
other.
A FortiGate unit operating in Transparent mode normally has only one IP address, the management IP.
To support NAT in Transparent mode you can add a second management IP. These two management
IPs must be on different subnets. When you add two management IP addresses, all FortiGate unit
network interfaces will respond to connections to both of these IP addresses.
In the example below, all of the PCs on the internal network (subnet address 192.168.1.0/24) are
configured with 192.168.1.99 as their default route. One of the management IPs of the FortiGate unit is
set to 192.168.1.99. This configuration results in a typical NAT mode firewall. When a PC on the
internal network attempts to connect to the internet, the PC's default route sends packets destined for
the internet to the FortiGate unit internal interface.
Similarly on the DMZ network (subnet address 10.1.1.0/24) all of the PCs have a default route of
10.1.1.99.
The example describes adding an internal to wan1 firewall policy to relay these packets from the
internal interface out the wan1 interface to the Internet. Because the wan1 interface does not have an
IP address of its own, you must add an IP pool to the wan1 interface that translates the source
addresses of the outgoing packets to an IP address on the network connected to the wan1 interface.
The example describes adding an IP pool with a single IP address of 10.1.1.201. So all packets sent
by a PC on the internal network that are accepted by the internal to wan1 policy leave the wan1
interface with their source address translated to 10.1.1.201. These packets can now travel across the
Internet to their destination. Reply packets return to the wan1 interface because they have a
destination address of 10.1.1.201. The internal to wan1 NAT policy translates the destination address
of these return packets to the IP address of the originating PC and sends them out the internal
interface to the originating PC.
Use the following steps to configure NAT in Transparent mode
• Adding two management IPs
• Adding an IP pool to the wan1 interface
• Adding an internal to wan1 firewall policy

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 111
policy, policy6 firewall

Adding two management IPs

Use the following commands to add two management IPs. The second management IP is the default
gateway for the internal network.
config system settings
set manageip 10.1.1.99/24 192.168.1.99/24
end

Adding an IP pool to the wan1 interface

Use the following command to add an IP pool to the wan1 interface:
config firewall ippool
edit nat-out
set interface "wan1"
set startip 10.1.1.201
set endip 10.1.1.201
end

Adding an internal to wan1 firewall policy

Use the following command to add an internal to wan1 firewall policy with NAT enabled that also
includes an IP pool:
config firewall policy
edit 1
set srcintf "internal"
set dstintf "wan1"
set scraddr "all"
set dstaddr "all"
set action accept

FortiGate CLI Version 3.0 MR6 Reference

112 01-30006-0015-20080205
firewall policy, policy6

set schedule "always"

set service "ANY"
set nat enable
set ippool enable
set poolname nat-out
end
Note: You can add the firewall policy from the web-based manager and then use the CLI to enable NAT
and add the IP Pool.

History

FortiOS v2.80 Revised.

FortiOS v2.80 MR2 Replaced usrgrp keyword with userdomain.
Added poolname keyword.
FortiOS v2.80 MR3 Removed userdomain keyword.
Added groups keyword.
FortiOS v2.80 MR6 Removed authentication keyword. Authentication is automatically enabled for a policy
when one or more user group are set with the groups keyword.
FortiOS v3.0 Added ssl-vpn options: sslvpn-ccert, sslvpn-cipher, and sslvpn-auth. The encrypt
action name changed to ipsec. Updated ipsec options: vpntunnel, inbound,
outbound, natoutbound, natinbound, and natip. Added fsae. Changes to
profile and profile_status.
Added tcp-mms-sender and tcp-mss-receiver.
FortiOS v3.0 MR4 Added the command ntlm. Described the new ability to add multiple entries for the
following commands: srcaddr, dstaddr, and service.
Nat policy in transparent mode example added.
FortiOS v3.0 MR5 Added secure-vlan keyword. This is available only on the FortiGate-224B unit.
FortiOS v3.0 MR6 New variable custom-log-fields <fieldid_int>. Selects custom log fields to
append to the policy’s log message.
FortiOS v3.0 MR6 New option tacacs+. Selects TACACS+ authentication method when the firewall policy
action is set to ssl-vpn.
FortiOS v3.0 MR6 New variable auth-path {enable | disable}. Enables or disables authentication-
based routing.
FortiOS v3.0 MR6 New variable auth-redirect-addr <domainname_str>. Specifies address used in
URL when performing HTTP-to-HTTPS redirects for policy authentication.

Related topics
• firewall address, address6
• firewall profile
• firewall schedule onetime
• firewall schedule recurring
• firewall service custom
• firewall service group

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 113
profile firewall

profile
Use this command to configure protection profiles which can be applied to traffic by selecting the
protection profile in one or more firewall policies, or by associating a protection profile with a firewall
user group. The firewall policy will apply the subset of the protection profile that is relevant to the
service or service group.

Syntax
config firewall profile
edit <profile_str>
set aim {enable-inspect | } {archive-full archive-summary block-audio
block-encrypt block-file block-im block-long-chat block-photo
inspect-anyport no-content-summary}
set bittorrent {block | pass | limit}
set bittorrent-limit <limit_int>
set comment <comment_str>
set edonkey {block | pass | limit}
set edonkey-limit <limit_int>
set filepattable <index_int> (not in FortiOS Carrier)
set file-pat-table <index_int> (FortiOS Carrier)
set file-type-table <index_int> (FortiOS Carrier)
set ftgd-wf-allow {all | <category_str>}
set ftgd-wf-deny {all | <category_str>}
set ftgd-wf-enable {all | <category_str>}
set ftgd-wf-disable {all | <category_str>}
set ftgd-wf-https-options {allow-ovrd error-allow rate-server-ip
strict-blocking}
set ftgd-wf-log {all | <category_str>}
set ftgd-wf-options {allow-ovrd error-allow http-err-detail
rate-image-urls rate-server-ip redir-block strict-blocking}
set ftgd-wf-ovrd {all | <category_str>}
set ftp {archive-full archive-summary avmonitor avquery block
clientcomfort filetype no-content-summary oversize quarantine scan
scanextended splice}
set ftpcomfortamount <size_int>
set ftpcomfortinterval <seconds_int>
set ftpoversizelimit <size_int>
set gnutella {block | pass | limit}
set gnutella-limit <limit_int>
set http {activexfilter archive-full archive-summary avmonitor
avquery bannedword block chunkedbypass clientcomfort cookiefilter
exemptword filetype fortiguard-wf javafilter no-content-summary
oversize quarantine rangeblock scan scanextended strict-file
urlfilter}
set httpcomfortamount <size_int>
set httpcomfortinterval <seconds_int>
set httpoversizelimit <size_int>
set http-retry-count <retry_int>
set https {allow-ssl-unknown-sess-id block-invalid-url fortiguard-wf
no-content-summary urlfilter}
set icq {enable-inspect | } {archive-full archive-summary block-audio
block-file block-im block-photo inspect-anyport no-content-
summary}

FortiGate CLI Version 3.0 MR6 Reference

114 01-30006-0015-20080205
firewall profile

set im { avmonitor avquery block oversize quarantine scan}

set imap { archive-full archive-summary avmonitor avquery bannedword
block filetype fragmail no-content-summary oversize quarantine
scan spam-mail-log spamemailbwl spamfschksum spamfsip spamfssubmit
spamfsurl spamhdrcheck spamipbwl spamraddrdns spamrbl}
set imapoversizelimit <size_int>
set imap-spamaction {pass | tag}
set imap-spamtagmsg <message_str>
set imap-spamtagtype {header | subject} {spaminfo | }
set imoversizelimit <size_int>
set imoversizechat <size_int>
set ips-sensor <name_str>
set ips-sensor-status {enable | disable}
set kazaa {block | pass | limit}
set kazaa-limit <limit_int>
set log-antispam-mass-mms {enable | disable} (FortiOS Carrier)
set log-av-block {enable | disable}
set log-av-msisdn-filter {enable | disable} (FortiOS Carrier)
set log-av-oversize {enable | disable}
set log-av-virus {enable | disable}
set log-im {enable | disable}
set log-intercept {enable | disable} (FortiOS Carrier)
set log-ips {enable | disable}
set log-mms-notification {enable | disable} (FortiOS Carrier)
set log-p2p {enable | disable}
set log-spam {enable | disable}
set log-voip {enable | disable}
set log-voip-violations {enable | disable}
set log-web-content {enable | disable}
set log-web-filter-activex {enable | disable}
set log-web-filter-applet {enable | disable}
set log-web-filter-cookie {enable | disable}
set log-web-ftgd-err {enable | disable}
set log-web-url {enable | disable}
set mail-sig <signature_str>
set mailsig-status {enable | disable}
set mm1 {archive-full archive-summary avmonitor avquery bannedword
block chunkedbypass clientcomfort exemptword filetype msisdn-bwl
no-content-summary oversize quarantine scan server-comfort
strict-file} (FortiOS Carrier)
set mm3 {archive-full archive-summary avmonitor avquery bannedword
block filetype fragmail msisdn-bwl no-content-summary oversize
quarantine scan splice} (FortiOS Carrier)
set mm4 {archive-full archive-summary avmonitor avquery bannedword
block filetype fragmail msisdn-bwl no-content-summary oversize
quarantine scan splice} (FortiOS Carrier)
set mm7 {archive-full archive-summary avmonitor avquery bannedword
block chunkedbypass clientcomfort exemptword filetype msisdn-bwl
no-content-summary oversize quarantine scan server-comfort
strict-file} (FortiOS Carrier)
set mm1-addr-hdr <identifier_str> (FortiOS Carrier)
set mm1-addr-source {cookie | http-header} (FortiOS Carrier)
set mm1-convert-hex {enable | disable} (FortiOS Carrier)
set mm1-retr-dupe {enable | disable} (FortiOS Carrier)

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 115
profile firewall

set mm1comfortamount <size_int> (FortiOS Carrier)

set mm1comfortinterval <seconds_int> (FortiOS Carrier)
set mm7-addr-hdr <identifier_str> (FortiOS Carrier)
set mm7-addr-source {cookie | http-header} (FortiOS Carrier)
set mm7-convert-hex {enable | disable} (FortiOS Carrier)
set mm7comfortamount <size_int> (FortiOS Carrier)
set mm7comfortinterval <seconds_int> (FortiOS Carrier)
set mms-bword-table <index_int> (FortiOS Carrier)
set mms-bword-threshold (FortiOS Carrier)
set mms-exmword-table (FortiOS Carrier)
set mms-file-pat-table <index_int> (FortiOS Carrier)
set mms-file-type-table <index_int> (FortiOS Carrier)
set mms-msisdn-bwl-table <index_int> (FortiOS Carrier)
set msisdn-prefix {enable | disable} (FortiOS Carrier)
set msisdn-prefix-string (FortiOS Carrier)
set msisdn-prefix-range-min (FortiOS Carrier)
set msisdn-prefix-range-max (FortiOS Carrier)
set msn {enable-inspect | } {archive-full archive-summary block-audio
block-file block-im block-photo no-content-summary}
set nntp {archive-full archive-summary avmonitor avquery block
filetype no-content-summary oversize scan spam-mail-log }
set nntpoversizelimit <limit_int>
set p2p {enable | disable}
set pop3 {archive-full archive-summary avmonitor avquery bannedword
block filetype fragmail no-content-summary oversize quarantine scan
spam-mail-log spamemailbwl spamfschksum spamfsip spamfssubmit
spamfsurl spamhdrcheck spamipbwl spamraddrdns spamrbl}
set pop3oversizelimit <size_int>
set pop3-spamaction {pass | tag}
set pop3-spamtagmsg <message_str>
set pop3-spamtagtype {header | subject} {spaminfo | }
set replacemsg-group <name_str>
set skype {block | pass}
set smtp {archive-full archive-summery avmonitor avquery bannedword
block filetype fragmail no-content-summary oversize quarantine scan
spam-mail-log spamemailbwl spamfsip spamfschksum spamfsurl
spamhdrcheck spamhelodns spamipbwl spamraddrdns spamrbl splice}
set smtp-spam-localoverride {enable | disable}
set smtpoversizelimit <size_int>
set smtp-spamaction {discard | pass | tag}
set smtp-spamhdrip {enable | disable}
set smtp-spamtagmsg <message_str>
set smtp-spamtagtype {header | subject} {spaminfo | }
set spambwordtable <index_int>
set spamemaddrtable <index_int>
set spamipbwltable <index_int>
set spamiptrusttable <index_int>
set spammheadertable <index_int>
set spamrbltable <index_int>
set spambwordthreshold <value_int>
set webbwordtable <index_int> (not in FortiOS Carrier)
set web-bword-table <index_int> (FortiOS Carrier)
set webbwordthreshold <value_int> (not in FortiOS Carrier)
set web-bword-threshold <value_int> (FortiOS Carrier)

FortiGate CLI Version 3.0 MR6 Reference

116 01-30006-0015-20080205
firewall profile

set webexmwordtable <index_int> (not in FortiOS Carrier)

set web-exmword-table <index_int> (FortiOS Carrier)
set weburlfiltertable <index_int>
set winny {block | pass | limit}
set winny-limit <limit_int>
set yahoo {enable-inspect | } {archive-full archive-summary
block-audio block-file block-im block-photo inspect-anyport no-
content-summary}
config dupe {mm1 | mm4} (FortiOS Carrier)
set status {enable | disable}
set action {archive block intercept log}
set block-time <minutes_int>
set limit <duplicatetrigger_int>
set window <minutes_int>
get protocol
end
config flood {mm1 | mm4} (FortiOS Carrier)
set status {enable | disable}
set action {archive block intercept log}
set block-time <minutes_int>
set limit <floodtrigger_int>
set window <minutes_int>
get protocol
end
config notification {mm1 | mm3 | mm4 | mm7} (FortiOS Carrier)
set bword-int <noticeinterval_int>
set bword-int-mode {minutes | hours}
set bword-status {enable | disable}
set detect-server {enable | disable}
set dupe-int <interval_int>
set dupe-int-mode {hours | minutes}
set dupe-status
set file-block-int <noticeinterval_int>
set file-block-int-mode {hours | minutes}
set file-block-status {enable | disable}
set flood-int <interval_int>
set flood-int-mode {hours | minutes}
set flood-status
set from-in-header {enable | disable}
set mmsc-hostname
set mmsc-password <passwd_str>
set mmsc-port
set mmsc-url
set mmsc-username <user_str>
set msg-protocol {mm1 | mm3 | mm4 | mm7}
set msg-type {deliver-req | send-req}
set msisdn-bwl-int <interval_int>
set msisdn-bwl-int-mode {hours | minutes}
set msisdn-bwl-status {enable | disable}
set rate-limit <limit_int>
set tod-window-start <window_time>
set tod-window-end <window_time>
set vas-id <vas_str>
set vasp-id <vasp_str>

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 117
profile firewall

set virus-int <interval_int>

set virus-int-mode {hours | minutes}
set virus-status {enable | disable}
end
config sccp
set status {enable | disable}
set archive-summary {enable | disable}
set block-mcast {enable | disable}
set max-calls <limit_int>
set no-content-summary {enable | disable}
set verify-header {enable | disable}
end
config simple
set status {enable | disable}
set archive-full {enable | disable}
set archive-summary {enable | disable}
set block-message {enable | disable}
set message-rate <limit_int>
end
config sip
set status {enable | disable}
set ack-rate <rate_int>
set archive-summary {enable | disable}
set block-ack {enable | disable}
set block-bye {enable | disable}
set block-cancel {enable | disable}
set block-info {enable | disable}
set block-invite {enable | disable}
set block-long-lines {enable | disable}
set block-notify {enable | disable}
set block-options {enable | disable}
set block-prack {enable | disable}
set block-publish {enable | disable}
set block-refer {enable | disable}
set block-register {enable | disable}
set block-subscribe {enable | disable}
set block-unknown {enable | disable}
set block-update {enable | disable}
set call-keepalive <limit_int>
set info-rate <rate_int>
set invite-rate <limit_int>
set max-dialogs <limit_int>
set max-line-length <limit_int>
set no-sdp-fixup {enable | disable}
set notify-rate <limit_int>
set options-rate <limit_int>
set prack-rate <limit_int>
set preserve-override {enable | disable}
set primary-secondary {enable | disable}
set refer-rate <limit_int>
set register-rate <limit_int>
set rtp {enable | disable}
set strict-register {enable | disable}
set subscribe-rate <limit_int>

FortiGate CLI Version 3.0 MR6 Reference

118 01-30006-0015-20080205
firewall profile

set timeout-buffer <calls_int>

set update-rate <limit_int>
end
end
Keywords and variables Description Default
<profile_str> Enter the name of this protection profile. No default.
The following commands are the set options for edit <profile str>.
aim Enter enable-inspect to enable inspection of AOL inspect-
{enable-inspect | } Instant Messenger (AIM) traffic, then enter any additional anyport
{archive-full archive- options, separated by a space.
summary block-audio • archive-full: Content archive both metadata and
the chat itself.
block-encrypt block-file
• archive-summary: Content archive chat metadata.
block-im block-long-chat
• block-audio: Block audio content.
block-photo
• block-encrypt: Block encrypted session.
inspect-anyport no-
• block-file: Block file transfers.
content-summary}
• block-im: Block instant messages.
• block-long-chat: Block oversize instant messages.
• block-photo: Block photo sharing.
• inspect-anyport: Inspect AIM traffic on any port that
is not used by a FortiGate proxy.
• no-content-summary: Omit content information from
the dashboard.
bittorrent Select the action the FortiGate unit performs on BitTorrent pass
{block | pass | limit} peer-to-peer (P2P) traffic.
• block: Block BitTorrent traffic.
• pass: Allow BitTorrent traffic.
• limit: Restrict bandwidth used by BitTorrent.
Configure bittorrent-limit to specify the
bandwidth limit.
This option is available only if p2p is enable.
bittorrent-limit Enter the maximum amount of bandwidth BitTorrent 0
<limit_int> connections are allowed to use, up to 100000 KB/s. If this
variable is set to zero (0), BitTorrent traffic is not allowed.
This option appears only if bittorrent is set to limit.
The bandwidth limit can be applied separately for each
firewall policy that uses the protection profile, or shared
by all firewall policies that use the protection profile. By
default, the limit is applied separately to each firewall
policy. For information on configuring per policy or per
protection profile P2P bandwidth limiting, see the p2p-
rate-limiting variable in “system settings” on
page 440.
comment <comment_str> Enter a comment about the protection profile. If the No default.
comment contains spaces or special characters, surround
the comment with double quotes (“). Comments can be
up to 64 characters long.
edonkey Select the action the FortiGate unit performs on eDonkey pass
{block | pass | limit} peer-to-peer (P2P) traffic.
• block: Block eDonkey traffic.
• pass: Allow eDonkey traffic.
• limit: Restrict bandwidth used by eDonkey. Configure
edonkey-limit to specify the bandwidth limit.
This option is available only if p2p is enable.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 119
profile firewall

Keywords and variables Description Default

edonkey-limit Enter the maximum amount of bandwidth eDonkey 0
<limit_int> connections are allowed to use, up to 100000 KB/s. If this
variable is set to zero (0), eDonkey traffic is not allowed.
This option appears only if edonkey is set to limit.
The bandwidth limit can be applied separately for each
firewall policy that uses the protection profile, or shared
by all firewall policies that use the protection profile. By
default, the limit is applied separately to each firewall
policy. For information on configuring per policy or per
protection profile P2P bandwidth limiting, see the p2p-
rate-limiting variable in “system settings” on
page 440.
filepattable <index_int> Enter the ID number of the file pattern list to be used with 0
(not in FortiOS Carrier) the protection profile.
This option appears only on FortiGate-800 models and
greater.
file-pat-table Enter the ID number of the file pattern list to be used with No default.
<index_int> the protection profile.
(FortiOS Carrier) This option appears only on FortiGate-800 models and
greater.
file-type-table Enter the ID number of the file type list to be used with the No default.
<index_int> protection profile.
(FortiOS Carrier) In the web-based manager, both the file pattern and file
type filters and configured and enabled together, with the
File Filter controls. In the CLI, the file pattern and file type
filters are separately adjustable, and each can even use
different tables.
ftgd-wf-allow Enter all, or enter one or more category codes, All categories
{all | <category_str>} representing FortiGuard Web Filtering web page not specified as
categories or category groups that you want to allow. deny or monitor.
To view a list of available category codes with their
descriptions, enter get, then locate entries for ftgd-wf-
enable, such as g01 Potentially Liable, 1 Drug
Abuse, and c06 Spam URL.
Separate multiple codes with a space. To delete entries,
use the unset command to delete the entire list.
See also “webfilter fortiguard” on page 552.
ftgd-wf-deny Enter all, or enter one or more category codes, No default.
{all | <category_str>} representing FortiGuard Web Filtering web page
categories or category groups that you want to block.
To view a list of available category codes with their
descriptions, enter get, then locate entries for ftgd-wf-
enable, such as g01 Potentially Liable, 1 Drug
Abuse, and c06 Spam URL.
Separate multiple codes with a space. To delete entries,
use the unset command to delete the entire list.
See also “webfilter fortiguard” on page 552.
ftgd-wf-enable Enable categories for use in local ratings. You can enable No default.
{all | <category_str>} categories, classes, and groups.
To view a list of available category codes with their
descriptions, enter get, then locate entries for ftgd-wf-
enable, such as g01 Potentially Liable, 1 Drug
Abuse, and c06 Spam URL.
Separate multiple codes with a space. To delete entries,
use the unset command to delete the entire list.
See also “webfilter fortiguard” on page 552.

FortiGate CLI Version 3.0 MR6 Reference

120 01-30006-0015-20080205
firewall profile

Keywords and variables Description Default

ftgd-wf-disable Disable categories for use in local ratings. You can No default.
{all | <category_str>} disable categories, classes, and groups.
To view a list of available category codes with their
descriptions, enter get, then locate entries for ftgd-wf-
enable, such as g01 Potentially Liable, 1 Drug
Abuse, and c06 Spam URL.
Separate multiple codes with a space. To delete entries,
use the unset command to delete the entire list.
See also “webfilter fortiguard” on page 552.
ftgd-wf-https-options Select the options for FortiGuard Web Filtering category strict-
{allow-ovrd blocking. blocking
error-allow • allow-ovrd: Allow authenticated rating overrides.
rate-server-ip • error-allow to allow web pages with a rating error to
strict-blocking} pass through.
• rate-server-ip: Rate both the URL and the IP
address of the requested site, providing additional
security against circumvention attempts.
• strict-blocking to block any web pages if any
classification or category matches the rating.
Separate multiple options with a space. To remove an
option from the list or add an option to the list, retype the
list with the option removed or added.
ftgd-wf-log Enter all, or enter one or more category codes, No default.
{all | <category_str>} representing FortiGuard Web Filtering web page
categories or category groups that you want to log.
To view a list of available category codes with their
descriptions, enter get, then locate entries for ftgd-wf-
enable, such as g01 Potentially Liable, 1 Drug
Abuse, and c06 Spam URL.
Separate multiple codes with a space. To delete entries,
use the unset command to delete the entire list.
ftgd-wf-options Select options for FortiGuard web filtering, separating strict-
{allow-ovrd multiple options with a space. blocking
error-allow • allow-ovrd: Allow authenticated rating overrides.
http-err-detail • error-allow: Allow web pages with a rating error to
rate-image-urls pass through.
rate-server-ip • http-err-detail: Display a replacement message
for 4xx and 5xx HTTP errors. If error pages are allowed,
redir-block malicious or objectionable sites could use these
strict-blocking} common error pages to circumvent web category
blocking. This option does not apply to HTTPS.
• rate-image-urls: Rate images by URL. Blocked
images are replaced with blanks. This option does not
apply to HTTPS.
• rate-server-ip: Send both the URL and the IP
address of the requested site for checking, providing
additional security against attempts to bypass the
FortiGuard system.
• redir-block: Block HTTP redirects. Many web sites
use HTTP redirects legitimately; however, in some
cases, redirects may be designed specifically to
circumvent web filtering, as the initial web page could
have a different rating than the destination web page of
the redirect.
• strict-blocking: Block any web pages if any
classification or category matches the rating. This
option does not apply to HTTPS.
To remove an option from the list or add an option to the
list, retype the list with the option removed or added.
These options take effect only if FortiGuard web filtering is
enabled for the protocol.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 121
profile firewall

Keywords and variables Description Default

ftgd-wf-ovrd Enter all, or enter one or more category codes, No default.
{all | <category_str>} representing FortiGuard Web Filtering web page
categories or category groups that you want to allow
users to override. If filtering overrides are enabled for the
protocol and a user requests a web page from a category
that is blocked, the user is presented with an
authentication challenge; if they successfully
authenticate, they are permitted to bypass the filter and
access the web page. User groups permitted to
authenticate are defined in the firewall policy. For details,
see “groups <name_str>” on page 108.
To view a list of available category codes with their
descriptions, enter get, then locate entries for ftgd-wf-
enable, such as g01 Potentially Liable, 1 Drug
Abuse, and c06 Spam URL.
Separate multiple codes with a space. To delete entries,
use the unset command to delete the entire list.
ftp Select actions, if any, the FortiGate unit will perform with splice
{archive-full FTP connections.
archive-summary • archive-full: Content archive both metadata and
avmonitor the file itself.
avquery • archive-summary: Content archive metadata.
block • avmonitor: Log detected viruses, but allow them
through the firewall without modification.
clientcomfort
• avquery: Use the FortiGuard AV query service.
filetype
• block: Deny files matching the file pattern selected by
no-content-summary filepattable (not in FortiOS Carrier) or file-pat-
oversize table (FortiOS Carrier), even if the files do not contain
quarantine viruses.
scan scanextended • clientcomfort: Apply client comforting and prevent
splice} client timeout.
• filetype: Block specific types of files even if the files
do not contain viruses. The file type table used is set
with the file-type-table command. (FortiOS
Carrier)
• no-content-summary: Omit the content summary
from the dashboard.
• oversize: Block files that are over the file size limit.
• quarantine: Quarantine files that contain viruses.
This feature is available for FortiGate units that contain
a hard disk or are connected to a FortiAnalyzer unit.
• scan: Scan files for viruses and worms.
• scanextended: Scan files for viruses and worms,
using both the current FortiGuard Antivirus wild list
database and the extended database, which consists of
definitions for older viruses that FortiGuard has not
recently observed in the wild. For details on the
extended database, see the FortiGate Administration
Guide.
• splice: Simultaneously scan a message and send it to
the recipient. If the FortiGate unit detects a virus, it
prematurely terminates the connection.
Separate multiple options with a space. To remove an
option from the list or add an option to the list, retype the
list with the option removed or added.
ftpcomfortamount Enter the number of bytes client comforting sends each 1
<size_int> interval to show that an FTP download is progressing.
The interval time is set using ftpcomfortinterval.
ftpcomfortinterval Enter the time in seconds before client comforting starts 10
<seconds_int> after an FTP download has begun. It is also the interval
between subsequent client comforting sends. The amount
of data sent each interval is set using
ftpcomfortamount.

FortiGate CLI Version 3.0 MR6 Reference

122 01-30006-0015-20080205
firewall profile

Keywords and variables Description Default

ftpoversizelimit Enter the maximum in-memory file size that will be 10
<size_int> scanned, in megabytes. If the file is larger than the
ftpoversizelimit, the file is passed or blocked,
depending on whether ftp contains the oversize
option. The maximum file size for scanning in memory is
10% of the FortiGate unit’s RAM.
gnutella Select the action the FortiGate unit performs on Gnutella pass
{block | pass | limit} peer-to-peer (P2P) traffic.
• block: Block Gnutella traffic.
• pass: Allow Gnutella traffic.
• limit: Restrict bandwidth used by Gnutella. Configure
gnutella-limit to specify the bandwidth limit.
This option is available only if p2p is enable.
gnutella-limit Enter the maximum amount of bandwidth Gnutella 0
<limit_int> connections are allowed to use, up to 100000 KB/s. If this
variable is set to zero (0), Gnutella traffic is not allowed.
This option appears only if gnutella is set to limit.
The bandwidth limit can be applied separately for each
firewall policy that uses the protection profile, or shared
by all firewall policies that use the protection profile. By
default, the limit is applied separately to each firewall
policy. For information on configuring per policy or per
protection profile P2P bandwidth limiting, see the p2p-
rate-limiting variable in “system settings” on
page 440.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 123
profile firewall

Keywords and variables Description Default

http Select actions, if any, the FortiGate unit will perform with rangeblock
{activexfilter HTTP connections.
archive-full • activexfilter: Block ActiveX plugins.
archive-summary • archive-full: Content archive both metadata and
avmonitor the request.
avquery • archive-summary: Content archive metadata.
bannedword • avmonitor: Log detected viruses, but allow them
through the firewall without modification.
block
• avquery: Use the FortiGuard Antivirus service for virus
chunkedbypass detection using MD5 checksums. This feature is
clientcomfort disabled by default.
cookiefilter • bannedword: Block web pages containing content in
exemptword the banned word list.
filetype • block: Deny files matching the file pattern selected by
fortiguard-wf filepattable (not in FortiOS Carrier) or file-pat-
table (FortiOS Carrier), even if the files do not contain
javafilter viruses.
no-content-summary • chunkedbypass: Allow web sites that use chunked
oversize encoding for HTTP to bypass the firewall. Chunked
quarantine encoding means the HTTP message body is altered to
rangeblock allow it to be transferred in a series of chunks. Use of
scan this feature is a risk. Malicious content could enter the
network if web content is allowed to bypass the firewall.
scanextended
• clientcomfort: Apply client comforting and prevent
strict-file client timeout.
urlfilter} • cookiefilter: Block cookies.
• exemptword: Exempt words from content blocking.
• filetype: Block specific types of files even if the files
do not contain viruses. The file type table used is set
with the file-type-table command. (FortiOS
Carrier)
• fortiguard-wf: Use FortiGuard Web Filtering.
• javafilter: Block Java applets.
• no-content-summary: Omit content information from
the dashboard.
• oversize: Block files that are over the file size limit.
• quarantine: Quarantine files that contain viruses.
This feature is available for FortiGate units that contain
a hard disk or are connected to a FortiAnalyzer unit.
• rangeblock: Block ddownloading parts of a file that
have already been partially downloaded. Enabling this
option prevents the unintentional download of virus files
hidden in fragmented files. Note that some types of files,
such as PDF, fragment files to increase download speed
and enabling this option can cause download
interruptions. Enabling this option may break certain
applications that use the Range Header in the HTTP
protocol, such as YUM, a Linux update manager.
• scan: Scan files for viruses and worms.
• strict-file to perform stricter checking for blocked
files as specified by antivirus file patterns. This more
thorough checking can effectively block some web sites
with elaborate scripting using .exe or .dll files if
those patterns are blocked.
• urlfilter: Use the URL filter list.
Separate multiple options with a space.To remove an
option from the list or add an option to the list, retype the
list with the option removed or added.
httpcomfortamount Enter the number of bytes client comforting sends each 1
<size_int> interval to show an FTP download is progressing. The
interval time is set using httpcomfortinterval.

FortiGate CLI Version 3.0 MR6 Reference

124 01-30006-0015-20080205
firewall profile

Keywords and variables Description Default

httpcomfortinterval Enter the time in seconds before client comforting starts 10
<seconds_int> after an HTTP download has begun. It is also the interval
between subsequent client comforting sends. The amount
of data sent each interval is set using
httpcomfortamount.
httpoversizelimit Enter the maximum in-memory file size that will be 10
<size_int> scanned, in megabytes. If the file is larger than the
httpoversizelimit, the file is passed or blocked,
depending on whether oversize is set in the profile
http command. The maximum file size for scanning in
memory is 10% of the FortiGate unit’s RAM.
http-retry-count Enter the number of times to retry establishing an HTTP 0
<retry_int> connection when the connection fails on the first try. The
range is 0 to 100.
This allows the web server proxy to repeat the connection
attempt on behalf of the browser if the server refuses the
connection the first time. This works well and reduces the
number of hang-ups or page not found errors for busy
web servers.
Entering zero (0) effectively disables this feature.
https Select actions, if any, the FortiGate unit will perform with No default.
{allow-ssl-unknown-sess- HTTPS connections.
id • allow-ssl-unknown-sess-id: Allow SSL sessions
block-invalid-url whose ID has not been previously filtered.
fortiguard-wf • block-invalid-url: Block SSL sites whose URL
cannot be determined.
no-content-summary
• fortiguard-wf: Enable FortiGuard Web Filtering.
urlfilter}
• no-content-summary: Omit content information from
the dashboard.
• Enter urlfilter to enable the URL filter list.
Separate multiple options with a space.To remove an
option from the list or add an option to the list, retype the
list with the option removed or added.
icq {enable-inspect | } Enter enable-inspect to enable inspection of ICQ inspect-anyp
{archive-full Instant Messenger traffic, then enter any additional ort
archive-summary options, separated by a space.
block-audio block-file • archive-full: Content archive both metadata and
the chat itself.
block-im block-photo
• archive-summary: Content archive metadata.
inspect-anyport no-
• block-audio: Block audio content.
content-summary}
• block-file: Block file transfers.
• block-im: Block instant messages.
• block-photo: Block photo sharing.
• inspect-anyport: Inspect ICQ traffic on any port that
is not used by a FortiGate proxy.
• no-content-summary: Omit content information from
the dashboard.
im { Select actions, if any, the FortiGate unit will perform with No default.
avmonitor instant message (IM) connections.
avquery • avmonitor: Log detected viruses, but allow them
block through the firewall without modification.
oversize • avquery: Use the FortiGuard Antivirus service for virus
detection using MD5 checksums.
quarantine
• oversize: Block files that are over the file size limit.
scan}
• quarantine: Quarantine files that contain viruses.
This feature is available for FortiGate units that contain
a hard disk or are connected to a FortiAnalyzer unit.
• scan: Scan files for viruses and worms.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 125
profile firewall

Keywords and variables Description Default

imap { Select actions, if any, the FortiGate unit will perform with fragmail
archive-full IMAP connections. spamfssubmit
archive-summary • archive-full: Content archive both metadata and
avmonitor the email itself.
avquery • archive-summary: Content archive metadata.
bannedword • avmonitor: Log detected viruses, but allow them
through the firewall without modification.
block
• avquery: Use the FortiGuard Antivirus service for virus
filetype detection using MD5 checksums.
fragmail • bannedword: Block email containing content on the
no-content-summary banned word list.
oversize • block: Deny files matching the file pattern selected by
quarantine filepattable (not in FortiOS Carrier) or file-pat-
scan table (FortiOS Carrier), even if the files do not contain
viruses.
spam-mail-log
• filetype: Block specific types of files even if the files
spamemailbwl do not contain viruses. The file type table used is set
spamfschksum with the file-type-table command. (FortiOS
spamfsip Carrier)
spamfssubmit • fragmail: Allow fragmented email. Fragmented email
spamfsurl cannot be scanned for viruses.
spamhdrcheck • no-content-summary: Omit content information from
spamipbwl the dashboard.nto email, ftp, and http categories.
spamraddrdns • oversize: Block files that are over the file size limit.
spamrbl} • quarantine to enable quarantining files that contain
viruses. This feature is available for FortiGate units that
contain a hard disk.
• scan: Scan files for viruses and worms.
• spam-mail-log to include spam in mail log.
• spamemailbwlto enable filtering based on the email
address list.
• spamfschksum to enable the FortiGuard Antispam
email message checksum spam check.
• spamfsip to enable the FortiGuard Antispam filtering
IP address blacklist.
• spamfssubmit to add a link to the message body to
allow users to report messages incorrectly marked as
spam. If an email message is not spam, simply click the
link in the message to inform FortiGuard of the false
positive.
• spamfsurl to enable the FortiGuard Antispam filtering
URL blacklist.
• spamhdrcheck to enable filtering based on the MIME
header list.Enter spamipbwl to enable filtering based
on the email ip address.
• spamaddrdns to enable filtering based on the return
email DNS check.
• spamrbl to enable checking traffic against configured
DNS-based Blackhole List (DNSBL) and Open Relay
Database List (ORDBL) servers.
Separate multiple options with a space. To remove an
option from the list or add an option to the list, retype the
list with the option removed or added.

FortiGate CLI Version 3.0 MR6 Reference

126 01-30006-0015-20080205
firewall profile

Keywords and variables Description Default

imapoversizelimit Enter the maximum in-memory file size that will be 10
<size_int> scanned, in megabytes. If the file is larger than the
imapoversizelimit, the file is passed or blocked,
depending on whether oversize is set in the profile
imap command. The maximum file size for scanning in
memory is 10% of the FortiGate unit’s RAM.
Note: For email scanning, the oversize threshold refers to
the final size of the email after encoding by the email
client, including attachments. Email clients may use a
variety of encoding types and some encoding types
translate into larger file sizes than the original attachment.
The most common encoding, base64, translates 3 bytes
of binary data into 4 bytes of base64 data. So a file may
be blocked or logged as oversized even if the attachment
is several megabytes smaller than the configured
oversize threshold.
imap-spamaction Select the action that this profile uses for filtered IMAP tag
{pass | tag} email. Enter pass or tag.
• pass: Disable spam filtering for IMAP traffic.
• tag: Tag spam email with text configured using text set
in imap-spamtagmsg and the location set using
imap-spamtagtype.
imap-spamtagmsg Enter a word or phrase (tag) to affix to email identified as Spam
<message_str> spam.
When typing a tag, use the same language as the
FortiGate unit’s current administrator language setting.
Tag text using other encodings may not be accepted. For
example, when entering a spam tag that uses Japanese
characters, first verify that the administrator language
setting is Japanese; the FortiGate unit will not accept a
spam tag written in Japanese characters while the
administrator language setting is English. For details on
changing the language setting, see “system global” on
page 350.
Note: To correctly enter the tag, your SSH or telnet client
must also support your language’s encoding.
Alternatively, you can use the web-based manager’s CLI
widget to enter the tag.
Tags must not exceed 64 bytes. The number of
characters constituting 64 bytes of data varies by text
encoding, which may vary by the FortiGate administrator
language setting.
Tags containing space characters, such as multiple words
or phrases, must be surrounded by quote characters (‘)to
be accepted by the CLI.
imap-spamtagtype Select to affix the tag to either the MIME header or the subject
{header | subject} subject line, and whether or not to append spam spaminfo
{spaminfo | } information to the spam header, when an email is
detected as spam. Also configure imap-spamtagmsg.
If you select to affix the tag to the subject line, the
FortiGate unit will convert the entire subject line, including
tag, to UTF-8 by default. This improves display for some
email clients that cannot properly display subject lines
that use more than one encoding. For details on disabling
conversion of subject line to UTF-8, see “system settings”
on page 440.
imoversizelimit Enter the maximum in-memory file size that will be 10
<size_int> scanned, in megabytes. If the file is larger than the
imoversizelimit, the file is passed or blocked,
depending on whether oversize is set in the profile im
command. The maximum file size for scanning in memory
is 10% of the FortiGate unit’s RAM.
imoversizechat Enter the maximum allowed length of chat messages in 8192
<size_int> bytes, from 2048 to 65536.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 127
profile firewall

Keywords and variables Description Default

ips-sensor Enter the name of an IPS sensor (set of signatures). No default.
<name_str>
ips-sensor-status Select to use an IPS sensor. If enabled, also configure disable
{enable | disable} ips-sensor.
This option does not select denial of service (DoS)
sensors. For details on configuring DoS sensors, see “ips
DoS” on page 178.
kazaa Select the action the FortiGate unit performs on Kazaa pass
{block | pass | limit} peer-to-peer (P2P) traffic.
• block: Block Kazaa traffic.
• pass: Allow Kazaa traffic.
• limit: Restrict bandwidth used by Kazaa. Configure
kazaa-limit to specify the bandwidth limit.
This option is available only if p2p is enable.
kazaa-limit <limit_int> Enter the maximum amount of bandwidth Kazaa 0
connections are allowed to use, up to 100000 KB/s. If this
variable is set to zero (0), Kazaa traffic is not allowed.
This option appears only if kazaa is set to limit.
The bandwidth limit can be applied separately for each
firewall policy that uses the protection profile, or shared
by all firewall policies that use the protection profile. By
default, the limit is applied separately to each firewall
policy. For information on configuring per policy or per
protection profile P2P bandwidth limiting, see the p2p-
rate-limiting variable in “system settings” on
page 440.
log-antispam-mass-mms Select to log duplicate or flood MMS notification disable
{enable | disable} messages. Also select the log action for each
(FortiOS Carrier) protocol and bulk MMS message event that you
want to log. For details, see “action {archive block
intercept log}” on page 140 and “action {archive
block intercept log}” on page 140.
log-av-block Select to log file pattern or file type blocking. disable
{enable | disable}
log-av-msisdn-filter Select to log MSISDN blocking, intercepts, and archiving. disable
{enable | disable}
(FortiOS Carrier)
log-av-oversize Select to log oversize file and email blocking. disable
{enable | disable}
log-av-virus Select to log viruses detected. disable
{enable | disable}
log-im Select to log IM activity by profile. disable
{enable | disable}
log-intercept Select to log MMS intercept actions. disable
{enable | disable}
(FortiOS Carrier)
log-ips Select to log IPS events. disable
{enable | disable}
log-mms-notification Select to log MMS notification messages. disable
{enable | disable}
(FortiOS Carrier)
log-p2p Select to log P2P activity. disable
{enable | disable}
log-spam Select to log spam detected. disable
{enable | disable}

FortiGate CLI Version 3.0 MR6 Reference

128 01-30006-0015-20080205
firewall profile

Keywords and variables Description Default

log-voip Select to log VoIP activity. disable
{enable | disable}
log-voip-violations Select to log VoIP events. disable
{enable | disable}
log-web-content Select to log web content blocking. disable
{enable | disable}
log-web-filter-activex Select to log ActiveX plugin blocking. disable
{enable | disable}
log-web-filter-applet Select to log Java applet blocking. disable
{enable | disable}
log-web-filter-cookie Select to log cookie blocking. disable
{enable | disable}
log-web-ftgd-err Select to log FortiGuard rating errors. enable
{enable | disable}
log-web-url Select to log URL blocking. disable
{enable | disable}
mail-sig <signature_str> Enter a signature to add to outgoing email. If the signature No default.
contains spaces, surround it with single or double quotes
(‘ or “).
This option is applied only if mailsig-status is
enable.
mailsig-status Select to add a signature to outgoing email. Also disable
{enable | disable} configure mail-sig.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 129
profile firewall

Keywords and variables Description Default

mm1 {archive-full Select actions, if any, the FortiGate unit will take on MMS No default.
archive-summary messages of the specified protocol. (FortiOS Carrier)
avmonitor avquery • archive-full: Content archive both metadata and
bannedword the MMS message itself.
block • archive-summary: Content archive metadata.
chunkedbypass • avmonitor: Log detected viruses, but allow them
through the firewall without modification.
clientcomfort
• avquery: Use the FortiGuard Antivirus service for virus
exemptword detection using MD5 checksums.
filetype • bannedword: Block messages containing content in
msisdn-bwl the banned word list.
no-content-summary • block: Block messages matching the file patterns
oversize selected by mms-file-pat-table, even if the files do
quarantine not contain viruses.
scan server-comfort • chunkedbypass: Allow web sites that use chunked
encoding for HTTP to bypass the firewall. Chunked
strict-file} encoding means the HTTP message body is altered to
mm3 {archive-full allow it to be transferred in a series of chunks. Use of no-content-
archive-summary this feature is a risk. Malicious content could enter the summary
network if web content is allowed to bypass the firewall. splice
avmonitor avquery This option only available for the mm1 and mm7
bannedword commands.
block • clientcomfort: Apply client comforting to prevent
filetype client timeout. This option is available only for mm1 and
fragmail mm7.
msisdn-bwl • exemptword: Exempt words from content blocking.
This option only available for the mm1 and mm7
no-content-summary commands.
oversize • filetype: Block specific types of files even if the files
quarantine do not contain viruses. The file type table used is set
scan splice} with the mms-file-type-table command.
mm4 {archive-full • fragmail: Pass fragmented email messages. splice
Fragmented email messages cannot be scanned for
archive-summary viruses. This option only available for the mm3 and mm4
avmonitor avquery commands.
bannedword • msisdn-bwl: Block messages based on the MSISDN.
block The MSISDN filtering list used is set with the mms-
filetype msisdn-bwl-table command.
fragmail • no-content-summary: Omit MMS filtering statistics
from the dashboard.
msisdn-bwl
• oversize: Block files that are over the file size limit.
no-content-summary
• quarantine: Quarantine files that contain viruses.
oversize This feature is available for FortiGate units that contain
quarantine a hard disk or are connected to a FortiAnalyzer unit.
scan splice} • scan: Scan files for viruses and worms.
mm7 {archive-full • server-comfort: Apply server comforting and No default.
archive-summary prevent server timeout. This option is available only for
mm1 and mm7.
avmonitor avquery
• splice: Simultaneously scan a message and send it to
bannedword the recipient. If the FortiGate unit detects a virus, it
block prematurely terminates the connection and returns an
chunkedbypass error message to the recipient, listing the virus name
clientcomfort and infected file name. This option is available only for
mm3 and mm4.
exemptword
• strict-file: Perform stricter checking for blocked
filetype files as specified in config antivirus
msisdn-bwl filepattern. This can prevent circumvention by web
no-content-summary sites with elaborate scripting using .exe or .dll files if
oversize quarantine scan those patterns are blocked. This option is available only
server-comfort for mm1 and mm7.
strict-file}
(FortiOS Carrier)

FortiGate CLI Version 3.0 MR6 Reference

130 01-30006-0015-20080205
firewall profile

Keywords and variables Description Default

mm1-addr-hdr Enter the sender address (MSISDN) identifier. x-up-
<identifier_str> If mm1-addr-source is http-header, the address and calling-
(FortiOS Carrier) its identifier in the HTTP request header is in the format line-id
of:
<Sender Address Identifier>: <MSISDN
Value>
For example, the HTTP header might contain:
x-up-calling-line-id: 6044301297
where x-up-calling-line-id would be the Sender Address
Identifier.
If mm1-addr-source is cookie, the address and its
identifier in the HTTP request header’s Cookie field is in
the format of attribute-value pairs:
Cookie: id=<cookie-id>;
<Sender Address Identifier>=<MSISDN Value>
For example, the HTTP request headers might contain:
Cookie: id=0123jf!a;x-up-calling-line-
id=6044301297
where x-up-calling-line-id would be the sender
address identifier.
mm1-addr-source {cookie Select to extract the sender’s address from the HTTP http-header
| http-header} header field or a cookie.
(FortiOS Carrier)
mm1-convert-hex {enable Select to convert the sender address from ASCII to disable
| disable} hexadecimal or from hexadecimal to ASCII. This is
(FortiOS Carrier) required by some applications.

mm1-retr-dupe {enable | Select to scan MM1 mm1-retr messages for duplicates. disable
disable} By default, mm1-retr messages are not scanned for
(FortiOS Carrier) duplicates as they may often be the same without
necessarily being bulk or spam.
This option is available only if status is enable for the
config dupe mm1 command.
mm1comfortamount Enter the number of bytes client comforting sends each 1
<size_int> interval to show a download is progressing.
(FortiOS Carrier) The interval time is set using mm1comfortinterval.
mm1comfortinterval Enter the time in seconds before client comforting starts 10
<seconds_int> after a download has begun. It is also the interval
(FortiOS Carrier) between subsequent client comforting sends.
The amount of data sent each interval is set using
mm1comfortamount.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 131
profile firewall

Keywords and variables Description Default

mm7-addr-hdr Enter the sender address (MSISDN) identifier. x-up-
<identifier_str> If mm7-addr-source is http-header, the address and calling-
(FortiOS Carrier) its identifier in the HTTP request header is in the format line-id
of:
<Sender Address Identifier>: <MSISDN
Value>
For example, the HTTP header might contain:
x-up-calling-line-id: 6044301297
where x-up-calling-line-id would be the Sender Address
Identifier.
If mm7-addr-source is cookie, the address and its
identifier in the HTTP request header’s Cookie field is in
the format of attribute-value pairs:
Cookie: id=<cookie-id>;
<Sender Address Identifier>=<MSISDN Value>
For example, the HTTP request headers might contain:
Cookie: id=0123jf!a;x-up-calling-line-
id=6044301297
where x-up-calling-line-id would be the sender
address identifier.
mm7-addr-source {cookie Select to extract the sender’s address from the HTTP http-header
| http-header} header field or a cookie.
(FortiOS Carrier)
mm7-convert-hex {enable Select to convert the sender address from ASCII to disable
| disable} hexadecimal or from hexadecimal to ASCII. This is
(FortiOS Carrier) required by some applications.

mm7comfortamount Enter the number of bytes client comforting sends each 1

<size_int> interval to show a download is progressing.
(FortiOS Carrier) The interval time is set using mm7comfortinterval.
mm7comfortinterval Enter the time in seconds before client comforting starts 10
<seconds_int> after a download has begun. It is also the interval
(FortiOS Carrier) between subsequent client comforting sends.
The amount of data sent each interval is set using
mm7comfortamount.
mms-bword-table Enter the ID number of the web content block filter to be No default.
<index_int> used for MMS traffic.
(FortiOS Carrier) The web content block tables can be configured using the
config webfilter bword command.
mms-bword-threshold Enter the maximum score an MMS message can have 10
(FortiOS Carrier) before being blocked. If the combined scores of the
content block patterns appearing in an MMS message
exceed the threshold value, the message will be blocked.
mms-exmword-table Enter the ID number of the webfilter exempt word list to No default.
(FortiOS Carrier) be used with the protection profile.
The web content exempt tables can be configured using
the config webfilter exmword command.
mms-file-pat-table Enter the ID number of the file pattern list to be used for No default.
<index_int> MMS traffic with the protection profile.
(FortiOS Carrier) This variable appears only on FortiGate-800 and above
units.
mms-file-type-table Enter the ID number of the file type list to be used for No default.
<index_int> MMS traffic with the protection profile.
(FortiOS Carrier) In the web-based manager, both the file pattern and file
type filters and configured and enabled together, with the
File Filter controls. In the CLI, the file pattern and file type
filters are separately adjustable, and each can use
different tables.

FortiGate CLI Version 3.0 MR6 Reference

132 01-30006-0015-20080205
firewall profile

Keywords and variables Description Default

mms-msisdn-bwl-table Enter the ID number of the MSISDN filtering table to use No default.
<index_int> for MMS traffic with the protection profile.
(FortiOS Carrier)
msisdn-prefix {enable | Select to add the country code to the extracted MSISDN disable
disable} for logging and notification purposes. You can limit the
(FortiOS Carrier) number length for the test numbers used for internal
monitoring without a country code.
msisdn-prefix-string Enter the MSISDN prefix. No default.
(FortiOS Carrier) This option appears only if msisdn-prefix is enable.
msisdn-prefix-range-min Enter the minimum length. If this and msisdn-prefix- 0
(FortiOS Carrier) range-max are set to zero (0), length is not limited.
This option appears only if msisdn-prefix is enable.
msisdn-prefix-range-max Enter the maximum length. If this and msisdn-prefix- 0
(FortiOS Carrier) range-min are set to zero (0), length is not limited.
This option appears only if msisdn-prefix is enable.
msn {enable-inspect | } Enter enable-inspect to enable inspection of No default.
{archive-full archive- Microsoft Messenger traffic, then enter additional options,
summary block-audio if any.
block-file block-im • archive-full: Content archive both metadata and
the chat itself.
block-photo no-content-
• archive-summary: Content archive metadata.
summary}
• block-audio: Block audio content.
• block-file: Block file transfers.
• block-im: Block instant messages.
• block-photo: Block photo sharing.
• no-content-summary: Omit content information from
the dashboard.
nntp {archive-full Select actions, if any, the FortiGate unit will perform with No default.
archive-summary NNTP connections.
avmonitor avquery block • archive-full: Content archive both metadata and
filetype the mail itself.
no-content-summary • archive-summary: Content archive metadata.
oversize scan spam-mail- • avmonitor: Log detected viruses, but allow them
through the firewall without modification.
log }
• avquery: Use the FortiGuard Antivirus query service.
• block: Deny files matching the file pattern selected by
filepattable (not in FortiOS Carrier) or file-pat-
table (FortiOS Carrier), even if the files do not contain
viruses.
• filetype: Block specific types of files even if the files
do not contain viruses. The file type table used is set
with the file-type-table command. (FortiOS
Carrier)
• no-content-summary: Omit content information from
the dashboard.
• oversize: Block files that are over the file size limit.
• scan: Scan files for viruses and worms.
• spam-mail-log: Include spam in the mail log.
Separate multiple options with a space. To remove an
option from the list or add an option to the list, retype the
list with the option removed or added.
nntpoversizelimit Enter the maximum in-memory file size that will be 10
<limit_int> scanned, in megabytes. If the file is larger than the
ntpoversizelimit, the file is passed or blocked,
depending on whether oversize is set in the profile
nntp command. The maximum file size for scanning in
memory is 10% of the FortiGate unit’s RAM.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 133
profile firewall

Keywords and variables Description Default

p2p {enable | disable} Select to inspect peer-to-peer (P2P) traffic. If disabled, disable
P2P traffic passing through the FortiGate unit will not
receive inspection or statistics tracking.
pop3 Select actions, if any, the FortiGate unit will perform with fragmail
{archive-full archive- POP3 connections. spamfssubmit
summary avmonitor • archive-full: Content archive both metadata and
avquery bannedword block the email itself.
filetype fragmail • archive-summary: Content archive metadata.
no-content-summary • avmonitor: Log detected viruses, but allow them
through the firewall without modification.
oversize quarantine scan
• avquery: Use the FortiGuard Antivirus query service.
spam-mail-log
• bannedword: Block email containing content in the
spamemailbwl banned word list.
spamfschksum spamfsip • block: Deny files matching the file pattern selected by
spamfssubmit spamfsurl filepattable (not in FortiOS Carrier) or file-pat-
spamhdrcheck spamipbwl table (FortiOS Carrier), even if the files do not contain
spamraddrdns spamrbl} viruses.
• filetype: Block specific types of files even if the files
do not contain viruses. The file type table used is set
with the file-type-table command. (FortiOS
Carrier)
• fragmail: Allow fragmented email. Fragmented email
cannot be scanned for viruses.
• no-content-summary: Omit content information from
the dashboard.nto email, FTP, and HTTP categories.
• oversize: Block files that are over the file size limit.
• quarantine: Quarantine files that contain viruses.
This feature is available for FortiGate units that contain
a hard disk or a connection to a FortiAnalyzer unit.
• scan: Scan files for viruses and worms.
• spam-mail-log: Include spam in the email log.
• spamemailbwl: Block email containing addresses in
the email address list.
• spamfschksum: Use FortiGuard Antispam email
message checksum spam checking.
• spamfsip: Use the FortiGuard Antispam IP address
blacklist.
• spamfssubmit: Add a link to the message body to
allow users to report messages incorrectly marked as
spam. If an email message is not spam, click the link in
the message to inform FortiGuard of the false positive.
• spamfsurl: Use the FortiGuard Antispam URL
blacklist.
• spamhdrcheck: Filter email using the MIME header
list.
• spamipbwl: Filter email using the email IP address.
• spamaddrdns: Filter email using the return email DNS
check.
• spamrbl: Filter email using the configured DNS-based
Blackhole List (DNSBL) and Open Relay Database List
(ORDBL) servers.
Separate multiple options with a space. To remove an
option from the list or add an option to the list, retype the
list with the option removed or added.

FortiGate CLI Version 3.0 MR6 Reference

134 01-30006-0015-20080205
firewall profile

Keywords and variables Description Default

pop3oversizelimit Enter the maximum in-memory file size that will be 10
<size_int> scanned, in megabytes. If the file is larger than the
pop3oversizelimit, the file is passed or blocked,
depending on whether oversize is set in the profile
pop3 command. The maximum file size for scanning in
memory is 10% of the FortiGate unit’s RAM.
Note: For email scanning, the oversize threshold refers to
the final size of the email after encoding by the email
client, including attachments. Email clients may use a
variety of encoding types and some encoding types
translate into larger file sizes than the original attachment.
The most common encoding, base64, translates 3 bytes
of binary data into 4 bytes of base64 data. So a file may
be blocked or logged as oversized even if the attachment
is several megabytes smaller than the configured
oversize threshold.
pop3-spamaction Select the action to perform on POP3 email that is tag
{pass | tag} detected as spam.
• pass: Disable spam filtering for POP3 traffic.
• tag: Tag spam email with text configured using the
pop3-spamtagmsg keyword and the location set using
the pop3-spamtagtype keyword.
pop3-spamtagmsg Enter a word or phrase (tag) to affix to email identified as Spam
<message_str> spam.
When typing a tag, use the same language as the
FortiGate unit’s current administrator language setting.
Tag text using other encodings may not be accepted. For
example, when entering a spam tag that uses Japanese
characters, first verify that the administrator language
setting is Japanese; the FortiGate unit will not accept a
spam tag written in Japanese characters while the
administrator language setting is English. For details on
changing the language setting, see “system global” on
page 350.
Note: To correctly enter the tag, your SSH or telnet client
must also support your language’s encoding.
Alternatively, you can use the web-based manager’s CLI
widget to enter the tag.
Tags must not exceed 64 bytes. The number of
characters constituting 64 bytes of data varies by text
encoding, which may vary by the FortiGate administrator
language setting.
Tags containing space characters, such as multiple words
or phrases, must be surrounded by quote characters (‘)to
be accepted by the CLI.
pop3-spamtagtype Select to affix the tag to either the MIME header or the subject
{header | subject} subject line, and whether or not to append spam spaminfo
{spaminfo | } information to the spam header, when an email is
detected as spam. Also configure pop3-spamtagmsg.
If you select to affix the tag to the subject line, the
FortiGate unit will convert the entire subject line, including
tag, to UTF-8 by default. This improves display for some
email clients that cannot properly display subject lines
that use more than one encoding. For details on disabling
conversion of subject line to UTF-8, see “system settings”
on page 440.
replacemsg-group Enter the name of the replacement message group to be No default.
<name_str> used with this protection profile.
(FortiOS Carrier)

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 135
profile firewall

Keywords and variables Description Default

skype Select the action the FortiGate unit performs on Skype pass
{block | pass} peer-to-peer (P2P) traffic.
• block: Block Skype traffic.
• pass: Allow Skype traffic.
This option is available only if p2p is enable.
smtp Select actions, if any, the FortiGate unit will perform with no-content-
{archive-full archive- SMTP connections. summary
summery avmonitor • archive-full: Content archive both metadata and splice
avquery bannedword block the email itself.
filetype fragmail • archive-summary: Content archive metadata.
no-content-summary • avmonitor: Log detected viruses, but allow them
through the firewall without modification.
oversize quarantine scan
• avquery: Use the FortiGuard AV query service.
spam-mail-log
• bannedword: Block email containing content in the
spamemailbwl spamfsip banned word list.
spamfschksum spamfsurl • block: Deny files matching the file pattern selected by
spamhdrcheck spamhelodns filepattable (not in FortiOS Carrier) or file-pat-
spamipbwl spamraddrdns table (FortiOS Carrier), even if the files do not contain
spamrbl splice} viruses.
• filetype: Block specific types of files even if the files
do not contain viruses. The file type table used is set
with the file-type-table command. (FortiOS
Carrier)
• fragmail: Allow fragmented email. Fragmented email
cannot be scanned for viruses.
• no-content-summary: Omit content information from
the dashboard.
• oversize: Block files that are over the file size limit.
• quarantine: Quarantine files that contain viruses.
This feature is available for FortiGate units that contain
a hard disk or a connection to a FortiAnalyzer unit.
• scan: Scan files for viruses and worms.
• spam-mail-log: Include spam in the email log.
• spamemailbwl: Filter email using the email address
list.
• spamfsip: Use the FortiGuard Antispam filtering IP
address blacklist.
• spamfschksum: Use FortiGuard Antispam email
message checksum spam checking.
• spamfssubmit: Add a link to the message body
allowing users to report messages incorrectly marked
as spam. If an email message is not spam, click the link
in the message to report the false positive.
• spamfsurl: Use the FortiGuard Antispam filtering URL
blacklist.
• spamhdrcheck: Filter email using the MIME header
list.
• spamhelodns: Filter email using an HELO/EHLO DNS
check.
• spamipbwl: Filter email using the source IP or subnet
address.
• spamaddrdns: Filter email using a return email DNS
check.
• spamrbl: Filter email using configured DNS-based
Blackhole List (DNSBL) and Open Relay Database List
(ORDBL) servers.

FortiGate CLI Version 3.0 MR6 Reference

136 01-30006-0015-20080205
firewall profile

Keywords and variables Description Default

smtp (continued) • splice: Simultaneously scan a message and send it to
the recipient. If the FortiGate unit detects a virus, it
prematurely terminates the connection, and returns an
error message to the sender, listing the virus and
infected file name. splice is selected when scan is
selected. With streaming mode enabled, select either
Spam Action (Tagged or Discard) for SMTP spam.
When streaming mode is disabled for SMTP, infected
attachments are removed and the email is forwarded
(without the attachment) to the SMTP server for delivery
to the recipient.
Throughput is higher when streaming mode is enabled.
Separate multiple options with a space. To remove an
option from the list or add an option to the list, retype the
list with the option removed or added.
smtp-spam-localoverride Select to override SMTP remote check, which includes IP disable
{enable | disable} RBL check, IP FortiGuard antispam check, and HELO
DNS check, with the locally defined black/white antispam
list.
smtpoversizelimit Enter the maximum in-memory file size that will be 10
<size_int> scanned, in megabytes. If the file is larger than the
smtpoversizelimit, the file is passed or blocked,
depending on whether oversize is set in the profile
smtp command. The maximum file size for scanning in
memory is 10% of the FortiGate unit’s RAM.
Note: For email scanning, the oversize threshold refers to
the final size of the email after encoding by the email
client, including attachments. Email clients may use a
variety of encoding types and some encoding types
translate into larger file sizes than the original attachment.
The most common encoding, base64, translates 3 bytes
of binary data into 4 bytes of base64 data. So a file may
be blocked or logged as oversized even if the attachment
is several megabytes smaller than the configured
oversize threshold.
smtp-spamaction Select the action that this profile uses for filtered SMTP discard
{discard | pass | tag} email. Tagging appends custom text to the subject or
header of email identified as spam. When scan or
streaming mode (also called splice) is selected, the
FortiGate unit can only discard spam email. Discard
immediately drops the connection. Without streaming
mode or scanning enabled, chose to discard, pass, or tag
SMTP spam. In the US Domestic distribution, streaming
mode is permanently enabled for SMTP, and the tag
option is not available.
• discard: Do not pass email identified as spam.
• pass: Disable spam filtering for SMTP traffic.
• tag: Tag spam email with text configured using the
smtp-spamtagmsg keyword and the location set using
the smtp-spamtagtype keyword.
smtp-spamhdrip Select to check header IP addresses for spamfsip, disable
{enable | disable} spamrbl, and spamipbwl filters.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 137
profile firewall

Keywords and variables Description Default

smtp-spamtagmsg Enter a word or phrase (tag) to affix to email identified as Spam
<message_str> spam.
When typing a tag, use the same language as the
FortiGate unit’s current administrator language setting.
Tag text using other encodings may not be accepted. For
example, when entering a spam tag that uses Japanese
characters, first verify that the administrator language
setting is Japanese; the FortiGate unit will not accept a
spam tag written in Japanese characters while the
administrator language setting is English. For details on
changing the language setting, see “system global” on
page 350.
Note: To correctly enter the tag, your SSH or telnet client
must also support your language’s encoding.
Alternatively, you can use the web-based manager’s CLI
widget to enter the tag.
Tags must not exceed 64 bytes. The number of
characters constituting 64 bytes of data varies by text
encoding, which may vary by the FortiGate administrator
language setting.
Tags containing space characters, such as multiple words
or phrases, must be surrounded by quote characters (‘)to
be accepted by the CLI.
smtp-spamtagtype Select to affix the tag to either the MIME header or the subject
{header | subject} subject line, and whether or not to append spam spaminfo
{spaminfo | } information to the spam header, when an email is
detected as spam. Also configure smtp-spamtagmsg.
If you select to affix the tag to the subject line, the
FortiGate unit will convert the entire subject line, including
tag, to UTF-8 by default. This improves display for some
email clients that cannot properly display subject lines
that use more than one encoding. For details on disabling
conversion of subject line to UTF-8, see “system settings”
on page 440.
spambwordtable Enter the ID number of the spamfilter banned word list to 0
<index_int> be used with the protection profile.
This variable appears only on FortiGate-800 and above
units.
spamemaddrtable Enter the ID number of the spamfilter email address list to 0
<index_int> be used with the protection profile.
This variable appears only on FortiGate-800 and above
units.
spamipbwltable Enter the ID number of the spamfilter IP address 0
<index_int> black/white list to be used with the protection profile.
This variable appears only on FortiGate-800 and above
units.
spamiptrusttable Enter the ID number of the spamfilter IP trust list to be 0
<index_int> used with the protection profile.
This variable only appears on FortiGate-800 models and
greater.
spammheadertable Enter the ID number of the spamfilter MIME header list to 0
<index_int> be used with the protection profile.
This variable only appears on FortiGate-800 models and
greater.
spamrbltable <index_int> Enter the ID number of the spamfilter DNSBL list to be 0
used with the protection profile.
This variable only appears on FortiGate-800 models and
greater.

FortiGate CLI Version 3.0 MR6 Reference

138 01-30006-0015-20080205
firewall profile

Keywords and variables Description Default

spambwordthreshold If the combined scores of the banned word patterns 10
<value_int> appearing in an email message exceed the threshold
value, the message will be processed according to the
Spam Action setting.
webbwordtable Enter the ID number of the webfilter banned word list to 0
<index_int> be used with the protection profile.
(not in FortiOS Carrier) This variable only appears on FortiGate-800 models and
greater.
web-bword-table Enter the ID number of the webfilter banned word list to No default.
<index_int> be used with the protection profile.
(FortiOS Carrier) This variable only appears on FortiGate-800 models and
greater.
webbwordthreshold Enter the maximum score a web page can have before 10
<value_int> being blocked. If the combined scores of the content
(not in FortiOS Carrier) block patterns appearing on a web page exceed the
threshold value, the page will be blocked.
web-bword-threshold Enter the maximum score a web page can have before 10
<value_int> being blocked. If the combined scores of the content
(FortiOS Carrier) block patterns appearing on a web page exceed the
threshold value, the page will be blocked.
webexmwordtable Enter the ID number of the webfilter exempt word list to 0
<index_int> be used with the protection profile.
(not in FortiOS Carrier) This variable only appears on FortiGate-800 models and
greater.
web-exmword-table Enter the ID number of the webfilter exempt word list to No default.
<index_int> be used with the protection profile.
(FortiOS Carrier) This variable only appears on FortiGate-800 models and
greater.
weburlfiltertable Enter the ID number of the webfilter URL filter list to be 0
<index_int> used with the protection profile.
This variable appears only on FortiGate-800 models and
greater.
winny Select the action the FortiGate unit performs on WinNY pass
{block | pass | limit} peer-to-peer (P2P) traffic.
• block: Block WinNY traffic.
• pass: Allow WinNY traffic.
• limit: Restrict bandwidth used by WinNY. Configure
winny-limit to specify the bandwidth limit.
This option is available only if p2p is enable.
winny-limit <limit_int> Enter the maximum amount of bandwidth WinNY 0
connections are allowed to use, up to 100000 KB/s. If this
variable is set to zero (0), WinNY traffic is not allowed.
This option appears only if winny is set to limit.
The bandwidth limit can be applied separately for each
firewall policy that uses the protection profile, or shared
by all firewall policies that use the protection profile. By
default, the limit is applied separately to each firewall
policy. For information on configuring per policy or per
protection profile P2P bandwidth limiting, see the p2p-
rate-limiting variable in “system settings” on
page 440.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 139
profile firewall

Keywords and variables Description Default

yahoo Enter enable-inspect to enable inspection of Yahoo inspect-
{enable-inspect | } Messenger traffic, then enter any additional options. anyport
{archive-full archive- Separate multiple options with a space.
summary block-audio • archive-full: Content archive both metadata and
the chat itself.
block-file block-im
• archive-summary: Content archive metadata.
block-photo
• block-audio: Block audio content.
inspect-anyport no-
• block-file: Block file transfers.
content-summary}
• block-im: Block instant messages.
• block-photo: Block photo sharing.
• inspect-anyport: Inspect traffic on any port that is
not used by a FortiGate proxy.
• no-content-summary: Omit content information from
the dashboard.
dupe
The following commands are the options for config dupe.
(FortiOS Carrier)
{mm1 | mm4} Select to configure detection of excessive MMS message No default.
duplicates for the MM1 or MM4 protocol.
status {enable | Select to detect and act upon duplicate MMS messages. disable
disable}
(FortiOS Carrier)
action {archive block Select which actions to take, if any, when excessive archive
intercept log} duplicate messages are detected. To select more than block
(FortiOS Carrier) one action, separate each action with a space. intercept
• archive: Content archive excessive duplicates. log
• block: Block and intercept excess duplicates. If block
is selected, messages are also intercepted, even if
intercept is not selected.
• intercept: Intercept excess duplicates.
• log: Log excess duplicates. This option takes effect
only if logging is enabled for bulk MMS message
detection. See “log-antispam-mass-mms {enable |
disable}” on page 128.
This option appears only if status is enable for the
MMS protocol.
block-time <minutes_int> Enter the amount of time in minutes during which the 100
(FortiOS Carrier) FortiGate unit will perform the action after a message
flood is detected.
This option appears only if status is enable for the
MMS protocol.
limit Enter the number of messages which signifies excessive 100
<duplicatetrigger_int> message duplicates if exceeded within the window.
(FortiOS Carrier) This option appears only if status is enable for the
MMS protocol.
window <minutes_int> Enter the period of time in minutes during which 60
(FortiOS Carrier) excessive message duplicates will be detected if the
limit is exceeded.
This option appears only if status is enable for the
protocol (MM1 or MM4).
protocol The MMS protocol to which excessive MMS message Varies by “{mm1
(FortiOS Carrier) duplicate detection will be applied. | mm4}” on
This variable can be viewed with the get command, but page 140.
cannot be set.

FortiGate CLI Version 3.0 MR6 Reference

140 01-30006-0015-20080205
firewall profile

Keywords and variables Description Default

flood
The following commands are the options for config flood.
(FortiOS Carrier)
status Select to detect and act upon excessive MMS message disable
{enable | disable} activity.
(FortiOS Carrier)
{mm1 | mm4} Select to configure detection of excessive MMS message No default.
activity for the MM1 or MM4 protocol.
status Select to detect and act upon excessive MMS message disable
{enable | disable} activity.
(FortiOS Carrier)
action Select which actions to take, if any, when excessive archive
{archive block intercept message activity is detected. To select more than one block
log} action, separate each action with a space. intercept
• archive: Content archive excessive messages. log
(FortiOS Carrier)
• block: Block and intercept excess messages. If block
is selected, messages are also intercepted, even if
intercept is not selected.
• intercept: Intercept excess messages.
• log: Log excess messages. This option takes effect
only if logging is enabled for bulk MMS message
detection. See “log-antispam-mass-mms {enable |
disable}” on page 128.
This option appears only if status is enable for the
MMS protocol.
block-time <minutes_int> Enter the amount of time in minutes during which the 100
(FortiOS Carrier) FortiGate unit will perform the action after a message
flood is detected.
This option appears only if status is enable for the
MMS protocol.
limit <floodtrigger_int> Enter the number of messages which signifies excessive 100
(FortiOS Carrier) message activity if exceeded within the window.
This option appears only if status is enable for the
MMS protocol.
window <minutes_int> Enter the period of time in minutes during which 60
(FortiOS Carrier) excessive message activity will be detected if the limit
is exceeded.
This option appears only if status is enable for the
MMS protocol.
protocol The MMS protocol to which excessive MMS message Varies by “{mm1
(FortiOS Carrier) activity detection will be applied. | mm4}” on
This variable can be viewed with the get command, but page 141.
cannot be set.
notification
The following commands are the options for config notification.
(FortiOS Carrier)
{mm1 | mm3 | mm4 | mm7} Select to which MMS interfaces notification will apply. No default.
(FortiOS Carrier)
bword-int Enter the banned word notification send interval. 24
<noticeinterval_int>
(FortiOS Carrier)
bword-int-mode Select whether the value specified in the bword-int hours
{minutes | hours} command is minutes or hours.
(FortiOS Carrier)

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 141
profile firewall

Keywords and variables Description Default

bword-status Select to send notices for banned word events. disable
{enable | disable}
(FortiOS Carrier)
detect-server Select to automatically determine the server address. enable
{enable | disable}
(FortiOS Carrier)
dupe-int <interval_int> Enter the amount of time between notifications of 24
(FortiOS Carrier) excessive MMS duplicates. Also set dupe-status to
enable and select the time unit in dupe-int-mode.
dupe-int-mode Select the unit of time in minutes or hours for dupe-int. hours
{hours | minutes}
(FortiOS Carrier)
dupe-status Select to send notices for excessive MMS message disable
(FortiOS Carrier) duplicate events.
file-block-int Enter the amount of time between notifications of file 24
<noticeinterval_int> block events. Also set file-block-status to enable
(FortiOS Carrier) and select the time unit in file-block-int-mode.

file-block-int-mode Select whether the value specified in the hours

{hours | minutes} file-block-int command is minutes or hours.
(FortiOS Carrier)
file-block-status Select to send notices for file block events. disable
{enable | disable}
flood-int <interval_int> Enter the amount of time between notifications of 24
(FortiOS Carrier) excessive MMS activity. Also set flood-status to
enable and select the time unit in flood-int-mode.
flood-int-mode Select the unit of time in minutes or hours for flood- hours
{hours | minutes} int.
(FortiOS Carrier)
flood-status Select to send notices for excessive MMS message disable
(FortiOS Carrier) activity events.
from-in-header Select to insert the “from” address in the HTTP header. disable
{enable | disable}
(FortiOS Carrier)
mmsc-hostname Enter the FQDN or the IP address of the destination No default.
(FortiOS Carrier) server.
mmsc-password Enter the password required for sending messages using No default.
<passwd_str> this server. (Optional)
(FortiOS Carrier)
mmsc-port Enter the port number the server is using. Varies by msg-
(FortiOS Carrier) protocol.
mmsc-url Enter the URL address of the server. No default.
(FortiOS Carrier)
mmsc-username <user_str> Enter the user-name required for sending messages No default.
(FortiOS Carrier) using this server. (Optional)
msg-protocol Select the protocol to use for sending notification Default varies
{mm1 | mm3 | mm4 | mm7} messages. by config
(FortiOS Carrier) notification
{mm1 | mm3 |
mm4 | mm7}.
msg-type Select the type of notification message directed to either a deliver-req
{deliver-req | send-req} VASP or a MMSC.
(FortiOS Carrier)

FortiGate CLI Version 3.0 MR6 Reference

142 01-30006-0015-20080205
firewall profile

Keywords and variables Description Default

msisdn-bwl-int Enter the amount of time between notifications for 24
<interval_int> MSISDN black/white list events. Also set msisdn-bwl-
(FortiOS Carrier) status to enable and select the time unit in msisdn-
bwl-int-mode.
msisdn-bwl-int-mode Select the unit of time in minutes or hours for msisdn- hours
{hours | minutes} bwl-int.
(FortiOS Carrier)
msisdn-bwl-status Select to send notices for MSISDN black/white list events. disable
{enable | disable}
(FortiOS Carrier)
rate-limit <limit_int> Enter the number of notifications to send per second. If 0
(FortiOS Carrier) you enter zero (0), the notification rate is not limited.
tod-window-start Select the time of day to begin sending notifications. If 00:00
<window_time> you select a start and end time of zero (00:00),
(FortiOS Carrier) notifications are not limited by time of day.

tod-window-end Select the time of day to stop sending notifications. If you 00:00
<window_time> select a start and end time of zero (00:00), notifications
(FortiOS Carrier) are not limited by time of day.

vas-id <vas_str> Enter the value added service (VAS) ID to be used when No default.
(FortiOS Carrier) sending a notification message.
vasp-id <vasp_str> Enter the value added service provider (VASP) ID to be No default.
(FortiOS Carrier) used when sending a notification message.
virus-int <interval_int> Enter the amount of time between notifications for 24
(FortiOS Carrier) antivirus events. Also set virus-status to enable and
select the time unit in virus-int-mode.
virus-int-mode Select the unit of time in minutes or hours for virus- hours
{hours | minutes} int.
(FortiOS Carrier)
virus-status Select to send notices for antivirus events. disable
{enable | disable}
(FortiOS Carrier)
sccp
The following commands are the options for config sccp.
status Select to inspect SCCP traffic. Other SCCP inspection disable
{enable | disable} options become available if this option is set to enable.
archive-summary Select to content archive call metadata. disable
{enable | disable} This option appears only if status is enable.
block-mcast Select to block multicast RTP connections. disable
{enable | disable} This option appears only if status is enable.
max-calls <limit_int> Enter the maximum calls per minute per SCCP client 0
(max 65535).
This option appears only if status is enable.
no-content-summary Select to omit monitoring of content information from disable
{enable | disable} dashboard.
This option appears only if status is enable.
verify-header Select to verify SCCP header content. disable
{enable | disable} This option appears only if status is enable.
simple
The following commands are the options for config simple.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 143
profile firewall

Keywords and variables Description Default

status Select to inspect SIMPLE traffic. Other SIMPLE disable
{enable | disable} inspection options become available if this option is set to
enable.
archive-full Select to content archive full contents of chat messages. disable
{enable | disable}
archive-summary Select to content archive summary information for chat disable
{enable | disable} messages.
block-message Select to block SIMPLE instant messages. disable
{enable | disable}
message-rate <limit_int> Enter the MESSAGE request rate limit per second, per 0
policy.
sip
The following commands are the options for config sip.
status Select to inspect SIP traffic. Other SIP inspection options disable
{enable | disable} become available if this option is set to enable.
ack-rate <rate_int> Enter the ACK rate limit per second, per policy. 0
This option appears only if status is enable.
archive-summary Select to content archive call metadata. disable
{enable | disable} This option appears only if status is enable.
block-ack Select to block ACK requests. disable
{enable | disable} This option appears only if status is enable.
block-bye Select to block BYE requests. disable
{enable | disable} This option appears only if status is enable.
block-cancel Select to block CANCEL requests. disable
{enable | disable} This option appears only if status is enable.
block-info Select to block INFO requests. disable
{enable | disable} This option appears only if status is enable.
block-invite Select to block INVITE requests. disable
{enable | disable} This option appears only if status is enable.
block-long-lines Select to block requests with headers exceeding max- enable
{enable | disable} line-length.
This option appears only if status is enable.
block-notify Select to block NOTIFY requests. disable
{enable | disable} This option appears only if status is enable.
block-options Select to block OPTIONS requests. disable
{enable | disable} This option appears only if status is enable.
block-prack Select to block prack requests. disable
{enable | disable} This option appears only if status is enable.
block-publish Select to block PUBLISH requests. disable
{enable | disable} This option appears only if status is enable.
block-refer Select to block REFER requests. disable
{enable | disable} This option appears only if status is enable.
block-register Select to block REGISTER requests. disable
{enable | disable} This option appears only if status is enable.
block-subscribe Select to block SUBSCRIBE requests. disable
{enable | disable} This option appears only if status is enable.
block-unknown Select to block unrecognized SIP requests. enable
{enable | disable} This option appears only if status is enable.

FortiGate CLI Version 3.0 MR6 Reference

144 01-30006-0015-20080205
firewall profile

Keywords and variables Description Default

block-update Select to block UPDATE requests. disable
{enable | disable} This option appears only if status is enable.
call-keepalive Enter the number of minutes to continue tracking calls 0
<limit_int> with no RTP.
This option appears only if status is enable.
info-rate <rate_int> Enter the INFO rate limit per second, per policy. 0
This option appears only if status is enable.
invite-rate <limit_int> Enter the INVITE request rate limit per second, per policy. 0
This option appears only if status is enable.
max-dialogs <limit_int> Enter the maximum number of concurrent calls. 0
This option appears only if status is enable.
max-line-length Enter the maximum SIP header line length (78-4096). 998
<limit_int> This option appears only if status is enable.
no-sdp-fixup Select to preserve the SDP packet. disable
{enable | disable} This option appears only if status is enable.
notify-rate <limit_int> Enter the NOTIFY rate limit per second, per policy. 0
This option appears only if status is enable.
options-rate <limit_int> Enter the OPTIONS rate limit per second, per policy. 0
This option appears only if status is enable.
prack-rate <limit_int> Enter the PRACK rate limit per second, per policy. 0
This option appears only if status is enable.
preserve-override Select to omit the original IP address from SDP i line. disable
{enable | disable} When disabled, IP addresses are appended.
This option appears only if status is enable.
primary-secondary Select to monitor primary/secondary outbound proxy disable
{enable | disable} redundancy.
This option appears only if status is enable.
refer-rate <limit_int> Enter the REFER rate limit per second, per policy. 0
This option appears only if status is enable.
register-rate Enter the REGISTER request rate limit (per second, per 0
<limit_int> policy).
This option appears only if status is enable.
rtp {enable | disable} Select for RTP NAT traversal. enable
This option appears only if status is enable.
strict-register Select to allow only the registrar to connect. disable
{enable | disable} This option appears only if status is enable.
subscribe-rate Enter the SUBSCRIBE rate limit per second, per policy. 0
<limit_int> This option appears only if status is enable.
timeout-buffer Enter the maximum number of timed out calls to buffer. 0
<calls_int> This option appears only if status is enable.
update-rate <limit_int> Enter the UPDATE rate limit per second, per policy. 0
This option appears only if status is enable.

Example
This example shows how to:
• create a profile called spammail
• enable filtering of email according to the email banned word list, the MIME header list, and the
return DNS check, enable spam to be logged and tagged with the tag “Spam” in the subject for
POP3 traffic

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 145
profile firewall

• enable filtering of email based on the DNSBL server, and discard messages identified as spam for
SMTP traffic
config firewall profile
edit spammail
set pop3 spamemailbwl spamhdrcheck spamraddrdns
set pop3-spamaction log tag
set pop3-spamtagmsg Spam
set pop3-spamtagtype subject
set smtp spamrbl
set smtp-spamaction discard
end
This example shows how to:
• add HTTP category blocking to the spammail profile created above
• configure category blocking to deny access to web pages categorized as Games (20),
Personals and Dating (37), Shopping and Auction (42) and the category group Objectionable or
Controversial (g02)
• configure category monitoring to log access to web pages categorized as Computer Security
(50) and the category group Potentially Bandwidth Consuming (g04)
config firewall profile
edit spammail
set ftgd-wf-deny 20 37 42 g02
set ftgd-wf-log 50 g04
end

History

FortiOS v2.80 Substantially revised.

FortiOS v2.80 MR2 Removed log variable from imap-spamaction, pop3-spamaction, and smtp-
spamaction keywords.
FortiOS v2.80 MR3 Added splice variable to ftp and smtp keywords. Moved from config
antivirus ftp service and config antivirus smtp service.
Added chunkedbypass variable to http keyword.
FortiOS v2.80 MR5 Added http_err_detail to cat_options keyword.
FortiOS v2.80 MR6 Removed buffer_to_disk variable from ftp, http, imap, pop3, and smtp
keywords.
Added spamfeip variable to imap, pop3, and smtp keywords.
Changed content_log variable to content-archive for ftp, http, imap,
pop3, and smtp keywords.
FortiOS v2.80 MR7 Changed spamfeip variable to spamfsip for the FortiShield Antispam Service.
Added no-content-summary variable to ftp, http, imap, pop3, and smtp
keywords.
FortiOS v2.80 MR8 Added spamfsurl for the FortiShield spam filter URL blacklist to imap, pop3, and
smtp keywords.
FortiOS v3.0 Added keywords for FortiGuard. New options added for ftp, http, imap,
pop3, smtp, imap-spamtagtype, pop3-spamtagtype, smtp-
spamtagtype. Added keywords for IM. Added new keywords for IPS. Added new
keywords for logging. Added smtp-spamhdrip to profile. Added all IM and P2P
options. Added client comforting and oversize file commands. Added NNTP-related
commands. Added list selection commands for FortiGate-800 models and greater.
FortiOS v3.0 MR3 Added new options avquery and exemptword for HTTP. Removed options
fileexempt, mail_log and spamfschksum from HTTP, POP3 and IMAP.
Added new options archive-full, archive-summary and avquery for
IMAP, POP3, and AIM. Removed options content-archive and fileexempt
from IMAP and IM.

FortiGate CLI Version 3.0 MR6 Reference

146 01-30006-0015-20080205
firewall profile

FortiOS v3.0 MR4 Added no-content-summary to AIM, ICQ, MSN, and Yahoo options. Removed
transfer-log, from the same commands as it is not a feature.
FortiOS v3.0 MR4 Added VoIP config commands for SCCP, Simple, and SIP protocols.
Added associated-interface, nntpoversizelimit, imoversizechat,
log-voip, log-voip-violations, and HTTPS commands.
Removed the following options and commands: nntp-spamaction,
nntp-spamtagtype, nntp-spamtagmsg.
Added set smtp-spam-localoverride command.
FortiOS v3.0 MR6 New option redir-block for variable ftgd-wf-options. Blocks HTTP redirects.
FortiOS v3.0 MR6 Removed variables ips-signature and ips-anomaly. IPS sensors, formerly
signatures, are now configured by selecting a sensor name. Denial of service (DoS)
sensors, formerly anomalies, are no longer configured in protection profiles.
FortiOS v3.0 MR6 New variables ips-sensor-status and ips-sensor. Enables IPS sensors, and
selects the IPS sensor name.
FortiOS v3.0 MR6 Renamed variable ips-log to log-ips.
FortiOS v3.0 MR6 New option block-long-chat for variable aim. Blocks oversize chat messages.
FortiOS v3.0 MR6 Renamed options content-full and content-meta to archive-full and
archive-summary, respectively, for the msn, icq, and yahoo variables.
FortiOS v3.0 MR6 Removed variable ftgd-wf-ovrd-group.
FortiOS v3.0 MR6 New option scanextended for the ftp and http variables. Scans for viruses and
worms using the extended database of virus definitions.
FortiOS Carrier v3.0 MR3 New variable imoversizechat. Limits the size of individual chat messages.
FortiOS Carrier v3.0 MR3 New command config dupe. Configures detection of excessive MMS message
duplicates.
FortiOS Carrier v3.0 MR3 New command config flood. Configures detection of excessive MMS message
activity.
FortiOS Carrier v3.0 MR3 New variables msisdn-prefix, msisdn-string, msisdn-prefix-range-min
and msisdn-prefix-range-max. Configures MSISDN prefixes.
FortiOS Carrier v3.0 MR3 New variable mm1-retr-dupe. Scans mm1-retr MMS messages for duplicates.
By default, mm1-retr messages are not scanned for duplicates as they may often
be the same without necessarily being bulk or spam.
FortiOS Carrier v3.0 MR3 New variables mm1-addr-hdr, mm1-addr-source, mm1-convert-hex, mm7-
addr-hdr, mm7-addr-source, mm7-convert-hex. Configures MSISDN
extraction and conversion to hexadecimal for MM1 and MM7 MMS messages.
FortiOS Carrier v3.0 MR3 New variables msisdn-bwl-int, msisdn-bwl-int-mode, msisdn-bwl-
status in the config notification subcommand. Configures MMS notification
intervals when MSISDN black/white list events occur.
FortiOS Carrier v3.0 MR3 New variables dupe-int, dupe-int-mode, dupe-status in the config
notification subcommand. Configures MMS notification intervals when
excessive MMS message duplicates are detected.
FortiOS Carrier v3.0 MR3 New variables flood-int, flood-int-mode, flood-status in the config
notification subcommand. Configures MMS notification intervals when
excessive MMS message activity is detected.
FortiOS Carrier v3.0 MR3 New variable rate-limit in the config notification subcommand. Limits the
rate at which MMS notices are sent.
FortiOS Carrier v3.0 MR3 New variables tod-window-start and tod-window-end in the config
notification subcommand. Configures the window of time during which MMS
notices are sent.
FortiOS Carrier v3.0 MR3 New variable no-sdp-fixup in the config sip subcommand. Preserves the
original SDP packet.
FortiOS Carrier v3.0 MR3 New variables notify-rate, options-rate, prack-rate, preserve-
override, refer-rate, subscribe-rate, and update-rate in the config
sip subcommand. Limits the rate at which certain types of SIP traffic are forwarded.
FortiOS Carrier v3.0 MR3 New variable preserve-override in the config sip subcommand. Omits the
original IP address from SDP i line.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 147
profile firewall

FortiOS Carrier v3.0 MR3 New variable primary-secondary in the config sip subcommand. Monitors
primary/secondary outbound proxy redundancy.
FortiOS Carrier v3.0 MR3 New variable timeout-buffer in the config sip subcommand. Configures the
maximum number of timed out calls to buffer.

Related topics
• firewall policy, policy6
• alertemail
• antivirus
• ips
• webfilter

FortiGate CLI Version 3.0 MR6 Reference

148 01-30006-0015-20080205
firewall schedule onetime

schedule onetime
Use this command to add, edit, or delete one-time schedules.
Use scheduling to control when policies are active or inactive. Use one-time schedules for policies that
are effective once for the period of time specified in the schedule.

Note: To edit a schedule, define the entire schedule, including the changes. This means entering all of the
schedule parameters, both those that are changing and those that are not.

Syntax
config firewall schedule onetime
edit <name_str>
set end <hh:mm> <yyyy/mm/dd>
set start <hh:mm> <yyyy/mm/dd>
end
Keywords and variables Description Default
<name_str> Enter the name of this schedule. No default.
end <hh:mm> <yyyy/mm/dd> Enter the ending day and time of the schedule. 00:00
• hh - 00 to 23 2001/01/01
• mm - 00, 15, 30, or 45
• yyyy - 1992 to infinity
• mm - 01 to 12
• dd - 01 to 31
start <hh:mm> Enter the starting day and time of the schedule. 00:00
<yyyy/mm/dd> • hh - 00 to 23 2001/01/01
• mm - 00, 15, 30, or 45
• yyyy - 1992 to infinity
• mm - 01 to 12
• dd - 01 to 31

Example
Use the following example to add a one-time schedule named Holiday that is valid from 5:00 pm on
3 September 2004 until 8:45 am on 7 September 2004.
config firewall schedule onetime
edit Holiday
set start 17:00 2004/09/03
set end 08:45 2004/09/07
end

History

FortiOS v2.80 Revised.

Related topics
• firewall policy, policy6
• firewall schedule recurring

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 149
schedule recurring firewall

schedule recurring
Use this command to add, edit, and delete recurring schedules used in firewall policies.
Use scheduling to control when policies are active or inactive. Use recurring schedules to create
policies that repeat weekly. Use recurring schedules to create policies that are effective only at
specified times of the day or on specified days of the week.

Note: If a recurring schedule is created with a stop time that occurs before the start time, the schedule starts at the
start time and finishes at the stop time on the next day. You can use this technique to create recurring schedules
that run from one day to the next. To create a recurring schedule that runs for 24 hours, set the start and stop
times to the same time.

Syntax
config firewall schedule recurring
edit <name_str>
set day <name_str>
set end <hh:mm>
set start <hh:mm>
end

Keywords and variables Description Default

<name_str> Enter the name of this schedule. No default.
day <name_str> Enter the names of one or more days of the week for which the sunday
schedule is valid. Separate multiple names with a space.
end <hh:mm> Enter the ending time of the schedule. 00:00
• hh can be 00 to 23
• mm can be 00, 15, 30, or 45 only
start <hh:mm> Enter the starting time of the schedule. 00:00
• hh can be 00 to 23
• mm can be 00, 15, 30, or 45 only

Example
This example shows how to add a recurring schedule named access so that it is valid Monday to
Friday from 7:45 am to 5:30 pm.
config firewall schedule recurring
edit access
set day monday tuesday wednesday thursday friday
set start 07:45
set end 17:30
end
Edit the recurring schedule named access so that it is no longer valid on Fridays.
config firewall schedule recurring
edit access
set day monday tuesday wednesday thursday
set start 07:45
set end 17:30
end

FortiGate CLI Version 3.0 MR6 Reference

150 01-30006-0015-20080205
firewall schedule recurring

History

FortiOS v2.80 Revised.

Related topics
• firewall policy, policy6
• firewall schedule onetime

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 151
service custom firewall

service custom
Use this command to configure a firewall service that is not in the predefined service list.

Note: To display a list of all predefined service names, enter the command get firewall service
predefined ?. To display a predefined service’s details, enter the command get firewall
service predefined <service_str>. For details, see “get firewall service predefined” on
page 635.

Syntax
config firewall service custom
edit <name_str>
set icmpcode <code_int>
set icmptype <type_int>
set protocol {ICMP | IP | TCP/UDP}
set protocol-number <protocol_int>
set tcp-portrange <dstportlow_int>[-<dstporthigh_int>:
<srcportlow_int>-<srcporthigh_int>]
set udp-portrange <dstportlow_int>[-<dstporthigh_int>:
<srcportlow_int>-<srcporthigh_int>]
end
Keywords and variables Description Default
<name_str> Enter the name of this custom service. No default
icmpcode <code_int> Enter the ICMP code number. Find ICMP type and code No default.
numbers at www.iana.org.
icmptype <type_int> Enter the ICMP type number. The range for type_int is from 0
0-255. Find ICMP type and code numbers at www.iana.org.
protocol Enter the protocol used by the service. IP
{ICMP | IP | TCP/UDP}
protocol-number For an IP service, enter the IP protocol number. For information 0
<protocol_int> on protocol numbers, see http://www.iana.org.
tcp-portrange For TCP services, enter the destination and source port ranges. No default.
<dstportlow_int>[- If the destination port range can be any port, enter 1-65535. If
<dstporthigh_int>: the destination is only a single port, simply enter a single port
<srcportlow_int>- number for dstportlow_int and no value for
dstporthigh_int.
<srcporthigh_int>]
If source port can be any port, no source port need be added. If
the source port is only a single port, simply enter a single port
number for srcportlow_int and no value for
srcporthigh_int.
udp-portrange For UDP services, enter the destination and source port No default.
<dstportlow_int>[- ranges.
<dstporthigh_int>: If the destination port range can be any port, enter 1-65535. If
<srcportlow_int>- the destination is only a single port, simply enter a single port
number for dstportlow_int and no value for
<srcporthigh_int>] dstporthigh_int.
If source port can be any port, no source port need be added. If
the source port is only a single port, simply enter a single port
number for srcportlow_int and no value for
srcporthigh_int.

FortiGate CLI Version 3.0 MR6 Reference

152 01-30006-0015-20080205
firewall service custom

Example
This example shows how to add a custom service called Custom_1. The service destination port
range is TCP 4501 to 4503. The service can use any source port.
config firewall service custom
edit Custom_1
set protocol TCP/UDP
set tcp-portrange 4501-4503
end
A second example shows how to add a custom service called Custom_2. The service destination port
range is TCP 4545 to 4550. The service uses source port 9620.
config firewall service custom
edit Custom_1
set protocol TCP/UDP
set tcp-portrange 4545-4550:9620
end

History

FortiOS v2.80 Revised.

FortiOS v3.00 The portrange command split into tcp-portrange and udp-portrange.

Related topics
• firewall policy, policy6

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 153
service group firewall

service group
Use this command to configure firewall service groups.
To simplify policy creation, you can create groups of services and then add one policy to provide or
block access for all the services in the group. A service group can contain predefined services and
custom services in any combination. A service group cannot contain another service group.

Note: To edit a service group, enter all of the members of the service group, both those changing and those
staying the same.

Syntax
config firewall service group
edit <name_str>
set member <name_str>
end

Keywords and variables Description Default

<group-name_str> Enter the name of this service group. No default.
member <service_str> Enter one or more names of predefined or custom firewall No default.
services to add to the service group. Separate multiple names
with a space. To view the list of available services enter set
member ? at the prompt.
<service_str> is case-sensitive.

Example
This example shows how to add a service group called web_Services that includes the FTP, HTTP,
HTTPS, and Real Audio services.
config firewall service group
edit web_Services
set member FTP HTTP HTTPS RAUDIO
end
This example shows how to add the TELNET service to the web_Services service group.
config firewall service group
edit web_Services
set member FTP HTTP HTTPS RAUDIO TELNET
end

History

FortiOS v2.80 Revised.

Related topics
• firewall policy, policy6

FortiGate CLI Version 3.0 MR6 Reference

154 01-30006-0015-20080205
firewall vip

vip
Use this command to configure virtual IPs and their associated address and port mappings (NAT).
Virtual IPs can be used to allow connections through a FortiGate unit using network address
translation (NAT) firewall policies. Virtual IPs use Proxy ARP so that the FortiGate unit can respond to
ARP requests on a network for a server that is actually installed on another network. Proxy ARP is
defined in RFC 1027.
For example, you can add a virtual IP to an external FortiGate unit interface so that the external
interface can respond to connection requests for users who are actually connecting to a server on the
DMZ or internal network.

Note: Virtual IPs are not available in Transparent mode.

Depending on your configuration of the virtual IP, its mapping may involve port address translation
(PAT), also known as port forwarding or network address port translation (NAPT), and/or network
address translation (NAT) of IP addresses.
If you configure NAT in the virtual IP and firewall policy, the NAT behavior varies by your selection of:
• static vs. dynamic NAT mapping
• the dynamic NAT’s load balancing style, if using dynamic NAT mapping
• full NAT vs. destination NAT (DNAT)
The following table describes combinations of PAT and/or NAT that are possible when configuring a
firewall policy with a virtual IP.

Static NAT Static, one-to-one NAT mapping: an external IP address is always translated to the same
mapped IP address.
If using IP address ranges, the external IP address range corresponds to a mapped IP
address range containing an equal number of IP addresses, and each IP address in the
external range is always translated to the same IP address in the mapped range.
Static NAT with Port Static, one-to-one NAT mapping with port forwarding: an external IP address is always
Forwarding translated to the same mapped IP address, and an external port number is always
translated to the same mapped port number.
If using IP address ranges, the external IP address range corresponds to a mapped IP
address range containing an equal number of IP addresses, and each IP address in the
external range is always translated to the same IP address in the mapped range. If using
port number ranges, the external port number range corresponds to a mapped port
number range containing an equal number of port numbers, and each port number in the
external range is always translated to the same port number in the mapped range.
Load Balancing Dynamic, one-to-many NAT mapping: an external IP address is translated to one of the
mapped IP addresses. For each session, a load balancing algorithm dynamically selects
an IP address from the mapped IP address range to provide more even traffic distribution.
The external IP address is not always translated to the same mapped IP address.
Load Balancing Dynamic, one-to-many NAT mapping with port forwarding: an external IP address is
with Port translated to one of the mapped IP addresses. For each session, a load balancing
Forwarding algorithm dynamically selects an IP address from the mapped IP address range to provide
more even traffic distribution. The external IP address is not always translated to the same
mapped IP address.
Dynamic Virtual IPs Dynamic, many-to-few or many-to-one NAT mapping: if you set the external IP address of
a virtual IP to 0.0.0.0, the interface maps traffic destined for any IP address, and is
dynamically translated to a mapped IP address or address range.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 155
vip firewall

Server Load Dynamic, one-to-many NAT mapping: an external IP address is translated to one of the
Balancing mapped IP addresses, as determined by the selected load balancing algorithm for more
even traffic distribution. The external IP address is not always translated to the same
mapped IP address.
Server load balancing requires that you configure at least one “real” server, but can use up
to eight. Real servers can be configured with health check monitors. Health check monitors
can be used to gauge server responsiveness before forwarding packets.
Server Load Dynamic, one-to-many NAT mapping with port forwarding: an external IP address is
Balancing with Port translated to one of the mapped IP addresses, as determined by the selected load
Forwarding balancing algorithm for more even traffic distribution.The external IP address is not always
translated to the same mapped IP address.
Server load balancing requires that you configure at least one “real” server, but can use up
to eight. Real servers can be configured with health check monitors. Health check monitors
can be used to gauge server responsiveness before forwarding packets.
Note: If the NAT check box is not selected when building the firewall policy, the resulting policy does not
perform full (source and destination) NAT; instead, it performs destination network address translation
(DNAT).
For inbound traffic, DNAT translates packets’ destination address to the mapped private IP address, but
does not translate the source address. The private network is aware of the source’s public IP address.
For reply traffic, the FortiGate unit translates packets’ private network source IP address to match the
destination address of the originating packets, which is maintained in the session table.

Virtual IPs have the following requirements.

• The Mapped IP Address/Range cannot be 0.0.0.0 or 255.255.255.255.
• The Mapped IP Address/Range must not include any interface IP addresses.
• If the virtual IP is mapped to a range of IP addresses and its type is Static NAT, the External IP
Address/Range cannot be 0.0.0.0.
• When port forwarding, the External IP Address/Range cannot include any interface IP
addresses.
• When port forwarding, the count of mapped port numbers and external port numbers must be
the same, and the last port number in the range must not exceed 65535.
• Virtual IP names must be different from address or address group names.
• Duplicate entries or overlapping ranges are not permitted.

Syntax
config firewall vip
edit <name_str>
config realservers
edit <table_int>
set dead-interval <seconds_int>
set healthcheck {enable | disable}
set ip <server_ip>
set healthcheck {enable | disable}
set ping-detect {enable | disable}
set port <port_ip>
set wake-interval <seconds_int>
set weight <loadbalanceweight_int>
end
set arp-reply {enable | disable}
set extintf <name_str>
set extip <address_ipv4>
set extport <port_int>
set http {enable | disable}
set http-ip-header {enable | disable}
set ldb-method {round-robin | static | weighted}

FortiGate CLI Version 3.0 MR6 Reference

156 01-30006-0015-20080205
firewall vip

set mappedip [<start_ipv4>-<end_ipv4>]

set mappedport <port_int>
set max-embryonic-connections <initiated_int>
set portforward {enable | disable}
set protocol {tcp | udp}
set ssl {full | half | off}
set ssl-certificate <certificate_str>
set ssl-client-session-state-max <sessionstates_int>
set ssl-client-session-state-timeout <timeout_int>
set ssl-client-session-state-type {both | client | disable | time}
set ssl-dh-bits <bits_int>
set ssl-http-location-conversion {enable | disable}
set ssl-max-version {ssl-3.0 | tls-1.0 | tls-1.1}
set ssl-min-version {ssl-3.0 | tls-1.0 | tls-1.1}
set ssl-send-empty-frags {enable | disable}
set type {load-balance | server-load-balance | static-nat}
end
Keywords and variables Description Default
<name_str> Enter the name of this virtual IP address. No default.
arp-reply Select to respond to ARP requests for this virtual IP address. enable
{enable | disable}
extintf <name_str> Enter the name of the interface connected to the source No default.
network that receives the packets that will be forwarded to the
destination network. The interface name can be any FortiGate
network interface, VLAN subinterface, IPSec VPN interface,
or modem interface.
extip <address_ipv4> Enter the IP address on the external interface that you want to 0.0.0.0
map to an address on the destination network.
If type is static-nat and mappedip is an IP address
range, the FortiGate unit uses extip as the first IP address in
the external IP address range, and calculates the last IP
address required to create an equal number of external and
mapped IP addresses for one-to-one mapping.
To configure a dynamic virtual IP that accepts connections
destined for any IP address, set extip to 0.0.0.0.
extport <port_int> Enter the external port number that you want to map to a port 0
number on the destination network.
If you want to configure a static NAT virtual IP that maps a
range of external port numbers to a range of destination port
numbers, set extip to the first port number in the range.
Then set mappedport to the start and end of the destination
port range. The FortiGate unit automatically calculates the
end of the extport port number range.
To configure a dynamic virtual IP that accepts connections for
any port, set extport to 0.
http {enable | disable} Select to use the FortiGate unit’s HTTP proxy to multiplex disable
multiple client connections destined for the web server into a
few connections between the FortiGate unit and the web
server. This can improve performance by reducing server
overhead associated with establishing multiple connections.
The server must be HTTP/1.1 compliant.
This option appears only if portforward is enable.
http-ip-header Select to preserve the client’s IP address in the X- disable
{enable | disable} Forwarded-For HTTP header line. This can be useful if you
require logging on the server of the client’s original IP
address. If this option is not selected, the header will contain
the IP address of the FortiGate unit.
This option appears only if portforward and http are
enable.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 157
vip firewall

Keywords and variables Description Default

ldb-method Select the load balancing method. static
{round-robin | static | • round-robin: Directs request to the next server, and
weighted} treats all servers as equals regardless of response time or
number of connections. Unresponsive servers are avoided.
A separate server is required.
• static: Distributes load evenly across all servers;
separate servers are not required.
• weighted: Servers with a higher weight value will receive
a larger percentage of connections at any one time. Server
weights can be set in config realservers set
weight
This option appears only if type is server-load-balance.
mappedip Enter the IP address or IP address range on the destination 0.0.0.0
[<start_ipv4>-<end_ipv4>] network to which the external IP address is mapped.
If type is static-nat and mappedip is an IP address
range, the FortiGate unit uses extip as the first IP address in
the external IP address range, and calculates the last IP
address required to create an equal number of external and
mapped IP addresses for one-to-one mapping.
If type is load-balance and mappedip is an IP address
range, the FortiGate unit uses extip as a single IP address
to create a one-to-many mapping.
mappedport <port_int> Enter the port number on the destination network to which the 0
external port number is mapped.
You can also enter a port number range to forward packets to
multiple ports on the destination network.
For a static NAT virtual IP, if you add a map to port range the
FortiGate unit calculates the external port number range.
max-embryonic-connections Enter the maximum number of partially established SSL or 1000
<initiated_int> HTTP connections. This should be greater than the maximum
number of connections you want to establish per second.
This option appears only if portforward is enable, and
http is enable or ssl is not off.
portforward Select to enable port forwarding. You must also specify the disable
{enable | disable} port forwarding mappings by configuring extport and
mappedport.
protocol {tcp | udp} Select the protocol, TCP or UDP, to use when forwarding tcp
packets.

FortiGate CLI Version 3.0 MR6 Reference

158 01-30006-0015-20080205
firewall vip

Keywords and variables Description Default

ssl {full | half | off} Select whether or not to accelerate SSL communications with off
the destination by using the FortiGate unit to perform SSL
operations, and indicate which segments of the connection
will receive SSL offloading.
• full: Select to apply SSL to both parts of the connection:
the segment between client and the FortiGate unit, and the
segment between the FortiGate unit and the server. The
segment between the FortiGate unit and the server will use
encrypted communications, but the handshakes will be
abbreviated. This results in performance which is less than
the option half, but still improved over communications
without SSL acceleration, and can be used in failover
configurations where the failover path does not have an SSL
accelerator. If the server is already configured to use SSL,
this also enables SSL acceleration without requiring
changes to the server’s configuration.
• half: Select to apply SSL only to the part of the connection
between the client and the FortiGate unit. The segment
between the FortiGate unit and the server will use clear text
communications. This results in best performance, but
cannot be used in failover configurations where the failover
path does not have an SSL accelerator.
• off: Do not apply SSL acceleration.
SSL 3.0, TLS 1.0, and TLS 1.1 are supported.
This option appears only if portforward is enable, and
only on FortiGate models whose hardware support SSL
acceleration, such as FortiGate-3600A.
ssl-certificate Enter the name of the SSL certificate to use with SSL No default.
<certificate_str> acceleration.
This option appears only if ssl is not off.
ssl-client-session-state- Enter the maximum number of SSL session states to keep for 1000
max <sessionstates_int> the segment of the SSL connection between the client and the
FortiGate unit.
This option appears only if ssl is not off.
ssl-client-session-state- Enter the number of minutes to keep the SSL session states 30
timeout <timeout_int> for the segment of the SSL connection between the client and
the FortiGate unit.
This option appears only if ssl is not off.
ssl-client-session-state- Select which method the FortiGate unit should use when both
type {both | client | deciding to expire SSL sessions for the segment of the SSL
disable | time} connection between the client and the FortiGate unit.
• both: Select to expire SSL session states when either ssl-
client-session-state-max or ssl-client-
session-state-timeout is exceeded, regardless of
which occurs first.
• count: Select to expire SSL session states when ssl-
client-session-state-max is exceeded.
• disable: Select to keep no SSL session states.
• time: Select to expire SSL session states when ssl-
client-session-state-timeout is exceeded.
This option appears only if ssl is not off.
ssl-dh-bits <bits_int> Enter the number of bits of the prime number used in the 1024
Diffie-Hellman exchange for RSA encryption of the SSL
connection. Larger prime numbers are associated with
greater cryptographic strength.
This option appears only if ssl is not off.
ssl-http-location- Select to replace http with https in the reply’s Location disable
conversion HTTP header field.
{enable | disable} For example, in the reply, Location:
http://example.com/ would be converted to Location:
https://example.com/ .
This option appears only if ssl is half.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 159
vip firewall

Keywords and variables Description Default

ssl-http-match-host Select to apply Location conversion to the reply’s HTTP disable
{enable | disable} header only if the host name portion of Location matches
the request’s Host field, or, if the Host field does not exist,
the host name portion of the request’s URI. If disabled,
conversion occurs regardless of whether the host names in
the request and the reply match.
For example, if host matching is enabled, and a request
contains Host: example.com and the reply contains
Location: http://example.cc/, the Location field
does not match the host of the original request and the reply’s
Location field remains unchanged. If the reply contains
Location: http://example.com/, however, then the
FortiGate unit detects the matching host name and converts
the reply field to Location: https://example.com/ .
This option appears only if ssl is half, and ssl-http-
location-conversion is enable.
ssl-max-version {ssl-3.0 Enter the maximum version of SSL/TLS to accept in tls-1.1
| tls-1.0 | tls-1.1} negotiation.
This option appears only if ssl is not off.
ssl-min-version {ssl-3.0 Enter the minimum version of SSL/TLS to accept in ssl-3.0
| tls-1.0 | tls-1.1} negotiation.
This option appears only if ssl is not off.
ssl-send-empty-frags Select to precede the record with empty fragments to thwart enable
{enable | disable} attacks on CBC IV. You might disable this option if SSL
acceleration will be used with an old or buggy SSL
implementation which cannot properly handle empty
fragments.
This option appears only if ssl is not off, and applies only to
SSL 3.0 and TLS 1.0.
ssl-server-session-state- Enter the maximum number of SSL session states to keep for 1000
max <sessionstates_int> the segment of the SSL connection between the server and
the FortiGate unit.
This option appears only if ssl is full.
ssl-server-session-state- Enter the number of minutes to keep the SSL session states 30
timeout <timeout_int> for the segment of the SSL connection between the server
and the FortiGate unit.
This option appears only if ssl is full.
ssl-server-session-state- Select which method the FortiGate unit should use when both
type {both | client | deciding to expire SSL sessions for the segment of the SSL
disable | time} connection between the server and the FortiGate unit.
• both: Select to expire SSL session states when either ssl-
server-session-state-max or ssl-server-
session-state-timeout is exceeded, regardless of
which occurs first.
• count: Select to expire SSL session states when ssl-
server-session-state-max is exceeded.
• disable: Select to keep no SSL session states.
• time: Select to expire SSL session states when ssl-
server-session-state-timeout is exceeded.
This option appears only if ssl is full.
type Select the type of static or dynamic NAT applied to the virtual static-nat
{load-balance | IP.
server-load-balance | • load-balance: Dynamic NAT load balancing with server
static-nat} selection from an IP address range. This option is
deprecated and may be removed in future.
• server-load-balance: Dynamic NAT load balancing
with server selection from among up to eight
realservers, determined by your selected load balancing
algorithm and server responsiveness monitors.
• static-nat: Static NAT.

FortiGate CLI Version 3.0 MR6 Reference

160 01-30006-0015-20080205
firewall vip

Keywords and variables Description Default

The following commands are available only if type is server-load-balance.
realservers • Use this command to configure destinations to be used No default.
when the virtual IP is load balanced.
This option appears only if type is server-load-balance.
<table_int> • Enter an index number used to identify the server that you No default.
are configuring. 0 means the lowest available number.
This option appears only if type is server-load-balance.
dead-interval Enter the interval of time that a connection can remain idle 10
<seconds_int> before it is dropped. A range of 10-255 seconds can be used.
This option is deprecated and may be removed in future.
Instead, configure monitor.
healthcheck Enable to check the responsiveness of the server before disable
{enable | disable} forwarding traffic. You must also configure monitor.
ip <server_ip> Enter the IP address of a real server in the load balanced 0.0.0.0
server cluster.
monitor <healthcheck_str> Enter one or more names of health check monitor settings to No default.
use when performing a health check, separating each name
with a space. If any of the configured health check monitors
detect failures, the FortiGate unit will deem the server
unresponsive, and will not forward traffic to that server. For
details on configuring health check monitor settings, see
“firewall ldb-monitor” on page 100.
This option appears only if healthcheck is enable.
ping-detect Select to test the server’s responsiveness by ICMP PING. disable
{enable | disable} This option is available only if healthcheck is enable.
port <port_ip> Used to specify the port used if port forwarding is enabled. 10
wake-interval Enter the interval of time the connection will try to detect a 10
<seconds_int> server before giving up. A range of 10-255 seconds can be
used.
This option is deprecated and may be removed in future.
Instead, configure monitor.
weight Enter the weight value of a specific server. The weight can be 1
<loadbalanceweight_int> any value from 1 to 255. Servers with a greater weight receive
a greater proportion of forwarded connections.
This option is available only if ldb-method is weighted.

Example
This example shows how to add a static NAT virtual IP named Web_Server that allows users on the
Internet to connect to a web server on the internal network. The internet address of the web server is
64.32.21.34 and the real IP address of the web server on the internal network is 192.168.1.44.
config firewall vip
edit Web_Server
set extintf external
set extip 64.32.21.34
set mappedip 192.168.1.44
end
This example shows how to edit the static NAT virtual IP named Web_Server to change the real IP
address of the web server on the internal network to 192.168.110.23.
config firewall vip
edit web_Server
set mappedip 192.168.110.23
end

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 161
vip firewall

This example shows how to add a static NAT port forwarding virtual IP that uses port address
translation to allow external access to a web server on the internal network if there is no separate
external IP address for the web server. In this example, the IP address of the external interface is
192.168.100.99 and the real IP address of the web server on the internal network is 192.168.1.93.
config firewall vip
edit web_Server
set portforward enable
set extintf external
set extip 192.168.100.99
set extport 80
set mappedip 192.168.1.93
set mappedport 80
end
This example shows how to enter a static NAT virtual IP named Server_Range that allows Internet
users to connect to a range of 10 virtual IP addresses on the Internet and have the IP addresses in this
range mapped to a range of IP addresses on the DMZ network. The DMZ network contains 10 servers
with IP addresses from 10.10.10.20 to 10.10.10.29. The Internet IP addresses for these servers are in
the range 219.34.56.10 to 219.34.56.19. In this example you do not have to enter the external IP
address range. Instead you enter the first IP address in the external IP address range and the
FortiGate unit calculates the end of the IP address range based on the number of IP addresses
defined by the mapped IP address range. Also in the example, port2 is connected to the Internet.
config firewall vip
edit Server_Range
set extintf port2
set extip 219.34.56.10
set mappedip 10.10.10.20 10.10.10.19
end
This example shows how to enter a load balancing virtual IP named Ext_Load_Balance that allows
Internet users to connect to a single virtual IP address on the Internet and have that IP address
mapped to a range of IP addresses on the network connected to port5. You might use a configuration
such as this to load balance connections from the internet to an internal server farm. In the example
the Internet is connected to port2 and the virtual IP address is 67.34.56.90 and the IP address range
on the network connected to port5 is 172.20.120.10 to 172.20.120.30.
config firewall vip
edit Server_Range
set type load-balance
set extintf port2
set extip 67.34.56.90
set mappedip 172.20.120.10-172.20.120.30
end

History

FortiOS v2.80 Revised.

FortiOS v3.00 Revised.
FortiOS v3.00 Added server-load-balance to set type.
FortiOS v3.0 MR4 Added the following commands and options: config realserver.
FortiOS v3.0 MR5 extintf <name_str> variable now accepts modem interface names. Formerly, it
accepted a network interface, VLAN subinterface, or IPSec VPN virtual interface.

FortiGate CLI Version 3.0 MR6 Reference

162 01-30006-0015-20080205
firewall vip

FortiOS v3.0 MR6 New variables monitor and healthcheck. Enables health checking for real
servers and specifies which of the health check settings to use.
FortiOS v3.0 MR6 New variables:
• ssl, ssl-certificate
• ssl-client-session-state-max
• ssl-client-session-state-timeout
• ssl-client-session-state-type
• ssl-dh-bits
• ssl-http-location-conversion
• ssl-http-match-host
• ssl-max-version
• ssl-min-version
• ssl-send-empty-frags
• ssl-server-session-state-max
• ssl-server-session-state-timeout
• ssl-server-session-state-type
Enables SSL acceleration by offloading SSL operations from the destination to the
FortiGate unit, and configures various aspects of the offloading, including to which
segment(s) of the connection the FortiGate unit will apply SSL, and what encryption
strength and other options to use.
FortiOS v3.0 MR6 New variable max-embryonic-connections. Specifies the maximum number of
partially established SSL or HTTP connections when the virtual IP is performing
HTTP multiplexing or SSL offloading.
FortiOS v3.0 MR6 New variable http. Enables multiplexing of port forwarded HTTP connections into a
few connections to the destination.
FortiOS v3.0 MR6 New variable http-ip-header. Preserves the original client’s IP address in the X-
Forwarded-For HTTP header line when using HTTP multiplexing.

Related topics
• firewall policy, policy6
• firewall ldb-monitor
• vipgrp

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 163
vipgrp firewall

vipgrp
You can create virtual IP groups to facilitate firewall policy traffic control. For example, on the DMZ
interface, if you have two email servers that use Virtual IP mapping, you can put these two VIPs into
one VIP group and create one external-to-DMZ policy, instead of two policies, to control the traffic.
Firewall policies using VIP Groups are matched by comparing both the member VIP IP address(es)
and port number(s).

Syntax
config firewall vipgrp
edit <name_str>
set interface <name_str>
set member <virtualip_str>
end
Keywords and variables Description Default
<name_str> Enter the name of the virtual IP group. No default.
interface Enter the name of the interface to which the virtual IP group will No default.
<name_str> be bound.
member Enter one or more virtual IPs that will comprise the virtual IP No default.
<virtualip_str> group.

Example
config firewall vipgrp
edit group_one
set interface internal
set member vipone viptwo vipthree
end

History

FortiOS v3.0 MR4 Command vipgrp added.

Related topics
• firewall policy, policy6
• vip

FortiGate CLI Version 3.0 MR6 Reference

164 01-30006-0015-20080205
gui

gui
This chapter covers the commands to restore web-based manager CLI console and topology viewer.
This chapter contains the following sections:

console
topology

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 165
console gui

console
Use this command to configure the web-based manager CLI console.

Syntax
config gui console
set preferences <filedata>
end
To obtain base-64 encoded data from a configured CLI console, use:
show gui console

Variables Description Default

preferences <filedata> Base64-encoded file to upload containing the commands to
set up the CLI console GUI on the FortiGate unit.

Example
This example shows how to upload the data file (topguifile) containing commands to set up the
topology GUI on the FortiGate unit and the background image (backgroundfile).
config gui console
set preferences pref-file
end

History

FortiOS v3.00 MR5 New.

FortiGate CLI Version 3.0 MR6 Reference

166 01-30006-0015-20080205
gui topology

topology
Use this command to configure the web-based manager topology viewer.

Syntax
config gui topology
set background-image <filedatabackground>
set database <filedatabase>
set preferences <filedatapref>
end
To obtain base-64 encoded data from a configured topology viewer, use:
show gui topology

Variables Description Default

background-image Base64-encoded file to upload containing the commands to
<filedatabackground> set up the background image of the web-based manager
topology viewer.
database <filedatabase> Base64-encoded file to upload containing the data used to set
up the web-based manager topology viewer.
preferences <filedatapref> Base64-encoded file to upload containing the commands to
set the preferences of the web-based manager topology
viewer.

Example
This example shows how to upload the data file (topguifile) containing commands to set up the
topology GUI on the FortiGate unit and the background image (backgroundfile).
config gui topology
set preferences topguifile
set background-image backgroundfile
end

History

FortiOS v3.00 MR5 New.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 167
topology gui

FortiGate CLI Version 3.0 MR6 Reference

168 01-30006-0015-20080205
imp2p

imp2p
Use imp2p commands to configure user access to Instant Messaging and Person-to-Person
applications, and to configure a global policy for unknown users who might use these applications.
This chapter contains the following sections:

aim-user
icq-user
msn-user
old-version
policy
yahoo-user

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 169
aim-user imp2p

aim-user
Use this command to permit or deny a specific user the use of AOL Instant Messenger.

Syntax
config imp2p aim-user
edit <name_str>
set action {permit | deny}
end

Keywords and variables Description Default

name_str The name of the AIM user.
action {permit | deny} Permit or deny the use of AOL Instant Messenger by this user. deny

Example
This example shows how to add user_1 and permit the user to use the AIM protocol if the policy is set
to allow AOL Instant Messenger.
config imp2p aim-user
edit user_1
set action permit
end

History

FortiOS v3.0 New

Related topics
• imp2p icq-user
• imp2p msn-user
• imp2p old-version
• imp2p policy
• imp2p yahoo-user

FortiGate CLI Version 3.0 MR6 Reference

170 01-30006-0015-20080205
imp2p icq-user

icq-user
Use this command to permit or deny a specific user the use of ICQ Instant Messenger.

Syntax
config imp2p icq-user
edit <name_str>
set action {permit | deny}
end

Keywords and variables Description Default

name_str The name of the ICQ user.
action {permit | deny} Permit or deny the use of the ICQ Instant Messenger by this deny
user.

Example
This example shows how to add user_1 and permit the user to use the ICQ protocol if the policy is set
to allow ICQ Instant Messenger.
config imp2p icq-user
edit user_1
set action permit
end

History

FortiOS v3.0 New

Related topics
• imp2p aim-user
• imp2p msn-user
• imp2p old-version
• imp2p policy
• imp2p yahoo-user

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 171
msn-user imp2p

msn-user
Use this command to permit or deny a specific user the use of MSN Messenger.

Syntax
config imp2p msn-user
edit <name_str>
set action {permit | deny}
end

Keywords and variables Description Default

name_str The name of the MSN user.
action {permit | deny} Permit or deny the use of MSN Messenger by this user. deny

Example
This example shows how to add user_1 and permit the user to use the MSN protocol if the policy is set
to allow MSN Messenger.
config imp2p msn-user
edit user_1
set action permit
end

History

FortiOS v3.0 New

Related topics
• imp2p aim-user
• imp2p icq-user
• imp2p old-version
• imp2p policy
• imp2p yahoo-user

FortiGate CLI Version 3.0 MR6 Reference

172 01-30006-0015-20080205
imp2p old-version

old-version
Some older versions of IM protocols are able to bypass file blocking because the message types are
not recognized. The following command provides the option to disable these older IM protocol
versions. Supported IM protocols include:
• MSN 6.0 and above
• ICQ 4.0 and above
• AIM 5.0 and above
• Yahoo 6.0 and above

Syntax
config imp2p old-version
set aim {block | best-effort}
set icq {block | best-effort}
set msn {block | best-effort}
set yahoo {block | best-effort}
end
Keywords and variables Description Default
aim {block | best-effort} Enter block to block the session if the version is too old. block
Enter best-effort to inspect the session based on the
policy.
icq {block | best-effort} Enter block to block the session if the version is too old. block
Enter best-effort to inspect the session based on the
policy.
msn {block | best-effort} Enter block to block the session if the version is too old. block
Enter best-effort to inspect the session based on the
policy.
yahoo Enter block to block the session if the version is too old. block
{block | best-effort} Enter best-effort to inspect the session based on the
policy.

Example
This example shows how to block older versions of MSN Messenger and inspect older versions of
Yahoo Messenger.
config imp2p old-version
set msn block
set yahoo best-effort
end

History

FortiOS v3.0 New

Related topics
• imp2p aim-user
• imp2p icq-user
• imp2p msn-user
• imp2p policy
• imp2p yahoo-user

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 173
policy imp2p

policy
Use this command to create a global policy for instant messenger applications. If an unknown user
attempts to use one of the applications, the user can either be permitted use and added to a white list,
or be denied use and added to a black list.

Syntax
config imp2p policy
set aim {allow | deny}
set icq {allow | deny}
set msn {allow | deny}
set yahoo {allow | deny}
end
Keywords and variables Description Default
aim {allow | deny} Allow an unknown user and add the user to the white list. deny
Deny an unknown user and add the user to the black list.
icq {allow | deny} Allow an unknown user and add the user to the white list. deny
Deny an unknown user and add the user to the black list.
msn {allow | deny} Allow an unknown user and add the user to the white list. deny
Deny an unknown user and add the user to the black list.
yahoo {allow | deny} Allow an unknown user and add the user to the white list. deny
Deny an unknown user and add the user to the black list.

Example
This example shows how to configure the IM/P2P policy to allow AOL Instant Messenger, MSN
Messenger, and Yahoo Messenger but deny ICQ Instant Messenger.
config imp2p policy
set aim allow
set msn allow
set icq deny
set yahoo allow
end

History

FortiOS v3.0 New

Related topics
• imp2p aim-user
• imp2p icq-user
• imp2p msn-user
• imp2p old-version
• imp2p yahoo-user

FortiGate CLI Version 3.0 MR6 Reference

174 01-30006-0015-20080205
imp2p yahoo-user

yahoo-user
Use this command to permit or deny a specific user the use of Yahoo Messenger.

Syntax
config imp2p yahoo-user
edit <name_str>
set action {permit | deny}
end

Keywords and variables Description Default

name_str The name of the Yahoo user.
action {permit | deny} Permit or deny the use of Yahoo Messenger by this user. deny

Example
This example shows how to add user_1 and permit the user to use the Yahoo protocol if the policy is
set to allow Yahoo Messenger.
config imp2p yahoo-user
edit user_1
set action permit
end

History

FortiOS v3.0 New

Related topics
• imp2p aim-user
• imp2p icq-user
• imp2p msn-user
• imp2p old-version
• imp2p policy

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 175
yahoo-user imp2p

FortiGate CLI Version 3.0 MR6 Reference

176 01-30006-0015-20080205
ips

ips
Use ips commands to configure IPS sensors to define which signatures are used to examine traffic and
what actions are taken when matches are discovered. DoS sensors can also be defined to examine
traffic for anomalies
This chapter contains the following sections:

DoS
custom
decoder
global
rule
sensor
Note: If the IPS test can’t find the destination MAC address, the peer interface will be used. To ensure
packets get IPS inspection, there must be a Peer Interface. Both interfaces must be in the same VDOM,
and one interface cannot be both the peer and original interface. For information on how to set the Peer
Interface see “interface” on page 373.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 177
DoS ips

DoS
FortiGate Intrusion Protection uses Denial of Service (DoS) sensors to identify network traffic
anomalies that do not fit known or preset traffic patterns. Four statistical anomaly types for the TCP,
UDP, and ICMP protocols can be identified.

Flooding If the number of sessions targeting a single destination in one second is over a threshold, the
destination is experiencing flooding.
Scan If the number of sessions from a single source in one second is over a threshold, the source is
scanning.
Source session If the number of concurrent sessions from a single source is over a threshold, the source
limit session limit is reached.
Destination If the number of concurrent sessions to a single destination is over a threshold, the destination
session limit session limit is reached.

Enable or disable logging for each anomaly, and select the action taken in response to detecting an
anomaly. Configure the anomaly thresholds to detect traffic patterns that could represent an attack.

Note: It is important to estimate the normal and expected traffic on the network before changing the default
anomaly thresholds. Setting the thresholds too low could cause false positives, and setting the thresholds too high
could allow some attacks.

The list of anomalies can be updated only when the FortiGate firmware image is upgraded.
config limit
Access the config limit subcommand using the config ips anomaly <name_str>
command. Use this command for session control based on source and destination network address.
This command is available for tcp_src_session, tcp_dst_session, icmp_src_session,
icmp_dst_session, udp_src_session, udp_dst_session.
The default entry cannot be edited. Addresses are matched from more specific to more general. For
example, if thresholds are defined for 192.168.100.0/24 and 192.168.0.0/16, the address with the 24
bit netmask is matched before the entry with the 16 bit netmask.

Syntax
config ips DoS
edit <sensor_int>
config address
edit <address_int>
set dst-ip <dst_ipv4mask>
set dst-port <dstport_int>
set src-ip <src_ipv4mask>
end
config anomaly
edit <anomaly_str>
set status {enable | disable}
set log {enable | disable}
set action {block | pass}
set threshold <threshold_int>
end
set comment <comment_str>
set name <name_str>
set status {disable | enable}
end

FortiGate CLI Version 3.0 MR6 Reference

178 01-30006-0015-20080205
ips DoS

Keywords and variables Description Default

sensor_int The DoS sensor number. Enter ‘?’ to display a list of senor
numbers. Enter an unused number to create a new sensor.
address_int Enter the protected address integer. This is an ID number used
to reference a specified protected address source/destination/
port combination.
dst-ip <dst_ipv4mask> Enter the destination IP address and subnet to which this 0.0.0.0
sensor will apply. The default is all addresses. 0.0.0.0
dst-port <dstport_int> Enter the destination port to which this sensor will apply. The 0
default is all ports.
src-ip <src_ipv4mask> Enter the source IP address and subnet to which this sensor 0.0.0.0
will apply. The default is all addresses. 0.0.0.0
anomaly_str Enter the name of the anomaly you want to configure. Display a
list of the available anomaly types by entering ‘?’.
status {enable | disable} Enable or disable the specified anomaly in the current DoS disable
sensor.
log {enable | disable} Enable or disable logging of the specified anomaly in the enable
current DoS sensor.
action {block | pass} Pass or block traffic in which the specified anomaly is detected. pass
threshold <threshold_int> Enter the number of times the specified anomaly must be varies by
detected in network traffic before the action is triggered. anomaly
comment <comment_str> Enter a description of the DoS sensor. This will be displayed in
the DoS sensor list. Descriptions with spaces must be enclosed
in quotation marks.
name <name_str> Enter a name for the DoS sensor. This will be displayed in the
DoS sensor list. Names with spaces must be enclosed in
quotation marks.
status {disable | enable} Enable or disable the current DoS sensor. disable

Example
This example shows how to create a DoS sensor, name it, and enable blocking of the udp_flood
anomaly with the default threshold.
config ips DoS
edit 12
set name test
set comment "This is for test"
config anomaly
edit udp_flood
set action block
set status enable
end
end

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 179
DoS ips

History

FortiOS v2.80 Substantially revised.

FortiOS v3.0 Added severity, default-action, and default-severity.
FortiOS v3.0 MR5 Under the config limit command, set ipaddress was
removed. dst-ip, service, and src-ip commands were added.
FortiOS v3.0 MR6 Completely revised. Anomalies now defined in DoS sensors allowing
the creation of multiple sensors to tailor behavior depending on traffic
source, destination, and port, if required.

Related topics
• ips custom
• ips global
• ips fail-open {enable | disable}

FortiGate CLI Version 3.0 MR6 Reference

180 01-30006-0015-20080205
ips custom

custom
Create custom IPS signatures and add them to IPS sensors.
Custom signatures provide the power and flexibility to customize FortiGate Intrusion Protection for
diverse network environments. The FortiGate predefined signatures cover common attacks. If an
unusual or specialized application or an uncommon platform is being used, add custom signatures
based on the security alerts released by the application and platform vendors.
Use custom signatures to block or allow specific traffic.
The custom signature settings are configured when it is defined as a signature override in an IPS
sensor. This way, a single custom signature can be used in multiple sensors with different settings in
each. See “ips sensor” on page 186 for details.
For more information on custom signature syntax see the FortiGate IPS Custom Signatures Technical
Bulletin.

Note: Custom signatures are an advanced feature. This document assumes the user has previous experience
writing intrusion detection signatures.

Syntax
config ips custom
edit <sig_str>
set signature <signature_str>
end
Keywords and variables Description Default
sig_str The name of the custom signature.
signature <signature_str> Enter the custom signature. The signature must be enclosed in No default.
single quotes.

Example
This example shows how to add a custom signature.
config ips custom
edit bad_things
set signature 'F-SBID (--protocol tcp; --flow bi_direction;
--pattern "nude cheerleader"; --no_case)'
end

History

FortiOS v2.80 Substantially revised.

FortiOS v3.0 Removed all options except signature. Other settings are configured
MR6 when specifying the signature in a signature override.

Related topics
• ips global
• execute backup
• execute restore
• ips fail-open {enable | disable}

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 181
decoder ips

decoder
The Intrusion Protection system looks for certain types of traffic on specific ports. Using the decoders
command, you can change ports if your configuration uses non-standard ports.

Syntax
config ips decoder
edit <decoder_str>
set port_list <port_int>
end
Keywords and variables Description Default
decoder_str Enter the name of the decoder. Enter ‘?’ for a list.
port_list <port_int> Enter the ports which the decoder will examine. Multiple ports varies by
can be specified by separating them with commas and decoder
enclosing the list in quotes.

Example
This example shows how to modify the dns_decoder to examine ports 1, 2, and 3 instead of the default
53.
config ips decoder dns_decoder
set port_list "1,2,3"
end

FortiGate CLI Version 3.0 MR6 Reference

182 01-30006-0015-20080205
ips global

global
Use this command to ignore sessions after a set amount of traffic has passed.

Syntax
config ips global
set anomaly-mode {continuous | periodical}
set engine-count <integer>
set fail-open {enable | disable}
set ignore-session-bytes <byte_integer>
set session-limit-mode {accurate | heuristic}
set socket-size <ips_buffer_size>
set traffic-submit {enable | disable}
end
Keywords and variables Description Default
anomaly-mode {continuous Enter continuous to start blocking packets once attack starts. continuous
| periodical} Enter periodical to allow configured number of packets per
second.
engine-count <integer> Enter the number of intrusion protection engines to run. Multi- 0
processor FortiGate units can more efficiently process traffic
with multiple engines running. When set to the default value of
0, the FortiGate unit determines the optimal number of intrusion
protection engines to run.
fail-open If for any reason the IPS should cease to function, it will fail enable
{enable | disable} open by default. This means that crucial network traffic will not
be blocked and the Firewall will continue to operate while the
problem is resolved.
ignore-session-bytes Set the number of bytes after which the session is ignored. 204800
<byte_integer>
session-limit-mode Enter accurate to accurately count the concurrent sessions. heuristic
{accurate | heuristic} This option demands more resource. Enter heuristic to
heuristically count the concurrent sessions.
socket-size Set intrusion protection buffer size. The default value is correct model-
<ips_buffer_size> in most cases. dependent
traffic-submit Submit attack characteristics to FortiGuard Service disable
{enable | disable}

Example
This example shows how to set intrusion protection to ignore sessions after 204800 bytes.
config ips global
set ignore-session-bytes 204800
end

This example shows how to see the current configuration of ips global.
# get ips global
anomaly-mode : continuous
engine-count : 0
fail-open : enable
ignore-session-bytes: 204800
session-limit-mode : heuristic
socket-size : 8 (MB)
traffic-submit : disable

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 183
global ips

History

FortiOS v3.0 New.

FortiOS v3.0 MR4 Merged get ips global including example.
FortiOS v3.0 MR6 Removed the ip-protocol option.

Related topics
• execute backup
• execute restore
• ips fail-open {enable | disable}

FortiGate CLI Version 3.0 MR6 Reference

184 01-30006-0015-20080205
ips rule

rule
The IPS sensors use signatures to detect attacks. These signatures can be listed with the rules
command. Details about the default settings of each signature can also be displayed.

Syntax
config ips rule <rule_str>
get
Keywords and variables Description Default
rule_str Enter the name of a signature. For a complete list of the
predefined signatures, enter ‘?’ instead of a signature name.

Example
This example shows how to display the current configuration of the Apache.Long.Header.DoS
signature.
# config ips rule Apache.Long.Header.DoS
(Apache.Long.He~d) # get
name : Apache.Long.Header.DoS
status : enable
log : enable
log-packet : disable
action : pass
group : web_server
severity : medium
location : server
os : Windows, Linux, BSD, Solaris
application : Apache
service : TCP, HTTP
rule-id : 11206
rev : 2.450
end

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 185
sensor ips

sensor
The IPS sensors use signatures to detect attacks. IPS sensors are made up of filters and override
rules. Each filter specifies a number of signature attributes and all signatures matching all the specified
attributes are included in the filter. Override rules allow you to override the settings of individual
signatures.

Syntax
config ips sensor
edit <sensor_str>
config filter
edit <filter_str>
set location {all | client | server}
set severity {all | info low medium high critical}
set protocol <protocol_str>
set os {all | other windows linux bsd solaris macos}
set application <app_str>
set status {default | enable | disable}
set log {default | enable | disable}
set action {block | default | pass | reject}
end
config override
edit <override_int>
config exempt-ip
edit <exempt_int>
set dst-ip <dest_ipv4mask>
set src-ip <source_ipv4mask>
end
set action {block | pass | reset}
set log {disable | enable}
set log-packet {disable | enable}
set status {disable | enable}
end
set comment <comment_str>
end
Keywords and variables Description Default
sensor_str Enter the name of an IPS sensor. For a list of the IPS sensors,
enter ‘?’ instead of an IPS sensor name. Enter a new name to
create a sensor.
filter_str Enter the name of a filter. For a list of the filters in the IPS
sensor, enter ‘?’ instead of a filter name. Enter a new name to
create a filter.
location {all | client | Specify the type of system to be protected. all
server} • client selects signatures for attacks against client
computers.
• server selects signatures for attacks against servers.
• all selects both client and server signatures.
severity {all | info low Specify the severity level or levels. all
medium high critical} Specify all to include all severity levels.
protocol <protocol_str> Specify the protocols to be examined. Enter ‘?’ to display a list all
of the available protocols. All will include all protocols. Other
will include all unlisted protocols.

FortiGate CLI Version 3.0 MR6 Reference

186 01-30006-0015-20080205
ips sensor

Keywords and variables Description Default

os {all | other windows Specify the operating systems to be protected. All will include all
linux bsd solaris macos} all operating systems. Other will include all unlisted operating
systems.
application <app_str> Specify the applications to be protected. Enter ‘?’ to display a all
list of the available applications. All will include all
applications. Other will include all unlisted applications.
status {default | enable Specify the status of the signatures included in the filter. default
| disable} • enable will enable the filter.
• disable will disable the filter.
• default will enable the filter and only use the filters with a
default status of enable. Filters with a default status of
disable will not be used.
log {default | enable | Specify the logging status of the signatures included in the filter. default
disable} • enable will enable logging.
• disable will disable logging.
• default will enable logging for only the filters with a default
logging status of enable. Filters with a default logging status
of disable will not be logged.
action {block | default | Specify what action is taken with traffic in which signatures ar default
pass | reject} detected.
• block will drop the session with the offending traffic.
• default will use the default signature action.
• pass will allow the traffic.
• reject will reset the session.
override_int Enter the rule ID of an override filter. The rule ID is number
assigned to a filter, pre-defined or custom, and it specified
which filter is being overridden. For a list of the currently
defined overrides, enter ‘?’ instead of a rule ID.
Rule IDs are an attribute of every signature. Use the
config ips rule command to list the signatures or view
them in the GUI.
exempt_int Each override can apply to any number of source addresses,
destination addresses, or source/destination pairs. The
addresses are referenced by exempt_id values.
dst-ip <dest_ipv4mask> Enter the destination IP address and subnet to which this 0.0.0.0
sensor will apply. The default is all addresses. 0.0.0.0
src-ip <source_ipv4mask> Enter the source IP address and subnet to which this sensor 0.0.0.0
will apply. The default is all addresses. 0.0.0.0
action {block | pass | Specify the action to be taken for this override. pass
reset} • block will drop the session.
• pass will allow the traffic.
• reset will reset the session.
log {disable | enable} Specify whether the log should record when the override disable
occurs.
log-packet {disable | When enabled, packet logging will save the packet that triggers disable
enable} the override. You can download the packets in pcap format for
diagnostic use. This feature is only available in FortiGate units
with internal hard drives.
status {disable | enable} Enable or disable the override. disable
comment <comment_str> Enter a description of the IPS sensor. This description will
appear in the ISP sensor list. Descriptions with spaces must be
enclosed in quotes.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 187
sensor ips

Example
This example shows how to create an IPS sensor containing a filter that includes all signatures to
protect against Windows server attacks.
config ips sensor
edit dept_srv
set comment "Department file servers"
config filter
edit win_srv
set location server
set os windows
set action block
end
end

History

FortiOS v3.0 MR6 New.

FortiGate CLI Version 3.0 MR6 Reference

188 01-30006-0015-20080205
log

log
Use the config log commands to set the logging type, the logging severity level, and the logging
location for the FortiGate unit.

Note: In Transparent mode, certain log settings and options may not be available because certain
features do not support logging or are not available in this mode. For example, SSL VPN events are not
available in Transparent mode.

custom-field
{disk | fortianalyzer | memory | syslogd | webtrends |
fortiguard} filter
disk setting
fortianalyzer setting
fortiguard setting
memory setting
memory global setting
report customization
report definition
report filter
report output
report period
report schedule
report scope
report selection
report summary-layout
syslogd setting
trafficfilter
webtrends setting

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 189
custom-field log

custom-field
Use the following command to customize the log fields with a name and/or value. The custom name
and/or value will appear in the log message.

Syntax
config log custom-field
edit id <integer>
set name <name>
set value <integer>
end
Keywords and variables Description Default
id <integer> Enter the identification number for the log field. No default
name <name> Enter a name to identify the log. No default
value <integer> Enter a firewall policy number to associate a firewall policy No default
with the logs.

Example
This example shows how to configure a customized field for logs for branch offices in a company and
are associated with specific firewall policies.
config log custom-field
edit 1
set name company_branch1
set value 2
next
edit 2
set name company_branch2
set value 4
next
edit 3
set name company_branch3
set value 5
end

History

FortiOS v3.0 MR6 New.

Related topics
• {disk | fortianalyzer | memory | syslogd | webtrends | fortiguard} filter

FortiGate CLI Version 3.0 MR6 Reference

190 01-30006-0015-20080205
log {disk | fortianalyzer | memory | syslogd | webtrends | fortiguard} filter

{disk | fortianalyzer | memory | syslogd | webtrends | fortiguard}

filter
Use this command to configure log filter options. Log filters define the types of log messages sent to
each log location. Use the ? command to view each filter setting since not all filter settings display for
each device.
Filter settings include commands for multiple Syslog servers or multiple FortiAnalyzer units. For
example, config log fortianalyzer2 filter. See “fortianalyzer setting” on page 199 for more
information about configuring multiple FortiAnalyzer units, and “syslogd setting” on page 216 for more
information about configuring multiple Syslog servers.
When enabling filter settings for VoIP, also enable VoIP settings in a protection profile. VoIP calls
cannot be properly logged unless both filter and protection profile settings for VoIP are enabled. See
“firewall” on page 81 about enabling VoIP settings in a protection profile.
Filter settings for fortiguard are only available when FortiGuard Analysis Services is enabled. Filter
settings for disk is available for FortiGate units with hard disks. FortiGuard Log & Analysis was
renamed to FortiGuard Analysis Services for FortiOS 3.0 MR5.

Syntax
config log {disk | fortianalyzer | memory | syslogd | webtrends |
fortiguard} filter
set admin {disable | enable}
set allowed {disable | enable}
set anomaly {disable | enable}
set attack {disable | enable}
set auth {disable | enable}
set blocked {disable | enable}
set dhcp {disable | enable}
set email {disable | enable}
set email-log-imap {disable | enable}
set email-log-pop3 {disable | enable}
set email-log-smtp {disable | enable}
set event {disable | enable}
set ha {disable | enable}
set ftgd-wf-block {disable | enable}
set ftgd-wf-errors {disable | enable}
set gtp {disable | enable}(FortiOS Carrier)
set im {disable | enable}
set im-all {disable | enable}
set infected {disable | enable}
set ipsec {disable | enable}
set msisdn-bwl {disable | enable}(FortiOS Carrier)
set other-traffic {disable | enable}
set oversized {disable | enable}
set pattern {disable | enable}
set ppp {disable | enable}
set severity {alert | critical | debug | emergency | error |
information | notification | warning}
set signature {disable | enable}
set sslvpn-log-adm {disable | enable}
set sslvpn-log-auth {disable | enable}

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 191
{disk | fortianalyzer | memory | syslogd | webtrends | fortiguard} filter log

set sslvpn-log-session {disable | enable}

set system {disable | enable}
set traffic {disable | enable}
set url-filter {disable | enable}
set violation {disable | enable}
set virus {disable | enable}
set voip {disable | enable}
set voip-all {disable | enable}
set web {disable | enable}
set web-content {disable | enable}
set web-filter-activex {disable | enable}
set web-filter-applet {disable | enable}
set web-filter-cookie {disable | enable}
end
Keywords and variables Description Default
admin Enable or disable logging all administrative events, such as user enable
{disable | enable} logins, resets, and configuration updates in the event log. This
keyword is available when event is enabled.
allowed Enable or disable logging all traffic that is allowed according to enable
{disable | enable} the firewall policy settings in the traffic log. This keyword is
available when traffic is enabled.
anomaly Enable or disable logging all detected and prevented attacks enable
{disable | enable} based on unknown or suspicious traffic patterns, and the action
taken by the FortiGate unit in the attack log. This keyword is
available when attack is enabled.
attack Enable or disable the attack log. enable
{disable | enable}
auth Enable or disable logging all firewall-related events, such as user enable
{disable | enable} authentication in the event log. This keyword is available when
event is enabled.
blocked Enable or disable logging all instances of blocked files. enable
{disable | enable}
dhcp Enable or disable logging of DHCP service messages. enable
{disable | enable}
email Enable or disable the spam filter log. enable
{disable | enable}
email-log-imap Enable or disable logging of spam detected in IMAP traffic. enable
{disable | enable} email enable only.
email-log-pop3 Enable or disable logging of spam detected in POP3 traffic. enable
{disable | enable} email enable only.
email-log-smtp Enable or disable logging of spam detected in SMTP traffic. enable
{disable | enable} email enable only.
event Enable or disable the event log. enable
{disable | enable}
ha Enable or disable HA activity messages. enable
{disable | enable}
ftgd-wf-block Enable or disable logging of web pages blocked by FortiGuard enable
{disable | enable} category filtering in the web filter log. This keyword is available
when web is enabled.
ftgd-wf-errors Enable or disable logging all instances of FortiGuard category enable
{disable | enable} filtering rating errors. This keyword is available when web is
enabled.

FortiGate CLI Version 3.0 MR6 Reference

192 01-30006-0015-20080205
log {disk | fortianalyzer | memory | syslogd | webtrends | fortiguard} filter

Keywords and variables Description Default

gtp {disable | enable} Enable or disable logging for GTP messages. enable
(FortiOS Carrier)
im Enable or disable logging of instant messages and Peer-to-Peer enable
{disable | enable} (P2P) events.
im-all Enable or disable logging of instant messages. enable
{disable | enable}
infected Enable or disable logging of all virus infections in the antivirus enable
{disable | enable} log. This keyword is available when virus is enabled.
ipsec Enable or disable logging of IPSec negotiation events, such as enable
{disable | enable} progress and error reports in the event log. This keyword is
available when event is enabled.
msisdn-bwl Enable or disable logging of MSISDN filter block messages. enable
{disable | enable}
(FortiOS Carrier)
other-traffic Enable or disable ICSA compliant logs. This setting is disable
{disable | enable} independent from the traffic setting. Traffic log entries include
generating traffic logs:
• for all dropped ICMP packets
• for all dropped invalid IP packets
• for session start and on session deletion
This setting is not rate limited. A large volume of invalid packets
can dramatically increase the number of log entries.
oversized Enable or disable logging of oversized files in the antivirus log. enable
{disable | enable} This keyword is available when virus is enabled.
pattern Enable or disable logging of all pattern update events, such as enable
{disable | enable} antivirus and IPS pattern updates and update failures in the event
log. This keyword is available when event is enabled.
ppp Enable or disable logging of all L2TP, PPTP, and PPPoE-related enable
{disable | enable} events, such as manager and socket creation processes, in the
event log. This keyword is available when event is enabled.
severity Select the logging severity level. The FortiGate unit logs all informa
{alert | critical | debug messages at and above the logging severity level you select. For tion
| emergency | error | example, if you select error, the unit logs error, critical,
alert and emergency level messages.
information |
emergency - The system is unusable.
notification | warning}
alert - Immediate action is required.
critical - Functionality is affected.
error - An erroneous condition exists and functionality is
probably affected.
warning - Functionality might be affected.
notification - Information about normal events.
information - General information about system operations.
debug - Information used for diagnosing or debugging the
FortiGate unit.
signature Enable or disable logging of detected and prevented attacks enable
{disable | enable} based on the attack signature, and the action taken by the
FortiGate unit, in the attack log. This keyword is available when
attack is enabled.
sslvpn-log-adm Enable or disable logging of SSL-VPN administration. enable
{disable | enable}
sslvpn-log-auth Enable or disable logging of SSL-VPN user authentication. enable
{disable | enable}
sslvpn-log-session Enable or disable logging of SSL-VPN sessions. enable
{disable | enable}

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 193
{disk | fortianalyzer | memory | syslogd | webtrends | fortiguard} filter log

Keywords and variables Description Default

system Enable or disable logging of system activity messages. enable
{disable | enable}
traffic Enable or disable the traffic log. enable
{disable | enable}
url-filter Enable or disable logging of blocked URLs (specified in the URL enable
{disable | enable} block list) in the web filter log. This keyword is available when
web is enabled.
violation Enable or disable logging of all traffic that violates the firewall enable
{disable | enable} policy settings in the traffic log. This keyword is available when
trafic is enabled.
virus Enable or disable the antivirus log. enable
{disable | enable}
voip Enable or disable to log VoIP events. If enabling VoIP, also enable
{disable | enable} enable VoIP settings in a protection profile. See “firewall” on
page 81 about enabling VoIP settings in a protection profile.
voip-all Enable or disable to log all subcategories of VoIP events. If enable
{disable | enable} enabling VoIP, also enable VoIP settings in a protection profile.
See “firewall” on page 81 about enabling VoIP settings in a
protection profile.
web Enable or disable the web filter log. enable
{disable | enable}
web-content Enable or disable logging of blocked content (specified in the enable
{disable | enable} banned words list) in the web filter log. This keyword is available
when web is enabled.
web-filter-activex Enable or disable the logging of Active X block messages enable
{disable | enable}
web-filter-applet Enable or disable the logging of java applet block messages enable
{disable | enable}
web-filter-cookie Enable or disable the logging of cookie block messages enable
{disable | enable}

Example
This example shows how to set the logging severity level to warning, enable virus logging for infected
files, and enable event logging for anomaly and IPSec events.
config log disk filter
set severity warning
set virus enable
set infected enable
set event enable
set anomaly enable
set ipsec enable
end

History

FortiOS v2.80 Substantially revised.

FortiOS v2.8 MR2 Removed email_content keyword.
Added email_log_imap, email_log_pop3, and email_log_smtp keywords.

FortiGate CLI Version 3.0 MR6 Reference

194 01-30006-0015-20080205
log {disk | fortianalyzer | memory | syslogd | webtrends | fortiguard} filter

FortiOS v3.0 cat-monitor, exempt and content-keywords commands removed.

url-block command renamed to url-filter.
cat-block and cat-errors commands renamed to ftgd-wf-block and ftgd-wf-
errors respectively.
New keywords im, im-all and sslvpn-auth, sslvpn-adm, sslvpn-session,
web-filter-activex, web-filter-applet and web-filter-cookie added.

FortiOS v3.0 MR4 Added the FortiGuard Log & Analysis command, fortiguard for configuring the filter
settings for the FortiGuard Log & Analysis server. Also added VoIP commands.
Added keywords for FortiOS Carrier.

Related topics
• log fortianalyzer setting
• log memory setting
• log syslogd setting
• log webtrends setting
• log trafficfilter
• log report definition
• firewall

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 195
disk setting log

disk setting
Use this command to configure log settings for logging to the local disk. Disk logging is only available
for FortiGate units with an internal hard disk. You can also use this command to configure the
FortiGate unit to upload current log files to an FTP server every time the log files are rolled.

Syntax
config log disk setting
set status {enable | disable}
set log full-first-warning threshold
set log full-second-warning threshold
set log full-final-warning threshold
set max-log-file-size <integer max>
set roll-schedule {daily | weekly}
set roll-time <hh:mm>
set diskfull {nolog | overwrite}
set upload {enable | disable}
set upload-destination {fortianalyzer | ftp-server}
set uploadip <class_ip>
set uploadport <port_integer>
set uploaduser <user_str>
set uploadpass <passwd>
set uploaddir <dir_name_str>
set uploadtype {attack event im spamfilter traffic virus voip
webfilter}
set uploadzip {disable | enable}
set uploadsched {disable | enable}
set uploadtime <time_integer>
set upload-delete-files {enable | disable}
set drive-standby-time <0-19800>
end
Keywords and variables Description Default
status Enter enable to enable logging to the local disk. disable
{enable | disable}
full-first-warning Enter to configure the first warning before reaching the 75
threshold threshold. You can enter a number between 1 and 100.
full-second-warning Enter to configure the second warning before reaching the 90
threshold threshold. You can enter a number between 1 and 100.
full-final-warning Enter to configure the final warning before reaching the 95
threshold threshold. You can enter a number between 1 and 100.
max-log-file-size Enter the maximum size of the log file (in MB) that is saved to 100
<integer max> the local disk.
When the log file reaches the specified maximum size, the
FortiGate unit saves the current log file and starts a new active
log file. The default maximum log file size 1 MB and the
maximum log file size allowed is 1024MB.
roll-schedule Enter the frequency of the log rolling. When set, the FortiGate daily
{daily | weekly} unit will roll the log event if the maximum size has not been
reached.
roll-time Enter the time of day, in the format hh:mm, when the FortiGate 00:00
<hh:mm> unit saves the current log file and starts a new active log file.

FortiGate CLI Version 3.0 MR6 Reference

196 01-30006-0015-20080205
log disk setting

Keywords and variables Description Default

diskfull Enter the action to take when the local disk is full. When you overwrite
{nolog | overwrite} enter nolog, the FortiGate unit will stop logging, and
overwrite will begin overwriting the oldest file once the local
disk is full.
upload Enable or disable uploading log files to a remote directory. disable
{enable | disable} Enable upload to upload log files to an FTP server whenever
a log file rolls.
Use the uploaddir, uploadip, uploadpass, uploadport,
and uploaduser keywords to add this information required to
connect to the FTP server and upload the log files to a specific
location on the server.
Use the uploadtype keyword to select the type of log files to
upload.
Use the upload-delete-files keyword to delete the files
from the hard disk once the FortiGate unit completes the file
transfer.
All upload keywords are available after enabling the upload
command.
upload-destination Select to upload log files directly to a FortiAnalyzer unit or to an disable
{fortianalyzer | ftp- FTP server. When you select to upload log files directly to a
server} FortiAnalyzer unit, you can also schedule when to upload the
log files, when the log file rolls, and so on.
uploadip Enter the IP address of the FTP server. This is required. 0.0.0.0
<class_ip>
uploadport Enter the port number used by the FTP server. The default port 21
<port_integer> is 21. Port 21 is the standard FTP port.
uploaduser Enter the user account for the upload server. This is required. No default.
<user_str>
uploadpass Enter the password required to connect to the FTP server. This No default
<passwd> is required.
uploaddir Enter the name of the path on the FTP server where the log No default
<dir_name_str> files will be transferred to. If you do not specify a remote
directory, the log files are uploaded to the root directory of the
FTP server.
uploadtype Select the log files to upload to the FTP server. You can enter traffic
{attack event im one or more of the log file types separated by spaces. Use a event
spamfilter traffic space to separate the log file types. If you want to remove a log spamfilter
file type from the list or add a log file type to the list, you must virus
virus voip webfilter} retype the list with the log file type removed or added. webfilter
voip
im
uploadzip Enter enable to compress the log files after uploading to the disable
{disable | enable} FTP server. If disable is entered, the log files are uploaded to
the FTP server in plain text format.
uploadsched Enable log uploads at a specific time of the day. When set to disable
{disable | enable} disable, the FortiGate unit uploads the logs when the logs are
rolled.
uploadtime Enter the time of day when the FortiGate unit uploads the logs. 0
<time_integer> The uploadsched setting must first be set to enable.
upload-delete-files Enable or disable the removal of the log files once the enable
{enable | disable} FortiGate unit has uploaded the log file to the FTP server.
drive-standby-time Set the power management for the hard disk. Enter the number 0
<0-19800> of seconds, up to 19800. If there is no hard disk activity within
the defined time frame, the hard disk will spin down to conserve
energy. Setting the value to 0 disables the setting.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 197
disk setting log

Example
This example shows how to enable logging to the local disk, set the action to stop logging when the
disk is full, log files have a maximum size of 300MB, roll log files daily and start a new one at 1:30pm
every day.
config log disk setting
set status enable
set diskfull nolog
set max-log-file-size 300
set roll-schedule daily
set roll-time 01:30
end
This example shows how to enable uploading the traffic log and content archive files to an FTP server.
The FTP server has the IP address 172.30.120.24, the user name is ftpone, the password is ftppass1,
and the directory on the FTP server is fortigate\login.
config log disk setting
set upload enable
set uploadip 172.30.120.24
set uploaduser ftpone
set uploadpass ftppass1
set uploadtype traffic content
set uploaddir fortigate\logs
end

History
FortiOS v2.80 Substantially revised.
FortiOS v2.80 MR2 Removed ftppasswd, ftpserver, and ftpuser keywords.
Added upload keyword.
Added upload, uploaddir, uploadip, uploadpass, uploadport, uploadtype,
and uploaduser keywords.
FortiOS v3.0 Renamed keyword filesize to max-log-file-size.
Removed duration and unit keywords.
Added upload-delete-files command.
FortiOS v3.0 MR2 Removed roll-day command.
FortiOS v3.0 MR4 Additional log files new to FortiOS 3.0MR4 were added to uploadtype keyword, voip
and im.
FortiOS v3.0 MR5 Removed the keyword, content, from uploadtype command.
Added keyword, upload-destination, for uploading log files to a FortiAnalyzer unit.
FortiOS v3.0 MR6 Added keywords full-first-warning threshold,
full-second-warning-threshold, and full-final-warning threshold.

Related topics
• log {disk | fortianalyzer | memory | syslogd | webtrends | fortiguard} filter
• log fortianalyzer setting
• log memory setting
• log syslogd setting
• log trafficfilter
• log webtrends setting
• log report definition

FortiGate CLI Version 3.0 MR6 Reference

198 01-30006-0015-20080205
log fortianalyzer setting

fortianalyzer setting
Use this command to configure the FortiGate unit to send log files to a FortiAnalyzer unit. See
“fortianalyzer, fortianalyzer2, fortianalyzer3” on page 340 to set the FortiAnalyzer configuration
settings.
FortiAnalyzer units are network appliances that provide integrated log collection, analysis tools and
data storage. Detailed log reports provide historical as well as current analysis of network and email
activity to help identify security issues and reduce network misuse and abuse.
Using the CLI, you can send logs to up to three different FortiAnalyzer units for maximum fail-over
protection of log data. After configuring logging to FortiAnalyzer units, the FortiGate unit will send the
same log packets to all configured FortiAnalyzer units. Additional FortiAnalyzer units are configured
using the fortianalyzer 2 and fortianalyzer 3 commands.
Use the multi-report command to enable configuring FortiAnalyzer reports. By default,
multi-report is disabled and only the default FortiAnalyzer report is available.

Note: The FortiAnalyzer CLI commands are not cumulative. Using a syntax similar to the following is not
valid:
config log fortianalyzer fortianalyzer2 fortianalyzer3 setting

Syntax
config log fortianalyzer setting
set status {disable | enable}
set multi-report {enable | disable}
set max-buffer-size
end
Keywords and variables Description Default
status {disable | enable} Enter enable to enable logging to a FortiAnalyzer unit. disable
multi-report Enter enable configuring of multiple reports. You need to disable
{enable | disable} enable this command to configure any FortiAnalyzer reports.
max-buffer-size Enter a number between 0 to 4095MB for the maximum buffer 10
size for the FortiAnalyzer unit. The number 0 disables the
maximum buffer size.

Example
This example shows how to enable logging to a FortiAnalyzer unit.
config log fortianalyzer setting
set status enable
end

History

FortiOS v2.80 New.

FortiOS v2.80 MR2 Added localid and psksecret keywords.
FortiOS v3.0 Moved all FortiAnalyzer configuration keywords under config system fortianalyzer.
Command includes up to three FortiAnalyzer units, fortianalyzer2 and
fortianalyzer3.
Changed FortiLog product name to FortiAnalyzer
FortiOS v3.0 MR4 Added multi-report keyword.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 199
fortianalyzer setting log

Related topics
• system fortianalyzer, fortianalyzer2, fortianalyzer3
• log {disk | fortianalyzer | memory | syslogd | webtrends | fortiguard} filter
• log fortianalyzer setting
• log memory setting
• log syslogd setting
• log webtrends setting
• log trafficfilter
• log report definition

FortiGate CLI Version 3.0 MR6 Reference

200 01-30006-0015-20080205
log fortiguard setting

fortiguard setting
Use this command for configuring FortiGuard Analysis Service settings. See the FortiGate
Administration Guide for more information about subscription-based FortiGuard Analysis Service,
including enabling logging to a FortiGuard Analysis server.

Note: The fortiguard setting command is only available when FortiGuard Analysis Service
subscription-based services are enabled. The storage space is a specified amount, and varies,
depending on the services requested.

Syntax
config log fortiguard setting
set quotafull {nolog | overwrite}
set status {disable | enable}
end
Keywords and variables Description Default
quotafull {nolog | Enter the action to take when the specified storage space on overwrite
overwrite} the FortiGuard Analysis server is full. When you enter nolog,
the FortiGate unit will stop logging, and overwrite will
begin overwriting the oldest file.
status {disable | enable} Enter to enable the FortiGuard Analysis server. disable

Example
In this example, the FortiGate unit is logging to a FortiGuard Analysis server, and will stop logging
when the maximum storage space on the server is reached.
config log fortiguard setting
set quotafull nolog
set status enable
end

History

FortiOS v3.0 MR4 New.

Related topics
• {disk | fortianalyzer | memory | syslogd | webtrends | fortiguard} filter

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 201
memory setting log

memory setting
Use this command to configure log settings for logging to the FortiGate system memory.
The FortiGate system memory has a limited capacity and only displays the most recent log entries.
Traffic logs are not stored in the memory buffer, due to the high volume of traffic information. After all
available memory is used, by default the FortiGate unit begins to overwrite the oldest messages. All
log entries are deleted when the FortiGate unit restarts.

Syntax
config log memory setting
set diskfull <overwrite>
set status {disable | enable}
end
Keywords and variables Description Default
diskfull <overwrite> Enter the action to take when the memory is reaching its overwrite
capacity. nolog means the FortiGate unit will stop logging,
overwrite means the FortiGate unit will begin overwriting
the oldest file and blocktraffic means the FortiGate unit
will block traffic when the memory is full.
status {disable | enable} Enter enable to enable logging to the FortiGate system disable
memory.

Example
This example shows how to enable logging to the FortiGate system memory, and configure the
FortiGate unit to stop logging when the log memory buffer is full.
config log memory setting
set status enable
set diskfull overwrite
end

History

FortiOS v2.80 Substantially revised.

FortiOS v3.0 Added diskfull keyword.
FortiOS v3.0 MR6 Removed blocktraffic and nolog keywords.

Related topics
• log {disk | fortianalyzer | memory | syslogd | webtrends | fortiguard} filter
• log fortianalyzer setting
• log syslogd setting
• log webtrends setting
• log trafficfilter
• log report definition
• memory global setting

FortiGate CLI Version 3.0 MR6 Reference

202 01-30006-0015-20080205
log memory global setting

memory global setting

Use this command to configure log threshold warnings, as well as the maximum buffer lines, for the
FortiGate system memory.
The FortiGate system memory has a limited capacity and displays only the most recent log entries.
Traffic logs are not stored in the memory buffer, due to the high volume of traffic information. After all
available memory is used, by default, the FortiGate unit begins to overwrite the oldest log messages.
All log entries are deleted when the FortiGate unit restarts.

Syntax
config log memory global setting
set full-final-warning-threshold
set full-first-warning-threshold
set full-second-warning-threshold
set max-lines
end
Keywords and variables Description Default
full-final-warning- Enter to configure the final warning before reaching the 95
threshold threshold. You can enter a number between 1 and 100.
full-first-warning- Enter to configure the first warning before reaching the 75
threshold threshold. You can enter a number between 1 and 100.
full-second-warning- Enter to configure the second warning before reaching the 90
threshold threshold. You can enter a number between 1 and 100.
max-lines Enter the maximum number of lines in the memory buffer log. No default

Example
This example shows how to configure the first, second, and final threshold warnings as well as the
maximum lines for the memory buffer log.
config log memory global setting
set first-full-warning-threshold 40
set second-full-warning-threshold 60
set final-full-warning-threshold 80
set max-lines 60
end

History

FortiOS v3.0 MR6 New.

Related topics
• log {disk | fortianalyzer | memory | syslogd | webtrends | fortiguard} filter
• log fortianalyzer setting
• log syslogd setting
• log webtrends setting
• log trafficfilter
• log report definition
• memory setting

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 203
report customization log

report customization
Use this command to customize your report with the company name, or to customize footers and
headers.

Syntax
config log report customization
set company <company_name>
set footer-option {custom | report-title} <footer>
set header <header_name>
end

Keywords and variables Description Default

company <company_name> Enter your company name to display on the report. No default
footer-option {custom | Enter to display the report-title in the footers of the report, report-title
report-title} <footer> or custom to customize the footers.
When customizing the footer, you can enter the footer
comment by using footer instead of entering
footer-option custom
header <header_name> Enter a header for the report. No default

Example
This example shows how to customize the report with the company name XYN, along with a
customized footer and header for the report.
config log report definition
set description "A weekly traffic report for the FortiGate-60"
set title "Weekly Report"
set footer “XYN: Weekly Report”
set header “XYN: Week of June 21”
end

History

FortiOS v3.0 New for this release.

FortiOS v3.0 MR5 Added footer for entering the footer comment without selecting footer-option
custom.

Related topics
• report filter
• report output
• report period
• report schedule
• report scope
• report selection

FortiGate CLI Version 3.0 MR6 Reference

204 01-30006-0015-20080205
log report definition

report definition
Use this command to add information to the report, including the title of the report and a description of
what is contained in the report.

Syntax
config log report definition
set description <report_description>
set title <report_title>
end
Keywords and variables Description Default
description Enter a description for the report describing what the report No default
<report_description> contains. Enclose the description in quotes. For example,
“This report contains network traffic
statistics.”
title <report_title> Enter a title for the report. If the title is more than one word, No default
enclose the title in quotes. For example, “Network Traffic
Statistics.”

Example
This example shows how to set the report name and title.
config log report definition
set description "A weekly traffic report for the FortiGate-60"
set title "Weekly Report"
end

History

FortiOS v3.0 New for this release.

Related topics
• report filter
• report output
• report period
• report schedule
• report scope
• report selection

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 205
report filter log

report filter
Use this command to view or remove information from a report to provide a more concise report. For
example, you only want reports on specific error messages, or you do not want include certain IP
address destinations.

Syntax
config log report filter
set filter-string <filter_string>
end
Keywords and variables Description Default
filter-string Enter a filter string to define what is included in the report. No default
<filter_string>

History

FortiOS v3.0 New for this release.

Related topics
• report definition
• report output
• report period
• report schedule
• report scope
• report selection

FortiGate CLI Version 3.0 MR6 Reference

206 01-30006-0015-20080205
log report output

report output
Use this command to configure a file format for the report for email recipients, saved to the
FortiAnalyzer hard disk. Use this command to also configure the FortiAnalyzer unit to upload the report
files to an FTP server when completed.

Syntax
config log report output
config addresses
edit address <address_str>
set from <from_sender>
set server <server_ip>
next
end
set email {html | pdf | rtf | txt}
set email-attachment-name <name_str>
set email-body <string>
set email-subject <subject_str>
set file {html | pdf | rtf | txt}
set upload {enable | disable}
set upload-delete {enable | disable}
set upload-dir <directory_str>
set upload-gzipped {enable | disable}
set upload-ip <ip_str>
set upload-password <passwd_str>
set upload-server-type {FTP | SCP | SFTP}
set upload-username <username_str>
end
Keywords and variables Description Default
edit address Enter the email recipients for the FortiAnalyzer report. No default
<address_str>
set from <from_sender> Enter the sender’s email address. No default
set server <server_ip> Enter the server IP address. No default
email Select the file format for the FortiAnalyzer unit sends to the No default
{html | pdf | rtf | txt} email recipients.
email-attachment-name Enter the email output attachment name. No default
<name_str>
email-body Enter the email output body. No default.
<string>
email-subject Enter the email’s subject for the subject line. No default
<subject_str>
file Select the file format the FortiAnalyzer saves to its hard disk. html
{html | pdf | rtf | txt}
upload {enable | disable} Set whether the FortiAnalyzer unit uploads the report files to disable
an FTP server.
All upload keywords are available when upload is enabled.
upload-delete Enable or disable the removal of the log files once the disable
{enable | disable} FortiGate unit has uploaded the log file to the FTP server.
upload-dir Enter the target directory in the uploading server. For example, No default
<directory_str> the file is in d:\, so it would be d:\george_files_xyn2006.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 207
report output log

Keywords and variables Description Default

upload-gzipped Enable or disable the compressing of the log files before disable
{enable | disable} uploading to the FTP server. This keyword is available when
upload is enabled.
upload-server-type Enter the upload server type. FTP
{FTP | SCP | SFTP}
upload-ip <ip_str> Enter the IP address required to connect to the FTP server. No default
This keyword is available when upload is enabled.
upload-password Enter the password required to connect to the FTP server. No default
<passwd_str> This keyword is available when upload is enabled.
upload-username Enter the user name required to connect to the FTP server. No default
<username_str> This keyword is available when upload is enabled.

Example
This example shows how to set the report output to HTML and PDF formats.
config log report output
set output file html pdf
end

History

FortiOS v3.0 New for this release.

FortiOS v3.0 MR2 Added the following keywords:
• email-subject
• upload-server-type
• upload-dir

Related topics
• report definition
• report filter
• report period
• report schedule
• report scope
• report selection

FortiGate CLI Version 3.0 MR6 Reference

208 01-30006-0015-20080205
log report period

report period
Use this command to select the time span for the report period or select a specific time frame. When
the FortiAnalyzer unit generates the report, it uses the log data found within the specified time period
only.

Syntax
config log report period
set type {last-14-days | last-2-weeks |last-30-days | last-7-days
|last-month | last-n-days | last-n-hours | last-n-weeks | last-
quarter | last week | other | this-month | this-quarter | this-week |
this-year | today | yesterday}
end
Keywords and variables Description Default
type {last-14-days | Select a time period for the report. This command is required last-7-
last-2-weeks |last-30- before entering the end and start date for the report period. days
days | last-7-days |last- The end and start date will not appear unless a type is
selected.
month | last-n-days |
last-n-hours | last-n-
weeks | last-quarter |
last week | other | this-
month | this-quarter |
this-week | this-year |
today | yesterday}

Example
This example shows how to set the reporting period to the previous weeks data.
config log report period
set type last-week
end

History

FortiOS v3.0 New for this release.

FortiOS v3.0 MR2 The keyword last-n is no longer available.

Related topics
• report definition
• report filter
• report output
• report schedule
• report scope
• report selection

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 209
report schedule log

report schedule
Use this command to set a schedule when the FortiAnalyzer unit generates the reports.

Syntax
config log report schedule
set type {daily | dates | days | none}
set dates {1-31}
set days {mon | tue | wed | thu | fri | sat |sun}
set time <hh:mm>
end
Keywords and variables Description Default
type {daily | dates | Select when the FortiAnalyzer unit initiates the report. With a none
days | none} selection of none, the FortiAnalyzer administrator must start
the report manually from the FortiAnalyzer unit.
dates {1-31} Select the days of the month when the FortiAnalyzer unit runs No default
the report. Separate multiple dates with a space.
For example, set dates 1 15 30.
days {mon | tue | wed | Select the days of the week when the FortiAnalyzer unit runs No default
thu | fri | sat |sun} the report. Separate multiple dates with a space.
For example, set days mon wed.
time <hh:mm> Select the time of the day when the FortiAnalyzer unit runs the 00:00
report.

Example
This example shows how to set the report to run every Monday at 9:56.
config log report schedule
set type days
set days mon
set time 09:56
end

History

FortiOS v3.0 New for this release.

Related topics
• report definition
• report filter
• report output
• report period
• report scope
• report selection

FortiGate CLI Version 3.0 MR6 Reference

210 01-30006-0015-20080205
log report scope

report scope
Use this command to select the type of results you would like to include in the report.

Syntax
config log report scope
set audit <integer>
set exclude-summary {enable |disable}
set include-nodata {enable | disable}
set include-summary {enable | disable}
set include-table-of-content {enable | disable}
set obfuscate-user {enable | disable}
set resolve-host {enable | disable}
set resolve-service {enable | disable}
set result {all}
set top1 {1-30}
set top2 {1-30}
end
Keywords and variables Description Default
audit <integer> Enter a number from 1 to 10000 to display the top number of 100
values in all audit reports.
exclude-summary Enable to exclude summary information in the report. enable
{enable |disable}
include-nodata Enable to include no summary information in the report. disable
{enable | disable}
include-summary Enable to include the summary information in the report. disable
{enable | disable}
include-table-of-content Enable to include the table of contents in the report. disable
{enable | disable}
obfuscate-user Enable to include obfsucate user group names in the report. disable
{enable | disable}
resolve-host Enable or disable the report to include actual user names disable
{enable | disable} rather than IP addresses. IP aliases must be configured on the
FortiAnalyzer unit. For example, User One instead of
10.10.10.1
resolve-service Enable or disable the report to include names rather than port disable
{enable | disable} numbers. For example, HTTP instead of port 80.
result {all} Set to include the results for all virtual domains all

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 211
report scope log

Keywords and variables Description Default

top1 {1-30} For some report types, you can set the top ranked items for 6
the report. These reports have “Top” in their name, and will
always show only the top number of entries. For example,
report on the most active mail clients within the organization
rather than all mail clients. Enter the value for the first “top”
results.
Reports that do not include “Top” in their name will always
show all information. Changing the values for top field will not
affect these reports.
top2 {1-30} For some report types, you can set the top ranked items for 3
the report. These reports have “Top” in their name, and will
always show only the top number of entries. For example,
report on the most active mail clients within the organization
rather than all mail clients. Enter the value for the second “top”
results.
Reports that do not include “Top” in their name will always
show all information. Changing the values for top field will not
affect these reports.

Example
This example shows how to set the resolving of the host and service names in the report.
config log report scope
set resolve-host enable
set resolve-service enable
end

History
FortiOS v3.0 New for this release.
FortiOS v3.0 MR4 Added the following keywords:
• exclude-summary
• include-summary
• include-nodata
• include-table-of-contents
• obfsucate-user
FortiOS v3.0 MR5 Added the keyword, audit.

Related topics
• report definition
• report filter
• report output
• report period
• report schedule
• report selection

FortiGate CLI Version 3.0 MR6 Reference

212 01-30006-0015-20080205
log report selection

report selection
Use this command to select the reports to include within the report profile.

Syntax
config log report selection
set selection <report_category> [<report> <report>...]
end
Keywords and variables Description Default
selection Select the report types to include. No default
<report_category>
[<report> <report>...]

For a list of report categories and reports, see the list in the command line interface.

Example
This example shows how to set the network activity report.
config log report selection
set network-activity net-date-dir net-dir
end

History

FortiOS v3.0 New for this release.

Related topics
• report definition
• report filter
• report output
• report period
• report schedule
• report scope

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 213
report summary-layout log

report summary-layout
Use this command to customize the summary reports.

Syntax
config log report summary-layout
set summary-column {1 | 2 | 3 | 4}
config summary-reports
edit name <sum_category> [<sum_report> <sum_report>...]
set order <integer>
set style {bar | line | pie}
set topN <integer>
end
Keywords and variables Description Default
summary-column Select a number for the number of columns included in the 2
{1 | 2 | 3 | 4} summary layout.
summary-reports Enter to configure and edit summary reports. No default
name <sum_category> Select a report name to configure and edit. Enter enter No default.
[<sum_report> name to view all summary reports so you can choose which
<sum_report>...] one to configure and edit.

order <integer> Enter a number to specify the display order of query in report. 100
style {bar | line | pie} Select the style for the summary report. pie
topN <integer> Enter a number to show the top values of the first variable in 1-10
Ranked Reports. The maximum value is 100.

Example
In this example, the number of columns in the summary layout is three. There are four summary
reports included in this report, the summary protocol distribution, total viruses detected, total spam
activity, and total web filter activity. The summary report, total viruses detected, will come first and all
summary reports will be pie charts.
config log report summary-layout
set summary-column 3
config summary-reports
edit name sum-proto
set order 4
set style column
set topN 5
next
edit name sum-tv
set order 1
set style bar
set topN 5
next
edit name sum-mf
set order 2
set style line
set topN 5
next

FortiGate CLI Version 3.0 MR6 Reference

214 01-30006-0015-20080205
log report summary-layout

edit name sum-wf

set order 3
set style pie
set topN 5
end
end

History

FortiOS v3.0 MR4 New for this release.

Related topics
• report definition
• report filter
• report output
• report period
• report schedule
• report scope

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 215
syslogd setting log

syslogd setting
Use this command to configure log settings for logging to a remote syslog server. You can configure
the FortiGate unit to send logs to a remote computer running a syslog server.
Using the CLI, you can send logs to up to three different syslog servers. Configure additional syslog
servers using syslogd2 and syslogd3 commands and the same keywords outlined below.
Note: Syslog CLI commands are not cumulative. Using a syntax similar to the following is not valid:
config log syslogd syslogd2 syslogd3 setting

Syntax
config log syslogd 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 port <port_integer>
set server <address_ipv4>
set status {disable | enable}
end
Keywords and variables Description Default
csv {disable | enable} Enter enable to enable the FortiGate unit to produce the log in disable
Comma Separated Value (CSV) format. If you do not enable
CSV format the FortiGate unit produces plain text files.
facility {alert | audit | Enter the facility type. facility identifies the source of the log local7
auth | authpriv | clock | message to syslog. You might want to change facility to
cron | daemon | ftp | distinguish log messages from different FortiGate units.
Available facility types are:
kernel | local0 | local1
• alert: log alert
| local2 | local3 |
• audit: log audit
local4 | local5 | local6
• auth: security/authorization messages
| local7 | lpr | mail |
• authpriv: security/authorization messages (private)
news | ntp | syslog |
• clock: clock daemon
user | uucp}
• cron: cron daemon performing scheduled commands
• daemon: system daemons running background system
processes
• ftp: File Transfer Protocol (FTP) daemon
• kernel: kernel messages
• local0 – local7: reserved for local use
• lpr: line printer subsystem
• mail: email system
• news: network news subsystem
• ntp: Network Time Protocol (NTP) daemon
• syslog: messages generated internally by the syslog
daemon
port <port_integer> Enter the port number for communication with the syslog server. 514
server <address_ipv4> Enter the IP address of the syslog server that stores the logs. No default.
status {disable | enable} Enter enable to enable logging to a remote syslog server. disable

FortiGate CLI Version 3.0 MR6 Reference

216 01-30006-0015-20080205
log syslogd setting

Example
This example shows how to enable logging to a remote syslog server, configure an IP address and
port for the server, and enable logging in CSV format.
config log syslogd setting
set status enable
set server 220.210.200.190
set port 601
set csv enable
end

History

FortiOS v2.80 Substantially revised.

FortiOS v2.80 MR3 Added alert and audit keywords for use with facility keyword.
FortiOS v3.0 Command includes up to three syslog servers, syslogd2 and syslogd3.

Related topics
• log {disk | fortianalyzer | memory | syslogd | webtrends | fortiguard} filter
• log fortianalyzer setting
• log memory setting
• log webtrends setting
• log trafficfilter
• log report definition

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 217
trafficfilter log

trafficfilter
Use this command to configure the following global settings for traffic logging:
• resolve IP addresses to host names
• display the port number or service (protocol) in the log message

Syntax
config log trafficfilter
set display {name | port}
set resolve {disable | enable}
end
The config log trafficfilter command has 1 subcommand.
config rule

Keywords and variables Description Default

display {name | port} Enter name to enable the display of the service name in the port
traffic log messages. Enter port to display the port number
used by traffic in traffic log messages.
resolve Enter enable to enable resolving IP addresses to host names disable
{disable | enable} in traffic log messages.

Example
This example shows how to display the service name and enable resolving IP addresses to host
names in log messages.
config log trafficfilter
set display name
set resolve enable
end

config rule
Access the rule subcommand using the log trafficfilter command.
Use the following commands to configure traffic filter rules based on source IP address, destination IP
address, and service (protocol).

Syntax
config rule
edit <name_str>
set dst <any_ip&any_netmask>
set service <name_str>
set src <class_ip&net_netmask>
end

FortiGate CLI Version 3.0 MR6 Reference

218 01-30006-0015-20080205
log trafficfilter

Keywords and variables Description Default

dst <any_ip&any_netmask> Enter the destination IP address and netmask where you want 0.0.0.0
to filter traffic logs to. 0.0.0.0
service <name_str> Enter the service that you want to filter traffic logs. You can No default.
choose from any of the predefined services listed and any
custom services you have configured. See “service custom” on
page 152.
src Enter the source IP address and netmask where you want to 0.0.0.0
<class_ip&net_netmask> filter traffic logs to. 0.0.0.0

Example
This example shows how to configure a traffic filter called TF_1, to configure the source and
destination IP and netmask, and to set the service to HTTP.
config log trafficfilter
config rule
edit TF_1
set dst 220.210.200.190 255.255.255.0
set src 192.168.100.1 255.255.255.0
set service HTTP
end
end

History

FortiOS v2.80 Revised.

Related topics
• log {disk | fortianalyzer | memory | syslogd | webtrends | fortiguard} filter
• log fortianalyzer setting
• log memory setting
• log syslogd setting
• log webtrends setting
• log report definition

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 219
webtrends setting log

webtrends setting
Use this command to configure log settings for logging to a remote computer running a NetIQ
WebTrends firewall reporting server.
FortiGate log formats comply with WebTrends Enhanced Log Format (WELF) and are compatible with
NetIQ WebTrends Security Reporting Center and Firewall Suite 4.1.

Syntax
config log webtrends setting
set server <address_ipv4>
set status {disable | enable}
end
Keywords and variables Description Default
server <address_ipv4> Enter the IP address of the WebTrends server that stores the No default.
logs.
status {disable | enable} Enter enable to enable logging to a WebTrends server. disable

Example
This example shows how to enable logging to and set an IP address for a remote WebTrends server.
config log webtrends setting
set status enable
set server 220.210.200.190
end

History

FortiOS v2.80 Substantially revised.

Related topics
• log {disk | fortianalyzer | memory | syslogd | webtrends | fortiguard} filter
• log fortianalyzer setting
• log memory setting
• log syslogd setting
• log trafficfilter
• log report definition

FortiGate CLI Version 3.0 MR6 Reference

220 01-30006-0015-20080205
notification (FortiOS Carrier)

notification (FortiOS Carrier)

This chapter covers the commands to configure event notification.
This chapter contains the following sections:

notification

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 221
notification notification (FortiOS Carrier)

notification
Use this command to configure event notification.

Syntax
config notification
set maximum-retries <integer>
set maximum-sessions <integer>
set mem-percent <integer>
end

Variables Description Default

maximum-retries <integer> Enter the maximum number of retries allowed for each 20
notification message.
maximum-sessions <integer> Enter the maximum number of simultaneous sessions with the 2048
MMSC.
mem-percent <integer> Enter the percentage of memory the notification cache is 5
allowed to use.

History

FortiOS v3.00 MR5 New.

FortiGate CLI Version 3.0 MR6 Reference

222 01-30006-0015-20080205
router

router
Routers move packets from one network segment to another towards a network destination. When a
packet reaches a router, the router uses data in the packet header to look up a suitable route on which
to forward the packet to the next segment. The information that a router uses to make routing decisions
is stored in a routing table. Other factors related to the availability of routes and the status of the
network may influence the route selection that a router makes when forwarding a packet to the next
segment.
The FortiGate unit supports many advanced routing functions and is compatible with industry standard
Internet routers. The FortiGate unit can communicate with other routers to determine the best route for
a packet.
The following router commands are available to configure options related to FortiGate router
communications and packet forwarding:

access-list key-chain rip

aspath-list multicast route-map
auth-path ospf static
bgp policy static6
community-list prefix-list

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 223
access-list router

access-list
Use this command to add, edit, or delete access lists. Access lists are filters used by FortiGate routing
processes. For an access list to take effect, it must be called by a FortiGate routing process (for
example, a process that supports RIP or OSPF).
Each rule in an access list consists of a prefix (IP address and netmask), the action to take for this
prefix (permit or deny), and whether to match the prefix exactly or to match the prefix and any more
specific prefix.

Note: The default route, 0.0.0.0/0 can not be exactly matched with an access-list. A prefix-list must be
used for this purpose. See “prefix-list” on page 275.

The FortiGate unit attempts to match a packet against the rules in an access list starting at the top of
the list. If it finds a match for the prefix, it takes the action specified for that prefix. If no match is found
the default action is deny.

Syntax
config router access-list
edit <access_list_name>
config rule
edit <access_list_id>
set action {deny | permit}
set exact-match {enable | disable}
set prefix { <prefix_ipv4mask> | any }
set wildcard <address_ipv4> <wildcard_mask>
end
end

Note: The action and prefix keywords are required. The exact-match keyword is optional.

Variables Description Default

edit <access_list_name> Enter a name for the access list. An access list and a No default.
prefix list cannot have the same name.
config rule variables
edit <access_list_id> Enter an entry number for the rule. The number must be No default.
an integer.
action {deny | permit} Set the action to take for this prefix. permit
exact-match {enable | disable} By default, access list rules are matched on the prefix or disable
any more specific prefix. Enable exact-match to match
only the configured prefix.
prefix { Enter the prefix for this access list rule, either: any
<prefix_ipv4mask> | any } • Type the IP address and network mask.
• Type any to match any prefix.
wildcard <address_ipv4> Enter the IP address and reverse (wildcard) mask to No default.
<wildcard_mask> process. The value of the mask (for example,
0.0.255.0) determines which address bits to match. A
value of 0 means that an exact match is required, while a
binary value of 1 indicates that part of the binary network
address does not have to match. You can specify
discontinuous masks (for example, to process “even” or
“odd” networks according to any network address octet).
For best results, do not specify a wildcard attribute
unless prefix is set to any.

FortiGate CLI Version 3.0 MR6 Reference

224 01-30006-0015-20080205
router access-list

Example
This example shows how to add an access list named acc_list1 with two rules. The first rule denies
the subnet that exactly matches the prefix 192.168.50.0 255.255.255.0 and permits all other
subnets that match the prefix 192.168.0.0 255.255.0.0.
config router access-list
edit acc_list1
config rule
edit 1
set prefix 192.168.50.0 255.255.255.0
set action deny
set exact-match enable
next
edit 2
set prefix 192.168.0.0 255.255.0.0
set action permit
set exact-match disable
end
end
The next example shows how to add an access list that permits all subnets matching network address
10.20.4.1 through 10.20.4.255 (addresses 10.20.4.x are processed):
config router access-list
edit acc_list2
config rule
edit 1
set action permit
set wildcard 10.20.4.0 0.0.0.255
end
end
The next example shows how to add an access list that permits “odd” subnets according to the third-
octet of network address 172.16.x.0 (networks 172.16.1.0, 172.16.3.0, 172.16.5.0, and so on are
processed):
config router access-list
edit acc_list3
config rule
edit 1
set action permit
set wildcard 172.16.1.0 0.0.254.0
end
end

History

FortiOS v2.80 New.

FortiOS v3.0 Added wildcard attribute. Changed exact_match keyword to exact-match.

Related topics
• router ospf
• router prefix-list
• router rip

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 225
aspath-list router

aspath-list
Use this command to set or unset BGP AS-path list parameters. By default, BGP uses an ordered list
of Autonomous System (AS) numbers to describe the route that a packet takes to reach its destination.
A list of AS numbers is called an AS path. You can filter BGP routes using AS path lists.
When the FortiGate unit receives routing updates from other autonomous systems, it can perform
operations on updates from neighbors and choose the shortest path to a destination. The shortest path
is determined by counting the number of AS numbers in the AS path. The path that has the least
number of AS numbers is considered the shortest AS path.
Use the config router aspath-list command to define an access list that examines the
AS_PATH attributes of BGP routes to match routes. Each entry in the AS-path list defines a rule for
matching and selecting routes based on the setting of the AS_PATH attribute. The default rule in an AS
path list (which the FortiGate unit applies last) denies the matching of all routes.

Syntax
config router aspath-list
edit <aspath_list_name>
config rule
edit <as_rule_id>
set action {deny | permit}
set regexp <regexp_str>
end
end

Note: The action and regexp keywords are required.

Variables Description Default

edit <aspath_list_name> Enter a name for the AS path list. No default.
config rule variables
edit <as_rule_id> Enter an entry number for the rule. The number must be an No default.
integer.
action {deny | permit} Deny or permit operations on a route based on the value of No default.
the route’s AS_PATH attribute.
regexp <regexp_str> Specify the regular expression that will be compared to the Null.
AS_PATH attribute (for example, ^730$).
The value is used to match AS numbers. Delimit a complex
regexp_str value using double-quotation marks.

Example
This example shows how to create an AS-path list named ebgp_in. The list contains a single rule that
permits operations on BGP routes whose AS_PATH attribute references an AS number of 333, 334,
338, or 71. The AS path list will match routes that originate in AS 333, AS 334, AS 338, or AS 71.
config router aspath-list
edit ebgp_in
config rule
edit 1
set action permit
set regexp _(333|334|338|71)$
end
end

FortiGate CLI Version 3.0 MR6 Reference

226 01-30006-0015-20080205
router aspath-list

History

FortiOS v3.0 New.

Related topics
• router bgp
• router community-list
• Using route maps with BGP
• router key-chain

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 227
auth-path router

auth-path
Authentication based routing allows firewall policies to determine how to direct network traffic flows.

To configure authentication based routing:

• A RADIUS authentication server must be configured.
• A user must be configured to use the RADIUS server, and added to a user group.
• The router auth-path object must be configured.
• A custom service must be configured for RADIUS traffic, and included in a firewall custom service
group along with other types of traffic that will be allowed to pass through the firewall.
• A firewall policy must be configured to have authentication based routing enabled.

Syntax
config router auth-path
edit <aspath_list_name>
set device <interface>
set gateway <gway_ipv4>
end
Variables Description Default
edit <auth_path_name> Enter a name for the authentication path. No default.
device <interface> Specify the interface for this path. No default.
gateway <gway_ipv4> Specify the gateway IP address for this path. Null.

History

FortiOS v3.0 MR6 New.

Related topics
• user local
• user radius
• firewall policy, policy6

FortiGate CLI Version 3.0 MR6 Reference

228 01-30006-0015-20080205
router bgp

bgp
Use this command to set or unset BGP-4 routing parameters. BGP can be used to perform Classless
Interdomain Routing (CIDR) and to route traffic between different autonomous systems or domains
using an alternative route if a link between a FortiGate unit and a BGP peer (such as an ISP router)
fails. Fortinet BGP-4 complies with RFC 1771 and supports IPv4 addressing.
When BGP is enabled, the FortiGate unit sends routing table updates to the upstream ISP router
whenever any part of the routing table changes. The update advertises which routes can be used to
reach the FortiGate unit. In this way, routes are made known from the border of the internal network
outwards (routes are pushed forward) instead of relying on upstream routers to propagate alternative
paths to the FortiGate unit.
FortiGate BGP supports the following extensions to help manage large numbers of BGP peers:
• Communities — The FortiGate unit can set the COMMUNITY attribute of a route to assign the route
to predefined paths (see RFC 1997). The FortiGate unit can examine the COMMUNITY attribute of
learned routes to perform local filtering and/or redistribution.
• Internal BGP (IBGP) route reflectors — The FortiGate unit can operate as a route reflector or
participate as a client in a cluster of IBGP peers (see RFC 1966).
• External BGP (EBGP) confederations — The FortiGate unit can operate as a confederation
member, using its AS confederation identifier in all transactions with peers that are not members of
its confederation (see RFC 3065).
Bi-directional Forwarding Detection (BFD) is a protocol used by BGP and OSPF. It is used to quickly
locate hardware failures in the network. Routers running BFD communicate with each other, and if a
timer runs out on a connection then that router is declared down. BFD then communicates this
information to the routing protocol and the routing information is updated. BFD support was added in
FortiOS v3.0 MR4, and can only be configured through the CLI.

Syntax
config router bgp
set always-compare-med {enable | disable}
set as <local_as_id>
set bestpath-as-path-ignore {enable | disable}
set bestpath-cmp-confed-aspath {enable | disable}
set bestpath-cmp-routerid {enable | disable}
set bestpath-med-confed {enable | disable}
set bestpath-med-missing-as-worst {enable | disable}
set client-to-client-reflection {enable | disable}
set cluster-id <address_ipv4>
set confederation-identifier <peerid_integer>
set dampening {enable | disable}
set dampening-max-suppress-time <minutes_integer>
set dampening-reachability-half-life <minutes_integer>
set dampening-reuse <reuse_integer>
set dampening-route-map <routemap-name_str>
set dampening-suppress <limit_integer>
set dampening-unreachability-half-life <minutes_integer>
set default-local-preference <preference_integer>
set deterministic-med {enable | disable}
set distance-external <distance_integer>
set distance-internal <distance_integer>
set distance-local <distance_integer>
set enforce-first-as {enable | disable}

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 229
bgp router

set fast-external-failover {enable | disable}

set graceful_restart {enable | disable}
set holdtime-timer <seconds_integer>
set ignore_optional_capability {enable | disable}
set keep-alive-timer <seconds_integer>
set log-neighbor-changes {enable | disable}
set network-import-check {enable | disable}
set router-id <address_ipv4>
set scan-time <seconds_integer>
set synchronization {enable | disable}
config admin-distance
edit <route_entry_id>
set distance <integer>
set neighbor-prefix <ip_and_netmask>
set route-list <string>
end
config aggregate-address
edit <aggr_addr_id>
set as-set {enable | disable}
set prefix <address_ipv4mask>
set summary-only {enable | disable}
end
config neighbor
edit <neighbor_address_ipv4>
set activate {enable | disable}
set advertisement-interval <seconds_integer>
set allowas-in <seconds_integer>
set allowas-in-enable {enable | disable}
set attribute-unchanged [as-path] [med] [next-hop]
set bfd {enable | disable}
set capability-default-originate {enable | disable}
set capability-dynamic {enable | disable}
set capability-graceful-restart {enable | disable}
set capability-orf {both | none | recieve | send}
set capability-route-refresh {enable | disable}
set connect-timer <seconds_integer>
set description <text_str>
set distribute-list-in <access-list-name_str>
set distribute-list-out <access-list-name_str>
set dont-capability-negotiate {enable | disable}
set ebgp-enforce-multihop {enable | disable}
set ebgp-multihop {enable | disable}
set ebgp-multihop-ttl <seconds_integer>
set filter-list-in <aspath-list-name_str>
set filter-list-out <aspath-list-name_str>
set holdtime-timer <seconds_integer>
set interface <interface-name_str>
set keep-alive-timer <seconds_integer>
set maximum-prefix <prefix_integer>
set maximum-prefix-threshold <percentage_integer>
set maximum-prefix-warning-only {enable | disable}
set next-hop-self {enable | disable}
set override-capability {enable | disable}
set passive {enable | disable}

FortiGate CLI Version 3.0 MR6 Reference

230 01-30006-0015-20080205
router bgp

set prefix-list-in <prefix-list-name_str>

set prefix-list-out <prefix-list-name_str>
set remote-as <id_integer>
set remove-private-as {enable | disable}
set retain-stale-time <seconds_integer>
set route-map-in <routemap-name_str>
set route-map-out <routemap-name_str>
set route-reflector-client {enable | disable}
set route-server-client {enable | disable}
set send-community {both | disable | extended | standard}
set shutdown {enable | disable}
set soft-reconfiguration {enable | disable}
set strict-capability-match {enable | disable}
set unsuppress-map <route-map-name_str>
set update-source <interface-name_str>
set weight <weight_integer>
end
config network
edit <network_id>
set backdoor {enable | disable}
set prefix <address_ipv4mask>
set route-map <routemap-name_str>
end
config redistribute {connected | static | rip | ospf}
set status {enable | disable}
set route-map <route-map-name_str>
end
end

config router bgp

Use this command to enable a Border Gateway Protocol version 4 (BGP-4) process on the FortiGate
unit, define the interfaces making up the local BGP network (see “config network” on page 239), and
set operating parameters for communicating with BGP neighbors (see “config neighbor” on page 235).
When multiple routes to the FortiGate unit exist, BGP attributes determine the best route and the
FortiGate unit communicates this information to its BGP peers. The best route is added to the IP
routing table of the BGP peer, which in turn propagates this updated routing information to upstream
routers.
FortiGate units maintain separate entries in their routing tables for BGP routes. See “Using route maps
with BGP” on page 288. To reduce the size of the BGP routing table and conserve network resources,
you can optionally aggregate routes to the FortiGate unit. An aggregate route enables the FortiGate
unit to advertise one block of contiguous IP addresses as a single, less-specific address. You can
implement aggregate routing either by redistributing an aggregate route (see “config redistribute” on
page 240) or by using the conditional aggregate routing feature (see “config aggregate-address” on
page 235).

Note: In the following table, the as and router-id keywords are required. All other keywords are optional.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 231
bgp router

Variables Description Default

always-compare-med Enable or disable the comparison of MULTI_EXIT_DISC disable
{enable | disable} (Multi Exit Discriminator or MED) attributes for identical
destinations advertised by BGP peers in different
autonomous systems.
as <local_as_id> Enter an integer to specify the local autonomous system (AS) 0
number of the FortiGate unit. The range is from 1 to 65 535.
When the local_as_id number is different than the AS
number of the specified BGP neighbor (see “remote-as
<id_integer>” on page 238), an External BGP (EBGP)
session is started. Otherwise, an Internal BGP (IBGP)
session is started. A value of 0 is not allowed.
bestpath-as-path-ignore Enable or disable the inclusion of an AS path in the selection disable
{enable | disable} algorithm for choosing a BGP route.
bestpath-cmp-confed- Enable or disable the comparison of the disable
aspath {enable | disable} AS_CONFED_SEQUENCE attribute, which defines an
ordered list of AS numbers representing a path from the
FortiGate unit through autonomous systems within the local
confederation.
bestpath-cmp-routerid Enable or disable the comparison of the router-ID values for disable
{enable | disable} identical EBGP paths.
bestpath-med-confed Enable or disable the comparison of MED attributes for routes disable
{enable | disable} advertised by confederation EBGP peers.
bestpath-med-missing-as- This keyword is available when bestpath-med-confed is disable
worst {enable | disable} set to enable.
When bestpath-med-confed is enabled, treat any
confederation path with a missing MED metric as the least
preferred path.
client-to-client- Enable or disable client-to-client route reflection between enable
reflection IBGP peers. If the clients are fully meshed, route reflection
{enable | disable} may be disabled.

cluster-id <address_ipv4> Set the identifier of the route-reflector in the cluster ID to 0.0.0.0
which the FortiGate unit belongs. If 0 is specified, the
FortiGate unit operates as the route reflector and its
router-id value is used as the cluster-id value. If the
FortiGate unit identifies its own cluster ID in the
CLUSTER_LIST attribute of a received route, the route is
ignored to prevent looping.
confederation-identifier Set the identifier of the confederation to which the FortiGate 0
<peerid_integer> unit belongs. The range is from 1 to 65 535.
dampening {enable | Enable or disable route-flap dampening on all BGP routes. disable
disable} See RFC 2439. (A flapping route is unstable and continually
transitions down and up.) If you set dampening, you may
optionally set dampening-route-map or define the
associated values individually using the dampening-*
keywords.
dampening-max-suppress- This keyword is available when dampening is set to 60
time <minutes_integer> enable.
Set the maximum time (in minutes) that a route can be
suppressed. The range is from 1 to 255. A route may
continue to accumulate penalties while it is suppressed.
However, the route cannot be suppressed longer than
minutes_integer.
dampening-reachability- This keyword is available when dampening is set to 15
half-life enable.
<minutes_integer> Set the time (in minutes) after which any penalty assigned to
a reachable (but flapping) route is decreased by half. The
range is from 1 to 45.

FortiGate CLI Version 3.0 MR6 Reference

232 01-30006-0015-20080205
router bgp

Variables Description Default

dampening-reuse This keyword is available when dampening is set to 750
<reuse_integer> enable.
Set a dampening-reuse limit based on accumulated
penalties. The range is from 1 to 20 000. If the penalty
assigned to a flapping route decreases enough to fall below
the specified reuse_integer, the route is not suppressed.
dampening-route-map This keyword is available when dampening is set to Null.
<routemap-name_str> enable.
Specify the route-map that contains criteria for dampening.
You must create the route-map before it can be selected
here. See “route-map” on page 286 and “Using route maps
with BGP” on page 288.
dampening-suppress This keyword is available when dampening is set to 2 000
<limit_integer> enable.
Set a dampening-suppression limit. The range is from 1 to
20 000. A route is suppressed (not advertised) when its
penalty exceeds the specified limit.
dampening-unreachability- This keyword is available when dampening is set to 15
half-life enable.
<minutes_integer> Set the time (in minutes) after which the penalty on a route
that is considered unreachable is decreased by half. The
range is from 1 to 45.
default-local-preference Set the default local preference value. A higher value 100
<preference_integer> signifies a preferred route. The range is from 0 to
4 294 967 295.
deterministic-med Enable or disable deterministic comparison of the MED disable
{enable | disable} attributes of routes advertised by peers in the same AS.
distance-external Set the administrative distance of EBGP routes. The range is 20
<distance_integer> from 1 to 255. If you set this value, you must also set values
for distance-internal and distance-local.
distance-internal This keyword is available when distance-external is set. 200
<distance_integer> Set the administrative distance of IBGP routes. The range is
from 1 to 255.
distance-local This keyword is available when distance-external is set. 200
<distance_integer> Set the administrative distance of local BGP routes. The
range is from 1 to 255.
enforce-first-as Enable or disable the addition of routes learned from an disable
{enable | disable} EBGP peer when the AS number at the beginning of the
route’s AS_PATH attribute does not match the AS number of
the EBGP peer.
fast-external-failover Immediately reset the session information associated with enable
{enable | disable} BGP external peers if the link used to reach them goes down.
graceful_restart Graceful restart capability limits the effects of software disable
{enable | disable} problems by allowing forwarding to continue when the control
plane of the router fails. It also reduces routing flaps by
stabilizing the network.
holdtime-timer The maximum amount of time (in seconds) that may expire 240
<seconds_integer> before the FortiGate unit declares any BGP peer down. A
keepalive message must be received every
seconds_integer seconds, or the peer is declared down.
The value can be 0 or an integer in the 3 to 65 535 range.
ignore_optional_capabilit Don’t send unknown optional capability notification message. disable
y {enable | disable}
keep-alive-timer The frequency (in seconds) that a keepalive message is sent 60
<seconds_integer> from the FortiGate unit to any BGP peer. The range is from 0
to 65 535. BGP peers exchange keepalive messages to
maintain the connection for the duration of the session.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 233
bgp router

Variables Description Default

log-neighbor-changes Enable or disable the logging of changes to BGP neighbor disable
{enable | disable} status.
network-import-check Enable or disable the advertising of the BGP network in IGP enable
{enable | disable} (see “config network” on page 239).
router-id <address_ipv4> Specify a fixed identifier for the FortiGate unit. A value of 0.0.0.0
0.0.0.0 is not allowed.
scan-time Configure the background scanner interval (in seconds) for 60
<seconds_integer> next-hop route scanning. The range is from 5 to 60.
synchronization Only advertise routes from iBGP if routes are present in an disable
{enable | disable} interior gateway protocol (IGP) such as RIP or OSPF.

Example
The following example defines the number of the AS of which the FortiGate unit is a member. It also
defines an EBGP neighbor at IP address 10.0.1.2.
config router bgp
set as 65001
set router-id 172.16.120.20
config neighbor
edit 10.0.1.2
set remote-as 65100
end
end

config admin-distance
Use this subcommand to set administrative distance modifications for bgp routes.

Variables Description Default

edit <route_entry_id> Enter an ID number for the entry. The number must be an integer. No default.
distance <integer> The administrative distance to apply to the route. This value can No default.
be from 1 to 255.
neighbor-prefix Neighbor address prefix. This variable must be a valid IP address No default.
<ip_and_netmask> and netmask.
route-list <string> The list of routes this distance will be applied to. No default.
The routes in this list can only come from the access-list which can
be viewed at config router access-list.

Example
This example shows how to manually adjust the distance associated with a route. It shows adding 25
to the weight of the route, that it will apply to neighbor routes with an IP address of 192.168.0.0 and a
netmask of 255.255.0.0, that are also permitted by the access-list “downtown_office”.
config router bgp
config admin-distance
edit 1
set distance 25
set neighbour-prefix 192.168.0.0 255.255.0.0
set route-list downtown_office
next
end
end

FortiGate CLI Version 3.0 MR6 Reference

234 01-30006-0015-20080205
router bgp

config aggregate-address
Use this subcommand to set or unset BGP aggregate-address table parameters. The subcommand
creates a BGP aggregate entry in the FortiGate routing table.
When you aggregate routes, routing becomes less precise because path details are not readily
available for routing purposes. The aggregate address represents addresses in several autonomous
systems. Aggregation reduces the length of the network mask until it masks only the bits that are
common to all of the addresses being summarized.

Note: The prefix keyword is required. All other keywords are optional.

Variables Description Default

edit <aggr_addr_id> Enter an ID number for the entry. The number must be an No default.
integer.
as-set {enable | disable} Enable or disable the generation of an unordered list of AS disable
numbers to include in the path information. When as-set is
enabled, a set-atomic-aggregate value (see “Using
route maps with BGP” on page 288) does not have to be
specified.
prefix <address_ipv4mask> Set an aggregate prefix. Include the IP address and netmask. 0.0.0.0
0.0.0.0
summary-only Enable or disable the advertising of aggregate routes only disable
{enable | disable} (the advertising of specific routes is suppressed).

Example
This example shows how to define an aggregate prefix of 192.168.0.0/16. The as-set command
enables the generation of an unordered list of AS numbers to include in the path information.
config router bgp
config aggregate-address
edit 1
set prefix 192.168.0.0/16
set as-set enable
end
end

config neighbor
Use this subcommand to set or unset BGP neighbor configuration settings. The subcommand adds a
BGP neighbor configuration to the FortiGate unit.
You can clear all or some BGP neighbor connections (sessions) using the exec router clear bgp
command (see “router clear bgp” on page 606).

Note: The remote-as keyword is required. All other keywords are optional.

Variables Description Default

edit <neighbor_address_ipv4> Enter the IP address of the BGP neighbor. No default.
activate {enable | disable} Enable or disable the address family for the BGP enable
neighbor.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 235
bgp router

Variables Description Default

advertisement-interval Set the minimum amount of time (in seconds) that the 30
<seconds_integer> FortiGate unit waits before sending a BGP routing
update to the BGP neighbor. The range is from 0 to
600.
allowas-in <seconds_integer> This keyword is available when allowas-in-enable unset
is set to enable.
Set the amount of time (in seconds) that the FortiGate
unit waits before readvertising to the BGP neighbor all
prefixes that contain duplicate AS numbers. The range
is from 1 to 10.
allowas-in-enable Enable or disable the readvertising of all prefixes disable
{enable | disable} containing duplicate AS numbers. Set the amount of
time that must expire before readvertising through the
allowas-in keyword.
attribute-unchanged [as-path] Propagate unchanged BGP attributes to the BGP Empty set.
[med] [next-hop] neighbor.
• To advertise unchanged AS_PATH attributes, select
as-path.
• To advertise unchanged MULTI_EXIT_DISC
attributes, select med.
• To advertise the IP address of the next-hop router
interface (even when the address has not changed),
select next-hop.
An empty set is a supported value.
bfd {enable | disable} Enable to turn on Bi-Directional Forwarding Detection disable
(BFD) for this neighbor. This indicates that this neighbor
is using BFD.
capability-default-originate Enable or disable the advertising of the default route to disable
{enable | disable} BGP neighbors.
capability-dynamic Enable or disable the advertising of dynamic capability disable
{enable | disable} to BGP neighbors.
capability-graceful-restart Enable or disable the advertising of graceful-restart disable
{enable | disable} capability to BGP neighbors.
capability-orf {both | disable Enable or disable the advertising of Outbound Routing disable
| receive | send} Filter (ORF) prefix-list capability to the BGP neighbor.
• To enable send and receive capability, select both.
• To enable receive capability, select receive.
• To enable send capability, select send.
To disable the advertising of ORF prefix-list capability,
select disable.
capability-orf {both | none | Accept/Send outbound router filter none
recieve | send} (ORF) lists to/from this neighbor:
• both - both accept and send ORF lists
• none - do not accept or send ORF lists
• recieve - only accept ORF lists
• send - only send ORF lists
capability-route-refresh Enable or disable the advertising of route-refresh enable
{enable | disable} capability to the BGP neighbor.
connect-timer Set the maximum amount of time (in seconds) that the -1 (not set)
<seconds_integer> FortiGate unit waits to make a connection with a BGP
neighbor before the neighbor is declared unreachable.
The range is from 0 to 65 535.
description <text_str> Enter a one-word (no spaces) description to associate Null.
with the BGP neighbor configuration settings.

FortiGate CLI Version 3.0 MR6 Reference

236 01-30006-0015-20080205
router bgp

Variables Description Default

distribute-list-in Limit route updates from the BGP neighbor based on Null.
<access-list-name_str> the Network Layer Reachability Information (NLRI)
defined in the specified access list. You must create the
access list before it can be selected here. See “access-
list” on page 224.
distribute-list-out Limit route updates to the BGP neighbor based on the Null.
<access-list-name_str> NLRI defined in the specified access list. You must
create the access list before it can be selected here.
See “access-list” on page 224.
dont-capability-negotiate Enable or disable capability negotiations with the BGP disable
{enable | disable} neighbor.
ebgp-enforce-multihop Enable or disable the enforcement of Exterior BGP disable
{enable | disable} (EBGP) multihops.
ebgp-multihop Enable or disable communications with EBGP disable
{enable | disable} neighbors that are not one hop away. When you enable
ebgp-multihop, set an ebgp-multihop-ttl value
to change the Time-To-Live (TTL) duration of the EBGP
packets.
ebgp-multihop-ttl This keyword is available when ebgp-multihop is set 255
<seconds_integer> to enable.
Define a TTL value (in hop counts) for BGP packets
sent to the BGP neighbor. The range is from 1 to 255.
filter-list-in Limit inbound BGP routes according to the specified Null.
<aspath-list-name_str> AS-path list. You must create the AS-path list before it
can be selected here. See “aspath-list” on page 226.
filter-list-out Limit outbound BGP routes according to the specified Null.
<aspath-list-name_str> AS-path list. You must create the AS-path list before it
can be selected here. See “aspath-list” on page 226.
holdtime-timer The amount of time (in seconds) that must expire -1 (not set)
<seconds_integer> before the FortiGate unit declares the BGP neighbor
down. This value overrides the global holdtime-
timer value (see “holdtime-timer
<seconds_integer>” on page 233). A keepalive
message must be received every seconds_integer
from the BGP neighbor or it is declared down. The
value can be 0 or an integer in the 3 to 65 535 range.
interface <interface-name_str> Specify a descriptive name for the BGP neighbor Null.
interface.
keep-alive-timer The frequency (in seconds) that a keepalive message -1 (not set)
<seconds_integer> is sent from the FortiGate unit to the BGP neighbor.
This value overrides the global keep-alive-timer
value (see “keep-alive-timer
<seconds_integer>” on page 233). The range is
from 0 to 65 535.
maximum-prefix Set the maximum number of NLRI prefixes to accept unset
<prefix_integer> from the BGP neighbor. When the maximum is
reached, the FortiGate unit disconnects the BGP
neighbor. The range is from 1 to 4 294 967 295.
Changing this value on the FortiGate unit does not
disconnect the BGP neighbor. However, if the neighbor
goes down because it reaches the maximum number of
prefixes and you increase the maximum-prefix value
afterward, the neighbor will be reset.
maximum-prefix-threshold This keyword is available when maximum-prefix is 75
<percentage_integer> set.
Specify the threshold (as a percentage) that must be
exceeded before a warning message about the
maximum number of NLRI prefixes is displayed. The
range is from 1 to 100.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 237
bgp router

Variables Description Default

maximum-prefix-warning-only This keyword is available when maximum-prefix is disable
{enable | disable} set.
Enable or disable the display of a warning when the
maximum-prefix-threshold has been reached.
next-hop-self Enable or disable advertising of the FortiGate unit’s IP disable
{enable | disable} address (instead of the neighbor’s IP address) in the
NEXT_HOP information that is sent to IBGP peers.
override-capability Enable or disable IPv6 addressing for a BGP neighbor disable
{enable | disable} that does not support capability negotiation.
passive {enable | disable} Enable or disable the sending of Open messages to disable
BGP neighbors.
prefix-list-in Limit route updates from a BGP neighbor based on the Null.
<prefix-list-name_str> Network Layer Reachability Information (NLRI) in the
specified prefix list. The prefix list defines the NLRI
prefix and length advertised in a route. You must create
the prefix list before it can be selected here. See
“prefix-list” on page 275
prefix-list-out Limit route updates to a BGP neighbor based on the Null.
<prefix-list-name_str> NLRI in the specified prefix list. The prefix list defines
the NLRI prefix and length advertised in a route. You
must create the prefix list before it can be selected
here. See “prefix-list” on page 275
remote-as <id_integer> Adds a BGP neighbor to the FortiGate configuration unset
and sets the AS number of the neighbor. The range is
from 1 to 65 535. If the number is identical to the
FortiGate AS number, the FortiGate unit communicates
with the neighbor using internal BGP (IBGP).
Otherwise, the neighbor is an external peer and the
FortiGate unit uses EBGP to communicate with the
neighbor.
remove-private-as Remove the private AS numbers from outbound disable
{enable | disable} updates to the BGP neighbor.
restart_time <seconds_integer> Sets the time until a restart happens. The time until the 0
restart can be from 0 to 3600 seconds.
retain-stale-time This keyword is available when capability- 0
<seconds_integer> graceful-restart is set to enable.
Specify the time (in seconds) that stale routes to the
BGP neighbor will be retained. The range is from 1 to
65 535.
route-map-in Limit route updates or change the attributes of route Null.
<routemap-name_str> updates from the BGP neighbor according to the
specified route map. You must create the route-map
before it can be selected here. See “route-map” on
page 286 and “Using route maps with BGP” on
page 288.
route-map-out Limit route updates or change the attributes of route Null.
<routemap-name_str> updates to the BGP neighbor according to the specified
route map. You must create the route-map before it can
be selected here. See “route-map” on page 286 and
“Using route maps with BGP” on page 288.
route-reflector-client This keyword is available when remote-as is identical disable
{enable | disable} to the FortiGate AS number (see “as
<local_as_id>” on page 232).
Enable or disable the operation of the FortiGate unit as
a route reflector and identify the BGP neighbor as a
route-reflector client.
route-server-client Enable or disable the recognition of the BGP neighbor disable
{enable | disable} as route-server client.

FortiGate CLI Version 3.0 MR6 Reference

238 01-30006-0015-20080205
router bgp

Variables Description Default

send-community {both | disable Enable or disable the sending of the COMMUNITY both
| extended | standard} attribute to the BGP neighbor.
• To advertise extended and standard capabilities,
select both.
• To advertise extended capabilities, select extended.
• To advertise standard capabilities, select standard.
• To disable the advertising of the COMMUNITY
attribute, select disable.
shutdown {enable | disable} Administratively enable or disable the BGP neighbor. disable
soft-reconfiguration Enable or disable the FortiGate unit to store unmodified disable
{enable | disable} updates from the BGP neighbor to support inbound
soft-reconfiguration.
strict-capability-match Enable or disable strict-capability negotiation matching disable
{enable | disable} with the BGP neighbor.
unsuppress-map Specify the name of the route-map to selectively Null.
<route-map-name_str> unsuppress suppressed routes. You must create the
route-map before it can be selected here. See “route-
map” on page 286 and “Using route maps with BGP” on
page 288.
update-source Specify the name of the local FortiGate interface to use Null.
<interface-name_str> for TCP connections to neighbors. The IP address of
the interface will be used as the source address for
outgoing updates.
weight <weight_integer> Apply a weight value to all routes learned from a unset
neighbor. A higher number signifies a greater
preference. The range is from 0 to 65 535.

Example
This example shows how to set the AS number of a BGP neighbor at IP address 10.10.10.167 and
enter a descriptive name for the configuration.
config router bgp
config neighbor
edit 10.10.10.167
set remote-as 2879
set description BGP_neighbor_Site1
end
end

config network
Use this subcommand to set or unset BGP network configuration parameters. The subcommand is
used to advertise a BGP network (that is, an IP prefix)—you specify the IP addresses making up the
local BGP network.
When you enable the network-import-check attribute on the FortiGate unit (see “network-
import-check {enable | disable}” on page 234) and you specify a BGP network prefix
through the config network command, the FortiGate unit searches its routing table for a matching
entry. If an exact match is found, the prefix is advertised. A route-map can optionally be used to modify
the attributes of routes before they are advertised.

Note: The prefix keyword is required. All other keywords are optional.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 239
bgp router

Variables Description Default

edit <network_id> Enter an ID number for the entry. The number must be an No default.
integer.
backdoor Enable or disable the route as a backdoor, which causes an disable
{enable | disable} administrative distance of 200 to be assigned to the route.
Backdoor routes are not advertised to EBGP peers.
prefix <address_ipv4mask> Enter the IP address and netmask that identifies the BGP 0.0.0.0
network to advertise. 0.0.0.0
route-map Specify the name of the route-map that will be used to modify Null.
<routemap-name_str> the attributes of the route before it is advertised. You must
create the route-map before it can be selected here. See
“route-map” on page 286 and “Using route maps with BGP” on
page 288.

Example
This example defines a BGP network at IP address 10.0.0.0/8. A route map named BGP_rmap1 is
used to modify the attributes of the local BGP routes before they are advertised.
config router bgp
config network
edit 1
set prefix 10.0.0.0/8
set route-map BGP_rmap1
end
end

config router route-map

edit BGP_rmap1
config rule
edit 1
set set-community no-export
end
end

config redistribute
Use this subcommand to set or unset BGP redistribution table parameters. You can enable BGP to
provide connectivity between connected, static, RIP, and/or OSPF routes. BGP redistributes the routes
from one protocol to another. When a large internetwork is divided into multiple routing domains, use
the subcommand to redistribute routes to the various domains. As an alternative, you can use the
config network subcommand to advertise a prefix to the BGP network (see “config network” on
page 239).
The BGP redistribution table contains four static entries. You cannot add entries to the table. The
entries are defined as follows:
• connected—Redistribute routes learned from a direct connection to the destination network.
• static—Redistribute the static routes defined in the FortiGate routing table.
• rip—Redistribute routes learned from RIP.
• ospf—Redistribute routes learned from OSPF.
When you enter the subcommand, end the command with one of the four static entry names (that is,
config redistribute {connected | static | rip | ospf}).

FortiGate CLI Version 3.0 MR6 Reference

240 01-30006-0015-20080205
router bgp

Note: The status and route-map keywords are optional.

Variables Description Default

status {enable | disable} Enable or disable the redistribution of connected, static, RIP, or disable
OSPF routes.
route-map Specify the name of the route map that identifies the routes to Null.
<route-map-name_str> redistribute. You must create the route map before it can be
selected here. See “route-map” on page 286 and “Using route
maps with BGP” on page 288. If a route map is not specified, all
routes are redistributed to BGP.

Example
The following example changes the status and route-map fields of the connected entry.
config router bgp
config redistribute connected
set status enable
set route-map rmap1
end
end

History
FortiOS v3.0 New.

Related topics
• router aspath-list
• router community-list
• Using route maps with BGP
• router key-chain

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 241
community-list router

community-list
Use this command to identify BGP routes according to their COMMUNITY attributes (see RFC 1997).
Each entry in the community list defines a rule for matching and selecting routes based on the setting
of the COMMUNITY attribute. The default rule in a community list (which the FortiGate unit applies
last) denies the matching of all routes.
You add a route to a community by setting its COMMUNITY attribute. A route can belong to more than
one community. A route may be added to a community because it has something in common with the
other routes in the group (for example, the attribute could identify all routes to satellite offices).
When the COMMUNITY attribute is set, the FortiGate unit can select routes based on their
COMMUNITY attribute values.

Syntax
config router community-list
edit <community_name>
set type {standard | expanded}
config rule
edit <community_rule_id>
set action {deny | permit}
set match <criteria>
set regexp <regular_expression>
end
end

Note: The action keyword is required. All other keywords are optional.

Variables Description Default

edit <community_name> Enter a name for the community list. No default.
type {standard | expanded} Specify the type of community to match. If you select standard
expanded, you must also specify a config rule regexp
value. See “regexp <regular_expression>” on
page 243.
config rule variables
edit <community_rule_id> Enter an entry number for the rule. The number must be an No default.
integer.
action {deny | permit} Deny or permit operations on a route based on the value of No default.
the route’s COMMUNITY attribute.

FortiGate CLI Version 3.0 MR6 Reference

242 01-30006-0015-20080205
router community-list

Variables Description Default

match <criteria> This keyword is available when set type is set to Null.
standard.
Specify the criteria for matching a reserved community.
• Use decimal notation to match one or more COMMUNITY
attributes having the syntax AA:NN, where AA represents
an AS, and NN is the community identifier. Delimit complex
expressions with double-quotation marks (for example,
“123:234 345:456”).
• To match all routes in the Internet community, type
internet.
• To match all routes in the LOCAL_AS community, type
local-AS. Matched routes are not advertised locally.
• To select all routes in the NO_ADVERTISE community, type
no-advertise. Matched routes are not advertised.
• To select all routes in the NO_EXPORT community, type
no-export. Matched routes are not advertised to EBGP
peers. If a confederation is configured, the routes are
advertised within the confederation.
regexp This keyword is available when set type is set to Null.
<regular_expression> expanded.
Specify an ordered list of COMMUNITY attributes as a regular
expression. The value or values are used to match a
community. Delimit a complex regular_expression value
using double-quotation marks.

Example
This example creates a community list named Satellite_offices. The list permits operations on
BGP routes whose COMMUNITY attribute is set to no-advertise.
config router community-list
edit Satellite_offices
set type standard
config rule
edit 1
set action permit
set match no-advertise
end
end
The next example creates a community list named ext_community. The list permits operations on
BGP routes whose COMMUNITY attribute has the number 3 in the second part of the first instance
and the number 86 in the second part of the second instance. For example, the community list could
match routes having the following COMMUNITY attribute values: “100:3 500:86 300:800”, “1:3 4:86”,
or “69:3 69:86 69:69 70:800 600:333”).
config router community-list
edit ext_community
set type expanded
config rule
edit 1
set action permit
set regexp “.*:3 .*:86”
end
end

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 243
community-list router

History

FortiOS v3.0 New.

Related topics
• router aspath-list
• router bgp
• router Using route maps with BGP
• router key-chain

FortiGate CLI Version 3.0 MR6 Reference

244 01-30006-0015-20080205
router key-chain

key-chain
Use this command to manage RIP version 2 authentication keys. You can add, edit or delete keys
identified by the specified key number.
RIP version 2 uses authentication keys to ensure that the routing information exchanged between
routers is reliable. For authentication to work both the sending and receiving routers must be set to use
authentication, and must be configured with the same keys.
A key chain is a list of one or more keys and the send and receive lifetimes for each key. Keys are
used for authenticating routing packets only during the specified lifetimes. The FortiGate unit migrates
from one key to the next according to the scheduled send and receive lifetimes. The sending and
receiving routers should have their system dates and times synchronized, but overlapping the key
lifetimes ensures that a key is always available even if there is some difference in the system times.
See “config system global” on page 243 to ensure that the FortiGate system date and time are correct.

Syntax
config router key-chain
edit <key_chain_name>
config key
edit <key_id>
set accept-lifetime <start> <end>
set key-string <password>
set send-lifetime <start> <end>
end
end

Note: The accept-lifetime, key-string, and send-lifetime keywords are required.

Variables Description Default

edit <key_chain_name> Enter a name for the key chain list. No default.
config key variables
edit <key_id> Enter an ID number for the key entry. The number must be No default.
an integer.
accept-lifetime <start> <end> Set the time period during which the key can be received. No default.
The start time has the syntax hh:mm:ss day month
year. The end time provides a choice of three settings:
• hh:mm:ss day month year
• a duration from 1 to 2147483646 seconds
• infinite (for a key that never expires)
The valid settings for hh:mm:ss day month year are:
• hh - 0 to 23
• mm - 0 to 59
• ss - 0 to 59
• day - 1 to 31
• month - 1 to 12
• year - 1993 to 2035

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 245
key-chain router

Variables Description Default

key-string <password> The <password_str> can be up to 35 characters long. No default.
send-lifetime <start> <end> Set the time period during which the key can be sent. The No default.
start time has the syntax hh:mm:ss day month year.
The end time provides a choice of three settings:
• hh:mm:ss day month year
• a duration from 1 to 2147483646 seconds
• infinite (for a key that never expires)
The valid settings for hh:mm:ss day month year are:
• hh - 0 to 23
• mm - 0 to 59
• ss - 0 to 59
• day - 1 to 31
• month - 1 to 12
• year - 1993 to 2035

Example
This example shows how to add a key chain named test1 with three keys. The first two keys each
have send and receive lifetimes of 13 hours, and the 3rd key has send and receive lifetimes that never
expire.
config router key-chain
edit test1
config key
edit 1
set accept-lifetime 10:00:00 1 6 2004 46800
set send-lifetime 10:00:00 1 6 2004 46800
set key-string 1a2b2c4d5e6f7g8h
next
edit 2
set accept-lifetime 22:00:00 1 6 2004 46800
set send-lifetime 22:00:00 1 6 2004 46800
set key-string 9i1j2k3l4m5n6o7p
next
edit 3
set accept-lifetime 10:00:00 2 6 2004 infinite
set send-lifetime 10:00:00 2 6 2004 infinite
set key-string 123abc456def789g
end
end

History

FortiOS v2.80 New.

Related topics
• router rip
• system global

FortiGate CLI Version 3.0 MR6 Reference

246 01-30006-0015-20080205
router multicast

multicast
A FortiGate unit can operate as a Protocol Independent Multicast (PIM) version 2 router in the root
virtual domain. FortiGate units support PIM sparse mode (RFC 4601) and PIM dense mode (RFC
3973) and can service multicast servers or receivers on the network segment to which a FortiGate
interface is connected. Multicast routing is only available in the root virtual domain. It is not supported
in Transparent mode (TP mode).

Note: To support PIM communications, the sending/receiving applications and all connecting PIM routers in
between must be enabled with PIM version 2. PIM can use static routes, RIP, OSPF, or BGP to forward multicast
packets to their destinations. To enable source-to-destination packet delivery, either sparse mode or dense mode
must be enabled on the PIM-router interfaces. Sparse mode routers cannot send multicast messages to dense
mode routers. In addition, if a FortiGate unit is located between a source and a PIM router, two PIM routers, or is
connected directly to a receiver, you must create a firewall policy manually to pass encapsulated (multicast)
packets or decapsulated data (IP traffic) between the source and destination.

A PIM domain is a logical area comprising a number of contiguous networks. The domain contains at
least one Boot Strap Router (BSR), and if sparse mode is enabled, a number of Rendezvous Points
(RPs) and Designated Routers (DRs). When PIM is enabled on a FortiGate unit, the FortiGate unit can
perform any of these functions at any time as configured.

Sparse mode
Initially, all candidate BSRs in a PIM domain exchange bootstrap messages to select one BSR to
which each RP sends the multicast address or addresses of the multicast group(s) that it can service.
The selected BSR chooses one RP per multicast group and makes this information available to all of
the PIM routers in the domain through bootstrap messages. PIM routers use the information to build
packet distribution trees, which map each multicast group to a specific RP. Packet distribution trees
may also contain information about the sources and receivers associated with particular multicast
groups.

Note: When a FortiGate interface is configured as a multicast interface, sparse mode is enabled on it by default to
ensure that distribution trees are not built unless at least one downstream receiver requests multicast traffic from
a specific source. If the sources of multicast traffic and their receivers are close to each other and the PIM domain
contains a dense population of active receivers, you may choose to enable dense mode throughout the PIM
domain instead.

An RP represents the root of a non-source-specific distribution tree to a multicast group. By joining and
pruning the information contained in distribution trees, a single stream of multicast packets (for
example, a video feed) originating from the source can be forwarded to a certain RP to reach a
multicast destination.
Each PIM router maintains a Multicast Routing Information Base (MRIB) that determines to which
neighboring PIM router join and prune messages are sent. An MRIB contains reverse-path information
that reveals the path of a multicast packet from its source to the PIM router that maintains the MRIB.
To send multicast traffic, a server application sends IP traffic to a multicast group address. The locally
elected DR registers the sender with the RP that is associated with the target multicast group. The RP
uses its MRIB to forward a single stream of IP packets from the source to the members of the multicast
group. The IP packets are replicated only when necessary to distribute the data to branches of the
RP’s distribution tree.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 247
multicast router

To receive multicast traffic, a client application can use Internet Group Management Protocol (IGMP)
version 1 (RFC 1112), 2 (RFC 2236), or 3 (RFC 3376) control messages to request the traffic for a
particular multicast group. The locally elected DR receives the request and adds the host to the
multicast group that is associated with the connected network segment by sending a join message
towards the RP for the group. Afterward, the DR queries the hosts on the connected network segment
continually to determine whether the hosts are active. When the DR no longer receives confirmation
that at least one member of the multicast group is still active, the DR sends a prune message towards
the RP for the group.

Dense mode
The packet organization used in sparse mode is also used in dense mode. When a multicast source
begins to send IP traffic and dense mode is enabled, the closest PIM router registers the IP traffic from
the multicast source (S) and forwards multicast packets to the multicast group address (G). All PIM
routers initially broadcast the multicast packets throughout the PIM domain to ensure that all receivers
that have requested traffic for multicast group address G can access the information if needed.
To forward multicast packets to specific destinations afterward, the PIM routers build distribution trees
based on the information in multicast packets. Upstream PIM routers depend on prune/graft messages
from downstream PIM routers to determine if receivers are actually present on directly connected
network segments. The PIM routers exchange state refresh messages to update their distribution
trees. FortiGate units store this state information in a Tree Information Base (TIB), which is used to
build a multicast forwarding table. The information in the multicast forwarding table determines whether
packets are forwarded downstream. The forwarding table is updated whenever the TIB is modified.
PIM routers receive data streams every few minutes and update their forwarding tables using the
source (S) and multicast group (G) information in the data stream. Superfluous multicast traffic is
stopped by PIM routers that do not have downstream receivers—PIM routers that do not manage
multicast groups send prune messages to the upstream PIM routers. When a receiver requests traffic
for multicast address G, the closest PIM router sends a graft message upstream to begin receiving
multicast packets.

Syntax
config router multicast
set igmp-state-limit <limit_integer>
set multicast-routing {enable | disable}
set route-limit <limit_integer>
set route-threshold <threshold_integer>
config interface
edit <interface_name>
set cisco-exclude-genid {enable | disable}
set dr-priority <priority_integer>
set hello-holdtime <holdtime_integer>
set hello-interval <hello_integer>
set neighbour-filter <access_list_name>
set passive {enable | disable}
set pim-mode {sparse-mode | dense-mode}
set propagation-delay <delay_integer>
set rp-candidate {enable | disable}
set rp-candidate-group <access_list_name>
set rp-candidate-interval <interval_integer>
set rp-candidate-priority <priority_integer>
set state-refresh-interval <refresh_integer>
set ttl-threshold <ttl_integer>
end

FortiGate CLI Version 3.0 MR6 Reference

248 01-30006-0015-20080205
router multicast

config join-group
edit address <address_ipv4>
end
config igmp
set access-group <access_list_name>
set immediate-leave-group <access_list_name>
set last-member-query-count <count_integer>
set last-member-query-interval <interval_integer>
set query-interval <interval_integer>
set query-max-response-time <time_integer>
set query-timeout <timeout_integer>
set router-alert-check { enable | disable }
set version {1 | 2 | 3}
end
end
config pim-sm-global
set accept-register-list <access_list_name>
set bsr-allow-quick-refresh {enable | disable}
set bsr-candidate {enable | disable}
set bsr-priority <priority_integer>
set bsr-interface <interface_name>
set bsr-hash <hash_integer>
set cisco-register-checksum {enable | disable}
set cisco-register-checksum-group <access_list_name>
set cisco-crp-prefix {enable | disable}
set cisco-ignore-rp-set-priority {enable | disable}
set message-interval <interval_integer>
set register-rate-limit <rate_integer>
set register-rp-reachability {enable | disable}
set register-source {disable | interface | ip-address}
set register-source-interface <interface_name>
set register-source-ip <address_ipv4>
set register-suppression <suppress_integer>
set rp-register-keepalive <keepalive_integer>
set spt-threshold {enable | disable}
set spt-threshold-group <access_list_name>
set ssm {enable | disable}
set ssm-range <access_list_name>
config rp-address
edit <rp_id>
set ip-address <address_ipv4>
set group <access_list_name>
end
end

config router multicast

You can configure a FortiGate unit to support PIM using the config router multicast CLI
command. When PIM is enabled, the FortiGate unit allocates memory to manage mapping
information. The FortiGate unit communicates with neighboring PIM routers to acquire mapping
information and if required, processes the multicast traffic associated with specific multicast groups.

Note: The end-user multicast client-server applications must be installed and configured to initiate
Internet connections and handle broadband content such as audio/video information.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 249
multicast router

Client applications send multicast data by registering IP traffic with a PIM-enabled router. An end-user
could type in a class D multicast group address, an alias for the multicast group address, or a call-
conference number to initiate the session. Rather than sending multiple copies of generated IP traffic
to more than one specific IP destination address, PIM-enabled routers encapsulate the data and use
the one multicast group address to forward multicast packets to multiple destinations. Because one
destination address is used, a single stream of data can be sent. Client applications receive multicast
data by requesting that the traffic destined for a certain multicast group address be delivered to them—
end-users may use phone books, a menu of ongoing or future sessions, or some other method through
a user interface to select the address of interest.
A class D address in the 224.0.0.0 to 239.255.255.255 range may be used as a multicast group
address, subject to the rules assigned by the Internet Assigned Numbers Authority (IANA). All class D
addresses must be assigned in advance. Because there is no way to determine in advance if a certain
multicast group address is in use, collisions may occur (to resolve this problem, end-users may switch
to a different multicast address).

To configure a PIM domain

1 If you will be using sparse mode, determine appropriate paths for multicast packets.
2 Make a note of the interfaces that will be PIM-enabled. These interfaces may run a unicast routing
protocol.
3 If you will be using sparse mode and want multicast packets to be handled by specific (static) RPs,
record the IP addresses of the PIM-enabled interfaces on those RPs.
4 Enable PIM version 2 on all participating routers between the source and receivers. On FortiGate units,
use the config router multicast command to set global operating
parameters.
5 Configure the PIM routers that have good connections throughout the PIM domain to be candidate
BSRs.
6 If sparse mode is enabled, configure one or more of the PIM routers to be candidate RPs.
7 If required, adjust the default settings of PIM-enabled interface(s).

Note: All keywords are optional.

Variables Description Default

igmp-state-limit If memory consumption is an issue, specify a limit on the 3200
<limit_integer> number of IGMP states (multicast memberships) that the
FortiGate unit will store. The value represents the maximum
combined number of IGMP states (multicast memberships)
that can be handled by all interfaces. Traffic associated with
excess IGMP membership reports is not delivered. The range
is from 96 to 64 000.
multicast-routing Enable or disable PIM routing. disable
{enable | disable}
route-limit If memory consumption is an issue, set a limit on the number 2147483674
<limit_integer> of multicast routes that can be added to the FortiGate routing
table. The range is from 1 to 2 147 483 674.
route-threshold Specify the number of multicast routes that can be added to 2147483674
<threshold_integer> the FortiGate routing table before a warning message is
displayed. The route-threshold value must be lower than
the route-limit value. The range is from 1 to
2 147 483 674.

FortiGate CLI Version 3.0 MR6 Reference

250 01-30006-0015-20080205
router multicast

config interface
Use this subcommand to change interface-related PIM settings, including the mode of operation
(sparse or dense). Global settings do not override interface-specific settings.

Note: All keywords are optional.

Variables Description Default

edit <interface_name> Enter the name of the FortiGate interface on which to enable No default.
PIM protocols.
cisco-exclude-genid This keyword applies only when pim-mode is sparse-mode. disable
{enable | disable} Enable or disable including a generation ID in hello messages
sent to neighboring PIM routers. A GenID value may be
included for compatibility with older Cisco IOS routers.
dr-priority This keyword applies only when pim-mode is sparse-mode. 1
<priority_integer> Assign a priority to FortiGate DR candidacy. The range is from
1 to 4 294 967 294. The value is compared to that of other DR
interfaces connected to the same network segment, and the
router having the highest DR priority is selected to be the DR.
If two DR priority values are the same, the interface having
the highest IP address is selected.
hello-holdtime Specify the amount of time (in seconds) that a PIM neighbor 105
<holdtime_integer> may consider the information in a hello message to be valid.
The range is from 1 to 65 535.
If the hello-interval attribute is modified and the hello-
holdtime attribute has never been set explicitly, the hello-
holdtime attribute is set to 3.5 x hello-interval
automatically.
hello-interval Set the amount of time (in seconds) that the FortiGate unit 30
<hello_integer> waits between sending hello messages to neighboring PIM
routers. The range is from 1 to 65 535. Changing the hello-
interval attribute may update the hello-holdtime
attribute automatically.
neighbour-filter Establish or terminate adjacency with PIM neighbors having Null.
<access_list_name> the IP addresses given in the specified access list. See
“access-list” on page 224.
passive {enable | Enable or disable PIM communications on the interface disable
disable} without affecting IGMP communications.
pim-mode {sparse-mode | Select the PIM mode of operation: sparse-
dense-mode} • Select sparse-mode to manage PIM packets through mode
distribution trees and multicast groups.
• Select dense-mode to enable multicast flooding.
propagation-delay This keyword is available when pim-mode is set to 500
<delay_integer> dense-mode.
Specify the amount of time (in milliseconds) that the FortiGate
unit waits to send prune-override messages. The range is
from 100 to 5 000.
rp-candidate {enable | This keyword is available when pim-mode is set to disable
disable} sparse-mode.
Enable or disable the FortiGate interface to offer Rendezvous
Point (RP) services.
rp-candidate-group This keyword is available when rp-candidate is set to Null.
<access_list_name> enable and pim-mode is set to sparse-mode.
Specify for which multicast groups RP candidacy is advertised
based on the multicast group prefixes given in the specified
access list. See “access-list” on page 224.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 251
multicast router

Variables Description Default

rp-candidate-interval This keyword is available when rp-candidate is set to 60
<interval_integer> enable and pim-mode is set to sparse-mode.
Set the amount of time (in seconds) that the FortiGate unit
waits between sending RP announcement messages. The
range is from 1 to 16 383.
rp-candidate-priority This keyword is available when rp-candidate is set to 192
<priority_integer> enable and pim-mode is set to sparse-mode.
Assign a priority to FortiGate RP candidacy. The range is from
0 to 255. The BSR compares the value to that of other RP
candidates that can service the same multicast group, and the
router having the highest RP priority is selected to be the RP
for that multicast group. If two RP priority values are the
same, the RP candidate having the highest IP address on its
RP interface is selected.
state-refresh-interval This keyword is available when pim-mode is set to 60
<refresh_integer> dense-mode.
This attribute is used when the FortiGate unit is connected
directly to the multicast source. Set the amount of time (in
seconds) that the FortiGate unit waits between sending state-
refresh messages. The range is from 1 to 100. When a state-
refresh message is received by a downstream router, the
prune state on the downstream router is refreshed.
ttl-threshold Specify the minimum Time-To-Live (TTL) value (in hops) that 1
<ttl_integer> an outbound multicast packet must have in order to be
forwarded from the interface. Specifying a high value (for
example, 195) prevents PIM packets from being forwarded
through the interface. The range is from 0 to 255.
config join-group variables
edit address Cause the FortiGate interface to activate (IGMP join) the No default.
<address_ipv4> multicast group associated with the specified multicast group
address.
config igmp variables
access-group Specify which multicast groups hosts on the connected Null.
<access_list_name> network segment may join based on the multicast addresses
given in the specified access list. See “access-list” on
page 224.
immediate-leave-group This keyword applies when version is set to 2 or 3. Null.
<access_list_name> Configure a FortiGate DR to stop sending traffic and IGMP
queries to receivers after receiving an IGMP version 2 group-
leave message from any member of the multicast groups
identified in the specified access list. See “access-list” on
page 224.
last-member-query-count This keyword applies when version is set to 2 or 3. 2
<count_integer> Specify the number of times that a FortiGate DR sends an
IGMP query to the last member of a multicast group after
receiving an IGMP version 2 group-leave message.
last-member-query- This keyword applies when version is set to 2 or 3. 1000
interval Set the amount of time (in milliseconds) that a FortiGate DR
<interval_integer> waits for the last member of a multicast group to respond to
an IGMP query. The range is from 1000 to 25 500. If no
response is received before the specified time expires and the
FortiGate DR has already sent an IGMP query last-
member-query-count times, the FortiGate DR removes the
member from the group and sends a prune message to the
associated RP.
query-interval Set the amount of time (in seconds) that a FortiGate DR waits 125
<interval_integer> between sending IGMP queries to determine which members
of a multicast group are active. The range is from 1 to 65 535.

FortiGate CLI Version 3.0 MR6 Reference

252 01-30006-0015-20080205
router multicast

Variables Description Default

query-max-response-time Set the maximum amount of time (in seconds) that a 10
<time_integer> FortiGate DR waits for a member of a multicast group to
respond to an IGMP query. The range is from 1 to 25. If no
response is received before the specified time expires, the
FortiGate DR removes the member from the group.
query-timeout Set the amount of time (in seconds) that must expire before a 255
<timeout_integer> FortiGate unit begins sending IGMP queries to the multicast
group that is managed through the interface. The range is
from 60 to 300. A FortiGate unit begins sending IGMP queries
if it does not receive regular IGMP queries from another DR
through the interface.
router-alert-check { Enable to require the Router Alert option in IGMP packets. disabled
enable | disable }
version {1 | 2 | 3} Specify the version number of IGMP to run on the interface. 3
The value can be 1, 2, or 3. The value must match the version
used by all other PIM routers on the connected network
segment.

config pim-sm-global
These global settings apply only to sparse mode PIM-enabled interfaces. Global PIM settings do not
override interface-specific PIM settings.
If sparse mode is enabled, you can configure a DR to send multicast packets to a particular RP by
specifying the IP address of the RP through the config rp-address subcommand. The IP address
must be directly accessible to the DR. If multicast packets from more than one multicast group can
pass through the same RP, you can use an access list to specify the associated multicast group
addresses.

Note: To send multicast packets to a particular RP using the config rp-address subcommand, the ip-
address keyword is required. All other keywords are optional.

Variables Description Default

accept-register-list Cause a FortiGate RP to accept or deny register packets Null.
<access_list_name> from the source IP addresses given in the specified access
list. See “access-list” on page 224.
bsr-allow-quick-refresh Enable or disable accepting bsr quick refresh packets from disable
{enable | disable} neighbors.
bsr-candidate {enable | Enable or disable the FortiGate unit to offer its services as a disable
disable} Boot Strap Router (BSR) when required.
bsr-priority This keyword is available when bsr-candidate is set to 0
<priority_integer> enable.
Assign a priority to FortiGate BSR candidacy. The range is
from 0 to 255. The value is compared to that of other BSR
candidates and the candidate having the highest priority is
selected to be the BSR. If two BSR priority values are the
same, the BSR candidate having the highest IP address on
its BSR interface is selected.
bsr-interface This keyword is available when bsr-candidate is set to Null.
<interface_name> enable.
Specify the name of the PIM-enabled interface through
which the FortiGate unit may announce BSR candidacy.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 253
multicast router

Variables Description Default

bsr-hash <hash_integer> This keyword is available when bsr-candidate is set to 10
enable.
Set the length of the mask (in bits) to apply to multicast
group addresses in order to derive a single Rendezvous
Point (RP) for one or more multicast groups. The range is
from 0 to 32. For example, a value of 24 means that the first
24 bits of the group address are significant. All multicast
groups having the same seed hash belong to the same RP.
cisco-crp-prefix {enable Enable or disable a FortiGate RP that has a group prefix disable
| disable} number of 0 to communicate with a Cisco BSR. You may
choose to enable the attribute if required for compatibility
with older Cisco BSRs.
cisco-ignore-rp-set- Enable or disable a FortiGate BSR to recognize Cisco RP- disable
priority {enable | SET priority values when deriving a single RP for one or
disable} more multicast groups. You may choose to enable the
attribute if required for compatibility with older Cisco RPs.
cisco-register-checksum Enable or disable performing a register checksum on entire disable
{enable | disable} PIM packets. A register checksum is performed on the
header only by default. You may choose to enable register
checksums on the whole packet for compatibility with older
Cisco IOS routers.
cisco-register-checksum- This keyword is available when cisco-register- Null.
group <access_list_name> checksum is set to enable.
Identify on which PIM packets to perform a whole-packet
register checksum based on the multicast group addresses
in the specified access list. See “access-list” on page 224.
You may choose to enable register checksums on entire
PIM packets for compatibility with older Cisco IOS routers.
message-interval Set the amount of time (in seconds) that the FortiGate unit 60
<interval_integer> waits between sending periodic PIM join/prune messages
(sparse mode) or prune messages (dense mode). The value
must be identical to the message interval value set on all
other PIM routers in the PIM domain. The range is from 1 to
65 535.
register-rate-limit Set the maximum number of register messages per (S,G) 0
<rate_integer> per second that a FortiGate DR can send for each PIM entry
in the routing table. The range is from 0 to 65 535, where 0
means an unlimited number of register messages per
second.
register-rp-reachability Enable or disable a FortiGate DR to check if an RP is enable
{enable | disable} accessible prior to sending register messages.
register-source {disable If the FortiGate unit acts as a DR, enable or disable ip-address
| interface | ip-address} changing the IP source address of outbound register
packets to one of the following IP addresses. The IP
address must be accessible to the RP so that the RP can
respond to the IP address with a Register-Stop message:
• To retain the IP address of the FortiGate DR interface
that faces the RP, select disable.
• To change the IP source address of a register packet to
the IP address of a particular FortiGate interface, select
interface. The register-source-interface
attribute specifies the interface name.
• To change the IP source address of a register packet to
a particular IP address, select ip-address. The
register-source-ip attribute specifies the IP
address.
register-source-interface This keyword is available when register-source is set Null.
<interface_name> to interface.
Enter the name of the FortiGate interface.

FortiGate CLI Version 3.0 MR6 Reference

254 01-30006-0015-20080205
router multicast

Variables Description Default

register-source-ip This keyword is available when register-source is set 0.0.0.0
<address_ipv4> to address.
Enter the IP source address to include in the register
message.
register-suppression Enter the amount of time (in seconds) that a FortiGate DR 60
<suppress_integer> waits to start sending data to an RP after receiving a
Register-Stop message from the RP. The range is from 1 to
65 535.
rp-register-keepalive If the FortiGate unit acts as an RP, set the frequency (in 185
<keepalive_integer> seconds) with which the FortiGate unit sends keepalive
messages to a DR. The range is from 1 to 65 535. The two
routers exchange keepalive messages to maintain a link for
as long as the source continues to generate traffic.
If the register-suppression attribute is modified on the
RP and the rp-register-keepalive attribute has never
been set explicitly, the rp-register-keepalive attribute
is set to (3 x register-suppression) + 5 automatically.
spt-threshold {enable | Enable or disable the FortiGate unit to build a Shortest Path enable
disable} Tree (SPT) for forwarding multicast packets.
spt-threshold-group This keyword is available when spt-threshold is set to Null.
<access_list_name> enable.
Build an SPT only for the multicast group addresses given in
the specified access list. See “access-list” on page 224.
ssm {enable | disable} This keyword is available when the IGMP version is set enable
to 3.
Enable or disable Source Specific Multicast (SSM)
interactions (see RFC 3569).
ssm-range This keyword is available when ssm is set to enable. Null.
<access_list_name> Enable SSM only for the multicast addresses given in the
specified access list. See “access-list” on page 224. By
default, multicast addresses in the 232.0.0.0 to
232.255.255.255 (232/8) range are used to support SSM
interactions.
config rp-address variables Applies only when pim-mode is sparse-mode.
edit <rp_id> Enter an ID number for the static RP address entry. The No default.
number must be an integer.
ip-address <address_ipv4> Specify a static IP address for the RP. 0.0.0.0
group <access_list_name> Configure a single static RP for the multicast group Null.
addresses given in the specified access list. See “access-
list” on page 224. If an RP for any of these group addresses
is already known to the BSR, the static RP address is
ignored and the RP known to the BSR is used instead.

Example
This example shows how to enable a FortiGate unit to support PIM routing in sparse mode and enable
BSR candidacy on the dmz interface:
config router multicast
set multicast-routing enable
config interface
edit dmz
set pim-mode sparse-mode
end
end
config pim-sm-global
set bsr-candidate enable

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 255
multicast router

set bsr-priority 1
set bsr-interface dmz
set bsr-hash 24
end
This example shows how to enable RP candidacy on the port1 interface for the multicast group
addresses given through an access list named multicast_port1:
config router multicast
set multicast-routing enable
config interface
edit port1
set pim-mode sparse-mode
set rp-candidate enable
set rp-candidate-group multicast_port1
set rp-candidate-priority 15
end
end

History

FortiOS v3.0 New.

Related topics
• get router info multicast
• execute mrouter clear

FortiGate CLI Version 3.0 MR6 Reference

256 01-30006-0015-20080205
router ospf

ospf
Use this command to configure Open Shortest Path First (OSPF) protocol settings on the FortiGate
unit. More information on OSPF can be found in RFC 2328.
OSPF is a link state protocol capable of routing larger networks than the simpler distance vector RIP
protocol. An OSPF autonomous system (AS) or routing domain is a group of areas connected to a
backbone area. A router connected to more than one area is an area border router (ABR). Routing
information is contained in a link state database. Routing information is communicated between
routers using link state advertisements (LSAs).
Bi-directional Forwarding Detection (BFD) is a protocol used by BGP and OSPF. It is used to quickly
locate hardware failures in the network. Routers running BFD communicate with each other, and if a
timer runs out on a connection then that router is declared down. BFD then communicates this
information to the routing protocol and the routing information is updated. BFD support was added in
FortiOS v3.0 MR4, and can only be configured through the CLI.

Syntax
config router ospf
set abr-type {cisco | ibm | shortcut | standard}
set auto-cost-ref-bandwidth <mbps_integer>
set bfd {enable | disable | global}
set database-overflow {enable | disable}
set database-overflow-max-lsas <lsas_integer>
set database-overflow-time-to-recover <seconds_integer>
set default-information-metric <metric_integer>
set default-information-metric-type {1 | 2}
set default-information-originate {always | disable | enable}
set default-information-route-map <name_str>
set default-metric <metric_integer>
set distance <distance_integer>
set distance-external <distance_integer>
set distance-inter-area <distance_integer>
set distance-intra-area <distance_integer>
set distribute-list-in <access_list_name>
set passive-interface <name_str>
set restart-mode {graceful-restart | lls | none}
set rfc1583-compatible {enable | disable}
set router-id <address_ipv4>
set spf-timers <delay_integer> <hold_integer>
config area
edit <area_address_ipv4>
set authentication {md5 | none | text}
set default-cost <cost_integer>
set nssa-default-information-originate {enable | disable}
set nssa-default-information-originate-metric <metric>
set nssa-default-information-originate-metric-type {1 | 2}
set nssa-redistribution {enable | disable}
set nssa-translator-role {always | candidate | never}
set shortcut {default | disable | enable}
set stub-type {no-summary | summary}
set type {nssa | regular | stub}
config filter-list
edit <filter-list_id>

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 257
ospf router

set direction {in | out}

set list <name_str>
end
config range
edit <range_id>
set advertise {enable | disable}
set prefix <address_ipv4mask>
set substitute <address_ipv4mask>
set substitute-status {enable | disable}
end
config virtual-link
edit <vlink_name>
set authentication {md5 | none | text}
set authentication-key <password_str>
set dead-interval <seconds_integer>
set hello-interval <seconds_integer>
set md5-key <id_integer><key_str>
set peer <address_ipv4>
set retransmit-interval <seconds_integer>
set transmit-delay <seconds_integer>
end
end
config distribute-list
edit <distribute-list_id>
set access-list <name_str>
set protocol {connected | rip | static}
end
end
config neighbor
edit <neighbor_id>
set cost <cost_integer>
set ip <address_ipv4>
set poll-interval <seconds_integer>
set priority <priority_integer>
end
end
config network
edit <network_id>
set area <id-address_ipv4>
set prefix <address_ipv4mask>
end
end
config ospf-interface
edit <ospf_interface_name>
set authentication {md5 | none | text}
set authentication-key <password_str>
set
set cost <cost_integer>
set database-filter-out {enable | disable}
set dead-interval <seconds_integer>
set hello-interval <seconds_integer>
set interface <name_str>
set ip <address_ipv4>
set md5-key <id_integer> <key_str>

FortiGate CLI Version 3.0 MR6 Reference

258 01-30006-0015-20080205
router ospf

set mtu <mtu_integer>

set mtu-ignore {enable | disable}
set network-type <type>
set priority <priority_integer>
set resync-timeout <integer>
set retransmit-interval <seconds_integer>
set status {enable | disable}
set transmit-delay <seconds_integer>
end
end
config redistribute {bgp | connected | static | rip}
set metric <metric_integer>
set metric-type {1 | 2}
set routemap <name_str>
set status {enable | disable}
set tag <tag_integer>
end
config summary-address
edit <summary-address_id>
set advertise {enable | disable}
set prefix <address_ipv4mask>
set tag <tag_integer>
end
end
end

config router ospf

Use this command to set the router ID of the FortiGate unit. Additional configuration options are
supported.

Note: The router-id keyword is required. All other keywords are optional.

Variables Description Default

abr-type {cisco | ibm | shortcut | Specify the behavior of a FortiGate unit acting as an standard
standard} OSPF area border router (ABR) when it has multiple
attached areas and has no backbone connection.
Selecting the ABR type compatible with the routers on
your network can reduce or eliminate the need for
configuring and maintaining virtual links. For more
information, see RFC 3509.
auto-cost-ref-bandwidth Enter the Mbits per second for the reference bandwidth.
<mbps_integer> Values can range from 1 to 65535.
bfd {enable | disable | global} Select one of the Bidirectional Forwarding Detection disable
(BFD) options for this interface.
• enable - start BFD on this interface
• disable - stop BFD on this interface
• global - use the global settings instead of explicitly
setting BFD per interface.
For the global settings see “system bfd
{enable | disable}” on page 440.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 259
ospf router

Variables Description Default

database-overflow Enable or disable dynamically limiting link state disable
{enable | disable} database size under overflow conditions. Enable this
command for FortiGate units on a network with routers
that may not be able to maintain a complete link state
database because of limited resources.
database-overflow-max-lsas If you have enabled database-overflow, set the limit 10000
<lsas_integer> for the number of external link state advertisements
(LSAs) that the FortiGate unit can keep in its link state
database before entering the overflow state. The
lsas_integer must be the same on all routers
attached to the OSPF area and the OSPF backbone.
The valid range for lsas_integer is 0 to 4294967294.
database-overflow-time-to-recover Enter the time, in seconds, after which the FortiGate unit 300
<seconds_integer> will attempt to leave the overflow state. If
seconds_integer is set to 0, the FortiGate unit will
not leave the overflow state until restarted. The valid
range for seconds_integer is 0 to 65535.
default-information-metric Specify the metric for the default route set by the 10
<metric_integer> default-information-originate command. The
valid range for metric_integer is 1 to 16777214.
default-information-metric-type Specify the OSPF external metric type for the default 2
{1 | 2} route set by the default-information-originate
command.
default-information-originate Enter enable to advertise a default route into an OSPF disable
{always | disable | enable} routing domain.
Use always to advertise a default route even if the
FortiGate unit does not have a default route in its routing
table.
default-information-route-map If you have set default-information-originate Null.
<name_str> to always, and there is no default route in the routing
table, you can configure a route map to define the
parameters that OSPF uses to advertise the default
route.
default-metric <metric_integer> Specify the default metric that OSPF should use for 10
redistributed routes. The valid range for
metric_integer is 1 to 16777214.
distance <distance_integer> Configure the administrative distance for all OSPF 110
routes. Using administrative distance you can specify
the relative priorities of different routes to the same
destination. A lower administrative distance indicates a
more preferred route. The valid range for
distance_integer is 1 to 255.
distance-external Change the administrative distance of all external OSPF 110
<distance_integer> routes. The range is from 1 to 255.
distance-inter-area Change the administrative distance of all inter-area 110
<distance_integer> OSPF routes. The range is from 1 to 255.
distance-intra-area Change the administrative distance of all intra-area 110
<distance_integer> OSPF routes. The range is from 1 to 255.
distribute-list-in Limit route updates from the OSPF neighbor based on Null.
<access_list_name> the Network Layer Reachability Information (NLRI)
defined in the specified access list. You must create the
access list before it can be selected here. See “access-
list” on page 224.
passive-interface <name_str> OSPF routing information is not sent or received through No
the specified interface. default.

FortiGate CLI Version 3.0 MR6 Reference

260 01-30006-0015-20080205
router ospf

Variables Description Default

restart-mode {graceful-restart Select the restart mode from: none
| lls | none} graceful-restart - (also known as hitless restart) when
FortiGate unit goes down it advertises to neighbors how
long it will be down to reduce traffic
lls - Enable Link-local Signaling (LLS) mode
none - hitless restart (graceful restart) is disabled
rfc1583-compatible Enable or disable RFC 1583 compatibility. RFC 1583 disable
{enable | disable} compatibility should be enabled only when there is
another OSPF router in the network that only supports
RFC 1583.
When RFC 1583 compatibility is enabled, routers
choose the path with the lowest cost. Otherwise, routers
choose the lowest cost intra-area path through a non-
backbone area.
router-id <address_ipv4> Set the router ID. The router ID is a unique number, in IP 0.0.0.0
address dotted decimal format, that is used to identify an
OSPF router to other OSPF routers within an area. The
router ID should not be changed while OSPF is running.
A router ID of 0.0.0.0 is not allowed.
spf-timers <delay_integer> Change the default shortest path first (SPF) calculation 5 10
<hold_integer> delay time and frequency.
The delay_integer is the time, in seconds, between
when OSPF receives information that will require an
SPF calculation and when it starts an SPF calculation.
The valid range for delay_integer is 0 to
4294967295.
The hold_integer is the minimum time, in seconds,
between consecutive SPF calculations. The valid range
for hold_integer is 0 to 4294967295.
OSPF updates routes more quickly if the SPF timers are
set low; however, this uses more CPU. A setting of 0 for
spf-timers can quickly use up all available CPU.

Example
This example shows how to set the OSPF router ID to 1.1.1.1 for a standard area border router:
config router ospf
set abr-type standard
set router-id 1.1.1.1
end

config area
Use this subcommand to set OSPF area related parameters. Routers in an OSPF autonomous system
(AS) or routing domain are organized into logical groupings called areas. Areas are linked together by
area border routers (ABRs). There must be a backbone area that all areas can connect to. You can
use a virtual link to connect areas that do not have a physical connection to the backbone. Routers
within an OSPF area maintain link state databases for their own areas.
You can use the config filter-list subcommand to control the import and export of LSAs into
and out of an area. See “config filter-list variables” on page 263. You can use access or prefix lists for
OSPF area filter lists. For more information, see “access-list” on page 224 and “prefix-list” on
page 275.
You can use the config range subcommand to summarize routes at an area boundary. If the
network numbers in an area are contiguous, the ABR advertises a summary route that includes all the
networks within the area that are within the specified range. See “config range variables” on page 263.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 261
ospf router

You can configure a virtual link using the config virtual-link subcommand to connect an area to
the backbone when the area has no direct connection to the backbone (see “config virtual-link
variables” on page 263). A virtual link allows traffic from the area to transit a directly connected area to
reach the backbone. The transit area cannot be a stub area. Virtual links can only be set up between
two ABRs.

Note: If you define a filter list, the direction and list keywords are required. If you define a range, the
prefix keyword is required. If you define a virtual link, the peer keyword is required. All other keywords are
optional.

Variables Description Default

edit <area_address_ipv4> Type the IP address of the area. An address of 0.0.0.0 No default.
indicates the backbone area.
authentication {md5 | Set the authentication type. none
none | text} Use the authentication keyword to define the
authentication used for OSPF packets sent and received in
this area. If you select none, no authentication is used. If you
select text, the authentication key is sent as plain text. If you
select md5, an authentication key is used to generate an MD5
hash.
Both text mode and MD5 mode only guarantee the
authenticity of the OSPF packet, not the confidentiality of the
information in the packet.
In text mode the key is sent in clear text over the network. Text
mode is usually used only to prevent network problems that
can occur if an unwanted or misconfigured router is
mistakenly added to the area.
If you configure authentication for interfaces, the
authentication configured for the area is not used.
Authentication passwords or keys are defined per interface.
See “config ospf-interface” on page 267.
default-cost Enter the metric to use for the summary default route in a stub 10
<cost_integer> area or not so stubby area (NSSA). A lower default cost
indicates a more preferred route.
The valid range for cost_integer is 1 to 16777214.
nssa-default-information- Enter enable to advertise a default route in a not so stubby disable
originate area. Affects NSSA ABRs or NSSA Autonomous System
{enable | disable} Boundary Routers only.

nssa-default-information- Specify the metric (an integer) for the default route set by the 10
originate-metric <metric> nssa-default-information-originate keyword.
nssa-default-information- Specify the OSPF external metric type for the default route set 2
originate-metric-type by the nssa-default-information-originate
{1 | 2} keyword.

nssa-redistribution Enable or disable redistributing routes into a NSSA area. enable

{enable | disable}
nssa-translator-role A NSSA border router can translate the Type 7 LSAs used for candidate
{always | candidate | external route information within the NSSA to Type 5 LSAs
never} used for distributing external route information to other parts
of the OSPF routing domain. Usually a NSSA will have only
one NSSA border router acting as a translator for the NSSA.
You can set the translator role to always to ensure this
FortiGate unit always acts as a translator if it is in a NSSA,
even if other routers in the NSSA are also acting as
translators.
You can set the translator role to candidate to have this
FortiGate unit participate in the process for electing a
translator for a NSSA.
You can set the translator role to never to ensure this
FortiGate unit never acts as the translator if it is in a NSSA.

FortiGate CLI Version 3.0 MR6 Reference

262 01-30006-0015-20080205
router ospf

Variables Description Default

shortcut {default | Use this command to specify area shortcut parameters. disable
disable | enable}
stub-type Enter no-summary to prevent an ABR sending summary summary
{no-summary | summary} LSAs into a stub area. Enter summary to allow an ABR to
send summary LSAs into a stub area.
type Set the area type: regular
{nssa | regular | stub} • Select nssa for a not so stubby area.
• Select regular for a normal OSPF area.
• Select stub for a stub area.
config filter-list variables
edit <filter-list_id> Enter an ID number for the filter list. The number must be an No default.
integer.
direction {in | out} Set the direction for the filter. Enter in to filter incoming out
packets. Enter out to filter outgoing packets.
list <name_str> Enter the name of the access list or prefix list to use for this Null.
filter list.
config range variables
edit <range_id> Enter an ID number for the range. The number must be an No default.
integer in the 0 to 4 294 967 295 range.
advertise Enable or disable advertising the specified range. enable
{enable | disable}
prefix <address_ipv4mask> Specify the range of addresses to summarize. 0.0.0.0
0.0.0.0
substitute Enter a prefix to advertise instead of the prefix defined for the 0.0.0.0
<address_ipv4mask> range. The prefix 0.0.0.0 0.0.0.0 is not allowed. 0.0.0.0
substitute-status {enable Enable or disable using a substitute prefix. disable
| disable}
config virtual-link variables
edit <vlink_name> Enter a name for the virtual link. No default.
authentication Set the authentication type. none
{md5 | none | text} Use the authentication keyword to define the
authentication used for OSPF packets sent and received over
this virtual link. If you select none, no authentication is used. If
you select text, the authentication key is sent as plain text. If
you select md5, an authentication key is used to generate an
MD5 hash.
Both text mode and MD5 mode only guarantee the
authenticity of the OSPF packet, not the confidentiality of the
information in the packet.
In text mode the key is sent in clear text over the network. Text
mode is usually used only to prevent network problems that
can occur if an unwanted or misconfigured router is
mistakenly added to the area.
authentication-key This keyword is available when authentication is set to *
<password_str> text. (No default.)
Enter the password to use for text authentication.
The authentication-key must be the same on both ends
of the virtual link.
The maximum length for the authentication-key is 15
characters.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 263
ospf router

Variables Description Default

dead-interval The time, in seconds, to wait for a hello packet before 40
<seconds_integer> declaring a router down. The value of the dead-interval
should be four times the value of the hello-interval.
Both ends of the virtual link must use the same value for
dead-interval.
The valid range for seconds_integer is 1 to 65535.
hello-interval The time, in seconds, between hello packets. 10
<seconds_integer> Both ends of the virtual link must use the same value for
hello-interval.
The valid range for seconds_integer is 1 to 65535.
md5-key This keyword is available when authentication is set to No default.
<id_integer><key_str> md5.
Enter the key ID and password to use for MD5 authentication.
Both ends of the virtual link must use the same key ID and
key.
The valid range for id_integer is 1 to 255. key_str is an
alphanumeric string of up to 16 characters.
peer <address_ipv4> The router id of the remote ABR. 0.0.0.0
0.0.0.0 is not allowed.
retransmit-interval The time, in seconds, to wait before sending a LSA 5
<seconds_integer> retransmission. The value for the retransmit interval must be
greater than the expected round-trip delay for a packet. The
valid range for seconds_integer is 1 to 65535.
transmit-delay The estimated time, in seconds, required to send a link state 1
<seconds_integer> update packet on this virtual link.
OSPF increments the age of the LSAs in the update packet to
account for transmission and propagation delays on the
virtual link.
Increase the value for transmit-delay on low speed links.
The valid range for seconds_integer is 1 to 65535.

Example
This example shows how to configure a stub area with the id 15.1.1.1, a stub type of summary, a
default cost of 20, and MD5 authentication.
config router ospf
config area
edit 15.1.1.1
set type stub
set stub-type summary
set default-cost 20
set authentication md5
end
end
This example shows how to use a filter list named acc_list1 to filter packets entering area 15.1.1.1.
config router ospf
config area
edit 15.1.1.1
config filter-list
edit 1
set direction in
set list acc_list1
end
end

FortiGate CLI Version 3.0 MR6 Reference

264 01-30006-0015-20080205
router ospf

This example shows how to set the prefix for range 1 of area 15.1.1.1.
config router ospf
config area
edit 15.1.1.1
config range
edit 1
set prefix 1.1.0.0 255.255.0.0
end
end
This example shows how to configure a virtual link.
config router ospf
config area
edit 15.1.1.1
config virtual-link
edit vlnk1
set peer 1.1.1.1
end
end

config distribute-list
Use this subcommand to filter the networks in routing updates using an access list. Routes not
matched by any of the distribution lists will not be advertised.
You must configure the access list that you want the distribution list to use before you configure the
distribution list. To configure an access list, see “access-list” on page 224.

Note: The access-list and protocol keywords are required.

Variables Description Default

edit <distribute-list_id> Enter an ID number for the distribution list. The number must No default.
be an integer.
access-list <name_str> Enter the name of the access list to use for this distribution Null.
list.
protocol Advertise only the routes discovered by the specified protocol connected
{connected | rip | static} and that are permitted by the named access list.

Example
This example shows how to configure distribution list 2 to use an access list named acc_list1 for all
static routes.
config router ospf
config distribute-list
edit 2
set access-list acc_list1
set protocol static
end
end

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 265
ospf router

config neighbor
Use this subcommand to manually configure an OSPF neighbor on non-broadcast networks. OSPF
packets are unicast to the specified neighbor address. You can configure multiple neighbors.

Note: The ip keyword is required. All other keywords are optional.

Variables Description Default

edit <neighbor_id> Enter an ID number for the OSPF neighbor. The number must No default.
be an integer.
bfd
cost <cost_integer> Enter the cost to use for this neighbor. The valid range for 10
cost_integer is 1 to 65535.
ip <address_ipv4> Enter the IP address of the neighbor. 0.0.0.0
poll-interval Enter the time, in seconds, between hello packets sent to the 10
<seconds_integer> neighbor in the down state. The value of the poll interval must
be larger than the value of the hello interval. The valid range for
seconds_integer is 1 to 65535.
priority Enter a priority number for the neighbor. The valid range for 1
<priority_integer> priority_integer is 0 to 255.

Example
This example shows how to manually add a neighbor.
config router ospf
config neighbor
edit 1
set ip 192.168.21.63
end
end

config network
Use this subcommand to identify the interfaces to include in the specified OSPF area. The prefix
keyword can define one or multiple interfaces.

Note: The area and prefix keywords are required.

Variables Description Default

edit <network_id> Enter an ID number for the network. The number must be an No default.
integer.
area <id-address_ipv4> The ID number of the area to be associated with the prefix. 0.0.0.0
prefix <address_ipv4mask> Enter the IP address and netmask for the OSPF network. 0.0.0.0
0.0.0.0

Example
Use the following command to enable OSPF for the interfaces attached to networks specified by the IP
address 10.0.0.0 and the netmask 255.255.255.0 and to add these interfaces to area 10.1.1.1.
config router ospf
config network

FortiGate CLI Version 3.0 MR6 Reference

266 01-30006-0015-20080205
router ospf

edit 2
set area 10.1.1.1
set prefix 10.0.0.0 255.255.255.0
end
end

config ospf-interface
Use this subcommand to change interface related OSPF settings.

Note: The interface keyword is required. All other keywords are optional.

Variables Description Default

edit Enter a descriptive name for this OSPF interface configuration. No default.
<ospf_interface_name> To apply this configuration to a FortiGate interface, set the
interface <name_str> attribute.
authentication Use the authentication keyword to define the none
{md5 | none | text} authentication used for OSPF packets sent and received by this
interface. If you select none, no authentication is used. If you
select text, the authentication key is sent as plain text. If you
select md5, the authentication key is used to generate an MD5
hash.
Both text mode and MD5 mode only guarantee the authenticity
of the update packet, not the confidentiality of the routing
information in the packet.
In text mode the key is sent in clear text over the network. Text
mode is usually used only to prevent network problems that can
occur if an unwanted or misconfigured router is mistakenly
added to the network.
If you configure authentication for the interface, authentication
for areas is not used.
All routers on the network must use the same authentication
type.
authentication-key This keyword is available when authentication is set to *
<password_str> text. (No default.)
Enter the password to use for text authentication.
The authentication-key must be the same on all
neighboring routers.
The maximum length for the authentication-key is 15
characters.
bfd {enable | disable} Select to enable Bi-directional Forwarding Detection (BFD). It is
used to quickly detect hardware problems on the network.
This command enables this service on this interface.

cost <cost_integer> Specify the cost (metric) of the link. The cost is used for shortest 10
path first calculations.
database-filter-out Enable or disable flooding LSAs out of this interface. disable
{enable | disable}
dead-interval The time, in seconds, to wait for a hello packet before declaring 40
<seconds_integer> a router down. The value of the dead-interval should be
four times the value of the hello-interval.
All routers on the network must use the same value for dead-
interval.
The valid range for seconds_integer is 1 to 65535.
hello-interval The time, in seconds, between hello packets. 10
<seconds_integer> All routers on the network must use the same value for hello-
interval.
The valid range for seconds_integer is 1 to 65535.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 267
ospf router

Variables Description Default

interface <name_str> Enter the name of the interface to associate with this OSPF Null.
configuration. The interface might be a virtual IPSec or GRE
interface.
ip <address_ipv4> Enter the IP address of the interface named by the interface 0.0.0.0
keyword.
It is possible to apply different OSPF configurations for different
IP addresses defined on the same interface.
The IP address 0.0.0.0 is not allowed.
md5-key This keyword is available when authentication is set to No default.
<id_integer> <key_str> md5.
Enter the key ID and password to use for MD5 authentication
You can add more than one key ID and key pair per interface.
However, you cannot unset one key without unsetting all of the
keys.
The key ID and key must be the same on all neighboring
routers.
The valid range for id_integer is 1 to 255. key_str is an
alphanumeric string of up to 16 characters.
mtu <mtu_integer> Change the Maximum Transmission Unit (MTU) size included in 1500
database description packets sent out this interface. The valid
range for mtu_integer is 576 to 65535.
mtu-ignore Use this command to control the way OSPF behaves when the disable
{enable | disable} MTU in the sent and received database description packets
does not match.
When mtu-ignore is enabled, OSPF will stop detecting
mismatched MTUs and go ahead and form an adjacency.
When mtu-ignore is disabled, OSPF will detect mismatched
MTUs and not form an adjacency.
mtu-ignore should only be enabled if it is not possible to
reconfigure the MTUs so that they match.
network-type <type> Specify the type of network to which the interface is connected. broadcast
OSPF supports four different types of network. This command
specifies the behavior of the OSPF interface according to the
network type, one of:
• broadcast
• non-broadcast
• point-to-multipoint
• point-to-point
If you specify non-broadcast, you must also configure
neighbors using “config neighbor” on page 113.
priority Set the router priority for this interface. 1
<priority_integer> Router priority is used during the election of a designated router
(DR) and backup designated router (BDR).
An interface with router priority set to 0 can not be elected DR or
BDR. The interface with the highest router priority wins the
election. If there is a tie for router priority, router ID is used.
Point-to-point networks do not elect a DR or BDR; therefore,
this setting has no effect on a point-to-point network.
The valid range for priority_integer is 0 to 255.
resync-timeout Enter the synchronizing timeout for graceful restart interval. 40
<integer> This is the period for this interface to synchronize with a
neighbor.
retransmit-interval The time, in seconds, to wait before sending a LSA 5
<seconds_integer> retransmission. The value for the retransmit interval must be
greater than the expected round-trip delay for a packet. The
valid range for seconds_integer is 1 to 65535.

FortiGate CLI Version 3.0 MR6 Reference

268 01-30006-0015-20080205
router ospf

Variables Description Default

status Enable or disable OSPF on this interface. enable
{enable | disable}
transmit-delay The estimated time, in seconds, required to send a link state 1
<seconds_integer> update packet on this interface.
OSPF increments the age of the LSAs in the update packet to
account for transmission and propagation delays on the
interface.
Increase the value for transmit-delay on low speed links.
The valid range for seconds_integer is 1 to 65535.

Example
This example shows how to assign an OSPF interface configuration named test to the interface
named internal and how to configure text authentication for this interface.
config router ospf
config ospf-interface
edit test
set interface internal
set ip 192.168.20.3
set authentication text
set authentication-key a2b3c4d5e
end
end

config redistribute
Use this subcommand to redistribute routes learned from BGP, RIP, static routes, or a direct
connection to the destination network.
The OSPF redistribution table contains four static entries. You cannot add entries to the table. The
entries are defined as follows:
• bgp—Redistribute routes learned from BGP.
• connected—Redistribute routes learned from a direct connection to the destination network.
• static—Redistribute the static routes defined in the FortiGate routing table.
• rip—Redistribute routes learned from RIP.
When you enter the subcommand, end the command with one of the four static entry names (that is,
config redistribute {bgp | connected | static | rip}).

Note: All keywords are optional.

Variables Description Default

metric <metric_integer> Enter the metric to be used for the redistributed routes. The 10
metric_integer range is from 1 to 16777214.
metric-type {1 | 2} Specify the external link type to be used for the redistributed 2
routes.
routemap <name_str> Enter the name of the route map to use for the redistributed Null.
routes. For information on how to configure route maps, see
“route-map” on page 286.
status {enable | disable} Enable or disable redistributing routes. disable
tag <tag_integer> Specify a tag for redistributed routes. 0
The valid range for tag_integer is 0 to 4294967295.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 269
ospf router

Example
This example shows how to enable route redistribution from RIP, using a metric of 3 and a route map
named rtmp2.
config router ospf
config redistribute rip
set metric 3
set routemap rtmp2
set status enable
end

config summary-address
Use this subcommand to summarize external routes for redistribution into OSPF. This command works
only for summarizing external routes on an Autonomous System Boundary Router (ASBR). For
information on summarization between areas, see “config range variables” on page 263. By replacing
the LSAs for each route with one aggregate route, you reduce the size of the OSPF link-state
database.

Note: The prefix keyword is required. All other keywords are optional.

Variables Description Default

edit <summary-address_id> Enter an ID number for the summary address. The number No default.
must be an integer.
advertise Advertise or suppress the summary route that matches the enable
{enable | disable} specified prefix.
prefix <address_ipv4mask> Enter the prefix (IP address and netmask) to use for the 0.0.0.0
summary route. The prefix 0.0.0.0 0.0.0.0 is not allowed. 0.0.0.0
tag <tag_integer> Specify a tag for the summary route. 0
The valid range for tag_integer is 0 to 4294967295.

Example
This example shows how to summarize routes using the prefix 10.0.0.0 255.0.0.0.
config router ospf
config summary-address
edit 5
set prefix 10.0.0.0 255.0.0.0
end
end

History

FortiOS v2.80 New.

FortiOS v3.0 Added distance-external, distance-inter-area, distance-intra-area, and
distribute-list-in keywords. Changed default value of abr-type attribute to
standard.
FortiOS v3.0 MR4 Added bfd, restart-mode, resynch-timeout, and restart-period keywords.

FortiGate CLI Version 3.0 MR6 Reference

270 01-30006-0015-20080205
router ospf

Related topics
• router access-list
• get router info ospf
• get router info protocols
• get router info routing-table
• router prefix-list
• router route-map

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 271
policy router

policy
Use this command to add, move, edit or delete a route policy. When you create a policy route, any
packets that match the policy are forwarded to the IP address of the next-hop gateway through the
specified outbound interface.
You can configure the FortiGate unit to route packets based on:
• a source address
• a protocol, service type, or port range
• the inbound interface
When the FortiGate unit receives a packet, it starts at the top of the policy routing list and attempts to
match the packet with a policy in ascending order. If no packets match the policy route, the FortiGate
unit routes the packet using the routing table. Route policies are processed before static routing. You
can change the order of policy routes using the move command. See “config branch” on page 34.

Note: For static routing, any number of static routes can be defined for the same destination. When multiple
routes for the same destination exist, the FortiGate unit chooses the route having the lowest administrative
distance. Route redundancy is not available for policy routing: any packets that match a route policy are forwarded
according to the route specified in the policy.

Syntax
config router policy
move <seq-num1> {before | after} <seq-num2>
edit <policy_integer>
set dst <dest-address_ipv4mask>
set end-port <port_integer>
set gateway <address_ipv4>
set input-device <interface-name_str>
set output-device <interface-name_str>
set protocol <protocol_integer>
set src <source-address_ipv4mask>
set start-port <port_integer>
end

Note: The input-device keyword is required. All other keywords are optional.

Variables Description Default

move <seq-num1> Move one policy before or after another. No default.
{before | after} <seq-num2>
edit <policy_integer> Enter an ID number for the route policy. The number must No default.
be an integer.
dst <dest-address_ipv4mask> Match packets that have this destination IP address and 0.0.0.0
netmask. 0.0.0.0
end-port <port_integer> The end port number of a port range for a policy route. 65 535
Match packets that have this destination port range. You
must configure both the start-port and end-port
keywords for destination-port-range matching to take
effect. To specify a range, the start-port value must be
lower than the end-port value. To specify a single port,
the start-port value must be identical to the end-port
value. The port_integer range is 0 to 65 535.
gateway <address_ipv4> Send packets that match the policy to this next hop router. 0.0.0.0

FortiGate CLI Version 3.0 MR6 Reference

272 01-30006-0015-20080205
router policy

Variables Description Default

input-device Match packets that are received on this interface. Null.
<interface-name_str>
output-device Send packets that match the policy out this interface. Null.
<interface-name_str>
protocol <protocol_integer> Match packets that have this protocol number. The range is 0
0 to 255.
src Match packets that have this source IP address and 0.0.0.0
<source-address_ipv4mask> netmask. 0.0.0.0
start-port <port_integer> The start port number of a port range for a policy route. 1
Match packets that have this destination port range. You
must configure both the start-port and end-port
keywords for destination-port-range matching to take
effect. To specify a range, the start-port value must be
lower than the end-port value. To specify a single port,
the start-port value must be identical to the end-port
value. The port_integer range is 0 to 65 535.

Example
If a FortiGate unit provides Internet access for multiple internal subnets, you can use policy routing to
control the route that traffic from each network takes to the Internet. For example, if the internal
network includes the subnets 192.168.10.0 and 192.168.20.0 you can enter the following route
policies:
• Enter the following command to route traffic from the 192.168.10.0 subnet to the
100.100.100.0 subnet. Force the packets to the next hop gateway at IP address 1.1.1.1
through the interface named external.
config router policy
edit 1
set input-device internal
set src 192.168.10.0 255.255.255.0
set dst 100.100.100.0 255.255.255.0
set output-device external
set gateway 1.1.1.1
end
• Enter the following command to route traffic from the 192.168.20.0 subnet to the 200.200.200.0
subnet. Force the packets to the next hop gateway at IP address 2.2.2.1 through the interface
named external.
config router policy
edit 2
set input-device internal
set src 192.168.20.0 255.255.255.0
set dst 200.200.200.0 255.255.255.0
set output-device external
set gateway 2.2.2.1
end
• Enter the following command to direct all HTTP traffic using port 80 to the next hop gateway at IP
address 1.1.1.1.
config router policy
edit 1
set input-device internal
set src 0.0.0.0 0.0.0.0
set dst 0.0.0.0 0.0.0.0

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 273
policy router

set output-device external

set gateway 1.1.1.1
set protocol 6
set start-port 80
set end-port 80
end
• Enter the following command to direct all other traffic to the next hop gateway at IP address
2.2.2.1.
config router policy
edit 2
set input-device internal
set src 0.0.0.0 0.0.0.0
set dst 0.0.0.0 0.0.0.0
set output-device external
set gateway 2.2.2.1
end

History

FortiOS v2.80 Revised.

FortiOS v3.0 Replaced all underscore characters in keywords with hyphens. Changed default start-
point number to 1. Changed default end-point number to 65 535.

Related topics
• router static

FortiGate CLI Version 3.0 MR6 Reference

274 01-30006-0015-20080205
router prefix-list

prefix-list
Use this command to add, edit, or delete prefix lists. A prefix list is an enhanced version of an access
list that allows you to control the length of the prefix netmask.
Each rule in a prefix list consists of a prefix (IP address and netmask), the action to take for this prefix
(permit or deny), and maximum and minimum prefix length settings.
The FortiGate unit attempts to match a packet against the rules in a prefix list starting at the top of the
list. If it finds a match for the prefix it takes the action specified for that prefix. If no match is found the
default action is deny. A prefix-list should be used to match the default route 0.0.0.0/0.
For a prefix list to take effect, it must be called by another FortiGate routing feature such as RIP or
OSPF.

Syntax
config router prefix-list
edit <prefix_list_name>
set comments <string>
config rule
edit <prefix_rule_id>
set action {deny | permit}
set ge <length_integer>
set le <length_integer>
set prefix {<address_ipv4mask> | any}
end
end

Note: The action and prefix keywords are required. All other keywords are optional.

Variables Description Default

edit <prefix_list_name> Enter a name for the prefix list. A prefix list and an access list No default.
cannot have the same name.
config rule variables
edit <prefix_rule_id> Enter an entry number for the rule. The number must be an No default.
integer.
action {deny | permit} Set the action to take for this prefix. permit
comments <string> Enter a description of this access list entry. The description
can be up to 127 characters long.
ge <length_integer> Match prefix lengths that are greater than or equal to this 0
number. The setting for ge should be less than the setting for
le. The setting for ge should be greater than the netmask set
for prefix. length_integer can be any number from 0 to
32.
le <length_integer> Match prefix lengths that are less than or equal to this number. 32
The setting for le should be greater than the setting for ge.
length_integer can be any number from 0 to 32.
prefix Enter the prefix (IP address and netmask) for this prefix list 0.0.0.0
{<address_ipv4mask> | any} rule or enter any to match any prefix. The length of the 0.0.0.0
netmask should be less than the setting for ge. If prefix is set
to any, ge and le should not be set.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 275
prefix-list router

Examples
This example shows how to add a prefix list named prf_list1 with three rules. The first rule permits
subnets that match prefix lengths between 26 and 30 for the prefix 192.168.100.0
255.255.255.0. The second rule denies subnets that match the prefix lengths between 20 and 25
for the prefix 10.1.0.0 255.255.0.0. The third rule denies all other traffic.
config router prefix-list
edit prf_list1
config rule
edit 1
set prefix 192.168.100.0 255.255.255.0
set action permit
set ge 26
set le 30
next
edit 2
set prefix 10.1.0.0 255.255.0.0
set action deny
set ge 20
set le 25
next
edit 3
set prefix any
set action deny
end
end

The following example shows how to create a prefix-list that will drop the default route but allow all
other prefixes to be passed. The first rule matches the default route only and is set to deny, the second
rule will match all other prefixes and allow them to be passed.
config router prefix-list
edit "drop_default"
config rule
edit 1
set action deny
set prefix 0.0.0.0 0.0.0.0
unset ge
unset le
next
edit 2
set prefix any
unset ge
unset le
next
end
next
end

FortiGate CLI Version 3.0 MR6 Reference

276 01-30006-0015-20080205
router prefix-list

History

FortiOS v2.80 New.

FortiOS v2.80 MR2 Changed default for le from 0 to 32.
FortiOS v3.0 MR4 Added second example.

Related topics
• router access-list
• router rip

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 277
rip router

rip
Use this command to configure the Routing Information Protocol (RIP) on the FortiGate unit. RIP is a
distance-vector routing protocol intended for small, relatively homogeneous, networks. RIP uses hop
count as its routing metric. Each network is usually counted as one hop. The network diameter is
limited to 15 hops with 16 hops.

Syntax
config router rip
set default-information-originate {enable | disable}
set default-metric <metric_integer>
set garbage-timer <timer_integer>
set passive-interface <name_str>
set timeout-timer <timer_integer>
set update-timer <timer_integer>
set version {1 2}
config distance
edit <distance_id>
set access-list <name_str>
set distance <distance_integer>
set prefix <address_ipv4mask>
end
config distribute-list
edit <distribute_list_id>
set direction {in | out}
set interface <name_str>
set listname <access/prefix-listname_str>
set status {enable | disable}
end
config interface
edit <interface_name>
set auth-keychain <name_str>
set auth-mode {none | text | md5}
set auth-string <password_str>
set receive-version {1 2}
set send-version {1 2}
set send-version1-compatible {enable | disable}
set split-horizon {poisoned | regular}
set split-horizon-status {enable | disable}
end
config neighbor
edit <neighbor_id>
set ip <address_ipv4>
end
config network
edit <network_id>
set prefix <address_ipv4mask>
end
config offset-list
edit <offset_list_id>
set access-list <name_str>
set direction {in | out}
set interface <name_str>

FortiGate CLI Version 3.0 MR6 Reference

278 01-30006-0015-20080205
router rip

set offset <metric_integer>

set status {enable | disable}
end
config redistribute {connected | static | ospf | bgp}
set metric <metric_integer>
set routemap <name_str>
set status {enable | disable}
end

config router rip

Use this command to specify RIP operating parameters. The FortiGate implementation of RIP
supports both RIP version 1 as defined by RFC 1058, and RIP version 2 as defined by RFC 2453. RIP
version 2 enables RIP messages to carry more information, and to support simple authentication and
subnet masks.

Note: All keywords are optional.

Variables Description Default

default-information-originate Enter enable to advertise a default static route into RIP. disable
{enable | disable}
default-metric For non-default routes in the static routing table and directly 1
<metric_integer> connected networks the default metric is the metric that the
FortiGate unit advertises to adjacent routers. This metric is
added to the metrics of learned routes. The default metric can
be a number from 1 to 16.
garbage-timer The time in seconds that must elapse after the timeout interval 120
<timer_integer> for a route expires, before RIP deletes the route. If RIP receives
an update for the route after the timeout timer expires but before
the garbage timer expires then the entry is switched back to
reachable.
RIP timer defaults are effective in most configurations. All
routers and access servers in the network should have the
same RIP timer settings.
passive-interface Block RIP broadcasts on the specified interface. You can use No
<name_str> “config neighbor” on page 283 and the passive interface default.
command to allow RIP to send unicast updates to the specified
neighbor while blocking broadcast updates on the specified
interface.
timeout-timer The time interval in seconds after which a route is declared 180
<timer_integer> unreachable. The route is removed from the routing table. RIP
holds the route until the garbage timer expires and then deletes
the route. If RIP receives an update for the route before the
timeout timer expires, then the timeout-timer is restarted. If RIP
receives an update for the route after the timeout timer expires
but before the garbage timer expires then the entry is switched
back to reachable. The value of the timeout timer should be at
least three times the value of the update timer.
RIP timer defaults are effective in most configurations. All
routers and access servers in the network should have the
same RIP timer settings.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 279
rip router

Variables Description Default

update-timer The time interval in seconds between RIP updates. 30
<timer_integer> RIP timer defaults are effective in most configurations. All
routers and access servers in the network should have the
same RIP timer settings.
version {1 2} Enable sending and receiving RIP version 1 packets, RIP 2
version 2 packets, or both for all RIP-enabled interfaces. You
can override this setting on a per interface basis using the
receive-version {1 2}and send-version {1 2} keywords described
under “config interface” on page 281.

Example
This example shows how to enable the advertising of a default static route into RIP, enable the sending
and receiving of RIP version 1 packets, and set the default metric to 5:
config router rip
set default-information-originate enable
set version 1
set default-metric 5
end

config distance
Use this subcommand to specify an administrative distance. When different routing protocols provide
multiple routes to the same destination, the administrative distance sets the priority of those routes.
The lowest administrative distance indicates the preferred route. If you specify a prefix, RIP uses the
specified distance when the source IP address of a packet matches the prefix.

Note: The distance keyword is required. All other keywords are optional.

Variables Description Default

edit <distance_id> Enter an entry number for the distance. The number must be No default.
an integer.
access-list <name_str> Enter the name of an access list. The distances associated Null.
with the routes in the access list will be modified. To create an
access list, see “access-list” on page 224.
distance Enter a number from 1 to 255, to set the administrative 0
<distance_integer> distance.
prefix Optionally enter a prefix to apply the administrative distance to. 0.0.0.0
<address_ipv4mask> 0.0.0.0

Example
This example shows how to change the administrative distance to 10.
config router rip
config distance
edit 1
set distance 10
end
end

FortiGate CLI Version 3.0 MR6 Reference

280 01-30006-0015-20080205
router rip

config distribute-list
Use this subcommand to filter incoming or outgoing updates using an access list or a prefix list. If you
do not specify an interface the filter will be applied to all interfaces. You must configure the access list
or prefix list that you want the distribution list to use before you configure the distribution list. For more
information on configuring access lists and prefix lists, see “access-list” on page 224 and “prefix-list”
on page 275.

Note: The direction and listname keywords are required. All other keywords are optional.

Variables Description Default

edit <distribute_list_id> Enter an entry number for the distribution list. The number No default.
must be an integer.
direction {in | out} Set the direction for the filter. Enter in to filter incoming out
packets. Enter out to filter outgoing packets.
interface <name_str> Enter the name of the interface to apply this distribution list to. Null.
If you do not specify an interface, this distribution list will be
used for all interfaces.
listname Enter the name of the access list or prefix list to use for this Null.
<access/prefix-listname_str> distribution list.
status {enable | disable} Enable or disable this distribution list. disable

Example
This example shows how to configure and enable distribution list 2 to use an access list named
acc_list1 on incoming updates on the external interface.
config router rip
config distribute-list
edit 2
set direction in
set interface external
set listname acc_list1
set status enable
end
end

config interface
Use this subcommand to configure RIP version 2 authentication, RIP version send and receive for the
specified interface, and to configure and enable split horizon.
Authentication is only available for RIP version 2 packets sent and received by an interface. You must
set auth-mode to none when receive-version or send-version are set to 1 or 1 2 (both are
set to 1 by default).

Note: All keywords are optional.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 281
rip router

Variables Description Default

edit <interface_name> Type the name of the FortiGate interface that is linked to the RIP No default.
network. The interface might be a virtual IPSec or GRE interface.
auth-keychain Enter the name of the key chain to use for authentication for RIP Null.
<name_str> version 2 packets sent and received by this interface. Use key
chains when you want to configure multiple keys. For information
on how to configure key chains, see “key-chain” on page 245.
auth-mode Use the auth-mode keyword to define the authentication used none
{none | text | md5} for RIP version 2 packets sent and received by this interface. If
you select none, no authentication is used. If you select text,
the authentication key is sent as plain text. If you select md5, the
authentication key is used to generate an MD5 hash.
Both text mode and MD5 mode only guarantee the authenticity of
the update packet, not the confidentiality of the routing
information in the packet.
In text mode the key is sent in clear text over the network. Text
mode is usually used only to prevent network problems that can
occur if an unwanted or misconfigured router is mistakenly added
to the network.
Use the auth-string keyword to specify the key.
auth-string Enter a single key to use for authentication for RIP version 2 Null.
<password_str> packets sent and received by this interface. Use auth-string
when you only want to configure one key. The key can be up to
35 characters long.
receive-version {1 2} RIP routing messages are UDP packets that use port 520. No default.
Enter 1 to configure RIP to listen for RIP version 1 messages on
an interface.
Enter 2 to configure RIP to listen for RIP version 2 messages on
an interface.
Enter 1 2 to configure RIP to listen for both RIP version 1 and
RIP version 2 messages on an interface.
send-version {1 2} RIP routing messages are UDP packets that use port 520. No default.
Enter 1 to configure RIP to send RIP version 1 messages from an
interface.
Enter 2 to configure RIP to send RIP version 2 messages from an
interface.
Enter 1 2 to configure RIP to send both RIP version 1 and RIP
version 2 messages from an interface.
send-version1-compatible Enable or disable sending broadcast updates from an interface disable
{enable | disable} configured for RIP version 2.
RIP version 2 normally multicasts updates. RIP version 1 can
only receive broadcast updates.
split-horizon Configure RIP to use either regular or poisoned split horizon on poisoned
{poisoned | regular} this interface.
Select regular to prevent RIP from sending updates for a route
back out the interface from which it received that route.
Select poisoned to send updates with routes learned on an
interface back out the same interface but with the routes marked
as unreachable.
split-horizon-status Enable or disable split horizon for this interface. Split horizon is enable
{enable | disable} enabled by default.
Disable split horizon only if there is no possibility of creating a
counting to infinity loop when network topology changes.

Example
This example shows how to configure the external interface to send and receive RIP version 2, to use
MD5 authentication, and to use a key chain called test1.
config router rip
config interface

FortiGate CLI Version 3.0 MR6 Reference

282 01-30006-0015-20080205
router rip

edit external
set receive-version 2
set send-version 2
set auth-mode md5
set auth-keychain test1
end
end

config neighbor
Use this subcommand to enable RIP to send unicast routing updates to the router at the specified
address. You can use the neighbor subcommand and “passive-interface <name_str>” on page 279
to allow RIP to send unicast updates to the specified neighbor while blocking broadcast updates on the
specified interface. You can configure multiple neighbors.

Note: The ip keyword is required. All other keywords are optional.

Variables Description Default

edit <neighbor_id> Enter an entry number for the RIP neighbor. The number must No default.
be an integer.
ip <address_ipv4> Enter the IP address of the neighboring router to which to send 0.0.0.0
unicast updates.

Example
This example shows how to specify that the router at 192.168.21.20 is a neighbor.
config router rip
config neighbor
edit 1
set ip 192.168.21.20
end
end

config network
Use this subcommand to identify the networks for which to send and receive RIP updates. If a network
is not specified, interfaces in that network will not be advertised in RIP updates.

Note: The prefix keyword is optional.

Variables Description Default

edit <network_id> Enter an entry number for the RIP network. The number must No default.
be an integer.
prefix <address_ipv4mask> Enter the IP address and netmask for the RIP network. 0.0.0.0
0.0.0.0

Example
Use the following command to enable RIP for the interfaces attached to networks specified by the IP
address 10.0.0.0 and the netmask 255.255.255.0.
config router rip

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 283
rip router

config network
edit 2
set prefix 10.0.0.0 255.255.255.0
end
end

config offset-list
Use this subcommand to add the specified offset to the metric (hop count) of a route from the offset list.

Note: The access-list, direction, and offset keywords are required. All other keywords are
optional.

Variables Description Default

edit <offset_list_id> Enter an entry number for the offset list. The number must be an No default.
integer.
access-list <name_str> Enter the name of the access list to use for this offset list. The Null.
access list is used to determine which routes to add the metric
to.
direction {in | out} Enter in to apply the offset to the metrics of incoming routes. out
Enter out to apply the offset to the metrics of outgoing routes.
interface <name_str> Enter the name of the interface to match for this offset list. Null.
offset <metric_integer> Enter the offset number to add to the metric. The metric is the 0
hop count. The metric_integer range is from 1 to 16, with 16
being unreachable.
status {enable | disable} Enable or disable this offset list. disable

Example
This example shows how to configure and enable offset list number 5 that adds a metric of 3 to
incoming routes that match the access list named acc_list1 on the external interface.
config router rip
config offset-list
edit 5
set access-list acc_list1
set direction in
set interface external
set offset 3
set status enable
end
end

config redistribute
Use this subcommand to redistribute routes learned from OSPF, BGP, static routes, or a direct
connection to the destination network.
The RIP redistribution table contains four static entries. You cannot add entries to the table. The entries
are defined as follows:
• bgp—Redistribute routes learned from BGP.
• connected—Redistribute routes learned from a direct connection to the destination network.
• ospf—Redistribute routes learned from OSPF.
• static—Redistribute the static routes defined in the FortiGate routing table.

FortiGate CLI Version 3.0 MR6 Reference

284 01-30006-0015-20080205
router rip

When you enter the subcommand, end the command with one of the four static entry names (that is,
config redistribute {bgp | connected | ospf | static}).

Note: All keywords are optional.

Variables Description Default

metric <metric_integer> Enter the metric value to be used for the redistributed routes. The 0
metric_integer range is from 0 to 16.
routemap <name_str> Enter the name of the route map to use for the redistributed Null.
routes. For information on how to configure route maps, see
“route-map” on page 286.
status {enable | disable} Enable or disable redistributing routes. disable

Example
This example shows how to enable route redistribution from OSPF, using a metric of 3 and a route
map named rtmp2.
config router rip
config redistribute ospf
set metric 3
set routemap rtmp2
set status enable
end

History

FortiOS v2.80 Substantially revised.

FortiOS v2.80 MR7 Added access-list keyword to config distance subcommand.

Related topics
• router access-list
• router key-chain
• router prefix-list
• router route-map
• get router info protocols
• get router info rip
• get router info routing-table

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 285
route-map router

route-map
Use this command to add, edit, or delete route maps. To use the command to limit the number of
received or advertised BGP route and routing updates using route maps, see “Using route maps with
BGP” on page 288.
Route maps provide a way for the FortiGate unit to evaluate optimum routes for forwarding packets or
suppressing the routing of packets to particular destinations. Compared to access lists, route maps
support enhanced packet-matching criteria. In addition, route maps can be configured to permit or
deny the addition of routes to the FortiGate routing table and make changes to routing information
dynamically as defined through route-map rules.
The FortiGate unit compares the rules in a route map to the attributes of a route. The rules are
examined in ascending order until one or more of the rules in the route map are found to match one or
more of the route attributes:
• When a single matching match-* rule is found, changes to the routing information are made as
defined through the rule’s set-ip-nexthop, set-metric, set-metric-type, and/or set-
tag settings.
• If no matching rule is found, no changes are made to the routing information.
• When more than one match-* rule is defined, all of the defined match-* rules must evaluate to
TRUE or the routing information is not changed.
• If no match-* rules are defined, the FortiGate unit makes changes to the routing information only
when all of the default match-* rules happen to match the attributes of the route.
The default rule in the route map (which the FortiGate unit applies last) denies all routes. For a route
map to take effect, it must be called by a FortiGate routing process.

Syntax
config router route-map
edit <route_map_name>
config rule
edit <route_map_rule_id>
set action {deny | permit}
set match-interface <name_str>
set match-ip-address <access/prefix-listname_str>
set match-ip-nexthop <access/prefix-listname_str>
set match-metric <metric_integer>
set match-route-type {1 | 2}
set match-tag <tag_integer>
set set-ip-nexthop <address_ipv4>
set set-metric <metric_integer>
set set-metric-type {1 | 2}
set set-tag <tag_integer>
end
end

FortiGate CLI Version 3.0 MR6 Reference

286 01-30006-0015-20080205
router route-map

Note: All keywords are optional.

Variables Description Default

edit <route_map_name> Enter a name for the route map. No default.
config rule variables
edit <route_map_rule_id> Enter an entry number for the rule. The number No default.
must be an integer.
action {deny | permit} Enter permit to permit routes that match this rule. permit
Enter deny to deny routes that match this rule.
match-interface <name_str> Enter the name of the local FortiGate interface that Null.
will be used to match route interfaces.
match-ip-address Match a route if the destination address is included Null.
<access/prefix-listname_str> in the specified access list or prefix list.
match-ip-nexthop Match a route that has a next-hop router address Null.
<access/prefix-listname_str> included in the specified access list or prefix list.
match-metric Match a route with the specified metric. The metric 0
<metric_integer> can be a number from 1 to 16.
match-route-type {1 | 2} Match a route that has the external type set to 1 or external-type1
2.
match-tag <tag_integer> This keyword is available when set-tag is set. 0
Match a route that has the specified tag.
set-ip-nexthop Set the next-hop router address for a matched 0.0.0.0
<address_ipv4> route.
set-metric <metric_integer> Set a metric value of 1 to 16 for a matched route. 0
set-metric-type {1 | 2} Set the type for a matched route. external-type1
set-tag <tag_integer> Set a tag value for a matched route. 0

Example
This example shows how to add a route map list named rtmp2 with two rules. The first rule denies
routes that match the IP addresses in an access list named acc_list2. The second rule permits
routes that match a metric of 2 and changes the metric to 4.
config router route-map
edit rtmp2
config rule
edit 1
set match-ip-address acc_list2
set action deny
next
edit 2
set match-metric 2
set action permit
set set-metric 4
end
end

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 287
route-map router

Using route maps with BGP

When a connection is established between BGP peers, the two peers exchange all of their BGP route
entries. Afterward, they exchange updates that only include changes to the existing routing
information. Several BGP entries may be present in a route-map table. You can limit the number of
received or advertised BGP route and routing updates using route maps. Use the config router
route-map command to create, edit, or delete a route map.

Note: When you specify a route map for the dampening-route-map value through the config router bgp
command (see “dampening-route-map <routemap-name_str>” on page 233), the FortiGate unit ignores
global dampening settings. You cannot set global dampening settings for the FortiGate unit and then override
those values through a route map.

Syntax
config router route-map
edit <route_map_name>
config rule
edit <route_map_rule_id>
set match-as-path <aspath-list-name_str>
set match-community <community-list-name_str>
set match-community-exact {enable | disable}
set match-origin {egp | igp | incomplete | none}
set set-aggregator-as <id_integer>
set set-aggregator-ip <address_ipv4>
set set-aspath <id_integer> <id_integer> <id_integer> ...
set set-atomic-aggregate {enable | disable}
set set-community-delete <community-list-name_str>
set set-community <criteria>
set set-community-additive {enable | disable}
set set-dampening-reachability-half-life <minutes>
set set-dampening-reuse <reuse_integer>
set set-dampening-suppress <suppress_integer>
set set-dampening-max-suppress <minutes>
set set-dampening-unreachability-half-life <minutes>
set set-extcommunity-rt <AA:NN> <AA:NN> <AA:NN> ...
set set-extcommunity-soo <AA:NN> <AA:NN> <AA:NN> ...
set set-local-preference <preference_integer>
set set-originator-id <address_ipv4>
set set-origin {egp | igp | incomplete | none}
set set-weight <weight_integer>
end

FortiGate CLI Version 3.0 MR6 Reference

288 01-30006-0015-20080205
router route-map

Note: All keywords are optional.

Variables Description Default

edit <route_map_name> Enter a name for the route map. No default.
config rule variables
edit <route_map_rule_id> Enter an entry number for the rule. The number must be an No default.
integer.
match-as-path Enter the AS-path list name that will be used to match BGP Null.
<aspath-list-name_str> route prefixes. You must create the AS-path list before it
can be selected here. See “aspath-list” on page 226.
match-community Enter the community list name that will be used to match Null.
<community-list-name_str> BGP routes according to their COMMUNITY attributes.
You must create the community list before it can be
selected here. See “community-list” on page 242.
match-community-exact This keyword is available when match-community is set. disable
{enable | disable} Enable or disable an exact match of the BGP route
community specified by the match-community keyword.
match-origin {egp | igp | Enter a value to compare to the ORIGIN attribute of a none
incomplete | none} routing update:
• To compare the NLRI learned from the Exterior Gateway
Protocol (EGP), select egp. The FortiGate unit has the
second-highest preference for routes of this type.
• To compare the NLRI learned from a protocol internal to
the originating AS, select igp. The FortiGate unit has the
highest preference for routes learned through Internal
Gateway Protocol (IGP).
• To match routes that were learned some other way (for
example, through redistribution), select incomplete.
• To disable the matching of BGP routes based on the
origin of the route, select none.
set-aggregator-as Set the originating AS of an aggregated route. The value unset
<id_integer> specifies at which AS the aggregate route originated. The
range is from 1 to 65 535. The set-aggregator-ip
value must also be set to further identify the originating AS.
set-aggregator-ip This keyword is available when set-aggregator-as is 0.0.0.0
<address_ipv4> set.
Set the IP address of the BGP router that originated the
aggregate route. The value should be identical to the
FortiGate router-id value (see “router-id
<address_ipv4>” on page 234).
set-aspath Modify the FortiGate AS_PATH attribute and add to it the No default.
<id_integer> <id_integer> AS numbers of the AS path belonging to a BGP route. The
<id_integer> ... resulting path describes the autonomous systems along
the route to the destination specified by the NLRI. The
range is from 1 to 65 535.
The set-aspath value is added to the beginning of the
AS_SEQUENCE segment of the AS_PATH attribute of
incoming routes, or to the end of the AS_SEQUENCE
segment of the AS_PATH attribute of outgoing routes.
Enclose all AS numbers in quotes if there are multiple
occurrences of the same id_integer. Otherwise the AS path
may be incomplete.
set-atomic-aggregate Enable or disable a warning to upstream routers through disable
{enable | disable} the ATOMIC_AGGREGATE attribute that address
aggregation has occurred on an aggregate route. This
value does not have to be specified when an as-set
value is specified in the aggregate-address table (see
“config aggregate-address” on page 235).

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 289
route-map router

Variables Description Default

set-community-delete Remove the COMMUNITY attributes from the BGP routes Null.
<community-list-name_str> identified in the specified community list. You must create
the community list first before it can be selected here (see
“community-list” on page 242).
set-community <criteria> Set the COMMUNITY attribute of a BGP route. No default.
• Use decimal notation to set a specific COMMUNITY
attribute for the route. The value has the syntax AA:NN,
where AA represents an AS, and NN is the community
identifier. Delimit complex expressions with double-
quotation marks (for example, “123:234 345:456”).
• To make the route part of the Internet community, select
internet.
• To make the route part of the LOCAL_AS community,
select local-AS.
• To make the route part of the NO_ADVERTISE
community, select no-advertise.
• To make the route part of the NO_EXPORT community,
select no-export.
set-community-additive This keyword is available when set-community is set. disable
{enable | disable} Enable or disable the appending of the set-community
value to a BGP route.
set-dampening-reachability- Set the dampening reachability half-life of a BGP route (in 0
half-life minutes). The range is from 1 to 45.
<minutes>
set-dampening-reuse Set the value at which a dampened BGP route will be 0
<reuse_integer> reused. The range is from 1 to 20 000. If you set set-
dampening-reuse, you must also set set-dampening-
suppress and set-dampening-max-suppress.
set-dampening-suppress Set the limit at which a BGP route may be suppressed. The 0
<suppress_integer> range is from 1 to 20 000. See also “dampening-
suppress <limit_integer>” on page 233.
set-dampening-max-suppress Set maximum time (in minutes) that a BGP route can be 0
<minutes> suppressed. The range is from 1 to 255. See also
“dampening-max-suppress-time” in “dampening-
max-suppress-time <minutes_integer>” on
page 232.
set-dampening- Set the unreachability half-life of a BGP route (in minutes). 0
unreachability-half-life The range is from 1 to 45. See also “dampening-
<minutes> unreachability-half-life” in “dampening-
unreachability-half-life <minutes_integer>”
on page 233.
set-extcommunity-rt Set the target extended community (in decimal notation) of No default.
<AA:NN> <AA:NN> <AA:NN> ... a BGP route. The COMMUNITY attribute value has the
syntax AA:NN, where AA represents an AS, and NN is the
community identifier.
set-extcommunity-soo Set the site-of-origin extended community (in decimal No default.
<AA:NN> <AA:NN> <AA:NN> ... notation) of a BGP route. The COMMUNITY attribute value
has the syntax AA:NN, where AA represents an AS, and NN
is the community identifier.
set-local-preference Set the LOCAL_PREF value of an IBGP route. The value 0
<preference_integer> is advertised to IBGP peers. The range is from 0 to
4 294 967 295. A higher number signifies a preferred route
among multiple routes to the same destination.
set-originator-id Set the ORIGINATOR_ID attribute, which is equivalent to 0.0.0.0
<address_ipv4> the router-id of the originator of the route in the local
AS. Route reflectors use this value to prevent routing
loops.

FortiGate CLI Version 3.0 MR6 Reference

290 01-30006-0015-20080205
router route-map

Variables Description Default

set-origin {egp | igp | Set the ORIGIN attribute of a local BGP route. none
incomplete | none} • To set the value to the NLRI learned from the Exterior
Gateway Protocol (EGP), select egp.
• To set the value to the NLRI learned from a protocol
internal to the originating AS, select igp.
• If you did not specify egp or igp, select incomplete.
• To disable the ORIGIN attribute, select none.
set-weight Set the weight of a BGP route. A route’s weight has the 0
<weight_integer> most influence when two identical BGP routes are
compared. A higher number signifies a greater preference.
The range is from 0 to 2 147 483 647.

Example
This example shows how to create a route map named BGP_rtmp2. The route map contains two
rules. The first rule permits operations on routes that match the IP addresses in an access list named
acc_list2. The second rule permits operations on routes according to a community list named
com_list3.
config router route-map
edit BGP_rtmp2
config rule
edit 1
set match-ip-address acc_list2
set action permit
next
edit 2
set match-community com_list3
set action permit
end
end

History
FortiOS v2.80 New.
FortiOS v3.0 Added support for BGP.

Related topics
• router access-list
• router prefix-list
• router rip
• router aspath-list
• router bgp
• router community-list
• router key-chain

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 291
static router

static
Use this command to add, edit, or delete static routes for IPv4 traffic. For IPv6 traffic, use the static6
command. You add static routes to control traffic exiting the FortiGate unit. You configure routes by
specifying destination IP addresses and network masks and adding gateways for these destination
addresses. Gateways are the next-hop routers to which traffic that matches the destination addresses
in the route are forwarded.
You can adjust the administrative distance of a route to indicate preference when more than one route
to the same destination is available. The lower the administrative distance, the greater the preferability
of the route. If the routing table contains several entries that point to the same destination (the entries
may have different gateways or interface associations), the FortiGate unit compares the administrative
distances of those entries, selects the entries having the lowest distances, and installs them as routes
in the FortiGate forwarding table. Any ties are resolved by comparing the routes’ priority, with lowest
priority being preferred. As a result, the FortiGate forwarding table only contains routes having the
lowest distances to every possible destination.
After the FortiGate unit selects static routes for the forwarding table based on their administrative
distances, the sequence numbers of those routes determines routing priority. When two routes to the
same destination exist in the forwarding table, the FortiGate unit selects the route having the lowest
sequence number.

Syntax
config router static
edit <sequence_number>
set blackhole {enable | disable}
set device <interface_name>
set distance <distance>
set dst <destination-address_ipv4mask>
set dynamic-gateway {enable | disable}
set gateway <gateway-address_ipv4>
set priority <integer>
end

Note: The dst and gateway keywords are required when blackhole is disabled. When blackhole is
enabled, the dst keyword is required. All other keywords are optional.

Variables Description Default

edit <sequence_number> Enter a sequence number for the static route. The sequence No default.
number may influence routing priority in the FortiGate
forwarding table.
blackhole {enable | Enable or disable the advertising of this route to neighbors disable
disable} through dynamic routing protocols while dropping all packets
that match this route.
device <interface_name> This keyword is available when blackhole is set to disable. Null.
Enter the name of the FortiGate interface through which to
route traffic.
distance <distance> Enter the administrative distance for the route. The distance 10
value may influence route preference in the FortiGate routing
table. The range is an integer from 1-255. See also config
system interface “distance <distance_integer>” on page 259.

FortiGate CLI Version 3.0 MR6 Reference

292 01-30006-0015-20080205
router static

Variables Description Default

dst <destination- Enter the destination IP address and network mask for this 0.0.0.0
address_ipv4mask> route. 0.0.0.0
You can enter 0.0.0.0 0.0.0.0 to create a new static
default route.
dynamic-gateway {enable | When enabled, dynamic-gateway hides the gateway variable disable
disable} for a dynamic interface, such as a DHCP or PPPoE interface.
When the interface connects or disconnects, the corresponding
routing entries are updated to reflect the change.
gateway <gateway- This keyword is available when blackhole is set to disable. 0.0.0.0
address_ipv4> Enter the IP address of the next-hop router to which traffic is
forwarded.
priority <integer> The administrative priority value is used to resolve ties in route
selection. In the case where both routes have the same priority,
the egress index for the routes will be used to determine the
selected route. The range is an integer from 0 to 4294967295.
Lower priority routes are preferred routes.
This field is only accessible through the CLI.

Example
This example shows how to add a static route that has the sequence number 2.
config router static
edit 2
set dev internal
set dst 192.168.22.0 255.255.255.0
set gateway 192.168.22.44
end
This example shows how to add a static route for a dynamic modem interface with a priority of 1.
config route static
edit 3
set dev modem
set dynamic-gateway enable
set dst 10.0.0.7 255.255.255.0
set priority 1
end

History

FortiOS v2.80 Substantially revised.

FortiOS v3.0 Added blackhole attribute.
FortiOS v3.0 MR2 Added dynamic-gateway attribute.

Related topics
• system interface
• get router info routing-table

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 293
static6 router

static6
Use this command to add, edit, or delete static routes for IPv6 traffic. You add static routes to specify
the destination of traffic exiting the FortiGate unit. You configure routes by adding destination IP
addresses and network masks and adding gateways for these destination addresses. The gateways
are the next-hop routers to which traffic that matches the destination addresses in the route are
forwarded.

Note: You can configure static routes for IPv6 traffic on FortiGate units that run in NAT/Route mode.

Syntax
config router static6
edit <sequence_number>
set device <interface_name>
set dst <destination-address_ipv6mask>
set gateway <gateway-address_ipv6>
end

Note: The device, dst, and gateway keywords are required.

Variables Description Default

edit <sequence_number> Enter a sequence number for the static route. No default.
device <interface_name> The name of the FortiGate interface through which to route Null.
traffic.
dst <destination- The destination IPv6 address and netmask for this route. ::/0
address_ipv6mask> You can enter ::/0 to create a new static default route for
IPv6 traffic.
gateway The IPv6 address of the next-hop router to which traffic is ::
<gateway-address_ipv6> forwarded.

Example
This example shows how to add an IPv6 static route that has the sequence number 2.
config router static6
edit 2
set dev internal
set dst 12AB:0:0:CD30::/60
set gateway 12AB:0:0:CD30:123:4567:89AB:CDEF
end

History

FortiOS v2.80 New.

Related topics
• system interface
• get router info routing-table

FortiGate CLI Version 3.0 MR6 Reference

294 01-30006-0015-20080205
spamfilter

spamfilter
Use spamfilter commands to create a banned word list, configure filters based on email addresses, ip
addresses, and MIME headers, and to configure the FortiGuard-Antispam service.
This chapter contains the following sections:

bword
emailbwl
fortishield
ipbwl
iptrust
mheader
options
DNSBL

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 295
bword spamfilter

bword
Use this command to add or edit and configure options for the spam filter banned word list.
The FortiGate spam filters are applied in the following order:

For SMTP
1 IP address BWL check - Last hop IP
2 DNSBL & ORDBL check, IP address FortiGuard check, HELO DNS lookup
3 E-mail address BWL check
4 MIME headers check
5 IP address BWL check (for IPs extracted from “Received” headers)
6 Return e-mail DNS check, FortiGuard Antispam check (for IPs extracted from “Received” headers, and
URLs in email content)
7 Banned word check

For POP3 and IMAP

1 E-mail address BWL check
2 MIME headers check, IP BWL check
3 Return e-mail DNS check, FortiGuard Antispam check, DNSBL & ORDBL check
4 Banned word check

For SMTP, POP3, and IMAP

Control spam by blocking email messages containing specific words or patterns. If enabled in the
protection profile, the FortiGate unit searches for words or patterns in email messages. If matches are
found, values assigned to the words are totalled. If a user-defined threshold value is exceeded, the
message is marked as spam. If no match is found, the email message is passed along to the next filter.
Use Perl regular expressions or wildcards to add banned word patterns to the list. See “Using Perl
regular expressions” on page 48. Add one or more banned words to sort email containing those words
in the email subject, body, or both. Words can be marked as spam or clear. Banned words can be one
word or a phrase up to 127 characters long.
If a single word is entered, the FortiGate unit blocks all email that contain that word. If a phrase is
entered, the FortiGate unit blocks all email containing the exact phrase. To block any word in a phrase,
use Perl regular expressions.

Note: Perl regular expression patterns are case sensitive for Spam Filter banned words. To make a word or
phrase case insensitive, use the regular expression /i. For example, /bad language/i blocks all instances of
bad language regardless of case. Wildcard patterns are not case sensitive.

FortiGate CLI Version 3.0 MR6 Reference

296 01-30006-0015-20080205
spamfilter bword

Syntax
config spamfilter bword
edit <banned_word_list_integer>
set name <banned_word_list>
set comment <banned_word_list_comment>
config entries
edit <banned_word_integer>
set action {clear | spam}
set language {french | japanese | korean | simch | thai | trach |
western}
set pattern <banned_word_str>
set pattern-type {regexp | wildcard}
set score <integer_value>
set status {enable | disable}
set where {all | body | subject}
end
Keywords and variables Description Default
<banned_word_list_integer> A unique number to identify the banned word list.
<banned_word_list> The name of the banned word list.
<banned_word_list_comment> The comment attached to the banned word list.
<banned_word_integer> A unique number to identify the banned word or pattern.
action {clear | spam} Enter clear to allow the email. Enter spam to apply the spam spam
action configured in the protection profile.
language {french | Enter the language character set used for the banned word or western
japanese | korean | simch phrase. Choose from French, Japanese, Korean, Simplified
| thai | trach | western} Chinese, Thai, Traditional Chinese, or Western.

pattern <banned_word_str> Enter the banned word or phrase pattern using regular No default.
expressions or wildcards.
pattern-type {regexp | Enter the pattern type for the banned word (pattern). Choose wildcard
wildcard} from regular expressions or wildcard.
score <integer_value> A numerical weighting applied to the banned word. The score 10
values of all the matching words appearing in an email
message are added, and if the total is greater than the
spamwordthreshold value set in the protection profile, the
message is processed according to the spam action setting in
the protection profile. The score for a banned word is counted
once even if the word appears multiple times in an email
message.
status {enable | disable} Enable or disable scanning email for each banned word. enable
where {all | body | Enter where in the email to search for the banned word or all
subject} phrase.

History

FortiOS v2.80 New.

FortiOS v2.80 MR2 Added French and Thai variables to the language keyword.
FortiOS v3.0 Added score variable. Added multiple-list capability for models 800 and above.
FortiOS v3.0 MR4 All models have the same CLI syntax now.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 297
bword spamfilter

Related topics
• spamfilter emailbwl
• spamfilter fortishield
• spamfilter ipbwl
• spamfilter iptrust
• spamfilter mheader
• spamfilter options
• spamfilter DNSBL

FortiGate CLI Version 3.0 MR6 Reference

298 01-30006-0015-20080205
spamfilter emailbwl

emailbwl
Use this command to filter email based on the sender’s email address or address pattern.
The FortiGate spam filters are applied in the following order:

For SMTP
1 IP address BWL check - Last hop IP
2 DNSBL & ORDBL check, IP address FortiGuard check, HELO DNS lookup
3 E-mail address BWL check
4 MIME headers check
5 IP address BWL check (for IPs extracted from “Received” headers)
6 Return e-mail DNS check, FortiGuard Antispam check (for IPs extracted from “Received” headers, and
URLs in email content)
7 Banned word check

For POP3 and IMAP

1 E-mail address BWL check
2 MIME headers check, IP BWL check
3 Return e-mail DNS check, FortiGuard Antispam check, DNSBL & ORDBL check
4 Banned word check

For SMTP, POP3, and IMAP

The FortiGate unit uses the email address list to filter incoming email. The FortiGate unit compares the
email address or domain of the sender to the list in sequence. If a match is found, the corresponding
action is taken. If no match is found, the email is passed on to the next spam filter.
The FortiGate unit can filter email from specific senders or all email from a domain (such as
example.net). Each email address can be marked as clear or spam.
Use Perl regular expressions or wildcards to add email address patterns to the list. See “Using Perl
regular expressions” on page 48.

Syntax
config spamfilter emailbwl
edit <emailbwl_list_integer>
set name <emailbwl_list>
set comment <emailbwl_list_comment>
config entries
edit <email_address_integer>
set action {clear | spam}
set email-pattern <email_address_str>
set pattern-type {regexp | wildcard}
set status {enable | disable}
end

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 299
emailbwl spamfilter

Keywords and variables Description Default

<emailbwl_list_integer> A unique number to identify the email black/white list.
<emailbwl_list> The name of the email black/white list.
<emailbwl_list_comment> The comment attached to the email black/white list.
<email_address_integer> A unique number to identify the email pattern.
action {clear | spam} Enter clear to exempt the email from the rest of the spam spam
filters. Enter spam to apply the spam action configured in the
protection profile.
email-pattern Enter the email address pattern using wildcards or Perl regular
<email_address_str> expressions.
pattern-type Enter the pattern-type for the email address. Choose from wildcard
{regexp | wildcard} wildcards or Perl regular expressions.
status {enable | disable} Enable or disable scanning for each email address. enable

History

FortiOS v2.80 New.

FortiOS v3.0 Added multiple-list capability for models 800 and above.
FortiOS v3.0 All models have the same CLI syntax now.
MR4

Related topics
• spamfilter bword
• spamfilter fortishield
• spamfilter ipbwl
• spamfilter iptrust
• spamfilter mheader
• spamfilter options
• spamfilter DNSBL

FortiGate CLI Version 3.0 MR6 Reference

300 01-30006-0015-20080205
spamfilter fortishield

fortishield
Use this command to configure the settings for the FortiGuard-Antispam Service.
The FortiGate spam filters are applied in the following order:

For SMTP
1 IP address BWL check - Last hop IP
2 DNSBL & ORDBL check, IP address FortiGuard check, HELO DNS lookup
3 E-mail address BWL check
4 MIME headers check
5 IP address BWL check (for IPs extracted from “Received” headers)
6 Return e-mail DNS check, FortiGuard Antispam check (for IPs extracted from “Received” headers, and
URLs in email content)
7 Banned word check

For POP3 and IMAP

1 E-mail address BWL check
2 MIME headers check, IP BWL check
3 Return e-mail DNS check, FortiGuard Antispam check, DNSBL & ORDBL check
4 Banned word check

For SMTP, POP3, and IMAP

FortiGuard-Antispam Service is an antispam system from Fortinet that includes an IP address black
list, a URL black list, and spam filtering tools. The IP address black list contains IP addresses of email
servers known to be used to generate Spam. The URL black list contains found in Spam email.
FortiGuard-Antispam Service compiles the IP address and URL list from email captured by spam
probes located around the world. Spam probes are email addresses purposely configured to attract
spam and identify known spam sources to create the antispam IP address and URL list. FortiGuard-
Antispam Service combines IP address and URL checks with other spam filter techniques in a two-
pass process.
On the first pass, if spamfsip is selected in the protection profile, FortiGuard-Antispam Service
extracts the SMTP mail server source address and sends the IP address to a FortiGuard-Antispam
Service server to see if this IP address matches the list of known spammers. If spamfsurl is selected
in the protection profile, FortiGuard-Antispam Service checks the body of email messages to extract
any URL links. These URL links will be sent to a FortiGuard-Antispam Service server to see if any of
them is listed. Typically Spam messages contain URL links to advertisements (also called
spamvertizing).
If an IP address or URL match is found, FortiGuard-Antispam Service terminates the session. If
FortiGuard-Antispam Service does not find a match, the mail server sends the email to the recipient.
As each email is received, FortiGuard-Antispam Service performs the second antispam pass by
checking the header, subject, and body of the email for common spam content. If FortiGuard-Antispam
Service finds spam content, the email is tagged or dropped according to the configuration in the
firewall protection profile.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 301
fortishield spamfilter

Both FortiGuard-Antispam Service antispam processes are completely automated and configured by
Fortinet. With constant monitoring and dynamic updates, FortiGuard-Antispam Service is always
current. Enable or disable FortiGuard-Antispam Service in a firewall protection profile.

Syntax
config spamfilter fortishield
set spam-submit-force {enable | disable}
set spam-submit-srv <url_str>
set spam-submit-txt2htm {enable | disable}
end
Keywords and variables Description Default
spam-submit-force {enable Enable or disable force insertion of a new mime entity for the enable
| disable} submission text.
spam-submit-srv <url_str> The host name of the FortiGuard-Antispam Service server. www.nospa
The FortiGate unit comes preconfigured with the host name. mmer.net
Use this command only to change the host name.
spam-submit-txt2htm Enable or disable converting text email to HTML. enable
{enable | disable}

History

FortiOS v2.80 MR7 New.

FortiOS v3.0 Some revisions and added port and timeout.
FortiOS v3.0 MR1 Restructured -- some commands were moved to system fortiguard and some new
commands were added.

Related topics
• spamfilter bword
• spamfilter emailbwl
• spamfilter ipbwl
• spamfilter iptrust
• spamfilter mheader
• spamfilter options
• spamfilter DNSBL

FortiGate CLI Version 3.0 MR6 Reference

302 01-30006-0015-20080205
spamfilter ipbwl

ipbwl
Use this command to filter email based on the IP or subnet address.
The FortiGate spam filters are generally applied in the following order:

For SMTP
1 IP address BWL check - Last hop IP
2 DNSBL & ORDBL check, IP address FortiGuard check, HELO DNS lookup
3 E-mail address BWL check
4 MIME headers check
5 IP address BWL check (for IPs extracted from “Received” headers)
6 Return e-mail DNS check, FortiGuard Antispam check (for IPs extracted from “Received” headers, and
URLs in email content)
7 Banned word check

For POP3 and IMAP

1 E-mail address BWL check
2 MIME headers check, IP BWL check
3 Return e-mail DNS check, FortiGuard Antispam check, DNSBL & ORDBL check
4 Banned word check

For SMTP, POP3, and IMAP

The FortiGate unit uses the IP address list to filter incoming email. The FortiGate unit compares the IP
address of the sender to the list in sequence. If a match is found, the corresponding protection profile
action is taken. If no match is found, the email is passed on to the next spam filter.
Enter an IP address and mask in one of two formats:
• x.x.x.x/x.x.x.x, for example 192.168.10.23/255.255.255.0
• x.x.x.x/x, for example 192.168.10.23/24
Configure the FortiGate unit to filter email from specific IP addresses. Mark each IP address as clear,
spam, or reject. Filter single IP addresses, or a range of addresses at the network level by configuring
an address and mask.

Syntax
config spamfilter ipbwl
edit <ipbwl_list_integer>
set name <ipbwl_list>
set comment <ipbwl_list_comment>
config entries
edit <address_ipv4_integer>
set action {clear | reject | spam}
set ip/subnet {<address_ipv4> |
<address_ipv4>/<address_ipv4mask>}
set status {enable | disable}
end

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 303
ipbwl spamfilter

Keywords and variables Description Default

<ipbwl_list_integer> A unique number to identify the IP black/white list.
<ipbwl_list> The name of the IP black/white list.
<ipbwl_list_comment> The comment attached to the IP black/white list.
<address_ipv4_integer> A unique number to identify the address.
action Enter clear to exempt the email from the rest of the spam spam
{clear | reject | spam} filters. Enter reject to drop any current or incoming sessions.
Enter spam to apply the spam action configured in the
protection profile.
ip/subnet {<address_ipv4> | The IP address to filter. A subnet mask in the format No default.
<address_ipv4>/<address_ip 192.168.10.23/255.255.255.0 or 192.168.10.23/24 can
v4mask>} also be included.

status {enable | disable} Enable or disable scanning email for each IP address. enable

History
FortiOS v2.80 New.
FortiOS v3.0 Added multiple-list capability for models 800 and above.
FortiOS v3.0 MR4 All models have the same CLI syntax now.

Related topics
• spamfilter bword
• spamfilter emailbwl
• spamfilter fortishield
• spamfilter iptrust
• spamfilter mheader
• spamfilter options
• spamfilter DNSBL

FortiGate CLI Version 3.0 MR6 Reference

304 01-30006-0015-20080205
spamfilter iptrust

iptrust
Use this command to add an entry to a list of trusted IP addresses.
If the FortiGate unit sits behind a company’s Mail Transfer Units, it may be unnecessary to check email
IP addresses because they are internal and trusted. The only IP addresses that need to be checked
are those from outside of the company. In some cases, external IP addresses may be added to the list
if it is known that they are not sources of spam.

Syntax
config spamfilter iptrust
edit <iptrust_list_integer>
set name <iptrust_list>
set comment <iptrust_list_comment>
config entries
edit <address_integer>
set ip/subnet {<address_ipv4> |
<address_ipv4>/<address_ipv4mask>}
set status {enable | disable}
end
Keywords and variables Description Default
<iptrust_list_integer> A unique number to identify the IP trust list.
<iptrust_list> The name of the IP trust list.
<iptrust_list_comment> The comment attached to the IP trust list.
<address_integer> A unique number to identify the address.
ip/subnet {<address_ipv4> | The trusted IP address. A subnet mask in the format No default
<address_ipv4>/<address_ip 192.168.10.23/255.255.255.0 or 192.168.10.23/24 can
v4mask>} also be included.

status Enable or disable the IP address. enable

{enable | disable}

History

FortiOS v3.0 New.

FortiOS v3.0 MR4 All models have the same CLI syntax now.

Related topics
• spamfilter bword
• spamfilter emailbwl
• spamfilter fortishield
• spamfilter ipbwl
• spamfilter mheader
• spamfilter options
• spamfilter DNSBL

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 305
mheader spamfilter

mheader
Use this command to configure email filtering based on the MIME header. MIME header settings are
configured with this command but MIME header filtering is enabled within each protection profile.
The FortiGate spam filters are applied in the following order:

For SMTP
1 IP address BWL check - Last hop IP
2 DNSBL & ORDBL check, IP address FortiGuard check, HELO DNS lookup
3 E-mail address BWL check
4 MIME headers check
5 IP address BWL check (for IPs extracted from “Received” headers)
6 Return e-mail DNS check, FortiGuard Antispam check (for IPs extracted from “Received” headers, and
URLs in email content)
7 Banned word check

For POP3 and IMAP

1 E-mail address BWL check
2 MIME headers check, IP BWL check
3 Return e-mail DNS check, FortiGuard Antispam check, DNSBL & ORDBL check
4 Banned word check

For SMTP, POP3, and IMAP

The FortiGate unit compares the MIME header key-value pair of incoming email to the list pair in
sequence. If a match is found, the corresponding action is taken. If no match is found, the email is
passed on to the next spam filter.
MIME (Multipurpose Internet Mail Extensions) headers are added to email to describe content type
and content encoding, such as the type of text in the email body or the program that generated the
email. Some examples of MIME headers include:
• X-mailer: outgluck
• X-Distribution: bulk
• Content_Type: text/html
• Content_Type: image/jpg
The first part of the MIME header is called the header key, or just header. The second part is called the
value. Spammers often insert comments into header values or leave them blank. These malformed
headers can fool some spam and virus filters.
Use the MIME headers list to mark email from certain bulk mail programs or with certain types of
content that are common in spam messages. Mark the email as spam or clear for each header
configured.
Use Perl regular expressions or wildcards to add MIME header patterns to the list. See “Using Perl
regular expressions” on page 48.

Note: MIME header entries are case sensitive.

FortiGate CLI Version 3.0 MR6 Reference

306 01-30006-0015-20080205
spamfilter mheader

Syntax
config spamfilter mheader
edit <mime_list_integer>
set name <mime_list>
set comment <mime_list_comment>
config entries
edit <mime_integer>
set action {clear | spam}
set fieldbody <mime_str>
set fieldname <mime_str>
set pattern-type {regexp | wildcard}
set status {enable | disable}
end
end
Keywords and variables Description Default
<mime_list_integer> A unique number to identify the MIME header list.
<mime_list> The name of the MIME header list.
<mime_list_comment> The comment attached to the MIME header list.
<mime_integer> A unique number to identify the MIME header.
action {clear | spam} Enter clear to exempt the email from the rest of the spam spam
filters. Enter spam to apply the spam action configured in the
protection profile.
fieldbody <mime_str> Enter the MIME header (key, header field body) using wildcards No default.
or Perl regular expressions.
fieldname <mime_str> Enter the MIME header value (header field name) using No default.
wildcards or Perl regular expressions. Do not include a trailing
colon.
pattern-type Enter the pattern-type for the MIME header. Choose from wildcard
{regexp | wildcard} wildcards or Perl regular expressions.
status Enable or disable scanning email headers for the MIME header enable
{enable | disable} and header value defined in the fieldbody and fieldname
strings.

History

FortiOS v2.80 New.

FortiOS v3.0 Added multiple-list capability for models 800 and above.
FortiOS v3.0 All models have the same CLI syntax now.
MR4

Related topics
• spamfilter bword
• spamfilter fortishield
• spamfilter fortishield
• spamfilter ipbwl
• spamfilter iptrust
• spamfilter options
• spamfilter DNSBL

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 307
options spamfilter

options
Use this command to set the spamfilter dns query timeout.

Syntax
config spamfilter options
set dns-timeout <timeout_integer>
end
Keywords and variables Description Default
dns-timeout Set the DNS query timeout in the range 1 to 30 seconds. 7
<timeout_integer>

Example
This example shows how to set the dns timeout.
config spamfilter options
set dns-timeout 15
end

History

FortiOS v3.0 New.

Related topics
• spamfilter bword
• spamfilter emailbwl
• spamfilter fortishield
• spamfilter ipbwl
• spamfilter iptrust
• spamfilter mheader
• spamfilter DNSBL

FortiGate CLI Version 3.0 MR6 Reference

308 01-30006-0015-20080205
spamfilter DNSBL

DNSBL
Use this command to configure email filtering using DNS-based Blackhole List (DNSBL) or Open
Relay Database List (ORDBL) servers. DSNBL and ORDBL settings are configured with this
command but DSNBL and ORDBL filtering is enabled within each protection profile.
The FortiGate spam filters are generally applied in the following order:

For SMTP
1 IP address BWL check - Last hop IP
2 DNSBL & ORDBL check, IP address FortiGuard check, HELO DNS lookup
3 E-mail address BWL check
4 MIME headers check
5 IP address BWL check (for IPs extracted from “Received” headers)
6 Return e-mail DNS check, FortiGuard Antispam check (for IPs extracted from “Received” headers, and
URLs in email content)
7 Banned word check

For POP3 and IMAP

1 E-mail address BWL check
2 MIME headers check, IP BWL check
3 Return e-mail DNS check, FortiGuard Antispam check, DNSBL & ORDBL check
4 Banned word check

For SMTP, POP3, and IMAP

The FortiGate unit compares the IP address or domain name of the sender to any database lists
configured in sequence. If a match is found, the corresponding action is taken. If no match is found, the
email is passed on to the next spam filter.
Some spammers use unsecured third party SMTP servers to send unsolicited bulk email. Using
DNSBLs and ORDBLs is an effective way to tag or reject spam as it enters the network. These lists act
as domain name servers that match the domain of incoming email to a list of IP addresses known to
send spam or allow spam to pass through.
There are several free and subscription servers available that provide reliable access to continually
updated DNSBLs and ORDBLs. Please check with the service being used to confirm the correct
domain name for connecting to the server.

Note: Because the FortiGate unit uses the server domain name to connect to the DNSBL or ORDBL server, it
must be able to look up this name on the DNS server. For information on configuring DNS, see “system dns” on
page 339.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 309
DNSBL spamfilter

Syntax
config spamfilter DNSBL
edit <DNSBL_list_integer>
set name <DNSBL_list>
set comment <DNSBL_list_comment>
config entries
edit <server_integer>
set action {reject | spam}
set server <name_str>
set status {enable | disable}
end
Keywords and variables Description Default
<DNSBL_list_integer> A unique number to identify the DNSBL list.
<DNSBL_list> The name of the DNSBL header list.
<DNSBL_list_comment> The comment attached to the DNSBL header list.
<server_integer> A unique number to identify the DNSBL server.
action {reject | spam} Enter reject to stop any further processing of the current spam
session and to drop an incoming connection at once. Enter
spam to identify email as spam.
server <name_str> Enter the domain name of a Real-time Blackhole List server or No default.
an Open Relay Database server.
status {enable | disable} Enable or disable querying the Real-time Blackhole List server enable
or Open Relay Database server named in the server string.

History

FortiOS v2.80 New.

FortiOS v3.0 Added multiple-list capability for models 800 and above.
FortiOS v3.0 Multiple-list feature is available for all models.
MR2
FortiOS v3.0 Changed RBL to DNSBL.
MR5

Related topics
• spamfilter bword
• spamfilter emailbwl
• spamfilter fortishield
• spamfilter ipbwl
• spamfilter iptrust
• spamfilter mheader
• spamfilter options
• system dns

FortiGate CLI Version 3.0 MR6 Reference

310 01-30006-0015-20080205
system

system
Use system commands to configure options related to the overall operation of the FortiGate unit,
including:
• Administrative access
• Automatic updating of antivirus and attack definitions
• High availability (HA)
• Network interfaces
• Replacement messages
• VLANs and virtual domains
This chapter contains the following sections:

accprofile gi-gk (FortiOS Carrier) replacemsg nntp

admin global replacemsg spam
alertemail gre-tunnel replacemsg sslvpn
arp-table ha replacemsg-group
(FortiOS Carrier)
auto-install interface
replacemsg-image
autoupdate clientoverride ipv6-tunnel
(FortiOS Carrier)
autoupdate override mac-address-table
session-helper
autoupdate push-update management-tunnel
session-sync
autoupdate schedule modem
session-ttl
autoupdate tunneling npu
settings
aux proxy-arp
snmp community
bug-report replacemsg admin
snmp sysinfo
console replacemsg alertmail
switch-interface
dhcp reserved-address replacemsg auth
tos-based-priority
dhcp server replacemsg fortiguard-wf
vdom-link
dns replacemsg ftp
wireless mac-filter
fortianalyzer, fortianalyzer2, replacemsg http
wireless settings
fortianalyzer3
replacemsg im
zone
fortiguard replacemsg mail
fortiguard-log replacemsg mm1 (FortiOS Carrier)
fortimanager
replacemsg mm3 (FortiOS Carrier)
replacemsg mm4 (FortiOS Carrier)
replacemsg mm7 (FortiOS Carrier)

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 311
accprofile system

accprofile
Use this command to add access profiles that control administrator access to FortiGate features. Each
FortiGate administrator account must include an access profile. You can create access profiles that
deny access, allow read only, or allow both read and write access to FortiGate features.
You cannot delete or modify the super_admin access profile, but you can use the super_admin profile
with more than one administrator account.

Syntax
config system accprofile
edit <profile-name>
set <access-group> <access-level>
system config fwgrp-permission
set address read-write
end
end
end

Variable Description Default

edit <profile-name> Enter a new profile name to create a new profile. Enter an No default.
existing profile name to edit that profile.

FortiGate CLI Version 3.0 MR6 Reference

312 01-30006-0015-20080205
system accprofile

Variable Description Default

<access-group> Enter the feature group for which you are configuring access: No default.
admingrp administrator accounts and access profiles
authgrp user authentication, including local users,
RADIUS servers, LDAP servers, and user groups
avgrp antivirus configuration
fwgrp firewall configuration
includes customized permission options:
- address
- others (Virtual IP)
- policy
- profile
- schedule
- service
impp2p IM, P2P, and VoIP access configuration
ipsgrp intrusion prevention system configuration
loggrp log and report configuration including log settings,
viewing logs and alert email settings
execute batch commands
mntgrp maintenance commands: reset to factory defaults,
format log disk, reboot, restore and shutdown
netgrp interfaces, dhcp servers, zones
• get system status
• get system arp table
• config system arp-table
• execute dhcp lease-list
• execute dhcp lease-clear
routegrp router configuration
spamgrp spamfilter configuration
sysgrp system configuration except accprofile, admin
and autoupdate
updategrp FortiGuard antivirus and IPS updates, manual
and automatic
vpngrp VPN configuration
webgrp webfilter configuration
<access-level> Enter the level of administrator access to this feature: none
custom configures custom access for fwgrp access
selections only
none no access
read read-only access
read-write read and write access

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 313
accprofile system

Variable Description Default

config fwgrp-permission Configures customized firewall policy attribute permissions for
administrator.
address Enter the level of administrator permissions to the
address attribute of the firewall policy - none,
read, read-write.
others Enter the level of administrator permissions to the
others attribute of the firewall policy - none,
read, read-write. Refers to Virtual IP
attribute.
policy Enter the level of administrator permissions to the
policy attribute of the firewall policy - none,
read, read-write.
profile Enter the level of administrator permissions to the
profile attribute of the firewall policy - none,
read, read-write.
schedule Enter the level of administrator permissions to the
schedule attribute of the firewall policy - none,
read, read-write.
service Enter the level of administrator permissions to the
service attribute of the firewall policy - none,
read, read-write.

Examples
Use the following commands to add a new access profile named policy_profile that allows read
and write access to firewall policies and that denies access to all other FortiGate features. An
administrator account with this access profile can view and edit firewall policies, but cannot view or
change any other FortiGate settings or features.
config system accprofile
edit policy_profile
set fwgrp read-write
end
Use the following commands to add a new access profile named policy_profile_cu that allows
customized read and write access to firewall policies and that denies access to all other FortiGate
features. An administrator account with this access profile can view and edit the selected custom
firewall permissions (address, policy, and schedule), but cannot view or change any other
FortiGate settings or features.
config system accprofile
edit policy_profile_cu
set fwgrp custom
config fwgrp-permission
set address read-write
set policy read-write
set schedule read-write
end
end
end

FortiGate CLI Version 3.0 MR6 Reference

314 01-30006-0015-20080205
system accprofile

History

FortiOS v2.80 New

FortiOS v3.0 MR1 Removed secgrp feature group.
FortiOS v3.0 MR2 Modifications for super_admin profile and read-write access-level changes
(no write only).
FortiOS v3.0 MR4 Modifications for custom fwgrp firewall permissions, execute batch
command control assigned to mntgrp (Maintenance) access control group.
FortiOS v3.0 MR6 Added imp2pgrp access profile.

Related topics
• system admin

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 315
admin system

admin
Use this command to add, edit, and delete administrator accounts. Administrators can control what
data modules appear in the FortiGate unit system dashboard by using the config system admin
command. Administrators must have read and write privileges to make dashboard GUI modifications.
Use the default admin account or an account with system configuration read and write privileges to add
new administrator accounts and control their permission levels. Each administrator account except the
default admin must include an access profile. You cannot delete the default super admin account or
change the access profile (super_admin). In addition, there is also an access profile that allows read-
only super admin privileges, super_admin_readonly. The super_admin_readonly profile cannot be
deleted or changed, similar to the super_admin profile. This read-only super-admin may be used in a
situation where it is necessary to troubleshoot a customer configuration without making changes.
You can authenticate administrators using a password stored on the FortiGate unit or you can use a
RADIUS server to perform authentication. When you use RADIUS authentication, you can
authenticate specific administrators or you can allow any account on the RADIUS server to access the
FortiGate unit as an administrator.

Note: For users with super_admin access profile, you can reset the password in the CLI.
For a user ITAdmin with the access profile super_admin, to set the password to 123456:
config sys admin
edit ITAdmin
set password 123456
end
For a user ITAdmin with the access profile super_admin, to reset the password from 123456 to the
default ‘empty’ or ‘null’:
config sys admin
edit ITAdmin
unset password 123456
end
If you type ‘set password ?’ in the CLI, you will have to enter the new password and the old password in
order for the change to be effective. In this case, you will NOT be able to reset the password to ‘empty’ or
‘null’.

You can configure an administrator to only be allowed to log in at certain times. The default setting
allows administrators to log in any time.
For detailed information about configuring administrators, see the System Administration chapter of
the FortiGate Administration Guide for your model.

Note: You cannot change the management VDOM if any administrators are using RADIUS authentication.

Syntax
config system admin
edit <name_str>
set accprofile <profile-name>
set comments <comments_string>
set password <admin_password>
set peer-auth <peer_auth>
set peer-group <peer-grp>
set remote-auth {enable | disable}
set remote-group <name>
set schedule <schedule-name>
set ssh-public-key1 "<key-type> <key-value>"

FortiGate CLI Version 3.0 MR6 Reference

316 01-30006-0015-20080205
system admin

set ssh-public-key2 "<key-type> <key-value>"

set ssh-public-key3 "<key-type> <key-value>"
set trusthost1 <address_ipv4mask>
set trusthost2 <address_ipv4mask>
set trusthost3 <address_ipv4mask>
set vdom <vdom_name>
config dashboard
edit moduleid <module_name>
set column <column_number>
set status <module_status>
end
end
end
Keywords and variables Description Default
accprofile <profile-name> Enter the name of the access profile to assign to this No default.
administrator account. Access profiles control
administrator access to FortiGate features.
comments Enter the last name, first name, email address, phone null
<comments_string> number, mobile phone number, and pager number for
this administrator. Separate each attribute with a comma,
and enclose the string in double-quotes. The total length
of the string can be up to 128 characters. (Optional)
password <admin_password> Enter the password for this administrator. null
peer-auth <peer_auth> Set to enable peer certificate authentication (for HTTPS disable
admin access).
peer-group <peer-grp> Name of peer group defined under config user null
peergrp or user group defined under config user
group. Used for peer certificate authentication (for
HTTPS admin access).
remote-auth Enable or disable authentication of this administrator disable
{enable | disable} using a RADIUS server.
remote-group <name> Enter the administrator user group name, if you are using No default.
RADIUS authentication. The user group must contain
only the RADIUS server.
This is only available when remote-auth is enabled.
schedule <schedule-name> Restrict times that an administrator can log in. Defined in null
config firewall schedule. Null indicates that the
administrator can log in at any time.
ssh-public-key1 You can specify the public keys of up to three SSH No default.
"<key-type> <key-value>" clients. These clients are authenticated without being
asked for the administrator password. You must create
ssh-public-key2 the public-private key pair in the SSH client application. No default.
"<key-type> <key-value>" <key type> is ssh-dss for a DSA key or ssh-rsa for
an RSA key.
ssh-public-key3 No default.
<key-value> is the public key string of the SSH client.
"<key-type> <key-value>"
trusthost1 Any IP address or subnet address and netmask from 0.0.0.0 0.0.0.0
<address_ipv4mask> which the administrator can connect to the FortiGate unit.
If you want the administrator to be able to access the
FortiGate unit from any address, set the trusted hosts to
0.0.0.0 and the netmask to 0.0.0.0.
trusthost2 Any IP address or subnet address and netmask from 0.0.0.0 0.0.0.0
<address_ipv4mask> which the administrator can connect to the FortiGate unit.
If you want the administrator to be able to access the
FortiGate unit from any address, set the trusted hosts to
0.0.0.0 and the netmask to 0.0.0.0.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 317
admin system

Keywords and variables Description Default

trusthost3 Any IP address or subnet address and netmask from 127.0.0.1
<address_ipv4mask> which the administrator can connect to the FortiGate unit. 255.255.255.255
If you want the administrator to be able to access the
FortiGate unit from any address, set the trusted hosts to
0.0.0.0 and the netmask to 0.0.0.0.
wildcard Enable wildcard to allow all accounts on the RADIUS disable
{enable | disable} server to log on to the FortiGate unit as administrator.
Disable wildcard if you want to allow only the specified
administrator to log on.
This is available when radius-auth is enabled.
vdom <vdom_name> Enter the name of the VDOM this account belongs to. No default.
(Optional)
dashboard Use config dashboard to configure the dashboard
GUI of the FortiGate unit. Administrator must have read
and write privileges to make changes.
moduleid <module_name> Name of the dashboard module. Includes the following
selections:
• alert - System restart/firmware change alerts
• sessions - Top sessions
• sysinfo - System information
• licinfo - License information
• jsconsole - CLI console
• sysres - System resource information
• sysop - Unit operation information
• statistics - System operational statistics
• top-attacks -Top system attacks
• top-viruses - Top viruses by month
• tr-history - Interface traffic history
column <column_number> Column in which the dashboard module appears. Values
1 or 2. Available for all dashboard modules.
status <module_status> Status of module on dashboard. Values open or close.
Available for all dashboard modules.
dashboard module
selections
alert show-conserve-mode: display conserve mode on alert
message console
show-firmware-change: display firmware
upgrade/downgrade on alert message console
show-system-restart: display system restart on alert
message console
jsconsole column and status settings available. status default
open.
licinfo column and status settings available. status default
open.
sessions refresh-interval: time in between refresh of
session data. Values between 10 and 1200, 0 to disable.
set-sort-by: sort top sessions by either destination
address or source address.
top-sessions: number of top sessions to display.
Values between 5 and 20.
statistics column and status settings available. status default
open.
sysinfo column and status settings available. status default
open.
sysop column and status settings available. status default
open.

FortiGate CLI Version 3.0 MR6 Reference

318 01-30006-0015-20080205
system admin

Keywords and variables Description Default

sysres show-fds-chart: display the FortiGuard log disk
usage chart
show-fortianalyzer-chart: display the
FortiAnalyzer disk usage chart
top-attacks refresh-interval: time in between refresh of top
attacks data. Values between 10 and 1200, 0 to disable.
top-sessions: number of top attacks to display. Values
between 5 and 20.
top-viruses refresh-interval: time in between refresh of top
viruses data. Values between 10 and 1200, 0 to disable.
top-sessions: number of top viruses to display. Values
between 5 and 20.
tr-history interface: name of interface monitored for traffic
history data.
refresh: set to refresh traffic history data automatically.

Example
Use the following commands to add a new administrator account named new_admin with the
password set to p8ssw0rd and that includes an access profile named policy_profile. It is
accessible on the main_office VDOM. Administrators that log in to this account will have
administrator access to the FortiGate unit from any IP address. The dashboard setting alert >
show-system-restart is enabled and displays in column 2 of the FortiOS GUI.
config system admin
edit new_admin
set password p8ssw0rd
set accprofile policy_profile
set vdom main_office
config dashboard
edit alert
set column 2
set status open
show-system-restart enable
end
end
end

History

FortiOS v2.80 Revised.

FortiOS v3.0 Added email-address, first-name, last-name, mobile-number,
pager-number, phone-number, radius-auth, radius-group,
wildcard keywords.
FortiOS v3.0 MR1 Added is-admin and vdom keywords.
FortiOS v3.0 MR3 Removed is-admin. Combined first-name, last-name, email-
address, phone-number, mobile-number,pager-number and put in
keyword comments (concatenated).
FortiOS v3.0 MR4 Added dashboard configuration keywords/variables, password.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 319
admin system

FortiOS v3.0 MR5 Added description of password setup.

FortiOS v3.0 MR6 Added schedule. Included description of ReadOnlyAdmin.
Added config dashboard subcommand.
Renamed keyword radius-auth to remote-auth.
Renamed keyword radius-group to remote-group.

Related topics
• system accprofile

FortiGate CLI Version 3.0 MR6 Reference

320 01-30006-0015-20080205
system alertemail

alertemail
Use this command to configure the FortiGate unit to access an SMTP server to send alert emails. This
command is global in scope.
To configure alertemail settings you must first configure the server, and enable authenticate. Then you
will be able to see all the keywords.

Note: You must configure the server setting under config system alertemail before the
commands under config alertemail become accessible. For more information on config
alertemail, see “alertemail” on page 63.

Syntax
config system alertemail
set authenticate {disable | enable}
set password <password-str>
set server {<name-str> | <address-ipv4>}
set username <username-str>
end
Keywords and variables Description Default
authenticate Enable SMTP authentication if the FortiGate unit is disable
{disable | enable} required to authenticate before using the SMTP server.
This variable is accessible only if server is defined.
password <password-str> Enter the password that the FortiGate unit needs to No
access the SMTP server. default.
This variable is accessible only if authenticate is
enabled and server is defined.
server Enter the name of the SMTP server, in the format No
{<name-str> | <address-ipv4>} smtp.domain.com, to which the FortiGate unit should default.
send email. Alternately, the IP address of the SMTP
server can be entered. The SMTP server can be located
on any network connected to the FortiGate unit.
username <username-str> Enter the user name for the SMTP server that the No
FortiGate unit uses to send alert emails. default.
This variable is accessible only if authenticate is
enabled and server is defined.

Examples
This example shows how to configure the FortiGate unit to send alert emails using the SMTP server
smtp.ourcompany.com. The order of the keywords is important. The server must be defined first.
Then authentication needs to be next. The FortiGate unit uses the user name admin2 and the
password h8rdt0g3uss to connect to the SMTP server.
config system alertemail
set server smtp.ourcompany.com
set authenticate enable
set password h8rdt0g3uss
set username admin2
end

History

FortiOS v3.0 Command created from alertemail command.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 321
arp-table system

arp-table
Use this command to manually configure the ARP table entries on the FortiGate unit. You can only
access the arp-table values from the CLI.
This command is not available when VDOMs are enabled or in TP mode.

Syntax
config system arp-table
edit <table_value>
set interface <port>
set ip <address-ipv4>
set mac <mac_address>
next
end
Keywords and variables Description Default
interface <port> Enter the interface this ARP entry is associated with No
default
ip <address-ipv4> Enter the IP address of the ARP entry. No
default.
mac <mac_address> Enter the MAC address of the device entered in the table, No
in the form of xx:xx:xx:xx:xx:xx. default.

Examples
This example adds an entry to the arp-table with a MAC address of 00-09-0f-69-00-7c and an IP
address of 172.20.120.161 on the port2 interface.
config system arp-table
edit 3
set interface port2
set ip 172.20.120.161
set mac 00:09:0f:69:00:7c
next
end

History

FortiOS v3.0 MR2 New command.

Related topics
• get system arp

FortiGate CLI Version 3.0 MR6 Reference

322 01-30006-0015-20080205
system auto-install

auto-install
Use this command to configure automatic installation of firmware and system configuration from a
USB disk when the FortiGate unit restarts. This command is available only on units that have a USB
disk connection.
If you set both configuration and firmware image update, both occur on the same reboot. The
FortiGate unit will not reload a firmware or configuration file that is already loaded.
FortiUSB and generic USB disks are supported. However, the USB disk must be formatted as a FAT16
drive. No other partition type is supported.
To format your USB Disk when its connected to your FortiGate unit, at the CLI prompt type “exe usb-
disk format”.
To format your USB disk when it is connected to a Windows system, at the command prompt type
“format <drive_letter>: /FS:FAT /V:<drive_label>” where <drive_letter> is the
letter of the connected USB drive you want to format, and <drive_label> is the name you want to
give the USB disk volume for identification.

Note: This command is available only when a USB key is installed on the FortiGate unit. Formatting your
USB disk will delete all information on your USB disk.

Syntax
config system auto-install
set auto-install-config {disable | enable}
set auto-install-image {disable | enable}
set default-config-file
set default-image-file
end
Variables Description Default
auto-install-config Enable or disable automatic loading of the system disable
{disable | enable} configuration from a USB disk on the next reboot.
auto-install-image Enable or disable automatic installation of firmware from a disable
{disable | enable} USB disk on the next reboot.
default-config-file Enter the name of the configuration file on the USB disk. system.conf
default-image-file Enter the name of the image file on the USB disk. image.out

History

FortiOS v3.0 New.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 323
autoupdate clientoverride system

autoupdate clientoverride
Use this command to receive updates on a different interface than the interface connected to the
FortiGuard Distribution Network (FDN). This command changes the source IP address of update
requests to the FortiGuard server, causing it to send the update to the modified source address.
This is useful if your company uses an internal updates server instead of FDN.

Syntax
config system autoupdate clientoverride
set address <address_ipv4>
set status {enable | disable}
end
Variables Description Default
address <address_ipv4> Enter the IP address or fully qualified domain name to receive No
updates from. default.
status {enable | disable} Enable or disable the ability to override the FDN interface disable
address.

Example
This example shows how to add a push update client IP address 192.0.2.45 which is on the port4
interface.
config system autoupdate clientoverride
set address 192.0.2.45
set status enable
end

History

FortiOS v2.80 MR6 Added.

Related topics
• system autoupdate override
• system autoupdate push-update
• system autoupdate schedule
• system autoupdate tunneling
• execute update-av

FortiGate CLI Version 3.0 MR6 Reference

324 01-30006-0015-20080205
system autoupdate override

autoupdate override
Use this command to specify an override FDS server.
If you cannot connect to the FortiGuard Distribution Network (FDN) or if your organization provides
updates using their own FortiGuard server, you can specify an override FDS server so that the
FortiGate unit connects to this server instead of the FDN.

Note: If you are unable to connect to the FDS server, even after specifying an override server, it is
possible your ISP is blocking the lower TCP and UDP ports for security reasons. Contact your ISP to
make sure they unblock TCP and UDP ports 1025 to 1035 to enable FDS server traffic.

Syntax
config system autoupdate override
set address <FDS_address>
set status {enable | disable}
end
Variables Description Default
address <FDS_address> Enter the IP address or fully qualified domain name of the No
override FDS server. default.
status {enable | disable} Enable or disable overriding the default FDS server. disable

Example
This example shows how to add and enable your company’s own FDS override server with an IP
address of 192.168.87.45.
config system autoupdate override
set address 192.168.87.45
set status enable
end

History

FortiOS v2.80 Revised.

Related topics
• system autoupdate push-update
• system autoupdate schedule
• system autoupdate tunneling
• execute update-av
• execute update-ips

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 325
autoupdate push-update system

autoupdate push-update
Use this command to configure push updates. The FortiGuard Distribution Network (FDN) can push
updates to FortiGate units to provide the fastest possible response to critical situations such as
software exploits or viruses. You must register the FortiGate unit before it can receive push updates.
When you configure a FortiGate unit to allow push updates, the FortiGate unit sends a SETUP
message to the FDN. The next time an update is released, the FDN notifies all FortiGate units that are
configured for push updates that a new update is available. Within 60 seconds of receiving a push
notification, the FortiGate unit requests an update from the FDN.
Using this command you can enable or disable push updates. You can also configure push IP address
and port overrides. If the FDN must connect to the FortiGate unit through a NAT device, you must
configure port forwarding on the NAT device and add the port forwarding information to the push
update override configuration.

Note: You cannot receive push updates through a NAT device if the external IP address of the NAT device is
dynamic (for example, set using PPPoE or DHCP).

Syntax
config system autoupdate push-update
set address <push_ipv4>
set override {enable | disable}
set port <FDN_port>
set status {enable | disable}
end
Variables Description Default
address <push_ipv4> Enter the External IP address that the FDN connects to if you No
want to enable push override. This is the address of the external default.
interface of your NAT device.
override Enable an override of push updates. Select enable if the disable
{enable | disable} FortiGate unit connects to the FDN through a NAT device.
port <FDN_port> Enter the port that the FDN connects to. This can be port 9443 9443
by default or a different port that you assign.
status {enable | disable} Enable or disable FDN push updates. disable

Example
This example shows how to enable push updates on port 9993.
config system autoupdate push-update
set status enable
set port 9993
end

History

FortiOS v2.80 Revised.

FortiGate CLI Version 3.0 MR6 Reference

326 01-30006-0015-20080205
system autoupdate push-update

Related topics
• system autoupdate override
• system autoupdate schedule
• system autoupdate tunneling
• execute update-av
• execute update-ips

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 327
autoupdate schedule system

autoupdate schedule
Use this command to enable or disable scheduled FDN updates at regular intervals throughout the
day, once a day, or once a week.
To have your FortiGate unit to update at a random time during a particular hour, select a time that
includes 60 minutes as this will choose a random time during that hour for the scheduled update.

Syntax
config system autoupdate schedule
set day <day_of_week>
set frequency {every | daily | weekly}
set status {enable | disable}
set time <hh:mm>
end
Variables Description Default
day <day_of_week> Enter the day of the week on which to check for updates. Enter Monday
one of: Sunday, Monday, Tuesday, Wednesday, Thursday,
Friday, or Saturday.
This option is available only when frequency is set to
weekly.
frequency Schedule the FortiGate unit to check for updates every hour, every
{every | daily | weekly} once a day, or once a week. Set interval to one of the
following:
every
• Check for updates periodically. Set time to the time interval
to wait between updates.
daily
• Check for updates once a day. Set time to the time of day to
check for updates.
weekly
• Check for updates once a week. Set day to the day of the
week to check for updates. Set time to the time of day to
check for updates.
status {enable | disable} Enable or disable scheduled updates. disable
time <hh:mm> Enter the time at which to check for updates. 01:60
• hh can be 00 to 23
• mm can be 00-59, or 60 for random minute

Examples
This example shows how to configure the FortiGate unit to check the FortiGuard Distribution Network
(FDN) for updates once a day at 3:00 in the morning.
config system autoupdate schedule
set frequency daily
set time 03:00
set status enable
end

FortiGate CLI Version 3.0 MR6 Reference

328 01-30006-0015-20080205
system autoupdate schedule

This example is the same as the above example but it will check for updates once a day at sometime
between 3:00 and 4:00 in the morning.
config system autoupdate schedule
set frequency daily
set time 03:60
set status enable
end

History

FortiOS v2.80 Revised.

FortiOS v2.80 MR2 Can set time as well as day for weekly updates.

Related topics
• system autoupdate override
• system autoupdate push-update
• system autoupdate tunneling
• system global

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 329
autoupdate tunneling system

autoupdate tunneling
Use this command to configure the FortiGate unit to use a proxy server to connect to the FortiGuard
Distribution Network (FDN). To use the proxy server, you must enable tunneling and add the IP
address and port required to connect to the proxy server. If the proxy server requires authentication,
add the user name and password required to connect to the proxy server.
The FortiGate unit connects to the proxy server using the HTTP CONNECT method, as described in
RFC 2616. The FortiGate unit sends a HTTP CONNECT request to the proxy server (optionally with
authentication information) specifying the IP address and port required to connect to the FDN. The
proxy server establishes the connection to the FDN and passes information between the FortiGate unit
and the FDN.
The CONNECT method is used mostly for tunneling SSL traffic. Some proxy servers do not allow
CONNECT to connect to any port; proxy servers restrict the allowed ports to the well known ports for
HTTPS and perhaps some other similar services. Because FortiGate autoupdates use HTTPS on port
8890 to connect to the FDN, your proxy server might have to be configured to allow connections on
this port.

Syntax
config system autoupdate tunneling
set address <proxy_address>
set password <password>
set port <proxy_port>
set status {enable | disable}
set username <name>
end
Variables Description Default
address <proxy_address> The IP address or fully qualified domain name of the proxy No
server. default.
password <password> The password to connect to the proxy server if one is required. No
default.
port <proxy_port> The port required to connect to the proxy server. No
default.
status {enable | disable} Enable or disable tunneling. disable
username <name> The user name used to connect to the proxy server. No
default.

Example
This example shows how to enable tunneling where the FortiGate unit must connect to a proxy server
with IP address 67.35.50.34 that uses port 8080, requires the user id proxy_user and the password
proxy_pwd.
config system autoupdate tunneling
set address 67.35.50.34
set port 8080
set username proxy_user
set password proxy_pwd
set status enable
end

FortiGate CLI Version 3.0 MR6 Reference

330 01-30006-0015-20080205
system autoupdate tunneling

History

FortiOS v2.80 Revised.

Related topics
• system autoupdate override
• system autoupdate push-update
• system autoupdate schedule

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 331
aux system

aux
Use this command to configure the AUX port on 1000A, 1000AFA2, and 3000A models for remote
console connection. You would use a modem to remotely connect to a console session on the
FortiGate unit.
The main difference between the standard console port and the aux port is that the standard console
port is for local serial console connections only - it cannot accept a modem connection to establish a
remote console connection. The aux console port allows you to establish a local connection, but it has
some limitations the standard console port does not have.
• The AUX port will not display the booting messages that the standard console connection displays.
• The AUX port will send out modem initializing strings (AT strings) that will appear on an aux console
session at the start.

Syntax
config system aux
set baudrate <baudrate>
<baudrate> is the speed of the connection. It can be set to one of the following: 9600, 19200, 38400,
57600, or 115200. The default is 9600.
Ensure devices on both ends of the connection are set to the same baudrate.

History

FortiOS v3.0 MR1 New.

Related topics
• system console

FortiGate CLI Version 3.0 MR6 Reference

332 01-30006-0015-20080205
system bug-report

bug-report
Use this command to configure a custom email relay for sending problem reports to Fortinet customer
support.

Syntax
config system bug-report
set auth {no | yes}
set mailto <email_address>
set password <password>
set server <servername>
set username <name>
set username-smtp <account_name>
end
Variables Description Default
auth {no | yes} Enter yes if the SMTP server requires authentication or no if it no
does not.
mailto <email_address> The email address for bug reports. The default is See
[email protected]. description.
password <password> If the SMTP server requires authentication, enter the No default.
password required.
server <servername> The SMTP server to use for sending bug report email. The See
default server is fortinetvirussubmit.com description.
username <name> A valid user name on the specified SMTP server. The default See
user name is bug_report. description.
username-smtp A valid user name on the specified SMTP server. The default See
<account_name> user name is bug_report. description.

Example
This example shows how to configure the FortiGate unit to send bug report email from the
ourmailserver.com email server to [email protected] using the User1 account. The email
server requires authentication.
config system bug-report
set auth yes
set mailto [email protected]
set password 123456
set server ourmailserver.com
set username OurAdmin
end

History

FortiOS v2.80 New.

FortiOS v2.80 MR2 Command changed from config bug-report to config system bug-report.
FortiOS v3.0 Changed username_smtp to username-smtp.
FortiOS v3.0 MR1 Added mailto keyword.

Related topics
• system dns

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 333
console system

console
Use this command to set the console command mode, the number of lines displayed by the console,
and the baud rate.
Fortigate-1000A, 1000AFA2, and 3000A models have an AUX port that can be used for remote
console connections using a modem. This port on these models is configured with the system aux
command, see “aux” on page 332.

Note: If this FortiGate unit is connected to a FortiManager unit running scripts, output must be set to
standard for scripts to execute properly.

If this FortiGate unit is connected to a FortiManager unit running scripts, output must be set to
standard for scripts to execute properly.

Syntax
config system console
set baudrate <speed>
set mode {batch | line}
set output {standard | more}
end
Variables Description Default
baudrate <speed> Set the console port baudrate. Select one of 9600, 19200, 9600
38400, 57600, or 115200.
mode {batch | line} Set the console mode to line or batch. Used for autotesting only. line
output {standard | more} Set console output to standard (no pause) or more (pause after standard
each screen is full, resume on keypress).
This setting applies to show or get commands only.

Example
This example shows how to set the baudrate to 38400 and set the output style to more so it will pause
after each screen full of information.
config system console
set baudrate 38400
set output more
end

History

FortiOS v2.80 Revised.

FortiOS v2.80 MR2 Command changed from config console to config system console.
FortiOS v2.80 MR4 page keyword removed. output keyword added.

Related topics
• system aux

FortiGate CLI Version 3.0 MR6 Reference

334 01-30006-0015-20080205
system dhcp reserved-address

dhcp reserved-address
Use this command to reserve an IP address for a particular client identified by its device MAC address
and type of connection. The DHCP server then always assigns the reserved IP address to the client.
The number of reserved addresses that you can define ranges from 10 to 200 depending on the
FortiGate model.

Note: For this configuration to take effect, you must configure at least one DHCP server using the
config system dhcp server command, see “dhcp server” on page 336.

Syntax
config system dhcp reserved-address
edit <name_str>
set ip <address_ipv4>
set mac <address_hex>
set type {regular | ipsec}
end
Variables Description Default
ip <address_ipv4> Enter the IP address. 0.0.0.0
mac <address_hex> Enter the MAC address. 00:00:00:00:00:00
type {regular | ipsec} Enter the type of the connection to be reserved: regular
• regular
Client connecting through regular Ethernet
• IPSec
Client connecting through IPSec VPN

Example
Use the following command to add a reserved address named client_1 consisting of IP address
192.168.110.3 and MAC address 00:09:0F:0A:01:BC for a regular ethernet connection.
config system dhcp reserved-address
edit client_1
set ip 192.168.110.3
set mac 00:09:0F:0A:01:BC
set type regular
end

History

FortiOS v2.80 Substantially revised.

Related topics
• system dhcp server
• system interface

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 335
dhcp server system

dhcp server
Use this command to add one or more DHCP servers for any FortiGate interface. As a DHCP server,
the interface dynamically assigns IP addresses to hosts on a network connected to the interface. On
FortiGate models numbered 100 and below, you can configure up to 8 DHCP servers. On all other
models, you can configure up to 32 DHCP servers.
You can add more than one DHCP server to a single interface to be able to provide DHCP services to
multiple networks. For more information on configuring your network and FortiGate unit to use multiple
DHCP servers on one interface, see the System DHCP chapter in the Administration Guide for your
FortiGate unit.
This command is available in NAT/Route mode only.

Syntax
config system dhcp server
edit <dhcpservername>
set conflicted-ip-timeout <timeout_int>
set default-gateway <address_ipv4>
set dns-server1 <address_ipv4>
set dns-server2 <address_ipv4>
set dns-server3 <address_ipv4>
set domain <domain-name_str>
set enable {enable | disable}
set end-ip <address_ipv4>
set interface <interface-name>
set ipsec-lease-hold <release_seconds>
set lease-time <seconds>
set netmask <mask>
set option1 <option_code> [<option_hex>]
set option2 <option_code> [<option_hex>]
set option3 <option_code> [<option_hex>]
set server-type <type>
set start-ip <address_ipv4>
set wins-server1 <wins_ipv4>
set wins-server2 <wins_ipv4>
config exclude-range
edit <excl_range_num>
set end-ip <excl_ipv4>
set start-ip <excl_ipv4>
end
end
Variables Description Default
conflicted-ip-timeout Enter the time in seconds to wait before a conflicted IP 1800
<timeout_int> address is removed from the DHCP range. Valid range is
from 60 to 8640000 seconds (1 minute to 100 days).
default-gateway <address_ipv4> The IP address of the default gateway that the DHCP 0.0.0.0
server assigns to DHCP clients.
dns-server1 <address_ipv4> The IP address of the first DNS server that the DHCP 0.0.0.0
server assigns to DHCP clients.
dns-server2 <address_ipv4> The IP address of the second DNS server that the DHCP 0.0.0.0
server assigns to DHCP clients.

FortiGate CLI Version 3.0 MR6 Reference

336 01-30006-0015-20080205
system dhcp server

Variables Description Default

dns-server3 <address_ipv4> The IP address of the third DNS server that the DHCP 0.0.0.0
server assigns to DHCP clients.
domain <domain-name_str> Domain name suffix for the IP addresses that the DHCP No
server assigns to DHCP clients. default.
enable {enable | disable} Enable or disable this DHCP server. enable
end-ip <address_ipv4> The ending IP for the range of IP addresses that this 0.0.0.0
DHCP server assigns to DHCP clients. The IP range is
defined by the start-ip and the end-ip keywords
which should both be in the same subnet.
interface <interface-name> The interface of the DHCP server. internal
ipsec-lease-hold Set the DHCP lease release delay in seconds for DHCP- 60
<release_seconds> over-IPSec tunnels when the tunnel goes down.
A value of 0 disables the forced expiry of the DHCP-
over-IPSec leases.
Visible only when server-type is set to ipsec.
lease-time <seconds> The interval in seconds after which a DHCP client must 604,800
ask the DHCP server for new settings. The lease (7 days)
duration must be between 300 and 864,000 seconds (10
days).
Set lease-time to 0 for an unlimited lease time.
netmask <mask> The DHCP client netmask assigned by the DHCP server. 0.0.0.0
option1 <option_code> The first, second, and third custom DHCP options that No
[<option_hex>] can be sent by the DHCP server. option_code is the default.
option2 <option_code> DHCP option code in the range 1 to 255. option_hex is
an even number of hexadecimal characters. For detailed
[<option_hex>] information about DHCP options, see RFC 2132, DHCP
option3 <option_code> Options and BOOTP Vendor Extensions.
[<option_hex>]
server-type <type> Enter the type of client to serve: regular
• regular
Client connects through regular Ethernet
• IPSec
Client connects through IPSec VPN
start-ip <address_ipv4> The starting IP for the range of IP addresses that this 0.0.0.0
DHCP server assigns to DHCP clients. The IP range is
defined by the start-ip and the end-ip keywords
which should both be in the same subnet.
wins-server1 <wins_ipv4> The IP address of the first WINS server that the DHCP 0.0.0.0
server assigns to DHCP clients.
wins-server2 <wins_ipv4> The IP address of the second WINS server that the 0.0.0.0
DHCP server assigns to DHCP clients.
config exclude-range Configure a range of IP addresses to exclude from the
list of DHCP addresses that are available.
edit <excl_range_num> Enter an integer ID for this exclusion range. None
You can add up to 16 exclusion ranges of IP addresses
that the FortiGate DHCP server cannot assign to DHCP
clients
start-ip <excl_ipv4> The start IP address in the exclusion range. The start IP 0.0.0.0
and end IP must be in the same subnet.
This keyword applies to exclude-range.
end-ip <excl_ipv4> The end IP address in the exclusion range. The start IP 0.0.0.0
and end IP must be in the same subnet.
This keyword applies to exclude-range.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 337
dhcp server system

Example
Use the following command to add a DHCP server named new_dhcp. This DHCP server assigns IP
addresses to computers connected to the same network as the internal interface. The IP addresses
assigned are in the range 192.168.33.100 to 192.168.33.200. The example DHCP configuration also
sets the netmask, default gateway, two DNS server IP addresses, the lease time, and one WINS
server.
config system dhcp server
edit new_dhcp
set interface internal
set start-ip 192.168.33.100
set end-ip 192.168.33.200
set netmask 255.255.255.0
set default-gateway 192.168.33.1
set dns-server1 56.34.56.96
set dns-server2 56.34.56.99
set lease-time 4000
set wins-server1 192.168.33.45
end
The following command shows how to add an exclusion range from 192.168.20.22 to 192.168.20.25.
config system dhcp server
edit new_dhcp
config exclude-range
edit 1
set start-ip 192.168.20.22
set end-ip 192.168.20.25
end
end

History

FortiOS v2.80 Substantially revised.

FortiOS v2.80 MR2 Added domain keyword.
Removed discard-age keyword.
FortiOS v2.80 MR8 default-router changed to default-gateway
config exclude_range subcommand added (formerly
config dhcp exclude_range command)
FortiOS v3.0 Changed exclude_range to exclude-range.
FortiOS v3.0 MR1 Removed edit keyword.
FortiOS v3.0 MR3 Added edit keyword.
FortiOS v3.0 MR5 Added conflicted-ip-timeout keyword.
FortiOS v3.0 MR6 Added ipsec-lease-hold keyword.

Related topics
• system dhcp reserved-address
• system interface

FortiGate CLI Version 3.0 MR6 Reference

338 01-30006-0015-20080205
system dns

dns
Use this command to set the DNS server addresses. Several FortiGate functions, including sending
email alerts and URL blocking, use DNS.
On models numbered 100 and lower, you can use this command to configure DNS forwarding. The
autosvr and fwdintf keywords are only available on models numbered 100 and lower.

Syntax
config system dns
set autosvr {enable | disable}
set cache-notfound-responses {enable | disable}
set dns-cache-limit <integer>
set domain <domain_name>
set fwdintf <interface>
set primary <dns_ipv4>
set secondary <dns_ip4>
end
Keywords and variables Description Default
autosvr Enable or disable DNS forwarding. disable
{enable | disable} Available only on models numbered 100 and lower in
NAT/Route mode.
cache-notfound-responses Enable to cache NOTFOUND responses from the DNS disable
{enable | disable} server.
dns-cache-limit Set maximum number of entries in the DNS cache. 5000
<integer>
domain <domain_name> Set the local domain name (optional). No default.
fwdintf <interface> Enter the interface to which forwarding applies: No default.
• internal
• dmz
Available on models numbered 100 and lower in
NAT/Route mode.
primary <dns_ipv4> Enter the primary DNS server IP address. 65.39.139.53
secondary <dns_ip4> Enter the secondary DNS IP server address. 65.39.139.63

Example
This example shows how to set the primary FortiGate DNS server IP address to 45.37.121.76 and
the secondary FortiGate DNS server IP address to 45.37.121.77.
config system dns
set primary 45.37.121.76
set secondary 45.37.121.77
end

History

FortiOS v2.80 Revised.

FortiOS v2.80 MR2 Added autosvr and fwdintf keywords for models numbered 100 and lower.
FortiOS v2.80 MR8 Added cache-notfound-responses keyword.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 339
fortianalyzer, fortianalyzer2, fortianalyzer3 system

fortianalyzer, fortianalyzer2, fortianalyzer3

Use this command to configure the FortiGate unit to communicate with up to three FortiAnalyzer units.
Once communication with the FortiAnalyzer unit(s) has been configured, you then need to configure
logging to the FortiAnalyzer units using the log fortianalyzer filter and log
fortianalyzer setting command.
status must be set to enable for the other keywords to be visible.

Note: If the FortiGate unit is connected to a FortiAnalyzer device and a FortiManager device through a
NAT device, changing any fortianalyzer setting on the FortiGate unit will reset the connection with the
FortiManager device. To resolve this issue, create separate virtual IP address for the FortiAnalyzer and
FortiManager to ensure they do not have the same IP address.

Syntax
The command syntax is the same for fortianalyzer, fortianalyzer2 and fortianalyzer3.
config system fortianalyzer
set address-mode {auto-discovery | static}
set conn-timeout <seconds>
set encrypt {enable | disable}
set fdp-device <serial_number>
set localid <identifier>
set psksecret <pre-shared_key>
set server <fortianalyzer_ipv4>
set status {enable | disable}
set ver-1 {enable | disable}
end
Variables Description Default
address-mode {auto- Select auto-discovery to have the FortiAnalyzer device static
discovery | static} automatically detect the IP address of this FortiGate unit.
Select static if the FortiGate unit has a static IP address.
conn-timeout <seconds> Enter the number of seconds before the FortiAnalyzer 10
connection times out.
encrypt {enable | disable} Enable to use IPSec VPN tunnel for communication. disable
Disable to send data as plain text.
fdp-device <serial_number> Enter the serial number of the Fortianalyzer unit to connect No default
to. This keyword is only available when address-mode is set
to auto-discovery.
localid <identifier> Enter an identifier up to 64 characters long. You must use No default.
the same identifier on the FortiGate unit and the
FortiAnalyzer unit.
psksecret <pre-shared_key> Enter the pre-shared key for the IPSec VPN tunnel. No default.
This is needed only if encrypt is set to enable.
server Enter the IP address of the FortiAnalyzer unit. 0.0.0.0
<fortianalyzer_ipv4> This keyword is only available when address-mode is set to
static.
status {enable | disable} Enable or disable communication with the FortiAnalyzer disable
unit.
The other keywords are available only if status is set to
enable.
ver-1 {enable | disable} Enable for FortiAnalyzer 1.0 unit, otherwise disable. disable

FortiGate CLI Version 3.0 MR6 Reference

340 01-30006-0015-20080205
system fortianalyzer, fortianalyzer2, fortianalyzer3

Example
This example shows how to set the FortiGate unit to communicate with a FortiAnalyzer-400 unit that is
using a static IP address of 192.20.120.100:
config system fortianalyzer
set address-mode static
set encrypt enable
set localid fortianalyzer-400
set psksecret <128-character string>
set server 192.20.120.100
set status enable
set ver-1 disable
set conn-timeout 60
end

History

FortiOS v3.0 New

FortiOS v3.0 MR1 Added address-mode variable.
FortiOS v3.0 MR4 Added conn-timeout variable.

Related topics
• log fortianalyzer setting

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 341
fortiguard system

fortiguard
Use this command to configure communications with the FortiGuard Distribution Network (FDN) for
FortiGuard services such as:
• FortiGuard Antivirus and IPS
• FortiGuard Web Filtering and Antispam
• FortiGuard Analysis Service
• FortiGuard Management Service
Alternatively, for FortiGuard Antivirus and IPS or FortiGuard Web Filtering and Antispam, you can
configure the FortiGate unit to communicate with a FortiManager unit, which can act as a private FDS
for those services.
By default, FortiGate units connect to the FDN using a set of default connection settings. You can
override these settings to use IP addresses and port numbers other than the defaults. For example, if
you have a FortiManager unit, you might download a local copy of FortiGuard service updates to the
FortiManager unit, then redistribute those updates by configuring each server override feature on the
FortiGate unit to use the IP address on the FortiManager unit. For details, see the FortiManager
Administration Guide.

Note: If the FortiGate unit is unable to connect to the FDN, verify connectivity on required ports. For a list
of required ports, see the Knowledge Center article Traffic Types and TCP/UDP Ports Used by Fortinet
Products.

Syntax
config system fortiguard
set hostname <url_str>
set srv-ovrd {enable | disable}
set port {53 | 8888}
set client-override-status {enable | disable}
set client-override-ip <ovrd_ipv4>
set service-account-id <id_str>
set central-mgmt-status {enable | disable}
set antispam-status {enable | disable}
set antispam-cache {enable | disable}
set antispam-cache-ttl <ttl_int>
set antispam-cache-mpercent <ram_int>
set antispam-license
set antispam-expiration
set antispam-timeout <timeout_int>
set avquery-status {enable | disable}
set avquery-cache {enable | disable}
set avquery-cache-ttl <ttl_int>
set avquery-cache-mpercent <max_int>
set avquery-timeout <timeout_int>
set webfilter-status {enable | disable}
set webfilter-cache {enable | disable}
set webfilter-cache-ttl <ttl_int>
set webfilter-timeout <timeout_int>
end

FortiGate CLI Version 3.0 MR6 Reference

342 01-30006-0015-20080205
system fortiguard

Variables Description Default

hostname <url_str> Enter the host name of the primary FortiGuard server. service.
FortiGate unit defaults include the host name. Use this command fortiguard
only when required to change the host name. Alternatively .net
configure srv-ovrd.
This keyword is available only if srv-ovrd is disable.
srv-ovrd Enable to override the primary FortiGuard server set in disable
{enable | disable} hostname. Specify override server(s) using config
srv-ovrd-list. Alternatively, configure hostname.
hostname is not used and unavailable for configuration when
this keyword is enable.
port {53 | 8888} Enter the port to use for rating queries to the FortiGuard Web 53
Filtering or FortiGuard Antispam service.
client-override- Enable or disable the client override IP address. disable
status This feature forces your FortiGate unit to connect to the
{enable | disable} FortiGuard servers using a specific IP address even if it has
more than one IP address available.
client-override-ip Enter the IP address on this FortiGate unit that will be used to No default.
<ovrd_ipv4> connect to the FortiGuard servers.
This keyword is available only if client-override-status is
enable.
service-account-id Enter the Service Account ID to use with communications with No default
<id_str> FortiGuard Analysis or FortiGuard Management service.
central-mgmt-status Enable remote management of the FortiGate unit by a disable
{enable | disable} FortiManager unit or FortiGuard Management Service.
For details on configuring management by a FortiManager unit,
see “fortimanager” on page 347.
antispam-status Enable or disable use of FortiGuard Antispam. disable
{enable | disable}
antispam-cache Enable or disable caching of FortiGuard Antispam query results, disble
{enable | disable} including IP address and URL block list.
Enabling the cache can improve performance because the
FortiGate unit does not need to access the FDN or FortiManager
unit each time the same IP address or URL appears as the
source of an email. When the cache is full, the least recently
used cache entry is replaced.
antispam-cache-ttl Enter a time to live (TTL), in seconds, for antispam cache 1800
<ttl_int> entries. When the TTL expires, the cache entry is removed,
requiring the FortiGate unit to query the FDN or FortiManager
unit the next time that item occurs in scanned traffic. Valid TTL
ranges from 300 to 86400 seconds.
antispam-cache- Enter the maximum percentage of memory (RAM) to use for 2
mpercent <ram_int> antispam caching. Valid percentage ranges from 1 to 15.
antispam-license The interval of time between license checks for the FortiGuard 7
Antispam service contract.
This variable can be viewed with the get command, but cannot
be set.
antispam-expiration The expiration date of the FortiGuard Antispam service contract. No default
This variable can be viewed with the get command, but cannot
be set.
antispam-timeout Enter the FortiGuard Antispam query timeout. Valid timeout 7
<timeout_int> ranges from 1 to 30 seconds.
avquery-status Enable or disable use of FortiGuard Antivirus. disable
{enable | disable}

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 343
fortiguard system

Variables Description Default

avquery-cache Enable or disable caching of FortiGuard Antivirus query results. enable
{enable | disable} Enabling the cache can improve performance because the
FortiGate unit does not need to access the FDN each time the
same IP address or URL appears as the source of an email.
When the cache is full, the least recently used cache entry is
replaced.
avquery-cache-ttl Enter a time to live (TTL), in seconds, for antivirus cache entries. 1800
<ttl_int> When the TTL expires, the cache entry is removed, requiring the
FortiGate unit to query the FDN or FortiManager unit the next
time that item occurs in scanned traffic. Valid TTL ranges from
300 to 86400 seconds.
avquery-cache-mpercent Enter the maximum memory to be used for FortiGuard Antivirus 2
<max_int> query caching. Valid percentage ranges from 1 to 15.
avquery-license The interval of time between license checks for the FortiGuard No default
Antivirus service contract.
This variable can be viewed with the get command, but cannot
be set.
avquery-expiration The expiration date of the FortiGuard Antivirus service contract. No default
This variable can be viewed with the get command, but cannot
be set.
avquery-timeout Enter the time limit in seconds for the FortiGuard Antivirus 7
<timeout_int> service query timeout. Valid timeout ranges from 1 to 30.

webfilter-status Enable or disable use of FortiGuard Web Filtering service. disable

{enable | disable}
webfilter-cache Enable or disable caching of FortiGuard Web Filtering query disable
{enable | disable} results, including category ratings for URLs.
Enabling the cache can improve performance because the
FortiGate unit does not need to access the FDN or FortiManager
unit each time the same IP address or URL is requested. When
the cache is full, the least recently used cache entry is replaced.
webfilter-cache-ttl Enter a time to live (TTL), in seconds, for web filtering cache 3600
<ttl_int> entries. When the TTL expires, the cache entry is removed,
requiring the FortiGate unit to query the FDN or FortiManager
unit the next time that item occurs in scanned traffic. Valid TTL
ranges from 300 to 86400 seconds.
webfilter-license The interval of time between license checks for the FortiGuard No default
Web Filtering service contract.
This variable can be viewed with the get command, but cannot
be set.
webfilter-expiration The expiration date of the FortiGuard Web Filtering service No default
contract.
This variable can be viewed with the get command, but cannot
be set.
webfilter-timeout Enter the FortiGuard Web Filtering query timeout. Valid timeout 15
<timeout_int> ranges from 1 to 30 seconds.

Example
This example shows how to configure the FortiGate unit to receive FortiGuard services.
config system fortiguard
set antispam-status enable
set antispam-cache enable
set antispam-cache-mpercent enable
set webfilter-cahce enable
set webfilter-status enable
set avquery-status enable

FortiGate CLI Version 3.0 MR6 Reference

344 01-30006-0015-20080205
system fortiguard

set avquery-cache enable

end

History

FortiOS v3.0 New.

FortiOS v3.0 MR2 Added get system fortiguard-service status command reference.
FortiOS v3.0 MR5 Added service-account-id, central-mgmt-status, central-mgmt-
scheduled-upgrade, central-mgmt-auto-backup, and central-mgmt-
scheduled-config-restore for Central Management feature.
FortiOS Carrier v3.0 MR3 New variables antispam-expiration, antispam-license, avquery-
expiration, avquery-license, webfilter-expiration, webfilter-
license, client-override-ip.
FortiOS Carrier v3.0 MR6 Removed the following keywords:
• antispam-license
• antispam-expiration
• config srv-ovrd-list
edit <srv_ovrd_num>
ip <ovrd_ipv4>

Related topics
• system dashboard
• fortiguard setting

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 345
fortiguard-log system

fortiguard-log
Use this command to override default ports and IP addresses used to connect to FortiGuard Analysis
Service.

Syntax
config system fortiguard-log
set controller-ip <address_ipv4>
set controller-port <port_int>
set override-controller {enable | disable}
end
Variables Description Default
controller-ip Enter the IP address of the controller. 0.0.0.0
<address_ipv4> This option appears only if override-controller is
enable.
controller-port <port_int> Enter the port number of the controller. Valid ports range 0
from 0 to 65535.
This option appears only if override-controller is
enable.
override-controller Select to override the default controller IP address and/or disable
{enable | disable} port.

Example
This example shows how to override the default FortiGuard Analysis Service controller settings with IP
address 172.16.142.99 and port 1234.
config system fortiguard-log
set override-controller enable
set controller-ip 172.16.142.99
set controller-port 1234
end

History

FortiOS v3.0 MR4 New.

Related topics
• system fortiguard
• fortiguard setting

FortiGate CLI Version 3.0 MR6 Reference

346 01-30006-0015-20080205
system fortimanager

fortimanager
Use this command to configure remote management by a FortiManager unit.
You can configure the remote management tunnel and which remote management actions the
FortiGate unit will allow from the FortiManager unit or FortiGuard Management Service. For details,
see “system management-tunnel” on page 391.

Syntax
config system fortimanager
set central-management {enable | disable}
set central-mgmt-auto-backup {enable | disable}
set central-mgmt-schedule-config-restore {enable | disable}
set ip <address_ipv4>
set ipsec {enable | disable}
set vdom <vdom_str>
end
Variables Description Default
central-management Select to allow central management by the FortiManager disable
{enable | disable} unit.
This option is available only if, in config system
management-tunnel, status is enable, and in
config system fortiguard, central-mgmt-
status is disable.
central-mgmt-auto-backup Select to automatically back up FortiGate unit disable
{enable | disable} configuration changes on administrator logout or session
timeout.
This option appears only if central-management is
enable.
central-mgmt-schedule- Select to allow the FortiManager unit to send a disable
config-restore configuration file to the FortiGate unit. This feature can be
{enable | disable} used to restore the configuration on the FortiGate unit.
This option appears only if central-management is
enable.
ip <address_ipv4> Enter the IP address of the FortiManager unit that is 0.0.0.0
allowed to manage this FortiGate unit.
ipsec {enable | disable} Select to apply an IPSec VPN to connections between the disable
FortiManager unit and this FortiGate unit. Alternatively,
configure the management tunnel. For details, see “system
management-tunnel” on page 391.
vdom <vdom_str> Enter the FortiGate unit virtual domain (VDOM) that will root
communicate with the FortiManager unit. (Optional.)

Example
This example shows how to configure secure remote management of the FortiGate unit by a
FortiManager unit whose serial number is FMG-3K2404400063 and IP address is 172.168.2.10,
enabling the FortiManager unit to restore the configuration on the FortiGate unit and change firmware
but disabling automatic configuration backups to the FortiManager unit.
config system fortimanager
set ip 172.168.2.10
set central-mgmt-scheduled-cfg-restore enable
set central-mgmt-auto-backup disable
end

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 347
fortimanager system

config system management-tunnel

set status enable
set authorized-manager-only enable
set serial-number FMG-3K2404400063
set allow-config-restore enable
set allow-push-configuration enable
set allow-push-firmware enable
end

History

FortiOS v3.0 MR6 New command. Replaces config system fm and defines settings specific to remote
management by a FortiManager unit.

Related topics
• system fortiguard
• system management-tunnel

FortiGate CLI Version 3.0 MR6 Reference

348 01-30006-0015-20080205
system gi-gk (FortiOS Carrier)

gi-gk (FortiOS Carrier)

This command configures the settings for the Gi gateway firewall. This firewall is used in the anti-
overbilling configuration, and can be enabled on a per interface basis. For more information see
“system interface” on page 373.

Syntax
config system gi-gk
set context <id_integer>
set port <tcp_port>
end
Variables Description Default
context <id_integer> Enter the context ID for the Gi gateway firewall
port <tcp_port> Enter the TCP port to listen to. Valid range is from 0 to 0
65535.

History

FortiOS v3.0 MR5 New.

Related topics
• system interface

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 349
global system

global
Use this command to configure global settings that affect various FortiGate systems and
configurations.
Runtime-only config mode was introduced in FortiOS v3.0 MR2. This mode allows you to try out
commands that may put your FortiGate unit into an unrecoverable state normally requiring a physical
reboot. In runtime-only config mode you can set a timeout so after a period of no input activity the
FortiGate unit will reboot with the last saved configuration. Another option in runtime-only configuration
mode is to manually save your configuration periodically to preserve your changes. For more
information see set cfg-save {automatic | manual | revert}, set cfg-revert-
timeout <seconds>, and execute cfg reload.
Switch mode is available on FortiWiFi 60B, FortiGate 60B, 100A (Rev2.0 and higher), and 200A
(Rev2.0 and higher) models where the internal interface is a four or six port switch. Normally the
internal interface is configured as one interface shared by all four ports. Switch mode allows you to
configure each interface on the switch separately with their own interfaces. Consult your release notes
for the most current list of supported models for this feature. The keywords internal-switch-mode
{interface | switch} and internal-switch-speed {100full | 100half | 10full | 10half | auto} apply only to
switch mode enabled FortiGate models.

Syntax
config system global
set access-banner {enable | disable}
set admin-https-pki-required {enable | disable}
set admin-maintainer {enable | disable}
set admin-port <port_number>
set admin-scp {enable | disable}
set admin-server-cert { self-sign | <certificate>}
set admin-sport <port_number>
set admin-ssh-port <port_number>
set admin-ssh-v1 {enable | disable}
set admin-telnet-port <port_number>
set admintimeout <admin_timeout_minutes>
set allow-interface-subnet-overlap {enable | disable}
set auth-cert <cert-name>
set auth-http-port <http_port>
set auth-https-port <https_port>
set auth-keepalive {enable | disable}
set av-failopen {off | one-shot | pass}
set av-failopen-session {enable | disable}
set batch_cmdb {enable | disable}
set CC-mode {enable | disable}
set cfg-save {automatic | manual | revert}
set cfg-revert-timeout <seconds>
set check-reset-range {enable | disable}
set clt-cert-req {enable | disable}
set conn-tracking {enable | disable}
set daily-restart {enable | disable}
set detection-summary {enable | disable}
set dst {enable | disable}
set failtime <failures_count>
set fds-statistics {enable | disable}
set fds-statistics-period <minutes>
set forticlient-portal-port <port>

FortiGate CLI Version 3.0 MR6 Reference

350 01-30006-0015-20080205
system global

set fsae-burst-size <packets>

set fsae-rate-limit (pkt_sec)
set gui-lines-per-page <gui_lines>
set hostname <unithostname>
set http-obfuscate {header-only | modified | no-error | none}
set ie6workaround {enable | disable}
set internal-switch-mode {interface | switch}
set internal-switch-speed {100full | 100half | 10full | 10half | auto}
set interval <deadgw_detect_seconds>
set ip-src-port-range <start_port>-<end_port>
set language <language>
set lcdpin <pin_number>
set lcdprotection {enable | disable}
set ldapconntimeout <ldaptimeout_msec>
set loglocaldeny {enable | disable}
set management-vdom <domain>
set ntpserver <ntp_server_address>
set ntpsync {enable | disable}
set optimize {antivirus | throughput}
set phase1-rekey {enable | disable}
set radius-port <radius_port>
set refresh <refresh_seconds>
set remoteauthtimeout <remoteauth_timeout_mins>
set reset-sessionless-tcp {enable | disable}
set restart-time <hh:mm>
set show-backplane-intf {enable | disable}
set sslvpn-sport <port_number>
set strong-crypto {enable | disable}
set syncinterval <ntpsync_minutes>
set tcp-halfclose-timer <seconds>
set tcp-halfopen-timer <seconds>
set tcp-option {enable | enable}
set timezone <timezone_number>
set tos-based-priority {low | medium | high}
set tp-mc-skip-policy {enable | disable}
set udp-idle-timer <seconds>
set user-server-cert <cert_name>
set vdom-admin {enable | disable}
set vip-arp-range {unlimited | restricted}
end
Keywords and variables Description Default
access-banner Enable to display the admin access disclaimer message. disable
{enable | disable} For more information see “system replacemsg admin” on
page 398.
admin-https-pki-required Enable to allow user to login by providing a valid certificate disable
{enable | disable} if PKI is enabled for HTTPS administrative access. Default
setting disable allows admin users to log in by providing
a valid certificate or password.
admin-maintainer Enabled by default. Disable for CC. enable
{enable | disable}
admin-port <port_number> Enter the port to use for HTTP administrative access. 80
admin-scp Enable to allow system configuration download by the disable
{enable | disable} secure copy (SCP) protocol.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 351
global system

Keywords and variables Description Default

admin-server-cert { Select the admin https server certificate to use. Choices See definition
self-sign | include self-sign, and the filename of any installed under
<certificate>} certificates. Default setting is Fortinet_Factory, if Description.
available, otherwise self-sign.
admin-sport <port_number> Enter the port to use for HTTPS administrative access. 443
admin-ssh-port Enter the port to use for SSH administrative access. 22
<port_number>
admin-ssh-v1 Enable compatibility with SSH v1.0. disable
{enable | disable}
admin-telnet-port Enter the port to use for telnet administrative access. 21
<port_number>
admintimeout Set the number of minutes before an idle administrator 5
<admin_timeout_minutes> times out. This controls the amount of inactive time before
the administrator must log in again. The maximum
admintimeout interval is 480 minutes (8 hours).
To improve security keep the idle timeout at the default
value of 5 minutes.
allow-interface-subnet- Enable or disable limited support for interface and VLAN disable
overlap subinterface IP address overlap. Use this command to
{enable | disable} enable limited support for overlapping IP addresses in an
existing network configuration.
Caution: for advanced users only. Use this only for existing
network configurations that cannot be changed to eliminate
IP address overlapping.
auth-cert <cert-name> Https server certificate for policy authentication. self-sign
Self-sign is the built in certificate but others will be listed as
you add them.
auth-http-port Set the HTTP authentication port. <http_port> can be 1000
<http_port> from 1 to 65535.
auth-https-port Set the HTTPS authentication port. <https_port> can be 1003
<https_port> from 1 to 65535.
auth-keepalive Enable to extend the authentication time of the session disable
{enable | disable} through periodic traffic to prevent an idle timeout.
av-failopen Set the action to take if there is an overload of the antivirus pass
{off | one-shot | pass} system. Valid options are off, one-shot, and pass.
• Enter off to continue to handle and deliver connections
regardless of free memory.
• Enter one-shot to bypass the antivirus system when
memory is low. You must enter off or pass to restart
antivirus scanning.
• Enter pass to bypass the antivirus system when memory
is low. Antivirus scanning resumes when the low memory
condition is resolved.
This applies to FortiGate models numbered 300A and
higher.
av-failopen-session When enabled and a proxy for a protocol runs out of room disable
{enable | disable} in its session table, that protocol goes into failopen mode
and enacts the action specified by av-failopen.
This applies to models numbered 300A and higher.
batch_cmdb Enable/disable batch mode run in cmdbsvr. enable
{enable | disable}
CC-mode Enable Federal Information Processing Standards/ disable
{enable | disable} Common Criteria (FIPS/CC) mode. This is an enhanced
security mode that is valid only on FIPS/CC-certified
versions of the FortiGate firmware.

FortiGate CLI Version 3.0 MR6 Reference

352 01-30006-0015-20080205
system global

Keywords and variables Description Default

cfg-save {automatic | Set the method for saving the FortiGate system automatic
manual | revert} configuration and enter into runtime-only configuration
mode. Methods for saving the configuration are:
• automatic - automatically save the configuration after
every change
• manually - manually save the configuration using the
execute cfg save command
• revert - manually save the current configuration and then
revert to that saved configuration after cfg-revert-
timeout expires
Switching to automatic mode disconnects your session.
This command is used as part of the runtime-only
configuration mode.
See “execute cfg reload” on page 566 for more information.
cfg-revert-timeout Enter the timeout interval in seconds. If the administrator 600
<seconds> makes a change and there is no activity for the timeout
period, the FortiGate unit will automatically revert to the last
saved configuration. Default timeout is 600 seconds.
This command is available only when cfg-save is set to
revert.
This command is part of the runtime-only configuration
mode. See “execute cfg reload” on page 566 for more
information.
check-reset-range Set whether RST out-of-window checking is performed. If disable
{enable | disable} set to strict (enable), RST must fall between the last ACK
and the next send. If set to disable, no check is performed.
clt-cert-req Enable to require a client certificate before an administrator disable
{enable | disable} logs on to the web-based manager using HTTPS.
conn-tracking Enable to have the firewall drop SYN packets after the enable
{enable | disable} connection has been established with the remote system.
This will help prevent a SYN flood and free up system
resources.
daily-restart Enable to restart the FortiGate unit every day. disable
{enable | disable} The time of the restart is controlled by restart-time.
detection-summary Disable to prohibit the collection of detection summary enable
{enable | disable} statistics for FortiGuard.
dst {enable | disable} Enable or disable daylight saving time. disable
If you enable daylight saving time, the FortiGate unit
adjusts the system time when the time zone changes to
daylight saving time and back to standard time.
failtime <failures_count> Set the dead gateway detection failover interval. Enter the 5
number of times that ping fails before the FortiGate unit
assumes that the gateway is no longer functioning. 0
disables dead gateway detection.
fds-statistics Enable or disable AV/IPS signature reporting. enable
{enable | disable} If necessary, disable to avoid error messages on HA slave
units during an AV/IPS update.
fds-statistics-period Select the number of minutes in the FDS report period. 60
<minutes> Range is 1 to 1440 minutes.
forticlient-portal-port Enter the HTTP port used to download a copy of 8009
<port> FortiClient. Valid numbers are from 0 to 65535.
On the FortiGate models 1000A, 3600A, and 5005FA2,
firewall policies can deny access for hosts that do not have
FortiClient Host Security software installed and operating.
For more information see the Firewall chapter and System
Maintenance chapter of the FortiGate Administration
Guide.
fsae-burst-size <packets> Set the FSAE burst size in packets. 300

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 353
global system

Keywords and variables Description Default

fsae-rate-limit (pkt_sec) Set the FSAE message rate limit in packets per second. 100
gui-lines-per-page Set the number of lines displayed on table lists. Range is 50
<gui_lines> from 20 - 1000 lines per page.
hostname <unithostname> Enter a name for this FortiGate unit. A hostname can not FortiGate
include spaces or punctuation other than hyphens and serial number.
underlines.
By default the hostname of your FortiGate unit is its serial
number which includes the model.
http-obfuscate Set the level at which the identity of the FortiGate web none
{header-only | modified | server is hidden or obfuscated.
no-error | none} • none does not hide the FortiGate web server identity
• header-only hides the HTTP server banner
• modified provides modified error responses
• no-error suppresses error responses
ie6workaround Enable or disable the work around for a navigation bar disable
{enable | disable} freeze issue caused by using the FortiGate web-based
manager with Internet Explorer 6.
internal-switch-mode Set the mode for the internal switch to be one of interface, switch
{interface | switch} or switch.
The internal interface refers to a switch that has 4 network
connections. The switch option is regular operation with
one internal interface that all 4 network connections
access. The interface option splits the internal interface into
4 separate interfaces, one for each network connection.
The default value is switch.
This applies only to FortiWiFi 60B, FortiGate 60B, 100A
(Rev2.0 and higher), and 200A (Rev2.0 and higher)
models.
internal-switch-speed Set the speed of the switch used for the internal interface. auto
{100full | 100half | Choose one of:
10full | 10half | auto} • 100full
• 100half
• 10full
• 10half
• auto
100 and 10 refer to 100M or 10M bandwidth. Full and half
refer to full or half duplex.
Default value is auto.
This applies only to FortiWiFi 60B, FortiGate 60B, 100A
(Rev2.0 and higher), and 200A (Rev2.0 and higher)
models.
interval Select the number of seconds between pings the FortiGate 5
<deadgw_detect_seconds> unit sends to the target for dead gateway detection.
Selecting 0 disables dead gateway detection.
ip-src-port-range Specify the IP source port range used for traffic originating 1024-4999
<start_port>-<end_port> from the FortiGate unit. The valid range for
<start_port> and <end_port> is from 1 to 65535
inclusive.
You can use this setting to avoid problems with networks
that block some ports, such as FDN ports.
language <language> Set the web-based manager display language. You can set english
<language> to one of english, french, japanese,
korean, simch (Simplified Chinese) or trach (Traditional
Chinese).
lcdpin <pin_number> Set the 6 digit PIN administrators must enter to use the 123456
LCD panel.
This applies to FortiGate models numbered 300 to 3600.

FortiGate CLI Version 3.0 MR6 Reference

354 01-30006-0015-20080205
system global

Keywords and variables Description Default

lcdprotection Enable or disable LCD panel PIN protection. disable
{enable | disable} This applies to FortiGate models numbered 300 to 3600.
ldapconntimeout LDAP connection timeout in msec 500
<ldaptimeout_msec>
loglocaldeny Enable or disable logging of failed connection attempts to disable
{enable | disable} the FortiGate unit that use TCP/IP ports other than the
TCP/IP ports configured for management access (443 for
https, 22 for ssh, 23 for telnet, and 80 for HTTP by default).
management-vdom <domain> Enter the name of the management virtual domain. root
Management traffic such as FortiGuard traffic originates
from the management VDOM.
ntpserver Enter the domain name or IP address of a Network Time 132.246.168.1
<ntp_server_address> Protocol (NTP) server. 48
ntpsync Enable or disable automatically updating the system date disable
{enable | disable} and time by connecting to a Network Time Protocol (NTP)
server. For more information about NTP and to find the IP
address of an NTP server that you can use, see
http://www.ntp.org.
optimize Set firmware performance optimization to either No default
{antivirus | throughput} antivirus or throughput.
This is available on FortiGate models numbered 1000 and
higher.
phase1-rekey Enable or disable automatic rekeying between IKE peers enable
{enable | disable} before the phase 1 keylife expires.
radius-port <radius_port> Change the default RADIUS port. The default port for 1812
RADIUS traffic is 1812. If your RADIUS server is using port
1645 you can use the CLI to change the default RADIUS
port on your FortiGate unit.
refresh <refresh_seconds> Set the Automatic Refresh Interval, in seconds, for the 0
web-based manager System Status Monitor.
Enter 0 for no automatic refresh.
remoteauthtimeout Timeout for RADIUS/LDAP authentication in minutes. 5
<remoteauth_timeout_mins> To improve security keep the remote authentication timeout
at the default value of 5 minutes.

reset-sessionless-tcp Enabling this option may help resolve issues with a disable
{enable | disable} problematic server, but it can make the FortiGate unit more
vulnerable to denial of service attacks. In most cases you
should leave reset-sessionless-tcp disabled.
The reset-sessionless-tcp command determines
what action the FortiGate unit performs if it receives a TCP
packet but cannot find a corresponding session in its
session table. This happens most often because the
session has timed out.
If you disable reset-sessionless-tcp, the FortiGate
unit silently drops the packet. The packet originator does
not know that the session has expired and might re-
transmit the packet several times before attempting to start
a new session. This is normal network operation.
If you enable reset-sessionless-tcp, the FortiGate
unit sends a RESET packet to the packet originator. The
packet originator ends the current session, but it can try to
establish a new session.
This is available in NAT/Route mode only.
restart-time <hh:mm> Enter daily restart time in hh:mm format (hours and No default.
minutes).
This is available only when daily-restart is enabled.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 355
global system

Keywords and variables Description Default

show-backplane-intf Select enable to show FortiGate-5000 backplane interfaces disable
{enable | disable} as port9 and port10. Once these backplanes are visible
they can be treated as regular physical interfaces.
This is only available on FortiGate-5000 models.
sslvpn-sport Enter the port to use for SSL-VPN access (HTTPS). 443
<port_number>
strong-crypto Enable to use strong encryption and only allow strong disable
{enable | disable} ciphers (AES, 3DES) and digest (SHA1) for HTTPS/SSH
admin access.
When strong encryption is enabled, HTTPS is supported by
the following web browsers: Netscape 7.2, Netscape 8.0,
Firefox, and Microsoft Internet Explorer 7.0 (beta).
Note that Microsoft Internet Explorer 5.0 and 6.0 are not
supported in strong encryption.
syncinterval Enter how often, in minutes, the FortiGate unit should 0
<ntpsync_minutes> synchronize its time with the Network Time Protocol (NTP)
server. The syncinterval number can be from 1 to 1440
minutes. Setting to 0 disables time synchronization.
tcp-halfclose-timer Enter how many seconds the FortiGate unit should wait to 120
<seconds> close a session after one peer has sent a FIN packet but
the other has not responded. The valid range is from 1 to
86400 seconds.
tcp-halfopen-timer Enter how many seconds the FortiGate unit should wait to 60
<seconds> close a session after one peer has sent an open session
packet but the other has not responded. The valid range is
from 1 to 86400 seconds.
tcp-option Enable SACK, timestamp and MSS TCP options. For enable
{enable | enable} normal operation tcp-option should be enabled. Disable
for performance testing or in rare cases where it impairs
performance.
timezone The number corresponding to your time zone from 00 to 72. 00
<timezone_number> Press ? to list time zones and their numbers. Choose the
time zone for the FortiGate unit from the list and enter the
correct number.
tos-based-priority Select the default system-wide level of priority for Type of high
{low | medium | high} Service (TOS). TOS determines the priority of traffic for
scheduling. Typically this is set on a per service type level.
See system tos-based-priority for more information.
The value of this keyword is the default setting for when
TOS is not configured on a per service level.
tp-mc-skip-policy Enable to allow skipping of the policy check, and to enable disable
{enable | disable} multicast through.
udp-idle-timer <seconds> Enter the number of sections before an idle udp connection 180
times out. The valid range is from 1 to 86400 seconds.
user-server-cert Select the certificate to use for https user authentication. See definition
<cert_name> Default setting is Fortinet_Factory, if available, under
otherwise self-sign. Description.
vdom-admin Enable to configure multiple virtual domains. disable
{enable | disable}
vip-arp-range vip-arp-range controls the number of ARP packets the restricted
{unlimited | restricted} FortiGate unit sends for a VIP range.
If restricted, the FortiGate unit sends ARP packets for
only the first 8192 addresses in a VIP range.
If unlimited, the FortiGate unit sends ARP packets for
every address in the VIP range.

FortiGate CLI Version 3.0 MR6 Reference

356 01-30006-0015-20080205
system global

Example
This example shows how to change to enable daylight savings time.
config system global
set dst enable
end

History

FortiOS v2.80 New.

FortiOS v2.80 MR2 The ip-overlap keyword was changed to allow-interface-subnet-overlap.
FortiOS v2.80 MR3 Added av_failopen and reset_sessionless_tcp keywords.
FortiOS v2.80 MR4 Moved date and time to execute branch.
Added phase1-rekey keyword.
FortiOS v2.80 MR6 Added ips-open keyword.
FortiOS v3.0 Removed management-vdom, opmode keywords.
Added detection-summary, fsae-burst-size, fsae-rate-limit,
ldapconntimeout, remoteauthtimeout.
Changed underscore to hyphen in av-failopen, conn-tracking, ip_signature,
local_anomaly, mc-ttl-notchange, radius-port, reset-sessionless-tcp,
restart-time, tcp-option.
FortiOS v3.0 MR1 Removed sslvpn-enable keyword.
Added av-failopen-session, management-vdom, strong-crypto keywords.
FortiOS v3.0 MR2 Added admin-ssh-port, admin-telnet-port, cfg-save, cfg-revert-timeout,
tcp-halfopen-timer, tos-based-priority.
FortiOS v3.0 MR3 Added fds-statistics and udp-idle-timer. Removed mc-ttl-notchange,
batch_sleep, and multicast-forward.
FortiOS v3.0 MR4 Added access-banner, admin-server-cert, admin-telnet-port,
forticlient-portal-port and tcp-halfopen-timer. Removed asymroute.
FortiOS v3.0 MR5 Added admin-https-pki-required, admin-maintainer, user-server-cert,
internal-switch-mode, internal-switch-speed, forticlient-portal-
port, tp-mc-skip-policy. Added auth-cert command.
FortiOS v3.0 MR6 Modified definition of admin-server-cert and user-server-cert. Removed
local-anomaly. Added fds-statistics-period. Moved authtimeout, auth-
secure-http, and auth-type to config user settings.

Related topics
• execute cfg reload
• execute cfg save

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 357
gre-tunnel system

gre-tunnel
Use this command to configure the tunnel for a GRE interface. A new interface of type “tunnel” with the
same name is created automatically as the local end of the tunnel. This command is available only in
NAT/Route mode.
To complete the configuration of a GRE tunnel, you need to:
• configure a firewall policy to pass traffic from the local private network to the tunnel interface
• configure a static route to the private network at the remote end of the tunnel using the GRE tunnel
“device”
• optionally, define the IP addresses for each end of the tunnel to enable dynamic routing through the
tunnel or to enable pinging of each end of the tunnel for testing

Syntax
config system gre-tunnel
edit <tunnel_name>
set interface <interface_name>
set local-gw <localgw_IP>
set remote-gw <remotegw_IP>
end

Variables Description Default

edit <tunnel_name> Enter a name for the tunnel. No default.
interface <interface_name> Enter the physical or VLAN interface that functions as the
local end of the tunnel.
local-gw <localgw_IP> Enter the IP address of the local gateway.
remote-gw <remotegw_IP> Enter the IP address of the remote gateway.

Example
In this example, a GRE tunnel is needed between two sites using FortiGate units. Users on the
192.168.2.0/24 network at Site A need to communicate with users on the 192.168.3.0/24 network at
Site B. At both sites the private network is connected to Port 2 of the FortiGate unit and the connection
to the Internet is through Port 1. At Site A, the public IP address is 172.16.67.199 and at Site B it is
172.16.68.198.

Site A configuration Site B configuration

config system gre-tunnel config system gre-tunnel
edit toSiteB edit toSiteA
set interface port1 set interface port1
set local-gw 172.16.67.199 set local-gw 172.16.68.198
set remote-gw 172.16.68.198 set remote-gw 172.16.67.199
end end

FortiGate CLI Version 3.0 MR6 Reference

358 01-30006-0015-20080205
system gre-tunnel

config firewall policy config firewall policy

edit 1 edit 1
set src-intf port2 set src-intf port2
set dst-intf toSiteB set dst-intf toSiteA
set srcaddr all set srcaddr all
set dstaddr all set dstaddr all
set action accept set action accept
set service ANY set service ANY
set schedule always set schedule always
next next

edit 2 edit 2
set src-intf toSiteB set src-intf toSiteA
set dst-intf port2 set dst-intf port2
set srcaddr all set srcaddr all
set dstaddr all set dstaddr all
set action accept set action accept
set service ANY set service ANY
set schedule always set schedule always
end end

config route static config route static

edit 1 edit 1
set device toSiteB set device toSiteA
set dst 192.168.3.0/24 set dst 192.168.2.0/24
end end

(Optional) (Optional)
config system interface config system interface
edit toSiteB edit toSiteA
set ip 10.0.0.1/32 set ip 10.0.0.2/32
set remote-ip 10.0.0.2 set remote-ip 10.0.0.1
set allowaccess ping set allowaccess ping
end end

History

FortiOS v3.0 New

Related topics
• system interface
• firewall policy, policy6
• router static

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 359
ha system

ha
Use this command to enable and configure FortiGate high availability (HA) and virtual clustering. HA is
supported on FortiGate and FortiWiFi models numbered 60 and higher. Using the config system
ha command you must configure all cluster members with the same group name, mode, and password
before the FortiGate units can form a cluster.
Group name, mode, password, as well as priority and group ID are not synchronized between cluster
units. The primary unit synchronizes all other configuration settings, including the other HA
configuration settings.
When virtual domains are enabled for the FortiGate units to be operating in HA mode you are
configuring virtual clustering. Using virtual clustering you create two virtual clusters and add virtual
domains to each cluster. Configuring virtual clustering is very similar to configuring normal HA except
that in a virtual cluster, the HA mode can only be set to active-passive. As well additional options are
available for adding virtual domains to each virtual cluster and for setting the device priority for each
device in each virtual cluster.

Note: You cannot enable HA mode if one of the FortiGate unit interfaces uses DHCP or PPPoE to acquire an IP
address. If DHCP or PPPoE is configured, the config ha mode keyword is not available.

For complete information about how to configure and operate FortiGate HA clusters and more detail
about the config system ha CLI command, see the FortiGate HA Overview, the FortiGate HA
Guide, and the Fortinet Knowledge Center.

Command syntax pattern

config system ha
set arps <arp_integer>
set arps-interval <interval_integer>
set authentication {disable | enable}
set encryption {disable | enable}
set group-id <id_integer>
set group-name <name_str>
set hb-interval <interval_integer>
set hb-lost-threshold <threshold_integer>
set hbdev <interface_name> <priority_integer> [<interface_name>
<priority_integer>]...
set helo-holddown <holddown_integer>
set link-failed-signal {disable | enable}
set load-balance-all {disable | enable}
set mode {a-a | a-p | standalone}
set monitor <interface_names>
set override {disable | enable}
set password <password_str>
set pingserver-failover-threshold <threshold_integer>
set pingserver-flip-timeout <timeout_integer>
set pingserver-monitor-interface <interface_names>
set priority <priority_integer>
set route-hold <hold_integer>
set route-ttl <ttl_integer>
set route-wait <wait_integer>
set schedule {hub | ip | ipport | leastconnection | none | random
| round-robin | weight-round-robin}
set session-pickup {disable | enable}

FortiGate CLI Version 3.0 MR6 Reference

360 01-30006-0015-20080205
system ha

set sync-config {disable | enable}

set uninterruptable-upgrade {disable | enable}
set weight <priority_integer> <weight_integer>
set vdom <vdom_names>
set vcluster2 {disable | enable}
end
config secondary-vcluster
set monitor <interface_names>
set override {disable | enable}
set priority <priority_integer>
set vdom <vdom_names>
end
end
Keywords and variables Description Default
arps <arp_integer> Set the number of times that the primary unit sends 5
gratuitous ARP packets. Gratuitous ARP packets are sent
when a cluster unit becomes a primary unit (this can occur
when the cluster is starting up or after a failover). Gratuitous
ARP packets configure connected network devices to
associate the cluster virtual MAC addresses and cluster IP
address with primary unit physical interfaces. (This is
sometimes called using gratuitous ARP packets to train the
network.)
The arps range is 1 to 16. Normally you would not need to
change the arps setting. However you may need to
increase the number of times the primary unit sends
gratuitous ARP packets if your cluster takes a long time to
failover or to train the network. Sending more gratuitous
ARP packets may help the failover happen faster.
There may be a number of reasons to reduce the number of
times that gratuitous ARP packets are sent. For example, if
your cluster has a large number of VLAN interfaces and
virtual domains and because gratuitous ARP packets are
broadcast, sending gratuitous ARP packets may generate a
lot of network traffic. As long as the cluster still fails over
successfully you could reduce the number of time gratuitous
ARP packets are sent to reduce the amount of traffic
produced after a failover.
Depending on your network, you may be able to use both
the arps and the arps-interval keywords to improve
how quickly your cluster fails over.
arps-interval Set the number of seconds to wait between sending 8
<interval_integer> gratuitous ARP packets. When a cluster unit becomes a
primary unit (this occurs when the cluster is starting up or
after a failover) the primary unit sends gratuitous ARP
packets immediately to inform connected network equipment
of the IP address and MAC address of the primary unit. The
primary unit then waits for the number of seconds in the
arps-interval and sends the gratuitous ARP packets
again. This happens until the gratuitous ARP packets have
been sent the number of times set by the arps keyword.
The arps-interval range is 1 to 20 seconds. Normally
you would not need to change the arps-interval.
However, you may need to decrease the arps-interval
to send gratuitous ARP packets more often if your cluster
takes a long time to failover or to train the network.
There may be a number of reasons to set the
arps-interval higher. For example, if your cluster has a
large number of VLAN interfaces and virtual domains and
because gratuitous ARP packets are broadcast, sending
gratuitous ARP packets may generate a lot of network traffic.
As long as the cluster still fails over successfully you could
increase arps-interval to reduce the amount of traffic
produced after a failover.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 361
ha system

Keywords and variables Description Default

authentication {disable Enable/disable HA heartbeat message authentication. disable
| enable} Enabling HA heartbeat message authentication prevents an
attacker from creating false HA heartbeat messages. False
HA heartbeat messages could affect the stability of the
cluster.
encryption {disable | Enable/disable HA heartbeat message encryption. Enabling disable
enable} HA heartbeat message encryption prevents an attacker from
sniffing HA packets to get HA cluster information.
group-id <id_integer> The HA group ID. The group ID range is from 0 to 63. All 0
members of the HA cluster must have the same group ID.
Changing the Group ID changes the cluster virtual MAC
address.
group-name <name_str> The HA group name. All cluster members must have the FGT-HA
same group name.
hb-lost-threshold The lost heartbeat threshold, which is the number of 20
<threshold_integer> seconds to wait to receive a heartbeat packet from another
cluster unit before assuming that the cluster unit has failed.
The lost heartbeat threshold range is 1 to 60 seconds.
hb-interval The heartbeat interval, which is the time between sending 2
<interval_integer> heartbeat packets. The heartbeat interval range is 1 to 20
(100*ms).
hbdev <interface_name> Select the FortiGate interfaces to be heartbeat interfaces Depends on the
<priority_integer> and set the heartbeat priority for each interface. The FortiGate model.
[<interface_name> heartbeat interface with the highest priority processes all
heartbeat traffic. If two or more heartbeat interfaces have the
<priority_integer>]... same priority, the heartbeat interface that is highest in the
interface list processes all heartbeat traffic.
By default two interfaces are configured to be heartbeat
interfaces and the priority for both these interfaces is set to
50. The heartbeat interface priority range is 0 to 512. In most
cases you can maintain the default hbdev configuration as
long as you can connect the hbdev interfaces together.
On the FortiGate-50B only one interface is configured as the
default heartbeat interface.
To change the heartbeat interface configuration, enter a list
of interface name and priority pairs. Enter the name of each
interface followed by the priority. Use a space to separate
each interface name and priority pair. If you want to remove
an interface from the list, add an interface to the list, or
change a priority, you must retype the entire updated list.
Heartbeat communication must be enabled on at least one
interface. If heartbeat communication is interrupted the
cluster stops processing traffic.
You can select up to 8 heartbeat interfaces. This limit only
applies to FortiGate units with more than 8 physical
interfaces.
helo-holddown The hello state hold-down time, which is the number of 20
<holddown_integer> seconds that a cluster unit waits before changing from hello
state to work state. A cluster unit changes from hello state to
work state when it starts up.
The hello state hold-down time range is 5 to 300 seconds.
link-failed-signal Enable or disable shutting down all primary unit interfaces disable
{disable | enable} (except for heartbeat device interfaces) for one second
when a link failover occurs. If all interfaces are not shut down
in this way, some switches may not detect that the primary
unit has become a subordinate unit and may keep sending
packets to the former primary unit.

FortiGate CLI Version 3.0 MR6 Reference

362 01-30006-0015-20080205
system ha

Keywords and variables Description Default

load-balance-all If mode is set to a-a, configure active-active HA to load disable
{disable | enable} balance TCP sessions and sessions for firewall policies that
include protection profiles or to just load balance sessions
for firewall policies that include protection profiles. Enter
enable to load balance TCP sessions and sessions for
firewall policies that include protection profiles. Enter
disable to load balance only sessions for firewall policies
that include protection profiles. UDP, ICMP, multicast, and
broadcast traffic is never load balanced and is always
processed by the primary unit. VoIP traffic, IM traffic, IPSec
VPN traffic, and SSL VPN traffic is also always processed
only by the primary unit.
mode {a-a | a-p | Set the HA mode. standalone
standalone} Enter a-p to create an Active-Passive HA cluster, in which
the primary cluster unit is actively processing all connections
and the other cluster units are passively monitoring the
cluster status and remaining synchronized with the primary
cluster unit.
Enter a-a to create an Active-Active HA cluster, in which
each cluster unit is actively processing connections and
monitoring the status of the other FortiGate units.
All members of an HA cluster must be set to the same HA
mode.
Not available if a FortiGate interface mode is set to dhcp or
pppoe.
a-a mode is not available for virtual clusters.
monitor Enable or disable port monitoring for link failure. Port No default
<interface_names> monitoring (also called interface monitoring) monitors
FortiGate interfaces to verify that the monitored interfaces
are functioning properly and connected to their networks.
Enter the names of the interfaces to monitor. Use a space to
separate each interface name. If you want to remove an
interface from the list or add an interface to the list you must
retype the list with the names changed as required.
You can monitor physical interfaces, redundant interfaces,
and 802.3ad aggregated interfaces but not VLAN
subinterfaces or IPSec VPN interfaces. You cannot monitor
interfaces that are 4-port switches. This includes the internal
interface of FortiGate models 50B, 60, 60M, 100A, 200A,
and FortiWiFi-60. This also includes the LAN interface of the
FortiGate-500A.
You can monitor up to 16 interfaces. This limit only applies to
FortiGate units with more than 16 physical interfaces.
override {disable | Enable or disable forcing the cluster to renegotiate and disable
enable} select a new primary unit every time a cluster unit leaves or enable when
joins a cluster, changes status within a cluster, or every time you use set
the HA configuration of a cluster unit changes. The override vcluster2
setting is not synchronized to all cluster units. enable to
Enabling override makes cluster operation more predictable enable virtual
but may lead to the cluster negotiating more often. During cluster 2.
cluster negotiation traffic may be interrupted.
For a virtual cluster configuration, override is enabled by
default for both virtual clusters when you enter set
vcluster2 enable to enable virtual cluster 2. Usually you
would enable virtual cluster 2 and expect one cluster unit to
be the primary unit for virtual cluster 1 and the other cluster
unit to be the primary unit for virtual cluster 2. For this
distribution to occur override must be enabled for both
virtual clusters. Otherwise you will need to restart the cluster
to force it to renegotiate. You can choose to disable
override for both virtual clusters once the cluster is
operating.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 363
ha system

Keywords and variables Description Default

password <password_str> Enter a password for the HA cluster. The password must be No default
the same for all FortiGate units in the cluster. The maximum
password length is 15 characters.
If you have more than one FortiGate HA cluster on the same
network, each cluster must have a different password.
pingserver-failover- Set the HA remote IP monitoring failover threshold. If HA 0
threshold remote monitoring is enabled using the
<threshold_integer> pingserver-monitor-interface set the failover
threshold so that if one or more ping servers fails, cluster
failover occurs when the priority of all failed ping servers
reaches or exceeds this threshold. You set the priority for
each remote IP monitoring ping server using the
ha-priority keyword of the command “system interface”
on page 373.
The failover threshold range is 0 to 50. Setting the failover
threshold to 0 means that if any ping server added to the HA
remote IP monitoring configuration fails an HA failover will
occur.
pingserver-flip-timeout Set the HA remote IP monitoring flip timeout in minutes. If 60
<timeout_integer> HA remote IP monitoring fails on all cluster units because
none of the cluster units can connect to the monitored IP
addresses, the flip timeout stops a failover from occurring
until the timer runs out. The range is 20 to 2147483647
minutes.
For example, setting the pingserver-flip-timeout to
120 means that remote IP monitoring can only cause a
failover every 120 minutes.
pingserver-monitor- Enable HA remote IP monitoring by specifying the FortiGate
interface unit interfaces that will be used to monitor remote IP
<interface_names> addresses. You can configure remote IP monitoring for all
types of interfaces including physical interfaces, VLAN
interfaces, redundant interfaces and aggregate interfaces.
Use a space to separate each interface name. If you want to
remove an interface from the list or add an interface to the
list you must retype the list with the names changed as
required.
For remote IP monitoring to work you must also:
• Add ping servers to these interfaces. You can use the
detectserver keyword of the command “system
interface” on page 373 or you can add ping servers from
the web-based manager.
• Set the ha-priority keyword of the command “system
interface” on page 373 for each ping server.
• Set the pingserver-failover-threshold and
pingserver-flip-timeout keywords.
For more information about configuring HA remote IP
monitoring, see “Remote IP Monitoring Example” on
page 369.
priority Change the device priority of the cluster unit. Each cluster 128
<priority_integer> unit can have a different device priority (the device priority is
not synchronized among cluster members). During HA
negotiation, the cluster unit with the highest device priority
becomes the primary unit. The device priority range is 0 to
255.
route-hold The time that the primary unit waits between sending routing 10
<hold_integer> table updates to subordinate units in a cluster. The route
hold range is 0 to 3600 seconds.

FortiGate CLI Version 3.0 MR6 Reference

364 01-30006-0015-20080205
system ha

Keywords and variables Description Default

route-ttl <ttl_integer> The time to live for routes in a cluster unit routing table. 10
The time to live range is 0 to 3600 seconds.
The time to live controls how long routes remain active in a
cluster unit routing table after the cluster unit becomes a
primary unit. To maintain communication sessions after a
cluster unit becomes a primary unit, routes remain active in
the routing table for the route time to live while the new
primary unit acquires new routes.
route-wait The time the primary unit waits after receiving a routing table 0
<wait_integer> update before sending the update to the subordinate units in
the cluster.
For quick routing table updates to occur, set route-wait to
a relatively short time so that the primary unit does not hold
routing table changes for too long before updating the
subordinate units.
The route-wait range is 0 to 3600 seconds.
schedule {hub | ip Active-active load balancing schedule. round-robin
| ipport hub: load balancing if the cluster interfaces are connected to
| leastconnection | hubs. Traffic is distributed to cluster units based on the
none | random Source IP and Destination IP of the packet.
| round-robin ip: load balancing according to IP address. If the cluster
units are connected using switches, use ip to distribute
| weight-round-robin} traffic to units in a cluster based on the Source IP and
Destination IP of the packet.
ipport: load balancing according to IP address and port. If
the cluster units are connected using switches, use ipport
to distribute traffic to units in a cluster based on the source
IP, source port, destination IP, and destination port of the
packet.
leastconnection: least connection load balancing. If the
cluster units are connected using switches, use
leastconnection to distribute traffic to the cluster unit
currently processing the fewest connections.
none: no load balancing. Use none when the cluster
interfaces are connected to load balancing switches.
random: random load balancing. If the cluster units are
connected using switches, use random to randomly
distribute traffic to cluster units.
round-robin: round robin load balancing. If the cluster
units are connected using switches, use round-robin to
distribute traffic to the next available cluster unit.
weight-round-robin: weighted round robin load
balancing. Similar to round robin, but you can use the
weight keyword to assign weighted values to each of the
units in a cluster based on their capacity and on how many
connections they are currently processing. For example, the
primary unit should have a lower weighted value because it
handles scheduling and forwards traffic. Weighted round
robin distributes traffic more evenly because units that are
not processing traffic are more likely to receive new
connections than units that are very busy. You can optionally
use the weight keyword to set a weighting for each cluster
unit.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 365
ha system

Keywords and variables Description Default

session-pickup {disable Enable or disable session pickup. Enable disable
| enable} session-pickup so that if the primary unit fails, all
sessions are picked up by the new primary unit.
If you enable session pickup the subordinate units maintain
session tables that match the primary unit session table. If
the primary unit fails, the new primary unit can maintain all
active communication sessions.
If you do not enable session pickup the subordinate units do
not maintain session tables. If the primary unit fails all
sessions are interrupted and must be restarted when the
new primary unit is operating.
You must enable session pickup for effective failover
protection. If you do not require effective failover protection,
leaving session pickup disabled may reduce HA CPU usage
and reduce HA heartbeat network bandwidth usage.
sync-config {disable | Enable or disable automatic synchronization of primary unit enable
enable} configuration changes to all cluster units.
uninterruptable-upgrade Enable or disable upgrading the cluster without interrupting enable
{disable | enable} cluster traffic processing.
If uninterruptable-upgrade is enabled, traffic
processing is not interrupted during a normal firmware
upgrade. This process can take some time and may reduce
the capacity of the cluster for a short time.
If uninterruptable-upgrade is disabled, traffic
processing is interrupted during a normal firmware upgrade
(similar to upgrading the firmware operating on a standalone
FortiGate unit).
weight The weighted round robin load balancing weight to assign to 1 1 1 1
<priority_integer> each cluster unit. When you set schedule to weight-
<weight_integer> round-robin you can use the weight keyword to set the
weight of each cluster unit. The weight is set according to
the priority of the unit in the cluster. A FortiGate HA cluster
can contain up to 32 FortiGate units so you can set up to 32
weights.
The default weight of 1 1 1 1 means that the first four units
in the cluster all have the same weight of 1.
priority_integer is a number from 0 to 31 that identifies
the priority of the cluster unit.
weight-integer is a number between 0 and 31 that is the
weight assigned to the clustet units according to their priority
in the cluster. Increase the weight to increase the number of
connections processed by the cluster unit with that priority.
weight is available when mode is set to a-a and
schedule is set to weight-round-robin.
vdom <vdom_names> Add virtual domains to virtual cluster 1 or virtual cluster 2. All virtual
Virtual cluster 2 is also called the secondary virtual cluster. domains are
In the config system ha shell, use set vdom to add added to virtual
virtual domains to virtual cluster 1. Adding a virtual domain cluster 1.
to virtual cluster 1 removes that virtual domain from virtual
cluster 2.
In the config secondary-vcluster shell, use set
vdom to add virtual domains to virtual cluster 2. Adding a
virtual domain to virtual cluster 2 removes it from virtual
cluster 1.
You can use vdom to add virtual domains to a virtual cluster
in any combination. You can add virtual domains one at a
time or you can add multiple virtual domains at a time. For
example, entering set vdom domain_1 followed by
set vdom domain_2 has the same result as entering
set vdom domain_1 domain_2.

FortiGate CLI Version 3.0 MR6 Reference

366 01-30006-0015-20080205
system ha

Keywords and variables Description Default

vcluster2 {disable | Enable or disable virtual cluster 2. disable
enable} In the global virtual domain configuration, virtual cluster 2 is
enabled by default. When virtual cluster 2 is enabled you
can use config secondary-cluster to configure virtual
cluster 2.
Disable virtual cluster 2 to move all virtual domains from
virtual cluster 2 back to virtual cluster 1.
Enabling virtual cluster 2 enables override for virtual
cluster 1 and virtual cluster 2.
config secondary- Configure virtual cluster 2. You must enable vcluster2. Same defaults as
vcluster Then you can use config secondary-vcluster to set virtual cluster 1
monitor, override, priority, and vdom for virtual except that the
cluster 2. default value for
override is
enable.

Examples
This example shows how to configure a FortiGate unit for active-active HA operation. The example
shows how to set up a basic HA configuration by setting the HA mode, changing the group-name,
and entering a password. You would enter the exact same commands on every FortiGate unit in the
cluster. In the example virtual domains are not enabled.
config system ha
set mode a-a
set group-name myname
set password HApass
end
The following example shows how to configure a FortiGate unit with virtual domains enabled for active-
passive HA operation. In the example, the FortiGate unit is configured with three virtual domains
(domain_1, domain_2, and domain_3) in addition to the root virtual domain. The example shows how
to set up a basic HA configuration similar to the previous example; except that the HA mode can only
be set to a-p. In addition, the example shows how to enable vcluster2 and how to add the virtual
domains domain_2 and domain_3 to vcluster2.
config global
config system ha
set mode a-p
set group-name myname
set password HApass
set vcluster2 enable
config secondary-vcluster
set vdom domain_2 domain_3
end
end
end
The following example shows how to change the device priority of the primary unit to 200 so that this
cluster unit always becomes the primary unit. When you log into the cluster you are actually
connecting to the primary unit. When you change the device priority of the primary unit this change
only affects the primary unit because the device priority is not synchronized to all cluster units. After
you enter the following commands the cluster renegotiates and may select a new primary unit.
config system ha
set priority 200
end

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 367
ha system

The following example shows how to change the device priority of a subordinate unit to 255 so that this
subordinate unit becomes the primary unit. This example involves connecting to the cluster CLI and
using the execute ha manage 0 command to connect to the highest priority subordinate unit. After
you enter the following commands the cluster renegotiates and selects a new primary unit.
execute ha manage 0
config system ha
set priority 255
end
The following example shows how to change the device priority of the primary unit in virtual cluster 2.
The example involves connecting to the virtual cluster CLI and changing the global configuration. In
the example virtual cluster 2 has already been enabled so all you have to do is use the config
secondary-vcluster command to configure virtual cluster 2.
config global
config system ha
config secondary-vcluster
set priority 50
end
end
end
The following example shows how to change the default heartbeat interface configuration so that the
port4 and port1 interfaces can be used for HA heartbeat communication and to give the port4 interface
the highest heartbeat priority so that port4 is the preferred HA heartbeat interface.
config system ha
set hbdev port4 100 port1 50
end
The following example shows how to enable monitoring for the external, internal, and DMZ interfaces.
config system ha
set monitor external internal dmz
end
The following example shows how to configure weighted round robin weights for a cluster of three
FortiGate units. You can enter the following commands to configure the weight values for each unit:

Table 5: Example weights for three cluster units

Cluster unit priority Weight

0 1
1 3
2 3

config system ha
set schedule weight-round-robin
set weight 0 1
set weight 1 3
set weight 2 3
end

FortiGate CLI Version 3.0 MR6 Reference

368 01-30006-0015-20080205
system ha

These commands have the following results:

• The first connection is processed by the primary unit (priority 0, weight 1)
• The next three connections are processed by the first subordinate unit (priority 1, weight 3)
• The next three connections are processed by the second subordinate unit (priority 2, weight 3)
The subordinate units process more connections than the primary unit, and both subordinate units, on
average, process the same number of connections.
This example shows how to display the settings for the system ha command.
get system ha
This example shows how to display the configuration for the system ha command.
show system ha

Remote IP Monitoring Example

HA Remote IP monitoring is similar to HA port monitoring. Port monitoring causes a cluster to failover
if a monitored primary unit interface fails or is disconnected. Remote IP monitoring uses ping servers
configured on FortiGate interfaces on the primary unit to test connectivity with IP addresses of network
devices. Usually these would be IP addresses of network devices not directly connected to the cluster.
Remote IP monitoring causes a failover if one or more of these remote IP addresses does not respond
to a ping server.
Using remote IP monitoring to select a new primary unit can be useful in a number of ways depending
on your network configuration. For example, in a full mesh HA configuration, with remote IP monitoring
the cluster can detect failures in network equipment that is not directly connected to the cluster but that
would interrupt traffic processed by the cluster if the equipment failed. In the example topology shown
in Figure 1, the switch connected directly to the primary unit is operating normally but the link on the
other side of the switches fails. As a result traffic can no longer flow between the primary unit and the
Internet.
To detect this failure you can create a remote IP monitoring configuration consisting of a ping server on
port2 of the cluster. The primary unit tests connectivity to 192.168.20.20. If the ping server cannot
connect to 192.268.20.20 the cluster to fails over and the subordinate unit becomes the new primary
unit. The remote HA monitoring ping server on the new primary unit can connect to 192.168.20.20 so
the failover maintains connectivity between the internal network and the Internet through the cluster.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 369
ha system

Figure 1: Example HA remote IP monitoring topology

Internet

Ping Server from Monitored

Primary unit Remote IP
Router
cannot Reach 192.168.20.20
Monitored IP,
Causing HA
Failover
Link Failure

Physical Link Switch Switch

Operating
port2 Primary Subordinate
Unit
Unit

port1

Switch Switch

Router

Internal Network

To configure remote IP monitoring

1 Enter the following commands to configure HA remote monitoring for the example topology.
• Enter the pingserver-monitor-interface keyword to enable HA remote IP monitoring on
port2.
• Enter the pingserver-failover-threshold keyword to set the HA remote IP monitoring
failover threshold to 10. If one or more ping servers fails, cluster failover occurs when the priority of
all failed ping servers reaches or exceeds this threshold. You set the priority for each ping server
using the ha-priority keyword as described in step 2 below.
• Enter the pingserver-flip-timeout keyword to set the flip timeout to 120 minutes. After a
failover, if HA remote IP monitoring on the new primary unit also causes a failover, the flip timeout
prevents the failover from occurring until the timer runs out. Setting the
pingserver-flip-timeout to 120 means that remote IP monitoring can only cause a failover
every 120 minutes. This flip timeout is required to prevent repeating failovers if remote IP
monitoring causes a failover from all cluster units because none of the cluster units can connect to
the monitored IP addresses.
config system ha
set pingserver-monitor-interface port2
set pingserver-failover-threshold 10
set pingserver-flip-timeout 120
end

FortiGate CLI Version 3.0 MR6 Reference

370 01-30006-0015-20080205
system ha

2 Enter the following commands to add the ping server to the port2 interface and to set the HA remote IP
monitoring priority for this ping server.
• Enter the detectserver keyword to add the ping server and set the ping server IP address to
192.168.20.20.
• Enter the ha-priority keyword to set the HA remote IP monitoring priority of the ping server to
10 so that if this ping server does not connect to 192.168.20.20 the HA remote IP monitoring
priority will be high enough to reach the failover threshold and cause a failover.
config system interface
edit port2
set detectserver 192.168.20.20
set ha-priority 10
end
3 You can also use the config global command to change the time interval between ping server
pings using the interval keyword and to change the number of times that the
ping fails before a failure is detected using the failtime keyword.
4 You can also do the following to configure HA remote IP monitoring to test more IP addresses:
• Enable HA remote IP monitoring on more interfaces by adding more interface names to the
pingserver-monitor-interface keyword.
• If your FortiGate configuration includes VLAN interfaces, aggregate interfaces and other interface
types, you can add the names of these interfaces to the pingserver-monitor-interface
keyword to configure HA remote IP monitoring for these interfaces.
• Add a second IP address to the detectserver keyword to monitor two IP addresses on each
interface.

Note: If you add two IP addresses to the detectserver keyword the ping will be sent to both at the
same time, and only when neither server responds will the ping server fail.

• Add secondary IPs to any interface and enter detectserver and ha-priority for each of the
secondary IPs. You can do this to monitor multiple IP addresses on any interface and set a different
HA priority for each one. By adding multiple ping servers to the remote HA monitoring configuration
and setting the HA priorities for each you can fine tune remote IP monitoring. For example, if its
more important to maintain connections to some remote IPs you can set the HA priorities higher for
these IPs. And if its less important to maintain connections to other remote IPs you can set the HA
priorities lower for these IPs. You can also adjust the pingserver-failover-threshold so
that if the cluster cannot connect to one or two high priority IPs a failover occurs. But a failover will
not occur if the cluster cannot connect to one or two low priority IPs.

Command History

FortiOS v2.80 Revised.

FortiOS v2.80 MR2 Added load-balance-all keyword.
FortiOS v2.80 MR5 Added route-hold, route-wait, and route-ttl keywords.
FortiOS v2.80 MR6 Added authentication, arps, encryption, hb-lost-threshold, helo-
holddown, and hb-interval keywords.
FortiOS v2.80 MR7 Changes to the weight keyword.
FortiOS v2.80 MR10 New link-failed-signal keyword.
FortiOS v3.0 Added the group-name, session-pickup, sync-config, vdom, vcluster2, and
config secondary-vcluster keywords. The monitor and hbdev functionality has
been simplified; priority numbers are no longer supported.
FortiOS v3.0 MR3 Added uninterruptable-upgrade keyword.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 371
ha system

FortiOS v3.0 MR4 Priorities added back to the hbdev keyword.

FortiOS v3.0 MR5 In a virtual cluster configuration override is enabled for virtual cluster 1 and virtual cluster
2 when you enter set vcluster2 enable to enable virtual cluster 2.
FortiOS v3.0 MR6 Added the arps-interval, pingserver-monitor-interface,
pingserver-failover-threshold, and pingserver-flip-timeout keywords.
Improved the description of the arps keyword.

FortiGate CLI Version 3.0 MR6 Reference

372 01-30006-0015-20080205
system interface

interface
Use this command to edit the configuration of a FortiGate physical interface, VLAN subinterface, IEEE
802.3ad aggregate interface, redundant interface or IPSec tunnel interface.
In the following table, VLAN subinterface can be substituted for interface in most places except that
you can only configure VLAN subinterfaces with static IP addresses. Use the edit command to add a
VLAN subinterface.

Note: VLAN communication over the backplane interfaces is available for FortiGate-5000 modules
installed in a FortiGate-5020 chassis. The FortiSwitch-5003 does not support VLAN-tagged packets so
VLAN communication is not available over the FortiGate-5050 and FortiGate-5140 chassis backplanes.

Some keywords are specific to aggregate interfaces. These appear at the end of the list of commands
under “variables for aggregate and redundant interfaces (models 300A, 400A, 500A, and 800 or
higher)” on page 386.

Syntax
Entering a name string for the edit keyword that is not the name of a physical interface adds a VLAN
subinterface.
config system interface
edit <interface_name>
set allowaccess <access_types>
set alias <name_string>
set arpforward {enable | disable}
set auth-type <ppp_auth_method>
set bfd {enable | disable | global}
set bfd-desired-min-tx <interval_msec>
set bfd-detect-mult <multiplier>
set bfd-required-min-rx <interval_msec>
set broadcast-forward {enable | disable}
set ddns {enable | disable}
set ddns-domain <ddns_domain_name>
set ddns-password <ddns_password>
set ddns-profile-id <dnsart_profile_id>
set ddns-server <ddns_service>
set ddns-sn <ddns_sn>
set ddns-username <ddns_username>
set defaultgw {enable | disable}
set detectserver <pingserver_ipv4> [pingserver2_ipv4]
set description <text>
set dhcp-relay-ip <dhcp_relay1_ipv4> {... <dhcp_relay8_ipv4>}
set dhcp-relay-service {enable | disable}
set dhcp-relay-type {ipsec | regular}
set disc-retry-timeout <pppoe_retry_seconds>
set distance <admin_distance>
set dns-server-override {enable | disable}
set fortimanager-discover-helper {enable | disable}
set forward-domain <collision_group_number>
set fp-anomaly [...]
set gi-gk {enable | disable} (FortiOS Carrier)
set gwaddr <IPv4>
set gwdetect {enable | disable}
set ha-priority <priority_integer>

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 373
interface system

set icmp-redirect {enable | disable}

set ident-accept {enable | disable}
set idle-timeout <pppoe_timeout_seconds>
set inbandwidth <bandwidth_integer>
set interface <port_name>
set ip <interface_ipv4mask>
set ipmac {enable | disable}
set ipunnumbered <unnumbered_ipv4>
set l2forward {enable | disable}
set lacp-ha-slave {enable | disable}
set lacp-mode {active | passive | static}
set lacp-speed {fast | slow}
set lcp-echo-interval <lcp_interval_seconds>
set lcp-max-echo-fail <missed_echoes>
set log {enable | disable}
set macaddr <mac_address>
set mediatype {serdes-sfp | sgmii-sfp}
set member <if_name1> <if_name2> ...
set mode <interface_mode>
set mpls {enable | disable} (FortiOS Carrier)
set mtu <mtu_bytes>
set mtu-override {enable | disable}
set mux-type { llc-encaps | vc-encaps}
set netbios-forward {disable | enable}
set padt-retry-timeout <padt_retry_seconds>
set password <pppoe_password>
set peer-interface <interface>
set pppoe-unnumbered-negotiate {disable | enable}
set pptp-client {disable | enable}
set pptp-user <pptp_username>
set pptp-password <pptp_userpassword>
set pptp-server-ip <pptp_serverid>
set pptp-auth-type <pptp_authtype>
set pptp-timeout <pptp_idletimeout>
set priority <learned_priority>
set remote-ip <ipv4>
set speed <interface_speed>
set status {down | up}
set stpforward {enable | disable}
set subst {enable | disable}
set substitute-dst-mac <destination_mac_addres>
set tcp-mss <max_send_bytes>
set type {adsl | aggregate | loopback | physical | redundant |
tunnel | vlan | wireless}
set username <pppoe_username>
set vci <integer>
set vdom <vdom_name>
set vlanforward {enable | disable}
set vlanid <id_number>
set vpi <integer>
set wifi-acl {allow | deny}
set wifi-auth {PSK | RADIUS}
set wifi-broadcast_ssid {enable | disable}
set wifi-encrypt {AES | TKIP}

FortiGate CLI Version 3.0 MR6 Reference

374 01-30006-0015-20080205
system interface

set wifi-fragment_threshold <packet_size>

set wifi-key <hex_key>
set wifi-mac-filter {enable | disable}
set wifi-passphrase <pass_str>
set wifi-radius-server <server_name>
set wifi-rts_threshold <integer>
set wifi-security <sec_mode>
set wifi-ssid <id_str>
set wins-ip <wins_server_ip>
config ipv6
set ip6-address <if_ipv6mask>
set ip6-allowaccess <access_types>
set ip6-default-life <ipv6_life_seconds>
set ip6-hop-limit <ipv6_hops_limit>
set ip6-link-mtu <ipv6_mtu>
set ip6-manage-flag {disable | enable}
set ip6-max-interval <adverts_max_seconds>
set ip6-min-interval <adverts_min_seconds>
set ip6-other-flag {disable | enable}
set ip6-reachable-time <reachable_msecs>
set ip6-retrans-time <retrans_msecs>
set ip6-send-adv {enable | disable}
config ip6-prefix-list
edit <ipv6_prefix>
set autonomous-flag {enable | disable}
set onlink-flag {enable | disable}
set preferred-life-time <seconds>
set valid-life-time <seconds>
end
end
end
config secondaryip
edit <secondary_ip_id>
set allowaccess <access_types>
set detectserver <pingserver_ipv4> [pingserver2_ipv4]
set gwdetect {enable | disable}
set ha-priority <priority_integer>
set ip <interface_ipv4mask>
end
end
config wifi-mac_list
edit <entry_number>
set mac <mac_address>
end

Note: A VLAN cannot have the same name as a zone or a virtual domain.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 375
interface system

Variable Description Default

allowaccess Enter the types of management access permitted on this Varies for
<access_types> interface or secondary IP address. each
Valid types are: http https ping snmp ssh telnet. interface.
Separate each type with a space.
To add or remove an option from the list, retype the complete
list as required.
alias <name_string> Enter an alias name for the interface. Once configured, the
alias will be displayed with the interface name to make it easier
to distinguish. The alias can be a maximum of 25 characters.
This option is only available when interface type is physical.
arpforward Enable or disable forwarding of ARP packets on this interface. enable
{enable | disable} ARP forwarding is required for DHCP relay and MS Windows
Client browsing.
auth-type Select the PPP authentication method for this interface. auto
<ppp_auth_method> • Enter auto to select authentication method automatically
• Enter chap for CHAP
• Enter mschapv1 for Microsoft CHAP v1
• Enter mschapv2 for Microsoft CHAP v2
• Enter pap for PAP
This is available only when mode is pppoe, and type of
interface is physical.
bfd {enable | disable | The status of Bidirectional Forwarding Detection (bfd) on this global
global} interface:
enable - enable BFD and ignore global BFD configuration
disable - disable BFD on this interface
global - BFD behavior on this interface will be based on the
global configuration for BFD
The other bfd* keywords are visible only if bfd is enabled.
bfd-desired-min-tx Enter the minimum desired interval for the BFD transmit 50
<interval_msec> interval. Valid range is from 1 to 100 000 msec.
bfd-detect-mult Select the BFD detection multiplier. 3
<multiplier>
bfd-required-min-rx Enter the minimum required interface for the BFD receive 50
<interval_msec> interval. Valid range is from 1 to 100 000 msec.
broadcast-forward Select to enable broadcast forwarding. Use with caution. disable
{enable | disable}
ddns {enable | disable} Enable or disable using a Dynamic DNS service (DDNS). If this disable
interface of your FortiGate unit uses a dynamic IP address, you
can arrange with a DDNS service provider to use a domain
name to provide redirection of traffic to your network whenever
the IP address changes.
DDNS is available only in NAT/Route mode.
ddns-domain Enter the fully qualified domain name to use for the DDNS. This No default.
<ddns_domain_name> is the domain name you have registered with your DDNS.
This is available only when ddns is enabled, but ddns-
server is not set to dnsart.com.
ddns-password Enter the password to use when connecting to the DDNS No default.
<ddns_password> server.
This is available only when ddns is enabled, but ddns-
server is not set to dipdns.net.
ddns-profile-id Enter your DDNS profile ID. This keyword is available instead No default.
<dnsart_profile_id> of ddns-domain.
This is only available when ddns is enabled, and ddns-
server is set to dnsart.com.

FortiGate CLI Version 3.0 MR6 Reference

376 01-30006-0015-20080205
system interface

Variable Description Default

ddns-server Select a DDNS server to use. The client software for these No default.
<ddns_service> services is built into the FortiGate firmware. The FortiGate unit
can only connect automatically to a DDNS server for these
supported clients.
• dhs.org supports members.dhs.org and dnsalias.com.
• dipdns.net supports dipdnsserver.dipdns.com.
• dnsart.com supports www.dnsart.com.
• dyndns.org supports members.dyndns.org.
• dyns.net supports www.dyns.net.
• now.net.cn supports ip.todayisp.com.
• ods.org supports ods.org.
• tzo.com supports rh.tzo.com.
• vavic.com supports ph001.oray.net.
This is available only when ddns is enabled.

ddns-sn <ddns_sn> Enter your DDNS serial number. No default.

This is available only if ddns is enabled, and ddns-server
is set to dipdns.net. This keyword is available instead of
ddns-username and ddns-password.
ddns-username Enter the user name to use when connecting to the DDNS No default.
<ddns_username> server.
This is available when ddns is enabled, but ddns-server is
not set to dipdns.net.
defaultgw Enable or disable getting the gateway IP address from the disable
{enable | disable} DHCP, PPPoE, or PPPoA server.
This is valid only when the mode is one of DHCP, PPPoE, or
PPPoA.

description <text> Optionally, enter up to 63 characters to describe this interface. No default.

detectserver Add the IP address of a ping server. A ping server is usually the No default.
<pingserver_ipv4> next hop router on the network connected to the interface. If
[pingserver2_ipv4] gwdetect is enabled, the FortiGate unit confirms connectivity
with the server at this IP address. Adding a ping server is
required for routing failover.
Optionally you can add 2 ping servers. The ping will be sent to
both at the same time, and only when neither server responds
will gwdetect fail.
A primary and secondary ping server IP address can be the
same.
This is available only in NAT/Route mode.
dhcp-relay-ip Set DHCP relay IP addresses. You can specify up to eight No default.
<dhcp_relay1_ipv4> {... DHCP relays. Replies from all DHCP servers are forwarded
<dhcp_relay8_ipv4>} back to the client. The client responds to the offer it wants to
accept.
Do not set dhcp-relay-ip to 0.0.0.0.
dhcp-relay-service Enable to provide DHCP relay service on this interface. The disable
{enable | disable} DHCP type relayed depends on the setting of dhcp-relay-
type.
There must be no other DHCP server of the same type (regular
or ipsec) configured on this interface.
dhcp-relay-type {ipsec | Set dhcp_type to ipsec or regular depending on type of regular
regular} firewall traffic.
disc-retry-timeout Set the initial discovery timeout in seconds. The time to wait 1
<pppoe_retry_seconds> before retrying to start a PPPoE discovery. Set
disc-retry-timeout to 0 to disable.
mode must be set to pppoe.
This is available in NAT/Route mode only.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 377
interface system

Variable Description Default

distance Configure the administrative distance for routes learned 1
<admin_distance> through PPPoE or DHCP. Using administrative distance you
can specify the relative priorities of different routes to the same
destination. A lower administrative distance indicates a more
preferred route. Distance can be an integer from 1-255. See
also router static “distance <distance>” on page 292
mode must be set to dhcp or pppoe for this keyword to be
available.
This is available in NAT/Route mode only.
dns-server-override Enable to allow the interface to use DNS server addresses it disable
{enable | disable} acquired via DHCP or PPPoe.
mode must be set to dhcp or pppoe.
edit <interface_name> Edit an existing interface or create a new VLAN interface. None.
edit <ipv6_prefix> Enter the IPv6 prefix you want to configure. For settings, see None.
the edit <ipv6_prefix> variables section of this table.
edit <secondary_ip_id> Enter an integer identifier, e.g., 1, for the secondary ip address None.
that you want to configure.
fortimanager-discover- When enabled, this the FortiGate unit will act as a relay disable
helper {enable | between a FortiManager and FortiClient units if they are on
disable} different networks.

forward-domain Specify the collision domain to which this interface belongs. 0

<collision_group_number> Layer 2 broadcasts are limited to the same group. By default,
all interfaces are in group 0.
Collision domains prevent the forwarding of ARP packets to all
VLANs on an interface. Without collision domains, duplicate
MAC addresses on VLANs may cause ARP packets to be
duplicated. Duplicate ARP packets can cause some switches to
reset.
This command is available in Transparent mode only. For more
information see “Working with virtual domains” on page 51.
fp-anomaly [...] Select which applications to enable for per-port fast path disable
anomaly protection.
You can select multiple anomalies from the list.
The default setting is disabled.
This option is available only on AMC interfaces found on AMC
cards.
gi-gk {enable | disable} Enable Gi Gatekeeper to enable the Gi firewall on this interface disable
(FortiOS Carrier) as part of the anti-overbilling configuration.
See “Configuring anti-overbilling protection” in the FortiGate
Administration Guide for more information.
(FortiOS Carrier)
gwdetect Enable or disable confirming connectivity with the server at the disable
{enable | disable} detectserver IP address. The frequency with which the
FortiGate unit confirms connectivity is set using the failtime
and interval keywords in the command “system global” on
page 350.
This is available in NAT/Route mode only.
ha-priority The HA priority to assign to the ping severs configured on an 0
<priority_integer> interface when the interface is added to an HA remote IP
monitoring configuration. The priority range is 0 to 50.
You configure HA remote IP monitoring using the
pingserver-monitor-interface keyword in the
command “system ha” on page 360.
You can set ha-priority for all types of interfaces including
physical interfaces, VLAN interfaces, and secondary IPs.
This keyword is not available in Transparent mode.
icmp-redirect Disable to stop ICMP redirect from sending from this interface. enable
{enable | disable}

FortiGate CLI Version 3.0 MR6 Reference

378 01-30006-0015-20080205
system interface

Variable Description Default

ident-accept Enable or disable passing ident packets (TCP port 113) to the disable
{enable | disable} firewall policy. If set to disable, the FortiGate unit sends a TCP
reset packet in response to an ident packet.
idle-timeout Disconnect if the PPPoE connection is idle for the specified 0
<pppoe_timeout_seconds> number of seconds. Set to zero to disable this feature.
This is available when mode is set to pppoe.
inbandwidth Enter the KB/sec limit for incoming traffic for this interface. 0
<bandwidth_integer> Use this command to configure inbound traffic shaping for an
interface. Inbound traffic shaping limits the bandwidth accepted
by the interface. Limiting inbound traffic takes precedence over
traffic shaping applied by firewall policies.
You can set inbound traffic shaping for any FortiGate interface
and it can be active for more than one FortiGate interface at a
time. Setting <bandwidth_integer> to 0 (the default) means
unlimited bandwidth or no traffic shaping.
interface <port_name> Enter the physical interface the virtual interface is linked to. None.
This is available only when adding virtual interfaces such as
VLANs and VPNs.
ip <interface_ipv4mask> Enter the interface IP address and netmask. Varies for
This is not available if mode is set to dhcp or pppoe. You can each
set the IP and netmask, but it will not display. interface.
This is available in NAT/Route mode only.
The IP address cannot be on the same subnet as any other
interface.
ipmac {enable | disable} Enable or disable IP/MAC binding for the specified interface. disable
See “ipmacbinding setting” on page 95 and “ipmacbinding
table” on page 97 for information about configuring IP/MAC
binding settings.
ipunnumbered Enable IP unnumbered mode for PPPoE. Specify the IP No default.
<unnumbered_ipv4> address to be borrowed by the interface. This IP address can
be the same as the IP address of another interface or can be
any IP address.
This is available only when mode is pppoe.
The Unnumbered IP may be used for PPPoE interfaces for
which no unique local address is provided. If you have been
assigned a block of IP addresses by your ISP for example, you
can add any of these IP addresses to the Unnumbered IP.
l2forward Set the state of layer 2 forwarding for this interface. Enter one disable
{enable | disable} of:
• enable
• disable
lcp-echo-interval Set the interval in seconds between PPPoE LCP echo 5
<lcp_interval_seconds> requests.
This is available only when mode is pppoe.
lcp-max-echo-fail Set the maximum number of missed LCP echoes before the 3
<missed_echoes> PPPoE link is disconnected.
This is available only when mode is pppoe.
log {enable | disable} Enable or disable traffic logging of connections to this interface. disable
macaddr <mac_address> Override the factory set MAC address of this interface by Factory set.
specifying a new MAC address. Use the form xx:xx:xx:xx:xx:xx.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 379
interface system

Variable Description Default

mediatype {serdes- Some FortiGate SFP interfaces can operate in SerDes serdes-
sfp | sgmii-sfp} (Serializer/Deserializer) or SGMII (Serial Gigabit Media sfp
Independent Interface) mode. The mode that the interface
operates in depends on the type of SFP transceiver installed.
Use this keyword to switch the interface between these two
modes.
• Set mediatype to serdes-sfp if you have installed a
SerDes transceiver. In SerDes mode an SFP interface can
only operate at 1000 Mbps.
• Set mediatype to sgmii-sfp iff you have installed an
SGMII transceiver. In SGMII mode the interface can operate
at 10, 100, or 1000 Mbps.
This keyword is available for some FortiGate SFP interfaces.
For example, all FortiGate-ASM-FB4 interfaces and interfaces
port3 to port18 of the FortiGate-3016B support both SerDes
and SGMII mode.
See your FortiGate unit install guide for more information about
what modes your FortiGate interfaces support.
mode <interface_mode> Configure the connection mode for the interface as one of: static
static, dhcp, or pppoe.
• static - configure a static IP address for the interface.
• dhcp - configure the interface to receive its IP address from
an external DHCP server.
• pppoe -configure the interface to receive its IP address from
an external PPPoE server. This is available only in
NAT/Route mode.
• pppoa - configure the interface to receive its IP address from
an external PPPoA server. This is available only in
NAT/Route mode on models with ADSL modem.
• eoa - Ethernet over ATM
• ipoa - IP over ATM (also known as bridged mode).
This is only available in NAT/Route mode.

mpls {enable | disable} Multi Protocol Label Switching (MPLS) is a networking protocol disable
that allows adding labels to packets (RFC 3031). Additional
MPLS labels can be added, or removed from the packet header
- FortiGate units support up to 6 layers of labels. The labels are
used for improved routing.
When MPLS is enabled on your FortiGate Carrier unit, AV
traffic will be blocked. Only IPS can be applied to MPLS
packets.
To use MPLS:
• operation mode must be transparent
• l2forward must be enabled to pass the MPLS packets
• a multicast policy is needed to allow MPLS router hello
traffic
MPLS is only available in FortiOS Carrier.

FortiGate CLI Version 3.0 MR6 Reference

380 01-30006-0015-20080205
system interface

Variable Description Default

mtu <mtu_bytes> Set a custom maximum transmission unit (MTU) size in bytes. 1 500
Ideally set mtu to the size of the smallest MTU of all the
networks between this FortiGate unit and the packet
destination.
<mtu_bytes> valid ranges are:
• 68 to 1 500 bytes in static mode
• 576 to 1 500 bytes in dhcp mode
• 576 to 1 492 bytes in pppoe mode.
• up to 16 110 bytes in jumbo frames (only supported on high
end FortiGate models)
In Transparent mode, if you change the MTU of an interface,
you must change the MTU of all interfaces to match the new
MTU.
If you configure jumbo frames on your FortiGate unit, all other
network equipment on the route to the destination must also
support jumbo frames.
You can only set the MTU of a physical interface. All virtual
interfaces will inherit that MTU from the physical parent
interface.
mtu is available only when mtu-override is enabled.
mtu-override Select enable to use custom MTU size instead of default disable
{enable | disable} (1 500). This is available for physical interfaces only.
If you change the MTU, you must reboot the FortiGate unit to
update the MTU values of the VLANs on this interface.
FortiGate models 3000 and larger support jumbo frames. For
more information on jumbo frames, see Fortinet Administration
Guide.
netbios-forward Select enable to forward NetBIOS broadcasts to a WINS disable
{disable | enable} server. Use wins-ip <wins_server_ip> to set the WINS server
IP address.
This is available in NAT/Route mode only.
padt-retry-timeout Initial PPPoE Active Discovery Terminate (PADT) timeout in 1
<padt_retry_seconds> seconds. Use this timeout to shut down the PPPoE session if it
is idle for this number of seconds. PADT must be supported by
your ISP.
This is available in NAT/Route mode when mode is pppoe.
password Enter the password to connect to the PPPoE server. No default.
<pppoe_password> This is available in NAT/Route mode when mode is pppoe.
peer-interface Select an interface to be used in TP mode, when the FortiGate
<interface> unit cannot find the destination MAC address in the local table.
This can happen during IPS test.
The peer-interface cannot be the same interface, but it must be
in the same VDOM.
This option is only available in Transparent mode.
pppoe-unnumbered- Disable to resolve problems when mode is set to PPPoE, and enable
negotiate ipunnumbered is set. The default configuration may not work in
{disable | enable} some regions, such as Japan.
This is only available when mode is pppoe and
ipunnumbered is set.
pptp-client Enable to configure and use a PPTP client. disable
{disable | enable}
pptp-user Enter the name of the PPTP user. No default.
<pptp_username>
pptp-password Enter the password for the PPTP user. No default.
<pptp_userpassword>
pptp-server-ip Enter the IP address for the PPTP server. No default.
<pptp_serverid>

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 381
interface system

Variable Description Default

pptp-auth-type Enter the authentication type for the PPTP user. No default.
<pptp_authtype>
pptp-timeout Enter the idle timeout in minutes. Use this timeout to shut down No default.
<pptp_idletimeout> the PPTP user session if it is idle for this number of seconds.
0 for disabled.
priority Enter the priority of routes using this interface. No default.
<learned_priority> This is only available when mode is pppoe.
remote-ip <ipv4> Enter an IP address for the remote end of a tunnel interface. No default.
If you want to use dynamic routing with the tunnel, or be able to
ping the tunnel interface, you must specify an address for the
remote end of the tunnel in remote-ip and an address for this
end of the tunnel in ip.
This is available only if type is tunnel.
speed <interface_speed> The interface speed: auto
• auto, the default speed. The interface uses auto-negotiation
to determine the connection speed. Change the speed only if
the interface is connected to a device that does not support
auto-negotiation.
• 10full, 10 Mbps, full duplex
• 10half, 10 Mbps, half duplex
• 100full, 100 Mbps, full duplex
• 100half, 100 Mbps, half duplex
• 1000full, 1000 Mbps, full duplex
• 1000half, 1000 Mbps, half duplex
Speed options vary for different models and interfaces. Enter a
space and a “?” after the speed keyword to display a list of
speeds available for your model and interface.
You cannot change the speed for interfaces that are 4-port
switches. This includes the internal interfaces of FortiGate
models 60, 60M, 100A, 200A, and FortiWiFi-60. This also
includes the LAN interface of the FortiGate-500A.
status {down | up} Start or stop the interface. If the interface is stopped, it does not up
accept or send packets. (down for
If you stop a physical interface, associated virtual interfaces VLANs)
such as VLAN interfaces will also stop.
stpforward Enable or disable forward Spanning Tree Protocol (STP) disable
{enable | disable} packets through this interface.
subst {enable | disable} Enter enable to use a substitute destination MAC address for disable
this address.
substitute-dst-mac Enter the substitute destination MAC address to use when No default.
<destination_mac_addres> subst is enabled. Use the xx:xx:xx:xx:xx:xx format.
tcp-mss <max_send_bytes> Enter the FortiGate unit’s maximum sending size for TCP No default.
packets.

FortiGate CLI Version 3.0 MR6 Reference

382 01-30006-0015-20080205
system interface

Variable Description Default

type {adsl | aggregate | Enter the type of interface. Note: vlan for
loopback | physical | • adsl is available only on FortiGate model 60ADSL. The newly
redundant | tunnel | ADSL FortiGate model has an internal ADSL modem and this created
is a physical interface to connect to your ADSL service. For interface,
vlan | wireless} physical
ADSL-specific keywords see “variables for ADSL interface
(model 60ADSL only)” on page 386. otherwise.
• aggregate is available only on FortiGate models 800 and
higher. Aggregate links use the 802.3ad standard to group up
to 8 interfaces together. For aggregate specific keywords see
“variables for aggregate and redundant interfaces (models
300A, 400A, 500A, and 800 or higher)” on page 386.
• loopback is a virtual interface that is always up. This
interface’s status and link status are not affected by external
changes. It is primarily used for blackhole routing - any traffic
routed to this interface is dropped. It may also be useful in
some routing situations. loopback interfaces have no dhcp
settings, no forwarding, no mode, or dns settings. You can
only create a loopback interface from the CLI.
• redundant is used to group 2 or more interfaces together for
reliability. Only one interface is in use at any given time. If the
first interface fails, traffic continues uninterrupted as it
switches to the next interface in the group. This is useful in
HA configurations. The order interfaces become active in the
group is determined by the order you specify using the set
member keyword.
• tunnel is for reference only - you cannot create tunnel
interfaces using this command. Create GRE tunnels using the
system gre-tunnel command. Create IPSec tunnels using the
vpn ipsec-intf phase1 command.
• vlan is for virtual LAN interfaces. This is the type of interface
created by default on any existing physical interface. VLANs
increase the number of network interfaces beyond the
physical connections on the unit.
• wireless applies only to FortiWiFi-60A, -60AM, and -60B
models.
username Enter the user name used to connect to the PPPoE server. No default.
<pppoe_username> This is only available in NAT/Route mode when mode is set to
pppoe.
vdom <vdom_name> Enter the name of the virtual domain to which this interface root
belongs.
When you change this keyword, the physical interface moves to
the specified virtual domain. Firewall IP pools and virtual IP
previously added for this interface are deleted. You should also
manually delete any routes that include this interface as they
may now be inaccessible.
For more about VDOMs, see the FortiGate VLANs and VDOMs
Guide.
vlanforward Enable or disable forwarding of traffic between VLANs on this enable
{enable | disable} interface. When disabled, all VLAN traffic will only be delivered
to that VLAN only.
vlanid <id_number> Enter a VLAN ID that matches the VLAN ID of the packets to be No default.
received by this VLAN subinterface.
The VLAN ID can be any number between 1 and 4096 but must
match the VLAN ID added by the IEEE 802.1Q-compliant
router on the other end of the connection. Two VLAN
subinterfaces added to the same physical interface cannot
have the same VLAN ID. However, you can add two or more
VLAN subinterfaces with the same VLAN ID to different
physical interfaces, and you can add more multiple VLANs with
different VLAN IDs to the same physical interface.
This is available only when editing an interface with a type of
VLAN.
For more about VLANs, see the FortiGate VLANs and VDOMs
Guide.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 383
interface system

Variable Description Default

wins-ip <wins_server_ip> Enter the IP address of a WINS server to which to forward No default.
NetBIOS broadcasts. This WINS server address is only used if
netbios-forward is enabled.
This is available in NAT/Route mode only.
WiFi keywords These keywords apply only to the FortiWiFi-60A and FortiWiFi-60AM unit
when type is wireless.
mac <mac_address> Enter a MAC address for the MAC filter list. This is used in the No default.
config wifi-mac_list subcommand.
wifi-acl {allow | deny} Select whether MAC filter list allows or denies access. deny
wifi-auth {PSK | RADIUS} Select either Pre-shared Key (PSK) or RADIUS to authenticate PSK
users connecting to this interface.
This is available only when wifi-security is set to WPA.
wifi-broadcast_ssid Enable if you want FortiWiFi-60 to broadcast its SSID. disable
{enable | disable}
wifi-encrypt Select either Advanced Encryption Standard (AES) or Temporal TKIP
{AES | TKIP} Key Integrity Protocol (TKIP) for encryption on this WLAN
interface.
This is available only when wifi-security is set to WPA.
wifi-fragment_threshold Set the maximum size of a data packet before it is broken into 2346
<packet_size> smaller packets, reducing the chance of packet collisions. If the
packet size is larger than the threshold, the FortiWiFi unit will
fragment the transmission. If the packet size less than the
threshold, the FortiWiFi unit will not fragment the transmission.
Range 800-2346. A setting of 2346 bytes effectively disables
this option.
This is available in AP mode only.
wifi-key <hex_key> Enter a WEP key. The WEP key must be 10 or 26 hexadecimal No default.
digits (0-9 a-f). For a 64-bit WEP key, enter 10 hexadecimal
digits. For a 128-bit WEP key, enter 26 hexadecimal digits.
wifi-security must be set to WEP128 or WEP64.
This is available in AP mode only.
wifi-mac-filter Enable MAC filtering for the wireless interface. disable
{enable | disable}
wifi-passphrase Enter shared key for WPA_PSK security. No default.
<pass_str> wifi-security must be set to WPA_PSK.
This is available in AP mode only.
wifi-radius-server Set RADIUS server name for WPA_RADIUS security. No default.
<server_name> wifi-security must be set to WPA_RADIUS.
This is available in AP mode only.
wifi-rts_threshold The request to send (RTS) threshold is the maximum size, in 2346
<integer> bytes, of a packet that the FortiWiFi will accept without sending
RTS/CTS packets to the sending wireless device. In some
cases, larger packets being sent may cause collisions, slowing
data transmissions.
The valid range is 256 to 2346. A setting of 2347 bytes
effectively disables this option.
This is available in AP mode only.

FortiGate CLI Version 3.0 MR6 Reference

384 01-30006-0015-20080205
system interface

Variable Description Default

wifi-security <sec_mode> Enter security (encryption) mode: None
• None
Communication is not encrypted.
• WEP64
WEP 64-bit encryption
• WEP128
WEP 128-bit encryption
• WPA_PSK
WPA encryption with pre-shared key
This is available in AP mode only.
• WPA_RADIUS
WPA encryption via RADIUS server.
This is available in AP mode only.
wifi-ssid <id_str> Change the Service Set ID (SSID) as required. fortinet
The SSID is the wireless network name that this FortiWiFi-60A
WLAN broadcasts. Users who wish to use the wireless network
should configure their computers to connect to the network that
broadcasts this network name.
config ipv6 variables
ip6-address The interface IPv6 address and netmask. The format for IPv6 ::/0
<if_ipv6mask> addresses and netmasks is described in RFC 3513.
This is available in NAT/Route mode only.
ip6-allowaccess Enter the type of management access permitted on this IPv6 Varies for
<access_types> interface. each
Valid types are: ping. interface.

ip6-default-life Enter the number, in seconds, to add to the Router Lifetime 1800
<ipv6_life_seconds> field of router advertisements sent from the interface. The valid
range is 0 to 9000.
This is available in NAT/Route mode only.
ip6-hop-limit Enter the number to be added to the Cur Hop Limit field in the 0
<ipv6_hops_limit> router advertisements sent out this interface. Entering 0 means
no hop limit is specified. This is available in NAT/Route mode
only.
This is available in NAT/Route mode only.
ip6-link-mtu <ipv6_mtu> Enter the MTU number to add to the router advertisements 0
options field. Entering 0 means that no MTU options are sent.
This is available in NAT/Route mode only.
ip6-manage-flag Enable or disable the managed address configuration flag in disable
{disable | enable} router advertisements.
This is available in NAT/Route mode only.
ip6-max-interval Enter the maximum time interval, in seconds, between sending 600
<adverts_max_seconds> unsolicited multicast router advertisements from the interface.
The valid range is 4 to 1800.
This is available in NAT/Route mode only.
ip6-min-interval Enter the minimum time interval, in seconds, between sending 198
<adverts_min_seconds> unsolicited multicast router advertisements from the interface.
The valid range is 4 to 1800.
This is available in NAT/Route mode only.
ip6-other-flag Enable or disable the other stateful configuration flag in router disable
{disable | enable} advertisements.
This is available in NAT/Route mode only.
ip6-reachable-time Enter the number to be added to the reachable time field in the 0
<reachable_msecs> router advertisements. The valid range is 0 to 3600. Entering 0
means no reachable time is specified.
This is available in NAT/Route mode only.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 385
interface system

Variable Description Default

ip6-retrans-time Enter the number to be added to the Retrans Timer field in the 0
<retrans_msecs> router advertisements. Entering 0 means that the Retrans
Timer is not specified.
This is available in NAT/Route mode only.
ip6-send-adv Enable or disable the flag indicating whether or not to send disable
{enable | disable} periodic router advertisements and to respond to router
solicitations.
This is available in NAT/Route mode only.
edit <ipv6_prefix> variables
autonomous-flag Set the state of the autonomous flag for the IPv6 prefix. Enter disable
{enable | disable} one of:
• enable
• disable
onlink-flag Set the state of the on-link flag ("L-bit") in the IPv6 prefix. Enter
{enable | disable} one of:
• enable
• disable
preferred-life-time Enter the preferred lifetime, in seconds, for this IPv6 prefix. 604800
<seconds>
valid-life-time Enter the valid lifetime, in seconds, for this IPv6 prefix. 2592000
<seconds>
variables for ADSL interface (model 60ADSL only)
These variables are available only when type is adsl
gwaddr <IPv4> Enter the IP address of the gateway for this interface.
mux-type { llc-encaps | Enter the MUX type as either llc-encaps or vc-encaps.
vc-encaps} This information is provided by your ISP.
vci <integer> Enter the virtual circuit identification VCI number. Valid numbers 0
are from 0 to 255. This number is provided by your ISP.
vpi <integer> Enter the virtual circuit identification VPI number. Valid numbers 35
are from 0 to 65535. This number is provided by your ISP.
variables for aggregate and redundant interfaces (models 300A, 400A, 500A, and 800 or higher)
These variables are available only when type is aggregate or redundant.
algorithm {L2 | L3 | L4} Enter the algorithm used to control how frames are distributed L4
across links in an aggregated interface. The choice of algorithm
determines what information is used to determine frame
distribution. Enter one of:
• L2 - use source and destination MAC addresses
• L3 - use source and destination IP addresses, fall back to L2
algorithm if IP information is not available
• L4 - use TCP, UDP or ESP header information
lacp-ha-slave This option affects how the aggregate interface participates in enable
{enable | disable} Link Aggregation Control Protocol (LACP) negotiation when HA
is enabled for the VDOM. It takes effect only if Active-Passive
HA is enabled and lacp-mode is not static. Enter enable
to participate in LACP negotiation as a slave or disable to
not participate.
lacp-mode {active | Enter one of active, passive, or static. active
passive | static} • active - send LACP PDU packets to negotiate link
aggregation connections. This is the default.
• passive - respond to LACP PDU packets and negotiate
link aggregation connections
• static - link aggregation is configured statically

FortiGate CLI Version 3.0 MR6 Reference

386 01-30006-0015-20080205
system interface

Variable Description Default

lacp-speed {fast | slow} Enter slow to send LACP PDU packets every 30 seconds to slow
negotiate link aggregation connections. This is the default.
Enter fast to send LACP PDU packets every second, as
recommended in the IEEE 802.3ad standard.
This is available only on FortiGate models 800 and higher when
type is aggregate.
member Specify a list of physical interfaces that are part of an aggregate No default.
<if_name1> <if_name2> or redundant group. To modify a list, enter the complete revised
... list.
If VDOMs are enabled, then vdom must be set the same for
each interface before you enter the member list.
An interface is available to be part of an aggregate or
redundant group only if
• it is a physical interface, not a VLAN interface
• it is not already part of an aggregated or redundant interface
• it is in the same VDOM as the aggregated interface
• it has no defined IP address and is not configured for DHCP
or PPPoE
• it has no DHCP server or relay configured on it
• it does not have any VLAN subinterfaces
• it is not referenced in any firewall policy, VIP, IP Pool or
multicast policy
• it is not an HA heartbeat device or monitored by HA
In a redundant group, failover to the next member interface
happens when the active interface fails or is disconnected.
The order you specify the interfaces in the member list is the
order they will become active in the redundant group. For
example if you enter set member port5 port1, then port5
will be active at the start, and when it fails or is disconnected
port1 will become active.
This is available only when type is aggregate or
redundant.

Example
This example shows how to set the FortiGate-300 internal interface IP address and netmask to
192.168.100.159 255.255.255.0, and the management access to ping, https, and ssh.
config system interface
edit internal
set allowaccess ping https ssh
set ip 192.168.110.26 255.255.255.0
end
This example shows how to add a loopback interface with a name of loop1. The IP address is set to
10.0.0.10 255.255.255.0 and bfd is set to global. Any traffic sent to this interface will be dropped, as it
is a blackhole route.
config system interface
edit loop1
set type loopback
set ip 10.0.0.10 255.255.255.0
set bfd global
end

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 387
interface system

This example shows how to add a secondary IP address and netmask of 192.176.23.180
255.255.255.0 to the internal interface. Also configure ping and https management access to
this secondary IP address. You can not add a secondary IP that is part of the subnet of the original
interface IP address.
config system interface
edit internal
config secondaryip
edit 1
set allowaccess ping https
set ip 192.176.23.180 255.255.255.0
end
end

History

FortiOS v2.80 Substantially revised. IPv6 added.

FortiOS v2.80 MR2 Added netbios-forward, wins-ip keywords.
Removed zone keyword, moved to system zone.
FortiOS v2.80 MR3 Added defaultgw keyword.
FortiOS v2.80 MR6 Added mtu-override keyword.
FortiOS v3.0 Added ident-accept keyword.
FortiOS v3.0 MR1 Added <pingserver2_ip4> to detectserver, aggregate and redundant to type
keyword, added pppoe-unnumbered-negotiate and priority keywords.
FortiOS v3.0 MR3 DDNS retry interval increased to after 3 failed attempts. Added wifi-auth, wifi-
encrypt, and show-backplane-intf keywords. Removed defaultgw keyword.
FortiOS v3.0 MR4 Added bfd, bfd-desired-min-tx, bfd-detect-mult, bfd-required-min-rx
keywords.
FortiOS v3.0 MR5 Added peer-interface, loopback type, alias, fp-anomaly, icmp-redirect,
and mediatype. Changes to parameters of auth-type.
FortiOS v3.0 MR6 Changed gateway_address to gwaddr, and lcp-max-echo-failures to lcp-max-
echo-fail. Changed ipv6-allowaccess parameters. Added pptp variables, and
mpls keyword (FortiOS Carrier only). Added the ha-priority keyword. Removed all
lt2p-client commands, and connection command.

FortiGate CLI Version 3.0 MR6 Reference

388 01-30006-0015-20080205
system ipv6-tunnel

ipv6-tunnel
Use this command to tunnel IPv6 traffic over an IPv4 network.
The IPv6 interface is configured under config system interface.

Note: This command is not available in Transparent mode.

Syntax
config system ipv6-tunnel
edit <tunnel_name>
set destination <tunnel_address>
set interface <name>
set ip6 <address_ipv6>
set source <address_ipv4>
end
Variables Description Default
edit <tunnel_name> Enter a name for the IPv6 tunnel. No default.
destination The destination IPv4 address for this tunnel. 0.0.0.0
<tunnel_address>
interface <name> The interface used to send and receive traffic for this tunnel. No default.
ip6 <address_ipv6> The IPv6 address for this tunnel. No default.
source <address_ipv4> The source IPv4 address for this tunnel. 0.0.0.0

Example
Use the following commands to set up an IPv6 tunnel.
config system ipv6-tunnel
edit test_tunnel
set destination 10.10.10.1
set interface internal
set ip6 12AB:0:0:CD30::/60
set source 192.168.50.1
end

History

FortiOS v2.80 New.

FortiOS v3.0 Changed from ipv6_tunnel to ipv6-tunnel.
FortiOS v3.0 MR1 Removed vdom keyword.
FortiOS v3.0 MR2 Added command syntax for multiple-vdom mode. Removed ipv6 and
mode keywords.
FortiOS v3.0 MR5 Added ip6

Related topics
• system interface

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 389
mac-address-table system

mac-address-table
Use this command to create a static MAC table. The table can hold up to 200 entries.
This command is available in Transparent mode only.

Syntax
config system mac-address-table
edit <mac-address_hex>
set interface <if_name>
end
Keywords and variables Description Default
edit <mac-address_hex> Enter the MAC address as six pairs of hexadecimal digits No
separated by colons, e.g.: 11:22:33:00:ff:aa default.
interface <if_name> Enter the name of the interface to which this MAC table entry No
applies. default.

Example
Use the following commands to add a static MAC entry for the internal interface.
config system mac-address-table
edit 11:22:33:00:ff:aa
set interface internal
end

History

FortiOS v2.80 Renamed and Revised. Formerly set system brctl.

FortiGate CLI Version 3.0 MR6 Reference

390 01-30006-0015-20080205
system management-tunnel

management-tunnel
Use this command to configure the remote management tunnel and which remote management
actions the FortiGate unit will allow from either the FortiManager unit or FortiGuard Management
Service.
To complete remote management setup with a FortiManager unit or FortiGuard Management Service,
also configure their required settings, such as providing the service account ID or defining the IP
address of the FortiManager unit. For details, see “system fortiguard” on page 342 or “system
fortimanager” on page 347.

Syntax
config system management-tunnel
set allow-collect-statistics {enable | disable}
set allow-config-restore {enable | disable}
set allow-push-configuration {enable | disable}
set allow-push-firmware {enable | disable}
set authorized-manager-only {enable | disable}
set serial-number <serial_str>
set status {enable | disable}
end
Variables Description Default
allow-collect-statistics Enable or disable real-time monitor SNMP polls through enable
{enable | disable} the tunnel.
This option appears only if status is enable.
allow-config-restore Enable or disable remote restoration of a previous enable
{enable | disable} configuration.
This option appears only if status is enable.
allow-push-configuration Enable or disable remote configuration. enable
{enable | disable} This option appears only if status is enable.
allow-push-firmware {enable Enable or disable remote firmware upgrades. enable
| disable} This option appears only if status is enable.
authorized-manager-only Enable or disable remote management only by the disable
{enable | disable} FortiManager unit with the specified serial number. Also
configure serial-number.
This option appears only if status is enable.
serial-number <serial_str> Enter up to five serial numbers of FortiManager unit that No default.
are authorized to remotely manage this FortiGate unit.
Separate multiple serial numbers with a space.
This option appears only if status and authorized-
manager-only is enable.
status {enable | disable} Enable or disable the SSL-secured management tunnel. enable
If ipsec is enable in config system fortimanager,
the FortiGate unit will use the IPSec tunnel and will not
apply SSL to the management connection.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 391
management-tunnel system

Example
This example shows how to configure the remote management tunnel to accept connections only from
the FortiManager unit whose serial number is FMG-3K2404400063, and to allow that FortiManager
unit to collect real-time monitor (SNMP) information, but not to permit remote firmware upgrades.
config system fortimanager
set ip 172.168.2.10
set central-mgmt-scheduled-cfg-restore enable
set central-mgmt-auto-backup disable
end
config system management-tunnel
set status enable
set authorized-manager-only enable
set serial-number FMG-3K2404400063
set allow-collect-statistics enable
set allow-push-firmware disable
end

History

FortiOS v3.0 MR6 New command. Configures remote management tunnel and actions allowed from the
FortiGuard Management Service or FortiManager unit.

Related topics
• system fortiguard
• system fortimanager

FortiGate CLI Version 3.0 MR6 Reference

392 01-30006-0015-20080205
system modem

modem
Use this command to configure a FortiGate-60M modem or a serial modem interface connected using
a serial converter to the FortiGate 50A or FortiGate-60 USB port.
You can add the information to connect to up to three dialup accounts. The FortiGate-60 or FortiGate-
60M unit modem interface can act as a backup interface for one of the FortiGate ethernet interfaces or
as a standalone dialup interface.
These commands are available in NAT/Route mode only and apply only to models 50A, 60, 60M and
60-WiFi.

Syntax
config system modem
set altmode {enable | disable}
set auto-dial {enable | disable}
set connect_timeout <seconds>
set dial-on-demand {enable | disable}
set distance <distance>
set holddown-timer <seconds>
set idle-timer <minutes>
set interface <name>
set mode {redudant | standalone}
set passwd1 <password_str>
set passwd2 <password_str>
set passwd3 <password_str>
set peer_modem1 {actiontec | ascendTNT | generic}
set peer_modem2 {actiontec | ascendTNT | generic}
set peer_modem3 {actiontec | ascendTNT | generic}
set phone1 <phone-number>
set phone2 <phone-number>
set phone3 <phone-number>
set priority <integer>
set redial <tries_integer>
set status {disable | enable}
set username1 <name_str>
set username2 <name_str>
set username3 <name_str>
end
Keywords and variables Description Default
altmode {enable | disable} Enable for installations using PPP in China. enable
auto-dial Enable to dial the modem automatically if the connection is disable
{enable | disable} lost or the FortiGate unit is restarted.
This is available only when dial-on-demand
is set to disabled, and mode is set to standalone.
connect_timeout <seconds> Set the connection completion timeout (30 - 255 seconds). 90
dial-on-demand Enable to dial the modem when packets are routed to the disable
{enable | disable} modem interface. The modem disconnects after the
idle-timer period.
This is available only if auto-dial is set to
disabled, and mode is set to standalone.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 393
modem system

Keywords and variables Description Default

distance <distance> Enter the administrative distance (1-255) to use for the 1
default route that is automatically added when the modem
connects and obtains an IP address. A lower distance
indicates a more preferred route. See also router static
“distance <distance>” on page 292
This keyword is useful for configuring redundant routes in
which the modem interface acts as a backup to another
interface.
holddown-timer <seconds> Used only when the modem is configured as a backup for 60
an interface. Set the time (1-60 seconds) that the FortiGate
unit waits before switching from the modem interface to the
primary interface, after the primary interface has been
restored.
This is available only when mode is set to redundant.
idle-timer <minutes> Set the number of minutes the modem connection can be 5
idle before it is disconnected.
This is available only if mode is set to standalone.
interface <name> Enter an interface name to associate the modem interface No default.
with the ethernet interface that you want to either back up
(backup configuration) or replace (standalone
configuration).
mode {redudant | Enter the required mode: standalone
standalone} • redundant
The modem interface automatically takes over from a
selected ethernet interface when that ethernet interface is
unavailable.
• standalone
The modem interface is the connection from the FortiGate
unit to the Internet.
passwd1 <password_str> Enter the password used to access the specified dialup No default.
account.
passwd2 <password_str> Enter the password used to access the specified dialup No default.
account.
passwd3 <password_str> Enter the password used to access the specified dialup No default.
account.
peer_modem1 If the modem at phone1 is Actiontec or AscendTNT, select generic
{actiontec | ascendTNT that type, otherwise leave setting as generic.
| generic} This setting applies to models 50AM, 60M and WiFi-60M
only.
peer_modem2 If the modem at phone2 is Actiontec or AscendTNT, select generic
{actiontec | ascendTNT that type, otherwise leave setting as generic.
| generic} This setting applies to models 50AM, 60M and WiFi-60M
only.
peer_modem3 If the modem at phone3 is Actiontec or AscendTNT, select generic
{actiontec | ascendTNT that type, otherwise leave setting as generic.
| generic} This setting applies to models 50AM, 60M and WiFi-60M
only.
phone1 Enter the phone number required to connect to the dialup No default.
<phone-number> account. Do not add spaces to the phone number. Make
sure to include standard special characters for pauses,
country codes, and other functions as required by your
modem to connect to your dialup account.
phone2 <phone-number> Enter the phone number required to connect to the dialup No default.
account. Do not add spaces to the phone number. Make
sure to include standard special characters for pauses,
country codes, and other functions as required by your
modem to connect to your dialup account.

FortiGate CLI Version 3.0 MR6 Reference

394 01-30006-0015-20080205
system modem

Keywords and variables Description Default

phone3 <phone-number> Enter the phone number required to connect to the dialup No default.
account. Do not add spaces to the phone number. Make
sure to include standard special characters for pauses,
country codes, and other functions as required by your
modem to connect to your dialup account.
priority <integer> Enter the priority of learned routes on this interface. 0
Valid priorities are from 0 to 4294967295.
redial <tries_integer> Set the maximum number of times (1-10) that the No default.
FortiGate unit dials the ISP to restore an active connection
on the modem interface. Select none to allow the modem
to redial without a limit.
status Enable or disable modem support. This is equivalent to disable
{disable | enable} bringing an interface up or down.
username1 <name_str> Enter the user name used to access the specified dialup No default.
account.
username2 <name_str> Enter the user name used to access the specified dialup No default.
account.
username3 <name_str> Enter the user name used to access the specified dialup No default.
account.

Example
This example shows how to enable the modem and configure the modem to act as a backup for the
WAN1 interface. Only one dialup account is configured. The FortiGate unit and modem will attempt to
dial this account 10 times. The FortiGate unit will wait 5 seconds after the WAN1 interface recovers
before switching back to the WAN1 interface.
config system modem
set action dial
set status enable
set holddown-timer 5
set interface wan1
set passwd1 acct1passwd
set phone1 1234567891
set redial 10
set username1 acct1user
end
This example shows how to display the settings for the modem command.
get system modem
This example shows how to display the configuration for the modem command.
show system modem

History

Related topics
• system interface

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 395
npu system

npu
Use this command to configure the Network Processing Unit (NPU) for FortiGate units that support
FB4.

Note: If you use the traffic-shaping-mode command, the bidirection option counts twice as much
traffic. You need to allow twice the bandwidth as with unidirection.

Syntax
config system npu
set enc-offload-antireplay {enable | disable}
set dec-offload-antireplay {enable | disable}
set offload-ipsec-host {enable | disable}
set traffic-shaping-mode {unidirection | bidirection}
next
end
Variables Description Default
enc-offload-antireplay Enable this option for the system to offload IPSEC disable
{enable | disable} packet encryption to FB4 when the egress port of the
tunnel is on FB4.
dec-offload-antireplay Enable this option for the system to offload IPSEC enable
{enable | disable} packet encryption to FB4 when the ingress port of the
tunnel is on FB4.
offload-ipsec-host Enable this option for the system to offload packet disable
{enable | disable} encryption to FB4 when the egress port of this packet
is on FB4.
traffic-shaping-mode Select the fast path bandwidth calculation method.
{unidirection | bidirection} In unidirection, traffic in each direction is counted
separately. In bidirection the traffic in both
directions is counted at the same time.
The default value on 3600A models is
bidirection.
The default value on 3810B models is
unidirection.

History

FortiOS v3.0 MR5 New.

FortiGate CLI Version 3.0 MR6 Reference

396 01-30006-0015-20080205
system proxy-arp

proxy-arp
Use this command to add IP addresses to MAC address translation entries to the proxy ARP table.

Syntax
config system proxy-arp
edit <table_entry>
set interface <port>
set ip <ipv4_address>
next
end
Variables Description Default
edit <table_entry> Enter the unique ID of the table entry to add or No default.
modify.
interface <port> Enter the physical port this IP will be associated with. No default.
ip <ipv4_address> Enter the IP address to associate with this physical No default.
port.

History

FortiOS v3.0 MR2 New.

Related topics
• system arp-table
• get router info bgp

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 397
replacemsg admin system

replacemsg admin
Use this command to change the administration disclaimer page.
These are HTML messages with HTTP headers.

Note: If you unset the buffer for a replacement message, it will be cleared.

Syntax
config system replacemsg admin admin_disclaimer_text
set buffer <message>
set format <format>
set header <header_type>
end
Variable Description Default
buffer <message> Type a new replacement message to replace the current replacement Depends on
message. Maximum length 8 192 characters. message
type.
format <format> Set the format of the message: No default
• html
• text
• none
header Set the format of the message header: Depends on
<header_type> • 8bit message
• http type.
• none

Replacement messages can include replacement message tags. When users receive the replacement
message, the replacement message tag is replaced with content relevant to the message. Generally
there is not a large call for these tags in disclaimer pages.

Table 6: Replacement message tags

Tag Description
%%AUTH_REDIR_URL%% Link to open a new window. (optional).
%%AUTH_LOGOUT%% Immediately close the connection policy.
%%KEEPALIVEURL%% URL the keep alive page connects to that keeps the connection policy alive. Connects
every %%TIMEOUT%% seconds.
%%TIMEOUT%% Configured number of seconds between %%KEEPALIVEURL%% connections.

History

FortiOS v3.0 MR4 New command.

FortiGate CLI Version 3.0 MR6 Reference

398 01-30006-0015-20080205
system replacemsg alertmail

replacemsg alertmail
Alertmail can be configured to alert users or admins about important system events such as blocked
files or viruses detected.
Use this command to change the alertmail pages including:
• the block message that alerts users a file transfer was blocked
• the critical firewall event message
• the hard disk log is full message
• the nids event message to notify a network intrusion event has occurred
• the virus message to indicate that a message was found
These are HTML messages with HTTP headers.

Note: If you unset the buffer for a replacement message, it will be cleared.

Syntax
config system replacemsg alertmail auth_msg_type
set buffer <message>
set format <format>
set header <header_type>
end
Variable Description Default
auth_msg_type FortiGuard replacement alertmail message type. One of: No default
alertmail- A file download was blocked.
block Default message includes name of file.
alertmail- A critical firewall event occurred.
crit-event Default message includes the event type.
alertmail- The hard disk log is full.
disk-full
alertmail- An intrusion event occurred.
nids-event Default message includes the intrusion type.
alertmail- A virus or worm was detected.
virus Default message includes the virus or worm type.
buffer <message> Type a new replacement message to replace the current replacement Depends on
message. Maximum length 8 192 characters. message
type.
format <format> Set the format of the message: No default
• html
• text
• none
header Set the format of the message header: Depends on
<header_type> • 8bit message
• http type.
• none

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 399
replacemsg alertmail system

Replacement messages can include replacement message tags. When users receive the replacement
message, the replacement message tag is replaced with content relevant to the message.

Table 7: Replacement message tags

Tag Description
%%FILE%% The name of a file that has been removed from a content stream. This could be a file
that contained a virus or was blocked by antivirus file blocking. %%FILE%% can be
used in virus and file block messages.
%%VIRUS%% The name of a virus that was found in a file by the antivirus system. %%VIRUS%% can
be used in virus messages
%%URL%% The URL of a web page. This can be a web page that is blocked by web filter content
or URL blocking. %%URL%% can also be used in http virus and file block messages to
be the URL of the web page from which a user attempted to download a file that is
blocked.
%%CRITICAL_EVENT%% Added to alert email critical event email messages. %%CRITICAL_EVENT%% is
replaced with the critical event message that triggered the alert email.
%%PROTOCOL%% The protocol (HTTP, FTP, POP3, IMAP, SMTP) in which a virus was detected.
%%PROTOCOL%% is added to alert email virus messages.
%%SOURCE_IP%% IP address of the email server that sent the email containing the virus.
%%DEST_IP%% IP address of the user’s computer that attempted to download the message from
which the file was removed.
%%EMAIL_FROM%% The email address of the sender of the message from which the file was removed.
%%EMAIL_TO%% The email address of the intended receiver of the message from which the file was
removed.
%%NIDS_EVENT%% The IPS attack message. %%NIDS_EVENT%% is added to alert email intrusion
messages.

Example
The default message for a detected virus is:
Virus/Worm detected: %%VIRUS%% Protocol: %%PROTOCOL%% Source IP: %%SOURCE_IP%%
Destination IP: %DST_IP%% Email Address From: %%EMAIL_FROM%% Email Address To:
%%EMAIL_TO%%

History

FortiOS v2.8 New command.

FortiOS v3.0 MR2 Command removed.
FortiOS v3.0 MR3 Command added. Replacement messages increased in size from 4 096 to 8 192 bytes per
message.

FortiGate CLI Version 3.0 MR6 Reference

400 01-30006-0015-20080205
system replacemsg auth

replacemsg auth
Use this command to change the authentication pages including:
• the challenge page that prompts users for additional verification past initial login information
• the disclaimer page that notifies users when they are leaving the protected network
• the keepalive page that keeps a session open by renewing the connection at a set interval
• the failed login page that informs the user of their failed attempt to authenticate themselves and
provides the login prompt for them to try again
• the login page presented to users who must authenticate themselves to use firewall policies or
VPNs
• the reject page that is displayed when the user rejects the disclaimer page
These are HTML messages with HTTP headers.

Note: If you unset the buffer for a replacement message, it will be cleared.

Syntax
config system replacemsg auth auth_msg_type
set buffer <message>
set format <format>
set header <header_type>
end
Variable Description Default
auth_msg_type FortiGuard replacement message type. One of: No default
auth- Challenges the user with a question.
challenge-
page
auth- Prompts user to accept the displayed disclaimer
disclaimer[ when leaving protected network.
1| 2| 3] The extra pages seamlessly extend the size of the
page from 8 192 characters up 16 384 and 24 576
characters respectively.
auth- Keeps a session open by connecting to renew the
keepalive- connection policy.
page Closing the page will timeout the connection.
auth-login- Displays after user fails to login. This page includes a
failed-page failed login message and a login prompt.
auth-login- Prompts the user for their username and password to
page login.
auth-reject- Displays when user rejects the disclaimer page.
page
buffer <message> Type a new replacement message to replace the current replacement Depends on
message. Maximum length 8 192 characters. message
type.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 401
replacemsg auth system

Variable Description Default

format <format> Set the format of the message: No default
• html
• text
• none
header Set the format of the message header: Depends on
<header_type> • 8bit message
• http type.
• none
Replacement messages can include replacement message tags. When users receive the replacement
message, the replacement message tag is replaced with content relevant to the message.

Table 8: Replacement message tags

Tag Description
%%AUTH_REDIR_URL%% Link to open a new window. (optional).
%%AUTH_LOGOUT%% Immediately close the connection policy.
%%FAILED_MESSAGE%% Message displayed on failed login page after user login fails.
%%KEEPALIVEURL%% URL the keep alive page connects to that keeps the connection policy alive.
Connects every %%TIMEOUT%% seconds.
%%QUESTION%% The default login and rejected login pages use this text immediately preceding the
username and password fields. the default challenge page uses this as the challenge
question. These are treated as two different variables by the server.
If you want to use different text, replace %%QUESTION%% with the text that you prefer.
%%TIMEOUT%% Configured number of seconds between %%KEEPALIVEURL%% connections.
%%USERNAMEID%% Username of the user logging in. This tag is used on the login and failed login pages.
%%PASSWORDID%% Password of the user logging in. This tag is used on the challenge, login and failed
login pages.

Requirements for login page

The authentication login page is linked to FortiGate functionality and you must construct it according to
the following guidelines to ensure that it will work.
• The login page must be an HTML page containing a form with ACTION="/" and METHOD="POST"
• The form must contain the following hidden controls:
•<INPUT TYPE="hidden" NAME="%%MAGICID%%" VALUE="%%MAGICVAL%%">
•<INPUT TYPE="hidden" NAME="%%STATEID%%" VALUE="%%STATEVAL%%">
•<INPUT TYPE="hidden" NAME="%%REDIRID%%" VALUE="%%PROTURI%%">
• The form must contain the following visible controls:
•<INPUT TYPE="text" NAME="%%USERNAMEID%%" size=25>
•<INPUT TYPE="password" NAME="%%PASSWORDID%%" size=25>

Example
This example shows how to change the authentication login page. You enter the web page content as
one long quoted string, using the backslash (“\”) character at the end of each line to continue the text
on the next line.

FortiGate CLI Version 3.0 MR6 Reference

402 01-30006-0015-20080205
system replacemsg auth

config system replacemsg auth auth-login-page

set buffer "<html><head> \
<title>Firewall Authentication</title> \
</head> \
<body><h4>You must authenticate to use this service.</h4> \
<form action="/" method="post"> \
<input name="%%MAGICID%%" value="%%MAGICVAL%%" type="hidden"> \
<table align="center" bgcolor="#00cccc" border="0" \
cellpadding="15" cellspacing="0" width="320"><tbody> \
<tr><th>Username:</th> \
<td><input name="%%USERNAMEID%%" size="25" type="text"></td></tr> \
<tr><th>Password:</th> \
<td><input name="%%PASSWORDID%%" size="25" type="password"></td> \
</tr><tr><td colspan="2" align="center" bgcolor="#00cccc"> \
<input name="%%STATEID%%" value="%%STATEVAL%%" type="hidden"> \
<input name="%%REDIRID%%" value="%%PROTURI%%" type="hidden"> \
<input value="Continue" type="submit"></td></tr></tbody></table> \
</font></form></body></html>"
set format html
set header http
end

History

FortiOS v3.0 auth category added.

FortiOS v3.0 MR2 Added auth-challenge-page, auth-disclaimer[1|2|3]-page, auth-
keepalive-page, auth-loginfailed-page and auth-reject-page keywords.
FortiOS v3.0 MR3 Replacement messages increased in size from 4 096 to 8 192 bytes per message.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 403
replacemsg fortiguard-wf system

replacemsg fortiguard-wf
Use this command to change the default messages that replace a web pages that FortiGuard web
filtering has blocked.
By default, these are a HTML messages.

Note: If you unset the buffer for a replacement message, it will be cleared.

Syntax
config system replacemsg fortiguard-wf <fortiguard_msg_type>
set buffer <message>
set format <format>
set header <header_type>
end
Variable Description Default
<fortiguard_msg_type> FortiGuard replacement message type. One of: No default.
ftgd-block FortiGuard blocked a web page.
ftgd-ovrd FortiGuard override form.
http-err An error occurred when accessing the web
page.
buffer <message> Type a new replacement message to replace the current Depends on
replacement message. Maximum length 8 192 characters. message type.
format <format> Set the format of the message, one of: html
• html
• text
• none
header <header_type> Set the format of the message header: http
• 8bit
• http
• none.

Replacement messages can include replacement message tags. When users receive the replacement
message, the replacement message tag is replaced with content relevant to the message.

Table 9: Replacement message tags

Tag Description
%%URL%% The URL of a web page. This can be a web page that is blocked by web filter content
or URL blocking. %%URL%% can also be used in http virus and file block messages to
be the URL of the web page from which a user attempted to download a file that is
blocked.

History

FortiOS v2.80 New

FortiOS v2.80 MR2 Changed cerb keyword to catblock.

FortiGate CLI Version 3.0 MR6 Reference

404 01-30006-0015-20080205
system replacemsg fortiguard-wf

FortiOS v3.0 IM category added.

Changed:
fortiguard_wf to fortiguard-wf
ftgd_block to ftgd-block
ftgd_ovrd to ftgd-ovrd
http_err to http-err
FortiOS v3.0 MR3 Replacement messages increased in size from 4 096 to 8 192 bytes per message.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 405
replacemsg ftp system

replacemsg ftp
Use this command to change default replacement messages added to FTP sessions when the antivirus
engine blocks a file either because of a matching file pattern or because a virus is detected.
By default, these are text-format messages with no header.

Note: If you unset the buffer for a replacement message, it will be cleared.

Syntax
config system replacemsg ftp <message-type>
set buffer <message>
set format <format>
set header <header_type>
end
Variable Description Default
<message-type> FTP replacement message type. One of: No default.
ftp-dl-blocked Antivirus system blocks a file that
matches a file pattern.
ftp-dl-filesize Antivirus system blocks an oversize file
(one that is too large to scan).
ftp-dl-infected Antivirus system detects a virus in a file
being downloaded and blocks the file.
buffer <message> Type a new replacement message to replace the current Depends on
replacement message. Maximum length 8 192 characters. message type.
format <format> Set the format of the message, one of: text
• html
• text
• none
header <header_type> Set the format of the message header, one of: none
• 8bit
• http
• none.

FortiGate CLI Version 3.0 MR6 Reference

406 01-30006-0015-20080205
system replacemsg ftp

Replacement messages can include replacement message tags. When users receive the replacement
message, the replacement message tag is replaced with content relevant to the message.

Table 10: Replacement message tags

Tag Description
%%FILE%% The name of a file that has been removed from a content stream. This could be a file
that contained a virus or was blocked by antivirus file blocking. %%FILE%% can be
used in virus and file block messages.
%%VIRUS%% The name of a virus that was found in a file by the antivirus system. %%VIRUS%% can
be used in virus messages
%%QUARFILENAME%% The name of a file that has been removed from a content stream and added to the
quarantine. This could be a file that contained a virus or was blocked by antivirus file
blocking. %%QUARFILENAME%% can be used in virus and file block messages.
Quarantining is only available on FortiGate units with a local disk.
%%URL%% The URL of a web page. This can be a web page that is blocked by web filter content
or URL blocking. %%URL%% can also be used in http virus and file block messages to
be the URL of the web page from which a user attempted to download a file that is
blocked.
%%PROTOCOL%% The protocol (HTTP, FTP, POP3, IMAP, SMTP) in which a virus was detected.
%%PROTOCOL%% is added to alert email virus messages.
%%SOURCE_IP%% The IP address from which a virus was received. For email this is the IP address of the
email server that sent the email containing the virus. For HTTP this is the IP address
of the web page that sent the virus.
%%DEST_IP%% The IP address of the computer that would have received the blocked file. For email
this is the IP address of the user’s computer that attempted to download the message
from which the file was removed.

Example
This example shows how to change the message sent when an FTP download is oversize.
config system replacemsg ftp ftp-dl-filesize
set buffer "This file download was blocked because it is > 10MB."
end

History

FortiOS v2.80 New

FortiOS v3.0 MR3 Replacement messages increased in size from 4 096 to 8 192 bytes per message.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 407
replacemsg http system

replacemsg http
Use this command to change default replacement messages added to web pages when the antivirus
engine blocks a file in an HTTP session because of a matching file pattern or because a virus is detected; or when
web filter blocks a web page.

Note: If you unset the buffer for a replacement message, it will be cleared.

Syntax
config system replacemsg http <message-type>
set buffer <message>
set format <format>
set header <header_type>
end
Variable Description Default
<message-type> HTTP replacement message type, one of: No default.
bannedword The web filter banned word list
blocks a web page.
http-block The antivirus system blocks a
file that matches a file pattern.
http-client-bannedword The antivirus system blocks a
file that matches a file pattern.
http-client-block The antivirus system blocks a
file that matches a file pattern.
http-client-filesize The antivirus system blocks a
file that is too large to scan.
http-client-virus The antivirus system blocks a
file that contains a virus.
http-filesize The antivirus system blocks a
file that is too large to be virus
scanned.
http-virus The antivirus system blocks a
file that contains a virus.
infcache-block The antivirus system blocks a
URL that has a previously
discovered virus.
url-block Web filter URL blocking blocks
a web page.
buffer <message> Type a new replacement message to replace the current Depends on
replacement message. Maximum length 8 192 characters. message type.
format <format> Set the format of the message, one of: html
• html
• text
• none
header <header_type> Set the format of the message header, one of: http
• 8bit
• http
• none

FortiGate CLI Version 3.0 MR6 Reference

408 01-30006-0015-20080205
system replacemsg http

Replacement messages can include replacement message tags. When users receive the replacement
message, the replacement message tag is replaced with content relevant to the message.

Table 11: Replacement message tags

Tag Description
%%FILE%% The name of a file that has been removed from a content stream. This could be a file
that contained a virus or was blocked by antivirus file blocking. %%FILE%% can be
used in virus and file block messages.
%%VIRUS%% The name of a virus that was found in a file by the antivirus system. %%VIRUS%% can
be used in virus messages
%%QUARFILENAME%% The name of a file that has been removed from a content stream and added to the
quarantine. This could be a file that contained a virus or was blocked by antivirus file
blocking. %%QUARFILENAME%% can be used in virus and file block messages.
Quarantining is only available on FortiGate units with a local disk.
%%URL%% The URL of a web page. This can be a web page that is blocked by web filter content
or URL blocking. %%URL%% can also be used in http virus and file block messages to
be the URL of the web page from which a user attempted to download a file that is
blocked.
%%PROTOCOL%% The protocol (HTTP, FTP, POP3, IMAP, SMTP) in which a virus was detected.
%%PROTOCOL%% is added to alert email virus messages.
%%SOURCE_IP%% The IP address of the web page from which a virus was received.
%%DEST_IP%% The IP address of the computer that would have received the blocked file. For email
this is the IP address of the user’s computer that attempted to download the message
from which the file was removed.

Example
This example shows how to change the message that replaces a web page blocked for banned words.
config system replacemsg http http-client-bannedword
set buffer "This web page was blocked. It contains banned words."
end

History

FortiOS v2.80 New

FortiOS v3.0 MR2 Added infcache-block replacemsg.
FortiOS v3.0 MR3 Replacement messages increased in size from 4 096 to 8 192 bytes per message.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 409
replacemsg im system

replacemsg im
Use this command to change default replacement messages added to instant messaging and peer-to-peer
sessions when either file-transfer or voice-chat is blocked.
By default, these are text messages with an 8-bit header.

Note: If you unset the buffer for a replacement message, it will be cleared.

Syntax
config system replacemsg im <message-type>
set buffer <message>
set format <format>
set header <header_type>
end

Variable Description Default

<message-type> im replacement message type, one of: No default.
im-file-xfer-block The IM system blocks a file
transfer.
im-file-xfer-infected The IM system blocks a virus-
infected file.
im-file-xfer-name The IM system blocks a file
due to file block list.
im-file-xfer-size The IM system blocks an
oversize file.
im-photo-share-block The IM system blocks a photo-
sharing request.
im-voice-chat-block The IM system blocks voice
chat.
buffer <message> Type a new replacement message to replace the current Depends on
replacement message. Maximum length 8 192 characters. message type.
format <format> Set the format of the message, one of: text
• html
• text
• none
header <header_type> Set the format of the message header, one of: 8bit
• 8bit
• http
• none

FortiGate CLI Version 3.0 MR6 Reference

410 01-30006-0015-20080205
system replacemsg im

Replacement messages can include replacement message tags. When users receive the replacement
message, the replacement message tag is replaced with content relevant to the message.

Table 12: Replacement message tags

Tag Description
%%FILE%% The name of a file that has been removed from a content stream. This could be a file
that contained a virus or was blocked by antivirus file blocking. %%FILE%% can be
used in virus and file block messages.
%%VIRUS%% The name of a virus that was found in a file by the antivirus system. %%VIRUS%% can
be used in virus messages
%%QUARFILENAME%% The name of a file that has been removed from a content stream and added to the
quarantine. This could be a file that contained a virus or was blocked by antivirus file
blocking. %%QUARFILENAME%% can be used in virus and file block messages.
Quarantining is only available on FortiGate units with a local disk.
%%PROTOCOL%% The protocol (HTTP, FTP, POP3, IMAP, SMTP) in which a virus was detected.
%%PROTOCOL%% is added to alert email virus messages.
%%SOURCE_IP%% The IP address from which a virus was received. For email this is the IP address of the
email server that sent the email containing the virus. For HTTP this is the IP address
of the web page that sent the virus.
%%DEST_IP%% The IP address of the computer that would have received the blocked file. For email
this is the IP address of the user’s computer that attempted to download the message
from which the file was removed.

Example
This example shows how to change the message added to instant messaging sessions when voice
chat is blocked.
config system replacemsg im im-voice-chat-block
set buffer "Use of chat applications is not permitted."
end

History

FortiOS v2.80 New

FortiOS v3.0 IM category added.
FortiOS v3.0 MR3 Replacement messages increased in size from 4 096 to 8 192 bytes per message.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 411
replacemsg mail system

replacemsg mail
Use this command to change default replacement messages added to email messages when the antivirus
engine blocks a file either because of a matching file pattern or because a virus is detected; or when spam filter
blocks an email.
By default, these are text messages with an 8-bit header.

Note: If you unset the buffer for a replacement message, it will be cleared.

Syntax
config system replacemsg mail <message-type>
set buffer <message>
set format <format>
set header <header_type>
end

Variable Description Default

<message-type> mail replacement message type, one of: No default.
email-block The antivirus system blocks a file that
matches a file pattern.
email-filesize The antivirus system blocks an email
message that is too large to be virus
scanned.
email-virus The antivirus system deletes a file from
an email messages that contains a
virus.
partial The FortiGate unit deletes a part of a
fragmented email message.
smtp-block The antivirus system blocks a file in an
SMTP email message that matches a
file pattern.
smtp-filesize The antivirus system blocks an SMTP
email message that is too large to be
virus scanned.
smtp-virus The antivirus system deletes a file from
an SMTP email messages that contains
a virus.
buffer <message> Type a new replacement message to replace the current Depends on
replacement message. Maximum length 8 192 characters. message type.
format <format> Set the format of the message, one of: text
• html
• text
• none
header <header_type> Set the format of the message header, one of: 8bit
• 8bit
• http
• none

FortiGate CLI Version 3.0 MR6 Reference

412 01-30006-0015-20080205
system replacemsg mail

Replacement messages can include replacement message tags. When users receive the replacement
message, the replacement message tag is replaced with content relevant to the message.

Table 13: Replacement message tags

Tag Description
%%FILE%% The name of a file that has been removed from a content stream. This could be a file
that contained a virus or was blocked by antivirus file blocking. %%FILE%% can be
used in virus and file block messages.
%%VIRUS%% The name of a virus that was found in a file by the antivirus system. %%VIRUS%% can
be used in virus messages
%%QUARFILENAME%% The name of a file that has been removed from a content stream and added to the
quarantine. This could be a file that contained a virus or was blocked by antivirus file
blocking. %%QUARFILENAME%% can be used in virus and file block messages.
Quarantining is only available on FortiGate units with a local disk.
%%PROTOCOL%% The protocol (HTTP, FTP, POP3, IMAP, SMTP) in which a virus was detected.
%%PROTOCOL%% is added to alert email virus messages.
%%SOURCE_IP%% IP address of the email server that sent the email containing the virus.
%%DEST_IP%% IP address of the user’s computer that attempted to download the message from
which the file was removed.
%%EMAIL_FROM%% The email address of the sender of the message from which the file was removed.
%%EMAIL_TO%% The email address of the intended receiver of the message from which the file was
removed.

Example
This example shows how to change the email message that is sent to test the alert email system.
config system replacemsg mail email-virus
set buffer "The attachment was blocked because it contains a virus."
end

History

FortiOS v2.80 New

FortiOS v3.0 MR3 Replacement messages increased in size from 4 096 to 8 192 bytes per message.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 413
replacemsg mm1 (FortiOS Carrier) system

replacemsg mm1 (FortiOS Carrier)

Use this command to change default replacement messages added to messages sent on the MM1 network
when the antivirus engine blocks a file either because of a matching file pattern or because a virus is detected; or
when spam filter blocks an email.

Syntax
config system replacemsg mm1 <message_type>
set add-smil {enable | disable}
set charset <character_set>
set class <class>
set format <format>
set from <from_address>
set from-sender {enable | disable}
set header <header_type>
set image <string>
set message <message_text>
set priority <priority>
set rsp-status <rsp_status>
set rsp-text <response_text>
set sender-visibility <sender_vis>
set smil-part <string>
set subject <subject_text>
end
Keywords and variable Description Default
<message_type> MM1 replacement message types, one of: No default.
• mm1-retr-conf-block
• mm1-retr-conf-bword
• mm1-retr-conf-sis-block
• mm1-retr-conf-virus
• mm1-send-conf-block
• mm1-send-conf-bword
• mm1-send-conf-sis-block
• mm1-send-conf-virus
• mm1-send-req-block
• mm1-send-req-bword
• mm1-send-req-sis-block
• mm1-send-req-virus
add-smil Enable to add SMIL content to the message. SMIL content can disable
{enable | disable} include images.
This keyword is available for the following message types:
• mm1-send-req-block
• mm1-send-req-bword
• mm1-send-req-sis-block
• mm1-send-req-virus
charset Character encoding used for replacement message, one of: utf-8
<character_set> • us-ascii
• utf-8

FortiGate CLI Version 3.0 MR6 Reference

414 01-30006-0015-20080205
system replacemsg mm1 (FortiOS Carrier)

class <class> The message can be classified as one of: automatic

• advertisement
• automatic
• informational
• not-included
• personal
format <format> Set the format of the message, one of: text
• html
• none
• text
• wml
Not all formats are supported by all message types.
from <from_address> Address the message is from. null
from-sender Enable for the notification message to be sent from the disable
{enable | disable} recipient. This is to avoid billing problems.
header <header_type> Set the format of the message header, one of: http
• 8bit
• http
• none
image <string> Enter the name of the image to include in the SMIL message
part. Using ‘?’ will show the list of available image names.
This is only available when add-smil is enabled.
message Text of the replacement message. Depends on
<message_text> message type.
priority <priority> Priority of the message, one of: normal
• high
• low
• normal
• not included
rsp-status Response status code, one of: err-
<rsp_status> • err-content-not-accepted content-
• err-msg-fmt-corrupt not-
accepted
• err-msg-not-found
• err-net-prob
• err-snd-addr-unresolv
• err-srv-denied
• err-unspecified
• err-unsupp-msg
• ok
rsp-text Response text. Depends on
<response_text> message type.
sender-visibility Sender visibility, one of: not-
<sender_vis> • hide specified
• not-specified
• show
smil-part <string> Enter the SMIL part of the replacement message.
subject Subject text string. Depends on
<subject_text> message type.

Example
This example shows how to set the message sent when a virus being sent by this user on the MM1
network. It uses the default message text.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 415
replacemsg mm1 (FortiOS Carrier) system

config system replacemsg mm1 mm1-send-conf-virus

set charset utf-8
set class automatic
set format text
set header none
set priority high
set rsp-status err-content-not-accepted
set subject “File you sent contains a virus”
set message "The message you sent has been blocked because the file
%%FILE%% in the message contains the virus %%VIRUS%%. The message
has been quarantined as %%QUARFILENAME%%."
end

History

FortiOS v3.0 New command.

FortiGate CLI Version 3.0 MR6 Reference

416 01-30006-0015-20080205
system replacemsg mm3 (FortiOS Carrier)

replacemsg mm3 (FortiOS Carrier)

Use this command to change default replacement messages added to messages sent on the MM3 network
when the antivirus engine blocks a file either because of a matching file pattern or because a virus is detected; or
when spam filter blocks an email.

Syntax
config system replacemsg mm3 <message_type>
set charset <character_set>
set format <format>
set from <from_address>
set header <header_type>
set message <message_text>
set priority <priority>
set subject <subject_text>
end
Keywords and variable Description Default
<message_type> MM3 replacement message types, one of: No default
• mm3-block
• mm3-block-notif
• mm3-bword
• mm3-bword-notif
• mm3-sis-block
• mm3-sis-block-notif
• mm3-sis-block-notif
• mm3-virus
• mm3-virus-block
charset Character encoding used for replacement messages, one of: utf-8
<character_set> • us-ascii
• utf-8
format <format> Replacement message format flag, one of: text
• html
• none
• text
• wml
from <from_address> Address the message is from. null
header <header_type> Set the format of the message header, one of: none
• 8bit
• http
• none
message Text of the replacement message. Depends on
<message_text> message type.
priority <priority> Priority of the message, one of: normal
• high
• low
• normal
• not included
subject Subject text string. Depends on
<subject_text> message type.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 417
replacemsg mm3 (FortiOS Carrier) system

Example
This example shows how to set the message sent when a user on the MM3 network sends one or
more viruses. It uses the default message text.
config system replacemsg mm3 mm3-virus
set charset utf-8
set class automatic
set format text
set header none
set priority high
set rsp-status err-content-not-accepted
set subject “Messages sent containing viruses”
set message "This device has sent %%NUM_MSG%% messages containing the
virus %%VIRUS%% in the last %%DURATION%% hours."
end

History

FortiOS v3.0 New command.

FortiGate CLI Version 3.0 MR6 Reference

418 01-30006-0015-20080205
system replacemsg mm4 (FortiOS Carrier)

replacemsg mm4 (FortiOS Carrier)

Use this command to change default replacement messages added to messages sent on the MM4 network
when the antivirus engine blocks a file either because of a matching file pattern or because a virus is detected; or
when spam filter blocks an email.

Syntax
config system replacemsg mm4 <message_type>
set charset <character_set>
set class <class>
set domain <address_domain>
set format <format>
set from <from_address>
set from-sender {enable | disable}
set header <header_type>
set image <string>
set message <message_text>
set priority <priority>
set rsp-status <rsp_status>
set smil-part <string>
set subject <subject_text>
end
Keywords and variables Description Default
<message_type> MM4 replacement message types, one of: No default
• mm4-block
• mm4-block-notif
• mm4-bword
• mm4-bword-notif
• mm4-sis-block
• mm4-sis-block-notif
• mm4-virus
• mm4-virus-block
add-smil Enable to add SMIL content to the message. SMIL content can disable
{enable | disable} include images.
This keyword is available for the following message types:
• mm4-block-notif
• mm4-bword-notif
• mm4-sis-block-notif
charset Character encoding used for replacement messages, one of: utf-8
<character_set> • us-ascii
• utf-8
class <class> The message can be classified as one of: automatic
• advertisement
• automatic
• informational
• not-included
• personal
domain The from address domain. null
<address_domain>

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 419
replacemsg mm4 (FortiOS Carrier) system

format <format> Replacement message format flag, one of: text

• html
• none
• text
• wml
from <from_address> Address the message is from. null
from-sender Enable for the notification message to be sent from the disable
{enable | disable} recipient. This is to avoid billing problems.
header <header_type> Set the format of the message header, one of: none
• 8bit
• http
• none
image <string> Enter the name of the image to include in the SMIL message
part. Using ‘?’ will show the list of available image names.
This is only available when add-smil is enabled.
message Text of the replacement message. Depends on
<message_text> message type.
priority <priority> Priority of the message, one of: normal
• high
• low
• normal
• not included
rsp-status Response status codes, one of: err-
<rsp_status> • err-content-not-accepted content-
• err-msg-fmt-corrupt not-
accepted
• err-net-prob
• err-snd-addr-unresolv
• err-srv-denied
• err-unspecified
• err-unsupp-msg
• ok
smil-part <string> Enter the SMIL part of the replacement message.
subject Subject text string. Depends on
<subject_text> message type.

Example
This example shows how to set the message sent when a user on the MM4 network sends one or
more viruses. It uses the default message text.
config system replacemsg mm4 mm4-virus-notif
set class automatic
set domain ‘’
set format text
set header none
set priority high
set subject “Messages sent containing viruses”
set message "This device has sent %%NUM_MSG%% messages containing the
virus %%VIRUS%% in the last %%DURATION%% hours."
end

History

FortiOS v3.0 New command.

FortiGate CLI Version 3.0 MR6 Reference

420 01-30006-0015-20080205
system replacemsg mm7 (FortiOS Carrier)

replacemsg mm7 (FortiOS Carrier)

Use this command to change default replacement messages added to messages sent on the MM7 network
when the antivirus engine blocks a file either because of a matching file pattern or because a virus is detected; or
when spam filter blocks an email.

Syntax
config system replacemsg mm7 <mm7message_type>
set add-smil {enable | disable}
set addr_type <addr_type>
set charset <character_set>
set class <class>
set format <format>
set from <from_address>
set from-sender {enable | disable}
set header <header_type>
set image <string>
set message <message_text>
set priority <priority>
set rsp-status <rsp_status>
set smil-part <string>
set subject <subject_text>
end
Keywords and variables Description Default
<mm7message_type> MM7 replacement message types, one of: No default
• mm7-block
• mm7-block-notif
• mm7-bword
• mm7-bword-notif
• mm7-sis-block
• mm7-sis-block-notif
• mm7-virus
• mm7-virus-block
add-smil Enable to add SMIL content to the message. SMIL content can disable
{enable | disable} include images.
This keyword is available for the following message types:
• mm7-block-notif
• mm7-bword-notif
• mm7-sis-block-notif
addr_type <addr_type> From address types, one of: number
• number
• rfc2882-addr
• short-code
charset Character encoding used for replacement messages, one of: utf-8
<character_set> • us-ascii
• utf-8
class <class> The message can be classified as one of: automatic
• advertisement
• automatic
• informational
• not-included
• personal

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 421
replacemsg mm7 (FortiOS Carrier) system

format <format> Replacement message format flag, one of: text

• html
• none
• text
• wml
from <from_address> Address the message is from. null
from-sender Enable for the notification message to be sent from the disable
{enable | disable} recipient. This is to avoid billing problems.
header <header_type> Set the format of the message header, one of: none
• 8bit
• http
• none
image <string> Enter the name of the image to include in the SMIL message
part. Using ‘?’ will show the list of available image names.
This is only available when add-smil is enabled.
message Text of the replacement message. Depends on
<message_text> message type.
priority <priority> Priority of the message, one of: normal
• high
• low
• normal
• not included
rsp-status Response status codes, one of: Depends on
<rsp_status> • addr-err message type.
• addr-not-found
• app-addr-not-supp
• app-denied
• app-id-not-found
• client-err
• content-refused
• gen-service-err
• improper-ident
• link-id-not-found
• msg-fmt-corrupt
• msg-id-not-found
• msg-rejected
• multiple-addr-not-supp
• not-possible
• oper-restrict
• partial-success
• repl-app-id-not-found
• service-denied
• service-err
• service-unavail
• srv-err
• success
• unsupp-oper
• unsupp-ver
• validation-err
smil-part <string> Enter the SMIL part of the replacement message.
subject Subject text string. Depends on
<subject_text> message type.

FortiGate CLI Version 3.0 MR6 Reference

422 01-30006-0015-20080205
system replacemsg mm7 (FortiOS Carrier)

Example
This example shows how to set the message sent when a user on the MM7 network sends one or
more viruses. It uses the default message text.
config system replacemsg mm7 mm7-virus-notif
set charset utf-8
set class automatic
set format text
set header none
set priority high
set rsp-status err-content-not-accepted
set subject “Messages sent containing viruses”
set message "This device has sent %%NUM_MSG%% messages containing the
virus %%VIRUS%% in the last %%DURATION%% hours."
end

History

FortiOS v3.0 New command.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 423
replacemsg nntp system

replacemsg nntp
Use this command to change the net news transfer protocol (NNTP) download pages including:
• NNTP download blocked
• NNTP download filesize error
• NNTP download infected
These are HTML messages with HTTP headers.

Note: If you unset the buffer for a replacement message, it will be cleared.

Syntax
config system replacemsg nntp auth_msg_type
set buffer <message>
set format <format>
set header <header_type>
end
Variable Description Default
auth_msg_type FortiGuard replacement alertmail message type. One of: No default
nntp-dl- A file being downloaded has been blocked, and
blocked quarantined.
nntp-dl- The article is larger than the configured size limit.
filesize
nntp-dl- An attached file has had a virus detected in it. The file
infected has been quarantined.
buffer <message> Type a new replacement message to replace the current replacement Depends on
message. Maximum length 8 192 characters. message
type.
format <format> Set the format of the message: No default
• html
• text
• none
header Set the format of the message header: Depends on
<header_type> • 8bit message
• http type.
• none

FortiGate CLI Version 3.0 MR6 Reference

424 01-30006-0015-20080205
system replacemsg nntp

Replacement messages can include replacement message tags. When users receive the replacement
message, the replacement message tag is replaced with content relevant to the message.

Table 14: Replacement message tags

Tag Description
%%FILE%% The name of a file that has been removed from a content stream. This could be a file
that contained a virus or was blocked by antivirus file blocking. The file may have been
quarantined if a virus was detected. %%FILE%% can be used in virus and file block
messages.
%%QUARFILENAME%% The name of a file that has been removed from a content stream and added to the
quarantine. This could be a file that contained a virus or was blocked by antivirus file
blocking. %%QUARFILENAME%% can be used in virus and file block messages.
Quarantining is only available on FortiGate units with a local disk.
%%VIRUS%% The name of a virus that was found in a file by the antivirus system. %%VIRUS%% can
be used in virus messages

Example
The default message for a detected virus is:
Virus/Worm detected: %%VIRUS%% Protocol: %%PROTOCOL%% Source IP: %%SOURCE_IP%%
Destination IP: %DST_IP%% Email Address From: %%EMAIL_FROM%% Email Address To:
%%EMAIL_TO%%

History

FortiOS v3.0 MR4 New command.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 425
replacemsg spam system

replacemsg spam
Use this command to change default replacement messages added to SMTP email messages when spam
filter blocks an email message. By default, these are text messages with an 8-bit header.

Note: If you unset the buffer for a replacement message, it will be cleared.

Syntax
config system replacemsg spam <message-type>
set buffer <message>
set format <format>
set header <header_type>
end

Variable Description Default

<message-type> spam replacement message type, one of: No default.
ipblocklist The spam filter IP address list
marked an email message as
reject or as spam.
reversedns Spam filtering return-email
DNS check identified a
message as spam.
smtp-spam-bannedword The spam filter email address
list marked an SMTP message
as spam.
smtp-spam-emailblack The spam filter email address
list marked an email as spam.
smtp-spam-feip FortiGuard-Spam blocked an
email based on its originating
IP address.
smtp-spam-fschksum Checksum is in the
FortiGuard- AntiSpam
checksum blacklist.
smtp-spam-fsurl FortiGuard-Spam blocked an
email based on its originating
URL.
smtp-spam-helo An email message is blocked
because the HELO/EHLO
domain is invalid.
smtp-spam-mimeheader The spam MIME headers list
marked a message as spam.
smtp-spam-rbl The spam filter DNSBL &
ORDBL list marked an email
message as reject or as spam.
submit The spam submit list marked
an email as spam.
buffer <message> Type a new replacement message to replace the current Depends on
replacement message. Maximum length 8 192 characters. message type.

FortiGate CLI Version 3.0 MR6 Reference

426 01-30006-0015-20080205
system replacemsg spam

Variable Description Default

format <format> Set the format of the message, one of: text
• html
• text
• none
header <header_type> Set the format of the message header, one of: 8bit
• 8bit
• http
• none
Replacement messages can include replacement message tags. When users receive the replacement
message, the replacement message tag is replaced with content relevant to the message.

Table 15: Replacement message tags

Tag Description
%%QUARFILENAME%% The name of a file that has been removed from a content stream and added to the
quarantine. This could be a file that contained a virus or was blocked by antivirus file
blocking. %%QUARFILENAME%% can be used in virus and file block messages.
Quarantining is only available on FortiGate units with a local disk.
%%SOURCE_IP%% The IP address from which a virus was received. For email this is the IP address of the
email server that sent the email containing the virus. For HTTP this is the IP address
of the web page that sent the virus.
%%DEST_IP%% The IP address of the computer that would have received the blocked file. For email
this is the IP address of the user’s computer that attempted to download the message
from which the file was removed.
%%EMAIL_FROM%% The email address of the sender of the message from which the file was removed.
%%EMAIL_TO%% The email address of the intended receiver of the message from which the file was
removed.

Example
This example shows how to change the message added to SMTP mail that the spam filter has
blocked.
config system replacemsg spam ipblocklist
set buffer "This email was blocked as spam."
end

History

FortiOS v2.80 New

FortiOS v3.0 MR2 Added smtp-spam-fschksum replacement message.
FortiOS v3.0 MR3 Replacement messages increased in size from 4 096 to 8 192 bytes per message.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 427
replacemsg sslvpn system

replacemsg sslvpn
Use this command to change the login page presented to SSL-VPN users.
This is an HTML message with an HTTP header.

Note: If you unset the buffer for a replacement message, it will be cleared.

Syntax
config system replacemsg sslvpn sslvpn-login
set buffer <message>
set format <format>
set header <header_type>
end
Variable Description Default
buffer <message> Type a new replacement message to replace the current Depends on
replacement message. Maximum length 8 192 characters. message type.
format <format> Set the format of the message: No default
• html
• text
• none
header <header_type> Set the format of the message header: Depends on
• 8bit message type.
• http
• none

Replacement messages can include replacement message tags. When users receive the replacement
message, the replacement message tag is replaced with content relevant to the message.

Requirements for login page

The SSL login page is linked to FortiGate functionality and you must construct it according to the
following guidelines to ensure that it will work.
• The login page must be an HTML page containing a form with ACTION="%%SSL_ACT%%" and
METHOD="%%SSL_METHOD%%"
• The form must contain the %%SSL_LOGIN%% tag to provide the logon form.
• The form must contain the %%SSL_HIDDEN%% tag.

History

FortiOS v3.0 sslvpn replacemsg category added.

FortiOS v3.0 MR3 Replacement messages increased in size from 4 096 to 8 192 bytes per message.

FortiGate CLI Version 3.0 MR6 Reference

428 01-30006-0015-20080205
system replacemsg-group (FortiOS Carrier)

replacemsg-group (FortiOS Carrier)

In FortiOS Carrier, replacement messages can be created and applied to specific protection profiles.
This allows the customization of messages for specific users or user groups. Users are assigned to a
group through the protection profile feature of firewall. See “firewall profile” on page 114 for more
information on protection profiles.
If a user is not part of a custom replacement message group, their replacement messages come from
the ‘default’ group. The ’default’ group always exists, and cannot be deleted. All additional replacement
message groups inherit from the default group. Any messages in custom groups that have not been
modified, inherit any changes to those messages in the default group.
The only replacement messages that can not be customized in groups are administration related
messages, which in the following categories:
• Alert Mail
• Administration
• Authentication
• IM and P2P
• SSL VPN
Except for mm1, mm3, mm4, mm7 which use the message keyword, all replacement message types
use the buffer keyword to refer to the body of the message.

Syntax
config system replacemsg_group
edit <groupname_string>
set comment <string>
config {fortiguard-wf | ftp | http | mail | mm1 | mm3 | mm4 | mm7 |
nntp | spam}
edit <msgkey_integer>
set msg-type <type>
set buffer <string>
set header <header_flag>
set format <format_flag>
set message <string>
end
end
Variable Description Default
edit <groupname_string> Create or edit a replacement message group.
comment <string> Enter a descriptive comment for this replacement
message group.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 429
replacemsg-group (FortiOS Carrier) system

Variable Description Default

config {fortiguard-wf | Select a replacement message type to add or edit. These
ftp | http | mail | mm1 | types or protocols, match with the existing replacemsg
mm3 | mm4 | mm7 | nntp | commands, and determine which msg-types are
available.
spam}
For more information on these replacement message
types see:
• “replacemsg fortiguard-wf” on page 404
• “replacemsg ftp” on page 406
• “replacemsg http” on page 408
• “replacemsg mail” on page 412
• “replacemsg mm1 (FortiOS Carrier)” on page 414
• “replacemsg mm3 (FortiOS Carrier)” on page 417
• “replacemsg mm4 (FortiOS Carrier)” on page 419
• “replacemsg mm7 (FortiOS Carrier)” on page 421
• “replacemsg nntp” on page 424
• “replacemsg spam” on page 426
edit <msgkey_integer> Create or edit a message entry in the table. Enter the key
of the entry.
Using ‘?’ will show you the existing message type as well
as the msgkey entries in the table.
msg-type <type> Select the message type for this message entry. Valid
message types vary according to which replacement
message table you are editing.
For a list of valid message types for this table, refer to the
CLI replacemsg command of the same name.
buffer <string> Enter the replacement message for this message type.
Enclose the message in quotes.
This keyword is used with the following replacement
messages:
• fortiguard-wf
• ftp
• http
• mail
• nntp
• spam
Other replacement messages use the message keyword.
header <header_flag> Select the header for this message. Valid types include:
• 8bit
• http
• none
format <format_flag> Select the format of this message. Valid formats include:
• html
• none
• text
• wml
message <string> Enter the replacement message for this message type.
Enclose the message in quotes.
This keyword is used with the following replacement
messages:
• mm1
• mm3
• mm4
• mm7
Other replacement messages use the buffer keyword.

FortiGate CLI Version 3.0 MR6 Reference

430 01-30006-0015-20080205
system replacemsg-group (FortiOS Carrier)

Example
In this example you have 2 groups of users that use different replacement messages due to language
and regional differences. The first group is in the United States, and the other group is in the United
Kingdom. Different spelling and different speech patterns mean, each group expects different
messages. To keep it simple, the format will be text only.
config system replacemsg-group
edit united_states
set comment “messages for United States customers”
config http
edit 1
set msg-type bannedword
set format text
set message “Your attempt to access this unauthorized web page has
been blocked. It contains off-color words that violate the banned
word list. URL = http://%%URL%%”
end
end
edit united_kingdom
set comment “messages for United Kingdom customers”
config http
edit 1
set msg-type bannedword
set format text
set message “Unfortunately your requested web page has been blocked.
It appears to contain prohibited off-colour words. URL =
http://%%URL%%”
end
end

History

FortiOS v3.0 MR5 New

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 431
replacemsg-image (FortiOS Carrier) system

replacemsg-image (FortiOS Carrier)

Use this command to add, edit, or delete images to be used in SMIL parts of replacement messages.
Both image-base64 and image-type must be present for a valid entry.

Syntax
config system replacemsg-image
edit <image_name>
set image-base64 <image_data>
set image-type <format>
end
Variables Description Default
edit <image_name> Enter the name or tag to use for this image none.
image-base64 Enter the image in base64 encoding. You can also use the graphical none.
<image_data> interface to add images by browsing to their location.

image-type <format> Select the format of the image. Available formats include: none.
• gif
• jpeg
• png
• tiff

History

FortiOS v3.0 MR5 New.

FortiGate CLI Version 3.0 MR6 Reference

432 01-30006-0015-20080205
system session-helper

session-helper
A session-helper binds a service to a TCP port. By default, there are session helpers that bind services
to standard ports. Use this command to configure a new session helper or to edit an existing one.

Syntax
config system session-helper
edit <helper-number>
set name <helper-name>
set port <port_number>
set protocol <protocol_number>
end

Services, ports, and protocols

1 pptp port 1723 protocol 6 8 ftp port 21 protocol 6
2 h323 port 1720 protocol 6 9 rtsp port 554 protocol 6
3 ras port 1719 protocol 17 10 rtsp port 7070 protocol 6
4 tns port 1521 protocol 6 11 pmap port 111 protocol 17
5 tftp port 69 protocol 17 12 mms port 1863 protocol 6
6 rtsp port 23 protocol 6 13 pmap port 111 protocol 6
7 rtsp port 25 protocol 6

Keywords and variables Description Default

edit <helper-number> Enter the number of the session-helper that you want to No default.
edit, or enter an unused number to create a new
session-helper.
name <helper-name> The name of the session helper. One of: No default.
dns-tcp, dns-udp, ftp, h245I, h245O, h323, ident, mms,
pmap, pptp, ras, rtsp, sip, tftp, tns.
port <port_number> Enter the port number to use for this protocol. No default.
protocol <protocol_number> The protocol number for this service, as defined in No default.
RFC 1700.

Example
Use the following commands to add the remote shell application to port 512, as protocol 6:
config system session-helper
edit 14
set name rsh
set port 512
set protocol 6
end

History

FortiOS v2.80 New

FortiOS v3.0 Changed dns_tcp to dns-tcp and dns_udp to dns-udp.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 433
session-sync system

session-sync
Use this command to configure TCP session synchronization between two standalone FortiGate units.
You can use this feature with external routers or load balancers configured to distribute or load balance
TCP sessions between two peer FortiGate units. If one of the peers fails, session failover occurs and
active sessions fail over to the peer that is still operating. This failover occurs without any loss of data.
As well the external routers or load balancers will detect the failover and re-distribute all sessions to
the peer that is still operating.

Note: TCP session synchronization between two standalone FortiGate units is also sometimes called standalone
session synchronization or session synchronization between non-HA FortiGate units.

Standalone session synchronization can be used instead of HA to provide session synchronization

between two peer FortiGate units. If the external load balances direct all sessions to one peer the
affect is similar to active-passive HA. If external load balancers or routers load balance traffic to both
peers, the affect is similar to active-active HA. The load balancers should be configured so that all of
the packets for any given session are processed by the same peer. This includes return packets.
Unlike HA, standalone session synchronization does not include configuration synchronization. In fact,
the configuration of the two peers is not identical because in most cases the peers would have different
IP addresses. Also unlike HA, load balancing is done by external routers or load balancers. The
FortiGate units only perform session synchronization and session failover.

Figure 2: Standalone session synchronization

Internet

Router or
Load Balancer

Session
Syncronization
Link

Router or
Load Balancer

Internal Network

FortiGate CLI Version 3.0 MR6 Reference

434 01-30006-0015-20080205
system session-sync

Notes and limitations

Session synchronization has the following limitations:
• Only TCP sessions accepted by firewall policies are synchronized. Due to their non-stateful nature,
UDP and ICMP sessions don't need to be synchronized to naturally failover.
• Sessions accepted by firewall policies that contain protection profiles are not synchronized.
• Sessions that include network address translation (NAT) applied by selecting NAT in firewall
policies are not synchronized because the address translation binds to a FortiGate unit address
and the peers have different IP addresses.
• Session synchronization is a CLI only configuration.
• Session synchronization is available for FortiGate units or virtual domains operating in NAT/Route
or Transparent mode. NAT sessions are not synchronized in either mode. In NAT/Route mode, only
sessions for route mode firewall policies are synchronized. In Transparent mode, only sessions for
normal Transparent mode policies are synchronized.
• Session synchronization cannot be asymmetric. Session synchronization is stateful. So all of the
packets of a given session must be processed on the same peer. This includes return packets. You
must configure the load balancers so that they do not cause asymmetric routing.
• Session synchronization is supported for traffic on physical interfaces, VLAN interfaces, zones, and
aggregate interfaces. Session synchronization has not been tested for inter-vdom links,
accelerated interfaces (FA2 and NP2), between HA clusters, and for redundant interfaces.
• The names of the matching interfaces, including VLAN interfaces, aggregate interfaces and so on,
must be the same on both peers.

Configuring session synchronization

You configure session synchronization for each virtual domain to be synchronized. If virtual domain
configuration is not enabled, you configure session synchronization for the root virtual domain. When
virtual domain configuration is enabled and you have added virtual domains you configure session
synchronization for each virtual domain to be synchronized. You don’t have to synchronize all of the
virtual domains. Session synchronization is a global configuration setting.
You must configure session synchronization on both peers. The session synchronization
configurations of each peer should compliment the other. In fact you can manage and configure both
peers as separate FortiGate units. Using FortiManager, you can manage both peers as two separate
FortiGate devices.
On each peer, configuring session synchronization consists of selecting the virtual domains to be
synchronized using the syncvd keyword, selecting the virtual domain on the other peer that receives
the synchronization packets using the peervd keyword, and setting IP address of the interface in the
peer unit that receives the synchronization packets using the peerip keyword. The interface with the
peerip must be in the peervd virtual domain.
The syncvd and peervd settings must be the same on both peers. However, the peerip settings will
be different because the peerip setting on the first peer includes the IP address of an interface on the
second peer. And the peerip setting on the second peer includes the IP address of an interface on
the first peer.
Because session synchronization does not synchronize FortiGate configuration settings you must
configure both peers separately. For session synchronization to work properly all session
synchronized virtual domains must be added to both peers. The names of the matching interfaces in
each virtual domain must also be the same; this includes the names of matching VLAN interfaces.
Note that the index numbers of the matching interfaces and VLAN interfaces can be different. Also the
VLAN IDs of the matching VLAN interfaces can be different.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 435
session-sync system

As well, the session synchronized virtual domains should have the same firewall policies so that
sessions can be resumed after a failover using the same firewall policies.
For a configuration example, see “Basic example configuration” on page 437.

Configuring the session synchronization link

When session synchronization is operating, the peers share session information over an Ethernet link
between the peers similar to an HA heartbeat link. Usually you would use the same interface on each
peer for session synchronization. You should connect the session synchronization interfaces directly
without using a switch or other networking equipment. If possible use a crossover cable for the session
synchronization link. For FortiGate-5000 systems you can use a backplane interface as the session
synchronization link.
You can use different interfaces on each peer for session synchronization links. Also, if you multiple
sessions synchronization configurations, you can have multiple session synchronization links between
the peers. In fact if you are synchronizing a lot of sessions, you may want to configure and connect
multiple session synchronization links to distribute session synchronization traffic to these multiple
links.
You cannot configure backup session synchronization links. Each configuration only includes one
session synchronization link.
The session synchronization link should always be maintained. If session synchronization
communication is interrupted and a failure occurs, sessions will not failover and data could be lost.
Session synchronization traffic can use a considerable amount of network bandwidth. If possible,
session synchronization link interfaces should only be used for session synchronization traffic and not
for data traffic.

Syntax
config system session-sync
edit <sync_id>
set peerip <peer_ipv4>
set peervd <vd_name>
set syncvd <vd_name>
config filter
set dstaddr <string>
set dstintf <interface_name>
set service <string>
set srcaddr <string>
set srcintf <interface_name>
end
end
Variables Description Default
<sync_id> Enter the unique ID number for the session synchronization configuration No
to edit. The session synchronization configuration ID can be any number default
between 1 and 200. The session synchronization configuration IDs of the
peers do not have to match.
peerip <peer_ipv4> Enter the IP address of the interface on the peer unit that is used for the 0.0.0.0
session synchronization link.
peervd <vd_name> Enter the name of the virtual domain that contains the session root
synchronization link interface on the peer unit. Usually both peers would
have the same peervd. Multiple session synchronization configurations
can use the same peervd.

FortiGate CLI Version 3.0 MR6 Reference

436 01-30006-0015-20080205
system session-sync

Variables Description Default

syncvd <vd_name> Enter the names of one or more virtual domains so that the sessions
processed by these virtual domains are synchronized using this session
synchronization configuration.
config filter Supported in a future version of FortiOS.
dstaddr <string> Supported in a future version of FortiOS.
dstintf Supported in a future version of FortiOS.
<interface_name>
service <string> Supported in a future version of FortiOS.
srcaddr <string> Supported in a future version of FortiOS.
srcintf Supported in a future version of FortiOS.
<interface_name>

Basic example configuration

The following configuration example shows how to configure a basic session synchronization
configuration for two peer FortiGate units shown in Figure 3 on page 437. The host names of peers are
peer_1 and peer_2. Both peers are configured with two virtual domains: root and vdom_1. All sessions
processed by vdom_1 are synchronized. The synchronization link interface is port3 which is in the root
virtual domain. The IP address of port3 on peer_1 is 10.10.10.1. The IP address of port3 on peer_2 is
10.10.10.2.
Also on both peers, port1 and port2 are added to vdom_1. On peer_1 the IP address of port1 is set to
192.168.20.1 and the IP address of port2 is set to 172.110.20.1. On peer_2 the IP address of port1 is
set to 192.168.20.2 and the IP address of port2 is set to 172.110.20.2.

Figure 3: Example standalone session synchronization network configuration

Internet

Router or
Load Balancer

Peer_1 port2 Peer_2

port2
port2 port3
root Session root
Vdom_1
Vdom_1 Syncronization
port3 port3 port1
port1 Link 10.10.10.2
10.10.10.1 port1

Router or
Load Balancer

Internal Network

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 437
session-sync system

Configuration steps
1 Configure the load balancer or router to send all sessions to peer_1.
2 Configure the load balancer or router to send all traffic to peer_2 if peer_1 fails.
3 Use normal FortiGate configuration steps on peer_1:
• Enable virtual domain configuration.
• Add the vdom_1 virtual domain.
• Add port1 and port2 to the vdom_1 virtual domain and configure these interfaces.
• Set the IP address of port1 to 192.168.20.1.
• Set the IP address of port2 to 172.110.20.1.
• Set the IP address of port3 to 10.10.10.1.
• Add route mode firewall policies between port1 and port2 to vdom_1.
4 Enter the following commands to configure session synchronization for peer_1
config system session-sync
edit 1
set peerip 10.10.10.2
set peervd root
set syncvd vdom_1
end
5 Use normal FortiGate configuration steps on peer_2:
• Enable virtual domain configuration.
• Add the vdom_1 virtual domain.
• Add port1 and port2 to the vdom_1 virtual domain and configure these interfaces.
• Set the IP address of port1 to 192.168.20.2.
• Set the IP address of port2 to 172.110.20.2.
• Set the IP address of port3 to 10.10.10.1.
• Add route mode firewall policies between port1 and port2 to vdom_1.
6 Enter the following commands to configure session synchronization for peer_1
config system session-sync
edit 1
set peerip 10.10.10.1
set peervd root
set syncvd vdom_1
end

History

FortiOS v3.0 MR6 The command config system session-sync is new for FortiOS v3.0 MR6.

FortiGate CLI Version 3.0 MR6 Reference

438 01-30006-0015-20080205
system session-ttl

session-ttl
Use this command to increase or decrease the length of time a TCP session can be idle before being
dropped. You can set the general default timeout or set the timeout for a specific port.

Syntax
config system session-ttl
set default <seconds>
config port
edit <port_number>
set timeout {<seconds> | never}
end
end
Variables Description Default
default <seconds> Enter a the default session timeout in seconds. The valid range is 3600
from 300 - 604800 seconds.
edit <port_number> Enter the port number for the TCP session. None.
timeout Enter the number of seconds the session can be idle for on this port. 300
{<seconds> | never} The valid range is from 300 - 604800 seconds. Optionally you can
select never instead of specifying the number of seconds.

Note: While it is possible to set a timeout for a session to a value that never expires, this is not a secure
configuration and should be avoided.

Examples
The following command increases the default session timeout:
config system session-ttl
set default 62000
end
Use the following command to change the session timeout for SSH on port 22 to 3600 seconds.
config system session-ttl
config port
edit 22
set timeout 3600
end
end

History

FortiOS v2.80 Revised.

FortiOS v3.0 Changed from session_ttl to session-ttl.
FortiOS v3.0 MR3 Added never keyword to timeout, and added valid ranges for times for
timeout and default.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 439
settings system

settings
Use this command to change settings that are per VDOM settings such as the operating mode and
default gateway. If the operating mode is Transparent, you must also set the management IP address.
system settings differs from system global in that system global keywords apply to the
entire FortiGate unit, where system settings keywords apply only to the current VDOM, or the
entire FortiGate unit if VDOMs are not enabled.
Bi-directional Forwarding Detection (BFD) is a protocol used by BGP and OSPF. It is used to quickly
locate hardware failures in the network. Routers running BFD communicate with each other, and if a
timer runs out on a connection then that router is declared down. BFD then communicates this
information to the routing protocol and the routing information is updated. BFD support was added in
FortiOS v3.0 MR4, and can only be configured through the CLI.

Syntax
config system settings
set asymroute {enable | disable}
set bfd {enable | disable}
set bfd-desired-min-tx <interval_msec>
set bfd-required-min-tx <interval_msec>
set bfd-detect-mult <multiplier
set bfd-dont-enforce-src-port {enable | disable}
set device <interface_name>
set ecmp-max-paths <max_entries>
set gateway <gw_ipv4>
set gateway-device <interface_name>
set ip <address_ipv4>
set manageip <manage_ipv4>
set multicast-forward {enable | disable}
set multicast-ttl-notchange {enable | disable}
set opmode {nat | transparent}
set p2p-rate-limit {per-policy | per-profile}
set sccp-port <port_number>
set sip-helper {enable | disable}
set sip-nat-trace {enable | disable}
set sip-tcp-port <port_number>
set sip-udp-port <port_number>
set status {enable | disable}
set utf8-spam-tagging {enable | disable}
end
Variables Description Default
asymroute Enable to turn on asymmetric routing on your FortiGate disabled
{enable | disable} unit, or this VDOM if you have VDOMs enabled.
This feature should only be used as a temporary check
to troubleshoot a network. It is not intended to be
enabled permanently. When it enabled, many security
features of your FortiGate unit are not enabled. For
more information on
bfd {enable | disable} Enable to turn on bi-directional forwarding detection disable
(BFD) for this virtual domain, or the whole FortiGate
unit. BFD can be used with OSPF and BGP
configurations, and overridden on a per interface
basis.

FortiGate CLI Version 3.0 MR6 Reference

440 01-30006-0015-20080205
system settings

Variables Description Default

bfd-desired-min-tx Enter a value from 1 to 100000 msec as the preferred 50
<interval_msec> minimum transmit interval for BFD packets. If possible
this will be the minimum used.
This is only available when bfd is enabled.
bfd-required-min-tx Enter a value from 1 to 100000 msec as the required 50
<interval_msec> minimum transmit interval for BFD packets. The
FortiGate unit will not transmit BFD packets at a slower
rate than this.
This is only available when bfd is enabled.
bfd-detect-mult Enter a value from 1 to 50 for the BFD detection 3
<multiplier multiplier.
bfd-dont-enforce-src-port Enable to not enforce the BFD source port. disable
{enable | disable}
device <interface_name> Enter the interface to use for management access. No default.
This is the interface to which ip applies. You must set
this when you change opmode from transparent
to nat.
ecmp-max-paths Enter the maximum number of routes allowed to be 10
<max_entries> included in an Equal Cost Multi-Path (ECMP)
configuration. Set to 1 to disable ECMP routing.
ECMP routes have the same distance and the same
priority, and can be used in load balancing.
gateway <gw_ipv4> Enter the default gateway IP address. You must set No default.
this when you change opmode from nat to
transparent.
This option not available in transparent mode.
gateway-device Enter the interface through which the default gateway No default.
<interface_name> can be reached. You must set this when you change
opmode from transparent to nat.
This option not available in transparent mode.
ip <address_ipv4> Enter the IP address to use after switching to nat No default.
mode. You must set this when you change opmode
from transparent to nat.
manageip <manage_ipv4> Set the IP address and netmask of the Transparent No default.
mode management interface. You must set this when
you change opmode from nat to transparent.
This option not available in transparent mode.
multicast-forward Enable or disable multicast forwarding to forward any disable
{enable | disable} multicast IP packets in which the TTL is 2 or higher to
all interfaces and VLAN interfaces except the receiving
interface. The TTL in the IP header will be reduced
by 1.
When multiple VDOMs are configured, this option is
only available within VDOMs.
multicast-ttl-notchange Enable to alter multicast forwarding so that it does not disable
{enable | disable} decrement the time-to-live (TTL) in the packet header.
Disable for normal multicast forwarding behavior.
In multiple VDOM mode, this option is only available
within VDOMs. It is not available at the global level.
opmode {nat | transparent} Enter the required operating mode. nat
If you change opmode from nat to transparent, you
must set manageip and gateway.
If you change opmode from transparent to nat, you
must set device, ip, gateway-device and
gateway.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 441
settings system

Variables Description Default

p2p-rate-limit {per- Select per-profile or per-policy for limiting the per-policy
policy | per-profile} bandwidth available for peer-to-peer applications.
With per-policy limiting, the profile may limit a p2p
application like BitTorrent to 50 KB/sec. But if 2 policies
refer to BitTorrent, each will have that limit for a total of
100 KB/Sec. This is the default behavior.
sccp-port <port_number> Enter the port number from 1 to 65535 of the TCP port 2000
to use to monitor Skinny Client Call protocol (SCCP)
traffic. SCCP is a Cisco proprietary protocol for VoIP.
sip-helper Enable to use the helper to add dynamic sip firewall enable
{enable | disable} allow rules.
sip-nat-trace Select enable to record the original IP address of the enable
{enable | disable} phone.

sip-tcp-port <port_number> Enter a port number from 1 to 65535 for the TCP port 5060
the SIP proxy will use to monitor for SIP traffic.
sip-udp-port <port_number> Enter a port number from 1 to 65535 for the UDP port 5060
the SIP proxy will use to monitor for SIP traffic.
status {enable | disable} Disable or enable this VDOM. Disabled VDOMs keep enable
all their configuration, but the resources of that VDOM
are not accessible.
To leave VDOM mode, all disabled VDOMs must be
deleted - to leave VDOM mode there can be only the
root VDOM configured.
utf8-spam-tagging Enable converts spam tags to UTF8 for better non- enable
{enable | disable} ascii character support.

History

FortiOS v3.0 New.

opmode moved from system global.
manageip moved from system manageip.
FortiOS v3.0 MR3 Added multicast-forward and multicast-ttl-notchange.
FortiOS v3.0 MR4 Added asymroute, bfd, bfd-desired-min-tx, bfd-required-
min-tx, bfd-detect-mult, bfd-dont-enforce-src-port,
sccp-port, sip-helper, sip-tcp-port, and sip-udp-port.
FortiOS v3.0 MR6 Added status, p2p-rate-limit, sip-nat-trace, and
utf8-spam-tagging.

Related Commands
• vdom

FortiGate CLI Version 3.0 MR6 Reference

442 01-30006-0015-20080205
system snmp community

snmp community
Use this command to configure SNMP communities to your FortiGate unit. You add SNMP
communities so that SNMP managers can connect to the FortiGate unit to view system information
and receive SNMP traps. You can add up to three SNMP communities. Each community can have a
different configuration for SNMP queries and traps. Each community can be configured to monitor the
FortiGate unit for a different set of events. You can also the add IP addresses of up to 8 SNMP
managers to each community.

Note: Part of configuring an SNMP manager is to list it as a host in a community on the FortiGate unit it
will be monitoring. Otherwise the SNMP monitor will not receive any traps from that FortiGate unit, or be
able to query it.

Syntax
config system snmp community
edit <index_number>
set events <events_list>
set name <community_name>
set query-v1-port <port_number>
set query-v1-status {enable | disable}
set query-v2c-port <port_number>
set query-v2c-status {enable | disable}
set status {enable | disable}
set trap-v1-lport <port_number>
set trap-v1-rport <port_number>
set trap-v1-status {enable | disable}
set trap-v2c-lport <port_number>
set trap-v2c-rport <port_number>
set trap-v2c-status {enable | disable}
config hosts
edit <host_number>
set interface <if_name>
set ip <address_ipv4>
end
end
Variables Description Default
edit <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.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 443
snmp community system

Variables Description Default

events <events_list> Enable the events for which the FortiGate unit should All events
send traps to the SNMP managers in this community. enabled.
av-fragmented A fragmented file has been
detected.
av-oversize An oversized file has been detected.
av-pattern An file matching the AV pattern is
detected.
av-virus A virus is detected.
cpu-high CPU usage exceeds threshold.
Default is 80%.
fm-conf-change FortiGate unit is managed by
FortiManager, but the FortiGate
administrator has modified the
configuration directly.
fm-if-change FortiManager interface changes.
ha-hb-failure The HA heartbeat interface has
failed.
ha-member-down The HA cluster member stops.
ha-member-up The HA cluster members starts.
ha-switch The primary unit in a HA cluster fails
and is replaced with a new HA unit.
intf-ip The IP address of a FortiGate
interface changes.
ips-anomaly IPS detects an anomaly.
ips-signature IPS detects an attack.
log-full Hard drive usage exceeds threshold.
Default is 90%.
mem-low Memory usage exceeds threshold.
Default is 80%.
temperature- Sensors report temperature too high.
high This event only available on
FortiGate 5001.
voltage-alarm Sensors report the voltage is outside
of the allowed range.
This event only available on
FortiGate 5001.
vpn-tun-down A VPN tunnel stops.
vpn-tun-up A VPN tunnel starts.
name <community_name> Enter the name of the SNMP community. No
default.
query-v1-port <port_number> Enter the SNMP v1 query port number used for SNMP 161
manager queries.
query-v1-status Enable or disable SNMP v1 queries for this SNMP enable
{enable | disable} community.
query-v2c-port <port_number> Enter the SNMP v2c query port number used for SNMP 161
manager queries.
query-v2c-status Enable or disable SNMP v2c queries for this SNMP enable
{enable | disable} community.
status {enable | disable} Enable or disable the SNMP community. enable

FortiGate CLI Version 3.0 MR6 Reference

444 01-30006-0015-20080205
system snmp community

Variables Description Default

trap-v1-lport <port_number> Enter the SNMP v1 local port number used for sending 162
traps to the SNMP managers.
trap-v1-rport <port_number> Enter the SNMP v1 remote port number used for sending 162
traps to the SNMP managers.
trap-v1-status Enable or disable SNMP v1 traps for this SNMP enable
{enable | disable} community.
trap-v2c-lport <port_number> Enter the SNMP v2c local port number used for sending 162
traps to the SNMP managers.
trap-v2c-rport <port_number> Enter the SNMP v2c remote port number used for 162
sending traps to the SNMP managers.
trap-v2c-status Enable or disable SNMP v2c traps for this SNMP enable
{enable | disable} community.
hosts variables
edit <host_number> Enter the index number of the host in the table. Enter an
unused index number to create a new host.
interface <if_name> Enter the name of the FortiGate interface to which the No
SNMP manager connects. Default
ip <address_ipv4> Enter the IP address of the SNMP manager. 0.0.0.0

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 disabled. After the community is configured the SNMP
manager is added. The SNMP manager IP address is 192.168.20.34 and it connects to the FortiGate
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

History

FortiOS v2.80 Substantially revised.

FortiOS v2.80 MR6 fm_if_change added to events
FortiOS v3.0 Event names hyphens changed to underscores.
Changed underscores to hyphens in keywords.
FortiOS v3.0 MR3 New events added: av-fragmented, av-oversized, av-pattern, ha-hb-failure,
temperature-high, and voltage-alarm. Added note.

Related topics
• system snmp sysinfo

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 445
snmp sysinfo system

snmp sysinfo
Use this command to enable the FortiGate SNMP agent and to enter basic system information used by
the SNMP agent. Use information about the FortiGate unit to identify it. When your SNMP manager
receives traps from the FortiGate unit, you will know which unit sent the information.

Syntax
config system snmp sysinfo
set contact-info <info_str>
set description <description>
set location <location>
set status {enable | disable}
set trap-high-cpu-threshold <percentage>
set trap-log-full-threshold <percentage>
set trap-low-memory-threshold <percentage>
end
Keywords and variables Description Default
contact-info <info_str> Add the contact information for the person responsible for this No
FortiGate unit. The contact information can be up to 35 default
characters long.
description <description> Add a name or description of the FortiGate unit. The description No
can be up to 35 characters long. default
location <location> Describe the physical location of the FortiGate unit. The system No
location description can be up to 35 characters long. default
status {enable | disable} Enable or disable the FortiGate SNMP agent. disable
trap-high-cpu-threshold Enter the percentage of CPU used that will trigger the threshold 80
<percentage> SNMP trap for the high-cpu.
trap-log-full-threshold Enter the percentage of disk space used that will trigger the 90
<percentage> threshold SNMP trap for the log-full.
trap-low-memory-threshold Enter the percentage of memory used that will be the threshold 80
<percentage> SNMP trap for the low-memory.

Example
This example shows how to enable the FortiGate SNMP agent and add basic SNMP information.
config system snmp sysinfo
set status enable
set contact-info 'System Admin ext 245'
set description 'Internal network unit'
set location 'Server Room A121'
end

History

FortiOS v2.80 Revised.

FortiOS v3.0 Changed contact_info to contact-info.
FortiOS v3.0 MR2 Added 3 trap- commands.

Related topics
• system snmp community

FortiGate CLI Version 3.0 MR6 Reference

446 01-30006-0015-20080205
system switch-interface

switch-interface
Use this command to group interfaces into a ‘soft-switch’ - a switch that is implemented in software
instead of hardware. A group of switched interfaces have one IP address between them to connect to
the FortiGate unit. This feature is only available on models that have the switch-mode feature
Interfaces that may be members of a ‘soft-switch’ are physical and wlan interfaces that are not used
anywhere else in FortiOS. Member interfaces cannot be monitored by HA or used as heart beat
devices.

Syntax
config system switch-interface
edit <group_name>
set member <if1_ipv4> <if2_ipv4> ...
end
Keywords and variables Description Default
<group_name> The name for this group of interfaces. No
Can not be in use by any other interfaces, vlans, or inter-VDOM default
links.
member <if1_ipv4> Enter all the interfaces that will be part of this switch on one line. No
<if2_ipv4> ... Separate each by a space. default
Use <tab> to advance through the list of available interfaces.

Example
This example shows how to create a group of 3 interfaces called low_speed ideally that are all at
10m speed. It assumes these interfaces are not referred to in FortiOS by anything else.
config system switch-interface
edit low_speed
set member port1 wlan dmz
end

History

FortiOS v3.0 MR6 New.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 447
tos-based-priority system

tos-based-priority
Use this command to prioritize your network traffic based on its type-of-service (TOS).
IP datagrams have a TOS byte in the header (as described in RFC 791). Four bits within this field
determine the delay, the throughput, the reliability, and cost associated with that service. Together
these bits are the tos variable of the tos-based-priority command.
The TOS information can be used to manage network traffic based on the needs of the application or
service. TOS application routing (RFC 1583) is supported by OSPF routing.

Syntax
config system tos-based-priority
edit <name>
set tos <ip_tos_value>
set priority [high | medium | low]
end
Variables Description Default
edit <name> Enter the name of the link object to create No default.
tos <ip_tos_value> Enter the value of the type of service byte in the IP 0
datagram header. This value can be from 0 to 15.
priority [high | medium | Select the priority of this type of service as either high, High
low] medium, or low priority. These priority levels conform to the
firewall traffic shaping priorities.

Examples
It is a good idea to have your entry names in the tos-based-priority table and their TOS values be the
same. Otherwise it can become confusing.
config tos-based-priority
edit 1
set tos 1
set priority low
next
edit 4
set tos 4
set priority medium
next
edit 6
set tos 6
set priority high
next
end

History

Related topics
• system global
• router ospf
• execute ping-options

FortiGate CLI Version 3.0 MR6 Reference

448 01-30006-0015-20080205
system vdom-link

vdom-link
Use this command to create an internal point-to-point interface object. This object is a link used to join
virtual domains.
Creating the interface object also creates 2 new interface objects by the name of <name>0 and
<name>1. For example if your object was named v_link, the 2 interface objects would be named
v_link0 and v_link1. You can then configure these new interfaces as you would any other virtual
interface using config system interface.
When using vdom-links in HA, you can only have vdom-links in one vcluster. If you have vclusters
defined, you must use the vcluster keyword to determine which vcluster will be allowed to contain the
vdom-links.
As of FortiOS v3.0 MR3, inter-VDOM links support BGP routing.
For more information on the vdom-link command see “Configuring inter-VDOM routing” on page 53
and the FortiGate VLANs and VDOMs Guide.

Syntax
config system vdom-link
edit <name>
end
Variables Description Default
edit <name> Enter the name of the link object to create. You are limited No default.
to 8 characters maximum for the name.
vcluster {1|2} Select vcluster 1 or 2 as the only vcluster to have inter-
VDOM links.
This option is available only when HA and vclusters are
configured, and there are VDOMs in both vclusters.

Examples
In this example you have already created two virtual domains called v1 and v2. You want to set up a
link between them. The following command creates the VDOM link called v12_link. Once you have the
link you need to bind its two ends to the VDOMs it will be working with.
config system vdom-link
edit v12_link
end

config system interface

edit v12_link0
set vdom v1
next
edit v12_link1
set vdom v2
end
If you want to delete the vdom-link, you must delete the interface - in the above example this would be:
config system interface
delete v12_link
end

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 449
vdom-link system

History

FortiOS v3.0 New command.

FortiOS v3.0 MR4 Added vcluster keyword.

Related topics
• system interface

FortiGate CLI Version 3.0 MR6 Reference

450 01-30006-0015-20080205
system wireless mac-filter

wireless mac-filter
Use this command to configure the WLAN interface MAC filter on the FortiWifi-60 unit in Access Point
mode.

Syntax
config system wireless mac-filter
set default-acl {allow | deny}
set status {enable | disable}
config mac-list
edit <list_number>
set acl {allow | deny }
set mac <mac_address>
end
end
Variables Description Default
default-acl {allow | deny} Select whether unlisted MAC addresses are allowed or deny
denied access.
edit <list_number> Enter the number of the MAC filter list that you want to edit.
Enter an unused number to create a new list.
status {enable | disable} Enable or disable MAC filter. disable
Status is always disable in Client mode.
mac-list variables
acl {allow | deny } Select Allow or Deny for the access control list (ACL). deny
mac <mac_address> Set the MAC address to add to the list. No default.

Examples
This example shows how to enable the MAC filter, specify that unlisted MAC addresses should be
denied access, and add MAC address 12:34:56:78:90:AB to the MAC filter Allow list:
config system wireless mac-filter
set status enable
set default-acl deny
config mac-list
edit 1
set acl allow
set mac 12:34:56:78:90:AB
end
end

History

FortiOS v2.80E New command, incorporating config system network wireless wlan.
FortiOS v3.0 Changed mac_filter to mac-filter, default_acl to default-acl, mac_list to
mac-list.

Related topics
• system wireless settings
• system interface

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 451
wireless settings system

wireless settings
Use this command to configure the WLAN interface wireless settings on the FortiWiFi-60 unit.

Syntax
config system wireless settings
set band {802.11a | 802.11b | 802.11g}
set beacon_interval <integer>
set broadcast_ssid {enable | disable}
set channel <channel_number>
set fragment_threshold <bytes>
set geography <americas | EMEA | Israel | Japan | World>
set key <WEP-key_hex>
set mode <opmode>
set passphrase <string>
set power_level <dBm>
set radius-server <radius_name>
set rts_threshold <integer>
set security <sec_mode>
set ssid <ssid_string>
end
Variable Description Default
band Enter the wireless band to use. (802.11a only available on 802.11g
{802.11a | 802.11b | 802.11g} the FortiWiFi-60A and FortiWiFi-60B.)
beacon_interval <integer> Set the interval between beacon packets. Access Points 100
broadcast Beacons or Traffic Indication Messages (TIM) to
synchronize wireless networks. In an environment with
high interference, decreasing the Beacon Interval might
improve network performance. In a location with few
wireless nodes, you can increase this value.
This is available in AP mode only.
broadcast_ssid Enable if you want FortiWiFi-60 to broadcast its SSID. disable
{enable | disable} For the FortiWiFi-60A unit, see wifi-broadcast-ssid
in the system interface command.
channel <channel_number> Select a channel number for your FortiWiFi-60 wireless 5
network.
Users who want to use the wireless network should
configure their computers to use this channel for wireless
networking.
fragment_threshold <bytes> Set the maximum size of a data packet before it is broken 2346
into smaller packets, reducing the chance of packet
collisions. If the packet size is larger than the threshold, the
FortiWiFi unit will fragment the transmission. If the packet
size less than the threshold, the FortiWiFi unit will not
fragment the transmission.
A setting of 2346 bytes effectively disables this option.
Range 800-2346.
This is available in AP mode only.
For the FortiWiFi-60A unit, see wifi-fragment_threshold
<packet_size> in the system interface command.
geography <americas | EMEA | Select the country or region in which this FortiWifi-60 will World
Israel | Japan | World> operate.

FortiGate CLI Version 3.0 MR6 Reference

452 01-30006-0015-20080205
system wireless settings

Variable Description Default

key <WEP-key_hex> Enter a WEP key. The WEP key must be 10 or 26 No default.
hexadecimal digits (0-9 a-f). For a 64-bit WEP key, enter
10 hexadecimal digits. For a 128-bit WEP key, enter 26
hexadecimal digits.
This is available in AP mode only when security is set to
WEP128 or WEP64.
For the FortiWiFi-60A unit, see wifi-key <hex_key> in the
system interface command.
mode <opmode> Enter the operation mode for the wireless interface: AP
• Access Point (AP)
Multiple wireless clients can connect to unit.
• Client
Connect to another wireless network as a client.
passphrase <string> Enter shared key for WPA_PSK security. No default.
security must be set to WPA_PSK.
This is available in AP mode only.
For the FortiWiFi-60A unit, see wifi-passphrase <pass_str>
in the system interface command.
power_level <dBm> Set transmitter power level in dBm. 31
Range 0 to 31.
This is available in AP mode only.
radius-server <radius_name> Set RADIUS server name for WPA_RADIUS security. No default.
This is only available in AP mode when security is set to
WPA_RADIUS.
For the FortiWiFi-60A unit, see wifi-radius-server
<server_name> in the system interface command.
rts_threshold <integer> The RTS threshold is the maximum size, in bytes, of a 2347
packet that the FortiWiFi will accept without sending
RTS/CTS packets to the sending wireless device. In some
cases, larger packets being sent may cause collisions,
slowing data transmissions.
Range 256-2347.
A setting of 2347 bytes effectively disables this option.
This is available in AP mode only.
For the FortiWiFi-60A unit, see wifi-rts_threshold <integer>
in the system interface command.
security <sec_mode> Enter security (encryption) mode: None
• None - Communication is not encrypted.
• WEP64 - WEP 64-bit encryption
• WEP128 - WEP 128-bit encryption
• WPA_PSK - WPA encryption with pre-shared key
This is available in AP mode only.
• WPA_RADIUS - WPA encryption via RADIUS server.
This is available in AP mode only.
For the FortiWiFi-60A unit, see wifi-security <sec_mode>
in the system interface command.
ssid <ssid_string> Change the Service Set ID (SSID) as required. fortinet
The SSID is the wireless network name that the FortiWiFi-
60 broadcasts. Users who wish to use the FortiWiFi-60
wireless network should configure their computers to
connect to the network that broadcasts this network name.
For the FortiWiFi-60A unit, see wifi-ssid <id_str> in the
system interface command.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 453
wireless settings system

Example
This example shows how to configure the wireless interface.
config system wireless settings
set channel 4
set geography Americas
set security WEP128
set ssid test_wifi
end

History

FortiOS v2.80E Command changed from config system wireless wlan.

Keywords added: beacon_interval, broadcast_ssid, fragment_threshold,
passphrase, power_level, radius_server, rts_threshold

Related topics
• system interface
• system vdom-link
• wireless mac-filter

FortiGate CLI Version 3.0 MR6 Reference

454 01-30006-0015-20080205
system zone

zone
Use this command to add or edit zones.
In NAT/Route mode, you can group related interfaces or VLAN subinterfaces into zones. Grouping
interfaces and subinterfaces into zones simplifies policy creation. For example, if you have two
interfaces connected to the Internet, you can add both of these interfaces to the same zone. Then you
can configure policies for connections to and from this zone, rather than to and from each interface.
In Transparent mode you can group related VLAN subinterfaces into zones and add these zones to
virtual domains.

Syntax
config system zone
edit <zone_name>
set interface <name_str>
set intrazone {allow | deny}
end
Keywords and variables Description Default
edit <zone_name> Enter the name of a new or existing zone.
interface <name_str> Add the specified interface to this zone. You cannot add an No default.
interface if it belongs to another zone or if firewall policies
are defined for it.
intrazone {allow | deny} Allow or deny traffic routing between different interfaces in deny
the same zone.

Example
This example shows how to add a zone named Zone1, add the internal interface to it, and to deny
routing between different zones.
config system zone
edit Zone1
set interface internal
set intrazone deny
end

History

FortiOS v2.80 Revised.

FortiOS v2.80 MR2 intrazone now available on all models. All models support zones.
Added interface keyword (was part of config system interface).

Related topics
• system interface

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 455
zone system

FortiGate CLI Version 3.0 MR6 Reference

456 01-30006-0015-20080205
user

user
This chapter covers
• configuration of the FortiGate unit to use external authentication servers, including
Windows Active Directory
• configuration of user accounts and user groups for firewall policy authentication, administrator
authentication and some types of VPN authentication
• configuration of peers and peer groups for IPSec VPN authentication and PKI user authentication
• configuration of dynamic profiles and msisdn filters (FortiOS Carrier)

This chapter contains the following sections:

Configuring users for authentication peer

adgrp peergrp
dynamic-profile (FortiOS Carrier) radius
msisdn-bwl (FortiOS Carrier) settings
msisdn-ip-filter (FortiOS Carrier) tacacs+
msisdn-translation (FortiOS Carrier)
fsae
group
ldap
local

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 457
Configuring users for authentication user

Configuring users for authentication

This chapter covers two types of user configuration:
• users authenticated by password
• users, sites or computers (peers) authenticated by certificate

Configuring users for password authentication

You need to set up authentication in the following order:
1 If external authentication is needed, configure the required servers.
• See “user radius” on page 481.
• See “user ldap” on page 473.
• See “user tacacs+” on page 484
• For Windows Active Directory, see “user fsae” on page 467.
2 Configure local user identities.
For each user, you can choose whether the FortiGate unit or an external authentication server verifies
the password.
• See “user local” on page 476.
3 Create user groups.
Add local users to each user group as appropriate. You can also add an authentication server to a user
group. In this case, all users in the server’s database can authenticate to the FortiGate unit.
• See “user group” on page 469.
• For Windows Active Directory, also see “user adgrp” on page 459.

Configuring peers for certificate authentication

If your FortiGate unit will host IPSec VPNs that authenticate clients using certificates, you need to
prepare for certificate authentication as follows:
1 Import the CA certificates for clients who authenticate with a FortiGate unit VPN using certificates.
• See “vpn certificate ca” on page 488.
2 Enter the certificate information for each VPN client (peer).
• See “user peer” on page 478.
3 Create peer groups, if you have VPNs that authenticate by peer group. Assign the appropriate peers to
each peer group.
• See “user peergrp” on page 480.
For detailed information about IPSec VPNs, see the FortiGate IPSec VPN Guide. For CLI-specific
information about VPN configuration, see the VPN chapter of this Reference.

FortiGate CLI Version 3.0 MR6 Reference

458 01-30006-0015-20080205
user adgrp

adgrp
Use this command to list Active Directory user groups.

Syntax
get user adgrp [<adgroupname>]
If you do not specify a group name, the command returns information for all Active Directory groups.
For example:
== [ DOCTEST/Cert Publishers ]
name: DOCTEST/Cert Publishers server-name: ADserv1
== [ DOCTEST/Developers ]
name: DOCTEST/Developers server-name: ADserv1
== [ DOCTEST/Domain Admins ]
name: DOCTEST/Domain Admins server-name: ADserv1
== [ DOCTEST/Domain Computers ]
name: DOCTEST/Domain Computers server-name: ADserv1
== [ DOCTEST/Domain Controllers ]
name: DOCTEST/Domain Controllers server-name: ADserv1
== [ DOCTEST/Domain Guests ]
name: DOCTEST/Domain Guests server-name: ADserv1
== [ DOCTEST/Domain Users ]
name: DOCTEST/Domain Users server-name: ADserv1
== [ DOCTEST/Enterprise Admins ]
name: DOCTEST/Enterprise Admins server-name: ADserv1
== [ DOCTEST/Group Policy Creator Owners ]
name: DOCTEST/Group Policy Creator Owners server-name: ADserv1
== [ DOCTEST/Schema Admins ]
name: DOCTEST/Schema Admins server-name: ADserv1
If you specify an Active Directory group name, the command returns information for only that group.
For example:
name : DOCTEST/Developers
server-name : ADserv1
The server-name is the name you assigned to the Active Directory server when you configured it in
the user fsae command.

History

FortiOS v3.0 New.

Related topics
• user fsae
• execute fsae refresh

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 459
dynamic-profile (FortiOS Carrier) user

dynamic-profile (FortiOS Carrier)

Dynamic profiles apply protection profiles on a per-user basis rather than a per-policy basis. If dynamic
profiles are enabled, the FortiGate unit listens for RADIUS accounting start and stop messages to
learn the mapping of user MSISDNs, IP addresses, and protection profiles.
The FortiGate unit gets the protection profile information from an administrator-configured attribute in
the RADIUS accounting start message.

Note: This feature only applies to HTTP, SMTP, MM1, MM3, MM4, and MM7 traffic.

Syntax
config user dynamic-profile
set attribute-key <RADIUS_attribute_key>
set context-timeout <timeout_seconds>
set hold-time <proxy_hold_time>
set log-flags <lflags>
set log-period <log_time>
set mem-percent <memory_percent>
set radius-attribute <radius_attribute_name>
set radius-response {enable | disable}
set radius-server-port <radius_listen_port>
set secret <server_password>
set status {enable | disable}
set validate-request-secret {enable | disable}
set vdom <vdom-name>
end
Keywords and variables Description Default
attribute-key Key that contains the profile name in the radius- No default.
<RADIUS_attribute_key> attribute.
context-timeout Timeout value for user context table entries. In seconds, 28800
<timeout_seconds> 0 disables the timeout feature.
hold-time Time to hold in proxy connection state to receive RADIUS 5
<proxy_hold_time> START. In seconds, 0 disables the feature and the proxy will
wait until the session times out.
log-flags <lflags> Enter one or more of the following options, separated by All options
spaces: except none.
none disable all RADIUS event logging
accounting-event enable to log accounting events
accounting-stop- enable to log missed accounting
missed events
context-missing enable to log missing context errors
profile-missing enable to log missing profile errors
protocol-error enable to log protocol errors
radiusd-other enable to log other radius log
messages
log-period <log_time> Enter the minimum time period to use for event logs. In 0
seconds, 0 means forever.
mem-percent Maximum percentage of system memory to use for context 4
<memory_percent> tables. CLI only.

FortiGate CLI Version 3.0 MR6 Reference

460 01-30006-0015-20080205
user dynamic-profile (FortiOS Carrier)

Keywords and variables Description Default

radius-attribute RADIUS attribute used to hold the firewall protection profile Class
<radius_attribute_name> name.
Details regarding standard RADIUS attributes are found in
RFC 2138 Remote Authentication Dial In User Service
(RADIUS) and RFC RADIUS Accounting.
radius-response {enable | Enable to send RADIUS response packets. disable
disable}
radius-server-port Enter the udp port to listen on for RADIUS accounting 1813
<radius_listen_port> packets.
secret <server_password> Enter the RADIUS server shared secret. No default.
status {enable | disable} Enter enable to activate the dynamic profile feature (user- disable
based dynamic firewall protection profiles). The FortiGate
unit will listen for RADIUS accounting start and stop
messages in order to learn the mapping of user
MSISDNs, IP addresses, and protection profiles.
validate-request-secret Enable to validate RADIUS request shared secret. disable
{enable | disable}
vdom <vdom-name> Enter/select the vdom to use for sending/receiving RADIUS root
packets. Only available in VDOM mode.

Example
This example shows how to enable a dynamic profile in the root vdom that will send RADIUS
responses/validate the RADIUS request secret, will use the default profile if the HTTP header is not
present in the MMS transaction, and log all events.
config user dynamic-profile
set status enable
set vdom “root”
set radius-response enable
set validate-request-secret enable
set http-header-status enable
set http-header-fallback default-profile
set log-flags protocol-error profile-missing context-missing
accounting-stop-missed accounting-event radiusd-other
end

History

FortiOS Carrier v3.0 New.

MR2

Related topics
• msisdn-bwl (FortiOS Carrier)
• msisdn-ip-filter (FortiOS Carrier)
• msisdn-translation (FortiOS Carrier)

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 461
msisdn-bwl (FortiOS Carrier) user

msisdn-bwl (FortiOS Carrier)

From a protection profile, it is possible to enable a BLOCK or ARCHIVE option for a lists of MSISDNs
from a catalog of lists. With MSISDN filtering, MM1/3/4/7 messages are filtered by the MSISDN
specified in the ‘from’ and ‘to’ addresses.
When a user request arrives, the user’s MSISDN is checked to determine the protection profile that
should be applied. If the user is found in the table, the specified protection profile is applied, otherwise
the default profile specified in the firewall policy is applied.
There can be multiple MSISDN filter lists that can be associated with each protection profile.

Syntax
config user msisdn-bwl
edit <msisdn_list_integer>
set comment msisdn_list_comment
config entries
edit msisdn-expression <msisdn_expression>
set pattern-type {regexp | wildcard | simple }
set action {none | block | exempt-mass-MMS | exempt }
set log-action {archive | intercept}
set status {enable | disable}
next
set name <msisdn_list_name>
next
end

Keywords and variables Description Default

action {none | block | The action (or actions archive and intercept) to take if block
exempt-mass-MMS | the MSISDN expression is found in the list.
exempt } • none: no action is taken
• block: message is not delivered to intended recipient,
log message in AV LOG as blocked due to MSISDN
• exempt-mass-MMS: no mass MMS scanning performed
• exempt: exempt user messages from all scanning
log-action {archive | • archive: message is delivered to intended recipient, disable
intercept} MMS transaction forwarded to FortiAnalyzer archive,
entry generated in content summary for FortiGate unit
• intercept: message delivered to intended recipient,
files are quarantined based on quarantine configuration,
log message in AV LOG as intercepted due to MSISDN
msisdn_list_comment Optional description of the MSISDN filter list. The comment null
text must be less than 63 characters long, or it will be
truncated. Spaces are replaced with a plus sign (+).
msisdn-expression The MSISDN expression to use for filtering/searching. No default
<msisdn_expression> Enclose in quotation marks.
<msisdn_list_integer> A unique number to identify the MSISDN filter list. No default
name <msisdn_list_name> The name of the MSISDN filter list. null
pattern-type {regexp | Set the pattern type for the banned word. Choose from wildcard
wildcard | simple } regexp, wildcard., or simple. Create patterns for
banned MSISDN expressions using Perl regular
expressions or wildcards.
status {enable | disable} Enable MSISDN filter search for MSISDN expression in disable
msisdn-expression.

FortiGate CLI Version 3.0 MR6 Reference

462 01-30006-0015-20080205
user msisdn-bwl (FortiOS Carrier)

Example
The following example details the MSISDN filter list MSISDN2+List. Entries combine features including
the action (none, block, exempt from mass MMS, exempt from all scanning), status (enable/disable),
and pattern type (wildcard/regular expression/single MSISDN).
config user msisdn-bwl
edit 2
set comment "Description+of+MSISDN2+list."
config entries
edit "*504*"
set action exempt-mass-mms
set pattern-type wildcard
set status enable
next
edit "6449675"
set pattern-type regexp
set status enable
next
edit "6132259381"
set action block
set log-action archive intercept
set pattern-type simple
set status enable
next
edit "*335*"
set action disable
next
edit "*555*"
set action exempt-mass-mms
set log-action archive intercept
set pattern-type wildcard
set status enable
next
end
set name "MSISDN2+List+2"
next
end
end

History

FortiOS Carrier v3.0 New.

MR2
FortiOS Carrier v3.0 Added log-action, and changed description/contents of action
MR3 and pattern-type.

Related topics
• dynamic-profile (FortiOS Carrier)
• msisdn-ip-filter (FortiOS Carrier)
• msisdn-translation (FortiOS Carrier)

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 463
msisdn-ip-filter (FortiOS Carrier) user

msisdn-ip-filter (FortiOS Carrier)

In mobile networks, neither the username nor the IP address can be used to identify a specific user.
The only element unique to a user is the MSISDN. The MSISDN IP filter provides a mechanism to
block network access for a specific list of MSISDNs, in addition to the black/white list capability for
MMS transactions configured in the protection profile.
The MSISDN IP filter feature uses a MSISDN filter list created using the CLI command config user
msisdn-bwl. To set up a MSISDN IP filter, you must create the MSISDN filter list prior to enabling the
MSISDN IP filter feature.

Syntax
config user msisdn-ip-filter
edit msisdn_filter_list_integer
set log-status {enable | disable}
next
end

Keywords and variables Description Default

msisdn_filter_list_integ A unique number to identify the MSISDN IP filter list. No default
er
log-status {enable | Enable MSISDN IP filter search for MSISDN expression. disable
disable}

History

FortiOS Carrier v3.0 New.

MR3

Related topics
• dynamic-profile (FortiOS Carrier)
• msisdn-bwl (FortiOS Carrier)
• msisdn-translation (FortiOS Carrier)

FortiGate CLI Version 3.0 MR6 Reference

464 01-30006-0015-20080205
user msisdn-translation (FortiOS Carrier)

msisdn-translation (FortiOS Carrier)

With MSISDN filtering, MM1/3/4/7 messages are filtered by the MSISDN specified in the ‘from’ or ‘to’
addresses.
The MSISDN information is normally found in the HTTP header, but there is a variety of formats and in
some cases, a requirement to extract this information from a cookie. The msisdn-translation feature
sets up the process to extract the MSISDN information if it is not present in the HTTP header.

Syntax
config user msisdn-translation
set missing-header-fallback <policy-profile | session-ip>
set msisdn-header <msisdn_header_title>
set profile-query-type < extract-ip | extract-msisdn | session-ip >
set msisdn-prefix {enable | disable}
set msisdn-prefix-string <prefix_string>
set msisdn-prefix-range-min <prefix_range_min>
set msisdn-prefix-range-max <prefix_range_max>
set msisdn-header-suppress {enable | disable}
set msisdn-source {http-header | cookie}
set msisdn-convert-hex {enable | disable}
set ip-header <ip_header_name>
set ip-header-suppress {enable | disable}
end
Keywords and variables Description Default
missing-header-fallback Specify method to determine user identification if policy-
<policy-profile | http_header is not present in the MSISDN information. profile
session-ip> policy-profile: use the default profile
session-ip: use the ip header address
msisdn-header Name of the MSISDN header. Up to 64 character x-up-
<msisdn_header_title> maximum. String. calling-
line-id
profile-query-type < Select the method used to suppress the address header session-ip
extract-ip | extract- used to set up a dynamic profile query from the HTTP
msisdn | session-ip > request as it is passed through the FortiGate unit. The
header may be either the MSISDN header or the IP header.
extract-ip: query by extracted ip address
extract-msisdn: query by extracted MSISDN
session-ip: query by ip session address
msisdn-prefix {enable | Enable to add the country code to the extracted MSISDN for disable
disable} logging and notification.
msisdn-prefix-string The alphanumeric string of the MSISDN prefix. null
<prefix_string> Only available if msisdn-prefix is enabled.
msisdn-prefix-range-min Minimum number of characters in the msisdn prefix string. null
<prefix_range_min> Range is integer 1 - 16.
Only available if msisdn-prefix is enabled.
msisdn-prefix-range-max Maximum number of characters in the msisdn prefix string. null
<prefix_range_max> Range is integer 1 - 16.
Only available if msisdn-prefix is enabled.
msisdn-header-suppress Enable to remove the address header used to set up the disable
{enable | disable} dynamic profile query from the HTTP request as it is passed
through the FortiGate unit.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 465
msisdn-translation (FortiOS Carrier) user

Keywords and variables Description Default

msisdn-source {http- Select the source of the MSISDN identifier. http-header
header | cookie} http-header: source is the http header field in the
sender’s address
cookie: source is the attributes of the sender’s address
cookie
msisdn-convert-hex Enable to convert the sender address from ASCII to HEX or disable
{enable | disable} from HEX to ASCII, if required.
ip-header Name of IP header. Only available if profile-query- X-Up-
<ip_header_name> type is session-ip. Up to 64 character maximum. Forwarded-
String. For
ip-header-suppress Enable to suppress the IP header address. Only available if disable
{enable | disable} profile-query-type is session-ip.

Example
This example shows how to configure MSISDN filtering address translation with the name ‘enable’ that
uses the session IP address (including the ability to convert from HEX to ASCII and reverse) and is
able to remove the address header to set up the dynamic profile from the HTTP request:
config user msisdn-translation
set missing-header-fallback session-ip
set profile-query-type extract-ip
set msisdn-header “enable”
set msisdn-convert-hex
set ip-header-suppress enable
end

History

FortiOS Carrier v3.0 New.

MR2

Related topics
• dynamic-profile (FortiOS Carrier)
• msisdn-bwl (FortiOS Carrier)
• msisdn-ip-filter (FortiOS Carrier)

FortiGate CLI Version 3.0 MR6 Reference

466 01-30006-0015-20080205
user fsae

fsae
Use this command to configure the FortiGate unit to receive user group information from a Windows
Active Directory server equipped with the Fortinet Server Authentication Extensions (FSAE). You can
specify up to five computers on which a FSAE collector agent is installed. The FortiGate unit uses
these collector agents in a redundant configuration. If the first agent fails, the FortiGate unit attempts to
connect to the next agent in the list.
You can add Windows user groups to Active Directory type user groups for authentication in firewall
policies.

Syntax
config user fsae
edit <server_name>
set ldap_server <ldap-server-name>
set password <password> password2 <password2> password3 <password3>
password4 <password4> password5 <password5>
set password2 <password2>
set password3 <password3>
set password4 <password4>
set password5 <password5>
set port <port_number> <port_number2>
set port <port_number2>
set port <port_number3>
set port <port_number4>
set port <port_number5>
set server <domain> server2 <domain2> server3 <domain3> server4
<domain4> server5 <domain5>
set server2 <domain2>
set server3 <domain3>
set server4 <domain4>
set server5 <domain5>
end
Keywords and variables Description Default
edit <server_name> Enter a name to identify the Windows AD server. No default.
Enter a new name to create a new server definition or enter an
existing server name to edit that server definition.
ldap_server <ldap-server- Enter the name of the LDAP server to be used to access the No default.
name> Windows AD.
password <password> For each collector agent, enter the password. No default.
password2 <password2>
password3 <password3>
password4 <password4>
password5 <password5>

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 467
fsae user

Keywords and variables Description Default

port <port_number> For each collector agent, enter the port number used for 8000
<port_number2> communication with FortiGate units.
<port_number3>
<port_number4>
<port_number5>
server <domain> Enter the domain name or IP address for up to five collector No default.
server2 <domain2> agents. Range from 1 to 63 characters.
server3 <domain3>
server4 <domain4>
server5 <domain5>

History

FortiOS v3.0 New.

FortiOS v3.0 MR6 Added ldap_server, added range to server <domain>.

Related topics
• user group
• execute fsae refresh
• firewall policy, policy6

FortiGate CLI Version 3.0 MR6 Reference

468 01-30006-0015-20080205
user group

group
Use this command to add or edit user groups.
There are three types of user groups:

Firewall user group Provides access to firewall policies that require authentication. A firewall policy
specifies the user groups that are allowed to use the policy. Members of a firewall
user group can be local users defined in user local, peer members defined in
user peer, or accounts on RADIUS or LDAP servers configured in user
radius or user ldap. Users must provide a user name and password to use
the firewall policy.
SSL-VPN user group Provides access to the FortiGate SSL-VPN tunnel and SSL-VPN web
applications. Members of an SSL-VPN user group can be local users defined in
user local or accounts on RADIUS or LDAP servers configured in user
radius or user ldap. Users authenticate using their VPN client or through
the SSL-VPN web portal login page.
Active Directory user group Provides access to firewall policies that require authentication. Members of an
Active Directory user group are members of selected Active Directory user
groups on Active Directory servers configured in user fsae. Users are
authenticated when they log on to their Windows domain and are not required to
authenticate again to use FortiGate firewall policies.

To enable authentication, you must add user names, RADIUS servers and LDAP servers to one or
more user groups. You can then select a user group when you require authentication. You can select a
user group to configure authentication for:
• Firewall policies that require authentication
Only users in the selected user group or users that can authenticate with the RADIUS or LDAP
servers added to the user group can authenticate with these policies.
• SSL-VPN configurations
• IPSec VPN Phase 1 configurations for dialup users
Only users in the selected user group can authenticate to use the VPN tunnel.
• XAuth for IPSec VPN Phase 1 configurations
Only users in the selected user group can be authenticated using XAuth.
• FortiGate PPTP and L2TP configurations
Only users in the selected user group can use the PPTP or L2TP configuration.
• Administrator login with RADIUS authentication
If you use a user group for administrator authentication, it must contain only RADIUS servers.
• FortiGuard Web Filtering override groups
When FortiGuard Web Filtering blocks a web page, authorized users can authenticate to access
the web page or to allow members of another group to access it.

Note: User groups can utilize defined peer members as part of a group.

When you add user names, RADIUS servers, and LDAP servers to a user group, the order in which
they are added determines the order in which the FortiGate unit checks for authentication. If user
names are first, then the FortiGate unit checks first for a match with the local user names. If a match is
not found, the FortiGate unit checks the RADIUS or LDAP server. If a RADIUS or LDAP server is
added first, the FortiGate unit checks the server and then the local user names.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 469
group user

Syntax
config user group
edit <groupname>
set authtimeout <timeout>
set group-type <grp_type>
set member <names>
set profile <profilename>
set ftgd-wf-ovrd {allow | deny}
set ftgd-wf-ovrd-dur <###d##h##m>
set ftgd-wf-ovrd-dur-mode <mode>
set ftgd-wf-ovrd-ext <option>
set ftgd-wf-ovrd-scope <scope>
set ftgd-wf-ovrd-type <o_type>
set redir-url <url_string>
set sslvpn-cache-cleaner {enable | disable}
set sslvpn-client-check {3rdAV | 3rdFW | forticlient}
set sslvpn-portal-heading <web_portal_string>
set sslvpn-tunnel {enable | disable}
set sslvpn-tunnel-startip <ipv4>
set sslvpn-tunnel-endip <ipv4>
set sslvpn-split-tunneling {enable | disable}
set sslvpn-webapp {enable | disable}
set sslvpn-ftp {enable | disable}
set sslvpn-http {enable | disable}
set sslvpn-samba {enable | disable}
set sslvpn-telnet {enable | disable}
set sslvpn-vnc {enable | disable}
set sslvpn-rdp {enable | disable}
end
Variables Description Default
edit <groupname> Enter a new name to create a new group or enter an No default.
existing group name to edit that group.
group-type <grp_type> Enter the group type. <grp_type> determines the type firewall
of users and is one of the following:
• active-directory - Active Directory users
• firewall - FortiGate users defined in user local,
user ldap or user radius
• sslvpn - SSL-VPN users
member <names> Enter the names of users, peers, LDAP servers, or No default.
RADIUS servers to add to the user group. Separate
names by spaces. To add or remove names from the
group you must re-enter the whole list with the additions
or deletions required.
profile <profilename> Enter the name of the firewall protection profile to No default.
associate with this user group.
authtimeout <timeout> Enter the value in seconds of an authentication timeout 0
for the user group. If not set, global authentication
timeout value used. 0 - 480 minutes.
FortiGuard override variables
ftgd-wf-ovrd {allow | deny} Allow or deny this group FortiGuard Web Filtering deny
overrides.
ftgd-wf-ovrd-dur <###d##h##m> Enter the FortiGuard Web Filtering override duration in 15m
days, hours, and minutes.

FortiGate CLI Version 3.0 MR6 Reference

470 01-30006-0015-20080205
user group

Variables Description Default

ftgd-wf-ovrd-dur-mode <mode> Enter the FortiGuard Web Filtering duration type, one of: constant
• constant - as specified in ftgd-wf-ovrd-dur
• ask - ask for duration when initiating override.
ftgd-wf-ovrd-dur is the maximum
ftgd-wf-ovrd-ext <option> Enter one of the following to determine whether users allow
can follow links to external sites during FortiGuard Web
Filtering override:
• allow
• deny
• ask
ftgd-wf-ovrd-scope <scope> Enter the scope of the FortiGuard Web Filtering override, user
one of:
user - override for the user
user-group - override for the user's group
ip - override for the initiating IP
profile - override for the user's protection profile
ask - ask for scope when initiating an override
ftgd-wf-ovrd-type <o_type> Enter the type of FortiGuard Web Filtering override, one dir
of:
dir - override for the specific website directory
domain - override for the specific domain
rating - override for the specific rating
ask - ask for type when initiating an override
SSLVPN variables
redir-url <url_string> Enter the URL for an optional second browser window to No default.
open when the SSL VPN web portal page opens. The
web server for this URL must reside on the private
network behind the FortiGate unit.
sslvpn-cache-cleaner Enable to remove all temporary Internet files created on disable
{enable | disable} the client computer between user login and logout. This
is done with a downloaded ActiveX control and works
only on Internet Explorer.
sslvpn-client-check Allow the client to connect only if it has security software No default.
{3rdAV | 3rdFW | forticlient} installed. Enter one of:
• 3rdAV - check for Norton (Symantec) or McAfee
antivirus software (for systems other than Windows XP
SP2), or Trend Micro, Sophos, Panda Platinum 2006
Internet Security, F-Secure, Secure Resolutions, Cat
Computer Services, or Ahnlab antivirus software for
Windows XP SP2
• 3rdFW - check for Norton (Symantec) or McAfee
antivirus software (for systems other than Windows XP
SP2), or Trend Micro, Panda Platinum 2006 Internet
Security, F-Secure, Secure Resolutions, Cat Computer
Services, or Ahnlab firewall software for Windows XP
SP2
• forticlient - check for FortiClient software
sslvpn-portal-heading Type a custom caption for display at the top of the web No default.
<web_portal_string> portal home page for the SSL VPN user group.
sslvpn-tunnel Enable or disable SSL-VPN tunnel access for this group. disable
{enable | disable} Not available in Transparent mode.
sslvpn-tunnel-startip <ipv4> Enter the first IP address of the IP address range No default.
reserved for SSL-VPN clients.
sslvpn-tunnel-endip <ipv4> Enter the last IP address of the IP address range No default.
reserved for SSL-VPN clients.
sslvpn-split-tunneling Enable or disable the split tunneling feature for this disable
{enable | disable} group.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 471
group user

Variables Description Default

sslvpn-webapp Enable or disable access to web applications for this disable
{enable | disable} group.
Not available in Transparent mode.
sslvpn-ftp Enable or disable access to the FTP web application. disable
{enable | disable} This option is available only if sslvpn-webapp is
enabled.
Not available in Transparent mode.
sslvpn-http Enable or disable access to the HTTP/HTTPS proxy web disable
{enable | disable} application. This option is available only if
sslvpn-webapp is enabled.
Not available in Transparent mode.
sslvpn-samba Enable or disable access to the Samba web application. disable
{enable | disable} This option is available only if sslvpn-webapp is
enabled. Not available in Transparent mode.
sslvpn-telnet Enable or disable access to the Telnet web disable
{enable | disable} application. This option is available only if
sslvpn-webapp is enabled. Not available in
Transparent mode.
sslvpn-vnc Enable or disable access to the VNC web application. disable
{enable | disable} This option is available only if sslvpn-webapp is
enabled. Not available in Transparent mode.
sslvpn-rdp Enable or disable access to the RDP web application. disable
{enable | disable} This option is available only if sslvpn-webapp is
enabled. Not available in Transparent mode.

Example
This example shows how to add a group named User_Grp_1, and add User_2, User_3, Radius_2 and
LDAP_1 as members of the group, and set the protection profile to strict:
config user group
edit User_Grp_1
set member User_2 User_3 Radius_2 LDAP_1
set profile strict
end

History

FortiOS v2.80 Revised.

FortiOS v2.80 MR3 Added profile keyword.
FortiOS v3.00 MR2 Expanded definition of sslvpn-client-check.
Added keyword/variable sslvpn-split-tunneling
{enable | disable}
Added keyword/variable sslvpn-portal-heading <web_portal_string>.
FortiOS v3.00 MR3 Added keyword/variable authtimeout. Added keyword/variables
sslvpn-vnc and sslvpn-rdp.
FortiOS v3.00 MR4 Peer members can be included in user groups.

Related topics
• user ldap
• user local
• user radius
• user tacacs+

FortiGate CLI Version 3.0 MR6 Reference

472 01-30006-0015-20080205
user ldap

ldap
Use this command to add or edit the definition of an LDAP server for user authentication.
To authenticate with the FortiGate unit, the user enters a user name and password. The FortiGate unit
sends this user name and password to the LDAP server. If the LDAP server can authenticate the user,
the user is successfully authenticated with the FortiGate unit. If the LDAP server cannot authenticate
the user, the connection is refused by the FortiGate unit.
The FortiGate unit supports LDAP protocol functionality defined in RFC2251 for looking up and
validating user names and passwords. FortiGate LDAP supports all LDAP servers compliant with
LDAP v3.
FortiGate LDAP support does not extend to proprietary functionality, such as notification of password
expiration, that is available from some LDAP servers. FortiGate LDAP support does not supply
information to the user about why authentication failed.
LDAP user authentication is supported for PPTP, L2TP, IPSec VPN, and firewall authentication. With
PPTP, L2TP, and IPSec VPN, PAP (Packet Authentication Protocol) is supported and CHAP
(Challenge Handshake Authentication Protocol) is not.

Syntax
config user ldap
edit <server_name>
set cnid <id>
set dn <dname>
set port <number>
set server <domain>
set type <auth_type>
set username <ldap_username>
set password <ldap_passwd>
set group <group>
set filter <group_filter>
set secure <auth_port>
set ca-cert <cert_name>
end
Keywords and variables Description Default
cnid <id> Enter the common name identifier for the LDAP server. cn
The common name identifier for most LDAP servers is cn.
However some servers use other common name identifiers
such as uid.
dn <dname> Enter the distinguished name used to look up entries on the No default.
LDAP server. It reflects the hierarchy of LDAP database object
classes above the Common Name Identifier. The FortiGate unit
passes this distinguished name unchanged to the server.
You must provide a dn value if type is simple.
edit <server_name> Enter a name to identify the LDAP server. No default.
Enter a new name to create a new server definition or enter an
existing server name to edit that server definition.
port <number> Enter the port number for communication with the LDAP server. 389
server <domain> Enter the LDAP server domain name or IP address. No default.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 473
ldap user

Keywords and variables Description Default

type <auth_type> Enter the authentication type for LDAP searches. One of: simple
• anonymous - bind using anonymous user search
• regular - bind using username/password and then search
• simple - simple password authentication without search
You can use simple authentication if the user records are all
under one dn that you know. If the users are under more than
one dn, use the anonymous or regular type, which can
search the entire LDAP database for the required user name.
If your LDAP server requires authentication to perform
searches, use the regular type and provide values for
username and password.
username <ldap_username> This keyword is available only if type is regular. For No default.
regular authentication, you need a user name and password.
See your server administrator for more information.
password <ldap_passwd> This keyword is available only if type is regular. For No default.
regular authentication, you need a user name and password.
See your server administrator for more information.
group <group> This keyword is available when the LDAP server must No default.
authenticate that a user is a member of this group on the LDAP
server.
filter <group_filter> Enter the name of the filter for group searches. The search for
the group on the LDAP server is done with the following default
filter configuration:
(&(objectcategory=group)(member=*))
secure <auth_port> Select the port to be used in authentication. disable
{disable | starttls | disable - port 389
ldaps} ldaps - port 636
starttls - port 389
ca-cert <cert_name> This keyword is available when secure is set to ldaps or null
starttls. User authentication will take place via a CA
certificate. The CA certificate will be used by the LDAP library
to validate the public certificate provided by the LDAP server.

Example
This example shows how to add an LDAP server called LDAP1 using the IP address 23.64.67.44,
the default port, the common name cn, and the distinguished names
ou=marketing,dc=fortinet,dc=com for simple authentication.
config user ldap
edit LDAP1
set server 23.64.67.44
set cnid cn
set dn ou=marketing,dc=fortinet,dc=com
end
This example shows how to change the distinguished name in the example above to
ou=accounts,ou=marketing,dc=fortinet,dc=com.
config user ldap
edit LDAP1
set dn ou=accounts,ou=marketing,dc=fortinet,dc=com
end

FortiGate CLI Version 3.0 MR6 Reference

474 01-30006-0015-20080205
user ldap

History

FortiOS v2.80 Revised.

FortiOS v3.00 MR2 Added key word/variable group <group>.
FortiOS v3.00 MR3 Added keywords filter, secure, ca-cert.

Related topics
• user group
• user local
• user radius
• user tacacs+

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 475
local user

local
Use this command to add local user names and configure user authentication for the FortiGate unit. To
add authentication by LDAP or RADIUS server you must first add servers using the config user
ldap and config user radius commands.

Syntax
config user local
edit <username>
set ldap-server <servername>
set passwd <password_str>
set radius-server <servername>
set status {enable | disable}
set type <auth-type>
end
Keywords and variables Description Default
edit <username> Enter the user name. Enter a new name to create a new user
account or enter an existing user name to edit that account.
ldap-server <servername> Enter the name of the LDAP server with which the user must No default.
authenticate. You can only select an LDAP server that has
been added to the list of LDAP servers. See “ldap” on
page 473.
This is available when type is set to ldap.
passwd <password_str> Enter the password with which the user must authenticate. No default.
Passwords at least 6 characters long provide better security
than shorter passwords.
This is available when type is set to password.
radius-server Enter the name of the RADIUS server with which the user must No default.
<servername> authenticate. You can only select a RADIUS server that has
been added to the list of RADIUS servers. See “radius” on
page 481.
This is available when type is set to radius.
status {enable | disable} Enter enable to allow the local user to authenticate with the enable
FortiGate unit.
type <auth-type> Enter one of the following to specify how this user’s password is No default.
verified:
ldap The LDAP server specified in
ldap-server verifies the password.
password The FortiGate unit verifies the password
against the value of passwd.
radius The RADIUS server specified in
radius-server verifies the password.

Example
This example shows how to add and enable a local user called Admin7 for authentication using the
RADIUS server RAD1.
config user local
edit Admin7
set status enable
set type radius
set radius-server RAD1
end

FortiGate CLI Version 3.0 MR6 Reference

476 01-30006-0015-20080205
user local

This example shows how to change the authentication method for the user Admin7 to password and
enter the password.
config user local
edit Admin7
set type password
set passwd abc123
end

History

FortiOS v2.80 Revised.

FortiOS v2.80 MR2 Removed try_other keyword.

Related topics
• user group
• user ldap
• user radius
• user tacacs+

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 477
peer user

peer
Use this command to add or edit peer (digital certificate holder) information. You use the peers you
define here in the config vpn ipsec phase1 command if you specify peertype as peer. Also,
you can add these peers to peer groups you define in the config user peergrp command.
For PKI user authentication, you can add or edit peer information and configure use of LDAP server to
check access rights for client certificates.
This command refers to certificates imported into the FortiGate unit. You import CA certificates using
the vpn certificate ca command. You import local certificates using the vpn certificate
local command.
You can configure a peer user with no values in subject or ca. This user behaves like a user account
or policy that is disabled.

Note: If you create a PKI user in the CLI with no values in subject or ca, you cannot open the user
record in the GUI, or you will be prompted to add a value in Subject (subject) or CA (ca).

Syntax
config user peer
edit <peer_name>
set ca <ca_name>
set cn <cn_name>
set cn-type <type>
set ldap-password <ldap_password>
set ldap-server <ldap_server>
set ldap-username <ldap_user>
set subject <constraints>
end

Keywords and variables Description Default

ca <ca_name> Enter the CA certificate name, as returned by execute vpn No default.
certificate ca list.
cn <cn_name> Enter the peer certificate common name. No default.
cn-type <type> Enter the peer certificate common name type: string
FQDN Fully-qualified domain name.
email The user’s email address.
ipv4 The user’s IP address (IPv4).
ipv6 The user’s IP address (IPv6).
string Any other piece of information.
edit <peer_name> Enter the peer name. Enter a new name to create a new peer or No default.
enter an existing peer name to edit that peer’s information.
ldap-password Enter the login password for the LDAP server used to perform No default.
<ldap_password> client access rights check for the defined peer.
ldap-server Enter the name of one of the LDAP servers defined under ‘config null
<ldap_server> user ldap’ used to perform client access rights check for the defined
peer.
ldap-username Enter the login name for the LDAP server used to perform client null
<ldap_user> access rights check for the defined peer.
subject <constraints> Optionally, enter any of the peer certificate name constraints. No default.

FortiGate CLI Version 3.0 MR6 Reference

478 01-30006-0015-20080205
user peer

Example
This example shows how to add the branch_office peer.
Configure the peer using the CA certificate name and peer information:
config user peer
edit branch_office
set ca CA_Cert_1
set cn [email protected]
set cn-type email
end
Configure the peer with empty subject and ca fields.
config user peer
edit peer2
end

History

FortiOS v2.80 MR2 New.

FortiOS v3.0 MR4 Addition of ldap-password, ldap-server, ldap-username for use
of LDAP servers for PKI user authentication.
FortiOS v3.0 MR5 Addition of cn-type <type> ipv6 for authentication of IPv6 IPSec.
FortiOS v3.0 MR6 Added description of empty subject and ca fields.

Related topics
• user peergrp
• vpn ipsec phase1
• vpn certificate ca
• vpn certificate local

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 479
peergrp user

peergrp
Use this command to add or edit a peer group. Peers are digital certificate holders defined using the
config user peer command. You use the peer groups you define here in the config vpn ipsec
phase1 command if you specify peertype as peergrp.
For PKI user authentication, you can add or edit peer group member information. User groups that use
PKI authentication can also be configured using config user group.

Syntax
config user peergrp
edit <groupname>
set member <peer_names>
end

Keywords and variables Description Default

edit <groupname> Enter a new name to create a new peer group or enter an
existing group name to edit that group.
member <peer_names> Enter the names of peers to add to the peer group. Separate No default.
names by spaces. To add or remove names from the group you
must re-enter the whole list with the additions or deletions
required.

Example
This example shows how to add peers to the peergrp EU_branches.
config user peergrp
edit EU_branches
set member Sophia_branch Valencia_branch Cardiff_branch
end

History

FortiOS v2.80 MR2 New.

Related topics
• user peer
• vpn ipsec phase1
• vpn l2tp
• vpn pptp

FortiGate CLI Version 3.0 MR6 Reference

480 01-30006-0015-20080205
user radius

radius
Use this command to add or edit the information used for RADIUS authentication.
The default port for RADIUS traffic is 1812. If your RADIUS server is using a different port you can
change the default RADIUS port. You may set a different port for each of your RADIUS servers.
The RADIUS server is now provided with more information to make authentication decisions, based on
values in server, use-management-vdom, use-group-for-profile, and nas-ip.
Attributes include:
• NAS-IP-Address - RADIUS setting or IP address of FortiGate interface used to talk to RADIUS
server, if not configured
• NAS-Port - physical interface number of the traffic that triggered the authentication
• Called-Station-ID - same value as NAS-IP Address but in text format
• Fortinet-Vdom-Name - name of VDOM of the traffic that triggered the authentication
• NAS-Identifier - configured hostname in non-HA mode; HA cluster group name in HA mode
• Acct-Session-ID - unique ID identifying the authentication session
• Connect-Info - identifies the service for which the authentication is being performed (web-auth,
vpn-ipsec, vpn-pptp, vpn-l2tp, vpn-ssl, admin-login, test)
You may select an alternative authentication method for each server. These include CHAP, PAP, MS-
CHAP, and MS-CHAP-v2.

Syntax
config user radius
edit <server_name>
set all-usergroup {enable | disable}
set auth-type {auto | chap | ms_chap | ms_chap_v2 | pap}
set nas-ip <use_ip>
set radius-port <radius_port_num>
set secondary-secret <sec_server_password>
set secondary-server <sec_server_domain>
set secret <server_password>
set server <domain>
set use-group-for-profile {enable | disable}
set use-management-vdom {enable | disable}
end

Keywords and variables Description Default

edit <server_name> Enter a name to identify the RADIUS server.
Enter a new name to create a new server definition or enter an
existing server name to edit that server definition.
all-usergroup {enable | Enable to automatically include this RADIUS server in all user disable
disable} groups.
auth-type {auto | chap | Select the authentication method for this RADIUS server. auto
ms_chap | ms_chap_v2 | auto uses pap, ms_chap_v2, and chap.
pap}
nas-ip <use_ip> IP address used as NAS-IP-Address and No default.
Called-Station-ID attribute in RADIUS access requests.
RADIUS setting or IP address of FGT interface used to talk with
RADIUS server, if not configured.
radius-port Change the default RADIUS port for this server. The default port 1812
<radius_port_num> for RADIUS traffic is 1812. Range is 0..65535.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 481
radius user

Keywords and variables Description Default

secondary-secret Enter the secondary RADIUS server shared secret. No default.
<sec_server_password>
secondary-server Enter the secondary RADIUS server domain name or IP No default.
<sec_server_domain> address.
secret <server_password> Enter the RADIUS server shared secret. No default.
server <domain> Enter the RADIUS server domain name or IP address. No default.
use-management-vdom Enable to use the management VDOM to send all RADIUS disable
{enable | disable} requests.
use-group-for-profile Enable to use RADIUS group attribute to select the protection disable
{enable | disable} profile.

Example
This example shows how to add the radius server RAD1 at the IP address 206.205.204.203 and set
the shared secret as R1a2D3i4U5s.
config user radius
edit RAD1
set secret R1a2D3i4U5s
set server 206.205.204.203
end

History

FortiOS v2.80 Revised.

FortiOS v3.0 MR3 Added use-management-vdom, use-group-for-profile,
nas-ip. Description of additional authentication attributes.
FortiOS v3.0 MR4 Added secondary-server and secondary-secret.
FortiOS v3.0 MR5 Added all-usergroup.
FortiOS v3.0 MR6 Added auth-type {auto | chap | ms_chap | ms_chap_v2 |
pap}, and radius-port.

Related topics
• user group
• user ldap
• user local
• user tacacs+

FortiGate CLI Version 3.0 MR6 Reference

482 01-30006-0015-20080205
user settings

settings
Use this command to change per VDOM user settings such as the firewall user authentication time out
and protocol support for firewall policy authentication.
user settings differ from system global settings in that system global settings
keywords apply to the entire FortiGate unit, where user settings keywords apply only to the user
VDOM.

Syntax
config user setting
set auth-cert <cert_name>
set auth-keepalive {enable | disable}
set auth-secure-http {enable | disable}
set auth-type {ftp | http | https | telnet}
set auth-timeout <auth_timeout_minutes>
end
Keywords and variables Description Default
auth-cert <cert_name> HTTPS server certificate for policy authentication. self-
Fortinet_Factory, Fortinet_Firmware (if applicable to your sign
FortiGate unit), and self-sign are built-in certificates but others
will be listed as you add them.
auth-keepalive Enable to extend the authentication time of the session through disable
{enable | disable} periodic traffic to prevent an idle timeout.
auth-secure-http Enable to have http user authentication redirected to secure disable
{enable | disable} channel - https.
auth-type {ftp | http | Set the user authentication protocol support for firewall policy
https | telnet} authentication. User controls which protocols should support the
authentication challenge.
auth-timeout Set the number of minutes before the firewall user 5
<auth_timeout_minutes> authentication timeout requires the user to authenticate again.
The maximum authtimeout interval is 480 minutes (8 hours).
To improve security, keep the authentication timeout at the
default value of 5 minutes.

Example
This example shows how to enable https user authentication, and set the firewall user authentication
timeout to 15 minutes.
config user setting
set auth-type https
set auth-timeout 15
end

History

FortiOS v3.0 MR6 New. Replaces system global variables authtimeout, auth-
type, and auth-secure-http

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 483
tacacs+ user

tacacs+
Use this command to add or edit the information used for TACACS+ authentication.
Terminal Access Controller Access-Control System (TACACS+) is a remote authentication protocol
used to communicate with an authentication server. TACACS+ allows a client to accept a username
and password and send a query to a TACACS+ authentication server. The server host determines
whether to accept or deny the request and sends a response back that allows or denies network
access to the user.
The default port for a TACACS+ server is 49.
You may select an alternative authentication method for each server. These include CHAP, PAP, MS-
CHAP, and ASCII.

Syntax
config user tacacs+
edit <server_name>
set authen-type {ascii | auto | chap | ms_chap | pap}
set key <server_key>
set tacacs+-port <tacacs+_port_num>
set server <domain>
end

Keywords and variables Description Default

edit <server_name> Enter a name to identify the TACACS+ server.
Enter a new name to create a new server definition or enter an
existing server name to edit that server definition.
authen-type {ascii | auto Select the authentication method for this TACACS+ server. auto
| chap | ms_chap | pap} auto uses pap, ms_chap_v, and chap, in that order.
key <server_key> Enter the key to access the server.
tacacs+-port Change the default TACACS+ port for this server. The default 49
<tacacs+_port_num> port for TACACS+ traffic is 49. Range is 0..65535.
server <domain> Enter the RADIUS server domain name or IP address. No default.

Example
This example shows how to add the TACACS+ server TACACS1 at the IP address
206.205.204.203, set the server key as R1a2D3i4U5s, and authenticate using PAP.
config user tacacs+
edit TACACS1
set authen-type pap
set key R1a2D3i4U5s
set server 206.205.204.203
end

History

FortiOS v3.0 MR6 New.

FortiGate CLI Version 3.0 MR6 Reference

484 01-30006-0015-20080205
user tacacs+

Related topics
• user group
• user local
• user ldap
• user radius

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 485
tacacs+ user

FortiGate CLI Version 3.0 MR6 Reference

486 01-30006-0015-20080205
vpn

vpn
Use vpn commands to configure options related to virtual private networking through the FortiGate
unit, including:
• IPSec operating parameters
• a local address range for PPTP or L2TP clients
• SSL VPN configuration settings
This chapter contains the following sections:

certificate ca
certificate crl
certificate local
certificate ocsp
certificate remote
ipsec concentrator
ipsec forticlient
ipsec manualkey
ipsec manualkey-interface
ipsec phase1
ipsec phase1-interface
ipsec phase2
ipsec phase2-interface
l2tp
pptp
ssl monitor
ssl settings
ssl web bookmarks
ssl web bookmarks-group
ssl web favorite

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 487
certificate ca vpn

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 vpn certificate local 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 vpn certificate local command to install the signed local certificate.
4 Use the vpn certificate ca command to install the CA certificate.
5 Use the vpn certificate crl command to install the CRL.
Depending on your terminal software, you can copy the certificate and paste it into the command.

Syntax
config vpn certificate ca
edit <ca_name>
set ca <cert>
end
To view all of the information about the certificate, use the get command:
get vpn certificate ca <ca_name>

<keyword> Description
edit <ca_name> Enter a name for the CA certificate.
ca <cert> Enter or retrieve the CA certificate in PEM format.

History

FortiOS v3.0 New.

Related topics
• vpn certificate crl
• vpn certificate local
• vpn certificate ocsp
• vpn certificate remote
• execute vpn certificate ca

FortiGate CLI Version 3.0 MR6 Reference

488 01-30006-0015-20080205
vpn certificate crl

certificate crl
Use this command to install a Certificate Revocation List (CRL).
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 vpn certificate local 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 vpn certificate local command to install the signed local certificate.
4 Use the vpn certificate ca command to install the CA certificate.
5 Use the vpn certificate crl command to install the CRL.
Depending on your terminal software, you can copy the certificate and paste it into the command.
The CRL now updates automatically from a remove server.

Syntax
config vpn certificate crl
edit <crl_name>
set crl <crl_PEM>
set ldap-server <ldap_server_name>
set ldap-username <ldap_username>
set ldap-password <ldap_password>
set scep-cert <scep_certificate>
set scep-url <scep_url>
set update-vdom <update_vdom>
set http-url <http_url>
end
<keyword> Description
edit <crl_name> Enter a name for the Certificate Revocation List (CRL).
crl <crl_PEM> Enter the CRL in PEM format.
ldap-server Name of the LDAP server defined in config user ldap table for CRL auto-update.
<ldap_server_name>
ldap-username LDAP login name.
<ldap_username>
ldap-password LDAP login password.
<ldap_password>
scep-cert Local certificate used for SCEP communication for CRL auto-update.
<scep_certificate>
scep-url URL of the SCEP server used for automatic CRL certificate updates. Start with http://.
<scep_url>
update-vdom VDOM used to communicate with remote SCEP server for CRL auto-update.
<update_vdom>
http-url URL of an http server used for automatic CRL certificate updates. Start with http://.
<http_url>

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 489
certificate crl vpn

History

FortiOS v3.0 New.

FortiOS v3.0 MR4 Added variables for use with certificate authentication (automatic CRL updates).

Related topics
• vpn certificate ca
• vpn certificate local
• vpn certificate ocsp
• vpn certificate remote
• execute vpn certificate crl

FortiGate CLI Version 3.0 MR6 Reference

490 01-30006-0015-20080205
vpn certificate local

certificate local
Use this command to install local 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 vpn certificate local 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 vpn certificate local command to install the signed local certificate.
4 Use the vpn certificate ca command to install the CA certificate.
5 Use the vpn certificate crl command to install the CRL.
Depending on your terminal software, you can copy the certificate and paste it into the command.
Syntax
config vpn certificate local
edit <cert_name>
set password <pwd>
set comments <comment_text>
set private-key <prkey>
set certificate <cert_PEM>
set csr <csr_PEM>
end
To view all of the information about the certificate, use the get command:
get vpn certificate local [cert_name]

<keyword> Description
edit <cert_name> Enter the local certificate name.
certificate <cert_PEM> Enter the signed local certificate in PEM format.
comments <comment_text> Enter any relevant information about the certificate.
You should not modify the following variables if you generated the CSR on this unit.
csr <csr_PEM> The CSR in PEM format.
password <pwd> The password in PEM format.
private-key <prkey> The private key in PEM format.

History
FortiOS v3.0 New.
FortiOS v3.0 MR6 Added comments field.

Related topics
• vpn certificate ca
• vpn certificate crl
• vpn certificate ocsp
• vpn certificate remote
• execute vpn certificate local

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 491
certificate ocsp vpn

certificate ocsp
Use this command to install remote certificates. The remote certificates are public certificates without a
private key. They are used as OCSP (Online Certificate Status Protocol) server certificates.

Syntax
config vpn certificate ocsp
edit cert <cert_name>
set url <ocsp_url>
set unavail-action <unavailable_action>
end
To view all of the information about the certificate, use the get command:
get vpn certificate ocsp [cert_name]

<keyword> Description
cert <cert_name> Enter the OCSP server public certificate (one of the remote certificates).
url <ocsp_url> Enter the URL of the OCSP server.
unavail-action Action taken on client certification when the OCSP server is unreachable.
<unavailable_action> revoke or ignore. Default is revoke.

History

FortiOS v3.0 MR4 New.

Related topics
• vpn certificate local
• vpn certificate ca
• vpn certificate crl
• vpn certificate remote
• execute vpn certificate remote

FortiGate CLI Version 3.0 MR6 Reference

492 01-30006-0015-20080205
vpn certificate remote

certificate remote
Use this command to install remote certificates. The remote certificates are public certificates without a
private key. They are used as OCSP (Online Certificate Status Protocol) server certificates.

Syntax
config vpn certificate remote
edit cert <cert_name>
set remote <remote_cert_detail>
end
To view all of the information about the certificate, use the get command:
get vpn certificate remote [cert_name]

<keyword> Description
cert <cert_name> Enter the name of the public certificate.
remote Details/description of the remote certificate.
<remote_cert_detail>

History

FortiOS v3.0 MR4 New.

Related topics
• vpn certificate local
• vpn certificate ca
• vpn certificate crl
• vpn certificate ocsp
• execute vpn certificate remote

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 493
ipsec concentrator vpn

ipsec concentrator
Use this command to add IPSec policy-based VPN tunnels to a VPN concentrator. The VPN
concentrator collects hub-and-spoke tunnels into a group.
The concentrator allows VPN traffic to pass from one tunnel to the other through the FortiGate unit.
The FortiGate unit functions as a concentrator, or hub, in a hub-and-spoke network.

Note: VPN concentrators are not available in Transparent mode.

Syntax
config vpn ipsec concentrator
edit <concentrator_name>
set member <member_name> [<member_name>] [<member_name>]
end

Note: The member keyword is required.

Variables Description Default

edit <concentrator_name> Enter a name for the concentrator. No default.
member <member_name> Enter the names of up to three VPN tunnels to add to the No default.
[member_name] concentrator. Separate the tunnel names with spaces.
Members can be tunnels defined in vpn ipsec phase1 or
[member_name] vpn ipsec manual-key.
To add or remove tunnels from the concentrator you must re-
enter the whole list with the required additions or deletions.

Example
Use the following commands to add an IPSec VPN concentrator named Concen_1 and add three
tunnels to the concentrator.
config vpn ipsec concentrator
edit Concen_1
set member Tunnel_1 Tunnel_2 Tunnel_3
end

History
FortiOS v2.80 Revised.
FortiOS v2.80 MR4 Method for adding concentrators changed.
FortiOS v3.0 Members must now be phase1 configurations, not phase2.

Related topics
• vpn ipsec phase1
• vpn ipsec manualkey

FortiGate CLI Version 3.0 MR6 Reference

494 01-30006-0015-20080205
vpn ipsec forticlient

ipsec forticlient
Use this command to configure automatic VPN configuration for FortiClient Host Security application
users.
The FortiClient users who will use automatic configuration must be members of a user group. The
config vpn ipsec forticlient command creates a “realm” that associates the user group with
the phase 2 VPN configuration. You can create multiple realms to associate different user groups with
different phase 2 configurations.
The user group identifies the user name and password settings that the dialup client’s credentials must
match in order for authentication to be successful. The phase 2 tunnel definition and its associated
firewall encryption policy provides the configuration parameters to download to the FortiClient Host
Security application.

Syntax
Set or unset VPN policy distribution parameters.
config vpn ipsec forticlient
edit <realm_name>
set phase2name <tunnel_name>
set status {disable | enable}
set usergroupname <group_name>
end
Variables Description Default
edit <realm_name> Enter a name for the FortiClient realm. This is also referred to No default.
as the policy name.
phase2name <tunnel_name> Enter the name of the phase 2 tunnel configuration that you Null.
defined as part of the dialup-client configuration.
status {disable | enable} Enable or disable IPSec VPN policy distribution. enable
usergroupname <group_name> Enter the name of the user group that you created for dialup Null.
clients. This group must already exist.

Example
The following example enables VPN policy distribution for a user group called Dialup_users. The
phase 2 tunnel configuration named FG1toDialup_tunnel provides the FortiGate unit with the
information it needs to find and apply the associated firewall encryption policy:
config vpn ipsec forticlient
edit Standard_VPN_policy
set phase2name FG1toDialup_tunnel
set usergroupname Dialup_users
set status enable
end

History

FortiOS v3.0 New.

Related topics
• vpn ipsec phase2
• user group

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 495
ipsec manualkey vpn

ipsec manualkey
Use this command to configure manual keys for IPSec tunnel-mode VPN tunnels. You configure a
manual key tunnel to create an IPSec tunnel-mode VPN tunnel between the FortiGate unit and a
remote IPSec VPN client or gateway that is also using manual key.
A manual key VPN tunnel consists of a name for the tunnel, the IP address of the VPN gateway or
client at the opposite end of the tunnel, and the encryption and authentication algorithms to use for the
tunnel. Because the keys are created when you configure the tunnel, no negotiation is required for the
VPN tunnel to start. However, the VPN gateway or client that connects to this tunnel must use the
same encryption and authentication algorithms and must have the same encryption and authentication
keys.

Syntax
config vpn ipsec manualkey
edit <tunnel_name>
set authentication <authentication_algortihm>
set authkey <authentication_key>
set encryption <method>
set enckey <encryption_key>
set interface <interface_name>
set localspi <local_spi_number>
set local-gw <address_ipv4>
set remote-gw <address_ipv4>
set remotespi <remote_spi_number>
end
Note: The authentication, encryption, interface, remote-gw, localspi, and remotespi keywords
are required. All other keywords are optional.

Variables Description Default

edit <tunnel_name> Enter a name for the tunnel. No default.
authentication Enter one of the following authentication algorithms: null
<authentication_algortihm> • md5
• null
• sha1
Make sure you use the same algorithm at both ends of the
tunnel.
Note: encryption and authentication cannot both be
null.
authkey This keyword is available when authentication is set to -
<authentication_key> md5 or sha1. (No default.)
• If authentication is md5, enter a 32 digit (16 byte)
hexadecimal number. Separate each 16 digit (8 byte)
hexadecimal segment with a hyphen.
• If authentication is sha1, enter a 40 digit (20 byte)
hexadecimal number. Use a hyphen to separate the first
16 digits (8 bytes) from the remaining 24 digits (12 bytes).
Digits can be 0 to 9, and a to f.
Use the same authentication key at both ends of the tunnel.

FortiGate CLI Version 3.0 MR6 Reference

496 01-30006-0015-20080205
vpn ipsec manualkey

Variables Description Default

encryption <method> Enter one of the following encryption algorithms: null
• 3des
• aes128
• aes192
• aes256
• des
• null
Make sure you use the same algorithm at both ends of the
tunnel.
Note: encryption and authentication cannot both be
null.
enckey This keyword is available when encryption is set to 3des, -
<encryption_key> aes128, aes192, aes256, or des. Enter the associated (No default.)
encryption key:
• If encryption is des, enter a 16 digit (8 byte)
hexadecimal number.
• If encryption is 3des, enter a 48 digit (24 byte)
hexadecimal number.
• If encryption is aes128, enter a 32 digit (16 byte)
hexadecimal number.
• If encryption is aes192, enter a 48 digit (24 byte)
hexadecimal number.
• If encryption is aes256, enter a 64 digit (32 byte)
hexadecimal number.
Digits can be 0 to 9, and a to f.
For all of the above, separate each 16 digit (8 byte)
hexadecimal segment with a hyphen.
Use the same encryption key at both ends of the tunnel.
interface <interface_name> Enter the name of the physical, aggregate, or VLAN Null.
interface to which the IPSec tunnel will be bound. The
FortiGate unit obtains the IP address of the interface from
system interface settings (see “interface” on page 373).
You cannot change interface if a firewall policy
references this VPN.
localspi Local Security Parameter Index. Enter a hexadecimal 0x100
<local_spi_number> number of up to eight digits (digits can be 0 to 9, a to f) in the
range 0x100 to FFFFFFF. This number must be added to the
Remote SPI at the opposite end of the tunnel.
local-gw <address_ipv4> Optionally specify an IP address for the local end of the VPN 0.0.0.0
tunnel. The IP address will be assigned to the physical,
aggregate, or VLAN interface that is currently selected in
interface. If you do not specify an IP address here, the
FortiGate unit obtains the IP address of the interface from
the system interface settings (see “interface” on page 373).
remote-gw <address_ipv4> The IP address of the remote gateway external interface. 0.0.0.0
remotespi Remote Security Parameter Index. Enter a hexadecimal 0x100
<remote_spi_number> number of up to eight digits in the range 0x100 to FFFFFFF.
This number must be added to the Local SPI at the opposite
end of the tunnel.

Example
Use the following command to add an IPSec VPN manual key tunnel with the following characteristics:
• Tunnel name: Manual_Tunnel
• Local SPI: 1000ff
• Remote SPI: 2000ff
• Remote gateway IP address: 206.37.33.45

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 497
ipsec manualkey vpn

• Encryption algorithm: 3DES

• Encryption keys: 003f2b01a9002f3b 004f4b0209003f01 3b00f23bff003eff
• Authentication algorithm: MD5
• Authentication keys: ff003f012ba900bb 00f402303f0100ff
config vpn ipsec manualkey
edit Manual_Tunnel
set localspi 1000ff
set remotespi 2000ff
set remote-gw 206.37.33.45
set encryption 3des
set enckey 003f2b01a9002f3b-004f4b0209003f01-3b00f23bff003eff
set authentication md5
set authkey ff003f012ba900bb-00f402303f0100ff
end

History

FortiOS v2.80 Revised

FortiOS v2.80 MR3 concentrator keyword available in NAT/Route mode only.
FortiOS v3.0 Removed concentrator keyword. Renamed gateway keyword to
remote-gw. Added interface keyword.
FortiOS v3.0 MR3 Added local-gw keyword.
FortiOS v3.0 MR5 encryption and authentication cannot both be null.

Related topics
• vpn ipsec phase2

FortiGate CLI Version 3.0 MR6 Reference

498 01-30006-0015-20080205
vpn ipsec manualkey-interface

ipsec manualkey-interface
Use this command to configure manual keys for a route-based (interface mode) IPSec VPN tunnel.
When you create a route-based tunnel, the FortiGate unit creates a virtual IPSec interface
automatically. The interface can be modified afterward using the system network interface CLI
command. This command is available only in NAT/Route mode.

Syntax
config vpn ipsec manualkey-interface
edit <tunnel_name>
set auth-alg <authentication_algortihm>
set auth-key <authentication_key>
set enc-alg <method>
set enc-key <encryption_key>
set interface <interface_name>
set ip-version <4 | 6>
set local-gw <address_ipv4>
set local-gw6 <address_ipv6>
set local-spi <local_spi_number>
set remote-gw <address_ipv4>
set remote-gw6 <address_ipv6>
set remote-spi <remote_spi_number>
end
Note: The auth-alg, enc-alg, interface, remote-gw, local-spi, and remote-spi keywords are
required. All other keywords are optional.

Variables Description Default

edit <tunnel_name> Enter a name for the tunnel. No default.
auth-alg Enter one of the following authentication algorithms: null
<authentication_algortihm> • md5
• null
• sha1
Make sure you use the same algorithm at both ends of the
tunnel.
Note: enc-alg and auth-alg cannot both be null.
auth-key This keyword is available when auth-alg is set to md5 or -
<authentication_key> sha1. (No default.)
• If auth-alg is md5, enter a 32 digit (16 byte) hexadecimal
number. Separate each 16 digit (8 byte) hexadecimal
segment with a hyphen.
• If auth-alg is sha1, enter a 40 digit (20 byte)
hexadecimal number. Use a hyphen to separate the first
16 digits (8 bytes) from the remaining 24 digits (12 bytes).
Digits can be 0 to 9, and a to f.
Use the same authentication key at both ends of the tunnel.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 499
ipsec manualkey-interface vpn

Variables Description Default

enc-alg <method> Enter one of the following encryption algorithms: null
• 3des
• aes128
• aes192
• aes256
• des
• null
Make sure you use the same algorithm at both ends of the
tunnel.
Note: enc-alg and auth-alg cannot both be null.
enc-key This keyword is available when enc-alg is set to 3des, -
<encryption_key> aes128, aes192, aes256, or des. Enter the associated (No default.)
encryption key:
• If enc-alg is des, enter a 16 digit (8 byte) hexadecimal
number.
• If enc-alg is 3des, enter a 48 digit (24 byte) hexadecimal
number.
• If enc-alg is aes128, enter a 32 digit (16 byte)
hexadecimal number.
• If enc-alg is aes192, enter a 48 digit (24 byte)
hexadecimal number.
• If enc-alg is aes256, enter a 64 digit (32 byte)
hexadecimal number.
Digits can be 0 to 9, and a to f.
For all of the above, separate each 16 digit (8 byte)
hexadecimal segment with a hyphen.
Use the same encryption key at both ends of the tunnel.
interface <interface_name> Enter the name of the physical, aggregate, or VLAN Null.
interface to which the IPSec tunnel will be bound. The
FortiGate unit obtains the IP address of the interface from
system interface settings (see “interface” on page 373).
ip-version <4 | 6> Enter 4 for IPv4 encapsulation or 6 for IPv6 encapsulation. 4
local-gw <address_ipv4> By default, the FortiGate unit determines the local gateway 0.0.0.0
local-gw6 <address_ipv6> IP address from the interface setting. Optionally, you can for IPv4
specify a secondary IP address configured on the same
interface.
:: for IPv6
local-gw6 is available when ip-version is 6.
local-gw is available when ip-version is 4.
local-spi Local Security Parameter Index. Enter a hexadecimal 0x100
<local_spi_number> number of up to eight digits (digits can be 0 to 9, a to f) in the
range 0x100 to FFFFFFF. This number must be added to the
Remote SPI at the opposite end of the tunnel.
remote-gw <address_ipv4> The IP address of the remote gateway external interface. 0.0.0.0
remote-gw6 <address_ipv6> remote-gw6 is available when ip-version is 6. for IPv4
remote-gw is available when ip-version is 4.
:: for IPv6
remote-spi Remote Security Parameter Index. Enter a hexadecimal 0x100
<remote_spi_number> number of up to eight digits in the range 0x100 to FFFFFFF.
This number must be added to the Local SPI at the opposite
end of the tunnel.

Example
Use the following command to add a route-based (interface-mode) IPSec VPN tunnel having the
following characteristics:
• Tunnel name: Manual-inf_tunnel
• Local SPI: 1000ff

FortiGate CLI Version 3.0 MR6 Reference

500 01-30006-0015-20080205
vpn ipsec manualkey-interface

• Remote SPI: 2000ff

• VLAN interface name: vlan_1
• Remote gateway IP address: 206.37.33.45
• Encryption algorithm: 3DES
• Encryption keys: 003f2b01a9002f3b 004f4b0209003f01 3b00f23bff003eff
• Authentication algorithm: MD5
• Authentication keys: ff003f012ba900bb 00f402303f0100ff
config vpn ipsec-intf manualkey-interface
edit Manual-inf_tunnel
set auth-alg md5
set auth-key ff003f012ba900bb-00f402303f0100ff
set enc-alg 3des
set enc-key 003f2b01a9002f3b-004f4b0209003f01-3b00f23bff003eff
set interface vlan_1
set local-spi 1000ff
set remote-spi 2000ff
set remote-gw 206.37.33.45
end

History

FortiOS v3.0 New

FortiOS v3.0 MR5 enc-alg and auth-alg cannot both be null
Added ip-version, local-gw6 and remote-gw6 keywords.

Related topics
• vpn ipsec phase2-interface

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 501
ipsec phase1 vpn

ipsec phase1
Use this command to add or edit IPSec tunnel-mode phase 1 configurations. When you add a tunnel-
mode phase 1 configuration, you define how the FortiGate unit and a remote VPN peer (gateway or
client) authenticate themselves to each other as part of establishing an IPSec VPN tunnel.
The phase 1 configuration specifies the name of a remote VPN peer, the nature of the connection
(static IP, dialup, or dynamic DNS), the encryption and authentication keys for the phase 1 proposal,
and the authentication method (preshared key or certificate). For authentication to be successful, the
FortiGate unit and the remote VPN peer must be configured with compatible phase 1 settings.
You can change all settings except the type setting after you define the configuration: if the address
type of a remote peer changes, you must delete the original phase 1 configuration and define a new
one. As a general rule, create only one phase 1 configuration per remote VPN peer.

Syntax
config vpn ipsec phase1
edit <gateway_name>
set add-gw-route {enable | disable}
set authmethod <authentication_method>
set authpasswd <password>
set authusr <user_name>
set authusrgrp <group_name>
set dhgrp {1 2 5}
set dpd {disable | enable}
set dpd-retrycount <retry_integer>
set dpd-retryinterval <seconds> [<milliseconds>]
set interface <interface_name>
set keepalive <seconds>
set keylife <seconds>
set local-gw <address_ipv4>
set localid <local_id>
set mode {aggressive | main}
set nattraversal {disable | enable}
set peer <CA_certificate_name>
set peerid <peer_id>
set peergrp <certificate_group_name>
set peertype <authentication_method>
set priority <prio>
set proposal <encryption_combination>
set psksecret <preshared_key>
set remote-gw <address_ipv4>
set remotegw-ddns <domain_name>
set rsa-certificate <server_certificate>
set type <remote_gw_type>
set usrgrp <group_name>
set xauthtype <XAuth_type>
end
Note: In NAT/Route mode, the interface keyword is required. A remote-gw value may be required
depending on the value of the type attribute. You must also enter a preshared key or a certificate name
depending on the value of authmethod. All other keywords are optional.

FortiGate CLI Version 3.0 MR6 Reference

502 01-30006-0015-20080205
vpn ipsec phase1

Variables Description Default

edit <gateway_name> Enter a name (maximum 35 characters) for this gateway. If No default.
type is dynamic, the maximum name length is further
reduced depending on the number of dialup tunnels that can
be established: by 2 for up to 9 tunnels, by 3 for up to 99
tunnels, 4 for up to 999 tunnels, and so on.
add-gw-route Enable to automatically add a route to the remote gateway disable
{enable | disable} specified in remote-gw. This is effective only when
interface is an interface that obtains its IP address by
DHCP or PPPoE. The route distance is specified in the
interface configuration. See “system interface” on page 373.
authmethod Specify the authentication method: psk
<authentication_method> • Enter psk to authenticate using a pre-shared key. Use
psksecret to enter the pre-shared key.
• Enter rsa-signature to authenticate using a digital
certificate. Use set rsa-certificate to enter the name
of the digital certificate.
You must configure certificates before selecting rsa-
signature here. For more information, see “execute vpn
certificate local” on page 625 and “vpn certificate ca” on
page 488.
authpasswd <password> This keyword is available when xauthtype is set to No default.
client.
Enter the XAuth client password for the FortiGate unit.
authusr <user_name> This keyword is available when xauthtype is set to Null.
client.
Enter the XAuth client user name for the FortiGate unit.
authusrgrp <group_name> This keyword is available when xauthtype is set to auto, Null.
pap, or chap.
When the FortiGate unit is configured as an XAuth server,
enter the user group to authenticate remote VPN peers. The
user group can contain local users, LDAP servers, and
RADIUS servers. The user group must be added to the
FortiGate configuration before the group name can be cross-
referenced. For more information, see “user group” on
page 469, “user ldap” on page 473, “user local” on page 476,
and “user radius” on page 481.
dhgrp {1 2 5} Type 1, 2, and/or 5 to select one or more Diffie-Hellman 5
groups from DH group 1, 2, and 5 respectively.
When using aggressive mode, DH groups cannot be
negotiated.
• If both VPN peers have static IP addresses and use
aggressive mode, enter a single DH Group. The setting on
the FortiGate unit must be identical to the setting on the
remote peer or client.
• When the VPN peer or client has a dynamic IP address and
uses aggressive mode, enter up to three DH groups on the
FortiGate unit and one DH group on the remote peer or
dialup client. The setting on the remote peer or client must
be identical to one of the selections on the FortiGate unit.
• If the VPN peer or client employs main mode, you can
select more than one DH group. At least one of the settings
on the remote peer or client must be identical to the
selections on the FortiGate unit.
distance Configure the administrative distance for routes added when 1
a dialup IPSec connection is established. Using
administrative distance you can specify the relative priorities
of different routes to the same destination. A lower
administrative distance indicates a more preferred route.
Distance can be an integer from 1-255. See also router static
“distance <distance>” on page 292.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 503
ipsec phase1 vpn

Variables Description Default

dpd {disable | enable} Enable or disable DPD (Dead Peer Detection). DPD detects disable
the status of the connection between VPN peers. Enabling
DPD facilitates cleaning up dead connections and
establishing new VPN tunnels. DPD is not supported by all
vendors and is not used unless DPD is supported and
enabled by both VPN peers.
dpd-retrycount This keyword is available when dpd is set to enable. 3
<retry_integer> The DPD retry count when dpd is set to enable. Set the
number of times that the local VPN peer sends a DPD probe
before it considers the link to be dead and tears down the
security association (SA). The dpd-retrycount range is 0
to 10.
To avoid false negatives due to congestion or other transient
failures, set the retry count to a sufficiently high value for your
network.
dpd-retryinterval This keyword is available when dpd is set to enable. 5
<seconds> [<milliseconds>] The DPD (Dead Peer Detection) retry interval is the time that
the local VPN peer waits between sending DPD probes.
Set the time in seconds plus, optionally, milliseconds. For
example, for 2.5 seconds enter 2 500. The range is 1 to 60
seconds, 0 to 999 milliseconds.
When the tunnel is starting, or if it has failed, a retry interval of
5 seconds is used if dpd-retryinterval is less than 5
seconds.
interface <interface_name> Enter the name of the physical, aggregate, or VLAN interface Null.
to which the IPSec tunnel will be bound. The FortiGate unit
obtains the IP address of the interface from system interface
settings (see “interface” on page 373) unless you specify a
different IP address using the local-gw <address_ipv4>
attribute.
You cannot change interface if a firewall policy references
this VPN.
keepalive <seconds> This keyword is available when nattraversal is set to 10
enable.
Set the NAT traversal keepalive frequency. This number
specifies (in seconds) how frequently empty UDP packets are
sent through the NAT device to make sure that the NAT
mapping does not change until P1 and P2 security
associations expire. The keepalive frequency can be from 10
to 900 seconds.
keylife <seconds> Set the keylife time. The keylife is the amount of time (in 28800
seconds) before the phase 1 encryption key expires. When
the key expires, a new key is generated without interrupting
service. The range is 120 to 172,800 seconds.
local-gw <address_ipv4> Optionally specify an IP address for the local end of the VPN 0.0.0.0
tunnel. The IP address will be assigned to the physical,
aggregate, or VLAN interface that is currently selected in
interface. If you do not specify an IP address here, the
FortiGate unit obtains the IP address of the interface from the
system interface settings (see “interface” on page 373).
localid <local_id> Enter a local ID if the FortiGate unit is functioning as a VPN Null.
client and will use the local ID for authentication purposes.
If you want to dedicate a tunnel to a FortiGate dialup client,
you must assign a unique identifier (local ID) to the FortiGate
client.
Whenever you configure a unique identifier (local ID) on a
FortiGate dialup client, you must enable aggressive mode on
the FortiGate dialup server and also specify the identifier as a
peer ID on the FortiGate dialup server.

FortiGate CLI Version 3.0 MR6 Reference

504 01-30006-0015-20080205
vpn ipsec phase1

Variables Description Default

mode {aggressive | main} Enter aggressive or main (ID Protection) mode. Both main
modes establish a secure channel.
In main mode, identifying information is hidden. Main mode is
typically used when both VPN peers have static IP
addresses.
In aggressive mode, identifying information is exchanged in
the clear.
When the remote VPN peer or client has a dynamic IP
address, or the remote VPN peer or client will be
authenticated using an identifier (local ID), you must select
Aggressive mode if there is more than one dialup phase 1
configuration for the interface IP address.
nattraversal {disable | Enable NAT traversal if you expect the IPSec VPN traffic to disable
enable} go through a gateway that performs NAT. If no NAT device is
detected, enabling NAT traversal has no effect. Both ends of
the VPN must have the same NAT traversal setting. If you
enable NAT traversal you can set the keepalive frequency.
peer <CA_certificate_name> This keyword is available when authmethod is set to rsa- Null.
signature and peertype is set to peer.
Enter the name of the peer (CA) certificate that will be used to
authenticate remote VPN clients or peers. Use the command
config user peer to add peer certificates. Peer
certificates must be added to the FortiGate configuration
before they can be cross-referenced. For more information,
see “user peer” on page 478.
peerid <peer_id> This keyword is available when peertype is set to one. Null.
Enter the peer ID that will be used to authenticate remote
clients or peers by peer ID.
peergrp This keyword is available when type is set to dynamic, Null.
<certificate_group_name> authmethod is set to rsa-signature, and peertype is
set to peergrp.
Enter the name of the peer certificate group that will be used
to authenticate remote clients or peers. You must create the
peer certificate group before the group name can be cross-
referenced. For more information, see “user peergrp” on
page 480.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 505
ipsec phase1 vpn

Variables Description Default

peertype The following attributes are available under the following any
<authentication_method> conditions:
• one is available when mode is set to aggressive or when
authmethod is set to rsa-signature.
• dialup is available when type is set to dynamic and
authmethod is set to psk.
• peer is available when authmethod is set to rsa-
signature.
• peergrp is available when type is set to dynamic and
authmethod is set to rsa-signature.
Enter the method for authenticating remote clients or peers
when they connect to the FortiGate unit:
• Type any to accept any remote client or peer (peer IDs are
not used for authentication purposes). The mode attribute
can be set to aggressive or main.
You can use this option with RSA Signature authentication.
But, for highest security, you should configure a PKI
user/group for the peer and set Peer Options to Accept this
peer certificate only.
• Type one to authenticate either a remote peer or client that
has a dynamic IP address and connects using a unique
identifier over a dedicated tunnel, or more than one dialup
client that connects through the same tunnel using the
same (shared) identifier. Use the peerid keyword to set
the peer ID. If more than one dialup client will be connecting
using the same (shared) identifier, set mode to
aggressive.
• Type dialup to authenticate dialup VPN clients that use
unique identifiers and preshared keys (or unique preshared
keys only) to connect to the VPN through the same VPN
tunnel. In this case, you must create a dialup user group for
authentication purposes. Use the usrgrp keyword to set
the user group name. If the dialup clients use unique
identifiers and preshared keys, set mode to aggressive. If
the dialup clients use preshared keys only, set mode to
main.
• Type peer to authenticate one (or more) certificate holders
based on a particular (or shared) certificate. Use the peer
keyword to enter the certificate name. Set mode to
aggressive if the remote peer or client has a dynamic IP
address.
• Type peergrp to authenticate certificate holders that use
unique certificates. In this case, you must create a group of
certificate holders for authentication purposes. Use the
peergrp keyword to set the certificate group name. The
mode attribute can be set to aggressive or main. Set
mode to aggressive if the remote peer or client has a
dynamic IP address.
priority <prio> This value is used to be break ties in selection of dialup 0
routes. In the case that both routes have the same priority,
the egress index for the routes will be used to determine the
selected route.
Set <prio> to a value between 0 and 4 294 967 295.

FortiGate CLI Version 3.0 MR6 Reference

506 01-30006-0015-20080205
vpn ipsec phase1

Variables Description Default

proposal Select a minimum of one and a maximum of three encryption- No default.
<encryption_combination> message digest combinations for the phase 1 proposal (for
example, 3des-md5). The remote peer must be configured
to use at least one of the proposals that you define. Use a
space to separate the combinations.
You can enter any of the following symmetric-key encryption
algorithms:
• 3des-md5
• 3des-sha1
• aes128-md5
• aes128-sha1
• aes192-md5
• aes192-sha1
• aes256-md5
• aes256-sha1
• des-md5
• des-sha1
Here is an explanation of the abbreviated combinations:
• des-Digital Encryption Standard, a 64-bit block algorithm
that uses a 56-bit key.
• 3des-Triple-DES, in which plain text is encrypted three
times by three keys.
• aes128-A 128-bit block algorithm that uses a 128-bit key.
• aes192-A 128-bit block algorithm that uses a 192-bit key.
• aes256-A 128-bit block algorithm that uses a 256-bit key.
You can select either of the following message digests to
check the authenticity of messages during an encrypted
session:
• md5-Message Digest 5, the hash algorithm developed by
RSA Data Security.
• sha1-Secure Hash Algorithm 1, which produces a 160-bit
message digest.
psksecret <preshared_key> This keyword is available when authmethod is set to psk. *
Enter the pre-shared key. The pre-shared key must be the (No
same on the remote VPN gateway or client and should only default.)
be known by network administrators. The key must consist of
at least 6 printable characters. For optimum protection
against currently known attacks, the key should consist of a
minimum of 16 randomly chosen alphanumeric characters.
remote-gw <address_ipv4> This keyword is available when type is set to static. 0.0.0.0
Enter the static IP address of the remote VPN peer.
remotegw-ddns This keyword is available when type is set to ddns. Null.
<domain_name> Enter the identifier of the remote peer (for example, a fully
qualified domain name).
Use this setting when the remote peer has a static domain
name and a dynamic IP address (the IP address is obtained
dynamically from an ISP and the remote peer subscribes to a
dynamic DNS service).
rsa-certificate This keyword is available when authmethod is set to rsa- Null.
<server_certificate> signature.
Enter the name of the signed personal certificate for the
FortiGate unit. You must install the server certificate before
you enter the server certificate name. For more information,
see “vpn certificate local” on page 625.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 507
ipsec phase1 vpn

Variables Description Default

type <remote_gw_type> Enter the connection type of the remote gateway: static
• If the remote VPN peer has a static IP address, type
static. Use the remotegw keyword to enter the IP
address.
• If the remote VPN peer has a dynamically assigned IP
address (DHCP or PPPoE), type dynamic.
• If the remote VPN peer has a dynamically assigned IP
address and subscribes to a dynamic DNS service, type
ddns. Use the remotegw-ddns keyword to enter the
domain name of the remote VPN peer.
usrgrp <group_name> This keyword is available when type is set to dynamic, Null.
authmethod is set to psk, and peertype is set to dialup.
Enter the name of the group of dialup VPN clients to
authenticate. The user group must be added to the FortiGate
configuration before it can be cross-referenced here. For
more information, see “user group” on page 469, “user ldap”
on page 473, “user local” on page 476, and “user radius” on
page 481.
xauthtype <XAuth_type> Optionally configure XAuth (eXtended Authentication): disable
• Type disable to disable XAuth.
• Type client to configure the FortiGate unit to act as an
XAuth client. Use the authuser keyword to add the XAuth
user name and password.
• Type auto, pap, or chap to configure the FortiGate unit as
an XAuth server. Use the authusrgrp keyword to specify
the user group containing members that will be
authenticated using XAuth.

Example
Use the following command to add a tunnel-mode IPSec VPN phase 1 configuration with the following
characteristics:
• Phase 1 configuration name: Simple_GW
• Physical interface name: port6
• Remote peer address type: Dynamic
• Encryption and authentication proposal: des-md5
• Authentication method: psk
• Pre-shared key: Qf2p3O93jIj2bz7E
• Mode: aggressive
• Dead Peer Detection: disable
config vpn ipsec phase1
edit Simple_GW
set interface port6
set type dynamic
set proposal des-md5
set authmethod psk
set psksecret Qf2p3O93jIj2bz7E
set mode aggressive
set dpd disable
end

FortiGate CLI Version 3.0 MR6 Reference

508 01-30006-0015-20080205
vpn ipsec phase1

History

FortiOS v2.80 Revised

FortiOS v2.80 MR2 Added two new parameters to the peertype keyword {peer | peergrp}.
Added two new keywords: peer and peergrp.
FortiOS v3.0 Renamed mixed attribute of xauthtype keyword to auto. Renamed remotegw to
remote-gw. Added interface and local-gw attributes. Name of phase 1 definition is
now limited to 15 characters.
Added priority keyword.

Related topics
• vpn ipsec phase2
• user group
• user local
• user peer
• user peergrp
• user radius
• execute vpn certificate local
• vpn certificate ca

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 509
ipsec phase1-interface vpn

ipsec phase1-interface
Use this command to define a phase 1 definition for a route-based (interface mode) IPSec VPN tunnel
that generates authentication and encryption keys automatically. A new interface of type “tunnel” with
the same name is created automatically as the local end of the tunnel.
Optionally, you can create a route-based phase 1 definition to act as a backup for another IPSec
interface. See the monitor-phase1 <phase1> keyword.
To complete the configuration of an IPSec tunnel, you need to:
• configure phase 2 settings (see “ipsec phase2-interface” on page 526)
• configure a firewall policy to pass traffic from the local private network to the tunnel interface
• configure a static route via the IPSec interface to the private network at the remote end of the tunnel
• optionally, define the IP addresses for each end of the tunnel to enable dynamic routing through the
tunnel or to enable pinging of each end of the tunnel for testing

Syntax
config vpn ipsec phase1-interface
edit <gateway_name>
set add-gw-route {enable | disable}
set authmethod <authentication_method>
set authpasswd <password>
set authusr <user_name>
set authusrgrp <group_name>
set default-gw <gw_ip>
set default-gw-priority <int>
set dhgrp {1 2 5}
set dpd {disable | enable}
set dpd-retrycount <retry_integer>
set dpd-retryinterval <seconds> [<milliseconds]
set interface <interface_name>
set ip-version <4 | 6>
set keepalive <seconds>
set keylife <seconds>
set local-gw <address_ipv4>
set local-gw6 <address_ipv6>
set localid <local_id>
set mode {aggressive | main}
set monitor-phase1 <phase1>
set nattraversal {disable | enable}
set peer <CA_certificate_name>
set peerid <peer_id>
set peergrp <certificate_group_name>
set peertype <authentication_method>
set priority <prio>
set proposal <encryption_combination>
set psksecret <preshared_key>
set remote-gw <address_ipv4>
set remote-gw6 <address_ipv6>
set remotegw-ddns <domain_name>
set rsa-certificate <server_certificate>
set type <remote_gw_type>
set usrgrp <group_name>

FortiGate CLI Version 3.0 MR6 Reference

510 01-30006-0015-20080205
vpn ipsec phase1-interface

set xauthtype <XAuth_type>

end
Note: The interface keyword is required. A remote-gw value may be required depending on the value of the
type attribute. You must also enter a preshared key or a certificate name depending on the value of
authmethod. All other keywords are optional.

Variables Description Default

edit <gateway_name> Enter a name (maximum 15 characters) for the remote No default.
gateway. If type is dynamic, the maximum name length is
further reduced depending on the number of dialup tunnels
that can be established: by 2 for up to 9 tunnels, by 3 for up to
99 tunnels, 4 for up to 999 tunnels, and so on
add-gw-route Enable to automatically add a route to the remote gateway disable
{enable | disable} specified in remote-gw. This is effective only when
interface is an interface that obtains its IP address by
DHCP or PPPoE. The route distance is specified in the
interface configuration. See “system interface” on page 373.
authmethod Specify the authentication method: psk
<authentication_method> • Enter psk to authenticate using a pre-shared key. Use
psksecret to enter the pre-shared key.
• Enter rsa-signature to authenticate using a digital
certificate. Use set rsa-certificate to enter the name
of the digital certificate.
You must configure certificates before selecting rsa-
signature here. For more information, see “execute vpn
certificate local” on page 625 and “vpn certificate ca” on
page 488.
authpasswd <password> This keyword is available when xauthtype is set to client. No default.
Enter the XAuth client password for the FortiGate unit.
authusr <user_name> This keyword is available when xauthtype is set to client. Null.
Enter the XAuth client user name for the FortiGate unit.
authusrgrp <group_name> This keyword is available when xauthtype is set to auto, Null.
pap, or chap.
When the FortiGate unit is configured as an XAuth server,
enter the user group to authenticate remote VPN peers. The
user group can contain local users, LDAP servers, and
RADIUS servers. The user group must be added to the
FortiGate configuration before the group name can be cross-
referenced. For more information, see “user group” on
page 469, “user ldap” on page 473, “user local” on page 476,
and “user radius” on page 481.
default-gw <gw_ip> If the IPSec interface has a different default route than other 0.0.0.0
traffic, enter the next hop router IP address. Be sure to set
default-gw-priority to a higher priority (lower value)
than the general default route.
This is available when type is dynamic. The route it creates
is not visible in the routing table.
default-gw-priority <int> If you set default-gw, set the priority to a lower value 0
(higher priority) than the general default route.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 511
ipsec phase1-interface vpn

Variables Description Default

dhgrp {1 2 5} Type 1, 2, and/or 5 to select one or more Diffie-Hellman 5
groups from DH group 1, 2, and 5 respectively.
When using aggressive mode, DH groups cannot be
negotiated.
• If both VPN peers have static IP addresses and use
aggressive mode, enter a single DH Group. The setting on
the FortiGate unit must be identical to the setting on the
remote peer or client.
• When the VPN peer or client has a dynamic IP address and
uses aggressive mode, enter up to three DH groups on the
FortiGate unit and one DH group on the remote peer or
dialup client. The setting on the remote peer or client must
be identical to one of the selections on the FortiGate unit.
• If the VPN peer or client employs main mode, you can
select more than one DH group. At least one of the settings
on the remote peer or client must be identical to the
selections on the FortiGate unit.
distance Configure the administrative distance for routes added when 1
a dialup IPSec connection is established. Using
administrative distance you can specify the relative priorities
of different routes to the same destination. A lower
administrative distance indicates a more preferred route.
Distance can be an integer from 1-255. See also router static
“distance <distance>” on page 292.
dpd {disable | enable} Enable or disable DPD (Dead Peer Detection). DPD detects disable
the status of the connection between VPN peers. Enabling
DPD facilitates cleaning up dead connections and
establishing new VPN tunnels. DPD is not supported by all
vendors and is not used unless DPD is supported and
enabled by both VPN peers.
dpd-retrycount This keyword is available when dpd is set to enable. 3
<retry_integer> The DPD retry count when dpd is set to enable. Set the
number of times that the local VPN peer sends a DPD probe
before it considers the link to be dead and tears down the
security association (SA). The dpd-retrycount range is 0
to 10.
To avoid false negatives due to congestion or other transient
failures, set the retry count to a sufficiently high value for your
network.
dpd-retryinterval This keyword is available when dpd is set to enable. 5
<seconds> [<milliseconds] The DPD (Dead Peer Detection) retry interval is the time that
the local VPN peer waits between sending DPD probes.
Set the time in seconds plus, optionally, milliseconds. For
example, for 2.5 seconds enter 2 500. The range is 1 to 60
seconds, 0 to 999 milliseconds.
When the tunnel is starting, or if it has failed, a retry interval of
5 seconds is used if dpd-retryinterval is less than 5
seconds.
interface Enter the name of the physical, aggregate, or VLAN interface Null.
<interface_name> to which the IPSec tunnel will be bound. The FortiGate unit
obtains the IP address of the interface from system interface
settings (see “interface” on page 373) unless you specify a
different IP address using the local-gw <address_ipv4>
attribute.
ip-version <4 | 6> Enter 4 for IPv4 encapsulation or 6 for IPv6 encapsulation. 4

FortiGate CLI Version 3.0 MR6 Reference

512 01-30006-0015-20080205
vpn ipsec phase1-interface

Variables Description Default

keepalive <seconds> This keyword is available when nattraversal is set to 5
enable.
Set the NAT traversal keepalive frequency. This number
specifies (in seconds) how frequently empty UDP packets are
sent through the NAT device to make sure that the NAT
mapping does not change until P1 and P2 security
associations expire. The keepalive frequency can be from 0 to
900 seconds.
keylife <seconds> Set the keylife time. The keylife is the amount of time (in 28800
seconds) before the phase 1 encryption key expires. When
the key expires, a new key is generated without interrupting
service. The range is 120 to 172,800 seconds.
local-gw <address_ipv4> Optionally specify an IP address for the local end of the VPN 0.0.0.0
local-gw6 <address_ipv6> tunnel. local-gw6 is available when ip-version is 6. for IPv4
local-gw is available when ip-version is 4.
The IP address will be assigned to the physical, aggregate, or :: for IPv6
VLAN interface that is currently selected in interface. If
you do not specify an IP address here, the FortiGate unit
obtains the IP address of the interface from system interface
settings (see “interface” on page 373).
localid <local_id> Enter a local ID if the FortiGate unit is functioning as a VPN Null.
client and will use the local ID for authentication purposes.
If you want to dedicate a tunnel to a FortiGate dialup client,
you must assign a unique identifier (local ID) to the FortiGate
client.
Whenever you configure a unique identifier (local ID) on a
FortiGate dialup client, you must enable aggressive mode on
the FortiGate dialup server and also specify the identifier as a
peer ID on the FortiGate dialup server.
mode {aggressive | main} Enter aggressive or main (ID Protection) mode. Both main
modes establish a secure channel.
In main mode, identifying information is hidden. Main mode is
typically used when both VPN peers have static IP addresses.
In aggressive mode, identifying information is exchanged in
the clear. Aggressive mode is typically used when a remote
peer or dialup client has a dynamic IP address. You must
enable aggressive mode when the remote FortiGate unit has
a dynamic IP address, or the remote VPN peer or client will
be authenticated using an identifier (local ID).
monitor-phase1 <phase1> Optionally, this IPSec interface can act as a backup for Null.
another (primary) IPSec interface. Enter the name of the
primary interface.
The backup interface is used only while the primary interface
is out of service. dpd must be enabled.
A primary interface can have only one backup interface and
cannot act as a backup for another interface.
For a configuration example, see “Example of backup IPSec
interface” on page 518.
nattraversal {disable | Enable NAT traversal if you expect the IPSec VPN traffic to go disable
enable} through a gateway that performs NAT. If no NAT device is
detected, enabling NAT traversal has no effect. Both ends of
the VPN must have the same NAT traversal setting. If you
enable NAT traversal you can set the keepalive frequency.
peer This keyword is available when authmethod is set to rsa- Null.
<CA_certificate_name> signature and peertype is set to peer.
Enter the name of the peer (CA) certificate that will be used to
authenticate remote VPN clients or peers. Use the command
config user peer to add peer certificates. Peer
certificates must be added to the FortiGate configuration
before they can be cross-referenced. For more information,
see “user peer” on page 478.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 513
ipsec phase1-interface vpn

Variables Description Default

peerid <peer_id> This keyword is available when peertype is set to one. Null.
Enter the peer ID that will be used to authenticate remote
clients or peers by peer ID.
peergrp This keyword is available when type is set to dynamic, Null.
<certificate_group_name> authmethod is set to rsa-signature, and peertype is
set to peergrp.
Enter the name of the peer certificate group that will be used
to authenticate remote clients or peers. You must create the
peer certificate group before the group name can be cross-
referenced. For more information, see “user peergrp” on
page 480.
peertype The following attributes are available under the following any
<authentication_method> conditions:
• dialup is available when type is set to dynamic and
authmethod is set to psk.
• peer is available when authmethod is set to rsa-
signature.
• peergrp is available when type is set to dynamic and
authmethod is set to rsa-signature.
Enter the method for authenticating remote clients or peers
when they connect to the FortiGate unit:
• Type any to accept any remote client or peer (peer IDs are
not used for authentication purposes). The mode attribute
can be set to aggressive or main.
You can use this option with RSA Signature authentication.
But, for highest security, you should configure a PKI
user/group for the peer and set Peer Options to Accept this
peer certificate only.
• Type one to authenticate either a remote peer or client that
has a dynamic IP address and connects using a unique
identifier over a dedicated tunnel, or more than one dialup
client that connects through the same tunnel using the
same (shared) identifier. Use the peerid keyword to set
the peer ID. If more than one dialup client will be connecting
using the same (shared) identifier, set mode to
aggressive.
• Type dialup to authenticate dialup VPN clients that use
unique identifiers and preshared keys (or unique preshared
keys only) to connect to the VPN through the same VPN
tunnel. In this case, you must create a dialup user group for
authentication purposes. Use the usrgrp keyword to set
the user group name. If the dialup clients use unique
identifiers and preshared keys, set mode to aggressive. If
the dialup clients use preshared keys only, set mode to
main.
• Type peer to authenticate one (or more) certificate holders
based on a particular (or shared) certificate. Use the peer
keyword to enter the certificate name. Set mode to
aggressive if the remote peer or client has a dynamic IP
address.
• Type peergrp to authenticate certificate holders that use
unique certificates. In this case, you must create a group of
certificate holders for authentication purposes. Use the
peergrp keyword to set the certificate group name. The
mode attribute can be set to aggressive or main. Set
mode to aggressive if the remote peer or client has a
dynamic IP address.
priority <prio> This value is used to be break ties in selection of dialup 0
routes. In the case that both routes have the same priority, the
egress index for the routes will be used to determine the
selected route.
Set <prio> to a value between 0 and 4 294 967 295.

FortiGate CLI Version 3.0 MR6 Reference

514 01-30006-0015-20080205
vpn ipsec phase1-interface

Variables Description Default

proposal Select a minimum of one and a maximum of three encryption- No default.
<encryption_combination> message digest combinations for the phase 1 proposal (for
example, 3des-md5). The remote peer must be configured to
use at least one of the proposals that you define. Use a space
to separate the combinations.
You can enter any of the following symmetric-key encryption
algorithms:
• 3des-md5
• 3des-sha1
• aes128-md5
• aes128-sha1
• aes192-md5
• aes192-sha1
• aes256-md5
• aes256-sha1
• des-md5
• des-sha1
Here is an explanation of the abbreviated combinations:
• des-Digital Encryption Standard, a 64-bit block algorithm
that uses a 56-bit key.
• 3des-Triple-DES, in which plain text is encrypted three
times by three keys.
• aes128-A 128-bit block algorithm that uses a 128-bit key.
• aes192-A 128-bit block algorithm that uses a 192-bit key.
• aes256-A 128-bit block algorithm that uses a 256-bit key.
You can select either of the following message digests to
check the authenticity of messages during an encrypted
session:
• md5-Message Digest 5, the hash algorithm developed by
RSA Data Security.
• sha1-Secure Hash Algorithm 1, which produces a 160-bit
message digest.
psksecret <preshared_key> This keyword is available when authmethod is set to psk. *
Enter the pre-shared key. The pre-shared key must be the (No default.)
same on the remote VPN gateway or client and should only
be known by network administrators. The key must consist of
at least 6 printable characters. For optimum protection
against currently known attacks, the key should consist of a
minimum of 16 randomly chosen alphanumeric characters.
remote-gw <address_ipv4> This keyword is available when type is set to static. 0.0.0.0
remote-gw6 <address_ipv6> Enter the static IP address of the remote VPN peer. for IPv4
remote-gw6 is available when ip-version is 6. remote-gw
is available when ip-version is 4. :: for IPv6
remotegw-ddns This keyword is available when type is set to ddns and Null.
<domain_name> ip-version is set to 4.
Enter the identifier of the remote peer (for example, a fully
qualified domain name).
Use this setting when the remote peer has a static domain
name and a dynamic IP address (the IP address is obtained
dynamically from an ISP and the remote peer subscribes to a
dynamic DNS service).
rsa-certificate This keyword is available when authmethod is set to rsa- Null.
<server_certificate> signature.
Enter the name of the signed personal certificate for the
FortiGate unit. You must install the server certificate before
you enter the server certificate name. For more information,
see “vpn certificate local” on page 625.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 515
ipsec phase1-interface vpn

Variables Description Default

type <remote_gw_type> Enter the connection type of the remote gateway: static
• If the remote VPN peer has a static IP address, type
static. Use the remotegw keyword to enter the IP
address.
• If the remote VPN peer has a dynamically assigned IP
address (DHCP or PPPoE), type dynamic.
• If the remote VPN peer has a dynamically assigned IP
address and subscribes to a dynamic DNS service, type
ddns. Use the remotegw-ddns keyword to enter the
domain name of the remote VPN peer. This option is not
available if ip-version is 6.
usrgrp <group_name> This keyword is available when type is set to dynamic, Null.
authmethod is set to psk, and peertype is set to dialup.
Enter the name of the group of dialup VPN clients to
authenticate. The user group must be added to the FortiGate
configuration before it can be cross-referenced here. For
more information, see “user group” on page 469, “user ldap”
on page 473, “user local” on page 476, and “user radius” on
page 481.
xauthtype <XAuth_type> Optionally configure XAuth (eXtended Authentication): disable
• Type disable to disable XAuth.
• Type client to configure the FortiGate unit to act as an
XAuth client. Use the authuser keyword to add the XAuth
user name and password.
• Type auto, pap, or chap to configure the FortiGate unit as
an XAuth server. Use the authusrgrp keyword to specify
the user group containing members that will be
authenticated using XAuth.

Example of route-based VPN

In this example, an IPSec tunnel is needed between two sites using FortiGate units. Users on the
192.168.2.0/24 network at Site A need to communicate with users on the 192.168.3.0/24 network at
Site B. At Site A, the public IP address is 172.16.67.199 and at Site B it is 172.16.68.198. At both ends:
• Port 2 of the FortiGate unit: connects to the private network
• Port 1 of the FortiGate unit: connects to the Internet
• Encryption and authentication proposal: des-md5
• Authentication method: psk
• Pre-shared key: Qf2p3O93jIj2bz7
• Mode: main
• Dead Peer Detection: enable

Site A configuration Site B configuration

config vpn ipsec phase1-interface config vpn ipsec phase1-interface
edit toSiteB edit toSiteA
set type static set type static
set remote-gw 172.16.68.198 set remote-gw 172.16.68.199
set interface port1 set interface port1
set proposal des-md5 set proposal des-md5
set authmethod psk set authmethod psk
set psksecret Qf2p3O93jIj2bz7 set psksecret Qf2p3O93jIj2bz7
set mode main set mode main
set dpd enable set dpd enable
end end

FortiGate CLI Version 3.0 MR6 Reference

516 01-30006-0015-20080205
vpn ipsec phase1-interface

config vpn ipsec phase2-interface config vpn ipsec phase2-interface

edit New_Tunnel edit New_Tunnel
set phase1name toSiteB set phase1name toSiteA
set proposal 3des-sha1 set proposal 3des-sha1
set keylife-type seconds set keylife-type seconds
set keylifeseconds 18001 set keylifeseconds 18001
set dhgrp 2 set dhgrp 2
set replay enable set replay enable
set pfs enable set pfs enable
set keepalive enable set keepalive enable
end end
config firewall policy config firewall policy
edit 1 edit 1
set src-intf port2 set src-intf port2
set dst-intf toSiteB set dst-intf toSiteA
set srcaddr all set srcaddr all
set dstaddr all set dstaddr all
set action accept set action accept
set service ANY set service ANY
set schedule always set schedule always
next next
edit 2 edit 2
set src-intf toSiteB set src-intf toSiteA
set dst-intf port2 set dst-intf port2
set srcaddr all set srcaddr all
set dstaddr all set dstaddr all
set action accept set action accept
set service ANY set service ANY
set schedule always set schedule always
end end

config route static config route static

edit 1 edit 1
set device toSiteB set device toSiteA
set dst 192.168.3.0/24 set dst 192.168.2.0/24
end end

In this example, the user defines IP addresses for each end of the tunnel to enable dynamic routing
through the tunnel or to enable pinging of each end of the tunnel for testing. The Site A end has the IP
address 10.0.0.1 and the SiteB end is 10.0.0.2.

Site A configuration Site B configuration

(Optional) (Optional)
config system interface config system interface
edit toSiteB edit toSiteA
set ip 10.0.0.1/32 set ip 10.0.0.2/32
set remote-ip 10.0.0.2 set remote-ip 10.0.0.1
set allowaccess ping set allowaccess ping
end end

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 517
ipsec phase1-interface vpn

Example of backup IPSec interface

In this example, the backupToHeadquarters IPSec interface provides failover protection for the
toHeadquarters IPSec interface.
The backupToHeadquarters interface is a backup interface because its monitor-phase1 option is
not null; it is set to monitor the toHeadquarters interface. If the monitored interface goes down, as
determined by Dead Peer Detection, the backup interface becomes active.
The backup interface uses a different physical interface, which could be connected to a different
Internet service provider. The remote gateway can be the same, or it can specify an alternative
gateway, if one exists. Otherwise, the two IPSec interfaces are identically configured.
config vpn ipsec phase1-interface
edit "toHeadquarters"
set interface "wan1"
set remote-gw 172.16.1.10
set dpd enable
... [other phase1 settings as needed]
next
edit "backupToHeadquarters"
set interface "wan2"
set monitor-phase1 "toHeadquarters"
set remote-gw 172.16.1.10
... [other phase1 settings as needed]
end
end

History

FortiOS v3.0 New

FortiOS v3.0 MR5 Added keywords ip-version, local-gw6, remote-gw6.
FortiOS v3.0 MR6 Added keywords default-gw and default-gw-priority.

Related topics
• vpn ipsec phase2-interface
• user group
• user local
• user peer
• user peergrp
• user radius
• vpn certificate local
• vpn certificate ca

FortiGate CLI Version 3.0 MR6 Reference

518 01-30006-0015-20080205
vpn ipsec phase2

ipsec phase2
Use this command to add or edit an IPSec tunnel-mode phase 2 configuration. The FortiGate unit uses
the tunnel-mode phase 2 configuration to create and maintain an IPSec VPN tunnel with a remote
VPN peer (the VPN gateway or client).
The phase 2 configuration consists of a name for the VPN tunnel, the name of an existing phase 1
configuration, the proposal settings (encryption and authentication algorithms) and DH group used for
phase 2. For phase 2 to be successful, the FortiGate unit and the remote VPN peer must be
configured with compatible proposal settings.

Syntax
config vpn ipsec phase2
edit <tunnel_name>
set auto-negotiate {enable | disable}
set dhcp-ipsec {disable | enable}
set dhgrp {1 | 2 | 5}
set dst-addr-type <type>
set dst-end-ip <address_ipv4>
set dst-name <address_name>
set dst-port <destination_port_number>
set dst-start-ip <address_ipv4>
set dst-subnet <address_ipv4mask>
set keepalive {disable | enable}
set keylife-type <keylife_type>
set keylifekbs <kb_integer>
set keylifeseconds <seconds>
set pfs {disable | enable}
set phase1name <gateway_name>
set proposal <encryption_combination>
set protocol <protocol_integer>
set replay {disable | enable}
set route-overlap {overlap_option}
set selector-match <match_type>
set single-source {disable | enable}
set src-addr-type <ip_source_name>
set src-end-ip <address_ipv4>
set src-name <address_name>
set src-port <source_port_number>
set src-start-ip <address_ipv4>
set src-subnet <address_ipv4mask>
set use-natip {enable | disable}
end

Note: The phase1name keyword is required. All other keywords are optional.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 519
ipsec phase2 vpn

Variables Description Default

edit <tunnel_name> Enter a name for the tunnel. No default.
auto-negotiate Enable to negotiate the phase 2 security association (SA) disable
{enable | disable} automatically, even if there is no traffic. This repeats every
five seconds until it succeeds.
You can use this option on a dialup peer to ensure that the
tunnel is available for peers at the server end to initiate traffic
to the dialup peer. Otherwise, the tunnel does not exist until
the dialup peer initiates traffic.
dhcp-ipsec {disable | This keyword is available when phase1name names a disable
enable} dialup gateway configuration.
Enable dhcp-ipsec if the FortiGate unit acts as a dialup
server and FortiGate DHCP relay will be used to assign VIP
addresses to FortiClient dialup clients. The DHCP relay
parameters must be configured separately.
For information about how to configure a DHCP server on a
FortiGate interface, see “system dhcp server” on page 336.
For information about FortiGate DHCP relay, see “system
interface” on page 373.
If the FortiGate unit acts as a dialup server and you manually
assigned FortiClient dialup clients VIP addresses that match
the network behind the dialup server, select Enable to cause
the FortiGate unit to act as a proxy for the dialup clients.
dhgrp {1 | 2 | 5} Type 1, 2 or 5 to select the Diffie-Hellman group to propose 5
for Phase 2 of the IPSec VPN connection. Both VPN peers
must use the same DH Group.
dst-addr-type <type> Enter the type of destination address that corresponds to the subnet
recipient(s) or network behind the remote VPN peer or
FortiGate dialup client:
• To specify the IP address of a server or host, type ip.
Enter the IP address using the dst-start-ip keyword.
• To specify a range of IP addresses, type range. Enter the
starting and ending addresses using the dst-start-ip
and dst-end-ip keywords.
• To specify a network address, type subnet. Enter the
network address using the dst-subnet keyword.
• To specify a firewall address or address group, type name.
Enter the address or address group name using the
dst-name keyword. You must also select the name option
for src-addr-type.
This option is intended for users upgrading VPN
configurations created using FortiOS 2.80. For new VPNs
that use firewall addresses or address groups as selectors,
interface mode VPNs are recommended.
dst-end-ip <address_ipv4> This keyword is available when dst-addr-type is set to 0.0.0.0
range.
Enter the highest destination IP address in the range of IP
addresses.
dst-name <address_name> This keyword is available when dst-addr-type is set to No default.
name. Enter the name of a firewall address or address
group.
dst-port Enter the port number that the remote VPN peer or FortiGate 0
<destination_port_number> dialup client uses to transport traffic related to the specified
service (see protocol). The range is 1 to 65535. To
specify all ports, type 0.
dst-start-ip This keyword is available when dst-addr-type is set to 0.0.0.0
<address_ipv4> range.
Enter the lowest destination IP address in the range of IP
addresses.

FortiGate CLI Version 3.0 MR6 Reference

520 01-30006-0015-20080205
vpn ipsec phase2

Variables Description Default

dst-subnet Enter the IP address and network mask that identifies the 0.0.0.0
<address_ipv4mask> private network behind the remote VPN peer or FortiGate 0.0.0.0
dialup client.
keepalive {disable | Enable to automatically negotiate a new phase 2 security disable
enable} association (SA) before the current SA expires, keeping the
tunnel up. Otherwise, a new SA is negotiated only if there is
traffic.
keylife-type Set when the phase 2 key expires. When the key expires, a seconds
<keylife_type> new key is generated without interrupting service.
• To make the key expire after a period of time has expired
and after an amount of data is transmitted, type both.
• To make the key expire after an amount of data is
transmitted, type kbs. Use the keylifekbs keyword to
set the amount of data that is transmitted.
• To make the key expire after a number of seconds elapses,
type seconds. Use the keylifeseconds keyword to set
the amount of time that elapses.
keylifekbs <kb_integer> This keyword is available when keylife-type is set to 5120
kbs or both.
Set the number of KBytes of data to transmit before the
phase 2 key expires. The range is 5120 to 99999 KBytes.
keylifeseconds <seconds> This keyword is available when keylife-type is set to 1800
seconds or both.
Set the number of seconds to elapse before the phase 2 key
expires. seconds can be 120 to 172800 seconds.
pfs {disable | enable} Optionally, enable or disable perfect forward secrecy (PFS). disable
PFS ensures that each key created during Phase 2 is
unrelated to keys created during Phase 1 or to other keys
created during Phase 2. PFS may cause minor delays during
key generation.
phase1name <gateway_name> Enter a phase 1 gateway configuration name. You must add Null.
the phase 1 gateway definition to the FortiGate configuration
before it can be cross-referenced.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 521
ipsec phase2 vpn

Variables Description Default

proposal Enter a minimum of one and a maximum of three encryption- No default.
<encryption_combination> message digest combinations (for example, 3des-md5).
The remote peer must be configured to use at least one of
the proposals that you define. Use a space to separate the
combinations.
You can enter any of the following symmetric-key encryption
algorithms:
• 3des-md5
• 3des-null
• 3des-sha1
• aes128-md5
• aes128-null
• aes128-sha1
• aes192-md5
• aes192-null
• aes192-sha1
• aes256-md5
• aes256-null
• aes256-sha1
• des-md5
• des-null
• des-sha1
• null-md5
• null-sha1
Here is an explanation of the abbreviated combinations:
• null-Do not use an encryption algorithm.
• des-Digital Encryption Standard, a 64-bit block algorithm
that uses a 56-bit key.
• 3des-Triple-DES, in which plain text is encrypted three
times by three keys.
• aes128-A 128-bit block algorithm that uses a 128-bit key.
• aes192-A 128-bit block algorithm that uses a 192-bit key.
• aes256-A 128-bit block algorithm that uses a 256-bit key.
You can enter either of the following message digests to
check the authenticity of messages during an encrypted
session:
• null-Do not use a message digest.
• md5-Message Digest 5, the hash algorithm developed by
RSA Data Security.
• sha1-Secure Hash Algorithm 1, which produces a 160-bit
message digest.
protocol This keyword is available when selector is set to 0
<protocol_integer> specify.
Enter the IP protocol number for the service. The range is 1
to 255. To specify all services, type 0.
replay {disable | enable} Optionally, enable or disable replay detection. Replay disable
attacks occur when an unauthorized party intercepts a series
of IPSec packets and replays them back into the tunnel.
Enable replay detection to check the sequence number of
every IPSec packet to see if it has been received before. If
packets arrive out of sequence, the FortiGate units discards
them.
You can configure the FortiGate unit to send an alert email
when it detects a replay packet. See “alertemail” on page 63.
route-overlap Specify how FortiGate unit handles multiple dialup users with use-new
{overlap_option} the same IP source address. Set overlap_option to one
of the following:
• allow - allow overlapping routes
• use-new - delete the old route and add the new route
• use-old - use the old route and do not add the new route

FortiGate CLI Version 3.0 MR6 Reference

522 01-30006-0015-20080205
vpn ipsec phase2

Variables Description Default

selector-match The peer’s IPSec selectors are compared to FortiGate auto
<match_type> phase 2 selectors, which are any of src-start-ip /
src-end-ip, src-subnet, dst-subnet, dst-start-
ip / dst-end-ip. The match_type value can be one of:
exact - peer’s selector must match exactly
subset - peer’s selector can be a subset of this selector
auto - use exact or subset match as needed (default)
Note: This keyword is configured automatically when
upgrading a FortiOS version 2.80 VPN to version 3.0. You
should not set this keyword when configuring a new VPN.
single-source {disable | Enable if src-addr-type is name and hosts on the internal disable
enable} network will initiate communication sessions with remote
dialup clients.
src-addr-type If the FortiGate unit is a dialup server, enter the type of subnet
<ip_source_name> source address that corresponds to the local sender(s) or
network behind the FortiGate dialup server:
• To specify the IP address of a server or host, type ip.
Enter the IP address using the src-start-ip keyword.
• To specify a range of IP addresses, type range. Enter
the starting and ending addresses using the src-
start-ip and src-end-ip keywords.
• To specify a network address, type subnet. Enter the
network address using the src-subnet keyword.
• To specify a firewall address or address group, type
name. Enter the address or address group name using
the src-name keyword. You must also select the name
option for dst-addr-type.
This option is intended for users upgrading VPN
configurations created using FortiOS 2.80. For new VPNs
that use firewall addresses or address groups as
selectors, interface mode VPNs are recommended.
If the FortiGate unit is a dialup client, src-addr-type must
refer to the server(s), host(s), or private network behind the
FortiGate dialup client.
src-end-ip <address_ipv4> This keyword is available when src-addr-type is set to 0.0.0.0
range.
Enter the highest source IP address in the range of IP
addresses.
src-name <address_name> This keyword is available when src-addr-type is set to No default.
name. Enter the name of a firewall address or address
group.
src-port If the FortiGate unit is a dialup server, enter the port number 0
<source_port_number> that the FortiGate dialup server uses to transport traffic
related to the specified service (see protocol). If the
FortiGate unit is a dialup client, enter the port number that
the FortiGate dialup client uses to transport traffic related to
the specified service. The src-port range is 1 to 65535.
To specify all ports, type 0.
src-start-ip This keyword is available when src-addr-type is set to 0.0.0.0
<address_ipv4> range.
Enter the lowest source IP address in the range of IP
addresses.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 523
ipsec phase2 vpn

Variables Description Default

src-subnet If the FortiGate unit is a dialup server, enter the IP address 0.0.0.0
<address_ipv4mask> and network mask that identifies the private network behind 0.0.0.0
the FortiGate dialup server. If the FortiGate unit is a dialup
client, enter the IP address and network mask that identifies
the private network behind the FortiGate dialup client.
use-natip By default, when outbound NAT is used, the FortiGate unit enable
{enable | disable} public interface IP address is the source selector. If you
disable use-natip, the source selector is as specified in
src-start-ip / src-end-ip or src-subnet.
Note: This keyword is configured automatically when
upgrading a FortiOS version 2.80 VPN to version 3.0. You
should not set this keyword when configuring a new VPN.

Example
Use the following command to add a tunnel-mode phase 2 configuration with the following
characteristics:
• Name: New_Tunnel
• Phase 1 name: Simple_GW
• Encryption and authentication proposal: 3des-sha1 aes256-sha1 des-md5
• Keylife type: seconds
• Keylife seconds: 18001
• Diffie-Hellman group: 2
• Replay detection: enable
• Perfect forward secrecy: enable
• Keepalive: enable
config vpn ipsec phase2
edit New_Tunnel
set phase1name Simple_GW
set proposal 3des-sha1 aes256-sha1 des-md5
set keylife-type seconds
set keylifeseconds 18001
set dhgrp 2
set replay enable
set pfs enable
set keepalive enable
end

History

FortiOS v2.80 Revised

FortiOS v2.80 MR3 concentrator keyword available in NAT/Route mode only.
FortiOS v2.80 MR7 wildcardid keyword removed.
selector keyword and associated srcaddr, dstaddr, protocol, srcport, and
dstport keywords added.
single-source keyword added.
FortiOS v3.0 Replaced underscore character in keylife-type keyword with a hyphen. Removed
bindtoif, concentrator, internetbrowsing, selector, dstaddr, dstport,
srcaddr, and srcport keywords. Added dst-addr-type, dst-port, dst-subnet,
dst-end-ip, dst-start-ip, src-addr-type, src-port, src-subnet, src-end-
ip, and src-start-ip keywords.
FortiOS v3.0 MR5 Removed null-null option from proposal keyword.

FortiGate CLI Version 3.0 MR6 Reference

524 01-30006-0015-20080205
vpn ipsec phase2

Related topics
• vpn ipsec phase1
• alertemail setting
• alertemail setting
• firewall policy, policy6

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 525
ipsec phase2-interface vpn

ipsec phase2-interface
Use this command to add a phase 2 configuration for a route-based (interface mode) IPSec tunnel or
edit an existing interface-mode phase 2 configuration. This command is available only in NAT/Route
mode.

Syntax
config vpn ipsec phase2-interface
edit <tunnel_name>
set auto-negotiate {enable | disable}
set dhgrp {1 | 2 | 5}
set dst-addr-type <type>
set dst-end-ip <address_ipv4>
set dst-end-ip6 <address_ipv6>
set dst-name <address_name>
set dst-port <destination_port_number>
set dst-start-ip <address_ipv4>
set dst-start-ip6 <address_ipv6>
set dst-subnet <address_ipv4mask>
set dst-subnet6 <address_ipv6mask>
set keepalive {disable | enable}
set keylife-type <keylife_type>
set keylifekbs <kb_integer>
set keylifeseconds <seconds>
set pfs {disable | enable}
set phase1name <gateway_name>
set proposal <encryption_combination>
set protocol <protocol_integer>
set replay {disable | enable}
set route-overlap {overlap_option}
set single-source {disable | enable}
set src-addr-type <ip_source_name>
set src-end-ip <address_ipv4>
set src-end-ip6 <address_ipv6>
set src-name <address_name>
set src-port <source_port_number>
set src-start-ip <address_ipv4>
set src-start-ip6 <address_ipv6>
set src-subnet6 <address_ipv6mask>
set src-subnet6 <address_ipv6mask>
end

Note: The phase1name keyword is required. All other keywords are optional.

FortiGate CLI Version 3.0 MR6 Reference

526 01-30006-0015-20080205
vpn ipsec phase2-interface

Variables Description Default

edit <tunnel_name> Enter a name for the phase 2 tunnel configuration. No default.
auto-negotiate Enable to negotiate the phase 2 security association (SA) disable
{enable | disable} automatically, even if there is no traffic. This repeats every
five seconds until it succeeds.
You can use this option on a dialup peer to ensure that the
tunnel is available for peers at the server end to initiate traffic
to the dialup peer. Otherwise, the tunnel does not exist until
the dialup peer initiates traffic.
dhgrp {1 | 2 | 5} Type 1, 2 or 5 to select the Diffie-Hellman group to propose 5
for Phase 2 of the IPSec VPN connection. Both VPN peers
must use the same DH Group.
dst-addr-type <type> Enter the type of destination address that corresponds to the subnet
recipient(s) or network behind the remote VPN peer or
FortiGate dialup client:
• To specify the IPv4 IP address of a server or host, type
ip. Enter the IP address using the dst-start-ip
keyword.
• To specify the IPv6 IP address of a server or host, type
ip6. Enter the IP address using the dst-start-ip6
keyword.
• To specify a range of IPv4 IP addresses, type range.
Enter the starting and ending addresses using the
dst-start-ip and dst-end-ip keywords.
• To specify a range of IPv6 IP addresses, type range6.
Enter the starting and ending addresses using the
dst-start-ip6 and dst-end-ip6 keywords.
• To specify an IPv4 network address, type subnet. Enter
the network address using the dst-subnet keyword.
• To specify an IPv6 network address, type subnet6.
Enter the network address using the dst-subnet
keyword.
• To specify an address defined in a firewall address or
address group, type name. Enter the address name using
the dst-name keyword. You must also select the name
option for src-addr-type. This is available only for
IPv4 addresses.
dst-end-ip <address_ipv4> This keyword is available when dst-addr-type is set to 0.0.0.0
range.
Enter the highest destination IP address in the range of IP
addresses.
dst-end-ip6 <address_ipv6> This keyword is available when dst-addr-type is set to ::
range6.
Enter the highest destination IP address in the range of IP
addresses.
dst-name <address_name> This keyword is available when dst-addr-type is set to
name. Enter the firewall address or address group name.
dst-port Enter the port number that the remote VPN peer or FortiGate 0
<destination_port_number> dialup client uses to transport traffic related to the specified
service (see protocol). The range is 1 to 65535. To
specify all ports, type 0.
dst-start-ip This keyword is available when dst-addr-type is set to 0.0.0.0
<address_ipv4> range.
Enter the lowest destination IP address in the range of IP
addresses.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 527
ipsec phase2-interface vpn

Variables Description Default

dst-start-ip6 This keyword is available when dst-addr-type is set to ::
<address_ipv6> range6.
Enter the lowest destination IP address in the range of IP
addresses.
dst-subnet Enter the IPv4 IP address and network mask that identifies 0.0.0.0
<address_ipv4mask> the private network behind the remote VPN peer or FortiGate 0.0.0.0
dialup client.
dst-subnet6 Enter the IPv6 IP address and network mask that identifies ::/0
<address_ipv6mask> the private network behind the remote VPN peer or FortiGate
dialup client.
keepalive {disable | Enable to automatically negotiate a new phase 2 security disable
enable} association (SA) before the current SA expires, keeping the
tunnel up. Otherwise, a new SA is negotiated only if there is
traffic.
keylife-type Set when the phase 2 key expires. When the key expires, a seconds
<keylife_type> new key is generated without interrupting service.
• To make the key expire after a period of time has expired
and after an amount of data is transmitted, type both.
• To make the key expire after an amount of data is
transmitted, type kbs. Use the keylifekbs keyword to
set the amount of data that is transmitted.
• To make the key expire after a number of seconds elapses,
type seconds. Use the keylifeseconds keyword to set
the amount of time that elapses.
keylifekbs <kb_integer> This keyword is available when keylife-type is set to 5120
kbs or both.
Set the number of KBytes of data to transmit before the
phase 2 key expires. The range is 5120 to 99999 KBytes.
keylifeseconds <seconds> This keyword is available when keylife-type is set to 1800
seconds or both.
Set the number of seconds to elapse before the phase 2 key
expires. seconds can be 120 to 172800 seconds.
pfs {disable | enable} Optionally, enable or disable perfect forward secrecy (PFS). disable
PFS ensures that each key created during Phase 2 is
unrelated to keys created during Phase 1 or to other keys
created during Phase 2. PFS may cause minor delays during
key generation.
phase1name <gateway_name> Enter a phase 1 gateway configuration name. You must add Null.
the phase 1 gateway definition to the FortiGate configuration
before it can be cross-referenced.

FortiGate CLI Version 3.0 MR6 Reference

528 01-30006-0015-20080205
vpn ipsec phase2-interface

Variables Description Default

proposal Enter a minimum of one and a maximum of three encryption- No default.
<encryption_combination> message digest combinations (for example, 3des-md5).
The remote peer must be configured to use at least one of
the proposals that you define. Use a space to separate the
combinations.
You can enter any of the following symmetric-key encryption
algorithms:
• 3des-md5
• 3des-null
• 3des-sha1
• aes128-md5
• aes128-null
• aes128-sha1
• aes192-md5
• aes192-null
• aes192-sha1
• aes256-md5
• aes256-null
• aes256-sha1
• des-md5
• des-null
• des-sha1
• null-md5
• null-sha1
Here is an explanation of the abbreviated combinations:
• null-Do not use an encryption algorithm.
• des-Digital Encryption Standard, a 64-bit block algorithm
that uses a 56-bit key.
• 3des-Triple-DES, which encrypts data three times by three
keys.
• aes128-A 128-bit block algorithm that uses a 128-bit key.
• aes192-A 128-bit block algorithm that uses a 192-bit key.
• aes256-A 128-bit block algorithm that uses a 256-bit key.
You can enter either of the following message digests to
check the authenticity of messages during an encrypted
session:
• null-Do not use a message digest.
• md5-Message Digest 5, the hash algorithm developed by
RSA Data Security.
• sha1-Secure Hash Algorithm 1, which produces a 160-bit
message digest.
protocol This keyword is available when selector is set to 0
<protocol_integer> specify.
Enter the IP protocol number for the service. The range is 1
to 255. To specify all services, type 0.
replay {disable | enable} Optionally, enable or disable replay detection. Replay disable
attacks occur when an unauthorized party intercepts a series
of IPSec packets and replays them back into the tunnel.
Enable replay detection to check the sequence number of
every IPSec packet to see if it has been received before. If
packets arrive out of sequence, the FortiGate units discards
them.
You can configure the FortiGate unit to send an alert email
when it detects a replay packet. See “alertemail” on page 63.
route-overlap Specify how FortiGate unit handles multiple dialup users with use-new
{overlap_option} the same IP source address. Set overlap_option to one
of the following:
• allow - allow overlapping routes
• use-new - delete the old route and add the new route
• use-old - use the old route and do not add the new route

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 529
ipsec phase2-interface vpn

Variables Description Default

single-source {disable | Enable or disable all FortiClient dialup clients to connect disable
enable} using the same phase 2 tunnel definition.
src-addr-type If the FortiGate unit is a dialup server, enter the type of subnet
<ip_source_name> source address that corresponds to the local sender(s) or
network behind the FortiGate dialup server:
• To specify the IPv4 IP address of a server or host, type
ip. Enter the IP address using the src-start-ip
keyword.
• To specify the IPv6 IP address of a server or host, type
ip6. Enter the IP address using the src-start-ip6
keyword.
• To specify a range of IPv4 IP addresses, type range.
Enter the starting and ending addresses using the
src-start-ip and src-end-ip keywords.
• To specify a range of IPv6 IP addresses, type range6.
Enter the starting and ending addresses using the
src-start-ip6 and src-end-ip6 keywords.
• To specify an IPv4 network address, type subnet. Enter
the network address using the src-subnet keyword.
• To specify an IPv6 network address, type subnet6.
Enter the network address using the src-subnet6
keyword.
• To specify an address defined in a firewall address or
address group, type name. Enter the address name using
the src-name keyword. You must also select the name
option for dst-addr-type. This is available only for
IPv4 addresses.
If the FortiGate unit is a dialup client, src-addr-type must
refer to the server(s), host(s), or private network behind the
FortiGate dialup client.
src-end-ip <address_ipv4> This keyword is available when src-addr-type is set to 0.0.0.0
range.
Enter the highest source IP address in the range of IP
addresses.
src-end-ip6 <address_ipv6> This keyword is available when src-addr-type is set to ::
range6.
Enter the highest source IP address in the range of IP
addresses.
src-name <address_name> This keyword is available when src-addr-type is set to
name. Enter the firewall address or address group name.
src-port If the FortiGate unit is a dialup server, enter the port number 0
<source_port_number> that the FortiGate dialup server uses to transport traffic
related to the specified service (see protocol). If the
FortiGate unit is a dialup client, enter the port number that
the FortiGate dialup client uses to transport traffic related to
the specified service. The src-port range is 1 to 65535.
To specify all ports, type 0.
src-start-ip This keyword is available when src-addr-type is set to 0.0.0.0
<address_ipv4> range.
Enter the lowest source IP address in the range of IP
addresses.
src-start-ip6 This keyword is available when src-addr-type is set to ::
<address_ipv6> range6.
Enter the lowest source IP address in the range of IP
addresses.

FortiGate CLI Version 3.0 MR6 Reference

530 01-30006-0015-20080205
vpn ipsec phase2-interface

Variables Description Default

src-subnet If the FortiGate unit is a dialup server, enter the IPv4 IP 0.0.0.0
<address_ipv4mask> address and network mask that identifies the private network 0.0.0.0
behind the FortiGate dialup server. If the FortiGate unit is a
dialup client, enter the IP address and network mask that
identifies the private network behind the FortiGate dialup
client.
src-subnet6 If the FortiGate unit is a dialup server, enter the IPv6 IP ::/0
<address_ipv6mask> address and network mask that identifies the private network
behind the FortiGate dialup server. If the FortiGate unit is a
dialup client, enter the IP address and network mask that
identifies the private network behind the FortiGate dialup
client.

Example
Use the following command to add a route-based (interface mode) phase 2 configuration with the
following characteristics:
• Name: Interface_Tunnel
• Phase 1 name: Interface_GW
• Encryption and authentication proposal: 3des-sha1 aes256-sha1 des-md5
• Keylife type: seconds
• Keylife seconds: 18001
• Diffie-Hellman group: 2
• Replay detection: enable
• Perfect forward secrecy: enable
• Keepalive: enable
config vpn ipsec phase2-interface
edit Interface_Tunnel
set phase1name Interface_GW
set proposal 3des-sha1 aes256-sha1 des-md5
set keylife-type seconds
set keylifeseconds 18001
set dhgrp 2
set replay enable
set pfs enable
set keepalive enable
end

History

FortiOS v3.0 New

FortiOS v3.0 MR3 added src-addr-type name, src-name, dst-addr-type name, dst-name.
FortiOS v3.0 MR5 Removed null-null option from proposal keyword.
Added ip6, range6, subnet6 options to src-addr-type keyword.
Added dst-end-ip6, dst-start-ip6, dst-subnet6, src-end-ip6,
src-start-ip6, src-subnet6 keywords.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 531
ipsec phase2-interface vpn

Related topics
• vpn ipsec phase1-interface
• alertemail setting
• alertemail setting
• firewall policy, policy6

FortiGate CLI Version 3.0 MR6 Reference

532 01-30006-0015-20080205
vpn l2tp

l2tp
Use this command to enable L2TP and specify a local address range to reserve for remote L2TP
clients. When a remote L2TP client connects to the internal network through a L2TP VPN, the client is
assigned an IP address from the specified range.
L2TP clients must authenticate with the FortiGate unit when a L2TP session starts. To support L2TP
authentication on the FortiGate unit, you must define the L2TP users who need access and then add
them to a user group. For more information, see “user group” on page 469, “user ldap” on page 473,
“user local” on page 476, and “user radius” on page 481.
You need to define a firewall policy to control services inside the L2TP tunnel. For more information,
see “firewall” on page 81. When you define the firewall policy:
• Create an “external -> internal” policy.
• Set the source address to match the L2TP address range.
• Set the destination address to reflect the private address range of the internal network behind the
local FortiGate unit.
• Set the policy service(s) to match the type(s) of traffic that L2TP users may generate.
• Set the policy action to accept.
• Enable NAT if required.

Caution: FortiGate units support L2TP with Microsoft Point-to-Point Encryption (MPPE) encryption only. Later
! implementations of Microsoft L2TP for Windows use IPSec and require certificates for authentication and
encryption. If you want to use Microsoft L2TP with IPSec to connect to a FortiGate unit, the IPSec and certificate
elements must be disabled on the remote client. For more information, see the Disabling Microsoft L2TP for
IPSec article in the Fortinet Knowledge Center.

Syntax
config vpn l2tp
set eip <address_ipv4>
set sip <address_ipv4>
set status {disable | enable}
set usrgrp <group_name>
end
Note: You can configure L2TP VPNs on FortiGate units that run in NAT/Route mode. The commands are
available in NAT/Route mode only. When you configure an L2TP address range for the first time, you must enter
a starting IP address, an ending IP address, and a user group.

Variables Description Default

eip <address_ipv4> The ending IP address of the L2TP address range. 0.0.0.0
sip <address_ipv4> The starting IP address of the L2TP address range. 0.0.0.0
status {disable | enable} Enable or disable L2TP VPN. disable
usrgrp <group_name> This keyword is available when status is set to enable. Null.
Enter the name of the user group for authenticating L2TP clients.
The user group must be added to the FortiGate configuration
before it can be specified here. For more information, see “user
group” on page 469, “user ldap” on page 473, “user local” on
page 476, and “user radius” on page 481.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 533
l2tp vpn

Example
This example shows how to enable L2TP and set the L2TP address range for the first time using a
starting address of 192.168.1.150, an ending address of 192.168.1.160 and an existing group of
L2TP users named L2TP_users:
config vpn l2tp
set sip 192.168.1.150
set eip 192.168.1.160
set status enable
set usrgrp L2TP_users
end

History

FortiOS v2.80 Revised

Related topics
• user group
• firewall policy, policy6

FortiGate CLI Version 3.0 MR6 Reference

534 01-30006-0015-20080205
vpn pptp

pptp
Use this command to enable PPTP and specify a local address range to reserve for remote PPTP
clients. When a remote PPTP client connects to the internal network through a PPTP VPN, the client is
assigned an IP address from the specified range.
PPTP clients must authenticate with the FortiGate unit when a PPTP session starts. To support PPTP
authentication on the FortiGate unit, you must define the PPTP users who need access and then add
them to a user group. For more information, see “user group” on page 469, “user ldap” on page 473,
“user local” on page 476, “user radius” on page 481, “user peer” on page 478, and “user peergrp” on
page 480.
You need to define a firewall policy to control services inside the PPTP tunnel. For more information,
see “firewall” on page 81. When you define the firewall policy:
• Create an “external -> internal” policy.
• Set the source address to match the PPTP address range.
• Set the destination address to reflect the private address range of the internal network behind the
local FortiGate unit.
• Set the policy service(s) to match the type(s) of traffic that PPTP users may generate.
• Set the policy action to accept.
• Enable NAT if required.

Syntax
config vpn pptp
set eip <address_ipv4>
set sip <address_ipv4>
set status {disable | enable}
set usrgrp <group_name>
end
Note: You can configure PPTP VPNs on FortiGate units that run in NAT/Route mode. The commands are
available in NAT/Route mode only. When you configure a PPTP address range for the first time, you must enter
a starting IP address, an ending IP address, and a user group.

Variables Description Default

eip <address_ipv4> The ending address of the PPTP address range. 0.0.0.0
sip <address_ipv4> The starting address of the PPTP address range. 0.0.0.0
status {disable | enable} Enable or disable PPTP VPN. disable
usrgrp <group_name> This keyword is available when status is set to enable. Null.
Enter the name of the user group for authenticating PPTP clients.
The user group must be added to the FortiGate configuration
before it can be specified here. For more information, see “user
group” on page 469, “user ldap” on page 473, “user local” on
page 476, “user radius” on page 481, “user peer” on
page 478, and “user peergrp” on page 480

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 535
pptp vpn

Example
This example shows how to enable PPTP and set the PPTP address range for the first time using a
starting address of 192.168.1.100, an ending address of 192.168.1.130 and an existing group of
PPTP users named PPTP_users:
config vpn pptp
set sip 192.168.1.100
set eip 192.168.1.130
set status enable
set usrgrp PPTP_users
end

History

FortiOS v2.80 Revised

FortiOS v3.0 MR5 Added links for PKI user and user group (peer and peer group).

Related topics
• user group
• firewall policy, policy6

FortiGate CLI Version 3.0 MR6 Reference

536 01-30006-0015-20080205
vpn ssl monitor

ssl monitor
Use this command to display information about logged in SSL VPN users and current SSL VPN
sessions.

Syntax
get vpn ssl monitor
Output

History

FortiOS v3.0 New.

Related topics
• vpn ssl settings

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 537
ssl settings vpn

ssl settings
Use this command to configure basic SSL VPN settings including interface idle-timeout values and
SSL encryption preferences. If required, you can also enable the use of digital certificates for
authenticating remote clients.
You can optionally specify the IP address of any Domain Name Service (DNS) server and/or Windows
Internet Name Service (WINS) server that resides on the private network behind the FortiGate unit.
The DNS and/or WINS server will find the IP addresses of other computers whenever a connected
SSL VPN user sends an email message or browses the Internet.

Note: You can configure SSL VPNs on FortiGate units that run in NAT/Route mode. The commands are
available in NAT/Route mode only.

Syntax
config vpn ssl settings
set algorithm <cipher_suite>
set auth-timeout <auth_seconds>
set dns-server1 <address_ipv4>
set dns-server2 <address_ipv4>
set idle-timeout <idle_seconds>
set portal-heading <caption>
set reqclientcert {disable | enable}
set route-source-interface {disable | enable}
set servercert <server_cert_name>
set sslv2 {disable | enable}
set sslv3 {disable | enable}
set sslvpn-enable {disable | enable}
set tunnel-endip <address_ipv4>
set tunnel-startip <address_ipv4>
set url-obscuration {disable | enable}
set wins-server1 <address_ipv4>
set wins-server2 <address_ipv4>
end
Note: Set the sslvpn-enable attribute to enable to view all possible settings. The tunnel-endip and
tunnel-startip keywords are required for tunnel-mode access only. All other keywords are optional.

When you configure the timeout settings, if you set the authentication timeout (auth-timeout)to 0,
then the remote client does not have to re-authenticate again unless they log out of the system. In
order to fully take advantage of this setting, the value for idle-timeout has to be set to 0 also, so the
client does not timeout if the maximum idle time is reached. If the idle-timeout is not set to the
infinite value, the system will log out if it reaches the limit set, regardless of the auth-timeout
setting.

FortiGate CLI Version 3.0 MR6 Reference

538 01-30006-0015-20080205
vpn ssl settings

Variables Description Default

algorithm <cipher_suite> This keyword is available when sslvpn-enable is set to default
enable.
Enter one of the following options to determine the level of
SSL encryption to use. The web browser on the remote
client must be capable of matching the level that you
specify:
• To use any cipher suite, type low.
• To use a 128-bit or greater cipher suite, type default.
• To use a cipher suite that is greater than 128 bits, type
high.
auth-timeout This keyword is available when sslvpn-enable is set to 1500
<auth_seconds> enable.
Enter the period of time (in seconds) to control how long an
authenticated connection will remain connected. When this
time expires, the system forces the remote client to
authenticate again. The range is from 10 to 28800
seconds. Use the value of 0 to indicate no timeout. Range
is 10 to 259,200 seconds (3 days).
dns-server1 Enter the IP address of the primary DNS server that SSL 0.0.0.0
<address_ipv4> VPN clients will be able to access after a connection has
been established. If required, you can specify a secondary
DNS server through the dns-server2 attribute.
dns-server2 Enter the IP address of a secondary DNS server if 0.0.0.0
<address_ipv4> required.
idle-timeout This keyword is available when sslvpn-enable is set to 300
<idle_seconds> enable.
Enter the period of time (in seconds) to control how long
the connection can remain idle before the system forces
the remote user to log in again. The range is from 10 to
28800 seconds. Use the value of 0 to indicate no timeout.
portal-heading <caption> This keyword is available when sslvpn-enable is set to Null.
enable.
If you want to display a custom caption at the top of the
web portal home page, type the message.
reqclientcert {disable | This keyword is available when sslvpn-enable is set to disable
enable} enable.
Disable or enable the use of group certificates for
authenticating remote clients.
route-source-interface This keyword is available when sslvpn-enable is set to disable
{disable | enable} enable.
Enable to allow the SSL VPN connection to bypass routing
and bind to the incoming interface.
servercert This keyword is available when sslvpn-enable is set to /etc/server
<server_cert_name> enable.
Enter the name of the signed server certificate that the
FortiGate unit will use to identify itself during the SSL
handshake with a web browser when the web browser
connects to the login page. The server certificate must
already be loaded into the FortiGate configuration. If you
do not specify a server certificate, the FortiGate unit offers
its factory installed (self-signed) certificate from Fortinet to
remote clients when they connect.
sslv2 {disable | enable} This keyword is available when sslvpn-enable is set to disable
enable.
Disable or enable SSL version 2 encryption.
sslv3 {disable | enable} This keyword is available when sslvpn-enable is set to enable
enable.
Disable or enable SSL version 3 encryption.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 539
ssl settings vpn

Variables Description Default

sslvpn-enable {disable | Disable or enable remote-client access. disable
enable}
tunnel-endip This keyword is available when sslvpn-enable is set to 0.0.0.0
<address_ipv4> enable.
This attribute is required for tunnel-mode access only.
Enter the ending address in the range of IP addresses
reserved for remote clients.
tunnel-startip This keyword is available when sslvpn-enable is set to 0.0.0.0
<address_ipv4> enable.
This attribute is required for tunnel-mode access only.
Enter the starting address in the range of IP addresses
reserved for remote clients.
url-obscuration {disable This keyword is available when sslvpn-enable is set to disable
| enable} enable.
Enable to encrypt the host name of the url in the display
(web address) of the browser for web mode only. This is a
requirement for ICSA ssl vpn certification.
wins-server1 Enter the IP address of the primary WINS server that SSL 0.0.0.0
<address_ipv4> VPN clients will be able to access after a connection has
been established. If required, you can specify a secondary
WINS server through the wins-server2 attribute.
wins-server2 Enter the IP address of a secondary WINS server if 0.0.0.0
<address_ipv4> required.

Example
The following command enables the FortiGate unit to assign virtual IP addresses in the 10.10.10.100
to 10.10.10.105 range to authenticated clients (an IP address range is needed to support tunnel-mode
access). The command also sets timeout values for authenticated connections and connection
inactivity respectively.
config vpn ssl settings
set sslvpn-enable enable
set tunnel-startip 10.10.10.100
set tunnel-endip 10.10.10.105
set auth-timeout 600
set idle-timeout 1500
end

History
FortiOS v3.0 New.
FortiOS v3.0 MR4 Added route-source-interface.
FortiOS v3.0 MR5 Added url-obscuration.
FortiOS v3.0 MR6 Changed values in auth-timeout and idle-timeout to include infinity setting.

Related topics
• system replacemsg sslvpn
• execute vpn sslvpn del-tunnel
• vpn ssl monitor
• user group
• log {disk | fortianalyzer | memory | syslogd | webtrends | fortiguard} filter
• firewall policy, policy6

FortiGate CLI Version 3.0 MR6 Reference

540 01-30006-0015-20080205
vpn ssl web bookmarks

ssl web bookmarks

Use this command to pre-define one or more bookmarks that you add to a bookmark group. A
bookmark is associated with a service and an application server. The bookmarks that you define are
displayed in the Predefined Bookmarks section of the user’s web portal page. Bookmark groups can
be associated to SSL VPN user groups. Users within the SSL VPN user group can select a bookmark
hyperlink in the Predefined Bookmarks list to initiate a session with the target server application. These
bookmarks cannot be edited by the user.

Syntax
config vpn ssl web bookmarks
edit <bookmark_name>
set apptype <service_type>
set folder <folder_name>
set host <host_name>
set url <target_ip>
end

Variables Description Default

edit <bookmark_name> Enter a name for the bookmark. No default.
apptype <service_type> Enter the identifier of the service to associate with the web
bookmark:
• Type ftp for FTP services.
• Type rdp for Windows Terminal services.
• Type smb for SMB/CIFS (Windows file share) services.
• Type ssh for SSH services.
• Type telnet for telnet services.
• Type vnc for VNC services.
• Type web for HTTP and/or HTTPS services.
folder <folder_name> Enter the remote folder name, if apptype is smb or ftp. No default.
The folder name must include the server name,
//172.20.120.103/myfolder/, for example.
host <host_name> Enter the host name/IP parameter, if apptype is telnet, No default.
rdp, or vnc.
url <target_ip> Enter the URL of the web page, if apptype is web. No default.

Example
The following command creates a bookmark named Company_intranet to the corporate Intranet
home page at www.example.com:
config vpn ssl web bookmarks
edit Company_intranet
set apptype web
set url http://www.example.com
end

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 541
ssl web bookmarks vpn

History

FortiOS v3.0 MR5 New feature.

Related topics
• vpn ssl settings
• vpn ssl web bookmarks-group
• vpn ssl web favorite

FortiGate CLI Version 3.0 MR6 Reference

542 01-30006-0015-20080205
vpn ssl web bookmarks-group

ssl web bookmarks-group

Use this command to define a group of bookmarks to associate to an SSL VPN user group.

Syntax
config vpn ssl web bookmarks-group
edit <bkmark_groupname>
set bookmarks <bookmark_names>
end
Variables Description Default
edit <bkmark_groupname> Enter the name of the bookmark group. No default.
bookmarks <bookmark_names> Enter the list of bookmarks to include in the bookmark No default.
group. Enclose the bookmark name in quotation marks,
and separate each bookmark in the list with a space.

Example
The following command creates a bookmark group that includes the bookmark to the corporate
Intranet home page at www.example.com named Company_intranet and a link to the Google
search site named Google_site:
config vpn ssl web bookmarks-group
edit <bkmark_groupname>
set “Company_intranet” “Google_site”
end

History
FortiOS v3.0 MR5 New

Related topics
• vpn ssl settings
• vpn ssl web bookmarks
• vpn ssl web favorite

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 543
ssl web favorite vpn

ssl web favorite

Use this command to define one or more bookmarks for an SSL VPN user. A bookmark is associated
with a service and an application server. The bookmarks that you define are displayed in the My
Bookmarks section of the user’s web portal page. Users can select the associated hyperlink to initiate
a session with the target server application.

Syntax
config vpn ssl web favorite
edit <bookmark_name>
set apptype <service_type>
set folder <folder_name>
set group <group_name>
set host <host_name>
set title <display_text>
set url <target_ip>
set user <user_name>
end

Variables Description Default

apptype <service_type> Enter the identifier of the service to associate with the web
bookmark:
• Type ftp for FTP services.
• Type rdp for Windows Terminal services.
• Type smb for SMB/CIFS (Windows file share) services.
• Type ssh for SSH services.
• Type telnet for telnet services.
• Type vnc for VNC services.
• Type web for HTTP and/or HTTPS services.
folder <folder_name> Enter the remote folder name, if apptype is smb or ftp. No default.
The folder name must include the server name,
//172.20.120.103/myfolder, for example.
group <group_name> Enter the SSL VPN user group name. No default.
host <host_name> Enter the host name, if apptype is telnet or rdp. No default.
title <display_text> Enter a text string to display as the hyperlink on the user’s web No default.
portal page. Enclose the string in quotation marks if it contains
spaces.
User entries are automatically named <user>+<timestamp>.
url <target_ip> Enter the URL of the web page, if apptype is web. No default.
user <user_name> Enter the user name from the SSL VPN user group. No default.

If a bookmark is created by the user through the web portal page, the value for bookmark_name is
automatically generated (<user>+<timestamp>+<group>). The text string in title is displayed as
the hyperlink in the My Bookmarks list.
If a bookmark is created in the CLI, there must be values assigned to the user and group variables to
link the bookmark to a user in an SSL VPN user group, and a text string in title to display as the
hyperlink in the My Bookmarks list.

FortiGate CLI Version 3.0 MR6 Reference

544 01-30006-0015-20080205
vpn ssl web favorite

Example
The following command creates a bookmark to the corporate Intranet home page at
www.example.com for the user juser who is a member of the SSL VPN user group sslusergroup:
config vpn ssl web favorite
edit Company_intranet
set apptype web
set title "Company Home Page"
set url http://www.example.com
set group sslusergroup
set user juser
end

History

FortiOS v3.0 New

FortiOS v3.0 MR4 Updated description of key words, incorporated variables from new commands config
vpn ssl web bookmarks and config vpn ssl web bookmarks-group..

Related topics
• vpn ssl settings
• vpn ssl web bookmarks
• vpn ssl web bookmarks-group

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 545
ssl web favorite vpn

FortiGate CLI Version 3.0 MR6 Reference

546 01-30006-0015-20080205
webfilter

webfilter
Use webfilter commands to add banned words to the banned word list, filter URLs, and configure
FortiGuard-Web category filtering.
This chapter contains the following sections:

bword
exmword
fortiguard
ftgd-local-cat
ftgd-local-rating
ftgd-ovrd
urlfilter

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 547
bword webfilter

bword
Control web content by blocking specific words or patterns. If enabled in the protection profile, the
FortiGate unit searches for words or patterns on requested web pages. If matches are found, values
assigned to the words are totalled. If a user-defined threshold value is exceeded, the web page is
blocked.
Use this command to add or edit and configure options for the Web content block list. Banned words
can be one word or a text string up to 80 characters long. The maximum number of banned words and
patterns in the list is 5000.
When a single word is entered, the FortiGate unit checks Web pages for that word. Add phrases by
enclosing the phrase in ‘single quotes’. When a phrase is entered, the FortiGate unit checks Web
pages for any word in the phrase. Add exact phrases by enclosing the phrases in “quotation marks”. If
the phrase is enclosed in quotation marks, the FortiGate checks Web pages for the exact phrase.
Create banned word patterns using wildcards or Perl regular expressions. See “Using Perl regular
expressions” on page 48.
You can add multiple banned word lists, and then select the best web content block list for each
protection profile. Choose the command syntax list below according to your FortiGate unit model.

Note: Perl regular expression patterns are case sensitive for Web Filter content block. To make a word or phrase
case insensitive, use the regular expression /i. For example, /bad language/i blocks all instances of bad
language regardless of case. Wildcard patterns are not case sensitive.

Syntax
config webfilter bword
edit <banned_word_list_integer>
set name <banned_word_list>
set comment <banned_word_list_comment>
config entries
edit <word_str>
set lang {french | japanese | korean | simch | thai | trach |
western}
set pattern-type {regexp | wildcard}
set score <integer_value>
set status {enable | disable}
end
C

Keywords and variables Description Default

<banned_word_list_integer> A unique number to identify the banned word list.
<banned_word_list> The name of the banned word list.
<banned_word_list_comment> The comment attached to the banned word list.
<word_str> The word to be blocked.
lang {french | japanese | Enter the language character set used for the banned word or western
korean | simch | thai | phrase. Choose from French, Japanese, Korean, Simplified
trach | western} Chinese, Thai, Traditional Chinese, or Western.

pattern-type Set the pattern type for the banned word. Choose from regexp wildcard
{regexp | wildcard} or wildcard.Create patterns for banned words using Perl
regular expressions or wildcards.

FortiGate CLI Version 3.0 MR6 Reference

548 01-30006-0015-20080205
webfilter bword

Keywords and variables Description Default

score <integer_value> A numerical weighting applied to the banned word. The score 10
values of all the matching words appearing on a web page are
added, and if the total is greater than the webwordthreshold
value set in the protection profile, the page is processed
according to whether the bannedword option is set with the
http command in the protection profile. The score for a
banned word is counted once even if the word appears multiple
times on the web page.
status {enable | disable} Enable or disable the banned word. disable

History

FortiOS v2.80 Substantially revised.

FortiOS v3.0 Added score variable. Added multiple-list capability for models 800 and
above. Minor changes.
FortiOS v3.0 All models have the same CLI syntax now.
MR4

Related topics
• exmword
• webfilter fortiguard
• webfilter ftgd-local-cat
• webfilter ftgd-local-rating
• webfilter ftgd-ovrd
• webfilter urlfilter

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 549
exmword webfilter

exmword
Web content exempt allows overriding of the web content block feature. If any patterns defined in the
web content exempt list appear on a web page, the page will not be blocked even if the web content
block feature would otherwise block it.
Use this command to add or edit and configure options for the Web content exempt list. Exempt words
can be one word or a text string up to 80 characters long. The maximum number of exempt words and
patterns in the list is 5000.
When a single word is entered, the FortiGate unit checks Web pages for that word. Add phrases by
enclosing the phrase in ‘single quotes’. When a phrase is entered, the FortiGate unit checks Web
pages for any word in the phrase. Add exact phrases by enclosing the phrases in “quotation marks”. If
the phrase is enclosed in quotation marks, the FortiGate checks Web pages for the exact phrase.
Create exempt word patterns using wildcards or Perl regular expressions. See “Using Perl regular
expressions” on page 48.
You can add multiple exempt word lists, and then select the best web content exempt list for each
protection profile. Choose the command syntax list below according to your FortiGate unit model.

Note: Perl regular expression patterns are case sensitive for Web Filter content exempt. To make a word or
phrase case insensitive, use the regular expression /i. For example, /good language/i exempts all instances
of good language regardless of case. Wildcard patterns are not case sensitive.

Syntax
config webfilter exmword
edit <exempt_word_list_integer>
set name <exempt_word_list>
set comment <exempt_word_list_comment>
config entries
edit <word_str>
set lang {french | japanese | korean | simch | thai | trach |
western}
set pattern-type {regexp | wildcard}
set status {enable | disable}
end
Keywords and variables Description Default
<exempt_word_list_integer> A unique number to identify the exempt word list.
<exempt_word_list> The name of the exempt word list.
<exempt_word_list_comment> The comment attached to the exempt word list.
<word_str> The word to be exempted.
lang {french | japanese | Enter the language character set used for the exempt word or western
korean | simch | thai | phrase. Choose from French, Japanese, Korean, Simplified
trach | western} Chinese, Thai, Traditional Chinese, or Western.

pattern-type Set the pattern type for the exempt word. Choose from regexp wildcard
{regexp | wildcard} or wildcard.Create patterns for exempt words using Perl
regular expressions or wildcards.
status {enable | disable} Enable or disable the exempt word. disable

FortiGate CLI Version 3.0 MR6 Reference

550 01-30006-0015-20080205
webfilter exmword

History

FortiOS v3.0 New.

MR2
FortiOS v3.0 All models have the same CLI syntax now.
MR4

Related topics
• bword
• webfilter fortiguard
• webfilter ftgd-local-cat
• webfilter ftgd-local-rating
• webfilter ftgd-ovrd
• webfilter urlfilter

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 551
fortiguard webfilter

fortiguard
Use this command to enable Web filtering by specific categories using FortiGuard-Web URL filtering.

FortiGuard-Web category blocking

FortiGuard-Web is a web filtering solution provided by Fortinet. FortiGuard-Web sorts thousands of
Web pages into a wide variety of categories that users can allow, block, or monitor. Categories are also
organized into broader groups to make configuration fast and easy. The FortiGate unit accesses the
nearest FortiGuard-Web server to determine the category of a requested web page and then follows
the firewall policy configured for that user or interface. FortiGuard-Web servers are located worldwide.

FortiGuard-Web licensing
Every FortiGate unit comes with a free 30 day FortiGuard-Web trial license. FortiGuard-Web license
management is done by the FortiGuard-Web server, so there is no need to enter a license number.
The FortiGate unit automatically contacts the FortiGuard-Web servers when FortiGuard-Web category
blocking is enabled.
To renew the FortiGuard-Web license after the free trial, contact Fortinet Technical Support.

FortiGuard-Web configuration
Once enabled, FortiGuard-Web category block settings apply globally. After enabling FortiGuard-Web,
configure different categories for each firewall protection profile create.
See “firewall profile” on page 114 to configure FortiGuard-Web category blocking in a protection profile.
See “FortiGuard-Web categories” in the FortiGate Administration Guide for a complete list and
description of the FortiGuard-Web web filter categories.

HTTP and HTTPS FortiGuard override traffic

The FortiGuard override for HTTP and HTTPS is no longer a single global forward rule. Instead, a
separate rule is created for each protection profile to redirect both the FortiGuard override HTTP and
HTTPS ports, as required, into the authentication daemon. This ensures that these ports only appear
open when the appropriate options are enabled in the profile. A matrix of how the profile options affect
the port status follows:

Table 16: Port status in different profiles

HTTP WF HTTP ovrd HTTPS WF ovrd via HTTPS HTTP Port HTTPS Port
0 0 0 0 closed closed
0 0 0 1 closed closed
0 0 1 0 closed open
0 0 1 1 closed open
0 1 0 0 closed closed
0 1 0 1 closed closed
0 1 1 0 closed open
0 1 1 1 closed open
1 0 0 0 open closed
1 0 0 1 open closed
1 0 1 0 open open
1 0 1 1 open open

FortiGate CLI Version 3.0 MR6 Reference

552 01-30006-0015-20080205
webfilter fortiguard

Table 16: Port status in different profiles

1 1 0 0 open closed
1 1 0 1 open open
1 1 1 0 open open
1 1 1 1 open open
There are two separate ports for HTTP and HTTPS override traffic which can be configured
independently.
In addition, HTTPS uses the HTTPS override form regardless of the ovrd-auth-https status. If
ovrd-auth-https is enabled, any attempts to use the HTTP version of the override form will
transparently be re-directed to the HTTPS version.

Syntax
config webfilter fortiguard
set cache-mode {ttl | db-ver}
set cache-mem-percent <percent_integer>
set ovrd-auth-port-http <port_integer>
set ovrd-auth-https <enable | disable>
set ovrd-auth-port-https <port_integer>
set cache-prefix-match <enable | disable>
end
Keywords and variables Description Default
cache-mode {ttl | db-ver} Change the cache entry expiration mode. Choices ttl
are ttl or db-ver.
Using ttl, cache entries are deleted after a number
of seconds determined by the cache-ttl setting, or
until newer cache entries force the removal of older
ones.
When set to db-ver, cache entries are kept until the
FortiGuard database changes, or until newer cache
entries force the removal of older ones.
cache-mem-percent Change the maximum percentage of memory the 2
<percent_integer> cache will use. Enter a value from 1 to 15 percent.

ovrd-auth-port-http The port to use for FortiGuard Web Filter HTTP 8008
<port_integer> override authentication.
ovrd-auth-https Enable to use HTTPS for override authentication. disable
<enable | disable>
ovrd-auth-port-https The port to use for FortiGuard Web filtering HTTPS 8010
<port_integer> override authentication.
cache-prefix-match Enable and disable prefix matching. enable
<enable | disable> If enabled the FortiGate unit attempts to match a
packet against the rules in a prefix list starting at the
top of the list.
For information on prefix lists see the section “prefix-
list” on page 275 of the Router chapter in the FortiOS
CLI Guide.

History

FortiOS v2.80 New.

FortiOS v2.80 MR2 Added cerb_hostname, cerb_port, ftgd_hostname, and, ftgd_port keywords.
Changed license to cerb_license.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 553
fortiguard webfilter

FortiOS v2.80 MR4 Removed cerb_hostname, cerb_license, and, cerb_port keywords.

Removed ftgd_port keyword.
FortiOS v3.0 Add cache-mode, cache-mem-percent, license, expiration, hostname,
img-sink-ip, ovrd-auth-port, ovrd-auth-https, and, port. Removed
ftgd_hostname, and, service.
Name changed from catblock to fortiguard.
FortiOS v3.0 MR1 Many of the commands were moved to “config system fortiguard” and some new
commands were added.
FortiOS v3.0 MR3 cache-prefix-match <enable | disable> command added.
FortiOS v3.0 MR4 Removed the command ovrd-auth-port replaced with ovrd-auth-port-http.
Added the command ovrd-auth-port-https.
Added new H3 section on HTTP and HTTPS FortiGuard override traffic.
FortiOS v3.0 MR4 Removed the command img-sink-ip.

Related topics
• webfilter bword
• webfilter ftgd-local-cat
• webfilter ftgd-local-rating
• webfilter ftgd-ovrd
• webfilter urlfilter

FortiGate CLI Version 3.0 MR6 Reference

554 01-30006-0015-20080205
webfilter ftgd-local-cat

ftgd-local-cat
Use this command to add local categories to the global URL category list. The categories defined here
appear in the global URL category list when configuring a protection profile. Users can rate URLs
based on the local categories.

Syntax
config webfilter ftgd-local-cat
edit <local_cat_str>
set id <id_integer>
end
Keywords and variables Description Default
<local_cat_str> The description of the local category.
id <id_integer> The local category unique ID number. 0

Example
This example shows how to add the category local_block with an ID of 10.
config webfilter ftgd-local-cat
edit local_block
set id 10
end

History

FortiOS v3.0 New

Related topics
• webfilter bword
• webfilter fortiguard
• webfilter ftgd-local-rating
• webfilter ftgd-ovrd
• webfilter urlfilter

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 555
ftgd-local-rating webfilter

ftgd-local-rating
Use this command to rate URLs using local categories.
Users can create user-defined categories then specify the URLs that belong to the category. This
allows users to block groups of web sites on a per profile basis. The ratings are included in the global
URL list with associated categories and compared in the same way the URL block list is processed.
The user can also specify whether the local rating is used in conjunction with the FortiGuard rating or is
used as an override.

Syntax
config webfilter ftgd-local-rating
edit <local_url_str>
set rating [[<category_integer>] [group_str] [class_str]...]
set status {enable | disable}
end
Keywords and variables Description Default
<local_url_str> The URL being rated.
rating Set categories, groups, and classifications for the rating. Enter
[[<category_integer>] ‘?’ to print a list of category codes and descriptions available. To
[group_str] remove categories from the rating, use the unset command.
[class_str]...]
status {enable | disable} Enable or disable the local rating. enable

Example
This example shows how to configure a local rating for the web site www.example.com. with a rating
including category 12, all categories in group 4, and classification 1.
config webfilter ftgd-local-rating
edit www.example.com
set rating 12 g4 c1
end

History

FortiOS v3.0 New

Related topics
• webfilter bword
• webfilter fortiguard
• webfilter ftgd-local-cat
• webfilter ftgd-ovrd
• webfilter urlfilter

FortiGate CLI Version 3.0 MR6 Reference

556 01-30006-0015-20080205
webfilter ftgd-ovrd

ftgd-ovrd
Use this command to configure FortiGuard-Web filtering overrides.
Users may require access to web sites that are blocked by a policy. In this case, an administrator can
give the user the ability to override the block for a specified period of time.
When a user attempts to access a blocked site, if override is enabled, a link appears on the block page
directing the user to an authentication form. The user must provide a correct user name and password
or the web site remains blocked. Authentication is based on user groups and can be performed for
local, RADIUS, and LDAP users.

Syntax
config webfilter ftgd-ovrd
edit <override_integer>
set expires
set ext-ref <allow | deny>
set ip <ipv4_address>
set profile <profile_str>
set rating [[<category_integer>] [group_str] [class_str]...]
set scope {user | user-group | ip | profile}
set status {enable | disable}
set type {dir | domain | rating}
set url <url_str>
set user <user_str>
set user-group <user_group_str>
end
get webfilter ftgd-ovrd <override_integer>
Keywords and variables Description Default
<override_integer> The unique ID number of the override.
expires The date and time the override expires.
ext-ref <allow | deny> Allow or deny access to off-site URLs. allow
initiator The user who initiated the override rule. This keyword is get-
only.
ip <ipv4_address> When the scope is IP, the IP address for which the override rule 0.0.0.0
applies.
profile <profile_str> When the scope is profile, the profile for which the override rule
applies.
rating Set categories, groups, and classifications for the rating. Enter
[[<category_integer>] ‘?’ to print a list of category codes and descriptions available. To
[group_str] remove categories from the rating, use the unset command.
[class_str]...]
scope {user | user-group The scope of the override rule. user
| ip | profile}
status {enable | disable} Enable or disable the override rule. disable
type {dir | domain | Specify the type od override rule. dir
rating} • dir - override the website directory
• domain - override the domain
• rating - override the specified categories and classifications
url <url_str> The URL for which the override rule applies.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 557
ftgd-ovrd webfilter

Keywords and variables Description Default

user <user_str> When the scope is user, the user for which the override rule
applies.
user-group When the scope is user group, the user group for which the
<user_group_str> override rule applies.

Example
This example shows how to set an override (13).
config webfilter ftgd-ovrd
edit 13
set rating 12 g4 c1
end
Use the following command to get information about an override.
get webfilter ftgd-ovrd 1
id : 1
expires : Wed Jul 6 07:00:30 2005
ext_ref : allow
initiator : admin
scope : user
status : enable
type : dir
url : 192.168.2201.23
user : user_1

History

FortiOS v3.0 New

Related topics
• webfilter bword
• webfilter fortiguard
• webfilter ftgd-local-cat
• webfilter ftgd-local-rating
• webfilter urlfilter

FortiGate CLI Version 3.0 MR6 Reference

558 01-30006-0015-20080205
webfilter urlfilter

urlfilter
Use this command to control access to specific URLs by adding them to the URL filter list. The
FortiGate unit exempts or blocks Web pages matching any specified URLs and displays a replacement
message instead.
Configure the FortiGate unit to allow, block, or exempt all pages on a website by adding the top-level
URL or IP address and setting the action to allow, block, or exempt.
Block individual pages on a website by including the full path and filename of the web page to block.
Type a top-level URL or IP address to block access to all pages on a website. For example,
www.example.com or 172.16.144.155 blocks access to all pages at this website.
Type a top-level URL followed by the path and filename to block access to a single page on a website.
For example, www.example.com/news.html or 172.16.144.155/news.html blocks the news
page on this website.
To block all pages with a URL that ends with example.com, add example.com to the block list. For
example, adding example.com blocks access to www.example.com, mail.example.com,
www.finance.example.com, and so on.
Use this command to exempt or block all URLs matching patterns created using text and regular
expressions (or wildcard characters). For example, example.* matches example.com,
example.org, example.net and so on. The FortiGate unit exempts or blocks Web pages that
match any configured pattern and displays a replacement message instead.
The maximum number of entries in the list is 5000.

Syntax
config webfilter urlfilter
edit <url_filter_list_integer>
set name <urlfilter_list>
set comment <urlfilter_list_comment>
config entries
edit <url_str>
set action {allow | block | exempt}
set status {enable | disable}
set type {simple | regex}
end
end
Keywords and variables Description Default
<url_filter_list_integer> A unique number to identify the URL filter list.
<urlfilter_list> The name of the URL filter list.
<urlfilter_list_comment> The comment attached to the URL filter list.
<url_str> The URL to added to the list.
action The action to take for matches. exempt
{allow | block | exempt} An allow match exits the URL filter list and checks the
other web filters.
An exempt match stops all further checking including AV
scanning.
A block match blocks the URL and no further checking
will be done.
status {enable | disable} The status of the filter. enable
type {simple | regex} The type of URL filter: simple or regular expression. simple

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 559
urlfilter webfilter

History

FortiOS v3.0 New

FortiOS v3.0 All models have the same CLI syntax now.
MR4

Related topics
• webfilter bword
• webfilter fortiguard
• webfilter ftgd-local-cat
• webfilter ftgd-local-rating
• webfilter ftgd-ovrd

FortiGate CLI Version 3.0 MR6 Reference

560 01-30006-0015-20080205
execute

execute
The execute commands perform immediate operations on the FortiGate unit. You can:
• Back up and restore the system configuration, or reset the unit to factory settings.
• Execute the run but not save feature
• Set the unit date and time.
• View and clear DHCP leases.
• Clear arp table entries.
• View and delete log messages. Delete old log files.
• Manually dial or hang up the modem (models 50A, 50AM, 60, 60M only).
• Use ping or traceroute to diagnose network problems.
• Restart the router or the entire FortiGate unit.
• Update the antivirus and attack definitions on demand.
• Generate certificate requests and install certificates for VPN authentication.

This chapter contains the following sections:

backup interface pppoe-reconnect router clear ospf process

batch log delete-all router restart
central-mgmt log delete-filtered send-fds-statistics
cfg reload log delete-rolled set-next-reboot
cfg save log display shutdown
clear system arp table log filter ssh
cli status-msg-only log fortianalzyer test-connectivity telnet
cli check-template-status log list time
date log roll traceroute
deploy modem dial update-av
dhcp lease-clear modem hangup update-ips
dhcp lease-list mrouter clear update-now
disconnect-admin-session ping upd-vd-license
factoryreset ping-options usb-disk
formatlogdisk ping6 vpn certificate local
fortiguard-log update reboot vpn certificate ca
fsae refresh restore vpn certificate crl
ha disconnect router clear bgp vpn certificate remote
ha manage router clear bfd vpn sslvpn del-tunnel
ha synchronize router clear ospf process vpn sslvpn del-web
interface dhcpclient-renew router restart

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 561
backup execute

backup
Back up the FortiGate configuration files, logs, or IPS user-defined signatures file to a TFTP server,
USB disk, or a management station. Management stations can be either a FortiManager unit, or
Central Management service. For more information see “system fortiguard” on page 342 or “system
fortiguard” on page 342.
When virtual domain configuration is enabled (in system global, vdom-admin is enabled), the
content of the backup file depends on the administrator account that created it.
• A backup of the system configuration from the super admin account contains the global settings
and the settings for all of the VDOMs. Only the super admin can restore the configuration from this
file.
• When you back up the system configuration from a regular administrator account, the backup file
contains the global settings and the settings for the VDOM to which the administrator belongs. Only
a regular administrator account can restore the configuration from this file.

Syntax
execute backup {disk | memory} alllogs <tftp_ipv4>
execute backup {disk | memory} log <tftp_ipv4> <log_type>
execute backup config management-station <comment>
execute backup config tftp <filename> <tftp_ipv4> [<password>]
execute backup config usb <filename> [<password>]
execute backup full-config tftp <filename> <tftp_ipv4> [<password>]
execute backup full-config usb <filename> [<password>]
execute backup ipsuserdefsig <filename> <tftp_ipv4>

Keywords and variables Description

{disk | memory} alllogs <tftp_ipv4> Back up either all memory or all hard disk log files for this
VDOM to a TFTP server. This command is effective only
on models that log to a hard disk. The file name has the
form: <log_file_name>_<VDOM>_<date>_<time>
{disk | memory} log <tftp_ipv4> Back up the selected type of log file from either hard disk
<log_type> or memory to a TFTP server.
<log_type> can be one of:
• traffic
• event
• ids
• virus
• webfilter
• spam
• im
config management-station <comment> Back up the system configuration to a configured
management station.
config tftp <filename> <tftp_ipv4> Back up the system configuration to a file on a TFTP
[<password>] server. Optionally, you can specify a password to protect
the saved data.
config usb <filename> [<password>] Back up the system configuration to a file on a USB disk.
Optionally, you can specify a password to protect the
saved data.
full-config tftp <filename> Back up the full system configuration to a file on a TFTP
<tftp_ipv4> [<password>] server. Optionally, you can specify a password to protect
the saved data.

FortiGate CLI Version 3.0 MR6 Reference

562 01-30006-0015-20080205
execute backup

Keywords and variables Description

full-config usb <filename> Back up the full system configuration to a file on a USB
[<password>] disk. Optionally, you can specify a password to protect
the saved data.
ipsuserdefsig <filename> <tftp_ipv4> Back up IPS user-defined signatures to a file on a TFTP
server.

Example
This example shows how to backup the FortiGate unit system configuration to a file named fgt.cfg
on a TFTP server at IP address 192.168.1.23.
execute backup config tftp fgt.cfg 192.168.1.23

History

FortiOS v2.80 Revised.

FortiOS v3.0 Added USB backup options.
FortiOS v3.0 MR1 Changed backup log from <filename> <tftp_ipv4> to <tftp_ipv4>
<log0_type>.
FortiOS v3.0 MR3 log and alllogs now refer to either disk or memory as selected.
FortiOS v3.0 MR4 Added full-config tftp and full-config usb.
FortiOS v3.0 MR5 Added config management-station.

Related topics
• execute restore
• ips custom

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 563
batch execute

batch
Execute a series of CLI commands.

Note: execute batch commands are controlled by the Maintenance (mntgrp) access
control group.

Syntax
execute batch [<cmd_cue>]
where <cmd_cue> is one of:
• end - exit session and run the batch commands
• lastlog - read the result of the last batch commands
• start - start batch mode
• status - batch mode status reporting if batch mode is running or stopped

Example
To start batch mode:
execute batch start
Enter batch mode...

To enter commands to run in batch mode:

config system global
set refresh 5
end
To execute the batch commands:
execute batch end
Exit and run batch commands...

History

FortiOS v3.0 MR1 New.

FortiOS v3.0 MR4 Control of execute batch commands in Maintenance (mntgrp) access control
group.
FortiOS v3.0 MR5 Added lastlog.

FortiGate CLI Version 3.0 MR6 Reference

564 01-30006-0015-20080205
execute central-mgmt

central-mgmt
Execute Central Management Service update of account information.

Syntax
execute central-mgmt set-mgmt-id <management_id>
execute central-mgmt update

set-mgmt-id is used to change or initially set the management ID, or your account number for
Central Management Services. This account ID must be set for the service to be enabled.
update is used to update your Central Management Service contract with your new management
account ID. This command is to be used if there are any changes to your management service
account.

Example
If you are registering with the Central Management Service for the first time, and your account number
is 123456, you would enter the following:
execute central-mgmt set-mgmt-id 123456
execute central-mgmt update

History

FortiOS v3.0 MR5 New.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 565
cfg reload execute

cfg reload
Use this command to restore the saved configuration when the configuration change mode is manual
or revert. This command has no effect if the mode is automatic, the default. The set cfg-save
command in system global sets the configuration change mode.
When you reload the saved system configuration, the your session ends and the FortiGate unit
restarts.
In the default configuration change mode, automatic, CLI commands become part of the saved unit
configuration when you execute them by entering either next or end.
In manual mode, commands take effect but do not become part of the saved configuration unless you
execute the execute cfg save command. When the FortiGate unit restarts, the saved configuration
is loaded. Configuration changes that were not saved are lost.
The revert mode is similar to manual mode, except that configuration changes are saved
automatically if the administrative session is idle for more than a specified timeout period. This
provides a way to recover from an erroneous configuration change, such as changing the IP address
of the interface you are using for administration. You set the timeout in system global using the
set cfg-revert-timeout command.

Syntax
execute cfg reload

Example
This is sample output from the command when successful:
# exec cfg reload
configs reloaded. system will reboot.This is sample output from the
command when not in runtime-only configuration mode:
# exec cfg reload
no config to be reloaded.

History

FortiOS v3.0 MR2 New.

Related topics
• execute cfg save
• system global

FortiGate CLI Version 3.0 MR6 Reference

566 01-30006-0015-20080205
execute cfg save

cfg save
Use this command to save configuration changes when the configuration change mode is manual or
revert. If the mode is automatic, the default, all changes are added to the saved configuration as
you make them and this command has no effect. The set cfg-save command in system global
sets the configuration change mode.
In manual mode, commands take effect but do not become part of the saved configuration unless you
execute the execute cfg save command. When the FortiGate unit restarts, the saved configuration
is loaded. Configuration changes that were not saved are lost.
The revert mode is similar to manual mode, except that configuration changes are saved
automatically if the administrative session is idle for more than a specified timeout period. This
provides a way to recover from an erroneous configuration change, such as changing the IP address
of the interface you are using for administration. To change the timeout from the default of 600
seconds, go to system global and use the set cfg-revert-timeout command.

Syntax
execute cfg save

Example
This is sample output from the command:
# exec cfg save
config saved.
This is sample output when not in runtime-only configuration mode. It also occurs when in runtime-only
configuration mode and no changes have been made:
# exec cfg save
no config to be saved.

History

FortiOS v3.0 MR2 New.

Related topics
• execute cfg reload
• system global

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 567
clear system arp table execute

clear system arp table

Clear all the entries in the arp table.

Syntax
exec clear system arp table

History

FortiOS v3.0 MR3 New.

Related topics
• execute router restart
• get router info routing-table
• get system arp

FortiGate CLI Version 3.0 MR6 Reference

568 01-30006-0015-20080205
execute cli status-msg-only

cli status-msg-only
Enable standardized CLI error output messages. If executed, this command stops other debug
messages from displaying in the current CLI session.

Syntax
exec cli status-msg-only <enable | disable>
The message format is:
[error code]: text message
There are three error categories: OK, Keyword Error, and Data Error. The error code provides details
about the type of error.
An OK message [00000] indicates that the command has been accepted. An ERROR message
indicates that the command generated an error. A Keyword Error [1000x] indicates that the keyword
is not supported, or the attempted command is not recognized. A Data Error [2000x] indicates that
the data source is already in use.

Keywords and variables Description

status-msg-only <enable | Enables standardized CLI error output messages.
disable>

History

FortiOS v3.0 MR5 New.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 569
cli check-template-status execute

cli check-template-status
Reports the status of the SCP script template.

Syntax
exec cli check-template-status

History

FortiOS v3.0 MR6 New.

FortiGate CLI Version 3.0 MR6 Reference

570 01-30006-0015-20080205
execute date

date
Get or set the system date.

Syntax
execute date [<date_str>]
date_str has the form yyyy-mm-dd, where
• yyyy is the year and can be 2001 to 2037
• mm is the month and can be 01 to 12
• dd is the day of the month and can be 01 to 31
If you do not specify a date, the command returns the current system date. Shortened values, such as
‘06’ instead of ‘2006’ for the year or ‘1’ instead of ‘01’ for month or day, are not valid.

Example
This example sets the date to 17 September 2004:
execute date 2004-09-17

History

FortiOS v2.80 MR4 New.

FortiOS v3.0 MR1 <date_str> changed from mm/dd/yyyy format.

Related topics
• execute time

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 571
deploy execute

deploy
Configure deploy mode.
This command is used by FortiManager.

Syntax
execute deploy start cmd
execute deploy confirm <confirm_code>
execute deploy end

Keywords and variables Description

start cmd Put the FortiGate unit into deploy mode.
confirm <confirm_code> Enter the confirmation string for this deployment.
end End deployment mode and activate the actual deployment.
The deployment code is displayed, and you will be prompted before this
command is executed.

History

FortiOS v3.0 MR4 New.

FortiGate CLI Version 3.0 MR6 Reference

572 01-30006-0015-20080205
execute dhcp lease-clear

dhcp lease-clear
Clear all DHCP address leases.

Syntax
execute dhcp lease-clear

History

FortiOS v2.80 MR2 New.

FortiOS v3.0 Command name changed from execute dhcpclear.

Related topics
• execute dhcp lease-list
• system dhcp server
• system dhcp reserved-address

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 573
dhcp lease-list execute

dhcp lease-list
Display DHCP leases on a given interface

Syntax
execute dhcp lease-list [interface_name]
If you specify an interface, the command lists only the leases issued on that interface. Otherwise, the
list includes all leases issued by DHCP servers on the FortiGate unit.
If there are no DHCP leases in user on the FortiGate unit, an error will be returned.

History

FortiOS v2.90 New.

Related topics
• execute deploy
• system dhcp server
• system dhcp reserved-address

FortiGate CLI Version 3.0 MR6 Reference

574 01-30006-0015-20080205
execute disconnect-admin-session

disconnect-admin-session
Disconnect an administrator who is logged in.

Syntax
execute disconnect-admin-session <index_number>
To determine the index of the administrator that you want to disconnect, view the list of logged-in
administrators by using the following command:
execute disconnect-admin-session ?
The list of logged-in administrators looks like this:
Connected:
INDEX USERNAME TYPE FROM TIME
0 admin WEB 172.20.120.51 Mon Aug 14 12:57:23 2006
1 admin2 CLI ssh(172.20.120.54) Mon Aug 14 12:57:23 2006

Example
This example shows how to disconnect a logged in administrator.
execute disconnect-admin-session 1

History

FortiOS v2.90 New.

FortiOS v3.0 MR3 Changed execute disconnect <index_number> to execute disconnect-
admin-session <index_number>. Deleted get system logged-users reference.

Related topics
• system mac-address-table
• get system info admin status

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 575
factoryreset execute

factoryreset
Reset the FortiGate configuration to factory default settings.

Syntax
execute factoryreset

Caution: This procedure deletes all changes that you have made to the FortiGate configuration and reverts the
! system to its original configuration, including resetting interface addresses.

History

FortiOS v2.80 No changes.

Related topics
• execute backup
• execute reboot

FortiGate CLI Version 3.0 MR6 Reference

576 01-30006-0015-20080205
execute formatlogdisk

formatlogdisk
Format the FortiGate hard disk to enhance performance for logging.

Syntax
execute formatlogdisk

! Caution: This operation will erase all quarantine files and logging data on the hard disk.

History
FortiOS v2.80 No change.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 577
fortiguard-log update execute

fortiguard-log update
Update the FortiGuard Log and Analysis contract.

Syntax
execute fortiguard-log update

History

FortiOS v3.0 MR4 New.

Related topics
• system fortiguard
• log fortianalyzer setting
• {disk | fortianalyzer | memory | syslogd | webtrends | fortiguard} filter

FortiGate CLI Version 3.0 MR6 Reference

578 01-30006-0015-20080205
execute fsae refresh

fsae refresh
Use this command to manually refresh user group information from Windows AD servers connected to
the FortiGate unit using the Fortinet Server Authentication Extensions (FSAE).

Syntax
execute fsae refresh

History

FortiOS v3.0 New.

Related topics
• user fsae

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 579
ha disconnect execute

ha disconnect
Use this command to disconnect a FortiGate unit from a functioning cluster. You must specify the serial
number of the unit to be disconnected. You must also specify an interface name and assign an IP
address and netmask to this interface of the disconnected unit. You can disconnect any unit from the
cluster even the primary unit. After the unit is disconnected the cluster responds as if the disconnected
unit has failed. The cluster may renegotiate and may select a new primary unit.
To disconnect the unit from the cluster, the execute ha disconnect command sets the HA mode of
the disconnected unit to standalone. In addition, all interface IP addresses of the disconnected unit are
set to 0.0.0.0. The interface specified in the command is set to the IP address and netmask that you
specify in the command. In addition all management access to this interface is enabled. Once the
FortiGate unit is disconnected you can use SSH, telnet, HTTPS, or HTTP to connect to and manage
the FortiGate unit.

Syntax
execute ha disconnect <cluster-member-serial_str> <interface_str>
<address_ipv4> <address_ipv4mask>

Keywords and variables Description

cluster-member-serial_str The serial number of the cluster unit to be disconnected.
interface_str The name of the interface to configure. The command configures the IP
address and netmask for this interface and also enables all management
access for this interface.

Example
This example shows how to disconnect a cluster unit with serial number FGT5002803033050. The
internal interface of the disconnected unit is set to IP address 1.1.1.1 and netmask 255.255.255.0.
execute ha disconnect FGT5002803033050 internal 1.1.1.1 255.255.255.0

History

FortiOS v3.0 New

Related topics
• execute ha manage
• execute ha synchronize
• system ha

FortiGate CLI Version 3.0 MR6 Reference

580 01-30006-0015-20080205
execute ha manage

ha manage
Use this command from the CLI of a FortiGate unit in an HA cluster to log into the CLI of another unit in
the cluster. Usually you would use this command from the CLI of the primary unit to log into the CLI of
a subordinate unit. However, if you have logged into a subordinate unit CLI, you can use this command
to log into the primary unit CLI, or the CLI of another subordinate unit.
You can use CLI commands to manage the cluster unit that you have logged into. If you make changes
to the configuration of any cluster unit (primary or subordinate unit) these changes are synchronized to
all cluster units.

Syntax
execute ha manage <cluster-index>
Keywords and variables Description
cluster-index The cluster index is assigned by the FortiGate Clustering Protocol
according to cluster unit serial number. The cluster unit with the highest
serial number has a cluster index of 0. The cluster unit with the second
highest serial number has a cluster index of 1 and so on.
Enter ? to list the cluster indexes of the cluster units that you can log into.
The list does not show the unit that you are already logged into.

Example
This example shows how to log into a subordinate unit in a cluster of three FortiGate units. In this
example you have already logged into the primary unit. The primary unit has serial number
FGT3082103000056. The subordinate units have serial numbers FGT3012803021709 and
FGT3082103021989.
execute ha manage ?
<id> please input slave cluster index.
<0> Subsidary unit FGT3012803021709
<1> Subsidary unit FGT3082103021989

Type 0 and press enter to connect to the subordinate unit with serial number FGT3012803021709. The
CLI prompt changes to the host name of this unit. To return to the primary unit, type exit.
From the subordinate unit you can also use the execute ha manage command to log into the
primary unit or into another subordinate unit. Enter the following command:
execute ha manage ?
<id> please input slave cluster index.
<1> Subsidary unit FGT3082103021989
<2> Subsidary unit FGT3082103000056

Type 2 and press enter to log into the primary unit or type 1 and press enter to log into the other
subordinate unit. The CLI prompt changes to the host name of this unit.

History

FortiOS v2.80 Unchanged.

FortiOS v3.0 Unchanged.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 581
ha manage execute

Related topics
• execute ha disconnect
• execute ha synchronize
• system ha

FortiGate CLI Version 3.0 MR6 Reference

582 01-30006-0015-20080205
execute ha synchronize

ha synchronize
Use this command from a subordinate unit in an HA cluster to manually synchronize its configuration
with the primary unit. Using this command you can synchronize the following:
• Configuration changes made to the primary unit (normal system configuration, firewall
configuration, VPN configuration and so on stored in the FortiGate configuration file),
• Antivirus engine and antivirus definition updates received by the primary unit from the FortiGuard
Distribution Network (FDN),
• IPS attack definition updates received by the primary unit from the FDN,
• Web filter lists added to or changed on the primary unit,
• Email filter lists added to or changed on the primary unit,
• Certification Authority (CA) certificates added to the primary unit,
• Local certificates added to the primary unit.
You can also use the start and stop keywords to force the cluster to synchronize its configuration or
to stop a synchronization process that is in progress.

Syntax
execute ha synchronize {config| avupd| attackdef| weblists| emaillists|
ca| localcert| all | start | stop}
Variables Description
config Synchronize the FortiGate configuration.
avupd Synchronize the antivirus engine and antivirus definitions.
attackdef Synchronize attack definitions.
weblists Synchronize web filter lists.
emaillists Synchronize email filter lists.
ca Synchronize CA certificates.
localcert Synchronize local certificates.
all Synchronize all of the above.
start Start synchronizing the cluster configuration.
stop Stop the cluster from completing synchronizing its configuration.

Example
From the CLI of a subordinate unit, use the following commands to synchronize the antivirus and
attack definitions on the subordinate FortiGate unit with the primary unit after the FDN has pushed new
definitions to the primary unit.
execute ha synchronize avupd
execute ha synchronize attackdef

History

FortiOS v2.80 MR6 Added start and stop keywords.

FortiOS v3.0 Unchanged.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 583
ha synchronize execute

Related topics
• execute ha disconnect
• execute ha manage
• system ha

FortiGate CLI Version 3.0 MR6 Reference

584 01-30006-0015-20080205
execute interface dhcpclient-renew

interface dhcpclient-renew
Renew the DHCP client for the specified DHCP interface and close the CLI session. If there is no
DHCP connection on the specified port, there is no output.

Syntax
execute interface dhcpclient-renew <port>

Example
This is the output for renewing the DHCP client on port1 before the session closes:
# exec interface dhcpclient-renew port1
renewing dhcp lease on port1

History

FortiOS v3.0 MR2 New. Replaces the old connect-enable command

Related topics
• execute deploy
• execute dhcp lease-list

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 585
interface pppoe-reconnect execute

interface pppoe-reconnect
Reconnect to the PPPoE service on the specified PPPoE interface and close the CLI session. If there
is no PPPoE connection on the specified port, there is no output.

Syntax
execute interface pppoe-reconnect <port>

History

FortiOS v3.0 MR2 New. Replaces the old connect-enable command

Related topics
• execute modem dial
• execute modem hangup

FortiGate CLI Version 3.0 MR6 Reference

586 01-30006-0015-20080205
execute log delete-all

log delete-all
Use this command to clear all log entries in memory and current log files on hard disk. If your FortiGate
unit has no hard disk, only log entries in memory will be cleared. You will be prompted to confirm the
command.

Syntax
execute log delete-all

History

FortiOS v3.0 New.

Related topics
• execute log delete-filtered
• execute log delete-rolled
• execute log display
• execute log filter
• execute log list

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 587
log delete-filtered execute

log delete-filtered
Use this command to delete log messages that match the current filter. You need to first set the log
filter with the execute log filter <filter> command.

Syntax
execute log delete-filtered

Example
To delete all traffic logs, enter the following commands:
execute log filter category traffic
execute log delete-filtered

History

FortiOS v2.90 New

Related topics
• execute log filter
• execute log delete-rolled
• execute log display
• execute log list

FortiGate CLI Version 3.0 MR6 Reference

588 01-30006-0015-20080205
execute log delete-rolled

log delete-rolled
Use this command to delete rolled log files.

Syntax
execute log delete-rolled <category> <start> <end>

Variable Description
<category> Enter the category of rolled log files that you want to delete:
• event
• ids
• spam
• traffic
• virus
• webfilter
<start> Enter the number of the first log to delete. If you are deleting multiple rolled log files, you
must also enter a number for end.
<end> Enter the number of the last log to delete, if you are deleting multiple rolled log files.

<category> must be one of: event, ids, spam, traffic, virus or webfilter. The <start>
and <end> values represent the range of log files to delete. If <end> is not specified, only the
<start> log number is deleted.

Example
To delete all of the rolled traffic log files, enter the following command:
execute log delete-rolled traffic 1 9999

History

FortiOS v2.90 New

Related topics
• log fortianalyzer setting
• execute log delete-filtered
• execute log filter
• execute log delete-all

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 589
log display execute

log display
Use this command to display log messages that you have selected with the execute log filter
command.

Syntax
execute log display
The console displays the first 10 log messages. To view more messages, run the command again. You
can do this until you have seen all of the selected log messages. To restart viewing the list from the
beginning, use the commands
execute log filter start_index 1
execute log display
You can restore the log filters to their default values using the command
execute log filter reset

History

FortiOS v2.90 New

Related topics
• execute log filter
• execute log delete-filtered

FortiGate CLI Version 3.0 MR6 Reference

590 01-30006-0015-20080205
execute log filter

log filter
Use this command to select log messages for viewing or deletion. You can view one log category on
one device at a time. Optionally, you can filter the messages to select only specified date ranges or
severities of log messages. For traffic logs, you can filter log messages by source or destination IP
address.
Commands are cumulative. If you omit a required variable, the command displays the current setting.
Use as many execute log filter commands as you need to define the log messages that you
want to view.

execute log filter category <category_name>

execute log filter device {disk | memory}
execute log filter field <name> [date[from_yyy-mm-dd to_yyy-mm-dd]|time
[from_hh:mm:ss to_hh:mm:ss]|log_id<string>[string2 string3...]|type<string>
[string2 string3...]|subtype <subtype>[subtype2 subtype3...]|pri <priority>
[priority2 priority3..]|user <user_id>[user_id2 user_id3...] | ui <string>
[string2 string3...]|action <string> [string2 string3...]|status
<string>[string1 string2 ...]|reason <string> [string1 string2 ...]|reason
<string> [string1 string2 ...]}
execute log filter lines-per-view <count>
execute log filter list
execute log filter number <integer>
execute log filter reset
execute log filter rolled_number <number>
execute log filter start-line <line_number>

Variables Description Default

category <category_name> Enter the type of log you want to select, one of: event
• traffic
• event
• virus
• webfilter
• spam
• attack
• content
• im
• voip
device {disk | memory} Device where the logs are stored. disk

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 591
log filter execute

Variables Description Default

field <name> Filter according to the following: No default.
[date[from_yyy-mm-dd to_yyy-mm- • date – filters according to date range entered in the
dd]|time [from_hh:mm:ss format yyyy-mm-dd; to exclude the date range,
to_hh:mm:ss]|log_id<string>[str specify 1 for negate. Default is 0.
ing2 string3...]|type<string> • time – filters according to the time entered in the
format hh:mm:ss
[string2 string3...]|subtype
• log_id – filters by the log identification number.
<subtype>[subtype2 Enter one of more log IDs, up to five, to match.
subtype3...]|pri <priority> • type – filters by log type; available types are attack,
[priority2 priority3..]|user content, event, spamfilter, traffic, virus, and webfilter.
<user_id>[user_id2 user_id3...] You can specify up to five log types.
| ui <string> [string2 • subtype – filters by subtype, depending on the type.
string3...]|action <string> You can specify up to five log subtypes.
[string2 string3...]|status • ui – filters by user identification. You can specify up
to five user IDs.
<string>[string1 string2
• user – filters by user interface field. You can specify
...]|reason <string> [string1 up to five strings to match in the user interface field.
string2 ...]|reason <string> • action – filters according to action. You can specify
[string1 string2 ...]} up to five actions.
• status – filters by status. You can specify up to five
strings to match in the status field.
• reason – filters by reason. You can specify up to five
strings to match in the reason field.
• msg – filters by log message content. You can
specify up to five strings to match in the log
message.
• detail – filters by log detail. You can specify up to
five strings to match in the log detail.
lines-per-view <count> Set lines per view. Range: 5 to 1000 10
list Display current filter settings. No default.
number <integer> Number of log entries displayed per page. 10
reset Execute this command to reset all filter settings. No default.
rolled_number <number> Select logs from rolled log file. 0 selects current log 0
file.
start-line <line_number> Select logs starting at specified line number. 1

History
FortiOS v2.90 New

Related topics
• execute log delete-filtered
• execute log display

FortiGate CLI Version 3.0 MR6 Reference

592 01-30006-0015-20080205
execute log fortianalzyer test-connectivity

log fortianalzyer test-connectivity

Use this command to test the connection to the FortiAnalyzer unit. This command is available only
when FortiAnalyzer is configured.

Syntax
execute log fortianalyzer test-connectivity

Example
When FortiAnalyzer is connected, the output looks like this:
FortiAnalyzer Host Name: FortiAnalyzer-800
FortiGate Device ID: FG300A2904500044
Registration: registered
Connection: allow
Disk Space (Used/Allocated): 0/1000 MB
Total Free Space: 456690 MB
Log: Tx & Rx
Report: Tx & Rx
Content Archive: Tx & Rx
Quarantine: Tx & Rx
When FortiAnalyzer is not connected, the output is: Connect Error

History

FortiOS v3.0 New

Related topics
• log fortianalyzer setting

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 593
log list execute

log list
You can view the list of current and rolled log files on the console. The list shows the file name, size
and timestamp.

Syntax
execute log list <category>
<category> must be one of: event, spam, traffic, virus or webfilter.

Example
The output looks like this:
elog 8704 Fri Jan 28 14:24:35 2005
elog.1 1536 Thu Jan 27 18:02:51 2005
elog.2 35840 Wed Jan 26 22:22:47 2005
At the end of the list, the total number of files in the category is displayed. For example:
501 event log file(s) found.

History

FortiOS v3.0 New

FortiOS v3.0 MR6 Removed the ids category.

Related topics
• execute log delete-rolled

FortiGate CLI Version 3.0 MR6 Reference

594 01-30006-0015-20080205
execute log roll

log roll
Use this command to roll all log files.

Syntax
execute log roll

History

FortiOS v3.0 New

Related topics
• execute log delete-rolled

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 595
modem dial execute

modem dial
Dial the modem.
The dial command dials the accounts configured in config system modem until it makes a
connection or it has made the maximum configured number of redial attempts.
This command applies only to models 50A, 60, 60M and 60-WiFi and is effective only if the modem is
in Standalone mode.

Syntax
execute modem dial

History

FortiOS v2.80 New

Related topics
• system modem
• execute modem hangup

FortiGate CLI Version 3.0 MR6 Reference

596 01-30006-0015-20080205
execute modem hangup

modem hangup
Hang up the modem.
This command applies only to models 50A, 60, 60M and 60-WiFi and is effective only if the modem is
in Standalone mode.

Syntax
execute modem hangup

History

FortiOS v2.80 New

Related topics
• system modem
• execute modem dial

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 597
mrouter clear execute

mrouter clear
Clear multicast routes, RP-sets, IGMP membership records or routing statistics.

Syntax
Clear IGMP memberships:
execute mrouter clear igmp-group {{<group-address>} <interface-name>}
execute mrouter clear igmp-interface <interface-name>

Clear multicast routes:

execute mrouter clear <route-type> {<group-address> {<source-address>}}

Clear PIM-SM RP-sets learned from the bootstrap router (BSR):

execute mrouter clear sparse-mode-bsr

Clear statistics:
execute mrouter clear statistics {<group-address> {<source-address>}}

Table 17: execute mrouter clear command keywords and variables

Variables Description
<interface-name> Enter the name of the interface on which you want to clear IGMP memberships.
<group-address> Optionally enter a group address to limit the command to a particular group.
<route-type> Enter one of:
• dense-routes - clear only PIM dense routes
• routes - clear all types of multicast routes
• sparse-routes - clear only sparse routes
<source-address> Optionally, enter a source address to limit the command to a particular source
address. You must also specify group-address.

History

FortiOS v3.0 New

Related topics
• router multicast
• get router info bgp

FortiGate CLI Version 3.0 MR6 Reference

598 01-30006-0015-20080205
execute ping

ping
Send an ICMP echo request (ping) to test the network connection between the FortiGate unit and
another network device.

Syntax
execute ping {<address_ipv4> | <host-name_str>}
<host-name_str> should be an IP address, or a fully qualified domain name.

Example
This example shows how to ping a host with the IP address 172.20.120.16.
execute ping 172.20.120.16
PING 172.20.120.16 (172.20.120.16): 56 data bytes
64 bytes from 172.20.120.16: icmp_seq=0 ttl=128 time=0.5 ms
64 bytes from 172.20.120.16: icmp_seq=1 ttl=128 time=0.2 ms
64 bytes from 172.20.120.16: icmp_seq=2 ttl=128 time=0.2 ms
64 bytes from 172.20.120.16: icmp_seq=3 ttl=128 time=0.2 ms
64 bytes from 172.20.120.16: icmp_seq=4 ttl=128 time=0.2 ms
--- 172.20.120.16 ping statistics ---
5 packets transmitted, 5 packets received, 0% packet loss
round-trip min/avg/max = 0.2/0.2/0.5 ms

History

FortiOS v2.80 No change.

FortiOS v3.0 No change.

Related topics
• execute ping-options
• execute ping6
• execute traceroute

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 599
ping-options execute

ping-options
Set ICMP echo request (ping) options to control the way ping tests the network connection between
the FortiGate unit and another network device.

Syntax
execute ping-options data-size <bytes>
execute ping-options df-bit {yes | no}
execute ping-options pattern <2-byte_hex>
execute ping-options repeat-count <repeats>
execute ping-options source {auto | <source-intf_ip>}
execute ping-options timeout <seconds>
execute ping-options tos <service_type>
execute ping-options ttl <hops>
execute ping-options validate-reply {yes | no}
execute ping-options view-settings

Keyword Description Default

data-size <bytes> Specify the datagram size in bytes. 56
df-bit {yes | no} Set df-bit to yes to prevent the ICMP packet from being no
fragmented. Set df-bit to no to allow the ICMP packet to be
fragmented.
pattern <2-byte_hex> Used to fill in the optional data buffer at the end of the ICMP No
packet. The size of the buffer is specified using the data_size default.
parameter. This allows you to send out packets of different sizes
for testing the effect of packet size on the connection.
repeat-count <repeats> Specify how many times to repeat ping. 5
source Specify the FortiGate interface from which to send the ping. If you auto
{auto | <source-intf_ip>} specify auto, the FortiGate unit selects the source address and
interface based on the route to the <host-name_str> or
<host_ip>. Specifying the IP address of a FortiGate interface
tests connections to different network segments from the specified
interface.
timeout <seconds> Specify, in seconds, how long to wait until ping times out. 2
tos <service_type> Set the ToS (Type of Service) field in the packet header to provide 0
an indication of the quality of service wanted.
• lowdelay = minimize delay
• throughput = maximize throughput
• reliability = maximize reliability
• lowcost = minimize cost
ttl <hops> Specify the time to live. Time to live is the number of hops the ping 64
packet should be allowed to make before being discarded or
returned.
validate-reply {yes | no} Select yes to validate reply data. no
view-settings Display the current ping-option settings. No
default

FortiGate CLI Version 3.0 MR6 Reference

600 01-30006-0015-20080205
execute ping-options

Example
Use the following command to increase the number of pings sent.
execute ping-options repeat-count 10
Use the following command to send all pings from the FortiGate interface with IP address
192.168.10.23.
execute ping-options source 192.168.10.23

History

FortiOS v2.80 No change.

Related topics
• execute ping
• execute ping6
• execute traceroute
• system tos-based-priority

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 601
ping6 execute

ping6
Send an ICMP echo request (ping) to test the network connection between the FortiGate unit and an
IPv6 capable network device.

Syntax
execute ping6 {<address_ipv6> | <host-name_str>}

Example
This example shows how to ping a host with the IPv6 address
12AB:0:0:CD30:123:4567:89AB:CDEF.
execute ping6 12AB:0:0:CD30:123:4567:89AB:CDEF

History

FortiOS v2.80 New.

Related topics
• execute ping
• execute ping-options
• router static6

FortiGate CLI Version 3.0 MR6 Reference

602 01-30006-0015-20080205
execute reboot

reboot
Restart the FortiGate unit.

Syntax
execute reboot <comment “comment_string”>
<comment “comment_string”> allows you to optionally add a message that will appear in the hard disk
log indicating the reason for the reboot. If the message is more than one word it must be enclosed in
quotes.

Example
This example shows the reboot command with a message included.
execute reboot comment “December monthly maintenance”

History

FortiOS v2.80 Unchanged.

FortiOS v3.0 MR4 Added comment keyword.

Related topics
• execute backup
• execute factoryreset

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 603
restore execute

restore
Use this command to
• restore the configuration from a file
• change the FortiGate firmware
• change the FortiGate backup firmware
• restore an IPS custom signature file
When virtual domain configuration is enabled (in system global, vdom-admin is enabled), the
content of the backup file depends on the administrator account that created it.
• A backup of the system configuration from the super admin account contains the global settings
and the settings for all of the VDOMs. Only the super admin account can restore the configuration
from this file.
• A backup file from a regular administrator account contains the global settings and the settings for
the VDOM to which the administrator belongs. Only a regular administrator account can restore the
configuration from this file.

Syntax
execute restore config management-station <type> <revision>
execute restore config tftp <filename> <tftp_ipv4> [<password>]
execute restore config usb <filename> [<password>]
execute restore av tftp <avfile> <tftp_ip4>
execute restore forticlient <fc_filename> <tftp_ipv4>
execute restore image ftp <filename> <ftp_ipv4>
execute restore image tftp <filename> <tftp_ipv4>
execute restore image usb <filename>
execute restore ips tftp <ipsfile> <tftp_ip4>
execute restore ipsuserdefsig <filename> <tftp_ipv4>
execute restore secondary-image tftp <filename> <tftp_ipv4>
execute restore secondary-image usb <filename>

Variables Description
config management-station Restore the system configuration from the Central Management
<type> <revision> server. The new configuration replaces the existing configuration,
including administrator accounts and passwords.
type can be normal or template. A template is a configuration
that can be applied to multiple FortiGate units.
revision is the number of the saved configuration to restore.
If the backup file was created with a password, you must specify
that password.
config tftp <filename> Restore the system configuration from a file on a TFTP server.
<tftp_ipv4> [<password>] The new configuration replaces the existing configuration,
including administrator accounts and passwords.
If the backup file was created with a password, you must specify
that password.

FortiGate CLI Version 3.0 MR6 Reference

604 01-30006-0015-20080205
execute restore

Variables Description
config usb <filename> Restore the system configuration from a file on a USB disk. The
[<password>] new configuration replaces the existing configuration, including
administrator accounts and passwords.
If the backup file was created with a password, you must specify
that password.
av tftp <avfile> <tftp_ip4> Upload the antivirus database file from a TFTP server to the
FortiGate unit.
forticlient <fc_filename> Upload the FortiClient image from a TFTP server to the FortiGate
<tftp_ipv4> unit. The filename must have the format:
FortiClientSetup_versionmajor.versionminor.build.exe.
For example, FortiClientSetup.3.0.377.exe.
image ftp <filename> Upload a firmware image from an FTP server to the FortiGate
<ftp_ipv4> unit. The FortiGate unit reboots, loading the new firmware.
This command is not available in multiple VDOM mode.

image tftp <filename> Upload a firmware image from a TFTP server to the FortiGate
<tftp_ipv4> unit. The FortiGate unit reboots, loading the new firmware.
This command is not available in multiple VDOM mode.
image usb <filename> Upload a firmware image from a USB disk to the FortiGate unit.
The FortiGate unit reboots, loading the new firmware.
ips tftp <ipsfile> <tftp_ip4> Upload the IPS database file from a TFTP server to the FortiGate
unit.
ipsuserdefsig <filename> Restore an IPS custom signature file. The file will overwrite the
<tftp_ipv4> existing IPS custom signature file.

secondary-image tftp <filename> Upload a firmware image from a TFTP server as the backup
<tftp_ipv4> firmware of the FortiGate unit. This is available only on models
numbered 100 and higher.
secondary-image usb <filename> Upload a firmware image from a USB disk as the backup
firmware of the FortiGate unit. The unit restarts when the upload
is complete. This is available only on models numbered 100 and
higher.

Example
This example shows how to upload a configuration file from a TFTP server to the FortiGate unit and
restart the FortiGate unit with this configuration. The name of the configuration file on the TFTP server
is backupconfig. The IP address of the TFTP server is 192.168.1.23.
execute restore config tftp backupconfig 192.168.1.23

History
FortiOS v2.80 Revised.
FortiOS v3.0 Added USB restore options and secondary-image restoration.
Removed allconfig option.
FortiOS v3.0 MR2 Added FTP restore option.
FortiOS v3.0 MR4 Added av, forticlient, ips keywords.
FortiOS v3.0 MR5 Added config management-station

Related topics
• execute backup
• ips custom

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 605
router clear bgp execute

router clear bgp

Use this command to clear BGP peer connections.

Syntax
execute router clear bgp all [soft] [in | out]
execute router clear bgp as <as_number> [soft] [in | out]
execute router clear bgp dampening {ip_address | ip/netmask}
execute router clear bgp external {in prefix-filter} [soft] [in | out]
execute router clear bgp flap-statistics {ip_address | ip/netmask}
execute router clear bgp ip <ip_address> [soft] [in | out]

Variables Description
all Clear all BGP peer connections.
as <as_number> Clear BGP peer connections by AS number.
dampening {ip_address | ip/netmask} Clear route flap dampening information for peer or network.
external {in prefix-filter} Clear all external peers.
ip <ip_address> Clear BGP peer connections by IP address.
peer-group Clear all members of a BGP peer-group.
[in | out] Optionally limit clear operation to inbound only or outbound
only.
flap-statistics {ip_address | Clear flap statistics for peer or network.
ip/netmask}
soft Do a soft reset that changes the configuration but does not
disturb existing sessions.

History

FortiOS v2.80 MR2 New.

FortiOS v3.0 MR1 Added flap-statistics keyword.

Related topics
• router bgp

FortiGate CLI Version 3.0 MR6 Reference

606 01-30006-0015-20080205
execute router clear bfd

router clear bfd

Use this command to clear bi-directional forwarding session.

Syntax
execute router clear bfd session <src_ip> <dst_ip> <interface>

Variables Description
<src_ip> Select the source IP address of the session.
<dst_ip> Select the destination IP address of the session.
<interface> Select the interface for the session.

History

FortiOS v3.0 MR4 New.

Related topics
• router bgp

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 607
router clear ospf process execute

router clear ospf process

Use this command to clear and restart the OSPF router.

Syntax
execute router clear ospf process

History

FortiOS v3.0 MR1 New.

Related topics
• router ospf

FortiGate CLI Version 3.0 MR6 Reference

608 01-30006-0015-20080205
execute router restart

router restart
Use this command to restart the routing software.

Syntax
execute router restart

History

FortiOS v2.80 MR2 New.

Related topics
• router

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 609
send-fds-statistics execute

send-fds-statistics
Use this command to send an FDS statistics report now, without waiting for the FDS statistics report
interval to expire.

Syntax
execute send-fds-statistics

History

FortiOS v3.0 MR6 New.

FortiGate CLI Version 3.0 MR6 Reference

610 01-30006-0015-20080205
execute set-next-reboot

set-next-reboot
Use this command to start the FortiGate unit with primary or secondary firmware after the next reboot.
This command is useful only on models numbered 100 and higher which are able to store two
firmware images. By default, the FortiGate unit loads the firmware from the primary partition.
VDOM administrators do not have permission to run this command. It must be executed by a super
administrator.

Syntax
execute set-next-reboot {primary | secondary}

History

FortiOS v3.0 New.

FortiOS v3.0 MR3 VDOM admins can’t run this command.

Related topics
• execute reboot
• execute shutdown

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 611
shutdown execute

shutdown
Shut down the FortiGate unit now. You will be prompted to confirm this command.

Syntax
execute shutdown <comment> <comment_string>
<comment> allows you to optionally add a message that will appear in the hard disk log indicating the
reason for the shutdown. If the message is more than one word it must be enclosed in quotes.

Example
This example shows the reboot command with a message included.
execute shutdown comment “emergency facility shutdown”

History

FortiOS v2.80 MR8 New.

FortiOS v3.0 MR4 Added comment.

Related topics
• execute factoryreset
• execute reboot

FortiGate CLI Version 3.0 MR6 Reference

612 01-30006-0015-20080205
execute ssh

ssh
Use this command to establish an ssh session with another system.

Syntax
execute ssh <destination>
<destination> - the destination in the form user@ip or user@host.

Example
execute ssh [email protected]
To end an ssh session, type exit:
FGT-6028030112 # exit
Connection to 172.20.120.122 closed.
FGT-8002805000 #

History
FortiOS v3.0 MR3 New.

Related topics
• execute ping
• execute traceroute
• system interface

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 613
telnet execute

telnet
Use telnet client. You can use this tool to test network connectivity.

Syntax
execute telnet <telnet_ipv4>
<telnet_ipv4> is the address to connect with.
Type exit to close the telnet session.

History

FortiOS v3.0 New.

Related topics
• execute ping
• execute traceroute
• system interface

FortiGate CLI Version 3.0 MR6 Reference

614 01-30006-0015-20080205
execute time

time
Get or set the system time.

Syntax
execute time [<time_str>]
time_str has the form hh:mm:ss, where
• hh is the hour and can be 00 to 23
• mm is the minutes and can be 00 to 59
• ss is the seconds and can be 00 to 59
If you do not specify a time, the command returns the current system time.
You are allowed to shorten numbers to only one digit when setting the time. For example both 01:01:01
and 1:1:1 are allowed.

Example
This example sets the system time to 15:31:03:
execute time 15:31:03

History

FortiOS v2.80 MR4 New.

Related topics
• execute date

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 615
traceroute execute

traceroute
Test the connection between the FortiGate unit and another network device, and display information
about the network hops between the device and the FortiGate unit.

Syntax
execute traceroute {<ip_address> | <host-name>}

Example
This example shows how to test the connection with http://docs.forticare.com. In this example the
traceroute command times out after the first hop indicating a possible problem.
#execute traceoute docs.forticare.com
traceroute to docs.forticare.com (65.39.139.196), 30 hops max, 38 byte
packets
1 172.20.120.2 (172.20.120.2) 0.324 ms 0.427 ms 0.360 ms
2 * * *
If your FortiGate unit is not connected to a working DNS server, you will not be able to connect to
remote host-named locations with traceroute.

History

FortiOS v2.80 No change.

Related topics
• execute ping
• execute ping-options

FortiGate CLI Version 3.0 MR6 Reference

616 01-30006-0015-20080205
execute update-av

update-av
Use this command to manually initiate the virus definitions and engines update. To update both virus
and attack definitions, use the execute update-now command.

Syntax
execute update-av

History

FortiOS v3.0 MR2 New.

Related topics
• execute update-now
• system autoupdate override
• system autoupdate push-update
• system autoupdate schedule

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 617
update-ips execute

update-ips
Use this command to manually initiate the Intrusion Prevention System (IPS) attack definitions and
engine update. To update both virus and attack definitions, use the execute update-now command.

Syntax
execute update-ips

History

FortiOS v3.0 MR2 New.

FortiOS v3.0 MR4 Command name changed from execute update-ids to execute update-ips.

Related topics
• execute update-now
• system autoupdate override
• system autoupdate override
• system autoupdate push-update
• system autoupdate schedule

FortiGate CLI Version 3.0 MR6 Reference

618 01-30006-0015-20080205
execute update-now

update-now
Use this command to manually initiate both virus and attack definitions and engine updates. To initiate
only virus or attack definitions, use the execute update-av or execute update-ids command
respectively.

Syntax
execute update-now

History

FortiOS v2.80 Revised.

Related topics
• execute update-av
• execute update-ips
• system autoupdate override
• system autoupdate push-update
• system autoupdate schedule

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 619
upd-vd-license execute

upd-vd-license
Use this command to enter a Virtual Domain (VDOM) license key.
If you have a FortiGate-3000 unit or higher, you can purchase a license key from Fortinet to increase
the maximum number of VDOMs to 25, 50, 100 or 250. By default, FortiGate units support a maximum
of 10 VDOMs.
This command is available only on FortiGate-3000 unit and higher.

Syntax
execute upd-vd-license <license_key>

Variables Description
<license_key> The license key is a 32-character string supplied by
Fortinet. Fortinet requires your unit serial number to
generate the license key.

History

FortiOS v3.0 New.

FortiGate CLI Version 3.0 MR6 Reference

620 01-30006-0015-20080205
execute usb-disk

usb-disk
Use these commands to manage your USB disks.

Syntax
execute usb-disk delete <filename>
execute usb-disk format
execute usb-disk list
execute usb-disk rename <old_name> <new_name>

Variables Description
delete <filename> Delete the named file from the USB disk.
format Format the USB disk.
list List the files on the USB disk.
rename <old_name> <new_name> Rename a file on the USB disk.

History
FortiOS v3.0 New.

Related topics
• execute backup
• execute restore

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 621
vpn certificate ca execute

vpn certificate ca
Use this command to import a CA certificate from a TFTP or SCEP server to the FortiGate unit, or to
export a CA certificate from the FortiGate unit to a TFTP server.
Before using this command you must obtain a CA certificate issued by a CA.
Digital certificates are used to ensure that both participants in an IPSec communications session are
trustworthy, prior to an encrypted VPN tunnel being set up between the participants. The CA certificate
is the certificate that the FortiGate unit uses to authenticate itself to other devices.

Note: VPN peers must use digital certificates that adhere to the X.509 standard.

Note: Digital certificates are not required for configuring FortiGate VPNs. Digital certificates are an advanced
feature provided for the convenience of system administrators. This manual assumes the user has prior
knowledge of how to configure digital certificates for their implementation.

Syntax
execute vpn certificate ca export tftp <certificate-name_str>
<file-name_str> <tftp_ip>
execute vpn certificate ca import auto <ca_server_url> <ca_identifier_str>
execute vpn certificate ca import tftp <file-name_str> <tftp_ip>

Keyword/variable Description
import Import the CA certificate from a TFTP server to the FortiGate unit.
export Export or copy the CA certificate from the FortiGate unit to a file on the
TFTP server. Type ? for a list of certificates.
<certificate-name_str> Enter the name of the CA certificate.
<file-name_str> Enter the file name on the TFTP server.
<tftp_ip> Enter the TFTP server address.
auto Retrieve a CA certificate from a SCEP server.
tftp Import the CA certificate to the FortiGate unit from a file on a TFTP
server (local administrator PC).
<ca_server_url> Enter the URL of the CA certificate server.
<ca_identifier_str> CA identifier on CA certificate server (optional).

Examples
Use the following command to import the CA certificate named trust_ca to the FortiGate unit from a
TFTP server with the address 192.168.21.54.
execute vpn certificate ca import trust_ca 192.168.21.54

FortiGate CLI Version 3.0 MR6 Reference

622 01-30006-0015-20080205
execute vpn certificate ca

History

FortiOS v2.80 MR2 The delete keyword was added.

The download keyword was changed to export.
FortiOS v2.80 MR3 Keywords were removed from the execute vpn certificate local
keyword and replaced with variables.
FortiOS v3.0 MR1 Removed all keywords but generate.
FortiOS v3.0 MR3 Added keywords import, export.
FortiOS v3.0 MR4 Added keywords auto, tftp and variables <ca_server_url>,
<ca_identifier_str> as result of the addition of the PKI certificate
authentication feature.

Related topics
• execute vpn certificate local
• execute vpn certificate remote
• execute vpn certificate crl
• execute vpn sslvpn del-tunnel
• execute vpn sslvpn del-web
• vpn certificate ca
• vpn certificate local
• vpn certificate crl
• vpn certificate remote

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 623
vpn certificate crl execute

vpn certificate crl

Use this command to get a CRL via LDAP, HTTP, or SCEP protocol, depending on the auto-update
configuration.
In order to use the command execute vpn certificate crl, the authentication servers must already be
configured.
Digital certificates are used to ensure that both participants in an IPSec communications session are
trustworthy, prior to an encrypted VPN tunnel being set up between the participants. The CA certificate
is the certificate that the FortiGate unit uses to authenticate itself to other devices.

Note: VPN peers must use digital certificates that adhere to the X.509 standard.

Note: Digital certificates are not required for configuring FortiGate VPNs. Digital certificates are an advanced
feature provided for the convenience of system administrators. This manual assumes the user has prior
knowledge of how to configure digital certificates for their implementation.

Syntax
execute vpn certificate crl import auto <crl-name>

Keyword/variable Description
import Import the CRL from the configured LDAP, HTTP, or SCEP
authentication server to the FortiGate unit.
<crl-name> Enter the name of the CRL.
auto Trigger an auto-update of the CRL from the configured LDAP, HTTP, or
SCEP authentication server.

History

FortiOS v3.0 MR4 New.

Related topics
• execute vpn certificate ca
• execute vpn certificate local
• execute vpn certificate remote
• execute vpn sslvpn del-tunnel
• execute vpn sslvpn del-web
• vpn certificate ca
• vpn certificate local
• vpn certificate crl
• vpn certificate remote

FortiGate CLI Version 3.0 MR6 Reference

624 01-30006-0015-20080205
execute vpn certificate local

vpn certificate local

Use this command to generate a local certificate, to export a local certificate from the FortiGate unit to
a TFTP server, and to import a local certificate from a TFTP server to the FortiGate unit.
Digital certificates are used to ensure that both participants in an IPSec communications session are
trustworthy, prior to an encrypted VPN tunnel being set up between the participants. The local
certificate is the certificate that the FortiGate unit uses to authenticate itself to other devices.
When you generate a certificate request, you create a private and public key pair for the local
FortiGate unit. The public key accompanies the certificate request. The private key remains
confidential.
When you receive the signed certificate from the CA, use the vpn certificate local command
to install it on the FortiGate unit.

Note: VPN peers must use digital certificates that adhere to the X.509 standard.

Note: Digital certificates are not required for configuring FortiGate VPNs. Digital certificates are an advanced
feature provided for the convenience of system administrators. This manual assumes the user has prior
knowledge of how to configure digital certificates for their implementation.

Syntax - generate
execute vpn certificate local generate <certificate-name_str>
<key-length> {<host_ip> | <domain-name_str> | email-addr_str>}
[<optional_information>]

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.
<host_ip>
{<host_ip> | Enter the host IP address (host_ip), the domain name
<domain-name_str> | (domain-name_str), or an email address (email-addr_str) to
email-addr_str>} identify the FortiGate unit being certified. Preferably use an IP address
or domain name. If this is impossible (such as with a dialup client), use
an e-mail address.
For host_ip, enter the IP address of the FortiGate unit.
For domain-name_str, enter the fully qualified domain name of the
FortiGate unit.
For email-addr_str, enter an email address that identifies the
FortiGate unit.
If you specify a host IP or domain name, use the IP address or domain
name associated with the interface on which IKE negotiations will take
place (usually the external interface of the local FortiGate unit). If the IP
address in the certificate does not match the IP address of this interface
(or if the domain name in the certificate does not match a DNS query of
the FortiGate unit’s IP), then some implementations of IKE may reject
the connection. Enforcement of this rule varies for different IPSec
products.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 625
vpn certificate local execute

Variable Description
<key-length> Enter 1024, 1536 or 2048 for the size in bits of the encryption key.
[<optional_information>] Enter optional_information as required to further identify the
certificate. See “Optional information variables” on page 626 for the list
of optional information variables. You must enter the optional variables
in 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. Enter execute vpn
certificates local generate <name_str> country
followed by a ? for a list of country codes. The country code is case
sensitive. Enter null if you do not want to specify a country.
<state_name_str> Enter the name of the state or province where the FortiGate unit is
located.
<city_name_str> Enter the name of the city, or town, where the person or organization
certifying the FortiGate unit resides.
<organization-name_str> Enter the name of the organization that is requesting the certificate for
the FortiGate unit.
<organization-unit_name_str> Enter a name that identifies the department or unit within the
organization that is requesting the certificate for the FortiGate unit.
<email_address_str> Enter a contact e-mail address for the FortiGate 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.

Example - generate
Use the following command to generate a local certificate request with the name branch_cert, the
domain name www.example.com and a key size of 1536.
execute vpn certificate local generate branch_cert 1536 www.example.com

Syntax - import/export
execute vpn certificate local import tftp <file-name_str> <tftp_ip>
execute vpn certificate local export tftp <certificate-name_str>
<file-name_str> <tftp_ip>

Keyword/variable Description
import Import the local certificate from a TFTP server to the FortiGate unit.
export Export or copy the local certificate from the FortiGate unit to a file on the
TFTP server. Type ? for a list of certificates.
<certificate-name_str> Enter the name of the local certificate.
<tftp_ip> Enter the TFTP server address.
<file-name_str> Enter the file name on the TFTP server.
list List local certificates.

FortiGate CLI Version 3.0 MR6 Reference

626 01-30006-0015-20080205
execute vpn certificate local

Examples - import/export
Use the following command to export the local certificate request generated in the above example
from the FortiGate unit to a TFTP server. The example uses the file name testcert for the
downloaded file and the TFTP server address 192.168.21.54.
exec vpn certificate local export branch_cert testcert 192.168.21.54
Use the following command to import the signed local certificate named branch_cert to the
FortiGate unit from a TFTP server with the address 192.168.21.54.
exec vpn certificate local import branch_cert 192.168.21.54

History

FortiOS v2.80 MR2 The delete keyword was added.

The download keyword was changed to export.
FortiOS v2.80 MR3 Keywords were removed from the execute vpn certificate local
keyword and replaced with variables.
FortiOS v3.0 MR1 Removed all keywords but generate.
FortiOS v3.0 MR3 Added keywords import, export.
FortiOS v3.0 MR4 Added optional variables for certificate-based user authentication.

Related topics
• execute vpn certificate ca
• execute vpn certificate remote
• execute vpn certificate crl
• execute vpn sslvpn del-tunnel
• execute vpn sslvpn del-web
• vpn certificate ca
• vpn certificate local
• vpn certificate crl
• vpn certificate remote

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 627
vpn certificate remote execute

vpn certificate remote

Use this command to import a remote certificate from a TFTP server, or export a remote certificate
from the FortiGate unit to a TFTP server. The remote certificates are public certificates without a
private key. They are used as OCSP (Online Certificate Status Protocol) server certificates.

Syntax
execute vpn certificate remote import tftp <file-name_str> <tftp_ip>
execute vpn certificate remote export tftp <certificate-name_str>
<file-name_str> <tftp_ip>

Keyword/variable Description
import Import the remote certificate from the TFTP server to the FortiGate unit.
export Export or copy the remote certificate from the FortiGate unit to a file on
the TFTP server. Type ? for a list of certificates.
<certificate-name_str> Enter the name of the public certificate.
<file-name_str> Enter the file name on the TFTP server.
<tftp_ip> Enter the TFTP server address.
tftp Import/export the remote certificate via a TFTP server.

History

FortiOS v3.0 MR4 New.

Related topics
• execute vpn certificate ca
• execute vpn certificate local
• execute vpn certificate crl
• execute vpn sslvpn del-tunnel
• execute vpn sslvpn del-web
• vpn certificate ca
• vpn certificate local
• vpn certificate crl
• vpn certificate remote

FortiGate CLI Version 3.0 MR6 Reference

628 01-30006-0015-20080205
execute vpn sslvpn del-tunnel

vpn sslvpn del-tunnel

Use this command to delete an SSL tunnel connection.

Syntax
execute vpn sslvpn del-tunnel <tunnel_index>
<tunnel_index> identifies which tunnel to delete if there is more than one active tunnel.

History

FortiOS v3.0 New.

FortiOS v3.0 MR1 Added <tunnel_index>.

Related topics
• vpn ssl settings

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 629
vpn sslvpn del-web execute

vpn sslvpn del-web

Use this command to delete an active SSL VPN web connection.

Syntax
execute vpn sslvpn del-web <web_index>
<web_index> identifies which web connection to delete if there is more than one active connection.

History

FortiOS v3.0 MR5 New.

Related topics
• vpn ssl settings

FortiGate CLI Version 3.0 MR6 Reference

630 01-30006-0015-20080205
get

get
The get commands retrieve information about the operation and performance of your FortiGate unit.
This chapter contains the following sections:

chassis status router info protocols system fortiguard-log-service status

firewall service predefined router info rip system fortiguard-service status
gui console status router info routing-table system ha status
gui topology status system admin list system info admin ssh
hardware status system admin status system info admin status
ips decoder system arp system performance status
ips rule system central-mgmt status system session list
ipsec tunnel list system checksum system session status
router info bgp system cmdb status system status
router info bfd system dashboard
router info multicast system fortianalyzer-connectivity
router info ospf

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 631
chassis status get

chassis status
For FortiGate-5000 series modules installed in a FortiGate-5050 or FortiGate-5140 chassis, you can
use the get chassis status command to view real-time operating status information about the
hardware components installed in the chassis.
Information displayed depends on the FortiGate-5000 series chassis and not on the FortiGate-5000
series module that you are connecting to. You can use this command to view information about all of
the hardware components installed in the chassis (including FortiGate, FortiController and other
Fortinet modules installed in the chassis as well as the chassis shelf managers).
The get chassis status command displays information received from the chassis shelf manager.
The command only displays information if at least one shelf manager is functioning in the chassis and
only if the FortiGate-5000 module that you have connected to can communicate with a shelf manager.

Syntax
get chassis status
The command display includes the following fields. For more information see the example that follows.

Chassis type The FortiGate chassis type: 5050 or 5140.

Active shelfmanager The number of the shelf manager slot containing the active shelf manager: 1 or 2.
Current blade The slot number that the FortiGate module that you are connected to is installed in.
Shelfmanager 2 Indicates whether a shelf manager is operating in shelf manager slot 2. exist if a
shelf manager is installed and operating in slot 2. empty if shelf manager slot 2 is
empty or if the shelf manager in slot 2 is not operating.
Shelfmanager 1 Indicates whether a shelf manager is operating in shelf manager slot 1. exist if a
shelf manager is installed and operating in slot 1. empty if shelf manager slot 1 is
empty or if the shelf manager in slot 1 is not operating.
Blade For each slot in the chassis, the command displays the slot number and the name
<slot_integer>: of the FortiGate-5000 module installed in the slot.
<module_name> <slot_integer> indicated the slot number in the chassis. Slots 1 to 5 are listed
for the FortiGate-5050 chassis and slots 1 to 14 are listed for the FortiGate-5140
chassis.
<module_name> indicates the name of the module installed in the chassis slot.
<module_name> can be 5001 for the FortiGate-5001SX and 5001FA2, 5002 for
the FortiGate-5002FB2, 5003 for the FortiSwitch-5003, and 5005 for the
FortiGate-5005FA2, and empty if the slot is empty.
The command displays voltage and temperature information for each module in the
chassis. The voltage and temperature information that is displayed is different for
each module and depends on the voltage and temperature sensors on the module.
Voltage, V For each slot in the chassis the command displays voltages detected by the voltage
sensors in the module installed in the slot. The information displayed for each
sensor includes the design voltage (for example 3.3V) followed by the actual
voltage (for example, 3.488V). The design voltage depends on the sensor.
The voltages that are displayed are different for each module type.
Temp For each slot in the chassis the command displays temperatures in degrees
Celsius detected by the temperature sensors in the module. The information
displayed for each sensor includes the name of the temperature sensor and the
temperature reading.
The temperatures that are displayed are different for each module type.

FortiGate CLI Version 3.0 MR6 Reference

632 01-30006-0015-20080205
get chassis status

Example
The following example shows the get chassis status output for a FortiGate-5050 chassis that
contains the following modules:
• Slot 5: FortiGate-5005FA2
• Slot 4: FortiGate-5001FA2
• Slot 3: FortiGate-5001SX
• Slot 2: FortiSwitch-5003
• Slot 1: empty
• Shelf Manager: one shelf manager in shelf manager slot 1
To enter the command, the administrator has connected to the CLI of the FortiGate-5001SX module
installed in slot 3.
Chassis type: 5050
Active shelfmanager: 1
Current blade: 3
Shelfmanager 2: empty
Shelfmanager 1: exist
Blade 4: 5005
CPU1 Voltage: 1.1956V
CPU2 Voltage: 1.1858V
+5.0V: 4.8755V
+3.3V: 3.321V
+2.5V CPU 1: 2.5742V
+2.5V CPU 2: 2.5376V
+1.2V 1: 1.2054V
+1.2V 2: 1.2348V
Incoming Air-Flo: 35C
CPU Board Temp: 42C
CPU1 Temp: 59C
CPU2 Temp: 60C
Blade 4: 5001
5V: 5.0739V
3.3V: 3.4992V
2.5V: 2.497V
1.8V: 1.8124V
1.5V: 1.5345V
TEMP1: 41C
TEMP2: 35C
Blade 3: 5001
5V: 5.0764V
3.3V: 3.4884V
2.5V: 2.534V
1.8V: 1.8236V
1.5V: 1.5326V
TEMP1: 41C
TEMP2: 34C
Blade 2: 5003
+1.5V: 1.521V
+2V: 1.989V

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 633
chassis status get

+2.5V: 2.4921V
+3.3V: 3.3024V
+3.3VSB: 3.3712V
+5VSB: 5.07V
+12V: 12.096V
Baseboard Temp: 38C
BRD Top Temp: 36C
BRD Bottom Temp: 36C
BRD Center Temp: 41C
Blade 1: empty

History

FortiOS v3.0 MR3 New.

FortiGate CLI Version 3.0 MR6 Reference

634 01-30006-0015-20080205
get firewall service predefined

firewall service predefined

Use this command to retrieve information about predefined services.
The following information is available:
• destination port
• source port
• ICMP code
• ICMP type
• protocol
• protocol-number

Syntax
get firewall service predefined <service_name>

Example output
Fortigate-200A # get firewall service predefined FTP
name : FTP
icmpcode :
icmptype :
protocol : TCP/UDP
protocol-number : 6
tcpport-range : 21-21:0-65535
udpport-range :

Fortigate-200A # get firewall service predefined SIP

name : SIP
icmpcode :
icmptype :
protocol : TCP/UDP
protocol-number : 17
tcpport-range :
udpport-range : 5060-5060:0-65535

Fortigate-200A # get firewall service predefined AOL

name : AOL
icmpcode :
icmptype :
protocol : TCP/UDP
protocol-number : 6
tcpport-range : 5190-5194:0-65535
udpport-range :

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 635
gui console status get

gui console status

Display information about the CLI console.

Syntax
get gui console status

Example
The output looks like this:
Preferences:
User: admin
Colour scheme (RGB): text=FFFFFF, background=000000
Font: style=monospace, size=10pt
History buffer=50 lines, external input=disabled

Related topics
• get gui topology status

History

FortiOS v3.0 MR5 New.

FortiGate CLI Version 3.0 MR6 Reference

636 01-30006-0015-20080205
get gui topology status

gui topology status

Display information about the topology viewer database.

Syntax
get gui topology status

Example
The output looks like this:
Preferences:
Canvas dimensions (pixels): width=780, height=800
Colour scheme (RGB): canvas=12ff08, lines=bf0f00, exterior=ddeeee
Background image: type=none, placement: x=0, y=0
Line style: thickness=2

Custom background image file: none

Topology element database:

__FortiGate__: x=260, y=340
Office: x=22, y=105
ISPnet: x=222, y=129
__Text__: x=77, y=112: "Ottawa"
__Text__: x=276, y=139: "Internet"

Related topics
• get gui console status

History

FortiOS v3.0 MR5 New.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 637
hardware status get

hardware status
Report information about the FortiGate unit hardware.

Syntax
get hardware status

Example
The output looks like this:
Model name: Fortigate-800
ASIC version: CP4
SRAM: 64M
CPU: Mobile Genuine Intel(R) processor 1400MHz
RAM: 1009 MB
Compact Flash: 122 MB /dev/hdc
Hard disk: 76308 MB /dev/hda
USB Flash: not available
Network Card chipset: Intel(R) PRO/1000 Network Connection (rev.0x01)
Network Card chipset: Intel(R) PRO/100 M Desktop Adapter (rev.0x0010)

History

FortiOS v3.0 MR2 New.

Related topics
• get system status

FortiGate CLI Version 3.0 MR6 Reference

638 01-30006-0015-20080205
get ips decoder

ips decoder
Displays all the port settings of all the IPS decoders.

Syntax
get ips decoder

History

FortiOS v3.0 MR6 New command.

Related topics
• ips decoder
• get ips rule

History

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 639
ips rule get

ips rule
Displays all the port settings of all the IPS decoders.

Syntax
get ips rule
get ips rule status

Enter get ips rule to display a list of all the intrusion protection signatures. Enter get ips rule
status to list the default settings of all the signatures. The default settings of any individual signature
can be displayed using the config ips rule command.

History

FortiOS v3.0 MR6 New command.

Related topics
• ips decoder
• get ips decoder
• ips rule

FortiGate CLI Version 3.0 MR6 Reference

640 01-30006-0015-20080205
get ipsec tunnel list

ipsec tunnel list

List the current IPSec VPN tunnels and their status.

Syntax
get ipsec tunnel list

Example
The output looks like this:
NAME REMOTE-GW PROXY-ID-SOURCE PROXY-ID-DESTINATION
STATUS TIMEOUT
VPN1 172.20.120.5:500 0.0.0.0/255.255.255.255 172.20.120.5/172.20.120.5
up 1786

NAME The name of the configured tunnel.

REMOTE-GW The public IP address and UDP port of the remote host device, or if a
NAT device exists in front of the remote host, the public IP address and
UDP port of the NAT device.
PROXY- ID-SOURCE The IP address range of the hosts, servers, or private networks behind
the FortiGate unit that are available through the VPN tunnel.
PROXY- ID-DESTINATION This field displays IP addresses as a range.
When a FortiClient dialup client establishes a tunnel:
• If VIP addresses are not used, the Proxy ID Destination field
displays the public IP address of the remote host Network Interface
Card (NIC).
• If VIP addresses were configured (manually or through FortiGate
DHCP relay), the Proxy ID Destination field displays either the VIP
address belonging to the FortiClient dialup client, or the subnet
address from which VIP addresses were assigned.
When a FortiGate dialup client establishes a tunnel, the Proxy ID
Destination field displays the IP address of the remote private network.
STATUS Tunnel status: up or down.
TIMEOUT The number of seconds before the next phase 2 key exchange. The
time is calculated by subtracting the time elapsed since the last key
exchange from the keylife duration setting. When the phase 2 key
expires, a new key is generated without interrupting service.

History

FortiOS v3.0 MR2 New.

Related topics
• vpn ipsec phase1
• vpn ipsec phase1-interface
• vpn ipsec manualkey
• vpn ipsec manualkey-interface

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 641
router info bgp get

router info bgp

Use this command to display information about the BGP configuration.

Syntax
get router info bgp <keyword>

<keyword> Description
cidr-only Show all BGP routes having non-natural network masks.
community Show all BGP routes having their COMMUNITY attribute
set.
community-info Show general information about the configured BGP
communities, including the routes in each community and
their associated network addresses.
community-list Show all routes belonging to configured BGP community
lists.
dampening {dampened-paths | flap- Display information about dampening:
statistics | parameters} • Type dampened-paths to show all paths that have
been suppressed due to flapping.
• Type flap-statistics to show flap statistics related
to BGP routes.
• Type parameters to show the current dampening
settings.
filter-list Show all routes matching configured AS-path lists.
inconsistent-as Show all routes associated with inconsistent autonomous
systems of origin.
memory Show the BGP memory table.
neighbors [<address_ipv4> | Show information about connections to TCP and BGP
<address_ipv4> advertised-routes | neighbors.
<address_ipv4> received prefix-filter |
<address_ipv4> received-routes |
<address_ipv4> routes]
network [<address_ipv4mask>] Show general information about the configured BGP
networks, including their network addresses and
associated prefixes.
network-longer-prefixes Show general information about the BGP route that you
<address_ipv4mask> specify (for example, 12.0.0.0/14) and any specific
routes associated with the prefix.
paths Show general information about BGP AS paths, including
their associated network addresses.
prefix-list <name> Show all routes matching configured prefix list <name>.
quote-regexp <regexp_str> Enter the regular expression to compare to the AS_PATH
attribute of BGP routes (for example, ^730$) and enable
the use of output modifiers (for example, include,
exclude, and begin) to search the results.
regexp <regexp_str> Enter the regular expression to compare to the AS_PATH
attribute of BGP routes (for example, ^730$).
route-map Show all routes matching configured route maps.
scan Show information about next-hop route scanning,
including the scan interval setting.
summary Show information about BGP neighbor status.

FortiGate CLI Version 3.0 MR6 Reference

642 01-30006-0015-20080205
get router info bgp

Example
For the command get router info bgp memory, the output looks like:
Memory type Alloc count Alloc bytes
=================================== ============= ===============
BGP structure : 2 1408
BGP VR structure : 2 104
BGP global structure : 1 56
BGP peer : 2 3440
BGP as list master : 1 24
Community list handler : 1 32
BGP Damp Reuse List Array : 2 4096
BGP table : 62 248
----------------------------------- ------------- ---------------
Temporary memory : 4223 96095
Hash : 7 140
Hash index : 7 28672
Hash bucket : 11 132
Thread master : 1 564
Thread : 4 144
Link list : 32 636
Link list node : 24 288
Show : 1 396
Show page : 1 4108
Show server : 1 36
Prefix IPv4 : 10 80
Route table : 4 32
Route node : 63 2772
Vector : 2180 26160
Vector index : 2180 18284
Host config : 1 2
Message of The Day : 1 100
IMI Client : 1 708
VTY master : 1 20
VTY if : 11 2640
VTY connected : 5 140
Message handler : 2 120
NSM Client Handler : 1 12428
NSM Client : 1 1268
Host : 1 64
Log information : 2 72
Context : 1 232
----------------------------------- ------------- ---------------
bgp proto specifc allocations : 9408 B
bgp generic allocations : 196333 B
bgp total allocations : 205741 B

History

FortiOS v3.0 New.

FortiOS v3.0 MR2 Command moved from ‘router’ to ‘get’ chapter.

Related topics
• router aspath-list
• router bgp
• router community-list

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 643
router info bfd get

router info bfd

Use this command to list state information about the neighbors in the bi-directional forwarding table.

Syntax
get router info bfd neighbour

History

FortiOS v3.0 MR4 New.

FortiGate CLI Version 3.0 MR6 Reference

644 01-30006-0015-20080205
get router info multicast

router info multicast

Use this command to display information about a Protocol Independent Multicasting (PIM)
configuration. Multicast routing is supported in the root virtual domain only.

Syntax
get router info multicast <keywords>

<keywords> Description
igmp Show Internet Group Management Protocol (IGMP) membership information
according to one of these qualifiers:
• Type groups [{<interface-name> | <group-address>}] to show
IGMP information for the multicast group(s) associated with the specified
interface or multicast group address.
• Type groups-detail [{<interface-name> | <group-
address>}] to show detailed IGMP information for the multicast group(s)
associated with the specified interface or multicast group address.
• Type interface [<interface-name>] to show IGMP information for
all multicast groups associated with the specified interface.
pim dense-mode Show information related to dense mode operation according to one of these
qualifiers:
• Type interface to show information about PIM-enabled interfaces.
• Type interface-detail to show detailed information about PIM-
enabled interfaces.
• Type neighbor to show the current status of PIM neighbors.
• Type neighbor-detail to show detailed information about PIM
neighbors.
• Type next-hop to show information about next-hop PIM routers.
• Type table [<group-address>][<source-address>] to show the
multicast routing table entries associated with the specified multicast group
address and/or multicast source address.
pim sparse-mode Show information related to sparse mode operation according to one of these
qualifiers:
• Type bsr-info to show Boot Strap Router (BSR) information.
• Type interface to show information about PIM-enabled interfaces.
• Type interface-detail to show detailed information about PIM-
enabled interfaces.
• Type neighbor to show the current status of PIM neighbors.
• Type neighbor-detail to show detailed information about PIM
neighbors.
• Type next-hop to show information about next-hop PIM routers.
• Type rp-mapping to show Rendezvous Point (RP) information.
• Type table [<group-address>][<source-address>] to show the
multicast routing table entries associated with the specified multicast group
address and/or multicast source address.
table [<group-address>] Show the multicast routing table entries associated with the specified
[<source-address>] multicast group address and/or multicast source address.

table-count Show statistics related to the specified multicast group address and/or
[<group-address>] multicast source address.
[<source-address>]

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 645
router info multicast get

Examples
This example displays all of the PIM entries in the multicast routing table:
get router info multicast table
This example displays IGMP information for the multicast group associated with multicast group
address 239.254.2.0:
get router info multicast igmp groups 239.254.2.0

History

FortiOS v3.0 New.

FortiOS v3.0 MR2 Moved from ‘router’ to ‘get’ chapter.

Related topics
• router multicast
• execute mrouter clear

FortiGate CLI Version 3.0 MR6 Reference

646 01-30006-0015-20080205
get router info ospf

router info ospf

Use this command to display information about the FortiGate OSPF configuration and/or the Link-
State Advertisements (LSAs) that the FortiGate unit obtains and generates. An LSA identifies the
interfaces of all OSPF-enabled routers in an area, and provides information that enables OSPF-
enabled routers to select the shortest path to a destination.

Syntax
get router info ospf <keyword>

<keyword> Description
border-routers Show OSPF routing table entries that have an Area Border Router (ABR)
or Autonomous System Boundary Router (ASBR) as a destination.
database <qualifier> Show information from the OSPF routing database according to one of
these qualifiers.
target can be one of the following values:
• Type adv_router <address_ipv4> to limit the information to LSAs
originating from the router at the specified IP address.
• Type self-originate <address_ipv4> to limit the information to
LSAs originating from the FortiGate unit.
adv-router Type adv-router <address_ipv4> to show ospf Advertising Router
<address_ipv4> link states for the router at the given IP address.
asbr-summary Type asbr-summary to show information about ASBR summary LSAs.
<target>
brief Type brief to show the number and type of LSAs associated with each
OSPF area.
external <target> Type external to show information about external LSAs.
max-age Type max-age to show all LSAs in the MaxAge list.
network <target> Type network to show information about network LSAs.
nssa-external Type nssa-external to show information about not-so-stubby external
<target> LSAs.
opaque-area Type opaque-area <address_ipv4> to show information about
<address_ipv4> opaque Type 10 (area-local) LSAs (see RFC 2370).
opaque-as Type opaque-as <address_ipv4> to show information about opaque
<address_ipv4> Type 11 LSAs (see RFC 2370), which are flooded throughout the AS.
opaque-link Type opaque-link <address_ipv4> to show information about
<address_ipv4> opaque Type 9 (link-local) LSAs (see RFC 2370).
router <target> Type router to show information about router LSAs.
self-originate Type self-originate to show self-originated LSAs.
summary <target> Type summary to show information about summary LSAs.
interface Show the status of one or all FortiGate interfaces and whether OSPF is
[<interface_name>] enabled on those interfaces.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 647
router info ospf get

<keyword> Description
neighbor [all | Show general information about OSPF neighbors, excluding down-status
<neighbor_id> | detail | neighbors:
detail all | interface • Type all to show information about all neighbors, including down-
<address_ipv4>] status neighbors.
• Type <neighbor_id> to show detailed information about the
specified neighbor only.
• Type detail to show detailed information about all neighbors,
excluding down-status neighbors.
• Type detail all to show detailed information about all neighbors,
including down-status neighbors.
• Type interface <address_ipv4> to show neighbor information
based on the FortiGate interface IP address that was used to establish
the neighbor’s relationship.
route Show the OSPF routing table.
status Show general information about the OSPF routing processes.
virtual-links Show information about OSPF virtual links.

Examples
The following example shows how to display information from LSAs originating from a neighboring
router at IP address 10.2.4.1:
get router info ospf database router adv_router 10.2.4.1
The following example shows how to display the number and type of LSAs associated with each OSPF
area to which the FortiGate unit is linked:
get router info ospf database brief
The following command shows the status of all FortiGate interfaces and whether OSPF is enabled on
those interfaces.
get router info ospf interface

History

FortiOS v2.80 MR1 New.

FortiOS v2.80 MR2 Renamed from execute router show ospf.
FortiOS v2.80 MR7 Added status keyword.
FortiOS v3.0 Added variants of the database and neighbor keywords.
FortiOS v3.0 MR1 No change.
FortiOS v3.0 MR2 Moved from ‘router’ to ‘get’ chapter.

Related topics
• execute router restart
• get router info protocols
• get router info routing-table
• system interface
• router ospf

FortiGate CLI Version 3.0 MR6 Reference

648 01-30006-0015-20080205
get router info protocols

router info protocols

Use this command to show the current states of active routing protocols. Inactive protocols are not
displayed.

Syntax
#get router info protocols
Routing Protocol is "rip"
Sending updates every 30 seconds with +/-50%
Timeout after 180 seconds, garbage collect after 120 seconds
Outgoing update filter list for all interface is not set
Incoming update filter list for all interface is not set
Default redistribution metric is 1
Redistributing:
Default version control: send version 2, receive version 2
Interface Send Recv Key-chain
Routing for Networks:
Routing Information Sources:
Gateway Distance Last Update Bad Packets Bad Routes
Distance: (default is 120)

Routing Protocol is "ospf 0"

Invalid after 0 seconds, hold down 0, flushed after 0
Outgoing update filter list for all interfaces is
Incoming update filter list for all interfaces is
Redistributing:
Routing for Networks:
Routing Information Sources: Gateway Distance Last Update
Distance: (default is 110) Address Mask Distance List

Routing Protocol is "bgp 5"

IGP synchronization is disabled
Automatic route summarization is disabled
Default local-preference applied to incoming route is 100
Redistributing:
Neighbor(s):
Address AddressFamily FiltIn FiltOut DistIn DistOut RouteMapIn
RouteMapOut Weight
192.168.20.10 unicast

History

FortiOS v2.80 New.

FortiOS v2.80 MR2 Renamed from execute router show protocols.
FortiOS v3.0 MR2 Moved from ‘router’ to ‘get’ chapter.

Related topics
• execute router restart
• get router info rip
• get router info routing-table
• router rip
• router ospf

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 649
router info rip get

router info rip

Use this command to display information about the RIP configuration.

Syntax
get router info rip <keyword>

<keyword> Description
database Show the entries in the RIP routing database.
interface [<interface_name>] Show the status of the specified FortiGate unit interface
<interface_name> and whether RIP is enabled.
If interface is used alone it lists all the FortiGate unit interfaces and
whether RIP is enabled on each.

Example
The following command displays the RIP configuration information for the port1 interface:
get router info rip interface port1

History

FortiOS v2.80 New.

FortiOS v2.80 MR2 Renamed from execute router show rip.
FortiOS v3.0 Added optional interface_name component to interface attribute.
FortiOS v3.0 MR1 No change.
FortiOS v3.0 MR2 Move from ‘router’ to ‘get’ chapter.

Related topics
• get router info protocols
• get router info routing-table
• router rip
• system interface

FortiGate CLI Version 3.0 MR6 Reference

650 01-30006-0015-20080205
get router info routing-table

router info routing-table

Use this command to display the routes in the routing table.

Syntax
get router info routing-table <keyword>

<keyword> Description
all Show all entries in the routing table.
bgp Show the BGP routes in the routing table.
connected Show the connected routes in the routing table.
database Show the routing information database.
details [<address_ipv4mask>] Show detailed information about a route in the routing table, including
the next-hop routers, metrics, outgoing interfaces, and protocol-specific
information.
ospf Show the OSPF routes in the routing table.
rip Show the RIP routes in the routing table.
static Show the static routes in the routing table.

Example
The following command displays the entire routing table:
get router info routing-table all

History

FortiOS v2.80 New.

FortiOS v2.80 MR2 Renamed from execute router show routing_table.
FortiOS v3.0 Added <keyword> variable to command syntax and replaced underscore character in
command with hyphen.
FortiOS v3.0 MR1 Added database keyword.
FortiOS v3.0 MR2 Moved from ‘router’ to ‘get’ chapter.

Related topics
• execute router restart
• get router info ospf
• get router info protocols
• get router info rip
• router policy
• router rip
• router static
• router static6
• system interface

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 651
system admin list get

system admin list

View a list of all the current administration sessions.

Syntax
get system admin list

Example
The output looks like this:
# get system admin list
username local device remote started
admin sshv2 port1:172.20.120.148:22 172.20.120.16:4167 2006-08-09 12:24:20
admin https port1:172.20.120.148:443 172.20.120.161:56365 2006-08-09 12:24:20
admin https port1:172.20.120.148:443 172.20.120.16:4214 2006-08-09 12:25:29

username Name of the admin account for this session admin

local The protocol this session used to connect to the sshv2
FortiGate unit.
device The interface, IP address, and port used by this port1:172.20.120.148:22
session to connect to the FortiGate unit.
remote The IP address and port used by the originating 172.20.120.16:4167
computer to connect to the FortiGate unit.
started The time the current session started. 2006-08-09 12:24:20

History

FortiOS v3.0 MR3 New command.

FortiGate CLI Version 3.0 MR6 Reference

652 01-30006-0015-20080205
get system admin status

system admin status

View the status of the currently logged in admin and their session.

Syntax
get system admin status

Example
The output looks like this:
# get system admin status
username: admin
login local: sshv2
login device: port1:172.20.120.148:22
login remote: 172.20.120.16:4167
login vdom: root
login started: 2006-08-09 12:24:20
current time: 2006-08-09 12:32:12

username Name of the admin account currently logged in. username: admin
login local The protocol used to start the current session. login local: sshv2
login device The login information from the FortiGate unit login remote:
including interface, IP address, and port number. 172.20.120.16:4167
login remote The computer the user is logging in from including login remote:
the IP address and port number. 172.20.120.16:4167
login vdom The virtual domain the admin is current logged into. login vdom: root
login started The time the current session started. login started: 2006-08-
09 12:24:20
current time The current time of day on the FortiGate unit current time: 2006-08-
09 12:32:12

History

FortiOS v3.0 MR3 New command.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 653
system arp get

system arp
View the ARP table entries on the FortiGate unit.
This command is not available in multiple VDOM mode.

Syntax
get system arp

Example
The output looks like this:
# get system arp
Address Age(min) Hardware Addr Interface
172.20.120.16 0 00:0d:87:5c:ab:65 internal
172.20.120.138 0 00:08:9b:09:bb:01 internal
Address The IP address that is linked to the MAC address. 0.0.0.0
Age Current duration of the ARP entry in minutes. 0
Hardware Addr The hardware, or MAC address, to link with this IP 00:00:00:00:00:00:
address.
Interface The physical interface the address is on.

History
FortiOS v3.0 New.
FortiOS v3.0 MR1 No change.
FortiOS v3.0 MR2 Moved from ‘system’ to ‘get’ chapter.
FortiOS v3.0 MR4 Output format changed.

Related topics
• system arp-table
• system proxy-arp

FortiGate CLI Version 3.0 MR6 Reference

654 01-30006-0015-20080205
get system central-mgmt status

system central-mgmt status

View information about the Central Management System status.

Syntax
get system central-mgmt status

Example
The output looks like this:
# get system central-mgmt status
Central Management Service
License: 1.0
Expiry date: 2007-12-31 00:00:00

History

FortiOS v3.0 MR5 New.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 655
system checksum get

system checksum
View the checksums for global, root, and all.

Syntax
get system checksum status

Example
The output looks like this:
# get system checksum status
global: 7a 87 3c 14 93 bc 98 92 b0 58 16 f2 eb bf a4 15
root: bb a4 80 07 42 33 c2 ff f1 b5 6e fe e4 bb 45 fb
all: 1c 28 f1 06 fa 2e bc 1f ed bd 6b 21 f9 4b 12 88

History

FortiOS v3.0 MR4 New.

FortiGate CLI Version 3.0 MR6 Reference

656 01-30006-0015-20080205
get system cmdb status

system cmdb status

View information about cmbdsvr on the FortiGate unit. FortiManager uses some of this information.

Syntax
get system cmdb status

Example
The output looks like this:
# get system cmdb status
version: 1
owner id: 18
update index: 6070
config checksum: 12879299049430971535
last request pid: 68
last request type: 29
last request: 78

version Version of the cmdb software.

owner id Process ID of the cndbsvr daemon.
update index The updated index shows how many changes have been made in cmdb.
config checksum The config file version used by FortiManager.
last request pid The last process to access the cmdb.
last requst type Type of the last attempted access of cmdb.
last request The number of the last attempted access of cmdb.

History

FortiOS v3.0 MR2 New command.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 657
system dashboard get

system dashboard
Display organization of the modules on the dashboard. The order the modules are listed in is the order
they appear - top to bottom, left to right.
FortiManager uses this information.

Syntax
get system cmdb status

Example
The output looks like this:
# get system dashboard
== [ sysinfo ]
name: sysinfo help: system information
== [ licinfo ]
name: licinfo help: license information
== [ sysop ]
name: sysop help: system operation
== [ sysres ]
name: sysres help: system resource
== [ alert ]
name: alert help: alert console
== [ statistics ]
name: statistics help: statistics
== [ jsconsole ]
name: jsconsole help: CLI console

History

FortiOS v3.0 MR4 New command.

FortiGate CLI Version 3.0 MR6 Reference

658 01-30006-0015-20080205
get system fortianalyzer-connectivity

system fortianalyzer-connectivity
Display connection and remote disk usage information about a connected FortiAnalyzer unit.

Syntax
get fortianalyzer-connectivity status

Example
The output looks like this:
# get system fortianalyzer-connectivity status
Status: connected
Disk Usage: 0%

History

FortiOS v3.0 MR4 New command.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 659
system fortiguard-log-service status get

system fortiguard-log-service status

Command returns information about the status of the FortiGuard Log & Analysis Service including
license and disk information.

Syntax
get system fortiguard-log-service status

Example
This shows a sample output.
# get system fortiguard-log-service status
FortiGuard Log & Analysis Service
Expire on: 20071231
Total disk quota: 1111 MB
Max daily volume: 111 MB
Current disk quota usage: n/a

History

FortiOS v3.0 MR4 New command.

FortiGate CLI Version 3.0 MR6 Reference

660 01-30006-0015-20080205
get system fortiguard-service status

system fortiguard-service status

COMMAND REPLACED. Command returns information about the status of the FortiGuard service
including the name, version late update, method used for the last update and when the update expires.
This information is shown for the AV Engine, virus definitions, attack definitions, and the IPS attack
engine.

Syntax
get system fortiguard-service status

Example
This shows a sample output.
NAME VERSION LAST UPDATE METHOD EXPIRE
AV Engine 2.002 2006-01-26 19:45:00 manual 2006-06-12 08:00:00
Virus Definitions 6.513 2006-06-02 22:01:00 manual 2006-06-12 08:00:00
Attack Definitions 2.299 2006-06-09 19:19:00 manual 2006-06-12 08:00:00
IPS Attack Engine 1.015 2006-05-09 23:29:00 manual 2006-06-12 08:00:00

History

FortiOS v3.0 MR2 New command.

FortiOS v3.0 MR5 Command replaced with get system central-mgmt status

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 661
system ha status get

system ha status
Use this command to display information about an HA cluster. The command displays general HA
configuration settings. The command also displays information about how the cluster unit that you
have logged into is operating in the cluster.
Usually you would log into the primary unit CLI using SSH or telnet. In this case the get system ha
status command displays information about the primary unit first, and also displays the HA state of
the primary unit (the primary unit operates in the work state). However, if you log into the primary unit
and then use the execute ha manage command to log into a subordinate unit, (or if you use a
console connection to log into a subordinate unit) the get system status command displays
information about this subordinate unit first, and also displays the HA state of this subordinate unit. The
state of a subordinate unit is work for an active-active cluster and standby for an active-passive cluster.
For a virtual cluster configuration, the get system ha status command displays information about
how the cluster unit that you have logged into is operating in virtual cluster 1 and virtual cluster 2. For
example, if you connect to the cluster unit that is the primary unit for virtual cluster 1 and the
subordinate unit for virtual cluster 2, the output of the get system ha status command shows
virtual cluster 1 in the work state and virtual cluster 2 in the standby state. The get system ha
status command also displays additional information about virtual cluster 1 and virtual cluster 2.

Syntax
get system ha status
The command display includes the following fields. For more information see the examples that follow.

Model The FortiGate model number.

Mode The HA mode of the cluster: a-a or a-p.
Group The group ID of the cluster.
Debug The debug status of the cluster.
ses_pickup The status of session pickup: enable or disable.
load_balance The status of the load-balance-all keyword: enable or disable. Displayed for
active-active clusters only.
schedule The active-active load balancing schedule. Displayed for active-active clusters only.
Master Master displays the device priority, host name, serial number, and actual cluster index of the
Slave primary (or master) unit.
Slave displays the device priority, host name, serial number, and actual cluster index of the
subordinate (or slave, or backup) unit or units.
The list of cluster units changes depending on how you log into the CLI. Usually you would
use SSH or telnet to log into the primary unit CLI. In this case the primary unit would be at the
top the list followed by the other cluster units.
If you use execute ha manage or a console connection to log into a subordinate unit CLI,
and then enter get system ha status the subordinate unit that you have logged into
appears at the top of the list of cluster units.
number of The number of virtual clusters. If virtual domains are not enabled, the cluster has one virtual
vcluster cluster. If virtual domains are enabled the cluster has two virtual clusters.

FortiGate CLI Version 3.0 MR6 Reference

662 01-30006-0015-20080205
get system ha status

vcluster 1 The HA state (hello, work, or standby) and HA heartbeat IP address of the cluster unit that
you have logged into in virtual cluster 1. If virtual domains are not enabled, vcluster 1
displays information for the cluster. If virtual domains are enabled, vcluster 1 displays
information for virtual cluster 1.
The HA heartbeat IP address is 10.0.0.1 if you are logged into a the primary unit of virtual
cluster 1 and 10.0.0.2 if you are logged into a subordinate unit of virtual cluster 1.
vcluster 1 also lists the primary unit (master) and subordinate units (slave) in virtual
cluster 1. The list includes the operating cluster index and serial number of each cluster unit
in virtual cluster 1. The cluster unit that you have logged into is at the top of the list.
If virtual domains are not enabled and you connect to the primary unit CLI, the HA state of the
cluster unit in virtual cluster 1 is work. The display lists the cluster units starting with the
primary unit.
If virtual domains are not enabled and you connect to a subordinate unit CLI, the HA state of
the cluster unit in virtual cluster 1 is standby. The display lists the cluster units starting with
the subordinate unit that you have logged into.
If virtual domains are enabled and you connect to the virtual cluster 1 primary unit CLI, the
HA state of the cluster unit in virtual cluster 1 is work. The display lists the cluster units
starting with the virtual cluster 1 primary unit.
If virtual domains are enabled and you connect to the virtual cluster 1 subordinate unit CLI,
the HA state of the cluster unit in virtual cluster 1 is standby. The display lists the cluster units
starting with the subordinate unit that you are logged into.
In a cluster consisting of two cluster units operating without virtual domains enabled all
clustering actually takes place in virtual cluster 1. HA is designed to work this way to support
virtual clustering. If this cluster was operating with virtual domains enabled, adding virtual
cluster 2 is similar to adding a new copy of virtual cluster 1. Virtual cluster 2 is visible in the
get system ha status command output when you add virtual domains to virtual cluster
2.
vcluster 2 vcluster 2 only appears if virtual domains are enabled. vcluster 2 displays the HA
state (hello, work, or standby) and HA heartbeat IP address of the cluster unit that you have
logged into in virtual cluster 2. The HA heartbeat IP address is 10.0.0.2 if you are logged into
the primary unit of virtual cluster 2 and 10.0.0.1 if you are logged into a subordinate unit of
virtual cluster 2.
vcluster 2 also lists the primary unit (master) and subordinate units (slave) in virtual
cluster 2. The list includes the cluster index and serial number of each cluster unit in virtual
cluster 2. The cluster unit that you have logged into is at the top of the list.
If you connect to the virtual cluster 2 primary unit CLI, the HA state of the cluster unit in virtual
cluster 2 is work. The display lists the cluster units starting with the virtual cluster 2 primary
unit.
If you connect to the virtual cluster 2 subordinate unit CLI, the HA state of the cluster unit in
virtual cluster 2 is standby. The display lists the cluster units starting with the subordinate
unit that you are logged into.

Examples
The following example shows get system ha status output for a cluster of two FortiGate-5001SX
units operating in active-active mode. The cluster group ID, session pickup, load balance all, and the
load balancing schedule are all set to the default values. The device priority of the primary unit is also
set to the default value. The device priority of the subordinate unit has been reduced to 100. The host
name of the primary unit is 5001_Slot_4. The host name of the subordinate unit in is 5001_Slot_3.
The command output was produced by connecting to the primary unit CLI (host name 5001_Slot_4).
Model: 5000
Mode: a-a
Group: 0
Debug: 0
ses_pickup: disable
load_balance: disable
schedule: round robin
Master:128 5001_Slot_4 FG50012204400045 1
Slave :100 5001_Slot_3 FG50012205400050 0
number of vcluster: 1
vcluster 1: work 10.0.0.2

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 663
system ha status get

Master:0 FG50012204400045
Slave :1 FG50012205400050
The following command output was produced by using execute HA manage 0 to log into the
subordinate unit CLI of the cluster shown in the previous example. The host name of the subordinate
unit is 5001_Slot_3.
Model: 5000
Mode: a-a
Group: 0
Debug: 0
ses_pickup: disable
load_balance: disable
schedule: round robin
Slave :100 5001_Slot_3 FG50012205400050 0
Master:128 5001_Slot_4 FG50012204400045 1
number of vcluster: 1
vcluster 1: work 10.0.0.2
Slave :1 FG50012205400050
Master:0 FG50012204400045

About the HA cluster index and the execute ha manage command

When a cluster starts up the FortiGate Cluster Protocol (FGCP) assigns a cluster index and a HA
heartbeat IP address to each cluster unit based on the serial number of the cluster unit. The FGCP
selects the cluster unit with the highest serial number to become the primary unit. The FGCP assigns a
cluster index of 0 and an HA heartbeat IP address of 10.0.0.1 to this unit. The FGCP assigns a cluster
index of 1 and an HA heartbeat IP address of 10.0.0.2 to the cluster unit with the second highest serial
number. If the cluster contains more units, the cluster unit with the third highest serial number is
assigned a cluster index of 2 and an HA heartbeat IP address of 10.0.0.3, and so on. You can display
the cluster index assigned to each cluster unit using the get system ha status command. Also
when you use the execute ha manage command you select a cluster unit to log into by entering its
cluster index.
The cluster index and HA heartbeat IP address only change if a unit leaves the cluster or if a new unit
joins the cluster. When one of these events happens, the FGCP resets the cluster index and HA
heartbeat IP address of each cluster unit again according to serial number.
Each cluster unit keeps its assigned cluster index and HA heartbeat IP address even as the units take
on different roles in the cluster. For example, after the initial cluster index and HA heartbeat IP
addresses are set, the FGCP checks other primary unit selection criteria such as device priority and
monitored interfaces. Checking these criteria could result in selecting a cluster unit without the highest
serial number to operate as the primary unit.
Even if the cluster unit without the highest serial number now becomes primary unit, the cluster
indexes and HA heartbeat IP addresses assigned to the individual cluster units do not change. Instead
the FGCP assigns a second cluster index, which could be called the operating cluster index, to reflect
this role change. The operating cluster index is 0 for the primary unit and 1 and higher for the other
units in the cluster. By default both sets of cluster indexes are the same. But if primary unit selection
selects the cluster unit that does not have the highest serial number to be the primary unit then this
cluster unit is assigned an operating cluster index of 1. The operating cluster unit is used by the FGCP
only. You can display the operating cluster index assigned to each cluster unit using the get system ha
status command. There are no CLI commands that reference the operating cluster index.

Note: Even though there are two cluster indexes there is only one HA heartbeat IP address
and the HA heartbeat address is not affected by a change in the operating cluster index.

FortiGate CLI Version 3.0 MR6 Reference

664 01-30006-0015-20080205
get system ha status

Using the execute ha manage command

When you use the CLI command execute ha manage <index_integer> to connect to the CLI of
another cluster unit, the <index_integer> that you enter is the cluster index of the unit that you
want to connect to.

Using get system ha status to display cluster indexes

You can display the cluster index assigned to each cluster unit using the CLI command get system
ha status. The following example shows the information displayed by the get system ha
status command for a cluster consisting of two FortiGate-5001SX units operating in active-passive
HA mode with virtual domains not enabled and without virtual clustering.
get system ha status
Model: 5000
Mode: a-p
Group: 0
Debug: 0
ses_pickup: disable
Master:128 5001_slot_7 FG50012205400050 0
Slave :128 5001_slot_11 FG50012204400045 1
number of vcluster: 1
vcluster 1: work 10.0.0.1
Master:0 FG50012205400050
Slave :1 FG50012204400045
In this example, the cluster unit with serial number FG50012205400050 has the highest serial number
and so has a cluster index of 0 and the cluster unit with serial number FG50012204400045 has a
cluster index of 1. From the CLI of the primary (or master) unit of this cluster you can connect to the
CLI of the subordinate (or slave) unit using the following command:
execute ha manage 1
This works because the cluster unit with serial number FG50012204400045 has a cluster index of 1.
The get system ha status command output shows two similar lists of indexes and serial
numbers. The listing on the sixth and seventh lines of the command output are the cluster indexes
assigned according to cluster unit serial number. These are the cluster indexes that you enter when
using the execute ha manage command. The cluster indexes shown in the last two lines of the
command output are the operating cluster indexes that reflect how the cluster units are actually
operating in the cluster. In this example both sets of cluster indexes are the same.
The last three lines of the command output display the status of vcluster 1. In a cluster consisting of
two cluster units operating without virtual domains enabled all clustering actually takes place in virtual
cluster 1. HA is designed to work this way to support virtual clustering. If this cluster was operating with
virtual domains enabled, adding virtual cluster 2 is similar to adding a new copy of virtual cluster 1.
Virtual cluster 2 is visible in the get system ha status command output when you add virtual
domains to virtual cluster 2.
The HA heartbeat IP address displayed on line 8 is the HA heartbeat IP address of the cluster unit that
is actually operating as the primary unit. For a default configuration this IP address will always be
10.0.0.1 because the cluster unit with the highest serial number will be the primary unit. This IP
address changes if the operating primary unit is not the primary unit with the highest serial number.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 665
system ha status get

Example: actual and operating cluster indexes do not match

This example shows get system ha status command output for same cluster of two FortiGate-5001SX
units. However, in this example the device priority of the cluster unit with the serial number
FG50012204400045 is increased to 200. As a result the cluster unit with the lowest serial number
becomes the primary unit. This means the actual and operating cluster indexes of the cluster units do
not match.
get system ha status
Model: 5000
Mode: a-p
Group: 0
Debug: 0
ses_pickup: disable
Master:128 5001_slot_7 FG50012205400050 0
Slave :200 5001_slot_11 FG50012204400045 1
number of vcluster: 1
vcluster 1: work 10.0.0.2
Master:1 FG50012205400050
Slave :0 FG50012204400045
The actual cluster indexes have not changed but the operating cluster indexes have. Also, the HA
heartbeat IP address displayed for vcluster 1 has changed to 10.0.0.2.

Virtual clustering example output

The get system ha status command output is the same if a cluster is operating with virtual
clustering turned on but with all virtual domains in virtual cluster 1. The following get system ha
status command output example shows the same cluster operating as a virtual cluster with virtual
domains in virtual cluster 1 and added to virtual cluster 2. In this example the cluster unit with serial
number FG50012204400045 is the primary unit for virtual cluster 1 and the cluster unit with serial
number FG50012205400050 is the primary unit for virtual cluster 2.
get system ha status
Model: 5000
Mode: a-p
Group: 0
Debug: 0
ses_pickup: disable
Master:128 5001_slot_7 FG50012205400050 0
Slave :200 5001_slot_11 FG50012204400045 1
number of vcluster: 2
vcluster 1: work 10.0.0.2
Master:1 FG50012205400050
Slave :0 FG50012204400045
vcluster 2: standby 10.0.0.1
Master:0 FG50012205400050
Slave :1 FG50012204400045
This example shows three sets of indexes. The indexes in lines six and seven are still used by the
execute ha manage command. The indexes on lines ten and eleven are for the primary and
subordinate units in virtual cluster 1 and the indexes on the last two lines are for virtual cluster 2.

History

FortiOS v3.0 MR2 New command.

FortiGate CLI Version 3.0 MR6 Reference

666 01-30006-0015-20080205
get system ha status

Related topics
• system ha
• execute ha disconnect
• execute ha manage
• execute ha synchronize

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 667
system info admin ssh get

system info admin ssh

Use this command to display information about the SSH configuration on the FortiGate unit such as:
• the SSH port number
• the interfaces with SSH enabled
• the hostkey DSA fingerprint
• the hostkey RSA fingerprint

Syntax
get system info admin ssh

Example
This shows sample output.
# get system info admin ssh
SSH v2 is enabled on port 22
SSH is enabled on the following 1 interfaces:
internal
SSH hostkey DSA fingerprint =
cd:e1:87:70:bb:f0:9c:7d:e3:7b:73:f7:44:23:a5:99
SSH hostkey RSA fingerprint =
c9:5b:49:1d:7c:ba:be:f3:9d:39:33:4d:48:9d:b8:49

History

FortiOS v3.0 MR2 New.

FortiOS v3.0 MR4 Output changed - added SSH hostkey RSA fingerprint.

Related topics
• system accprofile
• execute disconnect-admin-session

FortiGate CLI Version 3.0 MR6 Reference

668 01-30006-0015-20080205
get system info admin status

system info admin status

Use this command to display administrators that are logged into the FortiGate unit.

Syntax
get system info admin status

Example
This shows sample output.
Index User name Login type From
0 admin CLI ssh(172.20.120.16)
1 admin WEB 172.20.120.16

Index The order the administrators logged in. 0

User name The name of the user account logged in. admin
Login type Which interface was used to log in. CLI
From The IP address this user logged in from. 172.20.120.16

History

FortiOS v3.0 MR2 New.

Related topics
• get system info admin ssh

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 669
system performance status get

system performance status

Use this command to display FortiGate CPU usage, memory usage, network usage, sessions, virus,
IPS attacks, and system up time.

Syntax
get system performance status

Example
The output looks like this:
# get sys per status
CPU states: 0% user 0% system 0% nice 100% idle
Memory states: 18% used
Average network usage: 0 kbps in 1 minute, 0 kbps in 10 minutes, 1 kbps in
30 minutes
Average sessions: 5 sessions in 1 minute, 6 sessions in 10 minutes, 5
sessions in 30 minutes
Virus caught: 0 total in 1 minute
IPS attacks blocked: 0 total in 1 minute
Uptime: 9days, 22 hours, 0 minutes

CPU states The percentages of CPU cycles used by user, 0% user 0% system
system, nice and idle categories of processes. 0% nice 100% idle
Memory states The percentage of memory used. 18% used
Average network The average amount of network traffic in kbps in the last 0 kbps in
usage 1, 10 and 30 minutes. 1 minute,
0 kbps in
10 minutes,
1 kbps in
30 minutes
Average The average number of sessions connected to the 5 sessions in
sessions FortiGate unit over the list 1, 10 and 30 minutes. 1 minute,
6 sessions in
10 minutes,
5 sessions in
30 minutes
Virus caught The number of viruses the FortiGate unit has caught in 0 total in 1 minute
the last 1 minute.
IPS attacks The number of IPS attacks that have been blocked in the 0 total in 1 minute
blocked last 1 minute.

Uptime How long since the FortiGate unit has been restarted. 9 days, 22 hours,
0 minutes

FortiGate CLI Version 3.0 MR6 Reference

670 01-30006-0015-20080205
get system performance status

History

FortiOS v3.0 Added.

FortiOS v3.0 MR2 Changed to ‘get system performance status’ and moved from ‘system’ to
‘get’ chapter.
FortiOS v3.0 MR3 Output of command changed to include more CPU information, average
network traffic, average sessions, viruses caught, and IPS attacks
blocked.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 671
system session list get

system session list

Command returns a list of all the sessions active on the FortiGate unit. or the current virtual domain if
virtual domain mode is enabled.

Syntax
get system session list

Example
The output looks like this:
PROTO EXPIRE SOURCE SOURCE-NAT DESTINATION DESTINATION-NAT
tcp 0 127.0.0.1:1083 - 127.0.0.1:514 -
tcp 0 127.0.0.1:1085 - 127.0.0.1:514 -
tcp 10 127.0.0.1:1087 - 127.0.0.1:514 -
tcp 20 127.0.0.1:1089 - 127.0.0.1:514 -
tcp 30 127.0.0.1:1091 - 127.0.0.1:514 -
tcp 40 127.0.0.1:1093 - 127.0.0.1:514 -
tcp 60 127.0.0.1:1097 - 127.0.0.1:514 -
tcp 70 127.0.0.1:1099 - 127.0.0.1:514 -
tcp 80 127.0.0.1:1101 - 127.0.0.1:514 -
tcp 90 127.0.0.1:1103 - 127.0.0.1:514 -
tcp 100 127.0.0.1:1105 - 127.0.0.1:514 -
tcp 110 127.0.0.1:1107 - 127.0.0.1:514 -
tcp 103 172.20.120.16:3548 - 172.20.120.133:22 -
tcp 3600 172.20.120.16:3550 - 172.20.120.133:22 -
udp 175 127.0.0.1:1026 - 127.0.0.1:53 -
tcp 5 127.0.0.1:1084 - 127.0.0.1:514 -
tcp 5 127.0.0.1:1086 - 127.0.0.1:514 -
tcp 15 127.0.0.1:1088 - 127.0.0.1:514 -
tcp 25 127.0.0.1:1090 - 127.0.0.1:514 -
tcp 45 127.0.0.1:1094 - 127.0.0.1:514 -
tcp 59 127.0.0.1:1098 - 127.0.0.1:514 -
tcp 69 127.0.0.1:1100 - 127.0.0.1:514 -
tcp 79 127.0.0.1:1102 - 127.0.0.1:514 -
tcp 99 127.0.0.1:1106 - 127.0.0.1:514 -
tcp 109 127.0.0.1:1108 - 127.0.0.1:514 -
tcp 119 127.0.0.1:1110 - 127.0.0.1:514 -
PROTO The transfer protocol of the session. tcp
EXPIRE How long before this session will terminate. 3600
SOURCE The source IP address and port number. 127.0.0.1:1083
SOURCE-NAT The source of the NAT. ‘-’ indicates there is no NAT. -
DESTINATION The destination IP address and port number. 127.0.0.1:514
DESTINATION-NAT The destination of the NAT. ‘-’ indicates there is no NAT. -

History

FortiOS v3.0 MR2 New command.

FortiOS v3.0 MR6 Now per VDOM.

FortiGate CLI Version 3.0 MR6 Reference

672 01-30006-0015-20080205
get system session status

system session status

Command returns the number of active sessions on the FortiGate unit, or if virtual domain mode is
enabled it returns the number of active sessions on the current VDOM. In both situations it will say ‘the
current VDOM’.

Syntax
get system session status

Example
The output looks like this:
The total number of sessions for the current VDOM: 31

History

FortiOS v3.0 MR6 New command.

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 673
system status get

system status
Use this command to display system status information including:
• FortiGate firmware version, build number and branch point
• virus and attack definitions version
• FortiGate unit serial number and BIOS version
• log hard disk availability
• host name
• operation mode
• virtual domains status: current VDOM, max number of VDOMs, number of NAT and TP mode
VDOMs and VDOM status
• current HA status
• system time

Syntax
get system status

Example output
Version: Fortigate-500A 3.00,build0305,060512
Virus-DB: 6.473(2006-05-12 10:21)
IPS-DB: 2.295(2006-05-09 11:30)
Serial-Number: FG500A2904500004
BIOS version: 03006000
Log hard disk: Available
Hostname: FortiGate-500A
Operation Mode: NAT
Current virtual domain: root
Max number of virtual domains: 10
Virtual domains status: 1 in NAT mode, 0 in TP mode
Virtual domain configuration: disable
Common Criteria mode: disable
Current HA mode: standalone
Distribution: International
Branch point: 305
System time: Mon May 15 13:39:03 2006

History

FortiOS v3.0 Added.

FortiOS v3.0 MR2 Moved from ‘system’ to ‘get’ chapter.

Related topics
• hardware status

FortiGate CLI Version 3.0 MR6 Reference

674 01-30006-0015-20080205
Index

Index
Numerics address-mode
system fortianalyzer 340
3600A 396 addrgrp
3810B 396 firewall 84
admin
A log filter 192
system 316
abort 35
admingrp
abr-type
access group for system accprofile 313
router ospf 259
administrator access
accept-lifetime
access profiles description 28
router key-chain 245
system accprofile command 312
access control list 451
administrators
access-group info 669
router multicast interface igmp 252 list 652
access-list 234 admin-port
router 224 system global 351
router ospf 265
admin-sport
router rip distance 280
system global 352
router rip offset-list 284
admintimeout
accprofile
system global 352
system 312
system admin 317 ADSL
bridged mode 380
ACK 353
ipoa 380
acl
Advanced Encryption Standard (AES) 384
system wireless mac-filter 451
advertise
action
router ospf area filter-list 263
antivirus filepattern 70
router ospf summary-address 270
firewall multicast-policy 102
firewall policy 105 advertisement-interval
imp2p aim-user 170 router bgp neighbor 236
imp2p icq-user 171 agelimit
imp2p msn-user 172 antivirus quarantine 75
router access-list 224 aggregate interface 386
router aspath-list 226, 228 algorithm 386
router prefix-list 275 lacp-ha-slave 386
router route-map 287 lacp-mode 386
spamfilter bword 297 lacp-speed 387
spamfilter DNSBL 310 member 387
spamfilter emailbwl 300 aggregate route 231
spamfilter ipbwl 304 aim
spamfilter mheader 307 firewall profile 119
webfilter urlfilter 559 imp2p old-version 173
activate imp2p policy 174
router bgp neighbor 235 aim-user
active imp2p 170
antivirus filepattern 70 alertemail
address system 321
firewall 82 algorithm
log report output 207 system interface 386
system autoupdate clientoverride 324 vpn ssl settings 539
system autoupdate override 325 all
system autoupdate push-update 326 execute ha synchronize 583
system autoupdate tunneling 330 router info routing-table 651
address overlap 352

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 675
 Index

alllogs attribute-unchanged
execute backup 562 router bgp neighbor 236
allowaccess audit
system interface 376, 385 log report scope 211
allowas-in auth
router bgp neighbor 236 log filter 192
allowas-in-enable system bug-report 333
router bgp neighbor 236 auth-alg
allowed vpn ipsec manualkey-interface 499
log filter 192 authenticate
allow-interface-subnet-overlap system alertemail 321, 322
system global 352 authentication
altmode router ospf area 262
system modem 393 router ospf area virtual-link 263
always-compare-med router ospf ospf-interface 267
router bgp 232 system ha 362
anomaly vpn ipsec manualkey 496
ips 178 authentication based routing 228
log filter 192 authentication keys, RIP v2 245
antispam 295 authentication-key
antispam-cache router ospf area virtual-link 263
system fortiguard 343 router ospf ospf-interface 267
antispam-cache-ttl authgrp
system fortiguard 343 access group for system accprofile 313
antispam-timeout auth-key
system fortiguard 343 vpn ipsec manualkey-interface 499
antivirus 69 authkey
antivirus configuration 313 vpn ipsec manualkey 496
AP mode auth-keychain
system wireless settings 453 router rip interface 282
area authmethod
router ospf network 266 vpn ipsec phase1 503
area border router (ABR) 257, 261 vpn ipsec phase1-interface 511
ARP auth-mode
proxy ARP 155 router rip interface 282
arp authpasswd
system 654 vpn ipsec phase1 503
vpn ipsec phase1-interface 511
ARP packets 356, 376
auth-string
ARP table
router rip interface 282
adding entries 397
display 654 auth-timeout
vpn ssl settings 539
arpforward
system interface 376 auth-type
system interface 376
arps
system ha 361 authusr
vpn ipsec phase1 503
arps-interval
vpn ipsec phase1-interface 511
system ha 361
authusrgrp
arp-table
vpn ipsec phase1 503
system 322
vpn ipsec phase1-interface 511
as
auto
router bgp 232
execute vpn certificate ca 622
AS-path list 226 execute vpn certificate crl 624
aspath-list auto-dial
router 226 system modem 393
as-set auto-install
router bgp aggregate-address 235 system 323
attack Automatic Refresh Interval 355
log filter 192
autonomous system (AS) 232
attackdef
Autonomous System, bgp 232
execute ha synchronize 583
autonomous-flag
system interface config ipv6-prefix 386

FortiGate CLI Version 3.0 MR6 Reference

676 01-30006-0015-20080205
Index

autosvr bestpath-med-missing-as-worst
system dns 339 router bgp 232
autoupdate clientoverride BGP 449
system 324 AS-path list 226
autoupdate ips BGP-4 229
system 325 External 232
autoupdate override Internal 232
system 325 logging neighbor changes 234
autoupdate push-update memory table 642
system 326 RFC 1771 229
autoupdate schedule RFC 1997 229
system 328 storing updates from neighbor 239
autoupdate tunneling bgp
system 330 router 229
router info routing-table 651
aux
system 332 bindthroughfw
firewall ipmacbinding setting 95
AUX port configuration 332
bindtofw
AV/IPS signature reporting 353
firewall ipmacbinding setting 95
av-failopen
bittorrent
system global 352
firewall profile 119
av-failopen-session
bittorrent-limit
system global 352
firewall profile 119
avgrp
blackhole
access group for system accprofile 313
router static 292
system accprofile 313
blackhole route 383, 387
avquery-cache
system fortiguard 344 blocked
log filter 192
avquery-cache-ttl
system fortiguard 344 BOOTP Vendor Extensions 337
avquery-status border-routers
system fortiguard 343 router info ospf 647
avupd bridged mode 380
execute ha synchronize 583 broadcast_ssid
system wireless settings 452
B bsr-allow-quick-refresh
router multicast interface pim-smglobal 253
backdoor buffer
router bgp network 240 system replacemsg auth 398, 399, 401, 424
backplane interfaces 356 system replacemsg fortiguard-wf 404
backup ipsec interface system replacemsg ftp 406
example 518 system replacemsg http 408
monitor-phase1 513 system replacemsg im 410
backup, execute 562 system replacemsg mail 412
bandwidth limiting for interfaces 379 system replacemsg spam 426
batch system replacemsg sslvpn 428
execute 564, 566 bug-report
batch mode 352 system 333
batch_cmdb bword
system global 352 spamfilter 296
webfilter 548
baudrate
system console 334
beacon_interval C
system wireless settings 452 ca
bestpath-as-path-ignore execute ha synchronize 583
router bgp 232 cache
bestpath-cmp-confed-aspath spamfilter fortishield 302
router bgp 232 cache-mem-percent
bestpath-cmp-routerid webfilter fortiguard 553
router bgp 232 cache-mode
bestpath-med-confed webfilter fortiguard 553
router bgp 232 cache-notfound-responses
system dns 339

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 677
 Index

capability-default-originate command abbreviation 44

router bgp neighbor 236 command completion 43
capability-dynamic command help 43
router bgp neighbor 236 comment
capability-graceful-restart firewall profile 119
router bgp neighbor 236 comments
capability-orf firewall policy 106
router bgp neighbor 236 Common Criteria (CC) 352
capability-route-refresh community
router bgp neighbor 236 router info bgp 642
case sensitivity community-info
Perl regular expressions 48 router info bgp 642
CC-mode community-list
system global 352 router 242
certificate router info bgp 642
vpn ca 488 confederation-identifier
vpn crl 489 router bgp 232
vpn local 491 config 35
certificate ca execute backup 562
vpn 488 ha synchronize 583
certificate crl restore 604, 605
vpn 489 config checksum
certificate local system cmdb status 657
vpn 491 config limit
cfg reload ips anomaly 178
execute 566 config router 21
cfg save connected
execute 567 router info routing-table 651
channel connecting to the CLI 30
system wireless settings 452 through the console 30
CHAP 376 using SSH 31
chassis status using Telnet 32
get 632 connect-timer
check-reset-range router bgp neighbor 236
system global 353 conn-tracking
China, PPP option 393 system global 353
Chinese, Simplified 354 console
Chinese, Traditional 354 system 334
CIDR 229 console status 636
cidr-only get 636
router info bgp 642 console, gui 166, 222
cisco-exclude-genid contact-info
router multicast interface 251 system snmp sysinfo 446
Classless Interdomain Routing (CIDR) 229 cost
clear system arp table router ospf neighbor 266
execute 568 router ospf ospf-interface 267
CLI basics 43 counting to infinity loop 282
CLI structure 33 CPU usage, SNMP event 444
client certificate for SSL-VPN 539 csv
client certificate, require for logon 353 log syslogd setting 216
client-to-client-reflection syslogd setting 216
router bgp 232 custom
clt-cert-req ips 181
system global 353 custom field
cluster 360 log 190
virtual 360 customer service 19
cluster-id
router bgp 232 D
cnid daily-restart
user ldap 473 system global 353

FortiGate CLI Version 3.0 MR6 Reference

678 01-30006-0015-20080205
Index

dampening default-gateway
router bgp 232 system dhcp server 336
router info bgp 642 default-gw
dampening-max-suppress-time vpn ipsec phase1-interface 511
router bgp 232 defaultgw
dampening-reachability-half-life system interface 377
router bgp 232 default-gw-priority
dampening-reuse vpn ipsec phase1-interface 511
router bgp 233 default-information-metric
dampening-route-map router ospf 260
router bgp 233 default-information-metric-type
dampening-suppress router ospf 260
router bgp 233 default-information-originate
dampening-unreachability-half-life router ospf 260
router bgp 233 router rip 279
database default-information-route-map
router info ospf 647 router ospf 260
router info RIP 650 default-local-preference
router info routing-table 651 router bgp 233
database-filter-out default-metric
router ospf ospf-interface 267 router ospf 260
database-overflow router rip 279
router ospf 260 delete
database-overflow-max-lsas shell command 34
router ospf 260 denial of service (DoS) sensor 128
database-overflow-time-to-recover denial of service attacks 355
router ospf 260 dense mode 248
data-size deploy, execute 572
execute ping-options 600 description
date, execute 571 log report definition 205
day router bgp neighbor 236
firewall schedule recurring 150 system interface 377
system autoupdate schedule 328 system snmp sysinfo 446
daylight saving time 353 destination
ddns system ipv6-tunnel 389
system interface 376 details
ddns-domain router info routing-table 651
system interface 376 detection summary statistics 353
ddns-password detection-summary
system interface 376 system global 353
ddns-profile-id detectserver
system interface 376 system interface 377
ddns-server deterministic-med
system interface 377 router bgp 233
ddns-sn device
system interface 377 router static 292
ddns-username router static6 294
system interface 377 system settings 441
dead gateway detection 354 df-bit
dead gateway detection interval 353 execute ping-options 600
dead-interval DHCP exclusion range 338
router ospf area virtual-link 264 dhcp lease-clear, execute 573
router ospf ospf-interface 267 dhcp lease-list, execute 574
decoder DHCP Options 337
IPS 639, 640 DHCP relay 376
default dhcp reserved-address
system session-ttl 439 system 335
default-acl dhcp server
system wireless mac-filter 451 system 336
default-cost DHCP servers, maximum 336
router ospf area 262

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 679
 Index

dhcp-ipsec distribute-list-in
vpn ipsec phase2 520 router bgp neighbor 237
dhcp-relay-ip router ospf 260
system interface 377 distribute-list-out
dhcp-relay-service router bgp neighbor 237
system interface 377 dn
dhcp-relay-type user ldap 473
system interface 377 dns
dhgrp system 339
vpn ipsec phase1 503 DNSBL
vpn ipsec phase1-interface 512 spamfilter 309
vpn ipsec phase2 520 dns-cache-limit
vpn ipsec phase2-interface 527 system dns 339
diagnose commands 16 dns-server
dial-on-demand system dhcp server 336
system modem 393 dns-server-override
differentiated services code point (DSCP) system interface 378
originating traffic 106 dns-timeout
reply traffic 106 spamfilter options 308
diffservcode-forward dnstranslation
firewall policy 106 firewall 85
diffservcode-rev domain
firewall policy 106 system dhcp server 337
diffserv-forward 106 domain name 376
diffserv-reverse dont-capability-negotiate
firewall policy 106 router bgp neighbor 237
direction downstream router, prune state 252
router ospf area filter-list 263 dpd
router rip distribute-list 281 vpn ipsec phase1 504
router rip offset-list 284 vpn ipsec phase1-interface 512
disconnect-admin-session, execute 575 dpd-retrycount 512
disc-retry-timeout vpn ipsec phase1 504
system interface 377 dpd-retryinterval 512
disk filter vpn ipsec phase1 504
log 191 drive-standby-time
disk setting log disk setting 197
log 196 drop-blocked
diskfull antivirus quarantine 75
log disk setting 197 drop-heuristic
log memory setting 202 antivirus quarantine 75
display drop-infected
log trafficfilter 218 antivirus quarantine 75
distance dr-priority
router ospf 260 router multicast interface 251
router rip distance 280 dst
router static 292 firewall dnstranslation 85
system interface 378 log trafficfilter rule 219
system modem 394 router policy 272
vpn ipsec phase1 503 router static 293
vpn ipsec phase1-interface 512 router static6 294
distance-external system global 353
router bgp 233 dstaddr
router ospf 260 firewall multicast-policy 102
distance-inter-area firewall policy 106
router ospf 260 dst-addr-type
distance-internal vpn ipsec phase2 520
router bgp 233 vpn ipsec phase2-interface 527
distance-intra-area dst-end-ip
router ospf 260 vpn ipsec phase2 520
distance-local vpn ipsec phase2-interface 527
router bgp 233 dst-end-ip6
vpn ipsec phase2-interface 527

FortiGate CLI Version 3.0 MR6 Reference

680 01-30006-0015-20080205
Index

dstintf email-pattern
firewall multicast-policy 102 spamfilter emailbwl 300
firewall policy 106 email-subject
dst-name log report output 207
vpn ipsec phase2 520 enable
vpn ipsec phase2-interface 527 system dhcp server 337
dst-port enc-alg
vpn ipsec phase2 520 vpn ipsec manualkey-interface 500
vpn ipsec phase2-interface 527 enc-key
dst-start-ip vpn ipsec manualkey-interface 500
vpn ipsec phase2 520 enckey
vpn ipsec phase2-interface 527 vpn ipsec manualkey 497
dst-start-ip6 encrypted password support 45
vpn ipsec phase2-interface 528 encryption 356
dst-subnet ipsec manualkey 497
vpn ipsec phase2 521 system ha 362
vpn ipsec phase2-interface 528 end
dst-subnet6 command in a table shell 34
vpn ipsec phase2-interface 528 command in an edit shell 35
dynamic DNS 376 firewall schedule onetime 149
Dynamic DNS service (DDNS) 376 firewall schedule recurring 150
dynamic routing 382 end-ip
firewall address 82
E system dhcp server 337
system dhcp server config exclude-range 337
EBGP 232 endip
RFC 3065 229 firewall ippool 99, 100
ebgp-enforce-multihop end-port
router bgp neighbor 237 router policy 272
ebgp-multihop enforce-first-as
router bgp neighbor 237 router bgp 233
ebgp-multihop-ttl Equal Cost Multi-Path (ECMP) 441
router bgp neighbor 237 event
edit 34 log filter 192
system accprofile 312 events
system gre-tunnel 358 system snmp communities 444
system mac-address-table 390
exact-match
editing commands 44 router access-list 224
editing the configuration file 46 example command sequences 39
edonkey 119 exclude-summary
edonkey-limit 120 log report scope 211
eip execute 561
vpn l2tp 533 execute command
vpn pptp 535 backup 562
email batch 564, 566
log filter 192 cfg reload 566
log report output 207 cfg save 567
email when virus or spam detected 412 clear system arp table 568
email-attachment-name date 571
log report output 207 deploy 572
email-body dhcp lease-clear 573
log report output 207 dhcp lease-list 574
emailbwl disconnect-admin-session 575
spamfilter 299 factoryreset 576
emaillists formatlogdisk 577
execute ha synchronize 583 fortiguard-log delete 579
email-log-imap fortiguard-log update 578
log filter 192 fsae refresh 579
email-log-pop3 ha disconnect 580
log filter 192 ha manage 581
ha synchronize 583
email-log-smtp
interface dhcpclient-renew 585
log filter 192

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 681
 Index

execute command (continued) FDN

interface pppoe-reconnect 586 proxy server 330
log delete-all 587 RFC 2616 330
log delete-filtered 588 service 324
log delete-rolled 589 FDS
log display 590 override server 325
log filter 591 fieldbody
log fortianalzyer test-connectivity 593 spamfilter mheader 307
log list 594 fieldname
log roll 595 spamfilter mheader 307
modem dial 596, 606 file
modem hangup 597 log report output 207
ping 599
filepattern
ping6 602
antivirus 70
ping-options 600
reboot 603 filter
restore 604 log 191
router clear bfd 607 filter-list
router clear bgp 606 router info bgp 642
router restart 609 filter-list-in
set-next-reboot 611 router bgp neighbor 237
shutdown 612 filter-list-out
ssh 613 router bgp neighbor 237
telnet 614 filter-string
time 615 log report filter 206
traceroute 616 FIN packet 356
update-av 617 FIPS/CC 352
update-ips 618 Firefox 356
update-now 619 firewall 81
upd-vd-license 620 address 82
usb-disk 621 addrgrp 84
vpn certificate ca 622 multicast-policy 102
vpn certificate crl 624 profile 114
vpn certificate local 625
firewall configuration
vpn sslvpn del-tunnel 629
access profile setting 313
expires
firmware performance optimization 355
webfilter ftgd-ovrd 557
fixedport
export
firewall policy 107
execute vpn certificate ca 622
fm
extintf
system 342
firewall vip 157
footer-option
extip
log report customization 204
firewall vip 157
format
extport
system replacemsg auth 398, 399, 402, 424
firewall vip 157
system replacemsg fortiguard-wf 404
ext-ref system replacemsg ftp 406
webfilter ftgd-ovrd 557 system replacemsg http 408
system replacemsg im 410
F system replacemsg mail 412
facility system replacemsg spam 427
log syslogd setting 216 system replacemsg sslvpn 428
factoryreset, execute 576 formatlogdisk, execute 577
failed connection attempts 355 fortianalyzer
system 340
fail-open
system global 183 fortianalyzer filter
log 191
failopen mode, av-failopen 352
fortianalyzer setting
failtime
log 199
system global 353
FortiGate SNMP agent 446
fast-external-failover
router bgp 233 FortiGate system configuration 353
FB4 396 FortiGate-3016B 380
FortiGate-ASM-FB4 380

FortiGate CLI Version 3.0 MR6 Reference

682 01-30006-0015-20080205
Index

fortiguard ftgd-wf-errors
system 342 log filter 192
webfilter 552 ftgd-wf-log
FortiGuard Distribution Network (FDN) 325, 326, 330 firewall profile 121
fortiguard filter ftgd-wf-options
log 191 firewall profile 121
fortiguard setting ftgd-wf-ovrd 122
log 201 user group 470
FortiGuard updates 313, 324 ftgd-wf-ovrd-dur
fortiguard-log user group 470
system 346 ftgd-wf-ovrd-dur-mode
fortiguard-log (fortiguard analysis service) user group 471
system 346 ftgd-wf-ovrd-ext
fortiguard-log delete user group 471
execute 579 ftgd-wf-ovrd-scope
fortiguard-log update user group 471
execute 578 ftgd-wf-ovrd-type
FortiManager 391 user group 471
scripts 334 ftp
fortimanager firewall profile 122
system 347 ftp, message added when virus detected 406
FortiManager, configuration 342 ftpcomfortamount 122
fortimanager-discover-helper ftpcomfortinterval
system interface 378 firewall profile 122
Fortinet customer service 19 ftpoversizelimit
FortiOS v3.0 firewall profile 123
MR2 350 fwdintf
fortishield system dns 339
spamfilter 301 fwgrp
FortiWifi-60 access group for system accprofile 313
wireless MAC filter 451 system accprofile 313
wireless settings 452
FortiWifi-60A G
interface settings 384
wireless MAC filter 384 garbage-timer
router rip 279
forward-domain
system interface 378 gateway 377
default setting for VDOM 440
fqdn
router policy 272
firewall address 82
router static 293
fragment_threshold router static6 294
system wireless settings 452 system settings 441
frequency gateway-device
system autoupdate schedule 328 system settings 441
FSAE 353 gbandwidth
fsae firewall policy 107
firewall policy 107 ge
user 467 router prefix-list 275
fsae refresh geography
execute 579 system wireless settings 452
ftgd-local-cat get
webfilter 555 edit shell command 35
ftgd-local-rating table shell command 34
webfilter 556 get commands 631
ftgd-ovrd global
webfilter 557 configure global settings 57
ftgd-wf-allow ips 183
firewall profile 120 system 350
ftgd-wf-block gnutella
log filter 192 firewall profile 123
ftgd-wf-deny gnutella-limit
firewall profile 120 firewall profile 123

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 683
 Index

graceful_restart hb-interval
router bgp 233 system ha 362
grayware hb-lost-threshold
antivirus 72 system ha 362
GRE 282 header
gre-tunnel log report customization 204
system 358 system replacemsg auth 398, 399, 402, 424
group system replacemsg fortiguard-wf 404
user 469 system replacemsg ftp 406
group-id system replacemsg http 408
system ha 362 system replacemsg im 410
group-name system replacemsg mail 412
system ha 362 system replacemsg spam 427
system replacemsg sslvpn 428
groups
firewall policy 108 hello-holdtime
router multicast interface 251
gui 165, 221
hello-interval
gwdetect
router multicast interface 251
system interface 378
router ospf area virtual-link 264
router ospf ospf-interface 267
H helo-holddown
HA 360 system ha 362
heart beat device 447 heuristic
monitored interface 447 antivirus 74
remote IP monitoring 369 high availability 360
slave, error messages 353 holddown-timer
ha system modem 394
arps 361 holdtime-timer
arps-interval 361 router bgp 233
authentication 362 router bgp neighbor 237
encryption 362 hop count. 284
group-id 362 hostname
group-name 362 spamfilter fortishield 302
hbdev 362 system fortiguard 343
hb-interval 362 system global 354
hb-lost-threshold 362 http
helo-holddown 362 firewall profile 124, 125
link-failed-signal 362
HTTP session, antivirus 408
load-balance-all 363
mode 363 httpcomfortinterval
monitor 363 firewall profile 125
override 363 http-obfuscate
password 364 system global 354
priority 364 httpoversizelimit
route-hold 364 firewall profile 125
route-ttl 365 http-retry-count
route-wait 365 firewall profile 125
schedule 365
secondary-vcluster 367 I
session-pickup 366
sync-config 366 IBGP 232
system 360 RFC 1966 229
system status 662 ICMP dropped packets logging 193
uninterruptable-upgrade 366 icmpcode
vcluster2 367 firewall service custom 152
vdom 366 icmptype
weight 366 firewall service custom 152
ha disconnect, execute 580 icq
ha manage, execute 581 firewall profile 125
ha synchronize, execute 583 imp2p old-version 173
hardware status 638 imp2p policy 174
hbdev icq-user
system ha 362 imp2p 171

FortiGate CLI Version 3.0 MR6 Reference

684 01-30006-0015-20080205
Index

ICSA compliant logs 193 infected

id log filter 193
webfilter ftgd-local-cat 555 info ospf
ident-accept router 647
system interface 379 info protocols
idle-timeout 539 router 649
system interface 379 info rip
idle-timer router 650
system modem 394 info routing-table
ie6workaround router 651
system global 354 initiator
IEEE 802.1Q 383 webfilter ftgd-ovrd 557
IEEE 802.3ad 387 input-device
IGMP router policy 273
RFC 1112 248 interface
RFC 2236 248 firewall ippool 99, 100
RFC 3376 248 loopback 383, 387
igmp-state-limit proxy ARP 155
router multicast 250 router bgp neighbor 237
ignore_optional_capability router info ospf 647
router bgp 233 router info RIP 650
ignore-session-bytes 183 router ospf ospf-interface 268
router rip distribute-list 281
IKE 355
router rip offset-list 284
im 125 system 373
log filter 193 system dhcp server 337
IM, message if blocked 410 system gre-tunnel 358
image 605 system ipv6tunnel 389
execute restore 605 system mac-address-table 390
im-all system modem 394
log filter 193 system snmp community hosts 445
imap system zone 455
firewall profile 126 vpn ipsec manualkey 497
imapoversizelimit vpn ipsec manualkey-interface 500
firewall profile 127 vpn ipsec phase1 504
imap-spamaction vpn ipsec phase1-interface 512
firewall profile 127 interface dhcpclient-renew
imap-spamtagmsg execute 585
firewall profile 127 interface pppoe-reconnect
imap-spamtagtype execute 586
firewall profile 127 interior gateway protocol (IGP) 234
imoversizelimit International characters 46
firewall profile 127 Internet Explorer 354, 356
imp2p 169 interval
imp2pgrp system global 354
access group for system accprofile 313 inter-VDOM routing 53
import intrazone
execute vpn certificate ca 622 system zone 455
execute vpn certificate crl 624, 628 Intrusion protection
inbandwidth DoS sensor, protection profile 128
config system interface 379 ip
inbound firewall ipmacbinding table 97
firewall policy 108 router ospf neighbor 266
inbound traffic, limiting 379 router ospf ospf-interface 268
include-nodata router rip neighbor 283
log report scope 211 system dhcp reserved-address 335
include-summary system fortiguard 343
log report scope 211 system interface 379
include-table-of-content system settings 441
log report scope 211 system snmp community hosts 445
webfilter ftgd-ovrd 557
inconsistent-as
router info bgp 642 IP address formats 46
IP address overlap 352

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 685
 Index

IP address spoofing 95 ipsec phase2-interface

IP datagram vpn 526
TOS bits 448 IPSec tunnel
IP pool listing 641
proxy ARP 155 ipsec tunnel list
ip/subnet get 641
spamfilter ipbwl 304 ipsgrp
spamfilter iptrust 305 access group for system accprofile 313
ip6 ips-signature
firewall address6 82 firewall profile 128
ip6-address ipsuserdefsig
system interface config ipv6 385 execute backup 563
ip6-default-life execute restore 605
system interface config ipv6 385 iptrust
ip6-hop-limit spamfilter 305
system interface config ipv6 385 ipunnumbered
ip6-link-mtu system interface 379
system interface config ipv6 385 IPv6 375
ip6-manage-flag 6-to-4 address prefix 82
system interface config ipv6 385 ipv6-tunnel
ip6-max-interval system 389
system interface config ipv6 385 ISP 325
ip6-min-interval
system interface config ipv6 385 J
ip6-other-flag
system interface config ipv6 385 join-group
router multicast interface 252
ip6-reachable-time
system interface config ipv6 385 jumbo frames 381
ip6-retrans-time
system interface config ipv6 386 K
ip6-send-adv kazaa
system interface config ipv6 386 firewall profile 128
ipbwl kazaa-limit
spamfilter 303 firewall profile 128
ipmacbinding setting keepalive
firewall 95 vpn ipsec phase1 504
ipmacbinding table vpn ipsec phase1-interface 513
firewall 97 vpn ipsec phase2 521
ippool vpn ipsec phase2-interface 528
firewall 99 keep-alive-timer
firewall policy 108 router bgp 233
ips 177 router bgp neighbor 237
IPS decoder 639, 640 key
ips-anomaly system wireless settings 453
firewall profile 128 key-chain
IPSec 282 router 245
ipsec keylife 513
log filter 193 vpn ipsec phase1 504
ipsec concentrator keylifekbs 521
vpn 494 vpn ipsec phase2-interface 528
ipsec manualkey keylifeseconds 521
vpn 496 vpn ipsec phase2-interface 528
ipsec manualkey-interface keylife-type 521
vpn 499 vpn ipsec phase2-interface 528
ipsec phase1 key-string
vpn 502 router key-chain 246
ipsec phase1-interface
vpn 510 L
ipsec phase2
l2forward
vpn 519
system interface 379

FortiGate CLI Version 3.0 MR6 Reference

686 01-30006-0015-20080205
Index

l2tp local-gw
vpn 533 system gre-tunnel 358
lacp-ha-slave vpn ipsec manualkey 497
system interface 386 vpn ipsec manualkey-interface 500
lacp-mode vpn ipsec phase1 504
system interface 386 localid 513
lacp-speed vpn ipsec phase1 504
system interface 387 local-spi
language vpn ipsec manualkey-interface 500
spamfilter bword 297 localspi
system global 354 vpn ipsec manualkey 497
webfilter bword 548, 550 location
last request system snmp sysinfo 446
system cmdb status 657 log 189
last request pid execute backup 562
system cmdb status 657 system interface 379
last requst type log delete-all, execute 587
system cmdb status 657 log delete-filtered, execute 588
lcdpin log delete-rolled, execute 589
system global 354 log display, execute 590
lcdprotection log filter, execute 591
system global 355 log fortianalzyer test-connectivity
lcp-echo-interval execute 593
system interface 379 log list, execute 594
lcp-max-echo-failures log roll, execute 595
system interface 379 log settings 313
LDAP 355 log-av-block
ldap firewall profile 128
user 473 log-av-oversize
ldapconntimeout firewall profile 128
system global 355 log-av-virus
ldap-server firewall profile 128
user local 476 loggrp
le access group for system accprofile 313
router prefix-list 275 system accprofile 313
lease-time log-im
system dhcp server 337 firewall profile 128
license loglocaldeny
spamfilter fortishield 302 system global 355
license key entry 620 log-neighbor-changes
line continuation 44 router bgp 234
lines_per_view log-spam 128
execute logfilter 592 logtraffic
Link Aggregation Control Protocol (LACP) 386 firewall policy 108
link-failed-signal log-web-content
system ha 362 firewall profile 129
list log-web-filter-activex
router ospf area filter-list 263 firewall profile 129
listname log-web-filter-applet
router rip distribute-list 281 firewall profile 129
load-balance-all log-web-filter-cookie
system ha 363 firewall profile 129
local log-web-ftgd-err
user 476 firewall profile 129
localcert log-web-url
execute ha synchronize 583 firewall profile 129
loopback interface 383, 387
lowspace
antivirus quarantine 76

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 687
 Index

M maximum-prefix
router bgp neighbor 237
mac maximum-prefix-threshold
firewall ipmacbinding table 97 router bgp neighbor 237
system arp-table 322 maximum-prefix-warning-only
system dhcp reserved-address 335 router bgp neighbor 238
system interface, config wifi-mac_list 384
max-log-file-size
system wireless mac-filter 451
log disk setting 196
MAC address 382
mc-ttl-notchange
arp-table 322
system global 441
macaddr
md5-key
system interface 379
router ospf area virtual-link 264
mac-address-table router ospf ospf-interface 268
system 390
member
mac-list firewall addrgrp 84
system wireless mac-filter 451 firewall service group 154
mail-sig system interface 387
firewall profile 129 user group 470
mailsig-status user peergrp 480
firewall profile 129 vpn ipsec concentrator 494
mailto memory
system bug-report 333 router info bgp 642
mailto1, mailto2, mailto3 memory filter
alertemail setting 65 log 191
maintenance commands 313 memory global setting
manageip log 203
system settings 441 memory setting
management traffic 54 log 202
management VDOM 54, 316 metric
management-tunnel router ospf redistribute 269
system 391 router rip redistribute 285
management-vdom metric-type
system global 355 router ospf redistribute 269
mappedip mheader
firewall vip 158 spamfilter 306
mappedport mntgrp
firewall vip 158 access group for system accprofile 313
match-as-path system accprofile 313
router route-map rule 289 mode
match-community antivirus heuristic 74
router route-map rule 289 config system ha 363
match-community-exact system console 334
router route-map rule 289 system interface 380
match-interface system modem 394
router route-map 287 system wireless settings 453
match-ip-address vpn ipsec phase1 505
router route-map 287 vpn ipsec phase1-interface 513
match-ip-nexthop modem
router route-map 287 auto-dial 393
backup switchover 394
match-metric
dial-on-demand 393
router route-map 287
execute modem dial command 596, 606
match-origin 289 execute modem hangup command 597
match-route-type redundant 394
router route-map 287 standalone 394
match-tag system 393
router route-map 287 monitor
maxbandwidth system ha 363
firewall policy 108 monitor-phase1
maxfilesize vpn ipsec phase1-interface 513
antivirus quarantine 76 move 34
maximum transmission unit (MTU) 381 MS Windows Client 376

FortiGate CLI Version 3.0 MR6 Reference

688 01-30006-0015-20080205
Index

msn netgrp
firewall profile 133 access group for system accprofile 313
imp2p old-version 173 system accprofile 313
imp2p policy 174 netmask
msn-user firewall dnstranslation 85
imp2p 172 system dhcp server 337
MSS TCP 356 Netscape 356
mtu network
router ospf ospf-interface 268 router info bgp 642
system interface 381 network address translation (NAT) 155
mtu-ignore Network Layer Reachability Information (NLRI) 260
router ospf ospf-interface 268 Network Processing Unit (NPU) 396
Multi Exit Discriminator (MED) 232 Network Time Protocol (NTP) 355, 356
Multi Protocol Label Switching (MPLS) 380 network-import-check
multicast router bgp 234
dense mode 248 network-longer-prefixes
IGMP 248 router info bgp 642
router 247 network-type
system global 356 router ospf ospf-interface 268
multicast memberships 250 next 35
multicast-forward next-hop-self
system global 441 router bgp neighbor 238
multicast-policy NRLI prefix
firewall 102 router bgp 237
multicast-routing 250 nssa-default-information-originate
multi-report router ospf area 262
fortianalyzer setting 199 nssa-default-information-originate-metric
log fortianalyzer setting 199 router ospf area 262
nssa-default-information-originate-metric-type 262
N nssa-redistribution 262
name nssa-translator-role 262
firewall ipmacbinding table 97 ntpserver
log report summary-layout 214 system global 355
system session-helper 433 ntpsync
system snmp community 444 system global 355
nat
firewall multicast-policy 102 O
firewall policy 108
NAT device 326 obfuscated 354
NAT mode, changing 441 obfuscate-user
log report scope 211
NAT traversal 145
offset
NAT/Route mode 355
router rip offset-list 284
natinbound
old-version
firewall policy 108
imp2p 173
natip
onlink-flag
firewall policy 108
system interface config ipv6-prefix 386
natoutbound
operating mode
firewall policy 108
system settings 440
nattraversal
opmode
vpn ipsec phase1 505
system settings 441
vpn ipsec phase1-interface 513
optimize
neighbor
system global 355
router info ospf 648
option
neighbors
system dhcp server 337
router info bgp 642
options
neighbour-filter
spamfilter 308
router multicast interface 251
order
NetBIOS 381
log report summary-layout 214
netbios-forward
OSPF 257, 448
system interface 381
RFC 2328 257
TOS application routing 448

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 689
 Index

ospf pattern-type
ABR 257 spamfilter bword 297
RFC 3509 259 spamfilter emailbwl 300
router 257 spamfilter mheader 307
router info routing-table 651 webfilter bword 548, 550
OSPF, clear router 608 peer
other-traffic router ospf area virtual-link 264
log filter 193 vpn ipsec phase1 505
outbound vpn ipsec phase1-interface 513
firewall policy 109 peergrp 514
Outbound Routing Filter (ORF) 236 vpn ipsec phase1 505
output-device peerid 514
router policy 273 vpn ipsec phase1 505
override Peer-to-Peer, message if blocked 410
system autoupdate push-update 326 peertype 514
system ha 363 vpn ipsec phase1 506
override-capability performance info 670
router bgp neighbor 238 Perl regular expressions, using 48
oversized pfs
log filter 193 vpn ipsec phase2 521
ovrd-auth-https vpn ipsec phase2-interface 528
webfilter fortiguard 553 phase1name
ovrd-auth-port vpn ipsec phase2 521
webfilter fortiguard 553 vpn ipsec phase2-interface 528
owner id phone
system cmdb status 657 system modem 394
PIM, dense-mode 251
P PIM, sparse-mode 251
pim-mode
p2p 134 router multicast interface 251
packet size ping, execute 599
for wireless network 452
ping6, execute 602
padt-retry-timeout
ping-options, execute 600
system interface 381
policy
PAP 376
firewall 104
passive imp2p 174
router bgp neighbor 238 router 272
router multicast interface 251
policy check 356
passive-interface
policy check, skipping 356
router ospf 260
router rip 279 poll-interval
router ospf neighbor 266
passphrase 453
system wireless settings 453 poolname
firewall policy 109
passwd
system modem 394 pop3
user local 476 firewall profile 134
password pop3oversizelimit
system alertemail 321 firewall profile 135
system autoupdate tunneling 330 pop3-spamaction
system bug-report 333 firewall profile 135
system ha 364 pop3-spamtagmsg
system interface 381 firewall profile 135
user ldap 474 pop3-spamtagtype
PAT firewall profile 135
virtual IPs 155 port 216
paths antivirus service 79
router info bgp 642 log syslogd setting 216
pattern system autoupdate push-update 326
execute ping-options 600 system autoupdate tunneling 330
log filter 193 system fortiguard 343
spamfilter bword 297 system session-helper 433
user fsae 468
user ldap 473

FortiGate CLI Version 3.0 MR6 Reference

690 01-30006-0015-20080205
Index

port 8890 330 proposal

port address translation vpn ipsec phase1 507, 515
virtual IPs 155 vpn ipsec phase2 522
port forwarding 155 vpn ipsec phase2-interface 529
port range 354 protection profile
portal-heading DoS sensor 128
vpn ssl settings 539 protocol
portforward firewall service custom 152
firewall vip 158 firewall vip 158
power_level router ospf distribute-list 265
system wireless settings 453 router policy 273
system session-helper 433
ppp
vpn ipsec phase2 522
log filter 193
vpn ipsec phase2-interface 529
PPPoE 326
protocol-number
PPPoE Active Discovery Terminate (PADT) 381 firewall service custom 152
PPPoE auth 376 proxy ARP 155
pptp FortiGate interface 155
vpn 535 IP pool 155
preferences virtual IP 155
GUI console 166, 222 Proxy ID Destination
GUI topology viewer 167 IPSec interface mode 641
preferred-life-time Proxy ID Source
system interface config ipv6-prefix 386 IPSec interface mode 641
prefix proxy-arp
router access-list 224 system 397
router bgp aggregate-address 235 psksecret 515
router bgp network 240 vpn ipsec phase1 507
router ospf area range 263
purge 34
router ospf network 266
router ospf summary-address 270
router prefix-list 275 Q
router rip distance 280 quarantine
router rip network 283 antivirus 75
prefix-list quarfilepattern
router info bgp 642 antivirus 78
router prefix-list 275 quar-to-fortianalyzer
prefix-list-in antivirus quarantine 76
router bgp neighbor 238 query-v1-port
prefix-list-out system snmp community 444
router bgp neighbor 238 query-v1-status
preserve source port number 107 system snmp community 444
Pre-shared Key (PSK) 384 query-v2c-port
primary system snmp community 444
system dns 339 query-v2c-status
priority system snmp community 444
firewall policy 109 quotafull
router ospf neighbor 266 log fortiguard setting 201
router ospf ospf-interface 268 quote-regexp
system ha 364 router info bgp 642
system interface 382
system modem 395
profile
R
firewall 114 RADIUS 355, 384
firewall policy 109 radius
webfilter ftgd-ovrd 557 user 481
profile-status RADIUS authentication 54
firewall policy 109 radius-auth
propagation-delay system admin 317
router multicast interface 251 radius-group
system admin 317
radius-port
system global 355

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 691
 Index

radius-server replacemsg sslvpn

system wireless settings 453 system 428
user local 476 replay
rating vpn ipsec phase2 522
webfilter ftgd-local-rating 556 vpn ipsec phase2-interface 529
webfilter ftgd-ovrd 557 report customization
reboot, execute 603 log 204
recalling commands 44 report definition
received route, looping 232 log 205
receive-version report filter
router rip interface 282 log 206
redial report output
system modem 395 log 207
redir-url report period
user group 471 log 209
refresh report schedule
system global 355 log 210
regexp report scope
router aspath-list 226, 228 log 211
router info bgp 642 report selection
Remote Gateway log 213
VPN IPSec monitor field 641 report settings 313
remote IP monitoring report summary-layout
HA 369 log 214
remote-as reqclientcert
router bgp neighbor 238 vpn ssl settings 539
remoteauthtimeout request to send (RTS) 384
system global 355 reset-sessionless-tcp
remote-gw system global 355
system gre-tunnel 358 resolve
vpn ipsec manualkey 497 log trafficfilter 218
vpn ipsec manualkey-interface 500 resolve-host
vpn ipsec phase1 507 log report scope 211
vpn ipsec phase1-interface 515 resolve-service
remotegw-ddns log report scope 211
vpn ipsec phase1 507 restart-time
vpn ipsec phase1-interface 515 system global 355
remote-ip restore, execute 604
system interface 382 result
remote-spi log report scope 211
vpn ipsec manualkey-interface 500 retain-stale-time
remotespi router bgp neighbor 238
vpn ipsec manualkey 497 retransmit-interval
remove-private-as router ospf area virtual-link 264
router bgp neighbor 238 router ospf ospf-interface 268
rename 34 RFC 1112 248
repeat-count RFC 1583 261, 448
execute ping-options 600 RFC 1700 433
replacemsg auth 399, 401, 404 RFC 1771 229
replacemsg fortiguard-wf RFC 1966 229
system 404
RFC 1997 229
replacemsg ftp
RFC 1997, BGP community-list 242
system 406
RFC 2132 337
replacemsg http
system 408 RFC 2236 248
replacemsg im RFC 2328 257
sytem 410 RFC 2616 330
replacemsg mail RFC 3065 229
system 412 RFC 3376 248
replacemsg spam RFC 3509 259
system 426 RFC 3513 385
RFC 791 448

FortiGate CLI Version 3.0 MR6 Reference

692 01-30006-0015-20080205
Index

rfc1583-compatible routing
router ospf 261 authentication 228
rip blackhole 383, 387
router 278 routing failover 377
router info routing-table 651 routing table priority 395
rolled_number 592 routing table, displaying entries in 651
roll-schedule routing, administrative distance 378
disk setting 196 routing, flap 233
log disk setting 196 routing, inter-VDOM 53
roll-time rp-candidate
log disk setting 196 router multicast interface 251
route rp-candidate-group
router info ospf 648 router multicast interface 251
route, suppressed 232 rp-candidate-interval 252
route-flap 232 rp-candidate-priority 252
routegrp rsa-certificate
access group for system accprofile 313 vpn ipsec phase1 507
system accprofile 313 vpn ipsec phase1-interface 515
route-hold RST out-of-window checking 353
system ha 364 rule
route-limit 250 log trafficfilter 218
route-map Runtime-only config mode 350
router 286 runtime-only configuration mode 353
router bgp network 240
router bgp redistribute 241
router info bgp 642 S
routemap SACK 356
router ospf redistribute 269 scan
router rip redistribute 285 router info bgp 642
route-map-in scan-bzip2
router bgp neighbor 238 antivirus service 79
route-map-out scan-time
router bgp neighbor 238 router bgp 234
router 223 schedule
router clear bfd, execute 607 firewall policy 109
router clear bgp, execute 606 system ha 365
router clear ospf process schedule onetime
execute 608 firewall 149
router configuration 313 schedule recurring
router info firewall 150
ospf 647 scope
protocols 649 webfilter ftgd-ovrd 557
rip 650 score
routing table 651 spamfilter bword 297
router info bgp 642 webfilter bword 549
router restart, execute 609 scripts 334
router-alert-check secondary
config router multicast config interface config igmp system dns 339
253 secondary-image
route-reflector-client execute restore 605
router bgp neighbor 238 secondary-vcluster
router-id system ha 367
router bgp 234 secret
router ospf 261 user radius 482
route-server-client secure copy (SCP) 351
router bgp neighbor 238 security
route-threshold 250 system wireless settings 453
route-ttl selection
system ha 365 log report selection 213
route-wait send-community
system ha 365 router bgp neighbor 239

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 693
 Index

send-lifetime set-dampening-suppress 290

router key-chain 246 set-dampening-unreachability-half-life
send-version router route-map rule 290
router rip interface 282 set-extcommunity-rt
send-version1-compatible 282 router route-map rule 290
SerDes (Serializer/Deserializer) 380 set-extcommunity-soo
server router route-map rule 290
log syslogd setting 216 set-ip-nexthop
log webtrends setting 220 router route-map 287
spamfilter DNSBL 310 set-metric
syslogd setting 216 router route-map 287
system alertemail 321 set-metric-type
system bug-report 333 router route-map 287
user fsae 468 set-next-reboot, execute 611
user ldap 473 set-tag
user radius 482, 484 router route-map 287
webtrends setting 220
setting
servercert alertemail 64
vpn ssl settings 539
setting a default gateway for an IPSec interface 511
server-type
setting a default gateway priority 511
system dhcp server 337
setting administrative access for SSH or Telnet 31
service
antivirus 79 setting page length 47
firewall policy 109 settings
log trafficfilter rule 219 system 440
service custom severity
firewall 152 log filter 193
service group SFP interfaces 380
firewall 154 SGMII (Serial Gigabit Media Independent Interface)
service predefined 380
firewall 155 shortcut
Service Set ID (SSID) 385 router ospf area 263
session synchronization shortest path first (SPF) 261
between two standalone FortiGate units 434 shutdown
session table 355 router bgp neighbor 239
session-helper shutdown, execute 612
system 433 signature
session-pickup ips custom 181, 182
system ha 366 log filter 193
session-sync signature reporting 353
system 434 single-source
session-ttl 439 vpn ipsec phase2 523
RFC 1700 433 vpn ipsec phase2-interface 530
system 439 sip
set 35 vpn l2tp 533
set-aggregator-as vpn pptp 535
router route-map rule 289 Skinny Client Call protocol (SCCP) 442
set-aggregator-ip skype 136
router route-map rule 289 smtp 136
set-aspath SMTP server 333
router route-map rule 289 SMTP, blocked email 426
set-atomic-aggregate smtpoversizelimit 137
router route-map rule 289 smtp-spamaction 137
set-community smtp-spamhdrip 137
router route-map rule 290 smtp-spamtagmsg 138
set-community-additive 290 smtp-spamtagtype 138
set-community-delete SNMP
router route-map rule 290 v1 444
set-dampening-max-suppress 290 v2c 444
set-dampening-reachability-half-life snmp community
router route-map rule 290 system 443
set-dampening-reuse 290

FortiGate CLI Version 3.0 MR6 Reference

694 01-30006-0015-20080205
Index

snmp sysinfo ssl monitor

system 446 vpn 537
socket-size 183 sslv2
soft-reconfiguration vpn ssl settings 539
router bgp neighbor 239 SSL-VPN
source login page 428
execute ping-options 600 user group variables 471
system ipv6-tunnel 389 sslvpn-auth
spaces, entering in strings 45 firewall policy 109
spam filter configuration 313 sslvpn-cache-cleaner
spamfilter 295 user group 471
spamgrp sslvpn-ccert
access group for system accprofile 313 firewall policy 110
system accprofile 313 sslvpn-cipher
spamwordthreshold 139 firewall policy 110
Spanning Tree Protocol (STP) 382 sslvpn-client-check
special characters, where they are allowed 46 user group 471
speed sslvpn-enable 540
system interface 382 sslvpn-samba
spf-timers user group 472
router ospf 261 sslvpn-telnet
split-horizon user group 472
router rip interface 282 sslvpn-tunnel
split-horizon-status user group 471
router rip interface 282 sslvpn-webapp
spoofing user group 472
IP address 95 standalone session synchronization 434
src start
firewall dnstranslation 85 execute ha synchronize 583
log trafficfilter rule 219 firewall schedule onetime 149
router policy 273 firewall schedule recurring 150
srcaddr start-ip
firewall multicast-policy 102 firewall address 82
firewall policy 109 system dhcp server 337
src-addr-type system dhcp server config exclude-range 337
vpn ipsec phase2 523 startip
vpn ipsec phase2-interface 530 firewall ippool 99, 100
src-end-ip start-port
vpn ipsec phase2 523 router policy 273
vpn ipsec phase2-interface 530 state-refresh-interval
srcintf router multicast interface 252
firewall multicast-policy 102 static
firewall policy 109 router 292
src-name router info routing-table 651
vpn ipsec phase2 523 static6
src-port router 294
vpn ipsec phase2 523 status
vpn ipsec phase2-interface 530 administrators 653, 669
src-start-ip antivirus grayware 73
vpn ipsec phase2 523 antivirus quarfilepattern 78
vpn ipsec phase2-interface 530 chassis 632
src-subnet firewall ipmacbinding table 97
vpn ipsec phase2 524 firewall policy 110
vpn ipsec phase2-interface 531 FortiAnalyzer connection 659
srv-ovrd FortiGuard log service 660
system fortiguard 343 FortiGuard service 661
HA 662
ssh
hardware 638
execute 613
log disk setting 196
SSH configuration information 668 log fortianalyzer setting 199
ssid log fortiguard setting 201
system wireless settings 453 log memory setting 202

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 695
 Index

status (continued) substitute-status

log syslogd setting 216 router ospf area range 263
log webtrends setting 220 summary
router bgp redistribute 241 router info bgp 642
router info ospf 648 summary-column
router ospf ospf-interface 269 log report summary-layout 214
router ospf redistribute 269 summary-only
router rip distribute-list 281 router bgp aggregate-address 235
router rip offset-list 284 summary-reports
router rip redistribute 285 log report summary-layout 214
spamfilter bword 297
SYN packets 353
spamfilter DNSBL 310
spamfilter emailbwl 300 sync-config
spamfilter mheader 307 system ha 366
syslogd setting 216 synchronization
system autoupdate clientoverride 324 router bgp 234
system autoupdate override 325 sessions between two standalone FortiGate units
system autoupdate push-update 326 434
system autoupdate schedule 328 TCP sessions between two standalone FortiGate
system autoupdate tunneling 330 units 434
system cmdb 657 syncinterval
system fortianalyzer 340 system global 356
system interface 382 sysgrp
system modem 395 access group for system accprofile 313
system performance 670 system accprofile 313
system snmp community 444 syslogd filter
system snmp sysinfo 446 log 191
system wireless mac-filter 451 syslogd setting
user local 476 log 216
vpn l2tp 533 syslogd2 setting
vpn pptp 535 log 216
webfilter bword 549, 550 syslogd3 setting
webfilter ftgd-local-rating 556 log 216
webfilter ftgd-ovrd 557 system admin list 652
webfilter urlfilter 559
system admin status 653
stop
system checksum 656
execute ha synchronize 583
system cmdb status 657
store-blocked
antivirus quarantine 76 system dashboard 658
store-heuristic system fortianalyzer-connectivity 659
antivirus quarantine 76 system fortiguard-log-service status 660
store-infected system fortiguard-service status 661
antivirus quarantine 76 system ha status 662
stpforward system info admin ssh 668
system interface 382 system info admin status 669
strict-capability-match system performance status 670
router bgp neighbor 239
strong encryption 356 T
strong-crypto
tag
system global 356
router ospf redistribute 269
stub-type router ospf summary-address 270
router ospf area 263
TCP port, session helpers 433
style
TCP session synchronization
log report summary-layout 214
between two standalone FortiGate units 434
subnet
tcp-halfclose-timer
firewall address 82
system global 356
subst
tcp-option
system interface 382
system global 356
substitute
tcp-portrange
router ospf area range 263
firewall service custom 152
substitute-dst-mac
technical support 19
system interface 382
telnet, execute 614

FortiGate CLI Version 3.0 MR6 Reference

696 01-30006-0015-20080205
Index

time troubleshooting
execute 615 memory low 250
system autoupdate schedule 328 trusthost1, trusthost2, trusthost3
time synchronization 356 system admin 317
time zone 356 ttl
Timeout execute ping-options 600
IPSec interface mode 641 ttl-threshold
timeout router multicast interface 252
execute ping-options 600 tunnel, GRE
system session-ttl 439 system 358
timeout-timer tunnel-endip 540
router rip 279 tunnel-startip
timestamp 356 vpn ssl settings 540
time-to-live (TTL) 441 type
timezone firewall address 82
system global 356 firewall vip 160
title log report period 209
log report definition 205 log report schedule 210
top1 router ospf area 263
log report scope 212 system dhcp reserved-address 335
top2 user ldap 474
log report scope 212 user local 476
vpn ipsec phase1 508
topN
vpn ipsec phase1-interface 516
log report summary-layout 214
webfilter ftdg-ovrd 557
topology status webfilter urlfilter 559
get 637
Type of Service (TOS) 356
topology viewer status 637
type of service (TOS)
topology, gui 167 RFC 1583 448
tos RFC 791 448
execute ping-options 600
tos-based-priority U
system 448
tp-mc-skip-policy UDP 325
system global 356 udp-portrange
traceroute, execute 616 firewall service custom 152
traffic uncompnestlimit
log filter 194 antivirus service 79
Traffic Indication Messages (TIM) uncompsizelimit
system wireless settings 452 antivirus service 79
traffic shaping 379 undefinedhost
trafficfilter firewall ipmacbinding setting 95
log 218 unicast 283
trafficshaping uninterruptable-upgrade
firewall policy 110 system ha 366
transmit-delay unset 35
router ospf area virtual-link 264 unsuppress-map
router ospf interface 269 router bgp neighbor 239
transparent mode, changing 441 update index
trap-v1-lport system cmdb status 657
system snmp community 445 update-av, execute 617
trap-v1-rport updategrp
system snmp community 445 system accprofile 313
trap-v1-status update-ips, execute 618
system snmp community 445 update-now, execute 619
trap-v2c-lport update-source
system snmp community 445 router bgp neighbor 239
trap-v2c-rport update-timer
system snmp community 445 router rip 280
trap-v2c-status updgrp
system snmp community 445 access group for system accprofile 313
upd-vd-license, execute 620

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 697
 Index

upload usrgrp
log disk setting 197 vpn ipsec phase1 508, 516
log report output 207 vpn l2tp 533
upload-delete vpn pptp 535
log report output 207
upload-delete-files V
log disk setting 197
validate-reply
upload-destination
execute ping-options 600
log disk setting 197
valid-life-time
upload-dir
system interface config ipv6-prefix 386
log report output 207
vcluster2
uploaddir
system ha 367
log disk setting 197
VDOM
upload-gzipped
management 316
log report output 208
vdom 355
upload-ip
configure VDOMs 60
log report output 208
system admin 318
uploadip system ha 366
log disk setting 197 system interface 383
uploadpass vdom-link
log disk setting 197 system 449
upload-password ver-1
log report output 208 system fortianalyzer 340
uploadport version
log disk setting 197 IGMP 253
uploadsched router multicast interface igmp 253
log disk setting 197 router rip 280
upload-server-type system cmdb status 657
log report output 208 view-settings
uploadtime execute ping-options 600
log disk setting 197 violation
uploadtype log filter 194
log disk setting 197 vip
uploaduser firewall 155
log disk setting 197 vip group, grouping vip, vipgrp 164
upload-username VIP range 356
log report output 208 vip-arp-range
uploadzip system global 356
log disk setting 197 virtual clustering 360
url Virtual Domain (VDOM) 620
webfilter ftgd-ovrd 557
virtual IP 155
url-filter NAT 155
log filter 194 PAT 155
urlfilter port address translation 155
webfilter 559 virtual-links
usb-disk, execute 621 router info ospf 648
user 457 virus
webfilter ftgd-ovrd 558 log filter 194
user-group vlanforward
webfilter ftgd-ovrd 558 system interface 383
username vlanid
alertemail setting 65 system interface 383
status modem 395 vpn 487
system alertemail 321
vpn certificate ca
system autoupdate tunneling 330
execute 622
system bug-report 333
system interface 383 vpn certificate crl
user ldap 474 execute 624
username-smtp vpn certificate local, execute 625
system bug-report 333 VPN configuration 313
using the CLI 27 vpn sslvpn del-tunnel, execute 629

FortiGate CLI Version 3.0 MR6 Reference

698 01-30006-0015-20080205
Index

vpngrp wifi-mac-filter
access group for system accprofile 313 system interface 384
system accprofile 313 wifi-passphrase
vpntunnel system interface 384
firewall policy 110 wifi-radius-server
system interface 384
W wifi-rts_threshold
system interface 384
web
wifi-security
log filter 194
system interface 385
web browser support 356
wifi-ssid
web filtering, blocked pages 404 system interface 385
web-content wildcard
log filter 194 router access-list 224
webfilter 547 system admin 318
webfilter configuration 313 wildcard pattern matching 48
web-filter-activex Windows Active Directory
log filter 194 configuring FSAE 467
web-filter-applet refresh user group info via FSAE 579
log filter 194 winny
webfilter-cache firewall profile 139
system fortiguard 344 winny-limit 139
webfilter-cache-ttl wins-ip
system fortiguard 344 system interface 384
web-filter-cookie wins-server
log filter 194 system dhcp server 337
webfilter-status wireless interface access control 384
system fortiguard 344 wireless mac-filter
webfilter-timeout system 451
system fortiguard 344 wireless settings
webgrp system 452
access group for system accprofile 313 wireless, synchronize 452
system accprofile 313
word boundary
weblists Perl regular expressions 48
execute ha synchronize 583
webtrends filter
log 191
X
webtrends setting xauthtype
log 220 vpn ipsec phase1 508
webwordthreshold 139 vpn ipsec phase1-interface 516
weight
router bgp neighbor 239 Y
system ha 366
yahoo
WEP key 384, 453
firewall profile 140
where imp2p old-version 173
spamfilter bword 297 imp2p policy 174
wifi-acl yahoo-user
system interface 384 imp2p 175
wifi-broadcast_ssid
system interface 384
Z
wifi-fragment_threshold
system interface 384 zone, system 455
wifi-key
system interface 384

FortiGate CLI Version 3.0 MR6 Reference

01-30006-0015-20080205 699
 Index

FortiGate CLI Version 3.0 MR6 Reference

700 01-30006-0015-20080205
www.fortinet.com
www.fortinet.com