Iscsi Manager Bind Vnic

Iscsi Manager Bind Vnic

Bind a Virtual NIC to be used for an iSCSI adapter

Required privileges: Host.Config.Storage

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/IscsiManager/{moId}/BindVnic
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.2.0 APIs.


Request Body
BindVnicRequestType of type(s) application/json
Required
{
    "iScsiHbaName": "string",
    "vnicDevice": "string"
}
string
iScsiHbaName
Required

iSCSI adapter name for which the Virtual NIC to be added.

string
vnicDevice
Required

Virtual NIC that is to be bound to the iSCSI HBA

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

IscsiFaultVnicAlreadyBound: The given Virtual NIC is already bound to the HBA.

IscsiFaultVnicHasNoUplinks: The given Virtual NIC has no physical uplinks.

IscsiFaultVnicHasMultipleUplinks: The given Virtual NIC has multiple uplinks.

IscsiFaultVnicHasWrongUplink: The given Virtual NIC has the wrong uplink and it can't be used for iSCSI multi-pathing.

IscsiFaultVnicNotFound: The given Virtual NIC is not present on the system.

IscsiFaultInvalidVnic: The given Virtual NIC is not valid for the HBA.

PlatformConfigFault: For platform error that occurs during the operation.

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"
        }
    ]
}