modem_lans

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

Overview

Name	modem_lans
Type	Resource
Id	ovh.xdsl.modem_lans

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
task_id	integer	ID of the ongoing todo (NULL if none) (wire: taskId)
lan_name	string	Name of the LAN (wire: lanName)
addressing_type	string	How the modem gets its LAN IP Address (DHCP, Static) (wire: addressingType)
ip_address	string (ipv4)	IP address (e.g., 192.0.2.0) (example: 192.0.2.0) (wire: IPAddress)
subnet_mask	string (ipv4)	IP address (e.g., 192.0.2.0) (example: 192.0.2.0) (wire: subnetMask)

list

LAN Configuration of the Modem

Name	Datatype	Description
task_id	integer	ID of the ongoing todo (NULL if none) (wire: taskId)
lan_name	string	Name of the LAN (wire: lanName)
addressing_type	string	How the modem gets its LAN IP Address (DHCP, Static) (wire: addressingType)
ip_address	string (ipv4)	IP address (e.g., 192.0.2.0) (example: 192.0.2.0) (wire: IPAddress)
subnet_mask	string (ipv4)	IP address (e.g., 192.0.2.0) (example: 192.0.2.0) (wire: subnetMask)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	lan_name, service_name		Returns the IP address, subnet mask and addressing type of a LAN of the modem.
list	select	service_name	x_pagination_mode	Returns the names of the LANs configured on the modem of the access.
update	update	lan_name, service_name		Changes the IP address, subnet mask and addressing type of a LAN of the modem.

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"}})
lan_name	string	Lan name (wire: lanName)
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 IP address, subnet mask and addressing type of a LAN of the modem.

SELECT
task_id,
lan_name,
addressing_type,
ip_address,
subnet_mask
FROM ovh.xdsl.modem_lans
WHERE lan_name = '{{ lan_name }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the names of the LANs configured on the modem of the access.

SELECT
task_id,
lan_name,
addressing_type,
ip_address,
subnet_mask
FROM ovh.xdsl.modem_lans
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Changes the IP address, subnet mask and addressing type of a LAN of the modem.

UPDATE ovh.xdsl.modem_lans
SET 
ip_address = '{{ ip_address }}',
addressing_type = '{{ addressing_type }}',
subnet_mask = '{{ subnet_mask }}'
WHERE 
lan_name = '{{ lan_name }}' --required
AND service_name = '{{ service_name }}' --required;