sensu.sensu_go.event_info – Список событий Sensu
Примечание
Этот плагин входит в коллекцию sensu.sensu_go (версия 1.8.0).
Для его установки используйте: ansible-galaxy collection install sensu.sensu_go.
Для использования в книге задач укажите: sensu.sensu_go.event_info.
Введено в версии 1.0.0: модуля sensu.sensu_go
Обзор
- Получение последних событий, обработанных Sensu.
- Для получения дополнительной информации обратитесь к документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/events/.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth словарь | Параметры аутентификации. Можно определить каждый из них с помощью переменной среды. | ||
| api_key строка добавлен в версии 1.3.0 sensu.sensu_go | Ключ API, который должен использоваться при аутентификации. Если он не задан, будет проверено значение переменной среды SENSU_API_KEY. Заменяет параметры auth.user и auth.password. Дополнительную информацию о ключе API см. в официальной документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/. | ||
| ca_path путь добавлен в версии 1.5.0 sensu.sensu_go | Путь к пакету сертификатов CA, который следует использовать для проверки сертификата бэкенда. Если этот параметр не задан, модуль использует пакет CA, используемый Python. Также возможно задать этот параметр через переменную среды SENSU_CA_PATH. | ||
| password строка | Значение по умолчанию: "P@ssw0rd!" | Пароль пользователя Sensu. Если он не задан, будет проверено значение переменной среды SENSU_PASSWORD. Этот параметр игнорируется, если задан параметр auth.api_key. | |
| url строка | Значение по умолчанию: "http://localhost:8080" | Расположение API бэкенда Sensu. Если он не задан, будет проверено значение переменной среды SENSU_URL. | |
| user строка | Значение по умолчанию: "admin" | Имя пользователя для подключения к API Sensu. Если он не задан, будет проверено значение переменной среды SENSU_USER. Этот параметр игнорируется, если задан параметр auth.api_key. | |
| verify логическое значение добавлен в версии 1.5.0 sensu.sensu_go |
| Флаг, который управляет проверкой сертификатов. Если вы используете самозаверяющие сертификаты, вы можете установить этот параметр в false.Используйте этот параметр ТОЛЬКО в сценариях разработки! Если вы используете самозаверяющие сертификаты в рабочей среде, см. параметр auth.ca_path. Также возможно задать этот параметр через переменную среды SENSU_VERIFY. | |
| check строка | Ограничение результатов конкретной проверкой.
Если используется этот параметр, также необходимо указать параметр entity. | ||
| entity строка | Ограничение результатов конкретной сущностью. | ||
| namespace строка | Значение по умолчанию: "default" | Пространство имён RBAC для работы. Если не задано, будет использовано значение переменной среды SENSU_NAMESPACE. | |
См. также
См. также
- sensu.sensu_go.event
-
Официальная документация по модулю sensu.sensu_go.event.
Примеры
- 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. Пример: [{'check': {'check_hooks': None, 'command': 'check-cpu.sh -w 75 -c 90', 'duration': 1.07055808, 'env_vars': None, 'executed': 1552594757, 'handlers': [], 'high_flap_threshold': 0, 'history': [{'executed': 1552594757, 'status': 0}], 'interval': 60, 'metadata': {'name': 'check-cpu', 'namespace': 'default'}, 'occurrences': 1, 'occurrences_watermark': 1, 'output': 'CPU OK - Usage:3.96', 'subscriptions': ['linux'], 'timeout': 0, 'total_state_change': 0, 'ttl': 0}, 'entity': {'deregister': False, 'deregistration': {}, 'entity_class': 'agent', 'last_seen': 1552594641, 'metadata': {'name': 'sensu-centos', 'namespace': 'default'}}, 'id': '3a5948f3-6ffd-4ea2-a41e-334f4a72ca2f', 'metadata': {'namespace': 'default'}, 'sequence': 1, 'timestamp': 1552594758}] |
Авторы
- Paul Arthur (@flowerysong)
- Aljaz Kosir (@aljazkosir)
- Manca Bizjak (@mancabizjak)
- Tadej Borovsak (@tadeboro)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/sensu/sensu_go/event_info_module.html