fortios_wireless_controller_setting – VDOM wireless controller configuration in Fortinet’s FortiOS and FortiGate — Ansible Documentation

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

Documentation

# fortios_wireless_controller_setting – VDOM wireless controller configuration 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 setting 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_setting - | Default: null | VDOM wireless controller configuration.
| account-id - |  | FortiCloud customer account ID.
| country - | Choices: NA AL DZ AO AR AM AU AT AZ BH BD BB BY BE BZ BO BA BR BN BG KH CL CN CO CR HR CY CZ DK DO EC EG SV EE FI FR GE DE GR GL GD GU GT HT HN HK HU IS IN ID IR IE IL IT JM JO KZ KE KP KR KW LV LB LI LT LU MO MK MY MT MX MC MA MZ MM NP NL AN AW NZ no OM PK PA PG PY PE PH PL PT PR QA RO RU RW SA RS ME SG SK SI ZA ES LK SE SD CH SY TW TZ TH TT TN TR AE UA GB US PS UY UZ VE VN YE ZB ZW JP CA | Country or region in which the FortiGate is located. The country determines the 802.11 bands and channels that are available.
| duplicate-ssid - | Choices: enable disable | Enable/disable allowing Virtual Access Points (VAPs) to use the same SSID name in the same VDOM.
| fapc-compatibility - | Choices: enable disable | Enable/disable FAP-C series compatibility.

## 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: VDOM wireless controller configuration.
        fortios_wireless_controller_setting:
          host:  "{{ host }}"
          username: "{{ username }}"
          password: "{{ password }}"
          vdom:  "{{ vdom }}"
          https: "False"
          wireless_controller_setting:
            account-id: "<your_own_value>"
            country: "NA"
            duplicate-ssid: "enable"
            fapc-compatibility: "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.