модуль fortinet.fortimanager.fmgr_user_saml_dynamicmapping — конфигурация записи сервера SAML.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать коллекцию в плейбуке, укажите: fortinet.fortimanager.fmgr_user_saml_dynamicmapping.
Добавлено в fortinet.fortimanager 2.2.0
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрашиваемом URL. |
bypass_validation boolean | Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит работу без проверки параметров. Варианты:
|
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, для которых переопределяются условия ошибки. |
rc_succeeded list / elements=integer | Список кодов rc, для которых переопределяются условия успешного выполнения. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
saml string / обязательный | Параметр (saml) в запрашиваемом URL. |
state string / обязательный | Указание создать, обновить или удалить объект. Варианты:
|
user_saml_dynamicmapping dictionary | Набор параметров верхнего уровня. |
|
_scope list / elements=dictionary |
Область действия. |
|
name string |
Имя. |
|
vdom string |
VDOM. |
|
adfs_claim aliases: adfs-claim string |
Включить/отключить ADFS Claim для атрибута пользователя/группы в утверждении Варианты:
|
|
auth_url aliases: auth-url string |
URL для проверки аутентификации. |
|
cert string |
Сертификат для подписи сообщений SAML. |
|
clock_tolerance aliases: clock-tolerance integer |
Допустимое расхождение часов в секундах |
|
digest_method aliases: digest-method string |
Алгоритм дайджест-функции Варианты:
|
|
entity_id aliases: entity-id string |
Идентификатор сущности SP. |
|
group_claim_type aliases: group-claim-type string |
Утверждение о группе в утверждении SAML. Варианты:
|
|
group_name aliases: group-name string |
Имя группы в утверждении SAML. |
|
idp_cert aliases: idp-cert string |
Имя сертификата IDP. |
|
idp_entity_id aliases: idp-entity-id string |
Идентификатор сущности IDP. |
|
idp_single_logout_url aliases: idp-single-logout-url string |
URL единого выхода IDP. |
|
idp_single_sign_on_url aliases: idp-single-sign-on-url string |
URL единого входа IDP. |
|
limit_relaystate aliases: limit-relaystate string |
Включить/отключить ограничение параметра relay-state, если его размер превышает ограничение SAML 2. Варианты:
|
|
reauth string |
Включить/отключить отправку IDP указания принудительно повторно аутентифицировать пользователя Варианты:
|
|
require_signed_resp_and_asrt aliases: require-signed-resp-and-asrt string |
Требовать подписанные ответы и утверждения. Варианты:
|
|
scim_client aliases: scim-client any |
(список) Имя клиента SCIM. |
|
scim_group_attr_type aliases: scim-group-attr-type string |
Тип атрибута группы, используемый для сопоставления групп SCIM Варианты:
|
|
scim_user_attr_type aliases: scim-user-attr-type string |
Тип атрибута пользователя, используемый для сопоставления пользователей SCIM Варианты:
|
|
single_logout_url aliases: single-logout-url string |
URL единого выхода SP. |
|
single_sign_on_url aliases: single-sign-on-url string |
URL единого входа SP. |
|
user_claim_type aliases: user-claim-type string |
Утверждение об имени пользователя в утверждении SAML. Варианты:
|
|
user_name aliases: user-name string |
Имя пользователя в утверждении SAML. |
workspace_locking_adom string | ADOM, блокируемый для FortiManager, работающего в режиме рабочей области. Значением может быть global или другое значение, включая root. |
workspace_locking_timeout integer | Максимальное время ожидания освобождения блокировки рабочей области другим пользователем, в секундах. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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_dynamicmapping:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
saml: <your own value>
state: present # <value in [present, absent]>
user_saml_dynamicmapping:
# _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, ...]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях |
Ссылки на коллекцию
© 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_dynamicmapping_module.html