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

Plan Virtual Machine Check Dependent VMS

Description

Checks if a given list of dependent VMs is valid against the current VM.

Request

Request

URL

URL


post
https://{api_host}//pairings/{pairing_id}/recovery-management/plans/{plan_id}/vms/{vm_id}/recovery-settings/dependent-vms/actions/validate
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

DependentVmSpec of mimetype application/json Required

A spec describing the dependent VMs to be checked.

{
	"dependent_vms": [
		"string"
	]
}
array of string
dependent_vms Optional

A list of dependent VM IDs.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns DependentVmsValidationResult of type application/json

Validation result.

{
	"issue_type": "UNKNOWN",
	"valid": false
}
string
issue_type Optional

Dependent VMs validation issue details.

  • UNKNOWN - Unknown issue
  • CYCLE_DETECTED - A cycle was found in the dependency list.
  • NO_PERMISSION - Missing permission to validate dependent VMs.

Possible values are: UNKNOWNCYCLE_DETECTEDNO_PERMISSION


boolean
valid Optional

Whether the validation is successful or not

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

$DependentVmSpec = Initialize-SrmDependentVmSpec -DependentVms "MyDependentVms"
Invoke-SrmPlanVirtualMachineCheckDependentVms -pairingId "MypairingId" -planId "MyplanId" -vmId "MyvmId" -dependentVmSpec $dependentVmSpec

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"dependent_vms":["string"]}' https://{api_host}/pairings/{pairing_id}/recovery-management/plans/{plan_id}/vms/{vm_id}/recovery-settings/dependent-vms/actions/validate
Vendor Extensions

Vendor Extensions

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


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

Was this page helpful?