modem_wifi_qr_codes
Creates, updates, deletes, gets or lists a modem_wifi_qr_codes resource.
Overview​
| Name | modem_wifi_qr_codes |
| Type | Resource |
| Id | ovh.xdsl.modem_wifi_qr_codes |
Fields​
The following fields are returned by SELECT queries:
- get
| Name | Datatype | Description |
|---|---|---|
value | string |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name, wifi_name | Returns, as a base64 image, the QR code to connect to the WiFi network of the modem, when the modem supports it. |
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) |
SELECT examples​
- get
Returns, as a base64 image, the QR code to connect to the WiFi network of the modem, when the modem supports it.
SELECT
value
FROM ovh.xdsl.modem_wifi_qr_codes
WHERE service_name = '{{ service_name }}' -- required
AND wifi_name = '{{ wifi_name }}' -- required
;