lines_dslam_ports

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

Overview

Name	lines_dslam_ports
Type	Resource
Id	ovh.xdsl.lines_dslam_ports

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
last_desync_date	string (date-time)	Last time the port lost the synchronization (wire: lastDesyncDate)
last_sync_date	string (date-time)	Last time the port synchronized (wire: lastSyncDate)
profile	object	Profile on the DSLAM
status	string	Different states of a DSLAM port (activated, deactivated, outofsync)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	number, service_name		Returns the status and profile of the DSLAM port of the line, with its last synchronization and desynchronization dates.
change_profile	exec	number, serviceName, dslamProfileId		Applies one of the available profiles to the DSLAM port of the line. Returns the task that performs the change.
reset	exec	number, serviceName		Resets the port of the line on the DSLAM. 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"}})
number	string	Number
serviceName	string	Service name
service_name	string	Service name (wire: serviceName)

SELECT examples

get

Returns the status and profile of the DSLAM port of the line, with its last synchronization and desynchronization dates.

SELECT
last_desync_date,
last_sync_date,
profile,
status
FROM ovh.xdsl.lines_dslam_ports
WHERE number = '{{ number }}' -- required
AND service_name = '{{ service_name }}' -- required
;

Lifecycle Methods

EXEC variables use wire (API) names.

change_profile

Applies one of the available profiles to the DSLAM port of the line. Returns the task that performs the change.

EXEC ovh.xdsl.lines_dslam_ports.change_profile 
@number='{{ number }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"dslamProfileId": {{ dslamProfileId }}
}'
;

reset

Resets the port of the line on the DSLAM. Returns the task that performs the change.

EXEC ovh.xdsl.lines_dslam_ports.reset 
@number='{{ number }}' --required, 
@serviceName='{{ serviceName }}' --required
;