Fortinet white logo
Fortinet white logo

CLI Reference

config switch-controller flow-tracking

config switch-controller flow-tracking

Note

This command is available for model(s): FortiGate 1000D, FortiGate 1000F, FortiGate 1001F, FortiGate 100F, FortiGate 101F, FortiGate 1100E, FortiGate 1101E, FortiGate 120G, FortiGate 121G, FortiGate 1800F, FortiGate 1801F, FortiGate 2000E, FortiGate 200E, FortiGate 200F, FortiGate 201E, FortiGate 201F, FortiGate 2200E, FortiGate 2201E, FortiGate 2500E, FortiGate 2600F, FortiGate 2601F, FortiGate 3000D, FortiGate 3000F, FortiGate 3001F, FortiGate 300E, FortiGate 301E, FortiGate 3100D, FortiGate 3200D, FortiGate 3200F, FortiGate 3201F, FortiGate 3300E, FortiGate 3301E, FortiGate 3400E, FortiGate 3401E, FortiGate 3500F, FortiGate 3501F, FortiGate 3600E, FortiGate 3601E, FortiGate 3700D, FortiGate 3700F, FortiGate 3701F, FortiGate 3960E, FortiGate 3980E, FortiGate 400E Bypass, FortiGate 400E, FortiGate 400F, FortiGate 401E, FortiGate 401F, FortiGate 40F 3G4G, FortiGate 40F, FortiGate 4200F, FortiGate 4201F, FortiGate 4400F, FortiGate 4401F, FortiGate 500E, FortiGate 501E, FortiGate 600E, FortiGate 600F, FortiGate 601E, FortiGate 601F, FortiGate 60F, FortiGate 61F, FortiGate 70F, FortiGate 71F, FortiGate 800D, FortiGate 80F Bypass, FortiGate 80F DSL, FortiGate 80F-POE, FortiGate 80F, FortiGate 81F, FortiGate 900D, FortiGate 900G, FortiGate 901G, FortiGate 90G, FortiGate 91G, FortiGate VM ARM64 for Azure, FortiGate VM ARM64 for GCP BYOL, FortiGate VM ARM64 for OCI BYOL, FortiGate VM for Aliyun PAYG, FortiGate VM for AWS PAYG, FortiGate VM for Azure BYOL, FortiGate VM for Azure PAYG, FortiGate VM for GCP BYOL, FortiGate VM for OPC BYOL, FortiGate VM64, FortiGateRugged 60F 3G4G, FortiGateRugged 60F, FortiGateRugged 70F 3G4G, FortiGateRugged 70F, FortiWiFi 40F 3G4G, FortiWiFi 40F, FortiWiFi 60F, FortiWiFi 61F, FortiWiFi 80F 2R 3G4G DSL, FortiWiFi 80F 2R, FortiWiFi 81F 2R 3G4G DSL, FortiWiFi 81F 2R 3G4G-POE, FortiWiFi 81F 2R-POE, FortiWiFi 81F 2R.

It is not available for: FortiGate 5001E1, FortiGate 5001E.

Configure FortiSwitch flow tracking and export via ipfix/netflow.

config switch-controller flow-tracking
    Description: Configure FortiSwitch flow tracking and export via ipfix/netflow.
    config aggregates
        Description: Configure aggregates in which all traffic sessions matching the IP Address will be grouped into the same flow.
        edit <id>
            set ip {ipv4-classnet}
        next
    end
    config collectors
        Description: Configure collectors for the flow.
        edit <name>
            set ip {ipv4-address-any}
            set port {integer}
            set transport [udp|tcp|...]
        next
    end
    set format [netflow1|netflow5|...]
    set level [vlan|ip|...]
    set max-export-pkt-size {integer}
    set sample-mode [local|perimeter|...]
    set sample-rate {integer}
    set template-export-period {integer}
    set timeout-general {integer}
    set timeout-icmp {integer}
    set timeout-max {integer}
    set timeout-tcp {integer}
    set timeout-tcp-fin {integer}
    set timeout-tcp-rst {integer}
    set timeout-udp {integer}
end

config switch-controller flow-tracking

Parameter

Description

Type

Size

Default

format

Configure flow tracking protocol.

option

-

netflow9

Option

Description

netflow1

Netflow version 1 sampling.

netflow5

Netflow version 5 sampling.

netflow9

Netflow version 9 sampling.

ipfix

Ipfix sampling.

level

Configure flow tracking level.

option

-

ip

Option

Description

vlan

Collects srcip/dstip/srcport/dstport/protocol/tos/vlan from the sample packet.

ip

Collects srcip/dstip from the sample packet.

port

Collects srcip/dstip/srcport/dstport/protocol from the sample packet.

