Set-WssGlobalClientBackupPolicy
Changes the global client backup policy.
Syntax
Set-WssGlobalClientBackupPolicy
[-BackupEndTime <TimeSpan>]
[-BackupStartTime <TimeSpan>]
[-DailyRetainCount <UInt32>]
[-MonthlyRetainCount <UInt32>]
[-WeeklyRetainCount <UInt32>]
[-YearlyRetainCount <UInt32>]
[-Confirm]
[-WhatIf]
Set-WssGlobalClientBackupPolicy
[-Default]
[-Confirm]
[-WhatIf]
Description
The Set-WssGlobalClientBackupPolicy cmdlet changes the global client backup policy. This policy includes the following values:
- BackupStartTime. The beginning of the backup window. The default value is 18:00.
- BackupEndTime. The end of the backup window. The default value is 9:00.
- DailyRetainCount. The number of daily backups to keep. The default value is five.
- WeeklyRetainCount. The number of weekly backups to keep. The default value is four.
- MonthlyRetainCount. The number of monthly backups to keep. The default value is six.
- YearlyRetainCount. The number of yearly backups to keep. The default value is ten.
This cmdlet can change any of these values, or you can use the Default parameter to reset all the settings to the default values.
Examples
Example 1: Change the backup window for the global policy
PS C:\> Set-WssGlobalClientBackupPolicy -BackupEndTime 8:00 -BackupStartTime 19:00
This command changes the backup window for the global backup policy. The command specifies new start and end times for the policy.
Example 2: Restore default settings for the backup policy
PS C:\> Set-WssGlobalClientBackupPolicy -Default
This command restores default settings for the global backup policy. The command includes the Default parameter.
Parameters
-BackupEndTime
Specifies the end of the backup window as a TimeSpan object.
Type: | TimeSpan |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-BackupStartTime
Specifies the beginning of the backup window as a TimeSpan object.
Type: | TimeSpan |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DailyRetainCount
Specifies the number of daily backups to keep. The default value is five.
Type: | UInt32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Default
Indicates that the cmdlet resets all the settings to their default values.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MonthlyRetainCount
Specifies the number of monthly backups to keep. The default value is six.
Type: | UInt32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WeeklyRetainCount
Specifies the number of weekly backups to keep. The default value is four.
Type: | UInt32 |
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 |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-YearlyRetainCount
Specifies the number of yearly backups to keep. The default value is ten.
Type: | UInt32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |