Fortinet white logo
Fortinet white logo

CLI Reference

config log npu-server

config log npu-server

Note

This command is available for model(s): FortiGate 4401F.

It is not available for: FortiGate 1000D, FortiGate 1000F, FortiGate 1001F, FortiGate 100F, FortiGate 101F, FortiGate 1100E, FortiGate 1101E, 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 4800F, FortiGate 4801F, FortiGate 5001E1, FortiGate 5001E, FortiGate 500E, FortiGate 501E, FortiGate 50G SFP-POE, FortiGate 600E, FortiGate 600F, FortiGate 601E, FortiGate 601F, FortiGate 60F, FortiGate 61F, FortiGate 70F, FortiGate 70G, FortiGate 71F, FortiGate 800D, FortiGate 80F Bypass, FortiGate 80F DSL, FortiGate 80F-POE, FortiGate 80F, FortiGate 81F-POE, FortiGate 81F, FortiGate 900D, FortiGate 901G, FortiGate 91G, FortiGate-VM64 Aliyun, FortiGate-VM64 AWS, FortiGate-VM64 Azure, FortiGate-VM64 GCP, FortiGate-VM64 OPC, FortiGate-VM64, FortiGateRugged 60F 3G4G, FortiGateRugged 60F, FortiGateRugged 70F 3G4G, FortiGateRugged 70F, FortiWiFi 40F 3G4G, FortiWiFi 40F, FortiWiFi 51G, FortiWiFi 60F, FortiWiFi 61F, FortiWiFi 71G, 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.

Configure all the log servers and create the server groups.

config log npu-server
    Description: Configure all the log servers and create the server groups.
    set enforce-seq-order [disable|enable]
    set log-processing [may-drop|no-drop]
    set log-processor [hardware|host]
    set netflow-ver [v9|v10]
    config server-group
        Description: create server group.
        edit <group-name>
            set log-format [syslog|netflow]
            set log-gen-event [disable|enable]
            set log-mode [per-session|per-nat-mapping|...]
            set log-tx-mode [roundrobin|multicast]
            set log-user-info [disable|enable]
            set server-number {integer}
            set server-start-id {integer}
            set sw-log-flags [tcp-udp-only|enable-all-log|...]
        next
    end
    config server-info
        Description: configure server info.
        edit <id>
            set dest-port {integer}
            set ip-family [v4|v6]
            set ipv4-server {ipv4-address-any}
            set ipv6-server {ipv6-address}
            set log-transport [udp|tcp]
            set source-port {integer}
            set template-tx-timeout {integer}
            set vdom {string}
        next
    end
    set syslog-facility {integer}
    set syslog-severity {integer}
end

config log npu-server

Parameter

Description

Type

Size

Default

enforce-seq-order

sw session netflow logs will be delivered in strict order if the option is enabled. Please do not switch the option while sw traffic is passing through.

option

-

disable

Option

Description

disable

Do not enforce strict in-order delivery of netflow sw session log packets.

enable

Enforce strict in-order delivery of netflow sw session log packets.

log-processing

configure log processed by host to drop or no drop.

option

-

no-drop

Option

Description

may-drop

Log processed by host may drop

no-drop

Log processed by host may not drop

log-processor

configure the log module.

option

-

hardware

Option

Description

hardware

Hardware handles the log processing.

host

Host handles the log processing.

netflow-ver

configure the netfow verson.

option

-

v10

Option

Description

v9

Netflow v9.

v10

Netflow v10, that is IPFIX.

syslog-facility

configure the syslog facility.

integer

Minimum value: 0 Maximum value: 23

23

syslog-severity

configure the syslog severity.

integer

Minimum value: 0 Maximum value: 7

5

config server-group

Parameter

Description

Type

Size

Default

group-name

server group name.

string

Maximum length: 35

log-format

Set the log format

option

-

netflow

Option

Description

syslog

Create the log in the format of syslog.

netflow

Create the log in the format of netflow, the netflow version is v9 or v10, depends on the netflow_ver set.

log-gen-event

Enable/disbale generating event for Per-Mapping log

option

-

disable

Option

Description

disable

Do not generate system event for per-mapping logs.

enable

Generate system event for per-mapping logs.

