fortios_system_automation_action – Action for automation stitches in Fortinet’s FortiOS and FortiGate.

New in version 2.9.

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_action 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

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: 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
  • state - Indicates whether to create or remove the object. type: str required: True choices: present, absent
  • system_automation_action - Action for automation stitches. type: dict
    • action_type - Action type. type: str choices: email, ios-notification, alert, disable-ssid, quarantine, quarantine-forticlient, ban-ip, aws-lambda, webhook
    • aws_api_id - AWS API Gateway ID. type: str
    • aws_api_key - AWS API Gateway API key. type: str
    • aws_api_path - AWS API Gateway path. type: str
    • aws_api_stage - AWS API Gateway deployment stage name. type: str
    • aws_region - AWS region. type: str
    • email_subject - Email subject. type: str
    • email_to - Email addresses. type: list
      • name - Email address. type: str required: True
    • headers - Request headers. type: list
      • header - Request header. type: str required: True
    • http_body - Request body (if necessary). Should be serialized json string. type: str
    • method - Request method (GET, POST or PUT). type: str choices: post, put, get
    • minimum_interval - Limit execution to no more than once in this interval (in seconds). type: int
    • name - Name. type: str required: True
    • port - Protocol port. type: int
    • protocol - Request protocol. type: str choices: http, https
    • uri - Request API URI. type: str

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: Action for automation stitches.
    fortios_system_automation_action:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_automation_action:
        action_type: "email"
        aws_api_id: "<your_own_value>"
        aws_api_key: "<your_own_value>"
        aws_api_path: "<your_own_value>"
        aws_api_stage: "<your_own_value>"
        aws_region: "<your_own_value>"
        email_subject: "<your_own_value>"
        email_to:
         -
            name: "default_name_11"
        headers:
         -
            header: "<your_own_value>"
        http_body: "<your_own_value>"
        method: "post"
        minimum_interval: "16"
        name: "default_name_17"
        port: "18"
        protocol: "http"
        uri: "<your_own_value>"

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.