Sms Storage Manager Query Array Associated With Lun

Get the StorageArray object that is associated with the ScsiLun.

Required privileges: StorageViews.View

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/sms/SmsStorageManager/{moId}/QueryArrayAssociatedWithLun

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

string

release

Required

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

Request Body

QueryArrayAssociatedWithLunRequestType of type(s) application/json

Required

{
    "canonicalName": "string"
}

string

canonicalName

Required

ScsiLun.canonicalName of ScsiLun

Authentication

This operation uses the following authentication methods.

Session

Responses

200

StorageArray for the for the ScsiLun.

Returns StorageArray of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "name": "string",
    "uuid": "string",
    "vendorId": "string",
    "modelId": "string",
    "firmware": "string",
    "alternateName": [
        "string"
    ],
    "supportedBlockInterface": [
        "string"
    ],
    "supportedFileSystemInterface": [
        "string"
    ],
    "supportedProfile": [
        "string"
    ],
    "priority": 0,
    "discoverySvc": [
        {
            "_typeName": "string",
            "portType": "string",
            "svcNqn": "string",
            "ipInfo": {
                "_typeName": "string",
                "ipAddress": "string",
                "portNumber": "string"
            },
            "fcInfo": {
                "_typeName": "string",
                "nodeWwn": "string",
                "portWwn": "string"
            }
        }
    ]
}

string

name

Required

Name

string

uuid

Required

Unique identifier

string

vendorId

Required

Storage array Vendor Id

string

modelId

Required

Model Id

string

firmware

Optional

Storage array firmware

array of string

alternateName

Optional

List of alternate storage array names

array of string

supportedBlockInterface

Optional

Supported block-device interfaces

array of string

supportedFileSystemInterface

Optional

Supported file-system interfaces

array of string

supportedProfile

Optional

List of supported profiles

integer As int32 As int32

priority

Optional

Deprecated as of SMS API 6.0, replaced by VasaProviderInfo.priority.

Priority level of the provider for the given array within the session context.

SMS will use this value to pick a provider among the ones that are registered with SMS and manage this array. Once the provider is chosen, SMS will communicate with it to get the data related to this array. Valid range: 0 to 255.

array of VASAStorageArrayDiscoverySvcInfo

discoverySvc

Optional

Required for NVMe-oF arrays and optional otherwise.

Transport information to address the array's discovery service.

500

NotFound: if the specified entity does not exist.

QueryExecutionFault: if an error is encountered while processing the query request.

Returns MethodFault of type(s) application/json

This response body class contains all of the following: Any

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

MethodFault

faultCause

Optional

The base data object type for all the object model faults that an application might handle.

array of LocalizableMessage

faultMessage

Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.

On This Page

Description

Request

Path Parameters