Files
GPOZaurr/Docs/Get-GPOZaurrLinkSummary.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

3.5 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

Get-GPOZaurrLinkSummary

SYNOPSIS

Retrieves a summary of GPO links based on specified criteria.

SYNTAX

__AllParameterSets

Get-GPOZaurrLinkSummary [[-Report] <string[]>] [[-Forest] <string>] [[-ExcludeDomains] <string[]>] [[-IncludeDomains] <string[]>] [[-ExtendedForestInformation] <IDictionary>] [-UnlimitedProperties] [<CommonParameters>]

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

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

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.

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.

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.

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.

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'.

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.

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.

INPUTS

  • None

OUTPUTS

  • None
  • None