Set-WssGlobalClientBackupPolicy
Set-WssGlobalClientBackupPolicy
Changes the global client backup policy.
Syntax
Parameter Set: NonDefault
Set-WssGlobalClientBackupPolicy [-BackupEndTime <TimeSpan> ] [-BackupStartTime <TimeSpan> ] [-DailyRetainCount <UInt32> ] [-MonthlyRetainCount <UInt32> ] [-WeeklyRetainCount <UInt32> ] [-YearlyRetainCount <UInt32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: Default
Set-WssGlobalClientBackupPolicy [-Default] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed 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.
Parameters
-BackupEndTime<TimeSpan>
Specifies the end of the backup window as a TimeSpan object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-BackupStartTime<TimeSpan>
Specifies the beginning of the backup window as a TimeSpan object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DailyRetainCount<UInt32>
Specifies the number of daily backups to keep. The default value is five.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Default
Indicates that the cmdlet resets all the settings to their default values.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-MonthlyRetainCount<UInt32>
Specifies the number of monthly backups to keep. The default value is six.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WeeklyRetainCount<UInt32>
Specifies the number of weekly backups to keep. The default value is four.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-YearlyRetainCount<UInt32>
Specifies the number of yearly backups to keep. The default value is ten.
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 the backup window for the global policy
This command changes the backup window for the global backup policy. The command specifies new start and end times for the policy.
PS C:\> Set-WssGlobalClientBackupPolicy -BackupEndTime 8:00 -BackupStartTime 19:00
Example 2: Restore default settings for the backup policy
This command restores default settings for the global backup policy. The command includes the Default parameter.
PS C:\> Set-WssGlobalClientBackupPolicy -Default