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

Примечание

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

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

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

Для использования в playbook, укажите: 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`. Чтобы ваш playbook оставался идемпотентным, следует сохранить идентификатор в файле и прочитать его с помощью 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	Поддержка: нет	Возвращает подробную информацию о том, что изменилось (или, возможно, должно измениться в `check_mode`), в режиме diff.

Примеры

- 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/datadog_downtime_module.html