Set-WssFileHistoryConfiguration
Changes the File History configurations settings for the server.
Syntax
Set-WssFileHistoryConfiguration
[-Configuration] <ConfigurationSet>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
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.
Examples
Example 1: Change the File History configurations settings
PS C:\> $fileHistoryConfig = Get-WssFileHistoryConfiguration
PS C:\> $FileHistoryConfig.RetentionInMonths = 6
PS C:\> Set-WssFileHistoryConfiguration -Configuration $fileHistoryConfig
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.
Parameters
-Configuration
Specifies the File History configuration settings for the server.
Type: | ConfigurationSet |
Aliases: | Config |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
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 |
-Force
Forces the command to run without asking for user confirmation.
Type: | SwitchParameter |
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 |
Inputs
Microsoft.WindowsServerSolutions.DataProtection.FileBackup.ConfigurationSet
Outputs
Microsoft.WindowsServerSolutions.DataProtection.FileBackup.ConfigurationSet
This cmdlet generates the file history configuration settings stored on the server.
Related Links
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for