Модуль fortinet.fortimanager.fmgr_mpskprofile_mpskgroup — Список нескольких групп PSK.

Примечание

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

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

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_mpskprofile_mpskgroup.

Новая функция в 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-profile строка	Устарело, используйте “mpsk_profile”
mpsk_profile строка	Параметр (mpsk-profile) в запрошенном URL.
mpskprofile_mpskgroup словарь	Настройка верхнего уровня параметров.
mpsk-key список / элементы=словарь	Устарело, переименуйте на mpsk_key. Ключ MPSK.
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.
name строка / обязательно	Имя группы MPSK.
vlan-id целое число	Устарело, переименуйте на vlan_id. Необязательный идентификатор VLAN.

END_OF_DOCUMENT_MARKER

vlan-type string	Устаревшее, пожалуйста, переименуйте на vlan_type. Параметры VLAN группы MPSK. Варианты: `"no-vlan"` `"fixed-vlan"`
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое	Список rc-кодов, с которыми будут переопределены условия для завершения неудачно.
rc_succeeded список / элементы=целое	Список rc-кодов, с которыми будут переопределены условия для успешного завершения.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	ADOM для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корень.
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 groups.
      fortinet.fortimanager.fmgr_mpskprofile_mpskgroup:
        # 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>
        state: present # <value in [present, absent]>
        mpskprofile_mpskgroup:
          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]>

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

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

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