Datacenter Query Connection Info
This method provides a way of getting basic information about a host without adding it to a datacenter.
Connection wizards typically use this method to show information about a host so a user can confirm a set of changes before applying them.
Required privileges: System.View
Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/Datacenter/{moId}/QueryConnectionInfo
COPY
Path Parameters
string
moId
Required
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case Datacenter/{moId}.
string
release
Required
The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.
Request Body
QueryConnectionInfoRequestType of type(s) application/json
Required
Show optional properties
{
"hostname": "string",
"port": 0,
"username": "string",
"password": "string"
}{
"hostname": "string",
"port": 0,
"username": "string",
"password": "string",
"sslThumbprint": "string"
}string
hostname
Required
The target of the query.
integer As int32 As int32
port
Required
The port number of the target host. For ESX 2.x this is the authd port (902 by default). For ESX 3.x and above and for VMware Server hosts this is the https port (443 by default). You can specify -1 to have the vCenter Server try the default ports.
string
username
Required
The name of the user.
string As password As password
password
Required
The password of the user.
string
sslThumbprint
Optional
The expected SSL thumbprint of the host's certificate.
Responses
200
OK
Returns HostConnectInfo of type(s) application/json
This response body class contains all of the following: DataObject
{
"_typeName": "string",
"serverIp": "string",
"inDasCluster": false,
"host": {
"_typeName": "string",
"host": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"hardware": {
"_typeName": "string",
"vendor": "string",
"model": "string",
"uuid": "string",
"otherIdentifyingInfo": [
{
"_typeName": "string",
"identifierValue": "string",
"identifierType": {
"_typeName": "string",
"label": "string",
"summary": "string",
"key": "string"
}
}
],
"memorySize": 0,
"cpuModel": "string",
"cpuMhz": 0,
"numCpuPkgs": 0,
"numCpuCores": 0,
"numCpuThreads": 0,
"numNics": 0,
"numHBAs": 0
},
"runtime": {
"_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
}
},
"config": {
"_typeName": "string",
"name": "string",
"port": 0,
"sslThumbprint": "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"
},
"vmotionEnabled": false,
"faultToleranceEnabled": false,
"featureVersion": [
{
"_typeName": "string",
"key": "string",
"value": "string"
}
],
"agentVmDatastore": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"agentVmNetwork": {
"_typeName": "string",
"type": "string",
"value": "string"
}
},
"quickStats": {
"_typeName": "string",
"overallCpuUsage": 0,
"overallMemoryUsage": 0,
"distributedCpuFairness": 0,
"distributedMemoryFairness": 0,
"availablePMemCapacity": 0,
"uptime": 0
},
"overallStatus": "string",
"rebootRequired": false,
"customValue": [
{
"_typeName": "string",
"key": 0
}
],
"managementServerIp": "string",
"maxEVCModeKey": "string",
"currentEVCModeKey": "string",
"currentEVCGraphicsModeKey": "string",
"gateway": {
"_typeName": "string",
"gatewayType": "string",
"gatewayId": "string"
},
"tpmAttestation": {
"_typeName": "string",
"time": "string",
"status": "string",
"message": {
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
},
"trustAuthorityAttestationInfos": [
{
"_typeName": "string",
"attestationStatus": "string",
"serviceId": "string",
"attestedAt": "string",
"attestedUntil": "string",
"messages": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}
]
},
"vm": [
{
"_typeName": "string",
"vm": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"runtime": {
"_typeName": "string",
"device": [
{
"_typeName": "string",
"runtimeState": {
"_typeName": "string"
},
"key": 0
}
],
"host": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"connectionState": "string",
"powerState": "string",
"vmFailoverInProgress": false,
"faultToleranceState": "string",
"dasVmProtection": {
"_typeName": "string",
"dasProtected": false
},
"toolsInstallerMounted": false,
"suspendTime": "string",
"bootTime": "string",
"suspendInterval": 0,
"question": {
"_typeName": "string",
"id": "string",
"text": "string",
"choice": {
"_typeName": "string",
"valueIsReadonly": false,
"choiceInfo": [
{
"_typeName": "string",
"label": "string",
"summary": "string",
"key": "string"
}
],
"defaultIndex": 0
},
"message": [
{
"_typeName": "string",
"id": "string",
"argument": [
{
"_typeName": "string"
}
],
"text": "string"
}
]
},
"memoryOverhead": 0,
"maxCpuUsage": 0,
"maxMemoryUsage": 0,
"numMksConnections": 0,
"recordReplayState": "string",
"cleanPowerOff": false,
"needSecondaryReason": "string",
"onlineStandby": false,
"minRequiredEVCModeKey": "string",
"consolidationNeeded": false,
"offlineFeatureRequirement": [
{
"_typeName": "string",
"key": "string",
"featureName": "string",
"value": "string"
}
],
"featureRequirement": [
{
"_typeName": "string",
"key": "string",
"featureName": "string",
"value": "string"
}
],
"featureMask": [
{
"_typeName": "string",
"key": "string",
"featureName": "string",
"value": "string"
}
],
"vFlashCacheAllocation": 0,
"paused": false,
"snapshotInBackground": false,
"quiescedForkParent": false,
"instantCloneFrozen": false,
"cryptoState": "string",
"suspendedToMemory": false,
"opNotificationTimeout": 0,
"iommuActive": false
},
"guest": {
"_typeName": "string",
"guestId": "string",
"guestFullName": "string",
"toolsStatus": "string",
"toolsVersionStatus": "string",
"toolsVersionStatus2": "string",
"toolsRunningStatus": "string",
"hostName": "string",
"ipAddress": "string",
"hwVersion": "string"
},
"config": {
"_typeName": "string",
"name": "string",
"template": false,
"vmPathName": "string",
"memorySizeMB": 0,
"cpuReservation": 0,
"memoryReservation": 0,
"numCpu": 0,
"numEthernetCards": 0,
"numVirtualDisks": 0,
"uuid": "string",
"instanceUuid": "string",
"guestId": "string",
"guestFullName": "string",
"annotation": "string",
"product": {
"_typeName": "string",
"key": 0,
"classId": "string",
"instanceId": "string",
"name": "string",
"vendor": "string",
"version": "string",
"fullVersion": "string",
"vendorUrl": "string",
"productUrl": "string",
"appUrl": "string"
},
"installBootRequired": false,
"ftInfo": {
"_typeName": "string",
"role": 0,
"instanceUuids": [
"string"
],
"configPaths": [
"string"
],
"orphaned": false
},
"managedBy": {
"_typeName": "string",
"extensionKey": "string",
"type": "string"
},
"tpmPresent": false,
"numVmiopBackings": 0,
"hwVersion": "string"
},
"storage": {
"_typeName": "string",
"committed": 0,
"uncommitted": 0,
"unshared": 0,
"timestamp": "string"
},
"quickStats": {
"_typeName": "string",
"overallCpuUsage": 0,
"overallCpuDemand": 0,
"overallCpuReadiness": 0,
"guestMemoryUsage": 0,
"hostMemoryUsage": 0,
"guestHeartbeatStatus": "string",
"distributedCpuEntitlement": 0,
"distributedMemoryEntitlement": 0,
"staticCpuEntitlement": 0,
"staticMemoryEntitlement": 0,
"grantedMemory": 0,
"privateMemory": 0,
"sharedMemory": 0,
"swappedMemory": 0,
"balloonedMemory": 0,
"consumedOverheadMemory": 0,
"ftLogBandwidth": 0,
"ftSecondaryLatency": 0,
"ftLatencyStatus": "string",
"compressedMemory": 0,
"uptimeSeconds": 0,
"ssdSwappedMemory": 0,
"activeMemory": 0,
"memoryTierStats": [
{
"_typeName": "string",
"memoryTierType": "string",
"readBandwidth": 0
}
]
},
"overallStatus": "string",
"customValue": [
{
"_typeName": "string",
"key": 0
}
]
}
],
"vimAccountNameRequired": false,
"clusterSupported": false,
"network": [
{
"_typeName": "string",
"summary": {
"_typeName": "string",
"network": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"name": "string",
"accessible": false,
"ipPoolName": "string",
"ipPoolId": 0
}
}
],
"datastore": [
{
"_typeName": "string",
"summary": {
"_typeName": "string",
"datastore": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"name": "string",
"url": "string",
"capacity": 0,
"freeSpace": 0,
"uncommitted": 0,
"accessible": false,
"multipleHostAccess": false,
"type": "string",
"maintenanceMode": "string"
}
}
],
"license": {
"_typeName": "string",
"license": {
"_typeName": "string",
"licenseKey": "string",
"editionKey": "string",
"name": "string",
"total": 0,
"used": 0,
"costUnit": "string",
"properties": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"labels": [
{
"_typeName": "string",
"key": "string",
"value": "string"
}
]
},
"evaluation": {
"_typeName": "string",
"properties": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
]
},
"resource": {
"_typeName": "string",
"resource": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
]
}
},
"capability": {
"_typeName": "string",
"recursiveResourcePoolsSupported": false,
"cpuMemoryResourceConfigurationSupported": false,
"rebootSupported": false,
"shutdownSupported": false,
"vmotionSupported": false,
"standbySupported": false,
"ipmiSupported": false,
"maxSupportedVMs": 0,
"maxRunningVMs": 0,
"maxSupportedVcpus": 0,
"maxRegisteredVMs": 0,
"datastorePrincipalSupported": false,
"sanSupported": false,
"nfsSupported": false,
"iscsiSupported": false,
"vlanTaggingSupported": false,
"nicTeamingSupported": false,
"highGuestMemSupported": false,
"maintenanceModeSupported": false,
"suspendedRelocateSupported": false,
"restrictedSnapshotRelocateSupported": false,
"perVmSwapFiles": false,
"localSwapDatastoreSupported": false,
"unsharedSwapVMotionSupported": false,
"backgroundSnapshotsSupported": false,
"preAssignedPCIUnitNumbersSupported": false,
"screenshotSupported": false,
"scaledScreenshotSupported": false,
"storageVMotionSupported": false,
"vmotionWithStorageVMotionSupported": false,
"vmotionAcrossNetworkSupported": false,
"maxNumDisksSVMotion": 0,
"maxVirtualDiskDescVersionSupported": 0,
"hbrNicSelectionSupported": false,
"vrNfcNicSelectionSupported": false,
"recordReplaySupported": false,
"ftSupported": false,
"replayUnsupportedReason": "string",
"replayCompatibilityIssues": [
"string"
],
"smpFtSupported": false,
"ftCompatibilityIssues": [
"string"
],
"smpFtCompatibilityIssues": [
"string"
],
"maxVcpusPerFtVm": 0,
"loginBySSLThumbprintSupported": false,
"cloneFromSnapshotSupported": false,
"deltaDiskBackingsSupported": false,
"perVMNetworkTrafficShapingSupported": false,
"tpmSupported": false,
"tpmVersion": "string",
"txtEnabled": false,
"supportedCpuFeature": [
{
"_typeName": "string",
"level": 0,
"vendor": "string",
"eax": "string",
"ebx": "string",
"ecx": "string",
"edx": "string"
}
],
"virtualExecUsageSupported": false,
"storageIORMSupported": false,
"vmDirectPathGen2Supported": false,
"vmDirectPathGen2UnsupportedReason": [
"string"
],
"vmDirectPathGen2UnsupportedReasonExtended": "string",
"supportedVmfsMajorVersion": [
0
],
"vStorageCapable": false,
"snapshotRelayoutSupported": false,
"firewallIpRulesSupported": false,
"servicePackageInfoSupported": false,
"maxHostRunningVms": 0,
"maxHostSupportedVcpus": 0,
"vmfsDatastoreMountCapable": false,
"eightPlusHostVmfsSharedAccessSupported": false,
"nestedHVSupported": false,
"vPMCSupported": false,
"interVMCommunicationThroughVMCISupported": false,
"scheduledHardwareUpgradeSupported": false,
"featureCapabilitiesSupported": false,
"latencySensitivitySupported": false,
"storagePolicySupported": false,
"accel3dSupported": false,
"reliableMemoryAware": false,
"multipleNetworkStackInstanceSupported": false,
"messageBusProxySupported": false,
"vsanSupported": false,
"vFlashSupported": false,
"hostAccessManagerSupported": false,
"provisioningNicSelectionSupported": false,
"nfs41Supported": false,
"nfs41Krb5iSupported": false,
"turnDiskLocatorLedSupported": false,
"virtualVolumeDatastoreSupported": false,
"markAsSsdSupported": false,
"markAsLocalSupported": false,
"smartCardAuthenticationSupported": false,
"pMemSupported": false,
"pMemSnapshotSupported": false,
"cryptoSupported": false,
"oneKVolumeAPIsSupported": false,
"gatewayOnNicSupported": false,
"upitSupported": false,
"cpuHwMmuSupported": false,
"encryptedVMotionSupported": false,
"encryptionChangeOnAddRemoveSupported": false,
"encryptionHotOperationSupported": false,
"encryptionWithSnapshotsSupported": false,
"encryptionFaultToleranceSupported": false,
"encryptionMemorySaveSupported": false,
"encryptionRDMSupported": false,
"encryptionVFlashSupported": false,
"encryptionCBRCSupported": false,
"encryptionHBRSupported": false,
"ftEfiSupported": false,
"unmapMethodSupported": "string",
"maxMemMBPerFtVm": 0,
"virtualMmuUsageIgnored": false,
"virtualExecUsageIgnored": false,
"vmCreateDateSupported": false,
"vmfs3EOLSupported": false,
"ftVmcpSupported": false,
"quickBootSupported": false,
"encryptedFtSupported": false,
"assignableHardwareSupported": false,
"suspendToMemorySupported": false,
"useFeatureReqsForOldHWv": false,
"markPerenniallyReservedSupported": false,
"hppPspSupported": false,
"deviceRebindWithoutRebootSupported": false,
"storagePolicyChangeSupported": false,
"precisionTimeProtocolSupported": false,
"remoteDeviceVMotionSupported": false,
"maxSupportedVmMemory": 0,
"ahDeviceHintsSupported": false,
"nvmeOverTcpSupported": false,
"nvmeStorageFabricServicesSupported": false,
"assignHwPciConfigSupported": false,
"timeConfigSupported": false,
"nvmeBatchOperationsSupported": false,
"pMemFailoverSupported": false,
"hostConfigEncryptionSupported": false,
"maxSupportedSimultaneousThreads": 0,
"ptpConfigSupported": false,
"maxSupportedPtpPorts": 0,
"sgxRegistrationSupported": false,
"pMemIndependentSnapshotSupported": false,
"iommuSLDirtyCapable": false,
"vmknicBindingSupported": false,
"ultralowFixedUnmapSupported": false,
"nvmeVvolSupported": false,
"fptHotplugSupported": false,
"mconnectSupported": false,
"vsanNicMgmtSupported": false,
"vvolNQNSupported": false,
"stretchedSCSupported": false,
"vmknicBindingOnNFSv41": false,
"vpStatusCheckSupported": false,
"nConnectSupported": false,
"userKeySupported": false,
"ndcmSupported": false,
"uefiSecureBoot": false
}
}string
serverIp
Optional
The IP address of the VirtualCenter already managing this host, if any.
boolean
inDasCluster
Optional
If the host is already being managed by a vCenter Server, this property reports true if the host is also part of a vSphere HA enabled cluster.
If this is the case, remove or disconnect the host from this cluster before adding it to another vCenter Server.
host
Required
This data object type encapsulates a typical set of host information that is useful for list views and summary pages.
VirtualCenter can retrieve this information very efficiently, even for a large set of hosts.
boolean
vimAccountNameRequired
Optional
Whether or not the host requires a vimAccountName and password to be set in the ConnectSpec.
This is normally only required for VMware Server hosts.
boolean
clusterSupported
Optional
Whether or not the host supports clustering capabilities such as HA or DRS and therefore can be added to a cluster.
If false, the host must be added as a standalone host.
array of HostConnectInfoNetworkInfo
network
Optional
The list of network information for networks configured on this host.
license
Optional
This data object type describes license information stored on the host.
capability
Optional
Specifies the capabilities of the particular host.
This set of capabilities is referenced in other parts of the API specification to indicate under what circumstances an API will throw a NotSupported fault.
500
NotSupported: if called directly on a host.
NoHost: if unable to contact the host.
InvalidLogin: if unable to authenticate with the host.
NotSupportedHost: if the software version on the host is not supported.
AlreadyConnected: if the host is already being managed by this server.
HostConnectFault: if an error occurred when querying about a host. Typically, a more specific subclass, such as AlreadyBeingManaged, is thrown.
SSLDisabledFault: if the host has SSL access disabled
SSLVerifyFault: if the host certificate could not be authenticated
InvalidArgument: if both arguments sslThumbprint and sslCertificate are set, or if only the sslThumbprint argument is set, but the SHA-1 hashing algorithm is currently disabled for computing certificate thumbprints.
Returns VimFault of type(s) application/json
This response body class contains all of the following: MethodFault
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}
On This Page
Virtual Infrastructure Operations
POST
Datacenter Batch Query Connect Info
POST
Datacenter Destroy Task
GET
Datacenter Get Alarm Actions Enabled
GET
Datacenter Get Available Field
GET
Datacenter Get Config Issue
GET
Datacenter Get Config Status
GET
Datacenter Get Configuration
GET
Datacenter Get Custom Value
GET
Datacenter Get Datastore
GET
Datacenter Get Datastore Folder
GET
Datacenter Get Declared Alarm State
GET
Datacenter Get Disabled Method
GET
Datacenter Get Effective Role
GET
Datacenter Get Host Folder
GET
Datacenter Get Name
GET
Datacenter Get Network
GET
Datacenter Get Network Folder
GET
Datacenter Get Overall Status
GET
Datacenter Get Parent
GET
Datacenter Get Permission
GET
Datacenter Get Recent Task
GET
Datacenter Get Tag
GET
Datacenter Get Triggered Alarm State
GET
Datacenter Get Value
GET
Datacenter Get Vm Folder
POST
Datacenter Power On Multi VM Task
POST
Datacenter Query Connection Info
POST
Datacenter Query Connection Info Via Spec
POST
Datacenter Query Datacenter Config Option Descriptor
POST
Datacenter Reconfigure Datacenter Task
POST
Datacenter Reload
POST
Datacenter Rename Task
POST
Datacenter Set Custom Value