Try SpotterTrigger for automation stitches in Fortinet's FortiOS and FortiGate.
| "added in version" 2.0.0 of lix_fortinet.fortios"
Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)
preview | supported by community
Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120
collections:
- name: lix_fortinet.fortios
version: 102.2.120This 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
- 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:
-
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)"
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
state:
choices:
- present
- absent
description:
- Indicates whether to create or remove the object.
required: true
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
system_automation_trigger:
default: null
description:
- Trigger for automation stitches.
suboptions:
description:
description:
- Description.
type: str
event_type:
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
description:
- Event type.
type: str
fabric_event_name:
description:
- Fabric connector event handler name.
type: str
fabric_event_severity:
description:
- Fabric connector event severity.
type: str
faz_event_name:
description:
- FortiAnalyzer event handler name.
type: str
faz_event_severity:
description:
- FortiAnalyzer event severity.
type: str
faz_event_tags:
description:
- FortiAnalyzer event tags.
type: str
fields:
description:
- Customized trigger field settings.
elements: dict
suboptions:
id:
description:
- Entry ID.
type: int
name:
description:
- Name.
type: str
value:
description:
- Value.
type: str
type: list
ioc_level:
choices:
- medium
- high
description:
- IOC threat level.
type: str
license_type:
choices:
- forticare-support
- fortiguard-webfilter
- fortiguard-antispam
- fortiguard-antivirus
- fortiguard-ips
- fortiguard-management
- forticloud
- any
description:
- License type.
type: str
logid:
description:
- Log IDs to trigger event.
elements: dict
suboptions:
id:
description:
- Log ID.
type: int
type: list
name:
description:
- Name.
required: true
type: str
report_type:
choices:
- posture
- coverage
- optimization
- any
- PostureReport
- CoverageReport
- OptimizationReport
description:
- Security Rating report.
type: str
serial:
description:
- Fabric connector serial number.
type: str
trigger_datetime:
description:
- Trigger date and time (YYYY-MM-DD HH:MM:SS).
type: str
trigger_day:
description:
- Day within a month to trigger.
type: int
trigger_frequency:
choices:
- hourly
- daily
- weekly
- monthly
- once
description:
- Scheduled trigger frequency .
type: str
trigger_hour:
description:
- Hour of the day on which to trigger (0 - 23).
type: int
trigger_minute:
description:
- Minute of the hour on which to trigger (0 - 59).
type: int
trigger_type:
choices:
- event-based
- scheduled
description:
- Trigger type.
type: str
trigger_weekday:
choices:
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
description:
- Day of week for trigger.
type: str
vdom:
description:
- Virtual domain(s) that this trigger is valid for.
elements: dict
suboptions:
name:
description:
- Virtual domain name. Source system.vdom.name.
type: str
type: list
type: dict
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