lines

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

Overview

Name	lines
Type	Resource
Id	ovh.xdsl.lines

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
concentration_point	object	Data to identify the line at the concentration point (wire: concentrationPoint)
deconsolidation	string	Deconsolidation of the line. (createNeighbour, creation, creationNeighbour, partial, total)
direct_distribution	boolean	True if the line is directly wired on the DSLAM (wire: directDistribution)
distance	integer	Distance in meters from the DSLAM
fault_repair_time	string	Maximum time needed to repair a landline (10HO, 4HNO, 4HO, DPLUS1, NORMAL) (wire: faultRepairTime)
line_sections_length	array	Detailed information about the sections between the DSLAM and the telephone jack (wire: lineSectionsLength)
mitigation	number	Mitigation of the line in dB
number	string	The number of the line
original_number	string	The number used to place the order. Null if the same as the current number. (wire: originalNumber)
portability	boolean	Whether the line number has been ported to OVH, to be used with VoIP service
sync_down	number	The download synchronisation on the DSLAM in Kbps (wire: syncDown)
sync_up	number	The upload synchronisation on the DSLAM in Kbps (wire: syncUp)

list

Information about the physical copper line

Name	Datatype	Description
concentration_point	object	Data to identify the line at the concentration point (wire: concentrationPoint)
deconsolidation	string	Deconsolidation of the line. (createNeighbour, creation, creationNeighbour, partial, total)
direct_distribution	boolean	True if the line is directly wired on the DSLAM (wire: directDistribution)
distance	integer	Distance in meters from the DSLAM
fault_repair_time	string	Maximum time needed to repair a landline (10HO, 4HNO, 4HO, DPLUS1, NORMAL) (wire: faultRepairTime)
line_sections_length	array	Detailed information about the sections between the DSLAM and the telephone jack (wire: lineSectionsLength)
mitigation	number	Mitigation of the line in dB
number	string	The number of the line
original_number	string	The number used to place the order. Null if the same as the current number. (wire: originalNumber)
portability	boolean	Whether the line number has been ported to OVH, to be used with VoIP service
sync_down	number	The download synchronisation on the DSLAM in Kbps (wire: syncDown)
sync_up	number	The upload synchronisation on the DSLAM in Kbps (wire: syncUp)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	number, service_name		Returns the line number, distance and sections to the DSLAM, synchronization rates, mitigation, deconsolidation, portability and fault repair time.
list	select	service_name	x_pagination_mode	Returns the numbers of the copper lines of the access.
diagnostic_cancel	exec	number, serviceName		Cancels the ongoing advanced diagnostic of the line, when it can still be canceled.
diagnostic_run	exec	number, serviceName, faultType		Starts or continues the advanced diagnostic of the line with the customer answers and actions done. Returns the diagnostic with its status, fault type and data.

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)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Returns the line number, distance and sections to the DSLAM, synchronization rates, mitigation, deconsolidation, portability and fault repair time.

SELECT
concentration_point,
deconsolidation,
direct_distribution,
distance,
fault_repair_time,
line_sections_length,
mitigation,
number,
original_number,
portability,
sync_down,
sync_up
FROM ovh.xdsl.lines
WHERE number = '{{ number }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the numbers of the copper lines of the access.

SELECT
concentration_point,
deconsolidation,
direct_distribution,
distance,
fault_repair_time,
line_sections_length,
mitigation,
number,
original_number,
portability,
sync_down,
sync_up
FROM ovh.xdsl.lines
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

diagnostic_cancel

Cancels the ongoing advanced diagnostic of the line, when it can still be canceled.

EXEC ovh.xdsl.lines.diagnostic_cancel 
@number='{{ number }}' --required, 
@serviceName='{{ serviceName }}' --required
;

diagnostic_run

Starts or continues the advanced diagnostic of the line with the customer answers and actions done. Returns the diagnostic with its status, fault type and data.

EXEC ovh.xdsl.lines.diagnostic_run 
@number='{{ number }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"actionsDone": "{{ actionsDone }}", 
"answers": "{{ answers }}", 
"faultType": "{{ faultType }}"
}'
;