backup_repositories

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

Overview

Name	backup_repositories
Type	Resource
Id	ovh.dedicated_cloud.backup_repositories

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
repository_id	integer	Repository Id (wire: repositoryId)
repository_name	string	Repository Name (wire: repositoryName)
last_successful_replication_date	string (date-time)	Replication last successful date (wire: lastSuccessfulReplicationDate)
replication	string	Replication status (disabled, disabling, enabled, enabling, error, migrating, unknown)
replication_zone	string	Replication zone (wire: replicationZone)
sync_status	string	Replication sync status (ok, out-of-sync, sync-required, unknown) (wire: syncStatus)

list

Backup repository

Name	Datatype	Description
repository_id	integer	Repository Id (wire: repositoryId)
repository_name	string	Repository Name (wire: repositoryName)
last_successful_replication_date	string (date-time)	Replication last successful date (wire: lastSuccessfulReplicationDate)
replication	string	Replication status (disabled, disabling, enabled, enabling, error, migrating, unknown)
replication_zone	string	Replication zone (wire: replicationZone)
sync_status	string	Replication sync status (ok, out-of-sync, sync-required, unknown) (wire: syncStatus)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	repository_id, service_name		Get a backup repository. Returns the backup repository: name, replication zone, replication status and last successful replication date.
list	select	service_name	x_pagination_mode	List backup repositories

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"}})
repository_id	integer	Repository Id (wire: repositoryId)
service_name	string	Domain of the service (wire: serviceName)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get a backup repository. Returns the backup repository: name, replication zone, replication status and last successful replication date.

SELECT
repository_id,
repository_name,
last_successful_replication_date,
replication,
replication_zone,
sync_status
FROM ovh.dedicated_cloud.backup_repositories
WHERE repository_id = '{{ repository_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List backup repositories

SELECT
repository_id,
repository_name,
last_successful_replication_date,
replication,
replication_zone,
sync_status
FROM ovh.dedicated_cloud.backup_repositories
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;