Set-WssFileHistoryConfiguration.md

external help file	Module Name	online version	schema
WSS_Cmdlets.xml	WssCmdlets	https://learn.microsoft.com/powershell/module/wsscmdlets/set-wssfilehistoryconfiguration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp	2.0.0

Set-WssFileHistoryConfiguration

SYNOPSIS

Changes the File History configurations settings for the server.

SYNTAX

Set-WssFileHistoryConfiguration [-Configuration] <ConfigurationSet> [-Force] [-Confirm] [-WhatIf]

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
Parameter Sets: (All)
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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

INPUTS

OUTPUTS

NOTES

RELATED LINKS

Get-WssFileHistoryManagementStatus