fortios_wireless_controller_wag_profile – Configure wireless access gateway (WAG) profiles used for tunnels on AP 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 wireless_controller feature and wag_profile 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.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_wireless_controller_wag_profile | 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
- wireless_controller_wag_profile - Configure wireless access gateway (WAG) profiles used for tunnels on AP. type: dict more...
- comment - Comment. type: str more...
- dhcp_ip_addr - IP address of the monitoring DHCP request packet sent through the tunnel. type: str more...
- name - Tunnel profile name. type: str required: true more...
- ping_interval - Interval between two tunnel monitoring echo packets (1 - 65535 sec). type: int more...
- ping_number - Number of the tunnel monitoring echo packets (1 - 65535). type: int more...
- return_packet_timeout - Window of time for the return packets from the tunnel"s remote end (1 - 65535 sec). type: int more...
- tunnel_type - Tunnel type. type: str choices: l2tpv3, gre more...
- wag_ip - IP Address of the wireless access gateway. type: str more...
- wag_port - UDP port of the wireless access gateway. type: int 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: 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: "1"
ping_number: "5"
return_packet_timeout: "160"
tunnel_type: "l2tpv3"
wag_ip: "<your_own_value>"
wag_port: "1701"
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