features_backup_ftps

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

Overview

Name	features_backup_ftps
Type	Resource
Id	ovh.dedicated_server.features_backup_ftps

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
ftp_backup_name	string	The backup FTP server name (wire: ftpBackupName)
quota	object	The disk space available in gigabytes
read_only_date	string (date-time)	If not-null, gives the date since when your account was set in read-only mode because the quota was exceeded (wire: readOnlyDate)
type	string	The backup FTP type (included, storage)
usage	object	The disk space currently used on your backup FTP in percent

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Get the backup FTP space. Returns the backup FTP space: its server name, type, available disk space and usage. readOnlyDate is set when the account was switched to read-only because the quota was exceeded.
create	insert	service_name		Create the backup FTP space. Creates the backup FTP space and returns a task. The IP blocks allowed to reach it, and their protocols, are managed with the access routes.
delete	delete	service_name		Delete the backup FTP space. Terminates the backup FTP space and returns a task. All data stored on it is permanently deleted.
password	exec	serviceName		Reset the backup FTP password. Resets the backup FTP password and returns a task. The response does not contain the new password.

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 backup FTP space. Returns the backup FTP space: its server name, type, available disk space and usage. readOnlyDate is set when the account was switched to read-only because the quota was exceeded.

SELECT
ftp_backup_name,
quota,
read_only_date,
type,
usage
FROM ovh.dedicated_server.features_backup_ftps
WHERE service_name = '{{ service_name }}' -- required
;

INSERT examples

create

Create the backup FTP space. Creates the backup FTP space and returns a task. The IP blocks allowed to reach it, and their protocols, are managed with the access routes.

INSERT INTO ovh.dedicated_server.features_backup_ftps (
service_name
)
SELECT 
'{{ service_name }}'
RETURNING
planned_intervention_id,
task_id,
change_uuid,
comment,
done_date,
function,
last_update,
need_schedule,
note,
start_date,
status,
tags,
ticket_reference
;

Manifest

# Description fields are for documentation purposes
- name: features_backup_ftps
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the features_backup_ftps resource.

DELETE examples

delete

Delete the backup FTP space. Terminates the backup FTP space and returns a task. All data stored on it is permanently deleted.

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

Lifecycle Methods

EXEC variables use wire (API) names.

password

Reset the backup FTP password. Resets the backup FTP password and returns a task. The response does not contain the new password.

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