Esx.Settings.Hosts.Configuration.ReferenceHostInfo

Esx.Settings.Hosts.Configuration.ReferenceHostInfo
Esx.Settings.Hosts.Configuration.ReferenceHostInfo

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

Warning: this schema is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

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 connected.
  • DISCONNECTED: The reference host is disconnected.
  • UNAVAILABLE: There is no reference host.

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

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

string
host
Optional

The ID of the reference host.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This property is optional and it is only relevant when the value of status is one of Esx.Settings.Hosts.Configuration.ReferenceHostInfo.Status.OK or Esx.Settings.Hosts.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.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

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

summary
Required

A summary of the reference host status.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.