Docs4dev
Docs
ansible / 2.4 / rax_meta_module.html

rax_meta - Manipulate metadata for Rackspace Cloud Servers

New in version 1.7.

Synopsis

  • Manipulate metadata for Rackspace Cloud Servers

Requirements (on host that executes module)

  • python >= 2.6
  • pyrax

Options

parameter required default choices comments
address
 no
Server IP address to modify metadata for, will match any IP assigned to the server
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
id
 no
Server ID to modify metadata for
identity_type
(added in 1.5)
no rackspace
Authentication mechanism to use, such as rackspace or keystone.
meta
 no
A hash of metadata to associate with the instance
name
 no
Server name to modify metadata for
region
 no DFW
Region to create an instance in.
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: 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

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_meta_module.html