partition_scheme_partitions

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

Overview

Name	partition_scheme_partitions
Type	Resource
Id	ovh.dedicated_installation_template.partition_scheme_partitions

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
volume_name	string	Logical volume name (required if type is lv) or optional zpool name if filesystem is ZFS (wire: volumeName)
filesystem	string	Partition filesytem (btrfs, ext3, ext4, fat16, none, ntfs, reiserfs, swap, ufs, vmfs5, vmfs6, vmfsl, xfs, zfs)
mountpoint	string	Partition mount point
order	integer	specifies the creation order of the partition on the disk
raid	string	Partition raid (0, 1, 10, 5, 6, 7)
size	object	Partition size (unit: MB GB TB, MB by default), 0 => rest of the space
type	string	Partition type (logical, lv, primary)

list

Partitions defined in this partitioning scheme

Name	Datatype	Description
volume_name	string	Logical volume name (required if type is lv) or optional zpool name if filesystem is ZFS (wire: volumeName)
filesystem	string	Partition filesytem (btrfs, ext3, ext4, fat16, none, ntfs, reiserfs, swap, ufs, vmfs5, vmfs6, vmfsl, xfs, zfs)
mountpoint	string	Partition mount point
order	integer	specifies the creation order of the partition on the disk
raid	string	Partition raid (0, 1, 10, 5, 6, 7)
size	object	Partition size (unit: MB GB TB, MB by default), 0 => rest of the space
type	string	Partition type (logical, lv, primary)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	mountpoint, scheme_name, template_name		Get a partition. Returns the filesystem, type, size, RAID level and creation order of a partition of the partitioning scheme. A size of 0 means the rest of the disk space.
list	select	scheme_name, template_name	x_pagination_mode	List partitions. Returns the mount points of the partitions defined in the partitioning scheme. Each partition has a filesystem, a type, a size and a creation order on the disk.

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"}})
mountpoint	string	Partition mount point
scheme_name	string	This partitioning scheme name (wire: schemeName)
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 a partition. Returns the filesystem, type, size, RAID level and creation order of a partition of the partitioning scheme. A size of 0 means the rest of the disk space.

SELECT
volume_name,
filesystem,
mountpoint,
order,
raid,
size,
type
FROM ovh.dedicated_installation_template.partition_scheme_partitions
WHERE mountpoint = '{{ mountpoint }}' -- required
AND scheme_name = '{{ scheme_name }}' -- required
AND template_name = '{{ template_name }}' -- required
;

list

List partitions. Returns the mount points of the partitions defined in the partitioning scheme. Each partition has a filesystem, a type, a size and a creation order on the disk.

SELECT
volume_name,
filesystem,
mountpoint,
order,
raid,
size,
type
FROM ovh.dedicated_installation_template.partition_scheme_partitions
WHERE scheme_name = '{{ scheme_name }}' -- required
AND template_name = '{{ template_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;