Spec-Zone.ru › Ansible 2.10

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

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.6.0).

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

Для использования в книге задач укажите: f5networks.f5_modules.bigip_device_auth_ldap.

В версии 1.0.0: модуля f5networks.f5_modules

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

Описание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
bind_dn
строка
Указывает полное доменное имя (DN) пользователя Active Directory или LDAP-сервера.
Модуль аутентификации клиентов BIG-IP не поддерживает Active Directory или LDAP-сервера, которые не выполняют референтный bind при аутентификации ссылающихся учетных записей.
Поэтому, если вы планируете использовать Active Directory или LDAP в качестве источника аутентификации и хотите использовать ссылающиеся учетные записи, убедитесь, что ваши сервера выполняют референтный bind.
bind_password
строка
Указывает пароль для пользователя Active Directory или LDAP-сервера.
ca_cert
строка
Указывает имя сертификата SSL от центра сертификации (CA).
Чтобы удалить это значение, используйте зарезервированное значение none.

псевдонимы: ssl_ca_cert
check_member_attr
логическое значение
    Варианты:
  • no
  • yes
Проверяет атрибут member пользователя в удалённой группе LDAP или AD.
client_cert
строка
Указывает имя SSL-сертификата клиента.
Чтобы удалить это значение, используйте зарезервированное значение none.

псевдонимы: ssl_client_cert
client_key
строка
Указывает имя SSL-ключа клиента.
Чтобы удалить это значение, используйте зарезервированное значение none.

псевдонимы: ssl_client_key
fallback_to_local
логическое значение
    Варианты:
  • no
  • yes
Указывает, что система использует метод локальной аутентификации, если удалённый метод аутентификации недоступен.
Вариант доступен только на TMOS 13.0.0 и выше.
login_ldap_attr
строка
Указывает атрибут LDAP-каталога, содержащий имя локального пользователя, связанное с выбранной записью каталога.
Если этот параметр не указан, при первой настройке аутентификации устройств LDAP по умолчанию используется порт samaccountname.
port
целое число
Указывает порт, используемый системой для доступа к удалённому серверу.
При первой настройке аутентификации устройств LDAP по умолчанию используется порт 389, если этот параметр не указан.
provider
словарь
добавлено в 1.0.0 f5networks.f5_modules
Объект словаря, содержащий детали подключения.
auth_provider
строка
Настраивает поставщика аутентификации для получения токенов аутентификации от удалённого устройства.
Этот параметр используется при работе с устройствами BIG-IQ.
no_f5_teem
логическое значение
    Варианты:
  • no
  • yes
Если yes, данные телеметрии TEEM не отправляются в F5.
Можно опустить этот параметр, задав переменную среды F5_TEEM.
password
строка / обязательно
Пароль для учетной записи пользователя, используемой для подключения к BIG-IP.
Можно опустить этот параметр, задав переменную среды F5_PASSWORD.

псевдонимы: pass, pwd
server
строка / обязательно
Хост BIG-IP.
Можно опустить этот параметр, задав переменную среды F5_SERVER.
server_port
целое число
По умолчанию:
443
Порт сервера BIG-IP.
Можно опустить этот параметр, задав переменную среды F5_SERVER_PORT.
timeout
целое число
Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут превышен до завершения операции, модуль вернёт ошибку.
transport
строка
    Варианты:
  • rest ←
Настраивает транспортное соединение для подключения к удалённому устройству.
user
строка / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве.
Можно опустить этот параметр, задав переменную среды F5_USER.
validate_certs
логическое значение
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самоподписанными сертификатами.
Можно опустить этот параметр, задав переменную среды F5_VALIDATE_CERTS.
remote_directory_tree
строка
Указывает расположение файла (дерево) базы данных аутентификации пользователя на сервере.
scope
строка
    Варианты:
  • sub
  • one
  • base
Указывает уровень удалённого каталога Active Directory или LDAP, в котором система должна искать аутентификацию пользователя.
servers
список / элементы=строка
Указывает LDAP-сервера, которые система должна использовать для получения информации об аутентификации. При создании объекта конфигурации LDAP необходимо указать сервер.
ssl
строка
    Варианты:
  • yes
  • no
  • start-tls
