ansible.builtin.clc_alert_policy (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

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

Requirements

• python = 2.7
• requests >= 2.5.0
• clc-sdk

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# 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

Inputs

    
id:
    description:
    - The alert policy id. This is mutually exclusive with name

name:
    description:
    - The name of the alert policy. This is mutually exclusive with id

alias:
    description:
    - The alias of your CLC Account
    required: true

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether to create or delete the policy.

metric:
    choices:
    - cpu
    - memory
    - disk
    description:
    - The metric on which to measure the condition that will trigger the alert. This is
      required for state 'present'

duration:
    description:
    - The length of time in minutes that the condition must exceed the threshold. This
      is required for state 'present'

threshold:
    description:
    - 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

alert_recipients:
    description:
    - A list of recipient email ids to notify the alert. This is required for state 'present'

Outputs

policy:
  description: The alert policy information
  returned: success
  sample:
    actions:
    - action: email
      settings:
        recipients:
        - user1@domain.com
        - user1@domain.com
    id: ba54ac54a60d4a4f1ed6d48c1ce240a7
    links:
    - href: /v2/alertPolicies/alias/ba54ac54a60d4a4fb1d6d48c1ce240a7
      rel: self
      verbs:
      - GET
      - DELETE
      - PUT
    name: test_alert
    triggers:
    - duration: 00:05:00
      metric: disk
      threshold: 80.0
  type: dict