community.general.circonus_annotation – create an annotation in circonus¶
Note
This plugin is part of the community.general collection (version 2.5.1).
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¶
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:
Authors¶
Nick Harring (@NickatEpic)