licenses

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

Overview

Name	licenses
Type	Resource
Id	ovh.license_directadmin.licenses

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
client_id	integer	The client id on license provider side (wire: clientId)
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)
os	string	This license operating system (CentOs_5.0_32, CentOs_5.0_64, CentOs_6_32, CentOs_6_64, CentOs_7_64, CentOs_8_64, Debian_10.0_64, Debian_11.0_64, Debian_5.0_32, Debian_5.0_64, Debian_6.0_32, Debian_6.0_64, Debian_7.0_64, Debian_8.0_64, Debian_9.0_64, FreeBSD_11.x_64, FreeBSD_12.x_64, FreeBSD_7.x_32, FreeBSD_7.x_64, FreeBSD_8.x_64, FreeBSD_9.x_64)
status	string	This license state (ok, released, terminated, toDeliver)
version	string	This license version (DIRECTADMIN_1, directadmin-license)

list

Your DirectAdmin license

Name	Datatype	Description
client_id	integer	The client id on license provider side (wire: clientId)
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)
os	string	This license operating system (CentOs_5.0_32, CentOs_5.0_64, CentOs_6_32, CentOs_6_64, CentOs_7_64, CentOs_8_64, Debian_10.0_64, Debian_11.0_64, Debian_5.0_32, Debian_5.0_64, Debian_6.0_32, Debian_6.0_64, Debian_7.0_64, Debian_8.0_64, Debian_9.0_64, FreeBSD_11.x_64, FreeBSD_12.x_64, FreeBSD_7.x_32, FreeBSD_7.x_64, FreeBSD_8.x_64, FreeBSD_9.x_64)
status	string	This license state (ok, released, terminated, toDeliver)
version	string	This license version (DIRECTADMIN_1, directadmin-license)

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
change_os	exec	serviceName, os		Change the Operating System for a license
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 DirectAdmin license
service_name	string	The name of your DirectAdmin 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
client_id,
license_id,
creation,
delete_at_expiration,
domain,
iam,
ip,
os,
status,
version
FROM ovh.license_directadmin.licenses
WHERE service_name = '{{ service_name }}' -- required
;

list

List available services

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

UPDATE examples

update

Alter this object properties

UPDATE ovh.license_directadmin.licenses
SET 
delete_at_expiration = {{ delete_at_expiration }},
os = '{{ os }}'
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_directadmin.licenses.change_ip 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"destinationIp": "{{ destinationIp }}"
}'
;

change_os

Change the Operating System for a license

EXEC ovh.license_directadmin.licenses.change_os 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"os": "{{ os }}"
}'
;

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_directadmin.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_directadmin.licenses.terminate 
@serviceName='{{ serviceName }}' --required
;