Docs4dev
Docs
ansible / latest / collections / fortinet / fortimanager / fmgr_wtpprofile_radio1_module.html

fortinet.fortimanager.fmgr_wtpprofile_radio1 – Configuration options for radio 1.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_wtpprofile_radio1.

New in version 2.10: of fortinet.fortimanager

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
the rc codes list with which the conditions to succeed will be overriden
state
string / required
    Choices:
  • present
  • absent
the directive to create, update or delete an object
workspace_locking_adom
string
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout
integer
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock
wtp-profile
string / required
the parameter (wtp-profile) in requested url
wtpprofile_radio1
dictionary
the top level parameters set
airtime-fairness
string
    Choices:
  • disable
  • enable
Enable/disable airtime fairness (default = disable).
amsdu
string
    Choices:
  • disable
  • enable
Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients (default = enable).
ap-handoff
string
    Choices:
  • disable
  • enable
Enable/disable AP handoff of clients to other APs (default = disable).
ap-sniffer-addr
string
MAC address to monitor.
ap-sniffer-bufsize
integer
Sniffer buffer size (1 - 32 MB, default = 16).
ap-sniffer-chan
integer
Channel on which to operate the sniffer (default = 6).
ap-sniffer-ctl
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi control frame (default = enable).
ap-sniffer-data
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi data frame (default = enable).
ap-sniffer-mgmt-beacon
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi management Beacon frames (default = enable).
ap-sniffer-mgmt-other
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi management other frames (default = enable).
ap-sniffer-mgmt-probe
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi management probe frames (default = enable).
auto-power-high
integer
Automatic transmit power high limit in dBm (the actual range of transmit power depends on the AP platform type).
auto-power-level
string
    Choices:
  • disable
  • enable
Enable/disable automatic power-level adjustment to prevent co-channel interference (default = disable).
auto-power-low
integer
Automatic transmission power low limit in dBm (the actual range of transmit power depends on the AP platform type).
auto-power-target
string
The target of automatic transmit power adjustment in dBm. (-95 to -20, default = -70).
band
string
    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
WiFi band that Radio 1 operates on.
band-5g-type
string
    Choices:
  • 5g-full
  • 5g-high
  • 5g-low
WiFi 5G band type.
bandwidth-admission-control
string
    Choices:
  • disable
  • enable
Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. A request to join the wireles...
bandwidth-capacity
integer
Maximum bandwidth capacity allowed (1 - 600000 Kbps, default = 2000).
beacon-interval
integer
Beacon interval. The time between beacon frames in msec (the actual range of beacon interval depends on the AP platform type, ...
bss-color
integer
BSS color value for this 11ax radio (0 - 63, 0 means disable. default = 0).
call-admission-control
string
    Choices:
  • disable
  • enable
Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. New VoIP calls are ...
call-capacity
integer
Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60, default = 10).
channel
string
no description
channel-bonding
string
    Choices:
  • disable
  • enable
  • 80MHz
  • 40MHz
  • 20MHz
  • 160MHz
Channel bandwidth: 80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence.
channel-utilization
string
    Choices:
  • disable
  • enable
Enable/disable measuring channel utilization.
coexistence
string
    Choices:
  • disable
  • enable
Enable/disable allowing both HT20 and HT40 on the same radio (default = enable).
darrp
string
    Choices:
  • disable
  • enable
Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the most optim...
drma
string
    Choices:
  • disable
  • enable
Enable/disable dynamic radio mode assignment (DRMA) (default = disable).
drma-sensitivity
string
    Choices:
  • low
  • medium
  • high
Network Coverage Factor (NCF) percentage required to consider a radio as redundant (default = low).
dtim
integer
DTIM interval. The frequency to transmit Delivery Traffic Indication Message (or Map) (DTIM) messages (1 - 255, default = 1). ...
frag-threshold
integer
Maximum packet size that can be sent without fragmentation (800 - 2346 bytes, default = 2346).
frequency-handoff
string
    Choices:
  • disable
  • enable
Enable/disable frequency handoff of clients to other channels (default = disable).
iperf-protocol
string
    Choices:
  • udp
  • tcp
Iperf test protocol (default = "UDP").
iperf-server-port
integer
Iperf service port number.
max-clients
integer
Maximum number of stations (STAs) or WiFi clients supported by the radio. Range depends on the hardware.
max-distance
integer
Maximum expected distance between the AP and clients (0 - 54000 m, default = 0).
mode
string
    Choices:
  • disabled
  • ap
  • monitor
  • sniffer
  • sam
Mode of radio 1. Radio 1 can be disabled, configured as an access point, a rogue AP monitor, or a sniffer.
power-level
integer
Radio power level as a percentage of the maximum transmit power (0 - 100, default = 100).
power-mode
string
    Choices:
  • dBm
  • percentage
Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP (default = percentage). This...
power-value
integer
Radio EIRP power in dBm (1 - 33, default = 27).
powersave-optimize
list / elements=string
    Choices:
  • tim
  • ac-vo
  • no-obss-scan
  • no-11b-rate
  • client-rate-follow
no description
protection-mode
string
    Choices:
  • rtscts
  • ctsonly
  • disable
Enable/disable 802.11g protection modes to support backwards compatibility with older clients (rtscts, ctsonly, disable).
radio-id
integer
no description
rts-threshold
integer
Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 bytes, defa...
sam-bssid
string
BSSID for WiFi network.
sam-captive-portal
string
    Choices:
  • disable
  • enable
Enable/disable Captive Portal Authentication (default = disable).
sam-password
string
no description
sam-report-intv
integer
SAM report interval (sec), 0 for a one-time report.
sam-security-type
string
    Choices:
  • open
  • wpa-personal
  • wpa-enterprise
Select WiFi network security type (default = "wpa-personal").
sam-server
string
SAM test server IP address or domain name.
sam-ssid
string
SSID for WiFi network.
sam-test
string
    Choices:
  • ping
  • iperf
Select SAM test type (default = "PING").
sam-username
string
Username for WiFi network connection.
short-guard-interval
string
    Choices:
  • disable
  • enable
Use either the short guard interval (Short GI) of 400 ns or the long guard interval (Long GI) of 800 ns.
spectrum-analysis
string
    Choices:
  • disable
  • enable
  • scan-only
Enable/disable spectrum analysis to find interference that would negatively impact wireless performance.
transmit-optimize
list / elements=string
    Choices:
  • disable
  • power-save
  • aggr-limit
  • retry-limit
  • send-bar
no description
vap-all
string
    Choices:
  • disable
  • enable
  • tunnel
  • bridge
  • manual
Enable/disable the automatic inheritance of all Virtual Access Points (VAPs) (default = enable).
vap1
string
Virtual Access Point (VAP) for wlan ID 1
vap2
string
Virtual Access Point (VAP) for wlan ID 2
vap3
string
Virtual Access Point (VAP) for wlan ID 3
vap4
string
Virtual Access Point (VAP) for wlan ID 4
vap5
string
Virtual Access Point (VAP) for wlan ID 5
vap6
string
Virtual Access Point (VAP) for wlan ID 6
vap7
string
Virtual Access Point (VAP) for wlan ID 7
vap8
string
Virtual Access Point (VAP) for wlan ID 8
vaps
string
Manually selected list of Virtual Access Points (VAPs).
wids-profile
string
Wireless Intrusion Detection System (WIDS) profile name to assign to the radio.
zero-wait-dfs
string
    Choices:
  • disable
  • enable
Enable/disable zero wait DFS on radio (default = enable).

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, 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>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_wtpprofile_radio1_module.html