Модуль fortinet.fortimanager.fmgr_extensioncontroller_extendervap — настройка Wi-Fi VAP FortiExtender.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать коллекцию в плейбуке, укажите: fortinet.fortimanager.fmgr_extensioncontroller_extendervap.

Добавлено в fortinet.fortimanager 2.10.0

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль позволяет настраивать устройство FortiManager.
В примерах указаны все параметры и значения, которые перед использованием необходимо настроить в соответствии с источниками данных.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
extensioncontroller_extendervap dictionary	Набор параметров верхнего уровня.
allowaccess list / элементы=string	Управление доступом к управлению подключенным расширителем. Варианты: `"http"` `"ssh"` `"telnet"` `"snmp"` `"https"` `"ping"`
auth_server_address псевдонимы: auth-server-address string	Адрес сервера аутентификации Wi-Fi.
auth_server_port псевдонимы: auth-server-port integer	Порт сервера аутентификации Wi-Fi.
auth_server_secret псевдонимы: auth-server-secret string	Секрет сервера аутентификации Wi-Fi.
broadcast_ssid псевдонимы: broadcast-ssid string	Включение или отключение трансляции SSID Wi-Fi. Варианты: `"disable"` `"enable"`
bss_color_partial псевдонимы: bss-color-partial string	Wi-Fi 802. Варианты: `"disable"` `"enable"`
dtim integer	DTIM Wi-Fi.
end_ip псевдонимы: end-ip string	Конечный IP-адрес.
ip_address псевдонимы: ip-address list / элементы=string	IP-адрес расширителя.
max_clients псевдонимы: max-clients integer	Максимальное количество клиентов Wi-Fi.
mu_mimo псевдонимы: mu-mimo string	Включение или отключение многопользовательского MIMO Wi-Fi; по умолчанию включено. Варианты: `"disable"` `"enable"`
name string / обязательный	Имя VAP Wi-Fi.
passphrase list / элементы=string	Парольная фраза Wi-Fi.
pmf string	Включение или отключение PMF Wi-Fi; по умолчанию отключено. Варианты: `"disabled"` `"optional"` `"required"`
rts_threshold псевдонимы: rts-threshold integer	Порог RTS Wi-Fi.
sae_password псевдонимы: sae-password list / элементы=string	Пароль SAE Wi-Fi.
security string	Безопасность Wi-Fi. Варианты: `"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	SSID Wi-Fi.
start_ip псевдонимы: start-ip string	Начальный IP-адрес.
target_wake_time псевдонимы: target-wake-time string	Wi-Fi 802. Варианты: `"disable"` `"enable"`
type string	Тип VAP Wi-Fi: local-vap / lan-extension-vap. Варианты: `"local-vap"` `"lan-ext-vap"`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.
proposed_method string	Переопределяемый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, с помощью которого переопределяются условия сбоя.
rc_succeeded list / элементы=integer	Список кодов rc, с помощью которого переопределяются условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM для блокировки при работе FortiManager в режиме рабочей области. В качестве значения можно указать global или другое значение, в том числе root.
workspace_locking_timeout integer	Максимальное время ожидания освобождения блокировки рабочей области другим пользователем, в секундах. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, во всех входных аргументах используется соглашение об именовании с нижним подчёркиванием (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, однако будут выдаваться предупреждения об устаревании. Это предупреждение можно отключить, задав deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области. Для этого предназначены параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
Обычно выполнение модуля завершается ошибкой, если возвращается ненулевое значение rc. Условия сбоя или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: FortiExtender wifi vap configuration.
      fortinet.fortimanager.fmgr_extensioncontroller_extendervap:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        extensioncontroller_extendervap:
          name: "your value" # Required variable, string
          # allowaccess: ["http", "ssh", "telnet", "snmp", "https", "ping"]
          # auth_server_address: <string>
          # auth_server_port: <integer>
          # auth_server_secret: <string>
          # broadcast_ssid: <value in [disable, enable]>
          # bss_color_partial: <value in [disable, enable]>
          # dtim: <integer>
          # end_ip: <string>
          # ip_address: <list or string>
          # max_clients: <integer>
          # mu_mimo: <value in [disable, enable]>
          # passphrase: <list or string>
          # pmf: <value in [disabled, optional, required]>
          # rts_threshold: <integer>
          # sae_password: <list or string>
          # security: <value in [OPEN, WPA2-Personal, WPA-WPA2-Personal, ...]>
          # ssid: <string>
          # start_ip: <string>
          # target_wake_time: <value in [disable, enable]>
          # type: <value in [local-vap, lan-ext-vap]>

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, специфичные для этого модуля:

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_extensioncontroller_extendervap_module.html