модуль fortinet.fortimanager.fmgr_user_ldap — Настройка записей LDAP-серверов.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_user_ldap.
Добавлено в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль предназначен для настройки устройства FortiManager.
- В примерах приведены все параметры и значения, которые необходимо скорректировать в соответствии с источниками данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрашиваемом URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, для которых будут переопределены условия сбоя. |
rc_succeeded list / elements=integer | Список кодов rc, для которых будут переопределены условия успешного выполнения. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
user_ldap dictionary | Набор параметров верхнего уровня. |
|
account_key_cert_field псевдонимы: account-key-cert-field string |
Задаёт поле идентификатора субъекта в сертификате для проверки прав доступа пользователя. Варианты:
|
|
account_key_filter псевдонимы: account-key-filter string |
Фильтр ключа учётной записи, использующий UPN в качестве фильтра поиска. |
|
account_key_name псевдонимы: account-key-name string |
Имя ключа учётной записи, использующее UPN в качестве фильтра поиска. |
|
account_key_processing псевдонимы: account-key-processing string |
Операция обработки ключа учётной записи: сохранить или удалить доменную строку UPN в токене. Варианты:
|
|
account_key_upn_san псевдонимы: account-key-upn-san string |
Задаёт SAN в сертификате для сопоставления имени участника-пользователя. Варианты:
|
|
antiphish string |
Включить/отключить серверную часть учётных данных AntiPhishing. Варианты:
|
|
ca_cert псевдонимы: ca-cert string |
Имя сертификата центра сертификации. |
|
client_cert псевдонимы: client-cert string |
Имя сертификата клиента. |
|
client_cert_auth псевдонимы: client-cert-auth string |
Включить/отключить использование сертификата клиента для аутентификации TLS. Варианты:
|
|
cnid string |
Идентификатор общего имени для LDAP-сервера. |
|
dn string |
Различающееся имя, используемое для поиска записей на LDAP-сервере. |
|
dynamic_mapping list / elements=dictionary |
Динамическое сопоставление. |
|
_scope list / elements=dictionary |
Область действия. |
|
name string |
Имя. |
|
vdom string |
Виртуальный домен. |
|
account_key_cert_field псевдонимы: account-key-cert-field string |
Задаёт поле идентификатора субъекта в сертификате для проверки прав доступа пользователя. Варианты:
|
|
account_key_filter псевдонимы: account-key-filter string |
Фильтр ключа учётной записи. |
|
account_key_name псевдонимы: account-key-name string |
Имя ключа учётной записи. |
|
account_key_processing псевдонимы: account-key-processing string |
Обработка ключа учётной записи. Варианты:
|
|
account_key_upn_san псевдонимы: account-key-upn-san string |
Задаёт SAN в сертификате для сопоставления имени участника-пользователя. Варианты:
|
|
antiphish string |
Включить/отключить серверную часть учётных данных AntiPhishing. Варианты:
|
|
ca_cert псевдонимы: ca-cert string |
Сертификат центра сертификации. |
|
client_cert псевдонимы: client-cert string |
Имя сертификата клиента. |
|
client_cert_auth псевдонимы: client-cert-auth string |
Включить/отключить использование сертификата клиента для аутентификации TLS. Варианты:
|
|
cnid string |
Идентификатор общего имени. |
|
dn string |
Различающееся имя. |
|
filter string |
Фильтр. |
|
group string |
Группа. |
|
group_filter псевдонимы: group-filter string |
Фильтр группы. |
|
group_member_check псевдонимы: group-member-check string |
Проверка участника группы. Варианты:
|
|
group_object_filter псевдонимы: group-object-filter string |
Фильтр объекта группы. |
|
group_object_search_base псевдонимы: group-object-search-base string |
База поиска объектов группы. |
|
group_search_base псевдонимы: group-search-base string |
База поиска групп. |
|
interface string |
Интерфейс. |
|
interface_select_method псевдонимы: interface-select-method string |
Метод выбора интерфейса. Варианты:
|
|
max_connections псевдонимы: max-connections integer |
Максимальное количество соединений. |
|
member_attr псевдонимы: member-attr string |
Атрибут участника. |
|
obtain_user_info псевдонимы: obtain-user-info string |
Получение сведений о пользователе. Варианты:
|
|
password any |
(список) Пароль. |
|
password_attr псевдонимы: password-attr string |
Имя атрибута для получения хеша пароля. |
|
password_expiry_warning псевдонимы: password-expiry-warning string |
Предупреждение об истечении срока действия пароля. Варианты:
|
|
password_renewal псевдонимы: password-renewal string |
Продление срока действия пароля. Варианты:
|
|
port integer |
Порт. |
|
retrieve_protection_profile псевдонимы: retrieve-protection-profile string |
Получение профиля защиты. |
|
search_type aliases: search-type list / elements=string |
Тип поиска. Варианты:
|
|
secondary_server aliases: secondary-server string |
Вторичный сервер. |
|
secure string |
Безопасность. Варианты:
|
|
server string |
Сервер. |
|
server_identity_check aliases: server-identity-check string |
Проверка идентификатора сервера. Варианты:
|
|
source_ip aliases: source-ip string |
IP-адрес источника. |
|
source_ip_interface aliases: source-ip-interface any |
(список) Исходный интерфейс для связи с LDAP-сервером. |
|
source_port aliases: source-port integer |
Исходный порт для связи с LDAP-сервером. |
|
ssl_max_proto_version aliases: ssl-max-proto-version string |
Максимальная версия протокола SSL. Варианты:
|
|
ssl_min_proto_version aliases: ssl-min-proto-version string |
Минимальная версия протокола SSL. Варианты:
|
|
status_ttl aliases: status-ttl integer |
Время кэширования доступности сервера: если сервер недоступен, повторная попытка подключения не будет предприниматься в течение как минимум… |
|
tertiary_server aliases: tertiary-server string |
Третичный сервер. |
|
two_factor aliases: two-factor string |
Двухфакторная аутентификация. Варианты:
|
|
two_factor_authentication aliases: two-factor-authentication string |
Двухфакторная аутентификация. Варианты:
|
|
two_factor_filter aliases: two-factor-filter string |
Фильтр для синхронизации пользователей с FortiToken Cloud. |
|
two_factor_notification aliases: two-factor-notification string |
Уведомление о двухфакторной аутентификации. Варианты:
|
|
type string |
Тип. Варианты:
|
|
user_info_exchange_server aliases: user-info-exchange-server string |
Сервер обмена информацией о пользователях. |
|
username string |
Имя пользователя. |
|
validate_server_certificate aliases: validate-server-certificate string |
Проверка сертификата сервера. Варианты:
|
|
vrf_select aliases: vrf-select integer |
Идентификатор VRF для подключения к серверу. |
|
group_filter aliases: group-filter string |
Фильтр для сопоставления групп. |
|
group_member_check aliases: group-member-check string |
Методы проверки принадлежности к группе. Варианты:
|
|
group_object_filter aliases: group-object-filter string |
Фильтр для поиска групп. |
|
group_object_search_base aliases: group-object-search-base string |
База поиска для поиска групп. |
|
group_search_base aliases: group-search-base string |
База поиска для поиска групп. |
|
interface string |
Укажите исходящий интерфейс для подключения к серверу. |
|
interface_select_method aliases: interface-select-method string |
Укажите способ выбора исходящего интерфейса для подключения к серверу. Варианты:
|
|
max_connections aliases: max-connections integer |
Максимальное количество подключений. |
|
member_attr aliases: member-attr string |
Имя атрибута, из которого извлекаются сведения о членстве в группе. |
|
name string / обязательный |
Имя записи LDAP-сервера. |
|
obtain_user_info aliases: obtain-user-info string |
Включить или отключить получение сведений о пользователе. Варианты:
|
|
password any |
(список) Пароль для первоначальной привязки. |
|
password_attr aliases: password-attr string |
Имя атрибута для получения хеша пароля. |
|
password_expiry_warning aliases: password-expiry-warning string |
Включить или отключить предупреждения об истечении срока действия пароля. Варианты:
|
|
password_renewal aliases: password-renewal string |
Включить или отключить обновление пароля в режиме онлайн. Варианты:
|
|
port integer |
Порт для связи с LDAP-сервером |
|
search_type aliases: search-type list / elements=string |
Тип поиска. Варианты:
|
|
secondary_server aliases: secondary-server string |
Доменное имя CN или IP-адрес вторичного LDAP-сервера. |
|
secure string |
Порт для аутентификации. Варианты:
|
|
server string |
Доменное имя CN или IP-адрес LDAP-сервера. |
|
server_identity_check aliases: server-identity-check string |
Включить или отключить проверку идентификатора LDAP-сервера Варианты:
|
|
source_ip aliases: source-ip string |
IP-адрес источника для связи с LDAP-сервером. |
|
source_ip_interface aliases: source-ip-interface any |
(список) Исходный интерфейс для связи с LDAP-сервером. |
|
source_port aliases: source-port integer |
Исходный порт для связи с LDAP-сервером. |
|
ssl_max_proto_version aliases: ssl-max-proto-version string |
Максимальная версия протокола SSL. Варианты:
|
|
ssl_min_proto_version aliases: ssl-min-proto-version string |
Минимальная поддерживаемая версия протокола для подключений SSL/TLS Варианты:
|
|
status_ttl aliases: status-ttl integer |
Время кэширования доступности сервера: если сервер недоступен, повторная попытка подключения не будет предприниматься как минимум в течение… |
|
tertiary_server aliases: tertiary-server string |
Доменное имя CN или IP-адрес третичного LDAP-сервера. |
|
two_factor aliases: two-factor string |
Включить или отключить двухфакторную аутентификацию. Варианты:
|
|
two_factor_authentication aliases: two-factor-authentication string |
Метод аутентификации с помощью FortiToken Cloud. Варианты:
|
|
two_factor_filter aliases: two-factor-filter string |
Фильтр, используемый для синхронизации пользователей с FortiToken Cloud. |
|
two_factor_notification aliases: two-factor-notification string |
Метод уведомления пользователя об активации с помощью FortiToken Cloud. Варианты:
|
|
type string |
Тип аутентификации для поиска в LDAP. Варианты:
|
|
user_info_exchange_server aliases: user-info-exchange-server string |
Сервер MS Exchange, с которого следует получать сведения о пользователях. |
|
username string |
Имя пользователя |
|
validate_server_certificate aliases: validate-server-certificate string |
Проверять сертификат сервера. Варианты:
|
|
vrf_select aliases: vrf-select integer |
Идентификатор VRF, используемый для подключения к серверу. |
workspace_locking_adom string | ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области; значением может быть global и другие значения, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure LDAP server entries.
fortinet.fortimanager.fmgr_user_ldap:
bypass_validation: false
adom: ansible
state: present
user_ldap:
dn: ansible-test
name: ansible-test-ldap
password: fortinet
port: 9000
server: ansible
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the LDAP server entries
fortinet.fortimanager.fmgr_fact:
facts:
selector: "user_ldap"
params:
adom: "ansible"
ldap: "your_value"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Сведения о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=string | Предупреждение, если используемые в сценарии параметры не поддерживаются текущей версией FortiManager. Возвращается: при сложных условиях |
Ссылки на коллекцию
© 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_user_ldap_module.html