community.general.rax_cbs (6.6.8) — module

Install collection

Install with ansible-galaxy collection install community.general:==6.6.8

Add to requirements.yml

  collections:
    - name: community.general
      version: 6.6.8

Description

Manipulate Rackspace Cloud Block Storage Volumes

This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.

Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.

Requirements

• python >= 2.6
• pyrax

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
env:
    description:
    - Environment as configured in I(~/.pyrax.cfg), see U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration).
    type: str

meta:
    default: {}
    description:
    - A hash of metadata to associate with the volume.
    type: dict

name:
    description:
    - Name to give the volume being created.
    required: true
    type: str

size:
    default: 100
    description:
    - Size of the volume to create in Gigabytes.
    type: int

wait:
    default: false
    description:
    - Wait for the volume to be in state C(available) before returning.
    type: bool

image:
    description:
    - Image to use for bootable volumes. Can be an C(id), C(human_id) or C(name). This
      option requires C(pyrax>=1.9.3).
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Indicate desired state of the resource.
    type: str

region:
    description:
    - Region to create an instance in.
    type: str

api_key:
    aliases:
    - password
    description:
    - Rackspace API key, overrides I(credentials).
    type: str

username:
    description:
    - Rackspace username, overrides I(credentials).
    type: str

tenant_id:
    description:
    - The tenant ID used for authentication.
    type: str

credentials:
    aliases:
    - creds_file
    description:
    - File to find the Rackspace credentials in. Ignored if I(api_key) and I(username)
      are provided.
    type: path

description:
    description:
    - Description to give the volume being created.
    type: str

snapshot_id:
    description:
    - The id of the snapshot to create the volume from.
    type: str

tenant_name:
    description:
    - The tenant name used for authentication.
    type: str

volume_type:
    choices:
    - SATA
    - SSD
    default: SATA
    description:
    - Type of the volume being created.
    type: str

wait_timeout:
    default: 300
    description:
    - how long before wait gives up, in seconds.
    type: int

auth_endpoint:
    description:
    - The URI of the authentication service.
    - If not specified will be set to U(https://identity.api.rackspacecloud.com/v2.0/)
    type: str

identity_type:
    default: rackspace
    description:
    - Authentication mechanism to use, such as rackspace or keystone.
    type: str

validate_certs:
    aliases:
    - verify_ssl
    description:
    - Whether or not to require SSL validation of API endpoints.
    type: bool