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

From Get docs
Ansible/docs/2.11/collections/fortinet/fortimanager/fmgr wtpprofile radio1 module


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

Note

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

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

  • no ←

  • yes

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

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

  • 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

amsdu

string

  • disable
  • enable

Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients (default = enable).

ap-handoff

string

  • 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

  • disable
  • enable

Enable/disable sniffer on WiFi control frame (default = enable).

ap-sniffer-data

string

  • disable
  • enable

Enable/disable sniffer on WiFi data frame (default = enable).

ap-sniffer-mgmt-beacon

string

  • disable
  • enable

Enable/disable sniffer on WiFi management Beacon frames (default = enable).

ap-sniffer-mgmt-other

string

  • disable
  • enable

Enable/disable sniffer on WiFi management other frames (default = enable).

ap-sniffer-mgmt-probe

string

  • 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

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

band

string

  • 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

WiFi band that Radio 1 operates on.

bandwidth-admission-control

string

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

call-admission-control

string

  • 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

  • disable
  • enable
  • 80MHz
  • 40MHz
  • 20MHz

Channel bandwidth: 80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence.

channel-utilization

string

  • disable
  • enable

Enable/disable measuring channel utilization.

coexistence

string

  • disable
  • enable

Enable/disable allowing both HT20 and HT40 on the same radio (default = enable).

darrp

string

  • disable
  • enable

Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the most optim...

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

  • disable
  • enable

Enable/disable frequency handoff of clients to other channels (default = disable).

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

  • disabled
  • ap
  • monitor
  • sniffer

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

powersave-optimize

list / elements=string

  • tim
  • ac-vo
  • no-obss-scan
  • no-11b-rate
  • client-rate-follow

no description

protection-mode

string

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

short-guard-interval

string

  • 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

  • disable
  • enable

Enable/disable spectrum analysis to find interference that would negatively impact wireless performance.

transmit-optimize

list / elements=string

  • disable
  • power-save
  • aggr-limit
  • retry-limit
  • send-bar

no description

vap-all

string

  • disable
  • enable

Enable/disable the automatic inheritance of all Virtual Access Points (VAPs) (default = enable).

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.



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]>
           transmit-optimize:
             - disable
             - power-save
             - aggr-limit
             - retry-limit
             - send-bar
           vap-all: <value in [disable, enable]>
           vaps: <value of string>
           wids-profile: <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/2.11/collections/fortinet/fortimanager/fmgr_wtpprofile_radio1_module.html


Retrieved from "https://getdocs.org/index.php?title=Ansible/docs/2.11/collections/fortinet/fortimanager/fmgr_wtpprofile_radio1_module&oldid=64050"
Powered by MediaWiki