proto

Collects srcip/dstip/protocol from the sample packet.

mac

Collects smac/dmac from the sample packet.

max-export-pkt-size

Configure flow max export packet size.

integer

Minimum value: 512 Maximum value: 9216

512

sample-mode

Configure sample mode for the flow tracking.

option

-

perimeter

Option

Description

local

Set local mode which samples on the specific switch port.

perimeter

Set perimeter mode which samples on all switch fabric ports and fortilink port at the ingress.

device-ingress

Set device -ingress mode which samples across all switch ports at the ingress.

sample-rate

Configure sample rate for the perimeter and device-ingress sampling.

integer

Minimum value: 0 Maximum value: 99999

512

template-export-period

Configure template export period.

integer

Minimum value: 1 Maximum value: 60

5

timeout-general

Configure flow session general timeout.

integer

Minimum value: 60 Maximum value: 604800

3600

timeout-icmp

Configure flow session ICMP timeout.

integer

Minimum value: 60 Maximum value: 604800

300

timeout-max

Configure flow session max timeout.

integer

Minimum value: 60 Maximum value: 604800

604800

timeout-tcp

Configure flow session TCP timeout.

integer

Minimum value: 60 Maximum value: 604800

3600

timeout-tcp-fin

Configure flow session TCP FIN timeout.

integer

Minimum value: 60 Maximum value: 604800

300

timeout-tcp-rst

Configure flow session TCP RST timeout.

integer

Minimum value: 60 Maximum value: 604800

120

timeout-udp

Configure flow session UDP timeout.

integer

Minimum value: 60 Maximum value: 604800

300

config aggregates

Parameter

Description

Type

Size

Default

id

Aggregate id.

integer

Minimum value: 0 Maximum value: 4294967295

0

ip

IP address to group all matching traffic sessions to a flow.

ipv4-classnet

Not Specified

0.0.0.0 0.0.0.0

config collectors

Parameter

Description

Type

Size

Default

ip

Collector IP address.

ipv4-address-any

Not Specified

0.0.0.0

name

Collector name.

string

Maximum length: 63

port

Collector port number.

integer

Minimum value: 0 Maximum value: 65535

0

transport

Collector L4 transport protocol for exporting packets.

option

-

udp

Option

Description

udp

UDP protocol.

tcp

TCP protocol.

sctp

SCTP protocol.

config switch-controller flow-tracking

config switch-controller flow-tracking

Note

This command is available for model(s): FortiGate 1000D, FortiGate 1000F, FortiGate 1001F, FortiGate 100F, FortiGate 101F, FortiGate 1100E, FortiGate 1101E, FortiGate 120G, FortiGate 121G, FortiGate 1800F, FortiGate 1801F, FortiGate 2000E, FortiGate 200E, FortiGate 200F, FortiGate 201E, FortiGate 201F, FortiGate 2200E, FortiGate 2201E, FortiGate 2500E, FortiGate 2600F, FortiGate 2601F, FortiGate 3000D, FortiGate 3000F, FortiGate 3001F, FortiGate 300E, FortiGate 301E, FortiGate 3100D, FortiGate 3200D, FortiGate 3200F, FortiGate 3201F, FortiGate 3300E, FortiGate 3301E, FortiGate 3400E, FortiGate 3401E, FortiGate 3500F, FortiGate 3501F, FortiGate 3600E, FortiGate 3601E, FortiGate 3700D, FortiGate 3700F, FortiGate 3701F, FortiGate 3960E, FortiGate 3980E, FortiGate 400E Bypass, FortiGate 400E, FortiGate 400F, FortiGate 401E, FortiGate 401F, FortiGate 40F 3G4G, FortiGate 40F, FortiGate 4200F, FortiGate 4201F, FortiGate 4400F, FortiGate 4401F, FortiGate 500E, FortiGate 501E, FortiGate 600E, FortiGate 600F, FortiGate 601E, FortiGate 601F, FortiGate 60F, FortiGate 61F, FortiGate 70F, FortiGate 71F, FortiGate 800D, FortiGate 80F Bypass, FortiGate 80F DSL, FortiGate 80F-POE, FortiGate 80F, FortiGate 81F, FortiGate 900D, FortiGate 900G, FortiGate 901G, FortiGate 90G, FortiGate 91G, FortiGate VM ARM64 for Azure, FortiGate VM ARM64 for GCP BYOL, FortiGate VM ARM64 for OCI BYOL, FortiGate VM for Aliyun PAYG, FortiGate VM for AWS PAYG, FortiGate VM for Azure BYOL, FortiGate VM for Azure PAYG, FortiGate VM for GCP BYOL, FortiGate VM for OPC BYOL, FortiGate VM64, FortiGateRugged 60F 3G4G, FortiGateRugged 60F, FortiGateRugged 70F 3G4G, FortiGateRugged 70F, FortiWiFi 40F 3G4G, FortiWiFi 40F, FortiWiFi 60F, FortiWiFi 61F, FortiWiFi 80F 2R 3G4G DSL, FortiWiFi 80F 2R, FortiWiFi 81F 2R 3G4G DSL, FortiWiFi 81F 2R 3G4G-POE, FortiWiFi 81F 2R-POE, FortiWiFi 81F 2R.

