openstack.cloud.volume_type module – Manage OpenStack volume type

Note

This module is part of the openstack.cloud collection (version 2.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install openstack.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: openstack.cloud.volume_type.

Synopsis

• Add, remove or update volume types in OpenStack.

Requirements

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

• python >= 3.6

• openstacksdk >= 1.0.0

Parameters

Parameter	Comments
api_timeout integer	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 dictionary	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 (for example, user_domain_name or project_domain_name) 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 string	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.
ca_cert aliases: cacert string	A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
client_cert aliases: cert string	A path to a client certificate to use as part of the SSL transaction.
client_key aliases: key string	A path to a client key to use as part of the SSL transaction.
cloud any	Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. 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. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml.
description string	Description of the volume type.
extra_specs dictionary	List of volume type properties
interface aliases: endpoint_type string	Endpoint URL type to fetch from the service catalog. Choices: "admin" "internal" "public" ← (default)
is_public boolean	Make volume type accessible to the public. Can be set only during creation Choices: false true
name string / required	Volume type name or id.
region_name string	Name of the region.
sdk_log_level string	Log level of the OpenStackSDK Choices: "INFO" ← (default) "DEBUG"
sdk_log_path string	Path to the logfile of the OpenStackSDK. If empty no log is written
state string	Indicate desired state of the resource. When state is present, then is_public is required. Choices: "present" ← (default) "absent"
timeout integer	How long should ansible wait for the requested resource. Default: 180
validate_certs aliases: verify boolean	Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to true. Choices: false true
wait boolean	Should ansible wait until the requested resource is complete. Choices: false true ← (default)

Notes

Note

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

• Auth information is driven by openstacksdk, 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 https://docs.openstack.org/openstacksdk/

Examples

- name: Delete volume type by name
  openstack.cloud.volume_type:
    name: test_type
    state: absent

- name: Delete volume type by id
  openstack.cloud.volume_type:
    name: fbadfa6b-5f17-4c26-948e-73b94de57b42
    state: absent

- name: Create volume type
  openstack.cloud.volume_type:
    name: unencrypted_volume_type
    state: present
    extra_specs:
      volume_backend_name: LVM_iSCSI
    description: Unencrypted volume type
    is_public: True

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
volume_type dictionary	Dictionary describing volume type Returned: On success when state is ‘present’
description string	volume type description Returned: success Sample: "Unencrypted volume type"
extra_specs dictionary	volume type extra parameters Returned: success
is_public boolean	whether the volume type is public Returned: success Sample: true
name string	volume type name Returned: success Sample: "test_type"

Authors

• OpenStack Ansible SIG

Collection links

• Issue Tracker
• Repository (Sources)