Модуль sensu.sensu_go.silence_info – Список записей о заглушении Sensu

Примечание

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

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

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

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

Новое в sensu.sensu_go 1.0.0

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

Описание

Получение информации о заглушениях Sensu.
Для получения дополнительной информации обратитесь к документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/silencing/.

Требования

Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.

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` ← (по умолчанию)
check строка	Имя проверки, которой должна соответствовать запись. Если оставлено пустым, запись о заглушении будет содержать звездочку в позиции проверки.
namespace строка	Пространство имен RBAC для работы. Если не задано, будет использоваться значение переменной среды SENSU_NAMESPACE. По умолчанию: `"default"`
subscription строка	Имя подписки, которой должна соответствовать запись. Если оставлено пустым, запись о заглушении будет содержать звездочку в позиции подписки.

См. также

sensu.sensu_go.silence: Управление заглушениями Sensu.

Примеры

- 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. Возвращается: success Пример: `[{"begin": 1542671205, "check": null, "creator": "admin", "expire": -1, "expire_on_resolve": false, "metadata": {"annotations": null, "labels": null, "name": "entity:i-424242:*", "namespace": "default"}, "reason": null, "subscription": "entity:i-424242"}]`

Авторы

Paul Arthur (@flowerysong)
Aljaz Kosir (@aljazkosir)
Manca Bizjak (@mancabizjak)
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/silence_info_module.html