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

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
authentication_scheme словарь	Настройка параметров верхнего уровня.
domain-controller строка	Устарело, пожалуйста, переименуйте на domain_controller. Настройка контроллера домена.
ems-device-owner строка	Устарело, пожалуйста, переименуйте на ems_device_owner. Включение/отключение аутентификации с открытым ключом SSH с владельцем устройства Варианты: `"disable"` `"enable"`
fsso-agent-for-ntlm строка	Устарело, пожалуйста, переименуйте на fsso_agent_for_ntlm. Агент FSSO для использования при аутентификации NTLM.
fsso-guest строка	Устарело, пожалуйста, переименуйте на fsso_guest. Включение/выключение аутентификации пользователя fsso-guest Варианты: `"disable"` `"enable"`
kerberos-keytab строка	Устарело, пожалуйста, переименуйте на kerberos_keytab. Настройка Kerberos keytab.
method список / элементы=строка	Методы аутентификации Варианты: `"ntlm"` `"basic"` `"digest"` `"form"` `"negotiate"` `"fsso"` `"rsso"` `"ssh-publickey"` `"saml"` `"cert"` `"x-auth-user"` `"saml-sp"`
name строка / обязательно	Имя схемы аутентификации.
negotiate-ntlm строка	Устарело, пожалуйста, переименуйте на negotiate_ntlm. Включение/выключение аутентификации negotiate для NTLM Варианты: `"disable"` `"enable"`
require-tfa строка	Устарело, пожалуйста, переименуйте на require_tfa. Включение/выключение двухфакторной аутентификации Варианты: `"disable"` `"enable"`
saml-server строка	Устарело, пожалуйста, переименуйте на saml_server. Настройка SAML.
saml-timeout целое число	Устарело, пожалуйста, переименуйте на saml_timeout. Таймаут аутентификации SAML в секундах.
ssh-ca строка	Устарело, пожалуйста, переименуйте на ssh_ca. Имя SSH CA.
user-cert строка	Устарело, пожалуйста, переименуйте на user_cert. Включение/выключение аутентификации с помощью сертификата пользователя Варианты: `"disable"` `"enable"`
user-database любой	(список или строка) Устарело, пожалуйста, переименуйте на user_database. Сервер аутентификации для хранения информации о пользователе; локальный
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"`
workspace_locking_adom строка	ADOM для блокировки при работе FortiManager в режиме рабочей области. Значение может быть глобальным или другим, включая корень.
workspace_locking_timeout целое	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область. По умолчанию: `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: Configure Authentication Schemes.
      fortinet.fortimanager.fmgr_authentication_scheme:
        # 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]>
        authentication_scheme:
          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
          name: <string>
          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]>

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

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

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