fortinet.fortios.fortios_log_fortiguard_override_setting (2.3.6) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

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 override_setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

• ansible>=2.15

Usage examples

Scanned by Steampunk Spotter

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

- name: Override global FortiCloud logging settings for this VDOM.
  fortinet.fortios.fortios_log_fortiguard_override_setting:
      vdom: "{{ vdom }}"
      log_fortiguard_override_setting:
          access_config: "enable"
          max_log_rate: "0"
          override: "enable"
          priority: "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

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

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

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

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

log_fortiguard_override_setting:
    default: null
    description:
    - Override global FortiCloud logging settings for this VDOM.
    suboptions:
      access_config:
        choices:
        - enable
        - disable
        description:
        - Enable/disable FortiCloud access to configuration and data.
        type: str
      max_log_rate:
        description:
        - FortiCloud maximum log rate in MBps (0 = unlimited).
        type: int
      override:
        choices:
        - enable
        - disable
        description:
        - Overriding FortiCloud settings for this VDOM or use global settings.
        type: str
      priority:
        choices:
        - default
        - low
        description:
        - Set log transmission priority.
        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