:source: fmgr_extensioncontroller_extenderprofile_wifi.py
:orphan:
.. _fmgr_extensioncontroller_extenderprofile_wifi:
fmgr_extensioncontroller_extenderprofile_wifi -- FortiExtender wifi configuration.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.6.0
.. warning::
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0: ``var-name``, ``var name``, ``var.name``
- New argument name starting in 3.0.0: ``var_name``
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name.
You will receive deprecation warnings if you keep using the previous argument name.
You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
.. contents::
:local:
:depth: 1
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 v7.x.
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible-core>=2.16.0
FortiManager Version Compatibility
----------------------------------
.. raw:: html
Supported Version Ranges: v7.4.3 -> latest
Parameters
----------
.. raw:: html
- access_token -The token to access FortiManager without using username and password. type: str required: false
- 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
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- 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
- 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
- revision_note - The change note that can be specified when an object is created or updated. type: string required: false
- adom - The parameter in requested url type: str required: true
- extender_profile - The parameter in requested url type: str required: true
- extensioncontroller_extenderprofile_wifi - FortiExtender wifi configuration. type: dict
- DFS Wi-fi 5g radio dfs channel enable/disable. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- country Country in which this fex will operate (default = na). 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, IE, IL, IT, JM, JP, JO, KZ, KE, 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, TW, TH, TT, TN, TR, AE, UA, GB, US, PS, UY, UZ, VE, VN, YE, ZW, NA, BS, VC, KH, MV, AF, NG, TZ, ZM, SN, CI, GH, CM, MW, AO, GA, ML, BJ, MG, TD, BW, LY, RW, MZ, GM, LS, MU, CG, UG, BF, SL, SO, CD, NE, CF, SZ, TG, LR, MR, DJ, RE, RS, ME, IQ, MD, KY, BB, BM, TC, VI, PM, MF, GD, IM, FO, GI, GL, TM, MN, VU, FJ, LA, GU, WF, MH, BT, FM, PF, NI, PY, HT, GY, AW, KN, GF, AS, MP, PW, MM, LC, GP, ET, SR, CX, DM, MQ, YT, BL, --, TL]
more...
Supported Version Ranges: v7.4.3 -> latest
- radio_1 (Alias name: radio-1) Radio 1. type: dict
more...
Supported Version Ranges: v7.4.3 -> latest
- d80211d (Alias name: 80211d) Enable/disable wi-fi 802. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- band Wi-fi band selection 2. type: str choices: [2.4GHz]
more...
Supported Version Ranges: v7.4.3 -> latest
- bandwidth Wi-fi channel bandwidth. type: str choices: [auto, 20MHz, 40MHz, 80MHz]
more...
Supported Version Ranges: v7.4.3 -> latest
- beacon_interval (Alias name: beacon-interval) Wi-fi beacon interval in miliseconds (100 - 3500, default = 100). type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- bss_color (Alias name: bss-color) Wi-fi 802. type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- bss_color_mode (Alias name: bss-color-mode) Wi-fi 802. type: str choices: [auto, static]
more...
Supported Version Ranges: v7.4.3 -> latest
- channel Wi-fi channels. type: list choices: [CH1, CH2, CH3, CH4, CH5, CH6, CH7, CH8, CH9, CH10, CH11]
more...
Supported Version Ranges: v7.4.3 -> latest
- extension_channel (Alias name: extension-channel) Wi-fi extension channel. type: str choices: [auto, higher, lower]
more...
Supported Version Ranges: v7.4.3 -> latest
- guard_interval (Alias name: guard-interval) Wi-fi guard interval. type: str choices: [auto, 400ns, 800ns]
more...
Supported Version Ranges: v7.4.3 -> latest
- lan_ext_vap (Alias name: lan-ext-vap) Wi-fi lan-extention vap. type: list
more...
Supported Version Ranges: v7.4.3 -> latest
- local_vaps (Alias name: local-vaps) Wi-fi local vap. type: list
more...
Supported Version Ranges: v7.4.3 -> latest
- max_clients (Alias name: max-clients) Maximum number of wi-fi radio clients (0 - 512, 0 = unlimited, default = 0). type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- mode Wi-fi radio mode ap(lan mode) / client(wan mode). type: str choices: [AP, Client]
more...
Supported Version Ranges: v7.4.3 -> latest
- operating_standard (Alias name: operating-standard) Wi-fi operating standard. type: str choices: [auto, 11A-N-AC-AX, 11A-N-AC, 11A-N, 11A, 11N-AC-AX, 11AC-AX, 11AC, 11N-AC, 11B-G-N-AX, 11B-G-N, 11B-G, 11B, 11G-N-AX, 11N-AX, 11AX, 11G-N, 11N, 11G]
more...
Supported Version Ranges: v7.4.3 -> latest
- power_level (Alias name: power-level) Wi-fi power level in percent (0 - 100, 0 = auto, default = 100). type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- radio_id (Alias name: radio-id) Radio id. type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- status Enable/disable wi-fi radio. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- radio_2 (Alias name: radio-2) Radio 2. type: dict
more...
Supported Version Ranges: v7.4.3 -> latest
- d80211d (Alias name: 80211d) Enable/disable wi-fi 802. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- band Wi-fi band selection 2. type: str choices: [5GHz]
more...
Supported Version Ranges: v7.4.3 -> latest
- bandwidth Wi-fi channel bandwidth. type: str choices: [auto, 20MHz, 40MHz, 80MHz]
more...
Supported Version Ranges: v7.4.3 -> latest
- beacon_interval (Alias name: beacon-interval) Wi-fi beacon interval in miliseconds (100 - 3500, default = 100). type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- bss_color (Alias name: bss-color) Wi-fi 802. type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- bss_color_mode (Alias name: bss-color-mode) Wi-fi 802. type: str choices: [auto, static]
more...
Supported Version Ranges: v7.4.3 -> latest
- channel Wi-fi channels. type: list choices: [CH36, CH40, CH44, CH48, CH52, CH56, CH60, CH64, CH100, CH104, CH108, CH112, CH116, CH120, CH124, CH128, CH132, CH136, CH140, CH144, CH149, CH153, CH157, CH161, CH165]
more...
Supported Version Ranges: v7.4.3 -> latest
- extension_channel (Alias name: extension-channel) Wi-fi extension channel. type: str choices: [auto, higher, lower]
more...
Supported Version Ranges: v7.4.3 -> latest
- guard_interval (Alias name: guard-interval) Wi-fi guard interval. type: str choices: [auto, 400ns, 800ns]
more...
Supported Version Ranges: v7.4.3 -> latest
- lan_ext_vap (Alias name: lan-ext-vap) Wi-fi lan-extention vap. type: list
more...
Supported Version Ranges: v7.4.3 -> latest
- local_vaps (Alias name: local-vaps) Wi-fi local vap. type: list
more...
Supported Version Ranges: v7.4.3 -> latest
- max_clients (Alias name: max-clients) Maximum number of wi-fi radio clients (0 - 512, 0 = unlimited, default = 0). type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- mode Wi-fi radio mode ap(lan mode) / client(wan mode). type: str choices: [AP, Client]
more...
Supported Version Ranges: v7.4.3 -> latest
- operating_standard (Alias name: operating-standard) Wi-fi operating standard. type: str choices: [auto, 11A-N-AC-AX, 11A-N-AC, 11A-N, 11A, 11N-AC-AX, 11AC-AX, 11AC, 11N-AC, 11B-G-N-AX, 11B-G-N, 11B-G, 11B, 11G-N-AX, 11N-AX, 11AX, 11G-N, 11N, 11G]
more...
Supported Version Ranges: v7.4.3 -> latest
- power_level (Alias name: power-level) Wi-fi power level in percent (0 - 100, 0 = auto, default = 100). type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- radio_id (Alias name: radio-id) Radio id. type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- status Enable/disable wi-fi radio. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
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
--------
.. code-block:: yaml+jinja
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: FortiExtender wifi configuration.
fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_wifi:
# workspace_locking_adom:
adom:
extender_profile:
extensioncontroller_extenderprofile_wifi:
# DFS:
# country:
# radio_1:
# d80211d:
# band:
# bandwidth:
# beacon_interval:
# bss_color:
# bss_color_mode:
# channel: ["CH1", "CH2", "CH3", "CH4", "CH5", "CH6", "CH7", "CH8", "CH9", "CH10",
# "CH11"]
# extension_channel:
# guard_interval:
# lan_ext_vap:
# local_vaps:
# max_clients:
# mode:
# operating_standard:
# power_level:
# radio_id:
# status:
# radio_2:
# d80211d:
# band:
# bandwidth:
# beacon_interval:
# bss_color:
# bss_color_mode:
# channel: ["CH36", "CH40", "CH44", "CH48", "CH52", "CH56", "CH60", "CH64", "CH100",
# "CH104", "CH108", "CH112", "CH116", "CH120", "CH124", "CH128", "CH132",
# "CH136", "CH140", "CH144", "CH149", "CH153", "CH157", "CH161", "CH165"]
# extension_channel:
# guard_interval:
# lan_ext_vap:
# local_vaps:
# max_clients:
# mode:
# operating_standard:
# power_level:
# radio_id:
# status:
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:
.. raw:: html
- meta - The result of the request.returned: always type: dict
- 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_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)