Модуль sensu.sensu_go.handler_info – Список обработчиков Sensu
Примечание
Этот модуль входит в коллекцию sensu.sensu_go (версия 1.14.0).
У вас, возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install sensu.sensu_go. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.
Чтобы использовать его в playbook, укажите: sensu.sensu_go.handler_info.
Введено в sensu.sensu_go 1.0.0
Описание
- Получить информацию об обработчиках Sensu.
- Дополнительную информацию можно найти в документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/handlers/.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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 |
Путь к файлу с корневыми сертификатами, который должен использоваться для проверки сертификата бэкенда. Если этот параметр не задан, модуль использует корневой сертификат, используемый python. Также можно установить этот параметр через переменную среды SENSU_CA_PATH. |
|
password строка |
Пароль пользователя Sensu. Если он не задан, проверяется значение переменной среды SENSU_PASSWORD. Этот параметр игнорируется, если задан параметр auth.api_key. По умолчанию: |
|
url строка |
Расположение API бэкенда Sensu. Если он не задан, проверяется значение переменной среды SENSU_URL. По умолчанию: |
|
user строка |
Имя пользователя для подключения к API Sensu. Если он не задан, проверяется значение переменной среды SENSU_USER. Этот параметр игнорируется, если задан параметр auth.api_key. По умолчанию: |
|
verify логическое добавлено в sensu.sensu_go 1.5.0 |
Флаг, контролирующий проверку сертификата. Если вы используете самозаверяющие сертификаты, вы можете установить этот параметр в Используйте этот параметр ТОЛЬКО в СРЕДЕ РАЗРАБОТКИ! Если вы используете самозаверяющие сертификаты в ПРОИЗВОДСТВЕННОЙ среде, см. параметр auth.ca_path. Также можно установить этот параметр через переменную среды SENSU_VERIFY. Выбор:
|
name строка | Получить информацию об этом конкретном объекте вместо перечисления всех объектов. |
namespace строка | Пространство имен RBAC для работы. Если не задано, используется значение переменной среды SENSU_NAMESPACE. По умолчанию: |
См. также
См. также
- sensu.sensu_go.socket_handler
-
Управление обработчиком Sensu TCP/UDP.
- sensu.sensu_go.pipe_handler
-
Управление обработчиком Sensu pipe.
- sensu.sensu_go.handler_set
-
Управление набором обработчиков Sensu.
Примеры
- name: List all Sensu handlers
sensu.sensu_go.handler_info:
register: result
- name: Retrieve info for a specific Sensu handler
sensu.sensu_go.handler_info:
name: my-handler
register: result
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
objects список / элементы=словарь | Список обработчиков Sensu. Возвращаемое значение: успех Пример: |
Ссылки на коллекцию
© 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/handler_info_module.html
