модуль fortinet.fortimanager.fmgr_mpskprofile_mpskgroup_mpskkey — список нескольких записей PSK.

Примечание

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

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

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

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

Добавлено в 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.
mpsk-group string	Устарело, используйте “mpsk_group”
mpsk-profile string	Устарело, используйте “mpsk_profile”
mpsk_group string	Параметр (mpsk-group) в запрошенном URL.
mpsk_profile string	Параметр (mpsk-profile) в запрошенном URL.
mpskprofile_mpskgroup_mpskkey dictionary	Параметры верхнего уровня.
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	(список) Пароль WPA3 SAE.
sae_pk псевдонимы: sae-pk string	Включить/отключить WPA3 SAE-PK Варианты: `"disable"` `"enable"`
sae_private_key псевдонимы: sae-private-key string	Закрытый ключ, используемый для аутентификации WPA3 SAE-PK.
proposed_method string	Переопределяемый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, переопределяющий условия неудачного выполнения.
rc_succeeded list / elements=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: List of multiple PSK entries.
      fortinet.fortimanager.fmgr_mpskprofile_mpskgroup_mpskkey:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        mpsk_profile: <your own value>
        mpsk_group: <your own value>
        state: present # <value in [present, absent]>
        mpskprofile_mpskgroup_mpskkey:
          name: "your value" # Required variable, string
          # comment: <string>
          # concurrent_client_limit_type: <value in [default, unlimited, specified]>
          # concurrent_clients: <integer>
          # mac: <string>
          # mpsk_schedules: <list or 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>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=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_mpskgroup_mpskkey_module.html