ansible.builtin.fortios_log_setting (v2.8.20) — module

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

This module is able to configure a FortiGate or FortiOS by allowing the user to set and modify log feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.2

Requirements

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

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

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure general log settings.
    fortios_log_setting:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      log_setting:
        brief-traffic-format: "enable"
        custom-log-fields:
         -
            field-id: "<your_own_value> (source log.custom-field.id)"
        daemon-log: "enable"
        expolicy-implicit-log: "enable"
        fwpolicy-implicit-log: "enable"
        fwpolicy6-implicit-log: "enable"
        local-in-allow: "enable"
        local-in-deny-broadcast: "enable"
        local-in-deny-unicast: "enable"
        local-out: "enable"
        log-invalid-packet: "enable"
        log-policy-comment: "enable"
        log-policy-name: "enable"
        log-user-in-upper: "enable"
        neighbor-event: "enable"
        resolve-ip: "enable"
        resolve-port: "enable"
        user-anonymize: "enable"

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip address.
    required: true

vdom:
    default: root
    description:
    - Virtual domain, among those defined previously. A vdom is a virtual instance of
      the FortiGate that can be configured and used as a different unit.

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.

username:
    description:
    - FortiOS or FortiGate username.
    required: true

log_setting:
    default: null
    description:
    - Configure general log settings.
    suboptions:
      brief-traffic-format:
        choices:
        - enable
        - disable
        description:
        - Enable/disable brief format traffic logging.
      custom-log-fields:
        description:
        - Custom fields to append to all log messages.
        suboptions:
          field-id:
            description:
            - Custom log field. Source log.custom-field.id.
            required: true
      daemon-log:
        choices:
        - enable
        - disable
        description:
        - Enable/disable daemon logging.
      expolicy-implicit-log:
        choices:
        - enable
        - disable
        description:
        - Enable/disable explicit proxy firewall implicit policy logging.
      fwpolicy-implicit-log:
        choices:
        - enable
        - disable
        description:
        - Enable/disable implicit firewall policy logging.
      fwpolicy6-implicit-log:
        choices:
        - enable
        - disable
        description:
        - Enable/disable implicit firewall policy6 logging.
      local-in-allow:
        choices:
        - enable
        - disable
        description:
        - Enable/disable local-in-allow logging.
      local-in-deny-broadcast:
        choices:
        - enable
        - disable
        description:
        - Enable/disable local-in-deny-broadcast logging.
      local-in-deny-unicast:
        choices:
        - enable
        - disable
        description:
        - Enable/disable local-in-deny-unicast logging.
      local-out:
        choices:
        - enable
        - disable
        description:
        - Enable/disable local-out logging.
      log-invalid-packet:
        choices:
        - enable
        - disable
        description:
        - Enable/disable invalid packet traffic logging.
      log-policy-comment:
        choices:
        - enable
        - disable
        description:
        - Enable/disable inserting policy comments into traffic logs.
      log-policy-name:
        choices:
        - enable
        - disable
        description:
        - Enable/disable inserting policy name into traffic logs.
      log-user-in-upper:
        choices:
        - enable
        - disable
        description:
        - Enable/disable logs with user-in-upper.
      neighbor-event:
        choices:
        - enable
        - disable
        description:
        - Enable/disable neighbor event logging.
      resolve-ip:
        choices:
        - enable
        - disable
        description:
        - Enable/disable adding resolved domain names to traffic logs if possible.
      resolve-port:
        choices:
        - enable
        - disable
        description:
        - Enable/disable adding resolved service names to traffic logs.
      user-anonymize:
        choices:
        - enable
        - disable
        description:
        - Enable/disable anonymizing user names in log messages.

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str