Модуль sensu.sensu_go.filter_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.filter_info.

Новая в sensu.sensu_go 1.0.0

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

Обзор

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

Требования

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

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

См. также

sensu.sensu_go.filter: Управление фильтрами Sensu.

Примеры

- 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/sensu/sensu_go/filter_info_module.html