options
Creates, updates, deletes, gets or lists an options resource.
Overview​
| Name | options |
| Type | Resource |
| Id | ovh.license_plesk.options |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
amount | string | Quantity or corresponding label of the designated option enabled on your license |
can_be_deleted | boolean | Specifies whether this option can be released or not (wire: canBeDeleted) |
expiration_date | string (date-time) | This option expiration date (wire: expirationDate) |
label | string | This option designation (ANTISPAM_SPAMASSASSIN, ANTIVIRUS_DRWEB, ANTIVIRUS_KASPERSKY, DOMAINS, LANGUAGE_PACK, POWERPACK, SQL_SERVER, VIRTUOZZO_CONTAINERS) |
version | string | This option related version |
Your License options
| Name | Datatype | Description |
|---|---|---|
amount | string | Quantity or corresponding label of the designated option enabled on your license |
can_be_deleted | boolean | Specifies whether this option can be released or not (wire: canBeDeleted) |
expiration_date | string (date-time) | This option expiration date (wire: expirationDate) |
label | string | This option designation (ANTISPAM_SPAMASSASSIN, ANTIVIRUS_DRWEB, ANTIVIRUS_KASPERSKY, DOMAINS, LANGUAGE_PACK, POWERPACK, SQL_SERVER, VIRTUOZZO_CONTAINERS) |
version | string | This option related version |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | label, service_name | Get this object properties | |
list | select | service_name | x_pagination_mode | options attached to this license |
delete | delete | label, service_name | release this Option |
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"}}) |
label | string | This option designation |
service_name | string | The name of your Plesk license (wire: serviceName) |
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
- list
Get this object properties
SELECT
amount,
can_be_deleted,
expiration_date,
label,
version
FROM ovh.license_plesk.options
WHERE label = '{{ label }}' -- required
AND service_name = '{{ service_name }}' -- required
;
options attached to this license
SELECT
amount,
can_be_deleted,
expiration_date,
label,
version
FROM ovh.license_plesk.options
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;
DELETE examples​
- delete
release this Option
DELETE FROM ovh.license_plesk.options
WHERE label = '{{ label }}' --required
AND service_name = '{{ service_name }}' --required
;