Iscsi Manager Query Vnic Status

Query the status of Virtual NIC association with the iSCSI.

Required privileges: Host.Config.Storage

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/IscsiManager/{moId}/QueryVnicStatus

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

QueryVnicStatusRequestType of type(s) application/json

Required

{
    "vnicDevice": "string"
}

string

vnicDevice

Required

Virtual NIC device to check the status for

Authentication

This operation uses the following authentication methods.

Session

Responses

200

A status object IscsiStatus, containing list of the fault codes, providing the user with information as to whether Virtual NIC is used by iSCSI and list of compliance check failure codes if any. The returned IscsiStatus object will have an array of MethodFault objects providing following information:

Empty IscsiStatus (i.e reason unset) if Virtual NIC device is not used.
Fault code IscsiFaultVnicInUse if Virtual NIC is being used by iSCSI.
This will be followed with list of fault codes corresponding to the compliance check failures.

Returns IscsiStatus of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "reason": [
        {
            "_typeName": "string",
            "faultCause": "MethodFault Object",
            "faultMessage": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "arg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "message": "string"
                }
            ]
        }
    ]
}

array of MethodFault

reason

Optional

List of failure reason and associated remedy.

An array of fault codes associated with the failure. The fault itself will provide an indication of the actual failure code and MethodFault.faultMessage will indicate the remedy that needs to be taken to correct the failure.

500

IscsiFault: For any problem that is not handled with a more specific fault.

Returns IscsiFault of type(s) application/json

This response body class contains all of the following: VimFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Iscsi Manager Operations

POST

Iscsi Manager Bind Vnic