Skip to main content

specifications_hardware

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

Overview​

Namespecifications_hardware
TypeResource
Idovh.dedicated_server.specifications_hardware

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
default_disk_group_idintegerDefault disk group id used for OS reinstallation when not specified (wire: defaultDiskGroupId)
processor_namestringprocessor name (wire: processorName)
boot_modestringServer boot mode (legacy, uefi, uefi-legacy) (wire: bootMode)
cores_per_processorintegernumber of cores per processor (wire: coresPerProcessor)
default_hardware_raid_sizeobjectDefault hardware raid size for this server (wire: defaultHardwareRaidSize)
default_hardware_raid_typestringDefault hardware raid type configured on this server (raid0, raid1, raid10, raid1E, raid5, raid50, raid6, raid60) (wire: defaultHardwareRaidType)
descriptionstringcommercial name of this server
disk_groupsarraydetails about the groups of disks in the server (wire: diskGroups)
expansion_cardsarraydetails about the server's expansion cards (wire: expansionCards)
form_factorstringServer form factor (0.25u, 0.5u, 1u, 2u, 3u, 4u) (wire: formFactor)
memory_sizeobjectram capacity (wire: memorySize)
motherboardstringserver motherboard
number_of_processorsintegernumber of processors in this dedicated server (wire: numberOfProcessors)
processor_architecturestringprocessor architecture bit (arm64, armhf32, ppc64, x86, x86-ht, x86_64) (wire: processorArchitecture)
threads_per_processorintegernumber of threads per processor (wire: threadsPerProcessor)
usb_keysarrayCapacity of the USB keys installed on your server, if any (wire: usbKeys)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectservice_nameGet the hardware specifications. Returns the hardware of the server: commercial name, processors, memory, disk groups, expansion cards, motherboard, form factor and default RAID settings.

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​

Get the hardware specifications. Returns the hardware of the server: commercial name, processors, memory, disk groups, expansion cards, motherboard, form factor and default RAID settings.

SELECT
default_disk_group_id,
processor_name,
boot_mode,
cores_per_processor,
default_hardware_raid_size,
default_hardware_raid_type,
description,
disk_groups,
expansion_cards,
form_factor,
memory_size,
motherboard,
number_of_processors,
processor_architecture,
threads_per_processor,
usb_keys
FROM ovh.dedicated_server.specifications_hardware
WHERE service_name = '{{ service_name }}' -- required
;