Parameter |
Choices/Defaults |
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, os_user_domain_name or os_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
-
|
|
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.
|
display_description
-
|
|
String describing the volume
|
display_name
-
/ required
|
|
Name of volume
|
image
-
|
|
Image name or id for boot from volume
|
interface
string
|
Choices:
- admin
- internal
public ←
|
Endpoint URL type to fetch from the service catalog.
aliases: endpoint_type
|
metadata
-
added in 2.8 |
|
Metadata for the volume
|
region_name
string
|
|
Name of the region.
|
scheduler_hints
-
added in 2.4 |
|
Scheduler hints passed to volume API in form of dict
|
size
-
|
|
Size of volume in GB. This parameter is required when the state parameter is 'present'.
|
snapshot_id
-
|
|
Volume snapshot id to create from
|
state
-
|
Choices:
present ←
- absent
|
Should the resource be present or absent.
|
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
|
volume
-
|
|
Volume name or id to create from
|
volume_type
-
|
|
Volume type for volume
|
wait
boolean
|
|
Should ansible wait until the requested resource is complete.
|