fortinet.fortimanager.fmgr_user_ldap модуль — Настройка записей сервера LDAP.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
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"`
user_ldap словарь	Настройка верхнего уровня параметров.
account-key-cert-field строка	Устарело, пожалуйста, переименуйте на account_key_cert_field. Определение поля идентификатора субъекта в сертификате для права доступа пользователя… Варианты: `"othername"` `"rfc822name"` `"dnsname"` `"cn"`
account-key-filter строка	Устарело, пожалуйста, переименуйте на account_key_filter. Фильтр ключа учетной записи, используя UPN в качестве фильтра поиска.
account-key-name строка	Устарело, пожалуйста, переименуйте на account_key_name. Имя ключа учетной записи, используя UPN в качестве фильтра поиска.
account-key-processing строка	Устарело, пожалуйста, переименуйте на account_key_processing. Операция обработки ключа учетной записи, либо сохранить, либо удалить домен… Варианты: `"same"` `"strip"`
account-key-upn-san строка	Устарело, пожалуйста, переименуйте на account_key_upn_san. Определение SAN в сертификате для сопоставления имени принципа пользователя. Варианты: `"othername"` `"rfc822name"` `"dnsname"`
antiphish строка	Включить/выключить бэкенд аутентификации AntiPhishing. Варианты: `"disable"` `"enable"`
ca-cert строка	Устарело, пожалуйста, переименуйте на ca_cert. Имя сертификата CA.
client-cert строка	Устарело, пожалуйста, переименуйте на client_cert. Имя клиентского сертификата.
client-cert-auth строка	Устарело, пожалуйста, переименуйте на client_cert_auth. Включить/выключить использование клиентского сертификата для аутентификации TLS. Варианты: `"disable"` `"enable"`
cnid строка	Идентификатор общего имени для сервера LDAP.
dn строка	Отличительное имя, используемое для поиска записей на сервере LDAP.

END_OF_DOCUMENT_MARKER

dynamic_mapping list / elements=dictionary	Динамическое сопоставление.
_scope list / elements=dictionary	Область действия.
name string	Имя.
vdom string	Vdom.
account-key-cert-field string	Устарело, переименуйте в account_key_cert_field. Определите поле идентификатора субъекта в сертификате для доступа пользователя… Choices: `"othername"` `"rfc822name"` `"dnsname"` `"cn"`
account-key-filter string	Устарело, переименуйте в account_key_filter. Фильтр ключа учетной записи.
account-key-name string	Устарело, переименуйте в account_key_name. Имя ключа учетной записи.
account-key-processing string	Устарело, переименуйте в account_key_processing. Обработка ключа учетной записи. Choices: `"same"` `"strip"`
account-key-upn-san string	Устарело, переименуйте в account_key_upn_san. Определите SAN в сертификате для сопоставления имени участника. Choices: `"othername"` `"rfc822name"` `"dnsname"`
antiphish string	Включить/отключить бэкэнд учетных данных AntiPhishing. Choices: `"disable"` `"enable"`
ca-cert string	Устарело, переименуйте в ca_cert. Корневой сертификат.
client-cert string	Устарело, переименуйте в client_cert. Имя клиентского сертификата.
client-cert-auth string	Устарело, переименуйте в client_cert_auth. Включить/отключить использование клиентского сертификата для TLS-аутентификации. Choices: `"disable"` `"enable"`
cnid string	Cnid.
dn string	Dn.
filter string	Фильтр.
group string	Группа.
group-filter string	Устарело, переименуйте в group_filter. Фильтр группы.
group-member-check string	Устарело, переименуйте в group_member_check. Проверка принадлежности к группе. Choices: `"user-attr"` `"group-object"` `"posix-group-object"`
group-object-filter string	Устарело, переименуйте в group_object_filter. Фильтр объекта группы.
group-object-search-base string	Устарело, переименуйте в group_object_search_base. Базовая база поиска объекта группы.
group-search-base string	Устарело, переименуйте в group_search_base. Базовая база поиска группы.
interface string	Интерфейс.

