options

Creates, updates, deletes, gets or lists an options resource.

Overview

Name	options
Type	Resource
Id	ovh.vps.options

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
option	string	The option name (additionalDisk, automatedBackup, cpanel, ftpbackup, plesk, snapshot, veeam, windows)
state	string	The state of the option (released, subscribed)

list

Information about the options of a VPS Virtual Machine

Name	Datatype	Description
option	string	The option name (additionalDisk, automatedBackup, cpanel, ftpbackup, plesk, snapshot, veeam, windows)
state	string	The state of the option (released, subscribed)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	option, service_name		Returns the option and its state on the VPS.
list	select	service_name	x_pagination_mode	Returns the options attached to the VPS.
delete	delete	option, service_name	delete_now	Releases an option from the VPS. This call is deprecated. (Deprecated, will be removed)

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"}})
option	string	Option
service_name	string	Service name (wire: serviceName)
delete_now	boolean	Delete option now, don't wait for expiration (wire: deleteNow)
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

Returns the option and its state on the VPS.

SELECT
option,
state
FROM ovh.vps.options
WHERE option = '{{ option }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the options attached to the VPS.

SELECT
option,
state
FROM ovh.vps.options
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

DELETE examples

delete

Releases an option from the VPS. This call is deprecated. (Deprecated, will be removed)

DELETE FROM ovh.vps.options
WHERE option = '{{ option }}' --required
AND service_name = '{{ service_name }}' --required
AND delete_now = '{{ delete_now }}'
;