Fortinet Document Library

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

CLI Reference

config system fortiguard

Configure FortiGuard services.

config system fortiguard

Description: Configure FortiGuard services.

set fortiguard-anycast [enable|disable]

set fortiguard-anycast-source [fortinet|aws|...]

set protocol [udp|http|...]

set port [8888|53|...]

set load-balance-servers {integer}

set auto-join-forticloud [enable|disable]

set update-server-location [usa|any]

set sandbox-region {string}

set update-ffdb [enable|disable]

set update-uwdb [enable|disable]

set update-extdb [enable|disable]

set update-build-proxy [enable|disable]

set persistent-connection [enable|disable]

set antispam-force-off [enable|disable]

set antispam-cache [enable|disable]

set antispam-cache-ttl {integer}

set antispam-cache-mpercent {integer}

set antispam-license {integer}

set antispam-expiration {integer}

set antispam-timeout {integer}

set outbreak-prevention-force-off [enable|disable]

set outbreak-prevention-cache [enable|disable]

set outbreak-prevention-cache-ttl {integer}

set outbreak-prevention-cache-mpercent {integer}

set outbreak-prevention-license {integer}

set outbreak-prevention-expiration {integer}

set outbreak-prevention-timeout {integer}

set webfilter-force-off [enable|disable]

set webfilter-cache [enable|disable]

set webfilter-cache-ttl {integer}

set webfilter-license {integer}

set webfilter-expiration {integer}

set webfilter-timeout {integer}

set sdns-server-ip {user}

set sdns-server-port {integer}

set anycast-sdns-server-ip {ipv4-address}

set anycast-sdns-server-port {integer}

set sdns-options {option1}, {option2}, ...

set source-ip {ipv4-address}

set source-ip6 {ipv6-address}

set proxy-server-ip {ipv4-address}

set proxy-server-port {integer}

set proxy-username {string}

set proxy-password {password}

set videofilter-license {integer}

set videofilter-expiration {integer}

set ddns-server-ip {ipv4-address}

set ddns-server-ip6 {ipv6-address}

set ddns-server-port {integer}

set interface-select-method [auto|sdwan|...]

set interface {string}

end

config system fortiguard

Parameter

Description

Type

Size

Default

fortiguard-anycast

Enable/disable use of FortiGuard's Anycast network.

option

-

enable

 

Option

Description

enable

Enable use of FortiGuard's Anycast network.

disable

Disable use of FortiGuard's Anycast network.

fortiguard-anycast-source

Configure which of Fortinet's servers to provide FortiGuard services in FortiGuard's anycast network. Default is Fortinet.

option

-

fortinet

 

Option

Description

fortinet

Use Fortinet's servers to provide FortiGuard services in FortiGuard's anycast network.

aws

Use Fortinet's AWS servers to provide FortiGuard services in FortiGuard's anycast network.

debug

Use Fortinet's internal test servers to provide FortiGuard services in FortiGuard's anycast network.

protocol

Protocol used to communicate with the FortiGuard servers.

option

-

https

 

Option

Description

udp

UDP for server communication (for use by FortiGuard or FortiManager).

http

HTTP for server communication (for use only by FortiManager).

https

HTTPS for server communication (for use by FortiGuard or FortiManager).

port

Port used to communicate with the FortiGuard servers.

option

-

443

 

Option

Description

8888

port 8888 for server communication.

53

port 53 for server communication.

80

port 80 for server communication.

443

port 443 for server communication.

load-balance-servers

Number of servers to alternate between as first FortiGuard option.

integer

Minimum value: 1 Maximum value: 266

1

auto-join-forticloud *

Automatically connect to and login to FortiCloud.

option

-

enable

 

Option

Description

enable

Enable automatic connection and login to FortiCloud.

disable

Disable automatic connection and login to FortiCloud.

update-server-location

Signature update server location.

option

-

any

 

Option

Description

usa

FGD servers in United States.

any

FGD servers in any location.

sandbox-region

Cloud sandbox region.

string

Maximum length: 63

update-ffdb

Enable/disable Internet Service Database update.

option

-

enable

 

Option

Description

enable

Enable Internet Service Database update.

disable

Disable Internet Service Database update.

update-uwdb

Enable/disable allowlist update.

option

-

enable

 

Option

Description

enable

Enable allowlist update.

disable

Disable allowlist update.

update-extdb

Enable/disable external resource update.

option

-

enable

 

Option

Description

enable

Enable external resource update.

disable

Disable external resource update.

update-build-proxy

Enable/disable proxy dictionary rebuild.

option

-

enable

 

Option

Description

enable

Enable proxy dictionary rebuild.

disable

Disable proxy dictionary rebuild.

persistent-connection

Enable/disable use of persistent connection to receive update notification from FortiGuard.

option

-

disable

 

Option

Description

enable

Enable persistent connection to receive update notification from FortiGuard.

disable

Disable persistent connection to receive update notification from FortiGuard.

antispam-force-off

Enable/disable turning off the FortiGuard antispam service.

option

-

disable

 

Option

Description

enable

Turn off the FortiGuard antispam service.

disable

Allow the FortiGuard antispam service.

antispam-cache

Enable/disable FortiGuard antispam request caching. Uses a small amount of memory but improves performance.

option

-

enable

 

Option

Description

enable

Enable FortiGuard antispam request caching.

disable

Disable FortiGuard antispam request caching.

antispam-cache-ttl

Time-to-live for antispam cache entries in seconds . Lower times reduce the cache size. Higher times may improve performance since the cache will have more entries.

integer

Minimum value: 300 Maximum value: 86400

1800

antispam-cache-mpercent

Maximum percent of FortiGate memory the antispam cache is allowed to use .

integer

Minimum value: 1 Maximum value: 15

2

antispam-license

Interval of time between license checks for the FortiGuard antispam contract.

integer

Minimum value: 0 Maximum value: 4294967295

4294967295

antispam-expiration

Expiration date of the FortiGuard antispam contract.

integer

Minimum value: 0 Maximum value: 4294967295

0

antispam-timeout

Antispam query time out .

integer

Minimum value: 1 Maximum value: 30

7

outbreak-prevention-force-off

Turn off FortiGuard Virus Outbreak Prevention service.

option

-

disable

 

Option

Description

enable

Turn off FortiGuard antivirus service.

disable

Allow the FortiGuard antivirus service.

outbreak-prevention-cache

Enable/disable FortiGuard Virus Outbreak Prevention cache.

option

-

enable

 

Option

Description

enable

Enable FortiGuard antivirus caching.

disable

Disable FortiGuard antivirus caching.

outbreak-prevention-cache-ttl

Time-to-live for FortiGuard Virus Outbreak Prevention cache entries .

integer

Minimum value: 300 Maximum value: 86400

300

outbreak-prevention-cache-mpercent

Maximum percent of memory FortiGuard Virus Outbreak Prevention cache can use .

integer

Minimum value: 1 Maximum value: 15

2

outbreak-prevention-license

Interval of time between license checks for FortiGuard Virus Outbreak Prevention contract.

integer

Minimum value: 0 Maximum value: 4294967295

4294967295

outbreak-prevention-expiration

Expiration date of FortiGuard Virus Outbreak Prevention contract.

integer

Minimum value: 0 Maximum value: 4294967295

0

outbreak-prevention-timeout

FortiGuard Virus Outbreak Prevention time out .

integer

Minimum value: 1 Maximum value: 30

7

webfilter-force-off

Enable/disable turning off the FortiGuard web filtering service.

option

-

disable

 

Option

Description

enable

Turn off the FortiGuard web filtering service.

disable

Allow the FortiGuard web filtering service to operate.

webfilter-cache

Enable/disable FortiGuard web filter caching.

option

-

enable

 

Option

Description

enable

Enable FortiGuard web filter caching.

disable

Disable FortiGuard web filter caching.

webfilter-cache-ttl

Time-to-live for web filter cache entries in seconds .

integer

Minimum value: 300 Maximum value: 86400

3600

webfilter-license

Interval of time between license checks for the FortiGuard web filter contract.

integer

Minimum value: 0 Maximum value: 4294967295

4294967295

webfilter-expiration

Expiration date of the FortiGuard web filter contract.

integer

Minimum value: 0 Maximum value: 4294967295

0

webfilter-timeout

Web filter query time out .

integer

Minimum value: 1 Maximum value: 30

15

sdns-server-ip

IP address of the FortiGuard DNS rating server.

user

Not Specified

