Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_user_saml — настройка записи сервера SAML.

Примечание

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

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

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

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

Добавлено в fortinet.fortimanager 2.1.0

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

Обзор

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

Параметры

Параметр

Комментарии

access_token

string

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

adom

string / обязательный

Параметр (adom) в запрошенном URL.

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, для которых будут переопределены условия успешного выполнения.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

state

string / обязательный

Указание на создание, обновление или удаление объекта.

Варианты:

  • "present"
  • "absent"

user_saml

dictionary

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

adfs_claim

псевдонимы: adfs-claim

string

Включить/отключить утверждение ADFS для атрибута пользователя/группы в утверждении

Варианты:

  • "disable"
  • "enable"

auth_url

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

string

URL для проверки аутентификации.

cert

string

Сертификат для подписания сообщений SAML.

clock_tolerance

псевдонимы: clock-tolerance

integer

Допуск на рассинхронизацию часов в секундах

digest_method

псевдонимы: digest-method

string

Алгоритм метода хеширования.

Варианты:

  • "sha1"
  • "sha256"

dynamic_mapping

list / elements=dictionary

Динамическое сопоставление.

_scope

list / elements=dictionary

Область действия.

name

string

Имя.

vdom

string

VDOM.

adfs_claim

псевдонимы: adfs-claim

string

Включить/отключить утверждение ADFS для атрибута пользователя/группы в утверждении

Варианты:

  • "disable"
  • "enable"

auth_url

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

string

URL для проверки аутентификации.

cert

string

Сертификат для подписания сообщений SAML.

clock_tolerance

псевдонимы: clock-tolerance

integer

Допуск на рассинхронизацию часов в секундах

digest_method

псевдонимы: digest-method

string

Алгоритм метода хеширования

Варианты:

  • "sha1"
  • "sha256"

entity_id

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

string

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

group_claim_type

псевдонимы: group-claim-type

string

Утверждение группы в утверждении.

Варианты:

  • "email"
  • "given-name"
  • "name"
  • "upn"
  • "common-name"
  • "email-adfs-1x"
  • "group"
  • "upn-adfs-1x"
  • "role"
  • "sur-name"
  • "ppid"
  • "name-identifier"
  • "authentication-method"
  • "deny-only-group-sid"
  • "deny-only-primary-sid"
  • "deny-only-primary-group-sid"
  • "group-sid"
  • "primary-group-sid"
  • "primary-sid"
  • "windows-account-name"

group_name

псевдонимы: group-name

string

Имя группы в утверждении.

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.

limit_relaystate

псевдонимы: limit-relaystate

string

Включить/отключить ограничение параметра relay-state при превышении SAML 2.

Варианты:

  • "disable"
  • "enable"

reauth

string

Включить/отключить указание IDP принудительно повторно выполнить аутентификацию пользователя

Варианты:

  • "disable"
  • "enable"

require_signed_resp_and_asrt

псевдонимы: require-signed-resp-and-asrt

string

Требовать подписанные ответы и утверждения.

Варианты:

  • "disable"
  • "enable"

scim_client

псевдонимы: scim-client

any

(список) Имя клиента SCIM.

scim_group_attr_type

псевдонимы: scim-group-attr-type

string

Тип атрибута группы, используемый для сопоставления групп SCIM

Варианты:

  • "display-name"
  • "external-id"

scim_user_attr_type

псевдонимы: scim-user-attr-type

string

Тип атрибута пользователя, используемый для сопоставления пользователей SCIM

Варианты:

  • "display-name"
  • "external-id"
  • "user-name"
  • "email"

single_logout_url

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

string

URL единого выхода SP.

single_sign_on_url

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

string

URL единого входа SP.

user_claim_type

псевдонимы: user-claim-type

string

Утверждение имени пользователя в утверждении.

Варианты:

  • "email"
  • "given-name"
  • "name"
  • "upn"
  • "common-name"
  • "email-adfs-1x"
  • "group"
  • "upn-adfs-1x"
  • "role"
  • "sur-name"
  • "ppid"
  • "name-identifier"
  • "authentication-method"
  • "deny-only-group-sid"
  • "deny-only-primary-sid"
  • "deny-only-primary-group-sid"
  • "group-sid"
  • "primary-group-sid"
  • "primary-sid"
  • "windows-account-name"

user_name

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

string

Имя пользователя в утверждении.

entity_id

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

string

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

group_claim_type

псевдонимы: group-claim-type

string

Утверждение группы в утверждении.

