Sms Storage Manager Register Provider Task

Required privileges: StorageViews.ConfigureService

Request

URI

POST

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

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 9.1.0.0 APIs.

Request Body

RegisterProviderRequestType of type(s) application/json

Required

Show optional properties

{
    "providerSpec": {}
}

{
    "providerSpec": {
        "_typeName": "string",
        "name": "string",
        "description": "string"
    }
}

providerSpec

Required

SmsProviderSpec containing parameters needed to register the provider

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

InvalidArgument: if invalid input is provided.

AlreadyExists: if the provider already exists.

ProviderRegistrationFault: if an error is encountered during the registration operation. For instance, IncorrectUsernamePassword is thrown if the login credentials are incorrect. CertificateNotTrusted is thrown if the provider identifies itself with an untrusted certificate.

Returns MethodFault of type(s) application/json

This response body class contains all of the following: Any

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

faultCause

Optional

Fault which is the cause of this fault.

array of object

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.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"providerSpec":"{}"}' https://{api_host}/sdk/vim25/{release}/sms/SmsStorageManager/{moId}/RegisterProvider_Task

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Storage Monitoring Service Operations