sdns-server-port

Port to connect to on the FortiGuard DNS rating server.

integer

Minimum value: 1 Maximum value: 65535

53

anycast-sdns-server-ip

IP address of the FortiGuard anycast DNS rating server.

ipv4-address

Not Specified

0.0.0.0

anycast-sdns-server-port

Port to connect to on the FortiGuard anycast DNS rating server.

integer

Minimum value: 1 Maximum value: 65535

853

sdns-options

Customization options for the FortiGuard DNS service.

option

-

 

Option

Description

include-question-section

Include DNS question section in the FortiGuard DNS setup message.

source-ip

Source IPv4 address used to communicate with FortiGuard.

ipv4-address

Not Specified

0.0.0.0

source-ip6

Source IPv6 address used to communicate with FortiGuard.

ipv6-address

Not Specified

::

proxy-server-ip

IP address of the proxy server.

ipv4-address

Not Specified

0.0.0.0

proxy-server-port

Port used to communicate with the proxy server.

integer

Minimum value: 0 Maximum value: 65535

0

proxy-username

Proxy user name.

string

Maximum length: 64

proxy-password

Proxy user password.

password

Not Specified

videofilter-license

Interval of time between license checks for the FortiGuard video filter contract.

integer

Minimum value: 0 Maximum value: 4294967295

4294967295

videofilter-expiration

Expiration date of the FortiGuard video filter contract.

integer

Minimum value: 0 Maximum value: 4294967295

0

ddns-server-ip

IP address of the FortiDDNS server.

ipv4-address

Not Specified

0.0.0.0

ddns-server-ip6

IPv6 address of the FortiDDNS server.

ipv6-address

Not Specified

::

ddns-server-port

Port used to communicate with FortiDDNS servers.

integer

Minimum value: 1 Maximum value: 65535

443

interface-select-method

Specify how to select outgoing interface to reach server.

option

-

auto

 

Option

Description

auto

Set outgoing interface automatically.

sdwan

Set outgoing interface by SD-WAN or policy routing rules.

specify

Set outgoing interface manually.

interface

Specify outgoing interface to reach server.

string

Maximum length: 15

* This parameter may not exist in some models.

config system fortiguard

Configure FortiGuard services.

config system fortiguard

Description: Configure FortiGuard services.

set fortiguard-anycast [enable|disable]

set fortiguard-anycast-source [fortinet|aws|...]

set protocol [udp|http|...]

set port [8888|53|...]

set load-balance-servers {integer}

set auto-join-forticloud [enable|disable]

set update-server-location [usa|any]

set sandbox-region {string}

set update-ffdb [enable|disable]

set update-uwdb [enable|disable]

set update-extdb [enable|disable]

set update-build-proxy [enable|disable]

set persistent-connection [enable|disable]

set antispam-force-off [enable|disable]

set antispam-cache [enable|disable]

set antispam-cache-ttl {integer}

set antispam-cache-mpercent {integer}

set antispam-license {integer}

set antispam-expiration {integer}

set antispam-timeout {integer}

set outbreak-prevention-force-off [enable|disable]

set outbreak-prevention-cache [enable|disable]

set outbreak-prevention-cache-ttl {integer}

set outbreak-prevention-cache-mpercent {integer}

set outbreak-prevention-license {integer}

set outbreak-prevention-expiration {integer}

set outbreak-prevention-timeout {integer}

set webfilter-force-off [enable|disable]

set webfilter-cache [enable|disable]

set webfilter-cache-ttl {integer}

set webfilter-license {integer}

set webfilter-expiration {integer}

set webfilter-timeout {integer}

set sdns-server-ip {user}

set sdns-server-port {integer}

set anycast-sdns-server-ip {ipv4-address}

set anycast-sdns-server-port {integer}

set sdns-options {option1}, {option2}, ...

set source-ip {ipv4-address}

set source-ip6 {ipv6-address}

set proxy-server-ip {ipv4-address}

set proxy-server-port {integer}

set proxy-username {string}

set proxy-password {password}

set videofilter-license {integer}

set videofilter-expiration {integer}

set ddns-server-ip {ipv4-address}

set ddns-server-ip6 {ipv6-address}

set ddns-server-port {integer}

set interface-select-method [auto|sdwan|...]

set interface {string}

