Модуль sensu.sensu_go.auth_provider_info – Список провайдеров аутентификации Sensu

Примечание

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

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

Для установки используйте: ansible-galaxy collection install sensu.sensu_go. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Чтобы использовать его в книге задач, укажите: sensu.sensu_go.auth_provider_info.

Новое в sensu.sensu_go 1.10.0

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

Обзор

Получение информации о провайдерах аутентификации Sensu Go.
Для получения дополнительной информации обратитесь к документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/operations/control-access/.

Требования

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

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` ← (по умолчанию)
name строка	Получение информации об этом конкретном объекте вместо списка всех объектов.

См. также

sensu.sensu_go.ad_auth_provider: Управление провайдером аутентификации Sensu AD.
sensu.sensu_go.ldap_auth_provider: Управление провайдером аутентификации Sensu LDAP.
sensu.sensu_go.oidc_auth_provider: Управление провайдером аутентификации Sensu OIDC.

Примеры

- name: List all Sensu authentication providers
  sensu.sensu_go.auth_provider_info:
  register: result

- name: List the selected Sensu authentication provider
  sensu.sensu_go.auth_provider_info:
    name: my_auth_provider
  register: result

- name: Do something with result
  ansible.builtin.debug:
    msg: "{{ result.objects.0.metadata.name }}"

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

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

Ключ	Описание
objects список / элементы=словарь	Список провайдеров аутентификации Sensu. Возвращается: успех Пример: [{"groups_prefix": "", "metadata": {"name": "openldap"}, "servers": {"binding": {"user_dn": "cn=binder,dc=acme,dc=org"}, "client_cert_file": "", "client_key_file": "", "default_upn_domain": "", "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": "", "user_search": {"attribute": "uid", "base_dn": "dc=acme,dc=org", "name_attribute": "cn", "object_class": "person"}}, "username_prefix": ""}]

Ключ

Описание

objects

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

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

Возвращается: успех

Пример: [{"groups_prefix": "", "metadata": {"name": "openldap"}, "servers": {"binding": {"user_dn": "cn=binder,dc=acme,dc=org"}, "client_cert_file": "", "client_key_file": "", "default_upn_domain": "", "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": "", "user_search": {"attribute": "uid", "base_dn": "dc=acme,dc=org", "name_attribute": "cn", "object_class": "person"}}, "username_prefix": ""}]

Авторы

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/auth_provider_info_module.html