New in version 1.6.
- python >= 2.6
- pyrax
parameter | required | default | choices | comments |
---|---|---|---|---|
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 | ||
device |
yes | The device path to attach the volume to, e.g. /dev/xvde | ||
env (added in 1.5) |
no | Environment as configured in ~/.pyrax.cfg, see https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration. | ||
identity_type (added in 1.5) |
no | rackspace | Authentication mechanism to use, such as rackspace or keystone. | |
region |
no | DFW | Region to create an instance in. | |
server |
yes | Name or id of the server to attach/detach | ||
state |
yes | present |
|
Indicate desired state of the resource |
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. | ||
volume |
yes | Name or id of the volume to attach/detach | ||
wait |
no | 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 |
- 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
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#authenticatingRAX_USERNAME
and RAX_API_KEY
obviate the use of a credentials fileRAX_REGION
defines a Rackspace Public Cloud region (DFW, ORD, LON, ...)This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is community maintained without core committer oversight.
For more information on what this means please read Module Support
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.