Модуль community.grafana.grafana_silence – Управление отключениями Grafana

Примечание

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

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

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

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

Новое в community.grafana 1.8.0

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

Краткое описание

Создание/удаление отключений Grafana через API Alertmanager Silence.

Требования

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

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 список / элементы=словарь / обязательно	Список сопоставителей для выбора предупреждений, на которые влияет отключение.
skip_version_check логическое	Пропустить проверку версии Grafana и попытаться связаться с конечной точкой API в любом случае. Этот параметр может быть полезен, если вы включили `hide_version` в grafana.ini Варианты: `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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/grafana/grafana_silence_module.html