Get Group VMS
DescriptionA list of details for virtual machines that are part of the protection group.
Request
URLURL
Path Parameters
Path Parameters
The ID of a pairing between this Site Recovery Manager server and remote one.
The ID of a protection group defined within current pairing.
Query Parameters
Query Parameters
The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2
The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1
Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property ‘defaultResponsePageSize’ in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.
limit example
"10"
The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10
offset example
"10"
Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.
Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.
sort_by example
"name"
Authentication
Response
Response BodyResponse Body
200 OK
A list of VMs that are part of a protection group.
{
"_meta": {
"errors": [
{
"code": "string",
"field": "string",
"message": "string"
}
],
"limit": 0,
"links": {
"next": {
"href": "string"
},
"previous": {
"href": "string"
},
"self": {
"href": "string"
}
},
"offset": 0,
"total": 0
},
"list": [
{
"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"
}
]
}
]
}
Details about a VM and its protection settings within a protection group.
204 No Content
No content returned when the endpoint is called for non-applicable protection groups.
Errors
Bad request - the server could not understand the request due to invalid syntax or invalid request body content
Unauthorized - the client must authenticate itself to get the requested response
Forbidden - not sufficient access rights to fulfill the request
Not Found - server cannot find the requested in URL resource
Internal server error - unexpected condition prevents fulfilling the request
Code Samples
PowerCLI Client SDK Example
cURL Command
Vendor Extensions
x-dr-permissions:
permissions:
- System.View
- System.Read
x-dr-remote-site-connectivity-contract:
not-authenticated: PARTIAL_DATA
server-down: PARTIAL_DATA
