Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.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

string

Указывает отличительное имя (DN) идентификатора пользователя сервера Active Directory или LDAP.

Модуль клиентской аутентификации BIG-IP не поддерживает серверы Active Directory или LDAP, которые не выполняют перенаправление bind-запроса при аутентификации перенаправленных учетных записей.

Поэтому, если вы планируете использовать Active Directory или LDAP в качестве источника аутентификации и хотите использовать перенаправленные учетные записи, убедитесь, что ваши серверы выполняют перенаправление bind-запроса.

bind_password

string

Указывает пароль для идентификатора пользователя сервера Active Directory или LDAP.

ca_cert

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

string

Указывает имя SSL-сертификата, выданного центром сертификации (CA).

Чтобы удалить это значение, используйте зарезервированное значение none.

check_member_attr

boolean

Проверяет атрибут member пользователя в удаленной группе LDAP или AD.

Варианты:

  • false
  • true

client_cert

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

string

Указывает имя сертификата SSL-клиента.

Чтобы удалить это значение, используйте зарезервированное значение none.

client_key

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

string

Указывает имя ключа SSL-клиента.

Чтобы удалить это значение, используйте зарезервированное значение none.

fallback_to_local

boolean

Указывает, что система использует метод локальной аутентификации, если удаленный метод аутентификации недоступен.

Параметр доступен только в TMOS 13.0.0 и более поздних версиях.

Варианты:

  • false
  • true

login_ldap_attr

string

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

Если при первой настройке аутентификации устройств LDAP этот параметр не указан, по умолчанию используется порт samaccountname.

port

integer

Указывает порт, используемый системой для доступа к серверу удаленного узла.

При первой настройке аутентификации устройств LDAP, если этот параметр не указан, по умолчанию используется порт 389.

provider

dictionary

добавлено в f5networks.f5_modules 1.0.0

Объект dict, содержащий сведения о подключении.

auth_provider

string

Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства.

Этот параметр фактически используется при работе с устройствами BIG-IQ.

no_f5_teem

boolean

Если yes, телеметрические данные TEEM не отправляются в F5.

Этот параметр можно не указывать, задав переменную среды F5_TELEMETRY_OFF.

Ранее использовавшаяся переменная F5_TEEM объявлена устаревшей, поскольку ее название было неоднозначным.

Варианты:

  • false ← (по умолчанию)
  • true

password

псевдонимы: pass, pwd

string / обязательный

Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ.

Этот параметр можно не указывать, задав переменную среды F5_PASSWORD.

server

string / обязательный

Узел BIG-IP или BIG-IQ.

Этот параметр можно не указывать, задав переменную среды F5_SERVER.

server_port

integer

Порт сервера BIG-IP.

Этот параметр можно не указывать, задав переменную среды F5_SERVER_PORT.

По умолчанию: 443

timeout

integer

Указывает время ожидания в секундах при взаимодействии с сетевым устройством — как при подключении, так и при отправке команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку.

transport

string

Настраивает транспортное подключение, используемое при подключении к удаленному устройству.

Варианты:

  • "rest" ← (по умолчанию)

user

string / обязательный

Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен обладать правами администратора на устройстве.

Этот параметр можно не указывать, задав переменную среды F5_USER.

validate_certs

boolean

Если no, SSL-сертификаты не проверяются. Используйте этот параметр только на подконтрольных вам сайтах с самоподписанными сертификатами.

Этот параметр можно не указывать, задав переменную среды F5_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

referrals

boolean

добавлено в f5networks.f5_modules 1.22.0

Указывает, следует ли включить автоматическое следование перенаправлениям.

Параметр доступен только в TMOS 15.1.0 и более поздних версиях.

Варианты:

  • false
  • true

remote_directory_tree

string

Указывает расположение файла (дерево) базы данных аутентификации пользователей на сервере.

scope

string

Указывает уровень удаленного каталога Active Directory или LDAP, в котором система должна искать пользователя для аутентификации.

Варианты:

  • "sub"
  • "one"
  • "base"

servers

list / элементы=string

Указывает серверы LDAP, которые система должна использовать для получения сведений об аутентификации. При создании объекта конфигурации LDAP необходимо указать сервер.

