Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

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

Описание

  • Создание, обновление или удаление провайдера аутентификации Sensu Go AD.
  • Для получения дополнительной информации см. документацию Sensu Go по адресу https://docs.sensu.io/sensu-go/latest/operations/control-access/ad-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

строка

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

name

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

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

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

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

servers

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

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

binding

словарь

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

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

password

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

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

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

user_dn

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

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

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

client_cert_file

строка

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

client_key_file

строка

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

Обязателен, если присутствует client_cert_file.

default_upn_domain

строка

Включает аутентификацию UPN при установке. Суффикс UPN по умолчанию, который будет добавлен к имени пользователя, когда домен не указан во время входа (например, пользователь становится пользователь@доменпоумолчанию.xyz).

group_search

словарь

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

attribute

строка

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

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

base_dn

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

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

name_attribute

string

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

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

object_class

string

Определяет класс объектов, возвращаемых в результате поиска.

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

host

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

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

include_nested_groups

boolean

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

Варианты:

  • false
  • true

insecure

boolean

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

Варианты:

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

port

integer

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

security

string

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

Варианты:

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

trusted_ca_file

string

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

user_search

dictionary

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

attribute

string

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

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

base_dn

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

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

name_attribute

string

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

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

object_class

string

Определяет класс объектов, возвращаемых в результате поиска.

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

state

string

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

Варианты:

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

username_prefix

string

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

См. также

См. также

sensu.sensu_go.auth_provider_info

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

sensu.sensu_go.ldap_auth_provider

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

sensu.sensu_go.oidc_auth_provider

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

Примеры

- name: Create a AD auth provider
  sensu.sensu_go.ad_auth_provider:
    name: activedirectory
    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 AD auth provider
  sensu.sensu_go.ad_auth_provider:
    name: activedirectory
    state: absent

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

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

Ключ

Описание

object

dictionary

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

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

Пример: {"groups_prefix": "AD", "metadata": {"name": "activedirectory"}, "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", "default_upn_domain": "example.org", "group_search": {"attribute": "member", "base_dn": "dc=acme,dc=org", "name_attribute'": "cn", "object_class": "group"}, "host": "127.0.0.1", "insecure": "False", "port": "636", "security": "tls", "trusted_ca_file": "/path/to/trusted-certificate-authorities.pem", "user_search": {"attribute": "sAMAccountName", "base_dn": "dc=acme,dc=org", "name_attribute": "displayName", "object_class": "person"}}, "username_prefix": "AD"}

Авторы

  • 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/ad_auth_provider_module.html

Spec-Zone.ru

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