templates

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

Overview

Name	templates
Type	Resource
Id	ovh.dedicated_installation_template.templates

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
template_name	string	This template name (wire: templateName)
bit_format	integer	this template bit format (32, 64) (wire: bitFormat)
category	string	category of this template (informative only) (backup, basic, customer, database, erp, hosting, management, other, readyToUse, virtualisation, virtualization)
description	string	information about this template
distribution	string	the distribution this template is based on
end_of_install	string (date)	after this date, install of this template will not be possible at OVH (wire: endOfInstall)
family	string	this template family type (bsd, custom, ibm, linux, solaris, unix, windows)
filesystems	array	list of all filesystems available for this template
inputs	array	Inputs
license	object	This distribution licensing details
lvm_ready	boolean	This distribution supports Logical Volumes (Linux LVM) (wire: lvmReady)
no_partitioning	boolean	Partitioning customization is not available for this OS template (wire: noPartitioning)
project	object	This distribution project details
root_mountpoint	string	The mandatory mount point of the root filesystem on this OS (wire: rootMountpoint)
soft_raid_only_mirroring	boolean	Partitioning customization is available but limited to mirroring for this OS template (wire: softRaidOnlyMirroring)
subfamily	string	this template subfamily type (alma, aos, arch, byoi, byolinux, centos, cloudlinux, coreos, debian, dgx, esxi, fedora, freebsd, gentoo, hyperv, omnios, openio, openmediavault, opensuse, ovh, pcs, power, proxmox, rhel, rocky, slackware, sles-sap, smartos, solusvm, ubuntu, windows-server-core, windows-server-desktop-exp, xcp, xen)

list

Available installation templates

Name	Datatype	Description
template_name	string	This template name (wire: templateName)
bit_format	integer	this template bit format (32, 64) (wire: bitFormat)
category	string	category of this template (informative only) (backup, basic, customer, database, erp, hosting, management, other, readyToUse, virtualisation, virtualization)
description	string	information about this template
distribution	string	the distribution this template is based on
end_of_install	string (date)	after this date, install of this template will not be possible at OVH (wire: endOfInstall)
family	string	this template family type (bsd, custom, ibm, linux, solaris, unix, windows)
filesystems	array	list of all filesystems available for this template
inputs	array	Inputs
license	object	This distribution licensing details
lvm_ready	boolean	This distribution supports Logical Volumes (Linux LVM) (wire: lvmReady)
no_partitioning	boolean	Partitioning customization is not available for this OS template (wire: noPartitioning)
project	object	This distribution project details
root_mountpoint	string	The mandatory mount point of the root filesystem on this OS (wire: rootMountpoint)
soft_raid_only_mirroring	boolean	Partitioning customization is available but limited to mirroring for this OS template (wire: softRaidOnlyMirroring)
subfamily	string	this template subfamily type (alma, aos, arch, byoi, byolinux, centos, cloudlinux, coreos, debian, dgx, esxi, fedora, freebsd, gentoo, hyperv, omnios, openio, openmediavault, opensuse, ovh, pcs, power, proxmox, rhel, rocky, slackware, sles-sap, smartos, solusvm, ubuntu, windows-server-core, windows-server-desktop-exp, xcp, xen)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	template_name		Get an installation template. Returns the details of an installation template, such as its distribution, family, filesystems and inputs. After its endOfInstall date, the template can no longer be installed. This call does not require authentication.
list	select		x_pagination_mode	List installation templates. Returns the names of the operating system installation templates. This call does not require authentication. To get the templates compatible with a server, use GET /dedicated/server/{serviceName}/install/compatibleTemplates.

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"}})
template_name	string	This template name (wire: templateName)
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 installation template. Returns the details of an installation template, such as its distribution, family, filesystems and inputs. After its endOfInstall date, the template can no longer be installed. This call does not require authentication.

SELECT
template_name,
bit_format,
category,
description,
distribution,
end_of_install,
family,
filesystems,
inputs,
license,
lvm_ready,
no_partitioning,
project,
root_mountpoint,
soft_raid_only_mirroring,
subfamily
FROM ovh.dedicated_installation_template.templates
WHERE template_name = '{{ template_name }}' -- required
;

list

List installation templates. Returns the names of the operating system installation templates. This call does not require authentication. To get the templates compatible with a server, use GET /dedicated/server/{serviceName}/install/compatibleTemplates.

SELECT
template_name,
bit_format,
category,
description,
distribution,
end_of_install,
family,
filesystems,
inputs,
license,
lvm_ready,
no_partitioning,
project,
root_mountpoint,
soft_raid_only_mirroring,
subfamily
FROM ovh.dedicated_installation_template.templates
WHERE x_pagination_mode = '{{ x_pagination_mode }}'
;