ansible.builtin.fortios_system_automation_trigger (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

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

Requirements

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

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

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Trigger for automation stitches.
    fortios_system_automation_trigger:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      system_automation_trigger:
        event_type: "ioc"
        ioc_level: "medium"
        license_type: "forticare-support"
        logid: "6"
        name: "default_name_7"
        trigger_day: "8"
        trigger_frequency: "hourly"
        trigger_hour: "10"
        trigger_minute: "11"
        trigger_type: "event-based"
        trigger_weekday: "sunday"

Inputs

    
host:
    description:
    - FortiOS or FortiGate IP address.
    required: false
    type: str

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

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol.
    type: bool

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

password:
    default: ''
    description:
    - FortiOS or FortiGate password.
    type: str

username:
    description:
    - FortiOS or FortiGate username.
    required: false
    type: str

ssl_verify:
    default: true
    description:
    - Ensures FortiGate certificate must be verified by a proper CA.
    type: bool

system_automation_trigger:
    default: null
    description:
    - Trigger for automation stitches.
    suboptions:
      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
        description:
        - Event type.
        type: str
      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
        description:
        - License type.
        type: str
      logid:
        description:
        - Log ID to trigger event.
        type: int
      name:
        description:
        - Name.
        required: true
        type: str
      trigger_day:
        description:
        - Day within a month to trigger.
        type: int
      trigger_frequency:
        choices:
        - hourly
        - daily
        - weekly
        - monthly
        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, 60 to randomize).
        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
    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