Модуль fortinet.fortios.fortios_system_saml – Глобальные настройки SAML-аутентификации в 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_system_saml.

Новая функция в fortinet.fortios 2.0.0

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

Описание

Этот модуль может настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять системные функции и категорию SAML. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с 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"`
system_saml словарь	Общие настройки для аутентификации SAML.
artifact_resolution_url строка	URL разрешения артефакта SP.
binding_protocol строка	Протокол привязки IdP. Варианты: `"post"` `"redirect"`
cert строка	Сертификат для подписи сообщений SAML. Источник сертификата.local.name.
default_login_page строка	Выбор страницы входа по умолчанию. Варианты: `"normal"` `"sso"`
default_profile строка	Профиль по умолчанию для нового администратора SSO. Источник system.accprofile.name.
entity_id строка	Идентификатор сущности SP.
idp_artifact_resolution_url строка	URL разрешения артефакта IdP.
idp_cert строка	Имя сертификата IdP. Источник certificate.remote.name.
idp_entity_id строка	Идентификатор сущности IdP.
idp_single_logout_url строка	URL единого выхода IdP.
idp_single_sign_on_url строка	URL единого входа IdP.
life целое число	Длительность периода времени, в течение которого утверждение является действительным (в минутах).
portal_url строка	URL портала SP.
role строка	Роль SAML. Варианты: `"identity-provider"` `"service-provider"`
server_address строка	Адрес сервера.
service_providers список / элементы=словарь	Авторизованные поставщики услуг.
assertion_attributes список / элементы=словарь	Настраиваемые атрибуты SAML для отправки вместе с утверждением.
name строка / обязательно	Имя.

END_OF_DOCUMENT_MARKER

type string	Тип. Варианты: `"username"` `"email"` `"profile-name"`
idp_artifact_resolution_url string	URL разрешения артефакта IDP.
idp_entity_id string	Идентификатор сущности IDP.
idp_single_logout_url string	URL единого выхода IDP.
idp_single_sign_on_url string	URL единого входа IDP.
name string / обязательно	Имя.
prefix string	Префикс.
sp_artifact_resolution_url string	URL разрешения артефакта SP.
sp_binding_protocol string	Протокол связи SP. Варианты: `"post"` `"redirect"`
sp_cert string	Имя сертификата SP. Источник сертификата.remote.name.
sp_entity_id string	Идентификатор сущности SP.
sp_portal_url string	URL портала SP.
sp_single_logout_url string	URL единого выхода SP.
sp_single_sign_on_url string	URL единого входа SP.
single_logout_url string	URL единого выхода SP.
single_sign_on_url string	URL единого входа SP.
status string	Включить/выключить аутентификацию SAML. Варианты: `"enable"` `"disable"`
tolerance integer	Допуск к диапазону времени, когда утверждение действует (в минутах).
vdom string	Виртуальная область, среди ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который может быть настроен и использован как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Модуль fortiosapi устарел, предпочтительный способ выполнения playbooks — httpapi

Примеры

- name: Global settings for SAML authentication.
  fortinet.fortios.fortios_system_saml:
      vdom: "{{ vdom }}"
      system_saml:
          artifact_resolution_url: "<your_own_value>"
          binding_protocol: "post"
          cert: "<your_own_value> (source certificate.local.name)"
          default_login_page: "normal"
          default_profile: "<your_own_value> (source system.accprofile.name)"
          entity_id: "<your_own_value>"
          idp_artifact_resolution_url: "<your_own_value>"
          idp_cert: "<your_own_value> (source certificate.remote.name)"
          idp_entity_id: "<your_own_value>"
          idp_single_logout_url: "<your_own_value>"
          idp_single_sign_on_url: "<your_own_value>"
          life: "30"
          portal_url: "<your_own_value>"
          role: "identity-provider"
          server_address: "<your_own_value>"
          service_providers:
              -
                  assertion_attributes:
                      -
                          name: "default_name_20"
                          type: "username"
                  idp_artifact_resolution_url: "<your_own_value>"
                  idp_entity_id: "<your_own_value>"
                  idp_single_logout_url: "<your_own_value>"
                  idp_single_sign_on_url: "<your_own_value>"
                  name: "default_name_26"
                  prefix: "<your_own_value>"
                  sp_artifact_resolution_url: "<your_own_value>"
                  sp_binding_protocol: "post"
                  sp_cert: "<your_own_value> (source certificate.remote.name)"
                  sp_entity_id: "<your_own_value>"
                  sp_portal_url: "<your_own_value>"
                  sp_single_logout_url: "<your_own_value>"
                  sp_single_sign_on_url: "<your_own_value>"
          single_logout_url: "<your_own_value>"
          single_sign_on_url: "<your_own_value>"
          status: "enable"
          tolerance: "5"

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

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

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