Fortinet white logo
Fortinet white logo

CLI Reference

config switch-controller traffic-sniffer

config switch-controller traffic-sniffer

Note

This command is available for model(s): FortiGate 1000D, FortiGate 100EF, FortiGate 100E, FortiGate 100F, FortiGate 101E, FortiGate 101F, FortiGate 1100E, FortiGate 1101E, FortiGate 1200D, FortiGate 140E-POE, FortiGate 140E, FortiGate 1500DT, FortiGate 1500D, FortiGate 2000E, FortiGate 200E, FortiGate 200F, FortiGate 201E, FortiGate 201F, FortiGate 2200E, FortiGate 2201E, FortiGate 2500E, FortiGate 3000D, FortiGate 300D, FortiGate 300E, FortiGate 301E, FortiGate 3100D, FortiGate 3200D, FortiGate 3300E, FortiGate 3301E, FortiGate 3401E, FortiGate 3600E, FortiGate 3601E, FortiGate 3700D, FortiGate 3800D, FortiGate 3815D, FortiGate 3960E, FortiGate 3980E, FortiGate 400D, FortiGate 400E Bypass, FortiGate 400E, FortiGate 401E, FortiGate 40F 3G4G, FortiGate 40F, FortiGate 4200F, FortiGate 4201F, FortiGate 4400F, FortiGate 4401F, FortiGate 500D, FortiGate 500E, FortiGate 501E, FortiGate 600D, FortiGate 600E, FortiGate 601E, FortiGate 60E DSLJ, FortiGate 60E DSL, FortiGate 60E-POE, FortiGate 60E, FortiGate 60F, FortiGate 61E, FortiGate 61F, FortiGate 800D, FortiGate 80E-POE, FortiGate 80E, FortiGate 80F Bypass, FortiGate 80F-POE, FortiGate 80F, FortiGate 81E-POE, FortiGate 81E, FortiGate 81F-POE, FortiGate 81F, FortiGate 900D, FortiGate 90E, FortiGate 91E, FortiGateRugged 60F 3G4G, FortiGateRugged 60F, FortiWiFi 40F 3G4G, FortiWiFi 40F, FortiWiFi 60E DSLJ, FortiWiFi 60E DSL, FortiWiFi 60E, FortiWiFi 60F, FortiWiFi 61E, FortiWiFi 61F, FortiWiFi 80F 2R, FortiWiFi 81F 2R 3G4G-POE, FortiWiFi 81F 2R-POE, FortiWiFi 81F 2R.

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

Configure FortiSwitch RSPAN/ERSPAN traffic sniffing parameters.

config switch-controller traffic-sniffer
    Description: Configure FortiSwitch RSPAN/ERSPAN traffic sniffing parameters.
    set erspan-ip {ipv4-address}
    set mode [erspan-auto|rspan|...]
    config target-ip
        Description: Sniffer IPs to filter.
        edit <ip>
            set description {string}
        next
    end
    config target-mac
        Description: Sniffer MACs to filter.
        edit <mac>
            set description {string}
        next
    end
    config target-port
        Description: Sniffer ports to filter.
        edit <switch-id>
            set description {string}
            set in-ports <name1>, <name2>, ...
            set out-ports <name1>, <name2>, ...
        next
    end
end

config switch-controller traffic-sniffer

Parameter

Description

Type

Size

Default

erspan-ip

Configure ERSPAN collector IP address.

ipv4-address

Not Specified

0.0.0.0

mode

Configure traffic sniffer mode.

option

-

erspan-auto

Option

Description

erspan-auto

Mirror traffic using a GRE tunnel.

rspan

Mirror traffic on a layer2 VLAN.

none

Disable traffic mirroring (sniffer).

config target-ip

Parameter

Description

Type

Size

Default

ip

Sniffer IP.

ipv4-address

Not Specified

0.0.0.0

description

Description for the sniffer IP.

string

Maximum length: 63

config target-mac

Parameter

Description

Type

Size

Default

mac

Sniffer MAC.

mac-address

Not Specified

00:00:00:00:00:00

description

Description for the sniffer MAC.

string

Maximum length: 63

config target-port

Parameter

Description

Type

Size

Default

switch-id

Managed-switch ID.

string

Maximum length: 16

description

Description for the sniffer port entry.

string

Maximum length: 63

in-ports <name>

Configure source ingress port interfaces.

Interface name.

string

Maximum length: 79

out-ports <name>

Configure source egress port interfaces.

Interface name.

