backups

Creates, updates, deletes, gets or lists a backups resource.

Overview

Name	backups
Type	Resource
Id	ovh.vmware_cloud_director.backups

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	Unique identifier of the VMware Cloud Director backup
created_at	string (date-time)	Datetime when backup was enabled (wire: createdAt)
current_state	object	Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied. (wire: currentState)
current_tasks	array	Asynchronous operations ongoing on the VMware Cloud Director organization backup service (wire: currentTasks)
iam	object	IAM resource metadata
resource_status	string	Reflects the readiness of the VMware Cloud Director organization backup service. A new target specification request will be accepted only in READY status. (CREATING, DISABLED, DISABLING, READY, REMOVED, REMOVING, UPDATING) (wire: resourceStatus)
target_spec	object	Configuration you requested. While a change is still being applied it differs from currentState. (wire: targetSpec)
updated_at	string (date-time)	Datetime when backup is modified (wire: updatedAt)

list

VMware Cloud Director Backup service

Name	Datatype	Description
id	string	Unique identifier of the VMware Cloud Director backup
created_at	string (date-time)	Datetime when backup was enabled (wire: createdAt)
current_state	object	Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied. (wire: currentState)
current_tasks	array	Asynchronous operations ongoing on the VMware Cloud Director organization backup service (wire: currentTasks)
iam	object	IAM resource metadata
resource_status	string	Reflects the readiness of the VMware Cloud Director organization backup service. A new target specification request will be accepted only in READY status. (CREATING, DISABLED, DISABLING, READY, REMOVED, REMOVING, UPDATING) (wire: resourceStatus)
target_spec	object	Configuration you requested. While a change is still being applied it differs from currentState. (wire: targetSpec)
updated_at	string (date-time)	Datetime when backup is modified (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	backup_id		Returns the backup service: offers with their quota and used space, availability zone and status.
list	select		x_pagination_cursor, x_pagination_size, iam_tags	Returns the backup services, with their offers and status.
update	update	backup_id, target_spec		Replaces the backup offers of the service: BRONZE, SILVER or GOLD, each with a quota in TB. An offer left out of the list is removed. Accepted only when the service is READY, then applied asynchronously: currentState catches up with targetSpec.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
backup_id	string	Backup ID (wire: backupId)
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Returns the backup service: offers with their quota and used space, availability zone and status.

SELECT
id,
created_at,
current_state,
current_tasks,
iam,
resource_status,
target_spec,
updated_at
FROM ovh.vmware_cloud_director.backups
WHERE backup_id = '{{ backup_id }}' -- required
;

list

Returns the backup services, with their offers and status.

SELECT
id,
created_at,
current_state,
current_tasks,
iam,
resource_status,
target_spec,
updated_at
FROM ovh.vmware_cloud_director.backups
WHERE x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
AND iam_tags = '{{ iam_tags }}'
;

UPDATE examples

update

Replaces the backup offers of the service: BRONZE, SILVER or GOLD, each with a quota in TB. An offer left out of the list is removed. Accepted only when the service is READY, then applied asynchronously: currentState catches up with targetSpec.

UPDATE ovh.vmware_cloud_director.backups
SET 
target_spec = '{{ target_spec }}'
WHERE 
backup_id = '{{ backup_id }}' --required
AND target_spec = '{{ target_spec }}' --required
RETURNING
id,
created_at,
current_state,
current_tasks,
resource_status,
target_spec,
updated_at;