Модуль community.general.datadog_downtime — управление периодами отключения уведомлений Datadog

Примечание

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

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

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

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

Добавлено в community.general 2.0.0

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

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

Управляет периодами отключения уведомлений в Datadog.
Параметры описаны на странице https://docs.datadoghq.com/api/v1/downtimes/.

Требования

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

datadog-api-client
Python 3.6+

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Может работать в режиме `check_mode` и возвращать прогнозируемый статус изменений, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме diff возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).

Примеры

- 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": null, "creator_id": 1445416, "disabled": false, "downtime_type": 2, "end": null, "id": 1055751000, "message": "Downtime for foo:bar", "monitor_id": null, "monitor_tags": ["foo:bar"], "parent_id": null, "recurrence": null, "scope": ["test"], "start": 1607015009, "timezone": "UTC", "updater_id": null}`

Ключ

Описание

downtime

словарь

Период отключения, возвращенный API.

Возвращается: всегда

Пример: {"active": true, "canceled": null, "creator_id": 1445416, "disabled": false, "downtime_type": 2, "end": null, "id": 1055751000, "message": "Downtime for foo:bar", "monitor_id": null, "monitor_tags": ["foo:bar"], "parent_id": null, "recurrence": null, "scope": ["test"], "start": 1607015009, "timezone": "UTC", "updater_id": null}

Авторы

Datadog (@Datadog)

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

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