Documentation

os_volume - Create/Delete Cinder Volumes

New in version 2.0.

Synopsis

Create or Remove cinder block storage volumes

Requirements (on host that executes module)

  • python >= 2.6
  • python >= 2.7
  • shade

Options

parameter required default choices comments
api_timeout
 no None
    How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library.
    auth
    		 no
      Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present.
      auth_type
      		 no password
        Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly.
        availability_zone
        		 no
          Name of the availability zone.
          cacert
          		 no None
            A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
            cert
            		 no None
              A path to a client certificate to use as part of the SSL transaction
              cloud
              		 no
                Named cloud to operate against. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present.
                display_description
                		 no None
                  String describing the volume
                  display_name
                  		 yes
                    Name of volume
                    endpoint_type
                    		 no public
                    • public
                    • internal
                    • admin
                    Endpoint URL type to fetch from the service catalog.
                    image
                    		 no None
                      Image name or id for boot from volume
                      key
                      		 no None
                        A path to a client key to use as part of the SSL transaction
                        region_name
                        		 no
                          Name of the region.
                          size
                          		 no None
                            Size of volume in GB. This parameter is required when the state parameter is 'present'.
                            snapshot_id
                            		 no None
                              Volume snapshot id to create from
                              state
                              		 no present
                              • present
                              • absent
                              Should the resource be present or absent.
                              timeout
                              		 no 180
                                How long should ansible wait for the requested resource.
                                validate_certs
                                		 no True
                                  Whether or not SSL API requests should be verified.

                                  aliases: verify
                                  volume_type
                                  		 no None
                                    Volume type for volume
                                    wait
                                    		 no yes
                                    • yes
                                    • no
                                    Should ansible wait until the requested resource is complete.

                                    Examples

                                    # Creates a new volume
- name: create a volume
  hosts: localhost
  tasks:
  - name: create 40g test volume
    os_volume:
      state: present
      cloud: mordred
      availability_zone: az2
      size: 40
      display_name: test_volume

                                    Notes

                                    Note

                                    The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.

                                    Note

                                    Auth information is driven by os-client-config, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at http://docs.openstack.org/developer/os-client-config

                                    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.