Host System Get Summary

Host System Get Summary

Basic information about the host, including connection state.

Request
URI
GET
https://{api_host}/sdk/vim25/{release}/HostSystem/{moId}/summary
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId, in this case HostSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns HostListSummary of type(s) application/json
"HostListSummary Object"
host
Optional

The reference to the host-managed object.

hardware
Optional

Basic hardware information, if known.

runtime
Optional

Basic runtime information, if known.

config
Required

Basic configuration information, if known.

quickStats
Required

Basic host statistics.

overallStatus
Required

The overall alarm status of the host.

In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Since this property is on a DataObject, an update returned by WaitForUpdatesEx may contain values for this property when some other property on the DataObject changes. If this update is a result of a call to WaitForUpdatesEx with a non-empty version parameter, the value for this property may not be current.

boolean
rebootRequired
Required

Indicates whether or not the host requires a reboot due to a configuration change.

array of object
customValue
Optional

The customized field values.

string
managementServerIp
Optional

IP address of the VirtualCenter server managing this host, if any.

string
maxEVCModeKey
Optional

The most capable Enhanced VMotion Compatibility mode supported by the host hardware and software; unset if this host cannot participate in any EVC mode.

See also Capability.supportedEVCMode.

string
currentEVCModeKey
Optional

The Enhanced VMotion Compatibility mode that is currently in effect for this host.

If the host is in a cluster where EVC is active, this will match the cluster's EVC mode; otherwise this will be unset.

See also Capability.supportedEVCMode.

string
currentEVCGraphicsModeKey
Optional

The Enhanced VMotion Compatibility Graphics mode that is currently in effect for this host.

If the host is in a cluster where EVC is active, this will match the cluster's EVC Graphics mode; otherwise this will be unset.

See also Capability.supportedEVCGraphicsMode.

Since: vSphere API Release 7.0.1.0

gateway
Optional

Gateway configuration, if vCenter server manages the host via a gateway

object
tpmAttestation
Optional

This data object type represents result of TPM attestation.

array of object
trustAuthorityAttestationInfos
Optional

The attestation information for the host as retrieved from any Trust Authority attestation services configured in the host's parent compute resource.

This field will be set only if there is any Trust Authority attestation service configured for the host's parent compute resource, and unset otherwise.

Since: vSphere API Release 7.0.1.0


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/sdk/vim25/{release}/HostSystem/{moId}/summary
                
Virtual Infrastructure Operations
POST
Host System Acquire Cim Services Ticket
POST
Host System Configure Crypto Key
POST
Host System Destroy Task
POST
Host System Disconnect Host Task
POST
Host System Enable Crypto
POST
Host System Enter Lockdown Mode
Deprecated
POST
Host System Enter Maintenance Mode Task
POST
Host System Power Down Host To Stand By Task
POST
Host System Exit Lockdown Mode
Deprecated
POST
Host System Exit Maintenance Mode Task
POST
Host System Power Up Host From Stand By Task
POST
Host System Prepare Crypto
POST
Host System Query Host Connection Info
POST
Host System Query Memory Overhead
Deprecated
POST
Host System Query Memory Overhead Ex
Deprecated
POST
Host System Query Product Locker Location
POST
Host System Query Tpm Attestation Report
POST
Host System Reboot Host Task
POST
Host System Reconfigure Host For DAS Task
POST
Host System Reconnect Host Task
POST
Host System Reload
POST
Host System Rename Task
POST
Host System Retrieve Free Epc Memory
POST
Host System Retrieve Hardware Uptime
POST
Host System Set Custom Value
POST
Host System Shutdown Host Task
POST
Host System Update Flags
POST
Host System Update Ipmi
POST
Host System Update Product Locker Location Task
POST
Host System Update System Resources
Deprecated
POST
Host System Update System Swap Configuration
GET
Host System Get Alarm Actions Enabled
GET
Host System Get Answer File Validation Result
GET
Host System Get Answer File Validation State
GET
Host System Get Available Field
GET
Host System Get Capability
GET
Host System Get Compliance Check Result
GET
Host System Get Compliance Check State
GET
Host System Get Config
GET
Host System Get Config Issue
GET
Host System Get Config Manager
GET
Host System Get Config Status
GET
Host System Get Custom Value
GET
Host System Get Datastore
GET
Host System Get Datastore Browser
GET
Host System Get Declared Alarm State
GET
Host System Get Disabled Method
GET
Host System Get Effective Role
GET
Host System Get Hardware
GET
Host System Get Licensable Resource
GET
Host System Get Name
GET
Host System Get Network
GET
Host System Get Overall Status
GET
Host System Get Parent
GET
Host System Get Permission
GET
Host System Get Precheck Remediation Result
GET
Host System Get Recent Task
GET
Host System Get Remediation Result
GET
Host System Get Remediation State
GET
Host System Get Runtime
GET
Host System Get Summary
GET
Host System Get System Resources
GET
Host System Get Tag
GET
Host System Get Triggered Alarm State
GET
Host System Get Value
GET
Host System Get Vm