end

config system fortiguard

Parameter

Description

Type

Size

Default

fortiguard-anycast

Enable/disable use of FortiGuard's Anycast network.

option

-

enable

 

Option

Description

enable

Enable use of FortiGuard's Anycast network.

disable

Disable use of FortiGuard's Anycast network.

fortiguard-anycast-source

Configure which of Fortinet's servers to provide FortiGuard services in FortiGuard's anycast network. Default is Fortinet.

option

-

fortinet

 

Option

Description

fortinet

Use Fortinet's servers to provide FortiGuard services in FortiGuard's anycast network.

aws

Use Fortinet's AWS servers to provide FortiGuard services in FortiGuard's anycast network.

debug

Use Fortinet's internal test servers to provide FortiGuard services in FortiGuard's anycast network.

protocol

Protocol used to communicate with the FortiGuard servers.

option

-

https

 

Option

Description

udp

UDP for server communication (for use by FortiGuard or FortiManager).

http

HTTP for server communication (for use only by FortiManager).

https

HTTPS for server communication (for use by FortiGuard or FortiManager).

port

Port used to communicate with the FortiGuard servers.

option

-

443

 

Option

Description

8888

port 8888 for server communication.

53

port 53 for server communication.

80

port 80 for server communication.

443

port 443 for server communication.

load-balance-servers

Number of servers to alternate between as first FortiGuard option.

integer

Minimum value: 1 Maximum value: 266

1

auto-join-forticloud *

Automatically connect to and login to FortiCloud.

option

-

enable

 

Option

Description

enable

Enable automatic connection and login to FortiCloud.

disable

Disable automatic connection and login to FortiCloud.

update-server-location

Signature update server location.

option

-

any

 

Option

Description

usa

FGD servers in United States.

any

FGD servers in any location.

sandbox-region

Cloud sandbox region.

string

Maximum length: 63

update-ffdb

Enable/disable Internet Service Database update.

option

-

enable

 

Option

Description

enable

Enable Internet Service Database update.

disable

Disable Internet Service Database update.

update-uwdb

Enable/disable allowlist update.

option

-

enable

 

Option

Description

enable

Enable allowlist update.

disable

Disable allowlist update.

update-extdb

Enable/disable external resource update.

option

-

enable

 

Option

Description

enable

Enable external resource update.

disable

Disable external resource update.

update-build-proxy

Enable/disable proxy dictionary rebuild.

option

-

enable

 

Option

Description

enable

Enable proxy dictionary rebuild.

disable

Disable proxy dictionary rebuild.

persistent-connection

Enable/disable use of persistent connection to receive update notification from FortiGuard.

option

-

disable

 

Option

Description

enable

Enable persistent connection to receive update notification from FortiGuard.

disable

Disable persistent connection to receive update notification from FortiGuard.

antispam-force-off

Enable/disable turning off the FortiGuard antispam service.

option

-

disable

 

Option

Description

enable

Turn off the FortiGuard antispam service.

disable

Allow the FortiGuard antispam service.

antispam-cache

Enable/disable FortiGuard antispam request caching. Uses a small amount of memory but improves performance.

option

-

enable

 

Option

Description

enable

Enable FortiGuard antispam request caching.

disable

Disable FortiGuard antispam request caching.

antispam-cache-ttl

Time-to-live for antispam cache entries in seconds . Lower times reduce the cache size. Higher times may improve performance since the cache will have more entries.

integer

Minimum value: 300 Maximum value: 86400

1800

antispam-cache-mpercent

Maximum percent of FortiGate memory the antispam cache is allowed to use .

integer

Minimum value: 1 Maximum value: 15

2

antispam-license

Interval of time between license checks for the FortiGuard antispam contract.

integer

Minimum value: 0 Maximum value: 4294967295

4294967295

antispam-expiration

Expiration date of the FortiGuard antispam contract.

integer

Minimum value: 0 Maximum value: 4294967295

0

antispam-timeout

Antispam query time out .

integer

Minimum value: 1 Maximum value: 30

7

outbreak-prevention-force-off

Turn off FortiGuard Virus Outbreak Prevention service.

option

-

disable

 

Option

Description

enable

Turn off FortiGuard antivirus service.

disable

Allow the FortiGuard antivirus service.

outbreak-prevention-cache

Enable/disable FortiGuard Virus Outbreak Prevention cache.

option

-

enable

 

Option

Description

enable

Enable FortiGuard antivirus caching.

disable

Disable FortiGuard antivirus caching.

outbreak-prevention-cache-ttl

Time-to-live for FortiGuard Virus Outbreak Prevention cache entries .

integer

Minimum value: 300 Maximum value: 86400

300

outbreak-prevention-cache-mpercent

Maximum percent of memory FortiGuard Virus Outbreak Prevention cache can use .

integer

Minimum value: 1 Maximum value: 15

2

outbreak-prevention-license

Interval of time between license checks for FortiGuard Virus Outbreak Prevention contract.

integer

Minimum value: 0 Maximum value: 4294967295

4294967295

outbreak-prevention-expiration

Expiration date of FortiGuard Virus Outbreak Prevention contract.

integer

Minimum value: 0 Maximum value: 4294967295

0

outbreak-prevention-timeout

FortiGuard Virus Outbreak Prevention time out .

integer

Minimum value: 1 Maximum value: 30

7

webfilter-force-off

Enable/disable turning off the FortiGuard web filtering service.

option

-

disable

 

Option

Description

enable

Turn off the FortiGuard web filtering service.

disable

Allow the FortiGuard web filtering service to operate.

webfilter-cache

Enable/disable FortiGuard web filter caching.

option

-

enable

 

Option

Description

enable

Enable FortiGuard web filter caching.

disable

Disable FortiGuard web filter caching.

webfilter-cache-ttl

Time-to-live for web filter cache entries in seconds .

integer

Minimum value: 300 Maximum value: 86400

3600

webfilter-license

Interval of time between license checks for the FortiGuard web filter contract.

integer

Minimum value: 0 Maximum value: 4294967295

4294967295

webfilter-expiration

Expiration date of the FortiGuard web filter contract.

integer

Minimum value: 0 Maximum value: 4294967295

0

webfilter-timeout

Web filter query time out .

integer

Minimum value: 1 Maximum value: 30

15

sdns-server-ip

IP address of the FortiGuard DNS rating server.

user

Not Specified

sdns-server-port

Port to connect to on the FortiGuard DNS rating server.

integer

Minimum value: 1 Maximum value: 65535

53

anycast-sdns-server-ip

IP address of the FortiGuard anycast DNS rating server.

ipv4-address

Not Specified

0.0.0.0

anycast-sdns-server-port

Port to connect to on the FortiGuard anycast DNS rating server.

integer

Minimum value: 1 Maximum value: 65535

853

sdns-options

Customization options for the FortiGuard DNS service.

option

-

 

Option

Description

include-question-section

Include DNS question section in the FortiGuard DNS setup message.

source-ip

Source IPv4 address used to communicate with FortiGuard.

ipv4-address

Not Specified

0.0.0.0

source-ip6

Source IPv6 address used to communicate with FortiGuard.

ipv6-address

Not Specified

::

proxy-server-ip

IP address of the proxy server.

ipv4-address

Not Specified

0.0.0.0

proxy-server-port

Port used to communicate with the proxy server.

integer

Minimum value: 0 Maximum value: 65535

0

proxy-username

Proxy user name.

string

Maximum length: 64

proxy-password

Proxy user password.

password

Not Specified

videofilter-license

Interval of time between license checks for the FortiGuard video filter contract.

integer

Minimum value: 0 Maximum value: 4294967295

4294967295

videofilter-expiration

Expiration date of the FortiGuard video filter contract.

integer

Minimum value: 0 Maximum value: 4294967295

0

ddns-server-ip

IP address of the FortiDDNS server.

ipv4-address

Not Specified

0.0.0.0

ddns-server-ip6

IPv6 address of the FortiDDNS server.

ipv6-address

Not Specified

::

ddns-server-port

Port used to communicate with FortiDDNS servers.

integer

Minimum value: 1 Maximum value: 65535

443

interface-select-method

Specify how to select outgoing interface to reach server.

option

-

auto

 

Option

Description

auto

Set outgoing interface automatically.

sdwan

Set outgoing interface by SD-WAN or policy routing rules.

specify

Set outgoing interface manually.

interface

Specify outgoing interface to reach server.

string

Maximum length: 15

* This parameter may not