< Back

Set-FileIntegrity

Wed Jan 30, 2019 6:03 pm

NAME Set-FileIntegrity



SYNOPSIS

Sets integrity for a file on an ReFS volume.





SYNTAX

Set-FileIntegrity [-FileName] <String> [[-Enable] <Boolean>] [-CimSession <CimSession[]>] [-Enforce <Boolean>] [-ThrottleLimit <Int32>] [-Confirm]

[-WhatIf] [<CommonParameters>]





DESCRIPTION

The Set-FileIntegrity cmdlet sets integrity for a file on a Resilient File System (ReFS) volume. You can enable or disable integrity.





PARAMETERS

-CimSession [<CimSession[]>]

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or

Get-CimSession cmdlet. The default is the current session on the local computer.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-Enable [<Boolean>]

Indicates whether to enable integrity for the file.



Required? false

Position? 2

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-Enforce [<Boolean>]

Indicates whether to enable blocking access to a file if integrity streams indicate data corruption.



If you specify a value of $True for this parameter, the cmdlet also enables integrity for the file.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-FileName <String>

Specifies a file name. The cmdlet modifies integrity for the file that you specify.



Required? true

Position? 1

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ThrottleLimit [<Int32>]

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is

entered, then Windows PowerShell???? calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the

computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value false

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.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, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.IO.FileInfo

http://msdn.microsoft.com/library/syste ... .110).aspx





To obtain a FileInfo object, use the Get-Item cmdlet for a specified file name. The cmdlet uses the FullName property as the value of the FileName

parameter.



System.IO.DirectoryInfo

http://msdn.microsoft.com/library/syste ... .110).aspx





To obtain a DirectoryInfo object, use Get-Item for a specified directory name. The cmdlet uses the FullName property as the value of the FileName

parameter.





OUTPUTS





This cmdlet generates no output.





Example 1: Enable integrity



PS C:\\>Set-FileIntegrity -FileName 'H:\\Temp\\New Text Document.txt' -Enable $True

PS C:\\> Get-FileIntegrity 'H:\\Temp\\New Text Document.txt'

FileName Enabled Enforced



-------- ------- --------



H:\\Temp\\New Text Document.txt True True



The first command enables integrity for a file by specifying the Enable parameter.



The second command uses the Get-FileIntegrity cmdlet to display the file integrity settings for the specified file.





Example 2: Enable integrity for multiple files by using the pipeline



PS C:\\>Get-Item -Path 'H:\\Temp\\*' | Set-FileIntegrity -Enable $True

PS C:\\> Get-Item -Path 'H:\\Temp\\*' | Get-FileIntegrity

FileName Enabled Enforced



-------- ------- --------



H:\\Temp\\New Text Document 07 21 True True



H:\\Temp\\New Text Document 08 19 True True



H:\\Temp\\New Text Document 08 22 True True



H:\\Temp\\New Text Document 09 07 True True



The first command uses the Get-Item cmdlet to get all the files in the specified folder, and then passes them to the current cmdlet by using the

pipeline operator. For more information, type Get-Help Get-Item. The command enables integrity for each file in the directory.



The second command uses Get-Item to get all the files in the specified folder, and then passes them to the Get-FileIntegrity by using the pipeline

operator. The command displays the file integrity setting for all the files in the folder.







RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkId=816478

Get-FileIntegrity

Repair-FileIntegrity