VMware · Schema

HostSummary

Summary of an ESXi host in the vCenter inventory

Cloud ComputingContainer ManagementHybrid CloudInfrastructureVirtualization

Properties

Name	Type	Description
host	string	Unique identifier of the host (e.g., host-10)
name	string	Display name or hostname of the ESXi host
connection_state	string	Connection state of the host
power_state	string	Power state of the host

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HostSummary",
  "title": "HostSummary",
  "type": "object",
  "description": "Summary of an ESXi host in the vCenter inventory",
  "required": [
    "host",
    "name"
  ],
  "properties": {
    "host": {
      "type": "string",
      "description": "Unique identifier of the host (e.g., host-10)",
      "example": "example_value"
    },
    "name": {
      "type": "string",
      "description": "Display name or hostname of the ESXi host",
      "example": "Example Title"
    },
    "connection_state": {
      "type": "string",
      "description": "Connection state of the host",
      "enum": [
        "CONNECTED",
        "DISCONNECTED",
        "NOT_RESPONDING"
      ],
      "example": "CONNECTED"
    },
    "power_state": {
      "type": "string",
      "description": "Power state of the host",
      "enum": [
        "POWERED_ON",
        "POWERED_OFF",
        "STANDBY"
      ],
      "example": "POWERED_ON"
    }
  }
}