backup_repositories

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

Overview

Name	backup_repositories
Type	Resource
Id	ovh.veeam_cloud_connect.backup_repositories

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
inventory_name	string	The inventory name of your backup repository (wire: inventoryName)
quota	object	The quota allowed on this Backup repository
quota_used	object	The quota used on this Backup repository (wire: quotaUsed)
replication_zone	string	The replication zone of your repository (bhs1, rbx2, sbg1) (wire: replicationZone)
state	string	The state of your backup repository (configuring, delivered, disabled, disabling, error, migrating, removing)
usage	integer	The usage in percent of this backup repository

list

Veeam backup repository

Name	Datatype	Description
inventory_name	string	The inventory name of your backup repository (wire: inventoryName)
quota	object	The quota allowed on this Backup repository
quota_used	object	The quota used on this Backup repository (wire: quotaUsed)
replication_zone	string	The replication zone of your repository (bhs1, rbx2, sbg1) (wire: replicationZone)
state	string	The state of your backup repository (configuring, delivered, disabled, disabling, error, migrating, removing)
usage	integer	The usage in percent of this backup repository

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	inventory_name, service_name		Get Veeam backup repository
list	select	service_name	x_pagination_mode	List Veeam backup repositories
create	insert	service_name		Create backup repository
delete	delete	inventory_name, service_name		Delete backup repository
upgrade_quota	exec	inventoryName, serviceName, newQuota		Change quota

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"}})
inventoryName	string	The inventory name of your backup repository
inventory_name	string	The inventory name of your backup repository (wire: inventoryName)
serviceName	string	Domain of the service
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 Veeam backup repository

SELECT
inventory_name,
quota,
quota_used,
replication_zone,
state,
usage
FROM ovh.veeam_cloud_connect.backup_repositories
WHERE inventory_name = '{{ inventory_name }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List Veeam backup repositories

SELECT
inventory_name,
quota,
quota_used,
replication_zone,
state,
usage
FROM ovh.veeam_cloud_connect.backup_repositories
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create backup repository

INSERT INTO ovh.veeam_cloud_connect.backup_repositories (
service_name
)
SELECT 
'{{ service_name }}'
RETURNING
name,
task_id,
end_date,
progress,
start_date,
state
;

Manifest

# Description fields are for documentation purposes
- name: backup_repositories
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the backup_repositories resource.

DELETE examples

delete

Delete backup repository

DELETE FROM ovh.veeam_cloud_connect.backup_repositories
WHERE inventory_name = '{{ inventory_name }}' --required
AND service_name = '{{ service_name }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

upgrade_quota

Change quota

EXEC ovh.veeam_cloud_connect.backup_repositories.upgrade_quota 
@inventoryName='{{ inventoryName }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"newQuota": {{ newQuota }}
}'
;