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.
7.8 KiB
7.8 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 |
Invoke-GPOZaurrContent
SYNOPSIS
Invokes GPOZaurrContent function to retrieve Group Policy Objects information.
SYNTAX
Default (Default)
Invoke-GPOZaurrContent [-Forest <string>] [-ExcludeDomains <string[]>] [-IncludeDomains <string[]>] [-ExtendedForestInformation <IDictionary>] [-Type <string[]>] [-Splitter <string>] [-FullObjects] [-OutputType <string[]>] [-OutputPath <string>] [-Open] [-Online] [-CategoriesOnly] [-SingleObject] [-SkipNormalize] [-SkipCleanup] [-Extended] [-GPOName <string[]>] [-GPOGUID <string[]>] [<CommonParameters>]
Local
Invoke-GPOZaurrContent [-GPOPath <string>] [-Type <string[]>] [-Splitter <string>] [-FullObjects] [-OutputType <string[]>] [-OutputPath <string>] [-Open] [-Online] [-CategoriesOnly] [-SingleObject] [-SkipNormalize] [-SkipCleanup] [-Extended] [<CommonParameters>]
DESCRIPTION
This function retrieves Group Policy Objects information based on the specified parameters. It can search for GPOs in a forest, exclude specific domains, include specific domains, and provide extended forest information.
EXAMPLES
EXAMPLE 1
PS > Invoke-GPOZaurrContent -Forest "Contoso" -IncludeDomains "Domain1", "Domain2" -Type "Security" -OutputType "HTML" -OutputPath "C:\Reports\GPOReport.html"
Retrieves security-related Group Policy Objects information for the specified domains and saves the output as an HTML file.
EXAMPLE 2
PS > Invoke-GPOZaurrContent -GPOPath "CN={31B2F340-016D-11D2-945F-00C04FB984F9},CN=Policies,CN=System,DC=Contoso,DC=com" -Type "All" -OutputType "Object"
Retrieves all information for a specific Group Policy Object and outputs the result as an object.
EXAMPLE 3
PS > Invoke-GPOZaurrContent -GPOName "Group Policy Test" -SingleObject | ConvertTo-Json -Depth 3
Quickly view GPO settings by name in JSON format for easy inspection.
PARAMETERS
-CategoriesOnly
Indicates whether to retrieve only categories.
Type: SwitchParameter
Parameter Sets: Default, Local
Aliases:
Possible values:
Required: False
Position: named
Default value: False
Accept pipeline input: False
Accept wildcard characters: True
-ExcludeDomains
Specifies an array of domains to exclude from the search.
Type: String[]
Parameter Sets: Default
Aliases:
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-Extended
{{ Fill Extended Description }}
Type: SwitchParameter
Parameter Sets: Default, Local
Aliases:
Possible values:
Required: False
Position: named
Default value: False
Accept pipeline input: False
Accept wildcard characters: True
-ExtendedForestInformation
Specifies additional information about the forest.
Type: IDictionary
Parameter Sets: Default
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 Group Policy Objects.
Type: String
Parameter Sets: Default
Aliases: ForestName
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-FullObjects
Indicates whether to retrieve full objects.
Type: SwitchParameter
Parameter Sets: Default, Local
Aliases:
Possible values:
Required: False
Position: named
Default value: False
Accept pipeline input: False
Accept wildcard characters: True
-GPOGUID
{{ Fill GPOGUID Description }}
Type: String[]
Parameter Sets: Default
Aliases:
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-GPOName
{{ Fill GPOName Description }}
Type: String[]
Parameter Sets: Default
Aliases: Name
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-GPOPath
Specifies the path to a specific Group Policy Object.
Type: String
Parameter Sets: Local
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
Aliases: Domain, Domains
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-Online
Indicates whether to retrieve information online.
Type: SwitchParameter
Parameter Sets: Default, Local
Aliases:
Possible values:
Required: False
Position: named
Default value: False
Accept pipeline input: False
Accept wildcard characters: True
-Open
Indicates whether to open the output after retrieval.
Type: SwitchParameter
Parameter Sets: Default, Local
Aliases:
Possible values:
Required: False
Position: named
Default value: False
Accept pipeline input: False
Accept wildcard characters: True
-OutputPath
Specifies the path to save the output.
Type: String
Parameter Sets: Default, Local
Aliases:
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-OutputType
Specifies the type of output (HTML or Object).
Type: String[]
Parameter Sets: Default, Local
Aliases:
Possible values: HTML, Object
Required: False
Position: named
Default value: Object
Accept pipeline input: False
Accept wildcard characters: True
-SingleObject
Indicates whether to retrieve a single object.
Type: SwitchParameter
Parameter Sets: Default, Local
Aliases:
Possible values:
Required: False
Position: named
Default value: False
Accept pipeline input: False
Accept wildcard characters: True
-SkipCleanup
{{ Fill SkipCleanup Description }}
Type: SwitchParameter
Parameter Sets: Default, Local
Aliases:
Possible values:
Required: False
Position: named
Default value: False
Accept pipeline input: False
Accept wildcard characters: True
-SkipNormalize
Indicates whether to skip normalization.
Type: SwitchParameter
Parameter Sets: Default, Local
Aliases:
Possible values:
Required: False
Position: named
Default value: False
Accept pipeline input: False
Accept wildcard characters: True
-Splitter
Specifies the delimiter to use for splitting information.
Type: String
Parameter Sets: Default, Local
Aliases:
Possible values:
Required: False
Position: named
Default value: [System.Environment]::NewLine
Accept pipeline input: False
Accept wildcard characters: True
-Type
Specifies the type of information to retrieve.
Type: String[]
Parameter Sets: Default, Local
Aliases:
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