tenant_vspc_backup_licenses_backup_servers

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

Overview

Name	tenant_vspc_backup_licenses_backup_servers
Type	Resource
Id	ovh.backup_services.tenant_vspc_backup_licenses_backup_servers

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Unique identifier of the backup server
created_at	string (date-time)	Date and time when you register the backup server (wire: createdAt)
current_state	object	Current state of the backup server (wire: currentState)
current_tasks	array	Current tasks running on the backup server (wire: currentTasks)
status	string	Shows whether the backup server is ready (CREATING, DELETING, DISABLED, ENABLED, ERROR, NOT_CONFIGURED, NOT_INSTALLED, UPDATING)
target_spec	object	Target specification for the backup server (wire: targetSpec)
updated_at	string (date-time)	Date and time when you update the backup server (wire: updatedAt)

list

Represents a backup server, member of the Backup Licenses subscription

Name	Datatype	Description
id	string (uuid)	Unique identifier of the backup server
created_at	string (date-time)	Date and time when you register the backup server (wire: createdAt)
current_state	object	Current state of the backup server (wire: currentState)
current_tasks	array	Current tasks running on the backup server (wire: currentTasks)
status	string	Shows whether the backup server is ready (CREATING, DELETING, DISABLED, ENABLED, ERROR, NOT_CONFIGURED, NOT_INSTALLED, UPDATING)
target_spec	object	Target specification for the backup server (wire: targetSpec)
updated_at	string (date-time)	Date and time when you update the backup server (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	backup_licenses_id, backup_server_id, backup_services_id, vspc_tenant_id		Gets specific backup server details
list	select	backup_licenses_id, backup_services_id, vspc_tenant_id	x_pagination_cursor, x_pagination_size	Lists backup servers of the Backup Licenses subscription
create	insert	backup_licenses_id, backup_services_id, vspc_tenant_id, external_ips, license_type		Registers an additional backup server under the Backup Licenses subscription
update	update	backup_licenses_id, backup_server_id, backup_services_id, vspc_tenant_id, external_ips, license_type		Updates a backup server; IP and display name changes apply immediately, a license type change is applied on the 1st of the next month
delete	delete	backup_licenses_id, backup_server_id, backup_services_id, vspc_tenant_id		Deregisters a backup server from the Backup Licenses subscription; the subscription and license types are retained

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_licenses_id	string	Backup licenses ID (wire: backupLicensesId)
backup_server_id	string (uuid)	Backup server ID (wire: backupServerId)
backup_services_id	string (uuid)	Backup services ID (wire: backupServicesId)
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

Gets specific backup server details

SELECT
id,
created_at,
current_state,
current_tasks,
status,
target_spec,
updated_at
FROM ovh.backup_services.tenant_vspc_backup_licenses_backup_servers
WHERE backup_licenses_id = '{{ backup_licenses_id }}' -- required
AND backup_server_id = '{{ backup_server_id }}' -- required
AND backup_services_id = '{{ backup_services_id }}' -- required
AND vspc_tenant_id = '{{ vspc_tenant_id }}' -- required
;

list

Lists backup servers of the Backup Licenses subscription

SELECT
id,
created_at,
current_state,
current_tasks,
status,
target_spec,
updated_at
FROM ovh.backup_services.tenant_vspc_backup_licenses_backup_servers
WHERE backup_licenses_id = '{{ backup_licenses_id }}' -- required
AND backup_services_id = '{{ backup_services_id }}' -- required
AND vspc_tenant_id = '{{ vspc_tenant_id }}' -- required
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;

INSERT examples

create

Registers an additional backup server under the Backup Licenses subscription

INSERT INTO ovh.backup_services.tenant_vspc_backup_licenses_backup_servers (
display_name,
external_ips,
license_type,
private_ips,
backup_licenses_id,
backup_services_id,
vspc_tenant_id
)
SELECT 
'{{ display_name }}',
'{{ external_ips }}' /* required */,
'{{ license_type }}' /* required */,
'{{ private_ips }}',
'{{ backup_licenses_id }}',
'{{ backup_services_id }}',
'{{ vspc_tenant_id }}'
RETURNING
id,
created_at,
current_state,
current_tasks,
status,
target_spec,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: tenant_vspc_backup_licenses_backup_servers
props:
  - name: backup_licenses_id
    value: "{{ backup_licenses_id }}"
    description: Required parameter for the tenant_vspc_backup_licenses_backup_servers resource.
  - name: backup_services_id
    value: "{{ backup_services_id }}"
    description: Required parameter for the tenant_vspc_backup_licenses_backup_servers resource.
  - name: vspc_tenant_id
    value: "{{ vspc_tenant_id }}"
    description: Required parameter for the tenant_vspc_backup_licenses_backup_servers resource.
  - name: display_name
    value: "{{ display_name }}"
    description: |
      Name of the backup server
  - name: external_ips
    value:
      - "{{ external_ips }}"
    description: |
      External IP addresses of the backup server
  - name: license_type
    value: "{{ license_type }}"
    description: |
      Requested license type
    valid_values: ['VEEAM_BACKUP_REPLICATION_ENTERPRISE_PLUS', 'VEEAM_DATA_PLATFORM_ADVANCED', 'VEEAM_DATA_PLATFORM_FOUNDATION', 'VEEAM_DATA_PLATFORM_PREMIUM']
  - name: private_ips
    value:
      - "{{ private_ips }}"
    description: |
      Private IP addresses used for discovery

UPDATE examples

update

Updates a backup server; IP and display name changes apply immediately, a license type change is applied on the 1st of the next month

UPDATE ovh.backup_services.tenant_vspc_backup_licenses_backup_servers
SET 
display_name = '{{ display_name }}',
external_ips = '{{ external_ips }}',
license_type = '{{ license_type }}',
private_ips = '{{ private_ips }}'
WHERE 
backup_licenses_id = '{{ backup_licenses_id }}' --required
AND backup_server_id = '{{ backup_server_id }}' --required
AND backup_services_id = '{{ backup_services_id }}' --required
AND vspc_tenant_id = '{{ vspc_tenant_id }}' --required
AND external_ips = '{{ external_ips }}' --required
AND license_type = '{{ license_type }}' --required
RETURNING
id,
created_at,
current_state,
current_tasks,
status,
target_spec,
updated_at;

DELETE examples

delete

Deregisters a backup server from the Backup Licenses subscription; the subscription and license types are retained

DELETE FROM ovh.backup_services.tenant_vspc_backup_licenses_backup_servers
WHERE backup_licenses_id = '{{ backup_licenses_id }}' --required
AND backup_server_id = '{{ backup_server_id }}' --required
AND backup_services_id = '{{ backup_services_id }}' --required
AND vspc_tenant_id = '{{ vspc_tenant_id }}' --required
;