Files
GPOZaurr/Docs/Optimize-GPOZaurr.md
T
Przemysław Kłys f7bdaca724 docs: ✏️ Update documentation for GPOZaurr module
- Revised `Set-GPOZaurrOwner.md` to enhance clarity and detail for parameters and examples.
- Updated `Set-GPOZaurrStatus.md` with a new online version link and improved structure.
- Refined `Skip-GroupPolicy.md` to clarify usage within script blocks and added examples.
- Adjusted `GPOZaurr.psd1` for version updates and improved module dependencies.
- Enhanced `GPOZaurr.psm1` for better error handling during function imports.
- Modified `Invoke-GPOZaurrSupport.ps1` examples to use `Join-Path` for path construction.
2026-05-19 18:47:50 +02:00

4.7 KiB

external help file, Module Name, online version, schema
external help file Module Name online version schema
GPOZaurr-help.xml GPOZaurr https://github.com/EvotecIT/GPOZaurr 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] <scriptblock>] -GPOName <string> [-LimitProcessing <int>] [-Forest <string>] [-ExcludeDomains <string[]>] [-IncludeDomains <string[]>] [-ExtendedForestInformation <IDictionary>] [-WhatIf] [-Confirm] [<CommonParameters>]

GPOGUID

Optimize-GPOZaurr [[-ExcludeGroupPolicies] <scriptblock>] -GPOGuid <string> [-LimitProcessing <int>] [-Forest <string>] [-ExcludeDomains <string[]>] [-IncludeDomains <string[]>] [-ExtendedForestInformation <IDictionary>] [-WhatIf] [-Confirm] [<CommonParameters>]

All

Optimize-GPOZaurr [[-ExcludeGroupPolicies] <scriptblock>] -All [-LimitProcessing <int>] [-Forest <string>] [-ExcludeDomains <string[]>] [-IncludeDomains <string[]>] [-ExtendedForestInformation <IDictionary>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Enables or disables user/computer section of group policy based on it's content.

EXAMPLES

EXAMPLE 1

PS > Optimize-GPOZaurr -All -WhatIf -Verbose -LimitProcessing 2

EXAMPLE 2

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 }}

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

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

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

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

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 }}

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 }}

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

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

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.

INPUTS

  • None

OUTPUTS

  • None
  • None