Указывает, использует ли система порт SSL для связи с LDAP-сервером.
state
строка
    Варианты:
  • present ←
  • absent
Когда present, гарантирует, что метод аутентификации устройства существует.
Когда absent, гарантирует, что метод аутентификации устройства не существует.
Когда state равно (absent), перед удалением конфигурации LDAP система должна установить альтернативный способ аутентификации. В системе по умолчанию есть тип аутентификации local, поэтому при удалении конфигурации LDAP тип аутентификации устройства будет установлен на это значение.
update_password
строка
    Варианты:
  • always ←
  • on_create
always всегда обновит bind_password.
on_create будет обновлять bind_password только для вновь созданных механизмов аутентификации.
use_for_auth
логическое значение
    Варианты:
  • no
  • yes
Указывает, используется ли этот источник аутентификации в системе.
Если yes, модуль устанавливает текущий тип аутентификации системы на значение ldap.
Если no, модуль устанавливает тип аутентификации на local, аналогичное поведение, когда state равно absent, без удаления настроенного LDAP-ресурса.
user_template
строка
Указывает полное доменное имя (DN) пользователя, который входит в систему.
Вы указываете шаблон как переменную, которую система заменяет пользовательской информацией во время попытки входа.
Например, вы можете указать шаблон пользователя, такой как %s@siterequest.com или uxml:id=%s,ou=people,dc=siterequest,dc=com.
При попытке входа пользователем система заменяет %s именем, указанным пользователем в диалоговом окне Basic Authentication, и использует это как полное доменное имя для операции bind.
Система передаёт связанный пароль в качестве пароля для операции bind.
Это поле может содержать только один %s, и не может содержать другие спецификаторы формата.
validate_certs
логическое значение
    Варианты:
  • no
  • yes
Указывает, проверяет ли система удалённый узел SSL, в результате чего система требует и проверяет серверный сертификат.

псевдонимы: ssl_check_peer

Примечания

Примечание

  • Дополнительную информацию об использовании 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
строка
изменённое
Идентификатор пользователя сервера Active Directory или LDAP.

Пример:
user@foobar.local
ca_cert
строка
изменённое
Имя сертификата SSL от центра сертификации.

Пример:
My-Trusted-CA-Bundle.crt
check_member_attr
булево
изменённое
Атрибут пользователя-члена в удалённой группе LDAP или AD.

Пример:
True
client_cert
строка
изменённое
Имя SSL-клиентского сертификата.

Пример:
MyCert.crt
client_key
строка
изменённое
Имя SSL-клиентского ключа.

Пример:
MyKey.key
fallback_to_local
булево
изменённое
Указывает, что система использует локальный метод аутентификации по умолчанию.

Пример:
True
login_ldap_attr
строка
изменённое
Атрибут каталога LDAP, содержащий локальное имя пользователя, связанное с выбранной записью каталога.

Пример:
samaccountname
port
целое число
изменённое
Порт, используемый системой для доступа к удалённому серверу LDAP.

Пример:
389
remote_directory_tree
строка
изменённое
Расположение файла (дерева) базы данных аутентификации пользователя на сервере.

Пример:
CN=Users,DC=FOOBAR,DC=LOCAL
scope
строка
изменённое
Уровень удалённого каталога Active Directory или LDAP, в котором ищется аутентификация пользователя.

Пример:
base
servers
список / элементы=строка
изменённое
Серверы LDAP, используемые системой для получения информации об аутентификации.

Пример:
['192.168.1.1', '192.168.1.2']
ssl
строка
изменённое
Указывает, использует ли система порт SSL для связи с сервером LDAP.

Пример:
start-tls
user_template
строка
изменённое
Уникальное имя пользователя, который входит в систему.

Пример:
uid=%s,ou=people,dc=foobar,dc=local
validate_certs
булево
изменённое
Указывает, проверяет ли система SSL-партнера.

Пример:
True


Авторы

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_device_auth_ldap_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API