REST API - POST Virtual Machine Disaster Recovery Testboot
This operation performs a readiness check for the disaster recovery virtual machine (VM).
Request
Syntax
POST <webservice>/v2/vsa/vm/{vmGuid}/testboot HTTP/1.1
Host: <host name>
Accept: {application/json}
Content-type: application/json
{
"replicationGroupId":"",
}
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Parameters
A JSON message is required. The following table displays the parameters for the request body.
Name |
Description |
vmGuid |
The globally unique identifier for the virtualization client. If the vmGuid is not known, use the GET vmGuid API to retrieve it. |
replicationGroupId |
The ID of the specific DR site where the replication groups of VMs are replicated to. |
Request Headers
Name |
Description |
Host |
The host name of the Web Server or Web Console used in the API request. |
Accept |
The format of the response. Valid value is application/json. |
Content-type |
The media type contained in the request body. Valid value is application/json. |
Response
Response Parameters
Parameter |
Description |
taskId |
The system-generated ID assigned to the task. |
jobIds |
The job IDs of the current job accessing the drive. |
Examples
Sample Request
This request is for testboot.
POST <webservice>/v2/vsa/vm/257/testboot HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Content-type: application/json
{
"replicationGroupId": 33,
}
Sample Response
{
"taskId": 9358,
"jobIds": [
"153543"
]
}
Last modified: 4/21/2020 3:26:22 PM