Iscsi Manager Query Pnic Status

Query if Physical NIC device is used for iSCSI.

Required privileges: Host.Config.Storage

Request

URI

POST

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

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

QueryPnicStatusRequestType of type(s) application/json

Required

{
    "pnicDevice": "string"
}

string

pnicDevice

Required

Physical NIC device name to check the status for

Authentication

This operation uses the following authentication methods.

Session

Responses

200

A status object, IscsiStatus, indicating whether Physical NIC is used by iSCSI or not.

Empty IscsiStatus (i.e reason unset) if Physical NIC device is not used.
Fault code IscsiFaultPnicInUse if Physical NIC is being used.

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

Virtual Infrastructure Operations

POST

Iscsi Manager Bind Vnic