fmgr_wtpprofile_radio1 – Configuration options for radio 1.¶
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
- adom - The parameter in requested url type: str required: true
- wtp-profile - The parameter in requested url type: str required: true
- wtpprofile_radio1 - Configuration options for radio 1. type: dict
- amsdu - Enable/disable 802. type: str choices: [disable, enable]
- ap-handoff - Enable/disable AP handoff of clients to other APs (default = disable). type: str choices: [disable, enable]
- ap-sniffer-addr - MAC address to monitor. type: str
- ap-sniffer-bufsize - Sniffer buffer size (1 - 32 MB, default = 16). type: int
- ap-sniffer-chan - Channel on which to operate the sniffer (default = 6). type: int
- ap-sniffer-ctl - Enable/disable sniffer on WiFi control frame (default = enable). type: str choices: [disable, enable]
- ap-sniffer-data - Enable/disable sniffer on WiFi data frame (default = enable). type: str choices: [disable, enable]
- ap-sniffer-mgmt-beacon - Enable/disable sniffer on WiFi management Beacon frames (default = enable). type: str choices: [disable, enable]
- ap-sniffer-mgmt-other - Enable/disable sniffer on WiFi management other frames (default = enable). type: str choices: [disable, enable]
- ap-sniffer-mgmt-probe - Enable/disable sniffer on WiFi management probe frames (default = enable). type: str choices: [disable, enable]
- auto-power-high - Automatic transmit power high limit in dBm (the actual range of transmit power depends on the AP platform type). type: int
- auto-power-level - Enable/disable automatic power-level adjustment to prevent co-channel interference (default = disable). type: str choices: [disable, enable]
- auto-power-low - Automatic transmission power low limit in dBm (the actual range of transmit power depends on the AP platform type). type: int
- band - WiFi band that Radio 1 operates on. type: str choices: [802.11b, 802.11a, 802.11g, 802.11n, 802.11ac, 802.11n-5G, 802.11g-only, 802.11n-only, 802.11n,g-only, 802.11ac-only, 802.11ac,n-only, 802.11n-5G-only]
- bandwidth-admission-control - Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. type: str choices: [disable, enable]
- bandwidth-capacity - Maximum bandwidth capacity allowed (1 - 600000 Kbps, default = 2000). type: int
- beacon-interval - Beacon interval. type: int
- call-admission-control - Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. type: str choices: [disable, enable]
- call-capacity - Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60, default = 10). type: int
- channel - No description for the parameter type: str
- channel-bonding - Channel bandwidth: 80, 40, or 20MHz. type: str choices: [disable, enable, 80MHz, 40MHz, 20MHz]
- channel-utilization - Enable/disable measuring channel utilization. type: str choices: [disable, enable]
- coexistence - Enable/disable allowing both HT20 and HT40 on the same radio (default = enable). type: str choices: [disable, enable]
- darrp - Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the most optimal channel (default = disable). type: str choices: [disable, enable]
- dtim - DTIM interval. type: int
- frag-threshold - Maximum packet size that can be sent without fragmentation (800 - 2346 bytes, default = 2346). type: int
- frequency-handoff - Enable/disable frequency handoff of clients to other channels (default = disable). type: str choices: [disable, enable]
- max-clients - Maximum number of stations (STAs) or WiFi clients supported by the radio. type: int
- max-distance - Maximum expected distance between the AP and clients (0 - 54000 m, default = 0). type: int
- mode - Mode of radio 1. type: str choices: [disabled, ap, monitor, sniffer]
- power-level - Radio power level as a percentage of the maximum transmit power (0 - 100, default = 100). type: int
- powersave-optimize - No description for the parameter type: array choices: [tim, ac-vo, no-obss-scan, no-11b-rate, client-rate-follow]
- protection-mode - Enable/disable 802. type: str choices: [rtscts, ctsonly, disable]
- radio-id - No description for the parameter type: int
- rts-threshold - Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 bytes, default = 2346). type: int
- short-guard-interval - Use either the short guard interval (Short GI) of 400 ns or the long guard interval (Long GI) of 800 ns. type: str choices: [disable, enable]
- spectrum-analysis - Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: [disable, enable]
- transmit-optimize - No description for the parameter type: array choices: [disable, power-save, aggr-limit, retry-limit, send-bar]
- vap-all - Enable/disable the automatic inheritance of all Virtual Access Points (VAPs) (default = enable). type: str choices: [disable, enable]
- vaps - Manually selected list of Virtual Access Points (VAPs). type: str
- wids-profile - Wireless Intrusion Detection System (WIDS) profile name to assign to the radio. type: str
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: Configuration options for radio 1.
fmgr_wtpprofile_radio1:
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>
wtp-profile: <your own value>
wtpprofile_radio1:
amsdu: <value in [disable, enable]>
ap-handoff: <value in [disable, enable]>
ap-sniffer-addr: <value of string>
ap-sniffer-bufsize: <value of integer>
ap-sniffer-chan: <value of integer>
ap-sniffer-ctl: <value in [disable, enable]>
ap-sniffer-data: <value in [disable, enable]>
ap-sniffer-mgmt-beacon: <value in [disable, enable]>
ap-sniffer-mgmt-other: <value in [disable, enable]>
ap-sniffer-mgmt-probe: <value in [disable, enable]>
auto-power-high: <value of integer>
auto-power-level: <value in [disable, enable]>
auto-power-low: <value of integer>
band: <value in [802.11b, 802.11a, 802.11g, ...]>
bandwidth-admission-control: <value in [disable, enable]>
bandwidth-capacity: <value of integer>
beacon-interval: <value of integer>
call-admission-control: <value in [disable, enable]>
call-capacity: <value of integer>
channel: <value of string>
channel-bonding: <value in [disable, enable, 80MHz, ...]>
channel-utilization: <value in [disable, enable]>
coexistence: <value in [disable, enable]>
darrp: <value in [disable, enable]>
dtim: <value of integer>
frag-threshold: <value of integer>
frequency-handoff: <value in [disable, enable]>
max-clients: <value of integer>
max-distance: <value of integer>
mode: <value in [disabled, ap, monitor, ...]>
power-level: <value of integer>
powersave-optimize:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
protection-mode: <value in [rtscts, ctsonly, disable]>
radio-id: <value of integer>
rts-threshold: <value of integer>
short-guard-interval: <value in [disable, enable]>
spectrum-analysis: <value in [disable, enable]>
transmit-optimize:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
vap-all: <value in [disable, enable]>
vaps: <value of string>
wids-profile: <value of string>
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