Fortinet white logo
Fortinet white logo

CLI Reference

config system netflow

config system netflow

Configure NetFlow.

config system netflow
    Description: Configure NetFlow.
    set active-flow-timeout {integer}
    config collectors
        Description: Netflow collectors.
        edit <id>
            set collector-ip {string}
            set collector-port {integer}
            set interface {string}
            set interface-select-method [auto|sdwan|...]
            set source-ip {string}
            set source-ip-interface {string}
            set vrf-select {integer}
        next
    end
    config exclusion-filters
        Description: Exclusion filters
        edit <id>
            set destination-ip {user}
            set destination-port {user}
            set protocol {integer}
            set source-ip {user}
            set source-port {user}
        next
    end
    set inactive-flow-timeout {integer}
    set session-cache-size [min|default|...]
    set template-tx-counter {integer}
    set template-tx-timeout {integer}
end

config system netflow

Parameter

Description

Type

Size

Default

active-flow-timeout

Timeout to report active flows (60 - 3600 sec, default = 1800).

integer

Minimum value: 60 Maximum value: 3600

1800

inactive-flow-timeout

Timeout for periodic report of finished flows (10 - 600 sec, default = 15).

integer

Minimum value: 10 Maximum value: 600

15

session-cache-size

Maximum RAM usage allowed for Netflow session cache.

option

-

default

Option

Description

min

Up to 0.5% of system RAM.

default

Up to 1% of system RAM.

max

Up to 2% of system RAM.

template-tx-counter

Counter of flowset records before resending a template flowset record.

integer

Minimum value: 10 Maximum value: 6000

20

template-tx-timeout

Timeout for periodic template flowset transmission (60 - 86400 sec, default = 1800).

integer

Minimum value: 60 Maximum value: 86400

1800

config collectors

Parameter

Description

Type

Size

Default

collector-ip

Collector IP.

string

Maximum length: 63

collector-port

NetFlow collector port number.

integer

Minimum value: 0 Maximum value: 65535

2055

id

ID.

integer

Minimum value: 1 Maximum value: 6

0

interface

Specify outgoing interface to reach server.

string

Maximum length: 15

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.

source-ip

Source IP address for communication with the NetFlow agent.

string

Maximum length: 63

source-ip-interface

Name of the interface used to determine the source IP for exporting packets.

string

Maximum length: 15

vrf-select

VRF ID used for connection to server.

integer

Minimum value: 0 Maximum value: 511

0

config exclusion-filters

Parameter

Description

Type

Size

Default

destination-ip

Session destination address.

user

Not Specified

destination-port

Session destination port number or range.

user

Not Specified

id

Filter ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

protocol

Session IP protocol (0 - 255, default = 255, meaning any).

integer

Minimum value: 0 Maximum value: 255

255

source-ip

Session source address.

user

Not Specified

source-port

Session source port number or range.

user

Not Specified

config system netflow

config system netflow

Configure NetFlow.

config system netflow
    Description: Configure NetFlow.
    set active-flow-timeout {integer}
    config collectors
        Description: Netflow collectors.
        edit <id>
            set collector-ip {string}
            set collector-port {integer}
            set interface {string}
            set interface-select-method [auto|sdwan|...]
            set source-ip {string}
            set source-ip-interface {string}
            set vrf-select {integer}
        next
    end
    config exclusion-filters
        Description: Exclusion filters
        edit <id>
            set destination-ip {user}
            set destination-port {user}
            set protocol {integer}
            set source-ip {user}
            set source-port {user}
        next
    end
    set inactive-flow-timeout {integer}
    set session-cache-size [min|default|...]
    set template-tx-counter {integer}
    set template-tx-timeout {integer}
end

config system netflow

Parameter

Description

Type

Size

Default

active-flow-timeout

Timeout to report active flows (60 - 3600 sec, default = 1800).

integer

Minimum value: 60 Maximum value: 3600

1800

inactive-flow-timeout

Timeout for periodic report of finished flows (10 - 600 sec, default = 15).

integer

Minimum value: 10 Maximum value: 600

15

session-cache-size

Maximum RAM usage allowed for Netflow session cache.

option

-

default

Option

Description

min

Up to 0.5% of system RAM.

default

Up to 1% of system RAM.

max

Up to 2% of system RAM.

template-tx-counter

Counter of flowset records before resending a template flowset record.

integer

Minimum value: 10 Maximum value: 6000

20

template-tx-timeout

Timeout for periodic template flowset transmission (60 - 86400 sec, default = 1800).

integer

Minimum value: 60 Maximum value: 86400

1800

config collectors

Parameter

Description

Type

Size

Default

collector-ip

Collector IP.

string

Maximum length: 63

collector-port

NetFlow collector port number.

integer

Minimum value: 0 Maximum value: 65535

2055

id

ID.

integer

Minimum value: 1 Maximum value: 6

0

interface

Specify outgoing interface to reach server.

string

Maximum length: 15

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.

source-ip

Source IP address for communication with the NetFlow agent.

string

Maximum length: 63

source-ip-interface

Name of the interface used to determine the source IP for exporting packets.

string

Maximum length: 15

vrf-select

VRF ID used for connection to server.

integer

Minimum value: 0 Maximum value: 511

0

config exclusion-filters

Parameter

Description

Type

Size

Default

destination-ip

Session destination address.

user

Not Specified

destination-port

Session destination port number or range.

user

Not Specified

id

Filter ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

protocol

Session IP protocol (0 - 255, default = 255, meaning any).

integer

Minimum value: 0 Maximum value: 255

255

source-ip

Session source address.

user

Not Specified

source-port

Session source port number or range.

user

Not Specified