modem_ftps

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

Overview

Name	modem_ftps
Type	Resource
Id	ovh.xdsl.modem_ftps

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
value	string	Status of the service (disabled, enabled)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Returns whether the FTP service is enabled or disabled on the modem of the access.
create	insert	service_name, ftp		Changes the status of the FTP service on the modem of the access. Returns the task that performs the change.

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"}})
service_name	string	Service name (wire: serviceName)

SELECT examples

get

Returns whether the FTP service is enabled or disabled on the modem of the access.

SELECT
value
FROM ovh.xdsl.modem_ftps
WHERE service_name = '{{ service_name }}' -- required
;

INSERT examples

create

Changes the status of the FTP service on the modem of the access. Returns the task that performs the change.

INSERT INTO ovh.xdsl.modem_ftps (
ftp,
service_name
)
SELECT 
'{{ ftp }}' /* required */,
'{{ service_name }}'
RETURNING
id,
done_date,
function,
is_archived,
status,
todo_date,
update_date
;

Manifest

# Description fields are for documentation purposes
- name: modem_ftps
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the modem_ftps resource.
  - name: ftp
    value: "{{ ftp }}"
    description: |
      Status of the service
    valid_values: ['disabled', 'enabled']