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

Примечание

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

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

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

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

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

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

Описание

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

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

ansible>=2.15

Параметры

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

Примечания

Примечание

Устаревший fortiosapi устарел, httpapi — предпочтительный способ запуска playbooks

Примеры

- 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"

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

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

Ключ	Описание
build строка	Номер сборки образа Fortigate Возвращается: всегда Пример: `"1547"`
http_method строка	Последний метод, используемый для предоставления контента в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status строка	Последний результат, предоставленный FortiGate после последней операции Возвращается: всегда Пример: `"200"`
mkey строка	Главный ключ (id), используемый в последнем запросе к FortiGate Возвращается: успешно Пример: `"id"`
name строка	Имя таблицы, используемой для обработки запроса Возвращается: всегда Пример: `"urlfilter"`
path строка	Путь к таблице, используемой для обработки запроса Возвращается: всегда Пример: `"webfilter"`
revision строка	Внутренний номер версии Возвращается: всегда Пример: `"17.0.2.10658"`
serial строка	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status строка	Указание результата операции Возвращается: всегда Пример: `"success"`
vdom строка	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version строка	Версия 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_user_external_identity_provider_module.html