modem_connected_devices

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

Overview

Name	modem_connected_devices
Type	Resource
Id	ovh.xdsl.modem_connected_devices

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
host_name	string	Host name given by the device to the modem (wire: hostName)
active	boolean	The state of this device on the modem
address_source	string	How did the device got its IP address (DHCP, Static, Unknown) (wire: addressSource)
information_date	string (date-time)	The date time of the last update of thoses information (wire: informationDate)
interface_type	string	On which interface is connected the device (wire: interfaceType)
ip_address	string (ipv4)	The IP address of the device (example: 192.0.2.0) (wire: ipAddress)
lease_time_remaining	integer	The remaining time in seconds of the DHCP lease of this device (-1 means infinite) (wire: leaseTimeRemaining)
mac_address	string	MAC address of the device (wire: macAddress)

list

Connected Device

Name	Datatype	Description
host_name	string	Host name given by the device to the modem (wire: hostName)
active	boolean	The state of this device on the modem
address_source	string	How did the device got its IP address (DHCP, Static, Unknown) (wire: addressSource)
information_date	string (date-time)	The date time of the last update of thoses information (wire: informationDate)
interface_type	string	On which interface is connected the device (wire: interfaceType)
ip_address	string (ipv4)	The IP address of the device (example: 192.0.2.0) (wire: ipAddress)
lease_time_remaining	integer	The remaining time in seconds of the DHCP lease of this device (-1 means infinite) (wire: leaseTimeRemaining)
mac_address	string	MAC address of the device (wire: macAddress)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	mac_address, service_name		Returns the host name, IP address, interface, DHCP lease time and state of a device connected to the modem.
list	select	service_name	x_pagination_mode	Returns the MAC addresses of the devices connected to the modem of the access.

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"}})
mac_address	string	Mac address (wire: macAddress)
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 host name, IP address, interface, DHCP lease time and state of a device connected to the modem.

SELECT
host_name,
active,
address_source,
information_date,
interface_type,
ip_address,
lease_time_remaining,
mac_address
FROM ovh.xdsl.modem_connected_devices
WHERE mac_address = '{{ mac_address }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the MAC addresses of the devices connected to the modem of the access.

SELECT
host_name,
active,
address_source,
information_date,
interface_type,
ip_address,
lease_time_remaining,
mac_address
FROM ovh.xdsl.modem_connected_devices
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;