boots

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

Overview

Name	boots
Type	Resource
Id	ovh.dedicated_server.boots

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
boot_id	integer	boot id (wire: bootId)
boot_type	string	the boot system (harddisk, internal, network, power, rescue) (wire: bootType)
description	string	the boot description
kernel	string	The boot kernel

list

Available boots

Name	Datatype	Description
boot_id	integer	boot id (wire: bootId)
boot_type	string	the boot system (harddisk, internal, network, power, rescue) (wire: bootType)
description	string	the boot description
kernel	string	The boot kernel

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	boot_id, service_name		Get a netboot. Returns a netboot compatible with the server: its boot type, its kernel and its description.
list	select	service_name	boot_type, x_pagination_mode	List compatible netboots. Returns the identifiers of the netboots compatible with the server. Filter them by boot type (harddisk, network, rescue, internal or power) with the bootType parameter.

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"}})
boot_id	integer	boot id (wire: bootId)
service_name	string	The internal name of your dedicated server (wire: serviceName)
boot_type	string	Filter the value of bootType property (=) (wire: bootType)
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 a netboot. Returns a netboot compatible with the server: its boot type, its kernel and its description.

SELECT
boot_id,
boot_type,
description,
kernel
FROM ovh.dedicated_server.boots
WHERE boot_id = '{{ boot_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List compatible netboots. Returns the identifiers of the netboots compatible with the server. Filter them by boot type (harddisk, network, rescue, internal or power) with the bootType parameter.

SELECT
boot_id,
boot_type,
description,
kernel
FROM ovh.dedicated_server.boots
WHERE service_name = '{{ service_name }}' -- required
AND boot_type = '{{ boot_type }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;