options

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

Overview

Name	options
Type	Resource
Id	ovh.dedicated_server.options

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
option	string	The option name (BACKUPPROTOCOL, BANDWIDTH, BANDWIDTH_VRACK, OLA, SGX, TRAFFIC, TRAFFIC_DISCOVER, TUNING, TUNING_FIREWALL, TUNING_KVM, USB_KVM_IP)
state	string	The state of the option (released, subscribed)

list

Information about the options of a dedicated server

Name	Datatype	Description
option	string	The option name (BACKUPPROTOCOL, BANDWIDTH, BANDWIDTH_VRACK, OLA, SGX, TRAFFIC, TRAFFIC_DISCOVER, TUNING, TUNING_FIREWALL, TUNING_KVM, USB_KVM_IP)
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		Get an option. Returns the state of an option of the server, subscribed or released. The option is identified by its name, such as BANDWIDTH, OLA or SGX.
list	select	service_name	x_pagination_mode	List options. Returns the names of the options of the server. Get an option to know whether it is subscribed or released.
delete	delete	option, service_name		Release an option. Releases an option of the server, identified by its name, such as BANDWIDTH, TRAFFIC or USB_KVM_IP. The name is one of the options a server can have and release.

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	The option name
service_name	string	The internal name of your dedicated server (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

Get an option. Returns the state of an option of the server, subscribed or released. The option is identified by its name, such as BANDWIDTH, OLA or SGX.

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

list

List options. Returns the names of the options of the server. Get an option to know whether it is subscribed or released.

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

DELETE examples

delete

Release an option. Releases an option of the server, identified by its name, such as BANDWIDTH, TRAFFIC or USB_KVM_IP. The name is one of the options a server can have and release.

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