Get-FileIntegrity

  • Reference
Module:
Storage

Gets integrity information for a file on an ReFS volume.

Syntax

Get-FileIntegrity
   [-FileName] <String>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-FileIntegrity cmdlet gets integrity information for a file on a Resilient File System (ReFS) volume.

Examples

Example 1: Get file integrity information

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

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

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

This command gets file integrity information for a file.

Example 2: Get file integrity information for multiple files by using the pipeline

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

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

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

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

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

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

This 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 gets file integrity information for all the files in the folder.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

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

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

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FileName

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

Type:String
Aliases:FullName
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ThrottleLimit

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.

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

Inputs

System.IO.FileInfo. 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. 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

MSFT_FileIntegrity

This cmdlet generates an MSFT_FileIntegrity object.

Notes

  • When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).