interface-select-method string	Устарело, переименуйте в interface_select_method. Метод выбора интерфейса. Choices: `"auto"` `"sdwan"` `"specify"`
max-connections integer	Устарело, переименуйте в max_connections. Максимальное количество соединений.
member-attr string	Устарело, переименуйте в member_attr. Атрибут участника.
obtain-user-info string	Устарело, переименуйте в obtain_user_info. Получение информации о пользователе. Choices: `"disable"` `"enable"`
password any	(list) Пароль.
password-attr string	Устарело, переименуйте в password_attr. Имя атрибута для получения хэша пароля.
password-expiry-warning string	Устарело, переименуйте в password_expiry_warning. Предупреждение о истечении срока действия пароля. Choices: `"disable"` `"enable"`
password-renewal string	Устарело, переименуйте в password_renewal. Восстановление пароля. Choices: `"disable"` `"enable"`
port integer	Порт.
retrieve-protection-profile string	Устарело, переименуйте в retrieve_protection_profile. Получение профиля защиты.
search-type list / elements=string	Устарело, переименуйте в search_type. Тип поиска. Choices: `"nested"` `"recursive"`
secondary-server string	Устарело, переименуйте в secondary_server. Вторичный сервер.
secure string	Безопасность. Choices: `"disable"` `"starttls"` `"ldaps"`
server string	Сервер.
server-identity-check string	Устарело, переименуйте в server_identity_check. Проверка удостоверения сервера. Choices: `"disable"` `"enable"`
source-ip string	Устарело, переименуйте в source_ip. Исходный IP-адрес.
source-ip-interface any	(list) Устарело, переименуйте в source_ip_interface. Исходный интерфейс для связи с LDAP-сервером.
source-port integer	Устарело, переименуйте в source_port. Исходный порт, используемый для связи с LDAP-сервером.
ssl-min-proto-version string	Устарело, переименуйте в ssl_min_proto_version. Минимальная версия протокола SSL. Choices: `"default"` `"TLSv1"` `"TLSv1-1"` `"TLSv1-2"` `"SSLv3"` `"TLSv1-3"`
status-ttl integer	Устарело, переименуйте в status_ttl. Время, в течение которого кэшируется доступность сервера, так что когда сервер…
tertiary-server string	Устарело, переименуйте в tertiary_server. Третичный сервер.

two-factor string	Устарело, переименуйте в two_factor. Двухфакторная аутентификация. Choices: `"disable"` `"fortitoken-cloud"`
two-factor-authentication string	Устарело, переименуйте в two_factor_authentication. Двухфакторная аутентификация. Choices: `"fortitoken"` `"email"` `"sms"`
two-factor-filter string	Устарело, переименуйте в two_factor_filter. Фильтр, используемый для синхронизации пользователей с FortiToken Cloud.
two-factor-notification string	Устарело, переименуйте в two_factor_notification. Уведомление о двухфакторной аутентификации. Choices: `"email"` `"sms"`
type string	Тип. Choices: `"simple"` `"anonymous"` `"regular"`
user-info-exchange-server string	Устарело, переименуйте в user_info_exchange_server. Сервер обмена информацией о пользователях.
username string	Имя пользователя.
group-filter string	Устарело, переименуйте в group_filter. Фильтр, используемый для сопоставления групп.
group-member-check string	Устарело, переименуйте в group_member_check. Методы проверки членства в группе. Choices: `"user-attr"` `"group-object"` `"posix-group-object"`
group-object-filter string	Устарело, переименуйте в group_object_filter. Фильтр, используемый для поиска групп.
group-object-search-base string	Устарело, переименуйте в group_object_search_base. База поиска, используемая для поиска групп.
group-search-base string	Устарело, переименуйте в group_search_base. База поиска, используемая для поиска групп.
interface string	Укажите исходящий интерфейс для доступа к серверу.
interface-select-method string	Устарело, переименуйте в interface_select_method. Укажите, как выбрать исходящий интерфейс для доступа к серверу. Choices: `"auto"` `"sdwan"` `"specify"`
member-attr string	Устарело, переименуйте в member_attr. Имя атрибута, из которого получить членство в группе.
name string / required	Имя записи сервера LDAP.
obtain-user-info string	Устарело, переименуйте в obtain_user_info. Включить/отключить получение информации о пользователе. Choices: `"disable"` `"enable"`
password any	(list) Пароль для начального связывания.
password-attr string	Устарело, переименуйте в password_attr. Имя атрибута для получения хэша пароля.
password-expiry-warning string	Устарело, переименуйте в password_expiry_warning. Включить/отключить предупреждения о сроке действия пароля. Choices: `"disable"` `"enable"`
password-renewal string	Устарело, переименуйте в password_renewal. Включить/отключить онлайн-обновление пароля. Choices: `"disable"` `"enable"`

