community.general.rax_cbs module – Manipulate Rackspace Cloud Block Storage Volumes
Note
This module is part of the community.general collection (version 8.6.4).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.rax_cbs
.
DEPRECATED
- Removed in:
version 9.0.0
- Why:
This module relies on the deprecated package pyrax.
- Alternative:
Use the Openstack modules instead.
Synopsis
Manipulate Rackspace Cloud Block Storage Volumes
Aliases: cloud.rackspace.rax_cbs
Requirements
The below requirements are needed on the host that executes this module.
pyrax
Parameters
Parameter |
Comments |
---|---|
Rackspace API key, overrides |
|
The URI of the authentication service. If not specified will be set to https://identity.api.rackspacecloud.com/v2.0/. |
|
Description to give the volume being created. |
|
Environment as configured in |
|
Authentication mechanism to use, such as rackspace or keystone. Default: |
|
Image to use for bootable volumes. Can be an |
|
A hash of metadata to associate with the volume. Default: |
|
Name to give the volume being created. |
|
Region to create an instance in. |
|
Size of the volume to create in Gigabytes. Default: |
|
The id of the snapshot to create the volume from. |
|
Indicate desired state of the resource. Choices:
|
|
The tenant ID used for authentication. |
|
The tenant name used for authentication. |
|
Rackspace username, overrides |
|
Whether or not to require SSL validation of API endpoints. Choices:
|
|
Type of the volume being created. Choices:
|
|
Wait for the volume to be in state Choices:
|
|
how long before wait gives up, in seconds. Default: |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
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#authenticating.RAX_USERNAME
andRAX_API_KEY
obviate the use of a credentials file.RAX_REGION
defines a Rackspace Public Cloud region (DFW, ORD, LON, …).
Examples
- name: Build a Block Storage Volume
gather_facts: false
hosts: local
connection: local
tasks:
- name: Storage volume create request
local_action:
module: rax_cbs
credentials: ~/.raxpub
name: my-volume
description: My Volume
volume_type: SSD
size: 150
region: DFW
wait: true
state: present
meta:
app: my-cool-app
register: my_volume
Status
This module will be removed in version 9.0.0. [deprecated]
For more information see DEPRECATED.