modem_firmware

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

Overview

Name	modem_firmware
Type	Resource
Id	ovh.xdsl.modem_firmware

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		Returns the firmware version installed on the modem of the access.
create	insert	service_name, firmware		Installs a firmware version on the modem of the access, now or at the given date. Returns the task that performs the change.

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)

SELECT examples

get

Returns the firmware version installed on the modem of the access.

SELECT
value
FROM ovh.xdsl.modem_firmware
WHERE service_name = '{{ service_name }}' -- required
;

INSERT examples

create

Installs a firmware version on the modem of the access, now or at the given date. Returns the task that performs the change.

INSERT INTO ovh.xdsl.modem_firmware (
firmware,
todo_date,
service_name
)
SELECT 
'{{ firmware }}' /* required */,
'{{ todo_date }}',
'{{ service_name }}'
RETURNING
id,
done_date,
function,
is_archived,
status,
todo_date,
update_date
;

Manifest

# Description fields are for documentation purposes
- name: modem_firmware
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the modem_firmware resource.
  - name: firmware
    value: "{{ firmware }}"
    description: |
      The firmware version to upgrade to
  - name: todo_date
    value: "{{ todo_date }}"
    description: |
      Date of execution, default is now