tenant_vspc_backup_agents

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

Overview

Name	tenant_vspc_backup_agents
Type	Resource
Id	ovh.backup_services.tenant_vspc_backup_agents

Fields

The following fields are returned by SELECT queries:

get

successful operation

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

list

Represents a VSPC backup agent

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	backup_agent_id, backup_services_id, vspc_tenant_id		Gets specific backup agent details
list	select	backup_services_id, vspc_tenant_id	x_pagination_cursor, x_pagination_size	Lists backup agents
create	insert	backup_services_id, vspc_tenant_id		Creates backup agent
update	update	backup_agent_id, backup_services_id, vspc_tenant_id		Updates backup agent
delete	delete	backup_agent_id, backup_services_id, vspc_tenant_id		Deletes backup agent

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_agent_id	string (uuid)	Backup agent ID (wire: backupAgentId)
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 agent details

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

list

Lists backup agents

SELECT
id,
created_at,
current_state,
current_tasks,
status,
target_spec,
updated_at
FROM ovh.backup_services.tenant_vspc_backup_agents
WHERE 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

Creates backup agent

INSERT INTO ovh.backup_services.tenant_vspc_backup_agents (
display_name,
ips,
product_resource_name,
region,
backup_services_id,
vspc_tenant_id
)
SELECT 
'{{ display_name }}',
'{{ ips }}',
'{{ product_resource_name }}',
'{{ region }}',
'{{ backup_services_id }}',
'{{ vspc_tenant_id }}'
;

Manifest

# Description fields are for documentation purposes
- name: tenant_vspc_backup_agents
props:
  - name: backup_services_id
    value: "{{ backup_services_id }}"
    description: Required parameter for the tenant_vspc_backup_agents resource.
  - name: vspc_tenant_id
    value: "{{ vspc_tenant_id }}"
    description: Required parameter for the tenant_vspc_backup_agents resource.
  - name: display_name
    value: "{{ display_name }}"
    description: |
      Specifies the name of the backup agent
  - name: ips
    value:
      - "{{ ips }}"
    description: |
      Specifies the IP addresses assigned to the backup agent
  - name: product_resource_name
    value: "{{ product_resource_name }}"
    description: |
      Specifies the product resource name that the agent backs up
  - name: region
    value: "{{ region }}"
    description: |
      Specifies the geographic region where the backup agent operates
    valid_values: ['af-north-lz-rba', 'ap-south-mum', 'ap-southeast-sgp', 'ap-southeast-syd', 'ca-east-bhs', 'ca-east-tor', 'eu-central-lz-buh', 'eu-central-lz-prg', 'eu-central-lz-sof', 'eu-central-waw', 'eu-north-lz-cph', 'eu-north-lz-hel', 'eu-north-lz-osl', 'eu-north-lz-sto', 'eu-south-lz-lis', 'eu-south-lz-mad', 'eu-south-lz-mil', 'eu-south-mil', 'eu-west-eri', 'eu-west-gra', 'eu-west-gra-snc', 'eu-west-lim', 'eu-west-lz-ams', 'eu-west-lz-bru', 'eu-west-lz-dln', 'eu-west-lz-lux', 'eu-west-lz-mnc', 'eu-west-lz-mrs', 'eu-west-lz-vie', 'eu-west-lz-zrh', 'eu-west-par', 'eu-west-rbx', 'eu-west-rbx-snc', 'eu-west-sbg', 'eu-west-sbg-snc', 'us-central-lz-slc', 'us-central-lz-stl', 'us-east-lz-atl', 'us-east-lz-bos', 'us-east-lz-chi', 'us-east-lz-dal', 'us-east-lz-mia', 'us-east-lz-nyc', 'us-east-vin', 'us-west-hil', 'us-west-lz-den', 'us-west-lz-lax', 'us-west-lz-pao', 'us-west-lz-phx', 'us-west-lz-sea']

UPDATE examples

update

Updates backup agent

UPDATE ovh.backup_services.tenant_vspc_backup_agents
SET 
display_name = '{{ display_name }}',
ips = '{{ ips }}',
policy = '{{ policy }}'
WHERE 
backup_agent_id = '{{ backup_agent_id }}' --required
AND backup_services_id = '{{ backup_services_id }}' --required
AND vspc_tenant_id = '{{ vspc_tenant_id }}' --required;

DELETE examples

delete

Deletes backup agent

DELETE FROM ovh.backup_services.tenant_vspc_backup_agents
WHERE backup_agent_id = '{{ backup_agent_id }}' --required
AND backup_services_id = '{{ backup_services_id }}' --required
AND vspc_tenant_id = '{{ vspc_tenant_id }}' --required
;