fortios_wireless_controller_global – Configure wireless controller global settings in Fortinet’s FortiOS and FortiGate — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# fortios_wireless_controller_global – Configure wireless controller global settings in Fortinet’s FortiOS and FortiGate

New in version 2.8.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- This module is able to configure a FortiGate or FortiOS by allowing the user to set and modify wireless_controller feature and global category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.2

## Requirements

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

- fortiosapi>=0.9.8

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
host - / required |  | FortiOS or FortiGate ip address.
https boolean | Choices: no yes ← | Indicates if the requests towards FortiGate must use HTTPS protocol
password - | Default: "" | FortiOS or FortiGate password.
username - / required |  | FortiOS or FortiGate username.
vdom - | Default: "root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit.
wireless_controller_global - | Default: null | Configure wireless controller global settings.
| ap-log-server - | Choices: enable disable | Enable/disable configuring APs or FortiAPs to send log messages to a syslog server (default = disable).
| ap-log-server-ip - |  | IP address that APs or FortiAPs send log messages to.
| ap-log-server-port - |  | Port that APs or FortiAPs send log messages to.
| control-message-offload - | Choices: ebp-frame aeroscout-tag ap-list sta-list sta-cap-list stats aeroscout-mu | Configure CAPWAP control message data channel offload.
| data-ethernet-II - | Choices: enable disable | Configure the wireless controller to use Ethernet II or 802.3 frames with 802.3 data tunnel mode (default = disable).
| discovery-mc-addr - |  | Multicast IP address for AP discovery (default = 244.0.1.140).
| fiapp-eth-type - |  | Ethernet type for Fortinet Inter-Access Point Protocol (IAPP), or IEEE 802.11f, packets (0 - 65535, default = 5252).
| image-download - | Choices: enable disable | Enable/disable WTP image download at join time.
| ipsec-base-ip - |  | Base IP address for IPsec VPN tunnels between the access points and the wireless controller (default = 169.254.0.1).
| link-aggregation - | Choices: enable disable | Enable/disable calculating the CAPWAP transmit hash to load balance sessions to link aggregation nodes (default = disable).
| location - |  | Description of the location of the wireless controller.
| max-clients - |  | Maximum number of clients that can connect simultaneously (default = 0, meaning no limitation).
| max-retransmit - |  | Maximum number of tunnel packet retransmissions (0 - 64, default = 3).
| mesh-eth-type - |  | Mesh Ethernet identifier included in backhaul packets (0 - 65535, default = 8755).
| name - |  | Name of the wireless controller.
| rogue-scan-mac-adjacency - |  | Maximum numerical difference between an AP's Ethernet and wireless MAC values to match for rogue detection (0 - 31, default = 7).
| wtp-share - | Choices: enable disable | Enable/disable sharing of WTPs between VDOMs.

## Notes

Note

- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook

## Examples

    - hosts: localhost
      vars:
       host: "192.168.122.40"
       username: "admin"
       password: ""
       vdom: "root"
      tasks:
      - name: Configure wireless controller global settings.
        fortios_wireless_controller_global:
          host:  "{{ host }}"
          username: "{{ username }}"
          password: "{{ password }}"
          vdom:  "{{ vdom }}"
          https: "False"
          wireless_controller_global:
            ap-log-server: "enable"
            ap-log-server-ip: "<your_own_value>"
            ap-log-server-port: "5"
            control-message-offload: "ebp-frame"
            data-ethernet-II: "enable"
            discovery-mc-addr: "<your_own_value>"
            fiapp-eth-type: "9"
            image-download: "enable"
            ipsec-base-ip: "<your_own_value>"
            link-aggregation: "enable"
            location: "<your_own_value>"
            max-clients: "14"
            max-retransmit: "15"
            mesh-eth-type: "16"
            name: "default_name_17"
            rogue-scan-mac-adjacency: "18"
            wtp-share: "enable"

## Return Values

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

Key | Returned | Description
--- | --- | ---
build string | always | Build number of the fortigate image Sample: 1547
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id
name string | always | Name of the table used to fulfill the request Sample: urlfilter
path string | always | Path of the table used to fulfill the request Sample: webfilter
revision string | always | Internal revision number Sample: 17.0.2.10658
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352
status string | always | Indication of the operation's result Sample: success
vdom string | always | Virtual domain used Sample: root
version string | always | Version of the FortiGate Sample: v5.6.3

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation you can edit this document to improve it.