community.general.circonus_annotation – создание аннотации в circonus
Примечание
Этот плагин является частью коллекции community.general (версия 2.0.1).
Для его установки используйте: 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 начала события Если не указано, по умолчанию используется текущее время. | |
| stop целое число | Маркер времени Unix окончания события Если не указано, по умолчанию используется текущее время + продолжительность. | |
| title строка / обязательно | Название аннотации |
Примечания
Примечание
- Режим проверки (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 сложный | успех | детали созданной аннотации | |
| _cid строка | успех | идентификатор аннотации Пример: /annotation/100000 | |
| _created целое число | успех | маркер времени создания Пример: 1502236928 | |
| _last_modified целое число | успех | маркер времени последнего изменения Пример: 1502236928 | |
| _last_modified_by строка | успех | идентификатор пользователя, выполнившего последнее изменение Пример: /user/1000 | |
| category строка | успех | категория созданной аннотации Пример: alerts | |
| description строка | успех | описание созданной аннотации Пример: Хост не работает. | |
| rel_metrics список / элементы=строка | успех | Массив метрик, связанных с данной аннотацией, каждая метрика — строка. Пример: ['54321_kbps'] | |
| start целое число | успех | маркер времени, начиная с которого действует аннотация Пример: Хост не работает. | |
| stop строка | успех | маркер времени, до которого действует аннотация Пример: Хост не работает. | |
| title строка | успех | заголовок созданной аннотации Пример: ПРЕДУПРЕЖДЕНИЕ | |
Авторы
- Nick Harring (@NickatEpic)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/circonus_annotation_module.html
