Модуль community.general.circonus_annotation — создание аннотации в Circonus

Примечание

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

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

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

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

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

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

Создаёт событие-аннотацию с заданной категорией, заголовком и описанием. При необходимости можно указать время начала, окончания или длительность.

Требования

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

requests >= 2.0.0

Параметры

Параметр	Комментарии
api_key string / обязательный	Ключ API Circonus.
category string / обязательный	Категория аннотации.
description string / обязательный	Описание аннотации.
duration integer	Длительность аннотации в секундах. По умолчанию: `0`
start integer	Временная метка Unix начала события. Если не указано, по умолчанию используется «сейчас».
stop integer	Временная метка Unix окончания события. Если не указано, по умолчанию используется «сейчас» + `duration`.
title string / обязательный	Заголовок аннотации.

Атрибуты

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

Примеры

- name: Create a simple annotation event with a source, defaults to start and end time of now
  community.general.circonus_annotation:
    api_key: XXXXXXXXXXXXXXXXX
    title: App Config Change
    description: This is a detailed description of the config change
    category: This category groups like annotations

- name: Create an annotation with a duration of 5 minutes and a default start time of now
  community.general.circonus_annotation:
    api_key: XXXXXXXXXXXXXXXXX
    title: App Config Change
    description: This is a detailed description of the config change
    category: This category groups like annotations
    duration: 300

- name: Create an annotation with a start_time and end_time
  community.general.circonus_annotation:
    api_key: XXXXXXXXXXXXXXXXX
    title: App Config Change
    description: This is a detailed description of the config change
    category: This category groups like annotations
    start_time: 1395940006
    end_time: 1395954407

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

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

Ключ	Описание
annotation complex	Сведения о созданной аннотации. Возвращается: при успехе
_cid string	Идентификатор аннотации. Возвращается: при успехе Пример: `"/annotation/100000"`
_created integer	Временная метка создания. Возвращается: при успехе Пример: `1502236928`
_last_modified integer	Временная метка последнего изменения. Возвращается: при успехе Пример: `1502236928`
_last_modified_by string	Пользователь, последним изменивший запись. Возвращается: при успехе Пример: `"/user/1000"`
category string	Категория созданной аннотации. Возвращается: при успехе Пример: `"alerts"`
description string	Описание созданной аннотации. Возвращается: при успехе Пример: `"Host is down."`
rel_metrics list / elements=string	Массив метрик, связанных с этой аннотацией; каждая метрика представлена строкой. Возвращается: при успехе Пример: `["54321_kbps"]`
start integer	Временная метка начала действия аннотации. Возвращается: при успехе Пример: `"Host is down."`
stop string	Временная метка окончания действия аннотации. Возвращается: при успехе Пример: `"Host is down."`
title string	Заголовок созданной аннотации. Возвращается: при успехе Пример: `"WARNING"`

Авторы

Nick Harring (@NickatEpic)

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

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