Host Storage System Discover Nvme Controllers

Connects to a Discovery Controller and retrieves the Discovery Log using the provided NvmeDiscoverSpec.

For more details, see:

"NVM Express over Fabrics 1.0", Section 5, "Discovery service"

Required privileges: Host.Config.Storage

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostStorageSystem/{moId}/DiscoverNvmeControllers

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 HostStorageSystem/{moId}.

string

release

Required

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

Request Body

DiscoverNvmeControllersRequestType of type(s) application/json

Required

{
    "discoverSpec": {
        "_typeName": "string",
        "hbaName": "string",
        "transportParameters": {
            "_typeName": "string"
        },
        "autoConnect": false,
        "rootDiscoveryController": false
    }
}

HostNvmeDiscoverSpec

discoverSpec

Required

Specifies the parameters necessary to connect to a Discovery Service and retrieve a Discovery Log Page.

Here the transportParameters are used to establish a transport level connection to a Discovery Controller. Further details can be found here:

"NVM Express over Fabrics 1.0", Section 5, "Discovery service"

Authentication

This operation uses the following authentication methods.

Session

Responses

200

discoveryLog A data object that represents the Discovery Log.

Returns HostNvmeDiscoveryLog of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "entry": [
        {
            "_typeName": "string",
            "subnqn": "string",
            "subsystemType": "string",
            "subsystemPortId": 0,
            "controllerId": 0,
            "adminQueueMaxSize": 0,
            "transportParameters": {
                "_typeName": "string"
            },
            "transportRequirements": "string",
            "connected": false
        }
    ],
    "complete": false
}

array of HostNvmeDiscoveryLogEntry

entry

Optional

The list of entries that make up the Discovery Log.

boolean

complete

Required

Indicates whether the NvmeDiscoveryLog object completely represents the underlying Discovery Log returned by the controller.

It is possible some of the entries returned by the Discovery Controller contain unsupported transport types or data that cannot be interpreted - in that case, those entries will be skipped and the log will be marked as incomplete.

500

NotFound: if the given HBA or transport target could not be found.

InvalidArgument: if the provided spec is not valid.

NotSupported: if the adapter does not support the provided combination of parameters.

HostConfigFault: if the host is unable to retrieve the discovery log.

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

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Host Storage System Operations