Suspend-WssBackupPolicy
Suspend-WssBackupPolicy
Stops a scheduled task from running the next scheduled backup.
Syntax
Parameter Set: Default
Suspend-WssBackupPolicy [-BackupPolicy] <ScheduledBackupPolicy> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Suspend-WssBackupPolicy cmdlet stops a scheduled task from running the next scheduled backup.
Parameters
-BackupPolicy<ScheduledBackupPolicy>
Specifies the scheduled backup policy to suspend.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Force
Forces the command to run without asking for user confirmation.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Suspend a backup policy
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.
PS C:\> $ContosoBUPolicy25 = Get-WBPolicy
PS C:\> Suspend-WssBackupPolicy -BackupPolicy $ContosoBUPolicy25