ansible.builtin.fortios_wireless_controller_setting (v2.8.20) — module

VDOM wireless controller configuration in Fortinet's FortiOS and FortiGate.

| "added in version" 2.8 of ansible.builtin"

Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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"

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip address.
    required: true

vdom:
    default: root
    description:
    - 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.

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.

username:
    description:
    - FortiOS or FortiGate username.
    required: true

wireless_controller_setting:
    default: null
    description:
    - VDOM wireless controller configuration.
    suboptions:
      account-id:
        description:
        - 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
        - false
        - 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
        description:
        - 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
        description:
        - Enable/disable allowing Virtual Access Points (VAPs) to use the same SSID name
          in the same VDOM.
      fapc-compatibility:
        choices:
        - enable
        - disable
        description:
        - Enable/disable FAP-C series compatibility.

Outputs

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