Iscsi Manager Query Candidate Nics
Query the candidate Virtual NICs and Physical NICs that can be used for Port-Binding.
For dependent offload adapters, the Virtual NIC should be attached to the physical NIC associated with the hardware function.
Required privileges: Host.Config.Storage
Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/IscsiManager/{moId}/QueryCandidateNics
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 IscsiManager/{moId}.
string
release
Required
The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.
Request Body
QueryCandidateNicsRequestType of type(s) application/json
Required
{
"iScsiHbaName": "string"
}string
iScsiHbaName
Required
iSCSI Adapter name for which the method to be applied.
Responses
200
Array of IscsiPortInfo containing detailed information on list of eligible Virtual NICs that can be bound to the adapter. This list will also include details on the eligible Physical NICs that are not associated with any Virtual NICs.
Returns Array of IscsiPortInfo of type(s) application/json
[
{
"_typeName": "string",
"vnicDevice": "string",
"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": {
"_typeName": "string",
"key": "string",
"mac": [
"string"
],
"type": "string"
}
},
"pnicDevice": "string",
"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": {
"_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
}
},
"dpuId": "string"
},
"switchName": "string",
"switchUuid": "string",
"portgroupName": "string",
"portgroupKey": "string",
"portKey": "string",
"opaqueNetworkId": "string",
"opaqueNetworkType": "string",
"opaqueNetworkName": "string",
"externalId": "string",
"complianceStatus": {
"_typeName": "string",
"reason": [
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}
]
},
"pathStatus": "string"
}
]
500
IscsiFault: For any problem that is not handled with a more specific fault.
NotFound: If the given HBA is not found
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
Iscsi Manager Bind Vnic
POST
Iscsi Manager Query Bound Vnics
POST
Iscsi Manager Query Candidate Nics
POST
Iscsi Manager Query Migration Dependencies
POST
Iscsi Manager Query Pnic Status
POST
Iscsi Manager Query Vnic Status
POST
Iscsi Manager Unbind Vnic