:source: fmgd_wireless_global.py
:orphan:
.. _fmgd_wireless_global:
fmgd_wireless_global -- Configure wireless controller global settings.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 1.0.0
.. 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.2.6 -> v7.2.12, 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
- device - The parameter in requested url type: str required: true
- wireless_global - Configure wireless controller global settings. type: dict
- acd_process_count (Alias name: acd-process-count) Configure the number cw_acd daemons for multi-core cpu support (default = 0). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ap_log_server (Alias name: ap-log-server) Enable/disable configuring fortigate to redirect wireless event log messages or fortiaps to send utm log messages to a syslog server (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ap_log_server_ip (Alias name: ap-log-server-ip) Ip address that fortigate or fortiaps send log messages to. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ap_log_server_port (Alias name: ap-log-server-port) Port that fortigate or fortiaps send log messages to. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- control_message_offload (Alias name: control-message-offload) Configure capwap control message data channel offload. type: list choices: [ebp-frame, aeroscout-tag, ap-list, sta-list, sta-cap-list, stats, aeroscout-mu, sta-health, spectral-analysis]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- data_ethernet_II (Alias name: data-ethernet-II) Configure the wireless controller to use ethernet ii or 802. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dfs_lab_test (Alias name: dfs-lab-test) Enable/disable dfs certificate lab test mode. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- discovery_mc_addr (Alias name: discovery-mc-addr) Multicast ip address for ap discovery (default = 244. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- fiapp_eth_type (Alias name: fiapp-eth-type) Ethernet type for fortinet inter-access point protocol (iapp), or ieee 802. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- image_download (Alias name: image-download) Enable/disable wtp image download at join time. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipsec_base_ip (Alias name: ipsec-base-ip) Base ip address for ipsec vpn tunnels between the access points and the wireless controller (default = 169. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- link_aggregation (Alias name: link-aggregation) Enable/disable calculating the capwap transmit hash to load balance sessions to link aggregation nodes (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- local_radio_vdom (Alias name: local-radio-vdom) Assign local radios virtual domain. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- location Description of the location of the wireless controller. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- max_ble_device (Alias name: max-ble-device) Maximum number of ble devices stored on the controller (default = 0). type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- max_clients (Alias name: max-clients) Maximum number of clients that can connect simultaneously (default = 0, meaning no limitation). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- max_retransmit (Alias name: max-retransmit) Maximum number of tunnel packet retransmissions (0 - 64, default = 3). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- max_rogue_ap (Alias name: max-rogue-ap) Maximum number of rogue aps stored on the controller (default = 0). type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- max_rogue_ap_wtp (Alias name: max-rogue-ap-wtp) Maximum number of rogue aps wtp info stored on the controller (1 - 16, default = 16). type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- max_rogue_sta (Alias name: max-rogue-sta) Maximum number of rogue stations stored on the controller (default = 0). type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- max_sta_cap (Alias name: max-sta-cap) Maximum number of station cap stored on the controller (default = 0). type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- max_sta_cap_wtp (Alias name: max-sta-cap-wtp) Maximum number of station caps wtp info stored on the controller (1 - 16, default = 8). type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- mesh_eth_type (Alias name: mesh-eth-type) Mesh ethernet identifier included in backhaul packets (0 - 65535, default = 8755). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- nac_interval (Alias name: nac-interval) Interval in seconds between two wifi network access control (nac) checks (10 - 600, default = 120). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- name Name of the wireless controller. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- rogue_scan_mac_adjacency (Alias name: rogue-scan-mac-adjacency) Maximum numerical difference between an aps ethernet and wireless mac values to match for rogue detection (0 - 31, default = 7). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- rolling_wtp_upgrade (Alias name: rolling-wtp-upgrade) Enable/disable rolling wtp upgrade (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- rolling_wtp_upgrade_threshold (Alias name: rolling-wtp-upgrade-threshold) Minimum signal level/threshold in dbm required for the managed wtp to be included in rolling wtp upgrade (-95 to -20, default = -80). type: str
more...
Supported Version Ranges: v7.4.3 -> latest
- tunnel_mode (Alias name: tunnel-mode) Compatible/strict tunnel mode. type: str choices: [compatible, strict]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wpad_process_count (Alias name: wpad-process-count) Wpad daemon process count for multi-core cpu support. type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- wtp_share (Alias name: wtp-share) Enable/disable sharing of wtps between vdoms. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- max_wids_entry (Alias name: max-wids-entry) Maximum number of wids entries stored on the controller (default = 0). type: int
more...
Supported Version Ranges: v7.6.2 -> latest
- max_sta_offline (Alias name: max-sta-offline) Maximum number of station offline stored on the controller (default = 0). type: int
more...
Supported Version Ranges: v7.6.3 -> latest
- max_sta_offline_ip2mac (Alias name: max-sta-offline-ip2mac) Maximum number of station offline ip2mac stored on the controller (default = 0). type: int
more...
Supported Version Ranges: v7.6.3 -> latest
- discovery_mc_addr6 (Alias name: discovery-mc-addr6) Multicast ipv6 address for ap discovery (default = ff02::18c). type: str
more...
Supported Version Ranges: v7.6.5 -> 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
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure wireless controller global settings.
fortinet.fmgdevice.fmgd_wireless_global:
# bypass_validation: false
# workspace_locking_adom:
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device:
wireless_global:
# acd_process_count:
# ap_log_server:
# ap_log_server_ip:
# ap_log_server_port:
# control_message_offload:
# - "ebp-frame"
# - "aeroscout-tag"
# - "ap-list"
# - "sta-list"
# - "sta-cap-list"
# - "stats"
# - "aeroscout-mu"
# - "sta-health"
# - "spectral-analysis"
# data_ethernet_II:
# dfs_lab_test:
# discovery_mc_addr:
# fiapp_eth_type:
# image_download:
# ipsec_base_ip:
# link_aggregation:
# local_radio_vdom:
# location:
# max_ble_device:
# max_clients:
# max_retransmit:
# max_rogue_ap:
# max_rogue_ap_wtp:
# max_rogue_sta:
# max_sta_cap:
# max_sta_cap_wtp:
# mesh_eth_type:
# nac_interval:
# name:
# rogue_scan_mac_adjacency:
# rolling_wtp_upgrade:
# rolling_wtp_upgrade_threshold:
# tunnel_mode:
# wpad_process_count:
# wtp_share:
# max_wids_entry:
# max_sta_offline:
# max_sta_offline_ip2mac:
# discovery_mc_addr6:
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)