Host Network System Query Network Hint

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

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/HostNetworkSystem/{moId}/QueryNetworkHint
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 HostNetworkSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.

Request Body
QueryNetworkHintRequestType of type(s) application/json
Required 
{
    "device": [
        "string"
    ]
}
array of string
device
Optional

device

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Array of PhysicalNicHintInfo of type(s) application/json 
[
    {
        "_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"
                    }
                }
            ]
        }
    }
]

500

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.

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
Host Network System Add Port Group
POST
Host Network System Add Service Console Virtual Nic
POST
Host Network System Add Virtual Nic
POST
Host Network System Add Virtual Switch
GET
Host Network System Get Available Field
GET
Host Network System Get Capabilities
GET
Host Network System Get Console Ip Route Config
GET
Host Network System Get Dns Config
GET
Host Network System Get Ip Route Config
GET
Host Network System Get Network Config
GET
Host Network System Get Network Info
GET
Host Network System Get Offload Capabilities
GET
Host Network System Get Value
POST
Host Network System Query Network Hint
POST
Host Network System Refresh Network System
POST
Host Network System Remove Port Group
POST
Host Network System Remove Service Console Virtual Nic
POST
Host Network System Remove Virtual Nic
POST
Host Network System Remove Virtual Switch
POST
Host Network System Restart Service Console Virtual Nic
POST
Host Network System Set Custom Value
POST
Host Network System Start Dpu Failover
POST
Host Network System Update Console Ip Route Config
POST
Host Network System Update Dns Config
POST
Host Network System Update Ip Route Config
POST
Host Network System Update Ip Route Table Config
POST
Host Network System Update Network Config
POST
Host Network System Update Physical Nic Link Speed
POST
Host Network System Update Port Group
POST
Host Network System Update Service Console Virtual Nic
POST
Host Network System Update Virtual Nic
POST
Host Network System Update Virtual Switch