Disable-WssBackupPolicy
Disable-WssBackupPolicy
Disables and removes a scheduled server backup policy.
Syntax
Parameter Set: Default
Disable-WssBackupPolicy [-BackupPolicy] <ScheduledBackupPolicy> [-Force] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Disable-WssBackupPolicy cmdlet disables and removes a scheduled server backup policy. When you disable a scheduled server backup policy, the scheduled daily backups in the backup policy do not run.
Parameters
-BackupPolicy<ScheduledBackupPolicy>
Specifies the scheduled backup policy to disable and remove.
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 |
-PassThru
Indicates that the cmdlet creates an object that you can use in a pipeline. By default, this cmdlet does not generate any output.
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: Remove a scheduled server backup policy
This example disables and removes a scheduled server backup policy.
The first command gets the backup policy for the computer and stores the result in the $ContosoBUPolicy25 variable
The second command disables and removes the backup policy stored in $ContosoBUPolicy25.
PS C:\> $ContosoBUPolicy25 = Get-WssBackupPolicy
PS C:\> Disable-WssBackupPolicy -BackupPolicy $ContosoBUPolicy25