Модуль fortinet.fortios.fortios_user_external_identity_provider — настройка внешнего поставщика удостоверений в Fortinet FortiOS и FortiGate.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты; подробную информацию см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_user_external_identity_provider.

Добавлено в fortinet.fortios 2.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры категории user и функции external_identity_provider. Примеры содержат все параметры, значения которых необходимо адаптировать к источникам данных перед использованием. Проверено на FOS v6.0.0

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate.
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path string	Путь к атрибуту участника, с которым нужно выполнить операцию. Если атрибутов несколько, они разделяются косой чертой. Параметр с пометкой member_path можно использовать для выполнения операций с участниками.
member_state string	Добавить или удалить участника по указанному пути атрибута. Если задан параметр member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
state string / обязательный	Указывает, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
user_external_identity_provider dictionary	Настройка внешнего поставщика удостоверений.
group_attr_name string	Имя атрибута группы в запросе аутентификации.
interface string	Укажите исходящий интерфейс для доступа к серверу. Источник: system.interface.name.
interface_select_method string	Укажите способ выбора исходящего интерфейса для доступа к серверу. Варианты: `"auto"` `"sdwan"` `"specify"`
name string / обязательный	Имя внешнего поставщика удостоверений.
port integer	Номер порта службы внешнего поставщика удостоверений (0 — использовать значение по умолчанию).
server_identity_check string	Включить или отключить проверку подлинности сервера по его сертификату и альтернативным именам субъекта. Варианты: `"disable"` `"enable"`
source_ip string	Использовать этот адрес IPv4/IPv6 для подключения к внешнему поставщику удостоверений.
timeout integer	Время ожидания подключения в секундах.
type string	Тип внешнего поставщика удостоверений. Варианты: `"ms-graph"`
user_attr_name string	Имя атрибута пользователя в запросе аутентификации.
version string	Версия API внешнего поставщика удостоверений. Варианты: `"v1.0"` `"beta"`
vrf_select integer	Идентификатор VRF, используемый для подключения к серверу.
vdom string	Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Устаревший fortiosapi объявлен нерекомендуемым; предпочтительный способ запуска плейбуков — httpapi.
Модуль поддерживает check_mode.

Примеры

- name: Configure external identity provider.
  fortinet.fortios.fortios_user_external_identity_provider:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_external_identity_provider:
          group_attr_name: "<your_own_value>"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          name: "default_name_6"
          port: "0"
          server_identity_check: "disable"
          source_ip: "84.230.14.43"
          timeout: "5"
          type: "ms-graph"
          user_attr_name: "<your_own_value>"
          version: "v1.0"
          vrf_select: "0"

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

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

Ключ	Описание
build string	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат, полученный от FortiGate при выполнении последней операции Возвращается: всегда Пример: `"200"`
mkey string	Мастер-ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успехе Пример: `"id"`
name string	Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path string	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision string	Внутренний номер редакции Возвращается: всегда Пример: `"17.0.2.10658"`
serial string	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status string	Результат выполнения операции Возвращается: всегда Пример: `"success"`
vdom string	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version string	Версия FortiGate Возвращается: всегда Пример: `"v5.6.3"`

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Ссылки на коллекцию

© 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/fortios/fortios_user_external_identity_provider_module.html