fortinet.fortios.fortios_extension_controller_extender_vap module – FortiExtender wifi vap configuration in Fortinet’s FortiOS and FortiGate.

Note

This module is part of the fortinet.fortios collection (version 2.3.8).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortios. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: fortinet.fortios.fortios_extension_controller_extender_vap.

New in fortinet.fortios 2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify extension_controller feature and extender_vap category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

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

  • ansible>=2.15

Parameters

Parameter

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

extension_controller_extender_vap

dictionary

FortiExtender wifi vap configuration.

allowaccess

list / elements=string

Control management access to the managed extender. Separate entries with a space.

Choices:

  • "ping"

  • "telnet"

  • "http"

  • "https"

  • "ssh"

  • "snmp"

auth_server_address

string

Wi-Fi Authentication Server Address (IPv4 format).

auth_server_port

integer

Wi-Fi Authentication Server Port.

auth_server_secret

string

Wi-Fi Authentication Server Secret.

broadcast_ssid

string

Wi-Fi broadcast SSID enable / disable.

Choices:

  • "disable"

  • "enable"

bss_color_partial

string

Wi-Fi 802.11AX bss color partial enable / disable, default = enable.

Choices:

  • "disable"

  • "enable"

dtim

integer

Wi-Fi DTIM (1 - 255) default = 1.

end_ip

string

End ip address.

ip_address

string

Extender ip address.

max_clients

integer

Wi-Fi max clients (0 - 512))

mu_mimo

string

Wi-Fi multi-user MIMO enable / disable, default = enable.

Choices:

  • "disable"

  • "enable"

name

string / required

Wi-Fi VAP name.

passphrase

string

Wi-Fi passphrase.

pmf

string

Wi-Fi pmf enable/disable, default = disable.

Choices:

  • "disabled"

  • "optional"

  • "required"

rts_threshold

integer

Wi-Fi RTS Threshold (256 - 2347)).

sae_password

string

Wi-Fi SAE Password.

security

string

Wi-Fi security.

Choices:

  • "OPEN"

  • "WPA2-Personal"

  • "WPA-WPA2-Personal"

  • "WPA3-SAE"

  • "WPA3-SAE-Transition"

  • "WPA2-Enterprise"

  • "WPA3-Enterprise-only"

  • "WPA3-Enterprise-transition"

  • "WPA3-Enterprise-192-bit"

ssid

string

Wi-Fi SSID.

start_ip

string

Start ip address.

target_wake_time

string

Wi-Fi 802.11AX target wake time enable / disable, default = enable.

Choices:

  • "disable"

  • "enable"

type

string

Wi-Fi VAP type local-vap / lan-extension-vap.

Choices:

  • "local-vap"

  • "lan-ext-vap"

member_path

string

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.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • "present"

  • "absent"

state

string / required

Indicates whether to create or remove the object.

Choices:

  • "present"

  • "absent"

vdom

string

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.

Default: "root"

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: FortiExtender wifi vap configuration.
  fortinet.fortios.fortios_extension_controller_extender_vap:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      extension_controller_extender_vap:
          allowaccess: "ping"
          auth_server_address: "<your_own_value>"
          auth_server_port: "0"
          auth_server_secret: "<your_own_value>"
          broadcast_ssid: "disable"
          bss_color_partial: "disable"
          dtim: "1"
          end_ip: "<your_own_value>"
          ip_address: "<your_own_value>"
          max_clients: "0"
          mu_mimo: "disable"
          name: "default_name_14"
          passphrase: "<your_own_value>"
          pmf: "disabled"
          rts_threshold: "2347"
          sae_password: "<your_own_value>"
          security: "OPEN"
          ssid: "<your_own_value>"
          start_ip: "<your_own_value>"
          target_wake_time: "disable"
          type: "local-vap"

Return Values

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

Key

Description

build

string

Build number of the fortigate image

Returned: always

Sample: "1547"

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: "PUT"

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: "200"

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: "id"

name

string

Name of the table used to fulfill the request

Returned: always

Sample: "urlfilter"

path

string

Path of the table used to fulfill the request

Returned: always

Sample: "webfilter"

revision

string

Internal revision number

Returned: always

Sample: "17.0.2.10658"

serial

string

Serial number of the unit

Returned: always

Sample: "FGVMEVYYQT3AB5352"

status

string

Indication of the operation’s result

Returned: always

Sample: "success"

vdom

string

Virtual domain used

Returned: always

Sample: "root"

version

string

Version of the FortiGate

Returned: always

Sample: "v5.6.3"

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)