Changed1

[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]

srm-rest-api

Create Array Manager

Description

Create a Site Recovery Manager array manager that is part of a given pairing.

Request

URL

post

https://{api_host}//pairings/{pairing_id}/srms/{srm_id}/replication-management/abr/array-managers

Copy

Path Parameters

string

pairing_id Required

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

string

srm_id Required

ID of a Site Recovery Manager server.

Request Body

ArrayManagerSpec of mimetype application/json Required

Spec describing the new array manager.

Show optional properties

{
	"connection_params": [
		{
			"connection_params": [
				{
					"hint": "string",
					"key": "string",
					"name": "string",
					"optional": false,
					"password_param": false,
					"type": "USER_NAME"
				}
			],
			"key": "string",
			"name": "string"
		}
	],
	"name": "string",
	"storage_adapter": "string"
}

{
	"connection_params": [
		{
			"connection_params": [
				{
					"hint": "string",
					"key": "string",
					"name": "string",
					"optional": false,
					"password_param": false,
					"type": "USER_NAME",
					"value": "string"
				}
			],
			"hint": "string",
			"key": "string",
			"name": "string"
		}
	],
	"name": "string",
	"storage_adapter": "string"
}

array of ConnectionParamGroup

connection_params Required

Array of connection parameters groups used to connect to a storage replication adapter (SRA).

string

name Required

Name of the array manager.

string

storage_adapter Required

ID of the storage replication adapter (SRA) to connect to.

Authentication

This operation uses the following authentication methods.

SessionHeader

Response

Response Body

202 Accepted

Returns TaskDrResponseEntity of type application/json

Task to track progress of the operation.

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

Metadata

_meta Optional

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

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

PowerCLI Client SDK Example

$ConnectionParam = Initialize-SrmConnectionParam -Key "MyKey" -Name "MyName" -Hint "MyHint" -Value "MyValue" -Optional $false -PasswordParam $false -Type "USER_NAME"

$ConnectionParamGroup = Initialize-SrmConnectionParamGroup -Name "MyName" -Hint "MyHint" -Key "MyKey" -ConnectionParams $ConnectionParam

$ArrayManagerSpec = Initialize-SrmArrayManagerSpec -Name "MyName" -StorageAdapter "MyStorageAdapter" -ConnectionParams $ConnectionParamGroup

Invoke-SrmCreateArrayManager -pairingId "MypairingId" -srmId "MysrmId" -arrayManagerSpec $arrayManagerSpec

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"connection_params":[{"connection_params":[{"hint":"string","key":"string","name":"string","optional":false,"password_param":false,"type":"USER_NAME","value":"string"}],"hint":"string","key":"string","name":"string"}],"name":"string","storage_adapter":"string"}' https://{api_host}/pairings/{pairing_id}/srms/{srm_id}/replication-management/abr/array-managers

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-dr-permissions:
    permissions:
        - System.View
        - System.Read
        - VcDr.Storage.com.vmware.vcDr.Configure
x-dr-remote-site-connectivity-contract:
    not-authenticated: DEPENDS_ON_PROVIDED_PARAMS
    server-down: ERROR

[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]

srm-rest-api

What's changed in 2.0.0?

INTRODUCED

Replication Operations

post

Create Array Manager Introduced

post

Create Replicated Array Pair Introduced

delete

Delete Array Manager Introduced

delete

Delete Replicated Array Pair Introduced

post

Discover Replicated Array Pairs Introduced

post

Discover Storage Devices Introduced

get

Get All vVol Fault Domain Replication Groups

get

Get All vVol Fault Domains

get

Get Array Manager Introduced

get

Get Array Managers Introduced

get

Get Replicated Array Pair

get

Get Replicated Array Pairs

get

Get Storage Adapter Introduced

get

Get Storage Adapter Connection Params Introduced

get

Get Storage Adapters Introduced

get

Get Storage Devices Introduced

get

Get vVol Fault Domain

get

Get vVol Fault Domain Replication Group

post

Retrieve Unassigned Datastore Groups

Create Array Manager

Request

URL

Path Parameters

Request Body

Authentication

SessionHeader

Response

Response Body

202 Accepted

Errors

Code Samples

PowerCLI Client SDK Example

cURL Command

Vendor Extensions

What's changed in 2.0.0?

On This Page

Replication Operations

Was this page helpful?