HostSummary

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

Properties

HostConnectionState Enum

connection_state Required

Connection status of the host

Possible values are: CONNECTED , DISCONNECTED , NOT_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.

HostPowerState Enum

power_state Optional

Power state of the host This field is optional and it is only relevant when the value of Host.Summary.connection-state is CONNECTED.

Possible values are: POWERED_ON , POWERED_OFF , STANDBY

JSON Example

Show optional properties

{
    "connection_state": "enum",
    "host": "string",
    "name": "string"
}

{
    "connection_state": "enum",
    "host": "string",
    "name": "string",
    "power_state": "enum"
}

Returned By

List Host

HostSummary

Properties

JSON Example

Returned By

Was this page helpful?