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.
5.6 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-GPOZaurrAD
SYNOPSIS
Retrieves Group Policy Objects (GPOs) information from Active Directory.
SYNTAX
Default (Default)
Get-GPOZaurrAD [-Forest <string>] [-ExcludeDomains <string[]>] [-IncludeDomains <string[]>] [-DateFrom <datetime>] [-DateTo <datetime>] [-DateRange <string>] [-DateProperty <string[]>] [-ExtendedForestInformation <IDictionary>] [<CommonParameters>]
GPOName
Get-GPOZaurrAD [-GPOName <string>] [-Forest <string>] [-ExcludeDomains <string[]>] [-IncludeDomains <string[]>] [-DateFrom <datetime>] [-DateTo <datetime>] [-DateRange <string>] [-DateProperty <string[]>] [-ExtendedForestInformation <IDictionary>] [<CommonParameters>]
GPOGUID
Get-GPOZaurrAD [-GPOGuid <string>] [-Forest <string>] [-ExcludeDomains <string[]>] [-IncludeDomains <string[]>] [-DateFrom <datetime>] [-DateTo <datetime>] [-DateRange <string>] [-DateProperty <string[]>] [-ExtendedForestInformation <IDictionary>] [<CommonParameters>]
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
PS > Get-GPOZaurrAD -GPOName "ExampleGPO"
Description: Retrieves information about a GPO with the name "ExampleGPO".
EXAMPLE 2
PS > Get-GPOZaurrAD -GPOGuid "{12345678-1234-1234-1234-123456789012}"
Description: Retrieves information about a GPO with the specified GUID.
EXAMPLE 3
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
INPUTS
None
OUTPUTS
None
RELATED LINKS
- None