fortinet.fortios.fortios_user_ldap module – Настройка записей LDAP-серверов в Fortinet FortiOS и FortiGate.

Примечание

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

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

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

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

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

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

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

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

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate.
enable_log boolean	Включить или отключить ведение журнала для задачи. Допустимые значения: `false` ← (по умолчанию) `true`
member_path string	Путь к атрибуту участника, с которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с признаком member_path можно использовать для выполнения операции с участниками.
member_state string	Добавить или удалить участника по указанному пути к атрибуту. Если указан member_state, параметр state игнорируется. Допустимые значения: `"present"` `"absent"`
state string / обязательный	Указывает, следует ли создать или удалить объект. Допустимые значения: `"present"` `"absent"`
user_ldap dictionary	Настройка записей LDAP-серверов.
account_key_cert_field string	Задать поле идентификатора субъекта в сертификате для проверки прав доступа пользователя. Допустимые значения: `"othername"` `"rfc822name"` `"dnsname"` `"cn"`
account_key_filter string	Фильтр ключа учетной записи, использующий UPN в качестве поискового фильтра.
account_key_processing string	Операция обработки ключа учетной записи. FortiGate сохранит домен целиком или удалит домен из идентификатора субъекта. Допустимые значения: `"same"` `"strip"`
account_key_upn_san string	Задать SAN в сертификате для сопоставления имени участника-пользователя. Допустимые значения: `"othername"` `"rfc822name"` `"dnsname"`
antiphish string	Включить или отключить серверную часть учетных данных AntiPhishing. Допустимые значения: `"enable"` `"disable"`
ca_cert string	Имя сертификата центра сертификации. Источник: vpn.certificate.ca.name.
client_cert string	Имя сертификата клиента. Источник: vpn.certificate.local.name.
client_cert_auth string	Включить или отключить использование сертификата клиента для аутентификации TLS. Допустимые значения: `"enable"` `"disable"`
cnid string	Идентификатор общего имени для LDAP-сервера. Для большинства LDAP-серверов идентификатором общего имени является «cn».
dn string	Отличительное имя, используемое для поиска записей на LDAP-сервере.
group_filter string	Фильтр для сопоставления групп.
group_member_check string	Методы проверки участников группы. Допустимые значения: `"user-attr"` `"group-object"` `"posix-group-object"`
group_object_filter string	Фильтр для поиска групп.
group_search_base string	База поиска групп.
interface string	Указать исходящий интерфейс для связи с сервером. Источник: system.interface.name.
interface_select_method string	Указать способ выбора исходящего интерфейса для связи с сервером. Допустимые значения: `"auto"` `"sdwan"` `"specify"`
member_attr string	Имя атрибута, из которого следует получить членство в группе.
name string / обязательный	Имя записи LDAP-сервера.
obtain_user_info string	Включить или отключить получение сведений о пользователе. Допустимые значения: `"enable"` `"disable"`
password string	Пароль для первоначальной привязки.
password_attr string	Имя атрибута для получения хеша пароля.
password_expiry_warning string	Включить или отключить предупреждения об истечении срока действия пароля. Допустимые значения: `"enable"` `"disable"`
password_renewal string	Включить или отключить онлайн-смену пароля. Допустимые значения: `"enable"` `"disable"`
port integer	Порт для связи с LDAP-сервером.
search_type list / elements=string	Тип поиска. Допустимые значения: `"recursive"`
secondary_server string	Доменное имя CN или IP-адрес дополнительного LDAP-сервера.
secure string	Порт для аутентификации. Допустимые значения: `"disable"` `"starttls"` `"ldaps"`
server string	Доменное имя CN или IP-адрес LDAP-сервера.
server_identity_check string	Включить или отключить проверку подлинности LDAP-сервера (проверку доменного имени/IP-адреса сервера по сертификату сервера). Допустимые значения: `"enable"` `"disable"`
source_ip string	IP-адрес FortiGate, используемый для связи с LDAP-сервером.
source_ip_interface string	Исходный интерфейс для связи с LDAP-сервером. Источник: system.interface.name.
source_port integer	Исходный порт для связи с LDAP-сервером.
ssl_min_proto_version string	Минимальная поддерживаемая версия протокола для SSL/TLS-соединений. Допустимые значения: `"default"` `"SSLv3"` `"TLSv1"` `"TLSv1-1"` `"TLSv1-2"` `"TLSv1-3"`
status_ttl integer	Время кэширования доступности сервера. Если сервер недоступен, повторные попытки подключения не будут выполняться в течение как минимум этого периода времени (0 = кэширование отключено).
tertiary_server string	Доменное имя CN или IP-адрес третьего LDAP-сервера.
two_factor string	Включить или отключить двухфакторную аутентификацию. Допустимые значения: `"disable"` `"fortitoken-cloud"`
two_factor_authentication string	Метод аутентификации с помощью FortiToken Cloud. Допустимые значения: `"fortitoken"` `"email"` `"sms"`
two_factor_filter string	Фильтр для синхронизации пользователей с FortiToken Cloud.
two_factor_notification string	Способ уведомления пользователя об активации через FortiToken Cloud. Допустимые значения: `"email"` `"sms"`
type string	Тип аутентификации для поиска в LDAP. Допустимые значения: `"simple"` `"anonymous"` `"regular"`
user_info_exchange_server string	Сервер MS Exchange, с которого следует получать сведения о пользователе. Источник: user.exchange.name.
username string	Имя пользователя (полное DN) для первоначальной привязки.
vrf_select integer	Идентификатор VRF, используемый для подключения к серверу.
vdom string	Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: Configure LDAP server entries.
  fortinet.fortios.fortios_user_ldap:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_ldap:
          account_key_cert_field: "othername"
          account_key_filter: "<your_own_value>"
          account_key_processing: "same"
          account_key_upn_san: "othername"
          antiphish: "enable"
          ca_cert: "<your_own_value> (source vpn.certificate.ca.name)"
          client_cert: "<your_own_value> (source vpn.certificate.local.name)"
          client_cert_auth: "enable"
          cnid: "<your_own_value>"
          dn: "<your_own_value>"
          group_filter: "<your_own_value>"
          group_member_check: "user-attr"
          group_object_filter: "<your_own_value>"
          group_search_base: "<your_own_value>"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          member_attr: "<your_own_value>"
          name: "default_name_20"
          obtain_user_info: "enable"
          password: "<your_own_value>"
          password_attr: "<your_own_value>"
          password_expiry_warning: "enable"
          password_renewal: "enable"
          port: "389"
          search_type: "recursive"
          secondary_server: "<your_own_value>"
          secure: "disable"
          server: "192.168.100.40"
          server_identity_check: "enable"
          source_ip: "84.230.14.43"
          source_ip_interface: "<your_own_value> (source system.interface.name)"
          source_port: "0"
          ssl_min_proto_version: "default"
          status_ttl: "300"
          tertiary_server: "<your_own_value>"
          two_factor: "disable"
          two_factor_authentication: "fortitoken"
          two_factor_filter: "<your_own_value>"
          two_factor_notification: "email"
          type: "simple"
          user_info_exchange_server: "<your_own_value> (source user.exchange.name)"
          username: "<your_own_value>"
          vrf_select: "0"

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

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

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