Set-WssClientBackup
Set-WssClientBackup
Changes job retention policy and description for a client backup.
Syntax
Parameter Set: ByName
Set-WssClientBackup [-ComputerName] <String> [-BackupIndex] <Int32> [-Description <String> ] [-Retention <BackupJobRetention> {Automatic | Delete | Invalid | Keep} ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: BySid
Set-WssClientBackup [-ComputerSid] <String> [-BackupIndex] <Int32> [-Description <String> ] [-Retention <BackupJobRetention> {Automatic | Delete | Invalid | Keep} ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-WssClientBackup cmdlet changes job retention policy and description for a client backup for a computer. Specify a computer by name or security identifier (SID). Specify which backup to change by using its backup index.
Parameters
-BackupIndex<Int32>
Specifies the index for a backup job. To obtain a backup index, use the Get-WssClientBackup cmdlet.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Retention<BackupJobRetention>
Specifies a retention policy for the backup. The acceptable values for this parameter are:
-- Automatic
-- Delete
-- Keep
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: Change a description for a client backup
This command changes the description for a backup of the computer named Workstation073. The command specifies the backup by using its index. The description is January backup.
PS C:\> Set-WssClientBackup -ComputerName "Workstation073" -BackupIndex 1 -Description "January backup"