Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-FileIntegrity

Set-FileIntegrity

fileintegrity.cdxml

Synopsis

Sets integrity for a file on an ReFS volume.

Syntax

Set-FileIntegrity [-FileName] [-Enable] [-AsJob] [-CimSession] [-Enforce] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

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

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-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.

Aliases

Session

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.

Aliases

None

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 do not match the data.

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

Aliases

None

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.

Aliases

FullName

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.

Aliases

None

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.

Aliases

None

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.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

None

Examples

Example 1: Enable integrity

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.

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

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

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.

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

Online Version
Get-Item
Get-FileIntegrity
Repair-FileIntegrity