модуль fortinet.fortimanager.fmgr_mpskprofile — Настройка профиля MPSK.

Примечание

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

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

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

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

Новое в fortinet.fortimanager 2.1.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.
mpskprofile dictionary	Параметры верхнего уровня.
mpsk_concurrent_clients псевдонимы: mpsk-concurrent-clients integer	Максимальное количество одновременно подключённых клиентов, использующих одну и ту же парольную фразу при аутентификации с несколькими PSK
mpsk_external_server псевдонимы: mpsk-external-server any	(список) Сервер RADIUS для аутентификации пользователей MPSK.
mpsk_external_server_auth псевдонимы: mpsk-external-server-auth string	Включить или отключить аутентификацию MPSK на внешнем сервере Варианты: `"disable"` `"enable"`
mpsk_group псевдонимы: mpsk-group list / элементы=dictionary	Группа MPSK.
mpsk_key псевдонимы: mpsk-key list / элементы=dictionary	Ключ MPSK.
comment string	Комментарий.
concurrent_client_limit_type псевдонимы: concurrent-client-limit-type string	Варианты типа ограничения количества клиентов MPSK. Варианты: `"default"` `"unlimited"` `"specified"`
concurrent_clients псевдонимы: concurrent-clients integer	Количество клиентов, которые могут подключиться с помощью этого предварительно установленного ключа
key_type псевдонимы: key-type string	Выберите тип ключа. Варианты: `"wpa2-personal"` `"wpa3-sae"`
mac string	MAC-адрес.
mpsk_schedules псевдонимы: mpsk-schedules any	(список или строка) Расписание брандмауэра для парольной фразы MPSK.
name string	Имя предварительно установленного ключа.
passphrase any	(список) Предварительно установленный ключ WPA.
pmk any	(список) PMK WPA.
sae_password псевдонимы: sae-password any	(список) Пароль SAE для WPA3.
sae_pk псевдонимы: sae-pk string	Включить или отключить SAE-PK для WPA3 Варианты: `"disable"` `"enable"`
sae_private_key псевдонимы: sae-private-key string	Закрытый ключ, используемый для аутентификации WPA3 SAE-PK.
name string	Имя группы MPSK.
vlan_id псевдонимы: vlan-id integer	Необязательный идентификатор VLAN.
vlan_type псевдонимы: vlan-type string	Варианты VLAN для группы MPSK. Варианты: `"no-vlan"` `"fixed-vlan"`
mpsk_type псевдонимы: mpsk-type string	Выберите тип безопасности ключей для этого профиля. Варианты: `"wpa2-personal"` `"wpa3-sae"` `"wpa3-sae-transition"`
name string / обязательный	Имя профиля MPSK.
ssid string	SSID точки доступа VAP, в которой настроен профиль MPSK.
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: Configure MPSK profile.
      fortinet.fortimanager.fmgr_mpskprofile:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        mpskprofile:
          name: "your value" # Required variable, string
          # mpsk_concurrent_clients: <integer>
          # mpsk_group:
          #   - mpsk_key:
          #       - comment: <string>
          #         concurrent_client_limit_type: <value in [default, unlimited, specified]>
          #         concurrent_clients: <integer>
          #         mac: <string>
          #         mpsk_schedules: <list or string>
          #         name: <string>
          #         passphrase: <list or string>
          #         pmk: <list or string>
          #         key_type: <value in [wpa2-personal, wpa3-sae]>
          #         sae_password: <list or string>
          #         sae_pk: <value in [disable, enable]>
          #         sae_private_key: <string>
          #     name: <string>
          #     vlan_id: <integer>
          #     vlan_type: <value in [no-vlan, fixed-vlan]>
          # ssid: <string>
          # mpsk_external_server: <list or string>
          # mpsk_external_server_auth: <value in [disable, enable]>
          # mpsk_type: <value in [wpa2-personal, wpa3-sae, wpa3-sae-transition]>

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

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

Ключ	Описание
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_mpskprofile_module.html