You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

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.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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	Comments
access_token string	Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean	Enable/Disable logging for task. Choices: no ← (default) yes
member_path string	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.
member_state string	Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices: present absent
state string / required	Indicates whether to create or remove the object. Choices: present absent
system_automation_trigger dictionary	Trigger for automation stitches.
description string	Description.
event_type string	Event type. 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
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	IOC threat level. Choices: medium high
license_type string	License type. Choices: forticare-support fortiguard-webfilter fortiguard-antispam fortiguard-antivirus fortiguard-ips fortiguard-management forticloud any
logid integer	Log ID to trigger event.
name string / required	Name.
report_type string	Security Rating report. Choices: PostureReport CoverageReport OptimizationReport posture coverage optimization any
serial string	Fabric connector serial number.
trigger_day integer	Day within a month to trigger.
trigger_frequency string	Scheduled trigger frequency . Choices: hourly daily weekly monthly
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	Trigger type. Choices: event-based scheduled
trigger_weekday string	Day of week for trigger. Choices: sunday monday tuesday wednesday thursday friday saturday
vdom string	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. Default: “root”

Notes

Note

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

Examples

- collections:
  - fortinet.fortios
  connection: httpapi
  hosts: fortigate01
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    vdom: root
  tasks:
  - name: fortios_system_automation_trigger
    fortios_system_automation_trigger:
      vdom: root
      state: present
      system_automation_trigger:
        event_type: event-log
        ioc_level: high
        license_type: forticare-support
        logid: 32002
        name: '1'
        report_type: PostureReport
        trigger_day: 1
        trigger_frequency: daily
        trigger_hour: 0
        trigger_minute: 0
        trigger_type: event-based

Return Values

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

Key	Description
build string	Build number of the fortigate image Returned: always Sample: “1547”
http_method string	Last method used to provision the content into FortiGate Returned: always Sample: “PUT”
http_status string	Last result given by FortiGate on last operation applied Returned: always Sample: “200”
mkey string	Master key (id) used in the last call to FortiGate Returned: success Sample: “id”
name string	Name of the table used to fulfill the request Returned: always Sample: “urlfilter”
path string	Path of the table used to fulfill the request Returned: always Sample: “webfilter”
revision string	Internal revision number Returned: always Sample: “17.0.2.10658”
serial string	Serial number of the unit Returned: always Sample: “FGVMEVYYQT3AB5352”
status string	Indication of the operation’s result Returned: always Sample: “success”
vdom string	Virtual domain used Returned: always Sample: “root”
version string	Version of the FortiGate Returned: always 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)