Vcenter VM get
Returns information about a virtual machine.
Returns an authorization error if you do not have all of the privileges described as follows:
- The resource
VirtualMachinereferenced by the parameter vm requiresSystem.Read.
Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine.
Information about the specified virtual machine.
{
"guest_os": "string",
"name": "string",
"identity": {
"name": "string",
"bios_uuid": "string",
"instance_uuid": "string"
},
"power_state": "string",
"instant_clone_frozen": false,
"hardware": {
"version": "string",
"upgrade_policy": "string",
"upgrade_version": "string",
"upgrade_status": "string",
"upgrade_error": {}
},
"boot": {
"type": "string",
"efi_legacy_boot": false,
"network_protocol": "string",
"delay": 0,
"retry": false,
"retry_delay": 0,
"enter_setup_mode": false
},
"boot_devices": [
{
"type": "string",
"nic": "string",
"disks": [
"string"
]
}
],
"cpu": {
"count": 0,
"cores_per_socket": 0,
"hot_add_enabled": false,
"hot_remove_enabled": false
},
"memory": {
"size_mib": 0,
"hot_add_enabled": false,
"hot_add_increment_size_mib": 0,
"hot_add_limit_mib": 0
},
"disks": {
"disks": {
"label": "string",
"type": "string",
"ide": {
"primary": false,
"master": false
},
"scsi": {
"bus": 0,
"unit": 0
},
"sata": {
"bus": 0,
"unit": 0
},
"nvme": {
"bus": 0,
"unit": 0
},
"backing": {
"type": "string",
"vmdk_file": "string"
},
"capacity": 0
}
},
"nics": {
"nics": {
"label": "string",
"type": "string",
"upt_compatibility_enabled": false,
"upt_v2_compatibility_enabled": false,
"mac_type": "string",
"mac_address": "string",
"pci_slot_number": 0,
"wake_on_lan_enabled": false,
"backing": {
"type": "string",
"network": "string",
"network_name": "string",
"host_device": "string",
"distributed_switch_uuid": "string",
"distributed_port": "string",
"connection_cookie": 0,
"opaque_network_type": "string",
"opaque_network_id": "string"
},
"state": "string",
"start_connected": false,
"allow_guest_control": false
}
},
"cdroms": {
"cdroms": {
"type": "string",
"label": "string",
"ide": {
"primary": false,
"master": false
},
"sata": {
"bus": 0,
"unit": 0
},
"backing": {
"type": "string",
"iso_file": "string",
"host_device": "string",
"auto_detect": false,
"device_access_type": "string"
},
"state": "string",
"start_connected": false,
"allow_guest_control": false
}
},
"floppies": {
"floppies": {
"label": "string",
"backing": {
"type": "string",
"image_file": "string",
"host_device": "string",
"auto_detect": false
},
"state": "string",
"start_connected": false,
"allow_guest_control": false
}
},
"parallel_ports": {
"parallel_ports": {
"label": "string",
"backing": {
"type": "string",
"file": "string",
"host_device": "string",
"auto_detect": false
},
"state": "string",
"start_connected": false,
"allow_guest_control": false
}
},
"serial_ports": {
"serial_ports": {
"label": "string",
"yield_on_poll": false,
"backing": {
"type": "string",
"file": "string",
"host_device": "string",
"auto_detect": false,
"pipe": "string",
"no_rx_loss": false,
"network_location": "string",
"proxy": "string"
},
"state": "string",
"start_connected": false,
"allow_guest_control": false
}
},
"sata_adapters": {
"sata_adapters": {
"label": "string",
"type": "string",
"bus": 0,
"pci_slot_number": 0
}
},
"scsi_adapters": {
"scsi_adapters": {
"label": "string",
"type": "string",
"scsi": {
"bus": 0,
"unit": 0
},
"pci_slot_number": 0,
"sharing": "string"
}
},
"nvme_adapters": {
"nvme_adapters": {
"label": "string",
"bus": 0,
"pci_slot_number": 0
}
}
}Guest OS.
For more information see: Vcenter Vm GuestOS.
Virtual machine name.
Identity of the virtual machine.
This property was added in vSphere API 6.7.1.
This property is optional because it was added in a newer version than its parent node.
Power state of the virtual machine.
For more information see: Vcenter Vm Power State.
Indicates whether the virtual machine is frozen for instant clone, or not.
This property was added in vSphere API 6.7.1.
This property is optional because it was added in a newer version than its parent node.
Virtual hardware version information.
Boot configuration.
Boot device configuration. If the list has no entries, a server-specific default boot sequence is used.
CPU configuration.
Memory configuration.
List of disks.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.
List of Ethernet adapters.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.
List of CD-ROMs.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.
List of floppy drives.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Floppy. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Floppy.
List of parallel ports.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ParallelPort. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ParallelPort.
List of serial ports.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.
List of SATA adapters.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.
List of SCSI adapters.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ScsiAdapter. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ScsiAdapter.
List of NVMe adapters.
This property was added in vSphere API 7.0.0.1.
This property is optional because it was added in a newer version than its parent node.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.NvmeAdapter. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.NvmeAdapter.
if the user can not be authenticated.
{
"messages": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
],
"data": {},
"error_type": "string",
"challenge": "string"
}Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
if the user doesn't have the required privileges.
{
"messages": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
],
"data": {},
"error_type": "string"
}if the virtual machine is not found.
{
"messages": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
],
"data": {},
"error_type": "string"
}Vapi Std Errors Error if the system reports an error while responding to the request.
Vapi Std Errors ResourceInaccessible if the virtual machine's configuration state cannot be accessed.
{
"messages": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
],
"data": {},
"error_type": "string"
}Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
if the system is unable to communicate with a service to complete the request.
{
"messages": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
],
"data": {},
"error_type": "string"
} curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/vm/{vm}