rax_mon_entity - Create or delete a Rackspace Cloud Monitoring entity

New in version 2.0.

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 (on host that executes module)

python >= 2.6
pyrax

Options

parameter	required	default	choices	comments
agent_id	no			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	no			Rackspace API key, overrides credentials. aliases: password
auth_endpoint (added in 1.5)	no	https://identity.api.rackspacecloud.com/v2.0/		The URI of the authentication service.
credentials	no			File to find the Rackspace credentials in. Ignored if api_key and username are provided. aliases: creds_file
env (added in 1.5)	no			Environment as configured in ~/.pyrax.cfg, see https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration.
identity_type (added in 1.5)	no	rackspace		Authentication mechanism to use, such as rackspace or keystone.
label	yes			Defines a name for this entity. Must be a non-empty string between 1 and 255 characters long.
metadata	no			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	no			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	no	DFW		Region to create an instance in.
state	no		present absent	Ensure that an entity with this `name` exists or does not exist.
tenant_id (added in 1.5)	no			The tenant ID used for authentication.
tenant_name (added in 1.5)	no			The tenant name used for authentication.
username	no			Rackspace username, overrides credentials.
verify_ssl (added in 1.5)	no			Whether or not to require SSL validation of API endpoints.

Examples

- name: Entity example
  gather_facts: False
  hosts: local
  connection: local
  tasks:
  - name: Ensure an entity exists
    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

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, ...)

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/rax_mon_entity_module.html

Docs

Docs4dev

Title here