Stop-WssClientBackup
Stop-WssClientBackup
Cancels a client backup for a computer.
Syntax
Parameter Set: ByName
Stop-WssClientBackup [-ComputerName] <String> [ <CommonParameters>]
Parameter Set: BySid
Stop-WssClientBackup [-ComputerSid] <String> [ <CommonParameters>]
Detailed Description
The Stop-WssClientBackup cmdlet cancels any currently running client backup for a computer. Specify a computer by name or security identifier (SID). Canceling a backup creates a partial backup, but does not cause the previous backup to be deleted.
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 |
<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: Cancel a client backup
This command cancels any currently running client backup on the computer named Workstation073.
PS C:\> Stop-WssClientBackup -ComputerName "Workstation073"