Set-WssFileHistoryConfiguration
Set-WssFileHistoryConfiguration
Changes the File History configurations settings for the server.
Syntax
Parameter Set: Default
Set-WssFileHistoryConfiguration [-Configuration] <ConfigurationSet> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-WssFileHistoryConfiguration cmdlet changes the File History configuration settings for the server. File History is a backup application that continuously protects the personal files of users stored in Libraries, Desktop, Favorites, and Contacts folders. You can use the Get-WssFileHistoryConfiguration to get the File History configurations settings for the server.
Parameters
-Configuration<ConfigurationSet>
Specifies the File History configuration settings for the server.
Aliases |
Config |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Force
Forces the command to run without asking for user confirmation.
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 File History configurations settings
This example changes the File History configurations settings for the server.
The first command gets the File History configurations settings for the server, and stores the result in the $fileHistoryConfig variable.
The second command sets the RetentionInMonths property of the File History configurations object to six months.
The third command sets the File History configuration settings stored in $fileHistoryConfig.
PS C:\> $fileHistoryConfig = Get-WssFileHistoryConfiguration
PS C:\> $FileHistoryConfig.RetentionInMonths = 6
PS C:\> Set-WssFileHistoryConfiguration -Configuration $fileHistoryConfig