Host System Get Config
Host configuration information.
Host configuration information.
This might not be available for a disconnected host.
Request
URI
GET
https://{vcenter-host}/sdk/vim25/{release}/HostSystem/{moId}/config
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.1.0.0 APIs.
Responses
200
OK
{
"_typeName": "string",
"host": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"product": {
"_typeName": "string",
"name": "string",
"fullName": "string",
"vendor": "string",
"version": "string",
"patchLevel": "string",
"build": "string",
"localeVersion": "string",
"localeBuild": "string",
"osType": "string",
"productLineId": "string",
"apiType": "string",
"apiVersion": "string",
"instanceUuid": "string",
"licenseProductName": "string",
"licenseProductVersion": "string"
},
"deploymentInfo": {
"_typeName": "string",
"bootedFromStatelessCache": false
},
"hyperThread": {
"_typeName": "string",
"available": false,
"active": false,
"config": false
},
"cpuScheduler": {
"_typeName": "string",
"policy": "string"
},
"consoleReservation": {
"_typeName": "string",
"serviceConsoleReservedCfg": 0,
"serviceConsoleReserved": 0,
"unreserved": 0
},
"virtualMachineReservation": {
"_typeName": "string",
"virtualMachineMin": 0,
"virtualMachineMax": 0,
"virtualMachineReserved": 0,
"allocationPolicy": "string"
},
"storageDevice": {
"_typeName": "string",
"hostBusAdapter": [
{
"_typeName": "string",
"key": "string",
"device": "string",
"bus": 0,
"status": "string",
"model": "string",
"driver": "string",
"pci": "string",
"storageProtocol": "string",
"driverVersion": "string",
"firmwareVersion": "string"
}
],
"scsiLun": [
{
"_typeName": "string",
"deviceName": "string",
"deviceType": "string",
"key": "string",
"uuid": "string",
"descriptor": [
{
"_typeName": "string",
"quality": "string",
"id": "string"
}
],
"canonicalName": "string",
"displayName": "string",
"lunType": "string",
"vendor": "string",
"model": "string",
"revision": "string",
"scsiLevel": 0,
"serialNumber": "string",
"durableName": {
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
},
"alternateName": [
{
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
}
],
"standardInquiry": [
0
],
"queueDepth": 0,
"operationalState": [
"string"
],
"capabilities": {
"_typeName": "string",
"updateDisplayNameSupported": false
},
"vStorageSupport": "string",
"protocolEndpoint": false,
"perenniallyReserved": false,
"clusteredVmdkSupported": false,
"applicationProtocol": "string",
"dispersedNs": false,
"deviceReservation": "string"
}
],
"scsiTopology": {
"_typeName": "string",
"adapter": [
{
"_typeName": "string",
"key": "string",
"adapter": "string",
"target": [
{
"_typeName": "string",
"key": "string",
"target": 0,
"lun": [
{
"_typeName": "string",
"key": "string",
"lun": 0,
"scsiLun": "string"
}
],
"transport": {
"_typeName": "string"
}
}
]
}
]
},
"nvmeTopology": {
"_typeName": "string",
"adapter": [
{
"_typeName": "string",
"key": "string",
"adapter": "string",
"connectedController": [
{
"_typeName": "string",
"key": "string",
"controllerNumber": 0,
"subnqn": "string",
"name": "string",
"associatedAdapter": "string",
"transportType": "string",
"fusedOperationSupported": false,
"numberOfQueues": 0,
"queueSize": 0,
"attachedNamespace": [
{
"_typeName": "string",
"key": "string",
"name": "string",
"id": 0,
"blockSize": 0,
"capacityInBlocks": 0
}
],
"vendorId": "string",
"model": "string",
"serialNumber": "string",
"firmwareVersion": "string"
}
]
}
]
},
"multipathInfo": {
"_typeName": "string",
"lun": [
{
"_typeName": "string",
"key": "string",
"id": "string",
"lun": "string",
"path": [
{
"_typeName": "string",
"key": "string",
"name": "string",
"pathState": "string",
"state": "string",
"isWorkingPath": false,
"adapter": "string",
"lun": "string",
"transport": {
"_typeName": "string"
}
}
],
"policy": {
"_typeName": "string",
"policy": "string"
},
"storageArrayTypePolicy": {
"_typeName": "string",
"policy": "string"
}
}
]
},
"plugStoreTopology": {
"_typeName": "string",
"adapter": [
{
"_typeName": "string",
"key": "string",
"adapter": "string",
"path": [
"string"
]
}
],
"path": [
{
"_typeName": "string",
"key": "string",
"name": "string",
"channelNumber": 0,
"targetNumber": 0,
"lunNumber": 0,
"adapter": "string",
"target": "string",
"device": "string"
}
],
"target": [
{
"_typeName": "string",
"key": "string",
"transport": {
"_typeName": "string"
}
}
],
"device": [
{
"_typeName": "string",
"key": "string",
"lun": "string",
"path": [
"string"
]
}
],
"plugin": [
{
"_typeName": "string",
"key": "string",
"name": "string",
"device": [
"string"
],
"claimedPath": [
"string"
]
}
]
},
"softwareInternetScsiEnabled": false
},
"multipathState": {
"_typeName": "string",
"path": [
{
"_typeName": "string",
"name": "string",
"pathState": "string"
}
]
},
"fileSystemVolume": {
"_typeName": "string",
"volumeTypeList": [
"string"
],
"mountInfo": [
{
"_typeName": "string",
"mountInfo": {
"_typeName": "string",
"path": "string",
"accessMode": "string",
"mounted": false,
"accessible": false,
"inaccessibleReason": "string",
"vmknicName": "string",
"vmknicActive": false,
"mountFailedReason": "string",
"numTcpConnections": 0
},
"volume": {
"_typeName": "string",
"type": "string",
"name": "string",
"capacity": 0
},
"vStorageSupport": "string"
}
]
},
"systemFile": [
"string"
],
"network": {
"_typeName": "string",
"vswitch": [
{
"_typeName": "string",
"name": "string",
"key": "string",
"numPorts": 0,
"numPortsAvailable": 0,
"mtu": 0,
"portgroup": [
"string"
],
"pnic": [
"string"
],
"spec": {
"_typeName": "string",
"numPorts": 0,
"bridge": {
"_typeName": "string"
},
"policy": {
"_typeName": "string",
"security": {
"_typeName": "string",
"allowPromiscuous": false,
"macChanges": false,
"forgedTransmits": false
},
"nicTeaming": {
"_typeName": "string",
"policy": "string",
"reversePolicy": false,
"notifySwitches": false,
"rollingOrder": false,
"failureCriteria": {
"_typeName": "string",
"checkSpeed": "string",
"speed": 0,
"checkDuplex": false,
"fullDuplex": false,
"checkErrorPercent": false,
"percentage": 0,
"checkBeacon": false
},
"nicOrder": {
"_typeName": "string",
"activeNic": [
"string"
],
"standbyNic": [
"string"
]
}
},
"offloadPolicy": {
"_typeName": "string",
"csumOffload": false,
"tcpSegmentation": false,
"zeroCopyXmit": false
},
"shapingPolicy": {
"_typeName": "string",
"enabled": false,
"averageBandwidth": 0,
"peakBandwidth": 0,
"burstSize": 0
}
},
"mtu": 0
}
}
],
"proxySwitch": [
{
"_typeName": "string",
"dvsUuid": "string",
"dvsName": "string",
"key": "string",
"numPorts": 0,
"configNumPorts": 0,
"numPortsAvailable": 0,
"uplinkPort": [
{
"_typeName": "string",
"key": "string",
"value": "string"
}
],
"mtu": 0,
"pnic": [
"string"
],
"spec": {
"_typeName": "string",
"backing": {
"_typeName": "string"
}
},
"hostLag": [
{
"_typeName": "string",
"lagKey": "string",
"lagName": "string",
"uplinkPort": [
{
"_typeName": "string",
"key": "string",
"value": "string"
}
]
}
],
"networkReservationSupported": false,
"nsxtEnabled": false,
"ensEnabled": false,
"ensInterruptEnabled": false,
"transportZones": [
{
"_typeName": "string",
"uuid": "string",
"type": "string"
}
],
"nsxUsedUplinkPort": [
"string"
],
"nsxtStatus": "string",
"nsxtStatusDetail": "string",
"ensInfo": {
"_typeName": "string",
"opsVersion": 0,
"numPSOps": 0,
"numLcoreOps": 0,
"errorStatus": 0,
"lcoreStatus": 0
},
"networkOffloadingEnabled": false,
"hostUplinkState": [
{
"_typeName": "string",
"uplinkName": "string",
"state": "string"
}
],
"autoDeployOwned": false,
"hostPerfNicOffloadState": {
"_typeName": "string",
"enabled": false,
"runtimeStatus": "string",
"statusDescription": "string"
},
"teplessMode": false
}
],
"portgroup": [
{
"_typeName": "string",
"key": "string",
"port": [
{
"_typeName": "string",
"key": "string",
"mac": [
"string"
],
"type": "string"
}
],
"vswitch": "string",
"computedPolicy": {
"_typeName": "string",
"security": {
"_typeName": "string",
"allowPromiscuous": false,
"macChanges": false,
"forgedTransmits": false
},
"nicTeaming": {
"_typeName": "string",
"policy": "string",
"reversePolicy": false,
"notifySwitches": false,
"rollingOrder": false,
"failureCriteria": {
"_typeName": "string",
"checkSpeed": "string",
"speed": 0,
"checkDuplex": false,
"fullDuplex": false,
"checkErrorPercent": false,
"percentage": 0,
"checkBeacon": false
},
"nicOrder": {
"_typeName": "string",
"activeNic": [
"string"
],
"standbyNic": [
"string"
]
}
},
"offloadPolicy": {
"_typeName": "string",
"csumOffload": false,
"tcpSegmentation": false,
"zeroCopyXmit": false
},
"shapingPolicy": {
"_typeName": "string",
"enabled": false,
"averageBandwidth": 0,
"peakBandwidth": 0,
"burstSize": 0
}
},
"spec": {
"_typeName": "string",
"name": "string",
"vlanId": 0,
"vswitchName": "string",
"policy": {
"_typeName": "string",
"security": {
"_typeName": "string",
"allowPromiscuous": false,
"macChanges": false,
"forgedTransmits": false
},
"nicTeaming": {
"_typeName": "string",
"policy": "string",
"reversePolicy": false,
"notifySwitches": false,
"rollingOrder": false,
"failureCriteria": {
"_typeName": "string",
"checkSpeed": "string",
"speed": 0,
"checkDuplex": false,
"fullDuplex": false,
"checkErrorPercent": false,
"percentage": 0,
"checkBeacon": false
},
"nicOrder": {
"_typeName": "string",
"activeNic": [
"string"
],
"standbyNic": [
"string"
]
}
},
"offloadPolicy": {
"_typeName": "string",
"csumOffload": false,
"tcpSegmentation": false,
"zeroCopyXmit": false
},
"shapingPolicy": {
"_typeName": "string",
"enabled": false,
"averageBandwidth": 0,
"peakBandwidth": 0,
"burstSize": 0
}
}
}
}
],
"pnic": [
{
"_typeName": "string",
"key": "string",
"device": "string",
"pci": "string",
"driver": "string",
"driverVersion": "string",
"firmwareVersion": "string",
"linkSpeed": {
"_typeName": "string",
"speedMb": 0,
"duplex": false
},
"validLinkSpecification": [
{
"_typeName": "string",
"speedMb": 0,
"duplex": false
}
],
"spec": {
"_typeName": "string",
"ip": {
"_typeName": "string",
"dhcp": false,
"ipAddress": "string",
"subnetMask": "string",
"ipV6Config": {
"_typeName": "string",
"ipV6Address": [
{
"_typeName": "string",
"ipAddress": "string",
"prefixLength": 0,
"origin": "string",
"dadState": "string",
"lifetime": "string",
"operation": "string"
}
],
"autoConfigurationEnabled": false,
"dhcpV6Enabled": false
}
},
"linkSpeed": {
"_typeName": "string",
"speedMb": 0,
"duplex": false
},
"enableEnhancedNetworkingStack": false,
"ensInterruptEnabled": false
},
"wakeOnLanSupported": false,
"mac": "string",
"fcoeConfiguration": {
"_typeName": "string",
"priorityClass": 0,
"sourceMac": "string",
"vlanRange": [
{
"_typeName": "string",
"vlanLow": 0,
"vlanHigh": 0
}
],
"capabilities": {
"_typeName": "string",
"priorityClass": false,
"sourceMacAddress": false,
"vlanRange": false
},
"fcoeActive": false
},
"vmDirectPathGen2Supported": false,
"vmDirectPathGen2SupportedMode": "string",
"resourcePoolSchedulerAllowed": false,
"resourcePoolSchedulerDisallowedReason": [
"string"
],
"autoNegotiateSupported": false,
"enhancedNetworkingStackSupported": false,
"ensInterruptSupported": false,
"rdmaDevice": "string",
"dpuId": "string",
"perfNicOffloadSupported": false
}
],
"rdmaDevice": [
{
"_typeName": "string",
"key": "string",
"device": "string",
"driver": "string",
"description": "string",
"backing": {
"_typeName": "string"
},
"connectionInfo": {
"_typeName": "string",
"state": "string",
"mtu": 0,
"speedInMbps": 0
},
"capability": {
"_typeName": "string",
"roceV1Capable": false,
"roceV2Capable": false,
"iWarpCapable": false
}
}
],
"vnic": [
{
"_typeName": "string",
"device": "string",
"key": "string",
"portgroup": "string",
"spec": {
"_typeName": "string",
"dynamicProperty": [
{
"_typeName": "string",
"name": "string",
"val": {
"_typeName": "string"
}
}
],
"ip": {
"_typeName": "string",
"dhcp": false,
"ipAddress": "string",
"subnetMask": "string",
"ipV6Config": {
"_typeName": "string",
"ipV6Address": [
{
"_typeName": "string",
"ipAddress": "string",
"prefixLength": 0,
"origin": "string",
"dadState": "string",
"lifetime": "string",
"operation": "string"
}
],
"autoConfigurationEnabled": false,
"dhcpV6Enabled": false
}
},
"mac": "string",
"distributedVirtualPort": {
"_typeName": "string",
"switchUuid": "string",
"portgroupKey": "string",
"portKey": "string",
"connectionCookie": 0
},
"portgroup": "string",
"mtu": 0,
"tsoEnabled": false,
"netStackInstanceKey": "string",
"opaqueNetwork": {
"_typeName": "string",
"opaqueNetworkId": "string",
"opaqueNetworkType": "string"
},
"externalId": "string",
"pinnedPnic": "string",
"ipRouteSpec": {
"_typeName": "string",
"ipRouteConfig": {
"_typeName": "string",
"defaultGateway": "string",
"gatewayDevice": "string",
"ipV6DefaultGateway": "string",
"ipV6GatewayDevice": "string"
}
},
"systemOwned": false,
"dpuId": "string"
},
"port": "string",
"owner": "string"
}
],
"consoleVnic": [
{
"_typeName": "string",
"device": "string",
"key": "string",
"portgroup": "string",
"spec": {
"_typeName": "string",
"dynamicProperty": [
{
"_typeName": "string",
"name": "string",
"val": {
"_typeName": "string"
}
}
],
"ip": {
"_typeName": "string",
"dhcp": false,
"ipAddress": "string",
"subnetMask": "string",
"ipV6Config": {
"_typeName": "string",
"ipV6Address": [
{
"_typeName": "string",
"ipAddress": "string",
"prefixLength": 0,
"origin": "string",
"dadState": "string",
"lifetime": "string",
"operation": "string"
}
],
"autoConfigurationEnabled": false,
"dhcpV6Enabled": false
}
},
"mac": "string",
"distributedVirtualPort": {
"_typeName": "string",
"switchUuid": "string",
"portgroupKey": "string",
"portKey": "string",
"connectionCookie": 0
},
"portgroup": "string",
"mtu": 0,
"tsoEnabled": false,
"netStackInstanceKey": "string",
"opaqueNetwork": {
"_typeName": "string",
"opaqueNetworkId": "string",
"opaqueNetworkType": "string"
},
"externalId": "string",
"pinnedPnic": "string",
"ipRouteSpec": {
"_typeName": "string",
"ipRouteConfig": {
"_typeName": "string",
"defaultGateway": "string",
"gatewayDevice": "string",
"ipV6DefaultGateway": "string",
"ipV6GatewayDevice": "string"
}
},
"systemOwned": false,
"dpuId": "string"
},
"port": "string",
"owner": "string"
}
],
"dnsConfig": {
"_typeName": "string",
"dhcp": false,
"virtualNicDevice": "string",
"ipv6VirtualNicDevice": "string",
"hostName": "string",
"domainName": "string",
"address": [
"string"
],
"searchDomain": [
"string"
]
},
"ipRouteConfig": {
"_typeName": "string",
"defaultGateway": "string",
"gatewayDevice": "string",
"ipV6DefaultGateway": "string",
"ipV6GatewayDevice": "string"
},
"consoleIpRouteConfig": {
"_typeName": "string",
"defaultGateway": "string",
"gatewayDevice": "string",
"ipV6DefaultGateway": "string",
"ipV6GatewayDevice": "string"
},
"routeTableInfo": {
"_typeName": "string",
"ipRoute": [
{
"_typeName": "string",
"network": "string",
"prefixLength": 0,
"gateway": "string",
"deviceName": "string"
}
],
"ipv6Route": [
{
"_typeName": "string",
"network": "string",
"prefixLength": 0,
"gateway": "string",
"deviceName": "string"
}
]
},
"dhcp": [
{
"_typeName": "string",
"key": "string",
"spec": {
"_typeName": "string",
"virtualSwitch": "string",
"defaultLeaseDuration": 0,
"leaseBeginIp": "string",
"leaseEndIp": "string",
"maxLeaseDuration": 0,
"unlimitedLease": false,
"ipSubnetAddr": "string",
"ipSubnetMask": "string"
}
}
],
"nat": [
{
"_typeName": "string",
"key": "string",
"spec": {
"_typeName": "string",
"virtualSwitch": "string",
"activeFtp": false,
"allowAnyOui": false,
"configPort": false,
"ipGatewayAddress": "string",
"udpTimeout": 0,
"portForward": [
{
"_typeName": "string",
"type": "string",
"name": "string",
"hostPort": 0,
"guestPort": 0,
"guestIpAddress": "string"
}
],
"nameService": {
"_typeName": "string",
"dnsAutoDetect": false,
"dnsPolicy": "string",
"dnsRetries": 0,
"dnsTimeout": 0,
"dnsNameServer": [
"string"
],
"nbdsTimeout": 0,
"nbnsRetries": 0,
"nbnsTimeout": 0
}
}
}
],
"ipV6Enabled": false,
"atBootIpV6Enabled": false,
"netStackInstance": [
{
"_typeName": "string",
"key": "string",
"name": "string",
"dnsConfig": {
"_typeName": "string",
"dhcp": false,
"virtualNicDevice": "string",
"ipv6VirtualNicDevice": "string",
"hostName": "string",
"domainName": "string",
"address": [
"string"
],
"searchDomain": [
"string"
]
},
"ipRouteConfig": {
"_typeName": "string",
"defaultGateway": "string",
"gatewayDevice": "string",
"ipV6DefaultGateway": "string",
"ipV6GatewayDevice": "string"
},
"requestedMaxNumberOfConnections": 0,
"congestionControlAlgorithm": "string",
"ipV6Enabled": false,
"routeTableConfig": {
"_typeName": "string",
"ipRoute": [
{
"_typeName": "string",
"changeOperation": "string",
"route": {
"_typeName": "string",
"network": "string",
"prefixLength": 0,
"gateway": "string",
"deviceName": "string"
}
}
],
"ipv6Route": [
{
"_typeName": "string",
"changeOperation": "string",
"route": {
"_typeName": "string",
"network": "string",
"prefixLength": 0,
"gateway": "string",
"deviceName": "string"
}
}
]
},
"owner": "string"
}
],
"opaqueSwitch": [
{
"_typeName": "string",
"dynamicProperty": [
{
"_typeName": "string",
"name": "string",
"val": {
"_typeName": "string"
}
}
],
"key": "string",
"name": "string",
"pnic": [
"string"
],
"pnicZone": [
{
"_typeName": "string",
"key": "string",
"pnicDevice": [
"string"
]
}
],
"status": "string",
"vtep": [
{
"_typeName": "string",
"device": "string",
"key": "string",
"portgroup": "string",
"spec": {
"_typeName": "string",
"dynamicProperty": [
{
"_typeName": "string",
"name": "string",
"val": {
"_typeName": "string"
}
}
],
"ip": {
"_typeName": "string",
"dhcp": false,
"ipAddress": "string",
"subnetMask": "string",
"ipV6Config": {
"_typeName": "string",
"ipV6Address": [
{
"_typeName": "string",
"ipAddress": "string",
"prefixLength": 0,
"origin": "string",
"dadState": "string",
"lifetime": "string",
"operation": "string"
}
],
"autoConfigurationEnabled": false,
"dhcpV6Enabled": false
}
},
"mac": "string",
"distributedVirtualPort": {
"_typeName": "string",
"switchUuid": "string",
"portgroupKey": "string",
"portKey": "string",
"connectionCookie": 0
},
"portgroup": "string",
"mtu": 0,
"tsoEnabled": false,
"netStackInstanceKey": "string",
"opaqueNetwork": {
"_typeName": "string",
"opaqueNetworkId": "string",
"opaqueNetworkType": "string"
},
"externalId": "string",
"pinnedPnic": "string",
"ipRouteSpec": {
"_typeName": "string",
"ipRouteConfig": {
"_typeName": "string",
"defaultGateway": "string",
"gatewayDevice": "string",
"ipV6DefaultGateway": "string",
"ipV6GatewayDevice": "string"
}
},
"systemOwned": false,
"dpuId": "string"
},
"port": "string",
"owner": "string"
}
],
"extraConfig": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"featureCapability": [
{
"_typeName": "string",
"key": "string",
"featureName": "string",
"value": "string"
}
]
}
],
"opaqueNetwork": [
{
"_typeName": "string",
"dynamicProperty": [
{
"_typeName": "string",
"name": "string",
"val": {
"_typeName": "string"
}
}
],
"opaqueNetworkId": "string",
"opaqueNetworkName": "string",
"opaqueNetworkType": "string",
"pnicZone": [
"string"
],
"capability": {
"_typeName": "string",
"networkReservationSupported": false
},
"extraConfig": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
]
}
],
"nsxTransportNodeId": "string",
"nvdsToVdsMigrationRequired": false,
"migrationStatus": "string"
},
"vmotion": {
"_typeName": "string",
"netConfig": {
"_typeName": "string",
"candidateVnic": [
{
"_typeName": "string",
"device": "string",
"key": "string",
"portgroup": "string",
"spec": {
"_typeName": "string",
"dynamicProperty": [
{
"_typeName": "string",
"name": "string",
"val": {
"_typeName": "string"
}
}
],
"ip": {
"_typeName": "string",
"dhcp": false,
"ipAddress": "string",
"subnetMask": "string",
"ipV6Config": {
"_typeName": "string",
"ipV6Address": [
{
"_typeName": "string",
"ipAddress": "string",
"prefixLength": 0,
"origin": "string",
"dadState": "string",
"lifetime": "string",
"operation": "string"
}
],
"autoConfigurationEnabled": false,
"dhcpV6Enabled": false
}
},
"mac": "string",
"distributedVirtualPort": {
"_typeName": "string",
"switchUuid": "string",
"portgroupKey": "string",
"portKey": "string",
"connectionCookie": 0
},
"portgroup": "string",
"mtu": 0,
"tsoEnabled": false,
"netStackInstanceKey": "string",
"opaqueNetwork": {
"_typeName": "string",
"opaqueNetworkId": "string",
"opaqueNetworkType": "string"
},
"externalId": "string",
"pinnedPnic": "string",
"ipRouteSpec": {
"_typeName": "string",
"ipRouteConfig": {
"_typeName": "string",
"defaultGateway": "string",
"gatewayDevice": "string",
"ipV6DefaultGateway": "string",
"ipV6GatewayDevice": "string"
}
},
"systemOwned": false,
"dpuId": "string"
},
"port": "string",
"owner": "string"
}
],
"selectedVnic": "string"
},
"ipConfig": {
"_typeName": "string",
"dhcp": false,
"ipAddress": "string",
"subnetMask": "string",
"ipV6Config": {
"_typeName": "string",
"ipV6Address": [
{
"_typeName": "string",
"ipAddress": "string",
"prefixLength": 0,
"origin": "string",
"dadState": "string",
"lifetime": "string",
"operation": "string"
}
],
"autoConfigurationEnabled": false,
"dhcpV6Enabled": false
}
}
},
"virtualNicManagerInfo": {
"_typeName": "string",
"netConfig": [
{
"_typeName": "string",
"nicType": "string",
"multiSelectAllowed": false,
"candidateVnic": [
{
"_typeName": "string",
"device": "string",
"key": "string",
"portgroup": "string",
"spec": {
"_typeName": "string",
"dynamicProperty": [
{
"_typeName": "string",
"name": "string",
"val": {
"_typeName": "string"
}
}
],
"ip": {
"_typeName": "string",
"dhcp": false,
"ipAddress": "string",
"subnetMask": "string",
"ipV6Config": {
"_typeName": "string",
"ipV6Address": [
{
"_typeName": "string",
"ipAddress": "string",
"prefixLength": 0,
"origin": "string",
"dadState": "string",
"lifetime": "string",
"operation": "string"
}
],
"autoConfigurationEnabled": false,
"dhcpV6Enabled": false
}
},
"mac": "string",
"distributedVirtualPort": {
"_typeName": "string",
"switchUuid": "string",
"portgroupKey": "string",
"portKey": "string",
"connectionCookie": 0
},
"portgroup": "string",
"mtu": 0,
"tsoEnabled": false,
"netStackInstanceKey": "string",
"opaqueNetwork": {
"_typeName": "string",
"opaqueNetworkId": "string",
"opaqueNetworkType": "string"
},
"externalId": "string",
"pinnedPnic": "string",
"ipRouteSpec": {
"_typeName": "string",
"ipRouteConfig": {
"_typeName": "string",
"defaultGateway": "string",
"gatewayDevice": "string",
"ipV6DefaultGateway": "string",
"ipV6GatewayDevice": "string"
}
},
"systemOwned": false,
"dpuId": "string"
},
"port": "string",
"owner": "string"
}
],
"selectedVnic": [
"string"
]
}
]
},
"capabilities": {
"_typeName": "string",
"canSetPhysicalNicLinkSpeed": false,
"supportsNicTeaming": false,
"nicTeamingPolicy": [
"string"
],
"supportsVlan": false,
"usesServiceConsoleNic": false,
"supportsNetworkHints": false,
"maxPortGroupsPerVswitch": 0,
"vswitchConfigSupported": false,
"vnicConfigSupported": false,
"ipRouteConfigSupported": false,
"dnsConfigSupported": false,
"dhcpOnVnicSupported": false,
"ipV6Supported": false,
"backupNfcNiocSupported": false
},
"datastoreCapabilities": {
"_typeName": "string",
"nfsMountCreationRequired": false,
"nfsMountCreationSupported": false,
"localDatastoreSupported": false,
"vmfsExtentExpansionSupported": false
},
"offloadCapabilities": {
"_typeName": "string",
"csumOffload": false,
"tcpSegmentation": false,
"zeroCopyXmit": false
},
"service": {
"_typeName": "string",
"service": [
{
"_typeName": "string",
"key": "string",
"label": "string",
"required": false,
"uninstallable": false,
"running": false,
"ruleset": [
"string"
],
"policy": "string",
"sourcePackage": {
"_typeName": "string",
"sourcePackageName": "string",
"description": "string"
}
}
]
},
"firewall": {
"_typeName": "string",
"defaultPolicy": {
"_typeName": "string",
"incomingBlocked": false,
"outgoingBlocked": false
},
"ruleset": [
{
"_typeName": "string",
"key": "string",
"label": "string",
"required": false,
"rule": [
{
"_typeName": "string",
"port": 0,
"endPort": 0,
"direction": "string",
"portType": "string",
"protocol": "string"
}
],
"service": "string",
"enabled": false,
"allowedHosts": {
"_typeName": "string",
"ipAddress": [
"string"
],
"ipNetwork": [
{
"_typeName": "string",
"network": "string",
"prefixLength": 0
}
],
"allIp": false
},
"userControllable": false,
"ipListUserConfigurable": false
}
]
},
"autoStart": {
"_typeName": "string",
"defaults": {
"_typeName": "string",
"enabled": false,
"startDelay": 0,
"stopDelay": 0,
"waitForHeartbeat": false,
"stopAction": "string"
},
"powerInfo": [
{
"_typeName": "string",
"key": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"startOrder": 0,
"startDelay": 0,
"waitForHeartbeat": "string",
"startAction": "string",
"stopDelay": 0,
"stopAction": "string"
}
]
},
"activeDiagnosticPartition": {
"_typeName": "string",
"storageType": "string",
"diagnosticType": "string",
"slots": 0,
"id": {
"_typeName": "string",
"diskName": "string",
"partition": 0
}
},
"option": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"optionDef": [
{
"_typeName": "string",
"label": "string",
"summary": "string",
"key": "string",
"optionType": {
"_typeName": "string",
"valueIsReadonly": false
}
}
],
"datastorePrincipal": "string",
"localSwapDatastore": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"systemSwapConfiguration": {
"_typeName": "string",
"option": [
{
"_typeName": "string",
"key": 0
}
]
},
"systemResources": {
"_typeName": "string",
"key": "string",
"config": {
"_typeName": "string",
"entity": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"changeVersion": "string",
"lastModified": "string",
"cpuAllocation": {
"_typeName": "string",
"reservation": 0,
"expandableReservation": false,
"limit": 0,
"shares": {
"_typeName": "string",
"shares": 0,
"level": "string"
},
"overheadLimit": 0
},
"memoryAllocation": {
"_typeName": "string",
"reservation": 0,
"expandableReservation": false,
"limit": 0,
"shares": {
"_typeName": "string",
"shares": 0,
"level": "string"
},
"overheadLimit": 0
},
"scaleDescendantsShares": "string"
},
"child": [
{
"_typeName": "string",
"key": "string",
"config": {
"_typeName": "string",
"entity": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"changeVersion": "string",
"lastModified": "string",
"cpuAllocation": {
"_typeName": "string",
"reservation": 0,
"expandableReservation": false,
"limit": 0,
"shares": {
"_typeName": "string",
"shares": 0,
"level": "string"
},
"overheadLimit": 0
},
"memoryAllocation": {
"_typeName": "string",
"reservation": 0,
"expandableReservation": false,
"limit": 0,
"shares": {
"_typeName": "string",
"shares": 0,
"level": "string"
},
"overheadLimit": 0
},
"scaleDescendantsShares": "string"
},
"child": [
"HostSystemResourceInfo Object"
]
}
]
},
"dateTimeInfo": {
"_typeName": "string",
"timeZone": {
"_typeName": "string",
"key": "string",
"name": "string",
"description": "string",
"gmtOffset": 0
},
"systemClockProtocol": "string",
"ntpConfig": {
"_typeName": "string",
"server": [
"string"
],
"configFile": [
"string"
]
},
"ptpConfig": {
"_typeName": "string",
"domain": 0,
"port": [
{
"_typeName": "string",
"index": 0,
"deviceType": "string",
"device": "string",
"ipConfig": {
"_typeName": "string",
"dhcp": false,
"ipAddress": "string",
"subnetMask": "string",
"ipV6Config": {
"_typeName": "string",
"ipV6Address": [
{
"_typeName": "string",
"ipAddress": "string",
"prefixLength": 0,
"origin": "string",
"dadState": "string",
"lifetime": "string",
"operation": "string"
}
],
"autoConfigurationEnabled": false,
"dhcpV6Enabled": false
}
}
}
]
},
"enabled": false,
"disableEvents": false,
"disableFallback": false,
"inFallbackState": false,
"serviceSync": false,
"lastSyncTime": "string",
"remoteNtpServer": "string",
"ntpRunTime": 0,
"ptpRunTime": 0,
"ntpDuration": "string",
"ptpDuration": "string"
},
"flags": {
"_typeName": "string",
"backgroundSnapshotsEnabled": false
},
"adminDisabled": false,
"lockdownMode": "string",
"ipmi": {
"_typeName": "string",
"bmcIpAddress": "string",
"bmcMacAddress": "string",
"login": "string",
"password": "string"
},
"sslThumbprintInfo": {
"_typeName": "string",
"principal": "string",
"ownerTag": "string",
"sslThumbprints": [
"string"
]
},
"sslThumbprintData": [
{
"_typeName": "string",
"principal": "string",
"ownerTag": "string",
"sslThumbprints": [
"string"
]
}
],
"authenticationData": [
{
"_typeName": "string",
"principal": "string",
"ownerTag": "string",
"sslCertificates": [
"string"
]
}
],
"certificate": [
0
],
"pciPassthruInfo": [
{
"_typeName": "string",
"id": "string",
"dependentDevice": "string",
"passthruEnabled": false,
"passthruCapable": false,
"passthruActive": false,
"hardwareLabel": "string",
"directPathState": {
"_typeName": "string",
"mode": "string",
"configurableModes": [
"string"
],
"usedMemory": 0
}
}
],
"authenticationManagerInfo": {
"_typeName": "string",
"authConfig": [
{
"_typeName": "string",
"enabled": false
}
]
},
"featureVersion": [
{
"_typeName": "string",
"key": "string",
"value": "string"
}
],
"powerSystemCapability": {
"_typeName": "string",
"availablePolicy": [
{
"_typeName": "string",
"key": 0,
"name": "string",
"shortName": "string",
"description": "string"
}
]
},
"powerSystemInfo": {
"_typeName": "string",
"currentPolicy": {
"_typeName": "string",
"key": 0,
"name": "string",
"shortName": "string",
"description": "string"
}
},
"cacheConfigurationInfo": [
{
"_typeName": "string",
"key": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"swapSize": 0
}
],
"wakeOnLanCapable": false,
"featureCapability": [
{
"_typeName": "string",
"key": "string",
"featureName": "string",
"value": "string"
}
],
"maskedFeatureCapability": [
{
"_typeName": "string",
"key": "string",
"featureName": "string",
"value": "string"
}
],
"vFlashConfigInfo": {
"_typeName": "string",
"vFlashResourceConfigInfo": {
"_typeName": "string",
"vffs": {
"_typeName": "string",
"type": "string",
"name": "string",
"capacity": 0,
"majorVersion": 0,
"version": "string",
"uuid": "string",
"extent": [
{
"_typeName": "string",
"diskName": "string",
"partition": 0
}
]
},
"capacity": 0
},
"vFlashCacheConfigInfo": {
"_typeName": "string",
"vFlashModuleConfigOption": [
{
"_typeName": "string",
"vFlashModule": "string",
"vFlashModuleVersion": "string",
"minSupportedModuleVersion": "string",
"cacheConsistencyType": {
"_typeName": "string",
"valueIsReadonly": false,
"choiceInfo": [
{
"_typeName": "string",
"label": "string",
"summary": "string",
"key": "string"
}
],
"defaultIndex": 0
},
"cacheMode": {
"_typeName": "string",
"valueIsReadonly": false,
"choiceInfo": [
{
"_typeName": "string",
"label": "string",
"summary": "string",
"key": "string"
}
],
"defaultIndex": 0
},
"blockSizeInKBOption": {
"_typeName": "string",
"valueIsReadonly": false,
"min": 0,
"max": 0,
"defaultValue": 0
},
"reservationInMBOption": {
"_typeName": "string",
"valueIsReadonly": false,
"min": 0,
"max": 0,
"defaultValue": 0
},
"maxDiskSizeInKB": 0
}
],
"defaultVFlashModule": "string",
"swapCacheReservationInGB": 0
}
},
"vsanHostConfig": {
"_typeName": "string",
"enabled": false,
"hostSystem": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"clusterInfo": {
"_typeName": "string",
"uuid": "string",
"nodeUuid": "string"
},
"storageInfo": {
"_typeName": "string",
"autoClaimStorage": false,
"diskMapping": [
{
"_typeName": "string",
"ssd": {
"_typeName": "string",
"deviceName": "string",
"deviceType": "string",
"key": "string",
"uuid": "string",
"descriptor": [
{
"_typeName": "string",
"quality": "string",
"id": "string"
}
],
"canonicalName": "string",
"displayName": "string",
"lunType": "string",
"vendor": "string",
"model": "string",
"revision": "string",
"scsiLevel": 0,
"serialNumber": "string",
"durableName": {
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
},
"alternateName": [
{
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
}
],
"standardInquiry": [
0
],
"queueDepth": 0,
"operationalState": [
"string"
],
"capabilities": {
"_typeName": "string",
"updateDisplayNameSupported": false
},
"vStorageSupport": "string",
"protocolEndpoint": false,
"perenniallyReserved": false,
"clusteredVmdkSupported": false,
"applicationProtocol": "string",
"dispersedNs": false,
"deviceReservation": "string",
"capacity": {
"_typeName": "string",
"blockSize": 0,
"block": 0
},
"devicePath": "string",
"ssd": false,
"localDisk": false,
"physicalLocation": [
"string"
],
"emulatedDIXDIFEnabled": false,
"vsanDiskInfo": {
"_typeName": "string",
"vsanUuid": "string",
"formatVersion": 0
},
"scsiDiskType": "string",
"usedByMemoryTiering": false
},
"nonSsd": [
{
"_typeName": "string",
"deviceName": "string",
"deviceType": "string",
"key": "string",
"uuid": "string",
"descriptor": [
{
"_typeName": "string",
"quality": "string",
"id": "string"
}
],
"canonicalName": "string",
"displayName": "string",
"lunType": "string",
"vendor": "string",
"model": "string",
"revision": "string",
"scsiLevel": 0,
"serialNumber": "string",
"durableName": {
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
},
"alternateName": [
{
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
}
],
"standardInquiry": [
0
],
"queueDepth": 0,
"operationalState": [
"string"
],
"capabilities": {
"_typeName": "string",
"updateDisplayNameSupported": false
},
"vStorageSupport": "string",
"protocolEndpoint": false,
"perenniallyReserved": false,
"clusteredVmdkSupported": false,
"applicationProtocol": "string",
"dispersedNs": false,
"deviceReservation": "string",
"capacity": {
"_typeName": "string",
"blockSize": 0,
"block": 0
},
"devicePath": "string",
"ssd": false,
"localDisk": false,
"physicalLocation": [
"string"
],
"emulatedDIXDIFEnabled": false,
"vsanDiskInfo": {
"_typeName": "string",
"vsanUuid": "string",
"formatVersion": 0
},
"scsiDiskType": "string",
"usedByMemoryTiering": false
}
]
}
],
"diskMapInfo": [
{
"_typeName": "string",
"mapping": {
"_typeName": "string",
"ssd": {
"_typeName": "string",
"deviceName": "string",
"deviceType": "string",
"key": "string",
"uuid": "string",
"descriptor": [
{
"_typeName": "string",
"quality": "string",
"id": "string"
}
],
"canonicalName": "string",
"displayName": "string",
"lunType": "string",
"vendor": "string",
"model": "string",
"revision": "string",
"scsiLevel": 0,
"serialNumber": "string",
"durableName": {
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
},
"alternateName": [
{
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
}
],
"standardInquiry": [
0
],
"queueDepth": 0,
"operationalState": [
"string"
],
"capabilities": {
"_typeName": "string",
"updateDisplayNameSupported": false
},
"vStorageSupport": "string",
"protocolEndpoint": false,
"perenniallyReserved": false,
"clusteredVmdkSupported": false,
"applicationProtocol": "string",
"dispersedNs": false,
"deviceReservation": "string",
"capacity": {
"_typeName": "string",
"blockSize": 0,
"block": 0
},
"devicePath": "string",
"ssd": false,
"localDisk": false,
"physicalLocation": [
"string"
],
"emulatedDIXDIFEnabled": false,
"vsanDiskInfo": {
"_typeName": "string",
"vsanUuid": "string",
"formatVersion": 0
},
"scsiDiskType": "string",
"usedByMemoryTiering": false
},
"nonSsd": [
{
"_typeName": "string",
"deviceName": "string",
"deviceType": "string",
"key": "string",
"uuid": "string",
"descriptor": [
{
"_typeName": "string",
"quality": "string",
"id": "string"
}
],
"canonicalName": "string",
"displayName": "string",
"lunType": "string",
"vendor": "string",
"model": "string",
"revision": "string",
"scsiLevel": 0,
"serialNumber": "string",
"durableName": {
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
},
"alternateName": [
{
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
}
],
"standardInquiry": [
0
],
"queueDepth": 0,
"operationalState": [
"string"
],
"capabilities": {
"_typeName": "string",
"updateDisplayNameSupported": false
},
"vStorageSupport": "string",
"protocolEndpoint": false,
"perenniallyReserved": false,
"clusteredVmdkSupported": false,
"applicationProtocol": "string",
"dispersedNs": false,
"deviceReservation": "string",
"capacity": {
"_typeName": "string",
"blockSize": 0,
"block": 0
},
"devicePath": "string",
"ssd": false,
"localDisk": false,
"physicalLocation": [
"string"
],
"emulatedDIXDIFEnabled": false,
"vsanDiskInfo": {
"_typeName": "string",
"vsanUuid": "string",
"formatVersion": 0
},
"scsiDiskType": "string",
"usedByMemoryTiering": false
}
]
},
"mounted": false
}
],
"checksumEnabled": false
},
"networkInfo": {
"_typeName": "string",
"port": [
{
"_typeName": "string",
"ipConfig": {
"_typeName": "string",
"upstreamIpAddress": "string",
"downstreamIpAddress": "string"
},
"device": "string"
}
]
},
"faultDomainInfo": {
"_typeName": "string",
"name": "string"
},
"vsanEsaEnabled": false,
"vsanCyberRecoveryEnabled": false
},
"domainList": [
"string"
],
"scriptCheckSum": "string",
"hostConfigCheckSum": "string",
"descriptionTreeCheckSum": "string",
"graphicsInfo": [
{
"_typeName": "string",
"deviceName": "string",
"vendorName": "string",
"pciId": "string",
"graphicsType": "string",
"vgpuMode": "string",
"memorySizeInKB": 0,
"vm": [
{
"_typeName": "string",
"type": "string",
"value": "string"
}
]
}
],
"sharedPassthruGpuTypes": [
"string"
],
"graphicsConfig": {
"_typeName": "string",
"hostDefaultGraphicsType": "string",
"sharedPassthruAssignmentPolicy": "string",
"deviceType": [
{
"_typeName": "string",
"deviceId": "string",
"graphicsType": "string",
"vgpuMode": "string"
}
]
},
"sharedGpuCapabilities": [
{
"_typeName": "string",
"vgpu": "string",
"diskSnapshotSupported": false,
"memorySnapshotSupported": false,
"suspendSupported": false,
"migrateSupported": false
}
],
"ioFilterInfo": [
{
"_typeName": "string",
"id": "string",
"name": "string",
"vendor": "string",
"version": "string",
"type": "string",
"summary": "string",
"releaseDate": "string",
"available": false
}
],
"sriovDevicePool": [
{
"_typeName": "string",
"key": "string"
}
],
"assignableHardwareBinding": [
{
"_typeName": "string",
"instanceId": "string",
"vm": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"pciId": "string",
"deviceKey": 0
}
],
"assignableHardwareConfig": {
"_typeName": "string",
"attributeOverride": [
{
"_typeName": "string",
"instanceId": "string",
"name": "string",
"value": {
"_typeName": "string"
}
}
]
}
}Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/sdk/vim25/{release}/HostSystem/{moId}/config
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