log-mode

Set the log mode

option

-

per-session

Option

Description

per-session

Create log when setup and delete session.

per-nat-mapping

Create log when allocate or free mapping resource.

per-session-ending

Create log only when delete session.

log-tx-mode

Configure log transmit mode.

option

-

roundrobin

Option

Description

roundrobin

Transmit logs in round-robin mode.

multicast

Transmit logs in multicast mode.

log-user-info

Enable/disbale logging user information.

option

-

disable

Option

Description

disable

Do not log user informaton in logs.

enable

Log user information in logs.

server-number

server number in this group.

integer

Minimum value: 1 Maximum value: 16

1

server-start-id

the start id of the continuous server series in this group,[1,16].

integer

Minimum value: 1 Maximum value: 16

0

sw-log-flags

Set flags for software logging via driver.

option

-

tcp-udp-only

Option

Description

tcp-udp-only

Only TCP/UDP software sessions are logged. (default)

enable-all-log

All protocols of software sessions are logged.

disable-all-log

No software sessions are logged.

config server-info

Parameter

Description

Type

Size

Default

dest-port

set the dest port (1-65535) for the log packet. Default-syslog:514, default-ipfix:4739.

integer

Minimum value: 0 Maximum value: 65535

0

id

server id.

integer

Minimum value: 1 Maximum value: 16

0

ip-family

set the version the IP address

option

-

v4

Option

Description

v4

IP v4.

v6

IP v6.

ipv4-server

set the IPv4 address for the log server

ipv4-address-any

Not Specified

0.0.0.0

ipv6-server

set the IPv6 address for the log server

ipv6-address

Not Specified

::

log-transport

set transport protocol

option

-

udp

Option

Description

udp

Use UDP for log transport.

tcp

Use TCP for log transport.

source-port

set the source port (1-65535) for the log packet. Default-syslog:514, default-ipfix:4739.

integer

Minimum value: 0 Maximum value: 65535

0

template-tx-timeout

set the template tx timeout

integer

Minimum value: 60 Maximum value: 86400

600

vdom

Interface connected to the log server is in this virtual domain (VDOM).

string

Maximum length: 31

config log npu-server

config log npu-server

Note

This command is available for model(s): FortiGate 4401F.

It is not available for: FortiGate 1000D, FortiGate 1000F, FortiGate 1001F, FortiGate 100F, FortiGate 101F, FortiGate 1100E, FortiGate 1101E, 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 4800F, FortiGate 4801F, FortiGate 5001E1, FortiGate 5001E, FortiGate 500E, FortiGate 501E, FortiGate 50G SFP-POE, FortiGate 600E, FortiGate 600F, FortiGate 601E, FortiGate 601F, FortiGate 60F, FortiGate 61F, FortiGate 70F, FortiGate 70G, FortiGate 71F, FortiGate 800D, FortiGate 80F Bypass, FortiGate 80F DSL, FortiGate 80F-POE, FortiGate 80F, FortiGate 81F-POE, FortiGate 81F, FortiGate 900D, FortiGate 901G, FortiGate 91G, FortiGate-VM64 Aliyun, FortiGate-VM64 AWS, FortiGate-VM64 Azure, FortiGate-VM64 GCP, FortiGate-VM64 OPC, FortiGate-VM64, FortiGateRugged 60F 3G4G, FortiGateRugged 60F, FortiGateRugged 70F 3G4G, FortiGateRugged 70F, FortiWiFi 40F 3G4G, FortiWiFi 40F, FortiWiFi 51G, FortiWiFi 60F, FortiWiFi 61F, FortiWiFi 71G, 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.

Configure all the log servers and create the server groups.

config log npu-server
    Description: Configure all the log servers and create the server groups.
    set enforce-seq-order [disable|enable]
    set log-processing [may-drop|no-drop]
    set log-processor [hardware|host]
    set netflow-ver [v9|v10]
    config server-group
        Description: create server group.
        edit <group-name>
            set log-format [syslog|netflow]
            set log-gen-event [disable|enable]
            set log-mode [per-session|per-nat-mapping|...]
            set log-tx-mode [roundrobin|multicast]
            set log-user-info [disable|enable]
            set server-number {integer}
            set server-start-id {integer}
            set sw-log-flags [tcp-udp-only|enable-all-log|...]
        next
    end
    config server-info
        Description: configure server info.
        edit <id>
            set dest-port {integer}
            set ip-family [v4|v6]
            set ipv4-server {ipv4-address-any}
            set ipv6-server {ipv6-address}
            set log-transport [udp|tcp]
            set source-port {integer}
            set template-tx-timeout {integer}
            set vdom {string}
        next
    end
    set syslog-facility {integer}
    set syslog-severity {integer}
