Edit

Share via

Suspend-WssBackupPolicy

  • Reference
Module:
WSSCmdlets

Stops a scheduled task from running the next scheduled backup.

Syntax

Suspend-WssBackupPolicy
       [-BackupPolicy] <ScheduledBackupPolicy>
       [-Force]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

The Suspend-WssBackupPolicy cmdlet stops a scheduled task from running the next scheduled backup.

Examples

Example 1: Suspend a backup policy

PS C:\>$ContosoBUPolicy25 = Get-WBPolicy
PS C:\> Suspend-WssBackupPolicy -BackupPolicy $ContosoBUPolicy25

This example suspends a backup policy.

The first command gets the backup policy for the computer and stores it in the variable named $ContosoBUPolicy25.

The second command suspends the backup policy that is stored in $ContosoBUPolicy25.

Parameters

-BackupPolicy

Specifies the scheduled backup policy to suspend.

Type:ScheduledBackupPolicy
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.ScheduledBackupPolicy

This cmdlet generates the BackupPolicy parameter value.