The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| address - | Server IP address to modify metadata for, will match any IP assigned to the server | |
| api_key - | Rackspace API key, overrides credentials. aliases: password | |
| auth_endpoint - | 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 - | Environment as configured in ~/.pyrax.cfg, see https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration. | |
| id - | Server ID to modify metadata for | |
| identity_type - | Default: "rackspace" | Authentication mechanism to use, such as rackspace or keystone. |
| meta - | A hash of metadata to associate with the instance | |
| name - | Server name to modify metadata for | |
| region - | Default: "DFW" | Region to create an instance in. |
| tenant_id - | The tenant ID used for authentication. | |
| tenant_name - | The tenant name used for authentication. | |
| username - | Rackspace username, overrides credentials. | |
| validate_certs boolean |
| Whether or not to require SSL validation of API endpoints. aliases: verify_ssl |
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: 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
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/rax_meta_module.html