string

Maximum length: 79

config switch-controller traffic-sniffer

config switch-controller traffic-sniffer

Note

This command is available for model(s): FortiGate 1000D, FortiGate 100EF, FortiGate 100E, FortiGate 100F, FortiGate 101E, FortiGate 101F, FortiGate 1100E, FortiGate 1101E, FortiGate 1200D, FortiGate 140E-POE, FortiGate 140E, FortiGate 1500DT, FortiGate 1500D, FortiGate 2000E, FortiGate 200E, FortiGate 200F, FortiGate 201E, FortiGate 201F, FortiGate 2200E, FortiGate 2201E, FortiGate 2500E, FortiGate 3000D, FortiGate 300D, FortiGate 300E, FortiGate 301E, FortiGate 3100D, FortiGate 3200D, FortiGate 3300E, FortiGate 3301E, FortiGate 3401E, FortiGate 3600E, FortiGate 3601E, FortiGate 3700D, FortiGate 3800D, FortiGate 3815D, FortiGate 3960E, FortiGate 3980E, FortiGate 400D, FortiGate 400E Bypass, FortiGate 400E, FortiGate 401E, FortiGate 40F 3G4G, FortiGate 40F, FortiGate 4200F, FortiGate 4201F, FortiGate 4400F, FortiGate 4401F, FortiGate 500D, FortiGate 500E, FortiGate 501E, FortiGate 600D, FortiGate 600E, FortiGate 601E, FortiGate 60E DSLJ, FortiGate 60E DSL, FortiGate 60E-POE, FortiGate 60E, FortiGate 60F, FortiGate 61E, FortiGate 61F, FortiGate 800D, FortiGate 80E-POE, FortiGate 80E, FortiGate 80F Bypass, FortiGate 80F-POE, FortiGate 80F, FortiGate 81E-POE, FortiGate 81E, FortiGate 81F-POE, FortiGate 81F, FortiGate 900D, FortiGate 90E, FortiGate 91E, FortiGateRugged 60F 3G4G, FortiGateRugged 60F, FortiWiFi 40F 3G4G, FortiWiFi 40F, FortiWiFi 60E DSLJ, FortiWiFi 60E DSL, FortiWiFi 60E, FortiWiFi 60F, FortiWiFi 61E, FortiWiFi 61F, FortiWiFi 80F 2R, FortiWiFi 81F 2R 3G4G-POE, FortiWiFi 81F 2R-POE, FortiWiFi 81F 2R.

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

Configure FortiSwitch RSPAN/ERSPAN traffic sniffing parameters.

config switch-controller traffic-sniffer
    Description: Configure FortiSwitch RSPAN/ERSPAN traffic sniffing parameters.
    set erspan-ip {ipv4-address}
    set mode [erspan-auto|rspan|...]
    config target-ip
        Description: Sniffer IPs to filter.
        edit <ip>
            set description {string}
        next
    end
    config target-mac
        Description: Sniffer MACs to filter.
        edit <mac>
            set description {string}
        next
    end
    config target-port
        Description: Sniffer ports to filter.
        edit <switch-id>
            set description {string}
            set in-ports <name1>, <name2>, ...
            set out-ports <name1>, <name2>, ...
        next
    end
end

config switch-controller traffic-sniffer

Parameter

Description

Type

Size

Default

erspan-ip

Configure ERSPAN collector IP address.

ipv4-address

Not Specified

0.0.0.0

mode

Configure traffic sniffer mode.

option

-

erspan-auto

Option

Description

erspan-auto

Mirror traffic using a GRE tunnel.

rspan

Mirror traffic on a layer2 VLAN.

none

Disable traffic mirroring (sniffer).

config target-ip

Parameter

Description

Type

Size

Default

ip

Sniffer IP.

ipv4-address

Not Specified

0.0.0.0

description

Description for the sniffer IP.

string

Maximum length: 63

config target-mac

Parameter

Description

Type

Size

Default

mac

Sniffer MAC.

mac-address

Not Specified

00:00:00:00:00:00

description

Description for the sniffer MAC.

string

Maximum length: 63

config target-port

Parameter

Description

Type

Size

Default

switch-id

Managed-switch ID.

string

Maximum length: 16

description

Description for the sniffer port entry.

string

Maximum length: 63

in-ports <name>

Configure source ingress port interfaces.

Interface name.

string

Maximum length: 79

out-ports <name>

Configure source egress port interfaces.

Interface name.

string

Maximum length: 79