From 5a578278d00d1523d256423d24a5b40f8f39ebfa Mon Sep 17 00:00:00 2001 From: Przemyslaw Klys Date: Fri, 3 Dec 2021 22:32:16 +0100 Subject: [PATCH] Updated docs --- Docs/Get-GPOZaurr.md | 2 +- Docs/Get-GPOZaurrAD.md | 65 +++++++ Docs/Get-GPOZaurrBroken.md | 178 +++++++++---------- Docs/Get-GPOZaurrBrokenLink.md | 107 ++++++++++++ Docs/Get-GPOZaurrInheritance.md | 149 ++++++++++------ Docs/Get-GPOZaurrLink.md | 71 +++++++- Docs/Get-GPOZaurrOrganizationalUnit.md | 138 +++++++++++++++ Docs/Get-GPOZaurrOwner.md | 21 ++- Docs/Get-GPOZaurrPermissionAnalysis.md | 106 ++++++++++++ Docs/Get-GPOZaurrSysvolDFSR.md | 164 +++++++++--------- Docs/Get-GPOZaurrUpdates.md | 176 +++++++++++++++++++ Docs/Invoke-GPOZaurr.md | 227 ++++++++++++++----------- Docs/Invoke-GPOZaurrPermission.md | 2 +- Docs/Invoke-GPOZaurrSupport.md | 21 +-- Docs/Readme.md | 31 +++- Docs/Remove-GPOZaurr.md | 19 ++- Docs/Remove-GPOZaurrBroken.md | 185 ++++++++++---------- Docs/Remove-GPOZaurrLinkEmptyOU.md | 168 ++++++++++++++++++ Docs/Repair-GPOZaurrBrokenLink.md | 156 +++++++++++++++++ Docs/Repair-GPOZaurrNetLogonOwner.md | 136 ++++++++------- Docs/Repair-GPOZaurrPermission.md | 169 ++++++++++++++++++ Docs/Save-GPOZaurrFiles.md | 104 ++++++----- Docs/Set-GPOZaurrOwner.md | 38 ++++- Docs/Skip-GroupPolicy.md | 29 +++- 24 files changed, 1879 insertions(+), 583 deletions(-) create mode 100644 Docs/Get-GPOZaurrBrokenLink.md create mode 100644 Docs/Get-GPOZaurrOrganizationalUnit.md create mode 100644 Docs/Get-GPOZaurrPermissionAnalysis.md create mode 100644 Docs/Get-GPOZaurrUpdates.md create mode 100644 Docs/Remove-GPOZaurrLinkEmptyOU.md create mode 100644 Docs/Repair-GPOZaurrBrokenLink.md create mode 100644 Docs/Repair-GPOZaurrPermission.md diff --git a/Docs/Get-GPOZaurr.md b/Docs/Get-GPOZaurr.md index 0bd735e..0e3c147 100644 --- a/Docs/Get-GPOZaurr.md +++ b/Docs/Get-GPOZaurr.md @@ -235,7 +235,7 @@ Accept wildcard characters: False Type: String[] Parameter Sets: (All) Aliases: -Accepted values: Empty, Unlinked, Disabled, All +Accepted values: Empty, Unlinked, Disabled, NoApplyPermission, All Required: False Position: 3 diff --git a/Docs/Get-GPOZaurrAD.md b/Docs/Get-GPOZaurrAD.md index c768483..1af7251 100644 --- a/Docs/Get-GPOZaurrAD.md +++ b/Docs/Get-GPOZaurrAD.md @@ -15,18 +15,21 @@ schema: 2.0.0 ### Default (Default) ``` Get-GPOZaurrAD [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] + [-DateFrom ] [-DateTo ] [-DateRange ] [-DateProperty ] [-ExtendedForestInformation ] [] ``` ### GPOName ``` Get-GPOZaurrAD [-GPOName ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] + [-DateFrom ] [-DateTo ] [-DateRange ] [-DateProperty ] [-ExtendedForestInformation ] [] ``` ### GPOGUID ``` Get-GPOZaurrAD [-GPOGuid ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] + [-DateFrom ] [-DateTo ] [-DateRange ] [-DateProperty ] [-ExtendedForestInformation ] [] ``` @@ -44,6 +47,68 @@ PS C:\> {{ Add example code here }} ## PARAMETERS +### -DateFrom +{{ Fill DateFrom Description }} + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DateProperty +{{ Fill DateProperty Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Accepted values: WhenCreated, WhenChanged + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DateRange +{{ Fill DateRange Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted 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: False +``` + +### -DateTo +{{ Fill DateTo Description }} + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExcludeDomains {{ Fill ExcludeDomains Description }} diff --git a/Docs/Get-GPOZaurrBroken.md b/Docs/Get-GPOZaurrBroken.md index 9c0470c..62bc198 100644 --- a/Docs/Get-GPOZaurrBroken.md +++ b/Docs/Get-GPOZaurrBroken.md @@ -8,32 +8,51 @@ schema: 2.0.0 # Get-GPOZaurrBroken ## SYNOPSIS -{{ Fill in the Synopsis }} +Detects broken or otherwise damaged Group Policies ## SYNTAX ``` Get-GPOZaurrBroken [[-Forest] ] [[-ExcludeDomains] ] [[-ExcludeDomainControllers] ] - [[-IncludeDomains] ] [[-IncludeDomainControllers] ] [-SkipRODC] [[-GPOs] ] + [[-IncludeDomains] ] [[-IncludeDomainControllers] ] [-SkipRODC] [[-ExtendedForestInformation] ] [-VerifyDomainControllers] [] ``` ## DESCRIPTION -{{ Fill in the Description }} +Detects broken or otherwise damaged Group Policies providing insight whether GPO exists in both AD and SYSVOL. +It provides few statuses: +- Permissions issue - means account couldn't read GPO due to permissions +- ObjectClass issue - means that ObjectClass is of type Container, rather than expected groupPolicyContainer +- Not available on SYSVOL - means SYSVOL data is missing, yet AD metadata is available +- Not available in AD - means AD metadata is missing, yet SYSVOL data is available +- Exists - means AD metadata and SYSVOL data are available ## EXAMPLES -### Example 1 -```powershell -PS C:\> {{ Add example code here }} +### EXAMPLE 1 +``` +Get-GPOZaurrBroken -Verbose | Format-Table ``` - -{{ Add example description here }} ## PARAMETERS -### -ExcludeDomainControllers -{{ Fill ExcludeDomainControllers Description }} +### -Forest +Target different Forest, by default current forest is used + +```yaml +Type: String +Parameter Sets: (All) +Aliases: ForestName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned ```yaml Type: String[] @@ -47,8 +66,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} +### -ExcludeDomainControllers +Exclude specific domain controllers, by default there are no exclusions, as long as VerifyDomainControllers switch is enabled. +Otherwise this parameter is ignored. ```yaml Type: String[] @@ -56,14 +76,61 @@ Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -IncludeDomains +Include only specific domains, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: Domain, Domains + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDomainControllers +Include only specific domain controllers, by default all domain controllers are included, as long as VerifyDomainControllers switch is enabled. +Otherwise this parameter is ignored. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: DomainControllers + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipRODC +Skip Read-Only Domain Controllers. +By default all domain controllers are included. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} +Ability to provide Forest Information from another command to speed up processing ```yaml Type: IDictionary @@ -77,83 +144,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOs -{{ Fill GPOs Description }} - -```yaml -Type: Array -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomainControllers -{{ Fill IncludeDomainControllers Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: DomainControllers - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipRODC -{{ Fill SkipRODC Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -VerifyDomainControllers -{{ Fill VerifyDomainControllers Description }} +Forces cmdlet to check GPO Existance on Domain Controllers rather then per domain ```yaml Type: SwitchParameter @@ -162,7 +154,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -172,11 +164,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### None - ## OUTPUTS -### System.Object ## NOTES +General notes ## RELATED LINKS diff --git a/Docs/Get-GPOZaurrBrokenLink.md b/Docs/Get-GPOZaurrBrokenLink.md new file mode 100644 index 0000000..53510f2 --- /dev/null +++ b/Docs/Get-GPOZaurrBrokenLink.md @@ -0,0 +1,107 @@ +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: +schema: 2.0.0 +--- + +# Get-GPOZaurrBrokenLink + +## SYNOPSIS +Finds any GPO link that doesn't have a matching GPO (already removed GPO). + +## SYNTAX + +``` +Get-GPOZaurrBrokenLink [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] + [[-ExtendedForestInformation] ] [] +``` + +## DESCRIPTION +Finds any GPO link that doesn't have a matching GPO (already removed GPO). + +## EXAMPLES + +### EXAMPLE 1 +``` +Get-GPOZaurrBrokenLink -Verbose | Format-Table -AutoSize * +``` + +### EXAMPLE 2 +``` +Get-GPOZaurrBrokenLink -Verbose -IncludeDomains ad.evotec.pl | Format-Table -AutoSize * +``` + +## PARAMETERS + +### -Forest +Target different Forest, by default current forest is used + +```yaml +Type: String +Parameter Sets: (All) +Aliases: ForestName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDomains +Include only specific domains, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: Domain, Domains + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedForestInformation +Ability to provide Forest Information from another command to speed up processing + +```yaml +Type: IDictionary +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### 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 + +## OUTPUTS + +## NOTES +General notes + +## RELATED LINKS diff --git a/Docs/Get-GPOZaurrInheritance.md b/Docs/Get-GPOZaurrInheritance.md index 315d7fc..b30367d 100644 --- a/Docs/Get-GPOZaurrInheritance.md +++ b/Docs/Get-GPOZaurrInheritance.md @@ -8,32 +8,96 @@ schema: 2.0.0 # Get-GPOZaurrInheritance ## SYNOPSIS -{{ Fill in the Synopsis }} +Short description ## SYNTAX ``` -Get-GPOZaurrInheritance [-IncludeBlockedObjects] [-OnlyBlockedInheritance] [[-Forest] ] +Get-GPOZaurrInheritance [-IncludeBlockedObjects] [-OnlyBlockedInheritance] [-IncludeExcludedObjects] + [-IncludeGroupPoliciesForBlockedObjects] [[-Exclusions] ] [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [] ``` ## DESCRIPTION -{{ Fill in the Description }} +Long description ## EXAMPLES -### Example 1 -```powershell -PS C:\> {{ Add example code here }} +### EXAMPLE 1 +``` +$Objects = Get-GPOZaurrInheritance -IncludeBlockedObjects -IncludeExcludedObjects -OnlyBlockedInheritance -Exclusions $ExcludedOU ``` -{{ Add example description here }} +$Objects | Format-Table ## PARAMETERS -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} +### -IncludeBlockedObjects +Include OU's with blocked inheritance. +Default disabled + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnlyBlockedInheritance +Show only OU's with blocked inheritance + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeExcludedObjects +Show excluded objets. +Default disabled + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeGroupPoliciesForBlockedObjects +{{ Fill IncludeGroupPoliciesForBlockedObjects Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Exclusions +Provide exclusions for OU's approved by IT. +You can provide OU by canonical name or distinguishedName ```yaml Type: String[] @@ -47,11 +111,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} +### -Forest +Target different Forest, by default current forest is used ```yaml -Type: IDictionary +Type: String +Parameter Sets: (All) +Aliases: ForestName + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned + +```yaml +Type: String[] Parameter Sets: (All) Aliases: @@ -62,38 +141,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeBlockedObjects -{{ Fill IncludeBlockedObjects Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -IncludeDomains -{{ Fill IncludeDomains Description }} +Include only specific domains, by default whole forest is scanned ```yaml Type: String[] @@ -101,22 +150,22 @@ Parameter Sets: (All) Aliases: Domain, Domains Required: False -Position: 2 +Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OnlyBlockedInheritance -{{ Fill OnlyBlockedInheritance Description }} +### -ExtendedForestInformation +Ability to provide Forest Information from another command to speed up processing ```yaml -Type: SwitchParameter +Type: IDictionary Parameter Sets: (All) Aliases: Required: False -Position: Named +Position: 5 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -127,11 +176,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### None - ## OUTPUTS -### System.Object ## NOTES +General notes ## RELATED LINKS diff --git a/Docs/Get-GPOZaurrLink.md b/Docs/Get-GPOZaurrLink.md index 4d4a4a2..c15cafa 100644 --- a/Docs/Get-GPOZaurrLink.md +++ b/Docs/Get-GPOZaurrLink.md @@ -12,24 +12,32 @@ schema: 2.0.0 ## SYNTAX +### Linked (Default) +``` +Get-GPOZaurrLink [-Linked ] [-Limited] [-SkipDuplicates] [-GPOCache ] [-Forest ] + [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] + [-AsHashTable] [-Summary] [] +``` + ### ADObject ``` Get-GPOZaurrLink -ADObject [-Limited] [-SkipDuplicates] [-GPOCache ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] - [-ExtendedForestInformation ] [] + [-ExtendedForestInformation ] [-AsHashTable] [-Summary] [] ``` ### Filter ``` Get-GPOZaurrLink [-Filter ] [-SearchBase ] [-SearchScope ] [-Limited] [-SkipDuplicates] [-GPOCache ] [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [-ExtendedForestInformation ] [] + [-IncludeDomains ] [-ExtendedForestInformation ] [-AsHashTable] [-Summary] + [] ``` -### Linked +### Site ``` -Get-GPOZaurrLink -Linked [-Limited] [-SkipDuplicates] [-GPOCache ] [-Forest ] - [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] +Get-GPOZaurrLink [-Site ] [-GPOCache ] [-Forest ] [-ExcludeDomains ] + [-IncludeDomains ] [-ExtendedForestInformation ] [-AsHashTable] [-Summary] [] ``` @@ -62,6 +70,21 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` +### -AsHashTable +{{ Fill AsHashTable Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExcludeDomains {{ Fill ExcludeDomains Description }} @@ -157,7 +180,7 @@ Accept wildcard characters: False ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: Linked, ADObject, Filter Aliases: Required: False @@ -171,12 +194,12 @@ Accept wildcard characters: False {{ Fill Linked Description }} ```yaml -Type: String +Type: String[] Parameter Sets: Linked Aliases: -Accepted values: Root, DomainControllers, Site, Other +Accepted values: All, Root, DomainControllers, Site, OrganizationalUnit -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -214,9 +237,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Site +{{ Fill Site Description }} + +```yaml +Type: String[] +Parameter Sets: Site +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SkipDuplicates {{ Fill SkipDuplicates Description }} +```yaml +Type: SwitchParameter +Parameter Sets: Linked, ADObject, Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Summary +{{ Fill Summary Description }} + ```yaml Type: SwitchParameter Parameter Sets: (All) diff --git a/Docs/Get-GPOZaurrOrganizationalUnit.md b/Docs/Get-GPOZaurrOrganizationalUnit.md new file mode 100644 index 0000000..08328b7 --- /dev/null +++ b/Docs/Get-GPOZaurrOrganizationalUnit.md @@ -0,0 +1,138 @@ +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: +schema: 2.0.0 +--- + +# Get-GPOZaurrOrganizationalUnit + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-GPOZaurrOrganizationalUnit [[-Forest] ] [[-ExcludeDomains] ] + [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [[-Option] ] + [[-ExcludeOrganizationalUnit] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -ExcludeDomains +{{ Fill ExcludeDomains Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeOrganizationalUnit +{{ Fill ExcludeOrganizationalUnit Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: ExcludeOU, Exclusions + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedForestInformation +{{ Fill ExtendedForestInformation Description }} + +```yaml +Type: IDictionary +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Forest +{{ Fill Forest Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: ForestName + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDomains +{{ Fill IncludeDomains Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: Domain, Domains + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Option +{{ Fill Option Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Accepted values: OK, Unlink, Delete + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### 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 + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/Docs/Get-GPOZaurrOwner.md b/Docs/Get-GPOZaurrOwner.md index e628beb..2fb7dca 100644 --- a/Docs/Get-GPOZaurrOwner.md +++ b/Docs/Get-GPOZaurrOwner.md @@ -16,21 +16,21 @@ Gets owners of GPOs from Active Directory and SYSVOL ``` Get-GPOZaurrOwner [-IncludeSysvol] [-SkipBroken] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] - [-ADAdministrativeGroups ] [] + [-ADAdministrativeGroups ] [-ApprovedOwner ] [] ``` ### GPOName ``` Get-GPOZaurrOwner [-GPOName ] [-IncludeSysvol] [-SkipBroken] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] - [-ADAdministrativeGroups ] [] + [-ADAdministrativeGroups ] [-ApprovedOwner ] [] ``` ### GPOGUID ``` Get-GPOZaurrOwner [-GPOGuid ] [-IncludeSysvol] [-SkipBroken] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] - [-ADAdministrativeGroups ] [] + [-ADAdministrativeGroups ] [-ApprovedOwner ] [] ``` ## DESCRIPTION @@ -187,6 +187,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ApprovedOwner +Ability to provide different owner (non administrative that still is approved for use) + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: Exclusion, Exclusions + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### 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). diff --git a/Docs/Get-GPOZaurrPermissionAnalysis.md b/Docs/Get-GPOZaurrPermissionAnalysis.md new file mode 100644 index 0000000..21a1699 --- /dev/null +++ b/Docs/Get-GPOZaurrPermissionAnalysis.md @@ -0,0 +1,106 @@ +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: +schema: 2.0.0 +--- + +# Get-GPOZaurrPermissionAnalysis + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-GPOZaurrPermissionAnalysis [[-Forest] ] [[-ExcludeDomains] ] + [[-IncludeDomains] ] [[-Permissions] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -ExcludeDomains +{{ Fill ExcludeDomains Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Forest +{{ Fill Forest Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: ForestName + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDomains +{{ Fill IncludeDomains Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: Domain, Domains + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Permissions +{{ Fill Permissions Description }} + +```yaml +Type: Array +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### 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 + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/Docs/Get-GPOZaurrSysvolDFSR.md b/Docs/Get-GPOZaurrSysvolDFSR.md index 01ff14e..4f90495 100644 --- a/Docs/Get-GPOZaurrSysvolDFSR.md +++ b/Docs/Get-GPOZaurrSysvolDFSR.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-GPOZaurrSysvolDFSR ## SYNOPSIS -{{ Fill in the Synopsis }} +Gets DFSR information from the SYSVOL DFSR ## SYNTAX @@ -20,21 +20,36 @@ Get-GPOZaurrSysvolDFSR [[-Forest] ] [[-ExcludeDomains] ] ``` ## DESCRIPTION -{{ Fill in the Description }} +Gets DFSR information from the SYSVOL DFSR ## EXAMPLES -### Example 1 -```powershell -PS C:\> {{ Add example code here }} +### EXAMPLE 1 +``` +$DFSR = Get-GPOZaurrSysvolDFSR ``` -{{ Add example description here }} +$DFSR | Format-Table * ## PARAMETERS -### -ExcludeDomainControllers -{{ Fill ExcludeDomainControllers Description }} +### -Forest +Target different Forest, by default current forest is used + +```yaml +Type: String +Parameter Sets: (All) +Aliases: ForestName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned ```yaml Type: String[] @@ -48,74 +63,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} +### -ExcludeDomainControllers +Exclude specific domain controllers, by default there are no exclusions, as long as VerifyDomainControllers switch is enabled. +Otherwise this parameter is ignored. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomainControllers -{{ Fill IncludeDomainControllers Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: DomainControllers - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Domain, Domains - Required: False Position: 3 Default value: None @@ -123,11 +79,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchDFSR -{{ Fill SearchDFSR Description }} +### -IncludeDomains +Include only specific domains, by default whole forest is scanned ```yaml -Type: String +Type: String[] +Parameter Sets: (All) +Aliases: Domain, Domains + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDomainControllers +Include only specific domain controllers, by default all domain controllers are included, as long as VerifyDomainControllers switch is enabled. +Otherwise this parameter is ignored. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: DomainControllers + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipRODC +Skip Read-Only Domain Controllers. +By default all domain controllers are included. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedForestInformation +Ability to provide Forest Information from another command to speed up processing + +```yaml +Type: IDictionary Parameter Sets: (All) Aliases: @@ -138,17 +141,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipRODC -{{ Fill SkipRODC Description }} +### -SearchDFSR +Define DFSR Share. +By default it uses SYSVOL Share ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: None +Position: 7 +Default value: SYSVOL Share Accept pipeline input: False Accept wildcard characters: False ``` @@ -158,11 +162,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### None - ## OUTPUTS -### System.Object ## NOTES +General notes ## RELATED LINKS diff --git a/Docs/Get-GPOZaurrUpdates.md b/Docs/Get-GPOZaurrUpdates.md new file mode 100644 index 0000000..633243f --- /dev/null +++ b/Docs/Get-GPOZaurrUpdates.md @@ -0,0 +1,176 @@ +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: +schema: 2.0.0 +--- + +# Get-GPOZaurrUpdates + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### DateRange (Default) +``` +Get-GPOZaurrUpdates [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] + -DateRange [-DateProperty ] [-ExtendedForestInformation ] [] +``` + +### Dates +``` +Get-GPOZaurrUpdates [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] + -DateFrom -DateTo [-DateProperty ] [-ExtendedForestInformation ] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -DateFrom +{{ Fill DateFrom Description }} + +```yaml +Type: DateTime +Parameter Sets: Dates +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DateProperty +{{ Fill DateProperty Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Accepted values: WhenCreated, WhenChanged + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DateRange +{{ Fill DateRange Description }} + +```yaml +Type: String +Parameter Sets: DateRange +Aliases: +Accepted values: PastHour, CurrentHour, PastDay, CurrentDay, PastMonth, CurrentMonth, PastQuarter, CurrentQuarter, Last14Days, Last21Days, Last30Days, Last7Days, Last3Days, Last1Days + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DateTo +{{ Fill DateTo Description }} + +```yaml +Type: DateTime +Parameter Sets: Dates +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeDomains +{{ Fill ExcludeDomains Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedForestInformation +{{ Fill ExtendedForestInformation Description }} + +```yaml +Type: IDictionary +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Forest +{{ Fill Forest Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: ForestName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDomains +{{ Fill IncludeDomains Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: Domain, Domains + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### 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 + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/Docs/Invoke-GPOZaurr.md b/Docs/Invoke-GPOZaurr.md index e8b257f..01a6df0 100644 --- a/Docs/Invoke-GPOZaurr.md +++ b/Docs/Invoke-GPOZaurr.md @@ -8,62 +8,57 @@ schema: 2.0.0 # Invoke-GPOZaurr ## SYNOPSIS -{{ Fill in the Synopsis }} +Single cmdlet that provides 360 degree overview of Group Policies in Active Directory Forest. ## SYNTAX ``` -Invoke-GPOZaurr [[-ExcludeGroupPolicies] ] [-FilePath ] [[-Type] ] [-PassThru] - [-HideHTML] [-HideSteps] [-ShowError] [-ShowWarning] [-Forest ] [-ExcludeDomains ] - [-IncludeDomains ] [] +Invoke-GPOZaurr [[-Exclusions] ] [-FilePath ] [[-Type] ] [-PassThru] [-HideHTML] + [-HideSteps] [-ShowError] [-ShowWarning] [-Forest ] [-ExcludeDomains ] + [-IncludeDomains ] [-Online] [] ``` ## DESCRIPTION -{{ Fill in the 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 -```powershell -PS C:\> {{ Add example code here }} +### EXAMPLE 1 +``` +Invoke-GPOZaurr ``` -{{ Add example description here }} +### EXAMPLE 2 +``` +Invoke-GPOZaurr -Type GPOOrganizationalUnit -Online -FilePath $PSScriptRoot\Reports\GPOZaurrOU.html -Exclusions @( +``` + +'*OU=Production,DC=ad,DC=evotec,DC=pl' +) ## PARAMETERS -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} +### -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. ```yaml -Type: String[] +Type: Object Parameter Sets: (All) -Aliases: +Aliases: ExcludeGroupPolicies, ExclusionsCode Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeGroupPolicies -{{ Fill ExcludeGroupPolicies Description }} - -```yaml -Type: ScriptBlock -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -FilePath -{{ Fill FilePath Description }} +Path to the file where the report will be saved. ```yaml Type: String @@ -77,8 +72,100 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Type +Type of report to be generated from a list of available reports. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns created objects after the report is done + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HideHTML +Do not auto open HTML report in default browser + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HideSteps +Do not show steps in report + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowError +Show errors in HTML report. +Useful in case the report is being run as Scheduled Task + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowWarning +Show warnings in HTML report. +Useful in case the report is being run as Scheduled Task + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Forest -{{ Fill Forest Description }} +Target different Forest, by default current forest is used ```yaml Type: String @@ -92,26 +179,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HideHTML -{{ Fill HideHTML Description }} +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HideSteps -{{ Fill HideSteps Description }} - -```yaml -Type: SwitchParameter +Type: String[] Parameter Sets: (All) Aliases: @@ -123,7 +195,7 @@ Accept wildcard characters: False ``` ### -IncludeDomains -{{ Fill IncludeDomains Description }} +Include only specific domains, by default whole forest is scanned ```yaml Type: String[] @@ -137,8 +209,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -{{ Fill PassThru Description }} +### -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. ```yaml Type: SwitchParameter @@ -147,52 +219,7 @@ Aliases: Required: False Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowError -{{ Fill ShowError Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowWarning -{{ Fill ShowWarning Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -{{ Fill Type Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -202,11 +229,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### None - ## OUTPUTS -### System.Object ## NOTES +General notes ## RELATED LINKS diff --git a/Docs/Invoke-GPOZaurrPermission.md b/Docs/Invoke-GPOZaurrPermission.md index b35e71b..4399fa8 100644 --- a/Docs/Invoke-GPOZaurrPermission.md +++ b/Docs/Invoke-GPOZaurrPermission.md @@ -298,7 +298,7 @@ Accept wildcard characters: False Type: String Parameter Sets: Linked Aliases: -Accepted values: Root, DomainControllers, Site, Other +Accepted values: Root, DomainControllers, Site, OrganizationalUnit Required: True Position: Named diff --git a/Docs/Invoke-GPOZaurrSupport.md b/Docs/Invoke-GPOZaurrSupport.md index 2fdc92d..e326dc7 100644 --- a/Docs/Invoke-GPOZaurrSupport.md +++ b/Docs/Invoke-GPOZaurrSupport.md @@ -14,7 +14,7 @@ schema: 2.0.0 ``` Invoke-GPOZaurrSupport [[-Type] ] [[-ComputerName] ] [[-UserName] ] [[-Path] ] - [[-Splitter] ] [-PreventShow] [-Offline] [-ForceGPResult] [] + [[-Splitter] ] [-PreventShow] [-Online] [] ``` ## DESCRIPTION @@ -46,23 +46,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ForceGPResult -{{ Fill ForceGPResult Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Offline -{{ Fill Offline Description }} +### -Online +{{ Fill Online Description }} ```yaml Type: SwitchParameter diff --git a/Docs/Readme.md b/Docs/Readme.md index 60180f3..e2c035a 100644 --- a/Docs/Readme.md +++ b/Docs/Readme.md @@ -39,7 +39,10 @@ Provides Backup functionality to Group Policies {{ Fill in the Synopsis }} ### [Get-GPOZaurrBroken](Get-GPOZaurrBroken.md) -{{ Fill in the Synopsis }} +Detects broken or otherwise damaged Group Policies + +### [Get-GPOZaurrBrokenLink](Get-GPOZaurrBrokenLink.md) +Finds any GPO link that doesn't have a matching GPO (already removed GPO). ### [Get-GPOZaurrDictionary](Get-GPOZaurrDictionary.md) {{ Fill in the Synopsis }} @@ -57,7 +60,7 @@ Provides Backup functionality to Group Policies {{ Fill in the Synopsis }} ### [Get-GPOZaurrInheritance](Get-GPOZaurrInheritance.md) -{{ Fill in the Synopsis }} +Short description ### [Get-GPOZaurrLegacyFiles](Get-GPOZaurrLegacyFiles.md) {{ Fill in the Synopsis }} @@ -71,6 +74,9 @@ Provides Backup functionality to Group Policies ### [Get-GPOZaurrNetLogon](Get-GPOZaurrNetLogon.md) {{ Fill in the Synopsis }} +### [Get-GPOZaurrOrganizationalUnit](Get-GPOZaurrOrganizationalUnit.md) +{{ Fill in the Synopsis }} + ### [Get-GPOZaurrOwner](Get-GPOZaurrOwner.md) Gets owners of GPOs from Active Directory and SYSVOL @@ -80,6 +86,9 @@ Tries to find CPassword in Group Policies or given path and translate it to read ### [Get-GPOZaurrPermission](Get-GPOZaurrPermission.md) {{ Fill in the Synopsis }} +### [Get-GPOZaurrPermissionAnalysis](Get-GPOZaurrPermissionAnalysis.md) +{{ Fill in the Synopsis }} + ### [Get-GPOZaurrPermissionConsistency](Get-GPOZaurrPermissionConsistency.md) {{ Fill in the Synopsis }} @@ -93,13 +102,16 @@ Detects Group Policy missing Authenticated Users permission while not having hig {{ Fill in the Synopsis }} ### [Get-GPOZaurrSysvolDFSR](Get-GPOZaurrSysvolDFSR.md) +Gets DFSR information from the SYSVOL DFSR + +### [Get-GPOZaurrUpdates](Get-GPOZaurrUpdates.md) {{ Fill in the Synopsis }} ### [Get-GPOZaurrWMI](Get-GPOZaurrWMI.md) Get Group Policy WMI filter ### [Invoke-GPOZaurr](Invoke-GPOZaurr.md) -{{ Fill in the Synopsis }} +Single cmdlet that provides 360 degree overview of Group Policies in Active Directory Forest. ### [Invoke-GPOZaurrContent](Invoke-GPOZaurrContent.md) {{ Fill in the Synopsis }} @@ -123,7 +135,7 @@ Enables or disables user/computer section of group policy based on it's content. {{ Fill in the Synopsis }} ### [Remove-GPOZaurrBroken](Remove-GPOZaurrBroken.md) -{{ Fill in the Synopsis }} +Finds and removes broken Group Policies from SYSVOL or AD or both. ### [Remove-GPOZaurrDuplicateObject](Remove-GPOZaurrDuplicateObject.md) {{ Fill in the Synopsis }} @@ -134,13 +146,22 @@ Enables or disables user/computer section of group policy based on it's content. ### [Remove-GPOZaurrLegacyFiles](Remove-GPOZaurrLegacyFiles.md) {{ Fill in the Synopsis }} +### [Remove-GPOZaurrLinkEmptyOU](Remove-GPOZaurrLinkEmptyOU.md) +{{ Fill in the Synopsis }} + ### [Remove-GPOZaurrPermission](Remove-GPOZaurrPermission.md) {{ Fill in the Synopsis }} ### [Remove-GPOZaurrWMI](Remove-GPOZaurrWMI.md) {{ Fill in the Synopsis }} +### [Repair-GPOZaurrBrokenLink](Repair-GPOZaurrBrokenLink.md) +Removes any link to GPO that no longer exists. + ### [Repair-GPOZaurrNetLogonOwner](Repair-GPOZaurrNetLogonOwner.md) +Sets new owner to each file in NetLogon share. + +### [Repair-GPOZaurrPermission](Repair-GPOZaurrPermission.md) {{ Fill in the Synopsis }} ### [Repair-GPOZaurrPermissionConsistency](Repair-GPOZaurrPermissionConsistency.md) @@ -150,7 +171,7 @@ Enables or disables user/computer section of group policy based on it's content. {{ Fill in the Synopsis }} ### [Save-GPOZaurrFiles](Save-GPOZaurrFiles.md) -{{ Fill in the Synopsis }} +Exports GPO XML data to files and saves it to a given path ### [Set-GPOOwner](Set-GPOOwner.md) Used within Invoke-GPOZaurrPermission only. diff --git a/Docs/Remove-GPOZaurr.md b/Docs/Remove-GPOZaurr.md index 806ab77..92d620f 100644 --- a/Docs/Remove-GPOZaurr.md +++ b/Docs/Remove-GPOZaurr.md @@ -16,7 +16,7 @@ schema: 2.0.0 Remove-GPOZaurr [[-ExcludeGroupPolicies] ] [-Type] [-LimitProcessing ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-GPOPath ] [-BackupPath ] [-BackupDated] - [-WhatIf] [-Confirm] [] + [-RequireDays ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -183,6 +183,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RequireDays +{{ Fill RequireDays Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Type {{ Fill Type Description }} @@ -190,7 +205,7 @@ Accept wildcard characters: False Type: String[] Parameter Sets: (All) Aliases: -Accepted values: Empty, Unlinked, Disabled +Accepted values: Empty, Unlinked, Disabled, NoApplyPermission Required: True Position: 0 diff --git a/Docs/Remove-GPOZaurrBroken.md b/Docs/Remove-GPOZaurrBroken.md index 96585e8..7f7e677 100644 --- a/Docs/Remove-GPOZaurrBroken.md +++ b/Docs/Remove-GPOZaurrBroken.md @@ -8,35 +8,63 @@ schema: 2.0.0 # Remove-GPOZaurrBroken ## SYNOPSIS -{{ Fill in the Synopsis }} +Finds and removes broken Group Policies from SYSVOL or AD or both. ## SYNTAX ``` -Remove-GPOZaurrBroken [[-Type] ] [[-BackupPath] ] [-BackupDated] [[-LimitProcessing] ] - [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] - [[-ExtendedForestInformation] ] [-WhatIf] [-Confirm] [] +Remove-GPOZaurrBroken [-Type] [-BackupPath ] [-BackupDated] [-LimitProcessing ] + [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] + [-ExtendedForestInformation ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -{{ Fill in the Description }} +Finds and removes broken Group Policies from SYSVOL or AD or both. +Assesment is based on Get-GPOZaurrBroken and there are 3 supported types: +- AD - meaning GPOs which have no SYSVOL content will be deleted from AD +- SYSVOL - meaning GPOs which have no AD content will be deleted from SYSVOL +- ObjectClass - meaning GPOs which have ObjectClass category of Container rather than groupPolicyContainer will be deleted from AD & SYSVOL ## EXAMPLES -### Example 1 -```powershell -PS C:\> {{ Add example code here }} +### EXAMPLE 1 +``` +Remove-GPOZaurrBroken -Verbose -WhatIf -Type AD, SYSVOL ``` -{{ Add example description here }} +### EXAMPLE 2 +``` +Remove-GPOZaurrBroken -Verbose -WhatIf -Type AD, SYSVOL -IncludeDomains 'ad.evotec.pl' -LimitProcessing 2 +``` + +### EXAMPLE 3 +``` +Remove-GPOZaurrBroken -Verbose -IncludeDomains 'ad.evotec.xyz' -BackupPath $Env:UserProfile\Desktop\MyBackup1 -WhatIf -Type AD, SYSVOL +``` ## PARAMETERS -### -BackupDated -{{ Fill BackupDated Description }} +### -Type +Choose one or more types to delete. +Options are AD, ObjectClass, SYSVOL ```yaml -Type: SwitchParameter +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupPath +Path to optional backup of SYSVOL content before deletion + +```yaml +Type: String Parameter Sets: (All) Aliases: @@ -47,28 +75,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BackupPath -{{ Fill BackupPath Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -BackupDated +Forces backup to be created within folder that has date in it ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LimitProcessing +Allows to specify maximum number of items that will be fixed in a single run. +It doesn't affect amount of GPOs processed + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 2147483647 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Forest +Target different Forest, by default current forest is used + +```yaml +Type: String +Parameter Sets: (All) +Aliases: ForestName Required: False Position: Named @@ -78,7 +122,7 @@ Accept wildcard characters: False ``` ### -ExcludeDomains -{{ Fill ExcludeDomains Description }} +Exclude domain from search, by default whole forest is scanned ```yaml Type: String[] @@ -86,44 +130,14 @@ Parameter Sets: (All) Aliases: Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 3 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -IncludeDomains -{{ Fill IncludeDomains Description }} +Include only specific domains, by default whole forest is scanned ```yaml Type: String[] @@ -131,38 +145,22 @@ Parameter Sets: (All) Aliases: Domain, Domains Required: False -Position: 5 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -LimitProcessing -{{ Fill LimitProcessing Description }} +### -ExtendedForestInformation +Ability to provide Forest Information from another command to speed up processing ```yaml -Type: Int32 +Type: IDictionary Parameter Sets: (All) Aliases: Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -{{ Fill Type Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Accepted values: SYSVOL, AD - -Required: False -Position: 0 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -184,16 +182,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### 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 -### None - ## OUTPUTS -### System.Object ## NOTES +General notes ## RELATED LINKS diff --git a/Docs/Remove-GPOZaurrLinkEmptyOU.md b/Docs/Remove-GPOZaurrLinkEmptyOU.md new file mode 100644 index 0000000..0265aa9 --- /dev/null +++ b/Docs/Remove-GPOZaurrLinkEmptyOU.md @@ -0,0 +1,168 @@ +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: +schema: 2.0.0 +--- + +# Remove-GPOZaurrLinkEmptyOU + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-GPOZaurrLinkEmptyOU [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] + [[-ExtendedForestInformation] ] [[-ExcludeOrganizationalUnit] ] + [[-LimitProcessing] ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeDomains +{{ Fill ExcludeDomains Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeOrganizationalUnit +{{ Fill ExcludeOrganizationalUnit Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedForestInformation +{{ Fill ExtendedForestInformation Description }} + +```yaml +Type: IDictionary +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Forest +{{ Fill Forest Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: ForestName + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDomains +{{ Fill IncludeDomains Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: Domain, Domains + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LimitProcessing +{{ Fill LimitProcessing Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### 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 + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/Docs/Repair-GPOZaurrBrokenLink.md b/Docs/Repair-GPOZaurrBrokenLink.md new file mode 100644 index 0000000..3f97f28 --- /dev/null +++ b/Docs/Repair-GPOZaurrBrokenLink.md @@ -0,0 +1,156 @@ +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: +schema: 2.0.0 +--- + +# Repair-GPOZaurrBrokenLink + +## SYNOPSIS +Removes any link to GPO that no longer exists. + +## SYNTAX + +``` +Repair-GPOZaurrBrokenLink [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] + [[-ExtendedForestInformation] ] [[-LimitProcessing] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Removes any link to GPO that no longer exists. +It scans all site, organizational unit or domain root making sure every single link that may be linking to GPO that doesn't exists anymore is gone. + +## EXAMPLES + +### EXAMPLE 1 +``` +Repair-GPOZaurrBrokenLink -Verbose -LimitProcessing 1 -WhatIf +``` + +### EXAMPLE 2 +``` +Repair-GPOZaurrBrokenLink -Verbose -IncludeDomains ad.evotec.pl -LimitProcessing 1 -WhatIf +``` + +## PARAMETERS + +### -Forest +Target different Forest, by default current forest is used + +```yaml +Type: String +Parameter Sets: (All) +Aliases: ForestName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDomains +Include only specific domains, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: Domain, Domains + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedForestInformation +Ability to provide Forest Information from another command to speed up processing + +```yaml +Type: IDictionary +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LimitProcessing +Allows to specify maximum number of items that will be fixed in a single run. +It doesn't affect amount of GPOs processed + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### 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 + +## OUTPUTS + +## NOTES +General notes + +## RELATED LINKS diff --git a/Docs/Repair-GPOZaurrNetLogonOwner.md b/Docs/Repair-GPOZaurrNetLogonOwner.md index 97dfeb1..f06bd6d 100644 --- a/Docs/Repair-GPOZaurrNetLogonOwner.md +++ b/Docs/Repair-GPOZaurrNetLogonOwner.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Repair-GPOZaurrNetLogonOwner ## SYNOPSIS -{{ Fill in the Synopsis }} +Sets new owner to each file in NetLogon share. ## SYNTAX @@ -19,41 +19,24 @@ Repair-GPOZaurrNetLogonOwner [[-Forest] ] [[-ExcludeDomains] ] ``` ## DESCRIPTION -{{ Fill in the Description }} +Sets new owner to each file in NetLogon share. ## EXAMPLES -### Example 1 -```powershell -PS C:\> {{ Add example code here }} +### EXAMPLE 1 +``` +Repair-GPOZaurrNetLogonOwner -WhatIf -Verbose -IncludeDomains ad.evotec.pl ``` - -{{ Add example description here }} ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Forest +Target different Forest, by default current forest is used ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: +Aliases: ForestName Required: False Position: 1 @@ -62,43 +45,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Forest -{{ Fill Forest Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDomains -{{ Fill IncludeDomains Description }} +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned ```yaml Type: String[] Parameter Sets: (All) -Aliases: Domain, Domains +Aliases: Required: False Position: 2 @@ -107,23 +60,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LimitProcessing -{{ Fill LimitProcessing Description }} +### -IncludeDomains +Include only specific domains, by default whole forest is scanned ```yaml -Type: Int32 +Type: String[] +Parameter Sets: (All) +Aliases: Domain, Domains + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedForestInformation +Ability to provide Forest Information from another command to speed up processing + +```yaml +Type: IDictionary Parameter Sets: (All) Aliases: Required: False -Position: 5 +Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Principal -{{ Fill Principal Description }} +Provide named owner. +If not provided default S-1-5-32-544 is used. ```yaml Type: String @@ -131,8 +100,24 @@ Parameter Sets: (All) Aliases: Required: False -Position: 4 -Default value: None +Position: 5 +Default value: S-1-5-32-544 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LimitProcessing +Allows to specify maximum number of items that will be fixed in a single run. +It doesn't affect amount of GPOs processed + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: 2147483647 Accept pipeline input: False Accept wildcard characters: False ``` @@ -153,16 +138,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### 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 -### None - ## OUTPUTS -### System.Object ## NOTES +General notes ## RELATED LINKS diff --git a/Docs/Repair-GPOZaurrPermission.md b/Docs/Repair-GPOZaurrPermission.md new file mode 100644 index 0000000..53070bd --- /dev/null +++ b/Docs/Repair-GPOZaurrPermission.md @@ -0,0 +1,169 @@ +--- +external help file: GPOZaurr-help.xml +Module Name: GPOZaurr +online version: +schema: 2.0.0 +--- + +# Repair-GPOZaurrPermission + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Repair-GPOZaurrPermission [-Type] [[-Forest] ] [[-ExcludeDomains] ] + [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [[-LimitProcessing] ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeDomains +{{ Fill ExcludeDomains Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedForestInformation +{{ Fill ExtendedForestInformation Description }} + +```yaml +Type: IDictionary +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Forest +{{ Fill Forest Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: ForestName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDomains +{{ Fill IncludeDomains Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: Domain, Domains + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LimitProcessing +{{ Fill LimitProcessing Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +{{ Fill Type Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Accepted values: AuthenticatedUsers, Unknown, System, Administrative, All + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### 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 + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/Docs/Save-GPOZaurrFiles.md b/Docs/Save-GPOZaurrFiles.md index 822c763..7323124 100644 --- a/Docs/Save-GPOZaurrFiles.md +++ b/Docs/Save-GPOZaurrFiles.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Save-GPOZaurrFiles ## SYNOPSIS -{{ Fill in the Synopsis }} +Exports GPO XML data to files and saves it to a given path ## SYNTAX @@ -18,41 +18,24 @@ Save-GPOZaurrFiles [[-Forest] ] [[-ExcludeDomains] ] [[-Includ ``` ## DESCRIPTION -{{ Fill in the Description }} +Exports GPO XML data to files and saves it to a given path ## EXAMPLES -### Example 1 -```powershell -PS C:\> {{ Add example code here }} +### EXAMPLE 1 +``` +Save-GPOZaurrFiles -GPOPath 'C:\Support\GitHub\GpoZaurr\Ignore\GPOExportEvotec' -DeleteExisting -Verbose ``` - -{{ Add example description here }} ## PARAMETERS -### -DeleteExisting -{{ Fill DeleteExisting Description }} +### -Forest +Target different Forest, by default current forest is used ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: +Aliases: ForestName Required: False Position: 1 @@ -61,14 +44,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned ```yaml -Type: IDictionary +Type: String[] Parameter Sets: (All) Aliases: +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDomains +Include only specific domains, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: Domain, Domains + Required: False Position: 3 Default value: None @@ -76,26 +74,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Forest -{{ Fill Forest Description }} +### -ExtendedForestInformation +Ability to provide Forest Information from another command to speed up processing ```yaml -Type: String -Parameter Sets: (All) -Aliases: ForestName - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOPath -{{ Fill GPOPath Description }} - -```yaml -Type: String[] +Type: IDictionary Parameter Sets: (All) Aliases: @@ -106,31 +89,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDomains -{{ Fill IncludeDomains Description }} +### -GPOPath +Path where to save XML files from GPOReport ```yaml Type: String[] Parameter Sets: (All) -Aliases: Domain, Domains +Aliases: Required: False -Position: 2 +Position: 5 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -DeleteExisting +Delete existing files before saving new ones + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### 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 -### None - ## OUTPUTS -### System.Object ## NOTES +General notes ## RELATED LINKS diff --git a/Docs/Set-GPOZaurrOwner.md b/Docs/Set-GPOZaurrOwner.md index 9f5cf01..8541cb0 100644 --- a/Docs/Set-GPOZaurrOwner.md +++ b/Docs/Set-GPOZaurrOwner.md @@ -16,14 +16,15 @@ Sets GPO Owner to Domain Admins or other choosen account ``` Set-GPOZaurrOwner -Type [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-Principal ] [-SkipSysvol] [-LimitProcessing ] - [-Force] [-WhatIf] [-Confirm] [] + [-ApprovedOwner ] [-Action ] [-Force] [-WhatIf] [-Confirm] [] ``` ### Named ``` Set-GPOZaurrOwner [-GPOName ] [-GPOGuid ] [-Forest ] [-ExcludeDomains ] [-IncludeDomains ] [-ExtendedForestInformation ] [-Principal ] [-SkipSysvol] - [-LimitProcessing ] [-Force] [-WhatIf] [-Confirm] [] + [-LimitProcessing ] [-ApprovedOwner ] [-Action ] [-Force] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -43,6 +44,7 @@ Set-GPOZaurrOwner -Type All -Verbose -WhatIf -LimitProcessing 2 ### -Type Unknown - finds unknown Owners and sets them to Administrative (Domain Admins) or chosen principal NotMatching - find administrative groups only and if sysvol and gpo doesn't match - replace with chosen principal or Domain Admins if not specified +Inconsistent - same as not NotMatching NotAdministrative - combination of Unknown/NotMatching and NotAdministrative - replace with chosen principal or Domain Admins if not specified All - if Owner is known it checks if it's Administrative, if it sn't it fixes that. If owner is unknown it fixes it @@ -198,8 +200,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ApprovedOwner +{{ Fill ApprovedOwner Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: Exclusion, Exclusions + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Action +{{ Fill Action Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force -{{ Fill Force Description }} +Pushes new owner regardless if it's already set or not ```yaml Type: SwitchParameter diff --git a/Docs/Skip-GroupPolicy.md b/Docs/Skip-GroupPolicy.md index 48888ec..3f7a000 100644 --- a/Docs/Skip-GroupPolicy.md +++ b/Docs/Skip-GroupPolicy.md @@ -13,8 +13,14 @@ Allows to exclude Group Policy from being affected by fixes ## SYNTAX +### Name (Default) ``` -Skip-GroupPolicy [[-Name] ] [[-DomaiName] ] [] +Skip-GroupPolicy [-Name ] [-DomaiName ] [] +``` + +### Guid +``` +Skip-GroupPolicy [-GUID ] [-DomaiName ] [] ``` ## DESCRIPTION @@ -50,11 +56,26 @@ Define Group Policy Name to skip ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Name Aliases: GpoName, DisplayName Required: False -Position: 1 +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GUID +{{ Fill GUID Description }} + +```yaml +Type: String +Parameter Sets: Guid +Aliases: ID + +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -70,7 +91,7 @@ Parameter Sets: (All) Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False