sensu.sensu_go.filter_info – Список информации Sensu
Примечание
Этот плагин входит в коллекцию sensu.sensu_go (версия 1.8.0).
Для его установки используйте: ansible-galaxy collection install sensu.sensu_go.
Для использования в плейбуке укажите: sensu.sensu_go.filter_info.
Новое в версии 1.0.0: из sensu.sensu_go
Обзор
- Получение информации о фильтрах Sensu.
- Дополнительную информацию можно найти в документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/filters/.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- 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. | |
| name строка | Получить информацию об этом конкретном объекте вместо перечисления всех объектов. | ||
| namespace строка | По умолчанию: "default" | Пространство имён RBAC для работы. Если не задан, используется значение переменной среды SENSU_NAMESPACE. | |
См. также
См. также
- sensu.sensu_go.filter
-
Официальная документация по модулю sensu.sensu_go.filter.
Примеры
- name: List all Sensu filters
sensu.sensu_go.filter_info:
register: result
- name: Retrieve a specific Sensu filter
sensu.sensu_go.filter_info:
name: my-filter
register: result
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| objects список / элементы=словарь | успех | Список фильтров Sensu. Пример: [{'action': 'allow', 'expressions': ['event.check.occurrences == 1'], 'metadata': {'name': 'filter_minimum', 'namespace': 'default'}}] |
Авторы
- Paul Arthur (@flowerysong)
- Aljaz Kosir (@aljazkosir)
- Miha Plesko (@miha-plesko)
- 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/filter_info_module.html