community.general.rax_mon_entity module – Create or delete a Rackspace Cloud Monitoring entity

Note

This module is part of the community.general collection (version 4.8.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.rax_mon_entity.

Synopsis

  • Create or delete a Rackspace Cloud Monitoring entity, which represents a device to monitor. Entities associate checks and alarms with a target system and provide a convenient, centralized place to store IP addresses. Rackspace monitoring module flow | rax_mon_entity -> rax_mon_check -> rax_mon_notification -> rax_mon_notification_plan -> rax_mon_alarm

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6

  • pyrax

Parameters

Parameter

Comments

agent_id

string

Rackspace monitoring agent on the target device to which this entity is bound. Necessary to collect agent. rax_mon_checks against this entity.

api_key

aliases: password

string

Rackspace API key, overrides credentials.

auth_endpoint

string

The URI of the authentication service.

If not specified will be set to https://identity.api.rackspacecloud.com/v2.0/

credentials

aliases: creds_file

path

File to find the Rackspace credentials in. Ignored if api_key and username are provided.

env

string

Environment as configured in ~/.pyrax.cfg, see https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration.

identity_type

string

Authentication mechanism to use, such as rackspace or keystone.

Default: “rackspace”

label

string / required

Defines a name for this entity. Must be a non-empty string between 1 and 255 characters long.

metadata

dictionary

Hash of arbitrary name, value pairs that are passed to associated rax_mon_alarms. Names and values must all be between 1 and 255 characters long.

named_ip_addresses

dictionary

Hash of IP addresses that may be referenced by name by rax_mon_checks added to this entity. Must be a dictionary of with keys that are names between 1 and 64 characters long, and values that are valid IPv4 or IPv6 addresses.

region

string

Region to create an instance in.

state

string

Ensure that an entity with this name exists or does not exist.

Choices:

  • present ← (default)

  • absent

tenant_id

string

The tenant ID used for authentication.

tenant_name

string

The tenant name used for authentication.

username

string

Rackspace username, overrides credentials.

validate_certs

aliases: verify_ssl

boolean

Whether or not to require SSL validation of API endpoints.

Choices:

  • no

  • yes

Notes

Note

  • The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION.

  • RAX_CREDENTIALS and RAX_CREDS_FILE points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating

  • RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file

  • RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, …)

Examples

- name: Entity example
  gather_facts: False
  hosts: local
  connection: local
  tasks:
  - name: Ensure an entity exists
    community.general.rax_mon_entity:
      credentials: ~/.rax_pub
      state: present
      label: my_entity
      named_ip_addresses:
        web_box: 192.0.2.4
        db_box: 192.0.2.5
      meta:
        hurf: durf
    register: the_entity

Authors

  • Ash Wilson (@smashwilson)