API Reference
Function
Invoke-GPOZaurrContent
Invokes GPOZaurrContent function to retrieve Group Policy Objects information.
Remarks
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.
Common Parameters
This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see about_CommonParameters.
Syntax
Invoke-GPOZaurrContent [-CategoriesOnly] [-ExcludeDomains <String[]>] [-Extended] [-ExtendedForestInformation <IDictionary>] [-Forest <String>] [-FullObjects] [-GPOGUID <String[]>] [-GPOName <String[]>] [-IncludeDomains <String[]>] [-Online] [-Open] [-OutputPath <String>] [-OutputType <HTML|Object>] [-SingleObject] [-SkipCleanup] [-SkipNormalize] [-Splitter <String>] [-Type <String[]>] [<CommonParameters>]
#
Parameter set:
DefaultParameters
- CategoriesOnly SwitchParameter
- Indicates whether to retrieve only categories.
- ExcludeDomains String[]
- Specifies an array of domains to exclude from the search.
- Extended SwitchParameter
- ExtendedForestInformation IDictionary
- Specifies additional information about the forest.
- Forest String
- Specifies the forest name to search for Group Policy Objects.
- FullObjects SwitchParameter
- Indicates whether to retrieve full objects.
- GPOGUID String[]
- GPOName String[]
- IncludeDomains String[]
- Specifies an array of domains to include in the search.
- Online SwitchParameter
- Indicates whether to retrieve information online.
- Open SwitchParameter
- Indicates whether to open the output after retrieval.
- OutputPath String
- Specifies the path to save the output.
- OutputType String[]
- Specifies the type of output (HTML or Object).
- Possible values:
HTML,Object - SingleObject SwitchParameter
- Indicates whether to retrieve a single object.
- SkipCleanup SwitchParameter
- SkipNormalize SwitchParameter
- Indicates whether to skip normalization.
- Splitter String
- Specifies the delimiter to use for splitting information.
- Type String[]
- Specifies the type of information to retrieve.
Invoke-GPOZaurrContent [-CategoriesOnly] [-Extended] [-FullObjects] [-GPOPath <String>] [-Online] [-Open] [-OutputPath <String>] [-OutputType <HTML|Object>] [-SingleObject] [-SkipCleanup] [-SkipNormalize] [-Splitter <String>] [-Type <String[]>] [<CommonParameters>]
#
Parameter set:
LocalParameters
- CategoriesOnly SwitchParameter
- Indicates whether to retrieve only categories.
- Extended SwitchParameter
- FullObjects SwitchParameter
- Indicates whether to retrieve full objects.
- GPOPath String
- Specifies the path to a specific Group Policy Object.
- Online SwitchParameter
- Indicates whether to retrieve information online.
- Open SwitchParameter
- Indicates whether to open the output after retrieval.
- OutputPath String
- Specifies the path to save the output.
- OutputType String[]
- Specifies the type of output (HTML or Object).
- Possible values:
HTML,Object - SingleObject SwitchParameter
- Indicates whether to retrieve a single object.
- SkipCleanup SwitchParameter
- SkipNormalize SwitchParameter
- Indicates whether to skip normalization.
- Splitter String
- Specifies the delimiter to use for splitting information.
- Type String[]
- Specifies the type of information to retrieve.