community.general.rax_cbs module – Manipulate Rackspace Cloud Block Storage Volumes

Note

This module is part of the community.general collection (version 5.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. 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.

Synopsis

  • Manipulate Rackspace Cloud Block Storage Volumes

Requirements

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

  • python >= 2.6

  • pyrax

Parameters

Parameter

Comments

api_key

aliases: password

string

Rackspace API key, overrides credentials.

auth_endpoint

string

The URI of the authentication service.

If not specified will be set to https://identity.api.rackspacecloud.com/v2.0/

credentials

aliases: creds_file

path

File to find the Rackspace credentials in. Ignored if api_key and username are provided.

description

string

Description to give the volume being created.

env

string

Environment as configured in ~/.pyrax.cfg, see https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration.

identity_type

string

Authentication mechanism to use, such as rackspace or keystone.

Default: "rackspace"

image

string

Image to use for bootable volumes. Can be an id, human_id or name. This option requires pyrax>=1.9.3.

meta

dictionary

A hash of metadata to associate with the volume.

Default: {}

name

string / required

Name to give the volume being created.

region

string

Region to create an instance in.

size

integer

Size of the volume to create in Gigabytes.

Default: 100

snapshot_id

string

The id of the snapshot to create the volume from.

state

string

Indicate desired state of the resource.

Choices:

  • "present" ← (default)

  • "absent"

tenant_id

string

The tenant ID used for authentication.

tenant_name

string

The tenant name used for authentication.

username

string

Rackspace username, overrides credentials.

validate_certs

aliases: verify_ssl

boolean

Whether or not to require SSL validation of API endpoints.

Choices:

  • false

  • true

volume_type

string

Type of the volume being created.

Choices:

  • "SATA" ← (default)

  • "SSD"

wait

boolean

Wait for the volume to be in state available before returning.

Choices:

  • false ← (default)

  • true

wait_timeout

integer

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 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: 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

Authors

  • Christopher H. Laco (@claco)

  • Matt Martz (@sivel)