source: | fortios_system_automation_action.py |
---|---|
orphan: |
fortios_system_automation_action -- Action for automation stitches in Fortinet's FortiOS and FortiGate.
.. versionadded:: 2.0.0
- 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
The below requirements are needed on the host that executes this module.
- ansible>=2.9
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
|
fortios_system_automation_action | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: 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
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- 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
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
system_automation_action yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - accprofile - Access profile for CLI script action to access FortiGate features. Source system.accprofile.name. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
accprofile no no no no no no no no no no yes yes yes yes yes yes yes yes yes yes yes yes - action_type - Action type. type: str choices: email, fortiexplorer-notification, alert, disable-ssid, system-actions, quarantine, quarantine-forticlient, quarantine-nsx, quarantine-fortinac, ban-ip, aws-lambda, azure-function, google-cloud-function, alicloud-function, webhook, cli-script, slack-notification, microsoft-teams-notification, ios-notification
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
action_type yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [email] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [fortiexplorer-notification] no no no no no no no no no no yes yes yes yes yes yes yes yes yes yes yes yes [alert] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [disable-ssid] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [system-actions] no no no no no no no no no no no no no no no no no no no no yes yes [quarantine] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [quarantine-forticlient] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [quarantine-nsx] no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [quarantine-fortinac] no no no no no no no yes no yes yes yes yes yes yes yes yes yes yes yes yes yes [ban-ip] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [aws-lambda] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [azure-function] no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [google-cloud-function] no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [alicloud-function] no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [webhook] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [cli-script] no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [slack-notification] no no no no no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [microsoft-teams-notification] no no no no no no no no no no yes yes yes yes yes yes yes yes yes yes yes yes [ios-notification] yes yes yes yes yes yes yes yes yes yes n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a - alicloud_access_key_id - AliCloud AccessKey ID. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
alicloud_access_key_id no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - alicloud_access_key_secret - AliCloud AccessKey secret. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
alicloud_access_key_secret no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - alicloud_account_id - AliCloud account ID. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
alicloud_account_id no no no yes yes yes yes yes yes yes - alicloud_function - AliCloud function name. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
alicloud_function no no no yes yes yes yes yes yes yes - alicloud_function_authorization - AliCloud function authorization type. type: str choices: anonymous, function
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
alicloud_function_authorization no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [anonymous] n/a n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [function] n/a n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - alicloud_function_domain - AliCloud function domain. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
alicloud_function_domain no no no yes yes yes yes yes yes yes - alicloud_region - AliCloud region. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
alicloud_region no no no yes yes yes yes yes yes yes - alicloud_service - AliCloud service name. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
alicloud_service no no no yes yes yes yes yes yes yes - alicloud_version - AliCloud version. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
alicloud_version no no no yes yes yes yes yes yes yes - aws_api_id - AWS API Gateway ID. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
aws_api_id yes yes yes yes yes yes yes yes yes yes - aws_api_key - AWS API Gateway API key. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
aws_api_key yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - aws_api_path - AWS API Gateway path. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
aws_api_path yes yes yes yes yes yes yes yes yes yes - aws_api_stage - AWS API Gateway deployment stage name. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
aws_api_stage yes yes yes yes yes yes yes yes yes yes - aws_domain - AWS domain. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
aws_domain yes yes yes yes yes yes yes yes yes yes - aws_region - AWS region. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
aws_region yes yes yes yes yes yes yes yes yes yes - azure_api_key - Azure function API key. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
azure_api_key no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - azure_app - Azure function application name. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
azure_app no no no yes yes yes yes yes yes yes - azure_domain - Azure function domain. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
azure_domain no no no yes yes yes yes yes yes yes - azure_function - Azure function name. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
azure_function no no no yes yes yes yes yes yes yes - azure_function_authorization - Azure function authorization level. type: str choices: anonymous, function, admin
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
azure_function_authorization no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [anonymous] n/a n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [function] n/a n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [admin] n/a n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - delay - Delay before execution (in seconds). type: int
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
delay yes yes yes yes yes yes yes yes yes yes yes - description - Description. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
description no no no no no no no no no no yes yes yes yes yes yes yes yes yes yes yes yes - email_body - Email body. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
email_body no no no yes yes yes yes - email_from - Email sender name. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
email_from no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - email_subject - Email subject. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
email_subject yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - email_to - Email addresses. type: list
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
email_to yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - Email address. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - execute_security_fabric - Enable/disable execution of CLI script on all or only one FortiGate unit in the Security Fabric. type: str choices: enable, disable
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
execute_security_fabric no no no no no no no no no no no no yes yes yes yes yes yes yes yes yes yes [enable] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes yes yes yes yes yes yes yes yes yes [disable] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes yes yes yes yes yes yes yes yes yes - gcp_function - Google Cloud function name. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
gcp_function no no no yes yes yes yes yes yes yes - gcp_function_domain - Google Cloud function domain. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
gcp_function_domain no no no yes yes yes yes yes yes yes - gcp_function_region - Google Cloud function region. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
gcp_function_region no no no yes yes yes yes yes yes yes - gcp_project - Google Cloud Platform project name. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
gcp_project no no no yes yes yes yes yes yes yes - headers - Request headers. type: list
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
headers yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes no no no yes - header - Request header. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.2.0
header yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - http_body - Request body (if necessary). Should be serialized json string. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
http_body yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - http_headers - Request headers. type: list
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
http_headers no no no no no no no no no no no no no no no no yes yes yes no yes yes - id - Entry ID. type: int
more...
v7.0.6
v7.0.7
v7.0.8
v7.2.1
v7.2.2
id yes yes yes yes yes - key - Request header key. type: str
more...
v7.0.6
v7.0.7
v7.0.8
v7.2.1
v7.2.2
key yes yes yes yes yes - value - Request header value. type: str
more...
v7.0.6
v7.0.7
v7.0.8
v7.2.1
v7.2.2
value yes yes yes yes yes - message - Message content. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
message no no no no no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - message_type - Message type. type: str choices: text, json
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
message_type no no no no no no no no no no yes yes yes yes yes yes yes yes yes yes yes yes [text] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes [json] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes - method - Request method (POST, PUT, GET, PATCH or DELETE). type: str choices: post, put, get, patch, delete
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
method yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [post] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [put] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [get] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [patch] no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [delete] no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - minimum_interval - Limit execution to no more than once in this interval (in seconds). type: int
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
minimum_interval yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - Name. type: str required: true
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - output_size - Number of megabytes to limit script output to (1 - 1024). type: int
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
output_size no no no no no no no no no no no no no no no no no no no yes yes yes - port - Protocol port. type: int
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
port yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - protocol - Request protocol. type: str choices: http, https
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
protocol yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [http] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [https] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - replacement_message - Enable/disable replacement message. type: str choices: enable, disable
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
replacement_message no no no no no no no no no no yes yes yes yes yes yes yes yes yes yes yes yes [enable] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes [disable] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes - replacemsg_group - Replacement message group. Source system.replacemsg-group.name. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
replacemsg_group no no no no no no no no no no yes yes yes yes yes yes yes yes yes yes yes yes - required - Required in action chain. type: str choices: enable, disable
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
required yes yes yes yes yes yes yes yes yes yes yes [enable] yes yes yes yes yes yes yes yes yes yes yes [disable] yes yes yes yes yes yes yes yes yes yes yes - script - CLI script. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
script no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - sdn_connector - NSX SDN connector names. type: list
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
sdn_connector no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - SDN connector name. Source system.sdn-connector.name. type: str
more...
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - security_tag - NSX security tag. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
security_tag no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - system_action - System action type. type: str choices: reboot, shutdown, backup-config
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
system_action no no no no no no no no no no no no no no no no no no no no yes yes [reboot] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes yes [shutdown] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes yes [backup-config] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes yes - timeout - Maximum running time for this script in seconds (0 = no timeout). type: int
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
timeout no no no no no no no no no no no no no no no no no no no yes yes yes - tls_certificate - Custom TLS certificate for API request. Source certificate.local.name. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
tls_certificate no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - uri - Request API URI. type: str
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
uri yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - verify_host_cert - Enable/disable verification of the remote host certificate. type: str choices: enable, disable
more...
v6.0.0
v6.0.5
v6.0.11
v6.2.0
v6.2.3
v6.2.5
v6.2.7
v6.4.0
v6.4.1
v6.4.4
v7.0.0
v7.0.1
v7.0.2
v7.0.3
v7.0.4
v7.0.5
v7.0.6
v7.0.7
v7.0.8
v7.2.0
v7.2.1
v7.2.2
verify_host_cert no no no no no no no no no no yes yes yes yes yes yes yes yes yes yes yes yes [enable] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes [disable] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- 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: "0"
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"
execute_security_fabric: "enable"
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>"
http_headers:
-
id: "41"
key: "<your_own_value>"
value: "<your_own_value>"
message: "<your_own_value>"
message_type: "text"
method: "post"
minimum_interval: "0"
name: "default_name_48"
output_size: "10"
port: "0"
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_57 (source system.sdn-connector.name)"
security_tag: "<your_own_value>"
system_action: "reboot"
timeout: "0"
tls_certificate: "<your_own_value> (source certificate.local.name)"
uri: "<your_own_value>"
verify_host_cert: "enable"
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
- This module is not guaranteed to have a backwards compatible interface.
- 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.