GPOZaurr/Docs/Get-GPOZaurrLink.md

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

SYNOPSIS

Retrieves Group Policy Object (GPO) links based on specified criteria.

SYNTAX

Linked (Default)

Get-GPOZaurrLink [-Linked <string[]>] [-Limited] [-SkipDuplicates] [-GPOCache <IDictionary>] [-Forest <string>] [-ExcludeDomains <string[]>] [-IncludeDomains <string[]>] [-ExtendedForestInformation <IDictionary>] [-AsHashTable] [-Summary] [<CommonParameters>]

ADObject

Get-GPOZaurrLink -ADObject <ADObject[]> [-Limited] [-SkipDuplicates] [-GPOCache <IDictionary>] [-Forest <string>] [-ExcludeDomains <string[]>] [-IncludeDomains <string[]>] [-ExtendedForestInformation <IDictionary>] [-AsHashTable] [-Summary] [<CommonParameters>]

Filter

Get-GPOZaurrLink [-Filter <string>] [-SearchBase <string>] [-SearchScope <ADSearchScope>] [-Limited] [-SkipDuplicates] [-GPOCache <IDictionary>] [-Forest <string>] [-ExcludeDomains <string[]>] [-IncludeDomains <string[]>] [-ExtendedForestInformation <IDictionary>] [-AsHashTable] [-Summary] [<CommonParameters>]

Site

Get-GPOZaurrLink [-Site <string[]>] [-GPOCache <IDictionary>] [-Forest <string>] [-ExcludeDomains <string[]>] [-IncludeDomains <string[]>] [-ExtendedForestInformation <IDictionary>] [-AsHashTable] [-Summary] [<CommonParameters>]

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

PS > Get-GPOZaurrLink -ADObject $ADObject -Linked 'All'

Description

Retrieves all linked GPOZaurr links for the specified Active Directory object(s).

EXAMPLE 2

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.

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

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.

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

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.

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.

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.

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.

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.

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

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.

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.

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.

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.

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

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.

INPUTS

• ADObject[]

OUTPUTS

• None

RELATED LINKS

• None