Vasa Provider Failover Replication Group Task

Failover the specified device groups.

This function will always be called at the replication target location.

Required privileges: StorageViews.ConfigureService

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/sms/VasaProvider/{moId}/FailoverReplicationGroup_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 VasaProvider/{moId}.

string

release

Required

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

Request Body

FailoverReplicationGroupRequestType of type(s) application/json

Required

Show optional properties

{
    "failoverParam": {
        "isPlanned": false,
        "checkOnly": false
    }
}

{
    "failoverParam": {
        "_typeName": "string",
        "isPlanned": false,
        "checkOnly": false,
        "replicationGroupsToFailover": [
            {
                "_typeName": "string",
                "groupId": {
                    "_typeName": "string",
                    "faultDomainId": {
                        "_typeName": "string",
                        "id": "string"
                    },
                    "deviceGroupId": {
                        "_typeName": "string",
                        "id": "string"
                    }
                },
                "pitId": {
                    "_typeName": "string",
                    "id": "string"
                }
            }
        ],
        "policyAssociations": [
            {
                "_typeName": "string",
                "id": {
                    "_typeName": "string"
                },
                "policyId": "string",
                "datastore": {
                    "_typeName": "string",
                    "type": "string",
                    "value": "string"
                }
            }
        ]
    }
}

FailoverParam

failoverParam

Required

Input to the failover or testFailover methods.

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

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 failoverParam is null or contains invalid data.

NotImplemented: if the provider does not implement this function.

ProviderUnavailable: if the provider is temporarily unavailable.

ProviderOutOfResource: if it is not possible to perform the operation due to lack of resources.

InactiveProvider: if the provider is inactive for the specified entity.

TooMany: Thrown if the Provider is unable to handle the given set of replication groups in one call. The client needs to call this method based on the maxBatchSize specified in the TooMany fault. If the maxBatchSize is not specified, the client is expected to call the function for each group individually (i.e. maxBatchSize = 1).

ProviderBusy: if the provider is busy and cannot process the request.

SmsReplicationFault: if an error is encountered while processing the 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