Spec-Zone.ru › Ansible

sensu.sensu_go.ldap_auth_provider модуль – Управление провайдером аутентификации Sensu LDAP

Примечание

Этот модуль входит в коллекцию sensu.sensu_go (версия 1.14.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install sensu.sensu_go. Для использования этого модуля требуются дополнительные зависимости. Подробнее см. Требования.

Для использования в плейбуке укажите: sensu.sensu_go.ldap_auth_provider.

Новая функция в sensu.sensu_go 1.10.0

  • Обзор
  • Требования
  • Параметры
  • См. также
  • Примеры
  • Значения возврата

Обзор

  • Создание, обновление или удаление провайдера аутентификации Sensu Go LDAP.
  • Дополнительную информацию см. в документации Sensu Go по адресу https://docs.sensu.io/sensu-go/latest/operations/control-access/ldap-auth/.

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

  • python >= 2.7

Параметры

Параметр

Комментарии

auth

словарь

Параметры аутентификации. Можно определить каждый из них с помощью переменной окружения.

api_key

строка

добавлено в sensu.sensu_go 1.3.0

Ключ API, который следует использовать при аутентификации. Если он не задан, будет проверена переменная окружения SENSU_API_KEY.

Заменяет параметры auth.user и auth.password.

Дополнительную информацию о ключе API см. в официальной документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.

ca_path

путь

добавлено в sensu.sensu_go 1.5.0

Путь к каталогу сертификатов CA, который следует использовать для проверки сертификата бэкенда.

Если этот параметр не задан, модуль будет использовать каталог сертификатов CA, используемый python.

Этот параметр также можно задать через переменную окружения SENSU_CA_PATH.

password

строка

Пароль пользователя Sensu. Если он не задан, будет проверена переменная окружения SENSU_PASSWORD.

Этот параметр игнорируется, если задан параметр auth.api_key.

Значение по умолчанию: "P@ssw0rd!"

url

строка

Расположение API бэкенда Sensu. Если он не задан, будет проверена переменная окружения SENSU_URL.

Значение по умолчанию: "http://localhost:8080"

user

строка

Имя пользователя для подключения к API Sensu. Если он не задан, будет проверена переменная окружения SENSU_USER.

Этот параметр игнорируется, если задан параметр auth.api_key.

Значение по умолчанию: "admin"

verify

логический

добавлено в sensu.sensu_go 1.5.0

Флаг, контролирующий проверку сертификатов.

Если вы используете самозаверяющие сертификаты, вы можете установить этот параметр в false.

Используйте этот параметр ТОЛЬКО в сценариях разработки! При использовании самозаверяющих сертификатов в производстве, обратитесь к параметру auth.ca_path.

Этот параметр также можно задать через переменную окружения SENSU_VERIFY.

Варианты:

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

groups_prefix

строка

Префикс, добавляемый ко всем группам LDAP.

name

строка / обязательно

Имя ресурса Sensu. Это имя (в сочетании с пространством имён, где применимо) однозначно идентифицирует ресурс, на котором работает Ansible.

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

См. спецификацию атрибута метаданных name в документации upstream по адресу https://docs.sensu.io/sensu-go/latest/reference/ для получения дополнительной информации о допустимых именах и других ограничениях.

servers

список / элементы=словарь

Массив серверов LDAP для вашего каталога.

Требуется, если state равен present.

binding

словарь

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

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

password

строка / обязательно

Пароль для учетной записи user_dn.

Если ваш сервер поддерживает анонимное подключение, вы можете опустить этот атрибут.

user_dn

строка / обязательно

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

Если ваш сервер поддерживает анонимное подключение, вы можете опустить этот атрибут.

client_cert_file

строка

Путь к сертификату, который должен быть отправлен на сервер, если запрошен.

client_key_file

строка

Путь к файлу ключа, связанному с client_cert_file.

Требуется, если client_cert_file присутствует.

group_search

словарь

Настройки поиска групп.

attribute

строка

Используется для сравнения записей результатов.

Значение по умолчанию: "member"

base_dn

строка / обязательно

Какая часть древовидной структуры каталога должна быть просмотрена.

name_attribute

строка

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

Значение по умолчанию: "cn"

object_class

string

Идентифицирует класс объектов, возвращаемых в результате поиска.

По умолчанию: "groupOfNames"

host

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

IP-адрес сервера LDAP.

insecure

boolean

Пропускает проверку сертификата SSL, если установлено в значение true.

Варианты:

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

port

integer

Порт сервера LDAP.

security

string

Тип шифрования, используемый для подключения к серверу LDAP.

Варианты:

  • "insecure"
  • "tls" ← (по умолчанию)
  • "starttls"

trusted_ca_file

string

Путь к альтернативному файлу файла CA.

user_search

dictionary

Настройка поиска пользователей.

attribute

string

Используется для сравнения записей результатов.

По умолчанию: "uid"

base_dn

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

Какая часть дерева каталога должна быть проверена.

name_attribute

string

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

По умолчанию: "cn"

object_class

string

Идентифицирует класс объектов, возвращаемых в результате поиска.

По умолчанию: "person"

state

string

Целевое состояние объекта Sensu.

Варианты:

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

username_prefix

string

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

См. также

См. также

sensu.sensu_go.auth_provider_info

Список поставщиков аутентификации Sensu.

sensu.sensu_go.ad_auth_provider

Управление поставщиком аутентификации Sensu AD.

sensu.sensu_go.oidc_auth_provider

Управление поставщиком аутентификации Sensu OIDC.

Примеры

- name: Create a LDAP auth provider
  sensu.sensu_go.ldap_auth_provider:
    name: openldap
    servers:
      - host: 127.0.0.1
        group_search:
          base_dn: dc=acme,dc=org
        user_search:
          base_dn: dc=acme,dc=org

- name: Delete a LDAP auth provider
  sensu.sensu_go.ldap_auth_provider:
    name: openldap
    state: absent

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

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

Ключ

Описание

object

dictionary

Объект, представляющий поставщика аутентификации Sensu LDAP.

Возвращается: success

Пример: {"groups_prefix": "ldap", "metadata": {"name": "openldap"}, "servers": {"binding": {"user_dn": "cn=binder,dc=acme,dc=org"}, "client_cert_file": "/path/to/ssl/cert.pem", "client_key_file": "/path/to/ssl/key.pem", "group_search": {"attribute": "member", "base_dn": "dc=acme,dc=org", "name_attribute'": "cn", "object_class": "groupOfNames"}, "host": "127.0.0.1", "insecure": "False", "port": "636", "security": "tls", "trusted_ca_file": "/path/to/trusted-certificate-authorities.pem", "user_search": {"attribute": "uid", "base_dn": "dc=acme,dc=org", "name_attribute": "cn", "object_class": "person"}}, "username_prefix": "ldap"}

Авторы

  • Aljaz Kosir (@aljazkosir)
  • Manca Bizjak (@mancabizjak)
  • Miha Dolinar (@mdolin)
  • Tadej Borovsak (@tadeboro)

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

  • Отслеживание проблем
  • Репозиторий (источники)

© 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/sensu/sensu_go/ldap_auth_provider_module.html

Spec-Zone.ru

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