Skip to main content

datacenter_backup_offer_capabilities

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

Overview​

Namedatacenter_backup_offer_capabilities
TypeResource
Idovh.dedicated_cloud.datacenter_backup_offer_capabilities

Fields​

The following fields are returned by SELECT queries:

Details about BackupCapabilities

NameDatatypeDescription
offer_namestringName of offer type (wire: offerName)
backup_daysbooleanCustomized backup days (wire: backupDays)
custom_reportbooleanCustomized Backup report (wire: customReport)
dedicated_proxybooleanIndicates additional backup proxy for large disk size VM (wire: dedicatedProxy)
encryptionbooleanIndicates if backup will be encrypted
mail_addressbooleanIndicates if customer can add an additional email address for backup report (wire: mailAddress)
minimum_full_backupsintegerMinimum number of full backups (wire: minimumFullBackups)
proxy_per_hostbooleanBackup Proxy per host (wire: proxyPerHost)
replicationbooleanBackup Replication enabled
retentionintegerRestore points
schedule_hourbooleanScheduled hour of backup start customizable (wire: scheduleHour)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectdatacenter_id, service_nameList backup offers. Returns the features of each backup offer: retention, encryption, replication, backup days and report options.

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.

NameDatatypeDescription
api_hoststringThe 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"}})
datacenter_idintegerId of the Datacenter (wire: datacenterId)
service_namestringDomain of the service (wire: serviceName)

SELECT examples​

List backup offers. Returns the features of each backup offer: retention, encryption, replication, backup days and report options.

SELECT
offer_name,
backup_days,
custom_report,
dedicated_proxy,
encryption,
mail_address,
minimum_full_backups,
proxy_per_host,
replication,
retention,
schedule_hour
FROM ovh.dedicated_cloud.datacenter_backup_offer_capabilities
WHERE datacenter_id = '{{ datacenter_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;