mirror of
https://github.com/EvotecIT/GPOZaurr.git
synced 2026-07-26 11:49:17 +00:00
Przemysław Kłys
f7bdaca724
- Revised `Set-GPOZaurrOwner.md` to enhance clarity and detail for parameters and examples. - Updated `Set-GPOZaurrStatus.md` with a new online version link and improved structure. - Refined `Skip-GroupPolicy.md` to clarify usage within script blocks and added examples. - Adjusted `GPOZaurr.psd1` for version updates and improved module dependencies. - Enhanced `GPOZaurr.psm1` for better error handling during function imports. - Modified `Invoke-GPOZaurrSupport.ps1` examples to use `Join-Path` for path construction.
195 lines
5.0 KiB
Markdown
195 lines
5.0 KiB
Markdown
---
|
|
external help file: GPOZaurr-help.xml
|
|
Module Name: GPOZaurr
|
|
online version: https://github.com/EvotecIT/GPOZaurr
|
|
schema: 2.0.0
|
|
---
|
|
# Get-GPOZaurrPermissionSummary
|
|
## SYNOPSIS
|
|
Retrieves a summary of Group Policy Object (GPO) permissions based on specified criteria.
|
|
|
|
## SYNTAX
|
|
### __AllParameterSets
|
|
```powershell
|
|
Get-GPOZaurrPermissionSummary [[-Type] <string[]>] [[-PermitType] <string>] [[-IncludePermissionType] <string[]>] [[-ExcludePermissionType] <string[]>] [[-Forest] <string>] [[-ExcludeDomains] <string[]>] [[-IncludeDomains] <string[]>] [[-ExtendedForestInformation] <IDictionary>] [[-Separator] <string>] [<CommonParameters>]
|
|
```
|
|
|
|
## DESCRIPTION
|
|
Retrieves a summary of GPO permissions based on the specified criteria, including filtering by permission types, permit types, and more.
|
|
|
|
## EXAMPLES
|
|
|
|
### EXAMPLE 1
|
|
```powershell
|
|
PS > Get-GPOZaurrPermissionSummary -Type 'All' -PermitType 'Allow' -IncludePermissionType 'GpoApply', 'GpoEdit' -ExcludePermissionType 'GpoOwner' -Forest 'ExampleForest' -IncludeDomains 'Domain1', 'Domain2' -ExtendedForestInformation $ForestInfo -Separator '|'
|
|
```
|
|
|
|
|
|
### EXAMPLE 2
|
|
```powershell
|
|
PS > Get-GPOZaurrPermissionSummary -Type 'Administrative' -PermitType 'All' -IncludePermissionType 'GpoRead' -ExcludePermissionType 'GpoRootOwner' -Forest 'AnotherForest' -ExcludeDomains 'Domain3' -Separator ','
|
|
```
|
|
|
|
|
|
## PARAMETERS
|
|
|
|
### -ExcludeDomains
|
|
Specifies domains to exclude from the search.
|
|
|
|
```yaml
|
|
Type: String[]
|
|
Parameter Sets: __AllParameterSets
|
|
Aliases:
|
|
Possible values:
|
|
|
|
Required: False
|
|
Position: 5
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: True
|
|
```
|
|
|
|
### -ExcludePermissionType
|
|
Specifies the permission types to exclude from the summary.
|
|
|
|
```yaml
|
|
Type: String[]
|
|
Parameter Sets: __AllParameterSets
|
|
Aliases:
|
|
Possible values: GpoApply, GpoEdit, GpoCustom, GpoEditDeleteModifySecurity, GpoRead, GpoOwner, GpoRootCreate, GpoRootOwner
|
|
|
|
Required: False
|
|
Position: 3
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: True
|
|
```
|
|
|
|
### -ExtendedForestInformation
|
|
Provides additional forest information to speed up processing.
|
|
|
|
```yaml
|
|
Type: IDictionary
|
|
Parameter Sets: __AllParameterSets
|
|
Aliases:
|
|
Possible values:
|
|
|
|
Required: False
|
|
Position: 7
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: True
|
|
```
|
|
|
|
### -Forest
|
|
Specifies the target forest. By default, the current forest is used.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: __AllParameterSets
|
|
Aliases: ForestName
|
|
Possible values:
|
|
|
|
Required: False
|
|
Position: 4
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: True
|
|
```
|
|
|
|
### -IncludeDomains
|
|
Specifies domains to include in the search.
|
|
|
|
```yaml
|
|
Type: String[]
|
|
Parameter Sets: __AllParameterSets
|
|
Aliases: Domain, Domains
|
|
Possible values:
|
|
|
|
Required: False
|
|
Position: 6
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: True
|
|
```
|
|
|
|
### -IncludePermissionType
|
|
Specifies the permission types to include in the summary.
|
|
|
|
```yaml
|
|
Type: String[]
|
|
Parameter Sets: __AllParameterSets
|
|
Aliases:
|
|
Possible values: GpoApply, GpoEdit, GpoCustom, GpoEditDeleteModifySecurity, GpoRead, GpoOwner, GpoRootCreate, GpoRootOwner
|
|
|
|
Required: False
|
|
Position: 2
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: True
|
|
```
|
|
|
|
### -PermitType
|
|
Specifies the type of permission to permit. Options include 'Allow', 'Deny', and 'All'.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: __AllParameterSets
|
|
Aliases:
|
|
Possible values: Allow, Deny, All
|
|
|
|
Required: False
|
|
Position: 1
|
|
Default value: All
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: True
|
|
```
|
|
|
|
### -Separator
|
|
Specifies the separator to use in the output.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: __AllParameterSets
|
|
Aliases:
|
|
Possible values:
|
|
|
|
Required: False
|
|
Position: 8
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: True
|
|
```
|
|
|
|
### -Type
|
|
Specifies the type of permissions to include. Options include 'AuthenticatedUsers', 'DomainComputers', 'Unknown', 'WellKnownAdministrative', 'NotWellKnown', 'NotWellKnownAdministrative', 'NotAdministrative', 'Administrative', and 'All'.
|
|
|
|
```yaml
|
|
Type: String[]
|
|
Parameter Sets: __AllParameterSets
|
|
Aliases:
|
|
Possible values: AuthenticatedUsers, DomainComputers, Unknown, WellKnownAdministrative, NotWellKnown, NotWellKnownAdministrative, NotAdministrative, Administrative, All
|
|
|
|
Required: False
|
|
Position: 0
|
|
Default value: All
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: True
|
|
```
|
|
|
|
### 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
|
|
|
|
- `None`
|
|
|
|
## RELATED LINKS
|
|
|
|
- None
|
|
|