fortinet.fortimanager.fmgr_system_saml – Глобальные настройки для аутентификации SAML.

Примечание

Этот плагин является частью коллекции fortinet.fortimanager (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_system_saml.

Новое в версии 2.10: модуля fortinet.fortimanager

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

Описание

Этот модуль может настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо скорректировать для источников данных перед использованием.

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean			Варианты: нет ← да	устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров
rc_failed список / элементы=строка				список rc-кодов, с которыми условия для отказа будут переопределены
rc_succeeded список / элементы=строка				список rc-кодов, с которыми условия для успешного выполнения будут переопределены
state строка / обязательный			Варианты: present absent	направление для создания, обновления или удаления объекта
system_saml словарь				установленные параметры верхнего уровня
	acs-url строка			URL ACS(логин) SP.
	cert строка			Имя сертификата.
	entity-id строка			Идентификатор сущности SP.
	idp-cert строка			Имя сертификата IDP.
	idp-entity-id строка			Идентификатор сущности IDP.
	idp-single-logout-url строка			URL для выхода IDP.
	idp-single-sign-on-url строка			URL для входа IDP.
	login-auto-redirect строка		Варианты: выключить ← включить	Включить/Выключить автоматическое перенаправление на страницу входа IDP. выключить - Отключить автоматическое перенаправление на страницу входа IDP. включить - Включить автоматическое перенаправление на страницу входа IDP.
	role строка		Варианты: IDP SP ←	Роль SAML. IDP - Провайдер идентификации. SP - Провайдер сервиса.
	server-address строка			адрес сервера.
	service-providers список / элементы=строка			нет описания
		idp-entity-id строка		Идентификатор сущности IDP.
		idp-single-logout-url строка		URL для выхода IDP.
		idp-single-sign-on-url строка		URL для входа IDP.
		name строка		Имя.
		prefix строка		Префикс.
		sp-cert строка		Имя сертификата SP.
		sp-entity-id строка		Идентификатор сущности SP.
		sp-single-logout-url строка		URL для выхода SP.
		sp-single-sign-on-url строка		URL для входа SP.
	sls-url строка			URL SLS(выход) SP.
	status строка		Варианты: выключить ← включить	Включить/Выключить аутентификацию SAML (по умолчанию = выключить). выключить - Отключить аутентификацию SAML. включить - Включить аутентификацию SAML.
workspace_locking_adom строка				ADOM для блокировки при работе в режиме рабочего пространства FortiManager, значение может быть глобальным и другими, включая корневой.
workspace_locking_timeout целое число			По умолчанию: 300	максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство.

Примечания

Примечание

Работа в режиме блокировки рабочего пространства поддерживается в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этой работе.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться неудачей при возвращении ненулевого rc. Вы также можете переопределить условия отказа или успеха параметрами rc_failed и rc_succeeded.

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Global settings for SAML authentication.
     fmgr_system_saml:
        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, ...]
        system_saml:
           acs-url: <value of string>
           cert: <value of string>
           entity-id: <value of string>
           idp-cert: <value of string>
           idp-entity-id: <value of string>
           idp-single-logout-url: <value of string>
           idp-single-sign-on-url: <value of string>
           login-auto-redirect: <value in [disable, enable]>
           role: <value in [IDP, SP]>
           server-address: <value of string>
           service-providers:
             -
                 idp-entity-id: <value of string>
                 idp-single-logout-url: <value of string>
                 idp-single-sign-on-url: <value of string>
                 name: <value of string>
                 prefix: <value of string>
                 sp-cert: <value of string>
                 sp-entity-id: <value of string>
                 sp-single-logout-url: <value of string>
                 sp-single-sign-on-url: <value of string>
           sls-url: <value of string>
           status: <value in [disable, enable]>

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

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

Ключ	Возвращаемое значение	Описание
request_url строка	всегда	Полный запрашиваемый URL Пример: /sys/login/user
response_code целое число	всегда	Статус запроса API
response_message строка	всегда	Детальное сообщение ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_saml_module.html