Get‑NTFSAuditRule

SYNOPSIS

Gets NTFS audit rules for files and directories.

SYNTAX

Path (Default)

Get-NTFSAuditRule [[-Path] <String[]>] [-Account <String[]>] [-ExcludeInherited] [-ExcludeExplicit]
 [-ThrottleLimit <Int32>] [-Orphaned] [<CommonParameters>]

LiteralPath

Get-NTFSAuditRule -LiteralPath <String[]> [-Account <String[]>] [-ExcludeInherited] [-ExcludeExplicit]
 [-ThrottleLimit <Int32>] [-Orphaned] [<CommonParameters>]

DESCRIPTION

Returns structured SACL audit-rule objects filtered by account and by explicit or inherited origin. Reading SACLs requires SeSecurityPrivilege.

EXAMPLES

EXAMPLE 1

Get-NTFSAuditRule -LiteralPath C:\Data -ExcludeInherited

Gets the explicit audit rules assigned to C:\Data.

PARAMETERS

-Account

Limits output to one or more account names or SID strings.

Type: String[]
Parameter Sets: (All)
Aliases:

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

-ExcludeExplicit

Omits audit rules that are explicitly assigned to the item.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ExcludeInherited

Omits audit rules inherited from a parent directory.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-LiteralPath

One or more filesystem paths used exactly as supplied. FileSystem objects bind to this parameter through their PSPath property.

Type: String[]
Parameter Sets: LiteralPath
Aliases: PSPath

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Orphaned

Returns only rules whose SID cannot be translated to an account name.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Path

One or more filesystem paths. Wildcards are expanded by the FileSystem provider, and path strings can be supplied through the pipeline.

Type: String[]
Parameter Sets: Path
Aliases: FullName

Required: False
Position: 1
Default value: .
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: True

-ThrottleLimit

Limits concurrently processed canonical paths. One requests deterministic sequential execution.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: [Math]::Max(1, [Math]::Min(8, [Environment]::ProcessorCount))
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.String

System.IO.FileSystemInfo

OUTPUTS

WindowsAccessControl.AuditRule

NOTES

RELATED LINKS