GPOZaurr/Docs/Invoke-GPOZaurr.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

Invoke-GPOZaurr

SYNOPSIS

Single cmdlet that provides 360 degree overview of Group Policies in Active Directory Forest.

SYNTAX

__AllParameterSets

Invoke-GPOZaurr [[-Type] <string[]>] [[-Exclusions] <Object>] [-FilePath <string>] [-PassThru] [-HideHTML] [-HideSteps] [-ShowError] [-ShowWarning] [-Forest <string>] [-ExcludeDomains <string[]>] [-IncludeDomains <string[]>] [-Online] [-SplitReports] [-GPOName <string[]>] [-GPOGUID <string[]>] [<CommonParameters>]

DESCRIPTION

Single cmdlet that provides 360 degree overview of Group Policies in Active Directory Forest with ability to pick reports and export to HTML.

EXAMPLES

EXAMPLE 1

PS > Invoke-GPOZaurr

EXAMPLE 2

PS > Invoke-GPOZaurr -Type GPOOrganizationalUnit -Online -FilePath $PSScriptRoot\Reports\GPOZaurrOU.html -Exclusions @(
    '*OU=Production,DC=ad,DC=evotec,DC=pl'
)

PARAMETERS

-ExcludeDomains

Exclude domain from search, by default whole forest is scanned

Type: String[]
Parameter Sets: __AllParameterSets
Aliases:
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Exclusions

Allows to mark as excluded some Group Policies or Organizational Units depending on type. Can be a scriptblock or array depending on supported way by underlying report. Not every report support exclusions. Not every report support exclusions the same way. Exclusions should be used only if there is single report being asked for.

Type: Object
Parameter Sets: __AllParameterSets
Aliases: ExcludeGroupPolicies, ExclusionsCode
Possible values:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-FilePath

Path to the file where the report will be saved.

Type: String
Parameter Sets: __AllParameterSets
Aliases:
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Forest

Target different Forest, by default current forest is used

Type: String
Parameter Sets: __AllParameterSets
Aliases: ForestName
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-GPOGUID

{{ Fill GPOGUID Description }}

Type: String[]
Parameter Sets: __AllParameterSets
Aliases: GUID
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: __AllParameterSets
Aliases: Name
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-HideHTML

Do not auto open HTML report in default browser

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases:
Possible values:

Required: False
Position: named
Default value: False
Accept pipeline input: False
Accept wildcard characters: True

-HideSteps

Do not show steps in report

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases:
Possible values:

Required: False
Position: named
Default value: False
Accept pipeline input: False
Accept wildcard characters: True

-IncludeDomains

Include only specific domains, by default whole forest is scanned

Type: String[]
Parameter Sets: __AllParameterSets
Aliases: Domain, Domains
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Online

Forces report to use online resources in HTML (using CDN most of the time), by default it is run offline, and inlines all CSS/JS code.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases:
Possible values:

Required: False
Position: named
Default value: False
Accept pipeline input: False
Accept wildcard characters: True

-PassThru

Returns created objects after the report is done

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases:
Possible values:

Required: False
Position: named
Default value: False
Accept pipeline input: False
Accept wildcard characters: True

-ShowError

Show errors in HTML report. Useful in case the report is being run as Scheduled Task

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases:
Possible values:

Required: False
Position: named
Default value: False
Accept pipeline input: False
Accept wildcard characters: True

-ShowWarning

Show warnings in HTML report. Useful in case the report is being run as Scheduled Task

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases:
Possible values:

Required: False
Position: named
Default value: False
Accept pipeline input: False
Accept wildcard characters: True

-SplitReports

Split report into multiple files, one for each report. This can be useful for large domains with huge reports.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases:
Possible values:

Required: False
Position: named
Default value: False
Accept pipeline input: False
Accept wildcard characters: True

-Type

Type of report to be generated from a list of available reports.

Type: String[]
Parameter Sets: __AllParameterSets
Aliases:
Possible values:

Required: False
Position: 0
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