sensu.sensu_go.silence_info – Список записей о заглушении Sensu
Примечание
Этот плагин входит в состав коллекции sensu.sensu_go (версия 1.8.0).
Для его установки используйте: ansible-galaxy collection install sensu.sensu_go.
Для использования в плейбуке укажите: sensu.sensu_go.silence_info.
Новый в версии 1.0.0: модуля sensu.sensu_go
Описание
- Получение информации о заглушениях Sensu.
- Дополнительную информацию см. в документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/silencing/.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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 | Путь к файлу с сертификатами доверенных центров сертификации, используемым для проверки сертификата бэкенда. Если этот параметр не задан, модуль будет использовать сертификаты, используемые 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 строка | Имя проверки, с которой должна соответствовать запись. Если оставлено пустым, запись о заглушении будет содержать звездочку в позиции проверки. | ||
| namespace строка | По умолчанию: "default" | Пространство имён RBAC для работы. Если не задан, используется значение переменной среды SENSU_NAMESPACE. | |
| subscription строка | Имя подписки, с которой должна соответствовать запись. Если оставлено пустым, запись о заглушении будет содержать звездочку в позиции подписки. | ||
См. также
См. также
- sensu.sensu_go.silence
-
Официальная документация по модулю sensu.sensu_go.silence.
Примеры
- name: List all Sensu silence entries
sensu.sensu_go.silence_info:
register: result
- name: Fetch a specific silence with name proxy:awesome_check
sensu.sensu_go.silence_info:
subscription: proxy
check: awesome_check
register: result
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| objects список / элементы=словарь | успех | Список записей о заглушениях Sensu. Пример: [{'begin': 1542671205, 'check': None, 'creator': 'admin', 'expire': -1, 'expire_on_resolve': False, 'metadata': {'annotations': None, 'labels': None, 'name': 'entity:i-424242:*', 'namespace': 'default'}, 'reason': None, 'subscription': 'entity:i-424242'}] |
Авторы
- 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/silence_info_module.html
