fmgr_log_npuserver – Configure all the log servers and create the server groups.

New in version 2.2.0.

Synopsis

• This module is able to configure a FortiManager device.
• Examples include all parameters and values need to be adjusted to data sources before usage.
• Tested with FortiManager v6.x and v7.x.

Requirements

The below requirements are needed on the host that executes this module.

• ansible>=2.9.0

FortiManager Version Compatibility

6.0.0
False
6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
False	False	False	False	False	False	False	False	False	False
6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
False	False	False	False	False	False	False	True	True	True	True	True
7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
False	True	True	True	True	True	True	True
7.2.0	7.2.1	7.2.2
True	True	True
7.4.0
True

Parameters

• access_token -The token to access FortiManager without using username and password. type: str required: false
• bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
• enable_log - Enable/Disable logging for task. type: bool required: false default: False
• forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
• proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
• rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
• rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
• workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
• workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
• adom - The parameter in requested url type: str required: true
• log_npuserver - Configure all the log servers and create the server groups. type: dict
• log-processing - configure log processed by host to drop or no drop. type: str choices: [may-drop, no-drop] more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  False	False	False	False	False	False	False	False	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  False	False	False	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• log-processor - configure the log module. type: str choices: [hardware, host] more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  False	False	False	False	False	False	False	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  False	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• netflow-ver - configure the netfow verson. type: str choices: [v9, v10] more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  False	False	False	False	False	False	False	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  False	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• server-group - No description for the parameter type: array more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  False	False	False	False	False	False	False	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  False	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

  • group-name - server group name. type: str more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • log-format - Set the log format type: str choices: [syslog, netflow] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • log-mode - Set the log mode type: str choices: [per-session, per-nat-mapping, per-session-ending] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • log-tx-mode - Configure log transmit mode. type: str choices: [multicast, roundrobin] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • server-number - server number in this group. type: int more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • server-start-id - the start id of the continuous server series in this group,[1,16]. type: int more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sw-log-flags - Set flags for software logging via driver. type: int choices: [tcp-udp-only, enable-all-log, disable-all-log] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	False	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • log-gen-event - Enable/disbale generating event for Per-Mapping log type: str choices: [disable, enable] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	False	False	True	True	True	True
    7.2.0	7.2.1	7.2.2
    False	True	True
    7.4.0
    True

  • log-user-info - Enable/disbale logging user information. type: str choices: [disable, enable] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	False	False	True	True	True	True
    7.2.0	7.2.1	7.2.2
    False	True	True
    7.4.0
    True

• server-info - No description for the parameter type: array more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  False	False	False	False	False	False	False	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  False	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

  • dest-port - set the dest port for the log packet type: int more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • id - server id. type: int more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • ip-family - set the version the IP address type: str choices: [v4, v6] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • ipv4-server - set the IPv4 address for the log server type: str more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • ipv6-server - set the IPv6 address for the log server type: str more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • source-port - set the source port for the log packet type: int more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • template-tx-timeout - set the template tx timeout type: int more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • vdom - Interface connected to the log server is in this virtual domain (VDOM). type: str more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

• syslog-facility - configure the syslog facility. type: int more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  False	False	False	False	False	False	False	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  False	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• syslog-severity - configure the syslog severity. type: int more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  False	False	False	False	False	False	False	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  False	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

Notes

Note

• Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
• To create or update an object, use state: present directive.
• To delete an object, use state: absent directive
• Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure all the log servers and create the server groups.
     fmgr_log_npuserver:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        log_npuserver:
           log-processing: <value in [may-drop, no-drop]>
           log-processor: <value in [hardware, host]>
           netflow-ver: <value in [v9, v10]>
           server-group:
             -
                 group-name: <value of string>
                 log-format: <value in [syslog, netflow]>
                 log-mode: <value in [per-session, per-nat-mapping, per-session-ending]>
                 log-tx-mode: <value in [multicast, roundrobin]>
                 server-number: <value of integer>
                 server-start-id: <value of integer>
                 sw-log-flags: <value in [tcp-udp-only, enable-all-log, disable-all-log]>
                 log-gen-event: <value in [disable, enable]>
                 log-user-info: <value in [disable, enable]>
           server-info:
             -
                 dest-port: <value of integer>
                 id: <value of integer>
                 ip-family: <value in [v4, v6]>
                 ipv4-server: <value of string>
                 ipv6-server: <value of string>
                 source-port: <value of integer>
                 template-tx-timeout: <value of integer>
                 vdom: <value of string>
           syslog-facility: <value of integer>
           syslog-severity: <value of integer>

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

• meta - The result of the request.returned: always type: dict
• request_url - The full url requested. returned: always type: str sample: /sys/login/user
• response_code - The status of api request. returned: always type: int sample: 0
• response_data - The data body of the api response. returned: optional type: list or dict
• response_message - The descriptive message of the api response. returned: always type: str sample: OK
• system_information - The information of the target system. returned: always type: dict
• rc - The status the request. returned: always type: int 0
• version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0

Status

• This module is not guaranteed to have a backwards compatible interface.

Authors

• Xinwei Du (@dux-fortinet)
• Xing Li (@lix-fortinet)
• Jie Xue (@JieX19)
• Link Zheng (@chillancezen)
• Frank Shen (@fshen01)
• Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.