Documentation

rax_cbs - Manipulate Rackspace Cloud Block Storage Volumes

New in version 1.6.

Synopsis

Manipulate Rackspace Cloud Block Storage Volumes

Requirements (on host that executes module)

  • python >= 2.6
  • pyrax

Options

parameter required default choices comments
api_key
 no
    Rackspace API key (overrides credentials)

    aliases: password
    auth_endpoint
    (added in 1.5)
    		 no https://identity.api.rackspacecloud.com/v2.0/
      The URI of the authentication service
      credentials
      		 no
        File to find the Rackspace credentials in (ignored if api_key and username are provided)

        aliases: creds_file
        description
        		 no
          Description to give the volume being created
          env
          (added in 1.5)
          		 no
            identity_type
            (added in 1.5)
            		 no rackspace
              Authentication machanism to use, such as rackspace or keystone
              image
              (added in 1.9)
              		 no
                image to use for bootable volumes. Can be an id, human_id or name. This option requires pyrax>=1.9.3
                meta
                		 no
                  A hash of metadata to associate with the volume
                  name
                  		 yes
                    Name to give the volume being created
                    region
                    		 no DFW
                      Region to create an instance in
                      size
                      		 yes 100
                        Size of the volume to create in Gigabytes
                        snapshot_id
                        		 no
                          The id of the snapshot to create the volume from
                          state
                          		 yes present
                          • present
                          • absent
                          Indicate desired state of the resource
                          tenant_id
                          (added in 1.5)
                          		 no
                            The tenant ID used for authentication
                            tenant_name
                            (added in 1.5)
                            		 no
                              The tenant name used for authentication
                              username
                              		 no
                                Rackspace username (overrides credentials)
                                verify_ssl
                                (added in 1.5)
                                		 no
                                  Whether or not to require SSL validation of API endpoints
                                  volume_type
                                  		 yes SATA
                                  • SATA
                                  • SSD
                                  Type of the volume being created
                                  wait
                                  		 no no
                                  • yes
                                  • no
                                  wait for the volume to be in state 'available' before returning
                                  wait_timeout
                                  		 no 300
                                    how long before wait gives up, in seconds

                                    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: yes
        state: present
        meta:
          app: my-cool-app
      register: my_volume

                                    Notes

                                    Note

                                    The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION.

                                    Note

                                    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

                                    Note

                                    RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file

                                    Note

                                    RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, ...)

                                    This is a Core Module

                                    For more information on what this means please read Core Modules

                                    For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.