community.general.datadog_downtime – Управление простоями Datadog

Примечание

Этот плагин является частью коллекции community.general (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.general.

Чтобы использовать его в книге задач, укажите: community.general.datadog_downtime.

Новое в версии 2.0.0: из community.general

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

Обзор

Управляет простоями в Datadog.
Варианты, как описано на https://docs.datadoghq.com/api/v1/downtimes/s.

Требования

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

datadog-api-client
Python 3.6+

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_host строка	Значение по умолчанию: "https://api.datadoghq.com"	URL-адрес API Datadog. Это значение также можно задать с помощью переменной среды `DATADOG_HOST`.
api_key строка / обязательно		Ваш API-ключ Datadog.
app_key строка / обязательно		Ваш приложение ключ Datadog.
downtime_message строка		Сообщение для включения в уведомления об этом простое. Электронные уведомления могут быть отправлены определённым пользователям, используя тот же символ "@имя пользователя", что и для событий.
end целое число		Маркер временной метки POSIX для окончания простоя. Если не указано, простой действует до его отмены.
id целое число		Идентификатор простоя. Если пусто, создаётся новый простой, в противном случае он либо обновляется, либо удаляется в зависимости от `state`. Для сохранения идемпотентности книги задач необходимо сохранить идентификатор в файле и считать его с помощью поиска.
monitor_id целое число		Идентификатор монитора, который необходимо заглушить. Если не указано, простой применяется ко всем мониторам.
monitor_tags список / элементы=строка		Список тегов монитора, к которым применяется простой. Получившийся простой применяется к мониторам, которые соответствуют ВСЕМ предоставленным тегам монитора.
rrule строка		Стандарт `RRULE` для определения повторяющихся событий. Например, чтобы иметь повторяющееся событие в первый день каждого месяца, выберите тип rrule и установите `FREQ` на `MONTHLY` и `BYMONTHDAY` на `1`. Поддерживаются наиболее распространённые варианты rrule из спецификации iCalendar. Атрибуты, указывающие длительность в `RRULE`, не поддерживаются (например, `DTSTART`, `DTEND`, `DURATION`).
scope список / элементы=строка		Список областей, к которым применяется простой. Получившийся простой применяется к источникам, которые соответствуют ВСЕМ предоставленным областям.
start целое число		Маркер временной метки POSIX для начала простоя. Если не указано, простой начинается в момент его создания.
state строка	Варианты: present ← absent	Определённое состояние простоя.
timezone строка		Временная зона простоя.

Примеры

- name: Create a downtime
  register: downtime_var
  community.general.datadog_downtime:
    state: present
    monitor_tags:
      - "foo:bar"
    downtime_message: "Downtime for foo:bar"
    scope: "test"
    api_key: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    app_key: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    # Lookup the id in the file and ignore errors if the file doesn't exits, so downtime gets created
    id: "{{ lookup('file', inventory_hostname ~ '_downtime_id.txt', errors='ignore') }}"
- name: Save downtime id to file for later updates and idempotence
  delegate_to: localhost
  copy:
    content: "{{ downtime.downtime.id }}"
    dest: "{{ inventory_hostname ~ '_downtime_id.txt' }}"

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

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

Ключ	Возвращаемое значение	Описание
downtime словарь	всегда	Простой, возвращённый API. Пример: {'active': True, 'canceled': None, 'creator_id': 1445416, 'disabled': False, 'downtime_type': 2, 'end': None, 'id': 1055751000, 'message': 'Простой для foo:bar', 'monitor_id': None, 'monitor_tags': ['foo:bar'], 'parent_id': None, 'recurrence': None, 'scope': ['test'], 'start': 1607015009, 'timezone': 'UTC', 'updater_id': None}

Авторы

Datadog (@Datadog)

© 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/community/general/datadog_downtime_module.html