Stop-ApplianceBackupJob Command | Vmware PowerCLI Reference

Stop-ApplianceBackupJob

This cmdlet stops a list of running backup jobs matching the specified parameters.

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
required
Id String[] named
Stops backup jobs whose IDs match the specified IDs.
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.
Stop-ApplianceBackupJob
[-BackupJob < ApplianceBackupJob[] > ]
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional BackupJob ApplianceBackupJob[] named
  • pipeline
A list of ApplianceBackupJob objects representing the backup jobs to be stopped.
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

VMware.VimAutomation.ViCore.Interop.V1.Appliance.Backup.ApplianceBackupJob

Examples

Example 1

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

Stops all backup jobs on the specified vCenter Server.

Example 2

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

Stops a backup job with the specified ID.

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.