vultr.cloud.object_storage module – Manages object storages on Vultr
Note
This module is part of the vultr.cloud collection (version 1.13.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 vultr.cloud
.
To use it in a playbook, specify: vultr.cloud.object_storage
.
New in vultr.cloud 1.12.0
Synopsis
Manage object storages.
Parameters
Parameter |
Comments |
---|---|
URL to API endpint (without trailing slash). Fallback environment variable Default: |
|
API key of the Vultr API. Fallback environment variable |
|
Amount of retries in case of the Vultr API retuns an HTTP error code, such as - 429 Too Many Requests - 500 Internal Server Error - 504 Gateway Time-out Fallback environment variable Default: |
|
Retry backoff delay in seconds is exponential up to this max. value, in seconds. Fallback environment variable Default: |
|
HTTP timeout to Vultr API. Fallback environment variable Default: |
|
Cluster hostname where the object storage will be created. |
|
Name of the object storage. |
|
State of the object storage. Choices:
|
|
Validate SSL certs of the Vultr API. Choices:
|
Notes
Note
Also see the API documentation on https://www.vultr.com/api/.
Examples
---
- name: Ensure an object storage is present
vultr.cloud.object_storage:
label: my object storage
cluster: ewr1.vultrobjects.com
- name: Ensure an object storage is absent
vultr.cloud.object_storage:
label: my object storage
cluster: ewr1.vultrobjects.com
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Response from Vultr API with a few additions/modification. Returned: success |
|
Account used in the ini file to select the key. Returned: success Sample: |
|
Endpoint used for the API requests. Returned: success Sample: |
|
Amount of max retries for the API requests. Returned: success Sample: |
|
Exponential backoff delay in seconds between retries up to this max delay value. Returned: success Sample: |
|
Timeout used for the API requests. Returned: success Sample: |
|
Response from Vultr API. Returned: success |
|
Date the object storage was created. Returned: success Sample: |
|
A unique ID for the object storage. Returned: success Sample: |
|
The user-supplied label for this object storage. Returned: success Sample: |
|
The region for this object storage. Returned: success Sample: |
|
The object storage access key. Returned: success Sample: |
|
The Cluster hostname for this object storage. Returned: success Sample: |
|
The object storage secret key. Returned: success Sample: |
|
The status of this object storage. Returned: success Sample: |