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

Reconfigure Group

Description

Reconfigure settings for this group.

Request

Request

URL

URL


post
https://{api_host}//pairings/{pairing_id}/protection-management/groups/{group_id}/actions/reconfigure
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

ProtectionGroupEditSpec of mimetype application/json Required

Spec describing the new protection group settings.

{
	"name": "string"
}
string
name Required

The name of the group.


abr_spec Optional

Array-based replication details for creation or modification of a protection group.

replicatedArrayPair is the replicated array pair that holds underlying storage devices.


string
description Optional

The description of the group.


hbr_spec Optional

Host-based replication details for creation or modification of the protection group.


vvol_spec Optional

VMware vSphere Virtual Volumes (vVols)-based replication details for creation or modification of the 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

Task to monitor the operation progress.

{
	"_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

$AbrProtectionGroupSpec = Initialize-SrmAbrProtectionGroupSpec -ReplicatedArrayPair "MyReplicatedArrayPair" -Datastores "MyDatastores"
$HbrProtectionGroupSpec = Initialize-SrmHbrProtectionGroupSpec -Vms "MyVms"
$VvolReplicationGroupData = Initialize-SrmVvolReplicationGroupData -FaultDomainId "MyFaultDomainId" -DeviceGroupId "MyDeviceGroupId"
$VvolProtectionGroupSpec = Initialize-SrmVvolProtectionGroupSpec -ReplicationGroups $VvolReplicationGroupData
$ProtectionGroupEditSpec = Initialize-SrmProtectionGroupEditSpec -Name "MyName" -Description "MyDescription" -AbrSpec $AbrProtectionGroupSpec -HbrSpec $HbrProtectionGroupSpec -VvolSpec $VvolProtectionGroupSpec
Invoke-SrmReconfigureGroup -pairingId "MypairingId" -groupId "MygroupId" -protectionGroupEditSpec $protectionGroupEditSpec

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"abr_spec":{"datastores":["string"],"replicated_array_pair":"string"},"description":"string","hbr_spec":{"vms":["string"]},"name":"string","vvol_spec":{"replication_groups":[{"device_group_id":"string","fault_domain_id":"string"}]}}' https://{api_host}/pairings/{pairing_id}/protection-management/groups/{group_id}/actions/reconfigure
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?