diff --git a/Build/Manage-Module.ps1 b/Build/Build-Module.ps1 similarity index 84% rename from Build/Manage-Module.ps1 rename to Build/Build-Module.ps1 index 76ec90d..cea2959 100644 --- a/Build/Manage-Module.ps1 +++ b/Build/Build-Module.ps1 @@ -1,41 +1,4 @@ -[CmdletBinding()] -param( - [switch]$SkipPublish -) - -try { - Clear-Host -} catch { - Write-Verbose "Skipping Clear-Host because the current host is non-interactive." -} - -function Import-LocalPSPublishModule { - $candidateRoots = @() - - if ($env:POWERFORGE_ROOT) { - $candidateRoots += $env:POWERFORGE_ROOT - } - - $candidateRoots += [System.IO.Path]::GetFullPath((Join-Path $PSScriptRoot '..\..\PSPublishModule')) - - foreach ($root in $candidateRoots | Select-Object -Unique) { - if ([string]::IsNullOrWhiteSpace($root)) { - continue - } - - $manifestPath = Join-Path $root 'Module\PSPublishModule.psd1' - if (Test-Path -LiteralPath $manifestPath -PathType Leaf) { - Import-Module $manifestPath -Force -ErrorAction Stop - return - } - } - - Import-Module PSPublishModule -Force -ErrorAction Stop -} - -Import-LocalPSPublishModule - -Invoke-ModuleBuild -ModuleName 'GPOZaurr' { +Build-Module -ModuleName 'GPOZaurr' { # Usual defaults as per standard module $Manifest = @{ # Version number of this module. @@ -63,17 +26,9 @@ Invoke-ModuleBuild -ModuleName 'GPOZaurr' { New-ConfigurationManifest @Manifest New-ConfigurationModule -Type RequiredModule -Name 'PSWriteColor', 'PSSharedGoods', 'ADEssentials' -Guid Auto -Version Latest - New-ConfigurationModule -Type RequiredModule -Name "PSWriteHTML" -Guid Auto -Version "1.27.0" + New-ConfigurationModule -Type RequiredModule -Name "PSWriteHTML" -Guid Auto -Version Latest #New-ConfigurationModule -Type ExternalModule -Name 'Microsoft.PowerShell.Utility', 'Microsoft.PowerShell.Management','Microsoft.PowerShell.Security' New-ConfigurationModule -Type ApprovedModule -Name 'PSSharedGoods', 'PSWriteColor', 'Connectimo', 'PSUnifi', 'PSWebToolbox', 'PSMyPassword', 'ADEssentials' - - New-ConfigurationModule -Type ExternalModule -Name @( - "CimCmdlets" - 'Microsoft.PowerShell.Management' - 'Microsoft.PowerShell.Utility' - 'Microsoft.PowerShell.Security' - ) - New-ConfigurationModuleSkip -IgnoreModuleName @( # this are builtin into PowerShell, so not critical 'powershellget' @@ -243,7 +198,7 @@ Invoke-ModuleBuild -ModuleName 'GPOZaurr' { # when creating PSD1 use special style without comments and with only required parameters New-ConfigurationFormat -ApplyTo 'DefaultPSD1', 'OnMergePSD1' -PSD1Style 'Minimal' # configuration for documentation, at the same time it enables documentation processing - New-ConfigurationDocumentation -Enable:$true -StartClean -UpdateWhenNew -SyncExternalHelpToProjectRoot -PathReadme 'Docs\Readme.md' -Path 'Docs' + New-ConfigurationDocumentation -Enable:$true -StartClean -UpdateWhenNew -SyncExternalHelpToProjectRoot -PathReadme 'Docs\Readme.md' -Path 'Docs' #New-ConfigurationImportModule -ImportSelf @@ -254,9 +209,9 @@ Invoke-ModuleBuild -ModuleName 'GPOZaurr' { New-ConfigurationArtefact -Type Unpacked -Enable -Path "$PSScriptRoot\..\Artefacts\Unpacked" -AddRequiredModules New-ConfigurationArtefact -Type Packed -Enable -Path "$PSScriptRoot\..\Artefacts\Packed" -ArtefactName '.v.zip' -AddRequiredModules - # options for publishing to github/psgallery - if (-not $SkipPublish) { - New-ConfigurationPublish -Type PowerShellGallery -FilePath 'C:\Support\Important\PowerShellGalleryAPI.txt' -Enabled:$true - New-ConfigurationPublish -Type GitHub -FilePath 'C:\Support\Important\GitHubAPI.txt' -UserName 'EvotecIT' -Enabled:$true - } -} -ExitCode + # options for publishing to github/psgallery + if (-not $SkipPublish) { + #New-ConfigurationPublish -Type PowerShellGallery -FilePath 'C:\Support\Important\PowerShellGalleryAPI.txt' -Enabled:$true + # New-ConfigurationPublish -Type GitHub -FilePath 'C:\Support\Important\GitHubAPI.txt' -UserName 'EvotecIT' -Enabled:$true -GenerateReleaseNotes + } +} -ExitCode diff --git a/Docs/Add-GPOPermission.md b/Docs/Add-GPOPermission.md index 87a24ff..0b99b7c 100644 --- a/Docs/Add-GPOPermission.md +++ b/Docs/Add-GPOPermission.md @@ -1,125 +1,43 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Add-GPOPermission - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Add-GPOPermission [[-Type] ] [[-IncludePermissionType] ] [[-Principal] ] - [[-PrincipalType] ] [[-PermitType] ] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -IncludePermissionType -{{ Fill IncludePermissionType Description }} - -```yaml -Type: GPPermissionType -Parameter Sets: (All) -Aliases: -Accepted values: None, GpoApply, GpoRead, GpoEdit, GpoEditDeleteModifySecurity, GpoCustom, WmiFilterEdit, WmiFilterFullControl, WmiFilterCustom, StarterGpoRead, StarterGpoEdit, StarterGpoFullControl, StarterGpoCustom, SomCreateWmiFilter, SomWmiFilterFullControl, SomCreateGpo, SomCreateStarterGpo, SomLogging, SomPlanning, SomLink - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermitType -{{ Fill PermitType Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Allow, Deny - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Principal -{{ Fill Principal Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Trustee - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrincipalType -{{ Fill PrincipalType Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: TrusteeType -Accepted values: DistinguishedName, Name, Sid - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -{{ Fill Type Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: WellKnownAdministrative, Administrative, AuthenticatedUsers, Default - -Required: False -Position: 0 -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 - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Add-GPOPermission +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX +```powershell +Add-GPOPermission +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +```powershell +Add-GPOPermission +``` + + +## 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 + +- `None` + +## RELATED LINKS + +- None + diff --git a/Docs/Add-GPOZaurrPermission.md b/Docs/Add-GPOZaurrPermission.md index 5a96871..6f42818 100644 --- a/Docs/Add-GPOZaurrPermission.md +++ b/Docs/Add-GPOZaurrPermission.md @@ -1,348 +1,43 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Add-GPOZaurrPermission - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -### GPOName (Default) -``` -Add-GPOZaurrPermission -GPOName [-Type ] [-Principal ] [-PrincipalType ] - -PermissionType [-Inheritable] [-PermitType ] [-Forest ] - [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] - [-ADAdministrativeGroups ] [-LimitProcessing ] [-WhatIf] [-Confirm] [] -``` - -### GPOGUID -``` -Add-GPOZaurrPermission -GPOGuid [-Type ] [-Principal ] [-PrincipalType ] - -PermissionType [-Inheritable] [-PermitType ] [-Forest ] - [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] - [-ADAdministrativeGroups ] [-LimitProcessing ] [-WhatIf] [-Confirm] [] -``` - -### All -``` -Add-GPOZaurrPermission [-All] [-Type ] [-Principal ] [-PrincipalType ] - -PermissionType [-Inheritable] [-PermitType ] [-Forest ] - [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] - [-ADAdministrativeGroups ] [-LimitProcessing ] [-WhatIf] [-Confirm] [] -``` - -### ADObject -``` -Add-GPOZaurrPermission -ADObject [-Type ] [-Principal ] [-PrincipalType ] - -PermissionType [-Inheritable] [-PermitType ] [-Forest ] - [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] - [-ADAdministrativeGroups ] [-LimitProcessing ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -ADAdministrativeGroups -{{ Fill ADAdministrativeGroups Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ADObject -{{ Fill ADObject Description }} - -```yaml -Type: ADObject[] -Parameter Sets: ADObject -Aliases: OrganizationalUnit, DistinguishedName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -All -{{ Fill All Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: All -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOGuid -{{ Fill GPOGuid Description }} - -```yaml -Type: String -Parameter Sets: GPOGUID -Aliases: GUID, GPOID - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOName -{{ Fill GPOName Description }} - -```yaml -Type: String -Parameter Sets: GPOName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Inheritable -{{ Fill Inheritable Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LimitProcessing -{{ Fill LimitProcessing Description }} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermissionType -{{ Fill PermissionType Description }} - -```yaml -Type: GPPermissionType -Parameter Sets: (All) -Aliases: IncludePermissionType -Accepted values: None, GpoApply, GpoRead, GpoEdit, GpoEditDeleteModifySecurity, GpoCustom, WmiFilterEdit, WmiFilterFullControl, WmiFilterCustom, StarterGpoRead, StarterGpoEdit, StarterGpoFullControl, StarterGpoCustom, SomCreateWmiFilter, SomWmiFilterFullControl, SomCreateGpo, SomCreateStarterGpo, SomLogging, SomPlanning, SomLink - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermitType -{{ Fill PermitType Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Allow, Deny, All - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Principal -{{ Fill Principal Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Trustee - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrincipalType -{{ Fill PrincipalType Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: TrusteeType -Accepted values: DistinguishedName, Name, Sid - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -{{ Fill Type Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: WellKnownAdministrative, Administrative, AuthenticatedUsers, Default - -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 - -### None - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Add-GPOZaurrPermission +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX +```powershell +Add-GPOZaurrPermission +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +```powershell +Add-GPOZaurrPermission +``` + + +## 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 + +- `None` + +## RELATED LINKS + +- None + diff --git a/Docs/Backup-GPOZaurr.md b/Docs/Backup-GPOZaurr.md index 612bbae..396d9ea 100644 --- a/Docs/Backup-GPOZaurr.md +++ b/Docs/Backup-GPOZaurr.md @@ -1,205 +1,180 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Backup-GPOZaurr - -## SYNOPSIS -Provides Backup functionality to Group Policies - -## SYNTAX - -``` -Backup-GPOZaurr [[-LimitProcessing] ] [[-Type] ] [[-Forest] ] - [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] - [[-BackupPath] ] [-BackupDated] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Provides Backup functionality to Group Policies - -## EXAMPLES - -### EXAMPLE 1 -``` -$GPOSummary = Backup-GPOZaurr -BackupPath "$Env:UserProfile\Desktop\GPO" -Verbose -Type All -``` - -$GPOSummary | Format-Table # only if you want to display output of backup - -### EXAMPLE 2 -``` -$GPOSummary = Backup-GPOZaurr -BackupPath "$Env:UserProfile\Desktop\GPO" -Verbose -Type All -BackupDated -``` - -$GPOSummary | Format-Table # only if you want to display output of backup - -## PARAMETERS - -### -LimitProcessing -Limits amount of GPOs that are backed up - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Provides a way to backup only Empty or Unlinked GPOs. -The default is All. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: All -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -Target different Forest, by default current forest is used - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -Exclude domain from search, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -Include only specific domains, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -Ability to provide Forest Information from another command to speed up processing - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackupPath -Path where to keep the backup - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackupDated -Whether cmdlet should created Dated folders for executed backup or not. -Keep in mind it's not nessecary and two backups made to same folder have their dates properly tagged - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -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 -``` - -### -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 -``` - -### 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 - -## OUTPUTS - -## NOTES -General notes - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Backup-GPOZaurr +## SYNOPSIS +Provides Backup functionality to Group Policies + +## SYNTAX +### __AllParameterSets +```powershell +Backup-GPOZaurr [[-LimitProcessing] ] [[-Type] ] [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [[-BackupPath] ] [-BackupDated] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Provides Backup functionality to Group Policies + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > $GPOSummary = Backup-GPOZaurr -BackupPath "$Env:UserProfile\Desktop\GPO" -Verbose -Type All +$GPOSummary | Format-Table # only if you want to display output of backup +``` + + +### EXAMPLE 2 +```powershell +PS > $GPOSummary = Backup-GPOZaurr -BackupPath "$Env:UserProfile\Desktop\GPO" -Verbose -Type All -BackupDated +$GPOSummary | Format-Table # only if you want to display output of backup +``` + + +## PARAMETERS + +### -BackupDated +Whether cmdlet should created Dated folders for executed backup or not. Keep in mind it's not nessecary and two backups made to same folder have their dates properly tagged + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -BackupPath +Path where to keep the backup + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Ability to provide Forest Information from another command to speed up processing + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Target different Forest, by default current forest is used + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Include only specific domains, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -LimitProcessing +Limits amount of GPOs that are backed up + +```yaml +Type: Int32 +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 0 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Type +Provides a way to backup only Empty or Unlinked GPOs. The default is All. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: Empty, Unlinked, Disabled, All + +Required: False +Position: 1 +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 + diff --git a/Docs/Clear-GPOZaurrSysvolDFSR.md b/Docs/Clear-GPOZaurrSysvolDFSR.md index 14fa33a..8d35579 100644 --- a/Docs/Clear-GPOZaurrSysvolDFSR.md +++ b/Docs/Clear-GPOZaurrSysvolDFSR.md @@ -1,199 +1,180 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Clear-GPOZaurrSysvolDFSR - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Clear-GPOZaurrSysvolDFSR [[-Forest] ] [[-ExcludeDomains] ] - [[-ExcludeDomainControllers] ] [[-IncludeDomains] ] - [[-IncludeDomainControllers] ] [-SkipRODC] [[-ExtendedForestInformation] ] - [[-LimitProcessing] ] [-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 -``` - -### -ExcludeDomainControllers -{{ Fill ExcludeDomainControllers Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomainControllers -{{ Fill IncludeDomainControllers Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: DomainControllers - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LimitProcessing -{{ Fill LimitProcessing Description }} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipRODC -{{ Fill SkipRODC 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 - -### None - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Clear-GPOZaurrSysvolDFSR +## SYNOPSIS +Clears the ConflictAndDeleted folder in DFSR for specified GPOs. + +## SYNTAX +### __AllParameterSets +```powershell +Clear-GPOZaurrSysvolDFSR [[-Forest] ] [[-ExcludeDomains] ] [[-ExcludeDomainControllers] ] [[-IncludeDomains] ] [[-IncludeDomainControllers] ] [[-ExtendedForestInformation] ] [[-LimitProcessing] ] [-SkipRODC] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This function clears the ConflictAndDeleted folder in DFSR for specified Group Policy Objects (GPOs) within a given forest. It allows excluding specific domains and domain controllers if needed. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Clear-GPOZaurrSysvolDFSR -Forest "contoso.com" -IncludeDomains "child.contoso.com" -ExcludeDomainControllers "dc1.contoso.com" -SkipRODC +Clears the ConflictAndDeleted folder in DFSR for GPOs in the "contoso.com" forest, including only the "child.contoso.com" domain and excluding the "dc1.contoso.com" domain controller. +``` + + +### EXAMPLE 2 +```powershell +PS > Clear-GPOZaurrSysvolDFSR -Forest "contoso.com" -IncludeDomains "child.contoso.com" -LimitProcessing 5 +Clears the ConflictAndDeleted folder in DFSR for GPOs in the "contoso.com" forest, including only the "child.contoso.com" domain, and processes a maximum of 5 GPOs. +``` + + +## PARAMETERS + +### -ExcludeDomainControllers +Specifies an array of domain controllers to exclude from the cleanup process. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeDomains +Specifies an array of domains to exclude from the cleanup process. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Specifies additional forest information if needed. + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Specifies the forest name where the GPOs are located. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomainControllers +Specifies an array of domain controllers to include in the cleanup process. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: DomainControllers +Possible values: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Specifies an array of domains to include in the cleanup process. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -LimitProcessing +Specifies the maximum number of GPOs to process. + +```yaml +Type: Int32 +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 6 +Default value: 2147483647 +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -SkipRODC +Indicates whether Read-Only Domain Controllers (RODCs) should be skipped during cleanup. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +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 + diff --git a/Docs/ConvertFrom-CSExtension.md b/Docs/ConvertFrom-CSExtension.md index 4d5e57b..00a66f1 100644 --- a/Docs/ConvertFrom-CSExtension.md +++ b/Docs/ConvertFrom-CSExtension.md @@ -1,75 +1,84 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# ConvertFrom-CSExtension - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -ConvertFrom-CSExtension [[-CSE] ] [-Limited] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -CSE -{{ Fill CSE Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Limited -{{ Fill Limited 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 - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# ConvertFrom-CSExtension +## SYNOPSIS +Converts Client-side Extension (CSE) GUIDs to their corresponding names. + +## SYNTAX +### __AllParameterSets +```powershell +ConvertFrom-CSExtension [[-CSE] ] [-Limited] [] +``` + +## DESCRIPTION +This function takes an array of CSE GUIDs and returns their corresponding names. It can be used to easily identify the purpose of each CSE GUID. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > ConvertFrom-CSExtension -CSE '{35378EAC-683F-11D2-A89A-00C04FBBCFA2}', '{0F6B957E-509E-11D1-A7CC-0000F87571E3}' -Limited +Converts the specified CSE GUIDs to their corresponding names, limited to a predefined set. +``` + + +### EXAMPLE 2 +```powershell +PS > ConvertFrom-CSExtension -CSE '{D02B1F73-3407-48AE-BA88-E8213C6761F1}', '{0ACDD40C-75AC-47ab-BAA0-BF6DE7E7FE63}' +Converts the specified CSE GUIDs to their corresponding names without any limitations. +``` + + +## PARAMETERS + +### -CSE +Specifies an array of Client-side Extension (CSE) GUIDs to be converted to names. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Limited +Indicates whether the conversion should be limited to a predefined set of CSE GUIDs. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +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 + diff --git a/Docs/Export-GPOZaurrContent.md b/Docs/Export-GPOZaurrContent.md index 53da5fe..3e9c122 100644 --- a/Docs/Export-GPOZaurrContent.md +++ b/Docs/Export-GPOZaurrContent.md @@ -1,73 +1,77 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Export-GPOZaurrContent - -## SYNOPSIS -Saves GPOs to XML or HTML files. - -## SYNTAX - -``` -Export-GPOZaurrContent [-FolderOutput] [[-ReportType] ] [] -``` - -## DESCRIPTION -Saves GPOs to XML or HTML files. - -## EXAMPLES - -### EXAMPLE 1 -``` -An example -``` - -## PARAMETERS - -### -FolderOutput -The folder where the GPOs will be saved. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Path - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The type of report to generate. -Valid values are XML or HTML. -Default is XML. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: XML -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 - -## OUTPUTS - -## NOTES -General notes - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Export-GPOZaurrContent +## SYNOPSIS +Exports Group Policy Objects (GPOs) to XML or HTML files. + +## SYNTAX +### __AllParameterSets +```powershell +Export-GPOZaurrContent [-FolderOutput] [[-ReportType] ] [] +``` + +## DESCRIPTION +This function exports GPOs to either XML or HTML files based on the specified parameters. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Export-GPOZaurrContent -FolderOutput "C:\ExportedGPOs" -ReportType HTML +Exports all GPOs to HTML format and saves them in the "C:\ExportedGPOs" folder. +``` + + +## PARAMETERS + +### -FolderOutput +Specifies the folder path where the exported GPO files will be saved. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: Path +Possible values: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ReportType +Specifies the type of report to generate. Valid values are XML or HTML. The default value is XML. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: XML, HTML + +Required: False +Position: 1 +Default value: XML +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 + diff --git a/Docs/Find-CSExtension.md b/Docs/Find-CSExtension.md index 008d267..3aa0c68 100644 --- a/Docs/Find-CSExtension.md +++ b/Docs/Find-CSExtension.md @@ -1,75 +1,84 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Find-CSExtension - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Find-CSExtension [[-CSE] ] [[-ComputerName] ] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -CSE -{{ Fill CSE Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -{{ Fill ComputerName 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 - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Find-CSExtension +## SYNOPSIS +This function retrieves Group Policy Client Side Extensions (CSEs) from a specified Windows computer. + +## SYNTAX +### __AllParameterSets +```powershell +Find-CSExtension [[-CSE] ] [[-ComputerName] ] [] +``` + +## DESCRIPTION +The Find-CSExtension function lists Group Policy Client Side Extensions (CSEs) configured on a Windows computer. It queries the Windows Registry to retrieve information about the CSEs. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Find-CSExtension -ComputerName "Computer01" +Retrieves all CSEs configured on the computer named "Computer01". +``` + + +### EXAMPLE 2 +```powershell +PS > Find-CSExtension -CSE "CSE1", "CSE2" -ComputerName "Computer02" +Retrieves information about CSEs named "CSE1" and "CSE2" on the computer named "Computer02". +``` + + +## PARAMETERS + +### -ComputerName +Specifies the name of the computer from which to retrieve the CSE information. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -CSE +Specifies an array of CSE names to filter the results. If not provided, all CSEs will be listed. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 0 +Default value: None +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 + diff --git a/Docs/Get-GPOZaurr.md b/Docs/Get-GPOZaurr.md index a47e011..8036525 100644 --- a/Docs/Get-GPOZaurr.md +++ b/Docs/Get-GPOZaurr.md @@ -1,265 +1,273 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurr - -## SYNOPSIS -Gets information about all Group Policies. -Similar to what Get-GPO provides by default. - -## SYNTAX - -``` -Get-GPOZaurr [[-ExcludeGroupPolicies] ] [[-GPOName] ] [[-GPOGuid] ] - [[-Type] ] [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] - [[-ExtendedForestInformation] ] [[-GPOPath] ] [-PermissionsOnly] [-OwnerOnly] - [-Limited] [[-ADAdministrativeGroups] ] [] -``` - -## DESCRIPTION -Gets information about all Group Policies. -Similar to what Get-GPO provides by default. - -## EXAMPLES - -### EXAMPLE 1 -``` -$GPOs = Get-GPOZaurr -``` - -$GPOs | Format-Table DisplayName, Owner, OwnerSID, OwnerType - -### EXAMPLE 2 -``` -$GPO = Get-GPOZaurr -GPOName 'ALL | Allow use of biometrics' -``` - -$GPO | Format-List * - -### EXAMPLE 3 -``` -$GPOS = Get-GPOZaurr -ExcludeGroupPolicies { -``` - -Skip-GroupPolicy -Name 'de14_usr_std' - Skip-GroupPolicy -Name 'de14_usr_std' -DomaiName 'ad.evotec.xyz' - Skip-GroupPolicy -Name 'All | Trusted Websites' #-DomaiName 'ad.evotec.xyz' - '{D39BF08A-87BF-4662-BFA0-E56240EBD5A2}' - 'COMPUTERS | Enable Sets' -} -$GPOS | Format-Table -AutoSize * - -## PARAMETERS - -### -ExcludeGroupPolicies -Marks the GPO as excluded from the list. - -```yaml -Type: ScriptBlock -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOName -Provide a GPOName to get information about a specific GPO. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOGuid -Provide a GPOGuid to get information about a specific GPO. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: GUID, GPOID - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Choose a specific type of GPO. -Options are: 'Empty', 'Unlinked', 'Disabled', 'NoApplyPermission', 'All'. -Default is All. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -Target different Forest, by default current forest is used - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -Exclude domain from search, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -Include only specific domains, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -Ability to provide Forest Information from another command to speed up processing - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOPath -Define GPOPath where the XML files are located to be analyzed instead of asking Active Directory - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermissionsOnly -Only show permissions, by default all information is shown - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OwnerOnly -only show owner information, by default all information is shown - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Limited -Provide limited output without analyzing XML data - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ADAdministrativeGroups -Ability to provide ADAdministrativeGroups from different function to speed up processing - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -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 - -## OUTPUTS - -## NOTES -General notes - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurr +## SYNOPSIS +Gets information about all Group Policies. Similar to what Get-GPO provides by default. + +## SYNTAX +### __AllParameterSets +```powershell +Get-GPOZaurr [[-ExcludeGroupPolicies] ] [[-GPOName] ] [[-GPOGuid] ] [[-Type] ] [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [[-GPOPath] ] [[-ADAdministrativeGroups] ] [-PermissionsOnly] [-OwnerOnly] [-Limited] [] +``` + +## DESCRIPTION +Gets information about all Group Policies. Similar to what Get-GPO provides by default. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > $GPOs = Get-GPOZaurr +$GPOs | Format-Table DisplayName, Owner, OwnerSID, OwnerType +``` + + +### EXAMPLE 2 +```powershell +PS > $GPO = Get-GPOZaurr -GPOName 'ALL | Allow use of biometrics' +$GPO | Format-List * +``` + + +### EXAMPLE 3 +```powershell +PS > $GPOS = Get-GPOZaurr -ExcludeGroupPolicies { + Skip-GroupPolicy -Name 'de14_usr_std' + Skip-GroupPolicy -Name 'de14_usr_std' -DomaiName 'ad.evotec.xyz' + Skip-GroupPolicy -Name 'All | Trusted Websites' #-DomaiName 'ad.evotec.xyz' + '{D39BF08A-87BF-4662-BFA0-E56240EBD5A2}' + 'COMPUTERS | Enable Sets' +} +$GPOS | Format-Table -AutoSize * +``` + + +## PARAMETERS + +### -ADAdministrativeGroups +Ability to provide ADAdministrativeGroups from different function to speed up processing + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeGroupPolicies +Marks the GPO as excluded from the list. + +```yaml +Type: ScriptBlock +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Ability to provide Forest Information from another command 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 +Target different Forest, by default 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 +``` + +### -GPOGuid +Provide a GPOGuid to get information about a specific GPO. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: GUID, GPOID +Possible values: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOName +Provide a GPOName to get information about a specific GPO. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOPath +Define GPOPath where the XML files are located to be analyzed instead of asking Active Directory + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Include only specific domains, by default whole forest is scanned + +```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 +``` + +### -Limited +Provide limited output without analyzing XML data + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -OwnerOnly +only show owner information, by default all information is shown + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -PermissionsOnly +Only show permissions, by default all information is shown + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Type +Choose a specific type of GPO. Options are: 'Empty', 'Unlinked', 'Disabled', 'NoApplyPermission', 'All'. Default is All. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: Empty, Unlinked, Disabled, NoApplyPermission, All + +Required: False +Position: 3 +Default value: None +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 + diff --git a/Docs/Get-GPOZaurrAD.md b/Docs/Get-GPOZaurrAD.md index 1af7251..4af5bde 100644 --- a/Docs/Get-GPOZaurrAD.md +++ b/Docs/Get-GPOZaurrAD.md @@ -1,214 +1,232 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrAD - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -### Default (Default) -``` -Get-GPOZaurrAD [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] - [-DateFrom ] [-DateTo ] [-DateRange ] [-DateProperty ] - [-ExtendedForestInformation ] [] -``` - -### GPOName -``` -Get-GPOZaurrAD [-GPOName ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] - [-DateFrom ] [-DateTo ] [-DateRange ] [-DateProperty ] - [-ExtendedForestInformation ] [] -``` - -### GPOGUID -``` -Get-GPOZaurrAD [-GPOGuid ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] - [-DateFrom ] [-DateTo ] [-DateRange ] [-DateProperty ] - [-ExtendedForestInformation ] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -DateFrom -{{ Fill DateFrom Description }} - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DateProperty -{{ Fill DateProperty Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Accepted values: WhenCreated, WhenChanged - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DateRange -{{ Fill DateRange Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: PastHour, CurrentHour, PastDay, CurrentDay, PastMonth, CurrentMonth, PastQuarter, CurrentQuarter, Last14Days, Last21Days, Last30Days, Last7Days, Last3Days, Last1Days - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DateTo -{{ Fill DateTo Description }} - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOGuid -{{ Fill GPOGuid Description }} - -```yaml -Type: String -Parameter Sets: GPOGUID -Aliases: GUID, GPOID - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOName -{{ Fill GPOName Description }} - -```yaml -Type: String -Parameter Sets: GPOName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -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 - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrAD +## SYNOPSIS +Retrieves Group Policy Objects (GPOs) information from Active Directory. + +## SYNTAX +### Default (Default) +```powershell +Get-GPOZaurrAD [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-DateFrom ] [-DateTo ] [-DateRange ] [-DateProperty ] [-ExtendedForestInformation ] [] +``` + +### GPOName +```powershell +Get-GPOZaurrAD [-GPOName ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-DateFrom ] [-DateTo ] [-DateRange ] [-DateProperty ] [-ExtendedForestInformation ] [] +``` + +### GPOGUID +```powershell +Get-GPOZaurrAD [-GPOGuid ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-DateFrom ] [-DateTo ] [-DateRange ] [-DateProperty ] [-ExtendedForestInformation ] [] +``` + +## DESCRIPTION +This function retrieves information about Group Policy Objects (GPOs) from Active Directory based on specified criteria such as GPO name, GPO GUID, date range, and forest details. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Get-GPOZaurrAD -GPOName "ExampleGPO" +``` + +Description: +Retrieves information about a GPO with the name "ExampleGPO". + +### EXAMPLE 2 +```powershell +PS > Get-GPOZaurrAD -GPOGuid "{12345678-1234-1234-1234-123456789012}" +``` + +Description: +Retrieves information about a GPO with the specified GUID. + +### EXAMPLE 3 +```powershell +PS > Get-GPOZaurrAD -Forest "example.com" -IncludeDomains "domain1", "domain2" -DateRange "Last30Days" +``` + +Description: +Retrieves GPO information from the forest "example.com" for domains "domain1" and "domain2" created or modified in the last 30 days. + +## PARAMETERS + +### -DateFrom +Specifies the start date for filtering GPOs based on creation or modification date. + +```yaml +Type: DateTime +Parameter Sets: Default, GPOName, GPOGUID +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -DateProperty +Specifies the property (WhenCreated or WhenChanged) to use for filtering GPOs based on date. + +```yaml +Type: String[] +Parameter Sets: Default, GPOName, GPOGUID +Aliases: +Possible values: WhenCreated, WhenChanged + +Required: False +Position: named +Default value: WhenCreated +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -DateRange +Specifies a predefined date range for filtering GPOs based on creation or modification date. + +```yaml +Type: String +Parameter Sets: Default, GPOName, GPOGUID +Aliases: +Possible values: PastHour, CurrentHour, PastDay, CurrentDay, PastMonth, CurrentMonth, PastQuarter, CurrentQuarter, Last14Days, Last21Days, Last30Days, Last7Days, Last3Days, Last1Days + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -DateTo +Specifies the end date for filtering GPOs based on creation or modification date. + +```yaml +Type: DateTime +Parameter Sets: Default, GPOName, GPOGUID +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeDomains +Specifies an array of domains to exclude from the search. + +```yaml +Type: String[] +Parameter Sets: Default, GPOName, GPOGUID +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Specifies additional forest information to include in the output. + +```yaml +Type: IDictionary +Parameter Sets: Default, GPOName, GPOGUID +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Specifies the forest name to search for GPOs. + +```yaml +Type: String +Parameter Sets: Default, GPOName, GPOGUID +Aliases: ForestName +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOGuid +Specifies the GUID of the GPO to retrieve. + +```yaml +Type: String +Parameter Sets: GPOGUID +Aliases: GUID, GPOID +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOName +Specifies the name of the GPO to retrieve. + +```yaml +Type: String +Parameter Sets: GPOName +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Specifies an array of domains to include in the search. + +```yaml +Type: String[] +Parameter Sets: Default, GPOName, GPOGUID +Aliases: Domain, Domains +Possible values: + +Required: False +Position: named +Default value: None +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 + diff --git a/Docs/Get-GPOZaurrBackupInformation.md b/Docs/Get-GPOZaurrBackupInformation.md index 3f2a0b4..5c04c95 100644 --- a/Docs/Get-GPOZaurrBackupInformation.md +++ b/Docs/Get-GPOZaurrBackupInformation.md @@ -1,60 +1,70 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrBackupInformation - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Get-GPOZaurrBackupInformation [[-BackupFolder] ] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -BackupFolder -{{ Fill BackupFolder Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -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 - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrBackupInformation +## SYNOPSIS +Retrieves backup information from GPOZaurr manifest files. + +## SYNTAX +### __AllParameterSets +```powershell +Get-GPOZaurrBackupInformation [[-BackupFolder] ] [] +``` + +## DESCRIPTION +This function retrieves backup information from GPOZaurr manifest files located in the specified BackupFolder(s). + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Get-GPOZaurrBackupInformation -BackupFolder "C:\Backups" +``` + +Description: +Retrieves backup information from GPOZaurr manifest files located in the "C:\Backups" folder. + +### EXAMPLE 2 +```powershell +PS > Get-GPOZaurrBackupInformation -BackupFolder "C:\Backups", "D:\Archives" +``` + +Description: +Retrieves backup information from GPOZaurr manifest files located in both "C:\Backups" and "D:\Archives" folders. + +## PARAMETERS + +### -BackupFolder +Specifies the path(s) to the folder containing GPOZaurr manifest files. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 0 +Default value: None +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 + diff --git a/Docs/Get-GPOZaurrBroken.md b/Docs/Get-GPOZaurrBroken.md index 62bc198..55a2e21 100644 --- a/Docs/Get-GPOZaurrBroken.md +++ b/Docs/Get-GPOZaurrBroken.md @@ -1,172 +1,178 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrBroken - -## SYNOPSIS -Detects broken or otherwise damaged Group Policies - -## SYNTAX - -``` -Get-GPOZaurrBroken [[-Forest] ] [[-ExcludeDomains] ] [[-ExcludeDomainControllers] ] - [[-IncludeDomains] ] [[-IncludeDomainControllers] ] [-SkipRODC] - [[-ExtendedForestInformation] ] [-VerifyDomainControllers] [] -``` - -## DESCRIPTION +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrBroken +## SYNOPSIS +Detects broken or otherwise damaged Group Policies + +## SYNTAX +### __AllParameterSets +```powershell +Get-GPOZaurrBroken [[-Forest] ] [[-ExcludeDomains] ] [[-ExcludeDomainControllers] ] [[-IncludeDomains] ] [[-IncludeDomainControllers] ] [[-ExtendedForestInformation] ] [-SkipRODC] [-VerifyDomainControllers] [] +``` + +## DESCRIPTION Detects broken or otherwise damaged Group Policies providing insight whether GPO exists in both AD and SYSVOL. It provides few statuses: - Permissions issue - means account couldn't read GPO due to permissions - ObjectClass issue - means that ObjectClass is of type Container, rather than expected groupPolicyContainer - Not available on SYSVOL - means SYSVOL data is missing, yet AD metadata is available - Not available in AD - means AD metadata is missing, yet SYSVOL data is available -- Exists - means AD metadata and SYSVOL data are available - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-GPOZaurrBroken -Verbose | Format-Table -``` - -## PARAMETERS - -### -Forest -Target different Forest, by default current forest is used - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -Exclude domain from search, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomainControllers -Exclude specific domain controllers, by default there are no exclusions, as long as VerifyDomainControllers switch is enabled. -Otherwise this parameter is ignored. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -Include only specific domains, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomainControllers -Include only specific domain controllers, by default all domain controllers are included, as long as VerifyDomainControllers switch is enabled. -Otherwise this parameter is ignored. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: DomainControllers - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipRODC -Skip Read-Only Domain Controllers. -By default all domain controllers are included. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -Ability to provide Forest Information from another command to speed up processing - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VerifyDomainControllers -Forces cmdlet to check GPO Existance on Domain Controllers rather then per domain - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -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 - -## OUTPUTS - -## NOTES -General notes - -## RELATED LINKS +- Exists - means AD metadata and SYSVOL data are available + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Get-GPOZaurrBroken -Verbose | Format-Table +``` + + +## PARAMETERS + +### -ExcludeDomainControllers +Exclude specific domain controllers, by default there are no exclusions, as long as VerifyDomainControllers switch is enabled. Otherwise this parameter is ignored. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Ability to provide Forest Information from another command to speed up processing + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Target different Forest, by default current forest is used + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomainControllers +Include only specific domain controllers, by default all domain controllers are included, as long as VerifyDomainControllers switch is enabled. Otherwise this parameter is ignored. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: DomainControllers +Possible values: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Include only specific domains, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -SkipRODC +Skip Read-Only Domain Controllers. By default all domain controllers are included. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -VerifyDomainControllers +Forces cmdlet to check GPO Existance on Domain Controllers rather then per domain + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +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 + diff --git a/Docs/Get-GPOZaurrBrokenLink.md b/Docs/Get-GPOZaurrBrokenLink.md index 53510f2..5c0b833 100644 --- a/Docs/Get-GPOZaurrBrokenLink.md +++ b/Docs/Get-GPOZaurrBrokenLink.md @@ -1,107 +1,114 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrBrokenLink - -## SYNOPSIS -Finds any GPO link that doesn't have a matching GPO (already removed GPO). - -## SYNTAX - -``` -Get-GPOZaurrBrokenLink [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] - [[-ExtendedForestInformation] ] [] -``` - -## DESCRIPTION -Finds any GPO link that doesn't have a matching GPO (already removed GPO). - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-GPOZaurrBrokenLink -Verbose | Format-Table -AutoSize * -``` - -### EXAMPLE 2 -``` -Get-GPOZaurrBrokenLink -Verbose -IncludeDomains ad.evotec.pl | Format-Table -AutoSize * -``` - -## PARAMETERS - -### -Forest -Target different Forest, by default current forest is used - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -Exclude domain from search, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -Include only specific domains, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -Ability to provide Forest Information from another command to speed up processing - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -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 - -## OUTPUTS - -## NOTES -General notes - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrBrokenLink +## SYNOPSIS +Finds any GPO link that doesn't have a matching GPO (already removed GPO). + +## SYNTAX +### __AllParameterSets +```powershell +Get-GPOZaurrBrokenLink [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [] +``` + +## DESCRIPTION +Finds any GPO link that doesn't have a matching GPO (already removed GPO). + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Get-GPOZaurrBrokenLink -Verbose | Format-Table -AutoSize * +``` + + +### EXAMPLE 2 +```powershell +PS > Get-GPOZaurrBrokenLink -Verbose -IncludeDomains ad.evotec.pl | Format-Table -AutoSize * +``` + + +## PARAMETERS + +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Ability to provide Forest Information from another command to speed up processing + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Target different Forest, by default current forest is used + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Include only specific domains, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 2 +Default value: None +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 + diff --git a/Docs/Get-GPOZaurrDictionary.md b/Docs/Get-GPOZaurrDictionary.md index fefb2a3..9f98f29 100644 --- a/Docs/Get-GPOZaurrDictionary.md +++ b/Docs/Get-GPOZaurrDictionary.md @@ -1,60 +1,68 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrDictionary - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Get-GPOZaurrDictionary [[-Splitter] ] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -Splitter -{{ Fill Splitter Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -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 - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrDictionary +## SYNOPSIS +Retrieves a dictionary of Group Policy Objects (GPOs) with their associated types and paths. + +## SYNTAX +### __AllParameterSets +```powershell +Get-GPOZaurrDictionary [[-Splitter] ] [] +``` + +## DESCRIPTION +This function retrieves a dictionary of Group Policy Objects (GPOs) along with their associated types and paths. It iterates through the GPOs stored in the $Script:GPODitionary variable and constructs a custom object for each GPO containing its name, types, and path. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Get-GPOZaurrDictionary +Retrieves the dictionary of GPOs with their types and paths using the default newline delimiter. +``` + + +### EXAMPLE 2 +```powershell +PS > Get-GPOZaurrDictionary -Splitter "," +Retrieves the dictionary of GPOs with their types and paths using a comma as the delimiter. +``` + + +## PARAMETERS + +### -Splitter +Specifies the delimiter used to separate multiple types or paths. Default value is [System.Environment]::NewLine. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 0 +Default value: [System.Environment]::NewLine +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 + diff --git a/Docs/Get-GPOZaurrDuplicateObject.md b/Docs/Get-GPOZaurrDuplicateObject.md index 2b7a70e..f7c0b69 100644 --- a/Docs/Get-GPOZaurrDuplicateObject.md +++ b/Docs/Get-GPOZaurrDuplicateObject.md @@ -1,106 +1,111 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrDuplicateObject - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Get-GPOZaurrDuplicateObject [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] - [[-ExtendedForestInformation] ] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 2 -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 - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrDuplicateObject +## SYNOPSIS +Retrieves duplicate Group Policy Objects (GPOs) within a specified forest. + +## SYNTAX +### __AllParameterSets +```powershell +Get-GPOZaurrDuplicateObject [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [] +``` + +## DESCRIPTION +This function retrieves duplicate Group Policy Objects (GPOs) within a specified forest by comparing GPOs based on partial distinguished name matching. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Get-GPOZaurrDuplicateObject -Forest "contoso.com" -IncludeDomains "child1.contoso.com", "child2.contoso.com" -ExcludeDomains "child3.contoso.com" -ExtendedForestInformation $additionalInfo +``` + +Description +----------- +Retrieves duplicate GPOs within the "contoso.com" forest, including domains "child1.contoso.com" and "child2.contoso.com" while excluding "child3.contoso.com". Additional forest information is provided for the search. + +## PARAMETERS + +### -ExcludeDomains +Specifies an array of domain names to exclude from the search for duplicate GPOs. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Specifies additional information about the forest to aid in the search for duplicate GPOs. + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Specifies the name of the forest to search for duplicate GPOs. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Specifies an array of domain names to include in the search for duplicate GPOs. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 2 +Default value: None +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 + diff --git a/Docs/Get-GPOZaurrFiles.md b/Docs/Get-GPOZaurrFiles.md index e48bd5f..43989f6 100644 --- a/Docs/Get-GPOZaurrFiles.md +++ b/Docs/Get-GPOZaurrFiles.md @@ -1,199 +1,212 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrFiles - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Get-GPOZaurrFiles [[-Type] ] [[-HashAlgorithm] ] [-Signature] [-AsHashTable] [-Extended] - [-ExtendedMetaData] [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] - [[-ExtendedForestInformation] ] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -AsHashTable -{{ Fill AsHashTable Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Extended -{{ Fill Extended Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedMetaData -{{ Fill ExtendedMetaData Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HashAlgorithm -{{ Fill HashAlgorithm Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: None, MACTripleDES, MD5, RIPEMD160, SHA1, SHA256, SHA384, SHA512 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Signature -{{ Fill Signature Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -{{ Fill Type Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Accepted values: All, Netlogon, Sysvol - -Required: False -Position: 0 -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 - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrFiles +## SYNOPSIS +Retrieves information about Group Policy Objects (GPOs) stored in SYSVOL and NETLOGON folders. + +## SYNTAX +### __AllParameterSets +```powershell +Get-GPOZaurrFiles [[-Type] ] [[-HashAlgorithm] ] [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [-Signature] [-AsHashTable] [-Extended] [-ExtendedMetaData] [] +``` + +## DESCRIPTION +This function retrieves information about GPOs stored in SYSVOL and NETLOGON folders of specified domains. It can filter by type of files and hash algorithms used for verification. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Get-GPOZaurrFiles -Type 'All' -HashAlgorithm 'SHA256' -Signature +Retrieves all files from SYSVOL and NETLOGON folders with SHA256 hash algorithm and includes file signatures. +``` + + +### EXAMPLE 2 +```powershell +PS > Get-GPOZaurrFiles -Type 'Sysvol' -HashAlgorithm 'MD5' -AsHashTable +Retrieves only SYSVOL files with MD5 hash algorithm and returns the results as a hashtable. +``` + + +## PARAMETERS + +### -AsHashTable +Indicates whether to return the results as a hashtable. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeDomains +Specifies an array of domains to exclude from the search. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Extended +Indicates whether to include extended information about the forest. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Specifies additional forest information to include. + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedMetaData +Indicates whether to include extended metadata information. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Specifies the forest name to retrieve GPO information from. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -HashAlgorithm +Specifies the hash algorithm to use for file verification. Valid values are 'None', 'MACTripleDES', 'MD5', 'RIPEMD160', 'SHA1', 'SHA256', 'SHA384', 'SHA512'. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: None, MACTripleDES, MD5, RIPEMD160, SHA1, SHA256, SHA384, SHA512 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Specifies an array of domains to include in the search. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Signature +Indicates whether to include file signatures for verification. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Type +Specifies the type of files to retrieve. Valid values are 'All', 'Netlogon', and 'Sysvol'. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: All, Netlogon, Sysvol + +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 + diff --git a/Docs/Get-GPOZaurrFilesPolicyDefinition.md b/Docs/Get-GPOZaurrFilesPolicyDefinition.md index 9d1ea63..20b1d06 100644 --- a/Docs/Get-GPOZaurrFilesPolicyDefinition.md +++ b/Docs/Get-GPOZaurrFilesPolicyDefinition.md @@ -1,121 +1,125 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrFilesPolicyDefinition - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Get-GPOZaurrFilesPolicyDefinition [[-Forest] ] [[-ExcludeDomains] ] - [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [-Signature] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Signature -{{ Fill Signature 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 - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrFilesPolicyDefinition +## SYNOPSIS +Retrieves policy definitions for Group Policy Objects (GPOs) within specified domains. + +## SYNTAX +### __AllParameterSets +```powershell +Get-GPOZaurrFilesPolicyDefinition [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [-Signature] [] +``` + +## DESCRIPTION +This function retrieves policy definitions for GPOs within specified domains. It collects information about policy files, including their attributes and digital signatures. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Get-GPOZaurrFilesPolicyDefinition -Forest "contoso.com" -IncludeDomains "domain1", "domain2" -ExcludeDomains "domain3" -Signature +Retrieves policy definitions for GPOs within the "contoso.com" forest, including domains "domain1" and "domain2" while excluding "domain3". Digital signature information is also retrieved. +``` + + +## PARAMETERS + +### -ExcludeDomains +Specifies an array of domains to exclude from the search. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Specifies additional forest information to include in the output. + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Specifies the forest name to retrieve GPO policy definitions from. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Specifies an array of domains to include in the search. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Signature +Indicates whether to retrieve digital signature information for policy files. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +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 + diff --git a/Docs/Get-GPOZaurrFolders.md b/Docs/Get-GPOZaurrFolders.md index d8e36a3..cfb23f2 100644 --- a/Docs/Get-GPOZaurrFolders.md +++ b/Docs/Get-GPOZaurrFolders.md @@ -1,154 +1,164 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrFolders - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Get-GPOZaurrFolders [[-Type] ] [[-FolderType] ] [[-Forest] ] - [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] - [-AsHashTable] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -AsHashTable -{{ Fill AsHashTable Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FolderType -{{ Fill FolderType Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: All, NTFRS, Empty - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -{{ Fill Type Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Accepted values: All, Netlogon, Sysvol - -Required: False -Position: 0 -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 - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrFolders +## SYNOPSIS +Retrieves information about GPO folders within specified domains. + +## SYNTAX +### __AllParameterSets +```powershell +Get-GPOZaurrFolders [[-Type] ] [[-FolderType] ] [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [-AsHashTable] [] +``` + +## DESCRIPTION +This function retrieves information about various GPO folders within specified domains, such as PolicyDefinitions, Policies, Scripts, GPO Starters, NETLOGON Scripts, DfsrPrivate, and SYSVOL Root. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Get-GPOZaurrFolders -Type All -FolderType All -Forest 'example.com' -IncludeDomains 'domain1', 'domain2' -ExcludeDomains 'domain3' -ExtendedForestInformation $info -AsHashTable +Retrieves information about all types of GPO folders within the specified domains in the forest 'example.com', excluding 'domain3', and including 'domain1' and 'domain2', with extended forest information. +``` + + +### EXAMPLE 2 +```powershell +PS > Get-GPOZaurrFolders -Type Sysvol -FolderType NTFRS -Forest 'example.com' -IncludeDomains 'domain1' -AsHashTable +Retrieves information about Sysvol folders using NTFRS type within the specified domain 'domain1' in the forest 'example.com' and returns the output as a hashtable. +``` + + +## PARAMETERS + +### -AsHashTable +Indicates whether to return the output as a hashtable. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeDomains +Specifies domains to exclude from the retrieval. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Specifies additional information about the forest. + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -FolderType +Specifies the type of folders to retrieve. Valid values are 'All', 'NTFRS', 'Empty'. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: All, NTFRS, Empty + +Required: False +Position: 1 +Default value: All +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Specifies the forest name to retrieve information for. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Specifies domains to include in the retrieval. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Type +Specifies the type of folders to retrieve. Valid values are 'All', 'Netlogon', 'Sysvol'. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: All, Netlogon, Sysvol + +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 + diff --git a/Docs/Get-GPOZaurrInheritance.md b/Docs/Get-GPOZaurrInheritance.md index b30367d..3091ae9 100644 --- a/Docs/Get-GPOZaurrInheritance.md +++ b/Docs/Get-GPOZaurrInheritance.md @@ -1,184 +1,189 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrInheritance - -## SYNOPSIS -Short description - -## SYNTAX - -``` -Get-GPOZaurrInheritance [-IncludeBlockedObjects] [-OnlyBlockedInheritance] [-IncludeExcludedObjects] - [-IncludeGroupPoliciesForBlockedObjects] [[-Exclusions] ] [[-Forest] ] - [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] - [] -``` - -## DESCRIPTION -Long description - -## EXAMPLES - -### EXAMPLE 1 -``` -$Objects = Get-GPOZaurrInheritance -IncludeBlockedObjects -IncludeExcludedObjects -OnlyBlockedInheritance -Exclusions $ExcludedOU -``` - -$Objects | Format-Table - -## PARAMETERS - -### -IncludeBlockedObjects -Include OU's with blocked inheritance. -Default disabled - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OnlyBlockedInheritance -Show only OU's with blocked inheritance - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeExcludedObjects -Show excluded objets. -Default disabled - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeGroupPoliciesForBlockedObjects -{{ Fill IncludeGroupPoliciesForBlockedObjects Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Exclusions -Provide exclusions for OU's approved by IT. -You can provide OU by canonical name or distinguishedName - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -Target different Forest, by default current forest is used - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -Exclude domain from search, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -Include only specific domains, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -Ability to provide Forest Information from another command to speed up processing - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -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 - -## OUTPUTS - -## NOTES -General notes - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrInheritance +## SYNOPSIS +Retrieves inheritance information for Group Policy Objects (GPOs) within specified Organizational Units (OUs). + +## SYNTAX +### __AllParameterSets +```powershell +Get-GPOZaurrInheritance [[-Exclusions] ] [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [-IncludeBlockedObjects] [-OnlyBlockedInheritance] [-IncludeExcludedObjects] [-IncludeGroupPoliciesForBlockedObjects] [] +``` + +## DESCRIPTION +This function retrieves and displays inheritance information for GPOs within specified OUs. It provides details on blocked inheritance, excluded objects, and group policies associated with blocked objects. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > $Objects = Get-GPOZaurrInheritance -IncludeBlockedObjects -IncludeExcludedObjects -OnlyBlockedInheritance -Exclusions $ExcludedOU +$Objects | Format-Table +``` + + +## PARAMETERS + +### -ExcludeDomains +Specifies the domain to exclude from the search. By default, the entire forest is scanned. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Exclusions +Specifies the OUs approved by IT to be excluded. You can provide OUs by canonical name or distinguishedName. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Allows providing Forest Information from another command to speed up processing. + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 4 +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: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeBlockedObjects +Specifies whether to include OUs with blocked inheritance. By default, this is disabled. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Specifies specific domains to include. By default, the entire forest is scanned. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeExcludedObjects +Specifies whether to show excluded objects. By default, this is disabled. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeGroupPoliciesForBlockedObjects +Specifies whether to include Group Policies for blocked objects. By default, this is disabled. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -OnlyBlockedInheritance +Specifies whether to show only OUs with blocked inheritance. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +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 + diff --git a/Docs/Get-GPOZaurrLegacyFiles.md b/Docs/Get-GPOZaurrLegacyFiles.md index 3cf4ee2..24e29c1 100644 --- a/Docs/Get-GPOZaurrLegacyFiles.md +++ b/Docs/Get-GPOZaurrLegacyFiles.md @@ -1,106 +1,109 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrLegacyFiles - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Get-GPOZaurrLegacyFiles [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] - [[-ExtendedForestInformation] ] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 2 -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 - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrLegacyFiles +## SYNOPSIS +Retrieves legacy Group Policy Object (GPO) files from the SYSVOL directory of specified domains within a forest. + +## SYNTAX +### __AllParameterSets +```powershell +Get-GPOZaurrLegacyFiles [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [] +``` + +## DESCRIPTION +The Get-GPOZaurrLegacyFiles function retrieves legacy GPO files, such as '*.adm' and 'admfiles.ini', from the SYSVOL directory of specified domains within a forest. It provides detailed information about these files including their name, full path, creation time, last write time, attributes, associated domain name, and directory name. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Get-GPOZaurrLegacyFiles -Forest "contoso.com" -IncludeDomains "domain1", "domain2" -ExcludeDomains "domain3" -ExtendedForestInformation $additionalInfo +``` + +Retrieves legacy GPO files from the "contoso.com" forest for "domain1" and "domain2" domains while excluding "domain3", using additional forest information. + +## PARAMETERS + +### -ExcludeDomains +Specifies an array of domain names to exclude from the search for legacy GPO files. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Specifies additional information about the forest to enhance the retrieval process. + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Specifies the name of the forest from which to retrieve legacy GPO files. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Specifies an array of domain names to include in the search for legacy GPO files. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 2 +Default value: None +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 + diff --git a/Docs/Get-GPOZaurrLink.md b/Docs/Get-GPOZaurrLink.md index c15cafa..0f9019b 100644 --- a/Docs/Get-GPOZaurrLink.md +++ b/Docs/Get-GPOZaurrLink.md @@ -1,297 +1,311 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrLink - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -### Linked (Default) -``` -Get-GPOZaurrLink [-Linked ] [-Limited] [-SkipDuplicates] [-GPOCache ] [-Forest ] - [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] - [-AsHashTable] [-Summary] [] -``` - -### ADObject -``` -Get-GPOZaurrLink -ADObject [-Limited] [-SkipDuplicates] [-GPOCache ] - [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] - [-ExtendedForestInformation ] [-AsHashTable] [-Summary] [] -``` - -### Filter -``` -Get-GPOZaurrLink [-Filter ] [-SearchBase ] [-SearchScope ] [-Limited] - [-SkipDuplicates] [-GPOCache ] [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [-ExtendedForestInformation ] [-AsHashTable] [-Summary] - [] -``` - -### Site -``` -Get-GPOZaurrLink [-Site ] [-GPOCache ] [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [-ExtendedForestInformation ] [-AsHashTable] [-Summary] - [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -ADObject -{{ Fill ADObject Description }} - -```yaml -Type: ADObject[] -Parameter Sets: ADObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AsHashTable -{{ Fill AsHashTable Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -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: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOCache -{{ Fill GPOCache Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Limited -{{ Fill Limited Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: Linked, ADObject, Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Linked -{{ Fill Linked Description }} - -```yaml -Type: String[] -Parameter Sets: Linked -Aliases: -Accepted values: All, Root, DomainControllers, Site, OrganizationalUnit - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchBase -{{ Fill SearchBase Description }} - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchScope -{{ Fill SearchScope Description }} - -```yaml -Type: ADSearchScope -Parameter Sets: Filter -Aliases: -Accepted values: Base, OneLevel, Subtree - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -{{ Fill Site Description }} - -```yaml -Type: String[] -Parameter Sets: Site -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipDuplicates -{{ Fill SkipDuplicates Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: Linked, ADObject, Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Summary -{{ Fill Summary 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 - -### Microsoft.ActiveDirectory.Management.ADObject[] - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrLink +## SYNOPSIS +Retrieves Group Policy Object (GPO) links based on specified criteria. + +## SYNTAX +### Linked (Default) +```powershell +Get-GPOZaurrLink [-Linked ] [-Limited] [-SkipDuplicates] [-GPOCache ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-AsHashTable] [-Summary] [] +``` + +### ADObject +```powershell +Get-GPOZaurrLink -ADObject [-Limited] [-SkipDuplicates] [-GPOCache ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-AsHashTable] [-Summary] [] +``` + +### Filter +```powershell +Get-GPOZaurrLink [-Filter ] [-SearchBase ] [-SearchScope ] [-Limited] [-SkipDuplicates] [-GPOCache ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-AsHashTable] [-Summary] [] +``` + +### Site +```powershell +Get-GPOZaurrLink [-Site ] [-GPOCache ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-AsHashTable] [-Summary] [] +``` + +## DESCRIPTION +This function retrieves GPO links based on various parameters such as ADObject, Filter, Linked, Site, etc. It provides flexibility in searching for GPO links within Active Directory. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Get-GPOZaurrLink -ADObject $ADObject -Linked 'All' +``` + +Description +----------- +Retrieves all linked GPOZaurr links for the specified Active Directory object(s). + +### EXAMPLE 2 +```powershell +PS > Get-GPOZaurrLink -Filter "(objectClass -eq 'organizationalUnit')" -SearchBase 'CN=Configuration,DC=ad,DC=evotec,DC=xyz' +``` + +Description +----------- +Retrieves GPOZaurr links based on the specified filter and search base. + +## PARAMETERS + +### -ADObject +Specifies the Active Directory object(s) to search for GPO links. + +```yaml +Type: ADObject[] +Parameter Sets: ADObject +Aliases: +Possible values: + +Required: True +Position: named +Default value: None +Accept pipeline input: True (ByValue, ByPropertyName) +Accept wildcard characters: True +``` + +### -AsHashTable +{{ Fill AsHashTable Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Linked, ADObject, Filter, Site +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeDomains +Specifies the domains to exclude from the search. + +```yaml +Type: String[] +Parameter Sets: Linked, ADObject, Filter, Site +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +{{ Fill ExtendedForestInformation Description }} + +```yaml +Type: IDictionary +Parameter Sets: Linked, ADObject, Filter, Site +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Filter +Specifies the filter criteria to search for GPO links. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Specifies the forest name for filtering GPO links. + +```yaml +Type: String +Parameter Sets: Linked, ADObject, Filter, Site +Aliases: ForestName +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOCache +Specifies a cache for storing GPO information. + +```yaml +Type: IDictionary +Parameter Sets: Linked, ADObject, Filter, Site +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Specifies the domains to include in the search. + +```yaml +Type: String[] +Parameter Sets: Linked, ADObject, Filter, Site +Aliases: Domain, Domains +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Limited +Indicates whether to limit the search results. + +```yaml +Type: SwitchParameter +Parameter Sets: Linked, ADObject, Filter +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Linked +Specifies the type of linked GPOs to retrieve. Valid values are 'All', 'Root', 'DomainControllers', 'Site', and 'OrganizationalUnit'. + +```yaml +Type: String[] +Parameter Sets: Linked +Aliases: +Possible values: All, Root, DomainControllers, Site, OrganizationalUnit + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -SearchBase +Specifies the search base for filtering GPO links. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -SearchScope +Specifies the search scope for filtering GPO links. + +```yaml +Type: ADSearchScope +Parameter Sets: Filter +Aliases: +Possible values: Base, OneLevel, Subtree + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Site +Specifies the site(s) to search for GPO links. + +```yaml +Type: String[] +Parameter Sets: Site +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -SkipDuplicates +Indicates whether to skip duplicate search results. + +```yaml +Type: SwitchParameter +Parameter Sets: Linked, ADObject, Filter +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Summary +{{ Fill Summary Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Linked, ADObject, Filter, Site +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +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 + +- `ADObject[]` + +## OUTPUTS + +- `None` + +## RELATED LINKS + +- None + diff --git a/Docs/Get-GPOZaurrLinkSummary.md b/Docs/Get-GPOZaurrLinkSummary.md index bea2be3..ff2e367 100644 --- a/Docs/Get-GPOZaurrLinkSummary.md +++ b/Docs/Get-GPOZaurrLinkSummary.md @@ -1,138 +1,148 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrLinkSummary - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Get-GPOZaurrLinkSummary [[-Report] ] [-UnlimitedProperties] [[-Forest] ] - [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] - [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Report -{{ Fill Report Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Accepted values: All, MultipleLinks, OneLink, LinksSummary - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnlimitedProperties -{{ Fill UnlimitedProperties 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 - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrLinkSummary +## SYNOPSIS +Retrieves a summary of GPO links based on specified criteria. + +## SYNTAX +### __AllParameterSets +```powershell +Get-GPOZaurrLinkSummary [[-Report] ] [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [-UnlimitedProperties] [] +``` + +## DESCRIPTION +This function retrieves a summary of GPO links based on the provided parameters. It categorizes the links into different types and provides detailed information about each link. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Get-GPOZaurrLinkSummary -Forest "Contoso" -IncludeDomains "Domain1", "Domain2" -Report "MultipleLinks" +Retrieves a summary of GPO links for the specified forest and included domains, focusing on multiple links. +``` + + +### EXAMPLE 2 +```powershell +PS > Get-GPOZaurrLinkSummary -Forest "Fabrikam" -ExcludeDomains "Domain3" -Report "OneLink" +Retrieves a summary of GPO links for the specified forest excluding Domain3, focusing on a single link. +``` + + +## PARAMETERS + +### -ExcludeDomains +Specifies an array of domains to exclude from the report. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Specifies additional information about the forest. + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Specifies the forest name to retrieve GPO links from. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Specifies an array of domains to include in the report. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Report +Specifies the type of report to generate. Valid values are 'All', 'MultipleLinks', 'OneLink', and 'LinksSummary'. Default is 'All'. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: All, MultipleLinks, OneLink, LinksSummary + +Required: False +Position: 0 +Default value: All +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -UnlimitedProperties +Indicates whether to include unlimited properties in the report. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +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 + diff --git a/Docs/Get-GPOZaurrMissingFiles.md b/Docs/Get-GPOZaurrMissingFiles.md new file mode 100644 index 0000000..504232b --- /dev/null +++ b/Docs/Get-GPOZaurrMissingFiles.md @@ -0,0 +1,164 @@ +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrMissingFiles +## SYNOPSIS +Retrieves information about missing files in Group Policy Objects (GPOs) within a specified forest. + +## SYNTAX +### __AllParameterSets +```powershell +Get-GPOZaurrMissingFiles [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [[-GPOName] ] [[-GPOGUID] ] [-BrokenOnly] [] +``` + +## DESCRIPTION +This function queries Active Directory for GPOs and checks for missing files within them. It provides detailed information about any errors found. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Get-GPOZaurrMissingFiles -Forest "example.com" -IncludeDomains "domain1", "domain2" -ExcludeDomains "domain3" -GPOName "GPO1" +``` + +Retrieves information about missing files in the GPO named "GPO1" within the "example.com" forest, including only domains "domain1" and "domain2" while excluding "domain3". + +### EXAMPLE 2 +```powershell +PS > Get-GPOZaurrMissingFiles -Forest "example.com" -IncludeDomains "domain1", "domain2" -GPOGUID "12345678-1234-1234-1234-1234567890AB" -BrokenOnly +``` + +Retrieves information about GPOs with missing files in the "example.com" forest, including only domains "domain1" and "domain2" for the GPO with the specified GUID, displaying only GPOs with missing files. + +## PARAMETERS + +### -BrokenOnly +Indicates whether to only display GPOs with missing files. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeDomains +Specifies an array of domains to exclude from the query. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Specifies additional information about the forest. + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Specifies the name of the forest to query for GPO information. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOGUID +Specifies the GUID of the GPO to retrieve information for. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOName +Specifies the name of the GPO to retrieve information for. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Name +Possible values: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Specifies an array of domains to include in the query. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 2 +Default value: None +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 + diff --git a/Docs/Get-GPOZaurrNetLogon.md b/Docs/Get-GPOZaurrNetLogon.md index 61a8dbc..71cad40 100644 --- a/Docs/Get-GPOZaurrNetLogon.md +++ b/Docs/Get-GPOZaurrNetLogon.md @@ -1,149 +1,165 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrNetLogon - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -### Default (Default) -``` -Get-GPOZaurrNetLogon [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] - [-ExtendedForestInformation ] [] -``` - -### OwnerOnly -``` -Get-GPOZaurrNetLogon [-OwnerOnly] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] - [-ExtendedForestInformation ] [] -``` - -### SkipOwner -``` -Get-GPOZaurrNetLogon [-SkipOwner] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] - [-ExtendedForestInformation ] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OwnerOnly -{{ Fill OwnerOnly Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: OwnerOnly -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipOwner -{{ Fill SkipOwner Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: SkipOwner -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 - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrNetLogon +## SYNOPSIS +Retrieves information about Group Policy Objects (GPO) stored in the Netlogon and SYSVOL directories. + +## SYNTAX +### Default (Default) +```powershell +Get-GPOZaurrNetLogon [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [] +``` + +### OwnerOnly +```powershell +Get-GPOZaurrNetLogon [-OwnerOnly] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [] +``` + +### SkipOwner +```powershell +Get-GPOZaurrNetLogon [-SkipOwner] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [] +``` + +## DESCRIPTION +The Get-GPOZaurrNetLogon function retrieves details about GPOs stored in the Netlogon and SYSVOL directories of specified domains within a forest. It provides information about file ownership, status, domain, extension, creation time, and more. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Get-GPOZaurrNetLogon -Forest "contoso.com" -IncludeDomains "domain1", "domain2" +Retrieves GPO information for the specified forest and domains. +``` + + +### EXAMPLE 2 +```powershell +PS > Get-GPOZaurrNetLogon -OwnerOnly +Retrieves GPO information only for GPOs with identified owners. +``` + + +### EXAMPLE 3 +```powershell +PS > Get-GPOZaurrNetLogon -SkipOwner +Retrieves GPO information while skipping the owner check. +``` + + +## PARAMETERS + +### -ExcludeDomains +Specifies an array of domains to exclude from GPO retrieval. + +```yaml +Type: String[] +Parameter Sets: Default, OwnerOnly, SkipOwner +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Specifies additional forest information to include in the output. + +```yaml +Type: IDictionary +Parameter Sets: Default, OwnerOnly, SkipOwner +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Specifies the forest name to retrieve GPO information from. + +```yaml +Type: String +Parameter Sets: Default, OwnerOnly, SkipOwner +Aliases: ForestName +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Specifies an array of domains to include in GPO retrieval. + +```yaml +Type: String[] +Parameter Sets: Default, OwnerOnly, SkipOwner +Aliases: Domain, Domains +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -OwnerOnly +Specifies whether to include only GPOs with identified owners. + +```yaml +Type: SwitchParameter +Parameter Sets: OwnerOnly +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -SkipOwner +Specifies whether to skip checking the owner of GPOs. + +```yaml +Type: SwitchParameter +Parameter Sets: SkipOwner +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +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 + diff --git a/Docs/Get-GPOZaurrOrganizationalUnit.md b/Docs/Get-GPOZaurrOrganizationalUnit.md index 08328b7..a20f441 100644 --- a/Docs/Get-GPOZaurrOrganizationalUnit.md +++ b/Docs/Get-GPOZaurrOrganizationalUnit.md @@ -1,138 +1,141 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrOrganizationalUnit - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Get-GPOZaurrOrganizationalUnit [[-Forest] ] [[-ExcludeDomains] ] - [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [[-Option] ] - [[-ExcludeOrganizationalUnit] ] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeOrganizationalUnit -{{ Fill ExcludeOrganizationalUnit Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: ExcludeOU, Exclusions - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Option -{{ Fill Option Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Accepted values: OK, Unlink, Delete - -Required: False -Position: 4 -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 - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrOrganizationalUnit +## SYNOPSIS +Retrieves information about Group Policy Objects (GPOs) linked to Organizational Units (OUs) within a specified forest. + +## SYNTAX +### __AllParameterSets +```powershell +Get-GPOZaurrOrganizationalUnit [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [[-Option] ] [[-ExcludeOrganizationalUnit] ] [] +``` + +## DESCRIPTION +This function retrieves detailed information about the GPOs linked to OUs within a specified forest. It provides information on linked GPOs, objects within OUs, and counts of objects at different levels. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Get-GPOZaurrOrganizationalUnit -Forest "contoso.com" -IncludeDomains "child.contoso.com" -ExcludeDomains "test.contoso.com" -ExtendedForestInformation $ExtendedInfo -Option "OK" -ExcludeOrganizationalUnit "OU=Test,DC=contoso,DC=com" +Retrieves information about GPOs linked to OUs in the "contoso.com" forest, including the "child.contoso.com" domain, excluding the "test.contoso.com" domain, with additional forest information, performing the 'OK' action, and excluding the "OU=Test,DC=contoso,DC=com" OU. +``` + + +## PARAMETERS + +### -ExcludeDomains +Specifies an array of domains to exclude from processing. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeOrganizationalUnit +Specifies an array of OUs to exclude from processing. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: ExcludeOU, Exclusions +Possible values: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Specifies additional information about the forest. + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Specifies the name of the forest to retrieve information from. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Specifies an array of domains to include for processing. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Option +Specifies the action to perform on the retrieved data. Valid values are 'OK', 'Unlink', or 'Delete'. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: OK, Unlink, Delete + +Required: False +Position: 4 +Default value: None +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 + diff --git a/Docs/Get-GPOZaurrOwner.md b/Docs/Get-GPOZaurrOwner.md index 2fb7dca..fd8c52d 100644 --- a/Docs/Get-GPOZaurrOwner.md +++ b/Docs/Get-GPOZaurrOwner.md @@ -1,215 +1,220 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrOwner - -## SYNOPSIS -Gets owners of GPOs from Active Directory and SYSVOL - -## SYNTAX - -### Default (Default) -``` -Get-GPOZaurrOwner [-IncludeSysvol] [-SkipBroken] [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [-ExtendedForestInformation ] - [-ADAdministrativeGroups ] [-ApprovedOwner ] [] -``` - -### GPOName -``` -Get-GPOZaurrOwner [-GPOName ] [-IncludeSysvol] [-SkipBroken] [-Forest ] - [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] - [-ADAdministrativeGroups ] [-ApprovedOwner ] [] -``` - -### GPOGUID -``` -Get-GPOZaurrOwner [-GPOGuid ] [-IncludeSysvol] [-SkipBroken] [-Forest ] - [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] - [-ADAdministrativeGroups ] [-ApprovedOwner ] [] -``` - -## DESCRIPTION -Gets owners of GPOs from Active Directory and SYSVOL - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-GPOZaurrOwner -Verbose -IncludeSysvol -``` - -### EXAMPLE 2 -``` -Get-GPOZaurrOwner -Verbose -IncludeSysvol -SkipBroken -``` - -## PARAMETERS - -### -GPOName -Name of GPO. -By default all GPOs are returned - -```yaml -Type: String -Parameter Sets: GPOName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOGuid -GUID of GPO. -By default all GPOs are returned - -```yaml -Type: String -Parameter Sets: GPOGUID -Aliases: GUID, GPOID - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeSysvol -Includes Owner from SYSVOL as well - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipBroken -Doesn't display GPOs that have no SYSVOL content (orphaned GPOs) - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -Target different Forest, by default current forest is used - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -Exclude domain from search, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -Include only specific domains, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -Ability to provide Forest Information from another command to speed up processing - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ADAdministrativeGroups -Ability to provide AD Administrative Groups from another command to speed up processing - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApprovedOwner -Ability to provide different owner (non administrative that still is approved for use) - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Exclusion, Exclusions - -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 - -## OUTPUTS - -## NOTES -General notes - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrOwner +## SYNOPSIS +Gets owners of GPOs from Active Directory and SYSVOL + +## SYNTAX +### Default (Default) +```powershell +Get-GPOZaurrOwner [-IncludeSysvol] [-SkipBroken] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-ADAdministrativeGroups ] [-ApprovedOwner ] [] +``` + +### GPOName +```powershell +Get-GPOZaurrOwner [-GPOName ] [-IncludeSysvol] [-SkipBroken] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-ADAdministrativeGroups ] [-ApprovedOwner ] [] +``` + +### GPOGUID +```powershell +Get-GPOZaurrOwner [-GPOGuid ] [-IncludeSysvol] [-SkipBroken] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-ADAdministrativeGroups ] [-ApprovedOwner ] [] +``` + +## DESCRIPTION +Gets owners of GPOs from Active Directory and SYSVOL + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Get-GPOZaurrOwner -Verbose -IncludeSysvol +``` + + +### EXAMPLE 2 +```powershell +PS > Get-GPOZaurrOwner -Verbose -IncludeSysvol -SkipBroken +``` + + +## PARAMETERS + +### -ADAdministrativeGroups +Ability to provide AD Administrative Groups from another command to speed up processing + +```yaml +Type: IDictionary +Parameter Sets: Default, GPOName, GPOGUID +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ApprovedOwner +Ability to provide different owner (non administrative that still is approved for use) + +```yaml +Type: String[] +Parameter Sets: Default, GPOName, GPOGUID +Aliases: Exclusion, Exclusions +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: Default, GPOName, GPOGUID +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Ability to provide Forest Information from another command to speed up processing + +```yaml +Type: IDictionary +Parameter Sets: Default, GPOName, GPOGUID +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Target different Forest, by default current forest is used + +```yaml +Type: String +Parameter Sets: Default, GPOName, GPOGUID +Aliases: ForestName +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOGuid +GUID of GPO. By default all GPOs are returned + +```yaml +Type: String +Parameter Sets: GPOGUID +Aliases: GUID, GPOID +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOName +Name of GPO. By default all GPOs are returned + +```yaml +Type: String +Parameter Sets: GPOName +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Include only specific domains, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: Default, GPOName, GPOGUID +Aliases: Domain, Domains +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeSysvol +Includes Owner from SYSVOL as well + +```yaml +Type: SwitchParameter +Parameter Sets: Default, GPOName, GPOGUID +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -SkipBroken +Doesn't display GPOs that have no SYSVOL content (orphaned GPOs) + +```yaml +Type: SwitchParameter +Parameter Sets: Default, GPOName, GPOGUID +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +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 + diff --git a/Docs/Get-GPOZaurrPassword.md b/Docs/Get-GPOZaurrPassword.md index 886afd6..f75c185 100644 --- a/Docs/Get-GPOZaurrPassword.md +++ b/Docs/Get-GPOZaurrPassword.md @@ -1,122 +1,130 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrPassword - -## SYNOPSIS -Tries to find CPassword in Group Policies or given path and translate it to readable value - -## SYNTAX - -``` -Get-GPOZaurrPassword [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] - [[-ExtendedForestInformation] ] [[-GPOPath] ] [] -``` - -## DESCRIPTION -Tries to find CPassword in Group Policies or given path and translate it to readable value - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-GPOZaurrPassword -GPOPath 'C:\Users\przemyslaw.klys\Desktop\GPOExport_2020.10.12' -``` - -### EXAMPLE 2 -``` -Get-GPOZaurrPassword -``` - -## PARAMETERS - -### -Forest -Target different Forest, by default current forest is used - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -Exclude domain from search, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -Include only specific domains, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -Ability to provide Forest Information from another command to speed up processing - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOPath -Path where Group Policy content is located or where backup is located - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -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 - -## OUTPUTS - -## NOTES -General notes - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrPassword +## SYNOPSIS +Tries to find CPassword in Group Policies or given path and translate it to readable value + +## SYNTAX +### __AllParameterSets +```powershell +Get-GPOZaurrPassword [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [[-GPOPath] ] [] +``` + +## DESCRIPTION +Tries to find CPassword in Group Policies or given path and translate it to readable value + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Get-GPOZaurrPassword -GPOPath 'C:\Users\przemyslaw.klys\Desktop\GPOExport_2020.10.12' +``` + + +### EXAMPLE 2 +```powershell +PS > Get-GPOZaurrPassword +``` + + +## PARAMETERS + +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Ability to provide Forest Information from another command to speed up processing + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Target different Forest, by default current forest is used + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOPath +Path where Group Policy content is located or where backup is located + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Include only specific domains, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 2 +Default value: None +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 + diff --git a/Docs/Get-GPOZaurrPermission.md b/Docs/Get-GPOZaurrPermission.md index cb6e81e..dc8806a 100644 --- a/Docs/Get-GPOZaurrPermission.md +++ b/Docs/Get-GPOZaurrPermission.md @@ -1,392 +1,43 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrPermission - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -### GPO (Default) -``` -Get-GPOZaurrPermission [-Principal ] [-PrincipalType ] [-Type ] [-SkipWellKnown] - [-SkipAdministrative] [-IncludeOwner] [-IncludePermissionType ] - [-ExcludePermissionType ] [-PermitType ] [-ExcludePrincipal ] - [-ExcludePrincipalType ] [-IncludeGPOObject] [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [-ExtendedForestInformation ] - [-ADAdministrativeGroups ] [-ReturnSecurityWhenNoData] [-ReturnSingleObject] [] -``` - -### GPOName -``` -Get-GPOZaurrPermission [-GPOName ] [-Principal ] [-PrincipalType ] [-Type ] - [-SkipWellKnown] [-SkipAdministrative] [-IncludeOwner] [-IncludePermissionType ] - [-ExcludePermissionType ] [-PermitType ] [-ExcludePrincipal ] - [-ExcludePrincipalType ] [-IncludeGPOObject] [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [-ExtendedForestInformation ] - [-ADAdministrativeGroups ] [-ReturnSecurityWhenNoData] [-ReturnSingleObject] [] -``` - -### GPOGUID -``` -Get-GPOZaurrPermission [-GPOGuid ] [-Principal ] [-PrincipalType ] [-Type ] - [-SkipWellKnown] [-SkipAdministrative] [-IncludeOwner] [-IncludePermissionType ] - [-ExcludePermissionType ] [-PermitType ] [-ExcludePrincipal ] - [-ExcludePrincipalType ] [-IncludeGPOObject] [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [-ExtendedForestInformation ] - [-ADAdministrativeGroups ] [-ReturnSecurityWhenNoData] [-ReturnSingleObject] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -ADAdministrativeGroups -{{ Fill ADAdministrativeGroups Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludePermissionType -{{ Fill ExcludePermissionType Description }} - -```yaml -Type: GPPermissionType[] -Parameter Sets: (All) -Aliases: -Accepted values: None, GpoApply, GpoRead, GpoEdit, GpoEditDeleteModifySecurity, GpoCustom, WmiFilterEdit, WmiFilterFullControl, WmiFilterCustom, StarterGpoRead, StarterGpoEdit, StarterGpoFullControl, StarterGpoCustom, SomCreateWmiFilter, SomWmiFilterFullControl, SomCreateGpo, SomCreateStarterGpo, SomLogging, SomPlanning, SomLink - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludePrincipal -{{ Fill ExcludePrincipal Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludePrincipalType -{{ Fill ExcludePrincipalType Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: DistinguishedName, Name, Sid - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOGuid -{{ Fill GPOGuid Description }} - -```yaml -Type: String -Parameter Sets: GPOGUID -Aliases: GUID, GPOID - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOName -{{ Fill GPOName Description }} - -```yaml -Type: String -Parameter Sets: GPOName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeGPOObject -{{ Fill IncludeGPOObject Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeOwner -{{ Fill IncludeOwner Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludePermissionType -{{ Fill IncludePermissionType Description }} - -```yaml -Type: GPPermissionType[] -Parameter Sets: (All) -Aliases: -Accepted values: None, GpoApply, GpoRead, GpoEdit, GpoEditDeleteModifySecurity, GpoCustom, WmiFilterEdit, WmiFilterFullControl, WmiFilterCustom, StarterGpoRead, StarterGpoEdit, StarterGpoFullControl, StarterGpoCustom, SomCreateWmiFilter, SomWmiFilterFullControl, SomCreateGpo, SomCreateStarterGpo, SomLogging, SomPlanning, SomLink - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermitType -{{ Fill PermitType Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Allow, Deny, All - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Principal -{{ Fill Principal Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrincipalType -{{ Fill PrincipalType Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: DistinguishedName, Name, NetbiosName, Sid - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReturnSecurityWhenNoData -{{ Fill ReturnSecurityWhenNoData Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReturnSingleObject -{{ Fill ReturnSingleObject Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipAdministrative -{{ Fill SkipAdministrative Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipWellKnown -{{ Fill SkipWellKnown Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -{{ Fill Type Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Accepted values: AuthenticatedUsers, DomainComputers, Unknown, WellKnownAdministrative, NotWellKnown, NotWellKnownAdministrative, NotAdministrative, Administrative, All - -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 - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrPermission +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX +```powershell +Get-GPOZaurrPermission +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +```powershell +Get-GPOZaurrPermission +``` + + +## 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 + +- `None` + +## RELATED LINKS + +- None + diff --git a/Docs/Get-GPOZaurrPermissionAnalysis.md b/Docs/Get-GPOZaurrPermissionAnalysis.md index 21a1699..6e8755b 100644 --- a/Docs/Get-GPOZaurrPermissionAnalysis.md +++ b/Docs/Get-GPOZaurrPermissionAnalysis.md @@ -1,106 +1,109 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrPermissionAnalysis - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Get-GPOZaurrPermissionAnalysis [[-Forest] ] [[-ExcludeDomains] ] - [[-IncludeDomains] ] [[-Permissions] ] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permissions -{{ Fill Permissions Description }} - -```yaml -Type: Array -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -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 - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrPermissionAnalysis +## SYNOPSIS +Analyzes permissions for Group Policy Objects (GPOs) and administrative groups. + +## SYNTAX +### __AllParameterSets +```powershell +Get-GPOZaurrPermissionAnalysis [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-Permissions] ] [] +``` + +## DESCRIPTION +This function analyzes permissions for Group Policy Objects (GPOs) and identifies administrative groups with specific permissions. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Get-GPOZaurrPermissionAnalysis -Forest "ContosoForest" -IncludeDomains @("Domain1", "Domain2") -ExcludeDomains @("Domain3") -Permissions $PermissionsArray +Analyzes permissions for GPOs in the "ContosoForest" forest, including "Domain1" and "Domain2" while excluding "Domain3", using the specified permissions array. +``` + + +## PARAMETERS + +### -ExcludeDomains +Specifies an array of domains to exclude from the analysis. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Specifies the name of the forest to analyze. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Specifies an array of domains to include in the analysis. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Permissions +Specifies an array of permissions to analyze. + +```yaml +Type: Array +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 3 +Default value: None +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 + diff --git a/Docs/Get-GPOZaurrPermissionConsistency.md b/Docs/Get-GPOZaurrPermissionConsistency.md index 1b13537..ef20010 100644 --- a/Docs/Get-GPOZaurrPermissionConsistency.md +++ b/Docs/Get-GPOZaurrPermissionConsistency.md @@ -1,198 +1,206 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrPermissionConsistency - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -### Type (Default) -``` -Get-GPOZaurrPermissionConsistency [-Type ] [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [-ExtendedForestInformation ] [-IncludeGPOObject] - [-VerifyInheritance] [] -``` - -### GPOName -``` -Get-GPOZaurrPermissionConsistency [-GPOName ] [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [-ExtendedForestInformation ] [-IncludeGPOObject] - [-VerifyInheritance] [] -``` - -### GPOGUID -``` -Get-GPOZaurrPermissionConsistency [-GPOGuid ] [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [-ExtendedForestInformation ] [-IncludeGPOObject] - [-VerifyInheritance] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOGuid -{{ Fill GPOGuid Description }} - -```yaml -Type: String -Parameter Sets: GPOGUID -Aliases: GUID, GPOID - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOName -{{ Fill GPOName Description }} - -```yaml -Type: String -Parameter Sets: GPOName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeGPOObject -{{ Fill IncludeGPOObject Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -{{ Fill Type Description }} - -```yaml -Type: String[] -Parameter Sets: Type -Aliases: -Accepted values: Consistent, Inconsistent, All - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VerifyInheritance -{{ Fill VerifyInheritance 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 - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrPermissionConsistency +## SYNOPSIS +Retrieves information about Group Policy Objects (GPOs) and checks permission consistency across domains. + +## SYNTAX +### Type (Default) +```powershell +Get-GPOZaurrPermissionConsistency [-Type ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-IncludeGPOObject] [-VerifyInheritance] [] +``` + +### GPOName +```powershell +Get-GPOZaurrPermissionConsistency [-GPOName ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-IncludeGPOObject] [-VerifyInheritance] [] +``` + +### GPOGUID +```powershell +Get-GPOZaurrPermissionConsistency [-GPOGuid ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-IncludeGPOObject] [-VerifyInheritance] [] +``` + +## DESCRIPTION +The Get-GPOZaurrPermissionConsistency function retrieves information about GPOs and checks permission consistency across domains. It can filter by GPO name, GPO GUID, or type of consistency. It also provides options to include/exclude specific domains and verify inheritance. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Get-GPOZaurrPermissionConsistency -GPOName "TestGPO" -Forest "Contoso" -IncludeDomains @("DomainA", "DomainB") -Type "Consistent" +Retrieves permission consistency information for the GPO named "TestGPO" in the forest "Contoso" for domains "DomainA" and "DomainB" with consistent permissions. +``` + + +### EXAMPLE 2 +```powershell +PS > Get-GPOZaurrPermissionConsistency -GPOGuid "12345678-1234-1234-1234-1234567890AB" -Forest "Fabrikam" -Type "Inconsistent" -VerifyInheritance +Retrieves permission consistency information for the GPO with GUID "12345678-1234-1234-1234-1234567890AB" in the forest "Fabrikam" for all domains with inconsistent permissions and verifies inheritance. +``` + + +## PARAMETERS + +### -ExcludeDomains +Specifies an array of domains to exclude from the search. + +```yaml +Type: String[] +Parameter Sets: Type, GPOName, GPOGUID +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Specifies additional information about the forest. + +```yaml +Type: IDictionary +Parameter Sets: Type, GPOName, GPOGUID +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Specifies the forest name to retrieve GPO information from. + +```yaml +Type: String +Parameter Sets: Type, GPOName, GPOGUID +Aliases: ForestName +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOGuid +Specifies the GUID of the GPO to retrieve. + +```yaml +Type: String +Parameter Sets: GPOGUID +Aliases: GUID, GPOID +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOName +Specifies the name of the GPO to retrieve. + +```yaml +Type: String +Parameter Sets: GPOName +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Specifies an array of domains to include in the search. + +```yaml +Type: String[] +Parameter Sets: Type, GPOName, GPOGUID +Aliases: Domain, Domains +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeGPOObject +Indicates whether to include the GPO object in the output. + +```yaml +Type: SwitchParameter +Parameter Sets: Type, GPOName, GPOGUID +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Type +Specifies the type of consistency to check. Valid values are 'Consistent', 'Inconsistent', or 'All'. + +```yaml +Type: String[] +Parameter Sets: Type +Aliases: +Possible values: Consistent, Inconsistent, All + +Required: False +Position: named +Default value: All +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -VerifyInheritance +Indicates whether to verify inheritance of permissions. + +```yaml +Type: SwitchParameter +Parameter Sets: Type, GPOName, GPOGUID +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +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 + diff --git a/Docs/Get-GPOZaurrPermissionIssue.md b/Docs/Get-GPOZaurrPermissionIssue.md index aa2c348..39ba7d7 100644 --- a/Docs/Get-GPOZaurrPermissionIssue.md +++ b/Docs/Get-GPOZaurrPermissionIssue.md @@ -1,104 +1,109 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrPermissionIssue - -## SYNOPSIS -Detects Group Policy missing Authenticated Users permission while not having higher permissions. - -## SYNTAX - -``` -Get-GPOZaurrPermissionIssue [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] - [[-ExtendedForestInformation] ] [] -``` - -## DESCRIPTION -Detects Group Policy missing Authenticated Users permission while not having higher permissions. - -## EXAMPLES - -### EXAMPLE 1 -``` -$Issues = Get-GPOZaurrPermissionIssue -``` - -$Issues | Format-Table - -## PARAMETERS - -### -Forest -Target different Forest, by default current forest is used - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -Exclude domain from search, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -Include only specific domains, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -Ability to provide Forest Information from another command to speed up processing - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -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 - -## OUTPUTS - -## NOTES -General notes - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrPermissionIssue +## SYNOPSIS +Detects Group Policy missing Authenticated Users permission while not having higher permissions. + +## SYNTAX +### __AllParameterSets +```powershell +Get-GPOZaurrPermissionIssue [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [] +``` + +## DESCRIPTION +Detects Group Policy missing Authenticated Users permission while not having higher permissions. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > $Issues = Get-GPOZaurrPermissionIssue +$Issues | Format-Table +``` + + +## PARAMETERS + +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Ability to provide Forest Information from another command to speed up processing + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Target different Forest, by default current forest is used + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Include only specific domains, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 2 +Default value: None +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 + diff --git a/Docs/Get-GPOZaurrPermissionRoot.md b/Docs/Get-GPOZaurrPermissionRoot.md index 06657e8..8abd698 100644 --- a/Docs/Get-GPOZaurrPermissionRoot.md +++ b/Docs/Get-GPOZaurrPermissionRoot.md @@ -1,154 +1,162 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrPermissionRoot - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Get-GPOZaurrPermissionRoot [[-IncludePermissionType] ] [[-ExcludePermissionType] ] - [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] - [[-ExtendedForestInformation] ] [-SkipNames] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludePermissionType -{{ Fill ExcludePermissionType Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Accepted values: GpoRootCreate, GpoRootOwner - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludePermissionType -{{ Fill IncludePermissionType Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Accepted values: GpoRootCreate, GpoRootOwner - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipNames -{{ Fill SkipNames 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 - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrPermissionRoot +## SYNOPSIS +Retrieves the root permissions of Group Policy Objects (GPOs) based on specified criteria. + +## SYNTAX +### __AllParameterSets +```powershell +Get-GPOZaurrPermissionRoot [[-IncludePermissionType] ] [[-ExcludePermissionType] ] [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [-SkipNames] [] +``` + +## DESCRIPTION +Retrieves the root permissions of GPOs based on the specified criteria, including filtering by permission types, forest, domains, and more. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Get-GPOZaurrPermissionRoot -IncludePermissionType 'GpoRootCreate' -ExcludePermissionType 'GpoRootOwner' -Forest 'ExampleForest' -IncludeDomains 'Domain1', 'Domain2' -ExtendedForestInformation $ForestInfo -SkipNames +``` + + +### EXAMPLE 2 +```powershell +PS > Get-GPOZaurrPermissionRoot -IncludePermissionType 'GpoRootOwner' -ExcludePermissionType 'GpoRootCreate' -Forest 'AnotherForest' -ExcludeDomains 'Domain3' -SkipNames +``` + + +## PARAMETERS + +### -ExcludeDomains +Specifies domains to exclude from the search. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludePermissionType +Specifies the root permission types to exclude from the search. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: GpoRootCreate, GpoRootOwner + +Required: False +Position: 1 +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: 5 +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: 2 +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: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludePermissionType +Specifies the root permission types to include in the search. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: GpoRootCreate, GpoRootOwner + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -SkipNames +Skips processing names during the operation. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +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 + diff --git a/Docs/Get-GPOZaurrPermissionSummary.md b/Docs/Get-GPOZaurrPermissionSummary.md index 51cba36..04d6d33 100644 --- a/Docs/Get-GPOZaurrPermissionSummary.md +++ b/Docs/Get-GPOZaurrPermissionSummary.md @@ -1,187 +1,194 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrPermissionSummary - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Get-GPOZaurrPermissionSummary [[-Type] ] [[-PermitType] ] - [[-IncludePermissionType] ] [[-ExcludePermissionType] ] [[-Forest] ] - [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] - [[-Separator] ] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludePermissionType -{{ Fill ExcludePermissionType Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Accepted values: GpoApply, GpoEdit, GpoCustom, GpoEditDeleteModifySecurity, GpoRead, GpoOwner, GpoRootCreate, GpoRootOwner - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludePermissionType -{{ Fill IncludePermissionType Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Accepted values: GpoApply, GpoEdit, GpoCustom, GpoEditDeleteModifySecurity, GpoRead, GpoOwner, GpoRootCreate, GpoRootOwner - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermitType -{{ Fill PermitType Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Allow, Deny, All - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Separator -{{ Fill Separator Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -{{ Fill Type Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Accepted values: AuthenticatedUsers, DomainComputers, Unknown, WellKnownAdministrative, NotWellKnown, NotWellKnownAdministrative, NotAdministrative, Administrative, All - -Required: False -Position: 0 -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 - -### System.Object -## NOTES - -## RELATED LINKS +--- +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] ] [[-PermitType] ] [[-IncludePermissionType] ] [[-ExcludePermissionType] ] [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [[-Separator] ] [] +``` + +## 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 + diff --git a/Docs/Get-GPOZaurrRedirect.md b/Docs/Get-GPOZaurrRedirect.md new file mode 100644 index 0000000..3de3ea0 --- /dev/null +++ b/Docs/Get-GPOZaurrRedirect.md @@ -0,0 +1,214 @@ +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrRedirect +## SYNOPSIS +Command to detect if GPOs have correct path in SYSVOL, or someone changed it manually. + +## SYNTAX +### Default (Default) +```powershell +Get-GPOZaurrRedirect [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-DateFrom ] [-DateTo ] [-DateRange ] [-DateProperty ] [-ExtendedForestInformation ] [] +``` + +### GPOName +```powershell +Get-GPOZaurrRedirect [-GPOName ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-DateFrom ] [-DateTo ] [-DateRange ] [-DateProperty ] [-ExtendedForestInformation ] [] +``` + +### GPOGUID +```powershell +Get-GPOZaurrRedirect [-GPOGuid ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-DateFrom ] [-DateTo ] [-DateRange ] [-DateProperty ] [-ExtendedForestInformation ] [] +``` + +## DESCRIPTION +Command to detect if GPOs have correct path in SYSVOL, or someone changed it manually. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Get-GPOZaurrRedirect | Format-Table +``` + + +## PARAMETERS + +### -DateFrom +Provide a date from which to start the search, by default the last X days are used + +```yaml +Type: DateTime +Parameter Sets: Default, GPOName, GPOGUID +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -DateProperty +Choose a date property. It can be WhenCreated or WhenChanged or both. By default whenCreated is used for comparison purposes + +```yaml +Type: String[] +Parameter Sets: Default, GPOName, GPOGUID +Aliases: +Possible values: WhenCreated, WhenChanged + +Required: False +Position: named +Default value: WhenCreated +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -DateRange +Provide a date range to search for, by default the last X days are used + +```yaml +Type: String +Parameter Sets: Default, GPOName, GPOGUID +Aliases: +Possible values: PastHour, CurrentHour, PastDay, CurrentDay, PastMonth, CurrentMonth, PastQuarter, CurrentQuarter, Last14Days, Last21Days, Last30Days, Last7Days, Last3Days, Last1Days + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -DateTo +Provide a date to which to end the search, by default the last X days are used + +```yaml +Type: DateTime +Parameter Sets: Default, GPOName, GPOGUID +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: Default, GPOName, GPOGUID +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Ability to provide Forest Information from another command to speed up processing + +```yaml +Type: IDictionary +Parameter Sets: Default, GPOName, GPOGUID +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Target different Forest, by default current forest is used + +```yaml +Type: String +Parameter Sets: Default, GPOName, GPOGUID +Aliases: ForestName +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOGuid +Provide GPO GUID to search for. By default command returns all GPOs + +```yaml +Type: String +Parameter Sets: GPOGUID +Aliases: GUID, GPOID +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOName +Provide GPO name to search for. By default command returns all GPOs + +```yaml +Type: String +Parameter Sets: GPOName +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Include only specific domains, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: Default, GPOName, GPOGUID +Aliases: Domain, Domains +Possible values: + +Required: False +Position: named +Default value: None +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 + diff --git a/Docs/Get-GPOZaurrSysvolDFSR.md b/Docs/Get-GPOZaurrSysvolDFSR.md index 4f90495..074e955 100644 --- a/Docs/Get-GPOZaurrSysvolDFSR.md +++ b/Docs/Get-GPOZaurrSysvolDFSR.md @@ -1,170 +1,173 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrSysvolDFSR - -## SYNOPSIS -Gets DFSR information from the SYSVOL DFSR - -## SYNTAX - -``` -Get-GPOZaurrSysvolDFSR [[-Forest] ] [[-ExcludeDomains] ] - [[-ExcludeDomainControllers] ] [[-IncludeDomains] ] - [[-IncludeDomainControllers] ] [-SkipRODC] [[-ExtendedForestInformation] ] - [[-SearchDFSR] ] [] -``` - -## DESCRIPTION -Gets DFSR information from the SYSVOL DFSR - -## EXAMPLES - -### EXAMPLE 1 -``` -$DFSR = Get-GPOZaurrSysvolDFSR -``` - -$DFSR | Format-Table * - -## PARAMETERS - -### -Forest -Target different Forest, by default current forest is used - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -Exclude domain from search, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomainControllers -Exclude specific domain controllers, by default there are no exclusions, as long as VerifyDomainControllers switch is enabled. -Otherwise this parameter is ignored. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -Include only specific domains, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomainControllers -Include only specific domain controllers, by default all domain controllers are included, as long as VerifyDomainControllers switch is enabled. -Otherwise this parameter is ignored. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: DomainControllers - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipRODC -Skip Read-Only Domain Controllers. -By default all domain controllers are included. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -Ability to provide Forest Information from another command to speed up processing - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchDFSR -Define DFSR Share. -By default it uses SYSVOL Share - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: SYSVOL Share -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 - -## OUTPUTS - -## NOTES -General notes - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrSysvolDFSR +## SYNOPSIS +Gets DFSR information from the SYSVOL DFSR + +## SYNTAX +### __AllParameterSets +```powershell +Get-GPOZaurrSysvolDFSR [[-Forest] ] [[-ExcludeDomains] ] [[-ExcludeDomainControllers] ] [[-IncludeDomains] ] [[-IncludeDomainControllers] ] [[-ExtendedForestInformation] ] [[-SearchDFSR] ] [-SkipRODC] [] +``` + +## DESCRIPTION +Gets DFSR information from the SYSVOL DFSR + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > $DFSR = Get-GPOZaurrSysvolDFSR +$DFSR | Format-Table * +``` + + +## PARAMETERS + +### -ExcludeDomainControllers +Exclude specific domain controllers, by default there are no exclusions, as long as VerifyDomainControllers switch is enabled. Otherwise this parameter is ignored. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Ability to provide Forest Information from another command to speed up processing + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Target different Forest, by default current forest is used + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomainControllers +Include only specific domain controllers, by default all domain controllers are included, as long as VerifyDomainControllers switch is enabled. Otherwise this parameter is ignored. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: DomainControllers +Possible values: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Include only specific domains, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -SearchDFSR +Define DFSR Share. By default it uses SYSVOL Share + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 6 +Default value: SYSVOL Share +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -SkipRODC +Skip Read-Only Domain Controllers. By default all domain controllers are included. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +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 + diff --git a/Docs/Get-GPOZaurrUpdates.md b/Docs/Get-GPOZaurrUpdates.md index e55d7ac..ac519ef 100644 --- a/Docs/Get-GPOZaurrUpdates.md +++ b/Docs/Get-GPOZaurrUpdates.md @@ -1,178 +1,183 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrUpdates - -## SYNOPSIS -Gets the list of GPOs created or updated in the last X number of days. - -## SYNTAX - -### DateRange (Default) -``` -Get-GPOZaurrUpdates [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] - -DateRange [-DateProperty ] [-ExtendedForestInformation ] [] -``` - -### Dates -``` -Get-GPOZaurrUpdates [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] - -DateFrom -DateTo [-DateProperty ] [-ExtendedForestInformation ] - [] -``` - -## DESCRIPTION -Gets the list of GPOs created or updated in the last X number of days. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-GPOZaurrUpdates -DateRange Last14Days -DateProperty WhenCreated, WhenChanged -Verbose -IncludeDomains 'ad.evotec.pl' | Format-List -``` - -### EXAMPLE 2 -``` -Get-GPOZaurrUpdates -DateRange Last14Days -DateProperty WhenCreated -Verbose | Format-Table -``` - -## PARAMETERS - -### -Forest -Target different Forest, by default current forest is used - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -Exclude domain from search, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -Include only specific domains, by default whole forest is scanned -ą - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DateFrom -Provide a date from which to start the search, by default the last X days are used - -```yaml -Type: DateTime -Parameter Sets: Dates -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DateTo -Provide a date to which to end the search, by default the last X days are used - -```yaml -Type: DateTime -Parameter Sets: Dates -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DateRange -Provide a date range to search for, by default the last X days are used - -```yaml -Type: String -Parameter Sets: DateRange -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DateProperty -Choose a date property. -It can be WhenCreated or WhenChanged or both. -By default whenCreated is used for comparison purposes - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: WhenCreated -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -Ability to provide Forest Information from another command to speed up processing - -```yaml -Type: IDictionary -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 - -## OUTPUTS - -## NOTES -General notes - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrUpdates +## SYNOPSIS +Gets the list of GPOs created or updated in the last X number of days. + +## SYNTAX +### DateRange (Default) +```powershell +Get-GPOZaurrUpdates -DateRange [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-DateProperty ] [-ExtendedForestInformation ] [] +``` + +### Dates +```powershell +Get-GPOZaurrUpdates -DateFrom -DateTo [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-DateProperty ] [-ExtendedForestInformation ] [] +``` + +## DESCRIPTION +Gets the list of GPOs created or updated in the last X number of days. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Get-GPOZaurrUpdates -DateRange Last14Days -DateProperty WhenCreated, WhenChanged -Verbose -IncludeDomains 'ad.evotec.pl' | Format-List +``` + + +### EXAMPLE 2 +```powershell +PS > Get-GPOZaurrUpdates -DateRange Last14Days -DateProperty WhenCreated -Verbose | Format-Table +``` + + +## PARAMETERS + +### -DateFrom +Provide a date from which to start the search, by default the last X days are used + +```yaml +Type: DateTime +Parameter Sets: Dates +Aliases: +Possible values: + +Required: True +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -DateProperty +Choose a date property. It can be WhenCreated or WhenChanged or both. By default whenCreated is used for comparison purposes + +```yaml +Type: String[] +Parameter Sets: DateRange, Dates +Aliases: +Possible values: WhenCreated, WhenChanged + +Required: False +Position: named +Default value: WhenCreated +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -DateRange +Provide a date range to search for, by default the last X days are used + +```yaml +Type: String +Parameter Sets: DateRange +Aliases: +Possible values: PastHour, CurrentHour, PastDay, CurrentDay, PastMonth, CurrentMonth, PastQuarter, CurrentQuarter, Last14Days, Last21Days, Last30Days, Last7Days, Last3Days, Last1Days + +Required: True +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -DateTo +Provide a date to which to end the search, by default the last X days are used + +```yaml +Type: DateTime +Parameter Sets: Dates +Aliases: +Possible values: + +Required: True +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: DateRange, Dates +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Ability to provide Forest Information from another command to speed up processing + +```yaml +Type: IDictionary +Parameter Sets: DateRange, Dates +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Target different Forest, by default current forest is used + +```yaml +Type: String +Parameter Sets: DateRange, Dates +Aliases: ForestName +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Include only specific domains, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: DateRange, Dates +Aliases: Domain, Domains +Possible values: + +Required: False +Position: named +Default value: None +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 + diff --git a/Docs/Get-GPOZaurrWMI.md b/Docs/Get-GPOZaurrWMI.md index e483b4c..1c4c55b 100644 --- a/Docs/Get-GPOZaurrWMI.md +++ b/Docs/Get-GPOZaurrWMI.md @@ -1,153 +1,162 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Get-GPOZaurrWMI - -## SYNOPSIS -Get Group Policy WMI filter - -## SYNTAX - -``` -Get-GPOZaurrWMI [[-Guid] ] [[-Name] ] [[-Forest] ] [[-ExcludeDomains] ] - [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [-AsHashtable] - [] -``` - -## DESCRIPTION -Get Group Policy WMI filter - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-GPOZaurrWMI -AsHashtable -``` - -### EXAMPLE 2 -``` -Get-GPOZaurrWMI | Format-Table -``` - -## PARAMETERS - -### -Guid -Search for specific filter using GUID - -```yaml -Type: Guid[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Search for specific filter using Name - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -Target different Forest, by default current forest is used - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -Exclude domain from search, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -Include only specific domains, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -Ability to provide Forest Information from another command to speed up processing - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsHashtable -Return output as hashtable - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -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 - -## OUTPUTS - -## NOTES -General notes - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Get-GPOZaurrWMI +## SYNOPSIS +Get Group Policy WMI filter + +## SYNTAX +### __AllParameterSets +```powershell +Get-GPOZaurrWMI [[-Guid] ] [[-Name] ] [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [-AsHashtable] [] +``` + +## DESCRIPTION +Get Group Policy WMI filter + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Get-GPOZaurrWMI -AsHashtable +``` + + +### EXAMPLE 2 +```powershell +PS > Get-GPOZaurrWMI | Format-Table +``` + + +## PARAMETERS + +### -AsHashtable +Return output as hashtable + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Ability to provide Forest Information from another command to speed up processing + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Target different Forest, by default current forest is used + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Guid +Search for specific filter using GUID + +```yaml +Type: Guid[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Include only specific domains, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Name +Search for specific filter using Name + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 1 +Default value: None +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 + diff --git a/Docs/Invoke-GPOZaurr.md b/Docs/Invoke-GPOZaurr.md index f981663..cf5484a 100644 --- a/Docs/Invoke-GPOZaurr.md +++ b/Docs/Invoke-GPOZaurr.md @@ -1,253 +1,296 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Invoke-GPOZaurr - -## SYNOPSIS -Single cmdlet that provides 360 degree overview of Group Policies in Active Directory Forest. - -## SYNTAX - -``` -Invoke-GPOZaurr [[-Exclusions] ] [-FilePath ] [[-Type] ] [-PassThru] [-HideHTML] - [-HideSteps] [-ShowError] [-ShowWarning] [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [-Online] [-SplitReports] [] -``` - -## DESCRIPTION -Single cmdlet that provides 360 degree overview of Group Policies in Active Directory Forest with ability to pick reports and export to HTML. - -## EXAMPLES - -### EXAMPLE 1 -``` -Invoke-GPOZaurr -``` - -### EXAMPLE 2 -``` -Invoke-GPOZaurr -Type GPOOrganizationalUnit -Online -FilePath $PSScriptRoot\Reports\GPOZaurrOU.html -Exclusions @( -``` - -'*OU=Production,DC=ad,DC=evotec,DC=pl' -) - -## PARAMETERS - -### -Exclusions +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Invoke-GPOZaurr +## SYNOPSIS +Single cmdlet that provides 360 degree overview of Group Policies in Active Directory Forest. + +## SYNTAX +### __AllParameterSets +```powershell +Invoke-GPOZaurr [[-Type] ] [[-Exclusions] ] [-FilePath ] [-PassThru] [-HideHTML] [-HideSteps] [-ShowError] [-ShowWarning] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-Online] [-SplitReports] [-GPOName ] [-GPOGUID ] [] +``` + +## DESCRIPTION +Single cmdlet that provides 360 degree overview of Group Policies in Active Directory Forest with ability to pick reports and export to HTML. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Invoke-GPOZaurr +``` + + +### EXAMPLE 2 +```powershell +PS > Invoke-GPOZaurr -Type GPOOrganizationalUnit -Online -FilePath $PSScriptRoot\Reports\GPOZaurrOU.html -Exclusions @( + '*OU=Production,DC=ad,DC=evotec,DC=pl' +) +``` + + +## PARAMETERS + +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Exclusions Allows to mark as excluded some Group Policies or Organizational Units depending on type. Can be a scriptblock or array depending on supported way by underlying report. Not every report support exclusions. Not every report support exclusions the same way. -Exclusions should be used only if there is single report being asked for. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: ExcludeGroupPolicies, ExclusionsCode - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilePath -Path to the file where the report will be saved. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Type of report to be generated from a list of available reports. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns created objects after the report is done - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HideHTML -Do not auto open HTML report in default browser - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HideSteps -Do not show steps in report - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowError -Show errors in HTML report. -Useful in case the report is being run as Scheduled Task - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowWarning -Show warnings in HTML report. -Useful in case the report is being run as Scheduled Task - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -Target different Forest, by default current forest is used - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -Exclude domain from search, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -Include only specific domains, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Online -Forces report to use online resources in HTML (using CDN most of the time), by default it is run offline, and inlines all CSS/JS code. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SplitReports -Split report into multiple files, one for each report. -This can be useful for large domains with huge reports. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -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 - -## OUTPUTS - -## NOTES -General notes - -## RELATED LINKS +Exclusions should be used only if there is single report being asked for. + +```yaml +Type: Object +Parameter Sets: __AllParameterSets +Aliases: ExcludeGroupPolicies, ExclusionsCode +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -FilePath +Path to the file where the report will be saved. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Target different Forest, by default current forest is used + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOGUID +{{ Fill GPOGUID Description }} + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: GUID +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOName +{{ Fill GPOName Description }} + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Name +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -HideHTML +Do not auto open HTML report in default browser + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -HideSteps +Do not show steps in report + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Include only specific domains, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Online +Forces report to use online resources in HTML (using CDN most of the time), by default it is run offline, and inlines all CSS/JS code. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -PassThru +Returns created objects after the report is done + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ShowError +Show errors in HTML report. Useful in case the report is being run as Scheduled Task + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ShowWarning +Show warnings in HTML report. Useful in case the report is being run as Scheduled Task + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -SplitReports +Split report into multiple files, one for each report. This can be useful for large domains with huge reports. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Type +Type of report to be generated from a list of available reports. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 0 +Default value: None +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 + diff --git a/Docs/Invoke-GPOZaurrContent.md b/Docs/Invoke-GPOZaurrContent.md index c65e000..0a0bb77 100644 --- a/Docs/Invoke-GPOZaurrContent.md +++ b/Docs/Invoke-GPOZaurrContent.md @@ -1,367 +1,368 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Invoke-GPOZaurrContent - -## SYNOPSIS -Invokes GPOZaurrContent function to retrieve Group Policy Objects information. - -## SYNTAX - -### Default (Default) -``` -Invoke-GPOZaurrContent [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] - [-ExtendedForestInformation ] [-Type ] [-Splitter ] [-FullObjects] - [-OutputType ] [-OutputPath ] [-Open] [-Online] [-CategoriesOnly] [-SingleObject] - [-SkipNormalize] [-SkipCleanup] [-Extended] [-GPOName ] [-GPOGUID ] - [-ProgressAction ] [] -``` - -### Local -``` -Invoke-GPOZaurrContent [-GPOPath ] [-Type ] [-Splitter ] [-FullObjects] - [-OutputType ] [-OutputPath ] [-Open] [-Online] [-CategoriesOnly] [-SingleObject] - [-SkipNormalize] [-SkipCleanup] [-Extended] [-ProgressAction ] [] -``` - -## DESCRIPTION -This function retrieves Group Policy Objects information based on the specified parameters. -It can search for GPOs in a forest, exclude specific domains, include specific domains, and provide extended forest information. - -## EXAMPLES - -### EXAMPLE 1 -``` -Invoke-GPOZaurrContent -Forest "Contoso" -IncludeDomains "Domain1", "Domain2" -Type "Security" -OutputType "HTML" -OutputPath "C:\Reports\GPOReport.html" -Retrieves security-related Group Policy Objects information for the specified domains and saves the output as an HTML file. -``` - -### EXAMPLE 2 -``` -Invoke-GPOZaurrContent -GPOPath "CN={31B2F340-016D-11D2-945F-00C04FB984F9},CN=Policies,CN=System,DC=Contoso,DC=com" -Type "All" -OutputType "Object" -Retrieves all information for a specific Group Policy Object and outputs the result as an object. -``` - -### EXAMPLE 3 -``` -Invoke-GPOZaurrContent -GPOName "Group Policy Test" -SingleObject | ConvertTo-Json -Depth 3 -Quickly view GPO settings by name in JSON format for easy inspection. -``` - -## PARAMETERS - -### -Forest -Specifies the forest name to search for Group Policy Objects. - -```yaml -Type: String -Parameter Sets: Default -Aliases: ForestName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -Specifies an array of domains to exclude from the search. - -```yaml -Type: String[] -Parameter Sets: Default -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -Specifies an array of domains to include in the search. - -```yaml -Type: String[] -Parameter Sets: Default -Aliases: Domain, Domains - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -Specifies additional information about the forest. - -```yaml -Type: IDictionary -Parameter Sets: Default -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOPath -Specifies the path to a specific Group Policy Object. - -```yaml -Type: String -Parameter Sets: Local -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of information to retrieve. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Splitter -Specifies the delimiter to use for splitting information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: [System.Environment]::NewLine -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FullObjects -Indicates whether to retrieve full objects. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputType -Specifies the type of output (HTML or Object). - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Object -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputPath -Specifies the path to save the output. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Open -Indicates whether to open the output after retrieval. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Online -Indicates whether to retrieve information online. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CategoriesOnly -Indicates whether to retrieve only categories. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SingleObject -When enabled, returns a single consolidated object per GPO rather than multiple objects for each setting. For example, with drive mappings, instead of returning separate objects for each mapped drive in a GPO, it will return one object containing all drive mappings for that GPO. This affects how the data is structured in the output reports. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipNormalize -Indicates whether to skip normalization. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipCleanup -Indicates whether to skip cleanup of the output hashtable. When enabled, empty values in the output hashtable are preserved rather than being removed via Remove-EmptyValue. This parameter affects the final processing step before returning GPO analysis results. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Extended -When enabled, returns the complete output hashtable containing all GPO analysis data, including both the processed reports and raw categories. By default, only the processed reports are returned. This parameter is useful for debugging or when you need access to the underlying data structure. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOName -Specifies the name of the Group Policy Object to retrieve. The alias of this parameter is `Name`. - -```yaml -Type: String[] -Parameter Sets: Default -Aliases: Name - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOGUID -Specifies one or more Group Policy Object GUIDs to retrieve. This parameter allows you to target specific GPOs by their unique identifier rather than display name. - - -```yaml -Type: String[] -Parameter Sets: Default -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -Specifies the action to take when progress is reported. - -```yaml -Type: ActionPreference -Parameter Sets: (All) -Aliases: proga - -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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Invoke-GPOZaurrContent +## SYNOPSIS +Invokes GPOZaurrContent function to retrieve Group Policy Objects information. + +## SYNTAX +### Default (Default) +```powershell +Invoke-GPOZaurrContent [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-Type ] [-Splitter ] [-FullObjects] [-OutputType ] [-OutputPath ] [-Open] [-Online] [-CategoriesOnly] [-SingleObject] [-SkipNormalize] [-SkipCleanup] [-Extended] [-GPOName ] [-GPOGUID ] [] +``` + +### Local +```powershell +Invoke-GPOZaurrContent [-GPOPath ] [-Type ] [-Splitter ] [-FullObjects] [-OutputType ] [-OutputPath ] [-Open] [-Online] [-CategoriesOnly] [-SingleObject] [-SkipNormalize] [-SkipCleanup] [-Extended] [] +``` + +## DESCRIPTION +This function retrieves Group Policy Objects information based on the specified parameters. It can search for GPOs in a forest, exclude specific domains, include specific domains, and provide extended forest information. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Invoke-GPOZaurrContent -Forest "Contoso" -IncludeDomains "Domain1", "Domain2" -Type "Security" -OutputType "HTML" -OutputPath "C:\Reports\GPOReport.html" +Retrieves security-related Group Policy Objects information for the specified domains and saves the output as an HTML file. +``` + + +### EXAMPLE 2 +```powershell +PS > Invoke-GPOZaurrContent -GPOPath "CN={31B2F340-016D-11D2-945F-00C04FB984F9},CN=Policies,CN=System,DC=Contoso,DC=com" -Type "All" -OutputType "Object" +Retrieves all information for a specific Group Policy Object and outputs the result as an object. +``` + + +### EXAMPLE 3 +```powershell +PS > Invoke-GPOZaurrContent -GPOName "Group Policy Test" -SingleObject | ConvertTo-Json -Depth 3 +Quickly view GPO settings by name in JSON format for easy inspection. +``` + + +## PARAMETERS + +### -CategoriesOnly +Indicates whether to retrieve only categories. + +```yaml +Type: SwitchParameter +Parameter Sets: Default, Local +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeDomains +Specifies an array of domains to exclude from the search. + +```yaml +Type: String[] +Parameter Sets: Default +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Extended +{{ Fill Extended Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Default, Local +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Specifies additional information about the forest. + +```yaml +Type: IDictionary +Parameter Sets: Default +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Specifies the forest name to search for Group Policy Objects. + +```yaml +Type: String +Parameter Sets: Default +Aliases: ForestName +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -FullObjects +Indicates whether to retrieve full objects. + +```yaml +Type: SwitchParameter +Parameter Sets: Default, Local +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOGUID +{{ Fill GPOGUID Description }} + +```yaml +Type: String[] +Parameter Sets: Default +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOName +{{ Fill GPOName Description }} + +```yaml +Type: String[] +Parameter Sets: Default +Aliases: Name +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOPath +Specifies the path to a specific Group Policy Object. + +```yaml +Type: String +Parameter Sets: Local +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Specifies an array of domains to include in the search. + +```yaml +Type: String[] +Parameter Sets: Default +Aliases: Domain, Domains +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Online +Indicates whether to retrieve information online. + +```yaml +Type: SwitchParameter +Parameter Sets: Default, Local +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Open +Indicates whether to open the output after retrieval. + +```yaml +Type: SwitchParameter +Parameter Sets: Default, Local +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -OutputPath +Specifies the path to save the output. + +```yaml +Type: String +Parameter Sets: Default, Local +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -OutputType +Specifies the type of output (HTML or Object). + +```yaml +Type: String[] +Parameter Sets: Default, Local +Aliases: +Possible values: HTML, Object + +Required: False +Position: named +Default value: Object +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -SingleObject +Indicates whether to retrieve a single object. + +```yaml +Type: SwitchParameter +Parameter Sets: Default, Local +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -SkipCleanup +{{ Fill SkipCleanup Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Default, Local +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -SkipNormalize +Indicates whether to skip normalization. + +```yaml +Type: SwitchParameter +Parameter Sets: Default, Local +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Splitter +Specifies the delimiter to use for splitting information. + +```yaml +Type: String +Parameter Sets: Default, Local +Aliases: +Possible values: + +Required: False +Position: named +Default value: [System.Environment]::NewLine +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Type +Specifies the type of information to retrieve. + +```yaml +Type: String[] +Parameter Sets: Default, Local +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +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 + diff --git a/Docs/Invoke-GPOZaurrPermission.md b/Docs/Invoke-GPOZaurrPermission.md index 4399fa8..012d765 100644 --- a/Docs/Invoke-GPOZaurrPermission.md +++ b/Docs/Invoke-GPOZaurrPermission.md @@ -1,462 +1,43 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Invoke-GPOZaurrPermission - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -### Level -``` -Invoke-GPOZaurrPermission [[-PermissionRules] ] -Level -Limit [-Type ] - [-ApprovedGroups ] [-Trustee ] [-TrusteePermissionType ] - [-TrusteeType ] [-GPOCache ] [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [-ExtendedForestInformation ] [-LimitAdministrativeGroupsToDomain] - [-WhatIf] [-Confirm] [] -``` - -### Linked -``` -Invoke-GPOZaurrPermission [[-PermissionRules] ] -Linked [-Type ] - [-ApprovedGroups ] [-Trustee ] [-TrusteePermissionType ] - [-TrusteeType ] [-GPOCache ] [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [-ExtendedForestInformation ] [-LimitAdministrativeGroupsToDomain] - [-SkipDuplicates] [-WhatIf] [-Confirm] [] -``` - -### ADObject -``` -Invoke-GPOZaurrPermission [[-PermissionRules] ] -ADObject [-Type ] - [-ApprovedGroups ] [-Trustee ] [-TrusteePermissionType ] - [-TrusteeType ] [-GPOCache ] [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [-ExtendedForestInformation ] [-LimitAdministrativeGroupsToDomain] - [-SkipDuplicates] [-WhatIf] [-Confirm] [] -``` - -### Filter -``` -Invoke-GPOZaurrPermission [[-PermissionRules] ] [-Filter ] [-SearchBase ] - [-SearchScope ] [-Type ] [-ApprovedGroups ] [-Trustee ] - [-TrusteePermissionType ] [-TrusteeType ] [-GPOCache ] - [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] - [-ExtendedForestInformation ] [-LimitAdministrativeGroupsToDomain] [-SkipDuplicates] [-WhatIf] - [-Confirm] [] -``` - -### GPOName -``` -Invoke-GPOZaurrPermission [[-PermissionRules] ] [-GPOName ] [-Type ] - [-ApprovedGroups ] [-Trustee ] [-TrusteePermissionType ] - [-TrusteeType ] [-GPOCache ] [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [-ExtendedForestInformation ] [-LimitAdministrativeGroupsToDomain] - [-SkipDuplicates] [-WhatIf] [-Confirm] [] -``` - -### GPOGUID -``` -Invoke-GPOZaurrPermission [[-PermissionRules] ] [-GPOGuid ] [-Type ] - [-ApprovedGroups ] [-Trustee ] [-TrusteePermissionType ] - [-TrusteeType ] [-GPOCache ] [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [-ExtendedForestInformation ] [-LimitAdministrativeGroupsToDomain] - [-SkipDuplicates] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -ADObject -{{ Fill ADObject Description }} - -```yaml -Type: ADObject[] -Parameter Sets: ADObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ApprovedGroups -{{ Fill ApprovedGroups Description }} - -```yaml -Type: Array -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -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: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOCache -{{ Fill GPOCache Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOGuid -{{ Fill GPOGuid Description }} - -```yaml -Type: String -Parameter Sets: GPOGUID -Aliases: GUID, GPOID - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOName -{{ Fill GPOName Description }} - -```yaml -Type: String -Parameter Sets: GPOName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Level -{{ Fill Level Description }} - -```yaml -Type: Int32 -Parameter Sets: Level -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Limit -{{ Fill Limit Description }} - -```yaml -Type: Int32 -Parameter Sets: Level -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LimitAdministrativeGroupsToDomain -{{ Fill LimitAdministrativeGroupsToDomain Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Linked -{{ Fill Linked Description }} - -```yaml -Type: String -Parameter Sets: Linked -Aliases: -Accepted values: Root, DomainControllers, Site, OrganizationalUnit - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermissionRules -{{ Fill PermissionRules Description }} - -```yaml -Type: ScriptBlock -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchBase -{{ Fill SearchBase Description }} - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchScope -{{ Fill SearchScope Description }} - -```yaml -Type: ADSearchScope -Parameter Sets: Filter -Aliases: -Accepted values: Base, OneLevel, Subtree - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipDuplicates -{{ Fill SkipDuplicates Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: Linked, ADObject, Filter, GPOName, GPOGUID -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Trustee -{{ Fill Trustee Description }} - -```yaml -Type: Array -Parameter Sets: (All) -Aliases: Principal - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrusteePermissionType -{{ Fill TrusteePermissionType Description }} - -```yaml -Type: GPPermissionType -Parameter Sets: (All) -Aliases: -Accepted values: None, GpoApply, GpoRead, GpoEdit, GpoEditDeleteModifySecurity, GpoCustom, WmiFilterEdit, WmiFilterFullControl, WmiFilterCustom, StarterGpoRead, StarterGpoEdit, StarterGpoFullControl, StarterGpoCustom, SomCreateWmiFilter, SomWmiFilterFullControl, SomCreateGpo, SomCreateStarterGpo, SomLogging, SomPlanning, SomLink - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrusteeType -{{ Fill TrusteeType Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: PrincipalType -Accepted values: DistinguishedName, Name, Sid - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -{{ Fill Type Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Accepted values: Unknown, NotWellKnown, NotWellKnownAdministrative, NotAdministrative, All - -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 - -### Microsoft.ActiveDirectory.Management.ADObject[] - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Invoke-GPOZaurrPermission +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX +```powershell +Invoke-GPOZaurrPermission +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +```powershell +Invoke-GPOZaurrPermission +``` + + +## 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 + +- `None` + +## RELATED LINKS + +- None + diff --git a/Docs/Invoke-GPOZaurrSupport.md b/Docs/Invoke-GPOZaurrSupport.md index e326dc7..10beaec 100644 --- a/Docs/Invoke-GPOZaurrSupport.md +++ b/Docs/Invoke-GPOZaurrSupport.md @@ -1,152 +1,164 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Invoke-GPOZaurrSupport - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Invoke-GPOZaurrSupport [[-Type] ] [[-ComputerName] ] [[-UserName] ] [[-Path] ] - [[-Splitter] ] [-PreventShow] [-Online] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -ComputerName -{{ Fill ComputerName Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Server - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Online -{{ Fill Online 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: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreventShow -{{ Fill PreventShow Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Splitter -{{ Fill Splitter Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -{{ Fill Type Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: NativeHTML, HTML, XML, Object - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserName -{{ Fill UserName Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: User - -Required: False -Position: 2 -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 - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Invoke-GPOZaurrSupport +## SYNOPSIS +Invokes GPOZaurrSupport function to retrieve Group Policy information. + +## SYNTAX +### __AllParameterSets +```powershell +Invoke-GPOZaurrSupport [[-Type] ] [[-ComputerName] ] [[-UserName] ] [[-Path] ] [[-Splitter] ] [-PreventShow] [-Online] [] +``` + +## DESCRIPTION +This function retrieves Group Policy information using either HTML, XML, or Object format. It can be run locally or on a remote computer. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Invoke-GPOZaurrSupport -Type HTML -ComputerName "RemoteComputer" -UserName "Admin" -Path (Join-Path $env:TEMP 'GPOReport.html') +Retrieves Group Policy information in HTML format from a remote computer and saves it to a specified path. +``` + + +### EXAMPLE 2 +```powershell +PS > Invoke-GPOZaurrSupport -Type XML -Path (Join-Path $env:TEMP 'GPOReport.xml') -Online +Retrieves the latest Group Policy information in XML format and saves it to a specified path. +``` + + +## PARAMETERS + +### -ComputerName +Specifies the name of the remote computer to retrieve Group Policy information from. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: Server +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Online +Runs the function online to retrieve the latest Group Policy information. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Path +Specifies the path to save the output file. If not provided, a temporary file will be created. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -PreventShow +Prevents displaying the output in the console. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Splitter +Specifies the delimiter for splitting output data. Default is a new line. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 4 +Default value: [System.Environment]::NewLine +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Type +Specifies the type of output format. Valid values are 'NativeHTML', 'HTML', 'XML', or 'Object'. Default is 'HTML'. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: NativeHTML, HTML, XML, Object + +Required: False +Position: 0 +Default value: HTML +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -UserName +Specifies the username to run the function as on the remote computer. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: User +Possible values: + +Required: False +Position: 2 +Default value: None +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 + diff --git a/Docs/New-GPOZaurrWMI.md b/Docs/New-GPOZaurrWMI.md index 1e85ba6..a175044 100644 --- a/Docs/New-GPOZaurrWMI.md +++ b/Docs/New-GPOZaurrWMI.md @@ -1,228 +1,212 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# New-GPOZaurrWMI - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -New-GPOZaurrWMI [-Name] [[-Description] ] [[-Namespace] ] [-Query] - [-SkipQueryCheck] [-Force] [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] - [[-ExtendedForestInformation] ] [-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 -``` - -### -Description -{{ Fill Description Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -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 -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -{{ Fill Name Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -{{ Fill Namespace Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Query -{{ Fill Query Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipQueryCheck -{{ Fill SkipQueryCheck 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 - -### None - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# New-GPOZaurrWMI +## SYNOPSIS +Creates a new WMI filter based on a WMI filter query. + +## SYNTAX +### __AllParameterSets +```powershell +New-GPOZaurrWMI [-Name] [[-Description] ] [[-Namespace] ] [-Query] [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [-SkipQueryCheck] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This function creates a new WMI filter in Active Directory based on a specified WMI filter query. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > New-GPOZaurrWMI -Name "TestWMIFilter1" -Query "SELECT * FROM Win32_OperatingSystem" -Force +Creates a new WMI filter named "TestWMIFilter1" targeting all Windows operating systems. +``` + + +### EXAMPLE 2 +```powershell +PS > New-GPOZaurrWMI -Name "TestWMIFilter2" -Query "SELECT * FROM Win32_Processor" -Forest "Contoso" -IncludeDomains "FinanceDomain" +Creates a new WMI filter named "TestWMIFilter2" targeting all processors in the "FinanceDomain" within the "Contoso" forest. +``` + + +## PARAMETERS + +### -Description +The description for the new WMI filter. Default is an empty string. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeDomains +An array of domains to exclude from WMI application. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Additional information about the forest for WMI customization. + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Force +Switch to force the creation of the WMI entry without confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +The forest to target for WMI creation. + +```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 +An array of domains to include for WMI application. + +```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 +``` + +### -Name +The name of the new WMI filter to be created. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Namespace +The WMI namespace to target. Default is 'root\CIMv2'. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 2 +Default value: root\CIMv2 +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Query +The WMI filter query to be applied to the WMI entry. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -SkipQueryCheck +Switch to skip the query check before creating the WMI entry. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +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 + diff --git a/Docs/Optimize-GPOZaurr.md b/Docs/Optimize-GPOZaurr.md index 369a929..9d79c90 100644 --- a/Docs/Optimize-GPOZaurr.md +++ b/Docs/Optimize-GPOZaurr.md @@ -1,234 +1,207 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Optimize-GPOZaurr - -## SYNOPSIS -Enables or disables user/computer section of group policy based on it's content. - -## SYNTAX - -### GPOName (Default) -``` -Optimize-GPOZaurr [[-ExcludeGroupPolicies] ] -GPOName [-LimitProcessing ] - [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] - [-ExtendedForestInformation ] [-WhatIf] [-Confirm] [] -``` - -### GPOGUID -``` -Optimize-GPOZaurr [[-ExcludeGroupPolicies] ] -GPOGuid [-LimitProcessing ] - [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] - [-ExtendedForestInformation ] [-WhatIf] [-Confirm] [] -``` - -### All -``` -Optimize-GPOZaurr [[-ExcludeGroupPolicies] ] [-All] [-LimitProcessing ] [-Forest ] - [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -Enables or disables user/computer section of group policy based on it's content. - -## EXAMPLES - -### EXAMPLE 1 -``` -Optimize-GPOZaurr -All -WhatIf -Verbose -LimitProcessing 2 -``` - -### EXAMPLE 2 -``` -Optimize-GPOZaurr -All -WhatIf -Verbose -LimitProcessing 2 { -``` - -Skip-GroupPolicy -Name 'TEST | Drive Mapping 1' - Skip-GroupPolicy -Name 'TEST | Drive Mapping 2' -} - -## PARAMETERS - -### -ExcludeGroupPolicies -Provide a list of group policies to skip using Skip-GroupPolicy cmdlet - -```yaml -Type: ScriptBlock -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOName -{{ Fill GPOName Description }} - -```yaml -Type: String -Parameter Sets: GPOName -Aliases: Name, DisplayName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOGuid -{{ Fill GPOGuid Description }} - -```yaml -Type: String -Parameter Sets: GPOGUID -Aliases: GUID, GPOID - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -All -{{ Fill All Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: All -Aliases: - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LimitProcessing -Allows to specify maximum number of items that will be fixed in a single run. -It doesn't affect amount of GPOs processed - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -Target different Forest, by default current forest is used - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -Exclude domain from search, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -Include only specific domains, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -Ability to provide Forest Information from another command to speed up processing - -```yaml -Type: IDictionary -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 -``` - -### -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 -``` - -### 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 - -## OUTPUTS - -## NOTES -General notes - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Optimize-GPOZaurr +## SYNOPSIS +Enables or disables user/computer section of group policy based on it's content. + +## SYNTAX +### GPOName (Default) +```powershell +Optimize-GPOZaurr [[-ExcludeGroupPolicies] ] -GPOName [-LimitProcessing ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-WhatIf] [-Confirm] [] +``` + +### GPOGUID +```powershell +Optimize-GPOZaurr [[-ExcludeGroupPolicies] ] -GPOGuid [-LimitProcessing ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-WhatIf] [-Confirm] [] +``` + +### All +```powershell +Optimize-GPOZaurr [[-ExcludeGroupPolicies] ] -All [-LimitProcessing ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Enables or disables user/computer section of group policy based on it's content. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Optimize-GPOZaurr -All -WhatIf -Verbose -LimitProcessing 2 +``` + + +### EXAMPLE 2 +```powershell +PS > Optimize-GPOZaurr -All -WhatIf -Verbose -LimitProcessing 2 { + Skip-GroupPolicy -Name 'TEST | Drive Mapping 1' + Skip-GroupPolicy -Name 'TEST | Drive Mapping 2' +} +``` + + +## PARAMETERS + +### -All +{{ Fill All Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: All +Aliases: +Possible values: + +Required: True +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: GPOName, GPOGUID, All +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeGroupPolicies +Provide a list of group policies to skip using Skip-GroupPolicy cmdlet + +```yaml +Type: ScriptBlock +Parameter Sets: GPOName, GPOGUID, All +Aliases: +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Ability to provide Forest Information from another command to speed up processing + +```yaml +Type: IDictionary +Parameter Sets: GPOName, GPOGUID, All +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Target different Forest, by default current forest is used + +```yaml +Type: String +Parameter Sets: GPOName, GPOGUID, All +Aliases: ForestName +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOGuid +{{ Fill GPOGuid Description }} + +```yaml +Type: String +Parameter Sets: GPOGUID +Aliases: GUID, GPOID +Possible values: + +Required: True +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOName +{{ Fill GPOName Description }} + +```yaml +Type: String +Parameter Sets: GPOName +Aliases: Name, DisplayName +Possible values: + +Required: True +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Include only specific domains, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: GPOName, GPOGUID, All +Aliases: Domain, Domains +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -LimitProcessing +Allows to specify maximum number of items that will be fixed in a single run. It doesn't affect amount of GPOs processed + +```yaml +Type: Int32 +Parameter Sets: GPOName, GPOGUID, All +Aliases: +Possible values: + +Required: False +Position: named +Default value: 0 +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 + diff --git a/Docs/Readme.md b/Docs/Readme.md index ce591af..ceef10f 100644 --- a/Docs/Readme.md +++ b/Docs/Readme.md @@ -1,193 +1,195 @@ ---- -Module Name: GPOZaurr -Module Guid: f7d4c9e4-0298-4f51-ad77-e8e3febebbde -Download Help Link: {{ Update Download Link }} -Help Version: {{ Please enter version of help manually (X.X.X.X) format }} -Locale: en-US ---- - -# GPOZaurr Module -## Description -{{ Fill in the Description }} - -## GPOZaurr Cmdlets -### [Add-GPOPermission](Add-GPOPermission.md) -{{ Fill in the Synopsis }} - -### [Add-GPOZaurrPermission](Add-GPOZaurrPermission.md) -{{ Fill in the Synopsis }} - -### [Backup-GPOZaurr](Backup-GPOZaurr.md) -Provides Backup functionality to Group Policies - -### [Clear-GPOZaurrSysvolDFSR](Clear-GPOZaurrSysvolDFSR.md) -{{ Fill in the Synopsis }} - -### [ConvertFrom-CSExtension](ConvertFrom-CSExtension.md) -{{ Fill in the Synopsis }} - -### [Export-GPOZaurrContent](Export-GPOZaurrContent.md) -Saves GPOs to XML or HTML files. - -### [Find-CSExtension](Find-CSExtension.md) -{{ Fill in the Synopsis }} - -### [Get-GPOZaurr](Get-GPOZaurr.md) -Gets information about all Group Policies. -Similar to what Get-GPO provides by default. - -### [Get-GPOZaurrAD](Get-GPOZaurrAD.md) -{{ Fill in the Synopsis }} - -### [Get-GPOZaurrBackupInformation](Get-GPOZaurrBackupInformation.md) -{{ Fill in the Synopsis }} - -### [Get-GPOZaurrBroken](Get-GPOZaurrBroken.md) -Detects broken or otherwise damaged Group Policies - -### [Get-GPOZaurrBrokenLink](Get-GPOZaurrBrokenLink.md) -Finds any GPO link that doesn't have a matching GPO (already removed GPO). - -### [Get-GPOZaurrDictionary](Get-GPOZaurrDictionary.md) -{{ Fill in the Synopsis }} - -### [Get-GPOZaurrDuplicateObject](Get-GPOZaurrDuplicateObject.md) -{{ Fill in the Synopsis }} - -### [Get-GPOZaurrFiles](Get-GPOZaurrFiles.md) -{{ Fill in the Synopsis }} - -### [Get-GPOZaurrFilesPolicyDefinition](Get-GPOZaurrFilesPolicyDefinition.md) -{{ Fill in the Synopsis }} - -### [Get-GPOZaurrFolders](Get-GPOZaurrFolders.md) -{{ Fill in the Synopsis }} - -### [Get-GPOZaurrInheritance](Get-GPOZaurrInheritance.md) -Short description - -### [Get-GPOZaurrLegacyFiles](Get-GPOZaurrLegacyFiles.md) -{{ Fill in the Synopsis }} - -### [Get-GPOZaurrLink](Get-GPOZaurrLink.md) -{{ Fill in the Synopsis }} - -### [Get-GPOZaurrLinkSummary](Get-GPOZaurrLinkSummary.md) -{{ Fill in the Synopsis }} - -### [Get-GPOZaurrNetLogon](Get-GPOZaurrNetLogon.md) -{{ Fill in the Synopsis }} - -### [Get-GPOZaurrOrganizationalUnit](Get-GPOZaurrOrganizationalUnit.md) -{{ Fill in the Synopsis }} - -### [Get-GPOZaurrOwner](Get-GPOZaurrOwner.md) -Gets owners of GPOs from Active Directory and SYSVOL - -### [Get-GPOZaurrPassword](Get-GPOZaurrPassword.md) -Tries to find CPassword in Group Policies or given path and translate it to readable value - -### [Get-GPOZaurrPermission](Get-GPOZaurrPermission.md) -{{ Fill in the Synopsis }} - -### [Get-GPOZaurrPermissionAnalysis](Get-GPOZaurrPermissionAnalysis.md) -{{ Fill in the Synopsis }} - -### [Get-GPOZaurrPermissionConsistency](Get-GPOZaurrPermissionConsistency.md) -{{ Fill in the Synopsis }} - -### [Get-GPOZaurrPermissionIssue](Get-GPOZaurrPermissionIssue.md) -Detects Group Policy missing Authenticated Users permission while not having higher permissions. - -### [Get-GPOZaurrPermissionRoot](Get-GPOZaurrPermissionRoot.md) -{{ Fill in the Synopsis }} - -### [Get-GPOZaurrPermissionSummary](Get-GPOZaurrPermissionSummary.md) -{{ Fill in the Synopsis }} - -### [Get-GPOZaurrSysvolDFSR](Get-GPOZaurrSysvolDFSR.md) -Gets DFSR information from the SYSVOL DFSR - -### [Get-GPOZaurrUpdates](Get-GPOZaurrUpdates.md) -Gets the list of GPOs created or updated in the last X number of days. - -### [Get-GPOZaurrWMI](Get-GPOZaurrWMI.md) -Get Group Policy WMI filter - -### [Invoke-GPOZaurr](Invoke-GPOZaurr.md) -Single cmdlet that provides 360 degree overview of Group Policies in Active Directory Forest. - -### [Invoke-GPOZaurrContent](Invoke-GPOZaurrContent.md) -{{ Fill in the Synopsis }} - -### [Invoke-GPOZaurrPermission](Invoke-GPOZaurrPermission.md) -{{ Fill in the Synopsis }} - -### [Invoke-GPOZaurrSupport](Invoke-GPOZaurrSupport.md) -{{ Fill in the Synopsis }} - -### [New-GPOZaurrWMI](New-GPOZaurrWMI.md) -{{ Fill in the Synopsis }} - -### [Optimize-GPOZaurr](Optimize-GPOZaurr.md) -Enables or disables user/computer section of group policy based on it's content. - -### [Remove-GPOPermission](Remove-GPOPermission.md) -{{ Fill in the Synopsis }} - -### [Remove-GPOZaurr](Remove-GPOZaurr.md) -{{ Fill in the Synopsis }} - -### [Remove-GPOZaurrBroken](Remove-GPOZaurrBroken.md) -Finds and removes broken Group Policies from SYSVOL or AD or both. - -### [Remove-GPOZaurrDuplicateObject](Remove-GPOZaurrDuplicateObject.md) -{{ Fill in the Synopsis }} - -### [Remove-GPOZaurrFolders](Remove-GPOZaurrFolders.md) -{{ Fill in the Synopsis }} - -### [Remove-GPOZaurrLegacyFiles](Remove-GPOZaurrLegacyFiles.md) -{{ Fill in the Synopsis }} - -### [Remove-GPOZaurrLinkEmptyOU](Remove-GPOZaurrLinkEmptyOU.md) -{{ Fill in the Synopsis }} - -### [Remove-GPOZaurrPermission](Remove-GPOZaurrPermission.md) -{{ Fill in the Synopsis }} - -### [Remove-GPOZaurrWMI](Remove-GPOZaurrWMI.md) -{{ Fill in the Synopsis }} - -### [Repair-GPOZaurrBrokenLink](Repair-GPOZaurrBrokenLink.md) -Removes any link to GPO that no longer exists. - -### [Repair-GPOZaurrNetLogonOwner](Repair-GPOZaurrNetLogonOwner.md) -Sets new owner to each file in NetLogon share. - -### [Repair-GPOZaurrPermission](Repair-GPOZaurrPermission.md) -{{ Fill in the Synopsis }} - -### [Repair-GPOZaurrPermissionConsistency](Repair-GPOZaurrPermissionConsistency.md) -{{ Fill in the Synopsis }} - -### [Restore-GPOZaurr](Restore-GPOZaurr.md) -{{ Fill in the Synopsis }} - -### [Save-GPOZaurrFiles](Save-GPOZaurrFiles.md) -Exports GPO XML data to files and saves it to a given path - -### [Set-GPOOwner](Set-GPOOwner.md) -Used within Invoke-GPOZaurrPermission only. -Set new group policy owner. - -### [Set-GPOZaurrOwner](Set-GPOZaurrOwner.md) -Sets GPO Owner to Domain Admins or other choosen account - -### [Set-GPOZaurrStatus](Set-GPOZaurrStatus.md) -Enables or disables user/computer section of Group Policy. - -### [Skip-GroupPolicy](Skip-GroupPolicy.md) -Used within ScriptBlocks only. -Allows to exclude Group Policy from being affected by fixes - +--- +Module Name: GPOZaurr +Module Guid: f7d4c9e4-0298-4f51-ad77-e8e3febebbde +Download Help Link: https://github.com/EvotecIT/GPOZaurr +Help Version: 1.1.10 +Locale: en-US +--- +# GPOZaurr Module +## Description +Group Policy Eater is a PowerShell module that aims to gather information about Group Policies but also allows fixing issues that you may find in them. + +## GPOZaurr Cmdlets +### [Add-GPOPermission](Add-GPOPermission.md) +{{ Fill in the Description }} + +### [Add-GPOZaurrPermission](Add-GPOZaurrPermission.md) +{{ Fill in the Description }} + +### [Backup-GPOZaurr](Backup-GPOZaurr.md) +Provides Backup functionality to Group Policies + +### [Clear-GPOZaurrSysvolDFSR](Clear-GPOZaurrSysvolDFSR.md) +Clears the ConflictAndDeleted folder in DFSR for specified GPOs. + +### [ConvertFrom-CSExtension](ConvertFrom-CSExtension.md) +Converts Client-side Extension (CSE) GUIDs to their corresponding names. + +### [Export-GPOZaurrContent](Export-GPOZaurrContent.md) +Exports Group Policy Objects (GPOs) to XML or HTML files. + +### [Find-CSExtension](Find-CSExtension.md) +This function retrieves Group Policy Client Side Extensions (CSEs) from a specified Windows computer. + +### [Get-GPOZaurr](Get-GPOZaurr.md) +Gets information about all Group Policies. Similar to what Get-GPO provides by default. + +### [Get-GPOZaurrAD](Get-GPOZaurrAD.md) +Retrieves Group Policy Objects (GPOs) information from Active Directory. + +### [Get-GPOZaurrBackupInformation](Get-GPOZaurrBackupInformation.md) +Retrieves backup information from GPOZaurr manifest files. + +### [Get-GPOZaurrBroken](Get-GPOZaurrBroken.md) +Detects broken or otherwise damaged Group Policies + +### [Get-GPOZaurrBrokenLink](Get-GPOZaurrBrokenLink.md) +Finds any GPO link that doesn't have a matching GPO (already removed GPO). + +### [Get-GPOZaurrDictionary](Get-GPOZaurrDictionary.md) +Retrieves a dictionary of Group Policy Objects (GPOs) with their associated types and paths. + +### [Get-GPOZaurrDuplicateObject](Get-GPOZaurrDuplicateObject.md) +Retrieves duplicate Group Policy Objects (GPOs) within a specified forest. + +### [Get-GPOZaurrFiles](Get-GPOZaurrFiles.md) +Retrieves information about Group Policy Objects (GPOs) stored in SYSVOL and NETLOGON folders. + +### [Get-GPOZaurrFilesPolicyDefinition](Get-GPOZaurrFilesPolicyDefinition.md) +Retrieves policy definitions for Group Policy Objects (GPOs) within specified domains. + +### [Get-GPOZaurrFolders](Get-GPOZaurrFolders.md) +Retrieves information about GPO folders within specified domains. + +### [Get-GPOZaurrInheritance](Get-GPOZaurrInheritance.md) +Retrieves inheritance information for Group Policy Objects (GPOs) within specified Organizational Units (OUs). + +### [Get-GPOZaurrLegacyFiles](Get-GPOZaurrLegacyFiles.md) +Retrieves legacy Group Policy Object (GPO) files from the SYSVOL directory of specified domains within a forest. + +### [Get-GPOZaurrLink](Get-GPOZaurrLink.md) +Retrieves Group Policy Object (GPO) links based on specified criteria. + +### [Get-GPOZaurrLinkSummary](Get-GPOZaurrLinkSummary.md) +Retrieves a summary of GPO links based on specified criteria. + +### [Get-GPOZaurrMissingFiles](Get-GPOZaurrMissingFiles.md) +Retrieves information about missing files in Group Policy Objects (GPOs) within a specified forest. + +### [Get-GPOZaurrNetLogon](Get-GPOZaurrNetLogon.md) +Retrieves information about Group Policy Objects (GPO) stored in the Netlogon and SYSVOL directories. + +### [Get-GPOZaurrOrganizationalUnit](Get-GPOZaurrOrganizationalUnit.md) +Retrieves information about Group Policy Objects (GPOs) linked to Organizational Units (OUs) within a specified forest. + +### [Get-GPOZaurrOwner](Get-GPOZaurrOwner.md) +Gets owners of GPOs from Active Directory and SYSVOL + +### [Get-GPOZaurrPassword](Get-GPOZaurrPassword.md) +Tries to find CPassword in Group Policies or given path and translate it to readable value + +### [Get-GPOZaurrPermission](Get-GPOZaurrPermission.md) +{{ Fill in the Description }} + +### [Get-GPOZaurrPermissionAnalysis](Get-GPOZaurrPermissionAnalysis.md) +Analyzes permissions for Group Policy Objects (GPOs) and administrative groups. + +### [Get-GPOZaurrPermissionConsistency](Get-GPOZaurrPermissionConsistency.md) +Retrieves information about Group Policy Objects (GPOs) and checks permission consistency across domains. + +### [Get-GPOZaurrPermissionIssue](Get-GPOZaurrPermissionIssue.md) +Detects Group Policy missing Authenticated Users permission while not having higher permissions. + +### [Get-GPOZaurrPermissionRoot](Get-GPOZaurrPermissionRoot.md) +Retrieves the root permissions of Group Policy Objects (GPOs) based on specified criteria. + +### [Get-GPOZaurrPermissionSummary](Get-GPOZaurrPermissionSummary.md) +Retrieves a summary of Group Policy Object (GPO) permissions based on specified criteria. + +### [Get-GPOZaurrRedirect](Get-GPOZaurrRedirect.md) +Command to detect if GPOs have correct path in SYSVOL, or someone changed it manually. + +### [Get-GPOZaurrSysvolDFSR](Get-GPOZaurrSysvolDFSR.md) +Gets DFSR information from the SYSVOL DFSR + +### [Get-GPOZaurrUpdates](Get-GPOZaurrUpdates.md) +Gets the list of GPOs created or updated in the last X number of days. + +### [Get-GPOZaurrWMI](Get-GPOZaurrWMI.md) +Get Group Policy WMI filter + +### [Invoke-GPOZaurr](Invoke-GPOZaurr.md) +Single cmdlet that provides 360 degree overview of Group Policies in Active Directory Forest. + +### [Invoke-GPOZaurrContent](Invoke-GPOZaurrContent.md) +Invokes GPOZaurrContent function to retrieve Group Policy Objects information. + +### [Invoke-GPOZaurrPermission](Invoke-GPOZaurrPermission.md) +{{ Fill in the Description }} + +### [Invoke-GPOZaurrSupport](Invoke-GPOZaurrSupport.md) +Invokes GPOZaurrSupport function to retrieve Group Policy information. + +### [New-GPOZaurrWMI](New-GPOZaurrWMI.md) +Creates a new WMI filter based on a WMI filter query. + +### [Optimize-GPOZaurr](Optimize-GPOZaurr.md) +Enables or disables user/computer section of group policy based on it's content. + +### [Remove-GPOPermission](Remove-GPOPermission.md) +{{ Fill in the Description }} + +### [Remove-GPOZaurr](Remove-GPOZaurr.md) +Removes Group Policy Objects based on specified criteria. + +### [Remove-GPOZaurrBroken](Remove-GPOZaurrBroken.md) +Finds and removes broken Group Policies from SYSVOL or AD or both. + +### [Remove-GPOZaurrDuplicateObject](Remove-GPOZaurrDuplicateObject.md) +Removes duplicate Group Policy Objects (GPOs) identified by the Get-GPOZaurrDuplicateObject function. + +### [Remove-GPOZaurrFolders](Remove-GPOZaurrFolders.md) +Removes specified GPOZaurr folders and backs them up to a specified path. + +### [Remove-GPOZaurrLegacyFiles](Remove-GPOZaurrLegacyFiles.md) +Removes legacy Group Policy Objects (GPO) files from specified domains. + +### [Remove-GPOZaurrLinkEmptyOU](Remove-GPOZaurrLinkEmptyOU.md) +Removes Group Policy Object (GPO) links from empty Organizational Units (OUs) in a specified forest. + +### [Remove-GPOZaurrPermission](Remove-GPOZaurrPermission.md) +{{ Fill in the Description }} + +### [Remove-GPOZaurrWMI](Remove-GPOZaurrWMI.md) +Removes Group Policy WMI filters based on specified criteria. + +### [Repair-GPOZaurrBrokenLink](Repair-GPOZaurrBrokenLink.md) +Removes any link to GPO that no longer exists. + +### [Repair-GPOZaurrNetLogonOwner](Repair-GPOZaurrNetLogonOwner.md) +Sets new owner to each file in NetLogon share. + +### [Repair-GPOZaurrPermission](Repair-GPOZaurrPermission.md) +Repairs permissions for Group Policy Objects (GPOs) based on specified criteria. + +### [Repair-GPOZaurrPermissionConsistency](Repair-GPOZaurrPermissionConsistency.md) +Repairs permission consistency for Group Policy Objects (GPOs) in a specified domain or forest. + +### [Restore-GPOZaurr](Restore-GPOZaurr.md) +Restores Group Policy Objects (GPOs) from a specified backup folder. + +### [Save-GPOZaurrFiles](Save-GPOZaurrFiles.md) +Exports GPO XML data to files and saves it to a given path + +### [Set-GPOOwner](Set-GPOOwner.md) +Used within Invoke-GPOZaurrPermission only. Set new group policy owner. + +### [Set-GPOZaurrOwner](Set-GPOZaurrOwner.md) +Sets GPO Owner to Domain Admins or other choosen account + +### [Set-GPOZaurrStatus](Set-GPOZaurrStatus.md) +{{ Fill in the Description }} + +### [Skip-GroupPolicy](Skip-GroupPolicy.md) +Used within ScriptBlocks only. Allows to exclude Group Policy from being affected by fixes + diff --git a/Docs/Remove-GPOPermission.md b/Docs/Remove-GPOPermission.md index 1041422..1c8bb3b 100644 --- a/Docs/Remove-GPOPermission.md +++ b/Docs/Remove-GPOPermission.md @@ -1,174 +1,43 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Remove-GPOPermission - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Remove-GPOPermission [[-Type] ] [[-IncludePermissionType] ] - [[-ExcludePermissionType] ] [[-PermitType] ] [[-Principal] ] - [[-PrincipalType] ] [[-ExcludePrincipal] ] [[-ExcludePrincipalType] ] - [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -ExcludePermissionType -{{ Fill ExcludePermissionType Description }} - -```yaml -Type: GPPermissionType[] -Parameter Sets: (All) -Aliases: -Accepted values: None, GpoApply, GpoRead, GpoEdit, GpoEditDeleteModifySecurity, GpoCustom, WmiFilterEdit, WmiFilterFullControl, WmiFilterCustom, StarterGpoRead, StarterGpoEdit, StarterGpoFullControl, StarterGpoCustom, SomCreateWmiFilter, SomWmiFilterFullControl, SomCreateGpo, SomCreateStarterGpo, SomLogging, SomPlanning, SomLink - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludePrincipal -{{ Fill ExcludePrincipal Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludePrincipalType -{{ Fill ExcludePrincipalType Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: DistinguishedName, Name, Sid - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludePermissionType -{{ Fill IncludePermissionType Description }} - -```yaml -Type: GPPermissionType[] -Parameter Sets: (All) -Aliases: -Accepted values: None, GpoApply, GpoRead, GpoEdit, GpoEditDeleteModifySecurity, GpoCustom, WmiFilterEdit, WmiFilterFullControl, WmiFilterCustom, StarterGpoRead, StarterGpoEdit, StarterGpoFullControl, StarterGpoCustom, SomCreateWmiFilter, SomWmiFilterFullControl, SomCreateGpo, SomCreateStarterGpo, SomLogging, SomPlanning, SomLink - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermitType -{{ Fill PermitType Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Allow, Deny, All - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Principal -{{ Fill Principal Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrincipalType -{{ Fill PrincipalType Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: DistinguishedName, Name, Sid - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -{{ Fill Type Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Accepted values: Unknown, NotWellKnown, NotWellKnownAdministrative, Administrative, NotAdministrative, All - -Required: False -Position: 0 -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 - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Remove-GPOPermission +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX +```powershell +Remove-GPOPermission +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +```powershell +Remove-GPOPermission +``` + + +## 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 + +- `None` + +## RELATED LINKS + +- None + diff --git a/Docs/Remove-GPOZaurr.md b/Docs/Remove-GPOZaurr.md index 92d620f..3e9526c 100644 --- a/Docs/Remove-GPOZaurr.md +++ b/Docs/Remove-GPOZaurr.md @@ -1,245 +1,228 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Remove-GPOZaurr - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Remove-GPOZaurr [[-ExcludeGroupPolicies] ] [-Type] [-LimitProcessing ] - [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] - [-ExtendedForestInformation ] [-GPOPath ] [-BackupPath ] [-BackupDated] - [-RequireDays ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -BackupDated -{{ Fill BackupDated Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackupPath -{{ Fill BackupPath Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeGroupPolicies -{{ Fill ExcludeGroupPolicies Description }} - -```yaml -Type: ScriptBlock -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOPath -{{ Fill GPOPath Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LimitProcessing -{{ Fill LimitProcessing Description }} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireDays -{{ Fill RequireDays Description }} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -{{ Fill Type Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Accepted values: Empty, Unlinked, Disabled, NoApplyPermission - -Required: True -Position: 0 -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 - -### None - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Remove-GPOZaurr +## SYNOPSIS +Removes Group Policy Objects based on specified criteria. + +## SYNTAX +### __AllParameterSets +```powershell +Remove-GPOZaurr [-Type] [[-ExcludeGroupPolicies] ] [-LimitProcessing ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-GPOPath ] [-BackupPath ] [-BackupDated] [-RequireDays ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Remove-GPOZaurr function removes Group Policy Objects (GPOs) based on the specified criteria. It allows for filtering by various parameters such as GPO type, forest, domains, and more. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Remove-GPOZaurr -Type 'Empty' -Forest 'Contoso' -IncludeDomains 'Domain1', 'Domain2' -BackupPath 'C:\GPOBackups' -BackupDated -RequireDays 7 +Removes all empty GPOs from the 'Contoso' forest for 'Domain1' and 'Domain2', backs them up to 'C:\GPOBackups' with dated folders, and requires removal after 7 days. +``` + + +### EXAMPLE 2 +```powershell +PS > Remove-GPOZaurr -Type 'Disabled' -Forest 'Fabrikam' -ExcludeDomains 'Domain3' -LimitProcessing 10 +Removes all disabled GPOs from the 'Fabrikam' forest excluding 'Domain3' and processes only the first 10 GPOs. +``` + + +## PARAMETERS + +### -BackupDated +Indicates whether the backup should be dated. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -BackupPath +Specifies the path for backing up GPOs before removal. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeDomains +Specifies the domains to exclude from GPO removal. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeGroupPolicies +Specifies the Group Policies to exclude from removal. + +```yaml +Type: ScriptBlock +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Specifies additional information about the forest. + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Specifies the forest to target for GPO removal. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOPath +Specifies the path to the GPOs to be removed. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Specifies the domains to include for GPO removal. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -LimitProcessing +Specifies the maximum number of GPOs to process before stopping. + +```yaml +Type: Int32 +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -RequireDays +Specifies the number of days before GPO removal is required. + +```yaml +Type: Int32 +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Type +Specifies the type of GPOs to target for removal. Valid values are 'Empty', 'Unlinked', 'Disabled', 'NoApplyPermission'. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: Empty, Unlinked, Disabled, NoApplyPermission + +Required: True +Position: 0 +Default value: None +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 + diff --git a/Docs/Remove-GPOZaurrBroken.md b/Docs/Remove-GPOZaurrBroken.md index 7f7e677..6500991 100644 --- a/Docs/Remove-GPOZaurrBroken.md +++ b/Docs/Remove-GPOZaurrBroken.md @@ -1,210 +1,187 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Remove-GPOZaurrBroken - -## SYNOPSIS -Finds and removes broken Group Policies from SYSVOL or AD or both. - -## SYNTAX - -``` -Remove-GPOZaurrBroken [-Type] [-BackupPath ] [-BackupDated] [-LimitProcessing ] - [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] - [-ExtendedForestInformation ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Finds and removes broken Group Policies from SYSVOL or AD or both. -Assesment is based on Get-GPOZaurrBroken and there are 3 supported types: +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Remove-GPOZaurrBroken +## SYNOPSIS +Finds and removes broken Group Policies from SYSVOL or AD or both. + +## SYNTAX +### __AllParameterSets +```powershell +Remove-GPOZaurrBroken [-Type] [-BackupPath ] [-BackupDated] [-LimitProcessing ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Finds and removes broken Group Policies from SYSVOL or AD or both. Assesment is based on Get-GPOZaurrBroken and there are 3 supported types: - AD - meaning GPOs which have no SYSVOL content will be deleted from AD - SYSVOL - meaning GPOs which have no AD content will be deleted from SYSVOL -- ObjectClass - meaning GPOs which have ObjectClass category of Container rather than groupPolicyContainer will be deleted from AD & SYSVOL - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-GPOZaurrBroken -Verbose -WhatIf -Type AD, SYSVOL -``` - -### EXAMPLE 2 -``` -Remove-GPOZaurrBroken -Verbose -WhatIf -Type AD, SYSVOL -IncludeDomains 'ad.evotec.pl' -LimitProcessing 2 -``` - -### EXAMPLE 3 -``` -Remove-GPOZaurrBroken -Verbose -IncludeDomains 'ad.evotec.xyz' -BackupPath $Env:UserProfile\Desktop\MyBackup1 -WhatIf -Type AD, SYSVOL -``` - -## PARAMETERS - -### -Type -Choose one or more types to delete. -Options are AD, ObjectClass, SYSVOL - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackupPath -Path to optional backup of SYSVOL content before deletion - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackupDated -Forces backup to be created within folder that has date in it - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LimitProcessing -Allows to specify maximum number of items that will be fixed in a single run. -It doesn't affect amount of GPOs processed - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 2147483647 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -Target different Forest, by default current forest is used - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -Exclude domain from search, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -Include only specific domains, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -Ability to provide Forest Information from another command to speed up processing - -```yaml -Type: IDictionary -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 -``` - -### -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 -``` - -### 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 - -## OUTPUTS - -## NOTES -General notes - -## RELATED LINKS +- ObjectClass - meaning GPOs which have ObjectClass category of Container rather than groupPolicyContainer will be deleted from AD & SYSVOL + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Remove-GPOZaurrBroken -Verbose -WhatIf -Type AD, SYSVOL +``` + + +### EXAMPLE 2 +```powershell +PS > Remove-GPOZaurrBroken -Verbose -WhatIf -Type AD, SYSVOL -IncludeDomains 'ad.evotec.pl' -LimitProcessing 2 +``` + + +### EXAMPLE 3 +```powershell +PS > Remove-GPOZaurrBroken -Verbose -IncludeDomains 'ad.evotec.xyz' -BackupPath $Env:UserProfile\Desktop\MyBackup1 -WhatIf -Type AD, SYSVOL +``` + + +## PARAMETERS + +### -BackupDated +Forces backup to be created within folder that has date in it + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -BackupPath +Path to optional backup of SYSVOL content before deletion + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Ability to provide Forest Information from another command to speed up processing + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Target different Forest, by default current forest is used + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Include only specific domains, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -LimitProcessing +Allows to specify maximum number of items that will be fixed in a single run. It doesn't affect amount of GPOs processed + +```yaml +Type: Int32 +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: 2147483647 +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Type +Choose one or more types to delete. Options are AD, ObjectClass, SYSVOL + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: SYSVOL, AD, ObjectClass + +Required: True +Position: 0 +Default value: None +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 + diff --git a/Docs/Remove-GPOZaurrDuplicateObject.md b/Docs/Remove-GPOZaurrDuplicateObject.md index 476fdab..ccdf496 100644 --- a/Docs/Remove-GPOZaurrDuplicateObject.md +++ b/Docs/Remove-GPOZaurrDuplicateObject.md @@ -1,153 +1,126 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Remove-GPOZaurrDuplicateObject - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Remove-GPOZaurrDuplicateObject [[-LimitProcessing] ] [[-Forest] ] [[-ExcludeDomains] ] - [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [-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 -``` - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LimitProcessing -{{ Fill LimitProcessing Description }} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -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 - -### None - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Remove-GPOZaurrDuplicateObject +## SYNOPSIS +Removes duplicate Group Policy Objects (GPOs) identified by the Get-GPOZaurrDuplicateObject function. + +## SYNTAX +### __AllParameterSets +```powershell +Remove-GPOZaurrDuplicateObject [[-LimitProcessing] ] [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This function removes duplicate GPOs based on the criteria provided. It retrieves duplicate GPO objects using Get-GPOZaurrDuplicateObject and then attempts to remove them from the Active Directory. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Remove-GPOZaurrDuplicateObject -Forest "contoso.com" -IncludeDomains "domain1.com", "domain2.com" -ExcludeDomains "domain3.com" -LimitProcessing 5 +``` + +Description: +Removes duplicate GPOs from the forest "contoso.com" for domains "domain1.com" and "domain2.com", excluding "domain3.com", processing only the first 5 duplicates. + +## PARAMETERS + +### -ExcludeDomains +Specifies an array of domains to exclude from the duplicate GPO removal process. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Specifies additional information about the forest. + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Specifies the forest where the duplicate GPOs are located. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Specifies an array of domains to include in the duplicate GPO removal process. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -LimitProcessing +Specifies the maximum number of duplicate GPOs to process. Default is set to [int32]::MaxValue. + +```yaml +Type: Int32 +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 0 +Default value: 2147483647 +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 + diff --git a/Docs/Remove-GPOZaurrFolders.md b/Docs/Remove-GPOZaurrFolders.md index 6e353b9..13cde25 100644 --- a/Docs/Remove-GPOZaurrFolders.md +++ b/Docs/Remove-GPOZaurrFolders.md @@ -1,231 +1,205 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Remove-GPOZaurrFolders - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Remove-GPOZaurrFolders [[-BackupPath] ] [-BackupDated] [[-Type] ] [-FolderType] - [[-FolderName] ] [[-LimitProcessing] ] [[-Forest] ] [[-ExcludeDomains] ] - [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -BackupDated -{{ Fill BackupDated Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackupPath -{{ Fill BackupPath Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FolderName -{{ Fill FolderName Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FolderType -{{ Fill FolderType Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: NTFRS, Empty - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LimitProcessing -{{ Fill LimitProcessing Description }} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -{{ Fill Type Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Accepted values: All, Netlogon, Sysvol - -Required: False -Position: 1 -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 - -### None - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Remove-GPOZaurrFolders +## SYNOPSIS +Removes specified GPOZaurr folders and backs them up to a specified path. + +## SYNTAX +### __AllParameterSets +```powershell +Remove-GPOZaurrFolders [[-BackupPath] ] [[-Type] ] [-FolderType] [[-FolderName] ] [[-LimitProcessing] ] [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [-BackupDated] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This function removes specified GPOZaurr folders based on the provided criteria and backs them up to a specified path. It allows for filtering by folder type, domain, and other parameters. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Remove-GPOZaurrFolders -BackupPath "C:\Backups" -BackupDated -Type 'All' -FolderType 'NTFRS' -FolderName "Folder1" -LimitProcessing 10 -Forest "ExampleForest" -ExcludeDomains "Domain1" -IncludeDomains "Domain2" -ExtendedForestInformation $info +Removes GPOZaurr folders of type 'NTFRS' named "Folder1" from all domains in the forest "ExampleForest", backs them up to "C:\Backups" with a timestamp, and limits processing to 10 folders. +``` + + +## PARAMETERS + +### -BackupDated +Indicates whether the backup path should include a timestamp. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -BackupPath +The path where the GPOZaurr folders will be backed up. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeDomains +Specifies domains to exclude from processing. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Specifies additional forest information. + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -FolderName +Specifies the name of the folder to remove. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -FolderType +Specifies the type of folders to remove. Options are 'NTFRS' or 'Empty'. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: NTFRS, Empty + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Specifies the forest to target. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Specifies domains to include in processing. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -LimitProcessing +Limits the number of folders to process. + +```yaml +Type: Int32 +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 4 +Default value: 2147483647 +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Type +Specifies the type of folders to remove. Options are 'All', 'Netlogon', or 'Sysvol'. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: All, Netlogon, Sysvol + +Required: False +Position: 1 +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 + diff --git a/Docs/Remove-GPOZaurrLegacyFiles.md b/Docs/Remove-GPOZaurrLegacyFiles.md index f3c41fc..b205cdd 100644 --- a/Docs/Remove-GPOZaurrLegacyFiles.md +++ b/Docs/Remove-GPOZaurrLegacyFiles.md @@ -1,183 +1,157 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Remove-GPOZaurrLegacyFiles - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Remove-GPOZaurrLegacyFiles [[-BackupPath] ] [-BackupDated] [-RemoveEmptyFolders] [[-Forest] ] - [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-LimitProcessing] ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -BackupDated -{{ Fill BackupDated Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackupPath -{{ Fill BackupPath Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -``` - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LimitProcessing -{{ Fill LimitProcessing Description }} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveEmptyFolders -{{ Fill RemoveEmptyFolders 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 - -### None - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Remove-GPOZaurrLegacyFiles +## SYNOPSIS +Removes legacy Group Policy Objects (GPO) files from specified domains. + +## SYNTAX +### __AllParameterSets +```powershell +Remove-GPOZaurrLegacyFiles [[-BackupPath] ] [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-LimitProcessing] ] [-BackupDated] [-RemoveEmptyFolders] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Remove-GPOZaurrLegacyFiles function removes legacy GPO files from specified domains. It can back up the files before removal and optionally remove empty folders. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Remove-GPOZaurrLegacyFiles -BackupPath "C:\GPOBackups" -BackupDated -RemoveEmptyFolders -Forest "Contoso" -IncludeDomains "Domain1", "Domain2" -ExcludeDomains "Domain3" -LimitProcessing 100 +Removes legacy GPO files from the "Contoso" forest for "Domain1" and "Domain2", excluding "Domain3". Backs up files to "C:\GPOBackups" with timestamps and removes empty folders after deletion. +``` + + +## PARAMETERS + +### -BackupDated +Indicates whether backup files should be timestamped with the current date and time. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -BackupPath +Specifies the path where backup files will be stored. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeDomains +Specifies an array of domains to exclude from processing. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Specifies the forest where the GPO files are located. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Specifies an array of domains to include for processing. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -LimitProcessing +Specifies the maximum number of GPO files to process. + +```yaml +Type: Int32 +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 4 +Default value: 2147483647 +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -RemoveEmptyFolders +Indicates whether empty folders should be removed after GPO files are deleted. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +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 + diff --git a/Docs/Remove-GPOZaurrLinkEmptyOU.md b/Docs/Remove-GPOZaurrLinkEmptyOU.md index 0265aa9..565a346 100644 --- a/Docs/Remove-GPOZaurrLinkEmptyOU.md +++ b/Docs/Remove-GPOZaurrLinkEmptyOU.md @@ -1,168 +1,141 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Remove-GPOZaurrLinkEmptyOU - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Remove-GPOZaurrLinkEmptyOU [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] - [[-ExtendedForestInformation] ] [[-ExcludeOrganizationalUnit] ] - [[-LimitProcessing] ] [-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 -``` - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeOrganizationalUnit -{{ Fill ExcludeOrganizationalUnit Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LimitProcessing -{{ Fill LimitProcessing Description }} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -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 - -### None - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Remove-GPOZaurrLinkEmptyOU +## SYNOPSIS +Removes Group Policy Object (GPO) links from empty Organizational Units (OUs) in a specified forest. + +## SYNTAX +### __AllParameterSets +```powershell +Remove-GPOZaurrLinkEmptyOU [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [[-ExcludeOrganizationalUnit] ] [[-LimitProcessing] ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This function removes GPO links from OUs that are empty and meet specified criteria. It processes OUs within the specified forest based on inclusion and exclusion rules. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Remove-GPOZaurrLinkEmptyOU -Forest "ContosoForest" -IncludeDomains @("domain1", "domain2") -ExcludeDomains @("domain3") -ExtendedForestInformation $info -ExcludeOrganizationalUnit @("OU=TestOU,DC=contoso,DC=com") -LimitProcessing 100 +Removes GPO links from empty OUs in the "ContosoForest" forest, including domains "domain1" and "domain2" but excluding "domain3". Additional forest information is provided, and processing is limited to 100 OUs. +``` + + +## PARAMETERS + +### -ExcludeDomains +Specifies an array of domains to exclude from processing. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeOrganizationalUnit +Specifies an array of OUs to exclude from processing. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Specifies additional information about the forest. + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Specifies the name of the forest to target for processing. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Specifies an array of domains to include for processing. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -LimitProcessing +Specifies the maximum number of OUs to process. + +```yaml +Type: Int32 +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 5 +Default value: 2147483647 +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 + diff --git a/Docs/Remove-GPOZaurrPermission.md b/Docs/Remove-GPOZaurrPermission.md index 29b6c0f..cdd41fa 100644 --- a/Docs/Remove-GPOZaurrPermission.md +++ b/Docs/Remove-GPOZaurrPermission.md @@ -1,313 +1,43 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Remove-GPOZaurrPermission - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -### Global (Default) -``` -Remove-GPOZaurrPermission [-Principal ] [-PrincipalType ] [-Type ] - [-IncludePermissionType ] [-ExcludePermissionType ] [-SkipWellKnown] - [-SkipAdministrative] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] - [-ExtendedForestInformation ] [-LimitProcessing ] [-WhatIf] [-Confirm] - [] -``` - -### GPOName -``` -Remove-GPOZaurrPermission -GPOName [-Principal ] [-PrincipalType ] - [-Type ] [-IncludePermissionType ] [-ExcludePermissionType ] - [-SkipWellKnown] [-SkipAdministrative] [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [-ExtendedForestInformation ] [-LimitProcessing ] [-WhatIf] - [-Confirm] [] -``` - -### GPOGUID -``` -Remove-GPOZaurrPermission -GPOGuid [-Principal ] [-PrincipalType ] - [-Type ] [-IncludePermissionType ] [-ExcludePermissionType ] - [-SkipWellKnown] [-SkipAdministrative] [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [-ExtendedForestInformation ] [-LimitProcessing ] [-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 -``` - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludePermissionType -{{ Fill ExcludePermissionType Description }} - -```yaml -Type: GPPermissionType[] -Parameter Sets: (All) -Aliases: -Accepted values: None, GpoApply, GpoRead, GpoEdit, GpoEditDeleteModifySecurity, GpoCustom, WmiFilterEdit, WmiFilterFullControl, WmiFilterCustom, StarterGpoRead, StarterGpoEdit, StarterGpoFullControl, StarterGpoCustom, SomCreateWmiFilter, SomWmiFilterFullControl, SomCreateGpo, SomCreateStarterGpo, SomLogging, SomPlanning, SomLink - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOGuid -{{ Fill GPOGuid Description }} - -```yaml -Type: String -Parameter Sets: GPOGUID -Aliases: GUID, GPOID - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOName -{{ Fill GPOName Description }} - -```yaml -Type: String -Parameter Sets: GPOName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludePermissionType -{{ Fill IncludePermissionType Description }} - -```yaml -Type: GPPermissionType[] -Parameter Sets: (All) -Aliases: PermissionType -Accepted values: None, GpoApply, GpoRead, GpoEdit, GpoEditDeleteModifySecurity, GpoCustom, WmiFilterEdit, WmiFilterFullControl, WmiFilterCustom, StarterGpoRead, StarterGpoEdit, StarterGpoFullControl, StarterGpoCustom, SomCreateWmiFilter, SomWmiFilterFullControl, SomCreateGpo, SomCreateStarterGpo, SomLogging, SomPlanning, SomLink - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LimitProcessing -{{ Fill LimitProcessing Description }} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Principal -{{ Fill Principal Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrincipalType -{{ Fill PrincipalType Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: DistinguishedName, Name, NetbiosName, Sid - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipAdministrative -{{ Fill SkipAdministrative Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipWellKnown -{{ Fill SkipWellKnown Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -{{ Fill Type Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Accepted values: Unknown, NotAdministrative, Default - -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 - -### None - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Remove-GPOZaurrPermission +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX +```powershell +Remove-GPOZaurrPermission +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +```powershell +Remove-GPOZaurrPermission +``` + + +## 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 + +- `None` + +## RELATED LINKS + +- None + diff --git a/Docs/Remove-GPOZaurrWMI.md b/Docs/Remove-GPOZaurrWMI.md index 6622caf..5561223 100644 --- a/Docs/Remove-GPOZaurrWMI.md +++ b/Docs/Remove-GPOZaurrWMI.md @@ -1,168 +1,152 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Remove-GPOZaurrWMI - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Remove-GPOZaurrWMI [[-Guid] ] [[-Name] ] [[-Forest] ] [[-ExcludeDomains] ] - [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [-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 -``` - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Guid -{{ Fill Guid Description }} - -```yaml -Type: Guid[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -{{ Fill Name Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -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 - -### None - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Remove-GPOZaurrWMI +## SYNOPSIS +Removes Group Policy WMI filters based on specified criteria. + +## SYNTAX +### __AllParameterSets +```powershell +Remove-GPOZaurrWMI [[-Guid] ] [[-Name] ] [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This function removes WMI filters based on the provided GUIDs or names within the specified forest or domains. It retrieves WMI filters associated with the GPOs and removes them. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Remove-GPOZaurrWMI -Guid "12345678-1234-1234-1234-123456789012" +``` + +Description +----------- +Removes the WMI filter with the specified GUID. + +### EXAMPLE 2 +```powershell +PS > Remove-GPOZaurrWMI -Name "TestWMIFilter" +``` + +Description +----------- +Removes the WMI filter with the specified name. + +## PARAMETERS + +### -ExcludeDomains +Specifies an array of domains to exclude from the removal process. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Specifies additional information about the forest. + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Specifies the forest name where the WMI filters are located. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Guid +Specifies an array of GUIDs of the WMI filters to be removed. + +```yaml +Type: Guid[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Specifies an array of domains to include in the removal process. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Name +Specifies an array of names of the WMI filters to be removed. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 1 +Default value: None +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 + diff --git a/Docs/Repair-GPOZaurrBrokenLink.md b/Docs/Repair-GPOZaurrBrokenLink.md index 3f97f28..1a03cc3 100644 --- a/Docs/Repair-GPOZaurrBrokenLink.md +++ b/Docs/Repair-GPOZaurrBrokenLink.md @@ -1,156 +1,130 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Repair-GPOZaurrBrokenLink - -## SYNOPSIS -Removes any link to GPO that no longer exists. - -## SYNTAX - -``` -Repair-GPOZaurrBrokenLink [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] - [[-ExtendedForestInformation] ] [[-LimitProcessing] ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -Removes any link to GPO that no longer exists. -It scans all site, organizational unit or domain root making sure every single link that may be linking to GPO that doesn't exists anymore is gone. - -## EXAMPLES - -### EXAMPLE 1 -``` -Repair-GPOZaurrBrokenLink -Verbose -LimitProcessing 1 -WhatIf -``` - -### EXAMPLE 2 -``` -Repair-GPOZaurrBrokenLink -Verbose -IncludeDomains ad.evotec.pl -LimitProcessing 1 -WhatIf -``` - -## PARAMETERS - -### -Forest -Target different Forest, by default current forest is used - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -Exclude domain from search, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -Include only specific domains, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -Ability to provide Forest Information from another command to speed up processing - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LimitProcessing -Allows to specify maximum number of items that will be fixed in a single run. -It doesn't affect amount of GPOs processed - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: 0 -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 -``` - -### -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 -``` - -### 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 - -## OUTPUTS - -## NOTES -General notes - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Repair-GPOZaurrBrokenLink +## SYNOPSIS +Removes any link to GPO that no longer exists. + +## SYNTAX +### __AllParameterSets +```powershell +Repair-GPOZaurrBrokenLink [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [[-LimitProcessing] ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Removes any link to GPO that no longer exists. It scans all site, organizational unit or domain root making sure every single link that may be linking to GPO that doesn't exists anymore is gone. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Repair-GPOZaurrBrokenLink -Verbose -LimitProcessing 1 -WhatIf +``` + + +### EXAMPLE 2 +```powershell +PS > Repair-GPOZaurrBrokenLink -Verbose -IncludeDomains ad.evotec.pl -LimitProcessing 1 -WhatIf +``` + + +## PARAMETERS + +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Ability to provide Forest Information from another command to speed up processing + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Target different Forest, by default current forest is used + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Include only specific domains, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -LimitProcessing +Allows to specify maximum number of items that will be fixed in a single run. It doesn't affect amount of GPOs processed + +```yaml +Type: Int32 +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 4 +Default value: 0 +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 + diff --git a/Docs/Repair-GPOZaurrNetLogonOwner.md b/Docs/Repair-GPOZaurrNetLogonOwner.md index f06bd6d..476026d 100644 --- a/Docs/Repair-GPOZaurrNetLogonOwner.md +++ b/Docs/Repair-GPOZaurrNetLogonOwner.md @@ -1,166 +1,140 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Repair-GPOZaurrNetLogonOwner - -## SYNOPSIS -Sets new owner to each file in NetLogon share. - -## SYNTAX - -``` -Repair-GPOZaurrNetLogonOwner [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] - [[-ExtendedForestInformation] ] [[-Principal] ] [[-LimitProcessing] ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -Sets new owner to each file in NetLogon share. - -## EXAMPLES - -### EXAMPLE 1 -``` -Repair-GPOZaurrNetLogonOwner -WhatIf -Verbose -IncludeDomains ad.evotec.pl -``` - -## PARAMETERS - -### -Forest -Target different Forest, by default current forest is used - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -Exclude domain from search, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -Include only specific domains, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -Ability to provide Forest Information from another command to speed up processing - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Principal -Provide named owner. -If not provided default S-1-5-32-544 is used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: S-1-5-32-544 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LimitProcessing -Allows to specify maximum number of items that will be fixed in a single run. -It doesn't affect amount of GPOs processed - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: 2147483647 -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 -``` - -### -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 -``` - -### 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 - -## OUTPUTS - -## NOTES -General notes - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Repair-GPOZaurrNetLogonOwner +## SYNOPSIS +Sets new owner to each file in NetLogon share. + +## SYNTAX +### __AllParameterSets +```powershell +Repair-GPOZaurrNetLogonOwner [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [[-Principal] ] [[-LimitProcessing] ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Sets new owner to each file in NetLogon share. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Repair-GPOZaurrNetLogonOwner -WhatIf -Verbose -IncludeDomains ad.evotec.pl +``` + + +## PARAMETERS + +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Ability to provide Forest Information from another command to speed up processing + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Target different Forest, by default current forest is used + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Include only specific domains, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -LimitProcessing +Allows to specify maximum number of items that will be fixed in a single run. It doesn't affect amount of GPOs processed + +```yaml +Type: Int32 +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 5 +Default value: 2147483647 +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Principal +Provide named owner. If not provided default S-1-5-32-544 is used. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 4 +Default value: S-1-5-32-544 +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 + diff --git a/Docs/Repair-GPOZaurrPermission.md b/Docs/Repair-GPOZaurrPermission.md index 53070bd..7007013 100644 --- a/Docs/Repair-GPOZaurrPermission.md +++ b/Docs/Repair-GPOZaurrPermission.md @@ -1,169 +1,141 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Repair-GPOZaurrPermission - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Repair-GPOZaurrPermission [-Type] [[-Forest] ] [[-ExcludeDomains] ] - [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [[-LimitProcessing] ] - [-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 -``` - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LimitProcessing -{{ Fill LimitProcessing Description }} - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -{{ Fill Type Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Accepted values: AuthenticatedUsers, Unknown, System, Administrative, All - -Required: True -Position: 0 -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 - -### None - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Repair-GPOZaurrPermission +## SYNOPSIS +Repairs permissions for Group Policy Objects (GPOs) based on specified criteria. + +## SYNTAX +### __AllParameterSets +```powershell +Repair-GPOZaurrPermission [-Type] [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [[-LimitProcessing] ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Repair-GPOZaurrPermission function repairs permissions for GPOs based on the specified criteria. It analyzes the permissions of GPOs and adds necessary permissions if they are missing. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Repair-GPOZaurrPermission -Type 'All' -Forest 'ContosoForest' -IncludeDomains @('Domain1', 'Domain2') -ExcludeDomains @('Domain3') -ExtendedForestInformation $info -LimitProcessing 100 +Repairs permissions for all types of users in the 'ContosoForest' forest, including only 'Domain1' and 'Domain2' while excluding 'Domain3', with extended forest information and processing a maximum of 100 GPOs. +``` + + +## PARAMETERS + +### -ExcludeDomains +Specifies an array of domains to exclude from the analysis. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Specifies additional information about the forest. + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Specifies the forest name to analyze GPO permissions. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Specifies an array of domains to include in the analysis. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -LimitProcessing +Specifies the maximum number of GPOs to process. + +```yaml +Type: Int32 +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 5 +Default value: 2147483647 +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Type +Specifies the type of permissions to repair. Valid values are 'AuthenticatedUsers', 'Unknown', 'System', 'Administrative', and 'All'. + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: AuthenticatedUsers, Unknown, System, Administrative, All + +Required: True +Position: 0 +Default value: None +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 + diff --git a/Docs/Repair-GPOZaurrPermissionConsistency.md b/Docs/Repair-GPOZaurrPermissionConsistency.md index fa66fd0..0b32293 100644 --- a/Docs/Repair-GPOZaurrPermissionConsistency.md +++ b/Docs/Repair-GPOZaurrPermissionConsistency.md @@ -1,198 +1,174 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Repair-GPOZaurrPermissionConsistency - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -### Default (Default) -``` -Repair-GPOZaurrPermissionConsistency [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [-ExtendedForestInformation ] [-LimitProcessing ] [-WhatIf] - [-Confirm] [] -``` - -### GPOName -``` -Repair-GPOZaurrPermissionConsistency [-GPOName ] [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [-ExtendedForestInformation ] [-LimitProcessing ] [-WhatIf] - [-Confirm] [] -``` - -### GPOGUID -``` -Repair-GPOZaurrPermissionConsistency [-GPOGuid ] [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [-ExtendedForestInformation ] [-LimitProcessing ] [-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 -``` - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOGuid -{{ Fill GPOGuid Description }} - -```yaml -Type: String -Parameter Sets: GPOGUID -Aliases: GUID, GPOID - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOName -{{ Fill GPOName Description }} - -```yaml -Type: String -Parameter Sets: GPOName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LimitProcessing -{{ Fill LimitProcessing Description }} - -```yaml -Type: Int32 -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 - -### None - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Repair-GPOZaurrPermissionConsistency +## SYNOPSIS +Repairs permission consistency for Group Policy Objects (GPOs) in a specified domain or forest. + +## SYNTAX +### Default (Default) +```powershell +Repair-GPOZaurrPermissionConsistency [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-LimitProcessing ] [-WhatIf] [-Confirm] [] +``` + +### GPOName +```powershell +Repair-GPOZaurrPermissionConsistency [-GPOName ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-LimitProcessing ] [-WhatIf] [-Confirm] [] +``` + +### GPOGUID +```powershell +Repair-GPOZaurrPermissionConsistency [-GPOGuid ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-LimitProcessing ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Repair-GPOZaurrPermissionConsistency function repairs permission consistency for GPOs in a specified domain or forest. It checks for inconsistencies in GPO permissions and attempts to make them consistent. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Repair-GPOZaurrPermissionConsistency -GPOName "ExampleGPO" -Forest "example.com" +Repairs permission consistency for the GPO named "ExampleGPO" in the "example.com" forest. +``` + + +### EXAMPLE 2 +```powershell +PS > Repair-GPOZaurrPermissionConsistency -GPOGuid "12345678-1234-1234-1234-1234567890AB" -ExcludeDomains @("domain1", "domain2") -LimitProcessing 5 +Repairs permission consistency for the GPO with the specified GUID, excluding domains "domain1" and "domain2", and processing a maximum of 5 GPOs. +``` + + +## PARAMETERS + +### -ExcludeDomains +Specifies an array of domains to exclude from the repair process. + +```yaml +Type: String[] +Parameter Sets: Default, GPOName, GPOGUID +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Specifies additional information about the forest. + +```yaml +Type: IDictionary +Parameter Sets: Default, GPOName, GPOGUID +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Specifies the forest where the GPOs are located. + +```yaml +Type: String +Parameter Sets: Default, GPOName, GPOGUID +Aliases: ForestName +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOGuid +Specifies the GUID of the GPO to repair. + +```yaml +Type: String +Parameter Sets: GPOGUID +Aliases: GUID, GPOID +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOName +Specifies the name of the GPO to repair. + +```yaml +Type: String +Parameter Sets: GPOName +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Specifies an array of domains to include in the repair process. + +```yaml +Type: String[] +Parameter Sets: Default, GPOName, GPOGUID +Aliases: Domain, Domains +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -LimitProcessing +Specifies the maximum number of GPOs to process. + +```yaml +Type: Int32 +Parameter Sets: Default, GPOName, GPOGUID +Aliases: +Possible values: + +Required: False +Position: named +Default value: 2147483647 +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 + diff --git a/Docs/Restore-GPOZaurr.md b/Docs/Restore-GPOZaurr.md index c75e704..a670101 100644 --- a/Docs/Restore-GPOZaurr.md +++ b/Docs/Restore-GPOZaurr.md @@ -1,121 +1,130 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Restore-GPOZaurr - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Restore-GPOZaurr [-BackupFolder] [[-DisplayName] ] [[-NewDisplayName] ] - [[-Domain] ] [-SkipBackupSummary] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -BackupFolder -{{ Fill BackupFolder Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -{{ Fill DisplayName Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -{{ Fill Domain Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewDisplayName -{{ Fill NewDisplayName Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipBackupSummary -{{ Fill SkipBackupSummary 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 - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Restore-GPOZaurr +## SYNOPSIS +Restores Group Policy Objects (GPOs) from a specified backup folder. + +## SYNTAX +### __AllParameterSets +```powershell +Restore-GPOZaurr [-BackupFolder] [[-DisplayName] ] [[-NewDisplayName] ] [[-Domain] ] [-SkipBackupSummary] [] +``` + +## DESCRIPTION +Restores Group Policy Objects (GPOs) from a specified backup folder. This function allows restoring GPOs with the option to provide a new display name for the GPO. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Restore-GPOZaurr -BackupFolder 'C:\GPOBackups' -DisplayName 'TestGPO' +``` + + +### EXAMPLE 2 +```powershell +PS > Restore-GPOZaurr -BackupFolder 'C:\GPOBackups' -DisplayName 'TestGPO' -NewDisplayName 'NewTestGPO' -Domain 'example.com' +``` + + +## PARAMETERS + +### -BackupFolder +The path to the folder containing the GPO backups. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -DisplayName +The display name of the GPO to be restored. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: Name +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Domain +(Optional) The domain name where the GPO should be restored. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -NewDisplayName +(Optional) The new display name for the restored GPO. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -SkipBackupSummary +(Switch) Skip displaying the backup summary information. + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +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 + diff --git a/Docs/Save-GPOZaurrFiles.md b/Docs/Save-GPOZaurrFiles.md index 7323124..ac59464 100644 --- a/Docs/Save-GPOZaurrFiles.md +++ b/Docs/Save-GPOZaurrFiles.md @@ -1,132 +1,140 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Save-GPOZaurrFiles - -## SYNOPSIS -Exports GPO XML data to files and saves it to a given path - -## SYNTAX - -``` -Save-GPOZaurrFiles [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] - [[-ExtendedForestInformation] ] [[-GPOPath] ] [-DeleteExisting] [] -``` - -## DESCRIPTION -Exports GPO XML data to files and saves it to a given path - -## EXAMPLES - -### EXAMPLE 1 -``` -Save-GPOZaurrFiles -GPOPath 'C:\Support\GitHub\GpoZaurr\Ignore\GPOExportEvotec' -DeleteExisting -Verbose -``` - -## PARAMETERS - -### -Forest -Target different Forest, by default current forest is used - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -Exclude domain from search, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -Include only specific domains, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -Ability to provide Forest Information from another command to speed up processing - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOPath -Path where to save XML files from GPOReport - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeleteExisting -Delete existing files before saving new ones - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -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 - -## OUTPUTS - -## NOTES -General notes - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Save-GPOZaurrFiles +## SYNOPSIS +Exports GPO XML data to files and saves it to a given path + +## SYNTAX +### __AllParameterSets +```powershell +Save-GPOZaurrFiles [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [[-GPOPath] ] [-DeleteExisting] [] +``` + +## DESCRIPTION +Exports GPO XML data to files and saves it to a given path + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Save-GPOZaurrFiles -GPOPath 'C:\Support\GitHub\GpoZaurr\Ignore\GPOExportEvotec' -DeleteExisting -Verbose +``` + + +## PARAMETERS + +### -DeleteExisting +Delete existing files before saving new ones + +```yaml +Type: SwitchParameter +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Ability to provide Forest Information from another command to speed up processing + +```yaml +Type: IDictionary +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Target different Forest, by default current forest is used + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: ForestName +Possible values: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOPath +Path where to save XML files from GPOReport + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Include only specific domains, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: __AllParameterSets +Aliases: Domain, Domains +Possible values: + +Required: False +Position: 2 +Default value: None +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 + diff --git a/Docs/Set-GPOOwner.md b/Docs/Set-GPOOwner.md index 05120a4..acbbed7 100644 --- a/Docs/Set-GPOOwner.md +++ b/Docs/Set-GPOOwner.md @@ -1,81 +1,81 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Set-GPOOwner - -## SYNOPSIS -Used within Invoke-GPOZaurrPermission only. -Set new group policy owner. - -## SYNTAX - -``` -Set-GPOOwner [[-Type] ] [[-Principal] ] [] -``` - -## DESCRIPTION -Used within Invoke-GPOZaurrPermission only. -Set new group policy owner. - -## EXAMPLES - -### EXAMPLE 1 -``` -Invoke-GPOZaurrPermission -Verbose -SearchBase 'OU=Computers,OU=Production,DC=ad,DC=evotec,DC=xyz' { -``` - -Set-GPOOwner -Type Administrative - Remove-GPOPermission -Type NotAdministrative, NotWellKnownAdministrative -IncludePermissionType GpoEdit, GpoEditDeleteModifySecurity - Add-GPOPermission -Type Administrative -IncludePermissionType GpoEditDeleteModifySecurity - Add-GPOPermission -Type WellKnownAdministrative -IncludePermissionType GpoEditDeleteModifySecurity -} -WhatIf - -## PARAMETERS - -### -Type -Choose Owner Type. -When chosing Administrative Type, owner will be set to Domain Admins for current GPO domain. -When Default is set Owner will be set to Principal given in another parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: Default -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Principal -Choose Owner Name to set for Group Policy - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -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 - -## OUTPUTS - -## NOTES -General notes - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Set-GPOOwner +## SYNOPSIS +Used within Invoke-GPOZaurrPermission only. Set new group policy owner. + +## SYNTAX +### __AllParameterSets +```powershell +Set-GPOOwner [[-Type] ] [[-Principal] ] [] +``` + +## DESCRIPTION +Used within Invoke-GPOZaurrPermission only. Set new group policy owner. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Invoke-GPOZaurrPermission -Verbose -SearchBase 'OU=Computers,OU=Production,DC=ad,DC=evotec,DC=xyz' { + Set-GPOOwner -Type Administrative + Remove-GPOPermission -Type NotAdministrative, NotWellKnownAdministrative -IncludePermissionType GpoEdit, GpoEditDeleteModifySecurity + Add-GPOPermission -Type Administrative -IncludePermissionType GpoEditDeleteModifySecurity + Add-GPOPermission -Type WellKnownAdministrative -IncludePermissionType GpoEditDeleteModifySecurity +} -WhatIf +``` + + +## PARAMETERS + +### -Principal +Choose Owner Name to set for Group Policy + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Type +Choose Owner Type. When chosing Administrative Type, owner will be set to Domain Admins for current GPO domain. When Default is set Owner will be set to Principal given in another parameter. + +```yaml +Type: String +Parameter Sets: __AllParameterSets +Aliases: +Possible values: Administrative, Default + +Required: False +Position: 0 +Default value: Default +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 + diff --git a/Docs/Set-GPOZaurrOwner.md b/Docs/Set-GPOZaurrOwner.md index 8541cb0..2ff1fe5 100644 --- a/Docs/Set-GPOZaurrOwner.md +++ b/Docs/Set-GPOZaurrOwner.md @@ -1,289 +1,261 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Set-GPOZaurrOwner - -## SYNOPSIS -Sets GPO Owner to Domain Admins or other choosen account - -## SYNTAX - -### Type (Default) -``` -Set-GPOZaurrOwner -Type [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] - [-ExtendedForestInformation ] [-Principal ] [-SkipSysvol] [-LimitProcessing ] - [-ApprovedOwner ] [-Action ] [-Force] [-WhatIf] [-Confirm] [] -``` - -### Named -``` -Set-GPOZaurrOwner [-GPOName ] [-GPOGuid ] [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [-ExtendedForestInformation ] [-Principal ] [-SkipSysvol] - [-LimitProcessing ] [-ApprovedOwner ] [-Action ] [-Force] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -Sets GPO Owner to Domain Admins or other choosen account. -GPO Owner is set in AD and SYSVOL unless specified otherwise. -If account doesn't require change, no change is done. - -## EXAMPLES - -### EXAMPLE 1 -``` -Set-GPOZaurrOwner -Type All -Verbose -WhatIf -LimitProcessing 2 -``` - -## PARAMETERS - -### -Type +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Set-GPOZaurrOwner +## SYNOPSIS +Sets GPO Owner to Domain Admins or other choosen account + +## SYNTAX +### Type (Default) +```powershell +Set-GPOZaurrOwner -Type [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-Principal ] [-SkipSysvol] [-LimitProcessing ] [-ApprovedOwner ] [-Action ] [-Force] [-WhatIf] [-Confirm] [] +``` + +### Named +```powershell +Set-GPOZaurrOwner [-GPOName ] [-GPOGuid ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-Principal ] [-SkipSysvol] [-LimitProcessing ] [-ApprovedOwner ] [-Action ] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Sets GPO Owner to Domain Admins or other choosen account. GPO Owner is set in AD and SYSVOL unless specified otherwise. If account doesn't require change, no change is done. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Set-GPOZaurrOwner -Type All -Verbose -WhatIf -LimitProcessing 2 +``` + + +## PARAMETERS + +### -Action +{{ Fill Action Description }} + +```yaml +Type: String +Parameter Sets: Type, Named +Aliases: +Possible values: OnlyAD, OnlyFileSystem + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ApprovedOwner +{{ Fill ApprovedOwner Description }} + +```yaml +Type: String[] +Parameter Sets: Type, Named +Aliases: Exclusion, Exclusions +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: Type, Named +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ExtendedForestInformation +Ability to provide Forest Information from another command to speed up processing + +```yaml +Type: IDictionary +Parameter Sets: Type, Named +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Force +Pushes new owner regardless if it's already set or not + +```yaml +Type: SwitchParameter +Parameter Sets: Type, Named +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Forest +Target different Forest, by default current forest is used + +```yaml +Type: String +Parameter Sets: Type, Named +Aliases: ForestName +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOGuid +GUID of GPO. By default all GPOs are targetted + +```yaml +Type: String +Parameter Sets: Named +Aliases: GUID, GPOID +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GPOName +Name of GPO. By default all GPOs are targetted + +```yaml +Type: String +Parameter Sets: Named +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -IncludeDomains +Include only specific domains, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: Type, Named +Aliases: Domain, Domains +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -LimitProcessing +Allows to specify maximum number of items that will be fixed in a single run. It doesn't affect amount of GPOs processed + +```yaml +Type: Int32 +Parameter Sets: Type, Named +Aliases: +Possible values: + +Required: False +Position: named +Default value: 2147483647 +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Principal +Parameter description + +```yaml +Type: String +Parameter Sets: Type, Named +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -SkipSysvol +Set GPO Owner only in Active Directory. By default GPO Owner is being set in both places + +```yaml +Type: SwitchParameter +Parameter Sets: Type, Named +Aliases: +Possible values: + +Required: False +Position: named +Default value: False +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Type Unknown - finds unknown Owners and sets them to Administrative (Domain Admins) or chosen principal NotMatching - find administrative groups only and if sysvol and gpo doesn't match - replace with chosen principal or Domain Admins if not specified Inconsistent - same as not NotMatching NotAdministrative - combination of Unknown/NotMatching and NotAdministrative - replace with chosen principal or Domain Admins if not specified -All - if Owner is known it checks if it's Administrative, if it sn't it fixes that. -If owner is unknown it fixes it - -```yaml -Type: String -Parameter Sets: Type -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOName -Name of GPO. -By default all GPOs are targetted - -```yaml -Type: String -Parameter Sets: Named -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOGuid -GUID of GPO. -By default all GPOs are targetted - -```yaml -Type: String -Parameter Sets: Named -Aliases: GUID, GPOID - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -Target different Forest, by default current forest is used - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -Exclude domain from search, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -Include only specific domains, by default whole forest is scanned - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -Ability to provide Forest Information from another command to speed up processing - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Principal -Parameter description - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipSysvol -Set GPO Owner only in Active Directory. -By default GPO Owner is being set in both places - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LimitProcessing -Allows to specify maximum number of items that will be fixed in a single run. -It doesn't affect amount of GPOs processed - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 2147483647 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApprovedOwner -{{ Fill ApprovedOwner Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Exclusion, Exclusions - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Action -{{ Fill Action Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Pushes new owner regardless if it's already set or not - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -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 -``` - -### -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 -``` - -### 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 - -## OUTPUTS - -## NOTES -General notes - -## RELATED LINKS +All - if Owner is known it checks if it's Administrative, if it sn't it fixes that. If owner is unknown it fixes it + +```yaml +Type: String +Parameter Sets: Type +Aliases: +Possible values: Unknown, NotAdministrative, NotMatching, Inconsistent, All + +Required: True +Position: named +Default value: None +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 + diff --git a/Docs/Set-GPOZaurrStatus.md b/Docs/Set-GPOZaurrStatus.md index 972d255..858c1cc 100644 --- a/Docs/Set-GPOZaurrStatus.md +++ b/Docs/Set-GPOZaurrStatus.md @@ -1,193 +1,43 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Set-GPOZaurrStatus - -## SYNOPSIS -Enables or disables user/computer section of Group Policy. - -## SYNTAX - -### GPOName (Default) -``` -Set-GPOZaurrStatus -GPOName -Status [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [-ExtendedForestInformation ] [-WhatIf] [-Confirm] - [] -``` - -### GPOGUID -``` -Set-GPOZaurrStatus -GPOGuid -Status [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [-ExtendedForestInformation ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -Enables or disables user/computer section of Group Policy. - -## EXAMPLES - -### EXAMPLE 1 -``` -Set-GPOZaurrStatus -Name 'TEST | Empty GPO - AD.EVOTEC.PL CrossDomain GPO' -Status AllSettingsEnabled -Verbose -``` - -### EXAMPLE 2 -``` -Set-GPOZaurrStatus -Name 'TEST | Empty GPO - AD.EVOTEC.PL CrossDomain GPO' -DomainName ad.evotec.pl -Status AllSettingsEnabled -Verbose -``` - -## PARAMETERS - -### -GPOName -Provide Group Policy Name - -```yaml -Type: String -Parameter Sets: GPOName -Aliases: Name, DisplayName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOGuid -Provide Group Policy GUID - -```yaml -Type: String -Parameter Sets: GPOGUID -Aliases: GUID, GPOID - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -Choose a status for provided Group Policy - -```yaml -Type: GpoStatus -Parameter Sets: (All) -Aliases: -Accepted values: AllSettingsDisabled, UserSettingsDisabled, ComputerSettingsDisabled, AllSettingsEnabled - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -Choose forest to target. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -Exclude domains from trying to find Group Policy Name or GUID - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -Include domain (one or more) to find Group Policy Name or GUID - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains, DomainName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -Provide Extended Forest Information - -```yaml -Type: IDictionary -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 -``` - -### -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 -``` - -### 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 - -## OUTPUTS - -## NOTES -General notes - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Set-GPOZaurrStatus +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX +```powershell +Set-GPOZaurrStatus +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +```powershell +Set-GPOZaurrStatus +``` + + +## 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 + +- `None` + +## RELATED LINKS + +- None + diff --git a/Docs/Skip-GroupPolicy.md b/Docs/Skip-GroupPolicy.md index 3f7a000..58397c2 100644 --- a/Docs/Skip-GroupPolicy.md +++ b/Docs/Skip-GroupPolicy.md @@ -1,110 +1,109 @@ ---- -external help file: GPOZaurr-help.xml -Module Name: GPOZaurr -online version: -schema: 2.0.0 ---- - -# Skip-GroupPolicy - -## SYNOPSIS -Used within ScriptBlocks only. -Allows to exclude Group Policy from being affected by fixes - -## SYNTAX - -### Name (Default) -``` -Skip-GroupPolicy [-Name ] [-DomaiName ] [] -``` - -### Guid -``` -Skip-GroupPolicy [-GUID ] [-DomaiName ] [] -``` - -## DESCRIPTION -Used within ScriptBlocks only. -Allows to exclude Group Policy from being affected by fixes. -Only some commands support it. -The goal is to support all cmdlets. - -## EXAMPLES - -### EXAMPLE 1 -``` -Optimize-GPOZaurr -All -WhatIf -Verbose -LimitProcessing 2 { -``` - -Skip-GroupPolicy -Name 'TEST | Drive Mapping 1' - Skip-GroupPolicy -Name 'TEST | Drive Mapping 2' -} - -### EXAMPLE 2 -``` -Remove-GPOZaurr -Type Empty, Unlinked -BackupPath "$Env:UserProfile\Desktop\GPO" -BackupDated -LimitProcessing 2 -Verbose -WhatIf { -``` - -Skip-GroupPolicy -Name 'TEST | Drive Mapping 1' - Skip-GroupPolicy -Name 'TEST | Drive Mapping 2' -DomaiName 'ad.evotec.pl' -} - -## PARAMETERS - -### -Name -Define Group Policy Name to skip - -```yaml -Type: String -Parameter Sets: Name -Aliases: GpoName, DisplayName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GUID -{{ Fill GUID Description }} - -```yaml -Type: String -Parameter Sets: Guid -Aliases: ID - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomaiName -Define DomainName where Group Policy is located. -Otherwise each domain will be checked and skipped if found with same name. - -```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 - -## OUTPUTS - -## NOTES -General notes - -## RELATED LINKS +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: https://github.com/EvotecIT/GPOZaurr +schema: 2.0.0 +--- +# Skip-GroupPolicy +## SYNOPSIS +Used within ScriptBlocks only. Allows to exclude Group Policy from being affected by fixes + +## SYNTAX +### Name (Default) +```powershell +Skip-GroupPolicy [-Name ] [-DomaiName ] [] +``` + +### Guid +```powershell +Skip-GroupPolicy [-GUID ] [-DomaiName ] [] +``` + +## DESCRIPTION +Used within ScriptBlocks only. Allows to exclude Group Policy from being affected by fixes. Only some commands support it. The goal is to support all cmdlets. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +PS > Optimize-GPOZaurr -All -WhatIf -Verbose -LimitProcessing 2 { + Skip-GroupPolicy -Name 'TEST | Drive Mapping 1' + Skip-GroupPolicy -Name 'TEST | Drive Mapping 2' +} +``` + + +### EXAMPLE 2 +```powershell +PS > Remove-GPOZaurr -Type Empty, Unlinked -BackupPath "$Env:UserProfile\Desktop\GPO" -BackupDated -LimitProcessing 2 -Verbose -WhatIf { + Skip-GroupPolicy -Name 'TEST | Drive Mapping 1' + Skip-GroupPolicy -Name 'TEST | Drive Mapping 2' -DomaiName 'ad.evotec.pl' +} +``` + + +## PARAMETERS + +### -DomaiName +Define DomainName where Group Policy is located. Otherwise each domain will be checked and skipped if found with same name. + +```yaml +Type: String +Parameter Sets: Name, Guid +Aliases: +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -GUID +{{ Fill GUID Description }} + +```yaml +Type: String +Parameter Sets: Guid +Aliases: ID +Possible values: + +Required: False +Position: named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Name +Define Group Policy Name to skip + +```yaml +Type: String +Parameter Sets: Name +Aliases: GpoName, DisplayName +Possible values: + +Required: False +Position: named +Default value: None +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 + diff --git a/GPOZaurr.psd1 b/GPOZaurr.psd1 index 750ee62..18e9dcb 100644 --- a/GPOZaurr.psd1 +++ b/GPOZaurr.psd1 @@ -1,39 +1,40 @@ -@{ - AliasesToExport = @('Get-GPOZaurrSysvol', 'Get-GPOZaurrFilesPolicyDefinitions', 'Show-GPOZaurr', 'Show-GPO', 'Find-GPO', 'Remove-GPOZaurrOrphaned') - Author = 'Przemyslaw Klys' - CmdletsToExport = @() - CompanyName = 'Evotec' - CompatiblePSEditions = @('Desktop') - Copyright = '(c) 2011 - 2025 Przemyslaw Klys @ Evotec. All rights reserved.' - Description = 'Group Policy Eater is a PowerShell module that aims to gather information about Group Policies but also allows fixing issues that you may find in them.' - FunctionsToExport = @('Add-GPOPermission', 'Add-GPOZaurrPermission', 'Backup-GPOZaurr', 'Clear-GPOZaurrSysvolDFSR', 'ConvertFrom-CSExtension', 'Export-GPOZaurrContent', 'Find-CSExtension', 'Get-GPOZaurr', 'Get-GPOZaurrAD', 'Get-GPOZaurrBackupInformation', 'Get-GPOZaurrBroken', 'Get-GPOZaurrBrokenLink', 'Get-GPOZaurrDictionary', 'Get-GPOZaurrDuplicateObject', 'Get-GPOZaurrFiles', 'Get-GPOZaurrFilesPolicyDefinition', 'Get-GPOZaurrFolders', 'Get-GPOZaurrInheritance', 'Get-GPOZaurrLegacyFiles', 'Get-GPOZaurrLink', 'Get-GPOZaurrLinkSummary', 'Get-GPOZaurrMissingFiles', 'Get-GPOZaurrNetLogon', 'Get-GPOZaurrOrganizationalUnit', 'Get-GPOZaurrOwner', 'Get-GPOZaurrPassword', 'Get-GPOZaurrPermission', 'Get-GPOZaurrPermissionAnalysis', 'Get-GPOZaurrPermissionConsistency', 'Get-GPOZaurrPermissionIssue', 'Get-GPOZaurrPermissionRoot', 'Get-GPOZaurrPermissionSummary', 'Get-GPOZaurrRedirect', 'Get-GPOZaurrSysvolDFSR', 'Get-GPOZaurrUpdates', 'Get-GPOZaurrWMI', 'Invoke-GPOZaurr', 'Invoke-GPOZaurrContent', 'Invoke-GPOZaurrPermission', 'Invoke-GPOZaurrSupport', 'New-GPOZaurrWMI', 'Optimize-GPOZaurr', 'Remove-GPOPermission', 'Remove-GPOZaurr', 'Remove-GPOZaurrBroken', 'Remove-GPOZaurrDuplicateObject', 'Remove-GPOZaurrFolders', 'Remove-GPOZaurrLegacyFiles', 'Remove-GPOZaurrLinkEmptyOU', 'Remove-GPOZaurrPermission', 'Remove-GPOZaurrWMI', 'Repair-GPOZaurrBrokenLink', 'Repair-GPOZaurrNetLogonOwner', 'Repair-GPOZaurrPermission', 'Repair-GPOZaurrPermissionConsistency', 'Restore-GPOZaurr', 'Save-GPOZaurrFiles', 'Set-GPOOwner', 'Set-GPOZaurrOwner', 'Set-GPOZaurrStatus', 'Skip-GroupPolicy') - GUID = 'f7d4c9e4-0298-4f51-ad77-e8e3febebbde' - ModuleVersion = '1.1.10' - PowerShellVersion = '5.1' - PrivateData = @{ - PSData = @{ - ExternalModuleDependencies = @('CimCmdlets', 'Microsoft.PowerShell.Management', 'Microsoft.PowerShell.Utility', 'Microsoft.PowerShell.Security') - ProjectUri = 'https://github.com/EvotecIT/GPOZaurr' - RequireLicenseAcceptance = $false - Tags = @('Windows', 'ActiveDirectory', 'GPO', 'GroupPolicy') - } - } - RequiredModules = @(@{ - Guid = '0b0ba5c5-ec85-4c2b-a718-874e55a8bc3f' - ModuleName = 'PSWriteColor' - ModuleVersion = '1.0.3' - }, @{ - Guid = 'ee272aa8-baaa-4edf-9f45-b6d6f7d844fe' - ModuleName = 'PSSharedGoods' - ModuleVersion = '0.0.312' - }, @{ - Guid = '9fc9fd61-7f11-4f4b-a527-084086f1905f' - ModuleName = 'ADEssentials' - ModuleVersion = '0.0.267' - }, @{ - Guid = 'a7bdf640-f5cb-4acf-9de0-365b322d245c' - ModuleName = 'PSWriteHTML' - ModuleVersion = '1.27.0' - }, 'CimCmdlets', 'Microsoft.PowerShell.Management', 'Microsoft.PowerShell.Utility', 'Microsoft.PowerShell.Security') - RootModule = 'GPOZaurr.psm1' +@{ + AliasesToExport = @('Get-GPOZaurrSysvol', 'Get-GPOZaurrFilesPolicyDefinitions', 'Show-GPOZaurr', 'Show-GPO', 'Find-GPO', 'Remove-GPOZaurrOrphaned') + Author = 'Przemyslaw Klys' + CmdletsToExport = @() + CompanyName = 'Evotec' + CompatiblePSEditions = @('Desktop') + Copyright = '(c) 2011 - 2026 Przemyslaw Klys @ Evotec. All rights reserved.' + Description = 'Group Policy Eater is a PowerShell module that aims to gather information about Group Policies but also allows fixing issues that you may find in them.' + FunctionsToExport = @('Add-GPOPermission', 'Add-GPOZaurrPermission', 'Backup-GPOZaurr', 'Clear-GPOZaurrSysvolDFSR', 'ConvertFrom-CSExtension', 'Export-GPOZaurrContent', 'Find-CSExtension', 'Get-GPOZaurr', 'Get-GPOZaurrAD', 'Get-GPOZaurrBackupInformation', 'Get-GPOZaurrBroken', 'Get-GPOZaurrBrokenLink', 'Get-GPOZaurrDictionary', 'Get-GPOZaurrDuplicateObject', 'Get-GPOZaurrFiles', 'Get-GPOZaurrFilesPolicyDefinition', 'Get-GPOZaurrFolders', 'Get-GPOZaurrInheritance', 'Get-GPOZaurrLegacyFiles', 'Get-GPOZaurrLink', 'Get-GPOZaurrLinkSummary', 'Get-GPOZaurrMissingFiles', 'Get-GPOZaurrNetLogon', 'Get-GPOZaurrOrganizationalUnit', 'Get-GPOZaurrOwner', 'Get-GPOZaurrPassword', 'Get-GPOZaurrPermission', 'Get-GPOZaurrPermissionAnalysis', 'Get-GPOZaurrPermissionConsistency', 'Get-GPOZaurrPermissionIssue', 'Get-GPOZaurrPermissionRoot', 'Get-GPOZaurrPermissionSummary', 'Get-GPOZaurrRedirect', 'Get-GPOZaurrSysvolDFSR', 'Get-GPOZaurrUpdates', 'Get-GPOZaurrWMI', 'Invoke-GPOZaurr', 'Invoke-GPOZaurrContent', 'Invoke-GPOZaurrPermission', 'Invoke-GPOZaurrSupport', 'New-GPOZaurrWMI', 'Optimize-GPOZaurr', 'Remove-GPOPermission', 'Remove-GPOZaurr', 'Remove-GPOZaurrBroken', 'Remove-GPOZaurrDuplicateObject', 'Remove-GPOZaurrFolders', 'Remove-GPOZaurrLegacyFiles', 'Remove-GPOZaurrLinkEmptyOU', 'Remove-GPOZaurrPermission', 'Remove-GPOZaurrWMI', 'Repair-GPOZaurrBrokenLink', 'Repair-GPOZaurrNetLogonOwner', 'Repair-GPOZaurrPermission', 'Repair-GPOZaurrPermissionConsistency', 'Restore-GPOZaurr', 'Save-GPOZaurrFiles', 'Set-GPOOwner', 'Set-GPOZaurrOwner', 'Set-GPOZaurrStatus', 'Skip-GroupPolicy') + GUID = 'f7d4c9e4-0298-4f51-ad77-e8e3febebbde' + ModuleVersion = '1.1.10' + PowerShellVersion = '5.1' + PrivateData = @{ + PSData = @{ + ExternalModuleDependencies = @('CimCmdlets') + ProjectUri = 'https://github.com/EvotecIT/GPOZaurr' + RequireLicenseAcceptance = $false + Tags = @('Windows', 'ActiveDirectory', 'GPO', 'GroupPolicy') + } + } + RequiredModules = @(@{ + Guid = '0b0ba5c5-ec85-4c2b-a718-874e55a8bc3f' + ModuleName = 'PSWriteColor' + ModuleVersion = '1.0.3' + }, @{ + Guid = 'ee272aa8-baaa-4edf-9f45-b6d6f7d844fe' + ModuleName = 'PSSharedGoods' + ModuleVersion = '0.0.313.1' + }, @{ + Guid = '9fc9fd61-7f11-4f4b-a527-084086f1905f' + ModuleName = 'ADEssentials' + ModuleVersion = '1.0.4.1' + }, @{ + Guid = 'a7bdf640-f5cb-4acf-9de0-365b322d245c' + ModuleName = 'PSWriteHTML' + ModuleVersion = '1.41.0.5' + }) + RootModule = 'GPOZaurr.psm1' + ScriptsToProcess = @() } \ No newline at end of file diff --git a/GPOZaurr.psm1 b/GPOZaurr.psm1 index bd2d7a9..b1b7786 100644 --- a/GPOZaurr.psm1 +++ b/GPOZaurr.psm1 @@ -1,54 +1,54 @@ -#Get public and private function definition files. -$Public = @( Get-ChildItem -Path $PSScriptRoot\Public\*.ps1 -ErrorAction SilentlyContinue -Recurse ) -$Private = @( Get-ChildItem -Path $PSScriptRoot\Private\*.ps1 -ErrorAction SilentlyContinue -Recurse ) - -$AssemblyFolders = Get-ChildItem -Path $PSScriptRoot\Lib -Directory -ErrorAction SilentlyContinue -if ($AssemblyFolders.BaseName -contains 'Standard') { - $Assembly = @( Get-ChildItem -Path $PSScriptRoot\Lib\Standard\*.dll -ErrorAction SilentlyContinue ) -} else { - if ($PSEdition -eq 'Core') { - $Assembly = @( Get-ChildItem -Path $PSScriptRoot\Lib\Core\*.dll -ErrorAction SilentlyContinue ) - } else { - $Assembly = @( Get-ChildItem -Path $PSScriptRoot\Lib\Default\*.dll -ErrorAction SilentlyContinue ) - } -} -$FoundErrors = @( - foreach ($Import in @($Assembly)) { - try { - Add-Type -Path $Import.Fullname -ErrorAction Stop - } catch [System.Reflection.ReflectionTypeLoadException] { - Write-Warning "Processing $($Import.Name) Exception: $($_.Exception.Message)" - $LoaderExceptions = $($_.Exception.LoaderExceptions) | Sort-Object -Unique - foreach ($E in $LoaderExceptions) { - Write-Warning "Processing $($Import.Name) LoaderExceptions: $($E.Message)" - } - $true - #Write-Error -Message "StackTrace: $($_.Exception.StackTrace)" - } catch { - Write-Warning "Processing $($Import.Name) Exception: $($_.Exception.Message)" - $LoaderExceptions = $($_.Exception.LoaderExceptions) | Sort-Object -Unique - foreach ($E in $LoaderExceptions) { - Write-Warning "Processing $($Import.Name) LoaderExceptions: $($E.Message)" - } - $true - #Write-Error -Message "StackTrace: $($_.Exception.StackTrace)" - } - } - #Dot source the files - foreach ($Import in @($Private + $Public)) { - try { - . $Import.Fullname - } catch { - Write-Error -Message "Failed to import functions from $($import.Fullname): $_" - $true - } - } -) - -if ($FoundErrors.Count -gt 0) { - $ModuleName = (Get-ChildItem $PSScriptRoot\*.psd1).BaseName - Write-Warning "Importing module $ModuleName failed. Fix errors before continuing." - break -} - +#Get public and private function definition files. +$Public = @( Get-ChildItem -Path $PSScriptRoot\Public\*.ps1 -ErrorAction SilentlyContinue -Recurse ) +$Private = @( Get-ChildItem -Path $PSScriptRoot\Private\*.ps1 -ErrorAction SilentlyContinue -Recurse ) + +$AssemblyFolders = Get-ChildItem -Path $PSScriptRoot\Lib -Directory -ErrorAction SilentlyContinue +if ($AssemblyFolders.BaseName -contains 'Standard') { + $Assembly = @( Get-ChildItem -Path $PSScriptRoot\Lib\Standard\*.dll -ErrorAction SilentlyContinue ) +} else { + if ($PSEdition -eq 'Core') { + $Assembly = @( Get-ChildItem -Path $PSScriptRoot\Lib\Core\*.dll -ErrorAction SilentlyContinue ) + } else { + $Assembly = @( Get-ChildItem -Path $PSScriptRoot\Lib\Default\*.dll -ErrorAction SilentlyContinue ) + } +} +$FoundErrors = @( + foreach ($Import in @($Assembly)) { + try { + Add-Type -Path $Import.Fullname -ErrorAction Stop + } catch [System.Reflection.ReflectionTypeLoadException] { + Write-Warning "Processing $($Import.Name) Exception: $($_.Exception.Message)" + $LoaderExceptions = $($_.Exception.LoaderExceptions) | Sort-Object -Unique + foreach ($E in $LoaderExceptions) { + Write-Warning "Processing $($Import.Name) LoaderExceptions: $($E.Message)" + } + $true + #Write-Error -Message "StackTrace: $($_.Exception.StackTrace)" + } catch { + Write-Warning "Processing $($Import.Name) Exception: $($_.Exception.Message)" + $LoaderExceptions = $($_.Exception.LoaderExceptions) | Sort-Object -Unique + foreach ($E in $LoaderExceptions) { + Write-Warning "Processing $($Import.Name) LoaderExceptions: $($E.Message)" + } + $true + #Write-Error -Message "StackTrace: $($_.Exception.StackTrace)" + } + } + #Dot source the files + foreach ($Import in @($Private + $Public)) { + try { + . $Import.Fullname + } catch { + Write-Error -Message "Failed to import functions from $($import.Fullname): $_" + $true + } + } +) + +if ($FoundErrors.Count -gt 0) { + $ModuleName = (Get-ChildItem $PSScriptRoot\*.psd1).BaseName + Write-Warning "Importing module $ModuleName failed. Fix errors before continuing." + break +} + Export-ModuleMember -Function '*' -Alias '*' \ No newline at end of file diff --git a/Public/Invoke-GPOZaurrSupport.ps1 b/Public/Invoke-GPOZaurrSupport.ps1 index faa1705..1d06f01 100644 --- a/Public/Invoke-GPOZaurrSupport.ps1 +++ b/Public/Invoke-GPOZaurrSupport.ps1 @@ -28,11 +28,11 @@ Runs the function online to retrieve the latest Group Policy information. .EXAMPLE - Invoke-GPOZaurrSupport -Type HTML -ComputerName "RemoteComputer" -UserName "Admin" -Path "C:\Temp\GPOReport.html" + Invoke-GPOZaurrSupport -Type HTML -ComputerName "RemoteComputer" -UserName "Admin" -Path (Join-Path $env:TEMP 'GPOReport.html') Retrieves Group Policy information in HTML format from a remote computer and saves it to a specified path. .EXAMPLE - Invoke-GPOZaurrSupport -Type XML -Path "C:\Temp\GPOReport.xml" -Online + Invoke-GPOZaurrSupport -Type XML -Path (Join-Path $env:TEMP 'GPOReport.xml') -Online Retrieves the latest Group Policy information in XML format and saves it to a specified path. #>