модуль fortinet.fortimanager.fmgr_authentication_scheme — настройка схем аутентификации.

Примечание

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

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

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

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

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

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
authentication_scheme dictionary	Набор параметров верхнего уровня.
auth_user_header псевдонимы: auth-user-header string	Заголовок пользователя для аутентификации.
captcha string	CAPTCHA. Варианты: `"disable"` `"enable"`
captcha_secret_key псевдонимы: captcha-secret-key string	Секретный ключ CAPTCHA.
captcha_site_key псевдонимы: captcha-site-key string	Ключ сайта CAPTCHA.
captcha_vendor псевдонимы: captcha-vendor string	Поставщик CAPTCHA. Варианты: `"google-recaptcha-v2-checkbox"` `"google-recaptcha-v2-invisible"` `"google-recaptcha-v3"` `"cloudflare-turnstile"`
cert_http_header псевдонимы: cert-http-header string	Включить/отключить аутентификацию с помощью сертификата пользователя в HTTP-заголовке Client-Cert Варианты: `"disable"` `"enable"`
digest_algo псевдонимы: digest-algo list / elements=string	Алгоритмы аутентификации Digest. Варианты: `"md5"` `"sha-256"`
digest_rfc2069 псевдонимы: digest-rfc2069 string	Включить/отключить поддержку устаревшего клиента Digest RFC2069 Варианты: `"disable"` `"enable"`
domain_controller псевдонимы: domain-controller string	Настройка контроллера домена.
ems_device_owner псевдонимы: ems-device-owner string	Включить/отключить аутентификацию с помощью открытого ключа SSH и владельца устройства Варианты: `"disable"` `"enable"`
external_idp псевдонимы: external-idp any	(список) Конфигурация внешнего поставщика удостоверений.
fsso_agent_for_ntlm псевдонимы: fsso-agent-for-ntlm string	Агент FSSO для аутентификации NTLM.
fsso_guest псевдонимы: fsso-guest string	Включить/отключить аутентификацию пользователя fsso-guest Варианты: `"disable"` `"enable"`
group_attr_type псевдонимы: group-attr-type string	Тип атрибута группы, используемый для сопоставления групп SCIM Варианты: `"display-name"` `"external-id"`
kerberos_keytab псевдонимы: kerberos-keytab string	Настройка таблицы ключей Kerberos.
method list / elements=string	Методы аутентификации Варианты: `"ntlm"` `"basic"` `"digest"` `"form"` `"negotiate"` `"fsso"` `"rsso"` `"ssh-publickey"` `"saml"` `"cert"` `"x-auth-user"` `"saml-sp"` `"entra-sso"` `"ztna-relay"` `"oidc"`
name string / обязательный	Имя схемы аутентификации.
negotiate_ntlm псевдонимы: negotiate-ntlm string	Включить/отключить согласование аутентификации NTLM Варианты: `"disable"` `"enable"`
oidc_server псевдонимы: oidc-server any	(список) Сервер OIDC.
oidc_timeout псевдонимы: oidc-timeout integer	Тайм-аут OIDC.
require_tfa псевдонимы: require-tfa string	Включить/отключить двухфакторную аутентификацию Варианты: `"disable"` `"enable"`
saml_idp_portal псевдонимы: saml-idp-portal string	URL портала внешней аутентификации SAML-IDP.
saml_server псевдонимы: saml-server string	Конфигурация SAML.
saml_timeout псевдонимы: saml-timeout integer	Тайм-аут аутентификации SAML в секундах.
search_all_ldap_databases псевдонимы: search-all-ldap-databases string	Поиск во всех базах данных LDAP. Варианты: `"disable"` `"enable"`
ssh_ca псевдонимы: ssh-ca string	Имя центра сертификации SSH.
user_cert псевдонимы: user-cert string	Включить/отключить аутентификацию с помощью сертификата пользователя Варианты: `"disable"` `"enable"`
user_database псевдонимы: user-database any	(список или строка) Сервер аутентификации, содержащий сведения о пользователях; локальный
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"`
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: Configure Authentication Schemes.
      fortinet.fortimanager.fmgr_authentication_scheme:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        authentication_scheme:
          name: "your value" # Required variable, string
          # domain_controller: <string>
          # fsso_agent_for_ntlm: <string>
          # fsso_guest: <value in [disable, enable]>
          # kerberos_keytab: <string>
          # method: ["ntlm", "basic", "digest", "form", "negotiate", "fsso", "rsso",
          #          "ssh-publickey", "saml", "cert", "x-auth-user", "saml-sp", "entra-sso",
          #          "ztna-relay", "oidc"]
          # negotiate_ntlm: <value in [disable, enable]>
          # require_tfa: <value in [disable, enable]>
          # ssh_ca: <string>
          # user_database: <list or string>
          # ems_device_owner: <value in [disable, enable]>
          # saml_server: <string>
          # saml_timeout: <integer>
          # user_cert: <value in [disable, enable]>
          # external_idp: <list or string>
          # digest_algo: ["md5", "sha-256"]
          # group_attr_type: <value in [display-name, external-id]>
          # search_all_ldap_databases: <value in [disable, enable]>
          # saml_idp_portal: <string>
          # oidc_server: <list or string>
          # oidc_timeout: <integer>
          # digest_rfc2069: <value in [disable, enable]>
          # auth_user_header: <string>
          # captcha: <value in [disable, enable]>
          # captcha_secret_key: <string>
          # captcha_site_key: <string>
          # captcha_vendor: <value in [google-recaptcha-v2-checkbox, google-recaptcha-v2-invisible, google-recaptcha-v3, ...]>
          # cert_http_header: <value in [disable, enable]>

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

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

Ключ	Описание
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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_authentication_scheme_module.html