[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api
Get Group VM
DescriptionDetails of a protected virtual machine that is part of the protection group.
Request
URLURL
https://{api_host}//pairings/{pairing_id}/protection-management/groups/{group_id}/vms/{vm_id}
Path Parameters
Path Parameters
string
pairing_id
Required
The ID of a pairing between this Site Recovery Manager server and remote one.
string
group_id
Required
The ID of a protection group defined within current pairing.
string
vm_id
Required
The ID of a protected virtual machine.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
ProtectionGroupVmInfoDrResponseEntity
of type application/json
Information about a virtual machine that is part of a protection group.
{
"_meta": {
"errors": [
{
"code": "string",
"field": "string",
"message": "string"
}
]
},
"id": "string",
"inside_vapp": false,
"name": "string",
"protection_info": {
"recovery_folder": {
"id": "string",
"name": "string"
},
"recovery_host": {
"id": "string",
"name": "string"
},
"recovery_networks": [
{
"id": "string",
"name": "string",
"type": "UNKNOWN"
}
],
"recovery_resource_pool": {
"id": "string",
"name": "string"
},
"vmotion_eligible": false
},
"protection_status_details": {
"errors": [
"string"
],
"status": "LOADING"
},
"template": false,
"vvol_replication_group_data": [
{
"device_group_id": "string",
"fault_domain_id": "string",
"name": "string"
}
]
}
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
Invoke-SrmGetGroupVm -pairingId "MypairingId" -groupId "MygroupId" -vmId "MyvmId"
cURL Command
curl https://{api_host}/pairings/{pairing_id}/protection-management/groups/{group_id}/vms/{vm_id}
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: PARTIAL_DATA
server-down: PARTIAL_DATA
[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api
On This Page
Protection Operations
post
post
post
post
Create Protection Group Folder
Introduced
delete
delete
Delete Protection Group Folder
Introduced
get
get
get
get
get
get
Get Protection Group Folder
Introduced
get
Get Protection Group Folder Children
Introduced
get
Get Protection Group Folders
Introduced
post
Move Protection Group Folder
Introduced
post
delete
post
post
Rename Protection Group Folder
Introduced
