New in version 2.0.
- python = 2.7
- requests >= 2.5.0
- clc-sdk
parameter | required | default | choices | comments |
---|---|---|---|---|
alert_recipients |
no | None | A list of recipient email ids to notify the alert. This is required for state 'present' | |
alias |
yes | The alias of your CLC Account | ||
duration |
no | None | The length of time in minutes that the condition must exceed the threshold. This is required for state 'present' | |
id |
no | None | The alert policy id. This is mutually exclusive with name | |
metric |
no | None |
|
The metric on which to measure the condition that will trigger the alert. This is required for state 'present' |
name |
no | None | The name of the alert policy. This is mutually exclusive with id | |
state |
no | present |
|
Whether to create or delete the policy. |
threshold |
no | None | The threshold that will trigger the alert when the metric equals or exceeds it. This is required for state 'present' This number represents a percentage and must be a value between 5.0 - 95.0 that is a multiple of 5.0 |
# Note - You must set the CLC_V2_API_USERNAME And CLC_V2_API_PASSWD Environment variables before running these examples --- - name: Create Alert Policy Example hosts: localhost gather_facts: False connection: local tasks: - name: Create an Alert Policy for disk above 80% for 5 minutes clc_alert_policy: alias: wfad name: 'alert for disk > 80%' alert_recipients: - test1@centurylink.com - test2@centurylink.com metric: 'disk' duration: '00:05:00' threshold: 80 state: present register: policy - name: debug debug: var=policy --- - name: Delete Alert Policy Example hosts: localhost gather_facts: False connection: local tasks: - name: Delete an Alert Policy clc_alert_policy: alias: wfad name: 'alert for disk > 80%' state: absent register: policy - name: debug debug: var=policy
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
policy | The alert policy information | success | dict | {'name': 'test_alert', 'actions': [{'action': 'email', 'settings': {'recipients': ['user1@domain.com', 'user1@domain.com']}}], 'id': 'ba54ac54a60d4a4f1ed6d48c1ce240a7', 'links': [{'href': '/v2/alertPolicies/alias/ba54ac54a60d4a4fb1d6d48c1ce240a7', 'verbs': ['GET', 'DELETE', 'PUT'], 'rel': 'self'}], 'triggers': [{'duration': '00:05:00', 'threshold': 80.0, 'metric': 'disk'}]} |
Note
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is community maintained without core committer oversight.
For more information on what this means please read Module Support
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.