Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

bypass_validation

boolean

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров.

Допустимые значения:

  • false ← (по умолчанию)
  • true

enable_log

boolean

Включить/отключить ведение журнала для задачи.

Допустимые значения:

  • false ← (по умолчанию)
  • true

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.

proposed_method

string

Переопределенный метод для базового запроса Json RPC.

Допустимые значения:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

Список кодов rc, которыми будут переопределены условия сбоя.

rc_succeeded

list / elements=integer

Список кодов rc, которыми будут переопределены условия успешного выполнения.

system_saml

dictionary

Набор параметров верхнего уровня.

acs_url

псевдонимы: acs-url

string

ACS поставщика услуг (SP).

auth_request_signed

псевдонимы: auth-request-signed

string

Включить/отключить подпись запроса аутентификации.

disable — отключить настройку.

enable — включить настройку.

Допустимые значения:

  • "disable"
  • "enable"

cert

string

Имя сертификата.

default_profile

псевдонимы: default-profile

string

Имя профиля по умолчанию.

entity_id

псевдонимы: entity-id

string

Идентификатор сущности поставщика услуг (SP).

fabric_idp

псевдонимы: fabric-idp

list / elements=dictionary

IDP Fabric.

dev_id

псевдонимы: dev-id

string

Идентификатор устройства IDP.

idp_cert

псевдонимы: idp-cert

string

Имя сертификата IDP.

idp_entity_id

псевдонимы: idp-entity-id

string

Идентификатор сущности IDP.

idp_single_logout_url

псевдонимы: idp-single-logout-url

string

URL-адрес единого выхода IDP.

idp_single_sign_on_url

псевдонимы: idp-single-sign-on-url

string

URL-адрес единого входа IDP.

idp_status

псевдонимы: idp-status

string

Включить/отключить аутентификацию SAML.

disable — отключить аутентификацию SAML.

enable — включить аутентификацию SAML.

Допустимые значения:

  • "disable"
  • "enable"

forticloud_sso

псевдонимы: forticloud-sso

string

Включить/отключить FortiCloud SSO.

disable — отключить FortiCloud SSO.

enable — включить FortiCloud SSO.

Допустимые значения:

  • "disable"
  • "enable"

idp_cert

псевдонимы: idp-cert

string

Имя сертификата IDP.

idp_entity_id

псевдонимы: idp-entity-id

string

Идентификатор сущности IDP.

idp_single_logout_url

псевдонимы: idp-single-logout-url

string

URL-адрес единого выхода IDP.

idp_single_sign_on_url

псевдонимы: idp-single-sign-on-url

string

URL-адрес единого входа IDP.

login_auto_redirect

псевдонимы: login-auto-redirect

string

Включить/отключить автоматическое перенаправление на страницу входа IDP.

disable — отключить автоматическое перенаправление на страницу входа IDP.

enable — включить автоматическое перенаправление на страницу входа IDP.

Допустимые значения:

  • "disable"
  • "enable"

logout_request_signed

псевдонимы: logout-request-signed

string

Включить/отключить подпись запроса выхода.

disable — отключить настройку.

enable — включить настройку.

Допустимые значения:

  • "disable"
  • "enable"

logout_response_signed

псевдонимы: logout-response-signed

string

Включить/отключить подпись ответа на выход.

disable — отключить настройку.

enable — включить настройку.

Допустимые значения:

  • "disable"
  • "enable"

role

string

Роль SAML.

IDP — поставщик удостоверений.

SP — поставщик услуг.

Допустимые значения:

  • "IDP"
  • "SP"
  • "FAB-SP"

server_address

псевдонимы: server-address

string

Адрес сервера.

service_providers

псевдонимы: service-providers

list / elements=dictionary

Поставщики услуг.

idp_entity_id

псевдонимы: idp-entity-id

string

Идентификатор сущности IDP.

idp_single_logout_url

псевдонимы: idp-single-logout-url

string

URL-адрес единого выхода IDP.

idp_single_sign_on_url

псевдонимы: idp-single-sign-on-url

string

URL-адрес единого входа IDP.

name

string

Имя.

prefix

string

Префикс.

sp_adom

псевдонимы: sp-adom

string

Имя ADOM поставщика услуг (SP).

sp_cert

псевдонимы: sp-cert

string

Имя сертификата поставщика услуг (SP).

sp_entity_id

псевдонимы: sp-entity-id

string

Идентификатор сущности поставщика услуг (SP).

sp_profile

псевдонимы: sp-profile

string

Имя профиля поставщика услуг (SP).

sp_single_logout_url

псевдонимы: sp-single-logout-url

string

URL-адрес единого выхода поставщика услуг (SP).

sp_single_sign_on_url

псевдонимы: sp-single-sign-on-url

string

URL-адрес единого входа поставщика услуг (SP).

sls_url

псевдонимы: sls-url

string

SLS поставщика услуг (SP).

status

string

Включить/отключить аутентификацию SAML.

disable — отключить аутентификацию SAML.

enable — включить аутентификацию SAML.

Допустимые значения:

  • "disable"
  • "enable"

user_auto_create

псевдонимы: user-auto-create

string

Включить/отключить автоматическое создание пользователей.

disable — отключить автоматическое создание пользователей.

enable — включить автоматическое создание пользователей.

Допустимые значения:

  • "disable"
  • "enable"

want_assertions_signed

псевдонимы: want-assertions-signed

string

Включить/отключить требование подписанных утверждений.

disable — отключить настройку.

enable — включить настройку.

Допустимые значения:

  • "disable"
  • "enable"

workspace_locking_adom

string

ADOM, блокируемый для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global или другие ADOM, включая root.

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
  gather_facts: false
  tasks:
    - name: Global settings for SAML authentication.
      fortinet.fortimanager.fmgr_system_saml:
        # workspace_locking_adom: <global or your adom name>
        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]>
          # logout_request_signed: <value in [disable, enable]>
          # logout_response_signed: <value in [disable, enable]>

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

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

Ключ

Описание

meta

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный запрошенный URL.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / elements=string

Ответ API.

Возвращается: всегда

response_message

string

Описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / elements=string

Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_system_saml_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API