HostSummary

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


Properties

connection_state Required

The Host.ConnectionState enumerated type defines the connection status of a host.
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.

Possible values are: CONNECTEDDISCONNECTEDNOT_RESPONDING


string
host Required

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.


string
name Required

Name of the host.


power_state Optional

The Host.PowerState enumerated type defines the power states of a host.
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.

Possible values are: POWERED_ONPOWERED_OFFSTANDBY

JSON Example

{
	"connection_state": "CONNECTED",
	"host": "string",
	"name": "string"
}
Returned By

List Host

Feedback

Was this page helpful?