fortinet.fortimanager.fmgr_user_ldap – Настройка записей сервера LDAP.

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).

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

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

Новое в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр				Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно					параметр (adom) в запрошенном URL
bypass_validation логическое				Варианты: нет ← да	устанавливается в True только при расхождении схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров
rc_failed список / элементы=строка					список кодов rc, при которых условия выполнения будут игнорироваться
rc_succeeded список / элементы=строка					список кодов rc, при которых условия выполнения будут игнорироваться
state строка / обязательно				Варианты: present absent	направление создания, обновления или удаления объекта
user_ldap словарь					параметры верхнего уровня
	account-key-filter строка				Фильтр ключа учетной записи, использующий UPN в качестве фильтра поиска.
	account-key-processing строка			Варианты: same strip	Операция обработки ключа учетной записи, сохранение или удаление доменной части UPN в токенах.
	ca-cert строка				Имя сертификата CA.
	cnid строка				Идентификатор общего имени для сервера LDAP. Для большинства серверов LDAP идентификатор общего имени - "cn".
	dn строка				Отличительное имя, используемое для поиска записей на сервере LDAP.
	dynamic_mapping список / элементы=строка				без описания
		_scope список / элементы=строка			без описания
			name строка		без описания
			vdom строка		без описания
		account-key-filter строка			без описания
		account-key-name строка			без описания
		account-key-processing строка		Варианты: same strip	без описания
		ca-cert строка			без описания
		cnid строка			без описания
		dn строка			без описания
		filter строка			без описания
		group строка			без описания
		group-filter строка			без описания
		group-member-check строка		Варианты: user-attr group-object posix-group-object	без описания
		group-object-filter строка			без описания
		group-object-search-base строка			без описания
		group-search-base строка			без описания
		member-attr строка			без описания
		obtain-user-info строка		Варианты: disable enable	без описания
		password строка			без описания
		password-expiry-warning строка		Варианты: disable enable	без описания
		password-renewal строка		Варианты: disable enable	без описания
		port целое число			без описания
		retrieve-protection-profile строка			без описания
		search-type список / элементы=строка		Варианты: nested recursive	без описания
		secondary-server строка			без описания
		secure строка		Варианты: disable starttls ldaps	без описания
		server строка			без описания
		server-identity-check строка		Варианты: disable enable	без описания
		source-ip строка			без описания
		ssl-min-proto-version строка		Варианты: default TLSv1 TLSv1-1 TLSv1-2 SSLv3	без описания
		tertiary-server строка			без описания
		type строка		Варианты: simple anonymous regular	без описания
		user-info-exchange-server строка			без описания
		username строка			без описания
	group-filter строка				Фильтр, используемый для сопоставления групп.
	group-member-check строка			Варианты: user-attr group-object posix-group-object	Методы проверки членства в группах.
	group-object-filter строка				Фильтр, используемый для поиска групп.
	group-search-base строка				Базовая точка поиска для поиска групп.
	member-attr строка				Имя атрибута, из которого извлекается членство в группах.

	Имя строка		Имя записи сервера LDAP.
	пароль строка		нет описания
	password-expiry-warning строка	Варианты: отключить включить	Включить/отключить предупреждения о сроке действия пароля.
	password-renewal строка	Варианты: отключить включить	Включить/отключить онлайн-обновление пароля.
	порт целое число		Порт, используемый для связи с сервером LDAP (по умолчанию = 389).
	secondary-server строка		Имя домена CN или IP-адрес вторичного сервера LDAP.
	secure строка	Варианты: отключить starttls ldaps	Порт, используемый для аутентификации.
	сервер строка		Имя домена CN или IP-адрес сервера LDAP.
	server-identity-check строка	Варианты: отключить включить	Включить/отключить проверку подлинности сервера LDAP (проверить имя домена/IP-адрес сервера по сертификату сервера).
	source-ip строка		IP-адрес источника для связи с сервером LDAP.
	ssl-min-proto-version строка	Варианты: по умолчанию TLSv1 TLSv1-1 TLSv1-2 SSLv3	Минимальная поддерживаемая версия протокола для SSL/TLS-соединений (по умолчанию следует глобальным системным настройкам).
	tertiary-server строка		Имя домена CN или IP-адрес третичного сервера LDAP.
	тип строка	Варианты: простой анонимный обычный	Тип аутентификации для поиска LDAP.
	имя пользователя строка		Имя пользователя (полный DN) для первоначальной привязки.
workspace_locking_adom строка			адрес, который нужно заблокировать для FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая корень
workspace_locking_timeout целое число		По умолчанию: 300	максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство

Примечания

Примечание

Работа в режиме блокировки рабочего пространства поддерживается в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в работе.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой при возвращении ненулевого rc. Вы также можете переопределить условия завершения с ошибкой или успехом с параметрами rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure LDAP server entries.
     fmgr_user_ldap:
        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>
        state: <value in [present, absent]>
        user_ldap:
           account-key-filter: <value of string>
           account-key-processing: <value in [same, strip]>
           ca-cert: <value of string>
           cnid: <value of string>
           dn: <value of string>
           dynamic_mapping:
             -
                 _scope:
                   -
                       name: <value of string>
                       vdom: <value of string>
                 account-key-filter: <value of string>
                 account-key-name: <value of string>
                 account-key-processing: <value in [same, strip]>
                 ca-cert: <value of string>
                 cnid: <value of string>
                 dn: <value of string>
                 filter: <value of string>
                 group: <value of string>
                 group-filter: <value of string>
                 group-member-check: <value in [user-attr, group-object, posix-group-object]>
                 group-object-filter: <value of string>
                 group-object-search-base: <value of string>
                 group-search-base: <value of string>
                 member-attr: <value of string>
                 obtain-user-info: <value in [disable, enable]>
                 password: <value of string>
                 password-expiry-warning: <value in [disable, enable]>
                 password-renewal: <value in [disable, enable]>
                 port: <value of integer>
                 retrieve-protection-profile: <value of string>
                 search-type:
                   - nested
                   - recursive
                 secondary-server: <value of string>
                 secure: <value in [disable, starttls, ldaps]>
                 server: <value of string>
                 server-identity-check: <value in [disable, enable]>
                 source-ip: <value of string>
                 ssl-min-proto-version: <value in [default, TLSv1, TLSv1-1, ...]>
                 tertiary-server: <value of string>
                 type: <value in [simple, anonymous, regular]>
                 user-info-exchange-server: <value of string>
                 username: <value of string>
           group-filter: <value of string>
           group-member-check: <value in [user-attr, group-object, posix-group-object]>
           group-object-filter: <value of string>
           group-search-base: <value of string>
           member-attr: <value of string>
           name: <value of string>
           password: <value of string>
           password-expiry-warning: <value in [disable, enable]>
           password-renewal: <value in [disable, enable]>
           port: <value of integer>
           secondary-server: <value of string>
           secure: <value in [disable, starttls, ldaps]>
           server: <value of string>
           server-identity-check: <value in [disable, enable]>
           source-ip: <value of string>
           ssl-min-proto-version: <value in [default, TLSv1, TLSv1-1, ...]>
           tertiary-server: <value of string>
           type: <value in [simple, anonymous, regular]>
           username: <value of string>

Значения возврата

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

Ключ	Возвращаемое значение	Описание
request_url строка	всегда	Полный запрашиваемый URL Пример: /sys/login/user
response_code целое число	всегда	Статус запроса API
response_message строка	всегда	Описание сообщения ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_user_ldap_module.html