[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api

Add Datastore Group

Description

Add a replicated datastore group from an Array-Based Replication protection group. This operation also protects all VMs, including VMs residing on any datastore that is part of the newly added datastore group. For a non-Array-Based Replication protection group, this will return an empty response.

Request

Request

URL

URL


post
https://{api_host}//pairings/{pairing_id}/protection-management/groups/{group_id}/datastore-groups
Copy

Path Parameters

Path Parameters

string
pairing_id Required

The ID of a pairing between this Site Recovery Manager server and remote one.


string
group_id Required

The ID of a protection group defined within current pairing.


Request Body

Request Body

AddDatastoreGroupSpec of mimetype application/json Required

A spec containing the ID of a datastore group to be added to the protection group.

{
	"datastores": [
		"string"
	]
}
array of string
datastores Optional

A list of datastore group references. Datastore group is a set of replicated datastores.

  • Virtual machines located on these datastores can be protected. Virtual machine location is defined by its home directory (the directory that holds the .vmx file).
  • Any given replicated datastore can be part of only one protection group.
  • Datastores backed by storage devices combined in a consistency group must be added to the same protection group.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

202 Accepted

Returns TaskDrResponseEntity of type application/json

A task to track the addition of a datastore group to an Array-Based Replication protection group.

{
	"_meta": {
		"errors": [
			{
				"code": "string",
				"field": "string",
				"message": "string"
			}
		]
	},
	"complete_time": 0,
	"description": "string",
	"description_id": "string",
	"entity": "string",
	"entity_name": "string",
	"error": {
		"details": "string",
		"message": "string"
	},
	"id": "string",
	"progress": 0,
	"queued_time": 0,
	"result": {},
	"start_time": 0,
	"status": "QUEUED"
}
_meta Optional

Response meta data. Contains data about the response payload data.

Errors

Errors

ResponseError
400

Bad request - the server could not understand the request due to invalid syntax or invalid request body content


401

Unauthorized - the client must authenticate itself to get the requested response


ResponseError
403

Forbidden - not sufficient access rights to fulfill the request


404

Not Found - server cannot find the requested in URL resource


ResponseError
500

Internal server error - unexpected condition prevents fulfilling the request

Code Samples

Code Samples

PowerCLI Client SDK Example

$AddDatastoreGroupSpec = Initialize-SrmAddDatastoreGroupSpec -Datastores "MyDatastores"
Invoke-SrmAddDatastoreGroup -pairingId "MypairingId" -groupId "MygroupId" -addDatastoreGroupSpec $addDatastoreGroupSpec

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"datastores":["string"]}' https://{api_host}/pairings/{pairing_id}/protection-management/groups/{group_id}/datastore-groups
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-dr-permissions:
    permissions:
        - System.View
        - System.Read
        - VcDr.ProtectionProfile.com.vmware.vcDr.Edit
x-dr-remote-site-connectivity-contract:
    not-authenticated: ERROR
    server-down: ERROR


Feedback

Was this page helpful?