fmgr_wtpprofile – Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- wtpprofile - Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms. type: dict
- allowaccess - No description for the parameter type: array choices: [https, ssh, snmp, http, telnet]
- ap-country - Country in which this WTP, FortiAP or AP will operate (default = NA, automatically use the country configured for the current VDOM). type: str choices: [AL, DZ, AR, AM, AU, AT, AZ, BH, BD, BY, BE, BZ, BO, BA, BR, BN, BG, CA, CL, CN, CO, CR, HR, CY, CZ, DK, DO, EC, EG, SV, EE, FI, FR, GE, DE, GR, GT, HN, HK, HU, IS, IN, ID, IR, IE, IL, IT, JM, JP, JO, KZ, KE, KP, KR, KW, LV, LB, LI, LT, LU, MO, MK, MY, MT, MX, MC, MA, NP, NL, AN, NZ, NO, OM, PK, PA, PG, PE, PH, PL, PT, PR, QA, RO, RU, SA, SG, SK, SI, ZA, ES, LK, SE, CH, SY, TW, TH, TT, TN, TR, AE, UA, GB, US, PS, UY, UZ, VE, VN, YE, ZW, NA, KH, TZ, SD, AO, RW, MZ, RS, ME, BB, GD, GL, GU, PY, HT, AW, MM, ZB]
- ble-profile - Bluetooth Low Energy profile name. type: str
- comment - Comment. type: str
- control-message-offload - No description for the parameter type: array choices: [ebp-frame, aeroscout-tag, ap-list, sta-list, sta-cap-list, stats, aeroscout-mu, sta-health]
- deny-mac-list - No description for the parameter type: array
- id - ID. type: int
- mac - A WiFi device with this MAC address is denied access to this WTP, FortiAP or AP. type: str
- dtls-in-kernel - Enable/disable data channel DTLS in kernel. type: str choices: [disable, enable]
- dtls-policy - No description for the parameter type: array choices: [clear-text, dtls-enabled, ipsec-vpn]
- energy-efficient-ethernet - Enable/disable use of energy efficient Ethernet on WTP. type: str choices: [disable, enable]
- ext-info-enable - Enable/disable station/VAP/radio extension information. type: str choices: [disable, enable]
- handoff-roaming - Enable/disable client load balancing during roaming to avoid roaming delay (default = disable). type: str choices: [disable, enable]
- handoff-rssi - Minimum received signal strength indicator (RSSI) value for handoff (20 - 30, default = 25). type: int
- handoff-sta-thresh - Threshold value for AP handoff. type: int
- ip-fragment-preventing - No description for the parameter type: array choices: [tcp-mss-adjust, icmp-unreachable]
- led-schedules - Recurring firewall schedules for illuminating LEDs on the FortiAP. type: str
- led-state - Enable/disable use of LEDs on WTP (default = disable). type: str choices: [disable, enable]
- lldp - Enable/disable Link Layer Discovery Protocol (LLDP) for the WTP, FortiAP, or AP (default = disable). type: str choices: [disable, enable]
- login-passwd - No description for the parameter type: str
- login-passwd-change - Change or reset the administrator password of a managed WTP, FortiAP or AP (yes, default, or no, default = no). type: str choices: [no, yes, default]
- max-clients - Maximum number of stations (STAs) supported by the WTP (default = 0, meaning no client limitation). type: int
- name - WTP (or FortiAP or AP) profile name. type: str
- poe-mode - Set the WTP, FortiAP, or APs PoE mode. type: str choices: [auto, 8023af, 8023at, power-adapter]
- split-tunneling-acl - No description for the parameter type: array
- dest-ip - Destination IP and mask for the split-tunneling subnet. type: str
- id - ID. type: int
- split-tunneling-acl-local-ap-subnet - Enable/disable automatically adding local subnetwork of FortiAP to split-tunneling ACL (default = disable). type: str choices: [disable, enable]
- split-tunneling-acl-path - Split tunneling ACL path is local/tunnel. type: str choices: [tunnel, local]
- tun-mtu-downlink - Downlink CAPWAP tunnel MTU (0, 576, or 1500 bytes, default = 0). type: int
- tun-mtu-uplink - Uplink CAPWAP tunnel MTU (0, 576, or 1500 bytes, default = 0). type: int
- wan-port-mode - Enable/disable using a WAN port as a LAN port. type: str choices: [wan-lan, wan-only]
Notes¶
Note
- Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
- To create or update an object, use state: present directive.
- To delete an object, use state: absent directive
- Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples¶
- 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]>
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:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict