Set-WssClientBackup
Changes job retention policy and description for a client backup.
Syntax
Set-WssClientBackup
[-Retention <BackupJobRetention>]
[-Description <String>]
[-BackupIndex] <Int32>
[-ComputerName] <String>
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-WssClientBackup
[-Retention <BackupJobRetention>]
[-Description <String>]
[-BackupIndex] <Int32>
[-ComputerSid] <String>
[-WhatIf]
[-Confirm]
[<CommonParameters>] 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.
Examples
Example 1: Change a description for a client backup
PS C:\> Set-WssClientBackup -ComputerName "Workstation073" -BackupIndex 1 -Description "January 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.
Parameters
-BackupIndex
Specifies the index for a backup job. To obtain a backup index, use the Get-WssClientBackup cmdlet.
| Type: | Int32 |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ComputerName
Specifies the name of a computer.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ComputerSid
Specifies the SID of a computer.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
Specifies a description for the backup.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Retention
Specifies a retention policy for the backup. The acceptable values for this parameter are:
- Automatic
- Delete
- Keep
| Type: | BackupJobRetention |
| Accepted values: | Invalid, Automatic, Delete, Keep |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |