Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortios.
To use it in a playbook, specify: fortinet.fortios.fortios_wireless_controller_wag_profile.
New in version 2.10: of fortinet.fortios
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| access_token string | Token-based authentication. Generated from GUI of Fortigate. | ||
| enable_log boolean |
| Enable/Disable logging for task. | |
| state string / required |
| Indicates whether to create or remove the object. | |
| 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. | |
| wireless_controller_wag_profile dictionary | Configure wireless access gateway (WAG) profiles used for tunnels on AP. | ||
| comment string | Comment. | ||
| dhcp_ip_addr string | IP address of the monitoring DHCP request packet sent through the tunnel. | ||
| name string / required | Tunnel profile name. | ||
| ping_interval integer | Interval between two tunnel monitoring echo packets (1 - 65535 sec). | ||
| ping_number integer | Number of the tunnel monitoring echo packets (1 - 65535). | ||
| return_packet_timeout integer | Window of time for the return packets from the tunnel"s remote end (1 - 65535 sec). | ||
| tunnel_type string |
| Tunnel type. | |
| wag_ip string | IP Address of the wireless access gateway. | ||
| wag_port integer | UDP port of the wireless access gateway. | ||
Note
- 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: Configure wireless access gateway (WAG) profiles used for tunnels on AP.
fortios_wireless_controller_wag_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_wag_profile:
comment: "Comment."
dhcp_ip_addr: "<your_own_value>"
name: "default_name_5"
ping_interval: "6"
ping_number: "7"
return_packet_timeout: "8"
tunnel_type: "l2tpv3"
wag_ip: "<your_own_value>"
wag_port: "11"
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 |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_wireless_controller_wag_profile_module.html