community.general.circonus_annotation – create an annotation in circonus
community.general.circonus_annotation – create an annotation in circonus
Note
This plugin is part of the community.general collection (version 1.3.2).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.circonus_annotation
.
Synopsis
- Create an annotation event with a given category, title and description. Optionally start, end or durations can be provided
Requirements
The below requirements are needed on the host that executes this module.
- requests (either >= 2.0.0 for Python 3, or >= 1.0.0 for Python 2)
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
api_key string / required |
Circonus API key | |
category string / required |
Annotation Category | |
description string / required |
Description of annotation | |
duration integer |
Default: 0 |
Duration in seconds of annotation |
start integer |
Unix timestamp of event start If not specified, it defaults to now. | |
stop integer |
Unix timestamp of event end If not specified, it defaults to now + duration. | |
title string / required |
Title of annotation |
Notes
Note
- Check mode isn’t supported.
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
annotation complex |
success |
details about the created annotation
| |
_cid string |
success |
annotation identifier
Sample: /annotation/100000 | |
_created integer |
success |
creation timestamp
Sample: 1502236928 | |
_last_modified integer |
success |
last modification timestamp
Sample: 1502236928 | |
_last_modified_by string |
success |
last modified by
Sample: /user/1000 | |
category string |
success |
category of the created annotation
Sample: alerts | |
description string |
success |
description of the created annotation
Sample: Host is down. | |
rel_metrics list / elements=string |
success |
Array of metrics related to this annotation, each metrics is a string.
Sample: ['54321_kbps'] | |
start integer |
success |
timestamp, since annotation applies
Sample: Host is down. | |
stop string |
success |
timestamp, since annotation ends
Sample: Host is down. | |
title string |
success |
title of the created annotation
Sample: WARNING |
Authors
- Nick Harring (@NickatEpic)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/circonus_annotation_module.html