Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_wireless_controller_mpsk_profile — настройка профиля MPSK в Fortinet FortiOS и FortiGate.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для работы с этим модулем могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_wireless_controller_mpsk_profile.

Добавлено в fortinet.fortios 2.0.0

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

Обзор

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), устанавливая и изменяя параметры функции wireless_controller и категории mpsk_profile. Примеры включают все параметры; перед использованием необходимо настроить их значения в соответствии с источниками данных. Проверено с FOS v6.0.0

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate.

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

member_path

string

Путь к атрибуту элемента, с которым нужно выполнить операцию.

Если атрибутов несколько, они разделяются символом косой черты.

Параметр с указанием member_path можно использовать для выполнения операции над элементом.

member_state

string

Добавить или удалить элемент по указанному пути атрибута.

Если задан параметр member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

state

string / обязательный

Указывает, следует ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

vdom

string

Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

wireless_controller_mpsk_profile

dictionary

Настройка профиля MPSK.

mpsk_concurrent_clients

integer

Максимальное количество одновременно подключенных клиентов, использующих одну и ту же парольную фразу при аутентификации по нескольким PSK (0–65535).

mpsk_external_server

string

RADIUS-сервер для аутентификации пользователей MPSK. Источник: user.radius.name.

mpsk_external_server_auth

string

Включить или отключить аутентификацию MPSK с помощью внешнего сервера.

Варианты:

  • "enable"
  • "disable"

mpsk_group

list / elements=dictionary

Список нескольких групп PSK.

mpsk_key

list / elements=dictionary

Список нескольких записей PSK.

comment

string

Комментарий.

concurrent_client_limit_type

string

Тип ограничения числа клиентов MPSK.

Варианты:

  • "default"
  • "unlimited"
  • "specified"

concurrent_clients

integer

Количество клиентов, которые могут подключиться с использованием этого предварительно установленного ключа (1–65535).

key_type

string

Выберите тип ключа.

Варианты:

  • "wpa2-personal"
  • "wpa3-sae"

mac

string

MAC-адрес.

mpsk_schedules

list / elements=dictionary

Расписание межсетевого экрана для парольной фразы MPSK. Парольная фраза будет действовать только при наличии хотя бы одного действующего расписания.

name

string / обязательный

Имя расписания. Источник: firewall.schedule.group.name, firewall.schedule.recurring.name, firewall.schedule.onetime.name.

name

string / обязательный

Имя предварительно установленного ключа.

passphrase

string

Предварительно установленный ключ WPA.

sae_password

string

Пароль WPA3 SAE.

sae_pk

string

Включить или отключить WPA3 SAE-PK.

Варианты:

  • "enable"
  • "disable"

sae_private_key

string

Закрытый ключ для аутентификации WPA3 SAE-PK.

name

string / обязательный

Имя группы MPSK.

vlan_id

integer

Необязательный идентификатор VLAN.

vlan_type

string

Параметры VLAN группы MPSK.

Варианты:

  • "no-vlan"
  • "fixed-vlan"

mpsk_type

string

Выберите тип защиты ключей для этого профиля.

Варианты:

  • "wpa2-personal"
  • "wpa3-sae"
  • "wpa3-sae-transition"

name

string / обязательный

Имя профиля MPSK.

Примечания

Примечание

  • Поддержка устаревшего fortiosapi прекращена; для запуска плейбуков рекомендуется использовать httpapi.
  • Модуль поддерживает check_mode.

Примеры

- name: Configure MPSK profile.
  fortinet.fortios.fortios_wireless_controller_mpsk_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      wireless_controller_mpsk_profile:
          mpsk_concurrent_clients: "0"
          mpsk_external_server: "<your_own_value> (source user.radius.name)"
          mpsk_external_server_auth: "enable"
          mpsk_group:
              -
                  mpsk_key:
                      -
                          comment: "Comment."
                          concurrent_client_limit_type: "default"
                          concurrent_clients: "256"
                          key_type: "wpa2-personal"
                          mac: "<your_own_value>"
                          mpsk_schedules:
                              -
                                  name: "default_name_14 (source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name)"
                          name: "default_name_15"
                          passphrase: "<your_own_value>"
                          sae_password: "<your_own_value>"
                          sae_pk: "enable"
                          sae_private_key: "<your_own_value>"
                  name: "default_name_20"
                  vlan_id: "0"
                  vlan_type: "no-vlan"
          mpsk_type: "wpa2-personal"
          name: "default_name_24"

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

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

Ключ

Описание

build

string

Номер сборки образа FortiGate

Возвращается: всегда

Пример: "1547"

http_method

string

Последний метод, использованный для передачи данных в FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

string

Последний результат, возвращенный FortiGate для последней выполненной операции

Возвращается: всегда

Пример: "200"

mkey

string

Главный ключ (идентификатор), использованный в последнем запросе к FortiGate

Возвращается: при успешном выполнении

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

Возвращается: всегда

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

Возвращается: всегда

Пример: "webfilter"

revision

string

Внутренний номер редакции

Возвращается: всегда

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат операции

Возвращается: всегда

Пример: "success"

vdom

string

Используемый виртуальный домен

Возвращается: всегда

Пример: "root"

version

string

Версия FortiGate

Возвращается: всегда

Пример: "v5.6.3"

Авторы

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

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

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 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/fortios/fortios_wireless_controller_mpsk_profile_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API