fortinet.fortios.fortios_log_syslogd3_override_setting (1.1.7) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==1.1.7

Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 1.1.7

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_syslogd3 feature and override_setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.4.0

Requirements

• ansible>=2.9.0

Usage examples

Scanned by Steampunk Spotter

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

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Override settings for remote syslog server.
    fortios_log_syslogd3_override_setting:
      vdom:  "{{ vdom }}"
      log_syslogd3_override_setting:
        certificate: "<your_own_value> (source certificate.local.name)"
        custom_field_name:
         -
            custom: "<your_own_value>"
            id:  "6"
            name: "default_name_7"
        enc_algorithm: "high-medium"
        facility: "kernel"
        format: "default"
        max_log_rate: "11"
        mode: "udp"
        port: "13"
        priority: "default"
        server: "192.168.100.40"
        source_ip: "84.230.14.43"
        ssl_min_proto_version: "default"
        status: "enable"

Inputs

    
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.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

log_syslogd3_override_setting:
    default: null
    description:
    - Override settings for remote syslog server.
    suboptions:
      certificate:
        description:
        - Certificate used to communicate with Syslog server. Source certificate.local.name.
        type: str
      custom_field_name:
        description:
        - Custom field name for CEF format logging.
        suboptions:
          custom:
            description:
            - Field custom name.
            type: str
          id:
            description:
            - Entry ID.
            required: true
            type: int
          name:
            description:
            - Field name.
            type: str
        type: list
      enc_algorithm:
        choices:
        - high-medium
        - high
        - low
        - disable
        description:
        - Enable/disable reliable syslogging with TLS encryption.
        type: str
      facility:
        choices:
        - kernel
        - user
        - mail
        - daemon
        - auth
        - syslog
        - lpr
        - news
        - uucp
        - cron
        - authpriv
        - ftp
        - ntp
        - audit
        - alert
        - clock
        - local0
        - local1
        - local2
        - local3
        - local4
        - local5
        - local6
        - local7
        description:
        - Remote syslog facility.
        type: str
      format:
        choices:
        - default
        - csv
        - cef
        description:
        - Log format.
        type: str
      max_log_rate:
        description:
        - Syslog maximum log rate in MBps (0 = unlimited).
        type: int
      mode:
        choices:
        - udp
        - legacy-reliable
        - reliable
        description:
        - Remote syslog logging over UDP/Reliable TCP.
        type: str
      port:
        description:
        - Server listen port.
        type: int
      priority:
        choices:
        - default
        - low
        description:
        - Set log transmission priority.
        type: str
      server:
        description:
        - Address of remote syslog server.
        type: str
      source_ip:
        description:
        - Source IP address of syslog.
        type: str
      ssl_min_proto_version:
        choices:
        - default
        - SSLv3
        - TLSv1
        - TLSv1-1
        - TLSv1-2
        description:
        - Minimum supported protocol version for SSL/TLS connections .
        type: str
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable remote syslog logging.
        type: str
    type: dict

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