Host System Get Runtime

Host System Get Runtime

Runtime state information about the host such as connection state.

Request
URI
GET
https://{api_host}/sdk/vim25/{release}/HostSystem/{moId}/runtime
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 HostRuntimeInfo of type(s) application/json
"HostRuntimeInfo Object"
connectionState
Required

The host connection state.

See the description in the enums for the ConnectionState data object type.

powerState
Required

The host power state.

See the description in the enums for the PowerState data object type.

string
standbyMode
Optional

The host's standby mode.

For valid values see HostStandbyModeEnum. The property is only populated by vCenter server. If queried directly from a ESX host, the property is is unset.

boolean
inMaintenanceMode
Required

The flag to indicate whether or not the host is in maintenance mode.

This flag is set when the host has entered the maintenance mode. It is not set during the entering phase of maintenance mode.

See also HostSystem.EnterMaintenanceMode_Task, HostSystem.ExitMaintenanceMode_Task.

boolean
inQuarantineMode
Optional

The flag to indicate whether or not the host is in quarantine mode.

InfraUpdateHa will recommend to set this flag based on the HealthUpdates received by the HealthUpdateProviders configured for the cluster. A host that is reported as degraded will be recommended to enter quarantine mode, while a host that is reported as healthy will be recommended to exit quarantine mode. Execution of these recommended actions will set this flag. Hosts in quarantine mode will be avoided by vSphere DRS as long as the increased consolidation in the cluster does not negatively affect VM performance.

See also HealthUpdateManager, ClusterInfraUpdateHaConfigInfo, ClusterHostInfraUpdateHaModeAction.

string As date-time As date-time
bootTime
Optional

The time when the host was booted.

healthSystemRuntime
Optional

Available system health status

dasHostState
Optional

The availability state of an active host in a vSphere HA enabled cluster.

A host is inactive if it is in maintenance or standby mode, or it has been disconnected from vCenter Server. The active hosts in a cluster form a vSphere HA fault domain.

The property is unset if vSphere HA is disabled, the host is in maintenance or standby mode, or the host is disconnected from vCenter Server. The property is set to hostDown if the host has crashed.

array of object
tpmPcrValues
Optional

Deprecated as of @released("5.1") this information should be considered to be neither complete nor reliable.

The array of PCR digest values stored in the TPM device since the last host boot time.

vsanRuntimeInfo
Optional

Host Runtime information related to the VSAN service.

See also VsanHostRuntimeInfo.

networkRuntimeInfo
Optional

This property is for getting network related runtime info

vFlashResourceRuntimeInfo
Optional

Runtime information of vFlash resource of the host.

integer As int64 As int64
hostMaxVirtualDiskCapacity
Optional

The maximum theoretical virtual disk capacity supported by this host

string
cryptoState
Optional

Encryption state of the host.

Valid values are enumerated by the CryptoState type.

cryptoKeyId
Optional

Crypto Key used for coredump encryption

string
statelessNvdsMigrationReady
Optional

Indicating the host is ready for NVDS to VDS migration.

See HostRuntimeInfoStatelessNvdsMigrationStateEnum for supported values.

Since: vSphere API Release 7.0.2.0

array of object
partialMaintenanceMode
Optional

The following list contains the runtime status for all the partial maintenance modes currently supported on the host.

Since: vSphere API Release 8.0.3.0

stateEncryption
Optional

Host persistent state encryption information.

Since: vSphere API Release 7.0.3.0


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/sdk/vim25/{release}/HostSystem/{moId}/runtime
                
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