New in version 2.0.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
agent_id | 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 | Rackspace API key, overrides credentials. aliases: password | |
auth_endpoint (added in 1.5) | Default: https://identity.api.rackspacecloud.com/v2.0/ | The URI of the authentication service. |
credentials | File to find the Rackspace credentials in. Ignored if api_key and username are provided. aliases: creds_file | |
env (added in 1.5) | 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) | Default: rackspace | Authentication mechanism to use, such as rackspace or keystone. |
label required | Defines a name for this entity. Must be a non-empty string between 1 and 255 characters long. | |
metadata | 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 | 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 | Default: DFW | Region to create an instance in. |
state |
| Ensure that an entity with this name exists or does not exist. |
tenant_id (added in 1.5) | The tenant ID used for authentication. | |
tenant_name (added in 1.5) | The tenant name used for authentication. | |
username | Rackspace username, overrides credentials. | |
verify_ssl (added in 1.5) | Whether or not to require SSL validation of API endpoints. |
Note
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 fileRAX_REGION
defines a Rackspace Public Cloud region (DFW, ORD, LON, ...)- 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
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/rax_mon_entity_module.html