fmgr_wtpprofile_radio2 – Configuration options for radio 2.

New in version 2.0.0.

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.x and v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0
True
6.2.0 6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.2.7 6.2.8 6.2.9 6.2.10 6.2.11
True True True True True True True True True True True
6.4.0 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 6.4.6 6.4.7 6.4.8 6.4.9 6.4.10 6.4.11 6.4.12
True True True True True True True True True True True True True
7.0.0 7.0.1 7.0.2 7.0.3 7.0.4 7.0.5 7.0.6 7.0.7 7.0.8
True True True True True True True True True
7.2.0 7.2.1 7.2.2 7.2.3
True True True True
7.4.0
True

Parameters

  • 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
  • adom - The parameter in requested url type: str required: true
  • wtp-profile - The parameter in requested url type: str required: true
  • wtpprofile_radio2 - Configuration options for radio 2. type: dict
    • amsdu - Enable/disable 802. type: str choices: [disable, enable] more...
    • ap-handoff - Enable/disable AP handoff of clients to other APs (default = disable). type: str choices: [disable, enable] more...
    • ap-sniffer-addr - MAC address to monitor. type: str more...
    • ap-sniffer-bufsize - Sniffer buffer size (1 - 32 MB, default = 16). type: int more...
    • ap-sniffer-chan - Channel on which to operate the sniffer (default = 6). type: int more...
    • ap-sniffer-ctl - Enable/disable sniffer on WiFi control frame (default = enable). type: str choices: [disable, enable] more...
    • ap-sniffer-data - Enable/disable sniffer on WiFi data frame (default = enable). type: str choices: [disable, enable] more...
    • ap-sniffer-mgmt-beacon - Enable/disable sniffer on WiFi management Beacon frames (default = enable). type: str choices: [disable, enable] more...
    • ap-sniffer-mgmt-other - Enable/disable sniffer on WiFi management other frames (default = enable). type: str choices: [disable, enable] more...
    • ap-sniffer-mgmt-probe - Enable/disable sniffer on WiFi management probe frames (default = enable). type: str choices: [disable, enable] more...
    • auto-power-high - Automatic transmit power high limit in dBm (the actual range of transmit power depends on the AP platform type). type: int more...
    • auto-power-level - Enable/disable automatic power-level adjustment to prevent co-channel interference (default = disable). type: str choices: [disable, enable] more...
    • auto-power-low - Automatic transmission power low limit in dBm (the actual range of transmit power depends on the AP platform type). type: int more...
    • band - WiFi band that Radio 2 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, 802.11ax-5G, 802.11ax, 802.11ax-5G-only, 802.11ax,ac-only, 802.11ax,ac,n-only, 802.11ax-only, 802.11ax,n-only, 802.11ax,n,g-only, 802.11ac-2G, 802.11ax-6G] more...
    • bandwidth-admission-control - Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. type: str choices: [disable, enable] more...
    • bandwidth-capacity - Maximum bandwidth capacity allowed (1 - 600000 Kbps, default = 2000). type: int more...
    • beacon-interval - Beacon interval. type: int more...
    • call-admission-control - Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. type: str choices: [disable, enable] more...
    • call-capacity - Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60, default = 10). type: int more...
    • channel - No description for the parameter type: str more...
    • channel-bonding - Channel bandwidth: 80, 40, or 20MHz. type: str choices: [disable, enable, 80MHz, 40MHz, 20MHz, 160MHz] more...
    • channel-utilization - Enable/disable measuring channel utilization. type: str choices: [disable, enable] more...
    • coexistence - Enable/disable allowing both HT20 and HT40 on the same radio (default = enable). type: str choices: [disable, enable] more...
    • 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] more...
    • dtim - DTIM interval. type: int more...
    • frag-threshold - Maximum packet size that can be sent without fragmentation (800 - 2346 bytes, default = 2346). type: int more...
    • frequency-handoff - Enable/disable frequency handoff of clients to other channels (default = disable). type: str choices: [disable, enable] more...
    • max-clients - Maximum number of stations (STAs) or WiFi clients supported by the radio. type: int more...
    • max-distance - Maximum expected distance between the AP and clients (0 - 54000 m, default = 0). type: int more...
    • mode - Mode of radio 2. type: str choices: [disabled, ap, monitor, sniffer, sam] more...
    • power-level - Radio power level as a percentage of the maximum transmit power (0 - 100, default = 100). type: int more...
    • powersave-optimize - No description for the parameter type: array choices: [tim, ac-vo, no-obss-scan, no-11b-rate, client-rate-follow] more...
    • protection-mode - Enable/disable 802. type: str choices: [rtscts, ctsonly, disable] more...
    • radio-id - No description for the parameter type: int more...
    • 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 more...
    • 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] more...
    • spectrum-analysis - Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: [disable, enable, scan-only] more...
    • transmit-optimize - No description for the parameter type: array choices: [disable, power-save, aggr-limit, retry-limit, send-bar] more...
    • vap-all - Enable/disable the automatic inheritance of all Virtual Access Points (VAPs) (default = enable). type: str choices: [disable, enable, tunnel, bridge, manual] more...
    • vaps - Manually selected list of Virtual Access Points (VAPs). type: str more...
    • wids-profile - Wireless Intrusion Detection System (WIDS) profile name to assign to the radio. type: str more...
    • airtime-fairness - Enable/disable airtime fairness (default = disable). type: str choices: [disable, enable] more...
    • band-5g-type - WiFi 5G band type. type: str choices: [5g-full, 5g-high, 5g-low] more...
    • zero-wait-dfs - Enable/disable zero wait DFS on radio (default = enable). type: str choices: [disable, enable] more...
    • vap1 - Virtual Access Point (VAP) for wlan ID 1 type: str more...
    • vap2 - Virtual Access Point (VAP) for wlan ID 2 type: str more...
    • vap3 - Virtual Access Point (VAP) for wlan ID 3 type: str more...
    • vap4 - Virtual Access Point (VAP) for wlan ID 4 type: str more...
    • vap5 - Virtual Access Point (VAP) for wlan ID 5 type: str more...
    • vap6 - Virtual Access Point (VAP) for wlan ID 6 type: str more...
    • vap7 - Virtual Access Point (VAP) for wlan ID 7 type: str more...
    • vap8 - Virtual Access Point (VAP) for wlan ID 8 type: str more...
    • bss-color - BSS color value for this 11ax radio (0 - 63, 0 means disable. type: int more...
    • auto-power-target - The target of automatic transmit power adjustment in dBm. type: str more...
    • drma - Enable/disable dynamic radio mode assignment (DRMA) (default = disable). type: str choices: [disable, enable] more...
    • drma-sensitivity - Network Coverage Factor (NCF) percentage required to consider a radio as redundant (default = low). type: str choices: [low, medium, high] more...
    • iperf-protocol - Iperf test protocol (default = UDP). type: str choices: [udp, tcp] more...
    • iperf-server-port - Iperf service port number. type: int more...
    • power-mode - Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP (default = percentage). type: str choices: [dBm, percentage] more...
    • power-value - Radio EIRP power in dBm (1 - 33, default = 27). type: int more...
    • sam-bssid - BSSID for WiFi network. type: str more...
    • sam-captive-portal - Enable/disable Captive Portal Authentication (default = disable). type: str choices: [disable, enable] more...
    • sam-password - No description for the parameter type: str more...
    • sam-report-intv - SAM report interval (sec), 0 for a one-time report. type: int more...
    • sam-security-type - Select WiFi network security type (default = wpa-personal). type: str choices: [open, wpa-personal, wpa-enterprise] more...
    • sam-server - SAM test server IP address or domain name. type: str more...
    • sam-ssid - SSID for WiFi network. type: str more...
    • sam-test - Select SAM test type (default = PING). type: str choices: [ping, iperf] more...
    • sam-username - Username for WiFi network connection. type: str more...
    • arrp-profile - Distributed Automatic Radio Resource Provisioning (DARRP) profile name to assign to the radio. type: str more...
    • bss-color-mode - BSS color mode for this 11ax radio (default = auto). type: str choices: [auto, static] more...
    • sam-cwp-failure-string - Failure identification on the page after an incorrect login. type: str more...
    • sam-cwp-match-string - Identification string from the captive portal login form. type: str more...
    • sam-cwp-password - No description for the parameter type: str more...
    • sam-cwp-success-string - Success identification on the page after a successful login. type: str more...
    • sam-cwp-test-url - Website the client is trying to access. type: str more...
    • sam-cwp-username - Username for captive portal authentication. type: str more...
    • sam-server-fqdn - SAM test server domain name. type: str more...
    • sam-server-ip - SAM test server IP address. type: str more...
    • sam-server-type - Select SAM server type (default = IP). type: str choices: [ip, fqdn] more...
    • 80211d - Enable/disable 802. type: str choices: [disable, enable] more...
    • optional-antenna - Optional antenna used on FAP (default = none). type: str choices: [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, FANT-04ABGN-8065-P-N, FANT-04ABGN-0606-O-R, FANT-04ABGN-0606-P-R, FANT-10ACAX-1213-D-N, FANT-08ABGN-1213-D-R] more...

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 2.
     fmgr_wtpprofile_radio2:
        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_radio2:
           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, scan-only]>
           transmit-optimize:
             - disable
             - power-save
             - aggr-limit
             - retry-limit
             - send-bar
           vap-all: <value in [disable, enable, tunnel, ...]>
           vaps: <value of string>
           wids-profile: <value of string>
           airtime-fairness: <value in [disable, enable]>
           band-5g-type: <value in [5g-full, 5g-high, 5g-low]>
           zero-wait-dfs: <value in [disable, enable]>
           vap1: <value of string>
           vap2: <value of string>
           vap3: <value of string>
           vap4: <value of string>
           vap5: <value of string>
           vap6: <value of string>
           vap7: <value of string>
           vap8: <value of string>
           bss-color: <value of integer>
           auto-power-target: <value of string>
           drma: <value in [disable, enable]>
           drma-sensitivity: <value in [low, medium, high]>
           iperf-protocol: <value in [udp, tcp]>
           iperf-server-port: <value of integer>
           power-mode: <value in [dBm, percentage]>
           power-value: <value of integer>
           sam-bssid: <value of string>
           sam-captive-portal: <value in [disable, enable]>
           sam-password: <value of string>
           sam-report-intv: <value of integer>
           sam-security-type: <value in [open, wpa-personal, wpa-enterprise]>
           sam-server: <value of string>
           sam-ssid: <value of string>
           sam-test: <value in [ping, iperf]>
           sam-username: <value of string>
           arrp-profile: <value of string>
           bss-color-mode: <value in [auto, static]>
           sam-cwp-failure-string: <value of string>
           sam-cwp-match-string: <value of string>
           sam-cwp-password: <value of string>
           sam-cwp-success-string: <value of string>
           sam-cwp-test-url: <value of string>
           sam-cwp-username: <value of string>
           sam-server-fqdn: <value of string>
           sam-server-ip: <value of string>
           sam-server-type: <value in [ip, fqdn]>
           80211d: <value in [disable, enable]>
           optional-antenna: <value in [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, ...]>

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:

  • 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 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0

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)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.