Host Network System Query Network Hint
Requests network hint information for a physical network adapter.
A network hint is some information about the network to which the physical network adapter is attached. The method receives in a list of physical network adapter devices and returns an equal number of hints if some devices are provided. If the list of devices is empty, then the method accesses hints for all physical network adapters.
See also supportsNetworkHints, device.
Required privileges: System.Read
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 HostNetworkSystem/{moId}
.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
{
"device": [
"string"
]
}
device
OK
[
{
"_typeName": "string",
"device": "string",
"subnet": [
{
"_typeName": "string",
"vlanId": 0,
"ipSubnet": "string"
}
],
"network": [
{
"_typeName": "string",
"vlanId": 0,
"network": "string"
}
],
"connectedSwitchPort": {
"_typeName": "string",
"cdpVersion": 0,
"timeout": 0,
"ttl": 0,
"samples": 0,
"devId": "string",
"address": "string",
"portId": "string",
"deviceCapability": {
"_typeName": "string",
"router": false,
"transparentBridge": false,
"sourceRouteBridge": false,
"networkSwitch": false,
"host": false,
"igmpEnabled": false,
"repeater": false
},
"softwareVersion": "string",
"hardwarePlatform": "string",
"ipPrefix": "string",
"ipPrefixLen": 0,
"vlan": 0,
"fullDuplex": false,
"mtu": 0,
"systemName": "string",
"systemOID": "string",
"mgmtAddr": "string",
"location": "string"
},
"lldpInfo": {
"_typeName": "string",
"chassisId": "string",
"portId": "string",
"timeToLive": 0,
"parameter": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
]
}
}
]
NotFound: if a specified physical network adapter does not exist.
InvalidArgument: if the speed and duplexity combination is not valid for the current link driver.
NotSupported: if the host is not an ESX Server system.
HostConfigFault: for all other configuration failures.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}