Модуль sensu.sensu_go.event_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.event_info.
Добавлен в sensu.sensu_go 1.0.0
Описание
- Получить последние события, обработанные Sensu.
- Для получения дополнительной информации, обратитесь к документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/events/.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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. По умолчанию: |
|
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. Варианты:
|
check строка | Ограничить результаты определённым чекпоинтом. entity также должен быть указан, если используется этот параметр. |
entity строка | Ограничить результаты определённым объектом. |
namespace строка | Пространство имён RBAC для работы. Если не задано, используется значение переменной окружения SENSU_NAMESPACE. По умолчанию: |
См. также
См. также
- sensu.sensu_go.event
-
Управление событиями Sensu.
Примеры
- name: List Sensu events
sensu.sensu_go.event_info:
register: result
- name: List Sensu events for api.example.com
sensu.sensu_go.event_info:
entity: api.example.com
register: result
- name: Filter events by check and entity
sensu.sensu_go.event_info:
entity: api.example.com
check: check-cpu
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/event_info_module.html