Skip to main content

licenses

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

Overview​

Namelicenses
TypeResource
Idovh.license_cpanel.licenses

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
license_idstringThe license id on license provider side (wire: licenseId)
creationstring (date-time)This license creation date
delete_at_expirationbooleanShall we delete this on expiration ? (wire: deleteAtExpiration)
domainstringThe internal name of your license
iamobjectIAM resource metadata
ipstring (ipv4)The ip on which this license is attached (example: 192.0.2.0)
statusstringThis license state (ok, released, terminated, toDeliver)
versionstringThis license version (VERSION_11_FOR_LINUX, VERSION_11_FOR_VIRTUOZZO, VERSION_11_FOR_VPS, cpanel-license-version-11, cpanel-license-version-11-for-virtuozzo, cpanel-license-version-11-for-vps, version-admin-cloud, version-plus-cloud, version-premier-cloud-100, version-premier-cloud-1000, version-premier-cloud-10000, version-premier-cloud-1100, version-premier-cloud-1200, version-premier-cloud-1300, version-premier-cloud-1400, version-premier-cloud-150, version-premier-cloud-1500, version-premier-cloud-1600, version-premier-cloud-1700, version-premier-cloud-1800, version-premier-cloud-1900, version-premier-cloud-200, version-premier-cloud-2000, version-premier-cloud-2100, version-premier-cloud-2200, version-premier-cloud-2300, version-premier-cloud-2400, version-premier-cloud-250, version-premier-cloud-2500, version-premier-cloud-2600, version-premier-cloud-2700, version-premier-cloud-2800, version-premier-cloud-2900, version-premier-cloud-300, version-premier-cloud-3000, version-premier-cloud-3100, version-premier-cloud-3200, version-premier-cloud-3300, version-premier-cloud-3400, version-premier-cloud-3500, version-premier-cloud-3600, version-premier-cloud-3700, version-premier-cloud-3800, version-premier-cloud-3900, version-premier-cloud-400, version-premier-cloud-4000, version-premier-cloud-4100, version-premier-cloud-4200, version-premier-cloud-4300, version-premier-cloud-4400, version-premier-cloud-4500, version-premier-cloud-4600, version-premier-cloud-4700, version-premier-cloud-4800, version-premier-cloud-4900, version-premier-cloud-500, version-premier-cloud-5000, version-premier-cloud-5100, version-premier-cloud-5200, version-premier-cloud-5300, version-premier-cloud-5400, version-premier-cloud-5500, version-premier-cloud-5600, version-premier-cloud-5700, version-premier-cloud-5800, version-premier-cloud-5900, version-premier-cloud-600, version-premier-cloud-6000, version-premier-cloud-6100, version-premier-cloud-6200, version-premier-cloud-6300, version-premier-cloud-6400, version-premier-cloud-6500, version-premier-cloud-6600, version-premier-cloud-6700, version-premier-cloud-6800, version-premier-cloud-6900, version-premier-cloud-700, version-premier-cloud-7000, version-premier-cloud-7100, version-premier-cloud-7200, version-premier-cloud-7300, version-premier-cloud-7400, version-premier-cloud-7500, version-premier-cloud-7600, version-premier-cloud-7700, version-premier-cloud-7800, version-premier-cloud-7900, version-premier-cloud-800, version-premier-cloud-8000, version-premier-cloud-8100, version-premier-cloud-8200, version-premier-cloud-8300, version-premier-cloud-8400, version-premier-cloud-8500, version-premier-cloud-8600, version-premier-cloud-8700, version-premier-cloud-8800, version-premier-cloud-8900, version-premier-cloud-900, version-premier-cloud-9000, version-premier-cloud-9100, version-premier-cloud-9200, version-premier-cloud-9300, version-premier-cloud-9400, version-premier-cloud-9500, version-premier-cloud-9600, version-premier-cloud-9700, version-premier-cloud-9800, version-premier-cloud-9900, version-premier-metal-100, version-premier-metal-1000, version-premier-metal-10000, version-premier-metal-1100, version-premier-metal-1200, version-premier-metal-1300, version-premier-metal-1400, version-premier-metal-150, version-premier-metal-1500, version-premier-metal-1600, version-premier-metal-1700, version-premier-metal-1800, version-premier-metal-1900, version-premier-metal-200, version-premier-metal-2000, version-premier-metal-2100, version-premier-metal-2200, version-premier-metal-2300, version-premier-metal-2400, version-premier-metal-250, version-premier-metal-2500, version-premier-metal-2600, version-premier-metal-2700, version-premier-metal-2800, version-premier-metal-2900, version-premier-metal-300, version-premier-metal-3000, version-premier-metal-3100, version-premier-metal-3200, version-premier-metal-3300, version-premier-metal-3400, version-premier-metal-3500, version-premier-metal-3600, version-premier-metal-3700, version-premier-metal-3800, version-premier-metal-3900, version-premier-metal-400, version-premier-metal-4000, version-premier-metal-4100, version-premier-metal-4200, version-premier-metal-4300, version-premier-metal-4400, version-premier-metal-4500, version-premier-metal-4600, version-premier-metal-4700, version-premier-metal-4800, version-premier-metal-4900, version-premier-metal-500, version-premier-metal-5000, version-premier-metal-5100, version-premier-metal-5200, version-premier-metal-5300, version-premier-metal-5400, version-premier-metal-5500, version-premier-metal-5600, version-premier-metal-5700, version-premier-metal-5800, version-premier-metal-5900, version-premier-metal-600, version-premier-metal-6000, version-premier-metal-6100, version-premier-metal-6200, version-premier-metal-6300, version-premier-metal-6400, version-premier-metal-6500, version-premier-metal-6600, version-premier-metal-6700, version-premier-metal-6800, version-premier-metal-6900, version-premier-metal-700, version-premier-metal-7000, version-premier-metal-7100, version-premier-metal-7200, version-premier-metal-7300, version-premier-metal-7400, version-premier-metal-7500, version-premier-metal-7600, version-premier-metal-7700, version-premier-metal-7800, version-premier-metal-7900, version-premier-metal-800, version-premier-metal-8000, version-premier-metal-8100, version-premier-metal-8200, version-premier-metal-8300, version-premier-metal-8400, version-premier-metal-8500, version-premier-metal-8600, version-premier-metal-8700, version-premier-metal-8800, version-premier-metal-8900, version-premier-metal-900, version-premier-metal-9000, version-premier-metal-9100, version-premier-metal-9200, version-premier-metal-9300, version-premier-metal-9400, version-premier-metal-9500, version-premier-metal-9600, version-premier-metal-9700, version-premier-metal-9800, version-premier-metal-9900, version-pro-cloud, version-solo-cloud, version-solo-metal)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectservice_nameGet this object properties
listselectiam_tags, x_pagination_modeList available services
updateupdateservice_nameAlter this object properties
change_ipexecserviceName, destinationIpMove this license to another Ip
confirm_terminationexecserviceName, tokenConfirm 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.
terminateexecserviceNameRequest 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.

NameDatatypeDescription
api_hoststringThe 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"}})
serviceNamestringThe name of your Cpanel license
service_namestringThe name of your Cpanel license (wire: serviceName)
iam_tagsobjectFilter resources on IAM tags (wire: iamTags)
x_pagination_modestringSent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples​

Get this object properties

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

UPDATE examples​

Alter this object properties

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

Lifecycle Methods​

EXEC variables use wire (API) names.

Move this license to another Ip

EXEC ovh.license_cpanel.licenses.change_ip 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"destinationIp": "{{ destinationIp }}"
}'
;
Last updated on