community.general.rax_mon_notification_plan (6.6.8) — module

Install collection

Install with ansible-galaxy collection install community.general:==6.6.8

Add to requirements.yml

  collections:
    - name: community.general
      version: 6.6.8

Description

Create or delete a Rackspace Cloud Monitoring notification plan by associating existing rax_mon_notifications with severity levels. Rackspace monitoring module flow | rax_mon_entity -> rax_mon_check -> rax_mon_notification -> *rax_mon_notification_plan* -> rax_mon_alarm.

This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.

Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.

Requirements

• python >= 2.6
• pyrax

Usage examples

Scanned by Steampunk Spotter

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

- name: Example notification plan
  gather_facts: false
  hosts: local
  connection: local
  tasks:
  - name: Establish who gets called when.
    community.general.rax_mon_notification_plan:
      credentials: ~/.rax_pub
      state: present
      label: defcon1
      critical_state:
      - "{{ everyone['notification']['id'] }}"
      warning_state:
      - "{{ opsfloor['notification']['id'] }}"
    register: defcon1

Inputs

    
env:
    description:
    - Environment as configured in I(~/.pyrax.cfg), see U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration).
    type: str

label:
    description:
    - Defines a friendly name for this notification plan. String between 1 and 255 characters
      long.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Ensure that the notification plan with this C(label) exists or does not exist.
    type: str

region:
    description:
    - Region to create an instance in.
    type: str

api_key:
    aliases:
    - password
    description:
    - Rackspace API key, overrides I(credentials).
    type: str

ok_state:
    description:
    - Notification list to use when the alarm state is OK. Must be an array of valid rax_mon_notification
      ids.
    elements: str
    type: list

username:
    description:
    - Rackspace username, overrides I(credentials).
    type: str

tenant_id:
    description:
    - The tenant ID used for authentication.
    type: str

credentials:
    aliases:
    - creds_file
    description:
    - File to find the Rackspace credentials in. Ignored if I(api_key) and I(username)
      are provided.
    type: path

tenant_name:
    description:
    - The tenant name used for authentication.
    type: str

auth_endpoint:
    description:
    - The URI of the authentication service.
    - If not specified will be set to U(https://identity.api.rackspacecloud.com/v2.0/)
    type: str

identity_type:
    default: rackspace
    description:
    - Authentication mechanism to use, such as rackspace or keystone.
    type: str

warning_state:
    description:
    - Notification list to use when the alarm state is WARNING. Must be an array of valid
      rax_mon_notification ids.
    elements: str
    type: list

critical_state:
    description:
    - Notification list to use when the alarm state is CRITICAL. Must be an array of valid
      rax_mon_notification ids.
    elements: str
    type: list

validate_certs:
    aliases:
    - verify_ssl
    description:
    - Whether or not to require SSL validation of API endpoints.
    type: bool