Update module builder

CHANGELOG.MD

@@ -1,7 +1,13 @@
 # GPOZaurr Release History
 
+## 0.0.151 - 2022.07.26
+  - ℹ️ Improved `Invoke-GPOZaurr` by adding `SplitReports` functionality. This will allow you to split the reports into multiple files with a single request.
+  - ℹ️ Improved `Get-GPOZaurrInheritance` with some error handling
+
+## 0.0.150 - 2021.12.06
+  - ℹ️ Improves `GPOUpdates` report from `Invoke-GPOZaurr` - additional property
 ## 0.0.149 - 2021.12.05
-  - ☑ Improved docs
+  - ℹ️ Improved docs
 ## 0.0.148 - 2021.12.05
   - ☑ Improved `Invoke-GPOZaurr` - type `GPOOrganizationalUnit` - excludes default redirected computers/users OUs [#30](https://github.com/EvotecIT/GPOZaurr/issues/30)
   - ☑ Improved `Get-GPOZaurrOrganizationalUnit` - excludes default redirected computers/users OUs as per [#30](https://github.com/EvotecIT/GPOZaurr/issues/30)

Docs/Get-GPOZaurrUpdates.md

@@ -8,7 +8,7 @@ schema: 2.0.0
 # Get-GPOZaurrUpdates
 
 ## SYNOPSIS
-{{ Fill in the Synopsis }}
+Gets the list of GPOs created or updated in the last X number of days.
 
 ## SYNTAX
 
@@ -26,113 +26,24 @@ Get-GPOZaurrUpdates [-Forest <String>] [-ExcludeDomains <String[]>] [-IncludeDom
 ```
 
 ## DESCRIPTION
-{{ Fill in the Description }}
+Gets the list of GPOs created or updated in the last X number of days.
 
 ## EXAMPLES
 
-### Example 1
-```powershell
-PS C:\> {{ Add example code here }}
+### EXAMPLE 1
+```
+Get-GPOZaurrUpdates -DateRange Last14Days -DateProperty WhenCreated, WhenChanged -Verbose -IncludeDomains 'ad.evotec.pl' | Format-List
 ```
 
-{{ Add example description here }}
+### EXAMPLE 2
+```
+Get-GPOZaurrUpdates -DateRange Last14Days -DateProperty WhenCreated -Verbose | Format-Table
+```
 
 ## 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 }}
+Target different Forest, by default current forest is used
 
 ```yaml
 Type: String
@@ -146,8 +57,24 @@ 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: 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[]
@@ -161,16 +88,91 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -DateFrom
+Provide a date from which to start the search, by default the last X days are used
+
+```yaml
+Type: DateTime
+Parameter Sets: Dates
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -DateTo
+Provide a date to which to end the search, by default the last X days are used
+
+```yaml
+Type: DateTime
+Parameter Sets: Dates
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -DateRange
+Provide a date range to search for, by default the last X days are used
+
+```yaml
+Type: String
+Parameter Sets: DateRange
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -DateProperty
+Choose a date property.
+It can be WhenCreated or WhenChanged or both.
+By default whenCreated is used for comparison purposes
+
+```yaml
+Type: String[]
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: WhenCreated
+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: 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

Docs/Invoke-GPOZaurr.md

@@ -15,7 +15,7 @@ Single cmdlet that provides 360 degree overview of Group Policies in Active Dire
 ```
 Invoke-GPOZaurr [[-Exclusions] <Object>] [-FilePath <String>] [[-Type] <String[]>] [-PassThru] [-HideHTML]
  [-HideSteps] [-ShowError] [-ShowWarning] [-Forest <String>] [-ExcludeDomains <String[]>]
- [-IncludeDomains <String[]>] [-Online] [<CommonParameters>]
+ [-IncludeDomains <String[]>] [-Online] [-SplitReports] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -224,6 +224,22 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -SplitReports
+Split report into multiple files, one for each report.
+This can be useful for large domains with huge reports.
+
+```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).
 

Docs/Readme.md

@@ -106,7 +106,7 @@ Detects Group Policy missing Authenticated Users permission while not having hig
 Gets DFSR information from the SYSVOL DFSR
 
 ### [Get-GPOZaurrUpdates](Get-GPOZaurrUpdates.md)
-{{ Fill in the Synopsis }}
+Gets the list of GPOs created or updated in the last X number of days.
 
 ### [Get-GPOZaurrWMI](Get-GPOZaurrWMI.md)
 Get Group Policy WMI filter

GPOZaurr.psd1

@@ -4,11 +4,11 @@
     CmdletsToExport      = @()
     CompanyName          = 'Evotec'
     CompatiblePSEditions = @('Desktop')
-    Copyright            = '(c) 2011 - 2021 Przemyslaw Klys @ Evotec. All rights reserved.'
+    Copyright            = '(c) 2011 - 2022 Przemyslaw Klys @ Evotec. All rights reserved.'
     Description          = 'Group Policy Eater is a PowerShell module that aims to gather information about Group Policies but also allows fixing issues that you may find in them.'
     FunctionsToExport    = @('Add-GPOPermission', 'Add-GPOZaurrPermission', 'Backup-GPOZaurr', 'Clear-GPOZaurrSysvolDFSR', 'ConvertFrom-CSExtension', 'Find-CSExtension', 'Get-GPOZaurr', 'Get-GPOZaurrAD', 'Get-GPOZaurrBackupInformation', 'Get-GPOZaurrBroken', 'Get-GPOZaurrBrokenLink', 'Get-GPOZaurrDictionary', 'Get-GPOZaurrDuplicateObject', 'Get-GPOZaurrFiles', 'Get-GPOZaurrFilesPolicyDefinition', 'Get-GPOZaurrFolders', 'Get-GPOZaurrInheritance', 'Get-GPOZaurrLegacyFiles', 'Get-GPOZaurrLink', 'Get-GPOZaurrLinkSummary', 'Get-GPOZaurrNetLogon', 'Get-GPOZaurrOrganizationalUnit', 'Get-GPOZaurrOwner', 'Get-GPOZaurrPassword', 'Get-GPOZaurrPermission', 'Get-GPOZaurrPermissionAnalysis', 'Get-GPOZaurrPermissionConsistency', 'Get-GPOZaurrPermissionIssue', 'Get-GPOZaurrPermissionRoot', 'Get-GPOZaurrPermissionSummary', 'Get-GPOZaurrSysvolDFSR', 'Get-GPOZaurrUpdates', 'Get-GPOZaurrWMI', 'Invoke-GPOZaurr', 'Invoke-GPOZaurrContent', 'Invoke-GPOZaurrPermission', 'Invoke-GPOZaurrSupport', 'New-GPOZaurrWMI', 'Optimize-GPOZaurr', 'Remove-GPOPermission', 'Remove-GPOZaurr', 'Remove-GPOZaurrBroken', 'Remove-GPOZaurrDuplicateObject', 'Remove-GPOZaurrFolders', 'Remove-GPOZaurrLegacyFiles', 'Remove-GPOZaurrLinkEmptyOU', 'Remove-GPOZaurrPermission', 'Remove-GPOZaurrWMI', 'Repair-GPOZaurrBrokenLink', 'Repair-GPOZaurrNetLogonOwner', 'Repair-GPOZaurrPermission', 'Repair-GPOZaurrPermissionConsistency', 'Restore-GPOZaurr', 'Save-GPOZaurrFiles', 'Set-GPOOwner', 'Set-GPOZaurrOwner', 'Set-GPOZaurrStatus', 'Skip-GroupPolicy')
     GUID                 = 'f7d4c9e4-0298-4f51-ad77-e8e3febebbde'
-    ModuleVersion        = '0.0.149'
+    ModuleVersion        = '0.0.151'
     PowerShellVersion    = '5.1'
     PrivateData          = @{
         PSData = @{
@@ -18,15 +18,15 @@
         }
     }
     RequiredModules      = @(@{
-            ModuleVersion = '0.0.214'
+            ModuleVersion = '0.0.232'
             ModuleName    = 'PSSharedGoods'
             Guid          = 'ee272aa8-baaa-4edf-9f45-b6d6f7d844fe'
         }, @{
-            ModuleVersion = '0.0.138'
+            ModuleVersion = '0.0.146'
             ModuleName    = 'ADEssentials'
             Guid          = '9fc9fd61-7f11-4f4b-a527-084086f1905f'
         }, @{
-            ModuleVersion = '0.0.163'
+            ModuleVersion = '0.0.175'
             ModuleName    = 'PSWriteHTML'
             Guid          = 'a7bdf640-f5cb-4acf-9de0-365b322d245c'
         }, 'CimCmdlets', 'Microsoft.PowerShell.Management', 'Microsoft.PowerShell.Utility', 'Microsoft.PowerShell.Security')

Public/Get-GPOZaurrInheritance.ps1

@@ -68,7 +68,12 @@
                     DomainName         = ConvertFrom-DistinguishedName -ToDomainCN -DistinguishedName $OU.DistinguishedName
                 }
                 if ($InheritanceInformation.BlockedInheritance -and $IncludeGroupPoliciesForBlockedObjects.IsPresent) {
-                    $GPInheritance = Get-GPInheritance -Target $OU.distinguishedName
+                    try {
+                        $GPInheritance = Get-GPInheritance -Target $OU.distinguishedName -ErrorAction Stop
+                    } catch {
+                        Write-Warning -Message "Get-GPOZaurrInheritance - Can't get GPInheritance for $($OU.distinguishedName). Error: $($_.Exception.Message)"
+                        continue
+                    }
                     $ActiveGroupPolicies = foreach ($GPO in $GPInheritance.InheritedGpoLinks) {
                         [PSCustomObject] @{
                             OrganizationalUnit   = $OU.canonicalName

Public/Get-GPOZaurrUpdates.ps1

@@ -126,6 +126,7 @@
         }
         [PSCustomObject] @{
             DisplayName             = $GPO.DisplayName
+            GUID                    = ConvertFrom-DistinguishedName -DistinguishedName $GPO.GPODistinguishedName
             DomainName              = $GPO.DomainName
             Owner                   = $GPO.Owner
             OwnerName               = $Owner.Name

Public/Invoke-GPOZaurr.ps1

@@ -46,6 +46,9 @@
     .PARAMETER 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.
 
+    .PARAMETER SplitReports
+    Split report into multiple files, one for each report. This can be useful for large domains with huge reports.
+
     .EXAMPLE
     Invoke-GPOZaurr
 
@@ -71,7 +74,8 @@
         [alias('ForestName')][string] $Forest,
         [string[]] $ExcludeDomains,
         [alias('Domain', 'Domains')][string[]] $IncludeDomains,
-        [switch] $Online
+        [switch] $Online,
+        [switch] $SplitReports
     )
     Reset-GPOZaurrStatus # This makes sure types are at it's proper status
 
@@ -189,46 +193,100 @@
     if (-not $FilePath) {
         $FilePath = Get-FileName -Extension 'html' -Temporary
     }
-    Write-Color -Text '[i]', '[HTML ] ', "Generating HTML report ($FilePath)" -Color Yellow, DarkGray, Yellow
-    New-HTML -Author 'Przemysław Kłys' -TitleText 'GPOZaurr Report' {
-        New-HTMLTabStyle -BorderRadius 0px -TextTransform capitalize -BackgroundColorActive SlateGrey
-        New-HTMLSectionStyle -BorderRadius 0px -HeaderBackGroundColor Grey -RemoveShadow
-        New-HTMLPanelStyle -BorderRadius 0px
-        New-HTMLTableOption -DataStore JavaScript -BoolAsString -ArrayJoinString ', ' -ArrayJoin
+    if ($SplitReports -and $Type.Count -gt 1) {
+        # Split reports into multiple files for easier viewing
+        $DateName = $(Get-Date -f yyyy-MM-dd_HHmmss)
+        $FileName = [io.path]::GetFileNameWithoutExtension($FilePath)
+        $DirectoryName = [io.path]::GetDirectoryName($FilePath)
+        foreach ($T in $Script:GPOConfiguration.Keys) {
+            $NewFileName = $FileName + '_' + $T + "_" + $DateName + '.html'
+            $FilePath = [io.path]::Combine($DirectoryName, $NewFileName)
 
-        New-HTMLHeader {
-            New-HTMLSection -Invisible {
-                New-HTMLSection {
-                    New-HTMLText -Text "Report generated on $(Get-Date)" -Color Blue
-                } -JustifyContent flex-start -Invisible
-                New-HTMLSection {
-                    New-HTMLText -Text "GPOZaurr - $($Script:Reporting['Version'])" -Color Blue
-                } -JustifyContent flex-end -Invisible
-            }
-        }
+            if ($Script:GPOConfiguration[$T].Enabled -eq $true) {
+                Write-Color -Text '[i]', '[HTML ] ', "Generating HTML report ($FilePath) for $T with split reports" -Color Yellow, DarkGray, Yellow
+                New-HTML -Author 'Przemysław Kłys' -TitleText 'GPOZaurr Report' {
+                    New-HTMLTabStyle -BorderRadius 0px -TextTransform capitalize -BackgroundColorActive SlateGrey
+                    New-HTMLSectionStyle -BorderRadius 0px -HeaderBackGroundColor Grey -RemoveShadow
+                    New-HTMLPanelStyle -BorderRadius 0px
+                    New-HTMLTableOption -DataStore JavaScript -BoolAsString -ArrayJoinString ', ' -ArrayJoin
 
-        if ($Type.Count -eq 1) {
-            foreach ($T in $Script:GPOConfiguration.Keys) {
-                if ($Script:GPOConfiguration[$T].Enabled -eq $true) {
-                    if ($Script:GPOConfiguration[$T]['Summary']) {
-                        $Script:Reporting[$T]['Summary'] = Invoke-Command -ScriptBlock $Script:GPOConfiguration[$T]['Summary']
+                    New-HTMLHeader {
+                        New-HTMLSection -Invisible {
+                            New-HTMLSection {
+                                New-HTMLText -Text "Report generated on $(Get-Date)" -Color Blue
+                            } -JustifyContent flex-start -Invisible
+                            New-HTMLSection {
+                                New-HTMLText -Text "GPOZaurr - $($Script:Reporting['Version'])" -Color Blue
+                            } -JustifyContent flex-end -Invisible
+                        }
                     }
-                    & $Script:GPOConfiguration[$T]['Solution']
-                }
-            }
-        } else {
-            foreach ($T in $Script:GPOConfiguration.Keys) {
-                if ($Script:GPOConfiguration[$T].Enabled -eq $true) {
+
+                    # if ($Type.Count -eq 1) {
+                    #     foreach ($T in $Script:GPOConfiguration.Keys) {
+                    #         if ($Script:GPOConfiguration[$T].Enabled -eq $true) {
+                    #             if ($Script:GPOConfiguration[$T]['Summary']) {
+                    #                 $Script:Reporting[$T]['Summary'] = Invoke-Command -ScriptBlock $Script:GPOConfiguration[$T]['Summary']
+                    #             }
+                    #             & $Script:GPOConfiguration[$T]['Solution']
+                    #         }
+                    #     }
+                    # } else {
+
                     if ($Script:GPOConfiguration[$T]['Summary']) {
                         $Script:Reporting[$T]['Summary'] = Invoke-Command -ScriptBlock $Script:GPOConfiguration[$T]['Summary']
                     }
                     New-HTMLTab -Name $Script:GPOConfiguration[$T]['Name'] {
                         & $Script:GPOConfiguration[$T]['Solution']
                     }
-                }
+
+                    # }
+                } -Online:$Online.IsPresent -ShowHTML:(-not $HideHTML) -FilePath $FilePath
             }
         }
-    } -Online:$Online.IsPresent -ShowHTML:(-not $HideHTML) -FilePath $FilePath
+    } else {
+        # Standard reports as requested
+        Write-Color -Text '[i]', '[HTML ] ', "Generating HTML report ($FilePath)" -Color Yellow, DarkGray, Yellow
+        New-HTML -Author 'Przemysław Kłys' -TitleText 'GPOZaurr Report' {
+            New-HTMLTabStyle -BorderRadius 0px -TextTransform capitalize -BackgroundColorActive SlateGrey
+            New-HTMLSectionStyle -BorderRadius 0px -HeaderBackGroundColor Grey -RemoveShadow
+            New-HTMLPanelStyle -BorderRadius 0px
+            New-HTMLTableOption -DataStore JavaScript -BoolAsString -ArrayJoinString ', ' -ArrayJoin
+
+            New-HTMLHeader {
+                New-HTMLSection -Invisible {
+                    New-HTMLSection {
+                        New-HTMLText -Text "Report generated on $(Get-Date)" -Color Blue
+                    } -JustifyContent flex-start -Invisible
+                    New-HTMLSection {
+                        New-HTMLText -Text "GPOZaurr - $($Script:Reporting['Version'])" -Color Blue
+                    } -JustifyContent flex-end -Invisible
+                }
+            }
+
+            if ($Type.Count -eq 1) {
+                foreach ($T in $Script:GPOConfiguration.Keys) {
+                    if ($Script:GPOConfiguration[$T].Enabled -eq $true) {
+                        if ($Script:GPOConfiguration[$T]['Summary']) {
+                            $Script:Reporting[$T]['Summary'] = Invoke-Command -ScriptBlock $Script:GPOConfiguration[$T]['Summary']
+                        }
+                        & $Script:GPOConfiguration[$T]['Solution']
+                    }
+                }
+            } else {
+                foreach ($T in $Script:GPOConfiguration.Keys) {
+                    if ($Script:GPOConfiguration[$T].Enabled -eq $true) {
+                        if ($Script:GPOConfiguration[$T]['Summary']) {
+                            $Script:Reporting[$T]['Summary'] = Invoke-Command -ScriptBlock $Script:GPOConfiguration[$T]['Summary']
+                        }
+                        New-HTMLTab -Name $Script:GPOConfiguration[$T]['Name'] {
+                            & $Script:GPOConfiguration[$T]['Solution']
+                        }
+                    }
+                }
+            }
+        } -Online:$Online.IsPresent -ShowHTML:(-not $HideHTML) -FilePath $FilePath
+    }
+
     $TimeLogEndHTML = Stop-TimeLog -Time $TimeLogHTML -Option OneLiner
     Write-Color -Text '[i]', '[HTML ] ', 'Generating HTML report', " [Time to execute: $TimeLogEndHTML]" -Color Yellow, DarkGray, Yellow, DarkGray
     if ($PassThru) {

Publish/Manage-Module.ps1

@@ -1,5 +1,4 @@
 Clear-Host
-Import-Module "C:\Users\przemyslaw.klys\OneDrive - Evotec\Support\GitHub\PSPublishModule\PSPublishModule.psd1" -Force
 
 $Configuration = @{
     Information = @{
@@ -267,7 +266,7 @@ $Configuration = @{
             RefreshPSD1Only  = $false
         }
         BuildDocumentation = @{
-            Enable        = $false # enables documentation processing
+            Enable        = $true # enables documentation processing
             StartClean    = $true # always starts clean
             UpdateWhenNew = $true # always updates right after new
         }
@@ -277,10 +276,10 @@ $Configuration = @{
             Verbose         = $false
         }
         PublishModule      = @{  # requires Enable to be on to process all of that
-            Enabled      = $true
+            Enabled      = $false
             Prerelease   = ''
             RequireForce = $false
-            GitHub       = $true
+            GitHub       = $false
         }
     }
 }