features_backup_clouds

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

Overview

Name	features_backup_clouds
Type	Resource
Id	ovh.dedicated_server.features_backup_clouds

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
agreements	array	Agreement ids waiting for validation
archive	object	Archive space info.
status	object	Status of the container.
storage	object	Storage space info.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Get the cloud backup. Returns the cloud backup of the server: its storage and archive containers, its status and the agreements waiting for validation. (Beta version)
create	insert	service_name		Create the cloud backup. Creates the cloud backup of the server, with storage and archive containers in a cloud project. Set cloudProjectId to use an existing project; otherwise a project is created, described by projectDescription. (Beta version)
delete	delete	service_name		Deactivate the cloud backup. Deactivates the cloud backup of the server. The container data is not deleted. (Beta version)
password	exec	serviceName		Regenerate cloud backup passwords. Regenerates the cloud backup passwords and returns them: the Swift and SFTP passwords of the storage and archive containers. (Beta version)

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"}})
serviceName	string	The internal name of your dedicated server
service_name	string	The internal name of your dedicated server (wire: serviceName)

SELECT examples

get

Get the cloud backup. Returns the cloud backup of the server: its storage and archive containers, its status and the agreements waiting for validation. (Beta version)

SELECT
agreements,
archive,
status,
storage
FROM ovh.dedicated_server.features_backup_clouds
WHERE service_name = '{{ service_name }}' -- required
;

INSERT examples

create

Create the cloud backup. Creates the cloud backup of the server, with storage and archive containers in a cloud project. Set cloudProjectId to use an existing project; otherwise a project is created, described by projectDescription. (Beta version)

INSERT INTO ovh.dedicated_server.features_backup_clouds (
cloud_project_id,
project_description,
service_name
)
SELECT 
'{{ cloud_project_id }}',
'{{ project_description }}',
'{{ service_name }}'
RETURNING
agreements,
archive,
status,
storage
;

Manifest

# Description fields are for documentation purposes
- name: features_backup_clouds
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the features_backup_clouds resource.
  - name: cloud_project_id
    value: "{{ cloud_project_id }}"
    description: |
      cloud project id
  - name: project_description
    value: "{{ project_description }}"
    description: |
      Project description of the project to be created (ignored when an existing project is already specified)

DELETE examples

delete

Deactivate the cloud backup. Deactivates the cloud backup of the server. The container data is not deleted. (Beta version)

DELETE FROM ovh.dedicated_server.features_backup_clouds
WHERE service_name = '{{ service_name }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

password

Regenerate cloud backup passwords. Regenerates the cloud backup passwords and returns them: the Swift and SFTP passwords of the storage and archive containers. (Beta version)

EXEC ovh.dedicated_server.features_backup_clouds.password 
@serviceName='{{ serviceName }}' --required
;