end

config log npu-server

Parameter

Description

Type

Size

Default

enforce-seq-order

sw session netflow logs will be delivered in strict order if the option is enabled. Please do not switch the option while sw traffic is passing through.

option

-

disable

Option

Description

disable

Do not enforce strict in-order delivery of netflow sw session log packets.

enable

Enforce strict in-order delivery of netflow sw session log packets.

log-processing

configure log processed by host to drop or no drop.

option

-

no-drop

Option

Description

may-drop

Log processed by host may drop

no-drop

Log processed by host may not drop

log-processor

configure the log module.

option

-

hardware

Option

Description

hardware

Hardware handles the log processing.

host

Host handles the log processing.

netflow-ver

configure the netfow verson.

option

-

v10

Option

Description

v9

Netflow v9.

v10

Netflow v10, that is IPFIX.

syslog-facility

configure the syslog facility.

integer

Minimum value: 0 Maximum value: 23

23

syslog-severity

configure the syslog severity.

integer

Minimum value: 0 Maximum value: 7

5

config server-group

Parameter

Description

Type

Size

Default

group-name

server group name.

string

Maximum length: 35

log-format

Set the log format

option

-

netflow

Option

Description

syslog

Create the log in the format of syslog.

netflow

Create the log in the format of netflow, the netflow version is v9 or v10, depends on the netflow_ver set.

log-gen-event

Enable/disbale generating event for Per-Mapping log

option

-

disable

Option

Description

disable

Do not generate system event for per-mapping logs.

enable

Generate system event for per-mapping logs.

log-mode

Set the log mode

option

-

per-session

Option

Description

per-session

Create log when setup and delete session.

per-nat-mapping

Create log when allocate or free mapping resource.

per-session-ending

Create log only when delete session.

log-tx-mode

Configure log transmit mode.

option

-

roundrobin

Option

Description

roundrobin

Transmit logs in round-robin mode.

multicast

Transmit logs in multicast mode.

log-user-info

Enable/disbale logging user information.

option

-

disable

Option

Description

disable

Do not log user informaton in logs.

enable

Log user information in logs.

server-number

server number in this group.

integer

Minimum value: 1 Maximum value: 16

1

server-start-id

the start id of the continuous server series in this group,[1,16].

integer

Minimum value: 1 Maximum value: 16

0

sw-log-flags

Set flags for software logging via driver.

option

-

tcp-udp-only

Option

Description

tcp-udp-only

Only TCP/UDP software sessions are logged. (default)

enable-all-log

All protocols of software sessions are logged.

disable-all-log

No software sessions are logged.

config server-info

Parameter

Description

Type

Size

Default

dest-port

set the dest port (1-65535) for the log packet. Default-syslog:514, default-ipfix:4739.

integer

Minimum value: 0 Maximum value: 65535

0

id

server id.

integer

Minimum value: 1 Maximum value: 16

0

ip-family

set the version the IP address

option

-

v4

Option

Description

v4

IP v4.

v6

IP v6.

ipv4-server

set the IPv4 address for the log server

ipv4-address-any

Not Specified

0.0.0.0

ipv6-server

set the IPv6 address for the log server

ipv6-address

Not Specified

::

log-transport

set transport protocol

option

-

udp

Option

Description

udp

Use UDP for log transport.

tcp

Use TCP for log transport.

source-port

set the source port (1-65535) for the log packet. Default-syslog:514, default-ipfix:4739.

integer

Minimum value: 0 Maximum value: 65535

0

template-tx-timeout

set the template tx timeout

integer

Minimum value: 60 Maximum value: 86400

600

vdom

Interface connected to the log server is in this virtual domain (VDOM).

string

Maximum length: 31