tenant_vspc_managed_backup_virtual_machines

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

Overview

Name	tenant_vspc_managed_backup_virtual_machines
Type	Resource
Id	ovh.backup_services.tenant_vspc_managed_backup_virtual_machines

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	vSphere managed object reference of the virtual machine, vm- prefix included, for example vm-4021. A restored virtual machine is a new vSphere object with a new identifier.
name	string	Name of the virtual machine in vSphere at the last refresh
last_backup_at	string (date-time)	Date and time of the last backup cycle that included the virtual machine. Null when it has never been backed up. (wire: lastBackupAt)
protection_status	string	Indicates whether the virtual machine carries a valid vault tag. Independent of the result of its backups. (PROTECTED, UNPROTECTED) (wire: protectionStatus)
refreshed_at	string (date-time)	Date and time when this entry was last refreshed from the backup platform (wire: refreshedAt)
restore_point_count	integer	Number of restore points currently held for the virtual machine. 0 when it has never been backed up. (wire: restorePointCount)
size_band	string	Billing size band validated at the last backup of the virtual machine. Null when no backup has been validated yet. (MAX_1TB, MAX_250GB, MAX_2TB, MAX_4TB, MAX_6TB, MAX_8TB) (wire: sizeBand)
vault_level	string	Vault level resolved from the vSphere tag of the virtual machine at the last backup cycle. The tag category allows a single vault tag per virtual machine. Null when the virtual machine is unprotected. (ADVANCED, PREMIUM, STANDARD) (wire: vaultLevel)
vm_size_gb	integer	Used size of the virtual machine in GB, measured at the last backup and used to compute its sizeBand. Null when no measurement is available yet. (wire: vmSizeGb)

list

Protection state of a virtual machine of the Hosted Private Cloud covered by the Managed Backup service

Name	Datatype	Description
id	string	vSphere managed object reference of the virtual machine, vm- prefix included, for example vm-4021. A restored virtual machine is a new vSphere object with a new identifier.
name	string	Name of the virtual machine in vSphere at the last refresh
last_backup_at	string (date-time)	Date and time of the last backup cycle that included the virtual machine. Null when it has never been backed up. (wire: lastBackupAt)
protection_status	string	Indicates whether the virtual machine carries a valid vault tag. Independent of the result of its backups. (PROTECTED, UNPROTECTED) (wire: protectionStatus)
refreshed_at	string (date-time)	Date and time when this entry was last refreshed from the backup platform (wire: refreshedAt)
restore_point_count	integer	Number of restore points currently held for the virtual machine. 0 when it has never been backed up. (wire: restorePointCount)
size_band	string	Billing size band validated at the last backup of the virtual machine. Null when no backup has been validated yet. (MAX_1TB, MAX_250GB, MAX_2TB, MAX_4TB, MAX_6TB, MAX_8TB) (wire: sizeBand)
vault_level	string	Vault level resolved from the vSphere tag of the virtual machine at the last backup cycle. The tag category allows a single vault tag per virtual machine. Null when the virtual machine is unprotected. (ADVANCED, PREMIUM, STANDARD) (wire: vaultLevel)
vm_size_gb	integer	Used size of the virtual machine in GB, measured at the last backup and used to compute its sizeBand. Null when no measurement is available yet. (wire: vmSizeGb)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	backup_services_id, managed_backup_id, virtual_machine_id, vspc_tenant_id		Retrieves the protection state, billing dimensions and last backup information of a virtual machine
list	select	backup_services_id, managed_backup_id, vspc_tenant_id	x_pagination_cursor, x_pagination_size	Lists the virtual machines known to the Managed Backup service with their protection state, billing dimensions and last backup information

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_services_id	string (uuid)	Backup services ID (wire: backupServicesId)
managed_backup_id	string	Managed backup ID (wire: managedBackupId)
virtual_machine_id	string	Virtual machine ID (wire: virtualMachineId)
vspc_tenant_id	string (uuid)	Vspc tenant ID (wire: vspcTenantId)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Retrieves the protection state, billing dimensions and last backup information of a virtual machine

SELECT
id,
name,
last_backup_at,
protection_status,
refreshed_at,
restore_point_count,
size_band,
vault_level,
vm_size_gb
FROM ovh.backup_services.tenant_vspc_managed_backup_virtual_machines
WHERE backup_services_id = '{{ backup_services_id }}' -- required
AND managed_backup_id = '{{ managed_backup_id }}' -- required
AND virtual_machine_id = '{{ virtual_machine_id }}' -- required
AND vspc_tenant_id = '{{ vspc_tenant_id }}' -- required
;

list

Lists the virtual machines known to the Managed Backup service with their protection state, billing dimensions and last backup information

SELECT
id,
name,
last_backup_at,
protection_status,
refreshed_at,
restore_point_count,
size_band,
vault_level,
vm_size_gb
FROM ovh.backup_services.tenant_vspc_managed_backup_virtual_machines
WHERE backup_services_id = '{{ backup_services_id }}' -- required
AND managed_backup_id = '{{ managed_backup_id }}' -- required
AND vspc_tenant_id = '{{ vspc_tenant_id }}' -- required
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;