Модуль fortinet.fortios.fortios_authentication_setting — настройка параметров аутентификации в Fortinet FortiOS и FortiGate.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: fortinet.fortios.fortios_authentication_setting.

Добавлено в fortinet.fortios 2.0.0

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

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

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции и категории аутентификации. Перед использованием необходимо скорректировать все параметры и значения в примерах в соответствии с источниками данных. Протестировано с FOS v6.0.0

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate.
authentication_setting dictionary	Настройка параметров аутентификации.
active_auth_scheme string	Активный метод аутентификации (имя схемы). Источник: authentication.scheme.name.
auth_https string	Включить или отключить перенаправление HTTP-аутентификации пользователя на HTTPS. Варианты: `"enable"` `"disable"`
captive_portal string	Имя хоста портала авторизации. Источник: firewall.address.name.
captive_portal6 string	Имя хоста портала авторизации IPv6. Источник: firewall.address6.name.
captive_portal_ip string	IP-адрес портала авторизации.
captive_portal_ip6 string	IPv6-адрес портала авторизации.
captive_portal_port integer	Номер порта портала авторизации (1–65535).
captive_portal_ssl_port integer	Номер SSL-порта портала авторизации (1–65535).
captive_portal_type string	Тип портала авторизации. Варианты: `"fqdn"` `"ip"`
cert_auth string	Включить или отключить перенаправление аутентификации по сертификату на HTTPS-портал. Варианты: `"enable"` `"disable"`
cert_captive_portal string	Имя хоста портала авторизации по сертификату. Источник: firewall.address.name.
cert_captive_portal_ip string	IP-адрес портала авторизации по сертификату.
cert_captive_portal_port integer	Номер порта портала авторизации по сертификату (1–65535).
cookie_max_age integer	Максимальный срок действия постоянной cookie веб-портала в минутах (от 30 до 10080 (1 неделя)).
cookie_refresh_div integer	Делитель интервала обновления постоянной cookie веб-портала. Интервал обновления = cookie-max-age/cookie-refresh-div.
dev_range list / elements=dictionary	Диапазон адресов для запроса устройства на основе IP-адреса.
name string / обязательный	Имя адреса. Источник: firewall.address.name firewall.addrgrp.name.
ip_auth_cookie string	Включить или отключить постоянную cookie для аутентификации на веб-портале на основе IP-адреса. Варианты: `"enable"` `"disable"`
persistent_cookie string	Включить или отключить постоянную cookie для аутентификации на веб-портале. Варианты: `"enable"` `"disable"`
sso_auth_scheme string	Метод единого входа (имя схемы). Источник: authentication.scheme.name.
update_time string	Время последнего обновления.
user_cert_ca list / elements=dictionary	Сертификат CA, используемый для проверки сертификата клиента.
name string / обязательный	Список сертификатов CA. Источник: vpn.certificate.ca.name vpn.certificate.local.name.
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path string	Путь к атрибуту элемента, с которым нужно выполнить операцию. Если атрибутов несколько, они разделяются косой чертой. Параметр с пометкой member_path можно использовать для выполнения операции над элементом.
member_state string	Добавить или удалить элемент по указанному пути к атрибуту. Если задан member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
vdom string	Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Устаревший fortiosapi объявлен нерекомендуемым; для запуска плейбуков предпочтительно использовать httpapi
Модуль поддерживает check_mode.

Примеры

- name: Configure authentication setting.
  fortinet.fortios.fortios_authentication_setting:
      vdom: "{{ vdom }}"
      authentication_setting:
          active_auth_scheme: "<your_own_value> (source authentication.scheme.name)"
          auth_https: "enable"
          captive_portal: "<your_own_value> (source firewall.address.name)"
          captive_portal_ip: "<your_own_value>"
          captive_portal_ip6: "<your_own_value>"
          captive_portal_port: "7830"
          captive_portal_ssl_port: "7831"
          captive_portal_type: "fqdn"
          captive_portal6: "<your_own_value> (source firewall.address6.name)"
          cert_auth: "enable"
          cert_captive_portal: "<your_own_value> (source firewall.address.name)"
          cert_captive_portal_ip: "<your_own_value>"
          cert_captive_portal_port: "7832"
          cookie_max_age: "480"
          cookie_refresh_div: "2"
          dev_range:
              -
                  name: "default_name_19 (source firewall.address.name firewall.addrgrp.name)"
          ip_auth_cookie: "enable"
          persistent_cookie: "enable"
          sso_auth_scheme: "<your_own_value> (source authentication.scheme.name)"
          update_time: "<your_own_value>"
          user_cert_ca:
              -
                  name: "default_name_25 (source vpn.certificate.ca.name vpn.certificate.local.name)"

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

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

Ключ	Описание
build string	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для передачи данных на FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат, возвращенный FortiGate при выполнении последней операции Возвращается: всегда Пример: `"200"`
mkey string	Главный ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успешном выполнении Пример: `"id"`
name string	Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path string	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision string	Внутренний номер редакции Возвращается: всегда Пример: `"17.0.2.10658"`
serial string	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status string	Результат операции Возвращается: всегда Пример: `"success"`
vdom string	Использованный виртуальный домен Возвращается: всегда Пример: `"root"`
version string	Версия FortiGate Возвращается: всегда Пример: `"v5.6.3"`

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Ссылки на коллекцию

© 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/fortios/fortios_authentication_setting_module.html