From d6035777d87c96792e5dc71f46d9d955dd5742c4 Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 21:11:30 +1100 Subject: [PATCH 01/44] initial commit --- .readthedocs.yml | 13 + Docs/Cmdlets/Add-NTFSAccess.md | 240 +++++++++++++++++ Docs/Cmdlets/Add-NTFSAudit.md | 223 ++++++++++++++++ Docs/Cmdlets/Clear-NTFSAccess.md | 98 +++++++ Docs/Cmdlets/Clear-NTFSAudit.md | 98 +++++++ Docs/Cmdlets/Copy-Item2.md | 139 ++++++++++ Docs/Cmdlets/Disable-NTFSAccessInheritance.md | 115 ++++++++ Docs/Cmdlets/Disable-NTFSAuditInheritance.md | 115 ++++++++ Docs/Cmdlets/Disable-Privileges.md | 61 +++++ Docs/Cmdlets/Enable-NTFSAccessInheritance.md | 114 ++++++++ Docs/Cmdlets/Enable-NTFSAuditInheritance.md | 114 ++++++++ Docs/Cmdlets/Enable-Privileges.md | 61 +++++ Docs/Cmdlets/Get-ChildItem2.md | 246 ++++++++++++++++++ Docs/Cmdlets/Get-DiskSpace.md | 61 +++++ Docs/Cmdlets/Get-FileHash2.md | 79 ++++++ Docs/Cmdlets/Get-Item2.md | 63 +++++ Docs/Cmdlets/Get-NTFSAccess.md | 133 ++++++++++ Docs/Cmdlets/Get-NTFSAudit.md | 133 ++++++++++ Docs/Cmdlets/Get-NTFSEffectiveAccess.md | 133 ++++++++++ Docs/Cmdlets/Get-NTFSHardLink.md | 63 +++++ Docs/Cmdlets/Get-NTFSInheritance.md | 84 ++++++ Docs/Cmdlets/Get-NTFSOrphanedAccess.md | 133 ++++++++++ Docs/Cmdlets/Get-NTFSOrphanedAudit.md | 133 ++++++++++ Docs/Cmdlets/Get-NTFSOwner.md | 84 ++++++ Docs/Cmdlets/Get-NTFSSecurityDescriptor.md | 61 +++++ Docs/Cmdlets/Get-NTFSSimpleAccess.md | 148 +++++++++++ Docs/Cmdlets/Get-Privileges.md | 46 ++++ Docs/Cmdlets/Move-Item2.md | 139 ++++++++++ Docs/Cmdlets/New-NTFSHardLink.md | 93 +++++++ Docs/Cmdlets/New-NTFSSymbolicLink.md | 93 +++++++ Docs/Cmdlets/Remove-Item2.md | 136 ++++++++++ Docs/Cmdlets/Remove-NTFSAccess.md | 223 ++++++++++++++++ Docs/Cmdlets/Remove-NTFSAudit.md | 223 ++++++++++++++++ Docs/Cmdlets/Set-NTFSInheritance.md | 132 ++++++++++ Docs/Cmdlets/Set-NTFSOwner.md | 117 +++++++++ Docs/Cmdlets/Set-NTFSSecurityDescriptor.md | 76 ++++++ Docs/Cmdlets/Test-Path2.md | 81 ++++++ Docs/Contributing.md | 14 + Docs/Contributing/01-Getting-Started.md | 54 ++++ Docs/Contributing/02-Writing.md | 62 +++++ Docs/Index.md | 25 ++ appveyor.yml | 30 +++ mkdocs.yml | 50 ++++ 43 files changed, 4539 insertions(+) create mode 100644 .readthedocs.yml create mode 100644 Docs/Cmdlets/Add-NTFSAccess.md create mode 100644 Docs/Cmdlets/Add-NTFSAudit.md create mode 100644 Docs/Cmdlets/Clear-NTFSAccess.md create mode 100644 Docs/Cmdlets/Clear-NTFSAudit.md create mode 100644 Docs/Cmdlets/Copy-Item2.md create mode 100644 Docs/Cmdlets/Disable-NTFSAccessInheritance.md create mode 100644 Docs/Cmdlets/Disable-NTFSAuditInheritance.md create mode 100644 Docs/Cmdlets/Disable-Privileges.md create mode 100644 Docs/Cmdlets/Enable-NTFSAccessInheritance.md create mode 100644 Docs/Cmdlets/Enable-NTFSAuditInheritance.md create mode 100644 Docs/Cmdlets/Enable-Privileges.md create mode 100644 Docs/Cmdlets/Get-ChildItem2.md create mode 100644 Docs/Cmdlets/Get-DiskSpace.md create mode 100644 Docs/Cmdlets/Get-FileHash2.md create mode 100644 Docs/Cmdlets/Get-Item2.md create mode 100644 Docs/Cmdlets/Get-NTFSAccess.md create mode 100644 Docs/Cmdlets/Get-NTFSAudit.md create mode 100644 Docs/Cmdlets/Get-NTFSEffectiveAccess.md create mode 100644 Docs/Cmdlets/Get-NTFSHardLink.md create mode 100644 Docs/Cmdlets/Get-NTFSInheritance.md create mode 100644 Docs/Cmdlets/Get-NTFSOrphanedAccess.md create mode 100644 Docs/Cmdlets/Get-NTFSOrphanedAudit.md create mode 100644 Docs/Cmdlets/Get-NTFSOwner.md create mode 100644 Docs/Cmdlets/Get-NTFSSecurityDescriptor.md create mode 100644 Docs/Cmdlets/Get-NTFSSimpleAccess.md create mode 100644 Docs/Cmdlets/Get-Privileges.md create mode 100644 Docs/Cmdlets/Move-Item2.md create mode 100644 Docs/Cmdlets/New-NTFSHardLink.md create mode 100644 Docs/Cmdlets/New-NTFSSymbolicLink.md create mode 100644 Docs/Cmdlets/Remove-Item2.md create mode 100644 Docs/Cmdlets/Remove-NTFSAccess.md create mode 100644 Docs/Cmdlets/Remove-NTFSAudit.md create mode 100644 Docs/Cmdlets/Set-NTFSInheritance.md create mode 100644 Docs/Cmdlets/Set-NTFSOwner.md create mode 100644 Docs/Cmdlets/Set-NTFSSecurityDescriptor.md create mode 100644 Docs/Cmdlets/Test-Path2.md create mode 100644 Docs/Contributing.md create mode 100644 Docs/Contributing/01-Getting-Started.md create mode 100644 Docs/Contributing/02-Writing.md create mode 100644 Docs/Index.md create mode 100644 appveyor.yml create mode 100644 mkdocs.yml diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..58fb067 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,13 @@ +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Build documentation with MkDocs +mkdocs: + configuration: mkdocs.yml + +# Optionally build your docs in additional formats such as PDF and ePub +formats: all \ No newline at end of file diff --git a/Docs/Cmdlets/Add-NTFSAccess.md b/Docs/Cmdlets/Add-NTFSAccess.md new file mode 100644 index 0000000..e93dea8 --- /dev/null +++ b/Docs/Cmdlets/Add-NTFSAccess.md @@ -0,0 +1,240 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Add-NTFSAccess + +## SYNOPSIS +Adds an access control entry (ACE) to an object. + +## SYNTAX + +### PathComplex (Default) +``` +Add-NTFSAccess [-Path] [-Account] [-AccessRights] + [-AccessType ] [-InheritanceFlags ] + [-PropagationFlags ] [-PassThru] [] +``` + +### PathSimple +``` +Add-NTFSAccess [-Path] [-Account] [-AccessRights] + [-AccessType ] [-AppliesTo ] [-PassThru] [] +``` + +### SDSimple +``` +Add-NTFSAccess [-SecurityDescriptor] [-Account] + [-AccessRights] [-AccessType ] [-AppliesTo ] [-PassThru] + [] +``` + +### SDComplex +``` +Add-NTFSAccess [-SecurityDescriptor] [-Account] + [-AccessRights] [-AccessType ] [-InheritanceFlags ] + [-PropagationFlags ] [-PassThru] [] +``` + +## DESCRIPTION +Adds an access control entry (ACE) to an object such as a file or folder. Other examples would be an object inside of Active Directory. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Add-NTFSAccess -Path C:\Data -Account 'NT AUTHORITY\Authenticated Users' -AccessRights Read +``` + +The above command gives the read permissions to the built-in group of 'Authenticated users' + +## PARAMETERS + +### -AccessRights +The AccessRights parameter designates the permissions to assign. There are individual permissions as well as 'basic' permissions. See the below table for how the basic permissions permissions map the the advanced permissions. + +| Permissions | Basic Full Control | Basic Modify | Basic Read & Execute | Basic List Folder Contents | Basic Read | Basic Write | +|:---------------------------: |:------------------: |:------------: |:--------------------: |:--------------------------: |:----------: |:-----------: | +| Travers Folder/Execute | X | X | X | X | | | +| List Folder/ Read Data | X | X | X | X | X | | +| Read Attributes | X | X | X | X | X | | +| Read Extended Attributes | X | X | X | X | X | | +| Create Files/Write Data | X | X | | | | X | +| Create Folders/Append Data | X | X | | | | X | +| Write Attributes | X | X | | | | X | +| Write Extended Attributes | X | X | | | | X | +| Delete Subfolders and Files | X | | | | | | +| Delete | X | X | | | | | +| Read Permissions | X | X | X | X | X | X | +| Change Permissions | X | | | | | | +| Take Ownership | X | | | | | | +| Synchronize | X | X | X | X | X | X | + +```yaml +Type: FileSystemRights2 +Parameter Sets: (All) +Aliases: FileSystemRights +Accepted values: None, ReadData, ListDirectory, WriteData, CreateFiles, AppendData, CreateDirectories, ReadExtendedAttributes, WriteExtendedAttributes, ExecuteFile, Traverse, DeleteSubdirectoriesAndFiles, ReadAttributes, WriteAttributes, Write, Delete, ReadPermissions, Read, ReadAndExecute, Modify, ChangePermissions, TakeOwnership, Synchronize, FullControl, GenericAll, GenericExecute, GenericWrite, GenericRead + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AccessType +The AccessType parameter determines if the ACE allows or denies the permissions assigned. + +```yaml +Type: AccessControlType +Parameter Sets: (All) +Aliases: AccessControlType +Accepted values: Allow, Deny + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Account +{{ Fill Account Description }} + +```yaml +Type: IdentityReference2[] +Parameter Sets: (All) +Aliases: IdentityReference, ID + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AppliesTo +{{ Fill AppliesTo Description }} + +```yaml +Type: ApplyTo +Parameter Sets: PathSimple, SDSimple +Aliases: +Accepted values: ThisFolderOnly, ThisFolderSubfoldersAndFiles, ThisFolderAndSubfolders, ThisFolderAndFiles, SubfoldersAndFilesOnly, SubfoldersOnly, FilesOnly, ThisFolderSubfoldersAndFilesOneLevel, ThisFolderAndSubfoldersOneLevel, ThisFolderAndFilesOneLevel, SubfoldersAndFilesOnlyOneLevel, SubfoldersOnlyOneLevel, FilesOnlyOneLevel + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InheritanceFlags +{{ Fill InheritanceFlags Description }} + +```yaml +Type: InheritanceFlags +Parameter Sets: PathComplex, SDComplex +Aliases: +Accepted values: None, ContainerInherit, ObjectInherit + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: PathComplex, PathSimple +Aliases: FullName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PropagationFlags +{{ Fill PropagationFlags Description }} + +```yaml +Type: PropagationFlags +Parameter Sets: PathComplex, SDComplex +Aliases: +Accepted values: None, NoPropagateInherit, InheritOnly + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecurityDescriptor +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SDSimple, SDComplex +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +### Security2.IdentityReference2[] + +### Security2.FileSystemRights2 + +### System.Security.AccessControl.AccessControlType + +### System.Security.AccessControl.InheritanceFlags + +### System.Security.AccessControl.PropagationFlags + +### Security2.ApplyTo + +## OUTPUTS + +### Security2.FileSystemAccessRule2 + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Add-NTFSAudit.md b/Docs/Cmdlets/Add-NTFSAudit.md new file mode 100644 index 0000000..7dc5089 --- /dev/null +++ b/Docs/Cmdlets/Add-NTFSAudit.md @@ -0,0 +1,223 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Add-NTFSAudit + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### PathComplex (Default) +``` +Add-NTFSAudit [-Path] [-Account] [-AccessRights] + [-AuditFlags ] [-InheritanceFlags ] [-PropagationFlags ] + [-PassThru] [] +``` + +### PathSimple +``` +Add-NTFSAudit [-Path] [-Account] [-AccessRights] + [-AuditFlags ] [-AppliesTo ] [-PassThru] [] +``` + +### SDSimple +``` +Add-NTFSAudit [-SecurityDescriptor] [-Account] + [-AccessRights] [-AuditFlags ] [-AppliesTo ] [-PassThru] + [] +``` + +### SDComplex +``` +Add-NTFSAudit [-SecurityDescriptor] [-Account] + [-AccessRights] [-AuditFlags ] [-InheritanceFlags ] + [-PropagationFlags ] [-PassThru] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -AccessRights +{{ Fill AccessRights Description }} + +```yaml +Type: FileSystemRights2 +Parameter Sets: (All) +Aliases: FileSystemRights +Accepted values: None, ReadData, ListDirectory, WriteData, CreateFiles, AppendData, CreateDirectories, ReadExtendedAttributes, WriteExtendedAttributes, ExecuteFile, Traverse, DeleteSubdirectoriesAndFiles, ReadAttributes, WriteAttributes, Write, Delete, ReadPermissions, Read, ReadAndExecute, Modify, ChangePermissions, TakeOwnership, Synchronize, FullControl, GenericAll, GenericExecute, GenericWrite, GenericRead + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Account +{{ Fill Account Description }} + +```yaml +Type: IdentityReference2[] +Parameter Sets: (All) +Aliases: IdentityReference, ID + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AppliesTo +{{ Fill AppliesTo Description }} + +```yaml +Type: ApplyTo +Parameter Sets: PathSimple, SDSimple +Aliases: +Accepted values: ThisFolderOnly, ThisFolderSubfoldersAndFiles, ThisFolderAndSubfolders, ThisFolderAndFiles, SubfoldersAndFilesOnly, SubfoldersOnly, FilesOnly, ThisFolderSubfoldersAndFilesOneLevel, ThisFolderAndSubfoldersOneLevel, ThisFolderAndFilesOneLevel, SubfoldersAndFilesOnlyOneLevel, SubfoldersOnlyOneLevel, FilesOnlyOneLevel + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AuditFlags +{{ Fill AuditFlags Description }} + +```yaml +Type: AuditFlags +Parameter Sets: (All) +Aliases: +Accepted values: None, Success, Failure + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InheritanceFlags +{{ Fill InheritanceFlags Description }} + +```yaml +Type: InheritanceFlags +Parameter Sets: PathComplex, SDComplex +Aliases: +Accepted values: None, ContainerInherit, ObjectInherit + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: PathComplex, PathSimple +Aliases: FullName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PropagationFlags +{{ Fill PropagationFlags Description }} + +```yaml +Type: PropagationFlags +Parameter Sets: PathComplex, SDComplex +Aliases: +Accepted values: None, NoPropagateInherit, InheritOnly + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecurityDescriptor +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SDSimple, SDComplex +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +### Security2.IdentityReference2[] + +### Security2.FileSystemRights2 + +### System.Security.AccessControl.AuditFlags + +### System.Security.AccessControl.InheritanceFlags + +### System.Security.AccessControl.PropagationFlags + +### Security2.ApplyTo + +## OUTPUTS + +### Security2.FileSystemAccessRule2 + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Clear-NTFSAccess.md b/Docs/Cmdlets/Clear-NTFSAccess.md new file mode 100644 index 0000000..060705e --- /dev/null +++ b/Docs/Cmdlets/Clear-NTFSAccess.md @@ -0,0 +1,98 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Clear-NTFSAccess + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path (Default) +``` +Clear-NTFSAccess [-Path] [-DisableInheritance] [] +``` + +### SD +``` +Clear-NTFSAccess [-SecurityDescriptor] [-DisableInheritance] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -DisableInheritance +{{ Fill DisableInheritance Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecurityDescriptor +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SD +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Clear-NTFSAudit.md b/Docs/Cmdlets/Clear-NTFSAudit.md new file mode 100644 index 0000000..dc09927 --- /dev/null +++ b/Docs/Cmdlets/Clear-NTFSAudit.md @@ -0,0 +1,98 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Clear-NTFSAudit + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path (Default) +``` +Clear-NTFSAudit [-Path] [-DisableInheritance] [] +``` + +### SD +``` +Clear-NTFSAudit [-SecurityDescriptor] [-DisableInheritance] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -DisableInheritance +{{ Fill DisableInheritance Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecurityDescriptor +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SD +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Copy-Item2.md b/Docs/Cmdlets/Copy-Item2.md new file mode 100644 index 0000000..0dd5b18 --- /dev/null +++ b/Docs/Cmdlets/Copy-Item2.md @@ -0,0 +1,139 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Copy-Item2 + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Copy-Item2 [-Path] [-Destination] [-Force] [-PassThru ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +{{ Fill Destination Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +{{ Fill Force Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: FullName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### System.String + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Disable-NTFSAccessInheritance.md b/Docs/Cmdlets/Disable-NTFSAccessInheritance.md new file mode 100644 index 0000000..24fff2c --- /dev/null +++ b/Docs/Cmdlets/Disable-NTFSAccessInheritance.md @@ -0,0 +1,115 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Disable-NTFSAccessInheritance + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path (Default) +``` +Disable-NTFSAccessInheritance [[-Path] ] [-RemoveInheritedAccessRules] [-PassThru] + [] +``` + +### SecurityDescriptor +``` +Disable-NTFSAccessInheritance [-SecurityDescriptor] [-RemoveInheritedAccessRules] + [-PassThru] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -RemoveInheritedAccessRules +{{ Fill RemoveInheritedAccessRules Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityDescriptor +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SecurityDescriptor +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Disable-NTFSAuditInheritance.md b/Docs/Cmdlets/Disable-NTFSAuditInheritance.md new file mode 100644 index 0000000..79273f0 --- /dev/null +++ b/Docs/Cmdlets/Disable-NTFSAuditInheritance.md @@ -0,0 +1,115 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Disable-NTFSAuditInheritance + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path (Default) +``` +Disable-NTFSAuditInheritance [[-Path] ] [-RemoveInheritedAccessRules] [-PassThru] + [] +``` + +### SecurityDescriptor +``` +Disable-NTFSAuditInheritance [-SecurityDescriptor] [-RemoveInheritedAccessRules] + [-PassThru] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -RemoveInheritedAccessRules +{{ Fill RemoveInheritedAccessRules Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityDescriptor +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SecurityDescriptor +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Disable-Privileges.md b/Docs/Cmdlets/Disable-Privileges.md new file mode 100644 index 0000000..475f4d4 --- /dev/null +++ b/Docs/Cmdlets/Disable-Privileges.md @@ -0,0 +1,61 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Disable-Privileges + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Disable-Privileges [-PassThru] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### ProcessPrivileges.PrivilegeAndAttributes + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Enable-NTFSAccessInheritance.md b/Docs/Cmdlets/Enable-NTFSAccessInheritance.md new file mode 100644 index 0000000..44ecbf0 --- /dev/null +++ b/Docs/Cmdlets/Enable-NTFSAccessInheritance.md @@ -0,0 +1,114 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Enable-NTFSAccessInheritance + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path (Default) +``` +Enable-NTFSAccessInheritance [[-Path] ] [-PassThru] [-RemoveExplicitAccessRules] [] +``` + +### SecurityDescriptor +``` +Enable-NTFSAccessInheritance [-SecurityDescriptor] [-PassThru] + [-RemoveExplicitAccessRules] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -RemoveExplicitAccessRules +{{ Fill RemoveExplicitAccessRules Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityDescriptor +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SecurityDescriptor +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Enable-NTFSAuditInheritance.md b/Docs/Cmdlets/Enable-NTFSAuditInheritance.md new file mode 100644 index 0000000..8eb634c --- /dev/null +++ b/Docs/Cmdlets/Enable-NTFSAuditInheritance.md @@ -0,0 +1,114 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Enable-NTFSAuditInheritance + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path (Default) +``` +Enable-NTFSAuditInheritance [[-Path] ] [-PassThru] [-RemoveExplicitAccessRules] [] +``` + +### SecurityDescriptor +``` +Enable-NTFSAuditInheritance [-SecurityDescriptor] [-PassThru] + [-RemoveExplicitAccessRules] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -RemoveExplicitAccessRules +{{ Fill RemoveExplicitAccessRules Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityDescriptor +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SecurityDescriptor +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Enable-Privileges.md b/Docs/Cmdlets/Enable-Privileges.md new file mode 100644 index 0000000..57d9214 --- /dev/null +++ b/Docs/Cmdlets/Enable-Privileges.md @@ -0,0 +1,61 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Enable-Privileges + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Enable-Privileges [-PassThru] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### ProcessPrivileges.PrivilegeAndAttributes + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-ChildItem2.md b/Docs/Cmdlets/Get-ChildItem2.md new file mode 100644 index 0000000..f3852d9 --- /dev/null +++ b/Docs/Cmdlets/Get-ChildItem2.md @@ -0,0 +1,246 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-ChildItem2 + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-ChildItem2 [[-Path] ] [[-Filter] ] [-Recurse] [-Directory] [-File] + [-Attributes ] [-Hidden] [-System] [-ReadOnly] [-Force] [-SkipMountPoints] + [-SkipSymbolicLinks] [-Depth ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Attributes +{{ Fill Attributes Description }} + +```yaml +Type: FileAttributes +Parameter Sets: (All) +Aliases: +Accepted values: ReadOnly, Hidden, System, Directory, Archive, Device, Normal, Temporary, SparseFile, ReparsePoint, Compressed, Offline, NotContentIndexed, Encrypted, IntegrityStream, NoScrubData + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Depth +{{ Fill Depth Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Directory +{{ Fill Directory Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File +{{ Fill File Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +{{ Fill Filter Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +{{ Fill Force Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Hidden +{{ Fill Hidden Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ReadOnly +{{ Fill ReadOnly Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Recurse +{{ Fill Recurse Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipMountPoints +{{ Fill SkipMountPoints Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipSymbolicLinks +{{ Fill SkipSymbolicLinks Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -System +{{ Fill System Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### Alphaleonis.Win32.Filesystem.FileInfo + +### Alphaleonis.Win32.Filesystem.DirectoryInfo + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-DiskSpace.md b/Docs/Cmdlets/Get-DiskSpace.md new file mode 100644 index 0000000..a037eb9 --- /dev/null +++ b/Docs/Cmdlets/Get-DiskSpace.md @@ -0,0 +1,61 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-DiskSpace + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-DiskSpace [[-DriveLetter] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -DriveLetter +{{ Fill DriveLetter Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Alphaleonis.Win32.Filesystem.DiskSpaceInfo + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-FileHash2.md b/Docs/Cmdlets/Get-FileHash2.md new file mode 100644 index 0000000..703c223 --- /dev/null +++ b/Docs/Cmdlets/Get-FileHash2.md @@ -0,0 +1,79 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-FileHash2 + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-FileHash2 [-Path] [[-Algorithm] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Algorithm +{{ Fill Algorithm Description }} + +```yaml +Type: HashAlgorithms +Parameter Sets: (All) +Aliases: +Accepted values: SHA1, SHA256, SHA384, SHA512, MACTripleDES, MD5, RIPEMD160 + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: FullName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystem.FileInfo.HashAlgorithms + +## OUTPUTS + +### Security2.FileSystemAccessRule2 + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-Item2.md b/Docs/Cmdlets/Get-Item2.md new file mode 100644 index 0000000..1fc13e8 --- /dev/null +++ b/Docs/Cmdlets/Get-Item2.md @@ -0,0 +1,63 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-Item2 + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-Item2 [[-Path] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### Alphaleonis.Win32.Filesystem.FileInfo + +### Alphaleonis.Win32.Filesystem.DirectoryInfo + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-NTFSAccess.md b/Docs/Cmdlets/Get-NTFSAccess.md new file mode 100644 index 0000000..f07f251 --- /dev/null +++ b/Docs/Cmdlets/Get-NTFSAccess.md @@ -0,0 +1,133 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-NTFSAccess + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path (Default) +``` +Get-NTFSAccess [[-Path] ] [-Account ] [-ExcludeExplicit] [-ExcludeInherited] + [] +``` + +### SD +``` +Get-NTFSAccess [-SecurityDescriptor] [-Account ] [-ExcludeExplicit] + [-ExcludeInherited] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Account +{{ Fill Account Description }} + +```yaml +Type: IdentityReference2 +Parameter Sets: (All) +Aliases: IdentityReference, ID + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeExplicit +{{ Fill ExcludeExplicit Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeInherited +{{ Fill ExcludeInherited Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecurityDescriptor +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SD +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +### Security2.IdentityReference2 + +## OUTPUTS + +### Security2.FileSystemAccessRule2 + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-NTFSAudit.md b/Docs/Cmdlets/Get-NTFSAudit.md new file mode 100644 index 0000000..29c968d --- /dev/null +++ b/Docs/Cmdlets/Get-NTFSAudit.md @@ -0,0 +1,133 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-NTFSAudit + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path +``` +Get-NTFSAudit [[-Path] ] [-Account ] [-ExcludeExplicit] [-ExcludeInherited] + [] +``` + +### SD +``` +Get-NTFSAudit [-SecurityDescriptor] [-Account ] [-ExcludeExplicit] + [-ExcludeInherited] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Account +{{ Fill Account Description }} + +```yaml +Type: IdentityReference2 +Parameter Sets: (All) +Aliases: IdentityReference, ID + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeExplicit +{{ Fill ExcludeExplicit Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeInherited +{{ Fill ExcludeInherited Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecurityDescriptor +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SD +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +### Security2.IdentityReference2 + +## OUTPUTS + +### Security2.FileSystemAuditRule2 + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-NTFSEffectiveAccess.md b/Docs/Cmdlets/Get-NTFSEffectiveAccess.md new file mode 100644 index 0000000..58b66f1 --- /dev/null +++ b/Docs/Cmdlets/Get-NTFSEffectiveAccess.md @@ -0,0 +1,133 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-NTFSEffectiveAccess + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path (Default) +``` +Get-NTFSEffectiveAccess [[-Path] ] [[-Account] ] [-ServerName ] + [-ExcludeNoneAccessEntries] [] +``` + +### SecurityDescriptor +``` +Get-NTFSEffectiveAccess [-SecurityDescriptor] [[-Account] ] + [-ServerName ] [-ExcludeNoneAccessEntries] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Account +{{ Fill Account Description }} + +```yaml +Type: IdentityReference2 +Parameter Sets: (All) +Aliases: NTAccount, IdentityReference + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExcludeNoneAccessEntries +{{ Fill ExcludeNoneAccessEntries Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecurityDescriptor +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SecurityDescriptor +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ServerName +{{ Fill ServerName Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +### Security2.IdentityReference2 + +## OUTPUTS + +### Security2.FileSystemAccessRule2 + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-NTFSHardLink.md b/Docs/Cmdlets/Get-NTFSHardLink.md new file mode 100644 index 0000000..6718e09 --- /dev/null +++ b/Docs/Cmdlets/Get-NTFSHardLink.md @@ -0,0 +1,63 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-NTFSHardLink + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-NTFSHardLink [[-Path] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### Alphaleonis.Win32.Filesystem.FileInfo + +### Alphaleonis.Win32.Filesystem.DirectoryInfo + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-NTFSInheritance.md b/Docs/Cmdlets/Get-NTFSInheritance.md new file mode 100644 index 0000000..44e9156 --- /dev/null +++ b/Docs/Cmdlets/Get-NTFSInheritance.md @@ -0,0 +1,84 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-NTFSInheritance + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path (Default) +``` +Get-NTFSInheritance [[-Path] ] [] +``` + +### SecurityDescriptor +``` +Get-NTFSInheritance [-SecurityDescriptor] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecurityDescriptor +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SecurityDescriptor +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +## OUTPUTS + +### Security2.FileSystemInheritanceInfo + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-NTFSOrphanedAccess.md b/Docs/Cmdlets/Get-NTFSOrphanedAccess.md new file mode 100644 index 0000000..80f9a7c --- /dev/null +++ b/Docs/Cmdlets/Get-NTFSOrphanedAccess.md @@ -0,0 +1,133 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-NTFSOrphanedAccess + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path +``` +Get-NTFSOrphanedAccess [[-Path] ] [-Account ] [-ExcludeExplicit] + [-ExcludeInherited] [] +``` + +### SD +``` +Get-NTFSOrphanedAccess [-SecurityDescriptor] [-Account ] + [-ExcludeExplicit] [-ExcludeInherited] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Account +{{ Fill Account Description }} + +```yaml +Type: IdentityReference2 +Parameter Sets: (All) +Aliases: IdentityReference, ID + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeExplicit +{{ Fill ExcludeExplicit Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeInherited +{{ Fill ExcludeInherited Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecurityDescriptor +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SD +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +### Security2.IdentityReference2 + +## OUTPUTS + +### Security2.FileSystemAccessRule2 + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-NTFSOrphanedAudit.md b/Docs/Cmdlets/Get-NTFSOrphanedAudit.md new file mode 100644 index 0000000..3ef6d66 --- /dev/null +++ b/Docs/Cmdlets/Get-NTFSOrphanedAudit.md @@ -0,0 +1,133 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-NTFSOrphanedAudit + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path +``` +Get-NTFSOrphanedAudit [[-Path] ] [-Account ] [-ExcludeExplicit] + [-ExcludeInherited] [] +``` + +### SD +``` +Get-NTFSOrphanedAudit [-SecurityDescriptor] [-Account ] + [-ExcludeExplicit] [-ExcludeInherited] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Account +{{ Fill Account Description }} + +```yaml +Type: IdentityReference2 +Parameter Sets: (All) +Aliases: IdentityReference, ID + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeExplicit +{{ Fill ExcludeExplicit Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeInherited +{{ Fill ExcludeInherited Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecurityDescriptor +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SD +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +### Security2.IdentityReference2 + +## OUTPUTS + +### Security2.FileSystemAuditRule2 + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-NTFSOwner.md b/Docs/Cmdlets/Get-NTFSOwner.md new file mode 100644 index 0000000..d86e5a3 --- /dev/null +++ b/Docs/Cmdlets/Get-NTFSOwner.md @@ -0,0 +1,84 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-NTFSOwner + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path (Default) +``` +Get-NTFSOwner [[-Path] ] [] +``` + +### SecurityDescriptor +``` +Get-NTFSOwner [-SecurityDescriptor] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecurityDescriptor +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SecurityDescriptor +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +## OUTPUTS + +### Security2.FileSystemOwner + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-NTFSSecurityDescriptor.md b/Docs/Cmdlets/Get-NTFSSecurityDescriptor.md new file mode 100644 index 0000000..dfe66a1 --- /dev/null +++ b/Docs/Cmdlets/Get-NTFSSecurityDescriptor.md @@ -0,0 +1,61 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-NTFSSecurityDescriptor + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-NTFSSecurityDescriptor [[-Path] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### Security2.FileSystemSecurity2 + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-NTFSSimpleAccess.md b/Docs/Cmdlets/Get-NTFSSimpleAccess.md new file mode 100644 index 0000000..2dd0a31 --- /dev/null +++ b/Docs/Cmdlets/Get-NTFSSimpleAccess.md @@ -0,0 +1,148 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-NTFSSimpleAccess + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path +``` +Get-NTFSSimpleAccess [-IncludeRootFolder] [[-Path] ] [-Account ] + [-ExcludeExplicit] [-ExcludeInherited] [] +``` + +### SD +``` +Get-NTFSSimpleAccess [-IncludeRootFolder] [-SecurityDescriptor] + [-Account ] [-ExcludeExplicit] [-ExcludeInherited] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Account +{{ Fill Account Description }} + +```yaml +Type: IdentityReference2 +Parameter Sets: (All) +Aliases: IdentityReference, ID + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeExplicit +{{ Fill ExcludeExplicit Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeInherited +{{ Fill ExcludeInherited Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeRootFolder +{{ Fill IncludeRootFolder Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecurityDescriptor +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SD +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +### Security2.IdentityReference2 + +## OUTPUTS + +### Security2.SimpleFileSystemAccessRule + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-Privileges.md b/Docs/Cmdlets/Get-Privileges.md new file mode 100644 index 0000000..ac1e0c3 --- /dev/null +++ b/Docs/Cmdlets/Get-Privileges.md @@ -0,0 +1,46 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-Privileges + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-Privileges [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### 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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### ProcessPrivileges.PrivilegeAndAttributes + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Move-Item2.md b/Docs/Cmdlets/Move-Item2.md new file mode 100644 index 0000000..113e77b --- /dev/null +++ b/Docs/Cmdlets/Move-Item2.md @@ -0,0 +1,139 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Move-Item2 + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Move-Item2 [-Path] [-Destination] [-Force] [-PassThru ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +{{ Fill Destination Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +{{ Fill Force Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: FullName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### System.String + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/New-NTFSHardLink.md b/Docs/Cmdlets/New-NTFSHardLink.md new file mode 100644 index 0000000..a50ea26 --- /dev/null +++ b/Docs/Cmdlets/New-NTFSHardLink.md @@ -0,0 +1,93 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# New-NTFSHardLink + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-NTFSHardLink [[-Path] ] [[-Target] ] [-PassThru] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Target +{{ Fill Target Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Alphaleonis.Win32.Filesystem.FileInfo + +### Alphaleonis.Win32.Filesystem.DirectoryInfo + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/New-NTFSSymbolicLink.md b/Docs/Cmdlets/New-NTFSSymbolicLink.md new file mode 100644 index 0000000..28a5e4d --- /dev/null +++ b/Docs/Cmdlets/New-NTFSSymbolicLink.md @@ -0,0 +1,93 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# New-NTFSSymbolicLink + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-NTFSSymbolicLink [[-Path] ] [[-Target] ] [-PassThru] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Target +{{ Fill Target Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Alphaleonis.Win32.Filesystem.FileInfo + +### Alphaleonis.Win32.Filesystem.DirectoryInfo + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Remove-Item2.md b/Docs/Cmdlets/Remove-Item2.md new file mode 100644 index 0000000..be0ac85 --- /dev/null +++ b/Docs/Cmdlets/Remove-Item2.md @@ -0,0 +1,136 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Remove-Item2 + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-Item2 [[-Path] ] [-Force] [-Recurse] [-PassThur] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +{{ Fill Force Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThur +{{ Fill PassThur Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Recurse +{{ Fill Recurse Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Remove-NTFSAccess.md b/Docs/Cmdlets/Remove-NTFSAccess.md new file mode 100644 index 0000000..57ac22a --- /dev/null +++ b/Docs/Cmdlets/Remove-NTFSAccess.md @@ -0,0 +1,223 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Remove-NTFSAccess + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### PathComplex (Default) +``` +Remove-NTFSAccess [-Path] [-Account] [-AccessRights] + [-AccessType ] [-InheritanceFlags ] + [-PropagationFlags ] [-PassThru] [] +``` + +### PathSimple +``` +Remove-NTFSAccess [-Path] [-Account] [-AccessRights] + [-AccessType ] [-AppliesTo ] [-PassThru] [] +``` + +### SDSimple +``` +Remove-NTFSAccess [-SecurityDescriptor] [-Account] + [-AccessRights] [-AccessType ] [-AppliesTo ] [-PassThru] + [] +``` + +### SDComplex +``` +Remove-NTFSAccess [-SecurityDescriptor] [-Account] + [-AccessRights] [-AccessType ] [-InheritanceFlags ] + [-PropagationFlags ] [-PassThru] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -AccessRights +{{ Fill AccessRights Description }} + +```yaml +Type: FileSystemRights2 +Parameter Sets: (All) +Aliases: FileSystemRights +Accepted values: None, ReadData, ListDirectory, WriteData, CreateFiles, AppendData, CreateDirectories, ReadExtendedAttributes, WriteExtendedAttributes, ExecuteFile, Traverse, DeleteSubdirectoriesAndFiles, ReadAttributes, WriteAttributes, Write, Delete, ReadPermissions, Read, ReadAndExecute, Modify, ChangePermissions, TakeOwnership, Synchronize, FullControl, GenericAll, GenericExecute, GenericWrite, GenericRead + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AccessType +{{ Fill AccessType Description }} + +```yaml +Type: AccessControlType +Parameter Sets: (All) +Aliases: AccessControlType +Accepted values: Allow, Deny + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Account +{{ Fill Account Description }} + +```yaml +Type: IdentityReference2[] +Parameter Sets: (All) +Aliases: IdentityReference, ID + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AppliesTo +{{ Fill AppliesTo Description }} + +```yaml +Type: ApplyTo +Parameter Sets: PathSimple, SDSimple +Aliases: +Accepted values: ThisFolderOnly, ThisFolderSubfoldersAndFiles, ThisFolderAndSubfolders, ThisFolderAndFiles, SubfoldersAndFilesOnly, SubfoldersOnly, FilesOnly, ThisFolderSubfoldersAndFilesOneLevel, ThisFolderAndSubfoldersOneLevel, ThisFolderAndFilesOneLevel, SubfoldersAndFilesOnlyOneLevel, SubfoldersOnlyOneLevel, FilesOnlyOneLevel + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InheritanceFlags +{{ Fill InheritanceFlags Description }} + +```yaml +Type: InheritanceFlags +Parameter Sets: PathComplex, SDComplex +Aliases: +Accepted values: None, ContainerInherit, ObjectInherit + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: PathComplex, PathSimple +Aliases: FullName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PropagationFlags +{{ Fill PropagationFlags Description }} + +```yaml +Type: PropagationFlags +Parameter Sets: PathComplex, SDComplex +Aliases: +Accepted values: None, NoPropagateInherit, InheritOnly + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecurityDescriptor +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SDSimple, SDComplex +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +### Security2.IdentityReference2[] + +### Security2.FileSystemRights2 + +### System.Security.AccessControl.AccessControlType + +### System.Security.AccessControl.InheritanceFlags + +### System.Security.AccessControl.PropagationFlags + +### Security2.ApplyTo + +## OUTPUTS + +### Security2.FileSystemAccessRule2 + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Remove-NTFSAudit.md b/Docs/Cmdlets/Remove-NTFSAudit.md new file mode 100644 index 0000000..d6c4a28 --- /dev/null +++ b/Docs/Cmdlets/Remove-NTFSAudit.md @@ -0,0 +1,223 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Remove-NTFSAudit + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### PathComplex (Default) +``` +Remove-NTFSAudit [-Path] [-Account] [-AccessRights] + [-AuditFlags ] [-InheritanceFlags ] [-PropagationFlags ] + [-PassThru] [] +``` + +### PathSimple +``` +Remove-NTFSAudit [-Path] [-Account] [-AccessRights] + [-AuditFlags ] [-AppliesTo ] [-PassThru] [] +``` + +### SDSimple +``` +Remove-NTFSAudit [-SecurityDescriptor] [-Account] + [-AccessRights] [-AuditFlags ] [-AppliesTo ] [-PassThru] + [] +``` + +### SDComplex +``` +Remove-NTFSAudit [-SecurityDescriptor] [-Account] + [-AccessRights] [-AuditFlags ] [-InheritanceFlags ] + [-PropagationFlags ] [-PassThru] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -AccessRights +{{ Fill AccessRights Description }} + +```yaml +Type: FileSystemRights2 +Parameter Sets: (All) +Aliases: FileSystemRights +Accepted values: None, ReadData, ListDirectory, WriteData, CreateFiles, AppendData, CreateDirectories, ReadExtendedAttributes, WriteExtendedAttributes, ExecuteFile, Traverse, DeleteSubdirectoriesAndFiles, ReadAttributes, WriteAttributes, Write, Delete, ReadPermissions, Read, ReadAndExecute, Modify, ChangePermissions, TakeOwnership, Synchronize, FullControl, GenericAll, GenericExecute, GenericWrite, GenericRead + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Account +{{ Fill Account Description }} + +```yaml +Type: IdentityReference2[] +Parameter Sets: (All) +Aliases: IdentityReference, ID + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AppliesTo +{{ Fill AppliesTo Description }} + +```yaml +Type: ApplyTo +Parameter Sets: PathSimple, SDSimple +Aliases: +Accepted values: ThisFolderOnly, ThisFolderSubfoldersAndFiles, ThisFolderAndSubfolders, ThisFolderAndFiles, SubfoldersAndFilesOnly, SubfoldersOnly, FilesOnly, ThisFolderSubfoldersAndFilesOneLevel, ThisFolderAndSubfoldersOneLevel, ThisFolderAndFilesOneLevel, SubfoldersAndFilesOnlyOneLevel, SubfoldersOnlyOneLevel, FilesOnlyOneLevel + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AuditFlags +{{ Fill AuditFlags Description }} + +```yaml +Type: AuditFlags +Parameter Sets: (All) +Aliases: +Accepted values: None, Success, Failure + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InheritanceFlags +{{ Fill InheritanceFlags Description }} + +```yaml +Type: InheritanceFlags +Parameter Sets: PathComplex, SDComplex +Aliases: +Accepted values: None, ContainerInherit, ObjectInherit + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: PathComplex, PathSimple +Aliases: FullName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PropagationFlags +{{ Fill PropagationFlags Description }} + +```yaml +Type: PropagationFlags +Parameter Sets: PathComplex, SDComplex +Aliases: +Accepted values: None, NoPropagateInherit, InheritOnly + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecurityDescriptor +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SDSimple, SDComplex +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +### Security2.IdentityReference2[] + +### Security2.FileSystemRights2 + +### System.Security.AccessControl.AuditFlags + +### System.Security.AccessControl.InheritanceFlags + +### System.Security.AccessControl.PropagationFlags + +### Security2.ApplyTo + +## OUTPUTS + +### Security2.FileSystemAccessRule2 + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Set-NTFSInheritance.md b/Docs/Cmdlets/Set-NTFSInheritance.md new file mode 100644 index 0000000..f25a8e8 --- /dev/null +++ b/Docs/Cmdlets/Set-NTFSInheritance.md @@ -0,0 +1,132 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Set-NTFSInheritance + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path (Default) +``` +Set-NTFSInheritance [[-Path] ] [-AccessInheritanceEnabled ] + [-AuditInheritanceEnabled ] [-PassThru] [] +``` + +### SecurityDescriptor +``` +Set-NTFSInheritance [-SecurityDescriptor] [-AccessInheritanceEnabled ] + [-AuditInheritanceEnabled ] [-PassThru] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -AccessInheritanceEnabled +{{ Fill AccessInheritanceEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AuditInheritanceEnabled +{{ Fill AuditInheritanceEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecurityDescriptor +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SecurityDescriptor +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Set-NTFSOwner.md b/Docs/Cmdlets/Set-NTFSOwner.md new file mode 100644 index 0000000..17f2c6b --- /dev/null +++ b/Docs/Cmdlets/Set-NTFSOwner.md @@ -0,0 +1,117 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Set-NTFSOwner + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path (Default) +``` +Set-NTFSOwner [[-Path] ] [-Account] [-PassThru] [] +``` + +### SecurityDescriptor +``` +Set-NTFSOwner [-SecurityDescriptor] [-Account] [-PassThru] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Account +{{ Fill Account Description }} + +```yaml +Type: IdentityReference2 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecurityDescriptor +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SecurityDescriptor +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +### Security2.IdentityReference2 + +## OUTPUTS + +### Security2.FileSystemOwner + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Set-NTFSSecurityDescriptor.md b/Docs/Cmdlets/Set-NTFSSecurityDescriptor.md new file mode 100644 index 0000000..b7cde6d --- /dev/null +++ b/Docs/Cmdlets/Set-NTFSSecurityDescriptor.md @@ -0,0 +1,76 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Set-NTFSSecurityDescriptor + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Set-NTFSSecurityDescriptor [-SecurityDescriptor] [-PassThru] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityDescriptor +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Security2.FileSystemSecurity2[] + +## OUTPUTS + +### Security2.FileSystemSecurity2 + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Test-Path2.md b/Docs/Cmdlets/Test-Path2.md new file mode 100644 index 0000000..8a8f8a4 --- /dev/null +++ b/Docs/Cmdlets/Test-Path2.md @@ -0,0 +1,81 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Test-Path2 + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Test-Path2 [-Path] [-PathType ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: FullName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PathType +{{ Fill PathType Description }} + +```yaml +Type: TestPathType +Parameter Sets: (All) +Aliases: +Accepted values: Any, Container, Leaf + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### NTFSSecurity.TestPathType + +## OUTPUTS + +### Alphaleonis.Win32.Filesystem.FileInfo + +### Alphaleonis.Win32.Filesystem.DirectoryInfo + +## NOTES + +## RELATED LINKS diff --git a/Docs/Contributing.md b/Docs/Contributing.md new file mode 100644 index 0000000..7f854ee --- /dev/null +++ b/Docs/Contributing.md @@ -0,0 +1,14 @@ +# Contributor Guide + +Thank you for your interest in contributing to quality documentations. +As an open source project, we welcome input and updates from the community. +The following topics explain how to contribute to the NTFSAccess documentation. + +1. [Get started](./contributing/1-GET-STARTED.md) +2. [Writing PowerShell documentation](./contributing/2-WRITING.md) +3. [Style Guide](./contributing/3-STYLE-GUIDE.md) +4. [Markdown Specifics](./contributing/4-MARKDOWN-SPECIFICS.md) +5. [Formatting Code blocks](./contributing/5-FORMATTING-CODE.md) +6. [Updating Reference](./contributing/6-UPDATING-REFERENCE.md) + +This contributor guide is a modified version of the one found on the [Powershell Docs](https://github.com/PowerShell/PowerShell-Docs) GitHub page. \ No newline at end of file diff --git a/Docs/Contributing/01-Getting-Started.md b/Docs/Contributing/01-Getting-Started.md new file mode 100644 index 0000000..998fa4d --- /dev/null +++ b/Docs/Contributing/01-Getting-Started.md @@ -0,0 +1,54 @@ +# Contributing to PowerShell Documentation + +Thank you for your interest in NTFSAccess documentation! + +See below for details on how you can contribute to our technical documentation. + +> For general information about getting started with Git and GitHub, see [GitHub Help][git-help]. + +## Providing feedback on NTFSAccess documentation + +Report errors, suggest changes, or request new topics by [creating an issue][new-issue] on the +[NTFSAccess-Docs repository issues page][doc-issues]. + +## Making minor edits to existing topics + +To [edit an existing file][edit-file], navigate to it and click the "Edit" button. GitHub will +automatically create your own fork of our repository where you can make your changes. Once you are +finished, save your edits and submit a [pull request][pull] to the *staging* branch of the +[NTFSAccess-Docs][docs-repo] repository. After your pull request is created, someone on the +NTFSAccess documentation team reviews your changes before merging them into the *staging* branch. + +## Making major edits to existing topics + +If you are making significant changes, adding or changing images, or contributing a new article, you +need to create a GitHub fork and clone it to your computer. A fork is a GitHub-based replica of the +main repository, under your GitHub account, that provides you with a working copy which you can use +in isolation. You create pull requests from your fork. Similarly, a clone is a local-based replica +of the repository which, in this case, is a clone of your fork. The clone allows you to work on Git +repositories offline, and using more powerful native software/tools. + +Here is the workflow for making major edits to existing documentation: + +1. [Create a fork][fork] of the [NTFSAccess-Docs][docs-repo] repository. +2. [Create a clone of your fork][clone] on your local computer. +3. Create a new local branch in your cloned repository. +4. Make changes to the file(s) you want to update in a Markdown editor. +5. [Push your local branch][push] to your fork. +6. [Create a pull request][pull] to the *staging* branch of the [NTFSAccess-Docs][docs-repo] + repository. + +## Next steps + +See [Writing PowerShell documentation](2-WRITING.md). + + +[git-help]: https://help.github.com/ +[new-issue]: https://help.github.com/articles/creating-an-issue/ +[doc-issues]: https://github.com/Sup3rlativ3/NTFSAccess-Docs/issues +[edit-file]: https://help.github.com/articles/editing-files-in-another-user-s-repository/ +[docs-repo]: https://github.com/Sup3rlativ3/NTFSAccess-Docs +[fork]: https://help.github.com/articles/fork-a-repo/ +[clone]: https://help.github.com/articles/cloning-a-repository/ +[push]: https://help.github.com/articles/pushing-to-a-remote/ +[pull]: https://help.github.com/articles/creating-a-pull-request/ \ No newline at end of file diff --git a/Docs/Contributing/02-Writing.md b/Docs/Contributing/02-Writing.md new file mode 100644 index 0000000..f42232e --- /dev/null +++ b/Docs/Contributing/02-Writing.md @@ -0,0 +1,62 @@ +# Writing NTFSAccess documentation + +One of the easiest ways to contribute to the NTFSAccess PowerShell module is by helping to write and edit documentation. +All the documentation hosted on GitHub is written using *Markdown*. Markdown is a lightweight markup +language with plain text formatting syntax. Markdown forms the basis of our documentation's +conceptual authoring language. Creating new articles is as easy as writing a simple text file by +using your favorite text editor. + +## Markdown editors + +Here are some Markdown editors you can try out: + +- [Visual Studio Code](https://code.visualstudio.com) +- [Atom](https://atom.io/) +- [Sublime Text](http://www.sublimetext.com/) + +## Get started using Markdown + +To get started using Markdown, see [How to use Markdown for writing Docs](https://docs.microsoft.com/contribute/how-to-write-use-markdown). + +The Open Publishing System (OPS) is the platform used by docs.microsoft.com. OPS uses DocFX Flavored +Markdown (DFM). DFM supports all GitHub Flavored Markdown (GFM) syntax and is compatible with +CommonMark. There are some [differences between DFM and GFM][dfm-diffs] that can affect content +preview in GitHub or your editor. + +The default Markdown engine in OPS is built on the top of [markdig][]. This engine is based on the +CommonMark specification and supports extensions for DocFX. In the latest version of the [CommonMark][] +specification, many spacing rules have changed. Spaces are significant in Markdown. Don't use hard +tabs in Markdown. For more detailed information about the Markdown specification, see the +[Markdown Specifics](4-MARKDOWN-SPECIFICS.md) article. + +## Creating new topics + +To contribute new documentation, check for issues tagged as ["in progress"][labels] to make sure +you're not duplicating efforts. If no one seems to be working on what you have planned: + +- Open a new issue and label it as "in progress". If you don't have rights to assign labels, add "in + progress" as a comment to tell others what you're working on. +- Follow the same workflow as described above for making major edits to existing topics. +- Add your new article to the `TOC.yml` file (located in the top-level folder of each + documentation set). + +## Updating topics that exist in multiple versions + +Most reference topics are duplicated across all versions of PowerShell. When reporting an issue +about a cmdlet reference or an About_ article, you must specify which versions are affected by the +issue. The default issue template in GitHub includes a [GFM task list][gfm-task]. Use the checkboxes +in the task list to specify which versions of the content are affected. When you submit a change to +a article for an issue that affects multiple versions of the content, you must apply the appropriate +change to each version of the file. + +## Next Steps + +Read the [Style Guide](3-STYLE-GUIDE.md). + + +[markdig]: https://github.com/lunet-io/markdig +[CommonMark]: https://spec.commonmark.org/ +[gfm-help]: https://help.github.com/categories/writing-on-github/ +[labels]: https://github.com/PowerShell/PowerShell-Docs/labels/in%20progress +[gfm-task]: https://github.github.com/gfm/#task-list-items-extension- +[dfm-diffs]: https://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html#differences-between-dfm-and-gfm \ No newline at end of file diff --git a/Docs/Index.md b/Docs/Index.md new file mode 100644 index 0000000..01935fa --- /dev/null +++ b/Docs/Index.md @@ -0,0 +1,25 @@ +# NTFSSecurity + + +Managing permissions with PowerShell is only a bit easier than in VBS or the command line as there are no cmdlets for most day-to-day tasks like getting a permission report or adding permission to an item. PowerShell only offers Get-Acl and Set-Acl but everything in between getting and setting the ACL is missing. This module closes the gap. + +[Version History](https://github.com/raandree/NTFSSecurity/wiki/Version-History) + +## Installation +You have two options: + +* Download the latest release from the [releases](https://github.com/raandree/NTFSSecurity/releases) section on GitHub. +* Download the module from the [PowerShell Gallery](https://www.powershellgallery.com/packages/NTFSSecurity): +``` +Install-Module -Name NTFSSecurity +``` + +Further help can be found in How to install if you face difficulties getting this module installed. + +## Documentation +The cmdlets are yet not documented completely so Get-Help will not show help for all the cmdlets. Providing documentation is planned though. + +## Additional documentation is available: + +[NTFSSecurity Tutorial 1 - Getting, adding and removing permissions](http://blogs.technet.com/b/fieldcoding/archive/2014/12/05/ntfssecurity-tutorial-1-getting-adding-and-removing-permissions.aspx) +[NTFSSecurity Tutorial 2 - Managing NTFS Inheritance and Using Privileges](http://blogs.technet.com/b/fieldcoding/archive/2014/12/05/ntfssecurity-tutorial-2-managing-ntfs-inheritance-and-using-privileges.aspx) diff --git a/appveyor.yml b/appveyor.yml new file mode 100644 index 0000000..3b2f042 --- /dev/null +++ b/appveyor.yml @@ -0,0 +1,30 @@ +install: + - ps: | + Install-PackageProvider -Name NuGet -MinimumVersion 2.8.5.201 -Force + Install-Module platyPS -Force + Install-Module MarkdownLinkCheck -Force + Import-Module platyPS + Import-Module MarkdownLinkCheck + +init: + - ps: git config --global core.autocrlf true + +build_script: + - ps: Import-Module -Force ./NTFSSecurity/NTFSSecurity.psm1 + +test_script: + - ps: | + $ErrorActionPreference = 'Stop' + + # 01. Test that documentation is up-to-date + Update-MarkdownHelp -Path ./Docs + $Diff = git diff + if ($Diff) { + throw "Help is not up-to-date, run Update-MarkdownHelp: $diff" + } + + # 02. Verify hyperlinks + $BrokenLinks = Get-MarkdownLink -Path .\Docs -BrokenOnly + if ($brokenLinks) { + throw "Found broken hyperlinks $brokenLinks" + } \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..e2aebeb --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,50 @@ +copyright: NTFSSecurity is licensed under the MIT license +repo_url: https://github.com/raandree/NTFSSecurity +nav: +- Home: index.md +- Cmdlets: + - Add-NTFSAccess: Cmdlets/Add-NTFSAccess.md + - Add-NTFSAudit: Cmdlets/Add-NTFSAudit.md + - Clear-NTFSAccess: Cmdlets/Clear-NTFSAccess.md + - Clear-NTFSAudit: Cmdlets/Clear-NTFSAudit.md + - Copy-Item2: Cmdlets/Copy-Item2.md + - Disable-NTFSAccessInheritance: Cmdlets/Disable-NTFSAccessInheritance.md + - Disable-NTFSAuditInheritance: Cmdlets/Disable-NTFSAuditInheritance.md + - Disable-Privileges: Cmdlets/Disable-Privileges.md + - Enable-NTFSAccessInheritance: Cmdlets/Enable-NTFSAccessInheritance.md + - Enable-NTFSAuditInheritance: Cmdlets/Enable-NTFSAuditInheritance.md + - Enable-Privileges: Cmdlets/Enable-Privileges.md + - Get-ChildItem2: Cmdlets/Get-ChildItem2.md + - Get-DiskSpace: Cmdlets/Get-DiskSpace.md + - Get-FileHash2: Cmdlets/Get-FileHash2.md + - Get-Item2: Cmdlets/Get-Item2.md + - Get-NTFSAccess: Cmdlets/Get-NTFSAccess.md + - Get-NTFSAudit: Cmdlets/Get-NTFSAudit.md + - Get-NTFSEffectiveAccess: Cmdlets/Get-NTFSEffectiveAccess.md + - Get-NTFSHardLink: Cmdlets/Get-NTFSHardLink.md + - Get-NTFSInheritance: Cmdlets/Get-NTFSInheritance.md + - Get-NTFSOrphanedAccess: Cmdlets/Get-NTFSOrphanedAccess.md + - Get-NTFSOrphanedAudit: Cmdlets/Get-NTFSOrphanedAudit.md + - Get-NTFSOwner: Cmdlets/Get-NTFSOwner.md + - Get-NTFSSecurityDescriptor: Cmdlets/Get-NTFSSecurityDescriptor.md + - Get-NTFSSimpleAccess: Cmdlets/Get-NTFSSimpleAccess.md + - Get-Privileges: Cmdlets/Get-Privileges.md + - Move-Item2: Cmdlets/Move-Item2.md + - New-NTFSHardLink: Cmdlets/New-NTFSHardLink.md + - New-NTFSSymbolicLink: Cmdlets/New-NTFSSymbolicLink.md + - Remove-Item2: Cmdlets/Remove-Item2.md + - Remove-NTFSAccess: Cmdlets/Remove-NTFSAccess.md + - Remove-NTFSAudit: Cmdlets/Remove-NTFSAudit.md + - Set-NTFSInheritance: Cmdlets/Set-NTFSInheritance.md + - Set-NTFSOwner: Cmdlets/Set-NTFSOwner.md + - Set-NTFSSecurityDescriptor: Cmdlets/Set-NTFSSecurityDescriptor.md + - Test-Path2: Cmdlets/Test-Path2.md +- License: License.md +- Contributing: + - Getting Started: Contributing/01-Getting-Started.md + - Writing: /Contributing/02-Writing.md +site_name: NTFSSecurity +theme: readthedocs +site_author: Raimund Andrée, James Smith +edit_uri: edit/master/Help/ +docs_dir: Docs \ No newline at end of file From eb419e651e502b3d397e32cc92f38b781f8eb5af Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 21:13:19 +1100 Subject: [PATCH 02/44] fixed doco up-to-date test --- appveyor.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/appveyor.yml b/appveyor.yml index 3b2f042..b7db491 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -17,7 +17,7 @@ test_script: $ErrorActionPreference = 'Stop' # 01. Test that documentation is up-to-date - Update-MarkdownHelp -Path ./Docs + Update-MarkdownHelp -Path ./Docs/Cmdlets $Diff = git diff if ($Diff) { throw "Help is not up-to-date, run Update-MarkdownHelp: $diff" From 74d93c7985e69dadf29fbe2cb737690c4375732f Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 21:20:23 +1100 Subject: [PATCH 03/44] external help added --- Docs/Contributing.md | 4 - Out/NTFSSecurity.dll-Help.xml | 8110 +++++++++++++++++++++++++++++++++ 2 files changed, 8110 insertions(+), 4 deletions(-) create mode 100644 Out/NTFSSecurity.dll-Help.xml diff --git a/Docs/Contributing.md b/Docs/Contributing.md index 7f854ee..eebc38c 100644 --- a/Docs/Contributing.md +++ b/Docs/Contributing.md @@ -6,9 +6,5 @@ The following topics explain how to contribute to the NTFSAccess documentation. 1. [Get started](./contributing/1-GET-STARTED.md) 2. [Writing PowerShell documentation](./contributing/2-WRITING.md) -3. [Style Guide](./contributing/3-STYLE-GUIDE.md) -4. [Markdown Specifics](./contributing/4-MARKDOWN-SPECIFICS.md) -5. [Formatting Code blocks](./contributing/5-FORMATTING-CODE.md) -6. [Updating Reference](./contributing/6-UPDATING-REFERENCE.md) This contributor guide is a modified version of the one found on the [Powershell Docs](https://github.com/PowerShell/PowerShell-Docs) GitHub page. \ No newline at end of file diff --git a/Out/NTFSSecurity.dll-Help.xml b/Out/NTFSSecurity.dll-Help.xml new file mode 100644 index 0000000..f5a8221 --- /dev/null +++ b/Out/NTFSSecurity.dll-Help.xml @@ -0,0 +1,8110 @@ + + + + + Add-NTFSAccess + Add + NTFSAccess + + Adds an access control entry (ACE) to an object. + + + + Adds an access control entry (ACE) to an object such as a file or folder. Other examples would be an object inside of Active Directory. + + + + Add-NTFSAccess + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2[] + + IdentityReference2[] + + + None + + + AccessRights + + The AccessRights parameter designates the permissions to assign. There are individual permissions as well as 'basic' permissions. See the below table for how the basic permissions permissions map the the advanced permissions. + | Permissions | Basic Full Control | Basic Modify | Basic Read & Execute | Basic List Folder Contents | Basic Read | Basic Write | |:---------------------------: |:------------------: |:------------: |:--------------------: |:--------------------------: |:----------: |:-----------: | | Travers Folder/Execute | X | X | X | X | | | | List Folder/ Read Data | X | X | X | X | X | | | Read Attributes | X | X | X | X | X | | | Read Extended Attributes | X | X | X | X | X | | | Create Files/Write Data | X | X | | | | X | | Create Folders/Append Data | X | X | | | | X | | Write Attributes | X | X | | | | X | | Write Extended Attributes | X | X | | | | X | | Delete Subfolders and Files | X | | | | | | | Delete | X | X | | | | | | Read Permissions | X | X | X | X | X | X | | Change Permissions | X | | | | | | | Take Ownership | X | | | | | | | Synchronize | X | X | X | X | X | X | + + + None + ReadData + ListDirectory + WriteData + CreateFiles + AppendData + CreateDirectories + ReadExtendedAttributes + WriteExtendedAttributes + ExecuteFile + Traverse + DeleteSubdirectoriesAndFiles + ReadAttributes + WriteAttributes + Write + Delete + ReadPermissions + Read + ReadAndExecute + Modify + ChangePermissions + TakeOwnership + Synchronize + FullControl + GenericAll + GenericExecute + GenericWrite + GenericRead + + FileSystemRights2 + + FileSystemRights2 + + + None + + + AccessType + + The AccessType parameter determines if the ACE allows or denies the permissions assigned. + + + Allow + Deny + + AccessControlType + + AccessControlType + + + None + + + AppliesTo + + {{ Fill AppliesTo Description }} + + + ThisFolderOnly + ThisFolderSubfoldersAndFiles + ThisFolderAndSubfolders + ThisFolderAndFiles + SubfoldersAndFilesOnly + SubfoldersOnly + FilesOnly + ThisFolderSubfoldersAndFilesOneLevel + ThisFolderAndSubfoldersOneLevel + ThisFolderAndFilesOneLevel + SubfoldersAndFilesOnlyOneLevel + SubfoldersOnlyOneLevel + FilesOnlyOneLevel + + ApplyTo + + ApplyTo + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + + Add-NTFSAccess + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2[] + + IdentityReference2[] + + + None + + + AccessRights + + The AccessRights parameter designates the permissions to assign. There are individual permissions as well as 'basic' permissions. See the below table for how the basic permissions permissions map the the advanced permissions. + | Permissions | Basic Full Control | Basic Modify | Basic Read & Execute | Basic List Folder Contents | Basic Read | Basic Write | |:---------------------------: |:------------------: |:------------: |:--------------------: |:--------------------------: |:----------: |:-----------: | | Travers Folder/Execute | X | X | X | X | | | | List Folder/ Read Data | X | X | X | X | X | | | Read Attributes | X | X | X | X | X | | | Read Extended Attributes | X | X | X | X | X | | | Create Files/Write Data | X | X | | | | X | | Create Folders/Append Data | X | X | | | | X | | Write Attributes | X | X | | | | X | | Write Extended Attributes | X | X | | | | X | | Delete Subfolders and Files | X | | | | | | | Delete | X | X | | | | | | Read Permissions | X | X | X | X | X | X | | Change Permissions | X | | | | | | | Take Ownership | X | | | | | | | Synchronize | X | X | X | X | X | X | + + + None + ReadData + ListDirectory + WriteData + CreateFiles + AppendData + CreateDirectories + ReadExtendedAttributes + WriteExtendedAttributes + ExecuteFile + Traverse + DeleteSubdirectoriesAndFiles + ReadAttributes + WriteAttributes + Write + Delete + ReadPermissions + Read + ReadAndExecute + Modify + ChangePermissions + TakeOwnership + Synchronize + FullControl + GenericAll + GenericExecute + GenericWrite + GenericRead + + FileSystemRights2 + + FileSystemRights2 + + + None + + + AccessType + + The AccessType parameter determines if the ACE allows or denies the permissions assigned. + + + Allow + Deny + + AccessControlType + + AccessControlType + + + None + + + AppliesTo + + {{ Fill AppliesTo Description }} + + + ThisFolderOnly + ThisFolderSubfoldersAndFiles + ThisFolderAndSubfolders + ThisFolderAndFiles + SubfoldersAndFilesOnly + SubfoldersOnly + FilesOnly + ThisFolderSubfoldersAndFilesOneLevel + ThisFolderAndSubfoldersOneLevel + ThisFolderAndFilesOneLevel + SubfoldersAndFilesOnlyOneLevel + SubfoldersOnlyOneLevel + FilesOnlyOneLevel + + ApplyTo + + ApplyTo + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + + Add-NTFSAccess + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2[] + + IdentityReference2[] + + + None + + + AccessRights + + The AccessRights parameter designates the permissions to assign. There are individual permissions as well as 'basic' permissions. See the below table for how the basic permissions permissions map the the advanced permissions. + | Permissions | Basic Full Control | Basic Modify | Basic Read & Execute | Basic List Folder Contents | Basic Read | Basic Write | |:---------------------------: |:------------------: |:------------: |:--------------------: |:--------------------------: |:----------: |:-----------: | | Travers Folder/Execute | X | X | X | X | | | | List Folder/ Read Data | X | X | X | X | X | | | Read Attributes | X | X | X | X | X | | | Read Extended Attributes | X | X | X | X | X | | | Create Files/Write Data | X | X | | | | X | | Create Folders/Append Data | X | X | | | | X | | Write Attributes | X | X | | | | X | | Write Extended Attributes | X | X | | | | X | | Delete Subfolders and Files | X | | | | | | | Delete | X | X | | | | | | Read Permissions | X | X | X | X | X | X | | Change Permissions | X | | | | | | | Take Ownership | X | | | | | | | Synchronize | X | X | X | X | X | X | + + + None + ReadData + ListDirectory + WriteData + CreateFiles + AppendData + CreateDirectories + ReadExtendedAttributes + WriteExtendedAttributes + ExecuteFile + Traverse + DeleteSubdirectoriesAndFiles + ReadAttributes + WriteAttributes + Write + Delete + ReadPermissions + Read + ReadAndExecute + Modify + ChangePermissions + TakeOwnership + Synchronize + FullControl + GenericAll + GenericExecute + GenericWrite + GenericRead + + FileSystemRights2 + + FileSystemRights2 + + + None + + + AccessType + + The AccessType parameter determines if the ACE allows or denies the permissions assigned. + + + Allow + Deny + + AccessControlType + + AccessControlType + + + None + + + InheritanceFlags + + {{ Fill InheritanceFlags Description }} + + + None + ContainerInherit + ObjectInherit + + InheritanceFlags + + InheritanceFlags + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + PropagationFlags + + {{ Fill PropagationFlags Description }} + + + None + NoPropagateInherit + InheritOnly + + PropagationFlags + + PropagationFlags + + + None + + + + Add-NTFSAccess + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2[] + + IdentityReference2[] + + + None + + + AccessRights + + The AccessRights parameter designates the permissions to assign. There are individual permissions as well as 'basic' permissions. See the below table for how the basic permissions permissions map the the advanced permissions. + | Permissions | Basic Full Control | Basic Modify | Basic Read & Execute | Basic List Folder Contents | Basic Read | Basic Write | |:---------------------------: |:------------------: |:------------: |:--------------------: |:--------------------------: |:----------: |:-----------: | | Travers Folder/Execute | X | X | X | X | | | | List Folder/ Read Data | X | X | X | X | X | | | Read Attributes | X | X | X | X | X | | | Read Extended Attributes | X | X | X | X | X | | | Create Files/Write Data | X | X | | | | X | | Create Folders/Append Data | X | X | | | | X | | Write Attributes | X | X | | | | X | | Write Extended Attributes | X | X | | | | X | | Delete Subfolders and Files | X | | | | | | | Delete | X | X | | | | | | Read Permissions | X | X | X | X | X | X | | Change Permissions | X | | | | | | | Take Ownership | X | | | | | | | Synchronize | X | X | X | X | X | X | + + + None + ReadData + ListDirectory + WriteData + CreateFiles + AppendData + CreateDirectories + ReadExtendedAttributes + WriteExtendedAttributes + ExecuteFile + Traverse + DeleteSubdirectoriesAndFiles + ReadAttributes + WriteAttributes + Write + Delete + ReadPermissions + Read + ReadAndExecute + Modify + ChangePermissions + TakeOwnership + Synchronize + FullControl + GenericAll + GenericExecute + GenericWrite + GenericRead + + FileSystemRights2 + + FileSystemRights2 + + + None + + + AccessType + + The AccessType parameter determines if the ACE allows or denies the permissions assigned. + + + Allow + Deny + + AccessControlType + + AccessControlType + + + None + + + InheritanceFlags + + {{ Fill InheritanceFlags Description }} + + + None + ContainerInherit + ObjectInherit + + InheritanceFlags + + InheritanceFlags + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + PropagationFlags + + {{ Fill PropagationFlags Description }} + + + None + NoPropagateInherit + InheritOnly + + PropagationFlags + + PropagationFlags + + + None + + + + + + AccessRights + + The AccessRights parameter designates the permissions to assign. There are individual permissions as well as 'basic' permissions. See the below table for how the basic permissions permissions map the the advanced permissions. + | Permissions | Basic Full Control | Basic Modify | Basic Read & Execute | Basic List Folder Contents | Basic Read | Basic Write | |:---------------------------: |:------------------: |:------------: |:--------------------: |:--------------------------: |:----------: |:-----------: | | Travers Folder/Execute | X | X | X | X | | | | List Folder/ Read Data | X | X | X | X | X | | | Read Attributes | X | X | X | X | X | | | Read Extended Attributes | X | X | X | X | X | | | Create Files/Write Data | X | X | | | | X | | Create Folders/Append Data | X | X | | | | X | | Write Attributes | X | X | | | | X | | Write Extended Attributes | X | X | | | | X | | Delete Subfolders and Files | X | | | | | | | Delete | X | X | | | | | | Read Permissions | X | X | X | X | X | X | | Change Permissions | X | | | | | | | Take Ownership | X | | | | | | | Synchronize | X | X | X | X | X | X | + + FileSystemRights2 + + FileSystemRights2 + + + None + + + AccessType + + The AccessType parameter determines if the ACE allows or denies the permissions assigned. + + AccessControlType + + AccessControlType + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2[] + + IdentityReference2[] + + + None + + + AppliesTo + + {{ Fill AppliesTo Description }} + + ApplyTo + + ApplyTo + + + None + + + InheritanceFlags + + {{ Fill InheritanceFlags Description }} + + InheritanceFlags + + InheritanceFlags + + + None + + + PassThru + + {{ Fill PassThru Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + PropagationFlags + + {{ Fill PropagationFlags Description }} + + PropagationFlags + + PropagationFlags + + + None + + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + + + + System.String[] + + + + + + + + Security2.FileSystemSecurity2[] + + + + + + + + Security2.IdentityReference2[] + + + + + + + + Security2.FileSystemRights2 + + + + + + + + System.Security.AccessControl.AccessControlType + + + + + + + + System.Security.AccessControl.InheritanceFlags + + + + + + + + System.Security.AccessControl.PropagationFlags + + + + + + + + Security2.ApplyTo + + + + + + + + + + Security2.FileSystemAccessRule2 + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Add-NTFSAccess -Path C:\Data -Account 'NT AUTHORITY\Authenticated Users' -AccessRights Read + + The above command gives the read permissions to the built-in group of 'Authenticated users' + + + + + + + + Add-NTFSAudit + Add + NTFSAudit + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Add-NTFSAudit + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + AccessRights + + {{ Fill AccessRights Description }} + + + None + ReadData + ListDirectory + WriteData + CreateFiles + AppendData + CreateDirectories + ReadExtendedAttributes + WriteExtendedAttributes + ExecuteFile + Traverse + DeleteSubdirectoriesAndFiles + ReadAttributes + WriteAttributes + Write + Delete + ReadPermissions + Read + ReadAndExecute + Modify + ChangePermissions + TakeOwnership + Synchronize + FullControl + GenericAll + GenericExecute + GenericWrite + GenericRead + + FileSystemRights2 + + FileSystemRights2 + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2[] + + IdentityReference2[] + + + None + + + AppliesTo + + {{ Fill AppliesTo Description }} + + + ThisFolderOnly + ThisFolderSubfoldersAndFiles + ThisFolderAndSubfolders + ThisFolderAndFiles + SubfoldersAndFilesOnly + SubfoldersOnly + FilesOnly + ThisFolderSubfoldersAndFilesOneLevel + ThisFolderAndSubfoldersOneLevel + ThisFolderAndFilesOneLevel + SubfoldersAndFilesOnlyOneLevel + SubfoldersOnlyOneLevel + FilesOnlyOneLevel + + ApplyTo + + ApplyTo + + + None + + + AuditFlags + + {{ Fill AuditFlags Description }} + + + None + Success + Failure + + AuditFlags + + AuditFlags + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + + Add-NTFSAudit + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + AccessRights + + {{ Fill AccessRights Description }} + + + None + ReadData + ListDirectory + WriteData + CreateFiles + AppendData + CreateDirectories + ReadExtendedAttributes + WriteExtendedAttributes + ExecuteFile + Traverse + DeleteSubdirectoriesAndFiles + ReadAttributes + WriteAttributes + Write + Delete + ReadPermissions + Read + ReadAndExecute + Modify + ChangePermissions + TakeOwnership + Synchronize + FullControl + GenericAll + GenericExecute + GenericWrite + GenericRead + + FileSystemRights2 + + FileSystemRights2 + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2[] + + IdentityReference2[] + + + None + + + AppliesTo + + {{ Fill AppliesTo Description }} + + + ThisFolderOnly + ThisFolderSubfoldersAndFiles + ThisFolderAndSubfolders + ThisFolderAndFiles + SubfoldersAndFilesOnly + SubfoldersOnly + FilesOnly + ThisFolderSubfoldersAndFilesOneLevel + ThisFolderAndSubfoldersOneLevel + ThisFolderAndFilesOneLevel + SubfoldersAndFilesOnlyOneLevel + SubfoldersOnlyOneLevel + FilesOnlyOneLevel + + ApplyTo + + ApplyTo + + + None + + + AuditFlags + + {{ Fill AuditFlags Description }} + + + None + Success + Failure + + AuditFlags + + AuditFlags + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + + Add-NTFSAudit + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + AccessRights + + {{ Fill AccessRights Description }} + + + None + ReadData + ListDirectory + WriteData + CreateFiles + AppendData + CreateDirectories + ReadExtendedAttributes + WriteExtendedAttributes + ExecuteFile + Traverse + DeleteSubdirectoriesAndFiles + ReadAttributes + WriteAttributes + Write + Delete + ReadPermissions + Read + ReadAndExecute + Modify + ChangePermissions + TakeOwnership + Synchronize + FullControl + GenericAll + GenericExecute + GenericWrite + GenericRead + + FileSystemRights2 + + FileSystemRights2 + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2[] + + IdentityReference2[] + + + None + + + AuditFlags + + {{ Fill AuditFlags Description }} + + + None + Success + Failure + + AuditFlags + + AuditFlags + + + None + + + InheritanceFlags + + {{ Fill InheritanceFlags Description }} + + + None + ContainerInherit + ObjectInherit + + InheritanceFlags + + InheritanceFlags + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + PropagationFlags + + {{ Fill PropagationFlags Description }} + + + None + NoPropagateInherit + InheritOnly + + PropagationFlags + + PropagationFlags + + + None + + + + Add-NTFSAudit + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + AccessRights + + {{ Fill AccessRights Description }} + + + None + ReadData + ListDirectory + WriteData + CreateFiles + AppendData + CreateDirectories + ReadExtendedAttributes + WriteExtendedAttributes + ExecuteFile + Traverse + DeleteSubdirectoriesAndFiles + ReadAttributes + WriteAttributes + Write + Delete + ReadPermissions + Read + ReadAndExecute + Modify + ChangePermissions + TakeOwnership + Synchronize + FullControl + GenericAll + GenericExecute + GenericWrite + GenericRead + + FileSystemRights2 + + FileSystemRights2 + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2[] + + IdentityReference2[] + + + None + + + AuditFlags + + {{ Fill AuditFlags Description }} + + + None + Success + Failure + + AuditFlags + + AuditFlags + + + None + + + InheritanceFlags + + {{ Fill InheritanceFlags Description }} + + + None + ContainerInherit + ObjectInherit + + InheritanceFlags + + InheritanceFlags + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + PropagationFlags + + {{ Fill PropagationFlags Description }} + + + None + NoPropagateInherit + InheritOnly + + PropagationFlags + + PropagationFlags + + + None + + + + + + AccessRights + + {{ Fill AccessRights Description }} + + FileSystemRights2 + + FileSystemRights2 + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2[] + + IdentityReference2[] + + + None + + + AppliesTo + + {{ Fill AppliesTo Description }} + + ApplyTo + + ApplyTo + + + None + + + AuditFlags + + {{ Fill AuditFlags Description }} + + AuditFlags + + AuditFlags + + + None + + + InheritanceFlags + + {{ Fill InheritanceFlags Description }} + + InheritanceFlags + + InheritanceFlags + + + None + + + PassThru + + {{ Fill PassThru Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + PropagationFlags + + {{ Fill PropagationFlags Description }} + + PropagationFlags + + PropagationFlags + + + None + + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + + + + System.String[] + + + + + + + + Security2.FileSystemSecurity2[] + + + + + + + + Security2.IdentityReference2[] + + + + + + + + Security2.FileSystemRights2 + + + + + + + + System.Security.AccessControl.AuditFlags + + + + + + + + System.Security.AccessControl.InheritanceFlags + + + + + + + + System.Security.AccessControl.PropagationFlags + + + + + + + + Security2.ApplyTo + + + + + + + + + + Security2.FileSystemAccessRule2 + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Clear-NTFSAccess + Clear + NTFSAccess + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Clear-NTFSAccess + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + DisableInheritance + + {{ Fill DisableInheritance Description }} + + + SwitchParameter + + + False + + + + Clear-NTFSAccess + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + DisableInheritance + + {{ Fill DisableInheritance Description }} + + + SwitchParameter + + + False + + + + + + DisableInheritance + + {{ Fill DisableInheritance Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + + + + System.String[] + + + + + + + + Security2.FileSystemSecurity2[] + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Clear-NTFSAudit + Clear + NTFSAudit + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Clear-NTFSAudit + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + DisableInheritance + + {{ Fill DisableInheritance Description }} + + + SwitchParameter + + + False + + + + Clear-NTFSAudit + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + DisableInheritance + + {{ Fill DisableInheritance Description }} + + + SwitchParameter + + + False + + + + + + DisableInheritance + + {{ Fill DisableInheritance Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + + + + System.String[] + + + + + + + + Security2.FileSystemSecurity2[] + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Copy-Item2 + Copy + Item2 + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Copy-Item2 + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + Destination + + {{ Fill Destination Description }} + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Force + + {{ Fill Force Description }} + + + SwitchParameter + + + False + + + PassThru + + {{ Fill PassThru Description }} + + Boolean + + Boolean + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Destination + + {{ Fill Destination Description }} + + String + + String + + + None + + + Force + + {{ Fill Force Description }} + + SwitchParameter + + SwitchParameter + + + False + + + PassThru + + {{ Fill PassThru Description }} + + Boolean + + Boolean + + + None + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + + + + System.String[] + + + + + + + + System.String + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Disable-NTFSAccessInheritance + Disable + NTFSAccessInheritance + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Disable-NTFSAccessInheritance + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + RemoveInheritedAccessRules + + {{ Fill RemoveInheritedAccessRules Description }} + + + SwitchParameter + + + False + + + + Disable-NTFSAccessInheritance + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + RemoveInheritedAccessRules + + {{ Fill RemoveInheritedAccessRules Description }} + + + SwitchParameter + + + False + + + + + + PassThru + + {{ Fill PassThru Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + RemoveInheritedAccessRules + + {{ Fill RemoveInheritedAccessRules Description }} + + SwitchParameter + + SwitchParameter + + + False + + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + + + + System.String[] + + + + + + + + Security2.FileSystemSecurity2[] + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Disable-NTFSAuditInheritance + Disable + NTFSAuditInheritance + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Disable-NTFSAuditInheritance + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + RemoveInheritedAccessRules + + {{ Fill RemoveInheritedAccessRules Description }} + + + SwitchParameter + + + False + + + + Disable-NTFSAuditInheritance + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + RemoveInheritedAccessRules + + {{ Fill RemoveInheritedAccessRules Description }} + + + SwitchParameter + + + False + + + + + + PassThru + + {{ Fill PassThru Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + RemoveInheritedAccessRules + + {{ Fill RemoveInheritedAccessRules Description }} + + SwitchParameter + + SwitchParameter + + + False + + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + + + + System.String[] + + + + + + + + Security2.FileSystemSecurity2[] + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Disable-Privileges + Disable + Privileges + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Disable-Privileges + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + + + + PassThru + + {{ Fill PassThru Description }} + + SwitchParameter + + SwitchParameter + + + False + + + + + + None + + + + + + + + + + ProcessPrivileges.PrivilegeAndAttributes + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Enable-NTFSAccessInheritance + Enable + NTFSAccessInheritance + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Enable-NTFSAccessInheritance + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + RemoveExplicitAccessRules + + {{ Fill RemoveExplicitAccessRules Description }} + + + SwitchParameter + + + False + + + + Enable-NTFSAccessInheritance + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + RemoveExplicitAccessRules + + {{ Fill RemoveExplicitAccessRules Description }} + + + SwitchParameter + + + False + + + + + + PassThru + + {{ Fill PassThru Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + RemoveExplicitAccessRules + + {{ Fill RemoveExplicitAccessRules Description }} + + SwitchParameter + + SwitchParameter + + + False + + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + + + + System.String[] + + + + + + + + Security2.FileSystemSecurity2[] + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Enable-NTFSAuditInheritance + Enable + NTFSAuditInheritance + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Enable-NTFSAuditInheritance + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + RemoveExplicitAccessRules + + {{ Fill RemoveExplicitAccessRules Description }} + + + SwitchParameter + + + False + + + + Enable-NTFSAuditInheritance + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + RemoveExplicitAccessRules + + {{ Fill RemoveExplicitAccessRules Description }} + + + SwitchParameter + + + False + + + + + + PassThru + + {{ Fill PassThru Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + RemoveExplicitAccessRules + + {{ Fill RemoveExplicitAccessRules Description }} + + SwitchParameter + + SwitchParameter + + + False + + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + + + + System.String[] + + + + + + + + Security2.FileSystemSecurity2[] + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Enable-Privileges + Enable + Privileges + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Enable-Privileges + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + + + + PassThru + + {{ Fill PassThru Description }} + + SwitchParameter + + SwitchParameter + + + False + + + + + + None + + + + + + + + + + ProcessPrivileges.PrivilegeAndAttributes + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-ChildItem2 + Get + ChildItem2 + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-ChildItem2 + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + Filter + + {{ Fill Filter Description }} + + String + + String + + + None + + + Attributes + + {{ Fill Attributes Description }} + + + ReadOnly + Hidden + System + Directory + Archive + Device + Normal + Temporary + SparseFile + ReparsePoint + Compressed + Offline + NotContentIndexed + Encrypted + IntegrityStream + NoScrubData + + FileAttributes + + FileAttributes + + + None + + + Depth + + {{ Fill Depth Description }} + + Int32 + + Int32 + + + None + + + Directory + + {{ Fill Directory Description }} + + + SwitchParameter + + + False + + + File + + {{ Fill File Description }} + + + SwitchParameter + + + False + + + Force + + {{ Fill Force Description }} + + + SwitchParameter + + + False + + + Hidden + + {{ Fill Hidden Description }} + + + SwitchParameter + + + False + + + ReadOnly + + {{ Fill ReadOnly Description }} + + + SwitchParameter + + + False + + + Recurse + + {{ Fill Recurse Description }} + + + SwitchParameter + + + False + + + SkipMountPoints + + {{ Fill SkipMountPoints Description }} + + + SwitchParameter + + + False + + + SkipSymbolicLinks + + {{ Fill SkipSymbolicLinks Description }} + + + SwitchParameter + + + False + + + System + + {{ Fill System Description }} + + + SwitchParameter + + + False + + + + + + Attributes + + {{ Fill Attributes Description }} + + FileAttributes + + FileAttributes + + + None + + + Depth + + {{ Fill Depth Description }} + + Int32 + + Int32 + + + None + + + Directory + + {{ Fill Directory Description }} + + SwitchParameter + + SwitchParameter + + + False + + + File + + {{ Fill File Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Filter + + {{ Fill Filter Description }} + + String + + String + + + None + + + Force + + {{ Fill Force Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Hidden + + {{ Fill Hidden Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + ReadOnly + + {{ Fill ReadOnly Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Recurse + + {{ Fill Recurse Description }} + + SwitchParameter + + SwitchParameter + + + False + + + SkipMountPoints + + {{ Fill SkipMountPoints Description }} + + SwitchParameter + + SwitchParameter + + + False + + + SkipSymbolicLinks + + {{ Fill SkipSymbolicLinks Description }} + + SwitchParameter + + SwitchParameter + + + False + + + System + + {{ Fill System Description }} + + SwitchParameter + + SwitchParameter + + + False + + + + + + System.String[] + + + + + + + + + + Alphaleonis.Win32.Filesystem.FileInfo + + + + + + + + Alphaleonis.Win32.Filesystem.DirectoryInfo + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-DiskSpace + Get + DiskSpace + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-DiskSpace + + DriveLetter + + {{ Fill DriveLetter Description }} + + String[] + + String[] + + + None + + + + + + DriveLetter + + {{ Fill DriveLetter Description }} + + String[] + + String[] + + + None + + + + + + None + + + + + + + + + + Alphaleonis.Win32.Filesystem.DiskSpaceInfo + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-FileHash2 + Get + FileHash2 + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-FileHash2 + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + Algorithm + + {{ Fill Algorithm Description }} + + + SHA1 + SHA256 + SHA384 + SHA512 + MACTripleDES + MD5 + RIPEMD160 + + HashAlgorithms + + HashAlgorithms + + + None + + + + + + Algorithm + + {{ Fill Algorithm Description }} + + HashAlgorithms + + HashAlgorithms + + + None + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + + + + System.String[] + + + + + + + + Security2.FileSystem.FileInfo.HashAlgorithms + + + + + + + + + + Security2.FileSystemAccessRule2 + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-Item2 + Get + Item2 + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-Item2 + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + + + + System.String[] + + + + + + + + + + Alphaleonis.Win32.Filesystem.FileInfo + + + + + + + + Alphaleonis.Win32.Filesystem.DirectoryInfo + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-NTFSAccess + Get + NTFSAccess + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-NTFSAccess + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2 + + IdentityReference2 + + + None + + + ExcludeExplicit + + {{ Fill ExcludeExplicit Description }} + + + SwitchParameter + + + False + + + ExcludeInherited + + {{ Fill ExcludeInherited Description }} + + + SwitchParameter + + + False + + + + Get-NTFSAccess + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2 + + IdentityReference2 + + + None + + + ExcludeExplicit + + {{ Fill ExcludeExplicit Description }} + + + SwitchParameter + + + False + + + ExcludeInherited + + {{ Fill ExcludeInherited Description }} + + + SwitchParameter + + + False + + + + + + Account + + {{ Fill Account Description }} + + IdentityReference2 + + IdentityReference2 + + + None + + + ExcludeExplicit + + {{ Fill ExcludeExplicit Description }} + + SwitchParameter + + SwitchParameter + + + False + + + ExcludeInherited + + {{ Fill ExcludeInherited Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + + + + System.String[] + + + + + + + + Security2.FileSystemSecurity2[] + + + + + + + + Security2.IdentityReference2 + + + + + + + + + + Security2.FileSystemAccessRule2 + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-NTFSAudit + Get + NTFSAudit + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-NTFSAudit + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2 + + IdentityReference2 + + + None + + + ExcludeExplicit + + {{ Fill ExcludeExplicit Description }} + + + SwitchParameter + + + False + + + ExcludeInherited + + {{ Fill ExcludeInherited Description }} + + + SwitchParameter + + + False + + + + Get-NTFSAudit + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2 + + IdentityReference2 + + + None + + + ExcludeExplicit + + {{ Fill ExcludeExplicit Description }} + + + SwitchParameter + + + False + + + ExcludeInherited + + {{ Fill ExcludeInherited Description }} + + + SwitchParameter + + + False + + + + + + Account + + {{ Fill Account Description }} + + IdentityReference2 + + IdentityReference2 + + + None + + + ExcludeExplicit + + {{ Fill ExcludeExplicit Description }} + + SwitchParameter + + SwitchParameter + + + False + + + ExcludeInherited + + {{ Fill ExcludeInherited Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + + + + System.String[] + + + + + + + + Security2.FileSystemSecurity2[] + + + + + + + + Security2.IdentityReference2 + + + + + + + + + + Security2.FileSystemAuditRule2 + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-NTFSEffectiveAccess + Get + NTFSEffectiveAccess + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-NTFSEffectiveAccess + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2 + + IdentityReference2 + + + None + + + ExcludeNoneAccessEntries + + {{ Fill ExcludeNoneAccessEntries Description }} + + + SwitchParameter + + + False + + + ServerName + + {{ Fill ServerName Description }} + + String + + String + + + None + + + + Get-NTFSEffectiveAccess + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2 + + IdentityReference2 + + + None + + + ExcludeNoneAccessEntries + + {{ Fill ExcludeNoneAccessEntries Description }} + + + SwitchParameter + + + False + + + ServerName + + {{ Fill ServerName Description }} + + String + + String + + + None + + + + + + Account + + {{ Fill Account Description }} + + IdentityReference2 + + IdentityReference2 + + + None + + + ExcludeNoneAccessEntries + + {{ Fill ExcludeNoneAccessEntries Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + ServerName + + {{ Fill ServerName Description }} + + String + + String + + + None + + + + + + System.String[] + + + + + + + + Security2.FileSystemSecurity2[] + + + + + + + + Security2.IdentityReference2 + + + + + + + + + + Security2.FileSystemAccessRule2 + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-NTFSHardLink + Get + NTFSHardLink + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-NTFSHardLink + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + + + + System.String[] + + + + + + + + + + Alphaleonis.Win32.Filesystem.FileInfo + + + + + + + + Alphaleonis.Win32.Filesystem.DirectoryInfo + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-NTFSInheritance + Get + NTFSInheritance + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-NTFSInheritance + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + + Get-NTFSInheritance + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + + + + System.String[] + + + + + + + + Security2.FileSystemSecurity2[] + + + + + + + + + + Security2.FileSystemInheritanceInfo + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-NTFSOrphanedAccess + Get + NTFSOrphanedAccess + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-NTFSOrphanedAccess + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2 + + IdentityReference2 + + + None + + + ExcludeExplicit + + {{ Fill ExcludeExplicit Description }} + + + SwitchParameter + + + False + + + ExcludeInherited + + {{ Fill ExcludeInherited Description }} + + + SwitchParameter + + + False + + + + Get-NTFSOrphanedAccess + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2 + + IdentityReference2 + + + None + + + ExcludeExplicit + + {{ Fill ExcludeExplicit Description }} + + + SwitchParameter + + + False + + + ExcludeInherited + + {{ Fill ExcludeInherited Description }} + + + SwitchParameter + + + False + + + + + + Account + + {{ Fill Account Description }} + + IdentityReference2 + + IdentityReference2 + + + None + + + ExcludeExplicit + + {{ Fill ExcludeExplicit Description }} + + SwitchParameter + + SwitchParameter + + + False + + + ExcludeInherited + + {{ Fill ExcludeInherited Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + + + + System.String[] + + + + + + + + Security2.FileSystemSecurity2[] + + + + + + + + Security2.IdentityReference2 + + + + + + + + + + Security2.FileSystemAccessRule2 + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-NTFSOrphanedAudit + Get + NTFSOrphanedAudit + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-NTFSOrphanedAudit + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2 + + IdentityReference2 + + + None + + + ExcludeExplicit + + {{ Fill ExcludeExplicit Description }} + + + SwitchParameter + + + False + + + ExcludeInherited + + {{ Fill ExcludeInherited Description }} + + + SwitchParameter + + + False + + + + Get-NTFSOrphanedAudit + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2 + + IdentityReference2 + + + None + + + ExcludeExplicit + + {{ Fill ExcludeExplicit Description }} + + + SwitchParameter + + + False + + + ExcludeInherited + + {{ Fill ExcludeInherited Description }} + + + SwitchParameter + + + False + + + + + + Account + + {{ Fill Account Description }} + + IdentityReference2 + + IdentityReference2 + + + None + + + ExcludeExplicit + + {{ Fill ExcludeExplicit Description }} + + SwitchParameter + + SwitchParameter + + + False + + + ExcludeInherited + + {{ Fill ExcludeInherited Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + + + + System.String[] + + + + + + + + Security2.FileSystemSecurity2[] + + + + + + + + Security2.IdentityReference2 + + + + + + + + + + Security2.FileSystemAuditRule2 + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-NTFSOwner + Get + NTFSOwner + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-NTFSOwner + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + + Get-NTFSOwner + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + + + + System.String[] + + + + + + + + Security2.FileSystemSecurity2[] + + + + + + + + + + Security2.FileSystemOwner + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-NTFSSecurityDescriptor + Get + NTFSSecurityDescriptor + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-NTFSSecurityDescriptor + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + + + + System.String[] + + + + + + + + + + Security2.FileSystemSecurity2 + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-NTFSSimpleAccess + Get + NTFSSimpleAccess + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-NTFSSimpleAccess + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2 + + IdentityReference2 + + + None + + + ExcludeExplicit + + {{ Fill ExcludeExplicit Description }} + + + SwitchParameter + + + False + + + ExcludeInherited + + {{ Fill ExcludeInherited Description }} + + + SwitchParameter + + + False + + + IncludeRootFolder + + {{ Fill IncludeRootFolder Description }} + + + SwitchParameter + + + False + + + + Get-NTFSSimpleAccess + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2 + + IdentityReference2 + + + None + + + ExcludeExplicit + + {{ Fill ExcludeExplicit Description }} + + + SwitchParameter + + + False + + + ExcludeInherited + + {{ Fill ExcludeInherited Description }} + + + SwitchParameter + + + False + + + IncludeRootFolder + + {{ Fill IncludeRootFolder Description }} + + + SwitchParameter + + + False + + + + + + Account + + {{ Fill Account Description }} + + IdentityReference2 + + IdentityReference2 + + + None + + + ExcludeExplicit + + {{ Fill ExcludeExplicit Description }} + + SwitchParameter + + SwitchParameter + + + False + + + ExcludeInherited + + {{ Fill ExcludeInherited Description }} + + SwitchParameter + + SwitchParameter + + + False + + + IncludeRootFolder + + {{ Fill IncludeRootFolder Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + + + + System.String[] + + + + + + + + Security2.FileSystemSecurity2[] + + + + + + + + Security2.IdentityReference2 + + + + + + + + + + Security2.SimpleFileSystemAccessRule + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-Privileges + Get + Privileges + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-Privileges + + + + + + + None + + + + + + + + + + ProcessPrivileges.PrivilegeAndAttributes + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Move-Item2 + Move + Item2 + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Move-Item2 + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + Destination + + {{ Fill Destination Description }} + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Force + + {{ Fill Force Description }} + + + SwitchParameter + + + False + + + PassThru + + {{ Fill PassThru Description }} + + Boolean + + Boolean + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Destination + + {{ Fill Destination Description }} + + String + + String + + + None + + + Force + + {{ Fill Force Description }} + + SwitchParameter + + SwitchParameter + + + False + + + PassThru + + {{ Fill PassThru Description }} + + Boolean + + Boolean + + + None + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + + + + System.String[] + + + + + + + + System.String + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + New-NTFSHardLink + New + NTFSHardLink + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + New-NTFSHardLink + + Path + + {{ Fill Path Description }} + + String + + String + + + None + + + Target + + {{ Fill Target Description }} + + String + + String + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + + + + PassThru + + {{ Fill PassThru Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Path + + {{ Fill Path Description }} + + String + + String + + + None + + + Target + + {{ Fill Target Description }} + + String + + String + + + None + + + + + + System.String + + + + + + + + + + Alphaleonis.Win32.Filesystem.FileInfo + + + + + + + + Alphaleonis.Win32.Filesystem.DirectoryInfo + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + New-NTFSSymbolicLink + New + NTFSSymbolicLink + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + New-NTFSSymbolicLink + + Path + + {{ Fill Path Description }} + + String + + String + + + None + + + Target + + {{ Fill Target Description }} + + String + + String + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + + + + PassThru + + {{ Fill PassThru Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Path + + {{ Fill Path Description }} + + String + + String + + + None + + + Target + + {{ Fill Target Description }} + + String + + String + + + None + + + + + + System.String + + + + + + + + + + Alphaleonis.Win32.Filesystem.FileInfo + + + + + + + + Alphaleonis.Win32.Filesystem.DirectoryInfo + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Remove-Item2 + Remove + Item2 + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Remove-Item2 + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Force + + {{ Fill Force Description }} + + + SwitchParameter + + + False + + + PassThur + + {{ Fill PassThur Description }} + + + SwitchParameter + + + False + + + Recurse + + {{ Fill Recurse Description }} + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Force + + {{ Fill Force Description }} + + SwitchParameter + + SwitchParameter + + + False + + + PassThur + + {{ Fill PassThur Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + Recurse + + {{ Fill Recurse Description }} + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + + + + System.String[] + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Remove-NTFSAccess + Remove + NTFSAccess + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Remove-NTFSAccess + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2[] + + IdentityReference2[] + + + None + + + AccessRights + + {{ Fill AccessRights Description }} + + + None + ReadData + ListDirectory + WriteData + CreateFiles + AppendData + CreateDirectories + ReadExtendedAttributes + WriteExtendedAttributes + ExecuteFile + Traverse + DeleteSubdirectoriesAndFiles + ReadAttributes + WriteAttributes + Write + Delete + ReadPermissions + Read + ReadAndExecute + Modify + ChangePermissions + TakeOwnership + Synchronize + FullControl + GenericAll + GenericExecute + GenericWrite + GenericRead + + FileSystemRights2 + + FileSystemRights2 + + + None + + + AccessType + + {{ Fill AccessType Description }} + + + Allow + Deny + + AccessControlType + + AccessControlType + + + None + + + AppliesTo + + {{ Fill AppliesTo Description }} + + + ThisFolderOnly + ThisFolderSubfoldersAndFiles + ThisFolderAndSubfolders + ThisFolderAndFiles + SubfoldersAndFilesOnly + SubfoldersOnly + FilesOnly + ThisFolderSubfoldersAndFilesOneLevel + ThisFolderAndSubfoldersOneLevel + ThisFolderAndFilesOneLevel + SubfoldersAndFilesOnlyOneLevel + SubfoldersOnlyOneLevel + FilesOnlyOneLevel + + ApplyTo + + ApplyTo + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + + Remove-NTFSAccess + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2[] + + IdentityReference2[] + + + None + + + AccessRights + + {{ Fill AccessRights Description }} + + + None + ReadData + ListDirectory + WriteData + CreateFiles + AppendData + CreateDirectories + ReadExtendedAttributes + WriteExtendedAttributes + ExecuteFile + Traverse + DeleteSubdirectoriesAndFiles + ReadAttributes + WriteAttributes + Write + Delete + ReadPermissions + Read + ReadAndExecute + Modify + ChangePermissions + TakeOwnership + Synchronize + FullControl + GenericAll + GenericExecute + GenericWrite + GenericRead + + FileSystemRights2 + + FileSystemRights2 + + + None + + + AccessType + + {{ Fill AccessType Description }} + + + Allow + Deny + + AccessControlType + + AccessControlType + + + None + + + AppliesTo + + {{ Fill AppliesTo Description }} + + + ThisFolderOnly + ThisFolderSubfoldersAndFiles + ThisFolderAndSubfolders + ThisFolderAndFiles + SubfoldersAndFilesOnly + SubfoldersOnly + FilesOnly + ThisFolderSubfoldersAndFilesOneLevel + ThisFolderAndSubfoldersOneLevel + ThisFolderAndFilesOneLevel + SubfoldersAndFilesOnlyOneLevel + SubfoldersOnlyOneLevel + FilesOnlyOneLevel + + ApplyTo + + ApplyTo + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + + Remove-NTFSAccess + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2[] + + IdentityReference2[] + + + None + + + AccessRights + + {{ Fill AccessRights Description }} + + + None + ReadData + ListDirectory + WriteData + CreateFiles + AppendData + CreateDirectories + ReadExtendedAttributes + WriteExtendedAttributes + ExecuteFile + Traverse + DeleteSubdirectoriesAndFiles + ReadAttributes + WriteAttributes + Write + Delete + ReadPermissions + Read + ReadAndExecute + Modify + ChangePermissions + TakeOwnership + Synchronize + FullControl + GenericAll + GenericExecute + GenericWrite + GenericRead + + FileSystemRights2 + + FileSystemRights2 + + + None + + + AccessType + + {{ Fill AccessType Description }} + + + Allow + Deny + + AccessControlType + + AccessControlType + + + None + + + InheritanceFlags + + {{ Fill InheritanceFlags Description }} + + + None + ContainerInherit + ObjectInherit + + InheritanceFlags + + InheritanceFlags + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + PropagationFlags + + {{ Fill PropagationFlags Description }} + + + None + NoPropagateInherit + InheritOnly + + PropagationFlags + + PropagationFlags + + + None + + + + Remove-NTFSAccess + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2[] + + IdentityReference2[] + + + None + + + AccessRights + + {{ Fill AccessRights Description }} + + + None + ReadData + ListDirectory + WriteData + CreateFiles + AppendData + CreateDirectories + ReadExtendedAttributes + WriteExtendedAttributes + ExecuteFile + Traverse + DeleteSubdirectoriesAndFiles + ReadAttributes + WriteAttributes + Write + Delete + ReadPermissions + Read + ReadAndExecute + Modify + ChangePermissions + TakeOwnership + Synchronize + FullControl + GenericAll + GenericExecute + GenericWrite + GenericRead + + FileSystemRights2 + + FileSystemRights2 + + + None + + + AccessType + + {{ Fill AccessType Description }} + + + Allow + Deny + + AccessControlType + + AccessControlType + + + None + + + InheritanceFlags + + {{ Fill InheritanceFlags Description }} + + + None + ContainerInherit + ObjectInherit + + InheritanceFlags + + InheritanceFlags + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + PropagationFlags + + {{ Fill PropagationFlags Description }} + + + None + NoPropagateInherit + InheritOnly + + PropagationFlags + + PropagationFlags + + + None + + + + + + AccessRights + + {{ Fill AccessRights Description }} + + FileSystemRights2 + + FileSystemRights2 + + + None + + + AccessType + + {{ Fill AccessType Description }} + + AccessControlType + + AccessControlType + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2[] + + IdentityReference2[] + + + None + + + AppliesTo + + {{ Fill AppliesTo Description }} + + ApplyTo + + ApplyTo + + + None + + + InheritanceFlags + + {{ Fill InheritanceFlags Description }} + + InheritanceFlags + + InheritanceFlags + + + None + + + PassThru + + {{ Fill PassThru Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + PropagationFlags + + {{ Fill PropagationFlags Description }} + + PropagationFlags + + PropagationFlags + + + None + + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + + + + System.String[] + + + + + + + + Security2.FileSystemSecurity2[] + + + + + + + + Security2.IdentityReference2[] + + + + + + + + Security2.FileSystemRights2 + + + + + + + + System.Security.AccessControl.AccessControlType + + + + + + + + System.Security.AccessControl.InheritanceFlags + + + + + + + + System.Security.AccessControl.PropagationFlags + + + + + + + + Security2.ApplyTo + + + + + + + + + + Security2.FileSystemAccessRule2 + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Remove-NTFSAudit + Remove + NTFSAudit + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Remove-NTFSAudit + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2[] + + IdentityReference2[] + + + None + + + AccessRights + + {{ Fill AccessRights Description }} + + + None + ReadData + ListDirectory + WriteData + CreateFiles + AppendData + CreateDirectories + ReadExtendedAttributes + WriteExtendedAttributes + ExecuteFile + Traverse + DeleteSubdirectoriesAndFiles + ReadAttributes + WriteAttributes + Write + Delete + ReadPermissions + Read + ReadAndExecute + Modify + ChangePermissions + TakeOwnership + Synchronize + FullControl + GenericAll + GenericExecute + GenericWrite + GenericRead + + FileSystemRights2 + + FileSystemRights2 + + + None + + + AppliesTo + + {{ Fill AppliesTo Description }} + + + ThisFolderOnly + ThisFolderSubfoldersAndFiles + ThisFolderAndSubfolders + ThisFolderAndFiles + SubfoldersAndFilesOnly + SubfoldersOnly + FilesOnly + ThisFolderSubfoldersAndFilesOneLevel + ThisFolderAndSubfoldersOneLevel + ThisFolderAndFilesOneLevel + SubfoldersAndFilesOnlyOneLevel + SubfoldersOnlyOneLevel + FilesOnlyOneLevel + + ApplyTo + + ApplyTo + + + None + + + AuditFlags + + {{ Fill AuditFlags Description }} + + + None + Success + Failure + + AuditFlags + + AuditFlags + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + + Remove-NTFSAudit + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2[] + + IdentityReference2[] + + + None + + + AccessRights + + {{ Fill AccessRights Description }} + + + None + ReadData + ListDirectory + WriteData + CreateFiles + AppendData + CreateDirectories + ReadExtendedAttributes + WriteExtendedAttributes + ExecuteFile + Traverse + DeleteSubdirectoriesAndFiles + ReadAttributes + WriteAttributes + Write + Delete + ReadPermissions + Read + ReadAndExecute + Modify + ChangePermissions + TakeOwnership + Synchronize + FullControl + GenericAll + GenericExecute + GenericWrite + GenericRead + + FileSystemRights2 + + FileSystemRights2 + + + None + + + AppliesTo + + {{ Fill AppliesTo Description }} + + + ThisFolderOnly + ThisFolderSubfoldersAndFiles + ThisFolderAndSubfolders + ThisFolderAndFiles + SubfoldersAndFilesOnly + SubfoldersOnly + FilesOnly + ThisFolderSubfoldersAndFilesOneLevel + ThisFolderAndSubfoldersOneLevel + ThisFolderAndFilesOneLevel + SubfoldersAndFilesOnlyOneLevel + SubfoldersOnlyOneLevel + FilesOnlyOneLevel + + ApplyTo + + ApplyTo + + + None + + + AuditFlags + + {{ Fill AuditFlags Description }} + + + None + Success + Failure + + AuditFlags + + AuditFlags + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + + Remove-NTFSAudit + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2[] + + IdentityReference2[] + + + None + + + AccessRights + + {{ Fill AccessRights Description }} + + + None + ReadData + ListDirectory + WriteData + CreateFiles + AppendData + CreateDirectories + ReadExtendedAttributes + WriteExtendedAttributes + ExecuteFile + Traverse + DeleteSubdirectoriesAndFiles + ReadAttributes + WriteAttributes + Write + Delete + ReadPermissions + Read + ReadAndExecute + Modify + ChangePermissions + TakeOwnership + Synchronize + FullControl + GenericAll + GenericExecute + GenericWrite + GenericRead + + FileSystemRights2 + + FileSystemRights2 + + + None + + + AuditFlags + + {{ Fill AuditFlags Description }} + + + None + Success + Failure + + AuditFlags + + AuditFlags + + + None + + + InheritanceFlags + + {{ Fill InheritanceFlags Description }} + + + None + ContainerInherit + ObjectInherit + + InheritanceFlags + + InheritanceFlags + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + PropagationFlags + + {{ Fill PropagationFlags Description }} + + + None + NoPropagateInherit + InheritOnly + + PropagationFlags + + PropagationFlags + + + None + + + + Remove-NTFSAudit + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2[] + + IdentityReference2[] + + + None + + + AccessRights + + {{ Fill AccessRights Description }} + + + None + ReadData + ListDirectory + WriteData + CreateFiles + AppendData + CreateDirectories + ReadExtendedAttributes + WriteExtendedAttributes + ExecuteFile + Traverse + DeleteSubdirectoriesAndFiles + ReadAttributes + WriteAttributes + Write + Delete + ReadPermissions + Read + ReadAndExecute + Modify + ChangePermissions + TakeOwnership + Synchronize + FullControl + GenericAll + GenericExecute + GenericWrite + GenericRead + + FileSystemRights2 + + FileSystemRights2 + + + None + + + AuditFlags + + {{ Fill AuditFlags Description }} + + + None + Success + Failure + + AuditFlags + + AuditFlags + + + None + + + InheritanceFlags + + {{ Fill InheritanceFlags Description }} + + + None + ContainerInherit + ObjectInherit + + InheritanceFlags + + InheritanceFlags + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + PropagationFlags + + {{ Fill PropagationFlags Description }} + + + None + NoPropagateInherit + InheritOnly + + PropagationFlags + + PropagationFlags + + + None + + + + + + AccessRights + + {{ Fill AccessRights Description }} + + FileSystemRights2 + + FileSystemRights2 + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2[] + + IdentityReference2[] + + + None + + + AppliesTo + + {{ Fill AppliesTo Description }} + + ApplyTo + + ApplyTo + + + None + + + AuditFlags + + {{ Fill AuditFlags Description }} + + AuditFlags + + AuditFlags + + + None + + + InheritanceFlags + + {{ Fill InheritanceFlags Description }} + + InheritanceFlags + + InheritanceFlags + + + None + + + PassThru + + {{ Fill PassThru Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + PropagationFlags + + {{ Fill PropagationFlags Description }} + + PropagationFlags + + PropagationFlags + + + None + + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + + + + System.String[] + + + + + + + + Security2.FileSystemSecurity2[] + + + + + + + + Security2.IdentityReference2[] + + + + + + + + Security2.FileSystemRights2 + + + + + + + + System.Security.AccessControl.AuditFlags + + + + + + + + System.Security.AccessControl.InheritanceFlags + + + + + + + + System.Security.AccessControl.PropagationFlags + + + + + + + + Security2.ApplyTo + + + + + + + + + + Security2.FileSystemAccessRule2 + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Set-NTFSInheritance + Set + NTFSInheritance + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Set-NTFSInheritance + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + AccessInheritanceEnabled + + {{ Fill AccessInheritanceEnabled Description }} + + Boolean + + Boolean + + + None + + + AuditInheritanceEnabled + + {{ Fill AuditInheritanceEnabled Description }} + + Boolean + + Boolean + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + + Set-NTFSInheritance + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + AccessInheritanceEnabled + + {{ Fill AccessInheritanceEnabled Description }} + + Boolean + + Boolean + + + None + + + AuditInheritanceEnabled + + {{ Fill AuditInheritanceEnabled Description }} + + Boolean + + Boolean + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + + + + AccessInheritanceEnabled + + {{ Fill AccessInheritanceEnabled Description }} + + Boolean + + Boolean + + + None + + + AuditInheritanceEnabled + + {{ Fill AuditInheritanceEnabled Description }} + + Boolean + + Boolean + + + None + + + PassThru + + {{ Fill PassThru Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + + + + System.String[] + + + + + + + + Security2.FileSystemSecurity2[] + + + + + + + + System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Set-NTFSOwner + Set + NTFSOwner + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Set-NTFSOwner + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2 + + IdentityReference2 + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + + Set-NTFSOwner + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + Account + + {{ Fill Account Description }} + + IdentityReference2 + + IdentityReference2 + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + + + + Account + + {{ Fill Account Description }} + + IdentityReference2 + + IdentityReference2 + + + None + + + PassThru + + {{ Fill PassThru Description }} + + SwitchParameter + + SwitchParameter + + + False + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + + + + System.String[] + + + + + + + + Security2.FileSystemSecurity2[] + + + + + + + + Security2.IdentityReference2 + + + + + + + + + + Security2.FileSystemOwner + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Set-NTFSSecurityDescriptor + Set + NTFSSecurityDescriptor + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Set-NTFSSecurityDescriptor + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + PassThru + + {{ Fill PassThru Description }} + + + SwitchParameter + + + False + + + + + + PassThru + + {{ Fill PassThru Description }} + + SwitchParameter + + SwitchParameter + + + False + + + SecurityDescriptor + + {{ Fill SecurityDescriptor Description }} + + FileSystemSecurity2[] + + FileSystemSecurity2[] + + + None + + + + + + Security2.FileSystemSecurity2[] + + + + + + + + + + Security2.FileSystemSecurity2 + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Test-Path2 + Test + Path2 + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Test-Path2 + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + PathType + + {{ Fill PathType Description }} + + + Any + Container + Leaf + + TestPathType + + TestPathType + + + None + + + + + + Path + + {{ Fill Path Description }} + + String[] + + String[] + + + None + + + PathType + + {{ Fill PathType Description }} + + TestPathType + + TestPathType + + + None + + + + + + System.String[] + + + + + + + + NTFSSecurity.TestPathType + + + + + + + + + + Alphaleonis.Win32.Filesystem.FileInfo + + + + + + + + Alphaleonis.Win32.Filesystem.DirectoryInfo + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + \ No newline at end of file From 3fb4b77a7f8b00968f83eefe6509302443f7c70a Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 21:23:49 +1100 Subject: [PATCH 04/44] Fix to test path --- appveyor.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/appveyor.yml b/appveyor.yml index b7db491..eafbb83 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -10,7 +10,7 @@ init: - ps: git config --global core.autocrlf true build_script: - - ps: Import-Module -Force ./NTFSSecurity/NTFSSecurity.psm1 + - ps: Import-Module -Force NTFSSecurity\NTFSSecurity\NTFSSecurity.psm1 test_script: - ps: | From 38c1bafcde241af81213837272a6a4794661b1ac Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 21:24:58 +1100 Subject: [PATCH 05/44] test path change reverted --- appveyor.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/appveyor.yml b/appveyor.yml index eafbb83..2729cc6 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -10,7 +10,7 @@ init: - ps: git config --global core.autocrlf true build_script: - - ps: Import-Module -Force NTFSSecurity\NTFSSecurity\NTFSSecurity.psm1 + - ps: Import-Module -Force .\NTFSSecurity\NTFSSecurity.psm1 test_script: - ps: | From 7e30dc6abf655d597d01c80cdb7ef085d23de8c4 Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 21:28:55 +1100 Subject: [PATCH 06/44] mocking test --- appveyor.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/appveyor.yml b/appveyor.yml index 2729cc6..46dea40 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -10,7 +10,7 @@ init: - ps: git config --global core.autocrlf true build_script: - - ps: Import-Module -Force .\NTFSSecurity\NTFSSecurity.psm1 + - ps: Import-Module -Force NTFSSecurity test_script: - ps: | From 87f8047749fe6f9e77326ffe1f64fb1e14365d7d Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 21:30:25 +1100 Subject: [PATCH 07/44] import module --- appveyor.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/appveyor.yml b/appveyor.yml index 46dea40..2a37532 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -3,6 +3,7 @@ install: Install-PackageProvider -Name NuGet -MinimumVersion 2.8.5.201 -Force Install-Module platyPS -Force Install-Module MarkdownLinkCheck -Force + Install-Module NTFSSecurity -Force Import-Module platyPS Import-Module MarkdownLinkCheck From 9d54b5b57ff7f17e8d49f10c209a92951d396325 Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 21:35:12 +1100 Subject: [PATCH 08/44] updated markdown links --- Docs/Contributing/01-Getting-Started.md | 6 +++--- Docs/Contributing/02-Writing.md | 4 ++-- Docs/Contributing/03-Style-Guide.md | 0 Docs/Contributing/04-Markdown-Specifics.md | 0 4 files changed, 5 insertions(+), 5 deletions(-) create mode 100644 Docs/Contributing/03-Style-Guide.md create mode 100644 Docs/Contributing/04-Markdown-Specifics.md diff --git a/Docs/Contributing/01-Getting-Started.md b/Docs/Contributing/01-Getting-Started.md index 998fa4d..163cf30 100644 --- a/Docs/Contributing/01-Getting-Started.md +++ b/Docs/Contributing/01-Getting-Started.md @@ -40,14 +40,14 @@ Here is the workflow for making major edits to existing documentation: ## Next steps -See [Writing PowerShell documentation](2-WRITING.md). +See [Writing PowerShell documentation](02-Writing.md). [git-help]: https://help.github.com/ [new-issue]: https://help.github.com/articles/creating-an-issue/ -[doc-issues]: https://github.com/Sup3rlativ3/NTFSAccess-Docs/issues +[doc-issues]: https://github.com/Sup3rlativ3/NTFSAccess/issues [edit-file]: https://help.github.com/articles/editing-files-in-another-user-s-repository/ -[docs-repo]: https://github.com/Sup3rlativ3/NTFSAccess-Docs +[docs-repo]: https://github.com/Sup3rlativ3/NTFSAccess [fork]: https://help.github.com/articles/fork-a-repo/ [clone]: https://help.github.com/articles/cloning-a-repository/ [push]: https://help.github.com/articles/pushing-to-a-remote/ diff --git a/Docs/Contributing/02-Writing.md b/Docs/Contributing/02-Writing.md index f42232e..7ee8b7f 100644 --- a/Docs/Contributing/02-Writing.md +++ b/Docs/Contributing/02-Writing.md @@ -27,7 +27,7 @@ The default Markdown engine in OPS is built on the top of [markdig][]. This engi CommonMark specification and supports extensions for DocFX. In the latest version of the [CommonMark][] specification, many spacing rules have changed. Spaces are significant in Markdown. Don't use hard tabs in Markdown. For more detailed information about the Markdown specification, see the -[Markdown Specifics](4-MARKDOWN-SPECIFICS.md) article. +[Markdown Specifics](04-Markdown-Specifics.md) article. ## Creating new topics @@ -51,7 +51,7 @@ change to each version of the file. ## Next Steps -Read the [Style Guide](3-STYLE-GUIDE.md). +Read the [Style Guide](03-Style-Guide.md). [markdig]: https://github.com/lunet-io/markdig diff --git a/Docs/Contributing/03-Style-Guide.md b/Docs/Contributing/03-Style-Guide.md new file mode 100644 index 0000000..e69de29 diff --git a/Docs/Contributing/04-Markdown-Specifics.md b/Docs/Contributing/04-Markdown-Specifics.md new file mode 100644 index 0000000..e69de29 From 5ff257adf285f1511292b753b0731cc3162d3e8b Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 21:36:54 +1100 Subject: [PATCH 09/44] fix broken dir link --- appveyor.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/appveyor.yml b/appveyor.yml index 2a37532..aedc8fe 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -25,7 +25,7 @@ test_script: } # 02. Verify hyperlinks - $BrokenLinks = Get-MarkdownLink -Path .\Docs -BrokenOnly + $BrokenLinks = Get-MarkdownLink -Path ./Docs -BrokenOnly if ($brokenLinks) { throw "Found broken hyperlinks $brokenLinks" } \ No newline at end of file From 9f0a0f50146d7b2d0b5c59861165cadb1d03ae65 Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 21:39:15 +1100 Subject: [PATCH 10/44] tests --- appveyor.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/appveyor.yml b/appveyor.yml index aedc8fe..0774672 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -28,4 +28,6 @@ test_script: $BrokenLinks = Get-MarkdownLink -Path ./Docs -BrokenOnly if ($brokenLinks) { throw "Found broken hyperlinks $brokenLinks" + $dir = pwd + throw "$pwd" } \ No newline at end of file From 94c9d220f3f02fb61d0f521da03ca729bf483c1d Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 21:40:51 +1100 Subject: [PATCH 11/44] tests --- appveyor.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/appveyor.yml b/appveyor.yml index 0774672..3a47f17 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -27,7 +27,7 @@ test_script: # 02. Verify hyperlinks $BrokenLinks = Get-MarkdownLink -Path ./Docs -BrokenOnly if ($brokenLinks) { - throw "Found broken hyperlinks $brokenLinks" + #throw "Found broken hyperlinks $brokenLinks" $dir = pwd throw "$pwd" } \ No newline at end of file From db01a879d55ba51982e51eb8e19b46bcfcd08b3d Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 21:45:19 +1100 Subject: [PATCH 12/44] markdown link fixes --- Docs/Contributing.md | 4 ++-- appveyor.yml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Docs/Contributing.md b/Docs/Contributing.md index eebc38c..c2f637f 100644 --- a/Docs/Contributing.md +++ b/Docs/Contributing.md @@ -4,7 +4,7 @@ Thank you for your interest in contributing to quality documentations. As an open source project, we welcome input and updates from the community. The following topics explain how to contribute to the NTFSAccess documentation. -1. [Get started](./contributing/1-GET-STARTED.md) -2. [Writing PowerShell documentation](./contributing/2-WRITING.md) +1. [Get started](./contributing/01-Getting-Started.md) +2. [Writing PowerShell documentation](./contributing/02-Writing.md) This contributor guide is a modified version of the one found on the [Powershell Docs](https://github.com/PowerShell/PowerShell-Docs) GitHub page. \ No newline at end of file diff --git a/appveyor.yml b/appveyor.yml index 3a47f17..c7e21f1 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -25,7 +25,7 @@ test_script: } # 02. Verify hyperlinks - $BrokenLinks = Get-MarkdownLink -Path ./Docs -BrokenOnly + $BrokenLinks = Get-MarkdownLink -Path .\Docs\ -BrokenOnly if ($brokenLinks) { #throw "Found broken hyperlinks $brokenLinks" $dir = pwd From a5c06784b68a2ebf4726bfc018bd77070515bf42 Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 21:45:48 +1100 Subject: [PATCH 13/44] fixed test --- appveyor.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/appveyor.yml b/appveyor.yml index c7e21f1..a0573d6 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -27,7 +27,5 @@ test_script: # 02. Verify hyperlinks $BrokenLinks = Get-MarkdownLink -Path .\Docs\ -BrokenOnly if ($brokenLinks) { - #throw "Found broken hyperlinks $brokenLinks" - $dir = pwd - throw "$pwd" + throw "Found broken hyperlinks $brokenLinks" } \ No newline at end of file From 7622e53962944e93484a57b155f5802f54f8442e Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 21:56:46 +1100 Subject: [PATCH 14/44] Added build status badge and fixed some markdown --- Docs/Index.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/Docs/Index.md b/Docs/Index.md index 01935fa..81cf5c7 100644 --- a/Docs/Index.md +++ b/Docs/Index.md @@ -1,25 +1,29 @@ # NTFSSecurity +[![Build status](https://ci.appveyor.com/api/projects/status/2gfb58t9qh655b8x?svg=true)](https://ci.appveyor.com/project/Sup3rlativ3/ntfssecurity) Managing permissions with PowerShell is only a bit easier than in VBS or the command line as there are no cmdlets for most day-to-day tasks like getting a permission report or adding permission to an item. PowerShell only offers Get-Acl and Set-Acl but everything in between getting and setting the ACL is missing. This module closes the gap. [Version History](https://github.com/raandree/NTFSSecurity/wiki/Version-History) ## Installation + You have two options: * Download the latest release from the [releases](https://github.com/raandree/NTFSSecurity/releases) section on GitHub. * Download the module from the [PowerShell Gallery](https://www.powershellgallery.com/packages/NTFSSecurity): -``` -Install-Module -Name NTFSSecurity + +```PowerShell +Install-Module -Name NTFSSecurity ``` Further help can be found in How to install if you face difficulties getting this module installed. ## Documentation + The cmdlets are yet not documented completely so Get-Help will not show help for all the cmdlets. Providing documentation is planned though. -## Additional documentation is available: +## Additional documentation is available -[NTFSSecurity Tutorial 1 - Getting, adding and removing permissions](http://blogs.technet.com/b/fieldcoding/archive/2014/12/05/ntfssecurity-tutorial-1-getting-adding-and-removing-permissions.aspx) +[NTFSSecurity Tutorial 1 - Getting, adding and removing permissions](http://blogs.technet.com/b/fieldcoding/archive/2014/12/05/ntfssecurity-tutorial-1-getting-adding-and-removing-permissions.aspx) [NTFSSecurity Tutorial 2 - Managing NTFS Inheritance and Using Privileges](http://blogs.technet.com/b/fieldcoding/archive/2014/12/05/ntfssecurity-tutorial-2-managing-ntfs-inheritance-and-using-privileges.aspx) From 7271d60c2678cbec300ad18337a882c90e482466 Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 22:01:59 +1100 Subject: [PATCH 15/44] typo --- mkdocs.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index e2aebeb..67cb3f9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,7 @@ copyright: NTFSSecurity is licensed under the MIT license repo_url: https://github.com/raandree/NTFSSecurity nav: -- Home: index.md +- Home: Index.md - Cmdlets: - Add-NTFSAccess: Cmdlets/Add-NTFSAccess.md - Add-NTFSAudit: Cmdlets/Add-NTFSAudit.md @@ -42,7 +42,8 @@ nav: - License: License.md - Contributing: - Getting Started: Contributing/01-Getting-Started.md - - Writing: /Contributing/02-Writing.md + - Writing: /Contributing/02-Writing.md + site_name: NTFSSecurity theme: readthedocs site_author: Raimund Andrée, James Smith From 77c9691c17ce494c0f3aac7b1f97c4ea349c382e Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 22:10:04 +1100 Subject: [PATCH 16/44] rtd fixes --- Docs/Index.md | 2 +- mkdocs.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Docs/Index.md b/Docs/Index.md index 81cf5c7..3307a42 100644 --- a/Docs/Index.md +++ b/Docs/Index.md @@ -11,7 +11,7 @@ Managing permissions with PowerShell is only a bit easier than in VBS or the com You have two options: * Download the latest release from the [releases](https://github.com/raandree/NTFSSecurity/releases) section on GitHub. -* Download the module from the [PowerShell Gallery](https://www.powershellgallery.com/packages/NTFSSecurity): +* Download the module from the [PowerShell Gallery](https://www.powershellgallery.com/packages/NTFSSecurity): ```PowerShell Install-Module -Name NTFSSecurity diff --git a/mkdocs.yml b/mkdocs.yml index 67cb3f9..f39052b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -48,4 +48,4 @@ site_name: NTFSSecurity theme: readthedocs site_author: Raimund Andrée, James Smith edit_uri: edit/master/Help/ -docs_dir: Docs \ No newline at end of file +docs_dir: ./Docs \ No newline at end of file From 19bc63499538c7227dfaead0adacbd064c82792e Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 22:15:01 +1100 Subject: [PATCH 17/44] updated licence text --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index f39052b..65b422c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,4 @@ -copyright: NTFSSecurity is licensed under the MIT license +copyright: The NTFSSecurity module is licensed under the MIT license repo_url: https://github.com/raandree/NTFSSecurity nav: - Home: Index.md From 48a626dcb5c33a3e170f1734f940cb506bd9ba79 Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 22:17:36 +1100 Subject: [PATCH 18/44] licence link --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 65b422c..e66373c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -39,7 +39,7 @@ nav: - Set-NTFSOwner: Cmdlets/Set-NTFSOwner.md - Set-NTFSSecurityDescriptor: Cmdlets/Set-NTFSSecurityDescriptor.md - Test-Path2: Cmdlets/Test-Path2.md -- License: License.md +- License: ../../License.md - Contributing: - Getting Started: Contributing/01-Getting-Started.md - Writing: /Contributing/02-Writing.md From d5486485735aa7ceb710c203fd30073ff6b6dca0 Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 22:19:32 +1100 Subject: [PATCH 19/44] test --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index e66373c..bc3926d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -39,7 +39,7 @@ nav: - Set-NTFSOwner: Cmdlets/Set-NTFSOwner.md - Set-NTFSSecurityDescriptor: Cmdlets/Set-NTFSSecurityDescriptor.md - Test-Path2: Cmdlets/Test-Path2.md -- License: ../../License.md +#- License: ../../License.md - Contributing: - Getting Started: Contributing/01-Getting-Started.md - Writing: /Contributing/02-Writing.md From f050cb663ce4b5f20b44177ac775718d6947dce4 Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 23:03:39 +1100 Subject: [PATCH 20/44] rtd fix --- mkdocs.yml | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index bc3926d..f4dfd2a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,7 @@ copyright: The NTFSSecurity module is licensed under the MIT license repo_url: https://github.com/raandree/NTFSSecurity nav: -- Home: Index.md +- Home: index.md - Cmdlets: - Add-NTFSAccess: Cmdlets/Add-NTFSAccess.md - Add-NTFSAudit: Cmdlets/Add-NTFSAudit.md @@ -39,13 +39,11 @@ nav: - Set-NTFSOwner: Cmdlets/Set-NTFSOwner.md - Set-NTFSSecurityDescriptor: Cmdlets/Set-NTFSSecurityDescriptor.md - Test-Path2: Cmdlets/Test-Path2.md -#- License: ../../License.md - Contributing: - Getting Started: Contributing/01-Getting-Started.md - Writing: /Contributing/02-Writing.md - site_name: NTFSSecurity theme: readthedocs site_author: Raimund Andrée, James Smith edit_uri: edit/master/Help/ -docs_dir: ./Docs \ No newline at end of file +docs_dir: Docs \ No newline at end of file From 7a929de121af42af26f8a788681133364f65d7bd Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 23:11:02 +1100 Subject: [PATCH 21/44] index --- Docs/Index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Docs/Index.md b/Docs/Index.md index 3307a42..da66399 100644 --- a/Docs/Index.md +++ b/Docs/Index.md @@ -2,7 +2,7 @@ [![Build status](https://ci.appveyor.com/api/projects/status/2gfb58t9qh655b8x?svg=true)](https://ci.appveyor.com/project/Sup3rlativ3/ntfssecurity) -Managing permissions with PowerShell is only a bit easier than in VBS or the command line as there are no cmdlets for most day-to-day tasks like getting a permission report or adding permission to an item. PowerShell only offers Get-Acl and Set-Acl but everything in between getting and setting the ACL is missing. This module closes the gap. +Managing file & folder permissions with PowerShell is only a bit easier than in VBS or the command line as there are no cmdlets for most day-to-day tasks like getting a permission report or adding permission to an item. PowerShell only offers Get-Acl and Set-Acl but everything in between getting and setting the ACL is missing. This module closes the gap. [Version History](https://github.com/raandree/NTFSSecurity/wiki/Version-History) From 0e51791aa8446643b6dcf321ce2e1f5d85a75d47 Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 23:15:49 +1100 Subject: [PATCH 22/44] docs dir rtd --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index f4dfd2a..677e8e6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -46,4 +46,4 @@ site_name: NTFSSecurity theme: readthedocs site_author: Raimund Andrée, James Smith edit_uri: edit/master/Help/ -docs_dir: Docs \ No newline at end of file +docs_dir: ./Docs \ No newline at end of file From f3ce0c0a8137d97ebe9e284bd29c04659d3a26c6 Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 23:26:51 +1100 Subject: [PATCH 23/44] rtd fix --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 677e8e6..73e24fd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,7 @@ copyright: The NTFSSecurity module is licensed under the MIT license repo_url: https://github.com/raandree/NTFSSecurity nav: -- Home: index.md +- Home: ./Index.md - Cmdlets: - Add-NTFSAccess: Cmdlets/Add-NTFSAccess.md - Add-NTFSAudit: Cmdlets/Add-NTFSAudit.md From e105d178fcbc462d5f207cd9bdb1170657c483d9 Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 23:27:43 +1100 Subject: [PATCH 24/44] rtd fixes --- Docs/Contributing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Docs/Contributing.md b/Docs/Contributing.md index c2f637f..b616d31 100644 --- a/Docs/Contributing.md +++ b/Docs/Contributing.md @@ -4,7 +4,7 @@ Thank you for your interest in contributing to quality documentations. As an open source project, we welcome input and updates from the community. The following topics explain how to contribute to the NTFSAccess documentation. -1. [Get started](./contributing/01-Getting-Started.md) -2. [Writing PowerShell documentation](./contributing/02-Writing.md) +1. [Get started](./Contributing/01-Getting-Started.md) +2. [Writing PowerShell documentation](./Contributing/02-Writing.md) This contributor guide is a modified version of the one found on the [Powershell Docs](https://github.com/PowerShell/PowerShell-Docs) GitHub page. \ No newline at end of file From e9e8f3f98b546e31ac5e36d31a835b1e3fa2f493 Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 23:30:44 +1100 Subject: [PATCH 25/44] rtd fixes --- mkdocs.yml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 73e24fd..4fa1827 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -39,9 +39,11 @@ nav: - Set-NTFSOwner: Cmdlets/Set-NTFSOwner.md - Set-NTFSSecurityDescriptor: Cmdlets/Set-NTFSSecurityDescriptor.md - Test-Path2: Cmdlets/Test-Path2.md -- Contributing: +- Contributing: Contributing.md - Getting Started: Contributing/01-Getting-Started.md - - Writing: /Contributing/02-Writing.md + - Writing: Contributing/02-Writing.md + - Style Guide: Contributing/03-Style-Guide.md + - Markdown Specifics: Contributing:04-Markdown-Specifics.md site_name: NTFSSecurity theme: readthedocs site_author: Raimund Andrée, James Smith From c8267a2bbc162846450fc7ce187c0462829d3130 Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 23:32:49 +1100 Subject: [PATCH 26/44] rtd fix --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 4fa1827..78d8a1b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -39,7 +39,7 @@ nav: - Set-NTFSOwner: Cmdlets/Set-NTFSOwner.md - Set-NTFSSecurityDescriptor: Cmdlets/Set-NTFSSecurityDescriptor.md - Test-Path2: Cmdlets/Test-Path2.md -- Contributing: Contributing.md +- Contributing: - Getting Started: Contributing/01-Getting-Started.md - Writing: Contributing/02-Writing.md - Style Guide: Contributing/03-Style-Guide.md From 790f9631540096508e045c48c448e8fc9f1ce8e6 Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 23:36:42 +1100 Subject: [PATCH 27/44] rtd fixes --- Out/NTFSSecurity.dll-Help.xml | 8110 --------------------------------- mkdocs.bak | 51 + mkdocs.yml | 43 - 3 files changed, 51 insertions(+), 8153 deletions(-) delete mode 100644 Out/NTFSSecurity.dll-Help.xml create mode 100644 mkdocs.bak diff --git a/Out/NTFSSecurity.dll-Help.xml b/Out/NTFSSecurity.dll-Help.xml deleted file mode 100644 index f5a8221..0000000 --- a/Out/NTFSSecurity.dll-Help.xml +++ /dev/null @@ -1,8110 +0,0 @@ - - - - - Add-NTFSAccess - Add - NTFSAccess - - Adds an access control entry (ACE) to an object. - - - - Adds an access control entry (ACE) to an object such as a file or folder. Other examples would be an object inside of Active Directory. - - - - Add-NTFSAccess - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2[] - - IdentityReference2[] - - - None - - - AccessRights - - The AccessRights parameter designates the permissions to assign. There are individual permissions as well as 'basic' permissions. See the below table for how the basic permissions permissions map the the advanced permissions. - | Permissions | Basic Full Control | Basic Modify | Basic Read & Execute | Basic List Folder Contents | Basic Read | Basic Write | |:---------------------------: |:------------------: |:------------: |:--------------------: |:--------------------------: |:----------: |:-----------: | | Travers Folder/Execute | X | X | X | X | | | | List Folder/ Read Data | X | X | X | X | X | | | Read Attributes | X | X | X | X | X | | | Read Extended Attributes | X | X | X | X | X | | | Create Files/Write Data | X | X | | | | X | | Create Folders/Append Data | X | X | | | | X | | Write Attributes | X | X | | | | X | | Write Extended Attributes | X | X | | | | X | | Delete Subfolders and Files | X | | | | | | | Delete | X | X | | | | | | Read Permissions | X | X | X | X | X | X | | Change Permissions | X | | | | | | | Take Ownership | X | | | | | | | Synchronize | X | X | X | X | X | X | - - - None - ReadData - ListDirectory - WriteData - CreateFiles - AppendData - CreateDirectories - ReadExtendedAttributes - WriteExtendedAttributes - ExecuteFile - Traverse - DeleteSubdirectoriesAndFiles - ReadAttributes - WriteAttributes - Write - Delete - ReadPermissions - Read - ReadAndExecute - Modify - ChangePermissions - TakeOwnership - Synchronize - FullControl - GenericAll - GenericExecute - GenericWrite - GenericRead - - FileSystemRights2 - - FileSystemRights2 - - - None - - - AccessType - - The AccessType parameter determines if the ACE allows or denies the permissions assigned. - - - Allow - Deny - - AccessControlType - - AccessControlType - - - None - - - AppliesTo - - {{ Fill AppliesTo Description }} - - - ThisFolderOnly - ThisFolderSubfoldersAndFiles - ThisFolderAndSubfolders - ThisFolderAndFiles - SubfoldersAndFilesOnly - SubfoldersOnly - FilesOnly - ThisFolderSubfoldersAndFilesOneLevel - ThisFolderAndSubfoldersOneLevel - ThisFolderAndFilesOneLevel - SubfoldersAndFilesOnlyOneLevel - SubfoldersOnlyOneLevel - FilesOnlyOneLevel - - ApplyTo - - ApplyTo - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - - Add-NTFSAccess - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2[] - - IdentityReference2[] - - - None - - - AccessRights - - The AccessRights parameter designates the permissions to assign. There are individual permissions as well as 'basic' permissions. See the below table for how the basic permissions permissions map the the advanced permissions. - | Permissions | Basic Full Control | Basic Modify | Basic Read & Execute | Basic List Folder Contents | Basic Read | Basic Write | |:---------------------------: |:------------------: |:------------: |:--------------------: |:--------------------------: |:----------: |:-----------: | | Travers Folder/Execute | X | X | X | X | | | | List Folder/ Read Data | X | X | X | X | X | | | Read Attributes | X | X | X | X | X | | | Read Extended Attributes | X | X | X | X | X | | | Create Files/Write Data | X | X | | | | X | | Create Folders/Append Data | X | X | | | | X | | Write Attributes | X | X | | | | X | | Write Extended Attributes | X | X | | | | X | | Delete Subfolders and Files | X | | | | | | | Delete | X | X | | | | | | Read Permissions | X | X | X | X | X | X | | Change Permissions | X | | | | | | | Take Ownership | X | | | | | | | Synchronize | X | X | X | X | X | X | - - - None - ReadData - ListDirectory - WriteData - CreateFiles - AppendData - CreateDirectories - ReadExtendedAttributes - WriteExtendedAttributes - ExecuteFile - Traverse - DeleteSubdirectoriesAndFiles - ReadAttributes - WriteAttributes - Write - Delete - ReadPermissions - Read - ReadAndExecute - Modify - ChangePermissions - TakeOwnership - Synchronize - FullControl - GenericAll - GenericExecute - GenericWrite - GenericRead - - FileSystemRights2 - - FileSystemRights2 - - - None - - - AccessType - - The AccessType parameter determines if the ACE allows or denies the permissions assigned. - - - Allow - Deny - - AccessControlType - - AccessControlType - - - None - - - AppliesTo - - {{ Fill AppliesTo Description }} - - - ThisFolderOnly - ThisFolderSubfoldersAndFiles - ThisFolderAndSubfolders - ThisFolderAndFiles - SubfoldersAndFilesOnly - SubfoldersOnly - FilesOnly - ThisFolderSubfoldersAndFilesOneLevel - ThisFolderAndSubfoldersOneLevel - ThisFolderAndFilesOneLevel - SubfoldersAndFilesOnlyOneLevel - SubfoldersOnlyOneLevel - FilesOnlyOneLevel - - ApplyTo - - ApplyTo - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - - Add-NTFSAccess - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2[] - - IdentityReference2[] - - - None - - - AccessRights - - The AccessRights parameter designates the permissions to assign. There are individual permissions as well as 'basic' permissions. See the below table for how the basic permissions permissions map the the advanced permissions. - | Permissions | Basic Full Control | Basic Modify | Basic Read & Execute | Basic List Folder Contents | Basic Read | Basic Write | |:---------------------------: |:------------------: |:------------: |:--------------------: |:--------------------------: |:----------: |:-----------: | | Travers Folder/Execute | X | X | X | X | | | | List Folder/ Read Data | X | X | X | X | X | | | Read Attributes | X | X | X | X | X | | | Read Extended Attributes | X | X | X | X | X | | | Create Files/Write Data | X | X | | | | X | | Create Folders/Append Data | X | X | | | | X | | Write Attributes | X | X | | | | X | | Write Extended Attributes | X | X | | | | X | | Delete Subfolders and Files | X | | | | | | | Delete | X | X | | | | | | Read Permissions | X | X | X | X | X | X | | Change Permissions | X | | | | | | | Take Ownership | X | | | | | | | Synchronize | X | X | X | X | X | X | - - - None - ReadData - ListDirectory - WriteData - CreateFiles - AppendData - CreateDirectories - ReadExtendedAttributes - WriteExtendedAttributes - ExecuteFile - Traverse - DeleteSubdirectoriesAndFiles - ReadAttributes - WriteAttributes - Write - Delete - ReadPermissions - Read - ReadAndExecute - Modify - ChangePermissions - TakeOwnership - Synchronize - FullControl - GenericAll - GenericExecute - GenericWrite - GenericRead - - FileSystemRights2 - - FileSystemRights2 - - - None - - - AccessType - - The AccessType parameter determines if the ACE allows or denies the permissions assigned. - - - Allow - Deny - - AccessControlType - - AccessControlType - - - None - - - InheritanceFlags - - {{ Fill InheritanceFlags Description }} - - - None - ContainerInherit - ObjectInherit - - InheritanceFlags - - InheritanceFlags - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - PropagationFlags - - {{ Fill PropagationFlags Description }} - - - None - NoPropagateInherit - InheritOnly - - PropagationFlags - - PropagationFlags - - - None - - - - Add-NTFSAccess - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2[] - - IdentityReference2[] - - - None - - - AccessRights - - The AccessRights parameter designates the permissions to assign. There are individual permissions as well as 'basic' permissions. See the below table for how the basic permissions permissions map the the advanced permissions. - | Permissions | Basic Full Control | Basic Modify | Basic Read & Execute | Basic List Folder Contents | Basic Read | Basic Write | |:---------------------------: |:------------------: |:------------: |:--------------------: |:--------------------------: |:----------: |:-----------: | | Travers Folder/Execute | X | X | X | X | | | | List Folder/ Read Data | X | X | X | X | X | | | Read Attributes | X | X | X | X | X | | | Read Extended Attributes | X | X | X | X | X | | | Create Files/Write Data | X | X | | | | X | | Create Folders/Append Data | X | X | | | | X | | Write Attributes | X | X | | | | X | | Write Extended Attributes | X | X | | | | X | | Delete Subfolders and Files | X | | | | | | | Delete | X | X | | | | | | Read Permissions | X | X | X | X | X | X | | Change Permissions | X | | | | | | | Take Ownership | X | | | | | | | Synchronize | X | X | X | X | X | X | - - - None - ReadData - ListDirectory - WriteData - CreateFiles - AppendData - CreateDirectories - ReadExtendedAttributes - WriteExtendedAttributes - ExecuteFile - Traverse - DeleteSubdirectoriesAndFiles - ReadAttributes - WriteAttributes - Write - Delete - ReadPermissions - Read - ReadAndExecute - Modify - ChangePermissions - TakeOwnership - Synchronize - FullControl - GenericAll - GenericExecute - GenericWrite - GenericRead - - FileSystemRights2 - - FileSystemRights2 - - - None - - - AccessType - - The AccessType parameter determines if the ACE allows or denies the permissions assigned. - - - Allow - Deny - - AccessControlType - - AccessControlType - - - None - - - InheritanceFlags - - {{ Fill InheritanceFlags Description }} - - - None - ContainerInherit - ObjectInherit - - InheritanceFlags - - InheritanceFlags - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - PropagationFlags - - {{ Fill PropagationFlags Description }} - - - None - NoPropagateInherit - InheritOnly - - PropagationFlags - - PropagationFlags - - - None - - - - - - AccessRights - - The AccessRights parameter designates the permissions to assign. There are individual permissions as well as 'basic' permissions. See the below table for how the basic permissions permissions map the the advanced permissions. - | Permissions | Basic Full Control | Basic Modify | Basic Read & Execute | Basic List Folder Contents | Basic Read | Basic Write | |:---------------------------: |:------------------: |:------------: |:--------------------: |:--------------------------: |:----------: |:-----------: | | Travers Folder/Execute | X | X | X | X | | | | List Folder/ Read Data | X | X | X | X | X | | | Read Attributes | X | X | X | X | X | | | Read Extended Attributes | X | X | X | X | X | | | Create Files/Write Data | X | X | | | | X | | Create Folders/Append Data | X | X | | | | X | | Write Attributes | X | X | | | | X | | Write Extended Attributes | X | X | | | | X | | Delete Subfolders and Files | X | | | | | | | Delete | X | X | | | | | | Read Permissions | X | X | X | X | X | X | | Change Permissions | X | | | | | | | Take Ownership | X | | | | | | | Synchronize | X | X | X | X | X | X | - - FileSystemRights2 - - FileSystemRights2 - - - None - - - AccessType - - The AccessType parameter determines if the ACE allows or denies the permissions assigned. - - AccessControlType - - AccessControlType - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2[] - - IdentityReference2[] - - - None - - - AppliesTo - - {{ Fill AppliesTo Description }} - - ApplyTo - - ApplyTo - - - None - - - InheritanceFlags - - {{ Fill InheritanceFlags Description }} - - InheritanceFlags - - InheritanceFlags - - - None - - - PassThru - - {{ Fill PassThru Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - PropagationFlags - - {{ Fill PropagationFlags Description }} - - PropagationFlags - - PropagationFlags - - - None - - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - - - - System.String[] - - - - - - - - Security2.FileSystemSecurity2[] - - - - - - - - Security2.IdentityReference2[] - - - - - - - - Security2.FileSystemRights2 - - - - - - - - System.Security.AccessControl.AccessControlType - - - - - - - - System.Security.AccessControl.InheritanceFlags - - - - - - - - System.Security.AccessControl.PropagationFlags - - - - - - - - Security2.ApplyTo - - - - - - - - - - Security2.FileSystemAccessRule2 - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> Add-NTFSAccess -Path C:\Data -Account 'NT AUTHORITY\Authenticated Users' -AccessRights Read - - The above command gives the read permissions to the built-in group of 'Authenticated users' - - - - - - - - Add-NTFSAudit - Add - NTFSAudit - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Add-NTFSAudit - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - AccessRights - - {{ Fill AccessRights Description }} - - - None - ReadData - ListDirectory - WriteData - CreateFiles - AppendData - CreateDirectories - ReadExtendedAttributes - WriteExtendedAttributes - ExecuteFile - Traverse - DeleteSubdirectoriesAndFiles - ReadAttributes - WriteAttributes - Write - Delete - ReadPermissions - Read - ReadAndExecute - Modify - ChangePermissions - TakeOwnership - Synchronize - FullControl - GenericAll - GenericExecute - GenericWrite - GenericRead - - FileSystemRights2 - - FileSystemRights2 - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2[] - - IdentityReference2[] - - - None - - - AppliesTo - - {{ Fill AppliesTo Description }} - - - ThisFolderOnly - ThisFolderSubfoldersAndFiles - ThisFolderAndSubfolders - ThisFolderAndFiles - SubfoldersAndFilesOnly - SubfoldersOnly - FilesOnly - ThisFolderSubfoldersAndFilesOneLevel - ThisFolderAndSubfoldersOneLevel - ThisFolderAndFilesOneLevel - SubfoldersAndFilesOnlyOneLevel - SubfoldersOnlyOneLevel - FilesOnlyOneLevel - - ApplyTo - - ApplyTo - - - None - - - AuditFlags - - {{ Fill AuditFlags Description }} - - - None - Success - Failure - - AuditFlags - - AuditFlags - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - - Add-NTFSAudit - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - AccessRights - - {{ Fill AccessRights Description }} - - - None - ReadData - ListDirectory - WriteData - CreateFiles - AppendData - CreateDirectories - ReadExtendedAttributes - WriteExtendedAttributes - ExecuteFile - Traverse - DeleteSubdirectoriesAndFiles - ReadAttributes - WriteAttributes - Write - Delete - ReadPermissions - Read - ReadAndExecute - Modify - ChangePermissions - TakeOwnership - Synchronize - FullControl - GenericAll - GenericExecute - GenericWrite - GenericRead - - FileSystemRights2 - - FileSystemRights2 - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2[] - - IdentityReference2[] - - - None - - - AppliesTo - - {{ Fill AppliesTo Description }} - - - ThisFolderOnly - ThisFolderSubfoldersAndFiles - ThisFolderAndSubfolders - ThisFolderAndFiles - SubfoldersAndFilesOnly - SubfoldersOnly - FilesOnly - ThisFolderSubfoldersAndFilesOneLevel - ThisFolderAndSubfoldersOneLevel - ThisFolderAndFilesOneLevel - SubfoldersAndFilesOnlyOneLevel - SubfoldersOnlyOneLevel - FilesOnlyOneLevel - - ApplyTo - - ApplyTo - - - None - - - AuditFlags - - {{ Fill AuditFlags Description }} - - - None - Success - Failure - - AuditFlags - - AuditFlags - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - - Add-NTFSAudit - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - AccessRights - - {{ Fill AccessRights Description }} - - - None - ReadData - ListDirectory - WriteData - CreateFiles - AppendData - CreateDirectories - ReadExtendedAttributes - WriteExtendedAttributes - ExecuteFile - Traverse - DeleteSubdirectoriesAndFiles - ReadAttributes - WriteAttributes - Write - Delete - ReadPermissions - Read - ReadAndExecute - Modify - ChangePermissions - TakeOwnership - Synchronize - FullControl - GenericAll - GenericExecute - GenericWrite - GenericRead - - FileSystemRights2 - - FileSystemRights2 - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2[] - - IdentityReference2[] - - - None - - - AuditFlags - - {{ Fill AuditFlags Description }} - - - None - Success - Failure - - AuditFlags - - AuditFlags - - - None - - - InheritanceFlags - - {{ Fill InheritanceFlags Description }} - - - None - ContainerInherit - ObjectInherit - - InheritanceFlags - - InheritanceFlags - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - PropagationFlags - - {{ Fill PropagationFlags Description }} - - - None - NoPropagateInherit - InheritOnly - - PropagationFlags - - PropagationFlags - - - None - - - - Add-NTFSAudit - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - AccessRights - - {{ Fill AccessRights Description }} - - - None - ReadData - ListDirectory - WriteData - CreateFiles - AppendData - CreateDirectories - ReadExtendedAttributes - WriteExtendedAttributes - ExecuteFile - Traverse - DeleteSubdirectoriesAndFiles - ReadAttributes - WriteAttributes - Write - Delete - ReadPermissions - Read - ReadAndExecute - Modify - ChangePermissions - TakeOwnership - Synchronize - FullControl - GenericAll - GenericExecute - GenericWrite - GenericRead - - FileSystemRights2 - - FileSystemRights2 - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2[] - - IdentityReference2[] - - - None - - - AuditFlags - - {{ Fill AuditFlags Description }} - - - None - Success - Failure - - AuditFlags - - AuditFlags - - - None - - - InheritanceFlags - - {{ Fill InheritanceFlags Description }} - - - None - ContainerInherit - ObjectInherit - - InheritanceFlags - - InheritanceFlags - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - PropagationFlags - - {{ Fill PropagationFlags Description }} - - - None - NoPropagateInherit - InheritOnly - - PropagationFlags - - PropagationFlags - - - None - - - - - - AccessRights - - {{ Fill AccessRights Description }} - - FileSystemRights2 - - FileSystemRights2 - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2[] - - IdentityReference2[] - - - None - - - AppliesTo - - {{ Fill AppliesTo Description }} - - ApplyTo - - ApplyTo - - - None - - - AuditFlags - - {{ Fill AuditFlags Description }} - - AuditFlags - - AuditFlags - - - None - - - InheritanceFlags - - {{ Fill InheritanceFlags Description }} - - InheritanceFlags - - InheritanceFlags - - - None - - - PassThru - - {{ Fill PassThru Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - PropagationFlags - - {{ Fill PropagationFlags Description }} - - PropagationFlags - - PropagationFlags - - - None - - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - - - - System.String[] - - - - - - - - Security2.FileSystemSecurity2[] - - - - - - - - Security2.IdentityReference2[] - - - - - - - - Security2.FileSystemRights2 - - - - - - - - System.Security.AccessControl.AuditFlags - - - - - - - - System.Security.AccessControl.InheritanceFlags - - - - - - - - System.Security.AccessControl.PropagationFlags - - - - - - - - Security2.ApplyTo - - - - - - - - - - Security2.FileSystemAccessRule2 - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Clear-NTFSAccess - Clear - NTFSAccess - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Clear-NTFSAccess - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - DisableInheritance - - {{ Fill DisableInheritance Description }} - - - SwitchParameter - - - False - - - - Clear-NTFSAccess - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - DisableInheritance - - {{ Fill DisableInheritance Description }} - - - SwitchParameter - - - False - - - - - - DisableInheritance - - {{ Fill DisableInheritance Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - - - - System.String[] - - - - - - - - Security2.FileSystemSecurity2[] - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Clear-NTFSAudit - Clear - NTFSAudit - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Clear-NTFSAudit - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - DisableInheritance - - {{ Fill DisableInheritance Description }} - - - SwitchParameter - - - False - - - - Clear-NTFSAudit - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - DisableInheritance - - {{ Fill DisableInheritance Description }} - - - SwitchParameter - - - False - - - - - - DisableInheritance - - {{ Fill DisableInheritance Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - - - - System.String[] - - - - - - - - Security2.FileSystemSecurity2[] - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Copy-Item2 - Copy - Item2 - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Copy-Item2 - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - Destination - - {{ Fill Destination Description }} - - String - - String - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - Force - - {{ Fill Force Description }} - - - SwitchParameter - - - False - - - PassThru - - {{ Fill PassThru Description }} - - Boolean - - Boolean - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - Destination - - {{ Fill Destination Description }} - - String - - String - - - None - - - Force - - {{ Fill Force Description }} - - SwitchParameter - - SwitchParameter - - - False - - - PassThru - - {{ Fill PassThru Description }} - - Boolean - - Boolean - - - None - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - - - - System.String[] - - - - - - - - System.String - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Disable-NTFSAccessInheritance - Disable - NTFSAccessInheritance - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Disable-NTFSAccessInheritance - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - RemoveInheritedAccessRules - - {{ Fill RemoveInheritedAccessRules Description }} - - - SwitchParameter - - - False - - - - Disable-NTFSAccessInheritance - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - RemoveInheritedAccessRules - - {{ Fill RemoveInheritedAccessRules Description }} - - - SwitchParameter - - - False - - - - - - PassThru - - {{ Fill PassThru Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - RemoveInheritedAccessRules - - {{ Fill RemoveInheritedAccessRules Description }} - - SwitchParameter - - SwitchParameter - - - False - - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - - - - System.String[] - - - - - - - - Security2.FileSystemSecurity2[] - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Disable-NTFSAuditInheritance - Disable - NTFSAuditInheritance - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Disable-NTFSAuditInheritance - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - RemoveInheritedAccessRules - - {{ Fill RemoveInheritedAccessRules Description }} - - - SwitchParameter - - - False - - - - Disable-NTFSAuditInheritance - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - RemoveInheritedAccessRules - - {{ Fill RemoveInheritedAccessRules Description }} - - - SwitchParameter - - - False - - - - - - PassThru - - {{ Fill PassThru Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - RemoveInheritedAccessRules - - {{ Fill RemoveInheritedAccessRules Description }} - - SwitchParameter - - SwitchParameter - - - False - - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - - - - System.String[] - - - - - - - - Security2.FileSystemSecurity2[] - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Disable-Privileges - Disable - Privileges - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Disable-Privileges - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - - - - PassThru - - {{ Fill PassThru Description }} - - SwitchParameter - - SwitchParameter - - - False - - - - - - None - - - - - - - - - - ProcessPrivileges.PrivilegeAndAttributes - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Enable-NTFSAccessInheritance - Enable - NTFSAccessInheritance - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Enable-NTFSAccessInheritance - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - RemoveExplicitAccessRules - - {{ Fill RemoveExplicitAccessRules Description }} - - - SwitchParameter - - - False - - - - Enable-NTFSAccessInheritance - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - RemoveExplicitAccessRules - - {{ Fill RemoveExplicitAccessRules Description }} - - - SwitchParameter - - - False - - - - - - PassThru - - {{ Fill PassThru Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - RemoveExplicitAccessRules - - {{ Fill RemoveExplicitAccessRules Description }} - - SwitchParameter - - SwitchParameter - - - False - - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - - - - System.String[] - - - - - - - - Security2.FileSystemSecurity2[] - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Enable-NTFSAuditInheritance - Enable - NTFSAuditInheritance - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Enable-NTFSAuditInheritance - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - RemoveExplicitAccessRules - - {{ Fill RemoveExplicitAccessRules Description }} - - - SwitchParameter - - - False - - - - Enable-NTFSAuditInheritance - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - RemoveExplicitAccessRules - - {{ Fill RemoveExplicitAccessRules Description }} - - - SwitchParameter - - - False - - - - - - PassThru - - {{ Fill PassThru Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - RemoveExplicitAccessRules - - {{ Fill RemoveExplicitAccessRules Description }} - - SwitchParameter - - SwitchParameter - - - False - - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - - - - System.String[] - - - - - - - - Security2.FileSystemSecurity2[] - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Enable-Privileges - Enable - Privileges - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Enable-Privileges - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - - - - PassThru - - {{ Fill PassThru Description }} - - SwitchParameter - - SwitchParameter - - - False - - - - - - None - - - - - - - - - - ProcessPrivileges.PrivilegeAndAttributes - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Get-ChildItem2 - Get - ChildItem2 - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Get-ChildItem2 - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - Filter - - {{ Fill Filter Description }} - - String - - String - - - None - - - Attributes - - {{ Fill Attributes Description }} - - - ReadOnly - Hidden - System - Directory - Archive - Device - Normal - Temporary - SparseFile - ReparsePoint - Compressed - Offline - NotContentIndexed - Encrypted - IntegrityStream - NoScrubData - - FileAttributes - - FileAttributes - - - None - - - Depth - - {{ Fill Depth Description }} - - Int32 - - Int32 - - - None - - - Directory - - {{ Fill Directory Description }} - - - SwitchParameter - - - False - - - File - - {{ Fill File Description }} - - - SwitchParameter - - - False - - - Force - - {{ Fill Force Description }} - - - SwitchParameter - - - False - - - Hidden - - {{ Fill Hidden Description }} - - - SwitchParameter - - - False - - - ReadOnly - - {{ Fill ReadOnly Description }} - - - SwitchParameter - - - False - - - Recurse - - {{ Fill Recurse Description }} - - - SwitchParameter - - - False - - - SkipMountPoints - - {{ Fill SkipMountPoints Description }} - - - SwitchParameter - - - False - - - SkipSymbolicLinks - - {{ Fill SkipSymbolicLinks Description }} - - - SwitchParameter - - - False - - - System - - {{ Fill System Description }} - - - SwitchParameter - - - False - - - - - - Attributes - - {{ Fill Attributes Description }} - - FileAttributes - - FileAttributes - - - None - - - Depth - - {{ Fill Depth Description }} - - Int32 - - Int32 - - - None - - - Directory - - {{ Fill Directory Description }} - - SwitchParameter - - SwitchParameter - - - False - - - File - - {{ Fill File Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Filter - - {{ Fill Filter Description }} - - String - - String - - - None - - - Force - - {{ Fill Force Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Hidden - - {{ Fill Hidden Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - ReadOnly - - {{ Fill ReadOnly Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Recurse - - {{ Fill Recurse Description }} - - SwitchParameter - - SwitchParameter - - - False - - - SkipMountPoints - - {{ Fill SkipMountPoints Description }} - - SwitchParameter - - SwitchParameter - - - False - - - SkipSymbolicLinks - - {{ Fill SkipSymbolicLinks Description }} - - SwitchParameter - - SwitchParameter - - - False - - - System - - {{ Fill System Description }} - - SwitchParameter - - SwitchParameter - - - False - - - - - - System.String[] - - - - - - - - - - Alphaleonis.Win32.Filesystem.FileInfo - - - - - - - - Alphaleonis.Win32.Filesystem.DirectoryInfo - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Get-DiskSpace - Get - DiskSpace - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Get-DiskSpace - - DriveLetter - - {{ Fill DriveLetter Description }} - - String[] - - String[] - - - None - - - - - - DriveLetter - - {{ Fill DriveLetter Description }} - - String[] - - String[] - - - None - - - - - - None - - - - - - - - - - Alphaleonis.Win32.Filesystem.DiskSpaceInfo - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Get-FileHash2 - Get - FileHash2 - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Get-FileHash2 - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - Algorithm - - {{ Fill Algorithm Description }} - - - SHA1 - SHA256 - SHA384 - SHA512 - MACTripleDES - MD5 - RIPEMD160 - - HashAlgorithms - - HashAlgorithms - - - None - - - - - - Algorithm - - {{ Fill Algorithm Description }} - - HashAlgorithms - - HashAlgorithms - - - None - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - - - - System.String[] - - - - - - - - Security2.FileSystem.FileInfo.HashAlgorithms - - - - - - - - - - Security2.FileSystemAccessRule2 - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Get-Item2 - Get - Item2 - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Get-Item2 - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - - - - System.String[] - - - - - - - - - - Alphaleonis.Win32.Filesystem.FileInfo - - - - - - - - Alphaleonis.Win32.Filesystem.DirectoryInfo - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Get-NTFSAccess - Get - NTFSAccess - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Get-NTFSAccess - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2 - - IdentityReference2 - - - None - - - ExcludeExplicit - - {{ Fill ExcludeExplicit Description }} - - - SwitchParameter - - - False - - - ExcludeInherited - - {{ Fill ExcludeInherited Description }} - - - SwitchParameter - - - False - - - - Get-NTFSAccess - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2 - - IdentityReference2 - - - None - - - ExcludeExplicit - - {{ Fill ExcludeExplicit Description }} - - - SwitchParameter - - - False - - - ExcludeInherited - - {{ Fill ExcludeInherited Description }} - - - SwitchParameter - - - False - - - - - - Account - - {{ Fill Account Description }} - - IdentityReference2 - - IdentityReference2 - - - None - - - ExcludeExplicit - - {{ Fill ExcludeExplicit Description }} - - SwitchParameter - - SwitchParameter - - - False - - - ExcludeInherited - - {{ Fill ExcludeInherited Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - - - - System.String[] - - - - - - - - Security2.FileSystemSecurity2[] - - - - - - - - Security2.IdentityReference2 - - - - - - - - - - Security2.FileSystemAccessRule2 - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Get-NTFSAudit - Get - NTFSAudit - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Get-NTFSAudit - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2 - - IdentityReference2 - - - None - - - ExcludeExplicit - - {{ Fill ExcludeExplicit Description }} - - - SwitchParameter - - - False - - - ExcludeInherited - - {{ Fill ExcludeInherited Description }} - - - SwitchParameter - - - False - - - - Get-NTFSAudit - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2 - - IdentityReference2 - - - None - - - ExcludeExplicit - - {{ Fill ExcludeExplicit Description }} - - - SwitchParameter - - - False - - - ExcludeInherited - - {{ Fill ExcludeInherited Description }} - - - SwitchParameter - - - False - - - - - - Account - - {{ Fill Account Description }} - - IdentityReference2 - - IdentityReference2 - - - None - - - ExcludeExplicit - - {{ Fill ExcludeExplicit Description }} - - SwitchParameter - - SwitchParameter - - - False - - - ExcludeInherited - - {{ Fill ExcludeInherited Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - - - - System.String[] - - - - - - - - Security2.FileSystemSecurity2[] - - - - - - - - Security2.IdentityReference2 - - - - - - - - - - Security2.FileSystemAuditRule2 - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Get-NTFSEffectiveAccess - Get - NTFSEffectiveAccess - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Get-NTFSEffectiveAccess - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2 - - IdentityReference2 - - - None - - - ExcludeNoneAccessEntries - - {{ Fill ExcludeNoneAccessEntries Description }} - - - SwitchParameter - - - False - - - ServerName - - {{ Fill ServerName Description }} - - String - - String - - - None - - - - Get-NTFSEffectiveAccess - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2 - - IdentityReference2 - - - None - - - ExcludeNoneAccessEntries - - {{ Fill ExcludeNoneAccessEntries Description }} - - - SwitchParameter - - - False - - - ServerName - - {{ Fill ServerName Description }} - - String - - String - - - None - - - - - - Account - - {{ Fill Account Description }} - - IdentityReference2 - - IdentityReference2 - - - None - - - ExcludeNoneAccessEntries - - {{ Fill ExcludeNoneAccessEntries Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - ServerName - - {{ Fill ServerName Description }} - - String - - String - - - None - - - - - - System.String[] - - - - - - - - Security2.FileSystemSecurity2[] - - - - - - - - Security2.IdentityReference2 - - - - - - - - - - Security2.FileSystemAccessRule2 - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Get-NTFSHardLink - Get - NTFSHardLink - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Get-NTFSHardLink - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - - - - System.String[] - - - - - - - - - - Alphaleonis.Win32.Filesystem.FileInfo - - - - - - - - Alphaleonis.Win32.Filesystem.DirectoryInfo - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Get-NTFSInheritance - Get - NTFSInheritance - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Get-NTFSInheritance - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - - Get-NTFSInheritance - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - - - - System.String[] - - - - - - - - Security2.FileSystemSecurity2[] - - - - - - - - - - Security2.FileSystemInheritanceInfo - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Get-NTFSOrphanedAccess - Get - NTFSOrphanedAccess - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Get-NTFSOrphanedAccess - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2 - - IdentityReference2 - - - None - - - ExcludeExplicit - - {{ Fill ExcludeExplicit Description }} - - - SwitchParameter - - - False - - - ExcludeInherited - - {{ Fill ExcludeInherited Description }} - - - SwitchParameter - - - False - - - - Get-NTFSOrphanedAccess - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2 - - IdentityReference2 - - - None - - - ExcludeExplicit - - {{ Fill ExcludeExplicit Description }} - - - SwitchParameter - - - False - - - ExcludeInherited - - {{ Fill ExcludeInherited Description }} - - - SwitchParameter - - - False - - - - - - Account - - {{ Fill Account Description }} - - IdentityReference2 - - IdentityReference2 - - - None - - - ExcludeExplicit - - {{ Fill ExcludeExplicit Description }} - - SwitchParameter - - SwitchParameter - - - False - - - ExcludeInherited - - {{ Fill ExcludeInherited Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - - - - System.String[] - - - - - - - - Security2.FileSystemSecurity2[] - - - - - - - - Security2.IdentityReference2 - - - - - - - - - - Security2.FileSystemAccessRule2 - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Get-NTFSOrphanedAudit - Get - NTFSOrphanedAudit - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Get-NTFSOrphanedAudit - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2 - - IdentityReference2 - - - None - - - ExcludeExplicit - - {{ Fill ExcludeExplicit Description }} - - - SwitchParameter - - - False - - - ExcludeInherited - - {{ Fill ExcludeInherited Description }} - - - SwitchParameter - - - False - - - - Get-NTFSOrphanedAudit - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2 - - IdentityReference2 - - - None - - - ExcludeExplicit - - {{ Fill ExcludeExplicit Description }} - - - SwitchParameter - - - False - - - ExcludeInherited - - {{ Fill ExcludeInherited Description }} - - - SwitchParameter - - - False - - - - - - Account - - {{ Fill Account Description }} - - IdentityReference2 - - IdentityReference2 - - - None - - - ExcludeExplicit - - {{ Fill ExcludeExplicit Description }} - - SwitchParameter - - SwitchParameter - - - False - - - ExcludeInherited - - {{ Fill ExcludeInherited Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - - - - System.String[] - - - - - - - - Security2.FileSystemSecurity2[] - - - - - - - - Security2.IdentityReference2 - - - - - - - - - - Security2.FileSystemAuditRule2 - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Get-NTFSOwner - Get - NTFSOwner - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Get-NTFSOwner - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - - Get-NTFSOwner - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - - - - System.String[] - - - - - - - - Security2.FileSystemSecurity2[] - - - - - - - - - - Security2.FileSystemOwner - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Get-NTFSSecurityDescriptor - Get - NTFSSecurityDescriptor - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Get-NTFSSecurityDescriptor - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - - - - System.String[] - - - - - - - - - - Security2.FileSystemSecurity2 - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Get-NTFSSimpleAccess - Get - NTFSSimpleAccess - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Get-NTFSSimpleAccess - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2 - - IdentityReference2 - - - None - - - ExcludeExplicit - - {{ Fill ExcludeExplicit Description }} - - - SwitchParameter - - - False - - - ExcludeInherited - - {{ Fill ExcludeInherited Description }} - - - SwitchParameter - - - False - - - IncludeRootFolder - - {{ Fill IncludeRootFolder Description }} - - - SwitchParameter - - - False - - - - Get-NTFSSimpleAccess - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2 - - IdentityReference2 - - - None - - - ExcludeExplicit - - {{ Fill ExcludeExplicit Description }} - - - SwitchParameter - - - False - - - ExcludeInherited - - {{ Fill ExcludeInherited Description }} - - - SwitchParameter - - - False - - - IncludeRootFolder - - {{ Fill IncludeRootFolder Description }} - - - SwitchParameter - - - False - - - - - - Account - - {{ Fill Account Description }} - - IdentityReference2 - - IdentityReference2 - - - None - - - ExcludeExplicit - - {{ Fill ExcludeExplicit Description }} - - SwitchParameter - - SwitchParameter - - - False - - - ExcludeInherited - - {{ Fill ExcludeInherited Description }} - - SwitchParameter - - SwitchParameter - - - False - - - IncludeRootFolder - - {{ Fill IncludeRootFolder Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - - - - System.String[] - - - - - - - - Security2.FileSystemSecurity2[] - - - - - - - - Security2.IdentityReference2 - - - - - - - - - - Security2.SimpleFileSystemAccessRule - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Get-Privileges - Get - Privileges - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Get-Privileges - - - - - - - None - - - - - - - - - - ProcessPrivileges.PrivilegeAndAttributes - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Move-Item2 - Move - Item2 - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Move-Item2 - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - Destination - - {{ Fill Destination Description }} - - String - - String - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - Force - - {{ Fill Force Description }} - - - SwitchParameter - - - False - - - PassThru - - {{ Fill PassThru Description }} - - Boolean - - Boolean - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - Destination - - {{ Fill Destination Description }} - - String - - String - - - None - - - Force - - {{ Fill Force Description }} - - SwitchParameter - - SwitchParameter - - - False - - - PassThru - - {{ Fill PassThru Description }} - - Boolean - - Boolean - - - None - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - - - - System.String[] - - - - - - - - System.String - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - New-NTFSHardLink - New - NTFSHardLink - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - New-NTFSHardLink - - Path - - {{ Fill Path Description }} - - String - - String - - - None - - - Target - - {{ Fill Target Description }} - - String - - String - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - - - - PassThru - - {{ Fill PassThru Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Path - - {{ Fill Path Description }} - - String - - String - - - None - - - Target - - {{ Fill Target Description }} - - String - - String - - - None - - - - - - System.String - - - - - - - - - - Alphaleonis.Win32.Filesystem.FileInfo - - - - - - - - Alphaleonis.Win32.Filesystem.DirectoryInfo - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - New-NTFSSymbolicLink - New - NTFSSymbolicLink - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - New-NTFSSymbolicLink - - Path - - {{ Fill Path Description }} - - String - - String - - - None - - - Target - - {{ Fill Target Description }} - - String - - String - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - - - - PassThru - - {{ Fill PassThru Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Path - - {{ Fill Path Description }} - - String - - String - - - None - - - Target - - {{ Fill Target Description }} - - String - - String - - - None - - - - - - System.String - - - - - - - - - - Alphaleonis.Win32.Filesystem.FileInfo - - - - - - - - Alphaleonis.Win32.Filesystem.DirectoryInfo - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Remove-Item2 - Remove - Item2 - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Remove-Item2 - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - Force - - {{ Fill Force Description }} - - - SwitchParameter - - - False - - - PassThur - - {{ Fill PassThur Description }} - - - SwitchParameter - - - False - - - Recurse - - {{ Fill Recurse Description }} - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - Force - - {{ Fill Force Description }} - - SwitchParameter - - SwitchParameter - - - False - - - PassThur - - {{ Fill PassThur Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - Recurse - - {{ Fill Recurse Description }} - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - - - - System.String[] - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Remove-NTFSAccess - Remove - NTFSAccess - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Remove-NTFSAccess - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2[] - - IdentityReference2[] - - - None - - - AccessRights - - {{ Fill AccessRights Description }} - - - None - ReadData - ListDirectory - WriteData - CreateFiles - AppendData - CreateDirectories - ReadExtendedAttributes - WriteExtendedAttributes - ExecuteFile - Traverse - DeleteSubdirectoriesAndFiles - ReadAttributes - WriteAttributes - Write - Delete - ReadPermissions - Read - ReadAndExecute - Modify - ChangePermissions - TakeOwnership - Synchronize - FullControl - GenericAll - GenericExecute - GenericWrite - GenericRead - - FileSystemRights2 - - FileSystemRights2 - - - None - - - AccessType - - {{ Fill AccessType Description }} - - - Allow - Deny - - AccessControlType - - AccessControlType - - - None - - - AppliesTo - - {{ Fill AppliesTo Description }} - - - ThisFolderOnly - ThisFolderSubfoldersAndFiles - ThisFolderAndSubfolders - ThisFolderAndFiles - SubfoldersAndFilesOnly - SubfoldersOnly - FilesOnly - ThisFolderSubfoldersAndFilesOneLevel - ThisFolderAndSubfoldersOneLevel - ThisFolderAndFilesOneLevel - SubfoldersAndFilesOnlyOneLevel - SubfoldersOnlyOneLevel - FilesOnlyOneLevel - - ApplyTo - - ApplyTo - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - - Remove-NTFSAccess - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2[] - - IdentityReference2[] - - - None - - - AccessRights - - {{ Fill AccessRights Description }} - - - None - ReadData - ListDirectory - WriteData - CreateFiles - AppendData - CreateDirectories - ReadExtendedAttributes - WriteExtendedAttributes - ExecuteFile - Traverse - DeleteSubdirectoriesAndFiles - ReadAttributes - WriteAttributes - Write - Delete - ReadPermissions - Read - ReadAndExecute - Modify - ChangePermissions - TakeOwnership - Synchronize - FullControl - GenericAll - GenericExecute - GenericWrite - GenericRead - - FileSystemRights2 - - FileSystemRights2 - - - None - - - AccessType - - {{ Fill AccessType Description }} - - - Allow - Deny - - AccessControlType - - AccessControlType - - - None - - - AppliesTo - - {{ Fill AppliesTo Description }} - - - ThisFolderOnly - ThisFolderSubfoldersAndFiles - ThisFolderAndSubfolders - ThisFolderAndFiles - SubfoldersAndFilesOnly - SubfoldersOnly - FilesOnly - ThisFolderSubfoldersAndFilesOneLevel - ThisFolderAndSubfoldersOneLevel - ThisFolderAndFilesOneLevel - SubfoldersAndFilesOnlyOneLevel - SubfoldersOnlyOneLevel - FilesOnlyOneLevel - - ApplyTo - - ApplyTo - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - - Remove-NTFSAccess - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2[] - - IdentityReference2[] - - - None - - - AccessRights - - {{ Fill AccessRights Description }} - - - None - ReadData - ListDirectory - WriteData - CreateFiles - AppendData - CreateDirectories - ReadExtendedAttributes - WriteExtendedAttributes - ExecuteFile - Traverse - DeleteSubdirectoriesAndFiles - ReadAttributes - WriteAttributes - Write - Delete - ReadPermissions - Read - ReadAndExecute - Modify - ChangePermissions - TakeOwnership - Synchronize - FullControl - GenericAll - GenericExecute - GenericWrite - GenericRead - - FileSystemRights2 - - FileSystemRights2 - - - None - - - AccessType - - {{ Fill AccessType Description }} - - - Allow - Deny - - AccessControlType - - AccessControlType - - - None - - - InheritanceFlags - - {{ Fill InheritanceFlags Description }} - - - None - ContainerInherit - ObjectInherit - - InheritanceFlags - - InheritanceFlags - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - PropagationFlags - - {{ Fill PropagationFlags Description }} - - - None - NoPropagateInherit - InheritOnly - - PropagationFlags - - PropagationFlags - - - None - - - - Remove-NTFSAccess - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2[] - - IdentityReference2[] - - - None - - - AccessRights - - {{ Fill AccessRights Description }} - - - None - ReadData - ListDirectory - WriteData - CreateFiles - AppendData - CreateDirectories - ReadExtendedAttributes - WriteExtendedAttributes - ExecuteFile - Traverse - DeleteSubdirectoriesAndFiles - ReadAttributes - WriteAttributes - Write - Delete - ReadPermissions - Read - ReadAndExecute - Modify - ChangePermissions - TakeOwnership - Synchronize - FullControl - GenericAll - GenericExecute - GenericWrite - GenericRead - - FileSystemRights2 - - FileSystemRights2 - - - None - - - AccessType - - {{ Fill AccessType Description }} - - - Allow - Deny - - AccessControlType - - AccessControlType - - - None - - - InheritanceFlags - - {{ Fill InheritanceFlags Description }} - - - None - ContainerInherit - ObjectInherit - - InheritanceFlags - - InheritanceFlags - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - PropagationFlags - - {{ Fill PropagationFlags Description }} - - - None - NoPropagateInherit - InheritOnly - - PropagationFlags - - PropagationFlags - - - None - - - - - - AccessRights - - {{ Fill AccessRights Description }} - - FileSystemRights2 - - FileSystemRights2 - - - None - - - AccessType - - {{ Fill AccessType Description }} - - AccessControlType - - AccessControlType - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2[] - - IdentityReference2[] - - - None - - - AppliesTo - - {{ Fill AppliesTo Description }} - - ApplyTo - - ApplyTo - - - None - - - InheritanceFlags - - {{ Fill InheritanceFlags Description }} - - InheritanceFlags - - InheritanceFlags - - - None - - - PassThru - - {{ Fill PassThru Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - PropagationFlags - - {{ Fill PropagationFlags Description }} - - PropagationFlags - - PropagationFlags - - - None - - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - - - - System.String[] - - - - - - - - Security2.FileSystemSecurity2[] - - - - - - - - Security2.IdentityReference2[] - - - - - - - - Security2.FileSystemRights2 - - - - - - - - System.Security.AccessControl.AccessControlType - - - - - - - - System.Security.AccessControl.InheritanceFlags - - - - - - - - System.Security.AccessControl.PropagationFlags - - - - - - - - Security2.ApplyTo - - - - - - - - - - Security2.FileSystemAccessRule2 - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Remove-NTFSAudit - Remove - NTFSAudit - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Remove-NTFSAudit - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2[] - - IdentityReference2[] - - - None - - - AccessRights - - {{ Fill AccessRights Description }} - - - None - ReadData - ListDirectory - WriteData - CreateFiles - AppendData - CreateDirectories - ReadExtendedAttributes - WriteExtendedAttributes - ExecuteFile - Traverse - DeleteSubdirectoriesAndFiles - ReadAttributes - WriteAttributes - Write - Delete - ReadPermissions - Read - ReadAndExecute - Modify - ChangePermissions - TakeOwnership - Synchronize - FullControl - GenericAll - GenericExecute - GenericWrite - GenericRead - - FileSystemRights2 - - FileSystemRights2 - - - None - - - AppliesTo - - {{ Fill AppliesTo Description }} - - - ThisFolderOnly - ThisFolderSubfoldersAndFiles - ThisFolderAndSubfolders - ThisFolderAndFiles - SubfoldersAndFilesOnly - SubfoldersOnly - FilesOnly - ThisFolderSubfoldersAndFilesOneLevel - ThisFolderAndSubfoldersOneLevel - ThisFolderAndFilesOneLevel - SubfoldersAndFilesOnlyOneLevel - SubfoldersOnlyOneLevel - FilesOnlyOneLevel - - ApplyTo - - ApplyTo - - - None - - - AuditFlags - - {{ Fill AuditFlags Description }} - - - None - Success - Failure - - AuditFlags - - AuditFlags - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - - Remove-NTFSAudit - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2[] - - IdentityReference2[] - - - None - - - AccessRights - - {{ Fill AccessRights Description }} - - - None - ReadData - ListDirectory - WriteData - CreateFiles - AppendData - CreateDirectories - ReadExtendedAttributes - WriteExtendedAttributes - ExecuteFile - Traverse - DeleteSubdirectoriesAndFiles - ReadAttributes - WriteAttributes - Write - Delete - ReadPermissions - Read - ReadAndExecute - Modify - ChangePermissions - TakeOwnership - Synchronize - FullControl - GenericAll - GenericExecute - GenericWrite - GenericRead - - FileSystemRights2 - - FileSystemRights2 - - - None - - - AppliesTo - - {{ Fill AppliesTo Description }} - - - ThisFolderOnly - ThisFolderSubfoldersAndFiles - ThisFolderAndSubfolders - ThisFolderAndFiles - SubfoldersAndFilesOnly - SubfoldersOnly - FilesOnly - ThisFolderSubfoldersAndFilesOneLevel - ThisFolderAndSubfoldersOneLevel - ThisFolderAndFilesOneLevel - SubfoldersAndFilesOnlyOneLevel - SubfoldersOnlyOneLevel - FilesOnlyOneLevel - - ApplyTo - - ApplyTo - - - None - - - AuditFlags - - {{ Fill AuditFlags Description }} - - - None - Success - Failure - - AuditFlags - - AuditFlags - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - - Remove-NTFSAudit - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2[] - - IdentityReference2[] - - - None - - - AccessRights - - {{ Fill AccessRights Description }} - - - None - ReadData - ListDirectory - WriteData - CreateFiles - AppendData - CreateDirectories - ReadExtendedAttributes - WriteExtendedAttributes - ExecuteFile - Traverse - DeleteSubdirectoriesAndFiles - ReadAttributes - WriteAttributes - Write - Delete - ReadPermissions - Read - ReadAndExecute - Modify - ChangePermissions - TakeOwnership - Synchronize - FullControl - GenericAll - GenericExecute - GenericWrite - GenericRead - - FileSystemRights2 - - FileSystemRights2 - - - None - - - AuditFlags - - {{ Fill AuditFlags Description }} - - - None - Success - Failure - - AuditFlags - - AuditFlags - - - None - - - InheritanceFlags - - {{ Fill InheritanceFlags Description }} - - - None - ContainerInherit - ObjectInherit - - InheritanceFlags - - InheritanceFlags - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - PropagationFlags - - {{ Fill PropagationFlags Description }} - - - None - NoPropagateInherit - InheritOnly - - PropagationFlags - - PropagationFlags - - - None - - - - Remove-NTFSAudit - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2[] - - IdentityReference2[] - - - None - - - AccessRights - - {{ Fill AccessRights Description }} - - - None - ReadData - ListDirectory - WriteData - CreateFiles - AppendData - CreateDirectories - ReadExtendedAttributes - WriteExtendedAttributes - ExecuteFile - Traverse - DeleteSubdirectoriesAndFiles - ReadAttributes - WriteAttributes - Write - Delete - ReadPermissions - Read - ReadAndExecute - Modify - ChangePermissions - TakeOwnership - Synchronize - FullControl - GenericAll - GenericExecute - GenericWrite - GenericRead - - FileSystemRights2 - - FileSystemRights2 - - - None - - - AuditFlags - - {{ Fill AuditFlags Description }} - - - None - Success - Failure - - AuditFlags - - AuditFlags - - - None - - - InheritanceFlags - - {{ Fill InheritanceFlags Description }} - - - None - ContainerInherit - ObjectInherit - - InheritanceFlags - - InheritanceFlags - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - PropagationFlags - - {{ Fill PropagationFlags Description }} - - - None - NoPropagateInherit - InheritOnly - - PropagationFlags - - PropagationFlags - - - None - - - - - - AccessRights - - {{ Fill AccessRights Description }} - - FileSystemRights2 - - FileSystemRights2 - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2[] - - IdentityReference2[] - - - None - - - AppliesTo - - {{ Fill AppliesTo Description }} - - ApplyTo - - ApplyTo - - - None - - - AuditFlags - - {{ Fill AuditFlags Description }} - - AuditFlags - - AuditFlags - - - None - - - InheritanceFlags - - {{ Fill InheritanceFlags Description }} - - InheritanceFlags - - InheritanceFlags - - - None - - - PassThru - - {{ Fill PassThru Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - PropagationFlags - - {{ Fill PropagationFlags Description }} - - PropagationFlags - - PropagationFlags - - - None - - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - - - - System.String[] - - - - - - - - Security2.FileSystemSecurity2[] - - - - - - - - Security2.IdentityReference2[] - - - - - - - - Security2.FileSystemRights2 - - - - - - - - System.Security.AccessControl.AuditFlags - - - - - - - - System.Security.AccessControl.InheritanceFlags - - - - - - - - System.Security.AccessControl.PropagationFlags - - - - - - - - Security2.ApplyTo - - - - - - - - - - Security2.FileSystemAccessRule2 - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Set-NTFSInheritance - Set - NTFSInheritance - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Set-NTFSInheritance - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - AccessInheritanceEnabled - - {{ Fill AccessInheritanceEnabled Description }} - - Boolean - - Boolean - - - None - - - AuditInheritanceEnabled - - {{ Fill AuditInheritanceEnabled Description }} - - Boolean - - Boolean - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - - Set-NTFSInheritance - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - AccessInheritanceEnabled - - {{ Fill AccessInheritanceEnabled Description }} - - Boolean - - Boolean - - - None - - - AuditInheritanceEnabled - - {{ Fill AuditInheritanceEnabled Description }} - - Boolean - - Boolean - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - - - - AccessInheritanceEnabled - - {{ Fill AccessInheritanceEnabled Description }} - - Boolean - - Boolean - - - None - - - AuditInheritanceEnabled - - {{ Fill AuditInheritanceEnabled Description }} - - Boolean - - Boolean - - - None - - - PassThru - - {{ Fill PassThru Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - - - - System.String[] - - - - - - - - Security2.FileSystemSecurity2[] - - - - - - - - System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Set-NTFSOwner - Set - NTFSOwner - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Set-NTFSOwner - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2 - - IdentityReference2 - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - - Set-NTFSOwner - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - Account - - {{ Fill Account Description }} - - IdentityReference2 - - IdentityReference2 - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - - - - Account - - {{ Fill Account Description }} - - IdentityReference2 - - IdentityReference2 - - - None - - - PassThru - - {{ Fill PassThru Description }} - - SwitchParameter - - SwitchParameter - - - False - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - - - - System.String[] - - - - - - - - Security2.FileSystemSecurity2[] - - - - - - - - Security2.IdentityReference2 - - - - - - - - - - Security2.FileSystemOwner - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Set-NTFSSecurityDescriptor - Set - NTFSSecurityDescriptor - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Set-NTFSSecurityDescriptor - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - PassThru - - {{ Fill PassThru Description }} - - - SwitchParameter - - - False - - - - - - PassThru - - {{ Fill PassThru Description }} - - SwitchParameter - - SwitchParameter - - - False - - - SecurityDescriptor - - {{ Fill SecurityDescriptor Description }} - - FileSystemSecurity2[] - - FileSystemSecurity2[] - - - None - - - - - - Security2.FileSystemSecurity2[] - - - - - - - - - - Security2.FileSystemSecurity2 - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Test-Path2 - Test - Path2 - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Test-Path2 - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - PathType - - {{ Fill PathType Description }} - - - Any - Container - Leaf - - TestPathType - - TestPathType - - - None - - - - - - Path - - {{ Fill Path Description }} - - String[] - - String[] - - - None - - - PathType - - {{ Fill PathType Description }} - - TestPathType - - TestPathType - - - None - - - - - - System.String[] - - - - - - - - NTFSSecurity.TestPathType - - - - - - - - - - Alphaleonis.Win32.Filesystem.FileInfo - - - - - - - - Alphaleonis.Win32.Filesystem.DirectoryInfo - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - \ No newline at end of file diff --git a/mkdocs.bak b/mkdocs.bak new file mode 100644 index 0000000..78d8a1b --- /dev/null +++ b/mkdocs.bak @@ -0,0 +1,51 @@ +copyright: The NTFSSecurity module is licensed under the MIT license +repo_url: https://github.com/raandree/NTFSSecurity +nav: +- Home: ./Index.md +- Cmdlets: + - Add-NTFSAccess: Cmdlets/Add-NTFSAccess.md + - Add-NTFSAudit: Cmdlets/Add-NTFSAudit.md + - Clear-NTFSAccess: Cmdlets/Clear-NTFSAccess.md + - Clear-NTFSAudit: Cmdlets/Clear-NTFSAudit.md + - Copy-Item2: Cmdlets/Copy-Item2.md + - Disable-NTFSAccessInheritance: Cmdlets/Disable-NTFSAccessInheritance.md + - Disable-NTFSAuditInheritance: Cmdlets/Disable-NTFSAuditInheritance.md + - Disable-Privileges: Cmdlets/Disable-Privileges.md + - Enable-NTFSAccessInheritance: Cmdlets/Enable-NTFSAccessInheritance.md + - Enable-NTFSAuditInheritance: Cmdlets/Enable-NTFSAuditInheritance.md + - Enable-Privileges: Cmdlets/Enable-Privileges.md + - Get-ChildItem2: Cmdlets/Get-ChildItem2.md + - Get-DiskSpace: Cmdlets/Get-DiskSpace.md + - Get-FileHash2: Cmdlets/Get-FileHash2.md + - Get-Item2: Cmdlets/Get-Item2.md + - Get-NTFSAccess: Cmdlets/Get-NTFSAccess.md + - Get-NTFSAudit: Cmdlets/Get-NTFSAudit.md + - Get-NTFSEffectiveAccess: Cmdlets/Get-NTFSEffectiveAccess.md + - Get-NTFSHardLink: Cmdlets/Get-NTFSHardLink.md + - Get-NTFSInheritance: Cmdlets/Get-NTFSInheritance.md + - Get-NTFSOrphanedAccess: Cmdlets/Get-NTFSOrphanedAccess.md + - Get-NTFSOrphanedAudit: Cmdlets/Get-NTFSOrphanedAudit.md + - Get-NTFSOwner: Cmdlets/Get-NTFSOwner.md + - Get-NTFSSecurityDescriptor: Cmdlets/Get-NTFSSecurityDescriptor.md + - Get-NTFSSimpleAccess: Cmdlets/Get-NTFSSimpleAccess.md + - Get-Privileges: Cmdlets/Get-Privileges.md + - Move-Item2: Cmdlets/Move-Item2.md + - New-NTFSHardLink: Cmdlets/New-NTFSHardLink.md + - New-NTFSSymbolicLink: Cmdlets/New-NTFSSymbolicLink.md + - Remove-Item2: Cmdlets/Remove-Item2.md + - Remove-NTFSAccess: Cmdlets/Remove-NTFSAccess.md + - Remove-NTFSAudit: Cmdlets/Remove-NTFSAudit.md + - Set-NTFSInheritance: Cmdlets/Set-NTFSInheritance.md + - Set-NTFSOwner: Cmdlets/Set-NTFSOwner.md + - Set-NTFSSecurityDescriptor: Cmdlets/Set-NTFSSecurityDescriptor.md + - Test-Path2: Cmdlets/Test-Path2.md +- Contributing: + - Getting Started: Contributing/01-Getting-Started.md + - Writing: Contributing/02-Writing.md + - Style Guide: Contributing/03-Style-Guide.md + - Markdown Specifics: Contributing:04-Markdown-Specifics.md +site_name: NTFSSecurity +theme: readthedocs +site_author: Raimund Andrée, James Smith +edit_uri: edit/master/Help/ +docs_dir: ./Docs \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 78d8a1b..69bff82 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,50 +2,7 @@ copyright: The NTFSSecurity module is licensed under the MIT license repo_url: https://github.com/raandree/NTFSSecurity nav: -- Home: ./Index.md +- Home: ./index.md site_name: NTFSSecurity theme: readthedocs site_author: Raimund Andrée, James Smith From 447557bd49bf80972bfafdf7d1fee75011990cfe Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Mon, 14 Oct 2019 23:47:53 +1100 Subject: [PATCH 31/44] added rtd pages back --- mkdocs.yml | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index 46a715d..5849386 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,6 +2,48 @@ copyright: The NTFSSecurity module is licensed under the Date: Tue, 15 Oct 2019 22:30:25 +1100 Subject: [PATCH 35/44] added primer on permissions --- Docs/Cmdlets/Add-NTFSAccess.md | 49 ++++++++--------- Docs/Permissions.md | 98 ++++++++++++++++++++++++++++++++++ Docs/index.md | 6 ++- 3 files changed, 124 insertions(+), 29 deletions(-) create mode 100644 Docs/Permissions.md diff --git a/Docs/Cmdlets/Add-NTFSAccess.md b/Docs/Cmdlets/Add-NTFSAccess.md index fa67744..98cc4b8 100644 --- a/Docs/Cmdlets/Add-NTFSAccess.md +++ b/Docs/Cmdlets/Add-NTFSAccess.md @@ -14,31 +14,27 @@ Adds an access control entry (ACE) to an object. ## SYNTAX ### PathComplex (Default) - -```PowerShell +``` Add-NTFSAccess [-Path] [-Account] [-AccessRights] [-AccessType ] [-InheritanceFlags ] [-PropagationFlags ] [-PassThru] [] ``` ### PathSimple - -```PowerShell +``` Add-NTFSAccess [-Path] [-Account] [-AccessRights] [-AccessType ] [-AppliesTo ] [-PassThru] [] ``` ### SDSimple - -```PowerShell +``` Add-NTFSAccess [-SecurityDescriptor] [-Account] [-AccessRights] [-AccessType ] [-AppliesTo ] [-PassThru] [] ``` ### SDComplex - -```PowerShell +``` Add-NTFSAccess [-SecurityDescriptor] [-Account] [-AccessRights] [-AccessType ] [-InheritanceFlags ] [-PropagationFlags ] [-PassThru] [] @@ -46,25 +42,9 @@ Add-NTFSAccess [-SecurityDescriptor] [-Account] Add-NTFSAccess -Path C:\Data -Account 'NT AUTHORITY\Authenticated Users' -AccessRights Read -``` - -The above command gives the read permissions to the built-in group of 'Authenticated users' - -## PARAMETERS - -### -AccessRights - -The AccessRights parameter designates the permissions to assign. There are individual permissions as well as 'basic' permissions. See the below table for how the basic permissions permissions map the the advanced permissions in the advanced security window. - -| AccessRights Applied | AccessRight displayed | Advanced Security Window | +| NTFSSecurity | AccessRight displayed | Advanced Security Window | |------------------------------|------------------------------|---------------------------------------------------------------------------------------------------------------------------| | ReadData | ListDirectory | List Folder / Read Data | | ListDirectory | ListDirectory | List Folder / Read Data | @@ -87,6 +67,22 @@ The AccessRights parameter designates the permissions to assign. There are indiv | Modify | Modify | Everything except Full Control, Delete SubFolders and Files, Change Permissions, Take Ownership | | ChangePermissions | ChangePermissions | Change Permissions | +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> Add-NTFSAccess -Path C:\Data -Account 'NT AUTHORITY\Authenticated Users' -AccessRights Read +``` + +The above command gives the read permissions to the built-in group of 'Authenticated users' + +## PARAMETERS + +### -AccessRights + +The AccessRights parameter designates the permissions to assign. There are individual permissions as well as 'basic' permissions. See the below table for how the basic permissions permissions map the the advanced permissions in the advanced security window. + ```yaml Type: FileSystemRights2 Parameter Sets: (All) @@ -233,7 +229,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Permissions.md b/Docs/Permissions.md new file mode 100644 index 0000000..62ba312 --- /dev/null +++ b/Docs/Permissions.md @@ -0,0 +1,98 @@ +# Permissions + +## Overview + +Before starting with the NTFSSecurity module there are some core concepts that you will need to understand. + +There are two ways you can handle permissions, basic and advanced. The basic set of permissions are goups of advanced permissions that allow you to assign common role such as 'Read', 'Read/Write', or 'Full'. Advanced permissions allow you granular control of what can and can't be access or used. The advanced permissions are commonly used to build custom Role-Based Access Control tooling. + +Below is an explaination taken from the fantastic site NTFS.com for each of the advanced file permissions. + +### Traverse Folder/Execute File + +* **Traverse Folder**: Allows or denies moving through a restricted folder to reach files and folders beneath the restricted folder in the folder hierarchy. Traverse folder takes effect only when the group or user is not granted the "Bypass traverse checking user" right in the Group Policy snap-in. This permission does not automatically allow running program files. + +* **Execute File**: Allows or denies running program (executable) files. + +### List Folder/Read Data + +* **List Folder**: Allows or denies viewing file names and subfolder names within the folder. List Folder only affects the contents of that folder and does not affect whether the folder you are setting the permission on will be listed. + +* **Read Data**: Allows or denies viewing data in files. + +### Read Attributes + +* Allows or denies viewing the attributes of a file or folder, for example, "read-only" and "hidden". + +### Read Extended Attributes + +* Allows or denies viewing the extended attributes of a file or folder. Extended attributes are defined by programs and may vary by program. + +### Create Files/Write Data + +* **Create Files**: Allows or denies creating files within the folder. + +* **Write Data**: Allows or denies making changes to a file and overwriting existing content. + +### Create Folders/Append Data + +* **Create Folders**: Allows or denies creating subfolders within the folder. + +* **Append Data**: Allows or denies making changes to the end of the file but not changing, deleting, or overwriting existing data. + +### Write Attributes + +* Allows or denies changing the attributes of a file or folder, for example, "read-only" or "hidden". + +* The Write Attributes permission does not imply creating or deleting files or folders, it only includes the permission to make changes to the attributes of an existing file or folder. + +### Write Extended Attributes + +* Allows or denies changing the extended attributes of a file or folder. Extended attributes are defined by programs and may vary by program. + +* The Write Extended Attributes permission does not imply creating or deleting files or folders, it only includes the permission to make changes to the extended attributes of an existing file or folder. + +### Delete Subfolders and Files + +* Allows or denies deleting subfolders and files, even if the Delete permission has not been granted on the subfolder or file. + +### Delete + +* Allows or denies deleting the file or folder. If you don't have Delete permission on a file or folder, you can still delete it if you have been granted Delete Subfolders and Files on the parent folder. + +### Read Permissions + +* Allows or denies reading permissions of a file or folder. + +### Change Permissions + +* Allows or denies changing permissions of the file or folder. + +### Take Ownership + +* Allows or denies taking ownership of the file or folder. The owner of a file or folder can always change permissions on it, regardless of any existing permissions that protect the file or folder. + +You can see how the basic permissions, advanced permissions, and the NTFSSecurity module relate to one another in the below table. + +| NTFSSecurity | AccessRight displayed | Advanced Security Window | +|------------------------------|------------------------------|---------------------------------------------------------------------------------------------------------------------------| +| ReadData | ListDirectory | List Folder / Read Data | +| ListDirectory | ListDirectory | List Folder / Read Data | +| WriteData | CreateFile | Create Files / Write Data | +| CreateFiles | CreateFile | Create Files / Write Data | +| AppendData | CreateDirectories | Create Folders / Append Data | +| CreateDirectories | CreateDirectories | Create Folders / Append Data | +| ReadExtendedAttributes | ReadExtendedAttributes | Read Extended Attributes | +| WriteExtendedAttributes | WriteExtendedAttributes | WriteExtendedAttributes | +| ExecuteFile | Traverse | Traverse Folder / Execute File | +| Traverse | Traverse | Traverse Folder / Execute File | +| DeleteSubdirectoriesAndFiles | DeleteSubdirectoriesAndFiles | Delete Sub-folders and Files | +| ReadAttributes | ReadAttributes | Read Attributes | +| WriteAttributes | WriteAttributes | Write Attributes | +| Write | Write | Create Files / Write Data, Create Folders / Append Data, Write-Attributes, Write Extended Attributes | +| Delete | Delete | Delete | +| ReadPermissions | ReadPermissions | Read Permissions | +| Read | Read | List Folder / Read Data, Read Attributes, Read Extended Attributes, Read Permissions | +| ReadAndExecute | ReadAndExecute | Traverse Folder / Execute File, List Folder / Read Data, Read Attributes, Read Extended Attributes, Read Permissions | +| Modify | Modify | Everything except Full Control, Delete SubFolders and Files, Change Permissions, Take Ownership | +| ChangePermissions | ChangePermissions | Change Permissions | diff --git a/Docs/index.md b/Docs/index.md index da66399..a8924b9 100644 --- a/Docs/index.md +++ b/Docs/index.md @@ -21,9 +21,11 @@ Further help can be found in How to install if you face difficulties getting thi ## Documentation -The cmdlets are yet not documented completely so Get-Help will not show help for all the cmdlets. Providing documentation is planned though. +The cmdlets are yet not documented completely so Get-Help will not show help for all the cmdlets. This ReadTheDocs site is the first step to documenting the module. -## Additional documentation is available +## Tutorials + +There are a number of tutorials available on the web. The below two were written by the author of the NTFSSecurity module. [NTFSSecurity Tutorial 1 - Getting, adding and removing permissions](http://blogs.technet.com/b/fieldcoding/archive/2014/12/05/ntfssecurity-tutorial-1-getting-adding-and-removing-permissions.aspx) [NTFSSecurity Tutorial 2 - Managing NTFS Inheritance and Using Privileges](http://blogs.technet.com/b/fieldcoding/archive/2014/12/05/ntfssecurity-tutorial-2-managing-ntfs-inheritance-and-using-privileges.aspx) From 11f4f0b80c48521df4c8a1c16b057dbb8d1ec8b6 Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Tue, 15 Oct 2019 22:32:43 +1100 Subject: [PATCH 36/44] added the primer to the menu --- mkdocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/mkdocs.yml b/mkdocs.yml index 5849386..efc6b89 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,6 +2,7 @@ copyright: The NTFSSecurity module is licensed under the MIT license -repo_url: https://github.com/raandree/NTFSSecurity -nav: -- Home: ./Index.md -- Cmdlets: - - Add-NTFSAccess: Cmdlets/Add-NTFSAccess.md - - Add-NTFSAudit: Cmdlets/Add-NTFSAudit.md - - Clear-NTFSAccess: Cmdlets/Clear-NTFSAccess.md - - Clear-NTFSAudit: Cmdlets/Clear-NTFSAudit.md - - Copy-Item2: Cmdlets/Copy-Item2.md - - Disable-NTFSAccessInheritance: Cmdlets/Disable-NTFSAccessInheritance.md - - Disable-NTFSAuditInheritance: Cmdlets/Disable-NTFSAuditInheritance.md - - Disable-Privileges: Cmdlets/Disable-Privileges.md - - Enable-NTFSAccessInheritance: Cmdlets/Enable-NTFSAccessInheritance.md - - Enable-NTFSAuditInheritance: Cmdlets/Enable-NTFSAuditInheritance.md - - Enable-Privileges: Cmdlets/Enable-Privileges.md - - Get-ChildItem2: Cmdlets/Get-ChildItem2.md - - Get-DiskSpace: Cmdlets/Get-DiskSpace.md - - Get-FileHash2: Cmdlets/Get-FileHash2.md - - Get-Item2: Cmdlets/Get-Item2.md - - Get-NTFSAccess: Cmdlets/Get-NTFSAccess.md - - Get-NTFSAudit: Cmdlets/Get-NTFSAudit.md - - Get-NTFSEffectiveAccess: Cmdlets/Get-NTFSEffectiveAccess.md - - Get-NTFSHardLink: Cmdlets/Get-NTFSHardLink.md - - Get-NTFSInheritance: Cmdlets/Get-NTFSInheritance.md - - Get-NTFSOrphanedAccess: Cmdlets/Get-NTFSOrphanedAccess.md - - Get-NTFSOrphanedAudit: Cmdlets/Get-NTFSOrphanedAudit.md - - Get-NTFSOwner: Cmdlets/Get-NTFSOwner.md - - Get-NTFSSecurityDescriptor: Cmdlets/Get-NTFSSecurityDescriptor.md - - Get-NTFSSimpleAccess: Cmdlets/Get-NTFSSimpleAccess.md - - Get-Privileges: Cmdlets/Get-Privileges.md - - Move-Item2: Cmdlets/Move-Item2.md - - New-NTFSHardLink: Cmdlets/New-NTFSHardLink.md - - New-NTFSSymbolicLink: Cmdlets/New-NTFSSymbolicLink.md - - Remove-Item2: Cmdlets/Remove-Item2.md - - Remove-NTFSAccess: Cmdlets/Remove-NTFSAccess.md - - Remove-NTFSAudit: Cmdlets/Remove-NTFSAudit.md - - Set-NTFSInheritance: Cmdlets/Set-NTFSInheritance.md - - Set-NTFSOwner: Cmdlets/Set-NTFSOwner.md - - Set-NTFSSecurityDescriptor: Cmdlets/Set-NTFSSecurityDescriptor.md - - Test-Path2: Cmdlets/Test-Path2.md -- Contributing: - - Getting Started: Contributing/01-Getting-Started.md - - Writing: Contributing/02-Writing.md - - Style Guide: Contributing/03-Style-Guide.md - - Markdown Specifics: Contributing:04-Markdown-Specifics.md -site_name: NTFSSecurity -theme: readthedocs -site_author: Raimund Andrée, James Smith -edit_uri: edit/master/Help/ -docs_dir: ./Docs \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index efc6b89..a25b256 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,7 +2,7 @@ copyright: The NTFSSecurity module is licensed under the Date: Sun, 20 Oct 2019 16:57:47 +1100 Subject: [PATCH 40/44] Fixed Markdown linting --- Docs/Cmdlets/Add-NTFSAccess.md | 13 ++++++--- Docs/Cmdlets/Add-NTFSAudit.md | 27 +++++++++++++++---- Docs/Cmdlets/Clear-NTFSAccess.md | 16 ++++++++--- Docs/Cmdlets/Clear-NTFSAudit.md | 16 ++++++++--- Docs/Cmdlets/Copy-Item2.md | 15 +++++++++-- Docs/Cmdlets/Disable-NTFSAccessInheritance.md | 17 +++++++++--- Docs/Cmdlets/Disable-NTFSAuditInheritance.md | 17 +++++++++--- Docs/Cmdlets/Disable-Privileges.md | 9 +++++-- Docs/Cmdlets/Enable-NTFSAccessInheritance.md | 17 +++++++++--- Docs/Cmdlets/Enable-NTFSAuditInheritance.md | 17 +++++++++--- Docs/Cmdlets/Enable-Privileges.md | 9 +++++-- Docs/Cmdlets/Get-ChildItem2.md | 21 +++++++++++++-- Docs/Cmdlets/Get-DiskSpace.md | 9 +++++-- Docs/Cmdlets/Get-FileHash2.md | 9 ++++++- Docs/Cmdlets/Get-Item2.md | 9 +++++-- Docs/Cmdlets/Get-NTFSAccess.md | 17 +++++++++--- Docs/Cmdlets/Get-NTFSAudit.md | 17 +++++++++--- Docs/Cmdlets/Get-NTFSEffectiveAccess.md | 17 +++++++++--- Docs/Cmdlets/Get-NTFSHardLink.md | 9 +++++-- Docs/Cmdlets/Get-NTFSInheritance.md | 14 +++++++--- Docs/Cmdlets/Get-NTFSOrphanedAccess.md | 17 +++++++++--- Docs/Cmdlets/Get-NTFSOrphanedAudit.md | 17 +++++++++--- Docs/Cmdlets/Get-NTFSOwner.md | 14 +++++++--- Docs/Cmdlets/Get-NTFSSecurityDescriptor.md | 9 +++++-- Docs/Cmdlets/Get-NTFSSimpleAccess.md | 18 ++++++++++--- Docs/Cmdlets/Get-Privileges.md | 8 ++++-- Docs/Cmdlets/Move-Item2.md | 15 +++++++++-- Docs/Cmdlets/New-NTFSHardLink.md | 11 ++++++-- Docs/Cmdlets/New-NTFSSymbolicLink.md | 11 ++++++-- Docs/Cmdlets/Remove-Item2.md | 15 +++++++++-- Docs/Cmdlets/Remove-NTFSAccess.md | 27 +++++++++++++++---- Docs/Cmdlets/Remove-NTFSAudit.md | 27 +++++++++++++++---- Docs/Cmdlets/Set-NTFSInheritance.md | 18 ++++++++++--- Docs/Cmdlets/Set-NTFSOwner.md | 16 ++++++++--- Docs/Cmdlets/Set-NTFSSecurityDescriptor.md | 10 +++++-- Docs/Cmdlets/Test-Path2.md | 10 +++++-- Docs/Contributing.md | 2 +- 37 files changed, 441 insertions(+), 99 deletions(-) diff --git a/Docs/Cmdlets/Add-NTFSAccess.md b/Docs/Cmdlets/Add-NTFSAccess.md index 98cc4b8..015835b 100644 --- a/Docs/Cmdlets/Add-NTFSAccess.md +++ b/Docs/Cmdlets/Add-NTFSAccess.md @@ -14,27 +14,31 @@ Adds an access control entry (ACE) to an object. ## SYNTAX ### PathComplex (Default) -``` + +```PowerShell Add-NTFSAccess [-Path] [-Account] [-AccessRights] [-AccessType ] [-InheritanceFlags ] [-PropagationFlags ] [-PassThru] [] ``` ### PathSimple -``` + +```PowerShell Add-NTFSAccess [-Path] [-Account] [-AccessRights] [-AccessType ] [-AppliesTo ] [-PassThru] [] ``` ### SDSimple -``` + +```PowerShell Add-NTFSAccess [-SecurityDescriptor] [-Account] [-AccessRights] [-AccessType ] [-AppliesTo ] [-PassThru] [] ``` ### SDComplex -``` + +```PowerShell Add-NTFSAccess [-SecurityDescriptor] [-Account] [-AccessRights] [-AccessType ] [-InheritanceFlags ] [-PropagationFlags ] [-PassThru] [] @@ -229,6 +233,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Add-NTFSAudit.md b/Docs/Cmdlets/Add-NTFSAudit.md index 7dc5089..418ac26 100644 --- a/Docs/Cmdlets/Add-NTFSAudit.md +++ b/Docs/Cmdlets/Add-NTFSAudit.md @@ -8,44 +8,51 @@ schema: 2.0.0 # Add-NTFSAudit ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX ### PathComplex (Default) -``` + +```PowerShell Add-NTFSAudit [-Path] [-Account] [-AccessRights] [-AuditFlags ] [-InheritanceFlags ] [-PropagationFlags ] [-PassThru] [] ``` ### PathSimple -``` + +```PowerShell Add-NTFSAudit [-Path] [-Account] [-AccessRights] [-AuditFlags ] [-AppliesTo ] [-PassThru] [] ``` ### SDSimple -``` + +```PowerShell Add-NTFSAudit [-SecurityDescriptor] [-Account] [-AccessRights] [-AuditFlags ] [-AppliesTo ] [-PassThru] [] ``` ### SDComplex -``` + +```PowerShell Add-NTFSAudit [-SecurityDescriptor] [-Account] [-AccessRights] [-AuditFlags ] [-InheritanceFlags ] [-PropagationFlags ] [-PassThru] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -54,6 +61,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -AccessRights + {{ Fill AccessRights Description }} ```yaml @@ -70,6 +78,7 @@ Accept wildcard characters: False ``` ### -Account + {{ Fill Account Description }} ```yaml @@ -85,6 +94,7 @@ Accept wildcard characters: False ``` ### -AppliesTo + {{ Fill AppliesTo Description }} ```yaml @@ -101,6 +111,7 @@ Accept wildcard characters: False ``` ### -AuditFlags + {{ Fill AuditFlags Description }} ```yaml @@ -117,6 +128,7 @@ Accept wildcard characters: False ``` ### -InheritanceFlags + {{ Fill InheritanceFlags Description }} ```yaml @@ -133,6 +145,7 @@ Accept wildcard characters: False ``` ### -PassThru + {{ Fill PassThru Description }} ```yaml @@ -148,6 +161,7 @@ Accept wildcard characters: False ``` ### -Path + {{ Fill Path Description }} ```yaml @@ -163,6 +177,7 @@ Accept wildcard characters: False ``` ### -PropagationFlags + {{ Fill PropagationFlags Description }} ```yaml @@ -179,6 +194,7 @@ Accept wildcard characters: False ``` ### -SecurityDescriptor + {{ Fill SecurityDescriptor Description }} ```yaml @@ -194,6 +210,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Clear-NTFSAccess.md b/Docs/Cmdlets/Clear-NTFSAccess.md index 060705e..906b0f1 100644 --- a/Docs/Cmdlets/Clear-NTFSAccess.md +++ b/Docs/Cmdlets/Clear-NTFSAccess.md @@ -8,27 +8,32 @@ schema: 2.0.0 # Clear-NTFSAccess ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX ### Path (Default) -``` + +```PowerShell Clear-NTFSAccess [-Path] [-DisableInheritance] [] ``` ### SD -``` + +```PowerShell Clear-NTFSAccess [-SecurityDescriptor] [-DisableInheritance] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -37,6 +42,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -DisableInheritance + {{ Fill DisableInheritance Description }} ```yaml @@ -52,6 +58,7 @@ Accept wildcard characters: False ``` ### -Path + {{ Fill Path Description }} ```yaml @@ -67,6 +74,7 @@ Accept wildcard characters: False ``` ### -SecurityDescriptor + {{ Fill SecurityDescriptor Description }} ```yaml @@ -82,6 +90,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -93,6 +102,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/Docs/Cmdlets/Clear-NTFSAudit.md b/Docs/Cmdlets/Clear-NTFSAudit.md index dc09927..9769bc4 100644 --- a/Docs/Cmdlets/Clear-NTFSAudit.md +++ b/Docs/Cmdlets/Clear-NTFSAudit.md @@ -8,27 +8,32 @@ schema: 2.0.0 # Clear-NTFSAudit ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX ### Path (Default) -``` + +```PowerShell Clear-NTFSAudit [-Path] [-DisableInheritance] [] ``` ### SD -``` + +```PowerShell Clear-NTFSAudit [-SecurityDescriptor] [-DisableInheritance] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -37,6 +42,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -DisableInheritance + {{ Fill DisableInheritance Description }} ```yaml @@ -52,6 +58,7 @@ Accept wildcard characters: False ``` ### -Path + {{ Fill Path Description }} ```yaml @@ -67,6 +74,7 @@ Accept wildcard characters: False ``` ### -SecurityDescriptor + {{ Fill SecurityDescriptor Description }} ```yaml @@ -82,6 +90,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -93,6 +102,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/Docs/Cmdlets/Copy-Item2.md b/Docs/Cmdlets/Copy-Item2.md index 0dd5b18..87751df 100644 --- a/Docs/Cmdlets/Copy-Item2.md +++ b/Docs/Cmdlets/Copy-Item2.md @@ -8,22 +8,25 @@ schema: 2.0.0 # Copy-Item2 ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX -``` +```PowerShell Copy-Item2 [-Path] [-Destination] [-Force] [-PassThru ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -32,6 +35,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -47,6 +51,7 @@ Accept wildcard characters: False ``` ### -Destination + {{ Fill Destination Description }} ```yaml @@ -62,6 +67,7 @@ Accept wildcard characters: False ``` ### -Force + {{ Fill Force Description }} ```yaml @@ -77,6 +83,7 @@ Accept wildcard characters: False ``` ### -PassThru + {{ Fill PassThru Description }} ```yaml @@ -92,6 +99,7 @@ Accept wildcard characters: False ``` ### -Path + {{ Fill Path Description }} ```yaml @@ -107,6 +115,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -123,6 +132,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -134,6 +144,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/Docs/Cmdlets/Disable-NTFSAccessInheritance.md b/Docs/Cmdlets/Disable-NTFSAccessInheritance.md index 24fff2c..5c1c487 100644 --- a/Docs/Cmdlets/Disable-NTFSAccessInheritance.md +++ b/Docs/Cmdlets/Disable-NTFSAccessInheritance.md @@ -8,29 +8,34 @@ schema: 2.0.0 # Disable-NTFSAccessInheritance ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX ### Path (Default) -``` + +```PowerShell Disable-NTFSAccessInheritance [[-Path] ] [-RemoveInheritedAccessRules] [-PassThru] [] ``` ### SecurityDescriptor -``` + +```PowerShell Disable-NTFSAccessInheritance [-SecurityDescriptor] [-RemoveInheritedAccessRules] [-PassThru] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -39,6 +44,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -PassThru + {{ Fill PassThru Description }} ```yaml @@ -54,6 +60,7 @@ Accept wildcard characters: False ``` ### -Path + {{ Fill Path Description }} ```yaml @@ -69,6 +76,7 @@ Accept wildcard characters: False ``` ### -RemoveInheritedAccessRules + {{ Fill RemoveInheritedAccessRules Description }} ```yaml @@ -84,6 +92,7 @@ Accept wildcard characters: False ``` ### -SecurityDescriptor + {{ Fill SecurityDescriptor Description }} ```yaml @@ -99,6 +108,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -110,6 +120,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/Docs/Cmdlets/Disable-NTFSAuditInheritance.md b/Docs/Cmdlets/Disable-NTFSAuditInheritance.md index 79273f0..d82a931 100644 --- a/Docs/Cmdlets/Disable-NTFSAuditInheritance.md +++ b/Docs/Cmdlets/Disable-NTFSAuditInheritance.md @@ -8,29 +8,34 @@ schema: 2.0.0 # Disable-NTFSAuditInheritance ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX ### Path (Default) -``` + +```PowerShell Disable-NTFSAuditInheritance [[-Path] ] [-RemoveInheritedAccessRules] [-PassThru] [] ``` ### SecurityDescriptor -``` + +```PowerShell Disable-NTFSAuditInheritance [-SecurityDescriptor] [-RemoveInheritedAccessRules] [-PassThru] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -39,6 +44,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -PassThru + {{ Fill PassThru Description }} ```yaml @@ -54,6 +60,7 @@ Accept wildcard characters: False ``` ### -Path + {{ Fill Path Description }} ```yaml @@ -69,6 +76,7 @@ Accept wildcard characters: False ``` ### -RemoveInheritedAccessRules + {{ Fill RemoveInheritedAccessRules Description }} ```yaml @@ -84,6 +92,7 @@ Accept wildcard characters: False ``` ### -SecurityDescriptor + {{ Fill SecurityDescriptor Description }} ```yaml @@ -99,6 +108,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -110,6 +120,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/Docs/Cmdlets/Disable-Privileges.md b/Docs/Cmdlets/Disable-Privileges.md index 475f4d4..ada8e73 100644 --- a/Docs/Cmdlets/Disable-Privileges.md +++ b/Docs/Cmdlets/Disable-Privileges.md @@ -8,21 +8,24 @@ schema: 2.0.0 # Disable-Privileges ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX -``` +```PowerShell Disable-Privileges [-PassThru] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -31,6 +34,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -PassThru + {{ Fill PassThru Description }} ```yaml @@ -46,6 +50,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Enable-NTFSAccessInheritance.md b/Docs/Cmdlets/Enable-NTFSAccessInheritance.md index 44ecbf0..bd1dbce 100644 --- a/Docs/Cmdlets/Enable-NTFSAccessInheritance.md +++ b/Docs/Cmdlets/Enable-NTFSAccessInheritance.md @@ -8,28 +8,33 @@ schema: 2.0.0 # Enable-NTFSAccessInheritance ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX ### Path (Default) -``` + +```PowerShell Enable-NTFSAccessInheritance [[-Path] ] [-PassThru] [-RemoveExplicitAccessRules] [] ``` ### SecurityDescriptor -``` + +```PowerShell Enable-NTFSAccessInheritance [-SecurityDescriptor] [-PassThru] [-RemoveExplicitAccessRules] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -38,6 +43,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -PassThru + {{ Fill PassThru Description }} ```yaml @@ -53,6 +59,7 @@ Accept wildcard characters: False ``` ### -Path + {{ Fill Path Description }} ```yaml @@ -68,6 +75,7 @@ Accept wildcard characters: False ``` ### -RemoveExplicitAccessRules + {{ Fill RemoveExplicitAccessRules Description }} ```yaml @@ -83,6 +91,7 @@ Accept wildcard characters: False ``` ### -SecurityDescriptor + {{ Fill SecurityDescriptor Description }} ```yaml @@ -98,6 +107,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -109,6 +119,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/Docs/Cmdlets/Enable-NTFSAuditInheritance.md b/Docs/Cmdlets/Enable-NTFSAuditInheritance.md index 8eb634c..59cb16a 100644 --- a/Docs/Cmdlets/Enable-NTFSAuditInheritance.md +++ b/Docs/Cmdlets/Enable-NTFSAuditInheritance.md @@ -8,28 +8,33 @@ schema: 2.0.0 # Enable-NTFSAuditInheritance ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX ### Path (Default) -``` + +```PowerShell Enable-NTFSAuditInheritance [[-Path] ] [-PassThru] [-RemoveExplicitAccessRules] [] ``` ### SecurityDescriptor -``` + +```PowerShell Enable-NTFSAuditInheritance [-SecurityDescriptor] [-PassThru] [-RemoveExplicitAccessRules] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -38,6 +43,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -PassThru + {{ Fill PassThru Description }} ```yaml @@ -53,6 +59,7 @@ Accept wildcard characters: False ``` ### -Path + {{ Fill Path Description }} ```yaml @@ -68,6 +75,7 @@ Accept wildcard characters: False ``` ### -RemoveExplicitAccessRules + {{ Fill RemoveExplicitAccessRules Description }} ```yaml @@ -83,6 +91,7 @@ Accept wildcard characters: False ``` ### -SecurityDescriptor + {{ Fill SecurityDescriptor Description }} ```yaml @@ -98,6 +107,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -109,6 +119,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/Docs/Cmdlets/Enable-Privileges.md b/Docs/Cmdlets/Enable-Privileges.md index 57d9214..395b303 100644 --- a/Docs/Cmdlets/Enable-Privileges.md +++ b/Docs/Cmdlets/Enable-Privileges.md @@ -8,21 +8,24 @@ schema: 2.0.0 # Enable-Privileges ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX -``` +```PowerShell Enable-Privileges [-PassThru] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -31,6 +34,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -PassThru + {{ Fill PassThru Description }} ```yaml @@ -46,6 +50,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-ChildItem2.md b/Docs/Cmdlets/Get-ChildItem2.md index f3852d9..745f950 100644 --- a/Docs/Cmdlets/Get-ChildItem2.md +++ b/Docs/Cmdlets/Get-ChildItem2.md @@ -8,23 +8,26 @@ schema: 2.0.0 # Get-ChildItem2 ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX -``` +```PowerShell Get-ChildItem2 [[-Path] ] [[-Filter] ] [-Recurse] [-Directory] [-File] [-Attributes ] [-Hidden] [-System] [-ReadOnly] [-Force] [-SkipMountPoints] [-SkipSymbolicLinks] [-Depth ] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -33,6 +36,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -Attributes + {{ Fill Attributes Description }} ```yaml @@ -49,6 +53,7 @@ Accept wildcard characters: False ``` ### -Depth + {{ Fill Depth Description }} ```yaml @@ -64,6 +69,7 @@ Accept wildcard characters: False ``` ### -Directory + {{ Fill Directory Description }} ```yaml @@ -79,6 +85,7 @@ Accept wildcard characters: False ``` ### -File + {{ Fill File Description }} ```yaml @@ -94,6 +101,7 @@ Accept wildcard characters: False ``` ### -Filter + {{ Fill Filter Description }} ```yaml @@ -109,6 +117,7 @@ Accept wildcard characters: False ``` ### -Force + {{ Fill Force Description }} ```yaml @@ -124,6 +133,7 @@ Accept wildcard characters: False ``` ### -Hidden + {{ Fill Hidden Description }} ```yaml @@ -139,6 +149,7 @@ Accept wildcard characters: False ``` ### -Path + {{ Fill Path Description }} ```yaml @@ -154,6 +165,7 @@ Accept wildcard characters: False ``` ### -ReadOnly + {{ Fill ReadOnly Description }} ```yaml @@ -169,6 +181,7 @@ Accept wildcard characters: False ``` ### -Recurse + {{ Fill Recurse Description }} ```yaml @@ -184,6 +197,7 @@ Accept wildcard characters: False ``` ### -SkipMountPoints + {{ Fill SkipMountPoints Description }} ```yaml @@ -199,6 +213,7 @@ Accept wildcard characters: False ``` ### -SkipSymbolicLinks + {{ Fill SkipSymbolicLinks Description }} ```yaml @@ -214,6 +229,7 @@ Accept wildcard characters: False ``` ### -System + {{ Fill System Description }} ```yaml @@ -229,6 +245,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-DiskSpace.md b/Docs/Cmdlets/Get-DiskSpace.md index a037eb9..c9ef7ef 100644 --- a/Docs/Cmdlets/Get-DiskSpace.md +++ b/Docs/Cmdlets/Get-DiskSpace.md @@ -8,21 +8,24 @@ schema: 2.0.0 # Get-DiskSpace ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX -``` +```PowerShell Get-DiskSpace [[-DriveLetter] ] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -31,6 +34,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -DriveLetter + {{ Fill DriveLetter Description }} ```yaml @@ -46,6 +50,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-FileHash2.md b/Docs/Cmdlets/Get-FileHash2.md index 703c223..6632688 100644 --- a/Docs/Cmdlets/Get-FileHash2.md +++ b/Docs/Cmdlets/Get-FileHash2.md @@ -8,21 +8,25 @@ schema: 2.0.0 # Get-FileHash2 ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX ``` + Get-FileHash2 [-Path] [[-Algorithm] ] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -31,6 +35,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -Algorithm + {{ Fill Algorithm Description }} ```yaml @@ -47,6 +52,7 @@ Accept wildcard characters: False ``` ### -Path + {{ Fill Path Description }} ```yaml @@ -62,6 +68,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-Item2.md b/Docs/Cmdlets/Get-Item2.md index 1fc13e8..ac67beb 100644 --- a/Docs/Cmdlets/Get-Item2.md +++ b/Docs/Cmdlets/Get-Item2.md @@ -8,21 +8,24 @@ schema: 2.0.0 # Get-Item2 ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX -``` +```PowerShell Get-Item2 [[-Path] ] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -31,6 +34,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -Path + {{ Fill Path Description }} ```yaml @@ -46,6 +50,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-NTFSAccess.md b/Docs/Cmdlets/Get-NTFSAccess.md index f07f251..0dc8b50 100644 --- a/Docs/Cmdlets/Get-NTFSAccess.md +++ b/Docs/Cmdlets/Get-NTFSAccess.md @@ -8,29 +8,34 @@ schema: 2.0.0 # Get-NTFSAccess ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX ### Path (Default) -``` + +```PowerShell Get-NTFSAccess [[-Path] ] [-Account ] [-ExcludeExplicit] [-ExcludeInherited] [] ``` ### SD -``` + +```PowerShell Get-NTFSAccess [-SecurityDescriptor] [-Account ] [-ExcludeExplicit] [-ExcludeInherited] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -39,6 +44,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -Account + {{ Fill Account Description }} ```yaml @@ -54,6 +60,7 @@ Accept wildcard characters: False ``` ### -ExcludeExplicit + {{ Fill ExcludeExplicit Description }} ```yaml @@ -69,6 +76,7 @@ Accept wildcard characters: False ``` ### -ExcludeInherited + {{ Fill ExcludeInherited Description }} ```yaml @@ -84,6 +92,7 @@ Accept wildcard characters: False ``` ### -Path + {{ Fill Path Description }} ```yaml @@ -99,6 +108,7 @@ Accept wildcard characters: False ``` ### -SecurityDescriptor + {{ Fill SecurityDescriptor Description }} ```yaml @@ -114,6 +124,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-NTFSAudit.md b/Docs/Cmdlets/Get-NTFSAudit.md index 29c968d..2d1663a 100644 --- a/Docs/Cmdlets/Get-NTFSAudit.md +++ b/Docs/Cmdlets/Get-NTFSAudit.md @@ -8,29 +8,34 @@ schema: 2.0.0 # Get-NTFSAudit ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX ### Path -``` + +```PowerShell Get-NTFSAudit [[-Path] ] [-Account ] [-ExcludeExplicit] [-ExcludeInherited] [] ``` ### SD -``` + +```PowerShell Get-NTFSAudit [-SecurityDescriptor] [-Account ] [-ExcludeExplicit] [-ExcludeInherited] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -39,6 +44,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -Account + {{ Fill Account Description }} ```yaml @@ -54,6 +60,7 @@ Accept wildcard characters: False ``` ### -ExcludeExplicit + {{ Fill ExcludeExplicit Description }} ```yaml @@ -69,6 +76,7 @@ Accept wildcard characters: False ``` ### -ExcludeInherited + {{ Fill ExcludeInherited Description }} ```yaml @@ -84,6 +92,7 @@ Accept wildcard characters: False ``` ### -Path + {{ Fill Path Description }} ```yaml @@ -99,6 +108,7 @@ Accept wildcard characters: False ``` ### -SecurityDescriptor + {{ Fill SecurityDescriptor Description }} ```yaml @@ -114,6 +124,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-NTFSEffectiveAccess.md b/Docs/Cmdlets/Get-NTFSEffectiveAccess.md index 58b66f1..f4622ce 100644 --- a/Docs/Cmdlets/Get-NTFSEffectiveAccess.md +++ b/Docs/Cmdlets/Get-NTFSEffectiveAccess.md @@ -8,29 +8,34 @@ schema: 2.0.0 # Get-NTFSEffectiveAccess ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX ### Path (Default) -``` + +```PowerShell Get-NTFSEffectiveAccess [[-Path] ] [[-Account] ] [-ServerName ] [-ExcludeNoneAccessEntries] [] ``` ### SecurityDescriptor -``` + +```PowerShell Get-NTFSEffectiveAccess [-SecurityDescriptor] [[-Account] ] [-ServerName ] [-ExcludeNoneAccessEntries] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -39,6 +44,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -Account + {{ Fill Account Description }} ```yaml @@ -54,6 +60,7 @@ Accept wildcard characters: False ``` ### -ExcludeNoneAccessEntries + {{ Fill ExcludeNoneAccessEntries Description }} ```yaml @@ -69,6 +76,7 @@ Accept wildcard characters: False ``` ### -Path + {{ Fill Path Description }} ```yaml @@ -84,6 +92,7 @@ Accept wildcard characters: False ``` ### -SecurityDescriptor + {{ Fill SecurityDescriptor Description }} ```yaml @@ -99,6 +108,7 @@ Accept wildcard characters: False ``` ### -ServerName + {{ Fill ServerName Description }} ```yaml @@ -114,6 +124,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-NTFSHardLink.md b/Docs/Cmdlets/Get-NTFSHardLink.md index 6718e09..ce82f82 100644 --- a/Docs/Cmdlets/Get-NTFSHardLink.md +++ b/Docs/Cmdlets/Get-NTFSHardLink.md @@ -8,21 +8,24 @@ schema: 2.0.0 # Get-NTFSHardLink ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX -``` +```PowerShell Get-NTFSHardLink [[-Path] ] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -31,6 +34,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -Path + {{ Fill Path Description }} ```yaml @@ -46,6 +50,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-NTFSInheritance.md b/Docs/Cmdlets/Get-NTFSInheritance.md index 44e9156..f5b6833 100644 --- a/Docs/Cmdlets/Get-NTFSInheritance.md +++ b/Docs/Cmdlets/Get-NTFSInheritance.md @@ -8,27 +8,32 @@ schema: 2.0.0 # Get-NTFSInheritance ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX ### Path (Default) -``` + +```PowerShell Get-NTFSInheritance [[-Path] ] [] ``` ### SecurityDescriptor -``` + +```PowerShell Get-NTFSInheritance [-SecurityDescriptor] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -37,6 +42,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -Path + {{ Fill Path Description }} ```yaml @@ -52,6 +58,7 @@ Accept wildcard characters: False ``` ### -SecurityDescriptor + {{ Fill SecurityDescriptor Description }} ```yaml @@ -67,6 +74,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-NTFSOrphanedAccess.md b/Docs/Cmdlets/Get-NTFSOrphanedAccess.md index 80f9a7c..9a08488 100644 --- a/Docs/Cmdlets/Get-NTFSOrphanedAccess.md +++ b/Docs/Cmdlets/Get-NTFSOrphanedAccess.md @@ -8,29 +8,34 @@ schema: 2.0.0 # Get-NTFSOrphanedAccess ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX ### Path -``` + +```PowerShell Get-NTFSOrphanedAccess [[-Path] ] [-Account ] [-ExcludeExplicit] [-ExcludeInherited] [] ``` ### SD -``` + +```PowerShell Get-NTFSOrphanedAccess [-SecurityDescriptor] [-Account ] [-ExcludeExplicit] [-ExcludeInherited] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -39,6 +44,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -Account + {{ Fill Account Description }} ```yaml @@ -54,6 +60,7 @@ Accept wildcard characters: False ``` ### -ExcludeExplicit + {{ Fill ExcludeExplicit Description }} ```yaml @@ -69,6 +76,7 @@ Accept wildcard characters: False ``` ### -ExcludeInherited + {{ Fill ExcludeInherited Description }} ```yaml @@ -84,6 +92,7 @@ Accept wildcard characters: False ``` ### -Path + {{ Fill Path Description }} ```yaml @@ -99,6 +108,7 @@ Accept wildcard characters: False ``` ### -SecurityDescriptor + {{ Fill SecurityDescriptor Description }} ```yaml @@ -114,6 +124,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-NTFSOrphanedAudit.md b/Docs/Cmdlets/Get-NTFSOrphanedAudit.md index 3ef6d66..248f4bc 100644 --- a/Docs/Cmdlets/Get-NTFSOrphanedAudit.md +++ b/Docs/Cmdlets/Get-NTFSOrphanedAudit.md @@ -8,29 +8,34 @@ schema: 2.0.0 # Get-NTFSOrphanedAudit ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX ### Path -``` + +```PowerShell Get-NTFSOrphanedAudit [[-Path] ] [-Account ] [-ExcludeExplicit] [-ExcludeInherited] [] ``` ### SD -``` + +```PowerShell Get-NTFSOrphanedAudit [-SecurityDescriptor] [-Account ] [-ExcludeExplicit] [-ExcludeInherited] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -39,6 +44,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -Account + {{ Fill Account Description }} ```yaml @@ -54,6 +60,7 @@ Accept wildcard characters: False ``` ### -ExcludeExplicit + {{ Fill ExcludeExplicit Description }} ```yaml @@ -69,6 +76,7 @@ Accept wildcard characters: False ``` ### -ExcludeInherited + {{ Fill ExcludeInherited Description }} ```yaml @@ -84,6 +92,7 @@ Accept wildcard characters: False ``` ### -Path + {{ Fill Path Description }} ```yaml @@ -99,6 +108,7 @@ Accept wildcard characters: False ``` ### -SecurityDescriptor + {{ Fill SecurityDescriptor Description }} ```yaml @@ -114,6 +124,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-NTFSOwner.md b/Docs/Cmdlets/Get-NTFSOwner.md index d86e5a3..6160e98 100644 --- a/Docs/Cmdlets/Get-NTFSOwner.md +++ b/Docs/Cmdlets/Get-NTFSOwner.md @@ -8,27 +8,32 @@ schema: 2.0.0 # Get-NTFSOwner ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX ### Path (Default) -``` + +```PowerShell Get-NTFSOwner [[-Path] ] [] ``` ### SecurityDescriptor -``` + +```PowerShell Get-NTFSOwner [-SecurityDescriptor] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -37,6 +42,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -Path + {{ Fill Path Description }} ```yaml @@ -52,6 +58,7 @@ Accept wildcard characters: False ``` ### -SecurityDescriptor + {{ Fill SecurityDescriptor Description }} ```yaml @@ -67,6 +74,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-NTFSSecurityDescriptor.md b/Docs/Cmdlets/Get-NTFSSecurityDescriptor.md index dfe66a1..ccd37ba 100644 --- a/Docs/Cmdlets/Get-NTFSSecurityDescriptor.md +++ b/Docs/Cmdlets/Get-NTFSSecurityDescriptor.md @@ -8,21 +8,24 @@ schema: 2.0.0 # Get-NTFSSecurityDescriptor ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX -``` +```PowerShell Get-NTFSSecurityDescriptor [[-Path] ] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -31,6 +34,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -Path + {{ Fill Path Description }} ```yaml @@ -46,6 +50,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-NTFSSimpleAccess.md b/Docs/Cmdlets/Get-NTFSSimpleAccess.md index 2dd0a31..ce971f7 100644 --- a/Docs/Cmdlets/Get-NTFSSimpleAccess.md +++ b/Docs/Cmdlets/Get-NTFSSimpleAccess.md @@ -8,29 +8,34 @@ schema: 2.0.0 # Get-NTFSSimpleAccess ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX ### Path -``` + +```PowerShell Get-NTFSSimpleAccess [-IncludeRootFolder] [[-Path] ] [-Account ] [-ExcludeExplicit] [-ExcludeInherited] [] ``` ### SD -``` + +```PowerShell Get-NTFSSimpleAccess [-IncludeRootFolder] [-SecurityDescriptor] [-Account ] [-ExcludeExplicit] [-ExcludeInherited] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -39,6 +44,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -Account + {{ Fill Account Description }} ```yaml @@ -54,6 +60,7 @@ Accept wildcard characters: False ``` ### -ExcludeExplicit + {{ Fill ExcludeExplicit Description }} ```yaml @@ -69,6 +76,7 @@ Accept wildcard characters: False ``` ### -ExcludeInherited + {{ Fill ExcludeInherited Description }} ```yaml @@ -84,6 +92,7 @@ Accept wildcard characters: False ``` ### -IncludeRootFolder + {{ Fill IncludeRootFolder Description }} ```yaml @@ -99,6 +108,7 @@ Accept wildcard characters: False ``` ### -Path + {{ Fill Path Description }} ```yaml @@ -114,6 +124,7 @@ Accept wildcard characters: False ``` ### -SecurityDescriptor + {{ Fill SecurityDescriptor Description }} ```yaml @@ -129,6 +140,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-Privileges.md b/Docs/Cmdlets/Get-Privileges.md index ac1e0c3..978151b 100644 --- a/Docs/Cmdlets/Get-Privileges.md +++ b/Docs/Cmdlets/Get-Privileges.md @@ -8,21 +8,24 @@ schema: 2.0.0 # Get-Privileges ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX -``` +```PowerShell Get-Privileges [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -31,6 +34,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Move-Item2.md b/Docs/Cmdlets/Move-Item2.md index 113e77b..fad26f6 100644 --- a/Docs/Cmdlets/Move-Item2.md +++ b/Docs/Cmdlets/Move-Item2.md @@ -8,22 +8,25 @@ schema: 2.0.0 # Move-Item2 ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX -``` +```PowerShell Move-Item2 [-Path] [-Destination] [-Force] [-PassThru ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -32,6 +35,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -47,6 +51,7 @@ Accept wildcard characters: False ``` ### -Destination + {{ Fill Destination Description }} ```yaml @@ -62,6 +67,7 @@ Accept wildcard characters: False ``` ### -Force + {{ Fill Force Description }} ```yaml @@ -77,6 +83,7 @@ Accept wildcard characters: False ``` ### -PassThru + {{ Fill PassThru Description }} ```yaml @@ -92,6 +99,7 @@ Accept wildcard characters: False ``` ### -Path + {{ Fill Path Description }} ```yaml @@ -107,6 +115,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -123,6 +132,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -134,6 +144,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/Docs/Cmdlets/New-NTFSHardLink.md b/Docs/Cmdlets/New-NTFSHardLink.md index a50ea26..4fff9ec 100644 --- a/Docs/Cmdlets/New-NTFSHardLink.md +++ b/Docs/Cmdlets/New-NTFSHardLink.md @@ -8,21 +8,24 @@ schema: 2.0.0 # New-NTFSHardLink ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX -``` +```PowerShell New-NTFSHardLink [[-Path] ] [[-Target] ] [-PassThru] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -31,6 +34,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -PassThru + {{ Fill PassThru Description }} ```yaml @@ -46,6 +50,7 @@ Accept wildcard characters: False ``` ### -Path + {{ Fill Path Description }} ```yaml @@ -61,6 +66,7 @@ Accept wildcard characters: False ``` ### -Target + {{ Fill Target Description }} ```yaml @@ -76,6 +82,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/New-NTFSSymbolicLink.md b/Docs/Cmdlets/New-NTFSSymbolicLink.md index 28a5e4d..5732174 100644 --- a/Docs/Cmdlets/New-NTFSSymbolicLink.md +++ b/Docs/Cmdlets/New-NTFSSymbolicLink.md @@ -8,21 +8,24 @@ schema: 2.0.0 # New-NTFSSymbolicLink ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX -``` +```PowerShell New-NTFSSymbolicLink [[-Path] ] [[-Target] ] [-PassThru] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -31,6 +34,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -PassThru + {{ Fill PassThru Description }} ```yaml @@ -46,6 +50,7 @@ Accept wildcard characters: False ``` ### -Path + {{ Fill Path Description }} ```yaml @@ -61,6 +66,7 @@ Accept wildcard characters: False ``` ### -Target + {{ Fill Target Description }} ```yaml @@ -76,6 +82,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Remove-Item2.md b/Docs/Cmdlets/Remove-Item2.md index be0ac85..df5659c 100644 --- a/Docs/Cmdlets/Remove-Item2.md +++ b/Docs/Cmdlets/Remove-Item2.md @@ -8,21 +8,24 @@ schema: 2.0.0 # Remove-Item2 ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX -``` +```PowerShell Remove-Item2 [[-Path] ] [-Force] [-Recurse] [-PassThur] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -31,6 +34,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -46,6 +50,7 @@ Accept wildcard characters: False ``` ### -Force + {{ Fill Force Description }} ```yaml @@ -61,6 +66,7 @@ Accept wildcard characters: False ``` ### -PassThur + {{ Fill PassThur Description }} ```yaml @@ -76,6 +82,7 @@ Accept wildcard characters: False ``` ### -Path + {{ Fill Path Description }} ```yaml @@ -91,6 +98,7 @@ Accept wildcard characters: False ``` ### -Recurse + {{ Fill Recurse Description }} ```yaml @@ -106,6 +114,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -122,6 +131,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -131,6 +141,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/Docs/Cmdlets/Remove-NTFSAccess.md b/Docs/Cmdlets/Remove-NTFSAccess.md index 57ac22a..828975d 100644 --- a/Docs/Cmdlets/Remove-NTFSAccess.md +++ b/Docs/Cmdlets/Remove-NTFSAccess.md @@ -8,44 +8,51 @@ schema: 2.0.0 # Remove-NTFSAccess ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX ### PathComplex (Default) -``` + +```PowerShell Remove-NTFSAccess [-Path] [-Account] [-AccessRights] [-AccessType ] [-InheritanceFlags ] [-PropagationFlags ] [-PassThru] [] ``` ### PathSimple -``` + +```PowerShell Remove-NTFSAccess [-Path] [-Account] [-AccessRights] [-AccessType ] [-AppliesTo ] [-PassThru] [] ``` ### SDSimple -``` + +```PowerShell Remove-NTFSAccess [-SecurityDescriptor] [-Account] [-AccessRights] [-AccessType ] [-AppliesTo ] [-PassThru] [] ``` ### SDComplex -``` + +```PowerShell Remove-NTFSAccess [-SecurityDescriptor] [-Account] [-AccessRights] [-AccessType ] [-InheritanceFlags ] [-PropagationFlags ] [-PassThru] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -54,6 +61,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -AccessRights + {{ Fill AccessRights Description }} ```yaml @@ -70,6 +78,7 @@ Accept wildcard characters: False ``` ### -AccessType + {{ Fill AccessType Description }} ```yaml @@ -86,6 +95,7 @@ Accept wildcard characters: False ``` ### -Account + {{ Fill Account Description }} ```yaml @@ -101,6 +111,7 @@ Accept wildcard characters: False ``` ### -AppliesTo + {{ Fill AppliesTo Description }} ```yaml @@ -117,6 +128,7 @@ Accept wildcard characters: False ``` ### -InheritanceFlags + {{ Fill InheritanceFlags Description }} ```yaml @@ -133,6 +145,7 @@ Accept wildcard characters: False ``` ### -PassThru + {{ Fill PassThru Description }} ```yaml @@ -148,6 +161,7 @@ Accept wildcard characters: False ``` ### -Path + {{ Fill Path Description }} ```yaml @@ -163,6 +177,7 @@ Accept wildcard characters: False ``` ### -PropagationFlags + {{ Fill PropagationFlags Description }} ```yaml @@ -179,6 +194,7 @@ Accept wildcard characters: False ``` ### -SecurityDescriptor + {{ Fill SecurityDescriptor Description }} ```yaml @@ -194,6 +210,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Remove-NTFSAudit.md b/Docs/Cmdlets/Remove-NTFSAudit.md index d6c4a28..04b70c8 100644 --- a/Docs/Cmdlets/Remove-NTFSAudit.md +++ b/Docs/Cmdlets/Remove-NTFSAudit.md @@ -8,44 +8,51 @@ schema: 2.0.0 # Remove-NTFSAudit ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX ### PathComplex (Default) -``` + +```PowerShell Remove-NTFSAudit [-Path] [-Account] [-AccessRights] [-AuditFlags ] [-InheritanceFlags ] [-PropagationFlags ] [-PassThru] [] ``` ### PathSimple -``` + +```PowerShell Remove-NTFSAudit [-Path] [-Account] [-AccessRights] [-AuditFlags ] [-AppliesTo ] [-PassThru] [] ``` ### SDSimple -``` + +```PowerShell Remove-NTFSAudit [-SecurityDescriptor] [-Account] [-AccessRights] [-AuditFlags ] [-AppliesTo ] [-PassThru] [] ``` ### SDComplex -``` + +```PowerShell Remove-NTFSAudit [-SecurityDescriptor] [-Account] [-AccessRights] [-AuditFlags ] [-InheritanceFlags ] [-PropagationFlags ] [-PassThru] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -54,6 +61,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -AccessRights + {{ Fill AccessRights Description }} ```yaml @@ -70,6 +78,7 @@ Accept wildcard characters: False ``` ### -Account + {{ Fill Account Description }} ```yaml @@ -85,6 +94,7 @@ Accept wildcard characters: False ``` ### -AppliesTo + {{ Fill AppliesTo Description }} ```yaml @@ -101,6 +111,7 @@ Accept wildcard characters: False ``` ### -AuditFlags + {{ Fill AuditFlags Description }} ```yaml @@ -117,6 +128,7 @@ Accept wildcard characters: False ``` ### -InheritanceFlags + {{ Fill InheritanceFlags Description }} ```yaml @@ -133,6 +145,7 @@ Accept wildcard characters: False ``` ### -PassThru + {{ Fill PassThru Description }} ```yaml @@ -148,6 +161,7 @@ Accept wildcard characters: False ``` ### -Path + {{ Fill Path Description }} ```yaml @@ -163,6 +177,7 @@ Accept wildcard characters: False ``` ### -PropagationFlags + {{ Fill PropagationFlags Description }} ```yaml @@ -179,6 +194,7 @@ Accept wildcard characters: False ``` ### -SecurityDescriptor + {{ Fill SecurityDescriptor Description }} ```yaml @@ -194,6 +210,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Set-NTFSInheritance.md b/Docs/Cmdlets/Set-NTFSInheritance.md index f25a8e8..90519ed 100644 --- a/Docs/Cmdlets/Set-NTFSInheritance.md +++ b/Docs/Cmdlets/Set-NTFSInheritance.md @@ -8,29 +8,34 @@ schema: 2.0.0 # Set-NTFSInheritance ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX ### Path (Default) -``` + +```PowerShell Set-NTFSInheritance [[-Path] ] [-AccessInheritanceEnabled ] [-AuditInheritanceEnabled ] [-PassThru] [] ``` ### SecurityDescriptor -``` + +```PowerShell Set-NTFSInheritance [-SecurityDescriptor] [-AccessInheritanceEnabled ] [-AuditInheritanceEnabled ] [-PassThru] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -39,6 +44,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -AccessInheritanceEnabled + {{ Fill AccessInheritanceEnabled Description }} ```yaml @@ -54,6 +60,7 @@ Accept wildcard characters: False ``` ### -AuditInheritanceEnabled + {{ Fill AuditInheritanceEnabled Description }} ```yaml @@ -69,6 +76,7 @@ Accept wildcard characters: False ``` ### -PassThru + {{ Fill PassThru Description }} ```yaml @@ -84,6 +92,7 @@ Accept wildcard characters: False ``` ### -Path + {{ Fill Path Description }} ```yaml @@ -99,6 +108,7 @@ Accept wildcard characters: False ``` ### -SecurityDescriptor + {{ Fill SecurityDescriptor Description }} ```yaml @@ -114,6 +124,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -127,6 +138,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/Docs/Cmdlets/Set-NTFSOwner.md b/Docs/Cmdlets/Set-NTFSOwner.md index 17f2c6b..39591ae 100644 --- a/Docs/Cmdlets/Set-NTFSOwner.md +++ b/Docs/Cmdlets/Set-NTFSOwner.md @@ -8,28 +8,33 @@ schema: 2.0.0 # Set-NTFSOwner ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX ### Path (Default) -``` + +```PowerShell Set-NTFSOwner [[-Path] ] [-Account] [-PassThru] [] ``` ### SecurityDescriptor -``` + +```PowerShell Set-NTFSOwner [-SecurityDescriptor] [-Account] [-PassThru] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -38,6 +43,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -Account + {{ Fill Account Description }} ```yaml @@ -53,6 +59,7 @@ Accept wildcard characters: False ``` ### -PassThru + {{ Fill PassThru Description }} ```yaml @@ -68,6 +75,7 @@ Accept wildcard characters: False ``` ### -Path + {{ Fill Path Description }} ```yaml @@ -83,6 +91,7 @@ Accept wildcard characters: False ``` ### -SecurityDescriptor + {{ Fill SecurityDescriptor Description }} ```yaml @@ -98,6 +107,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Set-NTFSSecurityDescriptor.md b/Docs/Cmdlets/Set-NTFSSecurityDescriptor.md index b7cde6d..8b05146 100644 --- a/Docs/Cmdlets/Set-NTFSSecurityDescriptor.md +++ b/Docs/Cmdlets/Set-NTFSSecurityDescriptor.md @@ -8,21 +8,24 @@ schema: 2.0.0 # Set-NTFSSecurityDescriptor ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX -``` +```PowerShell Set-NTFSSecurityDescriptor [-SecurityDescriptor] [-PassThru] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -31,6 +34,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -PassThru + {{ Fill PassThru Description }} ```yaml @@ -46,6 +50,7 @@ Accept wildcard characters: False ``` ### -SecurityDescriptor + {{ Fill SecurityDescriptor Description }} ```yaml @@ -61,6 +66,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Test-Path2.md b/Docs/Cmdlets/Test-Path2.md index 8a8f8a4..852bf6b 100644 --- a/Docs/Cmdlets/Test-Path2.md +++ b/Docs/Cmdlets/Test-Path2.md @@ -8,21 +8,24 @@ schema: 2.0.0 # Test-Path2 ## SYNOPSIS + {{ Fill in the Synopsis }} ## SYNTAX -``` +```PowerShell Test-Path2 [-Path] [-PathType ] [] ``` ## DESCRIPTION + {{ Fill in the Description }} ## EXAMPLES ### Example 1 -```powershell + +```PowerShell PS C:\> {{ Add example code here }} ``` @@ -31,6 +34,7 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -Path + {{ Fill Path Description }} ```yaml @@ -46,6 +50,7 @@ Accept wildcard characters: False ``` ### -PathType + {{ Fill PathType Description }} ```yaml @@ -62,6 +67,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Contributing.md b/Docs/Contributing.md index b616d31..f9e0e26 100644 --- a/Docs/Contributing.md +++ b/Docs/Contributing.md @@ -7,4 +7,4 @@ The following topics explain how to contribute to the NTFSAccess documentation. 1. [Get started](./Contributing/01-Getting-Started.md) 2. [Writing PowerShell documentation](./Contributing/02-Writing.md) -This contributor guide is a modified version of the one found on the [Powershell Docs](https://github.com/PowerShell/PowerShell-Docs) GitHub page. \ No newline at end of file +This contributor guide is a modified version of the one found on the [Powershell Docs](https://github.com/PowerShell/PowerShell-Docs) GitHub page. From be8a6fe79a14ab6862c1db3f944aca1733b1ebe5 Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Thu, 24 Oct 2019 22:18:07 +1100 Subject: [PATCH 41/44] more examples --- Docs/Cmdlets/Add-NTFSAccess.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/Docs/Cmdlets/Add-NTFSAccess.md b/Docs/Cmdlets/Add-NTFSAccess.md index 015835b..74b83a9 100644 --- a/Docs/Cmdlets/Add-NTFSAccess.md +++ b/Docs/Cmdlets/Add-NTFSAccess.md @@ -79,7 +79,23 @@ Adds an access control entry (ACE) to an object such as a file or folder. NTFSSe PS C:\> Add-NTFSAccess -Path C:\Data -Account 'NT AUTHORITY\Authenticated Users' -AccessRights Read ``` -The above command gives the read permissions to the built-in group of 'Authenticated users' +The above command gives the read permissions to the built-in group of 'Authenticated users'. + +### Example 2 + +```PowerShell +PS C:\> Add-NTFSAccess -Path C:\Data -Account 'Contoso\Domain Admins' -AccessRights Full +``` + +The above command gives full permissions to the domain administrators group in the contoso active directory. + +### Example 3 + +```PowerShell +PS C:\> Add-NTFSAccess -Path C:\Data -Account 'NT AUTHORITY\Authenticated Users' -AccessRights CreateFiles -AccessType Deny -AppliesTo ThisFolderOnly +``` + +The above command denies the the built-in group of 'Authenticated users' from creating files in this folder only. ## PARAMETERS From 103b9e10b21d0a434528017bf6ec75b304e5677f Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Thu, 24 Oct 2019 22:32:13 +1100 Subject: [PATCH 42/44] description updates --- Docs/Cmdlets/Add-NTFSAccess.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Docs/Cmdlets/Add-NTFSAccess.md b/Docs/Cmdlets/Add-NTFSAccess.md index 74b83a9..fa008dd 100644 --- a/Docs/Cmdlets/Add-NTFSAccess.md +++ b/Docs/Cmdlets/Add-NTFSAccess.md @@ -135,7 +135,7 @@ Accept wildcard characters: False ### -Account -{{ Fill Account Description }} +The Account parameter defines the account or group to apply the permissions to. ```yaml Type: IdentityReference2[] @@ -151,7 +151,7 @@ Accept wildcard characters: False ### -AppliesTo -{{ Fill AppliesTo Description }} +The AppliesTo parameter defines where the permissions apply to and if there is any inheritance e.g this folder and subfolders. ```yaml Type: ApplyTo @@ -201,7 +201,7 @@ Accept wildcard characters: False ### -Path -{{ Fill Path Description }} +The Path parameter defines where the file or container exists. ```yaml Type: String[] From 28289c442eaa67c9ef62e9c9ed9cd5f705edd658 Mon Sep 17 00:00:00 2001 From: sup3rlativ3 Date: Thu, 24 Oct 2019 22:36:28 +1100 Subject: [PATCH 43/44] removed md fixes to fix docs build --- Docs/Cmdlets/Add-NTFSAccess.md | 13 ++++--------- Docs/Cmdlets/Add-NTFSAudit.md | 13 ++++--------- Docs/Cmdlets/Clear-NTFSAccess.md | 7 ++----- Docs/Cmdlets/Clear-NTFSAudit.md | 7 ++----- Docs/Cmdlets/Copy-Item2.md | 3 +-- Docs/Cmdlets/Disable-NTFSAccessInheritance.md | 7 ++----- Docs/Cmdlets/Disable-NTFSAuditInheritance.md | 7 ++----- Docs/Cmdlets/Disable-Privileges.md | 3 +-- Docs/Cmdlets/Enable-NTFSAccessInheritance.md | 7 ++----- Docs/Cmdlets/Enable-NTFSAuditInheritance.md | 7 ++----- Docs/Cmdlets/Enable-Privileges.md | 3 +-- Docs/Cmdlets/Get-ChildItem2.md | 3 +-- Docs/Cmdlets/Get-DiskSpace.md | 3 +-- Docs/Cmdlets/Get-FileHash2.md | 2 -- Docs/Cmdlets/Get-Item2.md | 3 +-- Docs/Cmdlets/Get-NTFSAccess.md | 7 ++----- Docs/Cmdlets/Get-NTFSAudit.md | 7 ++----- Docs/Cmdlets/Get-NTFSEffectiveAccess.md | 7 ++----- Docs/Cmdlets/Get-NTFSHardLink.md | 3 +-- Docs/Cmdlets/Get-NTFSInheritance.md | 7 ++----- Docs/Cmdlets/Get-NTFSOrphanedAccess.md | 7 ++----- Docs/Cmdlets/Get-NTFSOrphanedAudit.md | 7 ++----- Docs/Cmdlets/Get-NTFSOwner.md | 7 ++----- Docs/Cmdlets/Get-NTFSSecurityDescriptor.md | 3 +-- Docs/Cmdlets/Get-NTFSSimpleAccess.md | 7 ++----- Docs/Cmdlets/Get-Privileges.md | 3 +-- Docs/Cmdlets/Move-Item2.md | 3 +-- Docs/Cmdlets/New-NTFSHardLink.md | 3 +-- Docs/Cmdlets/New-NTFSSymbolicLink.md | 3 +-- Docs/Cmdlets/Remove-Item2.md | 3 +-- Docs/Cmdlets/Remove-NTFSAccess.md | 13 ++++--------- Docs/Cmdlets/Remove-NTFSAudit.md | 13 ++++--------- Docs/Cmdlets/Set-NTFSInheritance.md | 7 ++----- Docs/Cmdlets/Set-NTFSOwner.md | 7 ++----- Docs/Cmdlets/Set-NTFSSecurityDescriptor.md | 3 +-- Docs/Cmdlets/Test-Path2.md | 3 +-- 36 files changed, 63 insertions(+), 148 deletions(-) diff --git a/Docs/Cmdlets/Add-NTFSAccess.md b/Docs/Cmdlets/Add-NTFSAccess.md index fa008dd..4449e07 100644 --- a/Docs/Cmdlets/Add-NTFSAccess.md +++ b/Docs/Cmdlets/Add-NTFSAccess.md @@ -14,31 +14,27 @@ Adds an access control entry (ACE) to an object. ## SYNTAX ### PathComplex (Default) - -```PowerShell +``` Add-NTFSAccess [-Path] [-Account] [-AccessRights] [-AccessType ] [-InheritanceFlags ] [-PropagationFlags ] [-PassThru] [] ``` ### PathSimple - -```PowerShell +``` Add-NTFSAccess [-Path] [-Account] [-AccessRights] [-AccessType ] [-AppliesTo ] [-PassThru] [] ``` ### SDSimple - -```PowerShell +``` Add-NTFSAccess [-SecurityDescriptor] [-Account] [-AccessRights] [-AccessType ] [-AppliesTo ] [-PassThru] [] ``` ### SDComplex - -```PowerShell +``` Add-NTFSAccess [-SecurityDescriptor] [-Account] [-AccessRights] [-AccessType ] [-InheritanceFlags ] [-PropagationFlags ] [-PassThru] [] @@ -249,7 +245,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Add-NTFSAudit.md b/Docs/Cmdlets/Add-NTFSAudit.md index 418ac26..9872a64 100644 --- a/Docs/Cmdlets/Add-NTFSAudit.md +++ b/Docs/Cmdlets/Add-NTFSAudit.md @@ -14,31 +14,27 @@ schema: 2.0.0 ## SYNTAX ### PathComplex (Default) - -```PowerShell +``` Add-NTFSAudit [-Path] [-Account] [-AccessRights] [-AuditFlags ] [-InheritanceFlags ] [-PropagationFlags ] [-PassThru] [] ``` ### PathSimple - -```PowerShell +``` Add-NTFSAudit [-Path] [-Account] [-AccessRights] [-AuditFlags ] [-AppliesTo ] [-PassThru] [] ``` ### SDSimple - -```PowerShell +``` Add-NTFSAudit [-SecurityDescriptor] [-Account] [-AccessRights] [-AuditFlags ] [-AppliesTo ] [-PassThru] [] ``` ### SDComplex - -```PowerShell +``` Add-NTFSAudit [-SecurityDescriptor] [-Account] [-AccessRights] [-AuditFlags ] [-InheritanceFlags ] [-PropagationFlags ] [-PassThru] [] @@ -210,7 +206,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Clear-NTFSAccess.md b/Docs/Cmdlets/Clear-NTFSAccess.md index 906b0f1..0184914 100644 --- a/Docs/Cmdlets/Clear-NTFSAccess.md +++ b/Docs/Cmdlets/Clear-NTFSAccess.md @@ -14,14 +14,12 @@ schema: 2.0.0 ## SYNTAX ### Path (Default) - -```PowerShell +``` Clear-NTFSAccess [-Path] [-DisableInheritance] [] ``` ### SD - -```PowerShell +``` Clear-NTFSAccess [-SecurityDescriptor] [-DisableInheritance] [] ``` @@ -90,7 +88,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Clear-NTFSAudit.md b/Docs/Cmdlets/Clear-NTFSAudit.md index 9769bc4..09f1c64 100644 --- a/Docs/Cmdlets/Clear-NTFSAudit.md +++ b/Docs/Cmdlets/Clear-NTFSAudit.md @@ -14,14 +14,12 @@ schema: 2.0.0 ## SYNTAX ### Path (Default) - -```PowerShell +``` Clear-NTFSAudit [-Path] [-DisableInheritance] [] ``` ### SD - -```PowerShell +``` Clear-NTFSAudit [-SecurityDescriptor] [-DisableInheritance] [] ``` @@ -90,7 +88,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Copy-Item2.md b/Docs/Cmdlets/Copy-Item2.md index 87751df..a62de6e 100644 --- a/Docs/Cmdlets/Copy-Item2.md +++ b/Docs/Cmdlets/Copy-Item2.md @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX -```PowerShell +``` Copy-Item2 [-Path] [-Destination] [-Force] [-PassThru ] [-WhatIf] [-Confirm] [] ``` @@ -132,7 +132,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Disable-NTFSAccessInheritance.md b/Docs/Cmdlets/Disable-NTFSAccessInheritance.md index 5c1c487..5afaf9e 100644 --- a/Docs/Cmdlets/Disable-NTFSAccessInheritance.md +++ b/Docs/Cmdlets/Disable-NTFSAccessInheritance.md @@ -14,15 +14,13 @@ schema: 2.0.0 ## SYNTAX ### Path (Default) - -```PowerShell +``` Disable-NTFSAccessInheritance [[-Path] ] [-RemoveInheritedAccessRules] [-PassThru] [] ``` ### SecurityDescriptor - -```PowerShell +``` Disable-NTFSAccessInheritance [-SecurityDescriptor] [-RemoveInheritedAccessRules] [-PassThru] [] ``` @@ -108,7 +106,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Disable-NTFSAuditInheritance.md b/Docs/Cmdlets/Disable-NTFSAuditInheritance.md index d82a931..def9bbb 100644 --- a/Docs/Cmdlets/Disable-NTFSAuditInheritance.md +++ b/Docs/Cmdlets/Disable-NTFSAuditInheritance.md @@ -14,15 +14,13 @@ schema: 2.0.0 ## SYNTAX ### Path (Default) - -```PowerShell +``` Disable-NTFSAuditInheritance [[-Path] ] [-RemoveInheritedAccessRules] [-PassThru] [] ``` ### SecurityDescriptor - -```PowerShell +``` Disable-NTFSAuditInheritance [-SecurityDescriptor] [-RemoveInheritedAccessRules] [-PassThru] [] ``` @@ -108,7 +106,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Disable-Privileges.md b/Docs/Cmdlets/Disable-Privileges.md index ada8e73..8cb7f0a 100644 --- a/Docs/Cmdlets/Disable-Privileges.md +++ b/Docs/Cmdlets/Disable-Privileges.md @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX -```PowerShell +``` Disable-Privileges [-PassThru] [] ``` @@ -50,7 +50,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Enable-NTFSAccessInheritance.md b/Docs/Cmdlets/Enable-NTFSAccessInheritance.md index bd1dbce..fb2e1a0 100644 --- a/Docs/Cmdlets/Enable-NTFSAccessInheritance.md +++ b/Docs/Cmdlets/Enable-NTFSAccessInheritance.md @@ -14,14 +14,12 @@ schema: 2.0.0 ## SYNTAX ### Path (Default) - -```PowerShell +``` Enable-NTFSAccessInheritance [[-Path] ] [-PassThru] [-RemoveExplicitAccessRules] [] ``` ### SecurityDescriptor - -```PowerShell +``` Enable-NTFSAccessInheritance [-SecurityDescriptor] [-PassThru] [-RemoveExplicitAccessRules] [] ``` @@ -107,7 +105,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Enable-NTFSAuditInheritance.md b/Docs/Cmdlets/Enable-NTFSAuditInheritance.md index 59cb16a..2128fcd 100644 --- a/Docs/Cmdlets/Enable-NTFSAuditInheritance.md +++ b/Docs/Cmdlets/Enable-NTFSAuditInheritance.md @@ -14,14 +14,12 @@ schema: 2.0.0 ## SYNTAX ### Path (Default) - -```PowerShell +``` Enable-NTFSAuditInheritance [[-Path] ] [-PassThru] [-RemoveExplicitAccessRules] [] ``` ### SecurityDescriptor - -```PowerShell +``` Enable-NTFSAuditInheritance [-SecurityDescriptor] [-PassThru] [-RemoveExplicitAccessRules] [] ``` @@ -107,7 +105,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Enable-Privileges.md b/Docs/Cmdlets/Enable-Privileges.md index 395b303..81606bb 100644 --- a/Docs/Cmdlets/Enable-Privileges.md +++ b/Docs/Cmdlets/Enable-Privileges.md @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX -```PowerShell +``` Enable-Privileges [-PassThru] [] ``` @@ -50,7 +50,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-ChildItem2.md b/Docs/Cmdlets/Get-ChildItem2.md index 745f950..4b0a5ba 100644 --- a/Docs/Cmdlets/Get-ChildItem2.md +++ b/Docs/Cmdlets/Get-ChildItem2.md @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX -```PowerShell +``` Get-ChildItem2 [[-Path] ] [[-Filter] ] [-Recurse] [-Directory] [-File] [-Attributes ] [-Hidden] [-System] [-ReadOnly] [-Force] [-SkipMountPoints] [-SkipSymbolicLinks] [-Depth ] [] @@ -245,7 +245,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-DiskSpace.md b/Docs/Cmdlets/Get-DiskSpace.md index c9ef7ef..7b52c52 100644 --- a/Docs/Cmdlets/Get-DiskSpace.md +++ b/Docs/Cmdlets/Get-DiskSpace.md @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX -```PowerShell +``` Get-DiskSpace [[-DriveLetter] ] [] ``` @@ -50,7 +50,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-FileHash2.md b/Docs/Cmdlets/Get-FileHash2.md index 6632688..51204e5 100644 --- a/Docs/Cmdlets/Get-FileHash2.md +++ b/Docs/Cmdlets/Get-FileHash2.md @@ -14,7 +14,6 @@ schema: 2.0.0 ## SYNTAX ``` - Get-FileHash2 [-Path] [[-Algorithm] ] [] ``` @@ -68,7 +67,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-Item2.md b/Docs/Cmdlets/Get-Item2.md index ac67beb..8b62835 100644 --- a/Docs/Cmdlets/Get-Item2.md +++ b/Docs/Cmdlets/Get-Item2.md @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX -```PowerShell +``` Get-Item2 [[-Path] ] [] ``` @@ -50,7 +50,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-NTFSAccess.md b/Docs/Cmdlets/Get-NTFSAccess.md index 0dc8b50..35f5b6b 100644 --- a/Docs/Cmdlets/Get-NTFSAccess.md +++ b/Docs/Cmdlets/Get-NTFSAccess.md @@ -14,15 +14,13 @@ schema: 2.0.0 ## SYNTAX ### Path (Default) - -```PowerShell +``` Get-NTFSAccess [[-Path] ] [-Account ] [-ExcludeExplicit] [-ExcludeInherited] [] ``` ### SD - -```PowerShell +``` Get-NTFSAccess [-SecurityDescriptor] [-Account ] [-ExcludeExplicit] [-ExcludeInherited] [] ``` @@ -124,7 +122,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-NTFSAudit.md b/Docs/Cmdlets/Get-NTFSAudit.md index 2d1663a..21e5dbb 100644 --- a/Docs/Cmdlets/Get-NTFSAudit.md +++ b/Docs/Cmdlets/Get-NTFSAudit.md @@ -14,15 +14,13 @@ schema: 2.0.0 ## SYNTAX ### Path - -```PowerShell +``` Get-NTFSAudit [[-Path] ] [-Account ] [-ExcludeExplicit] [-ExcludeInherited] [] ``` ### SD - -```PowerShell +``` Get-NTFSAudit [-SecurityDescriptor] [-Account ] [-ExcludeExplicit] [-ExcludeInherited] [] ``` @@ -124,7 +122,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-NTFSEffectiveAccess.md b/Docs/Cmdlets/Get-NTFSEffectiveAccess.md index f4622ce..d32d85d 100644 --- a/Docs/Cmdlets/Get-NTFSEffectiveAccess.md +++ b/Docs/Cmdlets/Get-NTFSEffectiveAccess.md @@ -14,15 +14,13 @@ schema: 2.0.0 ## SYNTAX ### Path (Default) - -```PowerShell +``` Get-NTFSEffectiveAccess [[-Path] ] [[-Account] ] [-ServerName ] [-ExcludeNoneAccessEntries] [] ``` ### SecurityDescriptor - -```PowerShell +``` Get-NTFSEffectiveAccess [-SecurityDescriptor] [[-Account] ] [-ServerName ] [-ExcludeNoneAccessEntries] [] ``` @@ -124,7 +122,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-NTFSHardLink.md b/Docs/Cmdlets/Get-NTFSHardLink.md index ce82f82..af36e38 100644 --- a/Docs/Cmdlets/Get-NTFSHardLink.md +++ b/Docs/Cmdlets/Get-NTFSHardLink.md @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX -```PowerShell +``` Get-NTFSHardLink [[-Path] ] [] ``` @@ -50,7 +50,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-NTFSInheritance.md b/Docs/Cmdlets/Get-NTFSInheritance.md index f5b6833..4c9ce85 100644 --- a/Docs/Cmdlets/Get-NTFSInheritance.md +++ b/Docs/Cmdlets/Get-NTFSInheritance.md @@ -14,14 +14,12 @@ schema: 2.0.0 ## SYNTAX ### Path (Default) - -```PowerShell +``` Get-NTFSInheritance [[-Path] ] [] ``` ### SecurityDescriptor - -```PowerShell +``` Get-NTFSInheritance [-SecurityDescriptor] [] ``` @@ -74,7 +72,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-NTFSOrphanedAccess.md b/Docs/Cmdlets/Get-NTFSOrphanedAccess.md index 9a08488..8e49e98 100644 --- a/Docs/Cmdlets/Get-NTFSOrphanedAccess.md +++ b/Docs/Cmdlets/Get-NTFSOrphanedAccess.md @@ -14,15 +14,13 @@ schema: 2.0.0 ## SYNTAX ### Path - -```PowerShell +``` Get-NTFSOrphanedAccess [[-Path] ] [-Account ] [-ExcludeExplicit] [-ExcludeInherited] [] ``` ### SD - -```PowerShell +``` Get-NTFSOrphanedAccess [-SecurityDescriptor] [-Account ] [-ExcludeExplicit] [-ExcludeInherited] [] ``` @@ -124,7 +122,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-NTFSOrphanedAudit.md b/Docs/Cmdlets/Get-NTFSOrphanedAudit.md index 248f4bc..5172ae8 100644 --- a/Docs/Cmdlets/Get-NTFSOrphanedAudit.md +++ b/Docs/Cmdlets/Get-NTFSOrphanedAudit.md @@ -14,15 +14,13 @@ schema: 2.0.0 ## SYNTAX ### Path - -```PowerShell +``` Get-NTFSOrphanedAudit [[-Path] ] [-Account ] [-ExcludeExplicit] [-ExcludeInherited] [] ``` ### SD - -```PowerShell +``` Get-NTFSOrphanedAudit [-SecurityDescriptor] [-Account ] [-ExcludeExplicit] [-ExcludeInherited] [] ``` @@ -124,7 +122,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-NTFSOwner.md b/Docs/Cmdlets/Get-NTFSOwner.md index 6160e98..5a0d237 100644 --- a/Docs/Cmdlets/Get-NTFSOwner.md +++ b/Docs/Cmdlets/Get-NTFSOwner.md @@ -14,14 +14,12 @@ schema: 2.0.0 ## SYNTAX ### Path (Default) - -```PowerShell +``` Get-NTFSOwner [[-Path] ] [] ``` ### SecurityDescriptor - -```PowerShell +``` Get-NTFSOwner [-SecurityDescriptor] [] ``` @@ -74,7 +72,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-NTFSSecurityDescriptor.md b/Docs/Cmdlets/Get-NTFSSecurityDescriptor.md index ccd37ba..b3f2648 100644 --- a/Docs/Cmdlets/Get-NTFSSecurityDescriptor.md +++ b/Docs/Cmdlets/Get-NTFSSecurityDescriptor.md @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX -```PowerShell +``` Get-NTFSSecurityDescriptor [[-Path] ] [] ``` @@ -50,7 +50,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-NTFSSimpleAccess.md b/Docs/Cmdlets/Get-NTFSSimpleAccess.md index ce971f7..c34118a 100644 --- a/Docs/Cmdlets/Get-NTFSSimpleAccess.md +++ b/Docs/Cmdlets/Get-NTFSSimpleAccess.md @@ -14,15 +14,13 @@ schema: 2.0.0 ## SYNTAX ### Path - -```PowerShell +``` Get-NTFSSimpleAccess [-IncludeRootFolder] [[-Path] ] [-Account ] [-ExcludeExplicit] [-ExcludeInherited] [] ``` ### SD - -```PowerShell +``` Get-NTFSSimpleAccess [-IncludeRootFolder] [-SecurityDescriptor] [-Account ] [-ExcludeExplicit] [-ExcludeInherited] [] ``` @@ -140,7 +138,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Get-Privileges.md b/Docs/Cmdlets/Get-Privileges.md index 978151b..703ef06 100644 --- a/Docs/Cmdlets/Get-Privileges.md +++ b/Docs/Cmdlets/Get-Privileges.md @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX -```PowerShell +``` Get-Privileges [] ``` @@ -34,7 +34,6 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Move-Item2.md b/Docs/Cmdlets/Move-Item2.md index fad26f6..217fb2a 100644 --- a/Docs/Cmdlets/Move-Item2.md +++ b/Docs/Cmdlets/Move-Item2.md @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX -```PowerShell +``` Move-Item2 [-Path] [-Destination] [-Force] [-PassThru ] [-WhatIf] [-Confirm] [] ``` @@ -132,7 +132,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/New-NTFSHardLink.md b/Docs/Cmdlets/New-NTFSHardLink.md index 4fff9ec..04cc5c8 100644 --- a/Docs/Cmdlets/New-NTFSHardLink.md +++ b/Docs/Cmdlets/New-NTFSHardLink.md @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX -```PowerShell +``` New-NTFSHardLink [[-Path] ] [[-Target] ] [-PassThru] [] ``` @@ -82,7 +82,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/New-NTFSSymbolicLink.md b/Docs/Cmdlets/New-NTFSSymbolicLink.md index 5732174..854a647 100644 --- a/Docs/Cmdlets/New-NTFSSymbolicLink.md +++ b/Docs/Cmdlets/New-NTFSSymbolicLink.md @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX -```PowerShell +``` New-NTFSSymbolicLink [[-Path] ] [[-Target] ] [-PassThru] [] ``` @@ -82,7 +82,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Remove-Item2.md b/Docs/Cmdlets/Remove-Item2.md index df5659c..d0c9cc9 100644 --- a/Docs/Cmdlets/Remove-Item2.md +++ b/Docs/Cmdlets/Remove-Item2.md @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX -```PowerShell +``` Remove-Item2 [[-Path] ] [-Force] [-Recurse] [-PassThur] [-WhatIf] [-Confirm] [] ``` @@ -131,7 +131,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Remove-NTFSAccess.md b/Docs/Cmdlets/Remove-NTFSAccess.md index 828975d..3f1f5fb 100644 --- a/Docs/Cmdlets/Remove-NTFSAccess.md +++ b/Docs/Cmdlets/Remove-NTFSAccess.md @@ -14,31 +14,27 @@ schema: 2.0.0 ## SYNTAX ### PathComplex (Default) - -```PowerShell +``` Remove-NTFSAccess [-Path] [-Account] [-AccessRights] [-AccessType ] [-InheritanceFlags ] [-PropagationFlags ] [-PassThru] [] ``` ### PathSimple - -```PowerShell +``` Remove-NTFSAccess [-Path] [-Account] [-AccessRights] [-AccessType ] [-AppliesTo ] [-PassThru] [] ``` ### SDSimple - -```PowerShell +``` Remove-NTFSAccess [-SecurityDescriptor] [-Account] [-AccessRights] [-AccessType ] [-AppliesTo ] [-PassThru] [] ``` ### SDComplex - -```PowerShell +``` Remove-NTFSAccess [-SecurityDescriptor] [-Account] [-AccessRights] [-AccessType ] [-InheritanceFlags ] [-PropagationFlags ] [-PassThru] [] @@ -210,7 +206,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Remove-NTFSAudit.md b/Docs/Cmdlets/Remove-NTFSAudit.md index 04b70c8..399ca1d 100644 --- a/Docs/Cmdlets/Remove-NTFSAudit.md +++ b/Docs/Cmdlets/Remove-NTFSAudit.md @@ -14,31 +14,27 @@ schema: 2.0.0 ## SYNTAX ### PathComplex (Default) - -```PowerShell +``` Remove-NTFSAudit [-Path] [-Account] [-AccessRights] [-AuditFlags ] [-InheritanceFlags ] [-PropagationFlags ] [-PassThru] [] ``` ### PathSimple - -```PowerShell +``` Remove-NTFSAudit [-Path] [-Account] [-AccessRights] [-AuditFlags ] [-AppliesTo ] [-PassThru] [] ``` ### SDSimple - -```PowerShell +``` Remove-NTFSAudit [-SecurityDescriptor] [-Account] [-AccessRights] [-AuditFlags ] [-AppliesTo ] [-PassThru] [] ``` ### SDComplex - -```PowerShell +``` Remove-NTFSAudit [-SecurityDescriptor] [-Account] [-AccessRights] [-AuditFlags ] [-InheritanceFlags ] [-PropagationFlags ] [-PassThru] [] @@ -210,7 +206,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Set-NTFSInheritance.md b/Docs/Cmdlets/Set-NTFSInheritance.md index 90519ed..dec6c97 100644 --- a/Docs/Cmdlets/Set-NTFSInheritance.md +++ b/Docs/Cmdlets/Set-NTFSInheritance.md @@ -14,15 +14,13 @@ schema: 2.0.0 ## SYNTAX ### Path (Default) - -```PowerShell +``` Set-NTFSInheritance [[-Path] ] [-AccessInheritanceEnabled ] [-AuditInheritanceEnabled ] [-PassThru] [] ``` ### SecurityDescriptor - -```PowerShell +``` Set-NTFSInheritance [-SecurityDescriptor] [-AccessInheritanceEnabled ] [-AuditInheritanceEnabled ] [-PassThru] [] ``` @@ -124,7 +122,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Set-NTFSOwner.md b/Docs/Cmdlets/Set-NTFSOwner.md index 39591ae..e0c947b 100644 --- a/Docs/Cmdlets/Set-NTFSOwner.md +++ b/Docs/Cmdlets/Set-NTFSOwner.md @@ -14,14 +14,12 @@ schema: 2.0.0 ## SYNTAX ### Path (Default) - -```PowerShell +``` Set-NTFSOwner [[-Path] ] [-Account] [-PassThru] [] ``` ### SecurityDescriptor - -```PowerShell +``` Set-NTFSOwner [-SecurityDescriptor] [-Account] [-PassThru] [] ``` @@ -107,7 +105,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Set-NTFSSecurityDescriptor.md b/Docs/Cmdlets/Set-NTFSSecurityDescriptor.md index 8b05146..eb14872 100644 --- a/Docs/Cmdlets/Set-NTFSSecurityDescriptor.md +++ b/Docs/Cmdlets/Set-NTFSSecurityDescriptor.md @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX -```PowerShell +``` Set-NTFSSecurityDescriptor [-SecurityDescriptor] [-PassThru] [] ``` @@ -66,7 +66,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/Docs/Cmdlets/Test-Path2.md b/Docs/Cmdlets/Test-Path2.md index 852bf6b..71f3664 100644 --- a/Docs/Cmdlets/Test-Path2.md +++ b/Docs/Cmdlets/Test-Path2.md @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX -```PowerShell +``` Test-Path2 [-Path] [-PathType ] [] ``` @@ -67,7 +67,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS From 729fb0bd4bde5934c1c6f7c6806d73d3a10e98b4 Mon Sep 17 00:00:00 2001 From: James Smith Date: Wed, 8 Jan 2020 12:18:44 +1100 Subject: [PATCH 44/44] Finished --- Docs/Cmdlets/Add-NTFSAccess.md | 26 ++++++++++++++++++++------ 1 file changed, 20 insertions(+), 6 deletions(-) diff --git a/Docs/Cmdlets/Add-NTFSAccess.md b/Docs/Cmdlets/Add-NTFSAccess.md index 4449e07..bca6469 100644 --- a/Docs/Cmdlets/Add-NTFSAccess.md +++ b/Docs/Cmdlets/Add-NTFSAccess.md @@ -1,6 +1,6 @@ --- external help file: NTFSSecurity.dll-Help.xml -Module Name: ntfssecurity +Module Name: NTFSSecurity online version: schema: 2.0.0 --- @@ -147,7 +147,7 @@ Accept wildcard characters: False ### -AppliesTo -The AppliesTo parameter defines where the permissions apply to and if there is any inheritance e.g this folder and subfolders. +The AppliesTo parameter defines where the permissions apply to and if there is any inheritance e.g "this folder only" or "this folder and subfolders". ```yaml Type: ApplyTo @@ -164,7 +164,13 @@ Accept wildcard characters: False ### -InheritanceFlags -{{ Fill InheritanceFlags Description }} +The InheritanceFlags parameter defines the inheritance of the ACLs. + +ObjectInherit will apply the ACE to files and folders in the folder defined by the Path parameter. + +ContainerInherit will apply the ACE to subfolders but not files. + +There is more information on Microsoft Docs [here](https://docs.microsoft.com/en-us/previous-versions/dotnet/netframework-4.0/ms229747(v=vs.100)?redirectedfrom=MSDN) ```yaml Type: InheritanceFlags @@ -181,7 +187,7 @@ Accept wildcard characters: False ### -PassThru -{{ Fill PassThru Description }} +The PassThru parameter will return the new permissions as a table. If the PassThru parameter is omitted, there is no information returned if the operation was successful. ```yaml Type: SwitchParameter @@ -213,7 +219,13 @@ Accept wildcard characters: False ### -PropagationFlags -{{ Fill PropagationFlags Description }} +The PropagationFlags parameter defines how the ACE is propagated to child objects. + +Inherit specifies that the ACE is propagated only to child objects. This includes both folder and file child objects. + +NoPropagateInherit specifies that the ACE is not propagated to child objects. + +None specifies that no inheritance flags are set. ```yaml Type: PropagationFlags @@ -230,7 +242,9 @@ Accept wildcard characters: False ### -SecurityDescriptor -{{ Fill SecurityDescriptor Description }} +The SecurityDescriptor parameter allows passing an security descriptor or an array or security descriptors. + +A security descriptor contains information about the owner of the object, and the primary group of an object. The security descriptor also contains two access control lists (ACL). The first list is called the discretionary access control lists (DACL), and describes who should have access to an object and what type of access to grant. The second list is called the system access control lists (SACL) and defines what type of auditing to record for an object. ```yaml Type: FileSystemSecurity2[]