Create Group

Create Group

Create a new protection group in a given pairing.

Request
URI
POST
https://{api_host}/pairings/{pairing_id}/protection-management/groups
COPY
Path Parameters
string
pairing_id
Required

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


Request Body

Spec describing the new group

ProtectionGroupCreateSpec of type(s) application/json
Required

Show optional properties

{
    "name": "string",
    "replication_type": "string",
    "protected_vc_guid": "string"
}
{
    "name": "string",
    "description": "string",
    "abr_spec": {
        "replicated_array_pair": "string",
        "datastores": [
            "string"
        ]
    },
    "hbr_spec": {
        "vms": [
            "string"
        ]
    },
    "vvol_spec": {
        "replication_groups": [
            {
                "fault_domain_id": "string",
                "device_group_id": "string"
            }
        ]
    },
    "location": "string",
    "replication_type": "string",
    "protected_vc_guid": "string"
}
string
name
Required
Constraints: minLength: 0 maxLength: 80

The name of the group.

string
description
Optional
Constraints: minLength: 0 maxLength: 4096

The description of the group.

object
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.

object
hbr_spec
Optional

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

object
vvol_spec
Optional

VMware vSphere Virtual Volumes (vVols)-based replication details for creation or modification of the protection group.

string
location
Optional

The target location where the protection group will be placed. If not specified - the root folder will be used.

string
replication_type
Required

Underlying replication type of the protection group. <ul> <li>UNKNOWN - Unknown replication * <li>ABR - Array-based replication <li>HBR - Host-based replication <li>VVOL - vVols-based * replication </ul>

Possible values are : UNKNOWN, ABR, HBR, VVOL,
string
protected_vc_guid
Required

The GUID of the protected site VC.

Authentication
This operation uses the following authentication methods.
Responses
202

Protection group creation task

Returns TaskDrResponseEntity of type(s) application/json
This response body class contains all of the following: InlineTaskDrResponseEntity0 , InlineTaskDrResponseEntity1
"TaskDrResponseEntity Object"

400

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

Returns ResponseError of type(s) application/json
"ResponseError Object"
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


401

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

Operation doesn't return any data structure

403

Forbidden - not sufficient access rights to fulfill the request

Returns ResponseError of type(s) application/json
"ResponseError Object"
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


404

Not Found - server cannot find the requested in URL resource

Operation doesn't return any data structure

500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json
"ResponseError Object"
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","protected_vc_guid:"string","replication_type:"string"}' https://{api_host}/pairings/{pairing_id}/protection-management/groups