Start-WssClientBackup
Start-WssClientBackup
Starts a client backup for a computer.
Syntax
Parameter Set: ByName
Start-WssClientBackup [-ComputerName] <String> [-Description] <String> [ <CommonParameters>]
Parameter Set: BySid
Start-WssClientBackup [-ComputerSid] <String> [-Description] <String> [ <CommonParameters>]
Detailed Description
The Start-WssClientBackup cmdlet starts a client backup for a computer. Specify a computer by name or security identifier (SID). Include a description for the backup job.
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 |
-Description<String>
Specifies a description for the backup job.
Aliases |
none |
Required? |
true |
Position? |
2 |
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: Start a client backup
This command starts a client backup for a computer named Workstation073. The command specifies a description.
PS C:\> Start-WssClientBackup -ComputerName "Workstation073" -Description "End of month backup"