fortinet.fortios.fortios_log_fortiguard_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_fortiguard feature and 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: Configure logging to FortiCloud.
    fortios_log_fortiguard_setting:
      vdom:  "{{ vdom }}"
      log_fortiguard_setting:
        conn_timeout: "3"
        enc_algorithm: "high-medium"
        max_log_rate: "5"
        priority: "default"
        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

    
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_fortiguard_setting:
    default: null
    description:
    - Configure logging to FortiCloud.
    suboptions:
      conn_timeout:
        description:
        - FortiGate Cloud connection timeout in seconds.
        type: int
      enc_algorithm:
        choices:
        - high-medium
        - high
        - low
        description:
        - Configure the level of SSL protection for secure communication with FortiCloud.
        type: str
      max_log_rate:
        description:
        - FortiCloud maximum log rate in MBps (0 = unlimited).
        type: int
      priority:
        choices:
        - default
        - low
        description:
        - Set log transmission priority.
        type: str
      source_ip:
        description:
        - Source IP address used to connect FortiCloud.
        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 logging to FortiCloud.
        type: str
      upload_day:
        description:
        - Day of week to roll logs.
        type: str
      upload_interval:
        choices:
        - daily
        - weekly
        - monthly
        description:
        - Frequency of uploading log files to FortiCloud.
        type: str
      upload_option:
        choices:
        - store-and-upload
        - realtime
        - 1-minute
        - 5-minute
        description:
        - Configure how log messages are sent to FortiCloud.
        type: str
      upload_time:
        description:
        - Time of day to roll logs (hh:mm).
        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