REST API - get
  1. Operations
  2. vcenter
  3. vm
  4. hardware
  5. boot
  6. device

vcenter vm hardware boot device: get

Returns an ordered list of boot devices for the virtual machine. If the array is empty, the virtual machine uses a default boot sequence.

Request:

HTTP request

GET https://{server}/rest/vcenter/vm/{vm}/hardware/boot/device

Path Parameters

Name Type Description
Required
vm string Virtual machine identifier.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : [
        {
            "disks" : [
                "obj-103",
                "obj-103"
            ],
            "nic" : "obj-103",
            "type" : "CDROM"
        },
        {
            "disks" : [
                "obj-103",
                "obj-103"
            ],
            "nic" : "obj-103",
            "type" : "CDROM"
        }
    ]
}

Response Type:

Name Type Description
bold = required
value entry[] Ordered list of configured boot devices.
value[].type string Virtual device type.

Defines the valid device types that may be used as bootable devices. Value is one of:
CDROM: Virtual CD-ROM device.
DISK: Virtual disk device.
ETHERNET: Virtual Ethernet adapter.
FLOPPY: Virtual floppy drive.
value[].nic string Virtual Ethernet device. Ethernet device to use as boot device for this entry.

Optional. It is only relevant when type has value ETHERNET. This field is optional and it is only relevant when the value of type is ETHERNET.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.
value[].disks string[] Virtual disk device. List of virtual disks in boot order.

Optional. It is only relevant when type has value DISK. This field is optional and it is only relevant when the value of type is DISK.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vcenter.vm.hardware.Disk. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vcenter.vm.hardware.Disk.

Errors:

HTTP Status Code Type Description
500 error if the system reports an error while responding to the request.
404 not_found if the virtual machine is not found.
500 resource_inaccessible if the virtual machine's configuration state cannot be accessed.
503 service_unavailable if the system is unable to communicate with a service to complete the request.
401 unauthenticated if the user can not be authenticated.
403 unauthorized if the user doesn't have the required privileges.