REST API - summary

vcenter VM: summary

The summary structure contains commonly used information about a virtual machine.

Representations:

JSON
XML

{
    "cpu_count": 1,
    "memory_size_MiB": 1,
    "name": "string",
    "power_state": "POWERED_OFF",
    "vm": "obj-103"
}

<?xml version="1.0" ?>
<ns0:Summary xmlns:ns0="http://vmware.com/vcenter/VM" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <cpu_count>1</cpu_count>
  <vm>obj-103</vm>
  <memory_size_MiB>1</memory_size_MiB>
  <power_state>POWERED_OFF</power_state>
  <name>string</name>
</ns0:Summary>

Attributes:

Name	Type	Description
Required
vm	string	Identifier of the virtual machine. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `VirtualMachine`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `VirtualMachine`.
name	string	Name of the Virtual machine.
power_state	string	Power state of the virtual machine. Defines the valid power states for a virtual machine. Value is one of: POWERED_OFF: The virtual machine is powered off. POWERED_ON: The virtual machine is powered on. SUSPENDED: The virtual machine is suspended.
Optional
cpu_count	long	Number of CPU cores. Optional. This field will be unset if the virtual machine configuration is not available. For example, the configuration information would be unavailable if the server is unable to access the virtual machine files on disk, and is often also unavailable during the intial phases of virtual machine creation.
memory_size_MiB	long	Memory size in mebibytes. Optional. This field will be unset if the virtual machine configuration is not available. For example, the configuration information would be unavailable if the server is unable to access the virtual machine files on disk, and is often also unavailable during the intial phases of virtual machine creation.