splas

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

Overview

Name	splas
Type	Resource
Id	ovh.dedicated_server.splas

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	License id
last_update	string (date-time)	Last update timestamp (wire: lastUpdate)
serial_number	string	License serial number (wire: serialNumber)
status	string	Status of license (terminated, used, waitingToCheck)
type	string	License type (os, sqlstd, sqlweb)

list

SPLA licenses management

Name	Datatype	Description
id	integer	License id
last_update	string (date-time)	Last update timestamp (wire: lastUpdate)
serial_number	string	License serial number (wire: serialNumber)
status	string	Status of license (terminated, used, waitingToCheck)
type	string	License type (os, sqlstd, sqlweb)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, service_name		Get an SPLA license. Returns an SPLA license attached to the server: its serial number, type, status and last update date. The status is waitingToCheck, used or terminated.
list	select	service_name	status, type, x_pagination_mode	List SPLA licenses. Returns the IDs of your own SPLA licenses attached to the server. The list can be filtered by status and by license type.
create	insert	service_name, serial_number, type		Add an SPLA license. Attaches an SPLA license to the server from its serial number and its type: os, sqlstd or sqlweb. Returns the ID of the new license.
update	update	id, service_name		Update an SPLA license. Updates the serial number of an SPLA license. The serial number is the only writable field of the license.
revoke	exec	id, serviceName		Revoke an SPLA license. Revokes an SPLA license attached to the server, identified by its license ID. The call returns no content.

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"}})
id	integer	License id
serviceName	string	The internal name of your dedicated server
service_name	string	The internal name of your dedicated server (wire: serviceName)
status	string	Filter the value of status property (=)
type	string	Filter the value of type property (=)
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

Get an SPLA license. Returns an SPLA license attached to the server: its serial number, type, status and last update date. The status is waitingToCheck, used or terminated.

SELECT
id,
last_update,
serial_number,
status,
type
FROM ovh.dedicated_server.splas
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List SPLA licenses. Returns the IDs of your own SPLA licenses attached to the server. The list can be filtered by status and by license type.

SELECT
id,
last_update,
serial_number,
status,
type
FROM ovh.dedicated_server.splas
WHERE service_name = '{{ service_name }}' -- required
AND status = '{{ status }}'
AND type = '{{ type }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Add an SPLA license. Attaches an SPLA license to the server from its serial number and its type: os, sqlstd or sqlweb. Returns the ID of the new license.

INSERT INTO ovh.dedicated_server.splas (
serial_number,
type,
service_name
)
SELECT 
'{{ serial_number }}' /* required */,
'{{ type }}' /* required */,
'{{ service_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: splas
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the splas resource.
  - name: serial_number
    value: "{{ serial_number }}"
    description: |
      License serial number
  - name: type
    value: "{{ type }}"
    description: |
      SPLA license type
    valid_values: ['os', 'sqlstd', 'sqlweb']

UPDATE examples

update

Update an SPLA license. Updates the serial number of an SPLA license. The serial number is the only writable field of the license.

UPDATE ovh.dedicated_server.splas
SET 
serial_number = '{{ serial_number }}'
WHERE 
id = '{{ id }}' --required
AND service_name = '{{ service_name }}' --required;

Lifecycle Methods

EXEC variables use wire (API) names.

revoke

Revoke an SPLA license. Revokes an SPLA license attached to the server, identified by its license ID. The call returns no content.

EXEC ovh.dedicated_server.splas.revoke 
@id='{{ id }}' --required, 
@serviceName='{{ serviceName }}' --required
;