fortinet.fortimanager.fmgr_pkg_authentication_setting модуль — Настройка параметров аутентификации.

Примечание

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

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

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_pkg_authentication_setting.

Новая функция в fortinet.fortimanager 2.1.0

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

Описание

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / required	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (default) `true`
enable_log boolean	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (default) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
pkg string / required	Параметр (pkg) в запрошенном URL.
pkg_authentication_setting dictionary	Набор параметров верхнего уровня.
active-auth-scheme string	Устарело, переименуйте в active_auth_scheme. Активный метод аутентификации
auth-https string	Устарело, переименуйте в auth_https. Включить/выключить переадресацию HTTP-аутентификации пользователя на HTTPS. Варианты: `"disable"` `"enable"`
captive-portal string	Устарело, переименуйте в captive_portal. Имя хоста портала невольного подключения.
captive-portal-ip string	Устарело, переименуйте в captive_portal_ip. IP-адрес портала невольного подключения.
captive-portal-ip6 string	Устарело, переименуйте в captive_portal_ip6. IPv6-адрес портала невольного подключения.
captive-portal-port integer	Устарело, переименуйте в captive_portal_port. Номер порта портала невольного подключения.
captive-portal-ssl-port integer	Устарело, переименуйте в captive_portal_ssl_port. Номер SSL-порта портала невольного подключения.
captive-portal-type string	Устарело, переименуйте в captive_portal_type. Тип портала невольного подключения. Варианты: `"fqdn"` `"ip"`
captive-portal6 string	Устарело, переименуйте в captive_portal6. Имя хоста IPv6-портала невольного подключения.
cert-auth string	Устарело, переименуйте в cert_auth. Включить/выключить переадресацию сертификатной аутентификации на HTTPS-портал. Варианты: `"disable"` `"enable"`
cert-captive-portal string	Устарело, переименуйте в cert_captive_portal. Имя хоста сертификатного портала невольного подключения.
cert-captive-portal-ip string	Устарело, переименуйте в cert_captive_portal_ip. IP-адрес сертификатного портала невольного подключения.
cert-captive-portal-port integer	Устарело, переименуйте в cert_captive_portal_port. Номер порта сертификатного портала невольного подключения.
cookie-max-age integer	Устарело, переименуйте в cookie_max_age. Максимальный срок действия постоянного cookie веб-портала в минутах.

cookie-refresh-div целое число	Устарело, пожалуйста, переименуйте его в cookie_refresh_div. Разделитель частоты обновления постоянного куки веб-портала
dev-range любое	(список или строка) Устарело, пожалуйста, переименуйте его в dev_range. Диапазон адресов для запроса устройства на основе IP.
ip-auth-cookie строка	Устарело, пожалуйста, переименуйте его в ip_auth_cookie. Включение/выключение постоянного куки при аутентификации на веб-портале на основе IP Варианты: `"disable"` `"enable"`
persistent-cookie строка	Устарело, пожалуйста, переименуйте его в persistent_cookie. Включение/выключение постоянного куки при аутентификации на веб-портале Варианты: `"disable"` `"enable"`
rewrite-https-port целое число	Устарело, пожалуйста, переименуйте его в rewrite_https_port. Перезапись порта HTTPS
sso-auth-scheme строка	Устарело, пожалуйста, переименуйте его в sso_auth_scheme. Метод аутентификации Single-Sign-On
update-time строка	Устарело, пожалуйста, переименуйте его в update_time. Время последнего обновления.
user-cert-ca любое	(список или строка) Устарело, пожалуйста, переименуйте его в user_cert_ca. Сертификат CA, используемый для проверки сертификата клиента.
proposed_method строка	Переопределённый метод для основного запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для отказа.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для успеха.
workspace_locking_adom строка	Область (ADOM) для блокировки при работе FortiManager в режиме рабочего пространства; значение может быть глобальным и другими, включая root.
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 помогают в этом.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой код 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 setting.
      fortinet.fortimanager.fmgr_pkg_authentication_setting:
        # 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>
        pkg: <your own value>
        pkg_authentication_setting:
          active_auth_scheme: <string>
          auth_https: <value in [disable, enable]>
          captive_portal: <string>
          captive_portal_ip: <string>
          captive_portal_ip6: <string>
          captive_portal_port: <integer>
          captive_portal_ssl_port: <integer>
          captive_portal_type: <value in [fqdn, ip]>
          captive_portal6: <string>
          rewrite_https_port: <integer>
          sso_auth_scheme: <string>
          dev_range: <list or string>
          user_cert_ca: <list or string>
          cert_auth: <value in [disable, enable]>
          cert_captive_portal: <string>
          cert_captive_portal_ip: <string>
          cert_captive_portal_port: <integer>
          cookie_max_age: <integer>
          cookie_refresh_div: <integer>
          ip_auth_cookie: <value in [disable, enable]>
          persistent_cookie: <value in [disable, enable]>
          update_time: <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 список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_pkg_authentication_setting_module.html