Note
This plugin is part of the fortinet.fortimanager collection (version 2.0.1).
To install it use: ansible-galaxy collection install fortinet.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_wtpprofile.
New in version 2.10: of fortinet.fortimanager
| Parameter | Choices/Defaults | Comments | ||
|---|---|---|---|---|
| adom string / required | the parameter (adom) in requested url | |||
| bypass_validation boolean |
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters | ||
| rc_failed list / elements=string | the rc codes list with which the conditions to fail will be overriden | |||
| rc_succeeded list / elements=string | the rc codes list with which the conditions to succeed will be overriden | |||
| state string / required |
| the directive to create, update or delete an object | ||
| workspace_locking_adom string | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root | |||
| workspace_locking_timeout integer | Default: 300 | the maximum time in seconds to wait for other user to release the workspace lock | ||
| wtpprofile dictionary | the top level parameters set | |||
| allowaccess list / elements=string |
| no description | ||
| ap-country string |
| Country in which this WTP, FortiAP or AP will operate (default = NA, automatically use the country configured for the current ... | ||
| ble-profile string | Bluetooth Low Energy profile name. | |||
| comment string | Comment. | |||
| control-message-offload list / elements=string |
| no description | ||
| deny-mac-list list / elements=string | no description | |||
| id integer | ID. | |||
| mac string | A WiFi device with this MAC address is denied access to this WTP, FortiAP or AP. | |||
| dtls-in-kernel string |
| Enable/disable data channel DTLS in kernel. | ||
| dtls-policy list / elements=string |
| no description | ||
| energy-efficient-ethernet string |
| Enable/disable use of energy efficient Ethernet on WTP. | ||
| ext-info-enable string |
| Enable/disable station/VAP/radio extension information. | ||
| handoff-roaming string |
| Enable/disable client load balancing during roaming to avoid roaming delay (default = disable). | ||
| handoff-rssi integer | Minimum received signal strength indicator (RSSI) value for handoff (20 - 30, default = 25). | |||
| handoff-sta-thresh integer | Threshold value for AP handoff. | |||
| ip-fragment-preventing list / elements=string |
| no description | ||
| led-schedules string | Recurring firewall schedules for illuminating LEDs on the FortiAP. If led-state is enabled, LEDs will be visible when at least... | |||
| led-state string |
| Enable/disable use of LEDs on WTP (default = disable). | ||
| lldp string |
| Enable/disable Link Layer Discovery Protocol (LLDP) for the WTP, FortiAP, or AP (default = disable). | ||
| login-passwd string | no description | |||
| login-passwd-change string |
| Change or reset the administrator password of a managed WTP, FortiAP or AP (yes, default, or no, default = no). | ||
| max-clients integer | Maximum number of stations (STAs) supported by the WTP (default = 0, meaning no client limitation). | |||
| name string | WTP (or FortiAP or AP) profile name. | |||
| poe-mode string |
| Set the WTP, FortiAP, or APs PoE mode. | ||
| split-tunneling-acl list / elements=string | no description | |||
| dest-ip string | Destination IP and mask for the split-tunneling subnet. | |||
| id integer | ID. | |||
| split-tunneling-acl-local-ap-subnet string |
| Enable/disable automatically adding local subnetwork of FortiAP to split-tunneling ACL (default = disable). | ||
| split-tunneling-acl-path string |
| Split tunneling ACL path is local/tunnel. | ||
| tun-mtu-downlink integer | Downlink CAPWAP tunnel MTU (0, 576, or 1500 bytes, default = 0). | |||
| tun-mtu-uplink integer | Uplink CAPWAP tunnel MTU (0, 576, or 1500 bytes, default = 0). | |||
| wan-port-mode string |
| Enable/disable using a WAN port as a LAN port. | ||
Note
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms.
fmgr_wtpprofile:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
wtpprofile:
allowaccess:
- https
- ssh
- snmp
- http
- telnet
ap-country: <value in [AL, DZ, AR, ...]>
ble-profile: <value of string>
comment: <value of string>
control-message-offload:
- ebp-frame
- aeroscout-tag
- ap-list
- sta-list
- sta-cap-list
- stats
- aeroscout-mu
- sta-health
deny-mac-list:
-
id: <value of integer>
mac: <value of string>
dtls-in-kernel: <value in [disable, enable]>
dtls-policy:
- clear-text
- dtls-enabled
- ipsec-vpn
energy-efficient-ethernet: <value in [disable, enable]>
ext-info-enable: <value in [disable, enable]>
handoff-roaming: <value in [disable, enable]>
handoff-rssi: <value of integer>
handoff-sta-thresh: <value of integer>
ip-fragment-preventing:
- tcp-mss-adjust
- icmp-unreachable
led-schedules: <value of string>
led-state: <value in [disable, enable]>
lldp: <value in [disable, enable]>
login-passwd: <value of string>
login-passwd-change: <value in [no, yes, default]>
max-clients: <value of integer>
name: <value of string>
poe-mode: <value in [auto, 8023af, 8023at, ...]>
split-tunneling-acl:
-
dest-ip: <value of string>
id: <value of integer>
split-tunneling-acl-local-ap-subnet: <value in [disable, enable]>
split-tunneling-acl-path: <value in [tunnel, local]>
tun-mtu-downlink: <value of integer>
tun-mtu-uplink: <value of integer>
wan-port-mode: <value in [wan-lan, wan-only]>
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| request_url string | always | The full url requested Sample: /sys/login/user |
| response_code integer | always | The status of api request |
| response_message string | always | The descriptive message of the api response Sample: OK. |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_wtpprofile_module.html