community.general.rax_meta – Manipulate metadata for Rackspace Cloud Servers

Note

This plugin is part of the community.general collection (version 1.3.6).

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.

aliases: password
auth_endpoint
string
The URI of the authentication service.
credentials
path
File to find the Rackspace credentials in. Ignored if api_key and username are provided.

aliases: creds_file
env
string
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
    Choices:
  • no
  • yes
Whether or not to require SSL validation of API endpoints.

aliases: verify_ssl

Notes

Note

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)