W3cubDocs

/Ansible 2.9

rax_cbs_attachments – Manipulate Rackspace Cloud Block Storage Volume Attachments

Synopsis
Requirements
Parameters
Notes
Examples
Status

Synopsis

Manipulate Rackspace Cloud Block Storage Volume Attachments

Requirements

The below requirements are needed on the host that executes this module.

python >= 2.6
pyrax

Parameters

Parameter	Choices/Defaults	Comments
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
device -		The device path to attach the volume to, e.g. /dev/xvde. Before 2.4 this was a required field. Now it can be left to null to auto assign the device name.
env -		Environment as configured in ~/.pyrax.cfg, see https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration.
identity_type -	Default: "rackspace"	Authentication mechanism to use, such as rackspace or keystone.
region -	Default: "DFW"	Region to create an instance in.
server - / required		Name or id of the server to attach/detach
state - / required	Choices: present ← absent	Indicate desired state of the resource
tenant_id -		The tenant ID used for authentication.
tenant_name -		The tenant name used for authentication.
username -		Rackspace username, overrides credentials.
validate_certs boolean	Choices: no yes	Whether or not to require SSL validation of API endpoints. aliases: verify_ssl
volume - / required		Name or id of the volume to attach/detach
wait boolean	Choices: no ← yes	wait for the volume to be in 'in-use'/'available' state before returning
wait_timeout -	Default: 300	how long before wait gives up, in seconds

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, …)

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

Status

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors

Christopher H. Laco (@claco)
Matt Martz (@sivel)

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