fortinet.fortios.fortios_wireless_controller_setting (1.1.7) — module

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

| "added in version" 2.8 of fortinet.fortios"

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==1.1.7


Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 1.1.7

Description

This module is able to configure a FortiGate or FortiOS (FOS) device 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.4.0


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: VDOM wireless controller configuration.
    fortios_wireless_controller_setting:
      vdom:  "{{ vdom }}"
      wireless_controller_setting:
        account_id: "<your_own_value>"
        country: "NA"
        darrp_optimize: "5"
        darrp_optimize_schedules:
         -
            name: "default_name_7 (source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name)"
        duplicate_ssid: "enable"
        fake_ssid_action: "log"
        fapc_compatibility: "enable"
        offending_ssid:
         -
            action: "log"
            id:  "13"
            ssid_pattern: "<your_own_value>"
        phishing_ssid_detect: "enable"
        wfa_compatibility: "enable"

Inputs

    
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.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

wireless_controller_setting:
    default: null
    description:
    - VDOM wireless controller configuration.
    suboptions:
      account_id:
        description:
        - FortiCloud customer account ID.
        type: str
      country:
        choices:
        - NA
        - AL
        - DZ
        - AO
        - AR
        - AM
        - AU
        - AT
        - AZ
        - BS
        - BH
        - BD
        - BB
        - BY
        - BE
        - BZ
        - BO
        - BA
        - BR
        - BN
        - BG
        - KH
        - CF
        - 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.
        type: str
      darrp_optimize:
        description:
        - Time for running Dynamic Automatic Radio Resource Provisioning (DARRP) optimizations
          (0 - 86400 sec).
        type: int
      darrp_optimize_schedules:
        description:
        - Firewall schedules for DARRP running time. DARRP will run periodically based
          on darrp-optimize within the schedules. Separate multiple schedule names with
          a space.
        suboptions:
          name:
            description:
            - Schedule name. Source firewall.schedule.group.name firewall.schedule.recurring.name
              firewall.schedule.onetime.name.
            required: true
            type: str
        type: list
      duplicate_ssid:
        choices:
        - enable
        - disable
        description:
        - Enable/disable allowing Virtual Access Points (VAPs) to use the same SSID name
          in the same VDOM.
        type: str
      fake_ssid_action:
        choices:
        - log
        - suppress
        description:
        - Actions taken for detected fake SSID.
        type: str
      fapc_compatibility:
        choices:
        - enable
        - disable
        description:
        - Enable/disable FAP-C series compatibility.
        type: str
      offending_ssid:
        description:
        - Configure offending SSID.
        suboptions:
          action:
            choices:
            - log
            - suppress
            description:
            - Actions taken for detected offending SSID.
            type: str
          id:
            description:
            - ID.
            required: true
            type: int
          ssid_pattern:
            description:
            - 'Define offending SSID pattern (case insensitive), eg: word, word*, *word,
              wo*rd.'
            type: str
        type: list
      phishing_ssid_detect:
        choices:
        - enable
        - disable
        description:
        - Enable/disable phishing SSID detection.
        type: str
      wfa_compatibility:
        choices:
        - enable
        - disable
        description:
        - Enable/disable WFA compatibility.
        type: str
    type: dict

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