clc_alert_policy - Create or Delete Alert Policies at CenturyLink Cloud.

New in version 2.0.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
Notes
This is an Extras Module

Synopsis

An Ansible module to Create or Delete Alert Policies at CenturyLink Cloud.

Requirements (on host that executes module)

python = 2.7

requests >= 2.5.0

clc-sdk

Options

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	cpu memory disk	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	present absent	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

Examples

# 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

Return Values

Common return values are documented here Common 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'}]}
changed	A flag indicating if any change was made or not	success	boolean	True

Notes

Note

To use this module, it is required to set the below environment variables which enables access to the Centurylink Cloud - CLC_V2_API_USERNAME, the account login id for the centurylink cloud - CLC_V2_API_PASSWORD, the account password for the centurylink cloud

Note

Alternatively, the module accepts the API token and account alias. The API token can be generated using the CLC account login and password via the HTTP api call @ https://api.ctl.io/v2/authentication/login - CLC_V2_API_TOKEN, the API token generated from https://api.ctl.io/v2/authentication/login - CLC_ACCT_ALIAS, the account alias associated with the centurylink cloud

Note

Users can set CLC_V2_API_URL to specify an endpoint for pointing to a different CLC environment.

This is an Extras Module

For more information on what this means please read Extras Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.