This API has a deprecated equivalent from v7.0U1.
Get VM
DescriptionReturns information about a virtual machine. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires System.Read.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}
Path Parameters
Path Parameters
string
vm
Required
Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
vmware-api-session-id example
b00db39f948d13ea1e59b4d6fce56389
Response
Response
Response BodyResponse Body
200 OK returns
VMInfo of type application/json
Information about the specified virtual machine.
{
"boot": {
"delay": 0,
"efi_legacy_boot": false,
"enter_setup_mode": false,
"network_protocol": "enum",
"retry": false,
"retry_delay": 0,
"type": "enum"
},
"boot_devices": [
{
"disks": [
"string"
],
"nic": "string",
"type": "enum"
}
],
"cdroms": {
"key": {
"allow_guest_control": false,
"backing": {
"auto_detect": false,
"device_access_type": "enum",
"host_device": "string",
"iso_file": "string",
"type": "enum"
},
"ide": {
"master": false,
"primary": false
},
"label": "string",
"sata": {
"bus": 0,
"unit": 0
},
"start_connected": false,
"state": "enum",
"type": "enum"
}
},
"cpu": {
"cores_per_socket": 0,
"count": 0,
"hot_add_enabled": false,
"hot_remove_enabled": false
},
"disks": {
"key": {
"backing": {
"type": "enum",
"vmdk_file": "string"
},
"capacity": 0,
"ide": {
"master": false,
"primary": false
},
"label": "string",
"sata": {
"bus": 0,
"unit": 0
},
"scsi": {
"bus": 0,
"unit": 0
},
"type": "enum"
}
},
"floppies": {
"key": {
"allow_guest_control": false,
"backing": {
"auto_detect": false,
"host_device": "string",
"image_file": "string",
"type": "enum"
},
"label": "string",
"start_connected": false,
"state": "enum"
}
},
"guest_OS": "enum",
"hardware": {
"upgrade_policy": "enum",
"upgrade_status": "enum",
"upgrade_version": "enum",
"version": "enum"
},
"identity": {
"bios_uuid": "string",
"instance_uuid": "string",
"name": "string"
},
"instant_clone_frozen": false,
"memory": {
"hot_add_enabled": false,
"hot_add_increment_size_MiB": 0,
"hot_add_limit_MiB": 0,
"size_MiB": 0
},
"name": "string",
"nics": {
"key": {
"allow_guest_control": false,
"backing": {
"connection_cookie": 0,
"distributed_port": "string",
"distributed_switch_uuid": "string",
"host_device": "string",
"network": "string",
"network_name": "string",
"opaque_network_id": "string",
"opaque_network_type": "string",
"type": "enum"
},
"label": "string",
"mac_address": "string",
"mac_type": "enum",
"pci_slot_number": 0,
"start_connected": false,
"state": "enum",
"type": "enum",
"upt_compatibility_enabled": false,
"wake_on_lan_enabled": false
}
},
"parallel_ports": {
"key": {
"allow_guest_control": false,
"backing": {
"auto_detect": false,
"file": "string",
"host_device": "string",
"type": "enum"
},
"label": "string",
"start_connected": false,
"state": "enum"
}
},
"power_state": "enum",
"sata_adapters": {
"key": {
"bus": 0,
"label": "string",
"pci_slot_number": 0,
"type": "enum"
}
},
"scsi_adapters": {
"key": {
"label": "string",
"pci_slot_number": 0,
"scsi": {
"bus": 0,
"unit": 0
},
"sharing": "enum",
"type": "enum"
}
},
"serial_ports": {
"key": {
"allow_guest_control": false,
"backing": {
"auto_detect": false,
"file": "string",
"host_device": "string",
"network_location": "string",
"no_rx_loss": false,
"pipe": "string",
"proxy": "string",
"type": "enum"
},
"label": "string",
"start_connected": false,
"state": "enum",
"yield_on_poll": false
}
}
}
map of
VmHardwareSerialInfo
serial_ports
Required
List of serial ports. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.
array of
VmHardwareBootDeviceEntry
boot_devices
Required
Boot device configuration. If the list has no entries, a server-specific default boot sequence is used.
map of
VmHardwareCdromInfo
cdroms
Required
List of CD-ROMs. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.
map of
VmHardwareDiskInfo
disks
Required
List of disks. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.
map of
VmHardwareFloppyInfo
floppies
Required
List of floppy drives. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Floppy. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Floppy.
guest_OS
Required
Guest OS.
Possible values are: DOS , WIN_31 , WIN_95 , WIN_98 , WIN_ME , more...
map of
VmHardwareAdapterScsiInfo
scsi_adapters
Required
List of SCSI adapters. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ScsiAdapter. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ScsiAdapter.
string
name
Required
Virtual machine name.
map of
VmHardwareEthernetInfo
nics
Required
List of Ethernet adapters. When clients pass a value of this structure as a parameter, the key in the field map 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 key in the field map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.
map of
VmHardwareParallelInfo
parallel_ports
Required
List of parallel ports. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ParallelPort. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ParallelPort.
power_state
Required
Power state of the virtual machine.
Possible values are: POWERED_OFF , POWERED_ON , SUSPENDED
map of
VmHardwareAdapterSataInfo
sata_adapters
Required
List of SATA adapters. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.
identity
Optional
Identity of the virtual machine. This field is optional because it was added in a newer version than its parent node.
boolean
instant_clone_frozen
Optional
Indicates whether the virtual machine is frozen for instant clone, or not. This field is optional because it was added in a newer version than its parent node.
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges.
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.
Availability
Added in 7.0U2
On This Page
VM Operations
get
post
get
delete
post
post
post
post
post
post
post
