Snapservice. Clusters. Protection Groups Activate$ Task

Activate the specified protection group. This operation activates a protection group from a recovery state putting it into an active state.

This will result in enabling local protection and remote replication for the members in the protection group.

This operation was added in vSphere API 9.0.0.0.

Request

URI

POST

https://{host}/api/snapservice/clusters/{cluster}/protection-groups/{pg}?action=activate&vmw-task=true

COPY

Path Parameters

string

cluster

Required

Identifier of the cluster.

The parameter must be an identifier for the resource type: ClusterComputeResource.

string

Required

Identifier of the protection group

The parameter must be an identifier for the resource type: com.vmware.snapservice.protection_group.

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

202

Success!

Returns string of type(s) application/json

Operation doesn't return any data structure

400

Vapi.Std.Errors.AlreadyInDesiredState If the protection group is already in active state.

Vapi.Std.Errors.NotAllowedInCurrentState If the specified protection group is not in a valid state for the transition or if there is another operation in progress.

Returns Vapi.Std.Errors.Error of type(s) application/json

"Vapi.Std.Errors.Error Object"

401

If the caller is not authenticated.

Returns Vapi.Std.Errors.Unauthenticated of type(s) application/json

"Vapi.Std.Errors.Unauthenticated Object"

403

If the caller is not authorized to perform the operation.

Returns Vapi.Std.Errors.Unauthorized of type(s) application/json

"Vapi.Std.Errors.Unauthorized Object"

404

If there is no cluster associated with cluster or protection group associated with pg in the system.

Returns Vapi.Std.Errors.NotFound of type(s) application/json

"Vapi.Std.Errors.NotFound Object"

500

If there is unknown internal error.

Returns Vapi.Std.Errors.Error of type(s) application/json

"Vapi.Std.Errors.Error Object"

503

If the service is not available.

Returns Vapi.Std.Errors.ServiceUnavailable of type(s) application/json

"Vapi.Std.Errors.ServiceUnavailable Object"

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' https://{api_host}/api/snapservice/clusters/{cluster}/protection-groups/{pg}?action=activate&vmw-task=true

On This Page

Description

Request

Path Parameters

Authentication

Response

202 Response Body

Errors

Snapservice.clusters.protection Groups Operations

GET

Snapservice. Clusters. Protection Groups List

GET