sensu.sensu_go.filter модуль — Управление фильтрами 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.
Добавлен в sensu.sensu_go 1.0.0
Обзор
- Создание, обновление или удаление фильтра Sensu.
- Для получения дополнительной информации обратитесь к документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/filters/.
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.
- python >= 2.7
Параметры
Параметр | Комментарии |
|---|---|
action строка | Действие, которое должно быть выполнено с событием, если выражения фильтра совпадают. Требуется, если state равно Варианты:
|
annotations словарь | Пользовательские метаданные с меньшими ограничениями, в виде пар ключ/значение. Эти метаданные сохраняются Sensu, но недоступны как токены или идентификаторы и предназначены в основном для использования с внешними инструментами. Значение по умолчанию: |
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. Значение по умолчанию: |
|
url строка |
Расположение API бэкенда Sensu. Если он не задан, проверяется значение переменной среды SENSU_URL. Значение по умолчанию: |
|
user строка |
Имя пользователя для подключения к API Sensu. Если оно не задано, проверяется значение переменной среды SENSU_USER. Этот параметр игнорируется, если задан параметр auth.api_key. Значение по умолчанию: |
|
verify логическое добавлен в sensu.sensu_go 1.5.0 |
Флаг, контролирующий валидацию сертификата. Если вы используете самозаверяющие сертификаты, вы можете установить этот параметр в Используйте этот параметр ТОЛЬКО в сценариях разработки! Если вы используете самозаверяющие сертификаты в производстве, обратитесь к параметру auth.ca_path. Также можно задать этот параметр через переменную среды SENSU_VERIFY. Варианты:
|
expressions список / элементы=строка | Выражения фильтра, которые нужно сравнить с данными события. Требуется, если state равно |
labels словарь | Пользовательские поля метаданных, к которым можно получить доступ в Sensu, в виде пар ключ/значение. Значение по умолчанию: |
name строка / обязательно | Имя ресурса Sensu. Это имя (в сочетании с пространством имен, где это применимо) однозначно идентифицирует ресурс, на котором Ansible выполняет операции. Если ресурс с выбранным именем уже существует, Ansible модуль обновит его в соответствии со спецификацией в задаче. Для получения дополнительной информации о допустимых именах и других ограничениях см. спецификацию атрибута метаданных name в документации upstream по адресу https://docs.sensu.io/sensu-go/latest/reference/ |
namespace строка | Пространство имен RBAC для работы. Если оно не задано, используется значение переменной среды SENSU_NAMESPACE. Значение по умолчанию: |
runtime_assets список / элементы=строка | Активности, которые должны быть применены к контексту выполнения фильтра. JavaScript-файлы в каталоге lib актива будут оценены. |
state строка | Целевое состояние объекта Sensu. Варианты:
|
См. также
См. также
- sensu.sensu_go.filter_info
-
Список информации о Sensu.
Примеры
- name: Create a filter
sensu.sensu_go.filter:
name: filter
action: deny
expressions:
- event.check.interval == 10
- event.check.occurrences == 1
runtime_assets: awesomeness
- name: Create a production filter
sensu.sensu_go.filter:
name: filter
action: allow
expressions:
- event.entity.labels['environment'] == 'production'
- name: Create a filter with JS expression
sensu.sensu_go.filter:
name: filter
action: deny
expressions:
- "_.reduce(event.check.history, function(memo, h) { return (memo || h.status != 0); })"
runtime_assets:
- underscore
- name: Handling repeated events
sensu.sensu_go.filter:
name: filter_interval_60_hourly
action: allow
expressions:
- event.check.interval == 60
- event.check.occurrences == 1 || event.check.occurrences % 60 == 0
- name: Delete a filter
sensu.sensu_go.filter:
name: filter_interval_60_hourly
state: absent
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
Ключ | Описание |
|---|---|
object словарь | Объект, представляющий фильтр Sensu. Возвращено: успех Пример: |
Ссылки на коллекцию
© 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_module.html