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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_system_saml.

Новое в fortinet.fortimanager 2.0.0

Обзор
Параметры
Примечания
Примеры
Значения возврата

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation логическое	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с помощью которых будут переопределены условия для отказа.
rc_succeeded список / элементы=целое число	Список кодов rc, с помощью которых будут переопределены условия для успеха.
system_saml словарь	Настройка верхнего уровня параметров.
acs_url строка	Устарело, пожалуйста, переименуйте на acs_url. SP ACS
auth_request_signed строка	Устарело, пожалуйста, переименуйте на auth_request_signed. Включить/выключить подпись запроса авторизации. disable - Выключить опцию. enable - Включить опцию. Варианты: `"disable"` `"enable"`
cert строка	Название сертификата.
default_profile строка	Устарело, пожалуйста, переименуйте на default_profile. Имя профиля по умолчанию.
entity_id строка	Устарело, пожалуйста, переименуйте на entity_id. Идентификатор сущности SP.
fabric_idp список / элементы=словарь	Устарело, пожалуйста, переименуйте на fabric_idp. Fabric idp.
dev_id строка	Устарело, пожалуйста, переименуйте на dev_id. ID устройства ИДП.
idp_cert строка	Устарело, пожалуйста, переименуйте на idp_cert. Название сертификата ИДП.
idp_entity_id строка	Устарело, пожалуйста, переименуйте на idp_entity_id. Идентификатор сущности ИДП.
idp_single_logout_url строка	Устарело, пожалуйста, переименуйте на idp_single_logout_url. URL единого выхода ИДП.
idp_single_sign_on_url строка	Устарело, пожалуйста, переименуйте на idp_single_sign_on_url. URL единого входа ИДП.
idp_status строка	Устарело, пожалуйста, переименуйте на idp_status. Включить/выключить авторизацию SAML. disable - Выключить авторизацию SAML. enable - Включить авторизацию SAML. Варианты: `"disable"` `"enable"`
forticloud_sso строка	Устарело, пожалуйста, переименуйте на forticloud_sso. Включить/выключить FortiCloud SSO. disable - Выключить Forticloud SSO. enable - Включить Forticloud SSO. Варианты: `"disable"` `"enable"`
idp_cert строка	Устарело, пожалуйста, переименуйте на idp_cert. Название сертификата ИДП.

END_OF_DOCUMENT_MARKER

idp-entity-id string	Устарело, переименуйте в idp_entity_id. IDP entity ID.
idp-single-logout-url string	Устарело, переименуйте в idp_single_logout_url. URL выхода из системы IDP.
idp-single-sign-on-url string	Устарело, переименуйте в idp_single_sign_on_url. URL единого входа IDP.
login-auto-redirect string	Устарело, переименуйте в login_auto_redirect. Включить/выключить автоматический перенаправление на страницу входа IDP. disable - Отключить автоматический перенаправление на страницу входа IDP. enable - Включить автоматический перенаправление на страницу входа IDP. Choices: `"disable"` `"enable"`
role string	Роль SAML. IDP - Поставщик удостоверений. SP - Поставщик услуг. Choices: `"IDP"` `"SP"` `"FAB-SP"`
server-address string	Устарело, переименуйте в server_address. Адрес сервера.
service-providers list / elements=dictionary	Устарело, переименуйте в service_providers. Поставщики услуг.
idp-entity-id string	Устарело, переименуйте в idp_entity_id. IDP Entity ID.
idp-single-logout-url string	Устарело, переименуйте в idp_single_logout_url. URL выхода из системы IDP.
idp-single-sign-on-url string	Устарело, переименуйте в idp_single_sign_on_url. URL единого входа IDP.
name string	Имя.
prefix string	Префикс.
sp-adom string	Устарело, переименуйте в sp_adom. Имя SP adom.
sp-cert string	Устарело, переименуйте в sp_cert. Имя сертификата SP.
sp-entity-id string	Устарело, переименуйте в sp_entity_id. SP Entity ID.
sp-profile string	Устарело, переименуйте в sp_profile. Имя профиля SP.
sp-single-logout-url string	Устарело, переименуйте в sp_single_logout_url. URL выхода из системы SP.
sp-single-sign-on-url string	Устарело, переименуйте в sp_single_sign_on_url. URL единого входа SP.
sls-url string	Устарело, переименуйте в sls_url. SP SLS
status string	Включить/отключить аутентификацию SAML disable - Отключить аутентификацию SAML. enable - Включить аутентификацию SAML. Choices: `"disable"` `"enable"`
user-auto-create string	Устарело, переименуйте в user_auto_create. Включить/отключить автоматическое создание пользователя disable - Отключить автоматическое создание пользователя. enable - Включить автоматическое создание пользователя. Choices: `"disable"` `"enable"`
want-assertions-signed string	Устарело, переименуйте в want_assertions_signed. Включить/отключить подписание утверждений. disable - Отключить настройку. enable - Включить настройку. Choices: `"disable"` `"enable"`

workspace_locking_adom string	ADOM для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корневой.
workspace_locking_timeout integer	Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют имя с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но вы будете получать предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
В этом модуле FortiManager поддерживается режим блокировки рабочего пространства; параметры workspace_locking_adom и workspace_locking_timeout помогают в этой задаче.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой rc. Также можно переопределить условия завершения с ошибкой или успехом с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Global settings for SAML authentication.
      fortinet.fortimanager.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: <string>
          cert: <string>
          entity_id: <string>
          idp_cert: <string>
          idp_entity_id: <string>
          idp_single_logout_url: <string>
          idp_single_sign_on_url: <string>
          login_auto_redirect: <value in [disable, enable]>
          role: <value in [IDP, SP, FAB-SP]>
          server_address: <string>
          service_providers:
            -
              idp_entity_id: <string>
              idp_single_logout_url: <string>
              idp_single_sign_on_url: <string>
              name: <string>
              prefix: <string>
              sp_cert: <string>
              sp_entity_id: <string>
              sp_single_logout_url: <string>
              sp_single_sign_on_url: <string>
              sp_adom: <string>
              sp_profile: <string>
          sls_url: <string>
          status: <value in [disable, enable]>
          default_profile: <string>
          fabric_idp:
            -
              dev_id: <string>
              idp_cert: <string>
              idp_entity_id: <string>
              idp_single_logout_url: <string>
              idp_single_sign_on_url: <string>
              idp_status: <value in [disable, enable]>
          forticloud_sso: <value in [disable, enable]>
          user_auto_create: <value in [disable, enable]>
          auth_request_signed: <value in [disable, enable]>
          want_assertions_signed: <value in [disable, enable]>

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

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Детальное сообщение об ответе API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: сложная структура

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на сборку

© 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/fortimanager/fmgr_system_saml_module.html