Note
This plugin is part of the openstack.cloud collection (version 1.2.1).
To install it use: ansible-galaxy collection install openstack.cloud.
To use it in a playbook, specify: openstack.cloud.volume_info.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| all_projects boolean |
| Whether return the volumes in all projects |
| 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. | |
| availability_zone string | Ignored. Present for backwards compatibility | |
| ca_cert string | A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert | |
| client_cert string | A path to a client certificate to use as part of the SSL transaction. aliases: cert | |
| client_key string | A path to a client key to use as part of the SSL transaction. aliases: key | |
| cloud raw | 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. | |
| details boolean |
| Whether to provide additional information about volumes |
| interface string |
| Endpoint URL type to fetch from the service catalog. aliases: endpoint_type |
| name string | Name of the volume as a string. | |
| region_name string | Name of the region. | |
| status string | Value of the status of the volume so that you can filter on "available" for example | |
| timeout integer | Default: 180 | How long should ansible wait for the requested resource. |
| validate_certs boolean |
| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to yes.aliases: verify |
| wait boolean |
| Should ansible wait until the requested resource is complete. |
Note
OS_USERNAME may be used instead of providing explicit values.- openstack.cloud.volume_info:
- openstack.cloud.volume_info:
name: myvolume
- openstack.cloud.volume_info:
all_projects: true
- openstack.cloud.volume_info:
all_projects: true
details: true
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| volumes list / elements=dictionary | always | Volumes in project Sample: [{'attachments': [], 'availability_zone': 'nova', 'consistency_group_id': None, 'created_at': '2017-11-15T10:51:19.000000', 'description': '', 'extended_replication_status': None, 'host': None, 'id': '103ac6ed-527f-4781-8484-7ff4467e34f5', 'image_id': None, 'is_bootable': True, 'is_encrypted': False, 'links': [{'href': 'https://...', 'rel': 'self'}, {'href': 'https://...', 'rel': 'bookmark'}], 'location': {'cloud': 'cloud', 'project': {'domain_id': None, 'domain_name': 'Default', 'id': 'cfe04702154742fc964d9403c691c76e', 'name': 'username'}, 'region_name': 'regionOne', 'zone': 'nova'}, 'metadata': {'readonly': 'False'}, 'migration_id': None, 'migration_status': None, 'name': '', 'project_id': 'cab34702154a42fc96ed9403c691c76e', 'replication_driver_data': None, 'replication_status': 'disabled', 'size': 9, 'snapshot_id': None, 'source_volume_id': None, 'status': 'available', 'volume_image_metadata': {'checksum': 'a14e113deeee3a3392462f167ed28cb5', 'container_format': 'bare', 'disk_format': 'raw', 'family': 'centos-7', 'image_id': 'afcf3320-1bf8-4a9a-a24d-5abd639a6e33', 'image_name': 'CentOS-7-x86_64-GenericCloud-1708', 'latest': 'centos-7-latest', 'min_disk': '0', 'min_ram': '0', 'official': 'True', 'official-image': 'True', 'size': '8589934592'}, 'volume_type': None}] |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/openstack/cloud/volume_info_module.html