circonus_annotation – create an annotation in circonus¶
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¶
# 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
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Nick Harring (@NickatEpic)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.