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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
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, с которыми условия завершения задачи по успеху будут переопределены.
saml строка / обязательно	Параметр (saml) в запрошенном URL.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
user_saml_dynamicmapping словарь	Установленные параметры верхнего уровня.
_scope список / элементы=словарь	Область видимости.
name строка	Имя.
vdom строка	Vdom.
adfs_claim строка	Устарело, пожалуйста, переименуйте на adfs_claim. Включить/выключить ADFS Claim для атрибута пользователя/группы в заявлении об утверждении Варианты: `"disable"` `"enable"`
auth_url строка	Устарело, пожалуйста, переименуйте на auth_url. URL для проверки аутентификации.
cert строка	Сертификат для подписи сообщений SAML.
clock_tolerance целое число	Устарело, пожалуйста, переименуйте на clock_tolerance. Разрешение на смещение часов в секундах
digest_method строка	Устарело, пожалуйста, переименуйте на digest_method. Алгоритм метода дайджеста. Варианты: `"sha1"` `"sha256"`
entity_id строка	Устарело, пожалуйста, переименуйте на entity_id. Идентификатор сущности SP.

group-claim-type string	Устаревшее, пожалуйста, переименуйте на group_claim_type. Групповое требование в утверждении. Варианты: `"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 string	Устаревшее, пожалуйста, переименуйте на group_name. Имя группы в утверждении.
idp-cert string	Устаревшее, пожалуйста, переименуйте на idp_cert. Имя сертификата ИДП.
idp-entity-id string	Устаревшее, пожалуйста, переименуйте на idp_entity_id. Идентификатор сущности ИДП.
idp-single-logout-url string	Устаревшее, пожалуйста, переименуйте на idp_single_logout_url. URL однократного выхода ИДП.
idp-single-sign-on-url string	Устаревшее, пожалуйста, переименуйте на idp_single_sign_on_url. URL однократного входа ИДП.
limit-relaystate string	Устаревшее, пожалуйста, переименуйте на limit_relaystate. Включить/выключить ограничение параметра relay-state, когда он превышает SAML 2. Варианты: `"disable"` `"enable"`
reauth string	Включить/выключить сигнализацию ИДП для принудительной повторной аутентификации пользователя Варианты: `"disable"` `"enable"`
scim-client any	(список) Устаревшее, пожалуйста, переименуйте на scim_client. Имя клиента SCIM.
single-logout-url string	Устаревшее, пожалуйста, переименуйте на single_logout_url. URL однократного выхода SP.
single-sign-on-url string	Устаревшее, пожалуйста, переименуйте на single_sign_on_url. URL однократного входа SP.
user-claim-type string	Устаревшее, пожалуйста, переименуйте на user_claim_type. Требование имени пользователя в утверждении. Варианты: `"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 string	Устаревшее, пожалуйста, переименуйте на user_name. Имя пользователя в утверждении.
workspace_locking_adom string	ADOM для блокировки рабочего пространства FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая 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 на верхнем уровне помогают в этой работе.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно запуск одного модуля может завершиться ошибкой, когда возвращается ненулевой код 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: SAML server entry configuration.
      fortinet.fortimanager.fmgr_user_saml_dynamicmapping:
        # 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, ...]
        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>

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

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

Ключ	Описание
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_user_saml_dynamicmapping_module.html