HostRuntimeInfo

HostRuntimeInfo
HostRuntimeInfo

This data object type describes the runtime state of a host.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "connectionState": "string",
    "powerState": "string",
    "standbyMode": "string",
    "inMaintenanceMode": false,
    "inQuarantineMode": false,
    "bootTime": "string",
    "healthSystemRuntime": {
        "_typeName": "string",
        "systemHealthInfo": {
            "_typeName": "string",
            "numericSensorInfo": [
                {
                    "_typeName": "string",
                    "name": "string",
                    "healthState": {
                        "_typeName": "string",
                        "label": "string",
                        "summary": "string",
                        "key": "string"
                    },
                    "currentReading": 0,
                    "unitModifier": 0,
                    "baseUnits": "string",
                    "rateUnits": "string",
                    "sensorType": "string",
                    "id": "string",
                    "sensorNumber": 0,
                    "timeStamp": "string",
                    "fru": {
                        "_typeName": "string",
                        "type": "string",
                        "partName": "string",
                        "partNumber": "string",
                        "manufacturer": "string",
                        "serialNumber": "string",
                        "mfgTimeStamp": "string"
                    }
                }
            ]
        },
        "hardwareStatusInfo": {
            "_typeName": "string",
            "memoryStatusInfo": [
                {
                    "_typeName": "string",
                    "name": "string",
                    "status": {
                        "_typeName": "string",
                        "label": "string",
                        "summary": "string",
                        "key": "string"
                    }
                }
            ],
            "cpuStatusInfo": [
                {
                    "_typeName": "string",
                    "name": "string",
                    "status": {
                        "_typeName": "string",
                        "label": "string",
                        "summary": "string",
                        "key": "string"
                    }
                }
            ],
            "storageStatusInfo": [
                {
                    "_typeName": "string",
                    "name": "string",
                    "status": {
                        "_typeName": "string",
                        "label": "string",
                        "summary": "string",
                        "key": "string"
                    },
                    "operationalInfo": [
                        {
                            "_typeName": "string",
                            "property": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "dpuStatusInfo": [
                {
                    "_typeName": "string",
                    "name": "string",
                    "status": {
                        "_typeName": "string",
                        "label": "string",
                        "summary": "string",
                        "key": "string"
                    },
                    "dpuId": "string",
                    "fru": {
                        "_typeName": "string",
                        "type": "string",
                        "partName": "string",
                        "partNumber": "string",
                        "manufacturer": "string",
                        "serialNumber": "string",
                        "mfgTimeStamp": "string"
                    },
                    "sensors": [
                        {
                            "_typeName": "string",
                            "sensorId": "string",
                            "healthState": {
                                "_typeName": "string",
                                "label": "string",
                                "summary": "string",
                                "key": "string"
                            },
                            "reading": "string",
                            "units": "string",
                            "timeStamp": "string"
                        }
                    ]
                }
            ]
        }
    },
    "dasHostState": {
        "_typeName": "string",
        "state": "string",
        "stateReporter": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    },
    "tpmPcrValues": [
        {
            "_typeName": "string",
            "digestMethod": "string",
            "digestValue": [
                0
            ],
            "objectName": "string",
            "pcrNumber": 0
        }
    ],
    "vsanRuntimeInfo": {
        "_typeName": "string",
        "membershipList": [
            {
                "_typeName": "string",
                "nodeUuid": "string",
                "hostname": "string"
            }
        ],
        "diskIssues": [
            {
                "_typeName": "string",
                "diskId": "string",
                "issue": "string"
            }
        ],
        "accessGenNo": 0
    },
    "networkRuntimeInfo": {
        "_typeName": "string",
        "netStackInstanceRuntimeInfo": [
            {
                "_typeName": "string",
                "netStackInstanceKey": "string",
                "state": "string",
                "vmknicKeys": [
                    "string"
                ],
                "maxNumberOfConnections": 0,
                "currentIpV6Enabled": false
            }
        ],
        "networkResourceRuntime": {
            "_typeName": "string",
            "pnicResourceInfo": [
                {
                    "_typeName": "string",
                    "pnicDevice": "string",
                    "availableBandwidthForVMTraffic": 0,
                    "unusedBandwidthForVMTraffic": 0,
                    "placedVirtualNics": [
                        {
                            "_typeName": "string",
                            "vm": {
                                "_typeName": "string",
                                "type": "string",
                                "value": "string"
                            },
                            "vnicKey": "string",
                            "reservation": 0
                        }
                    ]
                }
            ]
        }
    },
    "vFlashResourceRuntimeInfo": {
        "_typeName": "string",
        "usage": 0,
        "capacity": 0,
        "accessible": false,
        "capacityForVmCache": 0,
        "freeForVmCache": 0
    },
    "hostMaxVirtualDiskCapacity": 0,
    "cryptoState": "string",
    "cryptoKeyId": {
        "_typeName": "string",
        "keyId": "string",
        "providerId": {
            "_typeName": "string",
            "id": "string"
        }
    },
    "statelessNvdsMigrationReady": "string",
    "partialMaintenanceMode": [
        {
            "_typeName": "string",
            "key": "string",
            "hostStatus": "string"
        }
    ],
    "stateEncryption": {
        "_typeName": "string",
        "protectionMode": "string",
        "requireSecureBoot": false,
        "requireExecInstalledOnly": false
    }
}
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.

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

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