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

The name of the group.

string
description
Optional

The description of the group.

abr_spec
Optional

abr_spec

hbr_spec
Optional

hbr_spec

vvol_spec
Optional

vvol_spec

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:

  • UNKNOWN - Unknown replication.
  • ABR - Array-based replication.
  • HBR - Host-based replication replication.
  • VVOL - VVOL-based replication.

Possible values are : UNKNOWN, ABR, HBR, VVOL,
string As uuid As uuid
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: Task
{
    "id": "string",
    "description": "string",
    "description_id": "string",
    "entity": "string",
    "entity_name": "string",
    "status": "string",
    "error": {
        "message": "string",
        "details": "string"
    },
    "progress": 0,
    "queued_time": 0,
    "start_time": 0,
    "complete_time": 0,
    "_meta": {
        "errors": [
            {
                "code": "string",
                "message": "string",
                "field": "string"
            }
        ]
    }
}
_meta
Optional

_meta


400

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

Returns ResponseError of type(s) application/json
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
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
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
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
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
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.