Spec-Zone.ru › Ansible 2.8

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

Новая в версии 2.8.

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

Описание

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

Параметры

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

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

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

алиасы: ssl_client_key
fallback_to_local
логическое значение
    Варианты:
  • no
  • yes
Указывает, что система использует локальный метод аутентификации, если метод удалённой аутентификации недоступен.
login_ldap_attr
строка
Указывает атрибут каталога LDAP, содержащий имя локального пользователя, связанного с выбранной записью каталога.
При первой настройке аутентификации устройства LDAP, если этот параметр не указан, используется порт по умолчанию samaccountname.
password
строка / обязательно
Пароль для учетной записи пользователя, используемой для подключения к BIG-IP.
Можно опустить этот параметр, установив переменную среды F5_PASSWORD.

алиасы: pass, pwd
port
целое число
Указывает порт, используемый системой для доступа к удаленному серверу.
При первой настройке аутентификации устройства LDAP, если этот параметр не указан, используется порт по умолчанию 389.
provider
словарь
добавлено в 2.5
Объект словаря, содержащий данные подключения.
password
строка / обязательно
Пароль для учетной записи пользователя, используемой для подключения к BIG-IP.
Можно опустить этот параметр, установив переменную среды F5_PASSWORD.

алиасы: pass, pwd
server
строка / обязательно
Хост BIG-IP.
Можно опустить этот параметр, установив переменную среды F5_SERVER.
server_port
целое число
Значение по умолчанию:
443
Порт сервера BIG-IP.
Можно опустить этот параметр, установив переменную среды F5_SERVER_PORT.
ssh_keyfile
путь
Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli.
Можно опустить этот параметр, установив переменную среды ANSIBLE_NET_SSH_KEYFILE.
timeout
целое число
Значение по умолчанию:
10
Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истекает до завершения операции, модуль вернёт ошибку.
transport
строка
    Варианты:
  • cli
  • 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, который система должна искать для аутентификации пользователя.
server
строка / обязательно
Хост BIG-IP.
Можно опустить этот параметр, установив переменную среды F5_SERVER.
server_port
целое число
добавлено в 2.2
Значение по умолчанию:
443
Порт сервера BIG-IP.
Можно опустить этот параметр, установив переменную среды F5_SERVER_PORT.
servers
список
Указывает серверы LDAP, которые система должна использовать для получения информации об аутентификации. Вам необходимо указать сервер при создании объекта конфигурации LDAP.
ssl
строка
    Варианты:
  • yes
  • no
  • start-tls
Указывает, использует ли система порт SSL для связи с сервером LDAP.
state
строка
    Варианты:
  • present ←
  • absent
При present, гарантирует существование метода аутентификации устройства.
При absent, гарантирует, что метод аутентификации устройства отсутствует.
update_password
строка
    Варианты:
  • always ←
  • on_create
always всегда будет обновлять bind_password.
on_create будет устанавливать bind_password только для вновь созданных механизмов аутентификации.
user
строка / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве.
Можно опустить этот параметр, установив переменную среды F5_USER.
user_template
строка
Указывает имя пользователя, который выполняет вход.
Вы указываете шаблон в качестве переменной, которую система заменяет на информацию, специфичную для пользователя, во время попытки входа.
Например, вы можете указать шаблон пользователя, такой как %s@siterequest.com или uxml:id=%s,ou=people,dc=siterequest,dc=com.
Когда пользователь пытается войти, система заменяет %s именем, указанным пользователем в диалоговом окне "Основная аутентификация", и передает его в качестве имени для операции привязки.
Система передает связанный пароль в качестве пароля для операции привязки.
Это поле может содержать только один %s и не может содержать другие спецификаторы формата.
validate_certs
булево
добавлен в 2.0
    Варианты:
  • нет
  • да ←
Указывает, проверяет ли система удаленный SSL-партнер, в результате чего система требует и проверяет сертификат сервера.

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

Примечания

Примечание

  • Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
  • Требуется версия ПО BIG-IP ≥ 12.
  • Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы убедиться, что конфигурация, специфичная для BIG-IP, сохраняется на диске, обязательно включите по крайней мере одну задачу, использующую модуль 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


Статус

  • Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается партнером Ansible. [сертифицировано]

Авторы

  • 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.8/modules/bigip_device_auth_ldap_module.html

Spec-Zone.ru

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