fortios_system_automation_stitch – Automation stitches in Fortinet’s FortiOS and FortiGate.¶
New in version 2.0.0.
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_stitch category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
FortiOS Version Compatibility¶
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 |
v7.2.4 |
v7.4.0 |
|
fortios_system_automation_stitch | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- 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_stitch - Automation stitches. type: dict more...
- action - Action names. type: list member_path: action:name more...
- name - Action name. Source system.automation-action.name. type: str required: true more...
- actions - Configure stitch actions. type: list member_path: actions:id more...
- action - Action name. Source system.automation-action.name. type: str more...
- delay - Delay before execution (in seconds). type: int more...
- id - Entry ID. type: int required: true more...
- required - Required in action chain. type: str choices: enable, disable more...
- description - Description. type: str more...
- destination - Serial number/HA group-name of destination devices. type: list member_path: destination:name more...
- name - Destination name. Source system.automation-destination.name. type: str required: true more...
- name - Name. type: str required: true more...
- status - Enable/disable this stitch. type: str choices: enable, disable more...
- trigger - Trigger name. Source system.automation-trigger.name. type: str more...
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: Automation stitches.
fortios_system_automation_stitch:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_automation_stitch:
action:
-
name: "default_name_4 (source system.automation-action.name)"
actions:
-
action: "<your_own_value> (source system.automation-action.name)"
delay: "0"
id: "8"
required: "enable"
description: "<your_own_value>"
destination:
-
name: "default_name_12 (source system.automation-destination.name)"
name: "default_name_13"
status: "enable"
trigger: "<your_own_value> (source system.automation-trigger.name)"
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