community.general.rax_cbs_attachments – Manipulate Rackspace Cloud Block Storage Volume Attachments

From Get docs
Ansible/docs/2.10/collections/community/general/rax cbs attachments module


community.general.rax_cbs_attachments – Manipulate Rackspace Cloud Block Storage Volume Attachments

Note

This plugin is part of the community.general collection (version 1.3.2).

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.rax_cbs_attachments.


Synopsis

  • Manipulate Rackspace Cloud Block Storage Volume Attachments

Requirements

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

  • python >= 2.6
  • pyrax

Parameters

Parameter Choices/Defaults Comments

api_key

string

Rackspace API key, overrides credentials.


aliases: password

auth_endpoint

string

The URI of the authentication service.

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

credentials

path

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


aliases: creds_file

device

string

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.

env

string

identity_type

string

Default:

"rackspace"

Authentication mechanism to use, such as rackspace or keystone.

region

string

Region to create an instance in.

server

string / required

Name or id of the server to attach/detach

state

string

  • present

  • absent

Indicate desired state of the resource

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

boolean

  • no
  • yes

Whether or not to require SSL validation of API endpoints.


aliases: verify_ssl

volume

string / required

Name or id of the volume to attach/detach

wait

boolean

  • no

  • yes

wait for the volume to be in 'in-use'/'available' state before returning

wait_timeout

integer

Default:

300

how long before wait gives up, in seconds



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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/rax_cbs_attachments_module.html