Варианты:

  • "email"
  • "given-name"
  • "name"
  • "upn"
  • "common-name"
  • "email-adfs-1x"
  • "group"
  • "upn-adfs-1x"
  • "role"
  • "sur-name"
  • "ppid"
  • "name-identifier"
  • "authentication-method"
  • "deny-only-group-sid"
  • "deny-only-primary-sid"
  • "deny-only-primary-group-sid"
  • "group-sid"
  • "primary-group-sid"
  • "primary-sid"
  • "windows-account-name"

group_name

псевдонимы: group-name

string

Имя группы в утверждении.

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.

limit_relaystate

псевдонимы: limit-relaystate

string

Включить/отключить ограничение параметра relay-state при превышении SAML 2.

Варианты:

  • "disable"
  • "enable"

name

string / обязательный

Имя записи сервера SAML.

reauth

string

Включить/отключить передачу IDP сигнала о необходимости повторной аутентификации пользователя

Варианты:

  • "disable"
  • "enable"

require_signed_resp_and_asrt

псевдонимы: require-signed-resp-and-asrt

string

Требовать подписанные ответ и утверждение.

Варианты:

  • "disable"
  • "enable"

scim_client

псевдонимы: scim-client

any

(список) Имя клиента SCIM.

scim_group_attr_type

псевдонимы: scim-group-attr-type

string

Тип атрибута группы, используемый для сопоставления групп SCIM

Варианты:

  • "display-name"
  • "external-id"

scim_user_attr_type

псевдонимы: scim-user-attr-type

string

Тип атрибута пользователя, используемый для сопоставления пользователей SCIM

Варианты:

  • "display-name"
  • "external-id"
  • "user-name"
  • "email"

single_logout_url

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

string

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

single_sign_on_url

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

string

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

user_claim_type

псевдонимы: user-claim-type

string

Утверждение с именем пользователя в утверждении.

Варианты:

  • "email"
  • "given-name"
  • "name"
  • "upn"
  • "common-name"
  • "email-adfs-1x"
  • "group"
  • "upn-adfs-1x"
  • "role"
  • "sur-name"
  • "ppid"
  • "name-identifier"
  • "authentication-method"
  • "deny-only-group-sid"
  • "deny-only-primary-sid"
  • "deny-only-primary-group-sid"
  • "group-sid"
  • "primary-group-sid"
  • "primary-sid"
  • "windows-account-name"

user_name

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

string

Имя пользователя в утверждении.

workspace_locking_adom

string

ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области; значением может быть global и другие значения, включая 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.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: SAML server entry configuration.
      fortinet.fortimanager.fmgr_user_saml:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        user_saml:
          name: "your value" # Required variable, string
          # cert: <string>
          # entity_id: <string>
          # group_name: <string>
          # idp_cert: <string>
          # idp_entity_id: <string>
          # idp_single_logout_url: <string>
          # idp_single_sign_on_url: <string>
          # single_logout_url: <string>
          # single_sign_on_url: <string>
          # user_name: <string>
          # adfs_claim: <value in [disable, enable]>
          # digest_method: <value in [sha1, sha256]>
          # group_claim_type: <value in [email, given-name, name, ...]>
          # limit_relaystate: <value in [disable, enable]>
          # user_claim_type: <value in [email, given-name, name, ...]>
          # clock_tolerance: <integer>
          # dynamic_mapping:
          #   - _scope:
          #       - name: <string>
          #         vdom: <string>
          #     adfs_claim: <value in [disable, enable]>
          #     cert: <string>
          #     clock_tolerance: <integer>
          #     digest_method: <value in [sha1, sha256]>
          #     entity_id: <string>
          #     group_claim_type: <value in [email, given-name, name, ...]>
          #     group_name: <string>
          #     idp_cert: <string>
          #     idp_entity_id: <string>
          #     idp_single_logout_url: <string>
          #     idp_single_sign_on_url: <string>
          #     limit_relaystate: <value in [disable, enable]>
          #     single_logout_url: <string>
          #     single_sign_on_url: <string>
          #     user_claim_type: <value in [email, given-name, name, ...]>
          #     user_name: <string>
          #     auth_url: <string>
          #     reauth: <value in [disable, enable]>
          #     scim_client: <list or string>
          #     scim_group_attr_type: <value in [display-name, external-id]>
          #     require_signed_resp_and_asrt: <value in [disable, enable]>
          #     scim_user_attr_type: <value in [display-name, external-id, user-name, ...]>
          # auth_url: <string>
          # reauth: <value in [disable, enable]>
          # scim_client: <list or string>
          # scim_group_attr_type: <value in [display-name, external-id]>
          # require_signed_resp_and_asrt: <value in [disable, enable]>
          # scim_user_attr_type: <value in [display-name, external-id, user-name, ...]>

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

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

Ключ

Описание

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_user_saml_module.html

Spec-Zone.ru

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