Disable-WssClientBackup
Disable-WssClientBackup
Disables client backup for a computer.
Syntax
Parameter Set: ByName
Disable-WssClientBackup [-ComputerName] <String> [-Force] [-RemoveBackup] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: BySid
Disable-WssClientBackup [-ComputerSid] <String> [-Force] [-RemoveBackup] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Disable-WssClientBackup cmdlet disables client backup for a computer. Specify a computer by name or security identifier (SID). Use the RemoveBackup parameter to remove existing backups.
This cmdlet prevents client backups from the current time forward. If you want to stop only a current backup operation, use the Stop-WssClientBackup cmdlet.
Parameters
-ComputerName<String>
Specifies the name of a computer.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-ComputerSid<String>
Specifies the SID of a computer.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
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 |
-RemoveBackup
Indicates that the cmdlet removes the current client backup for the specified computer.
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: Disable client backup for a computer
This command disables client backups for a computer named Workstation073, and removes any existing backup.
PS C:\> Disable-WssClientBackup -ComputerName "Workstation073" -RemoveBackup