This API has a deprecated equivalent from v7.0U1.
Get Hardware Disk
Returns information about a virtual disk.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/hardware/disk/{disk}
Path Parameters
Path Parameters
string
vm
Required
Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
string
disk
Required
Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
VmHardwareDiskInfo
of type application/json
Information about the specified virtual disk.
{
"backing": {
"type": "VMDK_FILE",
"vmdk_file": "string"
},
"capacity": 0,
"ide": {
"master": false,
"primary": false
},
"label": "string",
"nvme": {
"bus": 0,
"unit": 0
},
"sata": {
"bus": 0,
"unit": 0
},
"scsi": {
"bus": 0,
"unit": 0
},
"type": "IDE"
}
type
Required
The Disk.HostBusAdapterType enumerated type defines the valid types of host bus adapters that may be used for attaching a virtual storage device to a virtual machine.
IDE : Disk is attached to an IDE adapter.
SCSI : Disk is attached to a SCSI adapter.
SATA : Disk is attached to a SATA adapter.
NVME : Disk is attached to a NVMe adapter.
Possible values are: IDE , SCSI , SATA , NVME
string
label
Required
Device label.
ide
Optional
Address of device attached to a virtual IDE adapter. Workaround for PR1459646
nvme
Optional
Address of device attached to a virtual NVMe adapter. This field is optional and it is only relevant when the value of Disk.Info.type is NVME.
sata
Optional
Address of device attached to a virtual SATA adapter. Workaround for PR1459646
scsi
Optional
Address of device attached to a virtual SCSI adapter. Workaround for PR1459646
integer
capacity
Optional
Capacity of the virtual disk in bytes. If unset, virtual disk is inaccessible or disk capacity is 0.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
404
com.vmware.vapi.std.errors.not_found : if the virtual machine or virtual disk is not found.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.resource_inaccessible : if the virtual machine’s configuration state cannot be accessed.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetVmDiskHardware -Vm "MyVm" -Disk "MyDisk"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}/hardware/disk/{disk}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/vm/{vm}/hardware/disk/{disk}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
On This Page
Hardware Disk Operations
post
patch
delete
