ansible.builtin.fortios_log_fortianalyzer3_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_fortianalyzer3 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: Global FortiAnalyzer settings.
    fortios_log_fortianalyzer3_setting:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      log_fortianalyzer3_setting:
        __change_ip: "3"
        certificate: "<your_own_value> (source certificate.local.name)"
        conn-timeout: "5"
        enc-algorithm: "high-medium"
        faz-type: "7"
        hmac-algorithm: "sha256"
        ips-archive: "enable"
        mgmt-name: "<your_own_value>"
        monitor-failure-retry-period: "11"
        monitor-keepalive-period: "12"
        reliable: "enable"
        server: "192.168.100.40"
        source-ip: "84.230.14.43"
        ssl-min-proto-version: "default"
        status: "enable"
        upload-day: "<your_own_value>"
        upload-interval: "daily"
        upload-option: "store-and-upload"
        upload-time: "<your_own_value>"

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_fortianalyzer3_setting:
    default: null
    description:
    - Global FortiAnalyzer settings.
    suboptions:
      __change_ip:
        description:
        - Hidden attribute.
      certificate:
        description:
        - Certificate used to communicate with FortiAnalyzer. Source certificate.local.name.
      conn-timeout:
        description:
        - FortiAnalyzer connection time-out in seconds (for status and log buffer).
      enc-algorithm:
        choices:
        - high-medium
        - high
        - low
        - disable
        description:
        - Enable/disable sending FortiAnalyzer log data with SSL encryption.
      faz-type:
        description:
        - Hidden setting index of FortiAnalyzer.
      hmac-algorithm:
        choices:
        - sha256
        - sha1
        description:
        - FortiAnalyzer IPsec tunnel HMAC algorithm.
      ips-archive:
        choices:
        - enable
        - disable
        description:
        - Enable/disable IPS packet archive logging.
      mgmt-name:
        description:
        - Hidden management name of FortiAnalyzer.
      monitor-failure-retry-period:
        description:
        - Time between FortiAnalyzer connection retries in seconds (for status and log
          buffer).
      monitor-keepalive-period:
        description:
        - Time between OFTP keepalives in seconds (for status and log buffer).
      reliable:
        choices:
        - enable
        - disable
        description:
        - Enable/disable reliable logging to FortiAnalyzer.
      server:
        description:
        - The remote FortiAnalyzer.
      source-ip:
        description:
        - Source IPv4 or IPv6 address used to communicate with FortiAnalyzer.
      ssl-min-proto-version:
        choices:
        - default
        - SSLv3
        - TLSv1
        - TLSv1-1
        - TLSv1-2
        description:
        - Minimum supported protocol version for SSL/TLS connections (default is to follow
          system global setting).
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable logging to FortiAnalyzer.
      upload-day:
        description:
        - Day of week (month) to upload logs.
      upload-interval:
        choices:
        - daily
        - weekly
        - monthly
        description:
        - Frequency to upload log files to FortiAnalyzer.
      upload-option:
        choices:
        - store-and-upload
        - realtime
        - 1-minute
        - 5-minute
        description:
        - Enable/disable logging to hard disk and then uploading to FortiAnalyzer.
      upload-time:
        description:
        - Time to upload logs (hh:mm).

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