fortinet.fortios.fortios_system_automation_action – Action 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_action.

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

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_action
dictionary
Action for automation stitches.
accprofile
string
Access profile for CLI script action to access FortiGate features. Source system.accprofile.name.
action_type
string
    Choices:
  • email
  • ios-notification
  • alert
  • disable-ssid
  • quarantine
  • quarantine-forticlient
  • ban-ip
  • aws-lambda
  • webhook
  • quarantine-nsx
  • azure-function
  • google-cloud-function
  • alicloud-function
  • cli-script
  • quarantine-fortinac
  • slack-notification
  • fortiexplorer-notification
  • microsoft-teams-notification
Action type.
alicloud_access_key_id
string
AliCloud AccessKey ID.
alicloud_access_key_secret
string
AliCloud AccessKey secret.
alicloud_account_id
string
AliCloud account ID.
alicloud_function
string
AliCloud function name.
alicloud_function_authorization
string
    Choices:
  • anonymous
  • function
AliCloud function authorization type.
alicloud_function_domain
string
AliCloud function domain.
alicloud_region
string
AliCloud region.
alicloud_service
string
AliCloud service name.
alicloud_version
string
AliCloud version.
aws_api_id
string
AWS API Gateway ID.
aws_api_key
string
AWS API Gateway API key.
aws_api_path
string
AWS API Gateway path.
aws_api_stage
string
AWS API Gateway deployment stage name.
aws_domain
string
AWS domain.
aws_region
string
AWS region.
azure_api_key
string
Azure function API key.
azure_app
string
Azure function application name.
azure_domain
string
Azure function domain.
azure_function
string
Azure function name.
azure_function_authorization
string
    Choices:
  • anonymous
  • function
  • admin
Azure function authorization level.
delay
integer
Delay before execution (in seconds).
description
string
Description.
email_body
string
Email body.
email_from
string
Email sender name.
email_subject
string
Email subject.
email_to
list / elements=string
Email addresses.
name
string / required
Email address.
gcp_function
string
Google Cloud function name.
gcp_function_domain
string
Google Cloud function domain.
gcp_function_region
string
Google Cloud function region.
gcp_project
string
Google Cloud Platform project name.
headers
list / elements=string
Request headers.
header
string / required
Request header.
http_body
string
Request body (if necessary). Should be serialized json string.
message
string
Message content.
message_type
string
    Choices:
  • text
  • json
Message type.
method
string
    Choices:
  • post
  • put
  • get
  • patch
  • delete
Request method (GET, POST or PUT).
minimum_interval
integer
Limit execution to no more than once in this interval (in seconds).
name
string / required
Name.
port
integer
Protocol port.
protocol
string
    Choices:
  • http
  • https
Request protocol.
replacement_message
string
    Choices:
  • enable
  • disable
Enable/disable replacement message.
replacemsg_group
string
Replacement message group. Source system.replacemsg-group.name.
required
string
    Choices:
  • enable
  • disable
Required in action chain.
script
string
CLI script.
sdn_connector
list / elements=string
NSX SDN connector names.
name
string / required
SDN connector name. Source system.sdn-connector.name.
security_tag
string
NSX security tag.
tls_certificate
string
Custom TLS certificate for API request. Source certificate.local.name.
uri
string
Request API URI.
verify_host_cert
string
    Choices:
  • enable
  • disable
Enable/disable verification of the remote host certificate.
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: Action for automation stitches.
    fortios_system_automation_action:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_automation_action:
        accprofile: "<your_own_value> (source system.accprofile.name)"
        action_type: "email"
        alicloud_access_key_id: "<your_own_value>"
        alicloud_access_key_secret: "<your_own_value>"
        alicloud_account_id: "<your_own_value>"
        alicloud_function: "<your_own_value>"
        alicloud_function_authorization: "anonymous"
        alicloud_function_domain: "<your_own_value>"
        alicloud_region: "<your_own_value>"
        alicloud_service: "<your_own_value>"
        alicloud_version: "<your_own_value>"
        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_domain: "<your_own_value>"
        aws_region: "<your_own_value>"
        azure_api_key: "<your_own_value>"
        azure_app: "<your_own_value>"
        azure_domain: "<your_own_value>"
        azure_function: "<your_own_value>"
        azure_function_authorization: "anonymous"
        delay: "25"
        description: "<your_own_value>"
        email_body: "<your_own_value>"
        email_from: "<your_own_value>"
        email_subject: "<your_own_value>"
        email_to:
         -
            name: "default_name_31"
        gcp_function: "<your_own_value>"
        gcp_function_domain: "<your_own_value>"
        gcp_function_region: "<your_own_value>"
        gcp_project: "<your_own_value>"
        headers:
         -
            header: "<your_own_value>"
        http_body: "<your_own_value>"
        message: "<your_own_value>"
        message_type: "text"
        method: "post"
        minimum_interval: "42"
        name: "default_name_43"
        port: "44"
        protocol: "http"
        replacement_message: "enable"
        replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
        required: "enable"
        script: "<your_own_value>"
        sdn_connector:
         -
            name: "default_name_51 (source system.sdn-connector.name)"
        security_tag: "<your_own_value>"
        tls_certificate: "<your_own_value> (source certificate.local.name)"
        uri: "<your_own_value>"
        verify_host_cert: "enable"

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)