Skip to content

Latest commit

 

History

History
726 lines (682 loc) · 30.6 KB

fortios_system_automation_trigger.rst

File metadata and controls

726 lines (682 loc) · 30.6 KB
Raw
source:fortios_system_automation_trigger.py
orphan:

fortios_system_automation_trigger -- Trigger for automation stitches in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

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

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_system_automation_trigger v6.0.0 -> latest

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - 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 default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • system_automation_trigger - Trigger for automation stitches. type: dict more...
    Supported Version Ranges
    system_automation_trigger v6.0.0 -> latest
    • description - Description. type: str more...
      Supported Version Ranges
      description v7.0.0 -> latest
    • event_type - Event type. type: str choices: ioc, event-log, reboot, low-memory, high-cpu, license-near-expiry, local-cert-near-expiry, ha-failover, config-change, security-rating-summary, virus-ips-db-updated, faz-event, incoming-webhook, fabric-event, ips-logs, anomaly-logs, virus-logs, ssh-logs, webfilter-violation, traffic-violation more...
      Supported Version Ranges
      event_type v6.0.0 -> latest
      [ioc] v6.0.0 -> latest
      [event-log] v6.0.0 -> latest
      [reboot] v6.0.0 -> latest
      [low-memory] v6.0.0 -> latest
      [high-cpu] v6.0.0 -> latest
      [license-near-expiry] v6.0.0 -> latest
      [local-cert-near-expiry] v7.2.1 -> latest
      [ha-failover] v6.0.0 -> latest
      [config-change] v6.0.0 -> latest
      [security-rating-summary] v6.0.0 -> latest
      [virus-ips-db-updated] v6.0.0 -> latest
      [faz-event] v6.2.0 -> latest
      [incoming-webhook] v6.4.0 -> latest
      [fabric-event] v7.0.0 -> latest
      [ips-logs] v7.2.0 -> latest
      [anomaly-logs] v7.2.0 -> latest
      [virus-logs] v7.2.0 -> latest
      [ssh-logs] v7.2.0 -> latest
      [webfilter-violation] v7.2.0 -> latest
      [traffic-violation] v7.2.0 -> latest
    • fabric_event_name - Fabric connector event handler name. type: str more...
      Supported Version Ranges
      fabric_event_name v7.0.0 -> latest
    • fabric_event_severity - Fabric connector event severity. type: str more...
      Supported Version Ranges
      fabric_event_severity v7.0.0 -> latest
    • faz_event_name - FortiAnalyzer event handler name. type: str more...
      Supported Version Ranges
      faz_event_name v6.2.0 -> latest
    • faz_event_severity - FortiAnalyzer event severity. type: str more...
      Supported Version Ranges
      faz_event_severity v6.2.0 -> latest
    • faz_event_tags - FortiAnalyzer event tags. type: str more...
      Supported Version Ranges
      faz_event_tags v6.2.0 -> latest
    • fields - Customized trigger field settings. type: list member_path: fields:id more...
      Supported Version Ranges
      fields v6.2.0 -> latest
      • id - Entry ID. see Notes. type: int required: true more...
        Supported Version Ranges
        id v6.2.0 -> latest
      • name - Name. type: str more...
        Supported Version Ranges
        name v6.2.0 -> latest
      • value - Value. type: str more...
        Supported Version Ranges
        value v6.2.0 -> latest
    • ioc_level - IOC threat level. type: str choices: medium, high more...
      Supported Version Ranges
      ioc_level v6.0.0 -> v7.0.7 v7.2.0 -> v7.2.2
      [medium] v6.0.0 -> latest
      [high] v6.0.0 -> latest
    • license_type - License type. type: str choices: forticare-support, fortiguard-webfilter, fortiguard-antispam, fortiguard-antivirus, fortiguard-ips, fortiguard-management, forticloud, any more...
      Supported Version Ranges
      license_type v6.0.0 -> latest
      [forticare-support] v6.0.0 -> latest
      [fortiguard-webfilter] v6.0.0 -> latest
      [fortiguard-antispam] v6.0.0 -> latest
      [fortiguard-antivirus] v6.0.0 -> latest
      [fortiguard-ips] v6.0.0 -> latest
      [fortiguard-management] v6.0.0 -> latest
      [forticloud] v6.0.0 -> latest
      [any] v6.4.0 -> latest
    • logid - Log IDs to trigger event. type: list member_path: logid:id more...
      Supported Version Ranges
      logid v6.0.0 -> latest
      • id - Log ID. see Notes. type: int required: true more...
        Supported Version Ranges
        id v7.0.0 -> latest
    • name - Name. type: str required: true more...
      Supported Version Ranges
      name v6.0.0 -> latest
    • report_type - Security Rating report. type: str choices: posture, coverage, optimization, any, PostureReport, CoverageReport, OptimizationReport more...
      Supported Version Ranges
      report_type v6.4.0 -> latest
      [posture] v7.0.0 -> latest
      [coverage] v7.0.0 -> latest
      [optimization] v7.0.0 -> latest
      [any] v7.0.0 -> latest
      [PostureReport] v6.4.0 -> v6.4.4
      [CoverageReport] v6.4.0 -> v6.4.4
      [OptimizationReport] v6.4.0 -> v6.4.4
    • serial - Fabric connector serial number. type: str more...
      Supported Version Ranges
      serial v7.0.0 -> latest
    • trigger_datetime - Trigger date and time (YYYY-MM-DD HH:MM:SS). type: str more...
      Supported Version Ranges
      trigger_datetime v7.2.1 -> latest
    • trigger_day - Day within a month to trigger. type: int more...
      Supported Version Ranges
      trigger_day v6.0.0 -> latest
    • trigger_frequency - Scheduled trigger frequency . type: str choices: hourly, daily, weekly, monthly, once more...
      Supported Version Ranges
      trigger_frequency v6.0.0 -> latest
      [hourly] v6.0.0 -> latest
      [daily] v6.0.0 -> latest
      [weekly] v6.0.0 -> latest
      [monthly] v6.0.0 -> latest
      [once] v7.2.1 -> latest
    • trigger_hour - Hour of the day on which to trigger (0 - 23). type: int more...
      Supported Version Ranges
      trigger_hour v6.0.0 -> latest
    • trigger_minute - Minute of the hour on which to trigger (0 - 59). type: int more...
      Supported Version Ranges
      trigger_minute v6.0.0 -> latest
    • trigger_type - Trigger type. type: str choices: event-based, scheduled more...
      Supported Version Ranges
      trigger_type v6.0.0 -> latest
      [event-based] v6.0.0 -> latest
      [scheduled] v6.0.0 -> latest
    • trigger_weekday - Day of week for trigger. type: str choices: sunday, monday, tuesday, wednesday, thursday, friday, saturday more...
      Supported Version Ranges
      trigger_weekday v6.0.0 -> latest
      [sunday] v6.0.0 -> latest
      [monday] v6.0.0 -> latest
      [tuesday] v6.0.0 -> latest
      [wednesday] v6.0.0 -> latest
      [thursday] v6.0.0 -> latest
      [friday] v6.0.0 -> latest
      [saturday] v6.0.0 -> latest
    • vdom - Virtual domain(s) that this trigger is valid for. type: list member_path: vdom:name more...
      Supported Version Ranges
      vdom v7.2.0 -> latest
      • name - Virtual domain name. Source system.vdom.name. type: str required: true more...
        Supported Version Ranges
        name v7.2.0 -> latest

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Trigger for automation stitches.
  fortinet.fortios.fortios_system_automation_trigger:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_automation_trigger:
          description: "<your_own_value>"
          event_type: "ioc"
          fabric_event_name: "<your_own_value>"
          fabric_event_severity: "<your_own_value>"
          faz_event_name: "<your_own_value>"
          faz_event_severity: "<your_own_value>"
          faz_event_tags: "<your_own_value>"
          fields:
              -
                  id: "11"
                  name: "default_name_12"
                  value: "<your_own_value>"
          ioc_level: "medium"
          license_type: "forticare-support"
          logid:
              -
                  id: "17"
          name: "default_name_18"
          report_type: "posture"
          serial: "<your_own_value>"
          trigger_datetime: "<your_own_value>"
          trigger_day: "1"
          trigger_frequency: "hourly"
          trigger_hour: "0"
          trigger_minute: "0"
          trigger_type: "event-based"
          trigger_weekday: "sunday"
          vdom:
              -
                  name: "default_name_29 (source system.vdom.name)"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

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

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.