From d3df1232898a5b3aec4ae3d5df488064a5332937 Mon Sep 17 00:00:00 2001 From: aafksab <36931057+aafksab@users.noreply.github.com> Date: Wed, 7 Aug 2019 10:00:00 -0500 Subject: [PATCH] added help via platyPS --- docs/Add-NTFSAccess.md | 223 +++++++++++++++++++++++ docs/Add-NTFSAudit.md | 223 +++++++++++++++++++++++ docs/Clear-NTFSAccess.md | 98 ++++++++++ docs/Clear-NTFSAudit.md | 98 ++++++++++ docs/Copy-Item2.md | 139 +++++++++++++++ docs/Disable-NTFSAccessInheritance.md | 115 ++++++++++++ docs/Disable-NTFSAuditInheritance.md | 115 ++++++++++++ docs/Disable-Privileges.md | 61 +++++++ docs/Enable-NTFSAccessInheritance.md | 114 ++++++++++++ docs/Enable-NTFSAuditInheritance.md | 114 ++++++++++++ docs/Enable-Privileges.md | 61 +++++++ docs/Get-ChildItem2.md | 246 ++++++++++++++++++++++++++ docs/Get-DiskSpace.md | 61 +++++++ docs/Get-FileHash2.md | 79 +++++++++ docs/Get-Item2.md | 63 +++++++ docs/Get-NTFSAccess.md | 133 ++++++++++++++ docs/Get-NTFSAudit.md | 133 ++++++++++++++ docs/Get-NTFSEffectiveAccess.md | 133 ++++++++++++++ docs/Get-NTFSHardLink.md | 63 +++++++ docs/Get-NTFSInheritance.md | 84 +++++++++ docs/Get-NTFSOrphanedAccess.md | 133 ++++++++++++++ docs/Get-NTFSOrphanedAudit.md | 133 ++++++++++++++ docs/Get-NTFSOwner.md | 84 +++++++++ docs/Get-NTFSSecurityDescriptor.md | 61 +++++++ docs/Get-NTFSSimpleAccess.md | 148 ++++++++++++++++ docs/Get-Privileges.md | 46 +++++ docs/Move-Item2.md | 139 +++++++++++++++ docs/New-NTFSHardLink.md | 93 ++++++++++ docs/New-NTFSSymbolicLink.md | 93 ++++++++++ docs/Remove-Item2.md | 136 ++++++++++++++ docs/Remove-NTFSAccess.md | 223 +++++++++++++++++++++++ docs/Remove-NTFSAudit.md | 223 +++++++++++++++++++++++ docs/Set-NTFSInheritance.md | 132 ++++++++++++++ docs/Set-NTFSOwner.md | 117 ++++++++++++ docs/Set-NTFSSecurityDescriptor.md | 76 ++++++++ docs/Test-Path2.md | 81 +++++++++ 36 files changed, 4274 insertions(+) create mode 100644 docs/Add-NTFSAccess.md create mode 100644 docs/Add-NTFSAudit.md create mode 100644 docs/Clear-NTFSAccess.md create mode 100644 docs/Clear-NTFSAudit.md create mode 100644 docs/Copy-Item2.md create mode 100644 docs/Disable-NTFSAccessInheritance.md create mode 100644 docs/Disable-NTFSAuditInheritance.md create mode 100644 docs/Disable-Privileges.md create mode 100644 docs/Enable-NTFSAccessInheritance.md create mode 100644 docs/Enable-NTFSAuditInheritance.md create mode 100644 docs/Enable-Privileges.md create mode 100644 docs/Get-ChildItem2.md create mode 100644 docs/Get-DiskSpace.md create mode 100644 docs/Get-FileHash2.md create mode 100644 docs/Get-Item2.md create mode 100644 docs/Get-NTFSAccess.md create mode 100644 docs/Get-NTFSAudit.md create mode 100644 docs/Get-NTFSEffectiveAccess.md create mode 100644 docs/Get-NTFSHardLink.md create mode 100644 docs/Get-NTFSInheritance.md create mode 100644 docs/Get-NTFSOrphanedAccess.md create mode 100644 docs/Get-NTFSOrphanedAudit.md create mode 100644 docs/Get-NTFSOwner.md create mode 100644 docs/Get-NTFSSecurityDescriptor.md create mode 100644 docs/Get-NTFSSimpleAccess.md create mode 100644 docs/Get-Privileges.md create mode 100644 docs/Move-Item2.md create mode 100644 docs/New-NTFSHardLink.md create mode 100644 docs/New-NTFSSymbolicLink.md create mode 100644 docs/Remove-Item2.md create mode 100644 docs/Remove-NTFSAccess.md create mode 100644 docs/Remove-NTFSAudit.md create mode 100644 docs/Set-NTFSInheritance.md create mode 100644 docs/Set-NTFSOwner.md create mode 100644 docs/Set-NTFSSecurityDescriptor.md create mode 100644 docs/Test-Path2.md diff --git a/docs/Add-NTFSAccess.md b/docs/Add-NTFSAccess.md new file mode 100644 index 0000000..59de483 --- /dev/null +++ b/docs/Add-NTFSAccess.md @@ -0,0 +1,223 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Add-NTFSAccess + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## 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 +{{ 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/Add-NTFSAudit.md b/docs/Add-NTFSAudit.md new file mode 100644 index 0000000..7dc5089 --- /dev/null +++ b/docs/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/Clear-NTFSAccess.md b/docs/Clear-NTFSAccess.md new file mode 100644 index 0000000..060705e --- /dev/null +++ b/docs/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/Clear-NTFSAudit.md b/docs/Clear-NTFSAudit.md new file mode 100644 index 0000000..dc09927 --- /dev/null +++ b/docs/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/Copy-Item2.md b/docs/Copy-Item2.md new file mode 100644 index 0000000..0dd5b18 --- /dev/null +++ b/docs/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/Disable-NTFSAccessInheritance.md b/docs/Disable-NTFSAccessInheritance.md new file mode 100644 index 0000000..24fff2c --- /dev/null +++ b/docs/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/Disable-NTFSAuditInheritance.md b/docs/Disable-NTFSAuditInheritance.md new file mode 100644 index 0000000..79273f0 --- /dev/null +++ b/docs/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/Disable-Privileges.md b/docs/Disable-Privileges.md new file mode 100644 index 0000000..475f4d4 --- /dev/null +++ b/docs/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/Enable-NTFSAccessInheritance.md b/docs/Enable-NTFSAccessInheritance.md new file mode 100644 index 0000000..44ecbf0 --- /dev/null +++ b/docs/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/Enable-NTFSAuditInheritance.md b/docs/Enable-NTFSAuditInheritance.md new file mode 100644 index 0000000..8eb634c --- /dev/null +++ b/docs/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/Enable-Privileges.md b/docs/Enable-Privileges.md new file mode 100644 index 0000000..57d9214 --- /dev/null +++ b/docs/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/Get-ChildItem2.md b/docs/Get-ChildItem2.md new file mode 100644 index 0000000..f3852d9 --- /dev/null +++ b/docs/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/Get-DiskSpace.md b/docs/Get-DiskSpace.md new file mode 100644 index 0000000..a037eb9 --- /dev/null +++ b/docs/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/Get-FileHash2.md b/docs/Get-FileHash2.md new file mode 100644 index 0000000..703c223 --- /dev/null +++ b/docs/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/Get-Item2.md b/docs/Get-Item2.md new file mode 100644 index 0000000..1fc13e8 --- /dev/null +++ b/docs/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/Get-NTFSAccess.md b/docs/Get-NTFSAccess.md new file mode 100644 index 0000000..f07f251 --- /dev/null +++ b/docs/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/Get-NTFSAudit.md b/docs/Get-NTFSAudit.md new file mode 100644 index 0000000..29c968d --- /dev/null +++ b/docs/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/Get-NTFSEffectiveAccess.md b/docs/Get-NTFSEffectiveAccess.md new file mode 100644 index 0000000..58b66f1 --- /dev/null +++ b/docs/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/Get-NTFSHardLink.md b/docs/Get-NTFSHardLink.md new file mode 100644 index 0000000..6718e09 --- /dev/null +++ b/docs/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/Get-NTFSInheritance.md b/docs/Get-NTFSInheritance.md new file mode 100644 index 0000000..44e9156 --- /dev/null +++ b/docs/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/Get-NTFSOrphanedAccess.md b/docs/Get-NTFSOrphanedAccess.md new file mode 100644 index 0000000..80f9a7c --- /dev/null +++ b/docs/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/Get-NTFSOrphanedAudit.md b/docs/Get-NTFSOrphanedAudit.md new file mode 100644 index 0000000..3ef6d66 --- /dev/null +++ b/docs/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/Get-NTFSOwner.md b/docs/Get-NTFSOwner.md new file mode 100644 index 0000000..d86e5a3 --- /dev/null +++ b/docs/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/Get-NTFSSecurityDescriptor.md b/docs/Get-NTFSSecurityDescriptor.md new file mode 100644 index 0000000..dfe66a1 --- /dev/null +++ b/docs/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/Get-NTFSSimpleAccess.md b/docs/Get-NTFSSimpleAccess.md new file mode 100644 index 0000000..2dd0a31 --- /dev/null +++ b/docs/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/Get-Privileges.md b/docs/Get-Privileges.md new file mode 100644 index 0000000..ac1e0c3 --- /dev/null +++ b/docs/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/Move-Item2.md b/docs/Move-Item2.md new file mode 100644 index 0000000..113e77b --- /dev/null +++ b/docs/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/New-NTFSHardLink.md b/docs/New-NTFSHardLink.md new file mode 100644 index 0000000..a50ea26 --- /dev/null +++ b/docs/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/New-NTFSSymbolicLink.md b/docs/New-NTFSSymbolicLink.md new file mode 100644 index 0000000..28a5e4d --- /dev/null +++ b/docs/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/Remove-Item2.md b/docs/Remove-Item2.md new file mode 100644 index 0000000..be0ac85 --- /dev/null +++ b/docs/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/Remove-NTFSAccess.md b/docs/Remove-NTFSAccess.md new file mode 100644 index 0000000..57ac22a --- /dev/null +++ b/docs/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/Remove-NTFSAudit.md b/docs/Remove-NTFSAudit.md new file mode 100644 index 0000000..d6c4a28 --- /dev/null +++ b/docs/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/Set-NTFSInheritance.md b/docs/Set-NTFSInheritance.md new file mode 100644 index 0000000..f25a8e8 --- /dev/null +++ b/docs/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/Set-NTFSOwner.md b/docs/Set-NTFSOwner.md new file mode 100644 index 0000000..17f2c6b --- /dev/null +++ b/docs/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/Set-NTFSSecurityDescriptor.md b/docs/Set-NTFSSecurityDescriptor.md new file mode 100644 index 0000000..b7cde6d --- /dev/null +++ b/docs/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/Test-Path2.md b/docs/Test-Path2.md new file mode 100644 index 0000000..8a8f8a4 --- /dev/null +++ b/docs/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