Merge pull request #112 from AsBuiltReport/dev

v0.7.13 public release
AsBuiltReport · Jun 23, 2023 · 5802723 · 5802723
2 parents f5a67e3 + 16ed83f
commit 5802723
Show file tree

Hide file tree

Showing 29 changed files with 1,212 additions and 567 deletions.
diff --git a/AsBuiltReport.Microsoft.AD.Style.ps1 b/AsBuiltReport.Microsoft.AD.Style.ps1
@@ -11,6 +11,7 @@ Style -Name 'Heading 1' -Size 16 -Color '0078D4'
 Style -Name 'Heading 2' -Size 14 -Color '00447C'
 Style -Name 'Heading 3' -Size 13 -Color '0081FF'
 Style -Name 'Heading 4' -Size 12 -Color '0077B7'
+Style -Name 'NO TOC Heading 4' -Size 12 -Color '0077B7'
 Style -Name 'Heading 5' -Size 11 -Color '1A9BA3'
 Style -Name 'NO TOC Heading 5' -Size 11 -Color '1A9BA3'
 Style -Name 'Heading 6' -Size 10 -Color '505050'

diff --git a/AsBuiltReport.Microsoft.AD.json b/AsBuiltReport.Microsoft.AD.json
@@ -11,9 +11,13 @@
     "Options": {
         "ShowDefinitionInfo": false,
         "PSDefaultAuthentication": "Negotiate",
+        "EnableCharts": false,
         "Exclude": {
             "Domains": [],
             "DCs": []
+        },
+        "Include": {
+            "Domains": []
         }
     },
     "InfoLevel": {
@@ -31,12 +35,14 @@
             "DFS": true,
             "SPN": true,
             "DuplicateObject": true,
-            "Security": true
+            "Security": true,
+            "BestPractice": true
         },
         "DomainController": {
             "Diagnostic": true,
             "Services": true,
-            "Software": true
+            "Software": true,
+            "BestPractice": true
         },
         "Site": {
             "Replication": true,
@@ -45,11 +51,14 @@
         "DNS": {
             "Aging": true,
             "DP": true,
-            "Zones": true
+            "Zones": true,
+            "BestPractice": true
+
         },
         "CA": {
             "Status": true,
-            "Statistics": true
+            "Statistics": true,
+            "BestPractice": true
         }
     }
 }
diff --git a/AsBuiltReport.Microsoft.AD.psd1 b/AsBuiltReport.Microsoft.AD.psd1
@@ -12,7 +12,7 @@
 RootModule = 'AsBuiltReport.Microsoft.AD.psm1'
 
 # Version number of this module.
-ModuleVersion = '0.7.12'
+ModuleVersion = '0.7.13'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,38 @@
 # :arrows_clockwise: Microsoft AD As Built Report Changelog
 
