Wait-ApplianceBackupJob Command | Vmware PowerCLI Reference

Wait-ApplianceBackupJob

This cmdlet monitors the progress of a backup job and returns the ApplianceBackupJob object when the backup job is complete.

Syntax

Wait-ApplianceBackupJob
-Id < String[] >
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Id String[] named
Specifies the IDs of the backup jobs you want to monitor and receive when finished.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.
Wait-ApplianceBackupJob
[-BackupJob < ApplianceBackupJob[] > ]
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional BackupJob ApplianceBackupJob[] named
  • pipeline
Specifies one or more ApplianceBackupJob object(s) representing the backup jobs you want to monitor and receive when finished.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.

Output

Examples

Example 1

PS C:\> Get-ApplianceBackupJob -Server 'vCenter server' | Wait-ApplianceBackupJob

Monitors the progress of all backup jobs on the 'vCenter Server' server and returns the backup job objects when finished.

Example 2

PS C:\> Wait-ApplianceBackupJob -Id '<backup job id>'

Monitors the progress of a backup job with the specified ID and returns the backup job object when finished

Related Commands

ApplianceBackupJob

This cmdlet retrieves a list of backup jobs for a vCenter Server system.

This cmdlet starts a backup job for a vCenter Server system.

This cmdlet stops running backup jobs on a vCenter Server system.

This cmdlet monitors the progress of a backup job and returns the ApplianceBackupJob object when the backup job is complete.

ApplianceBackupPart

This cmdlet retrieves backup parts that can be included in a backup for a vCenter Server system.