Host Virtual Nic Manager Query Net Config

Host Virtual Nic Manager Query Net Config

Get the NetConfig for the specified nicType

Required privileges: System.Read

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

string
release
Required

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


Request Body
QueryNetConfigRequestType of type(s) application/json
Required
{
    "nicType": "string"
}
string
nicType
Required

The HostVirtualNicManagerNicTypeEnum

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns VirtualNicManagerNetConfig of type(s) application/json
This response body class contains all of the following: DataObject
{
    "_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": {
                "_typeName": "string",
                "key": "string",
                "mac": [
                    "string"
                ],
                "type": "string"
            }
        }
    ],
    "selectedVnic": [
        {
            "_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": {
                "_typeName": "string",
                "key": "string",
                "mac": [
                    "string"
                ],
                "type": "string"
            }
        }
    ]
}
string
nicType
Required

The NicType of this NetConfig.

boolean
multiSelectAllowed
Required

Whether multiple nics can be selected for this nicType.

candidateVnic
Optional

List of VirtualNic objects that may be used.

This will be a subset of the list of VirtualNics in HostNetworkInfo.vnic.

selectedVnic
Optional

List of VirtualNic objects that are selected for use.


500

InvalidArgument: if nicType is invalid

HostConfigFault: for any other failure.

Returns MethodFault of type(s) application/json
This response body class contains all of the following: Any
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}
faultCause
Optional

The base data object type for all the object model faults that an application might handle.

faultMessage
Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.