Fortinet Document Library

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

CLI Reference

log-fetch

Use the following commands to configure log fetching.

log-fetch client-profile

Use this command to configure the fetching client settings.

Syntax

config system log-fetch client-profile

edit <id>

set client-adom <string>

set data-range {custom}

set data-range-value <integer>

set end-time <hh:mm> <yyyy/mm/dd>

set index-fetch-logs {enable | disable}

set log-filter-status {enable | disable}

set log-filter-logic {and | or}

set name <string>

set password <passwd>

set secure-connection {enable | disable}

set server-adom <string>

set server-ip <ip>

set start-time <hh:mm> <yyyy/mm/dd>

set sync-adom-config {enable | disable}

set user <string>

config device-filter

edit <id>

set adom <string>

set device <device>

set vdom <string>

next

config log-filter

edit <id>

set field <string>

set oper {= | != | < | > | <= | >= | contain | not-contain | match}

set value <string>

next

next

end

end

Variable

Description

id

The log-fetch client profile ID.

client-adom <string>

Log-fetch client side's adom name.

data-range {custom}

The data range settings for the fetched logs, which is always custom.

data-range-value <integer>

An integer representing the data range value.

end-time <hh:mm> <yyyy/mm/dd>

Set the end date and time of the data-range.

index-fetch-logs {enable | disable}

Enable/disable indexing logs automatically after fetching logs. Default: enabled.

log-filter-status {enable | disable}

Enable/Disable log-filter. Default: disabled.

log-filter-logic {and | or}

Set the logic for the log filters.

name <string>

The name of log-fetch client profile.

password <passwd>

The log-fetch server password.

secure-connection {enable | disable}

Enable/disable protecting log-fetch connection with TLS/SSL. Default: enabled.

server-adom <string>

Log-fetch server side's adom name.

server-ip <ip>

The log fetch server IPv4 address.

start-time <hh:mm> <yyyy/mm/dd>

Set the start date and time of the data-range. The start date should be earlier than the end date.

sync-adom-config {enable | disable}

Enable/Disable ADOM configuration synchronization.

user <string>

The log-fetch server username.

Variables forconfig device-filtersubcommand:

<id>

Add or edit a device filter.

adom <string>

Enter the ADOM name.

device <device>

Enter the device name or serial number.

vdom <string>

Enter the VDOM, if required.

Variables forconfig log-filtersubcommand:

<id>

The log filter ID.

field <string>

Enter the field name.

oper {= | != | < | > | <= | >= | contain | not-contain | match}

Set the filter operator:

  • = - Equal to
  • != - Not equal to
  • < - Less than
  • > - Greater than
  • <= - Less than or equal to
  • >= - Greater than or equal to
  • contain - Contain
  • not-contain - Not contain
  • match - Match (expression)

value <string>

Enter the field filter operand or free-text matching expression.

log-fetch server-setting

Use this command to configure the fetching server settings.

Syntax

config system log-fetch server-setting

set max-conn-per-session <integer>

set max-sessions <integer>

set user <string>

end

Variable

Description

max-conn-per-session <integer>

The maximum number of concurrent file download connections per session.

max-sessions <integer>

The maximum number of concurrent fetch sessions.

session-timeout <integer>

Set the fetch session timeout period, in minutes. This option is only available in server mode.

log-fetch

Use the following commands to configure log fetching.

log-fetch client-profile

Use this command to configure the fetching client settings.

Syntax

config system log-fetch client-profile

edit <id>

set client-adom <string>

set data-range {custom}

set data-range-value <integer>

set end-time <hh:mm> <yyyy/mm/dd>

set index-fetch-logs {enable | disable}

set log-filter-status {enable | disable}

set log-filter-logic {and | or}

set name <string>

set password <passwd>

set secure-connection {enable | disable}

set server-adom <string>

set server-ip <ip>

set start-time <hh:mm> <yyyy/mm/dd>

set sync-adom-config {enable | disable}

set user <string>

config device-filter

edit <id>

set adom <string>

set device <device>

set vdom <string>

next

config log-filter

edit <id>

set field <string>

set oper {= | != | < | > | <= | >= | contain | not-contain | match}

set value <string>

next

next

end

end

Variable

Description

id

The log-fetch client profile ID.

client-adom <string>

Log-fetch client side's adom name.

data-range {custom}

The data range settings for the fetched logs, which is always custom.

data-range-value <integer>

An integer representing the data range value.

end-time <hh:mm> <yyyy/mm/dd>

Set the end date and time of the data-range.

index-fetch-logs {enable | disable}

Enable/disable indexing logs automatically after fetching logs. Default: enabled.

log-filter-status {enable | disable}

Enable/Disable log-filter. Default: disabled.

log-filter-logic {and | or}

Set the logic for the log filters.

name <string>

The name of log-fetch client profile.

password <passwd>

The log-fetch server password.

secure-connection {enable | disable}

Enable/disable protecting log-fetch connection with TLS/SSL. Default: enabled.

server-adom <string>

Log-fetch server side's adom name.

server-ip <ip>

The log fetch server IPv4 address.

start-time <hh:mm> <yyyy/mm/dd>

Set the start date and time of the data-range. The start date should be earlier than the end date.

sync-adom-config {enable | disable}

Enable/Disable ADOM configuration synchronization.

user <string>

The log-fetch server username.

Variables forconfig device-filtersubcommand:

<id>

Add or edit a device filter.

adom <string>

Enter the ADOM name.

device <device>

Enter the device name or serial number.

vdom <string>

Enter the VDOM, if required.

Variables forconfig log-filtersubcommand:

<id>

The log filter ID.

field <string>

Enter the field name.

oper {= | != | < | > | <= | >= | contain | not-contain | match}

Set the filter operator:

  • = - Equal to
  • != - Not equal to
  • < - Less than
  • > - Greater than
  • <= - Less than or equal to
  • >= - Greater than or equal to
  • contain - Contain
  • not-contain - Not contain
  • match - Match (expression)

value <string>

Enter the field filter operand or free-text matching expression.

log-fetch server-setting

Use this command to configure the fetching server settings.

Syntax

config system log-fetch server-setting

set max-conn-per-session <integer>

set max-sessions <integer>

set user <string>

end

Variable

Description

max-conn-per-session <integer>

The maximum number of concurrent file download connections per session.

max-sessions <integer>

The maximum number of concurrent fetch sessions.

session-timeout <integer>

Set the fetch session timeout period, in minutes. This option is only available in server mode.