VasaProviderInfo

VasaProviderInfo
VasaProviderInfo

Information about VASA (vStorage APIs for Storage Awareness) providers.

This structure may be used only with operations rendered under /sms.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "uid": "string",
    "name": "string",
    "description": "string",
    "version": "string",
    "url": "string",
    "certificate": "string",
    "status": "string",
    "statusFault": {
        "_typeName": "string",
        "faultCause": "MethodFault Object",
        "faultMessage": [
            {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            }
        ]
    },
    "vasaVersion": "string",
    "namespace": "string",
    "lastSyncTime": "string",
    "supportedVendorModelMapping": [
        {
            "_typeName": "string",
            "vendorId": "string",
            "modelId": "string"
        }
    ],
    "supportedProfile": [
        "string"
    ],
    "supportedProviderProfile": [
        "string"
    ],
    "relatedStorageArray": [
        {
            "_typeName": "string",
            "arrayId": "string",
            "active": false,
            "manageable": false,
            "priority": 0
        }
    ],
    "providerId": "string",
    "certificateExpiryDate": "string",
    "certificateStatus": "string",
    "serviceLocation": "string",
    "needsExplicitActivation": false,
    "maxBatchSize": 0,
    "retainVasaProviderCertificate": false,
    "arrayIndependentProvider": false,
    "type": "string",
    "category": "string",
    "priority": 0,
    "failoverGroupId": "string"
}
string
url
Required

Provider URL

string
certificate
Optional

Provider certificate

string
status
Optional

The operational state of VASA Provider.

statusFault
Optional

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

string
vasaVersion
Optional

Supported VASA(vStorage APIs for Storage Awareness) version

string
namespace
Optional

Namespace to categorize storage capabilities provided by arrays managed by the provider

string
lastSyncTime
Optional

Time stamp to indicate when last sync operation was completed successfully.

supportedVendorModelMapping
Optional

List containing mapping between the supported vendorID and corresponding modelID

array of string
supportedProfile
Optional

Deprecated as of SMS API 3.0, use supportedProfile.

List of supported profiles

array of string
supportedProviderProfile
Optional

List of supported profiles at provider level.

Must be one of the string values from ProviderProfileEnum.

relatedStorageArray
Optional

List containing mapping between storage arrays reported by the provider and information such as whether the provider is considered active for them.

string
providerId
Optional

Provider identifier reported by the provider which is unique within the provider namespace.

string
certificateExpiryDate
Optional

Provider certificate expiry date.

string
certificateStatus
Optional

Provider certificate status This field holds values from VasaProviderCertificateStatusEnum

string
serviceLocation
Optional

Service location for the VASA endpoint that SMS is using to communicate with the provider.

boolean
needsExplicitActivation
Optional

Indicates the type of deployment supported by the provider.

If true, it is an active/passive deployment and the provider needs to be activated explicitly using activateProviderEx() VASA API. If false, it is an active/active deployment and provider does not need any explicit activation to respond to VASA calls.

integer As int64 As int64
maxBatchSize
Optional

Maximum number of elements in batch APIs that the VASA Provider can support.

This value is common to all batch APIs supported by the provider. However, for each specific API, the provider may still throw or return TooMany fault in which a different value of maxBatchSize can be specified. If the value is not specified (zero) or invalid (negative), client will assume there's no common limit for the number of elements that can be handled in all batch APIs.

boolean
retainVasaProviderCertificate
Optional

Indicate whether the provider wants to retain its certificate after bootstrapping.

If true, SMS will not provision a VMCA signed certificate for the provider and all certificate life cycle management workflows are disabled for this provider certificate. If false, SMS will provision a VMCA signed certificate for the provider and all certificate life cycle management workflows are enabled for this provider certificate.

boolean
arrayIndependentProvider
Optional

Indicates if this provider is independent of arrays.

Default value for this flag is false, which means this provider supports arrays. Arrays will be queried for this provider during sync. If this flag is set to true, arrays will not be synced for this provider and array related API will not be invoked on this provider.

string
type
Optional

Type of this VASA provider.

This field will be equal to one of the values of VpTypeEnum.

string
category
Optional

This field indicates the category of the provider and will be equal to one of the values of VpCategoryEnum.

integer As int32 As int32
priority
Optional

Priority level of the provider within a VASA HA group.

For a stand-alone provider which does not participate in VASA HA, this field will be ignored.

The priority value is an integer with valid range from 0 to 255.

string
failoverGroupId
Optional

Unique identifier of a VASA HA group.

Providers should report this identifier to utilize HA feature supported by vSphere. Different providers reporting the same failoverGroupId will be treated as an HA group. Failover/failback will be done within one group.