port integer	Порт, используемый для связи с сервером LDAP
search-type list / elements=string	Устарело, пожалуйста, переименуйте на search_type. Тип поиска. Варианты: `"nested"` `"recursive"`
secondary-server string	Устарело, пожалуйста, переименуйте на secondary_server. Доменное имя или IP-адрес вторичного сервера LDAP.
secure string	Порт, используемый для аутентификации. Варианты: `"disable"` `"starttls"` `"ldaps"`
server string	Доменное имя или IP-адрес сервера LDAP.
server-identity-check string	Устарело, пожалуйста, переименуйте на server_identity_check. Включить/выключить проверку подлинности сервера LDAP Варианты: `"disable"` `"enable"`
source-ip string	Устарело, пожалуйста, переименуйте на source_ip. IP-адрес источника для связи с сервером LDAP.
source-ip-interface any	(список) Устарело, пожалуйста, переименуйте на source_ip_interface. Истоковый интерфейс для связи с сервером LDAP.
source-port integer	Устарело, пожалуйста, переименуйте на source_port. Истоковый порт для связи с сервером LDAP.
ssl-min-proto-version string	Устарело, пожалуйста, переименуйте на ssl_min_proto_version. Минимальная поддерживаемая версия протокола для SSL/TLS соединений Варианты: `"default"` `"TLSv1"` `"TLSv1-1"` `"TLSv1-2"` `"SSLv3"` `"TLSv1-3"`
status-ttl integer	Устарело, пожалуйста, переименуйте на status_ttl. Время, в течение которого кешируется доступность сервера, чтобы при недоступности сервера...
tertiary-server string	Устарело, пожалуйста, переименуйте на tertiary_server. Доменное имя или IP-адрес третичного сервера LDAP.
two-factor string	Устарело, пожалуйста, переименуйте на two_factor. Включить/выключить двухфакторную аутентификацию. Варианты: `"disable"` `"fortitoken-cloud"`
two-factor-authentication string	Устарело, пожалуйста, переименуйте на two_factor_authentication. Метод аутентификации FortiToken Cloud. Варианты: `"fortitoken"` `"email"` `"sms"`
two-factor-filter string	Устарело, пожалуйста, переименуйте на two_factor_filter. Фильтр, используемый для синхронизации пользователей с FortiToken Cloud.
two-factor-notification string	Устарело, пожалуйста, переименуйте на two_factor_notification. Метод уведомления о регистрации пользователя FortiToken Cloud. Варианты: `"email"` `"sms"`
type string	Тип аутентификации для поиска в LDAP. Варианты: `"simple"` `"anonymous"` `"regular"`
user-info-exchange-server string	Устарело, пожалуйста, переименуйте на user_info_exchange_server. Сервер MS Exchange, из которого извлекать информацию о пользователе.
username string	Имя пользователя
workspace_locking_adom string	ADOM для блокировки при работе FortiManager в режиме рабочей области, значение может быть глобальным и другими, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем. По умолчанию: `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
  hosts: fortimanagers
  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 словарь	Результат запроса. Возвращается: всегда
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_user_ldap_module.html