modem_wifis

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

Overview

Name	modem_wifis
Type	Resource
Id	ovh.xdsl.modem_wifis

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)
wifi_name	string	Name of the Wifi (wire: wifiName)
band_steering	boolean	Indicate if frequencies 2.4GHz and 5GHz are agregated (wire: bandSteering)
channel	integer	Choice of a channel (When chosen, channelMode is set to Manual)
channel_mode	string	How the WiFi channel is selected (Auto, Manual) (wire: channelMode)
enabled	boolean	Wifi state
frequency	string	Frequency (2.4GHz | 5GHz) (2.4GHz, 5GHz)
guest	boolean	Indicate if it is normal access wifi or guest wifi
security_key	string	WiFi security key (wire: securityKey)
security_type	string	Type of WLAN security protection (None, WEP, WPA, WPA2, WPA2andWPA3, WPA3, WPAandWPA2) (wire: securityType)
ssid	string	Service Set Identifier of the WLAN interface (wire: SSID)
ssid_advertisement_enabled	boolean	Hide or show the Wifi (wire: SSIDAdvertisementEnabled)

list

WLAN Configuration of the Modem

Name	Datatype	Description
task_id	integer	ID of the ongoing todo (NULL if none) (wire: taskId)
wifi_name	string	Name of the Wifi (wire: wifiName)
band_steering	boolean	Indicate if frequencies 2.4GHz and 5GHz are agregated (wire: bandSteering)
channel	integer	Choice of a channel (When chosen, channelMode is set to Manual)
channel_mode	string	How the WiFi channel is selected (Auto, Manual) (wire: channelMode)
enabled	boolean	Wifi state
frequency	string	Frequency (2.4GHz | 5GHz) (2.4GHz, 5GHz)
guest	boolean	Indicate if it is normal access wifi or guest wifi
security_key	string	WiFi security key (wire: securityKey)
security_type	string	Type of WLAN security protection (None, WEP, WPA, WPA2, WPA2andWPA3, WPA3, WPAandWPA2) (wire: securityType)
ssid	string	Service Set Identifier of the WLAN interface (wire: SSID)
ssid_advertisement_enabled	boolean	Hide or show the Wifi (wire: SSIDAdvertisementEnabled)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name, wifi_name		Returns the SSID, state, visibility, frequency, channel, security type and key of a WiFi network, and whether it is a guest network.
list	select	service_name	x_pagination_mode	Returns the names of the WiFi networks of the modem of the access.
update	update	service_name, wifi_name		Changes the SSID, state, visibility, channel, channel mode, security type or security key of a WiFi network.

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)
wifi_name	string	Wifi name (wire: wifiName)
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 SSID, state, visibility, frequency, channel, security type and key of a WiFi network, and whether it is a guest network.

SELECT
task_id,
wifi_name,
band_steering,
channel,
channel_mode,
enabled,
frequency,
guest,
security_key,
security_type,
ssid,
ssid_advertisement_enabled
FROM ovh.xdsl.modem_wifis
WHERE service_name = '{{ service_name }}' -- required
AND wifi_name = '{{ wifi_name }}' -- required
;

list

Returns the names of the WiFi networks of the modem of the access.

SELECT
task_id,
wifi_name,
band_steering,
channel,
channel_mode,
enabled,
frequency,
guest,
security_key,
security_type,
ssid,
ssid_advertisement_enabled
FROM ovh.xdsl.modem_wifis
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Changes the SSID, state, visibility, channel, channel mode, security type or security key of a WiFi network.

UPDATE ovh.xdsl.modem_wifis
SET 
ssid = '{{ ssid }}',
ssid_advertisement_enabled = {{ ssid_advertisement_enabled }},
channel = {{ channel }},
channel_mode = '{{ channel_mode }}',
enabled = {{ enabled }},
security_key = '{{ security_key }}',
security_type = '{{ security_type }}'
WHERE 
service_name = '{{ service_name }}' --required
AND wifi_name = '{{ wifi_name }}' --required;