Модуль community.grafana.grafana_silence — управление подавлениями Grafana

Примечание

Этот модуль входит в коллекцию community.grafana (версия 2.3.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: community.grafana.grafana_silence.

Добавлено в community.grafana 1.9.0

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

Обзор

Создание и удаление подавлений Grafana с помощью API подавлений Alertmanager.

Требования

На узле, где выполняется этот модуль, должны быть соблюдены следующие требования.

API Alertmanager доступен только начиная с Grafana 8. Модуль завершится с ошибкой, если версия сервера ниже 8.

Параметры

Параметр	Комментарии
client_cert путь	Файл цепочки сертификатов в формате PEM, используемый для аутентификации SSL-клиента. Этот файл также может содержать ключ. Если ключ включен в файл, параметр client_key не требуется.
client_key путь	Файл в формате PEM, содержащий закрытый ключ для аутентификации SSL-клиента. Если параметр client_cert содержит и сертификат, и ключ, этот параметр не требуется.
comment строка / обязательный	Комментарий с описанием подавления.
created_by строка / обязательный	Автор, создавший подавление.
ends_at строка / обязательный	Метка времени в формате ISO 8601 с миллисекундами, например «2029-07-29T08:45:45.000Z», указывающая время окончания подавления.
grafana_api_key строка	Ключ API Grafana. Если задан, параметры `url_username` и `url_password` будут игнорироваться.
matchers список / элементы=словарь / обязательный	Список сопоставителей для выбора оповещений, на которые распространяется подавление.
org_id целое число	Идентификатор организации Grafana, в которой будет создано или удалено подавление. Не используется, если задан параметр grafana_api_key, поскольку ключ grafana_api_key относится только к одной организации. Не может использоваться одновременно с `org_name`. По умолчанию: `1`
org_name строка	Название организации Grafana, в которой будет создано или удалено подавление. Не используется, если задан параметр grafana_api_key, поскольку ключ grafana_api_key относится только к одной организации. Не может использоваться одновременно с `org_id`.
skip_version_check логическое значение	Пропустить проверку версии Grafana и в любом случае попытаться обратиться к конечной точке API. Этот параметр может быть полезен, если в grafana.ini включен параметр `hide_version`. Варианты: `false` ← (по умолчанию) `true`
starts_at строка / обязательный	Метка времени в формате ISO 8601 с миллисекундами, например «2029-07-29T08:45:45.000Z», указывающая время начала подавления.
state строка	Удалить первое подавление с такими же настройками. Допустимые значения: «absent» или «present». Варианты: `"present"` ← (по умолчанию) `"absent"`
url псевдонимы: grafana_url строка / обязательный	URL Grafana.
url_password псевдонимы: grafana_password строка	Пароль Grafana для аутентификации через API. По умолчанию: `"admin"`
url_username псевдонимы: grafana_user строка	Пользователь Grafana для аутентификации через API. По умолчанию: `"admin"`
use_proxy логическое значение	Если `false`, прокси использоваться не будет, даже если он задан в переменной окружения на целевых узлах. Варианты: `false` `true` ← (по умолчанию)
validate_certs логическое значение	Если `false`, сертификаты SSL проверяться не будут. Устанавливайте это значение в `false` только для сайтов под вашим контролем, использующих самоподписанные сертификаты. Варианты: `false` `true` ← (по умолчанию)

Примеры

---
- name: Create a silence
  community.grafana.grafana_silence:
    grafana_url: "https://grafana.example.com"
    grafana_api_key: "{{ some_api_token_value }}"
    comment: "a testcomment"
    created_by: "me"
    starts_at: "2029-07-29T08:45:45.000Z"
    ends_at: "2029-07-29T08:55:45.000Z"
    matchers:
      - isEqual: true
        isRegex: true
        name: environment
        value: test
    state: present

- name: Delete a silence
  community.grafana.grafana_silence:
    grafana_url: "https://grafana.example.com"
    grafana_api_key: "{{ some_api_token_value }}"
    comment: "a testcomment"
    created_by: "me"
    starts_at: "2029-07-29T08:45:45.000Z"
    ends_at: "2029-07-29T08:55:45.000Z"
    matchers:
      - isEqual: true
        isRegex: true
        name: environment
        value: test
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
silence сложный тип	Информация о подавлении Возвращается: при успешном выполнении
comment строка	Комментарий к подавлению Возвращается: при успешном выполнении Пример: `"['this is a test']"`
createdBy строка	Автор подавления Возвращается: при успешном выполнении Пример: `"['me']"`
endsAt строка	Метка времени окончания подавления Возвращается: при успешном выполнении Пример: `"['2029-07-29T08:55:45.000Z']"`
id строка	Идентификатор подавления Возвращается: при успешном выполнении Пример: `"['ec27df6b-ac3c-412f-ae0b-6e3e1f41c9c3']"`
matchers список / элементы=строка	Сопоставители подавления Возвращается: при успешном выполнении Пример: `[[{"isEqual": true, "isRegex": true, "name": "environment", "value": "test"}]]`
startsAt строка	Метка времени начала подавления Возвращается: при успешном выполнении Пример: `"['2029-07-29T08:45:45.000Z']"`
status словарь	Состояние подавления Возвращается: при успешном выполнении Пример: `[{"state": "pending"}]`
updatedAt строка	Метка времени последнего обновления подавления Возвращается: при успешном выполнении Пример: `"['2023-07-27T13:27:33.042Z']"`

Авторы

flkhndlr (@flkhndlr)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/grafana/grafana_silence_module.html