datacenter_backups

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

Overview

Name	datacenter_backups
Type	Resource
Id	ovh.dedicated_cloud.datacenter_backups

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
vmware_vm_id	string	The moref of the backup server virtual machine (wire: vmwareVmId)
backup_duration_in_report	boolean	Duration on email report (wire: backupDurationInReport)
backup_offer	string	Backup offer type (advanced, backup, classic, legacy, premium) (wire: backupOffer)
backup_size_in_report	boolean	Backup size on day on email report (wire: backupSizeInReport)
disk_size_in_report	boolean	Disk size on mail report (wire: diskSizeInReport)
encryption	boolean	Backup is encrypted
full_day_in_report	boolean	Full day on mail report (wire: fullDayInReport)
hostname	string	Name of the backup server virtual machine.
mail_address	string	Unique additional email address for backup daily report (wire: mailAddress)
replication_zone	string	Backup replication zone (wire: replicationZone)
restore_point_in_report	boolean	RestorePoint number on mail report (wire: restorePointInReport)
schedule_hour	string (time)	Schedule hour for start backup (example: 15:04:05) (wire: scheduleHour)
state	string	This Backup current state (disabled, disabling, enabled, enabling, error, migrating, removing)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	datacenter_id, service_name		Get the backup option. Returns the backup option of the datacenter: offer, state, schedule hour, encryption and report settings.
batch_restore	exec	datacenterId, serviceName, backupRepositoryName		Restore the last backups. Restores each backup job, or a single virtual machine, from its last restore point. Find the repository and job names in the report sent by generateReport. Returns a task to track progress.
change_properties	exec	datacenterId, serviceName, backupOffer		Update the backup option. Changes the backup offer, the schedule hour (UTC) and the additional email address for the daily report. Returns a task to track progress.
disable	exec	datacenterId, serviceName		Disable the backup option. Disables the backup option of the datacenter. Returns a task to track progress.
generate_report	exec	datacenterId, serviceName		Send a backup report. Sends a report with all backup information by email. Returns a task to track progress.
optimize_proxies	exec	datacenterId, serviceName		Optimize backup proxies. Optimizes the number of backup proxies of the datacenter. Returns a task to track progress.

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"}})
datacenterId	integer	Id of the Datacenter
datacenter_id	integer	Id of the Datacenter (wire: datacenterId)
serviceName	string	Domain of the service
service_name	string	Domain of the service (wire: serviceName)

SELECT examples

get

Get the backup option. Returns the backup option of the datacenter: offer, state, schedule hour, encryption and report settings.

SELECT
vmware_vm_id,
backup_duration_in_report,
backup_offer,
backup_size_in_report,
disk_size_in_report,
encryption,
full_day_in_report,
hostname,
mail_address,
replication_zone,
restore_point_in_report,
schedule_hour,
state
FROM ovh.dedicated_cloud.datacenter_backups
WHERE datacenter_id = '{{ datacenter_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

Lifecycle Methods

EXEC variables use wire (API) names.

batch_restore

Restore the last backups. Restores each backup job, or a single virtual machine, from its last restore point. Find the repository and job names in the report sent by generateReport. Returns a task to track progress.

EXEC ovh.dedicated_cloud.datacenter_backups.batch_restore 
@datacenterId='{{ datacenterId }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"backupJobName": "{{ backupJobName }}", 
"backupRepositoryName": "{{ backupRepositoryName }}"
}'
;

change_properties

Update the backup option. Changes the backup offer, the schedule hour (UTC) and the additional email address for the daily report. Returns a task to track progress.

EXEC ovh.dedicated_cloud.datacenter_backups.change_properties 
@datacenterId='{{ datacenterId }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"backupDurationInReport": {{ backupDurationInReport }}, 
"backupOffer": "{{ backupOffer }}", 
"backupSizeInReport": {{ backupSizeInReport }}, 
"diskSizeInReport": {{ diskSizeInReport }}, 
"fullDayInReport": {{ fullDayInReport }}, 
"mailAddress": "{{ mailAddress }}", 
"restorePointInReport": {{ restorePointInReport }}, 
"scheduleHour": "{{ scheduleHour }}"
}'
;

disable

Disable the backup option. Disables the backup option of the datacenter. Returns a task to track progress.

EXEC ovh.dedicated_cloud.datacenter_backups.disable 
@datacenterId='{{ datacenterId }}' --required, 
@serviceName='{{ serviceName }}' --required
;

generate_report

Send a backup report. Sends a report with all backup information by email. Returns a task to track progress.

EXEC ovh.dedicated_cloud.datacenter_backups.generate_report 
@datacenterId='{{ datacenterId }}' --required, 
@serviceName='{{ serviceName }}' --required
;

optimize_proxies

Optimize backup proxies. Optimizes the number of backup proxies of the datacenter. Returns a task to track progress.

EXEC ovh.dedicated_cloud.datacenter_backups.optimize_proxies 
@datacenterId='{{ datacenterId }}' --required, 
@serviceName='{{ serviceName }}' --required
;