community.general.rax_meta – Manipulate metadata for Rackspace Cloud Servers
community.general.rax_meta – Manipulate metadata for Rackspace Cloud Servers
Note
This plugin is part of the community.general collection (version 1.3.2).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.rax_meta
.
Synopsis
- Manipulate metadata for Rackspace Cloud Servers
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- pyrax
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
address string |
Server IP address to modify metadata for, will match any IP assigned to the server | |
api_key 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 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. | |
id string |
Server ID to modify metadata for | |
identity_type string |
Default: "rackspace" |
Authentication mechanism to use, such as rackspace or keystone. |
meta dictionary |
A hash of metadata to associate with the instance | |
name string |
Server name to modify metadata for | |
region string |
Region to create an instance in. | |
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 boolean |
|
Whether or not to require SSL validation of API endpoints.
|
Notes
Note
- The following environment variables can be used,
RAX_USERNAME
,RAX_API_KEY
,RAX_CREDS_FILE
,RAX_CREDENTIALS
,RAX_REGION
. RAX_CREDENTIALS
andRAX_CREDS_FILE
points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticatingRAX_USERNAME
andRAX_API_KEY
obviate the use of a credentials fileRAX_REGION
defines a Rackspace Public Cloud region (DFW, ORD, LON, …)
Examples
- name: Set metadata for a server
hosts: all
gather_facts: False
tasks:
- name: Set metadata
local_action:
module: rax_meta
credentials: ~/.raxpub
name: "{{ inventory_hostname }}"
region: DFW
meta:
group: primary_group
groups:
- group_two
- group_three
app: my_app
- name: Clear metadata
local_action:
module: rax_meta
credentials: ~/.raxpub
name: "{{ inventory_hostname }}"
region: DFW
Authors
- Matt Martz (@sivel)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/rax_meta_module.html