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
api_endpoint string	URL to API endpint (without trailing slash). Fallback environment variable VULTR_API_ENDPOINT. Default: "https://api.vultr.com/v2"
api_key string / required	API key of the Vultr API. Fallback environment variable VULTR_API_KEY.
api_retries integer	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 VULTR_API_RETRIES. Default: 5
api_retry_max_delay integer	Retry backoff delay in seconds is exponential up to this max. value, in seconds. Fallback environment variable VULTR_API_RETRY_MAX_DELAY. Default: 12
api_timeout integer	HTTP timeout to Vultr API. Fallback environment variable VULTR_API_TIMEOUT. Default: 180
cluster string / required	Cluster hostname where the object storage will be created.
label aliases: name string / required	Name of the object storage.
state string	State of the object storage. Choices: "present" ← (default) "absent"
validate_certs boolean	Validate SSL certs of the Vultr API. Choices: false true ← (default)

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
vultr_api dictionary	Response from Vultr API with a few additions/modification. Returned: success
api_account string	Account used in the ini file to select the key. Returned: success Sample: "default"
api_endpoint string	Endpoint used for the API requests. Returned: success Sample: "https://api.vultr.com/v2"
api_retries integer	Amount of max retries for the API requests. Returned: success Sample: 5
api_retry_max_delay integer	Exponential backoff delay in seconds between retries up to this max delay value. Returned: success Sample: 12
api_timeout integer	Timeout used for the API requests. Returned: success Sample: 60
vultr_block_storage dictionary	Response from Vultr API. Returned: success
date_created string	Date the object storage was created. Returned: success Sample: "2020-10-10T01:56:20+00:00"
id string	A unique ID for the object storage. Returned: success Sample: "cb676a46-66fd-4dfb-b839-443f2e6c0b60"
label string	The user-supplied label for this object storage. Returned: success Sample: "my object storage"
region string	The region for this object storage. Returned: success Sample: "ews"
s3_access_key string	The object storage access key. Returned: success Sample: "00example11223344"
s3_hostname string	The Cluster hostname for this object storage. Returned: success Sample: "ewr1.vultrobjects.com"
s3_secret_key string	The object storage secret key. Returned: success Sample: "00example1122334455667788990011"
status string	The status of this object storage. Returned: success Sample: "active"

Authors

• René Moser (@resmo)

Collection links

• Issue Tracker
• Repository (Sources)