f5networks.f5_modules.bigip_device_auth_ldap модуль — Управление настройками аутентификации устройств LDAP на BIG-IP

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать её в книге задач, укажите: f5networks.f5_modules.bigip_device_auth_ldap.

Новая функция в f5networks.f5_modules 1.0.0

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

Обзор

Управление настройками аутентификации устройств LDAP на BIG-IP.

Параметры

Параметр	Комментарии
bind_dn строка	Указывает имя с различающими атрибутами для идентификатора пользователя сервера Active Directory или LDAP. Модуль аутентификации клиентов BIG-IP не поддерживает серверы Active Directory или LDAP, которые не выполняют ссылку bind при аутентификации ссылаемых учетных записей. Поэтому, если вы планируете использовать Active Directory или LDAP в качестве источника аутентификации и хотите использовать ссылаемые учетные записи, убедитесь, что ваши серверы выполняют ссылку bind.
bind_password строка	Указывает пароль для идентификатора пользователя сервера Active Directory или LDAP.
ca_cert псевдонимы: ssl_ca_cert строка	Указывает имя сертификата SSL от центра сертификации (CA). Чтобы удалить это значение, используйте зарезервированное значение `none`.
check_member_attr логическое значение	Проверяет атрибут member пользователя в удаленной группе LDAP или AD. Варианты: `false` `true`
client_cert псевдонимы: ssl_client_cert строка	Указывает имя сертификата SSL клиента. Чтобы удалить это значение, используйте зарезервированное значение `none`.
client_key псевдонимы: ssl_client_key строка	Указывает имя закрытого ключа SSL клиента. Чтобы удалить это значение, используйте зарезервированное значение `none`.
fallback_to_local логическое значение	Указывает, что система использует метод локальной аутентификации, если метод удаленной аутентификации недоступен. Параметр доступен только в версиях `TMOS 13.0.0` и выше. Варианты: `false` `true`
login_ldap_attr строка	Указывает атрибут каталога LDAP, содержащий имя локального пользователя, связанное с выбранной записью каталога. Если этот параметр не указан, при первой настройке аутентификации устройств LDAP по умолчанию используется порт `samaccountname`.
port целое число	Указывает порт, используемый системой для доступа к серверу удаленного хоста. При первой настройке аутентификации устройств LDAP по умолчанию используется порт `389`, если этот параметр не указан.
provider словарь добавлен в f5networks.f5_modules 1.0.0	Объект словаря, содержащий данные подключения.
auth_provider строка	Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
no_f5_teem логическое значение	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную окружения `F5_TELEMETRY_OFF`. Предыдущая переменная `F5_TEEM` устарела, так как ее имя вызывало путаницу. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd строка / обязательный	Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Вы можете опустить этот параметр, установив переменную окружения `F5_PASSWORD`.
server строка / обязательный	Хост BIG-IP или хост BIG-IQ. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER`.
server_port целое число	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER_PORT`. По умолчанию: `443`
timeout целое число	Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку.
transport строка	Настраивает транспортное подключение для использования при подключении к удаленному устройству. Варианты: `"rest"` ← (по умолчанию)

END_OF_DOCUMENT_MARKER

