licenses

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

Overview

Name	licenses
Type	Resource
Id	ovh.license_worklight.licenses

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
license_id	string	The license id on license provider side (wire: licenseId)
creation	string (date-time)	This license creation date
delete_at_expiration	boolean	Shall we delete this on expiration ? (wire: deleteAtExpiration)
domain	string	The internal name of your license
iam	object	IAM resource metadata
ip	string (ipv4)	The ip on which this license is attached (example: 192.0.2.0)
status	string	This license state (ok, released, terminated, toDeliver)
version	string	This license version (VERSION-6.1U.1CPU, VERSION-6.1U.2CPU, VERSION-6.2U.1CPU, VERSION-6.2U.2CPU, VERSION-6.EVALUATION, worklight-license-version-6-1cpu-1u, worklight-license-version-6-1cpu-2u, worklight-license-version-6-2cpu-1u, worklight-license-version-6-2cpu-2u)

list

Your WorkLight license

Name	Datatype	Description
license_id	string	The license id on license provider side (wire: licenseId)
creation	string (date-time)	This license creation date
delete_at_expiration	boolean	Shall we delete this on expiration ? (wire: deleteAtExpiration)
domain	string	The internal name of your license
iam	object	IAM resource metadata
ip	string (ipv4)	The ip on which this license is attached (example: 192.0.2.0)
status	string	This license state (ok, released, terminated, toDeliver)
version	string	This license version (VERSION-6.1U.1CPU, VERSION-6.1U.2CPU, VERSION-6.2U.1CPU, VERSION-6.2U.2CPU, VERSION-6.EVALUATION, worklight-license-version-6-1cpu-1u, worklight-license-version-6-1cpu-2u, worklight-license-version-6-2cpu-1u, worklight-license-version-6-2cpu-2u)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Get this object properties
list	select		iam_tags, x_pagination_mode	List available services
update	update	service_name		Alter this object properties
change_ip	exec	serviceName, destinationIp		Move this license to another Ip
confirm_termination	exec	serviceName, token		Confirm service termination. Terminates the service with the token sent by email to the admin contact. A reason, a future use and a comment can be given.
terminate	exec	serviceName		Request service termination. Starts the termination of the service. The admin contact receives a token by email, to confirm with the confirmTermination call.

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	The name of your WorkLight license
service_name	string	The name of your WorkLight license (wire: serviceName)
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
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 this object properties

SELECT
license_id,
creation,
delete_at_expiration,
domain,
iam,
ip,
status,
version
FROM ovh.license_worklight.licenses
WHERE service_name = '{{ service_name }}' -- required
;

list

List available services

SELECT
license_id,
creation,
delete_at_expiration,
domain,
iam,
ip,
status,
version
FROM ovh.license_worklight.licenses
WHERE iam_tags = '{{ iam_tags }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Alter this object properties

UPDATE ovh.license_worklight.licenses
SET 
delete_at_expiration = {{ delete_at_expiration }}
WHERE 
service_name = '{{ service_name }}' --required;

Lifecycle Methods

EXEC variables use wire (API) names.

change_ip

Move this license to another Ip

EXEC ovh.license_worklight.licenses.change_ip 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"destinationIp": "{{ destinationIp }}"
}'
;

confirm_termination

Confirm service termination. Terminates the service with the token sent by email to the admin contact. A reason, a future use and a comment can be given.

EXEC ovh.license_worklight.licenses.confirm_termination 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"commentary": "{{ commentary }}", 
"futureUse": "{{ futureUse }}", 
"reason": "{{ reason }}", 
"token": "{{ token }}"
}'
;

terminate

Request service termination. Starts the termination of the service. The admin contact receives a token by email, to confirm with the confirmTermination call.

EXEC ovh.license_worklight.licenses.terminate 
@serviceName='{{ serviceName }}' --required
;