fortinet.fortios.fortios_wireless_controller_setting (2.3.6) — module

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

| "added in version" 2.0.0 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:==2.3.6


Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

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


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: VDOM wireless controller configuration.
  fortinet.fortios.fortios_wireless_controller_setting:
      vdom: "{{ vdom }}"
      wireless_controller_setting:
          account_id: "<your_own_value>"
          country: "--"
          darrp_optimize: "86400"
          darrp_optimize_schedules:
              -
                  name: "default_name_7 (source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name)"
          device_holdoff: "5"
          device_idle: "1440"
          device_weight: "1"
          duplicate_ssid: "enable"
          fake_ssid_action: "log"
          fapc_compatibility: "enable"
          firmware_provision_on_authorization: "enable"
          offending_ssid:
              -
                  action: "log"
                  id: "17"
                  ssid_pattern: "<your_own_value>"
          phishing_ssid_detect: "enable"
          rolling_wtp_upgrade: "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

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

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

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

wireless_controller_setting:
    default: null
    description:
    - VDOM wireless controller configuration.
    suboptions:
      account_id:
        description:
        - FortiCloud customer account ID.
        type: str
      country:
        choices:
        - --
        - AF
        - AL
        - DZ
        - AS
        - AO
        - AR
        - AM
        - AU
        - AT
        - AZ
        - BS
        - BH
        - BD
        - BB
        - BY
        - BE
        - BZ
        - BJ
        - BM
        - BT
        - BO
        - BA
        - BW
        - BR
        - BN
        - BG
        - BF
        - KH
        - CM
        - KY
        - CF
        - TD
        - CL
        - CN
        - CX
        - CO
        - CG
        - CD
        - CR
        - HR
        - CY
        - CZ
        - DK
        - DJ
        - DM
        - DO
        - EC
        - EG
        - SV
        - ET
        - EE
        - GF
        - PF
        - FO
        - FJ
        - FI
        - FR
        - GA
        - GE
        - GM
        - DE
        - GH
        - GI
        - GR
        - GL
        - GD
        - GP
        - GU
        - GT
        - GY
        - HT
        - HN
        - HK
        - HU
        - IS
        - IN
        - ID
        - IQ
        - IE
        - IM
        - IL
        - IT
        - CI
        - JM
        - JO
        - KZ
        - KE
        - KR
        - KW
        - LA
        - LV
        - LB
        - LS
        - LR
        - LY
        - LI
        - LT
        - LU
        - MO
        - MK
        - MG
        - MW
        - MY
        - MV
        - ML
        - MT
        - MH
        - MQ
        - MR
        - MU
        - YT
        - MX
        - FM
        - MD
        - MC
        - MN
        - MA
        - MZ
        - MM
        - NA
        - NP
        - NL
        - AN
        - AW
        - NZ
        - NI
        - NE
        - NG
        - 'NO'
        - MP
        - OM
        - PK
        - PW
        - PA
        - PG
        - PY
        - PE
        - PH
        - PL
        - PT
        - PR
        - QA
        - RE
        - RO
        - RU
        - RW
        - BL
        - KN
        - LC
        - MF
        - PM
        - VC
        - SA
        - SN
        - RS
        - ME
        - SL
        - SG
        - SK
        - SI
        - SO
        - ZA
        - ES
        - LK
        - SR
        - SZ
        - SE
        - CH
        - TW
        - TZ
        - TH
        - TG
        - TT
        - TN
        - TR
        - TM
        - AE
        - TC
        - UG
        - UA
        - GB
        - US
        - PS
        - UY
        - UZ
        - VU
        - VE
        - VN
        - VI
        - WF
        - YE
        - ZM
        - ZW
        - JP
        - CA
        - IR
        - KP
        - SD
        - SY
        - ZB
        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.
        elements: dict
        suboptions:
          name:
            description:
            - Schedule name. Source firewall.schedule.group.name firewall.schedule.recurring.name
              firewall.schedule.onetime.name.
            required: true
            type: str
        type: list
      device_holdoff:
        description:
        - Lower limit of creation time of device for identification in minutes (0 - 60).
        type: int
      device_idle:
        description:
        - Upper limit of idle time of device for identification in minutes (0 - 14400).
        type: int
      device_weight:
        description:
        - Upper limit of confidence of device for identification (0 - 255).
        type: int
      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.
        elements: str
        type: list
      fapc_compatibility:
        choices:
        - enable
        - disable
        description:
        - Enable/disable FAP-C series compatibility.
        type: str
      firmware_provision_on_authorization:
        choices:
        - enable
        - disable
        description:
        - Enable/disable automatic provisioning of latest firmware on authorization.
        type: str
      offending_ssid:
        description:
        - Configure offending SSID.
        elements: dict
        suboptions:
          action:
            choices:
            - log
            - suppress
            description:
            - Actions taken for detected offending SSID.
            elements: str
            type: list
          id:
            description:
            - ID. see <a href='#notes'>Notes</a>.
            required: true
            type: int
          ssid_pattern:
            description:
            - Define offending SSID pattern (case insensitive). For example, word, word*,
              *word, wo*rd.
            type: str
        type: list
      phishing_ssid_detect:
        choices:
        - enable
        - disable
        description:
        - Enable/disable phishing SSID detection.
        type: str
      rolling_wtp_upgrade:
        choices:
        - enable
        - disable
        description:
        - Enable/disable rolling WTP upgrade .
        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