circonus_annotation - создание аннотации в circonus
Новое в версии 2.0.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Создайте событие аннотации с заданной категорией, заголовком и описанием. При необходимости можно указать начало, конец или продолжительность.
Требования (к хосту, на котором выполняется модуль)
- requests (либо >= 2.0.0 для Python 3, либо >= 1.0.0 для Python 2)
Параметры
| параметр | обязательно | значение по умолчанию | допустимые значения | комментарии |
|---|---|---|---|---|
| api_key | да | Ключ API Circonus | ||
| category | да | Категория аннотации | ||
| description | да | Описание аннотации | ||
| duration | нет | Продолжительность аннотации в секундах | ||
| start | нет | I(now) | Маркер Unix времени начала события | |
| stop | нет | I(now) + I(duration) | Маркер Unix времени окончания события | |
| title | да | Заголовок аннотации |
Примеры
# Create a simple annotation event with a source, defaults to start and end time of now
- 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
# Create an annotation with a duration of 5 minutes and a default start time of now
- 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
# Create an annotation with a start_time and end_time
- 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 | детали созданной аннотации | успех | сложный | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| содержит: |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Примечания
Примечание
- Режим проверки (check mode) не поддерживается.
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимый.
Для получения помощи в разработке модулей ознакомьтесь с информацией о сообществе и сотрудничестве, тестированием Ansible и разработкой модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/circonus_annotation_module.html