Esx.Settings.Clusters.Configuration.ReferenceHostInfo

The Esx.Settings.Clusters.Configuration.ReferenceHostInfo schema contains properties that describe the host that was used as a reference for generating the schema.

This schema was added in vSphere API 8.0.3.0.

JSON Example

{
    "status": "string",
    "host": "string",
    "name": "string",
    "summary": "Vapi.Std.LocalizableMessage Object"
}

string

status

Required

The current status of the reference host.

Possible values:

OK: The reference host is in the cluster and connected.
DISCONNECTED: The reference host is in the cluster, but disconnected.
UNAVAILABLE: There is no reference host or it is no longer in the cluster.

For more information see: Esx.Settings.Clusters.Configuration.ReferenceHostInfo.Status.

This property was added in vSphere API 8.0.3.0.

string

host

Optional

The ID of the reference host.

This property was added in vSphere API 8.0.3.0.

This property is optional and it is only relevant when the value of status is one of Esx.Settings.Clusters.Configuration.ReferenceHostInfo.Status.OK or Esx.Settings.Clusters.Configuration.ReferenceHostInfo.Status.DISCONNECTED.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the property will be an identifier for the resource type: HostSystem.

string

name

Optional

The name of the reference host.

This property was added in vSphere API 8.0.3.0.

summary

Required

A summary of the reference host status.

This property was added in vSphere API 8.0.3.0.