modems

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

Overview

Name	modems
Type	Resource
Id	ovh.xdsl.modems

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
brand_name	string	(wire: brandName)
acs_backend	string	ACS backend used by the modem (beta, dev, stable) (wire: acsBackend)
acs_version	string	Version of ACS API used (wire: acsVersion)
capabilities	object	Describe the capabilities of the Modem
dmz_ip	string (ipv4)	IP Address of the DMZ (To modify or delete the DMZ IP on the modem, a re-configuration of your modem has to be made, your configuration will be maintained, but you will lose your connection a few minutes) (example: 192.0.2.0) (wire: dmzIP)
easy_firewall_level	string	Level of the FireWall on the modem (BlockAll, Disabled, Normal) (wire: easyFirewallLevel)
ipv_6_support	boolean	Whether or not the modem supports IPv6 (wire: ipv6Support)
is_bridged	boolean	Whether or not the modem is in bridge mode. To pass from bridge mode to routed mode, a reset is necessary. If the modem is managedByOvh, the bridge state will be kept after a reset (wire: isBridged)
last_cwmp_request_date	string (date-time)	Last time the modem made a CWMP request to the Auto Configuration Server (wire: lastCwmpRequestDate)
mac_address	string	(wire: macAddress)
managed_by_ovh	boolean	Whether or not the user can configure his modem via OVH Interface (will lock telnet and local HTTP configuration page) (wire: managedByOvh)
model	string
mtu_size	integer	Size of the Maximum Transmission Unit on the modem's interfaces (1432, 1456, 1492) (wire: mtuSize)
serial_number	string	(wire: serialNumber)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Returns the modem brand, model, serial and MAC address, its bridge and DMZ settings, MTU, firewall level, IPv6 support, ACS backend and capabilities.
update	update	service_name		Changes the settings that can be modified: management by OVHcloud, bridge mode, DMZ IP, MTU size and ACS backend.
reboot	exec	serviceName		Reboots the modem of the access, now or at the given date. Returns the task that performs the change.
reconfigure_voip	exec	serviceName		Pushes the VoIP line configuration again to the modem of the access.
refresh_connected_devices	exec	serviceName		Reads again from the modem of the access the devices connected to it. Returns the task that performs the change.
reset	exec	serviceName		Resets the modem of the access to its default configuration, and optionally the configuration stored by OVHcloud. Returns the task that performs the change.
reset_port_mapping_config	exec	serviceName		Removes every port mapping rule of the modem of the access.
retrieve_info	exec	serviceName		Reads the general information of the modem of the access. Returns an asynchronous task holding the modem information.

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"}})
serviceName	string	Service name
service_name	string	Service name (wire: serviceName)

SELECT examples

get

Returns the modem brand, model, serial and MAC address, its bridge and DMZ settings, MTU, firewall level, IPv6 support, ACS backend and capabilities.

SELECT
brand_name,
acs_backend,
acs_version,
capabilities,
dmz_ip,
easy_firewall_level,
ipv_6_support,
is_bridged,
last_cwmp_request_date,
mac_address,
managed_by_ovh,
model,
mtu_size,
serial_number
FROM ovh.xdsl.modems
WHERE service_name = '{{ service_name }}' -- required
;

UPDATE examples

update

Changes the settings that can be modified: management by OVHcloud, bridge mode, DMZ IP, MTU size and ACS backend.

UPDATE ovh.xdsl.modems
SET 
acs_backend = '{{ acs_backend }}',
dmz_ip = '{{ dmz_ip }}',
is_bridged = {{ is_bridged }},
managed_by_ovh = {{ managed_by_ovh }},
mtu_size = {{ mtu_size }}
WHERE 
service_name = '{{ service_name }}' --required;

Lifecycle Methods

EXEC variables use wire (API) names.

reboot

Reboots the modem of the access, now or at the given date. Returns the task that performs the change.

EXEC ovh.xdsl.modems.reboot 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"todoDate": "{{ todoDate }}"
}'
;

reconfigure_voip

Pushes the VoIP line configuration again to the modem of the access.

EXEC ovh.xdsl.modems.reconfigure_voip 
@serviceName='{{ serviceName }}' --required
;

refresh_connected_devices

Reads again from the modem of the access the devices connected to it. Returns the task that performs the change.

EXEC ovh.xdsl.modems.refresh_connected_devices 
@serviceName='{{ serviceName }}' --required
;

reset

Resets the modem of the access to its default configuration, and optionally the configuration stored by OVHcloud. Returns the task that performs the change.

EXEC ovh.xdsl.modems.reset 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"resetOvhConfig": {{ resetOvhConfig }}
}'
;

reset_port_mapping_config

Removes every port mapping rule of the modem of the access.

EXEC ovh.xdsl.modems.reset_port_mapping_config 
@serviceName='{{ serviceName }}' --required
;

retrieve_info

Reads the general information of the modem of the access. Returns an asynchronous task holding the modem information.

EXEC ovh.xdsl.modems.retrieve_info 
@serviceName='{{ serviceName }}' --required
;