fortinet.fortimanager.fmgr_user_saml модуль – Настройка записи сервера SAML.

Примечание

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

clock-tolerance integer	Устарело, переименуйте в clock_tolerance. Допуск расхождения времени в секундах
digest-method string	Устарело, переименуйте в digest_method. Алгоритм метода дайджеста Choices: `"sha1"` `"sha256"`
entity-id string	Устарело, переименуйте в entity_id. ID сущности SP.
group-claim-type string	Устарело, переименуйте в group_claim_type. Групповой атрибут в утверждении. Choices: `"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.
idp-entity-id string	Устарело, переименуйте в idp_entity_id. ID сущности IDP.
idp-single-logout-url string	Устарело, переименуйте в idp_single_logout_url. URL выхода из системы IDP.
idp-single-sign-on-url string	Устарело, переименуйте в idp_single_sign_on_url. URL единого входа IDP.
limit-relaystate string	Устарело, переименуйте в limit_relaystate. Включить/выключить ограничение параметра relay-state, когда он превышает… Choices: `"disable"` `"enable"`
reauth string	Включить/выключить сигнал для IDP для принудительной повторной аутентификации пользователя Choices: `"disable"` `"enable"`
scim-client any	(list) Устарело, переименуйте в 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. Атрибут имени пользователя в утверждении. Choices: `"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. Имя пользователя в утверждении.
entity-id string	Устарело, переименуйте в entity_id. ID сущности SP.
group-claim-type string	Устарело, переименуйте в group_claim_type. Групповой атрибут в утверждении. Choices: `"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"`
name string / обязательно	Имя записи сервера SAML.
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	Область, которую нужно заблокировать для 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:
        # 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>
        state: present # <value in [present, absent]>
        user_saml:
          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>
          name: <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>
          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_module.html