Skip to main content

orderable_kvms

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

Overview​

Nameorderable_kvms
TypeResource
Idovh.dedicated_server.orderable_kvms

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
valueboolean

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectservice_nameCheck whether a KVM is orderable. Returns true if a KVM can be ordered for the server, false otherwise. KVM Express has its own route, orderable/kvmExpress.

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"}})
service_namestringThe internal name of your dedicated server (wire: serviceName)

SELECT examples​

Check whether a KVM is orderable. Returns true if a KVM can be ordered for the server, false otherwise. KVM Express has its own route, orderable/kvmExpress.

SELECT
value
FROM ovh.dedicated_server.orderable_kvms
WHERE service_name = '{{ service_name }}' -- required
;