Модуль fortinet.fortimanager.fmgr_user_externalidentityprovider — Настройка внешнего поставщика идентификации.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

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

Новая функция в fortinet.fortimanager 2.6.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.
proposed_method строка	Переопределённый метод для основного запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое	Список кодов rc, с которыми будут переопределены условия для отказа.
rc_succeeded список / элементы=целое	Список кодов rc, с которыми будут переопределены условия для успешного выполнения.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
user_externalidentityprovider словарь	Настройка верхнего уровня параметров.
group_attr_name строка	Устарело, пожалуйста, переименуйте на group_attr_name. Имя атрибута группы в запросе аутентификации.
interface список / элементы=строка	Укажите исходящий интерфейс для доступа к серверу.
interface_select_method строка	Устарело, пожалуйста, переименуйте на interface_select_method. Укажите способ выбора исходящего интерфейса для доступа к серверу. Варианты: `"auto"` `"sdwan"` `"specify"`
name строка / обязательно	Название внешнего поставщика идентификации.
port целое число	Номер порта службы внешнего поставщика идентификации.
server_identity_check строка	Устарело, пожалуйста, переименуйте на server_identity_check. Включение/выключение проверки идентификации сервера по его сертификату и s… Варианты: `"disable"` `"enable"`
source_ip строка	Устарело, пожалуйста, переименуйте на source_ip. Используйте этот IPv4/v6 адрес для подключения к внешнему поставщику идентификации.
timeout целое число	Значение тайм-аута соединения в секундах.
type строка	Тип внешнего поставщика идентификации. Варианты: `"ms-graph"`
url строка	URL.

END_OF_DOCUMENT_MARKER

user-attr-name string	Устарело, пожалуйста, переименуйте на user_attr_name. Имя атрибута пользователя в запросе аутентификации.
version string	Версия внешнего API идентификации. Варианты: `"beta"` `"v1.0"`
workspace_locking_adom string	ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочего пространства. Значение может быть глобальным и другими, включая 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 external identity provider.
      fortinet.fortimanager.fmgr_user_externalidentityprovider:
        # 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]>
        user_externalidentityprovider:
          group_attr_name: <string>
          interface: <list or string>
          interface_select_method: <value in [auto, sdwan, specify]>
          name: <string>
          port: <integer>
          server_identity_check: <value in [disable, enable]>
          source_ip: <string>
          timeout: <integer>
          type: <value in [ms-graph]>
          url: <string>
          user_attr_name: <string>
          version: <value in [beta, v1.0]>

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

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

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