Модуль community.general.circonus_annotation – Создание аннотации в circonus

Примечание

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

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

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

Для использования в плейбуке укажите: community.general.circonus_annotation.

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

Описание

Создайте событие аннотации с заданной категорией, заголовком и описанием. Дополнительно можно указать начало, конец или продолжительность.

Требования

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

requests (либо >= 2.0.0 для Python 3, либо >= 1.0.0 для Python 2)

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Может работать в режиме `check_mode` и возвращать прогнозируемый результат изменения статуса без модификации целевого объекта.
diff_mode	Поддержка: нет	Возвращает подробную информацию о том, что изменилось (или, возможно, должно измениться в `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

END_OF_DOCUMENT_MARKER

Значения возврата

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

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

Авторы

Ник Харринг (@NickatEpic)

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

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