+## [0.7.13] - 2023-06-22
+
+### Added
+
+- Added Option "Include.Domains" to allow only a list of Active Directory Domain to document
+  - Include Domains in AD services
+  - Include Domains in DNS services
+- Added Site Connection Objects section
+
+### Changed
+
+- Major improvements to health check recommendations
+
+### Fixed
+
+- Fix HealthCheck sections not working after v0.7.12
+- Fix [#84](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/issues/84)
+- Fix [#98](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/issues/98)
+- Fix [#99](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/issues/99)
+- Fix [#100](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/issues/100)
+- Fix [#101](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/issues/101)
+- Fix [#102](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/issues/102)
+- Fix [#103](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/issues/103)
+- Fix [#104](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/issues/104)
+- Fix [#105](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/issues/105)
+- Fix [#106](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/issues/106)
+- Fix [#107](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/issues/107)
+- Fix [#108](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/issues/108)
+- Fix [#109](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/issues/109)
+- Fix [#110](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/issues/110)
+- Fix Node.js 12 actions are deprecated warning message
+- Fix the code to ensure that PSRemoting sessions are removed when they are no longer needed.
+
 ## [0.7.12] - 2023-05-23
 
 ### Changed

diff --git a/README.md b/README.md
@@ -164,9 +164,11 @@ The **Options** schema allows certain options within the report to be toggled on
 | Sub-Schema      | Setting      | Default | Description                                                                                                                                                                                 |
 |-----------------|--------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | ShowDefinitionInfo | true/false  | false    | Toggle to enable/disable Microsoft AD term explanations
-| PSDefaultAuthentication | Negotiate/Kerberos  | Negotiate    | Allow to set the value of the PSRemoting authentication method. For Workgroup authentication Negotiate value is required.
-| Exclude.DCs | Array List  | Empty    | Allow to filter on AD Domain Controller Server FQDN.
-| Exclude.Domains | Array List  | Empty    | Allow to filter on AD Domain FQDN
+| PSDefaultAuthentication | Negotiate/Kerberos  | Negotiate    | Allow to set the value of the PSRemoting authentication method. For Workgroup authentication Negotiate value is required. |
+| Exclude.Domains | Array List  | Empty    | Allow to filter on AD Domain FQDN |
+| Exclude.DCs | Array List  | Empty    | Allow to filter on AD Domain Controller Server FQDN. |
+| Include.Domains | Array List  | Empty    | Allow only a list of Active Directory Domain Controller FQDN to document. |
+| Include.DCs | Array List  | Empty    | Allow only a list of Active Directory Domain FQDN to document. |
 
 ### InfoLevel
 

diff --git a/Src/Private/Get-AbrADCAAIA.ps1 b/Src/Private/Get-AbrADCAAIA.ps1
@@ -5,7 +5,7 @@ function Get-AbrADCAAIA {
     .DESCRIPTION
 
     .NOTES
-        Version:        0.7.9
+        Version:        0.7.13
         Author:         Jonathan Colon
         Twitter:        @jcolonfzenpr
         Github:         rebelinux
@@ -58,12 +58,12 @@ function Get-AbrADCAAIA {
                             $OutObj | Table @TableParams
                         }
                         catch {
-                            Write-PscriboMessage -IsWarning "$($_.Exception.Message) (Authority Information Access Item)"
+                            Write-PscriboMessage -IsWarning "Authority Information Access Item $($URI.RegURI) Section: $($_.Exception.Message)"
                         }
                     }
                 }
                 catch {
-                    Write-PscriboMessage -IsWarning "$($_.Exception.Message) (Authority Information Access Table)"
+                    Write-PscriboMessage -IsWarning "Authority Information Access Section: $($_.Exception.Message)"
                 }
             }
         }

diff --git a/Src/Private/Get-AbrADCACRLSetting.ps1 b/Src/Private/Get-AbrADCACRLSetting.ps1
@@ -5,7 +5,7 @@ function Get-AbrADCACRLSetting {
     .DESCRIPTION
 
     .NOTES
-        Version:        0.7.9
+        Version:        0.7.13
         Author:         Jonathan Colon
         Twitter:        @jcolonfzenpr
         Github:         rebelinux
@@ -48,12 +48,12 @@ function Get-AbrADCACRLSetting {
                                 $OutObj += [pscustomobject]$inobj
                             }
                             catch {
-                                Write-PscriboMessage -IsWarning $_.Exception.Message
+                                Write-PscriboMessage -IsWarning "CRL Validity Period $($VP.Name) Section: $($_.Exception.Message)"
                             }
                         }
                     }
                     catch {
-                        Write-PscriboMessage -IsWarning $_.Exception.Message
+                        Write-PscriboMessage -IsWarning "CRL Validity Period Section: $($_.Exception.Message)"
                     }
 
                     $TableParams = @{
@@ -82,12 +82,12 @@ function Get-AbrADCACRLSetting {
                                     $OutObj += [pscustomobject]$inobj
                                 }
                                 catch {
-                                    Write-PscriboMessage -IsWarning $_.Exception.Message
+                                    Write-PscriboMessage -IsWarning "CRL Validity Period $($Flag.Name) Section: $($_.Exception.Message)"
                                 }
                             }
                         }
                         catch {
-                            Write-PscriboMessage -IsWarning $_.Exception.Message
+                            Write-PscriboMessage -IsWarning "CRL Validity Period Table Section: $($_.Exception.Message)"
                         }
 
                         $TableParams = @{
@@ -102,7 +102,7 @@ function Get-AbrADCACRLSetting {
                     }
                 }
                 catch {
-                    Write-PscriboMessage -IsWarning $_.Exception.Message
+                    Write-PscriboMessage -IsWarning "CRL Validity Period Section: $($_.Exception.Message)"
                 }
                 try {
                     Section -Style Heading5 "CRL Distribution Point" {

diff --git a/Src/Private/Get-AbrADDCDiag.ps1 b/Src/Private/Get-AbrADDCDiag.ps1
@@ -74,7 +74,7 @@ function Get-AbrADDCDiag {
                                 $OutObj += [pscustomobject]$inobj
                             }
                             catch {
-                                Write-PscriboMessage -IsWarning $_.Exception.Message
+                                Write-PscriboMessage -IsWarning "Active Directory DCDiag $($Result.TestName) Section: $($_.Exception.Message)"
                             }
                         }
                         if ($HealthCheck.DomainController.Diagnostic) {
@@ -93,7 +93,7 @@ function Get-AbrADDCDiag {
                 }
             }
             catch {
-                Write-PscriboMessage -IsWarning $_.Exception.Message
+                Write-PscriboMessage -IsWarning "Active Directory DCDiag Section: $($_.Exception.Message)"
             }
         }
     }

diff --git a/Src/Private/Get-AbrADDCRoleFeature.ps1 b/Src/Private/Get-AbrADDCRoleFeature.ps1
@@ -5,7 +5,7 @@ function Get-AbrADDCRoleFeature {
     .DESCRIPTION
 
     .NOTES
-        Version:        0.7.6
+        Version:        0.7.13
         Author:         Jonathan Colon
         Twitter:        @jcolonfzenpr
         Github:         rebelinux
@@ -43,15 +43,21 @@ function Get-AbrADDCRoleFeature {
                             $inObj = [ordered] @{
                                 'Name' = $Feature.DisplayName
                                 'Parent' = $Feature.FeatureType
-                                'InstallState' = $Feature.Description
+                                'Description' = $Feature.Description
                             }
                             $OutObj += [pscustomobject]$inobj
                         }
                         catch {
-                            Write-PscriboMessage -IsWarning "$($_.Exception.Message) (Roles Item)"
+                            Write-PscriboMessage -IsWarning "Roles $($Feature.DisplayName) Section: $($_.Exception.Message)"
                         }
                     }
 
+                    if ($HealthCheck.DomainController.BestPractice) {
+
+                        $OutObj | Where-Object {$_.'Name' -notin @('Active Directory Domain Services','DNS Server','File and Storage Services','DHCP Server')} | Set-Style -Style Warning
+
+                    }
+
                     $TableParams = @{
                         Name = "Roles - $($DC.ToString().split('.')[0].ToUpper())"
                         List = $false
@@ -61,15 +67,16 @@ function Get-AbrADDCRoleFeature {
                         $TableParams['Caption'] = "- $($TableParams.Name)"
                     }
                     $OutObj | Table @TableParams
-                    if ($HealthCheck.DomainController.Software) {
+                    if ($HealthCheck.DomainController.Software -and ($OutObj | Where-Object {$_.'Name' -notin @('Active Directory Domain Services','DNS Server','File and Storage Services')})) {
                         Paragraph "Health Check:" -Italic -Bold -Underline
+                        BlankLine
                         Paragraph "Best Practices: Domain Controllers should have limited software and agents installed including roles and services. Non-essential code running on Domain Controllers is a risk to the enterprise Active Directory environment. A Domain Controller should only run required software, services and roles critical to essential operation." -Italic -Bold
                     }
                 }
             }
         }
         catch {
-            Write-PscriboMessage -IsWarning "$($_.Exception.Message) (Role Section)"
+            Write-PscriboMessage -IsWarning "Roles Section: $($_.Exception.Message)"
         }
     }