Модуль fortinet.fortios.fortios_system_saml — глобальные настройки аутентификации SAML в Fortinet FortiOS и FortiGate.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_system_saml.
Добавлено в fortinet.fortios 2.0.0
Обзор
- Этот модуль позволяет настраивать устройства FortiGate или FortiOS (FOS), задавая и изменяя параметры системной функции и категории SAML. В примерах приведены все параметры и значения, которые необходимо скорректировать с учетом источников данных перед использованием. Проверено с FOS v6.0.0
Требования
На хосте, где выполняется этот модуль, должны быть установлены следующие компоненты.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
member_path string | Путь к атрибуту элемента, с которым нужно выполнить операцию. Если атрибутов несколько, они разделяются символом косой черты. Параметр с пометкой member_path можно использовать для выполнения операции с элементом. |
member_state string | Добавить или удалить элемент по указанному пути к атрибуту. Если задан member_state, параметр state игнорируется. Варианты:
|
system_saml dictionary | Глобальные настройки аутентификации SAML. |
|
artifact_resolution_url string |
URL-адрес разрешения артефактов SP. |
|
binding_protocol string |
Протокол привязки IdP. Варианты:
|
|
cert string |
Сертификат для подписи сообщений SAML. Источник: certificate.local.name. |
|
default_login_page string |
Выберите страницу входа по умолчанию. Варианты:
|
|
default_profile string |
Профиль по умолчанию для нового администратора SSO. Источник: system.accprofile.name. |
|
entity_id string |
Идентификатор сущности SP. |
|
idp_artifact_resolution_url string |
URL-адрес разрешения артефактов IDP. |
|
idp_cert string |
Имя сертификата IDP. Источник: certificate.remote.name. |
|
idp_entity_id string |
Идентификатор сущности IDP. |
|
idp_single_logout_url string |
URL-адрес единого выхода IDP. |
|
idp_single_sign_on_url string |
URL-адрес единого входа IDP. |
|
life integer |
Продолжительность периода, в течение которого утверждение действительно (в минутах). |
|
portal_url string |
URL-адрес портала SP. |
|
require_signed_resp_and_asrt string |
Требовать подписи и ответа, и утверждения от IDP, когда FGT выступает в роли SP. Варианты:
|
|
role string |
Роль SAML. Варианты:
|
|
server_address string |
Адрес сервера. |
|
service_providers list / элементы=dictionary |
Авторизованные поставщики услуг. |
|
assertion_attributes list / элементы=dictionary |
Настраиваемые атрибуты SAML, передаваемые вместе с утверждением. |
|
name string / обязательный |
Имя. |
|
type string |
Тип. Варианты:
|
|
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. Варианты:
|
|
sp_cert string |
Имя сертификата SP. Источник: certificate.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. Варианты:
|
|
tolerance integer |
Допустимое отклонение для периода, в течение которого утверждение действительно (в минутах). |
vdom string | Виртуальный домен из числа предварительно заданных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревший fortiosapi объявлен нерекомендуемым; предпочтительный способ запуска плейбуков — httpapi
- Модуль поддерживает check_mode.
Примеры
- 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>"
require_signed_resp_and_asrt: "enable"
role: "identity-provider"
server_address: "<your_own_value>"
service_providers:
-
assertion_attributes:
-
name: "default_name_21"
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_27"
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 Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, возвращённый FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey string | Мастер-ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успехе Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер ревизии Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат выполнения операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_system_saml_module.html