drmofu.fortimanager.fmgr_log_npuserver (2.2.2) — module

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2

Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

Description

This module is able to configure a FortiManager device.

Examples include all parameters and values which need to be adjusted to data sources before usage.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

 - 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>

Inputs

    
adom:
    description: the parameter (adom) in requested url
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    required: false
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    required: false
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    required: false
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    required: false
    type: list

log_npuserver:
    description: the top level parameters set
    required: false
    suboptions:
      log-processing:
        choices:
        - may-drop
        - no-drop
        description: configure log processed by host to drop or no drop.
        type: str
      log-processor:
        choices:
        - hardware
        - host
        description: configure the log module.
        type: str
      netflow-ver:
        choices:
        - v9
        - v10
        description: configure the netfow verson.
        type: str
      server-group:
        description: description
        elements: dict
        suboptions:
          group-name:
            description: server group name.
            type: str
          log-format:
            choices:
            - syslog
            - netflow
            description: Set the log format
            type: str
          log-gen-event:
            choices:
            - disable
            - enable
            description: Enable/disbale generating event for Per-Mapping log
            type: str
          log-mode:
            choices:
            - per-session
            - per-nat-mapping
            - per-session-ending
            description: Set the log mode
            type: str
          log-tx-mode:
            choices:
            - multicast
            - roundrobin
            description: Configure log transmit mode.
            type: str
          log-user-info:
            choices:
            - disable
            - enable
            description: Enable/disbale logging user information.
            type: str
          server-number:
            description: server number in this group.
            type: int
          server-start-id:
            description: the start id of the continuous server series in this group,[1,16].
            type: int
          sw-log-flags:
            description: Set flags for software logging via driver.
            type: int
        type: list
      server-info:
        description: description
        elements: dict
        suboptions:
          dest-port:
            description: set the dest port for the log packet
            type: int
          id:
            description: server id.
            type: int
          ip-family:
            choices:
            - v4
            - v6
            description: set the version the IP address
            type: str
          ipv4-server:
            description: set the IPv4 address for the log server
            type: str
          ipv6-server:
            description: set the IPv6 address for the log server
            type: str
          source-port:
            description: set the source port for the log packet
            type: int
          template-tx-timeout:
            description: set the template tx timeout
            type: int
          vdom:
            description: Interface connected to the log server is in this virtual domain
            type: str
        type: list
      syslog-facility:
        description: configure the syslog facility.
        type: int
      syslog-severity:
        description: configure the syslog severity.
        type: int
    type: dict

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    required: false
    type: str

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    required: false
    type: bool

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    required: false
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    required: false
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    required: false
    type: int

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list