rax_cbs_attachments - Manipulate Rackspace Cloud Block Storage Volume Attachments

Author:Christopher H. Laco, Matt Martz

Synopsis

New in version 1.6.

Manipulate Rackspace Cloud Block Storage Volume Attachments

Options

parameter	required	default	choices	comments
api_key	no			Rackspace API key (overrides credentials)
auth_endpoint	no	https://identity.api.rackspacecloud.com/v2.0/		The URI of the authentication service (added in Ansible 1.5)
credentials	no			File to find the Rackspace credentials in (ignored if api_key and username are provided)
device	yes			The device path to attach the volume to, e.g. /dev/xvde
env	no			Environment as configured in ~/.pyrax.cfg, see https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration (added in Ansible 1.5)
identity_type	no	rackspace		Authentication machanism to use, such as rackspace or keystone (added in Ansible 1.5)
region	no	DFW		Region to create an instance in
server	yes			Name or id of the server to attach/detach
state	yes	present	present absent	Indicate desired state of the resource
tenant_id	no			The tenant ID used for authentication (added in Ansible 1.5)
tenant_name	no			The tenant name used for authentication (added in Ansible 1.5)
username	no			Rackspace username (overrides credentials)
verify_ssl	no			Whether or not to require SSL validation of API endpoints (added in Ansible 1.5)
volume	yes			Name or id of the volume to attach/detach
wait	no	no	yes no	wait for the volume to be in 'in-use'/'available' state before returning
wait_timeout	no	300		how long before wait gives up, in seconds

Note

Requires pyrax

Examples

- name: Attach a Block Storage Volume
  gather_facts: False
  hosts: local
  connection: local
  tasks:
    - name: Storage volume attach request
      local_action:
        module: rax_cbs_attachments
        credentials: ~/.raxpub
        volume: my-volume
        server: my-server
        device: /dev/xvdd
        region: DFW
        wait: yes
        state: present
      register: my_volume

Note

The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION.

Note

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

Note

RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file

Note

RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, ...)