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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить логирование для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизация клиента Ansible с помощью токена доступа к API forticloud.
mpsk-group строка	Устаревшее, используйте «mpsk_group»
mpsk-profile строка	Устаревшее, используйте «mpsk_profile»
mpsk_group строка	Параметр (mpsk-group) в запрошенном URL.
mpsk_profile строка	Параметр (mpsk-profile) в запрошенном URL.
mpskprofile_mpskgroup_mpskkey словарь	Набор параметров верхнего уровня.
comment строка	Комментарий.
concurrent_client_limit_type строка	Устаревшее, переименовать в concurrent_client_limit_type. Типы лимитов одновременных клиентов MPSK. Варианты: `"default"` `"unlimited"` `"specified"`
concurrent_clients целое число	Устаревшее, переименовать в concurrent_clients. Количество клиентов, которые могут подключиться с использованием этого предварительно согласованного ключа.
key_type строка	Устаревшее, переименовать в key_type. Выбор типа ключа. Варианты: `"wpa2-personal"` `"wpa3-sae"`
mac строка	MAC-адрес.
mpsk_schedules любой	(список или строка) Устаревшее, переименовать в mpsk_schedules. Расписание брандмауэра для пароля MPSK.
name строка / обязательно	Имя предварительно согласованного ключа.
passphrase любой	(список) Предварительный ключ WPA.
pmk любой	(список) WPA PMK.
sae_password любой	(список) Устаревшее, переименовать в sae_password. Пароль WPA3 SAE.
sae_pk строка	Устаревшее, переименовать в sae_pk. Включить/выключить WPA3 SAE-PK Варианты: `"disable"` `"enable"`
sae_private_key строка	Устаревшее, переименовать в sae_private_key. Приватный ключ, используемый для аутентификации WPA3 SAE-PK.

proposed_method строка	Переопределённый метод для базового запроса Json RPC. Выбоpы: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список rc-кодов, по которым будет переопределено условие завершения с ошибкой.
rc_succeeded список / элементы=целое число	Список rc-кодов, по которым будет переопределено условие успешного завершения.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Выбоpы: `"present"` `"absent"`
workspace_locking_adom строка	ADOM для блокировки при работе FortiManager в режиме рабочего пространства; значение может быть глобальным или другим, включая root.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем. По умолчанию: `300`

Примечания

Примечание

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

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: List of multiple PSK entries.
      fortinet.fortimanager.fmgr_mpskprofile_mpskgroup_mpskkey:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        mpsk_profile: <your own value>
        mpsk_group: <your own value>
        state: present # <value in [present, absent]>
        mpskprofile_mpskgroup_mpskkey:
          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>

Значения возврата

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный запрашиваемый URL. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Детальное сообщение об ответе API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_mpskprofile_mpskgroup_mpskkey_module.html