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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить логирование для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Проверка подлинности клиента Ansible с помощью токена доступа к API forticloud.
mpskprofile словарь	Настройка параметров верхнего уровня.
mpsk_concurrent_clients целое число	Устаревшее, пожалуйста, переименуйте на mpsk_concurrent_clients. Максимальное количество одновременных подключений клиентов, использующих тот же …
mpsk_external_server любой тип	(список) Устаревшее, пожалуйста, переименуйте на mpsk_external_server. Сервер RADIUS, используемый для аутентификации пользователей MPSK.
mpsk_external_server_auth строка	Устаревшее, пожалуйста, переименуйте на mpsk_external_server_auth. Включить/выключить аутентификацию внешнего сервера MPSK Варианты: `"disable"` `"enable"`
mpsk_group список / элементы=словарь	Устаревшее, пожалуйста, переименуйте на mpsk_group. Группа MPSK.
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 string	Устарело, пожалуйста, переименуйте на sae_private_key. Секретный ключ, используемый для аутентификации WPA3 SAE-PK.
name string	Имя группы MPSK.
vlan-id integer	Устарело, пожалуйста, переименуйте на vlan_id. Необязательный идентификатор VLAN.
vlan-type string	Устарело, пожалуйста, переименуйте на vlan_type. Параметры VLAN группы MPSK. Варианты: `"no-vlan"` `"fixed-vlan"`
mpsk-type string	Устарело, пожалуйста, переименуйте на mpsk_type. Выберите тип защиты ключей для этого профиля. Варианты: `"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 список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для отказа.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для успеха.
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 помогают в этой работе.
Для создания или обновления объекта используйте директиву 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: Configure MPSK profile.
      fortinet.fortimanager.fmgr_mpskprofile:
        # 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>
        state: present # <value in [present, absent]>
        mpskprofile:
          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]>
          name: <string>
          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 словарь	Результат запроса. Возвращается: всегда
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_module.html