diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..58fb067 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,13 @@ +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Build documentation with MkDocs +mkdocs: + configuration: mkdocs.yml + +# Optionally build your docs in additional formats such as PDF and ePub +formats: all \ No newline at end of file diff --git a/Docs/Cmdlets/Add-NTFSAccess.md b/Docs/Cmdlets/Add-NTFSAccess.md new file mode 100644 index 0000000..bca6469 --- /dev/null +++ b/Docs/Cmdlets/Add-NTFSAccess.md @@ -0,0 +1,288 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: NTFSSecurity +online version: +schema: 2.0.0 +--- + +# Add-NTFSAccess + +## SYNOPSIS + +Adds an access control entry (ACE) to an object. + +## SYNTAX + +### PathComplex (Default) +``` +Add-NTFSAccess [-Path] [-Account] [-AccessRights] + [-AccessType ] [-InheritanceFlags ] + [-PropagationFlags ] [-PassThru] [] +``` + +### PathSimple +``` +Add-NTFSAccess [-Path] [-Account] [-AccessRights] + [-AccessType ] [-AppliesTo ] [-PassThru] [] +``` + +### SDSimple +``` +Add-NTFSAccess [-SecurityDescriptor] [-Account] + [-AccessRights] [-AccessType ] [-AppliesTo ] [-PassThru] + [] +``` + +### SDComplex +``` +Add-NTFSAccess [-SecurityDescriptor] [-Account] + [-AccessRights] [-AccessType ] [-InheritanceFlags ] + [-PropagationFlags ] [-PassThru] [] +``` + +## DESCRIPTION + +Adds an access control entry (ACE) to an object such as a file or folder. NTFSSecurity allows you to apply basic permission groups (read, read/write, full) or advanced permissions that allow you to get granular with the permissions. See the below table for how the basic permissions map to the advanced permissions, and how NTFSSecurity handles them. + +| NTFSSecurity | AccessRight displayed | Advanced Security Window | +|------------------------------|------------------------------|---------------------------------------------------------------------------------------------------------------------------| +| ReadData | ListDirectory | List Folder / Read Data | +| ListDirectory | ListDirectory | List Folder / Read Data | +| WriteData | CreateFile | Create Files / Write Data | +| CreateFiles | CreateFile | Create Files / Write Data | +| AppendData | CreateDirectories | Create Folders / Append Data | +| CreateDirectories | CreateDirectories | Create Folders / Append Data | +| ReadExtendedAttributes | ReadExtendedAttributes | Read Extended Attributes | +| WriteExtendedAttributes | WriteExtendedAttributes | WriteExtendedAttributes | +| ExecuteFile | Traverse | Traverse Folder / Execute File | +| Traverse | Traverse | Traverse Folder / Execute File | +| DeleteSubdirectoriesAndFiles | DeleteSubdirectoriesAndFiles | Delete Sub-folders and Files | +| ReadAttributes | ReadAttributes | Read Attributes | +| WriteAttributes | WriteAttributes | Write Attributes | +| Write | Write | Create Files / Write Data, Create Folders / Append Data, Write-Attributes, Write Extended Attributes | +| Delete | Delete | Delete | +| ReadPermissions | ReadPermissions | Read Permissions | +| Read | Read | List Folder / Read Data, Read Attributes, Read Extended Attributes, Read Permissions | +| ReadAndExecute | ReadAndExecute | Traverse Folder / Execute File, List Folder / Read Data, Read Attributes, Read Extended Attributes, Read Permissions | +| Modify | Modify | Everything except Full Control, Delete SubFolders and Files, Change Permissions, Take Ownership | +| ChangePermissions | ChangePermissions | Change Permissions | + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> Add-NTFSAccess -Path C:\Data -Account 'NT AUTHORITY\Authenticated Users' -AccessRights Read +``` + +The above command gives the read permissions to the built-in group of 'Authenticated users'. + +### Example 2 + +```PowerShell +PS C:\> Add-NTFSAccess -Path C:\Data -Account 'Contoso\Domain Admins' -AccessRights Full +``` + +The above command gives full permissions to the domain administrators group in the contoso active directory. + +### Example 3 + +```PowerShell +PS C:\> Add-NTFSAccess -Path C:\Data -Account 'NT AUTHORITY\Authenticated Users' -AccessRights CreateFiles -AccessType Deny -AppliesTo ThisFolderOnly +``` + +The above command denies the the built-in group of 'Authenticated users' from creating files in this folder only. + +## PARAMETERS + +### -AccessRights + +The AccessRights parameter designates the permissions to assign. There are individual permissions as well as 'basic' permissions. See the below table for how the basic permissions permissions map the the advanced permissions in the advanced security window. + +```yaml +Type: FileSystemRights2 +Parameter Sets: (All) +Aliases: FileSystemRights +Accepted values: None, ReadData, ListDirectory, WriteData, CreateFiles, AppendData, CreateDirectories, ReadExtendedAttributes, WriteExtendedAttributes, ExecuteFile, Traverse, DeleteSubdirectoriesAndFiles, ReadAttributes, WriteAttributes, Write, Delete, ReadPermissions, Read, ReadAndExecute, Modify, ChangePermissions, TakeOwnership, Synchronize, FullControl, GenericAll, GenericExecute, GenericWrite, GenericRead + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AccessType + +The AccessType parameter determines if the ACE allows or denies the permissions assigned. + +```yaml +Type: AccessControlType +Parameter Sets: (All) +Aliases: AccessControlType +Accepted values: Allow, Deny + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Account + +The Account parameter defines the account or group to apply the permissions to. + +```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 + +The AppliesTo parameter defines where the permissions apply to and if there is any inheritance e.g "this folder only" or "this folder and subfolders". + +```yaml +Type: ApplyTo +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 + +The InheritanceFlags parameter defines the inheritance of the ACLs. + +ObjectInherit will apply the ACE to files and folders in the folder defined by the Path parameter. + +ContainerInherit will apply the ACE to subfolders but not files. + +There is more information on Microsoft Docs [here](https://docs.microsoft.com/en-us/previous-versions/dotnet/netframework-4.0/ms229747(v=vs.100)?redirectedfrom=MSDN) + +```yaml +Type: InheritanceFlags +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 + +The PassThru parameter will return the new permissions as a table. If the PassThru parameter is omitted, there is no information returned if the operation was successful. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path + +The Path parameter defines where the file or container exists. + +```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 + +The PropagationFlags parameter defines how the ACE is propagated to child objects. + +Inherit specifies that the ACE is propagated only to child objects. This includes both folder and file child objects. + +NoPropagateInherit specifies that the ACE is not propagated to child objects. + +None specifies that no inheritance flags are set. + +```yaml +Type: PropagationFlags +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 + +The SecurityDescriptor parameter allows passing an security descriptor or an array or security descriptors. + +A security descriptor contains information about the owner of the object, and the primary group of an object. The security descriptor also contains two access control lists (ACL). The first list is called the discretionary access control lists (DACL), and describes who should have access to an object and what type of access to grant. The second list is called the system access control lists (SACL) and defines what type of auditing to record for an object. + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SDSimple, SDComplex +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +### Security2.IdentityReference2[] + +### Security2.FileSystemRights2 + +### System.Security.AccessControl.AccessControlType + +### System.Security.AccessControl.InheritanceFlags + +### System.Security.AccessControl.PropagationFlags + +### Security2.ApplyTo + +## OUTPUTS + +### Security2.FileSystemAccessRule2 + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Add-NTFSAudit.md b/Docs/Cmdlets/Add-NTFSAudit.md new file mode 100644 index 0000000..9872a64 --- /dev/null +++ b/Docs/Cmdlets/Add-NTFSAudit.md @@ -0,0 +1,235 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Add-NTFSAudit + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +### PathComplex (Default) +``` +Add-NTFSAudit [-Path] [-Account] [-AccessRights] + [-AuditFlags ] [-InheritanceFlags ] [-PropagationFlags ] + [-PassThru] [] +``` + +### PathSimple +``` +Add-NTFSAudit [-Path] [-Account] [-AccessRights] + [-AuditFlags ] [-AppliesTo ] [-PassThru] [] +``` + +### SDSimple +``` +Add-NTFSAudit [-SecurityDescriptor] [-Account] + [-AccessRights] [-AuditFlags ] [-AppliesTo ] [-PassThru] + [] +``` + +### SDComplex +``` +Add-NTFSAudit [-SecurityDescriptor] [-Account] + [-AccessRights] [-AuditFlags ] [-InheritanceFlags ] + [-PropagationFlags ] [-PassThru] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -AccessRights + +{{ Fill AccessRights Description }} + +```yaml +Type: FileSystemRights2 +Parameter Sets: (All) +Aliases: FileSystemRights +Accepted values: None, ReadData, ListDirectory, WriteData, CreateFiles, AppendData, CreateDirectories, ReadExtendedAttributes, WriteExtendedAttributes, ExecuteFile, Traverse, DeleteSubdirectoriesAndFiles, ReadAttributes, WriteAttributes, Write, Delete, ReadPermissions, Read, ReadAndExecute, Modify, ChangePermissions, TakeOwnership, Synchronize, FullControl, GenericAll, GenericExecute, GenericWrite, GenericRead + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Account + +{{ Fill Account Description }} + +```yaml +Type: IdentityReference2[] +Parameter Sets: (All) +Aliases: IdentityReference, ID + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AppliesTo + +{{ Fill AppliesTo Description }} + +```yaml +Type: ApplyTo +Parameter Sets: PathSimple, SDSimple +Aliases: +Accepted values: ThisFolderOnly, ThisFolderSubfoldersAndFiles, ThisFolderAndSubfolders, ThisFolderAndFiles, SubfoldersAndFilesOnly, SubfoldersOnly, FilesOnly, ThisFolderSubfoldersAndFilesOneLevel, ThisFolderAndSubfoldersOneLevel, ThisFolderAndFilesOneLevel, SubfoldersAndFilesOnlyOneLevel, SubfoldersOnlyOneLevel, FilesOnlyOneLevel + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AuditFlags + +{{ Fill AuditFlags Description }} + +```yaml +Type: AuditFlags +Parameter Sets: (All) +Aliases: +Accepted values: None, Success, Failure + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InheritanceFlags + +{{ Fill InheritanceFlags Description }} + +```yaml +Type: InheritanceFlags +Parameter Sets: PathComplex, SDComplex +Aliases: +Accepted values: None, ContainerInherit, ObjectInherit + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru + +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: PathComplex, PathSimple +Aliases: FullName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PropagationFlags + +{{ Fill PropagationFlags Description }} + +```yaml +Type: PropagationFlags +Parameter Sets: PathComplex, SDComplex +Aliases: +Accepted values: None, NoPropagateInherit, InheritOnly + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecurityDescriptor + +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SDSimple, SDComplex +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +### Security2.IdentityReference2[] + +### Security2.FileSystemRights2 + +### System.Security.AccessControl.AuditFlags + +### System.Security.AccessControl.InheritanceFlags + +### System.Security.AccessControl.PropagationFlags + +### Security2.ApplyTo + +## OUTPUTS + +### Security2.FileSystemAccessRule2 + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Clear-NTFSAccess.md b/Docs/Cmdlets/Clear-NTFSAccess.md new file mode 100644 index 0000000..0184914 --- /dev/null +++ b/Docs/Cmdlets/Clear-NTFSAccess.md @@ -0,0 +1,105 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Clear-NTFSAccess + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path (Default) +``` +Clear-NTFSAccess [-Path] [-DisableInheritance] [] +``` + +### SD +``` +Clear-NTFSAccess [-SecurityDescriptor] [-DisableInheritance] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -DisableInheritance + +{{ Fill DisableInheritance Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecurityDescriptor + +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SD +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Clear-NTFSAudit.md b/Docs/Cmdlets/Clear-NTFSAudit.md new file mode 100644 index 0000000..09f1c64 --- /dev/null +++ b/Docs/Cmdlets/Clear-NTFSAudit.md @@ -0,0 +1,105 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Clear-NTFSAudit + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path (Default) +``` +Clear-NTFSAudit [-Path] [-DisableInheritance] [] +``` + +### SD +``` +Clear-NTFSAudit [-SecurityDescriptor] [-DisableInheritance] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -DisableInheritance + +{{ Fill DisableInheritance Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecurityDescriptor + +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SD +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Copy-Item2.md b/Docs/Cmdlets/Copy-Item2.md new file mode 100644 index 0000000..a62de6e --- /dev/null +++ b/Docs/Cmdlets/Copy-Item2.md @@ -0,0 +1,149 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Copy-Item2 + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Copy-Item2 [-Path] [-Destination] [-Force] [-PassThru ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination + +{{ Fill Destination Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force + +{{ Fill Force Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +{{ Fill PassThru Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: FullName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Disable-NTFSAccessInheritance.md b/Docs/Cmdlets/Disable-NTFSAccessInheritance.md new file mode 100644 index 0000000..5afaf9e --- /dev/null +++ b/Docs/Cmdlets/Disable-NTFSAccessInheritance.md @@ -0,0 +1,123 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Disable-NTFSAccessInheritance + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path (Default) +``` +Disable-NTFSAccessInheritance [[-Path] ] [-RemoveInheritedAccessRules] [-PassThru] + [] +``` + +### SecurityDescriptor +``` +Disable-NTFSAccessInheritance [-SecurityDescriptor] [-RemoveInheritedAccessRules] + [-PassThru] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -PassThru + +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -RemoveInheritedAccessRules + +{{ Fill RemoveInheritedAccessRules Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityDescriptor + +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SecurityDescriptor +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Disable-NTFSAuditInheritance.md b/Docs/Cmdlets/Disable-NTFSAuditInheritance.md new file mode 100644 index 0000000..def9bbb --- /dev/null +++ b/Docs/Cmdlets/Disable-NTFSAuditInheritance.md @@ -0,0 +1,123 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Disable-NTFSAuditInheritance + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path (Default) +``` +Disable-NTFSAuditInheritance [[-Path] ] [-RemoveInheritedAccessRules] [-PassThru] + [] +``` + +### SecurityDescriptor +``` +Disable-NTFSAuditInheritance [-SecurityDescriptor] [-RemoveInheritedAccessRules] + [-PassThru] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -PassThru + +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -RemoveInheritedAccessRules + +{{ Fill RemoveInheritedAccessRules Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityDescriptor + +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SecurityDescriptor +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Disable-Privileges.md b/Docs/Cmdlets/Disable-Privileges.md new file mode 100644 index 0000000..8cb7f0a --- /dev/null +++ b/Docs/Cmdlets/Disable-Privileges.md @@ -0,0 +1,65 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Disable-Privileges + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Disable-Privileges [-PassThru] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -PassThru + +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### ProcessPrivileges.PrivilegeAndAttributes + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Enable-NTFSAccessInheritance.md b/Docs/Cmdlets/Enable-NTFSAccessInheritance.md new file mode 100644 index 0000000..fb2e1a0 --- /dev/null +++ b/Docs/Cmdlets/Enable-NTFSAccessInheritance.md @@ -0,0 +1,122 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Enable-NTFSAccessInheritance + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path (Default) +``` +Enable-NTFSAccessInheritance [[-Path] ] [-PassThru] [-RemoveExplicitAccessRules] [] +``` + +### SecurityDescriptor +``` +Enable-NTFSAccessInheritance [-SecurityDescriptor] [-PassThru] + [-RemoveExplicitAccessRules] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -PassThru + +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -RemoveExplicitAccessRules + +{{ Fill RemoveExplicitAccessRules Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityDescriptor + +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SecurityDescriptor +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Enable-NTFSAuditInheritance.md b/Docs/Cmdlets/Enable-NTFSAuditInheritance.md new file mode 100644 index 0000000..2128fcd --- /dev/null +++ b/Docs/Cmdlets/Enable-NTFSAuditInheritance.md @@ -0,0 +1,122 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Enable-NTFSAuditInheritance + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path (Default) +``` +Enable-NTFSAuditInheritance [[-Path] ] [-PassThru] [-RemoveExplicitAccessRules] [] +``` + +### SecurityDescriptor +``` +Enable-NTFSAuditInheritance [-SecurityDescriptor] [-PassThru] + [-RemoveExplicitAccessRules] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -PassThru + +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -RemoveExplicitAccessRules + +{{ Fill RemoveExplicitAccessRules Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityDescriptor + +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SecurityDescriptor +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Enable-Privileges.md b/Docs/Cmdlets/Enable-Privileges.md new file mode 100644 index 0000000..81606bb --- /dev/null +++ b/Docs/Cmdlets/Enable-Privileges.md @@ -0,0 +1,65 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Enable-Privileges + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Enable-Privileges [-PassThru] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -PassThru + +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### ProcessPrivileges.PrivilegeAndAttributes + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-ChildItem2.md b/Docs/Cmdlets/Get-ChildItem2.md new file mode 100644 index 0000000..4b0a5ba --- /dev/null +++ b/Docs/Cmdlets/Get-ChildItem2.md @@ -0,0 +1,262 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-ChildItem2 + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-ChildItem2 [[-Path] ] [[-Filter] ] [-Recurse] [-Directory] [-File] + [-Attributes ] [-Hidden] [-System] [-ReadOnly] [-Force] [-SkipMountPoints] + [-SkipSymbolicLinks] [-Depth ] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Attributes + +{{ Fill Attributes Description }} + +```yaml +Type: FileAttributes +Parameter Sets: (All) +Aliases: +Accepted values: ReadOnly, Hidden, System, Directory, Archive, Device, Normal, Temporary, SparseFile, ReparsePoint, Compressed, Offline, NotContentIndexed, Encrypted, IntegrityStream, NoScrubData + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Depth + +{{ Fill Depth Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Directory + +{{ Fill Directory Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File + +{{ Fill File Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter + +{{ Fill Filter Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +{{ Fill Force Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Hidden + +{{ Fill Hidden Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ReadOnly + +{{ Fill ReadOnly Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Recurse + +{{ Fill Recurse Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipMountPoints + +{{ Fill SkipMountPoints Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipSymbolicLinks + +{{ Fill SkipSymbolicLinks Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -System + +{{ Fill System Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### Alphaleonis.Win32.Filesystem.FileInfo + +### Alphaleonis.Win32.Filesystem.DirectoryInfo + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-DiskSpace.md b/Docs/Cmdlets/Get-DiskSpace.md new file mode 100644 index 0000000..7b52c52 --- /dev/null +++ b/Docs/Cmdlets/Get-DiskSpace.md @@ -0,0 +1,65 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-DiskSpace + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-DiskSpace [[-DriveLetter] ] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -DriveLetter + +{{ Fill DriveLetter Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Alphaleonis.Win32.Filesystem.DiskSpaceInfo + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-FileHash2.md b/Docs/Cmdlets/Get-FileHash2.md new file mode 100644 index 0000000..51204e5 --- /dev/null +++ b/Docs/Cmdlets/Get-FileHash2.md @@ -0,0 +1,84 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-FileHash2 + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-FileHash2 [-Path] [[-Algorithm] ] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Algorithm + +{{ Fill Algorithm Description }} + +```yaml +Type: HashAlgorithms +Parameter Sets: (All) +Aliases: +Accepted values: SHA1, SHA256, SHA384, SHA512, MACTripleDES, MD5, RIPEMD160 + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: FullName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystem.FileInfo.HashAlgorithms + +## OUTPUTS + +### Security2.FileSystemAccessRule2 + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-Item2.md b/Docs/Cmdlets/Get-Item2.md new file mode 100644 index 0000000..8b62835 --- /dev/null +++ b/Docs/Cmdlets/Get-Item2.md @@ -0,0 +1,67 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-Item2 + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-Item2 [[-Path] ] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### Alphaleonis.Win32.Filesystem.FileInfo + +### Alphaleonis.Win32.Filesystem.DirectoryInfo + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-NTFSAccess.md b/Docs/Cmdlets/Get-NTFSAccess.md new file mode 100644 index 0000000..35f5b6b --- /dev/null +++ b/Docs/Cmdlets/Get-NTFSAccess.md @@ -0,0 +1,141 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-NTFSAccess + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path (Default) +``` +Get-NTFSAccess [[-Path] ] [-Account ] [-ExcludeExplicit] [-ExcludeInherited] + [] +``` + +### SD +``` +Get-NTFSAccess [-SecurityDescriptor] [-Account ] [-ExcludeExplicit] + [-ExcludeInherited] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Account + +{{ Fill Account Description }} + +```yaml +Type: IdentityReference2 +Parameter Sets: (All) +Aliases: IdentityReference, ID + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeExplicit + +{{ Fill ExcludeExplicit Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeInherited + +{{ Fill ExcludeInherited Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecurityDescriptor + +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SD +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +### Security2.IdentityReference2 + +## OUTPUTS + +### Security2.FileSystemAccessRule2 + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-NTFSAudit.md b/Docs/Cmdlets/Get-NTFSAudit.md new file mode 100644 index 0000000..21e5dbb --- /dev/null +++ b/Docs/Cmdlets/Get-NTFSAudit.md @@ -0,0 +1,141 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-NTFSAudit + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path +``` +Get-NTFSAudit [[-Path] ] [-Account ] [-ExcludeExplicit] [-ExcludeInherited] + [] +``` + +### SD +``` +Get-NTFSAudit [-SecurityDescriptor] [-Account ] [-ExcludeExplicit] + [-ExcludeInherited] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Account + +{{ Fill Account Description }} + +```yaml +Type: IdentityReference2 +Parameter Sets: (All) +Aliases: IdentityReference, ID + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeExplicit + +{{ Fill ExcludeExplicit Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeInherited + +{{ Fill ExcludeInherited Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecurityDescriptor + +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SD +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +### Security2.IdentityReference2 + +## OUTPUTS + +### Security2.FileSystemAuditRule2 + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-NTFSEffectiveAccess.md b/Docs/Cmdlets/Get-NTFSEffectiveAccess.md new file mode 100644 index 0000000..d32d85d --- /dev/null +++ b/Docs/Cmdlets/Get-NTFSEffectiveAccess.md @@ -0,0 +1,141 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-NTFSEffectiveAccess + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path (Default) +``` +Get-NTFSEffectiveAccess [[-Path] ] [[-Account] ] [-ServerName ] + [-ExcludeNoneAccessEntries] [] +``` + +### SecurityDescriptor +``` +Get-NTFSEffectiveAccess [-SecurityDescriptor] [[-Account] ] + [-ServerName ] [-ExcludeNoneAccessEntries] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Account + +{{ Fill Account Description }} + +```yaml +Type: IdentityReference2 +Parameter Sets: (All) +Aliases: NTAccount, IdentityReference + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExcludeNoneAccessEntries + +{{ Fill ExcludeNoneAccessEntries Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecurityDescriptor + +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SecurityDescriptor +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ServerName + +{{ Fill ServerName Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +### Security2.IdentityReference2 + +## OUTPUTS + +### Security2.FileSystemAccessRule2 + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-NTFSHardLink.md b/Docs/Cmdlets/Get-NTFSHardLink.md new file mode 100644 index 0000000..af36e38 --- /dev/null +++ b/Docs/Cmdlets/Get-NTFSHardLink.md @@ -0,0 +1,67 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-NTFSHardLink + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-NTFSHardLink [[-Path] ] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### Alphaleonis.Win32.Filesystem.FileInfo + +### Alphaleonis.Win32.Filesystem.DirectoryInfo + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-NTFSInheritance.md b/Docs/Cmdlets/Get-NTFSInheritance.md new file mode 100644 index 0000000..4c9ce85 --- /dev/null +++ b/Docs/Cmdlets/Get-NTFSInheritance.md @@ -0,0 +1,89 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-NTFSInheritance + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path (Default) +``` +Get-NTFSInheritance [[-Path] ] [] +``` + +### SecurityDescriptor +``` +Get-NTFSInheritance [-SecurityDescriptor] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecurityDescriptor + +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SecurityDescriptor +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +## OUTPUTS + +### Security2.FileSystemInheritanceInfo + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-NTFSOrphanedAccess.md b/Docs/Cmdlets/Get-NTFSOrphanedAccess.md new file mode 100644 index 0000000..8e49e98 --- /dev/null +++ b/Docs/Cmdlets/Get-NTFSOrphanedAccess.md @@ -0,0 +1,141 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-NTFSOrphanedAccess + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path +``` +Get-NTFSOrphanedAccess [[-Path] ] [-Account ] [-ExcludeExplicit] + [-ExcludeInherited] [] +``` + +### SD +``` +Get-NTFSOrphanedAccess [-SecurityDescriptor] [-Account ] + [-ExcludeExplicit] [-ExcludeInherited] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Account + +{{ Fill Account Description }} + +```yaml +Type: IdentityReference2 +Parameter Sets: (All) +Aliases: IdentityReference, ID + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeExplicit + +{{ Fill ExcludeExplicit Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeInherited + +{{ Fill ExcludeInherited Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecurityDescriptor + +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SD +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +### Security2.IdentityReference2 + +## OUTPUTS + +### Security2.FileSystemAccessRule2 + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-NTFSOrphanedAudit.md b/Docs/Cmdlets/Get-NTFSOrphanedAudit.md new file mode 100644 index 0000000..5172ae8 --- /dev/null +++ b/Docs/Cmdlets/Get-NTFSOrphanedAudit.md @@ -0,0 +1,141 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-NTFSOrphanedAudit + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path +``` +Get-NTFSOrphanedAudit [[-Path] ] [-Account ] [-ExcludeExplicit] + [-ExcludeInherited] [] +``` + +### SD +``` +Get-NTFSOrphanedAudit [-SecurityDescriptor] [-Account ] + [-ExcludeExplicit] [-ExcludeInherited] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Account + +{{ Fill Account Description }} + +```yaml +Type: IdentityReference2 +Parameter Sets: (All) +Aliases: IdentityReference, ID + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeExplicit + +{{ Fill ExcludeExplicit Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeInherited + +{{ Fill ExcludeInherited Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecurityDescriptor + +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SD +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +### Security2.IdentityReference2 + +## OUTPUTS + +### Security2.FileSystemAuditRule2 + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-NTFSOwner.md b/Docs/Cmdlets/Get-NTFSOwner.md new file mode 100644 index 0000000..5a0d237 --- /dev/null +++ b/Docs/Cmdlets/Get-NTFSOwner.md @@ -0,0 +1,89 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-NTFSOwner + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path (Default) +``` +Get-NTFSOwner [[-Path] ] [] +``` + +### SecurityDescriptor +``` +Get-NTFSOwner [-SecurityDescriptor] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecurityDescriptor + +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SecurityDescriptor +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +## OUTPUTS + +### Security2.FileSystemOwner + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-NTFSSecurityDescriptor.md b/Docs/Cmdlets/Get-NTFSSecurityDescriptor.md new file mode 100644 index 0000000..b3f2648 --- /dev/null +++ b/Docs/Cmdlets/Get-NTFSSecurityDescriptor.md @@ -0,0 +1,65 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-NTFSSecurityDescriptor + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-NTFSSecurityDescriptor [[-Path] ] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### Security2.FileSystemSecurity2 + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-NTFSSimpleAccess.md b/Docs/Cmdlets/Get-NTFSSimpleAccess.md new file mode 100644 index 0000000..c34118a --- /dev/null +++ b/Docs/Cmdlets/Get-NTFSSimpleAccess.md @@ -0,0 +1,157 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-NTFSSimpleAccess + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path +``` +Get-NTFSSimpleAccess [-IncludeRootFolder] [[-Path] ] [-Account ] + [-ExcludeExplicit] [-ExcludeInherited] [] +``` + +### SD +``` +Get-NTFSSimpleAccess [-IncludeRootFolder] [-SecurityDescriptor] + [-Account ] [-ExcludeExplicit] [-ExcludeInherited] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Account + +{{ Fill Account Description }} + +```yaml +Type: IdentityReference2 +Parameter Sets: (All) +Aliases: IdentityReference, ID + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeExplicit + +{{ Fill ExcludeExplicit Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeInherited + +{{ Fill ExcludeInherited Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeRootFolder + +{{ Fill IncludeRootFolder Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecurityDescriptor + +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SD +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +### Security2.IdentityReference2 + +## OUTPUTS + +### Security2.SimpleFileSystemAccessRule + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Get-Privileges.md b/Docs/Cmdlets/Get-Privileges.md new file mode 100644 index 0000000..703ef06 --- /dev/null +++ b/Docs/Cmdlets/Get-Privileges.md @@ -0,0 +1,49 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Get-Privileges + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-Privileges [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### ProcessPrivileges.PrivilegeAndAttributes + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Move-Item2.md b/Docs/Cmdlets/Move-Item2.md new file mode 100644 index 0000000..217fb2a --- /dev/null +++ b/Docs/Cmdlets/Move-Item2.md @@ -0,0 +1,149 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Move-Item2 + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Move-Item2 [-Path] [-Destination] [-Force] [-PassThru ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination + +{{ Fill Destination Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force + +{{ Fill Force Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +{{ Fill PassThru Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: FullName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/New-NTFSHardLink.md b/Docs/Cmdlets/New-NTFSHardLink.md new file mode 100644 index 0000000..04cc5c8 --- /dev/null +++ b/Docs/Cmdlets/New-NTFSHardLink.md @@ -0,0 +1,99 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# New-NTFSHardLink + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-NTFSHardLink [[-Path] ] [[-Target] ] [-PassThru] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -PassThru + +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Target + +{{ Fill Target Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Alphaleonis.Win32.Filesystem.FileInfo + +### Alphaleonis.Win32.Filesystem.DirectoryInfo + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/New-NTFSSymbolicLink.md b/Docs/Cmdlets/New-NTFSSymbolicLink.md new file mode 100644 index 0000000..854a647 --- /dev/null +++ b/Docs/Cmdlets/New-NTFSSymbolicLink.md @@ -0,0 +1,99 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# New-NTFSSymbolicLink + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-NTFSSymbolicLink [[-Path] ] [[-Target] ] [-PassThru] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -PassThru + +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Target + +{{ Fill Target Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Alphaleonis.Win32.Filesystem.FileInfo + +### Alphaleonis.Win32.Filesystem.DirectoryInfo + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Remove-Item2.md b/Docs/Cmdlets/Remove-Item2.md new file mode 100644 index 0000000..d0c9cc9 --- /dev/null +++ b/Docs/Cmdlets/Remove-Item2.md @@ -0,0 +1,146 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Remove-Item2 + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-Item2 [[-Path] ] [-Force] [-Recurse] [-PassThur] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +{{ Fill Force Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThur + +{{ Fill PassThur Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Recurse + +{{ Fill Recurse Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Remove-NTFSAccess.md b/Docs/Cmdlets/Remove-NTFSAccess.md new file mode 100644 index 0000000..3f1f5fb --- /dev/null +++ b/Docs/Cmdlets/Remove-NTFSAccess.md @@ -0,0 +1,235 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Remove-NTFSAccess + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +### PathComplex (Default) +``` +Remove-NTFSAccess [-Path] [-Account] [-AccessRights] + [-AccessType ] [-InheritanceFlags ] + [-PropagationFlags ] [-PassThru] [] +``` + +### PathSimple +``` +Remove-NTFSAccess [-Path] [-Account] [-AccessRights] + [-AccessType ] [-AppliesTo ] [-PassThru] [] +``` + +### SDSimple +``` +Remove-NTFSAccess [-SecurityDescriptor] [-Account] + [-AccessRights] [-AccessType ] [-AppliesTo ] [-PassThru] + [] +``` + +### SDComplex +``` +Remove-NTFSAccess [-SecurityDescriptor] [-Account] + [-AccessRights] [-AccessType ] [-InheritanceFlags ] + [-PropagationFlags ] [-PassThru] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -AccessRights + +{{ Fill AccessRights Description }} + +```yaml +Type: FileSystemRights2 +Parameter Sets: (All) +Aliases: FileSystemRights +Accepted values: None, ReadData, ListDirectory, WriteData, CreateFiles, AppendData, CreateDirectories, ReadExtendedAttributes, WriteExtendedAttributes, ExecuteFile, Traverse, DeleteSubdirectoriesAndFiles, ReadAttributes, WriteAttributes, Write, Delete, ReadPermissions, Read, ReadAndExecute, Modify, ChangePermissions, TakeOwnership, Synchronize, FullControl, GenericAll, GenericExecute, GenericWrite, GenericRead + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AccessType + +{{ Fill AccessType Description }} + +```yaml +Type: AccessControlType +Parameter Sets: (All) +Aliases: AccessControlType +Accepted values: Allow, Deny + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Account + +{{ Fill Account Description }} + +```yaml +Type: IdentityReference2[] +Parameter Sets: (All) +Aliases: IdentityReference, ID + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AppliesTo + +{{ Fill AppliesTo Description }} + +```yaml +Type: ApplyTo +Parameter Sets: PathSimple, SDSimple +Aliases: +Accepted values: ThisFolderOnly, ThisFolderSubfoldersAndFiles, ThisFolderAndSubfolders, ThisFolderAndFiles, SubfoldersAndFilesOnly, SubfoldersOnly, FilesOnly, ThisFolderSubfoldersAndFilesOneLevel, ThisFolderAndSubfoldersOneLevel, ThisFolderAndFilesOneLevel, SubfoldersAndFilesOnlyOneLevel, SubfoldersOnlyOneLevel, FilesOnlyOneLevel + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InheritanceFlags + +{{ Fill InheritanceFlags Description }} + +```yaml +Type: InheritanceFlags +Parameter Sets: PathComplex, SDComplex +Aliases: +Accepted values: None, ContainerInherit, ObjectInherit + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru + +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: PathComplex, PathSimple +Aliases: FullName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PropagationFlags + +{{ Fill PropagationFlags Description }} + +```yaml +Type: PropagationFlags +Parameter Sets: PathComplex, SDComplex +Aliases: +Accepted values: None, NoPropagateInherit, InheritOnly + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecurityDescriptor + +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SDSimple, SDComplex +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +### Security2.IdentityReference2[] + +### Security2.FileSystemRights2 + +### System.Security.AccessControl.AccessControlType + +### System.Security.AccessControl.InheritanceFlags + +### System.Security.AccessControl.PropagationFlags + +### Security2.ApplyTo + +## OUTPUTS + +### Security2.FileSystemAccessRule2 + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Remove-NTFSAudit.md b/Docs/Cmdlets/Remove-NTFSAudit.md new file mode 100644 index 0000000..399ca1d --- /dev/null +++ b/Docs/Cmdlets/Remove-NTFSAudit.md @@ -0,0 +1,235 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Remove-NTFSAudit + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +### PathComplex (Default) +``` +Remove-NTFSAudit [-Path] [-Account] [-AccessRights] + [-AuditFlags ] [-InheritanceFlags ] [-PropagationFlags ] + [-PassThru] [] +``` + +### PathSimple +``` +Remove-NTFSAudit [-Path] [-Account] [-AccessRights] + [-AuditFlags ] [-AppliesTo ] [-PassThru] [] +``` + +### SDSimple +``` +Remove-NTFSAudit [-SecurityDescriptor] [-Account] + [-AccessRights] [-AuditFlags ] [-AppliesTo ] [-PassThru] + [] +``` + +### SDComplex +``` +Remove-NTFSAudit [-SecurityDescriptor] [-Account] + [-AccessRights] [-AuditFlags ] [-InheritanceFlags ] + [-PropagationFlags ] [-PassThru] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -AccessRights + +{{ Fill AccessRights Description }} + +```yaml +Type: FileSystemRights2 +Parameter Sets: (All) +Aliases: FileSystemRights +Accepted values: None, ReadData, ListDirectory, WriteData, CreateFiles, AppendData, CreateDirectories, ReadExtendedAttributes, WriteExtendedAttributes, ExecuteFile, Traverse, DeleteSubdirectoriesAndFiles, ReadAttributes, WriteAttributes, Write, Delete, ReadPermissions, Read, ReadAndExecute, Modify, ChangePermissions, TakeOwnership, Synchronize, FullControl, GenericAll, GenericExecute, GenericWrite, GenericRead + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Account + +{{ Fill Account Description }} + +```yaml +Type: IdentityReference2[] +Parameter Sets: (All) +Aliases: IdentityReference, ID + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AppliesTo + +{{ Fill AppliesTo Description }} + +```yaml +Type: ApplyTo +Parameter Sets: PathSimple, SDSimple +Aliases: +Accepted values: ThisFolderOnly, ThisFolderSubfoldersAndFiles, ThisFolderAndSubfolders, ThisFolderAndFiles, SubfoldersAndFilesOnly, SubfoldersOnly, FilesOnly, ThisFolderSubfoldersAndFilesOneLevel, ThisFolderAndSubfoldersOneLevel, ThisFolderAndFilesOneLevel, SubfoldersAndFilesOnlyOneLevel, SubfoldersOnlyOneLevel, FilesOnlyOneLevel + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AuditFlags + +{{ Fill AuditFlags Description }} + +```yaml +Type: AuditFlags +Parameter Sets: (All) +Aliases: +Accepted values: None, Success, Failure + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InheritanceFlags + +{{ Fill InheritanceFlags Description }} + +```yaml +Type: InheritanceFlags +Parameter Sets: PathComplex, SDComplex +Aliases: +Accepted values: None, ContainerInherit, ObjectInherit + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru + +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: PathComplex, PathSimple +Aliases: FullName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PropagationFlags + +{{ Fill PropagationFlags Description }} + +```yaml +Type: PropagationFlags +Parameter Sets: PathComplex, SDComplex +Aliases: +Accepted values: None, NoPropagateInherit, InheritOnly + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecurityDescriptor + +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SDSimple, SDComplex +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +### Security2.IdentityReference2[] + +### Security2.FileSystemRights2 + +### System.Security.AccessControl.AuditFlags + +### System.Security.AccessControl.InheritanceFlags + +### System.Security.AccessControl.PropagationFlags + +### Security2.ApplyTo + +## OUTPUTS + +### Security2.FileSystemAccessRule2 + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Set-NTFSInheritance.md b/Docs/Cmdlets/Set-NTFSInheritance.md new file mode 100644 index 0000000..dec6c97 --- /dev/null +++ b/Docs/Cmdlets/Set-NTFSInheritance.md @@ -0,0 +1,141 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Set-NTFSInheritance + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path (Default) +``` +Set-NTFSInheritance [[-Path] ] [-AccessInheritanceEnabled ] + [-AuditInheritanceEnabled ] [-PassThru] [] +``` + +### SecurityDescriptor +``` +Set-NTFSInheritance [-SecurityDescriptor] [-AccessInheritanceEnabled ] + [-AuditInheritanceEnabled ] [-PassThru] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -AccessInheritanceEnabled + +{{ Fill AccessInheritanceEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AuditInheritanceEnabled + +{{ Fill AuditInheritanceEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru + +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecurityDescriptor + +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SecurityDescriptor +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Set-NTFSOwner.md b/Docs/Cmdlets/Set-NTFSOwner.md new file mode 100644 index 0000000..e0c947b --- /dev/null +++ b/Docs/Cmdlets/Set-NTFSOwner.md @@ -0,0 +1,124 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Set-NTFSOwner + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +### Path (Default) +``` +Set-NTFSOwner [[-Path] ] [-Account] [-PassThru] [] +``` + +### SecurityDescriptor +``` +Set-NTFSOwner [-SecurityDescriptor] [-Account] [-PassThru] + [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Account + +{{ Fill Account Description }} + +```yaml +Type: IdentityReference2 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru + +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: Path +Aliases: FullName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecurityDescriptor + +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: SecurityDescriptor +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Security2.FileSystemSecurity2[] + +### Security2.IdentityReference2 + +## OUTPUTS + +### Security2.FileSystemOwner + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Set-NTFSSecurityDescriptor.md b/Docs/Cmdlets/Set-NTFSSecurityDescriptor.md new file mode 100644 index 0000000..eb14872 --- /dev/null +++ b/Docs/Cmdlets/Set-NTFSSecurityDescriptor.md @@ -0,0 +1,81 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Set-NTFSSecurityDescriptor + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Set-NTFSSecurityDescriptor [-SecurityDescriptor] [-PassThru] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -PassThru + +{{ Fill PassThru Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityDescriptor + +{{ Fill SecurityDescriptor Description }} + +```yaml +Type: FileSystemSecurity2[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Security2.FileSystemSecurity2[] + +## OUTPUTS + +### Security2.FileSystemSecurity2 + +## NOTES + +## RELATED LINKS diff --git a/Docs/Cmdlets/Test-Path2.md b/Docs/Cmdlets/Test-Path2.md new file mode 100644 index 0000000..71f3664 --- /dev/null +++ b/Docs/Cmdlets/Test-Path2.md @@ -0,0 +1,86 @@ +--- +external help file: NTFSSecurity.dll-Help.xml +Module Name: ntfssecurity +online version: +schema: 2.0.0 +--- + +# Test-Path2 + +## SYNOPSIS + +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Test-Path2 [-Path] [-PathType ] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```PowerShell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path + +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: FullName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PathType + +{{ Fill PathType Description }} + +```yaml +Type: TestPathType +Parameter Sets: (All) +Aliases: +Accepted values: Any, Container, Leaf + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### NTFSSecurity.TestPathType + +## OUTPUTS + +### Alphaleonis.Win32.Filesystem.FileInfo + +### Alphaleonis.Win32.Filesystem.DirectoryInfo + +## NOTES + +## RELATED LINKS diff --git a/Docs/Concepts.md b/Docs/Concepts.md new file mode 100644 index 0000000..be71b62 --- /dev/null +++ b/Docs/Concepts.md @@ -0,0 +1,98 @@ +# CORE CONCEPTS + +## Overview + +Before starting with the NTFSSecurity module there are some core concepts that you will need to understand. + +There are two ways you can handle permissions, basic and advanced. The basic set of permissions are goups of advanced permissions that allow you to assign common role such as 'Read', 'Read/Write', or 'Full'. Advanced permissions allow you granular control of what can and can't be access or used. The advanced permissions are commonly used to build custom Role-Based Access Control tooling. + +Below is an explaination taken from the fantastic site NTFS.com for each of the advanced file permissions. + +### Traverse Folder/Execute File + +* **Traverse Folder**: Allows or denies moving through a restricted folder to reach files and folders beneath the restricted folder in the folder hierarchy. Traverse folder takes effect only when the group or user is not granted the "Bypass traverse checking user" right in the Group Policy snap-in. This permission does not automatically allow running program files. + +* **Execute File**: Allows or denies running program (executable) files. + +### List Folder/Read Data + +* **List Folder**: Allows or denies viewing file names and subfolder names within the folder. List Folder only affects the contents of that folder and does not affect whether the folder you are setting the permission on will be listed. + +* **Read Data**: Allows or denies viewing data in files. + +### Read Attributes + +* Allows or denies viewing the attributes of a file or folder, for example, "read-only" and "hidden". + +### Read Extended Attributes + +* Allows or denies viewing the extended attributes of a file or folder. Extended attributes are defined by programs and may vary by program. + +### Create Files/Write Data + +* **Create Files**: Allows or denies creating files within the folder. + +* **Write Data**: Allows or denies making changes to a file and overwriting existing content. + +### Create Folders/Append Data + +* **Create Folders**: Allows or denies creating subfolders within the folder. + +* **Append Data**: Allows or denies making changes to the end of the file but not changing, deleting, or overwriting existing data. + +### Write Attributes + +* Allows or denies changing the attributes of a file or folder, for example, "read-only" or "hidden". + +* The Write Attributes permission does not imply creating or deleting files or folders, it only includes the permission to make changes to the attributes of an existing file or folder. + +### Write Extended Attributes + +* Allows or denies changing the extended attributes of a file or folder. Extended attributes are defined by programs and may vary by program. + +* The Write Extended Attributes permission does not imply creating or deleting files or folders, it only includes the permission to make changes to the extended attributes of an existing file or folder. + +### Delete Subfolders and Files + +* Allows or denies deleting subfolders and files, even if the Delete permission has not been granted on the subfolder or file. + +### Delete + +* Allows or denies deleting the file or folder. If you don't have Delete permission on a file or folder, you can still delete it if you have been granted Delete Subfolders and Files on the parent folder. + +### Read Permissions + +* Allows or denies reading permissions of a file or folder. + +### Change Permissions + +* Allows or denies changing permissions of the file or folder. + +### Take Ownership + +* Allows or denies taking ownership of the file or folder. The owner of a file or folder can always change permissions on it, regardless of any existing permissions that protect the file or folder. + +You can see how the basic permissions, advanced permissions, and the NTFSSecurity module relate to one another in the below table. + +| NTFSSecurity | AccessRight displayed | Advanced Security Window | +|------------------------------|------------------------------|---------------------------------------------------------------------------------------------------------------------------| +| ReadData | ListDirectory | List Folder / Read Data | +| ListDirectory | ListDirectory | List Folder / Read Data | +| WriteData | CreateFile | Create Files / Write Data | +| CreateFiles | CreateFile | Create Files / Write Data | +| AppendData | CreateDirectories | Create Folders / Append Data | +| CreateDirectories | CreateDirectories | Create Folders / Append Data | +| ReadExtendedAttributes | ReadExtendedAttributes | Read Extended Attributes | +| WriteExtendedAttributes | WriteExtendedAttributes | WriteExtendedAttributes | +| ExecuteFile | Traverse | Traverse Folder / Execute File | +| Traverse | Traverse | Traverse Folder / Execute File | +| DeleteSubdirectoriesAndFiles | DeleteSubdirectoriesAndFiles | Delete Sub-folders and Files | +| ReadAttributes | ReadAttributes | Read Attributes | +| WriteAttributes | WriteAttributes | Write Attributes | +| Write | Write | Create Files / Write Data, Create Folders / Append Data, Write-Attributes, Write Extended Attributes | +| Delete | Delete | Delete | +| ReadPermissions | ReadPermissions | Read Permissions | +| Read | Read | List Folder / Read Data, Read Attributes, Read Extended Attributes, Read Permissions | +| ReadAndExecute | ReadAndExecute | Traverse Folder / Execute File, List Folder / Read Data, Read Attributes, Read Extended Attributes, Read Permissions | +| Modify | Modify | Everything except Full Control, Delete SubFolders and Files, Change Permissions, Take Ownership | +| ChangePermissions | ChangePermissions | Change Permissions | diff --git a/Docs/Contributing.md b/Docs/Contributing.md new file mode 100644 index 0000000..f9e0e26 --- /dev/null +++ b/Docs/Contributing.md @@ -0,0 +1,10 @@ +# Contributor Guide + +Thank you for your interest in contributing to quality documentations. +As an open source project, we welcome input and updates from the community. +The following topics explain how to contribute to the NTFSAccess documentation. + +1. [Get started](./Contributing/01-Getting-Started.md) +2. [Writing PowerShell documentation](./Contributing/02-Writing.md) + +This contributor guide is a modified version of the one found on the [Powershell Docs](https://github.com/PowerShell/PowerShell-Docs) GitHub page. diff --git a/Docs/Contributing/01-Getting-Started.md b/Docs/Contributing/01-Getting-Started.md new file mode 100644 index 0000000..42ba548 --- /dev/null +++ b/Docs/Contributing/01-Getting-Started.md @@ -0,0 +1,54 @@ +# Contributing to PowerShell Documentation + +Thank you for your interest in NTFSAccess documentation! + +See below for details on how you can contribute to our technical documentation. + +> For general information about getting started with Git and GitHub, see [GitHub Help][git-help]. + +## Providing feedback on NTFSAccess documentation + +Report errors, suggest changes, or request new topics by [creating an issue][new-issue] on the +[NTFSAccess repository issues page][doc-issues]. + +## Making minor edits to existing topics + +To [edit an existing file][edit-file], navigate to it and click the "Edit" button. GitHub will +automatically create your own fork of our repository where you can make your changes. Once you are +finished, save your edits and submit a [pull request][pull] to the *staging* branch of the +[NTFSAccess-Docs][docs-repo] repository. After your pull request is created, someone on the +NTFSAccess documentation team reviews your changes before merging them into the *staging* branch. + +## Making major edits to existing topics + +If you are making significant changes, adding or changing images, or contributing a new article, you +need to create a GitHub fork and clone it to your computer. A fork is a GitHub-based replica of the +main repository, under your GitHub account, that provides you with a working copy which you can use +in isolation. You create pull requests from your fork. Similarly, a clone is a local-based replica +of the repository which, in this case, is a clone of your fork. The clone allows you to work on Git +repositories offline, and using more powerful native software/tools. + +Here is the workflow for making major edits to existing documentation: + +1. [Create a fork][fork] of the [NTFSAccess][docs-repo] repository. +2. [Create a clone of your fork][clone] on your local computer. +3. Create a new local branch in your cloned repository. +4. Make changes to the file(s) you want to update in a Markdown editor. +5. [Push your local branch][push] to your fork. +6. [Create a pull request][pull] to the *staging* branch of the [NTFSAccess-Docs][docs-repo] + repository. + +## Next steps + +See [Writing documentation](02-Writing.md). + + +[git-help]: https://help.github.com/ +[new-issue]: https://help.github.com/articles/creating-an-issue/ +[doc-issues]: https://github.com/raandree/NTFSSecurity/issues +[edit-file]: https://help.github.com/articles/editing-files-in-another-user-s-repository/ +[docs-repo]: https://github.com/raandree/NTFSSecurity/ +[fork]: https://help.github.com/articles/fork-a-repo/ +[clone]: https://help.github.com/articles/cloning-a-repository/ +[push]: https://help.github.com/articles/pushing-to-a-remote/ +[pull]: https://help.github.com/articles/creating-a-pull-request/ \ No newline at end of file diff --git a/Docs/Contributing/02-Writing.md b/Docs/Contributing/02-Writing.md new file mode 100644 index 0000000..b546560 --- /dev/null +++ b/Docs/Contributing/02-Writing.md @@ -0,0 +1,55 @@ +# WRITING DOCUMENTATION + +One of the easiest ways to contribute to the NTFSAccess PowerShell module is by helping to write and edit documentation. +All the documentation hosted on GitHub is written using *Markdown*. Markdown is a lightweight markup +language with plain text formatting syntax. Markdown forms the basis of our documentation's +conceptual authoring language. Creating new articles is as easy as writing a simple text file by +using your favorite text editor. + +## Markdown editors + +Here are some Markdown editors you can try out: + +- [Visual Studio Code](https://code.visualstudio.com) +- [Atom](https://atom.io/) +- [Sublime Text](http://www.sublimetext.com/) + +## Get started using Markdown + +To get started using Markdown, see [How to use Markdown for writing Docs](https://docs.microsoft.com/contribute/how-to-write-use-markdown). + +NTFSSecurity uses the [Mkdocs][mkdocs] builder on ReadTheDocs for documentation. + +Don't use hard tabs in Markdown. For more detailed information about the Markdown specification, see the +[Markdown Specifics](04-Markdown-Specifics.md) article. + +## Creating new topics + +To contribute new documentation, check for issues tagged as ["Help Wanted"][labels] to make sure +you're not duplicating efforts. If no one seems to be working on what you have planned: + +- Open a new issue and label it as "in progress". If you don't have rights to assign labels, add "in + progress" as a comment to tell others what you're working on. +- Follow the same workflow as described above for making major edits to existing topics. +- Add your new article to the `TOC.yml` file (located in the top-level folder of each + documentation set). + +## Updating topics that exist in multiple versions + +Most reference topics are duplicated across all versions of PowerShell. When reporting an issue +about a cmdlet reference or an About_ article, you must specify which versions are affected by the +issue. The default issue template in GitHub includes a [GFM task list][gfm-task]. Use the checkboxes +in the task list to specify which versions of the content are affected. When you submit a change to +a article for an issue that affects multiple versions of the content, you must apply the appropriate +change to each version of the file. + +## Next Steps + +Read the [Style Guide](03-Style-Guide.md). + + +[markdig]: https://github.com/lunet-io/markdig +[CommonMark]: https://spec.commonmark.org/ +[gfm-help]: https://help.github.com/categories/writing-on-github/ +[labels]: https://github.com/raandree/NTFSSecurity/labels/Help%20Wanted +[mkdocs]: https://www.mkdocs.org/user-guide/writing-your-docs/ \ No newline at end of file diff --git a/Docs/Contributing/03-Style-Guide.md b/Docs/Contributing/03-Style-Guide.md new file mode 100644 index 0000000..e69de29 diff --git a/Docs/Contributing/04-Markdown-Specifics.md b/Docs/Contributing/04-Markdown-Specifics.md new file mode 100644 index 0000000..e69de29 diff --git a/Docs/index.md b/Docs/index.md new file mode 100644 index 0000000..eee4b41 --- /dev/null +++ b/Docs/index.md @@ -0,0 +1,31 @@ +# NTFSSecurity + +[![Build status](https://ci.appveyor.com/api/projects/status/2gfb58t9qh655b8x?svg=true)](https://ci.appveyor.com/project/Sup3rlativ3/ntfssecurity) [![Documentation Status](https://readthedocs.org/projects/ntfssecurity/badge/?version=latest)](https://ntfssecurity.readthedocs.io/en/latest/?badge=latest) + +Managing file & folder permissions with PowerShell is only a bit easier than in VBS or the command line as there are no cmdlets for most day-to-day tasks like getting a permission report or adding permission to an item. PowerShell only offers Get-Acl and Set-Acl but everything in between getting and setting the ACL is missing. This module closes the gap. + +[Version History](https://github.com/raandree/NTFSSecurity/wiki/Version-History) + +## Installation + +You have two options: + +* Download the latest release from the [releases](https://github.com/raandree/NTFSSecurity/releases) section on GitHub. +* Download the module from the [PowerShell Gallery](https://www.powershellgallery.com/packages/NTFSSecurity): + +```PowerShell +Install-Module -Name NTFSSecurity +``` + +Further help can be found in How to install if you face difficulties getting this module installed. + +## Documentation + +The cmdlets are yet not documented completely so Get-Help will not show help for all the cmdlets. This ReadTheDocs site is the first step to documenting the module. + +## Tutorials + +There are a number of tutorials available on the web. The below two were written by the author of the NTFSSecurity module. + +[NTFSSecurity Tutorial 1 - Getting, adding and removing permissions](http://blogs.technet.com/b/fieldcoding/archive/2014/12/05/ntfssecurity-tutorial-1-getting-adding-and-removing-permissions.aspx) +[NTFSSecurity Tutorial 2 - Managing NTFS Inheritance and Using Privileges](http://blogs.technet.com/b/fieldcoding/archive/2014/12/05/ntfssecurity-tutorial-2-managing-ntfs-inheritance-and-using-privileges.aspx) diff --git a/appveyor.yml b/appveyor.yml new file mode 100644 index 0000000..a0573d6 --- /dev/null +++ b/appveyor.yml @@ -0,0 +1,31 @@ +install: + - ps: | + Install-PackageProvider -Name NuGet -MinimumVersion 2.8.5.201 -Force + Install-Module platyPS -Force + Install-Module MarkdownLinkCheck -Force + Install-Module NTFSSecurity -Force + Import-Module platyPS + Import-Module MarkdownLinkCheck + +init: + - ps: git config --global core.autocrlf true + +build_script: + - ps: Import-Module -Force NTFSSecurity + +test_script: + - ps: | + $ErrorActionPreference = 'Stop' + + # 01. Test that documentation is up-to-date + Update-MarkdownHelp -Path ./Docs/Cmdlets + $Diff = git diff + if ($Diff) { + throw "Help is not up-to-date, run Update-MarkdownHelp: $diff" + } + + # 02. Verify hyperlinks + $BrokenLinks = Get-MarkdownLink -Path .\Docs\ -BrokenOnly + if ($brokenLinks) { + throw "Found broken hyperlinks $brokenLinks" + } \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..a25b256 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,51 @@ +copyright: The NTFSSecurity module is licensed under the MIT license +repo_url: https://github.com/raandree/NTFSSecurity +nav: +- Home: ./index.md +- Concepts: ./Concepts.md +- Cmdlets: + - Add-NTFSAccess: Cmdlets/Add-NTFSAccess.md + - Add-NTFSAudit: Cmdlets/Add-NTFSAudit.md + - Clear-NTFSAccess: Cmdlets/Clear-NTFSAccess.md + - Clear-NTFSAudit: Cmdlets/Clear-NTFSAudit.md + - Copy-Item2: Cmdlets/Copy-Item2.md + - Disable-NTFSAccessInheritance: Cmdlets/Disable-NTFSAccessInheritance.md + - Disable-NTFSAuditInheritance: Cmdlets/Disable-NTFSAuditInheritance.md + - Disable-Privileges: Cmdlets/Disable-Privileges.md + - Enable-NTFSAccessInheritance: Cmdlets/Enable-NTFSAccessInheritance.md + - Enable-NTFSAuditInheritance: Cmdlets/Enable-NTFSAuditInheritance.md + - Enable-Privileges: Cmdlets/Enable-Privileges.md + - Get-ChildItem2: Cmdlets/Get-ChildItem2.md + - Get-DiskSpace: Cmdlets/Get-DiskSpace.md + - Get-FileHash2: Cmdlets/Get-FileHash2.md + - Get-Item2: Cmdlets/Get-Item2.md + - Get-NTFSAccess: Cmdlets/Get-NTFSAccess.md + - Get-NTFSAudit: Cmdlets/Get-NTFSAudit.md + - Get-NTFSEffectiveAccess: Cmdlets/Get-NTFSEffectiveAccess.md + - Get-NTFSHardLink: Cmdlets/Get-NTFSHardLink.md + - Get-NTFSInheritance: Cmdlets/Get-NTFSInheritance.md + - Get-NTFSOrphanedAccess: Cmdlets/Get-NTFSOrphanedAccess.md + - Get-NTFSOrphanedAudit: Cmdlets/Get-NTFSOrphanedAudit.md + - Get-NTFSOwner: Cmdlets/Get-NTFSOwner.md + - Get-NTFSSecurityDescriptor: Cmdlets/Get-NTFSSecurityDescriptor.md + - Get-NTFSSimpleAccess: Cmdlets/Get-NTFSSimpleAccess.md + - Get-Privileges: Cmdlets/Get-Privileges.md + - Move-Item2: Cmdlets/Move-Item2.md + - New-NTFSHardLink: Cmdlets/New-NTFSHardLink.md + - New-NTFSSymbolicLink: Cmdlets/New-NTFSSymbolicLink.md + - Remove-Item2: Cmdlets/Remove-Item2.md + - Remove-NTFSAccess: Cmdlets/Remove-NTFSAccess.md + - Remove-NTFSAudit: Cmdlets/Remove-NTFSAudit.md + - Set-NTFSInheritance: Cmdlets/Set-NTFSInheritance.md + - Set-NTFSOwner: Cmdlets/Set-NTFSOwner.md + - Set-NTFSSecurityDescriptor: Cmdlets/Set-NTFSSecurityDescriptor.md + - Test-Path2: Cmdlets/Test-Path2.md +- Contributing: + - Getting Started: Contributing/01-Getting-Started.md + - Writing: Contributing/02-Writing.md + - Style Guide: Contributing/03-Style-Guide.md + - Markdown Specifics: Contributing:04-Markdown-Specifics.md +site_name: NTFSSecurity +theme: readthedocs +site_author: Raimund Andrée, James Smith +docs_dir: ./Docs \ No newline at end of file