It is not available for: FortiGate 5001E1, FortiGate 5001E.

Configure FortiSwitch flow tracking and export via ipfix/netflow.

config switch-controller flow-tracking
    Description: Configure FortiSwitch flow tracking and export via ipfix/netflow.
    config aggregates
        Description: Configure aggregates in which all traffic sessions matching the IP Address will be grouped into the same flow.
        edit <id>
            set ip {ipv4-classnet}
        next
    end
    config collectors
        Description: Configure collectors for the flow.
        edit <name>
            set ip {ipv4-address-any}
            set port {integer}
            set transport [udp|tcp|...]
        next
    end
    set format [netflow1|netflow5|...]
    set level [vlan|ip|...]
    set max-export-pkt-size {integer}
    set sample-mode [local|perimeter|...]
    set sample-rate {integer}
    set template-export-period {integer}
    set timeout-general {integer}
    set timeout-icmp {integer}
    set timeout-max {integer}
    set timeout-tcp {integer}
    set timeout-tcp-fin {integer}
    set timeout-tcp-rst {integer}
    set timeout-udp {integer}
end

config switch-controller flow-tracking

Parameter

Description

Type

Size

Default

format

Configure flow tracking protocol.

option

-

netflow9

Option

Description

netflow1

Netflow version 1 sampling.

netflow5

Netflow version 5 sampling.

netflow9

Netflow version 9 sampling.

ipfix

Ipfix sampling.

level

Configure flow tracking level.

option

-

ip

Option

Description

vlan

Collects srcip/dstip/srcport/dstport/protocol/tos/vlan from the sample packet.

ip

Collects srcip/dstip from the sample packet.

port

Collects srcip/dstip/srcport/dstport/protocol from the sample packet.

proto

Collects srcip/dstip/protocol from the sample packet.

mac

Collects smac/dmac from the sample packet.

max-export-pkt-size

Configure flow max export packet size.

integer

Minimum value: 512 Maximum value: 9216

512

sample-mode

Configure sample mode for the flow tracking.

option

-

perimeter

Option

Description

local

Set local mode which samples on the specific switch port.

perimeter

Set perimeter mode which samples on all switch fabric ports and fortilink port at the ingress.

device-ingress

Set device -ingress mode which samples across all switch ports at the ingress.

sample-rate

Configure sample rate for the perimeter and device-ingress sampling.

integer

Minimum value: 0 Maximum value: 99999

512

template-export-period

Configure template export period.

integer

Minimum value: 1 Maximum value: 60

5

timeout-general

Configure flow session general timeout.

integer

Minimum value: 60 Maximum value: 604800

3600

timeout-icmp

Configure flow session ICMP timeout.

integer

Minimum value: 60 Maximum value: 604800

300

timeout-max

Configure flow session max timeout.

integer

Minimum value: 60 Maximum value: 604800

604800

timeout-tcp

Configure flow session TCP timeout.

integer

Minimum value: 60 Maximum value: 604800

3600

timeout-tcp-fin

Configure flow session TCP FIN timeout.

integer

Minimum value: 60 Maximum value: 604800

300

timeout-tcp-rst

Configure flow session TCP RST timeout.

integer

Minimum value: 60 Maximum value: 604800

120

timeout-udp

Configure flow session UDP timeout.

integer

Minimum value: 60 Maximum value: 604800

300

config aggregates

Parameter

Description

Type

Size

Default

id

Aggregate id.

integer

Minimum value: 0 Maximum value: 4294967295

0

ip

IP address to group all matching traffic sessions to a flow.

ipv4-classnet

Not Specified

0.0.0.0 0.0.0.0

config collectors

Parameter

Description

Type

Size

Default

ip

Collector IP address.

ipv4-address-any

Not Specified

0.0.0.0

name

Collector name.

string

Maximum length: 63

port

Collector port number.

integer

Minimum value: 0 Maximum value: 65535

0

transport

Collector L4 transport protocol for exporting packets.

option

-

udp

Option

Description

udp

UDP protocol.

tcp

TCP protocol.

sctp

SCTP protocol.