community.general.rax_cbs_attachments – Manipulate Rackspace Cloud Block Storage Volume Attachments
Note
This plugin is part of the community.general collection (version 3.8.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.rax_cbs_attachments
.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
pyrax
Parameters
Parameter |
Comments |
---|---|
Rackspace API key, overrides credentials. |
|
The URI of the authentication service. If not specified will be set to https://identity.api.rackspacecloud.com/v2.0/ |
|
File to find the Rackspace credentials in. Ignored if api_key and username are provided. |
|
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. |
|
Environment as configured in ~/.pyrax.cfg, see https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration. |
|
Authentication mechanism to use, such as rackspace or keystone. Default: “rackspace” |
|
Region to create an instance in. |
|
Name or id of the server to attach/detach |
|
Indicate desired state of the resource Choices:
|
|
The tenant ID used for authentication. |
|
The tenant name used for authentication. |
|
Rackspace username, overrides credentials. |
|
Whether or not to require SSL validation of API endpoints. Choices:
|
|
Name or id of the volume to attach/detach |
|
wait for the volume to be in ‘in-use’/’available’ state before returning Choices:
|
|
how long before wait gives up, in seconds Default: 300 |
Notes
Note
The following environment variables can be used,
RAX_USERNAME
,RAX_API_KEY
,RAX_CREDS_FILE
,RAX_CREDENTIALS
,RAX_REGION
.RAX_CREDENTIALS
andRAX_CREDS_FILE
points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticatingRAX_USERNAME
andRAX_API_KEY
obviate the use of a credentials fileRAX_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
Authors
Christopher H. Laco (@claco)
Matt Martz (@sivel)