backupftps
Creates, updates, deletes, gets or lists a backupftps resource.
Overview​
| Name | backupftps |
| Type | Resource |
| Id | ovh.vps.backupftps |
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 on your backup FTP |
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 |
usage | object | The disk space currently used on your backup FTP |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name | Returns the Backup FTP service of the VPS: its name, type, quota, usage and read-only date. | |
password | exec | serviceName | Sets a new password for the Backup FTP of the VPS and returns the task that performs it. |
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 | Service name |
service_name | string | Service name (wire: serviceName) |
SELECT examples​
- get
Returns the Backup FTP service of the VPS: its name, type, quota, usage and read-only date.
SELECT
ftp_backup_name,
quota,
read_only_date,
type,
usage
FROM ovh.vps.backupftps
WHERE service_name = '{{ service_name }}' -- required
;
Lifecycle Methods​
EXEC variables use wire (API) names.
- password
Sets a new password for the Backup FTP of the VPS and returns the task that performs it.
EXEC ovh.vps.backupftps.password
@serviceName='{{ serviceName }}' --required
;