Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
outlinetrue

By sending requests to the Virtual Machine endpoint /vm/ you can list, create, update or delete VMs.

...

NameTypeDescription
uuidstringVirtualCenter-specific 128-bit UUID of a virtual machine, represented as a hexademical string. This identifier is used by VirtualCenter to uniquely identify all virtual machine instances, including those that may share the same SMBIOS UUID.
namestringVirtual Machine name including VSS prefix.
ConfigVM Configuration
bootdelayintegerDelay in milliseconds before starting the boot sequence. The boot delay specifies a time interval between virtual machine power on or restart and the beginning of the boot sequence.
hotaddCPUbooleanWhether virtual processors can be added while this virtual machine is running.
hotremoveCpubooleanWhether virtual processors can be removed while this virtual machine is running.
hotaddMembooleanWhether memory can be added while this virtual machine is running.
FolderLogical Folder
namestringImmediate folder holding VM
parentstringParent folder holding the VM
pathstringFull path to immediate folder
GuestGuest status and configuration
guestFullNamestringThis is the full name of the guest operating system for the virtual machine. For example: Windows 2000 Professional.
guestIdstringGuest operating system configured on a virtual machine.
hostNamestringHostname of the guest operating system, if known.
ipAddressstringPrimary IP address assigned to the guest operating system, if known.
toolsStatusstringCurrent running status of VMware Tools in the guest operating system, if known.
toolsVersionstringCurrent version status of VMware Tools in the guest operating system, if known.
Hardware 
cpuCountintegerNumber of processors in the virtual machine. 
coresPerSocketintegerNumber of cores used to distribute virtual CPUs among sockets in this virtual machine. If the value is unset it implies to numCoresPerSocket = 1.
memoryMBintegerMemory size of the virtual machine, in megabytes.
numEthernetCardsintegerNumber of virtual network adapters. 
numVirtualDisksintegerNumber of virtual disks attached to the virtual machine. 
devicesstringList of strings holding controllers, cd/dvd, disks and nics configured in the VM
versionstringThe version string for this virtual machine.
StorageStorage summary
provisionedGBinteger

Sum of Committed and Uncommitted storage.

uncommittedGBintegerAdditional storage space, in bytes, potentially used by this virtual machine on all datastores.
committedGBintegerTotal storage space, in bytes, committed to this virtual machine across all datastores.
unsharedGBintegerTotal storage space, in bytes, occupied by the virtual machine across all datastores, that is not shared with any other virtual machine.
StatusRuntime status related attributes
overallStatusstringOverall alarm status on this node.
powerStatestringThe current power state of the virtual machine.
alarmsbooleanWhether the VM has triggered alarms.
bootTimeStringThe timestamp when the virtual machine was most recently powered on.
VSSVSS Management tags
AdminstringVM admin Admin responsible of this VM.
InformstringInformational contacts to be notified.
Requestedstring

The timestamp when the virtual machine was requested.

ClientstringCustom client key-value notes.

...