Stop-ApplianceBackupJob

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

Syntax

-Id  <String[]>
[-Server  <VIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Id
String[] named Stops backup jobs whose IDs match the specified IDs. Type: String[] Parameter Sets: ById Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False
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. Type: VIServer[] Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False

[-BackupJob  <ApplianceBackupJob[]>]
[-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. Type: ApplianceBackupJob[] Parameter Sets: Default Aliases: Required: False Position: 0 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False
    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. Type: VIServer[] Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False

    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 ''

    Stops a backup job with the specified ID.

    Related Commands

    Feedback

    Was this page helpful?