user строка / обязательно	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
validate_certs булево	Если `no`, сертификаты SSL не проверяются. Используйте этот параметр только на сайтах, контролируемых вами, с использованием собственных сертификатов. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
referrals булево добавлен в f5networks.f5_modules 1.22.0	Указывает, должна ли быть включена автоматическая проверка рефералов. Параметр доступен только в версиях `TMOS 15.1.0` и выше. Варианты: `false` `true`
remote_directory_tree строка	Указывает расположение файла (дерево) базы данных аутентификации пользователей на сервере.
scope строка	Указывает уровень удаленного каталога Active Directory или LDAP, который система должна искать для аутентификации пользователя. Варианты: `"sub"` `"one"` `"base"`
servers список / элементы=строка	Указывает LDAP-серверы, которые система должна использовать для получения информации об аутентификации. Вы должны указать сервер при создании объекта конфигурации LDAP.
source_type строка добавлен в f5networks.f5_modules 1.13.0	Указывает источник аутентификации для аутентификации пользователя, должен использоваться с `use_for_auth`. Варианты: `"ldap"` ← (по умолчанию) `"active-directory"`
ssl строка	Указывает, использует ли система порт SSL для связи с LDAP-сервером. Варианты: `"yes"` `"no"` `"start-tls"`
state строка	При `present`, гарантирует, что метод аутентификации устройства существует. При `absent`, гарантирует, что метод аутентификации устройства не существует. При `state` равном (absent), прежде чем вы сможете удалить конфигурацию LDAP, система должна установить аутентификацию на какой-либо другой вариант. Система поставляется с системной аутентификацией под названием `local`, поэтому тип системной аутентификации устанавливается на это значение на устройстве при удалении конфигурации LDAP. Варианты: `"present"` ← (по умолчанию) `"absent"`
update_password строка	`always` всегда обновляет `bind_password`. `on_create` устанавливает `bind_password` только для вновь созданных механизмов аутентификации. Варианты: `"always"` ← (по умолчанию) `"on_create"`
use_for_auth булево	Указывает, используется ли этот источник аутентификации в системе. Если `true`, модуль устанавливает текущий тип системной аутентификации в значение `ldap`. Если `false`, модуль устанавливает тип аутентификации в `local`, аналогичное поведение при `state` равном `absent`, без удаления настроенного LDAP-ресурса. Варианты: `false` `true`
user_template строка	Указывает полное доменное имя пользователя, который входит в систему. Вы указываете шаблон в качестве переменной, которую система заменяет пользователем-специфической информацией во время попытки входа. Например, вы можете указать шаблон пользователя, такой как `%s@siterequest.com` или `uxml:id=%s,ou=people,dc=siterequest,dc=com`. Когда пользователь пытается войти, система заменяет `%s` именем, указанным пользователем в диалоговом окне Основной аутентификации, и передает это как полное доменное имя для операции связывания. Система передает связанный пароль как пароль для операции связывания. Это поле может содержать только один `%s` и не может содержать другие спецификаторы формата.
validate_certs псевдонимы: ssl_check_peer булево	Указывает, проверяет ли система SSL-соединение, в результате чего система требует и проверяет сертификат сервера. Варианты: `false` `true`

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
Требуется версия программного обеспечения BIG-IP >= 12.
Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы гарантировать, что конфигурация BIG-IP сохраняется на диске, убедитесь, что включён хотя бы один шаг, использующий модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.

Примеры

- name: Create an LDAP authentication object
  bigip_device_auth_ldap:
    name: foo
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ	Описание
bind_dn string	Отличительное имя для идентификатора пользователя сервера Active Directory или LDAP. Возвращается: changed Пример: `"user@foobar.local"`
ca_cert string	Имя SSL-сертификата от центра сертификации. Возвращается: changed Пример: `"My-Trusted-CA-Bundle.crt"`
check_member_attr boolean	Атрибут участника пользователя в удаленной группе LDAP или AD. Возвращается: changed Пример: `true`
client_cert string	Имя SSL-сертификата клиента. Возвращается: changed Пример: `"MyCert.crt"`
client_key string	Имя SSL-ключа клиента. Возвращается: changed Пример: `"MyKey.key"`
fallback_to_local boolean	Указывает, что система использует локальный метод аутентификации в качестве резервного. Возвращается: changed Пример: `true`
login_ldap_attr string	Атрибут каталога LDAP, содержащий локальное имя пользователя, связанное с выбранной записью каталога. Возвращается: changed Пример: `"samaccountname"`
port integer	Порт, используемый системой для доступа к удаленному серверу LDAP. Возвращается: changed Пример: `389`
referrals boolean	Указывает, следует ли включать автоматический поиск рефералов. Возвращается: changed Пример: `true`
remote_directory_tree string	Расположение файла (дерево) базы данных аутентификации пользователей на сервере. Возвращается: changed Пример: `"CN=Users,DC=FOOBAR,DC=LOCAL"`
scope string	Уровень удаленного каталога Active Directory или LDAP, который просматривается для аутентификации пользователей. Возвращается: changed Пример: `"base"`
servers list / elements=string	Серверы LDAP, используемые системой для получения информации об аутентификации. Возвращается: changed Пример: `["192.168.1.1", "192.168.1.2"]`
ssl string	Указывает, использует ли система SSL-порт для связи с сервером LDAP. Возвращается: changed Пример: `"start-tls"`
user_template string	Отличительное имя пользователя, который выполняет вход. Возвращается: changed Пример: `"uid=%s,ou=people,dc=foobar,dc=local"`
validate_certs boolean	Указывает, проверяет ли система SSL-участника. Возвращается: changed Пример: `true`

Авторы

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

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

© 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/f5networks/f5_modules/bigip_device_auth_ldap_module.html