fmgr_wtpprofile_radio4 – Configuration options for radio 4.

Added in version 2.1.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.

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.15.0

FortiManager Version Compatibility

Supported Version Ranges: v6.2.5 -> latest

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_radio4 - Configuration options for radio 4. type: dict
    • airtime_fairness (Alias name: airtime-fairness) Enable/disable airtime fairness (default = disable). type: str choices: [disable, enable] more...
    • amsdu Enable/disable 802. type: str choices: [disable, enable] more...
    • ap_handoff (Alias name: ap-handoff) Enable/disable ap handoff of clients to other aps (default = disable). type: str choices: [disable, enable] more...
    • ap_sniffer_addr (Alias name: ap-sniffer-addr) Mac address to monitor. type: str more...
    • ap_sniffer_bufsize (Alias name: ap-sniffer-bufsize) Sniffer buffer size (1 - 32 mb, default = 16). type: int more...
    • ap_sniffer_chan (Alias name: ap-sniffer-chan) Channel on which to operate the sniffer (default = 6). type: int more...
    • ap_sniffer_ctl (Alias name: ap-sniffer-ctl) Enable/disable sniffer on wifi control frame (default = enable). type: str choices: [disable, enable] more...
    • ap_sniffer_data (Alias name: ap-sniffer-data) Enable/disable sniffer on wifi data frame (default = enable). type: str choices: [disable, enable] more...
    • ap_sniffer_mgmt_beacon (Alias name: ap-sniffer-mgmt-beacon) Enable/disable sniffer on wifi management beacon frames (default = enable). type: str choices: [disable, enable] more...
    • ap_sniffer_mgmt_other (Alias name: ap-sniffer-mgmt-other) Enable/disable sniffer on wifi management other frames (default = enable). type: str choices: [disable, enable] more...
    • ap_sniffer_mgmt_probe (Alias name: ap-sniffer-mgmt-probe) Enable/disable sniffer on wifi management probe frames (default = enable). type: str choices: [disable, enable] more...
    • auto_power_high (Alias name: auto-power-high) The upper bound of automatic transmit power adjustment in dbm (the actual range of transmit power depends on the ap platform type). type: int more...
    • auto_power_level (Alias name: auto-power-level) Enable/disable automatic power-level adjustment to prevent co-channel interference (default = enable). type: str choices: [disable, enable] more...
    • auto_power_low (Alias name: auto-power-low) The lower bound of automatic transmit power adjustment in dbm (the actual range of transmit power depends on the ap platform type). type: int more...
    • band Wifi band that radio 3 operates on. type: str choices: [802.11b, 802.11a, 802.11g, 802.11n, 802.11ac, 802.11n-5G, 802.11ax-5G, 802.11ax, 802.11g-only, 802.11n-only, 802.11n,g-only, 802.11ac-only, 802.11ac,n-only, 802.11n-5G-only, 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...
    • band_5g_type (Alias name: band-5g-type) Wifi 5g band type. type: str choices: [5g-full, 5g-high, 5g-low] more...
    • bandwidth_admission_control (Alias name: bandwidth-admission-control) Enable/disable wifi multimedia (wmm) bandwidth admission control to optimize wifi bandwidth use. type: str choices: [disable, enable] more...
    • bandwidth_capacity (Alias name: bandwidth-capacity) Maximum bandwidth capacity allowed (1 - 600000 kbps, default = 2000). type: int more...
    • beacon_interval (Alias name: beacon-interval) Beacon interval. type: int more...
    • call_admission_control (Alias name: 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 (Alias name: call-capacity) Maximum number of voice over wlan (vowlan) phones supported by the radio (0 - 60, default = 10). type: int more...
    • channel type: list more...
    • channel_bonding (Alias name: channel-bonding) Channel bandwidth: 160,80, 40, or 20mhz. type: str choices: [80MHz, 40MHz, 20MHz, 160MHz] more...
    • channel_utilization (Alias name: 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 Delivery traffic indication map (dtim) period (1 - 255, default = 1). type: int more...
    • frag_threshold (Alias name: frag-threshold) Maximum packet size that can be sent without fragmentation (800 - 2346 bytes, default = 2346). type: int more...
    • frequency_handoff (Alias name: frequency-handoff) Enable/disable frequency handoff of clients to other channels (default = disable). type: str choices: [disable, enable] more...
    • max_clients (Alias name: max-clients) Maximum number of stations (stas) or wifi clients supported by the radio. type: int more...
    • max_distance (Alias name: max-distance) Maximum expected distance between the ap and clients (0 - 54000 m, default = 0). type: int more...
    • mode Mode of radio 3. type: str choices: [ap, monitor, sniffer, disabled, sam] more...
    • power_level (Alias name: power-level) Radio power level as a percentage of the maximum transmit power (0 - 100, default = 100). type: int more...
    • powersave_optimize (Alias name: powersave-optimize) type: list choices: [tim, ac-vo, no-obss-scan, no-11b-rate, client-rate-follow] more...
    • protection_mode (Alias name: protection-mode) Enable/disable 802. type: str choices: [rtscts, ctsonly, disable] more...
    • radio_id (Alias name: radio-id) type: int more...
    • rts_threshold (Alias name: 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 (Alias name: 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 (Alias name: 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 (Alias name: transmit-optimize) type: list choices: [disable, power-save, aggr-limit, retry-limit, send-bar] more...
    • vap_all (Alias name: 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: list or str more...
    • wids_profile (Alias name: wids-profile) Wireless intrusion detection system (wids) profile name to assign to the radio. type: str more...
    • zero_wait_dfs (Alias name: 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 (Alias name: bss-color) Bss color value for this 11ax radio (0 - 63, 0 means disable. type: int more...
    • auto_power_target (Alias name: 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 (Alias name: 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 (Alias name: iperf-protocol) Iperf test protocol (default = udp). type: str choices: [udp, tcp] more...
    • iperf_server_port (Alias name: iperf-server-port) Iperf service port number. type: int more...
    • power_mode (Alias name: 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 (Alias name: power-value) Radio eirp power in dbm (1 - 33, default = 27). type: int more...
    • sam_bssid (Alias name: sam-bssid) Bssid for wifi network. type: str more...
    • sam_captive_portal (Alias name: sam-captive-portal) Enable/disable captive portal authentication (default = disable). type: str choices: [disable, enable] more...
    • sam_password (Alias name: sam-password) type: list more...
    • sam_report_intv (Alias name: sam-report-intv) Sam report interval (sec), 0 for a one-time report. type: int more...
    • sam_security_type (Alias name: sam-security-type) Select wifi network security type (default = wpa-personal). type: str choices: [open, wpa-personal, wpa-enterprise, owe, wpa3-sae] more...
    • sam_server (Alias name: sam-server) Sam test server ip address or domain name. type: str more...
    • sam_ssid (Alias name: sam-ssid) Ssid for wifi network. type: str more...
    • sam_test (Alias name: sam-test) Select sam test type (default = ping). type: str choices: [ping, iperf] more...
    • sam_username (Alias name: sam-username) Username for wifi network connection. type: str more...
    • arrp_profile (Alias name: arrp-profile) Distributed automatic radio resource provisioning (darrp) profile name to assign to the radio. type: str more...
    • bss_color_mode (Alias name: bss-color-mode) Bss color mode for this 11ax radio (default = auto). type: str choices: [auto, static] more...
    • sam_cwp_failure_string (Alias name: sam-cwp-failure-string) Failure identification on the page after an incorrect login. type: str more...
    • sam_cwp_match_string (Alias name: sam-cwp-match-string) Identification string from the captive portal login form. type: str more...
    • sam_cwp_password (Alias name: sam-cwp-password) type: list more...
    • sam_cwp_success_string (Alias name: sam-cwp-success-string) Success identification on the page after a successful login. type: str more...
    • sam_cwp_test_url (Alias name: sam-cwp-test-url) Website the client is trying to access. type: str more...
    • sam_cwp_username (Alias name: sam-cwp-username) Username for captive portal authentication. type: str more...
    • sam_server_fqdn (Alias name: sam-server-fqdn) Sam test server domain name. type: str more...
    • sam_server_ip (Alias name: sam-server-ip) Sam test server ip address. type: str more...
    • sam_server_type (Alias name: sam-server-type) Select sam server type (default = ip). type: str choices: [ip, fqdn] more...
    • d80211d (Alias name: 80211d) Enable/disable 802. type: str choices: [disable, enable] more...
    • optional_antenna (Alias name: 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, custom] more...
    • mimo_mode (Alias name: mimo-mode) Configure radio mimo mode (default = default). type: str choices: [default, 1x1, 2x2, 3x3, 4x4, 8x8] more...
    • optional_antenna_gain (Alias name: optional-antenna-gain) Optional antenna gain in dbi (0 to 20, default = 0). type: str more...
    • sam_ca_certificate (Alias name: sam-ca-certificate) Ca certificate for wpa2/wpa3-enterprise. type: str more...
    • sam_client_certificate (Alias name: sam-client-certificate) Client certificate for wpa2/wpa3-enterprise. type: str more...
    • sam_eap_method (Alias name: sam-eap-method) Select wpa2/wpa3-enterprise eap method (default = peap). type: str choices: [tls, peap, both] more...
    • sam_private_key (Alias name: sam-private-key) Private key for wpa2/wpa3-enterprise. type: str more...
    • sam_private_key_password (Alias name: sam-private-key-password) type: list 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

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configuration options for radio 4.
      fortinet.fortimanager.fmgr_wtpprofile_radio4:
        # 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_radio4:
          airtime_fairness: <value in [disable, enable]>
          amsdu: <value in [disable, enable]>
          ap_handoff: <value in [disable, enable]>
          ap_sniffer_addr: <string>
          ap_sniffer_bufsize: <integer>
          ap_sniffer_chan: <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: <integer>
          auto_power_level: <value in [disable, enable]>
          auto_power_low: <integer>
          band: <value in [802.11b, 802.11a, 802.11g, ...]>
          band_5g_type: <value in [5g-full, 5g-high, 5g-low]>
          bandwidth_admission_control: <value in [disable, enable]>
          bandwidth_capacity: <integer>
          beacon_interval: <integer>
          call_admission_control: <value in [disable, enable]>
          call_capacity: <integer>
          channel: <list or string>
          channel_bonding: <value in [80MHz, 40MHz, 20MHz, ...]>
          channel_utilization: <value in [disable, enable]>
          coexistence: <value in [disable, enable]>
          darrp: <value in [disable, enable]>
          dtim: <integer>
          frag_threshold: <integer>
          frequency_handoff: <value in [disable, enable]>
          max_clients: <integer>
          max_distance: <integer>
          mode: <value in [ap, monitor, sniffer, ...]>
          power_level: <integer>
          powersave_optimize:
            - tim
            - ac-vo
            - no-obss-scan
            - no-11b-rate
            - client-rate-follow
          protection_mode: <value in [rtscts, ctsonly, disable]>
          radio_id: <integer>
          rts_threshold: <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: <list or string>
          wids_profile: <string>
          zero_wait_dfs: <value in [disable, enable]>
          vap1: <string>
          vap2: <string>
          vap3: <string>
          vap4: <string>
          vap5: <string>
          vap6: <string>
          vap7: <string>
          vap8: <string>
          bss_color: <integer>
          auto_power_target: <string>
          drma: <value in [disable, enable]>
          drma_sensitivity: <value in [low, medium, high]>
          iperf_protocol: <value in [udp, tcp]>
          iperf_server_port: <integer>
          power_mode: <value in [dBm, percentage]>
          power_value: <integer>
          sam_bssid: <string>
          sam_captive_portal: <value in [disable, enable]>
          sam_password: <list or string>
          sam_report_intv: <integer>
          sam_security_type: <value in [open, wpa-personal, wpa-enterprise, ...]>
          sam_server: <string>
          sam_ssid: <string>
          sam_test: <value in [ping, iperf]>
          sam_username: <string>
          arrp_profile: <string>
          bss_color_mode: <value in [auto, static]>
          sam_cwp_failure_string: <string>
          sam_cwp_match_string: <string>
          sam_cwp_password: <list or string>
          sam_cwp_success_string: <string>
          sam_cwp_test_url: <string>
          sam_cwp_username: <string>
          sam_server_fqdn: <string>
          sam_server_ip: <string>
          sam_server_type: <value in [ip, fqdn]>
          d80211d: <value in [disable, enable]>
          optional_antenna: <value in [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, ...]>
          mimo_mode: <value in [default, 1x1, 2x2, ...]>
          optional_antenna_gain: <string>
          sam_ca_certificate: <string>
          sam_client_certificate: <string>
          sam_eap_method: <value in [tls, peap, both]>
          sam_private_key: <string>
          sam_private_key_password: <list or 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:

  • 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)