mirror of
https://github.com/EvotecIT/GPOZaurr.git
synced 2026-07-26 11:49:17 +00:00
Przemysław Kłys
f7bdaca724
- Revised `Set-GPOZaurrOwner.md` to enhance clarity and detail for parameters and examples. - Updated `Set-GPOZaurrStatus.md` with a new online version link and improved structure. - Refined `Skip-GroupPolicy.md` to clarify usage within script blocks and added examples. - Adjusted `GPOZaurr.psd1` for version updates and improved module dependencies. - Enhanced `GPOZaurr.psm1` for better error handling during function imports. - Modified `Invoke-GPOZaurrSupport.ps1` examples to use `Join-Path` for path construction.
312 lines
7.0 KiB
Markdown
312 lines
7.0 KiB
Markdown
---
|
|
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 <string[]>] [-Limited] [-SkipDuplicates] [-GPOCache <IDictionary>] [-Forest <string>] [-ExcludeDomains <string[]>] [-IncludeDomains <string[]>] [-ExtendedForestInformation <IDictionary>] [-AsHashTable] [-Summary] [<CommonParameters>]
|
|
```
|
|
|
|
### ADObject
|
|
```powershell
|
|
Get-GPOZaurrLink -ADObject <ADObject[]> [-Limited] [-SkipDuplicates] [-GPOCache <IDictionary>] [-Forest <string>] [-ExcludeDomains <string[]>] [-IncludeDomains <string[]>] [-ExtendedForestInformation <IDictionary>] [-AsHashTable] [-Summary] [<CommonParameters>]
|
|
```
|
|
|
|
### Filter
|
|
```powershell
|
|
Get-GPOZaurrLink [-Filter <string>] [-SearchBase <string>] [-SearchScope <ADSearchScope>] [-Limited] [-SkipDuplicates] [-GPOCache <IDictionary>] [-Forest <string>] [-ExcludeDomains <string[]>] [-IncludeDomains <string[]>] [-ExtendedForestInformation <IDictionary>] [-AsHashTable] [-Summary] [<CommonParameters>]
|
|
```
|
|
|
|
### Site
|
|
```powershell
|
|
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
|
|
```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
|
|
|