REST API - summary

vcenter host: summary

The summary structure contains commonly used information about a host in vCenter Server.

Representations:

JSON
XML

{
    "connection_state": "CONNECTED",
    "host": "obj-103",
    "name": "string",
    "power_state": "POWERED_ON"
}

<?xml version="1.0" ?>
<ns0:Summary xmlns:ns0="http://vmware.com/vcenter/host" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <connection_state>CONNECTED</connection_state>
  <host>obj-103</host>
  <power_state>POWERED_ON</power_state>
  <name>string</name>
</ns0:Summary>

Attributes:

Name	Type	Description
Required
host	string	Identifier of the host. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `HostSystem`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `HostSystem`.
name	string	Name of the host.
connection_state	string	Connection status of the host Defines the connection status of a host. Value is one of: CONNECTED: Host is connected to the vCenter Server DISCONNECTED: Host is disconnected from the vCenter Server NOT_RESPONDING: VirtualCenter is not receiving heartbeats from the server. The state automatically changes to connected once heartbeats are received again.
Optional
power_state	string	Power state of the host Defines the power states of a host. Value is one of: POWERED_ON: The host is powered on. A host that is entering standby mode is also in this state. POWERED_OFF: The host was specifically powered off by the user through vCenter server. This state is not a cetain state, because after vCenter server issues the command to power off the host, the host might crash, or kill all the processes but fail to power off. STANDBY: The host was specifically put in standby mode, either explicitly by the user, or automatically by DPM. This state is not a cetain state, because after VirtualCenter issues the command to put the host in standby state, the host might crash, or kill all the processes but fail to enter standby mode. A host that is exiting standby mode is also in this state.Optional. It is only relevant when connection_state has value CONNECTED. This field is optional and it is only relevant when the value of `connection_state` is CONNECTED.