fortinet.fortios.fortios_system_automation_trigger – Trigger for automation stitches in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

To install it use: ansible-galaxy collection install fortinet.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_system_automation_trigger.

New in version 2.10: of fortinet.fortios

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.9.0

Parameters

Parameter Choices/Defaults Comments
access_token
string
Token-based authentication. Generated from GUI of Fortigate.
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task.
state
string / required
    Choices:
  • present
  • absent
Indicates whether to create or remove the object.
system_automation_trigger
dictionary
Trigger for automation stitches.
description
string
Description.
event_type
string
    Choices:
  • ioc
  • event-log
  • reboot
  • low-memory
  • high-cpu
  • license-near-expiry
  • ha-failover
  • config-change
  • security-rating-summary
  • virus-ips-db-updated
  • faz-event
  • incoming-webhook
  • fabric-event
Event type.
fabric_event_name
string
Fabric connector event handler name.
fabric_event_severity
string
Fabric connector event severity.
faz_event_name
string
FortiAnalyzer event handler name.
faz_event_severity
string
FortiAnalyzer event severity.
faz_event_tags
string
FortiAnalyzer event tags.
fields
list / elements=string
Customized trigger field settings.
id
integer / required
Entry ID.
name
string
Name.
value
string
Value.
ioc_level
string
    Choices:
  • medium
  • high
IOC threat level.
license_type
string
    Choices:
  • forticare-support
  • fortiguard-webfilter
  • fortiguard-antispam
  • fortiguard-antivirus
  • fortiguard-ips
  • fortiguard-management
  • forticloud
  • any
License type.
logid
integer
Log ID to trigger event.
name
string / required
Name.
report_type
string
    Choices:
  • PostureReport
  • CoverageReport
  • OptimizationReport
  • posture
  • coverage
  • optimization
  • any
Security Rating report.
serial
string
Fabric connector serial number.
trigger_day
integer
Day within a month to trigger.
trigger_frequency
string
    Choices:
  • hourly
  • daily
  • weekly
  • monthly
Scheduled trigger frequency .
trigger_hour
integer
Hour of the day on which to trigger (0 - 23).
trigger_minute
integer
Minute of the hour on which to trigger (0 - 59, 60 to randomize).
trigger_type
string
    Choices:
  • event-based
  • scheduled
Trigger type.
trigger_weekday
string
    Choices:
  • sunday
  • monday
  • tuesday
  • wednesday
  • thursday
  • friday
  • saturday
Day of week for trigger.
vdom
string
Default:
"root"
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.

Notes

Note

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

Examples

- 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: Trigger for automation stitches.
    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: "16"
        name: "default_name_17"
        report_type: "PostureReport"
        serial: "<your_own_value>"
        trigger_day: "20"
        trigger_frequency: "hourly"
        trigger_hour: "22"
        trigger_minute: "23"
        trigger_type: "event-based"
        trigger_weekday: "sunday"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
build
string
always
Build number of the fortigate image

Sample:
1547
http_method
string
always
Last method used to provision the content into FortiGate

Sample:
PUT
http_status
string
always
Last result given by FortiGate on last operation applied

Sample:
200
mkey
string
success
Master key (id) used in the last call to FortiGate

Sample:
id
name
string
always
Name of the table used to fulfill the request

Sample:
urlfilter
path
string
always
Path of the table used to fulfill the request

Sample:
webfilter
revision
string
always
Internal revision number

Sample:
17.0.2.10658
serial
string
always
Serial number of the unit

Sample:
FGVMEVYYQT3AB5352
status
string
always
Indication of the operation's result

Sample:
success
vdom
string
always
Virtual domain used

Sample:
root
version
string
always
Version of the FortiGate

Sample:
v5.6.3


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)