Job Status

Description

Tasks such as on-demand backups and recoveries are asynchronous requests and return an AsynRequestStatus which can be monitored for progress and completion.

To monitor the asynchronous request status for VMware vSphere, provide the ID of the cluster and the ID of the job. You can query the request status periodically until a terminal state (SUCCEEDED, FAILED, CANCELLED) is set given in the status field.

Code Samples

GraphQLPowerShell SDKShell

query {
  vSphereVMAsyncRequestStatus(
    id: "d4822e3d-c6e3-4bbe-950e-3e63c4770a78"
    clusterUuid: "e4e7d2a2-c58b-4bc2-b11e-d6f9102e6fc8"
  ) {
    id
    status
    startTime
    progress
    endTime
    error {
      message
    }
  }
}

$statusQuery = New-RscQuery -GqlQuery vSphereVMAsyncRequestStatus
$statusQuery.var.id = $request.Id
$statusQuery.var.clusterUuid = $my_vm.cluster.Id
$status = Invoke-Rsc $statusQuery