source_type

string

добавлено в f5networks.f5_modules 1.13.0

Указывает источник аутентификации пользователя; следует использовать вместе с use_for_auth.

Варианты:

  • "ldap" ← (по умолчанию)
  • "active-directory"

ssl

string

Указывает, использует ли система SSL-порт для обмена данными с сервером LDAP.

Варианты:

  • "yes"
  • "no"
  • "start-tls"

state

string

Если present, обеспечивает наличие метода аутентификации устройства.

Если absent, обеспечивает отсутствие метода аутентификации устройства.

Когда state равно (absent), перед удалением конфигурации LDAP система должна назначить альтернативный метод аутентификации. В системе предусмотрен системный метод аутентификации с именем local, поэтому при удалении конфигурации LDAP для типа системной аутентификации на устройстве устанавливается это значение.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

update_password

string

always всегда обновляет bind_password.

on_create устанавливает bind_password только для вновь созданных механизмов аутентификации.

Варианты:

  • "always" ← (по умолчанию)
  • "on_create"

use_for_auth

boolean

Указывает, используется ли этот источник аутентификации в системе.

Если true, модуль устанавливает для текущего типа системной аутентификации значение ldap.

Если false, модуль устанавливает тип аутентификации local. Поведение аналогично случаю, когда state имеет значение absent, но настроенный ресурс LDAP не удаляется.

Варианты:

  • false
  • true

user_template

string

Указывает отличительное имя пользователя, выполняющего вход.

Шаблон задается как переменная, которую система заменяет данными конкретного пользователя во время попытки входа.

Например, можно указать шаблон пользователя, например %s@siterequest.com или uxml:id=%s,ou=people,dc=siterequest,dc=com.

Когда пользователь пытается войти в систему, система заменяет %s именем, указанным пользователем в диалоговом окне базовой аутентификации, и передает его в качестве отличительного имени для операции bind.

Система передает соответствующий пароль в качестве пароля для операции bind.

Это поле может содержать только один %s и не может содержать другие спецификаторы формата.

validate_certs

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

boolean

Указывает, проверяет ли система 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.

Возвращается: при изменении

Пример: "user@foobar.local"

ca_cert

string

Имя SSL-сертификата центра сертификации.

Возвращается: при изменении

Пример: "My-Trusted-CA-Bundle.crt"

check_member_attr

boolean

Атрибут участника пользователя в удаленной группе LDAP или AD.

Возвращается: при изменении

Пример: true

client_cert

string

Имя клиентского SSL-сертификата.

Возвращается: при изменении

Пример: "MyCert.crt"

client_key

string

Имя клиентского SSL-ключа.

Возвращается: при изменении

Пример: "MyKey.key"

fallback_to_local

boolean

Указывает, что система использует локальный метод аутентификации в качестве резервного.

Возвращается: при изменении

Пример: true

login_ldap_attr

string

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

Возвращается: при изменении

Пример: "samaccountname"

port

integer

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

Возвращается: при изменении

Пример: 389

referrals

boolean

Указывает, следует ли включить автоматическое следование перенаправлениям.

Возвращается: при изменении

Пример: true

remote_directory_tree

string

Расположение (дерево) файла базы данных аутентификации пользователей на сервере.

Возвращается: при изменении

Пример: "CN=Users,DC=FOOBAR,DC=LOCAL"

scope

string

Уровень удаленного каталога Active Directory или LDAP, в котором выполняется поиск для аутентификации пользователей.

Возвращается: при изменении

Пример: "base"

servers

list / элементы=string

Серверы LDAP, используемые системой для получения сведений об аутентификации.

Возвращается: при изменении

Пример: ["192.168.1.1", "192.168.1.2"]

ssl

string

Указывает, использует ли система SSL-порт для связи с сервером LDAP.

Возвращается: при изменении

Пример: "start-tls"

user_template

string

Уникальное имя пользователя, который выполняет вход в систему.

Возвращается: при изменении

Пример: "uid=%s,ou=people,dc=foobar,dc=local"

validate_certs

boolean

Указывает, проверяет ли система SSL-узел.

Возвращается: при изменении

Пример: true

Авторы

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

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

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

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