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

Update Plan Virtual Machine Recovery Priority

Description

Update the recovery priority of a protected virtual machine.

Request

Request

URL

URL


put
https://{api_host}//pairings/{pairing_id}/recovery-management/plans/{plan_id}/vms/{vm_id}/recovery-settings/priority
Copy

Path Parameters

Path Parameters

string
pairing_id Required

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


string
plan_id Required

The ID of a recovery plan defined within current pairing.


string
vm_id Required

The ID of a virtual machine.


Request Body

Request Body

PriorityGroupData of mimetype application/json Required

Priority group for the protected virtual machine.

{
	"priority": "P1"
}
string
priority Required

Recovery priority group. Used to translate server priority values to client priorities. The recovery priority for this VM. P1 is the highest and P5 is the lowest priority.

Possible values are: P1P2P3P4P5

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

$PriorityGroupData = Initialize-SrmPriorityGroupData -Priority "P1"
Invoke-SrmUpdatePlanVirtualMachineRecoveryPriority -pairingId "MypairingId" -planId "MyplanId" -vmId "MyvmId" -priorityGroupData $priorityGroupData

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"priority":"P1"}' https://{api_host}/pairings/{pairing_id}/recovery-management/plans/{plan_id}/vms/{vm_id}/recovery-settings/priority
Vendor Extensions

Vendor Extensions

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


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

Was this page helpful?