diagnostics

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

Overview

Name	diagnostics
Type	Resource
Id	ovh.xdsl.diagnostics

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
capabilities	object	Available tests for this access
diagnostic_time	string (date-time)	Datime of the diagnostic (wire: diagnosticTime)
incident	boolean	Is there an ongoing genericIncident on the access ?
is_active_on_lns	boolean	Is the access active on its primary or secondary LNS (wire: isActiveOnLns)
is_modem_connected	boolean	Is the modem connected ? (wire: isModemConnected)
line_details	array	Test details by line (wire: lineDetails)
maintenance	boolean	Is there an ongoing scheduled maintenance by operator on the access ?
ping	boolean	Does the access ping ?
remaining	integer	Remaining number of diagnostic for this access

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Returns the last diagnostic of the access: modem connection, ping, LNS activity, ongoing incident or maintenance, line details, available tests and remaining diagnostics.
create	insert	service_name		Starts a diagnostic 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 the last diagnostic of the access: modem connection, ping, LNS activity, ongoing incident or maintenance, line details, available tests and remaining diagnostics.

SELECT
capabilities,
diagnostic_time,
incident,
is_active_on_lns,
is_modem_connected,
line_details,
maintenance,
ping,
remaining
FROM ovh.xdsl.diagnostics
WHERE service_name = '{{ service_name }}' -- required
;

INSERT examples

create

Starts a diagnostic of the access. Returns the task that performs the change.

INSERT INTO ovh.xdsl.diagnostics (
service_name
)
SELECT 
'{{ service_name }}'
RETURNING
id,
done_date,
function,
is_archived,
status,
todo_date,
update_date
;

Manifest

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