New in version 2.6.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| api_timeout |
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 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 |
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 |
Availability zone in which to create the snapshot.
|
|
| cacert |
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
|
|
| cert |
A path to a client certificate to use as part of the SSL transaction.
|
|
| cloud |
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.
|
|
| display_description |
Default: null
|
String describing the snapshot
aliases: description |
|
display_name
required |
Name of the snapshot
aliases: name |
|
|
force
bool |
|
Allows or disallows snapshot of a volume to be created when the volume is attached to an instance.
|
|
interface
(added in 2.3) |
|
Endpoint URL type to fetch from the service catalog.
aliases: endpoint_type |
| key |
A path to a client key to use as part of the SSL transaction.
|
|
| region_name |
Name of the region.
|
|
| state |
|
Should the resource be present or absent.
|
| timeout |
Default: 180
|
How long should ansible wait for the requested resource.
|
|
verify
bool |
|
Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.
aliases: validate_certs |
|
volume
required |
The volume name or id to create/delete the snapshot
|
|
|
wait
bool |
|
Should ansible wait until the requested resource is complete.
|
Note
OS_USERNAME may be used instead of providing explicit values.# Creates a snapshot on volume 'test_volume'
- name: create and delete snapshot
hosts: localhost
tasks:
- name: create snapshot
os_volume_snapshot:
state: present
cloud: mordred
availability_zone: az2
display_name: test_snapshot
volume: test_volume
- name: delete snapshot
os_volume_snapshot:
state: absent
cloud: mordred
availability_zone: az2
display_name: test_snapshot
volume: test_volume
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
snapshot
dict
|
success |
The snapshot instance after the change
Sample:
{'status': 'available', 'display_name': 'test_snapshot', 'name': 'test_snapshot', 'volume_id': 'ec646a7c-6a35-4857-b38b-808105a24be6', 'id': '837aca54-c0ee-47a2-bf9a-35e1b4fdac0c', 'size': 2}
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.