community.general.rax_cbs_attachments (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 Volume Attachments

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: 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: true
        state: present
      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

wait:
    default: false
    description:
    - wait for the volume to be in 'in-use'/'available' state before returning
    type: bool

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

device:
    description:
    - 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.
    type: str

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

server:
    description:
    - Name or id of the server to attach/detach
    required: true
    type: str

volume:
    description:
    - Name or id of the volume to attach/detach
    required: true
    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

tenant_name:
    description:
    - The tenant name used for authentication.
    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