Get Details for Steps Added for VM in Plan

You can get runtime details for every step added for a VM with the specified ID included in a specific plan.

Request

To retrieve a representation of a collection for all steps added for a specific VM, send the HTTP GET request to to the /RuntimeDetails/Plans/{planId}/Vms/{vmId}/Steps endpoint.

HTTP Request

GET https://<hostname>:<port>/api/v3/RuntimeDetails/Plans/{planId}/Vms/{vmId}/Steps

Request Headers

The request contains the following headers.

Header

Required/Optional

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

Accept

Optional

  • application/xml
  • text/json
  • application/json

Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type.

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns 200 response code.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Value

Description

Content-Length

integer

Identifies the length of the response body message, in bytes.

Content-Type

  • application/xml
  • text/json
  • application/json

Identifies the media type of the response body message.

Response Body

In the response body, VAO returns a representation of the /RuntimeDetails collection for all steps added for the specified VM. The StepRuntimeDetails schema is used for the collection representation.

Get Details for Steps Added for VM in PlanExample

The following request returns runtime details for all steps added for a VM with the ID 2fd504d0-924e-4fe2-80e0-f8e8cdb1257f in a plan with the ID 62685fe6-222a-493d-a99b-feea900921a2.

Request:

GET https://uwin2012r2.n.local:9898/api/v3/RuntimeDetails/Plans/62685fe6-222a-493d-a99b-feea900921a2/Vms/2fd504d0-924e-4fe2-80e0-f8e8cdb1257f/Steps

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "total": 6,

 "data": [

   {

     "actionType": "CheckVmLicense",

     "hidden": false,

     "stepDefinitionUid": "22987802-71d3-4ef8-88f9-07a85a8d0f54",

     "executionState": "Completed",

     "executionResult": {

       "startTime": "2020-07-09T07:42:50.2592757Z",

       "finishTime": "2020-07-09T07:42:50.2592757Z",

       "result": "Success",

       "details": [

         {

           "friendlyInfo": "[VM license status] VM is licensed as a New VM.",

           "level": "Critical",

           "severity": "Info",

           "timestamp": "2020-07-09T07:42:50.2592757Z"

         }

       ]

     },

     "id": "b63a7b41-b1be-4c66-827d-587e2a1d0d3d",

     "name": "Check VM license and availability",

     "progress": 100

   },

   {

     "actionType": "RestoreVm",

     "hidden": false,

     "stepDefinitionUid": "8a001db8-284a-405c-830b-b3d6b27f4fb7",

     "executionState": "Completed",

     "executionResult": {

       "startTime": "2020-07-09T07:42:50.2592757Z",

       "finishTime": "2020-07-09T07:42:50.3842665Z",

       "result": "Warning",

       "details": [

         {

           "friendlyInfo": "[Source vCenter] Source vCenter is online",

           "level": "Critical",

           "severity": "Info",

           "timestamp": "2020-07-09T07:42:50.2592757Z"

         },

         {

           "friendlyInfo": "[Source VM existence] The source VM is still present in the original location. Executing the plan will restore VM with a suffix as [VM Name]_VAORESTORE, the original VM will not be overwritten",

           "level": "Critical",

           "severity": "Info",

           "timestamp": "2020-07-09T07:42:50.2592757Z"

         },

         {

           "friendlyInfo": "[Backup existence] Backup exists",

           "level": "Critical",

           "severity": "Info",

           "timestamp": "2020-07-09T07:42:50.2592757Z"

         },

         {

           "friendlyInfo": "[VAO Agent Health] The VAO Agent running on the Veeam Backup & Replication server win12-vbr.n.local is Healthy",

           "level": "Critical",

           "severity": "Info",

           "timestamp": "2020-07-09T07:42:50.274905Z"

         },

         {

           "friendlyInfo": "[Backup Restore Point] Valid restore point found",

           "level": "Critical",

           "severity": "Info",

           "timestamp": "2020-07-09T07:42:50.274905Z"

         },

         {

           "friendlyInfo": "[Repository] VM located in backup file in repository",

           "level": "Critical",

           "severity": "Info",

           "timestamp": "2020-07-09T07:42:50.337397Z"

         },

         {

           "friendlyInfo": "[Backup Job] Recovery VM located in Veeam job",

           "level": "Critical",

           "severity": "Info",

           "timestamp": "2020-07-09T07:42:50.337397Z"

         },

         {

           "friendlyInfo": "[RPO] Restore Point does not meet desired RPO",

           "level": "Critical",

           "severity": "Warning",

           "timestamp": "2020-07-09T07:42:50.3842665Z"

         },

         {

           "friendlyInfo": "[Source networks] Source VM networks retrieved from backup file:\r\nStandard network 'VM Network'",

           "level": "Critical",

           "severity": "Info",

           "timestamp": "2020-07-09T07:42:50.3842665Z"

         },

         {

           "friendlyInfo": "[Restore location] Restore location: Host 'vic02.n.local', Datastore 'SanRs', all source VM networks are available",

           "level": "Critical",

           "severity": "Info",

           "timestamp": "2020-07-09T07:42:50.3842665Z"

         }

       ]

     },

     "id": "3aa83c1b-2315-4612-a457-30c7737e51f7",

     "name": "Restore - Recovery",

     "progress": 100

   },

   {

     "actionType": "CheckVmHeartbeat",

     "hidden": false,

     "stepDefinitionUid": "37c36a1d-8434-4c87-b5f8-ffa8d7ee7814",

     "executionState": "Completed",

     "executionResult": {

       "startTime": "2020-07-09T07:42:50.3842665Z",

       "finishTime": "2020-07-09T07:42:50.3842665Z",

       "result": "Success",

       "details": [

         {

           "friendlyInfo": "[Step Sequence] Step is in correct sequence",

           "level": "Critical",

           "severity": "Info",

           "timestamp": "2020-07-09T07:42:50.3842665Z"

         },

         {

           "friendlyInfo": "[VMware Tools] VMware Tools are installed - OK",

           "level": "Critical",

           "severity": "Info",

           "timestamp": "2020-07-09T07:42:50.3842665Z"

         }

       ]

     },

     "id": "d55abd90-71f7-44ad-bd99-819a5972197d",

     "name": "Check VM Heartbeat",

     "progress": 100

   },

   {

     "actionType": "CheckVm",

     "hidden": false,

     "stepDefinitionUid": "c9c20a77-c056-4314-aa33-55aeca685302",

     "executionState": "Completed",

     "executionResult": {

       "startTime": "2020-07-09T07:42:50.3842665Z",

       "finishTime": "2020-07-09T07:42:50.3842665Z",

       "result": "Success",

       "details": [

         {

           "friendlyInfo": "[Step Sequence] Step is in correct sequence",

           "level": "Critical",

           "severity": "Info",

           "timestamp": "2020-07-09T07:42:50.3842665Z"

         }

       ]

     },

     "id": "c61e6222-9f28-4af2-b2b8-0dc0594549c1",

     "name": "Check VM Network",

     "progress": 100

   },

   {

     "actionType": "MigrateVm",

     "hidden": false,

     "stepDefinitionUid": "b058d63a-1106-4e67-85e6-4bda117c5b3e",

     "executionState": "Completed",

     "executionResult": {

       "startTime": "2020-07-09T07:42:50.3842665Z",

       "finishTime": "2020-07-09T07:42:50.3842665Z",

       "result": "Success",

       "details": [

         {

           "friendlyInfo": "[Migrate location] Migrate location: Datastore 'SanRs'",

           "level": "Critical",

           "severity": "Info",

           "timestamp": "2020-07-09T07:42:50.3842665Z"

         }

       ]

     },

     "id": "94b64a0e-7dba-41cb-8762-b4d7d0a3a10b",

     "name": "Restore - Migrate",

     "progress": 100

   },

   {

     "actionType": "RestoreVM",

     "hidden": false,

     "stepDefinitionUid": "f8fa1551-a5cf-4ec9-aa9d-dd0e6d213796",

     "executionState": "Completed",

     "executionResult": {

       "startTime": "2020-07-09T07:42:50.3842665Z",

       "finishTime": "2020-07-09T07:42:50.3842665Z",

       "result": "Success",

       "details": [

         {

           "friendlyInfo": "[Restored VM name] A VM with the name 'win12-10-3' already exists on the host 'radayvc.hv1.veeam.local'",

           "level": "Critical",

           "severity": "Info",

           "timestamp": "2020-07-09T07:42:50.3842665Z"

         }

       ]

     },

     "id": "4868a39f-1400-478a-aae8-b743e48e8843",

     "name": "Restore - Recovery",

     "progress": 100

   }

 ]

}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.