Add HealthCheck Recommendations AsBuiltReport#100

rebelinux · Jun 1, 2023 · 6ad0bd3 · 6ad0bd3
1 parent 37dd5d1
commit 6ad0bd3
Show file tree

Hide file tree

Showing 18 changed files with 172 additions and 45 deletions.
diff --git a/AsBuiltReport.Veeam.VBR.psd1 b/AsBuiltReport.Veeam.VBR.psd1
@@ -12,7 +12,7 @@
 RootModule = 'AsBuiltReport.Veeam.VBR.psm1'
 
 # Version number of this module.
-ModuleVersion = '0.7.1'
+ModuleVersion = '0.7.2'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()

diff --git a/AsBuiltreport.Veeam.VBR.json b/AsBuiltreport.Veeam.VBR.json
@@ -91,7 +91,9 @@
             "Tenants": true,
             "BackupStorage": true,
             "ReplicaResources": true
+        },
+        "Jobs": {
+            "Status": true
         }
-
     }
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,21 @@
 # :arrows_clockwise: Veeam VBR As Built Report Changelog
 
+## [0.7.2] - 2023-05-30
+
+### Added
+
+- Added HealthCheck recommendations
+- Added Global Notification options
+
+### Changed
+
+- Visually improved the Backup Window Time Period table
+
+### Fixed
+
+- Fix [#99](https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/issues/99)
+- Fix [#100](https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/issues/100)
+
 ## [0.7.1] - 2023-03-07
 
 ### Changed

diff --git a/Src/Private/Get-AbrVbrBackupRepository.ps1 b/Src/Private/Get-AbrVbrBackupRepository.ps1
@@ -166,6 +166,7 @@ function Get-AbrVbrBackupRepository {
                                                 $OutObj += [pscustomobject]$inobj
 
                                                 if ($HealthCheck.Infrastructure.BR) {
+                                                    $OutObj | Where-Object { $_.'Immutability Supported' -eq 'Yes' } | Set-Style -Style OK -Property 'Immutability Supported'
                                                     $OutObj | Where-Object { $_.'Immutability Supported' -eq 'Yes' -and $_.'Immutability Enabled' -eq 'No' } | Set-Style -Style Warning -Property 'Immutability Enabled'
                                                 }
 
@@ -178,6 +179,11 @@ function Get-AbrVbrBackupRepository {
                                                     $TableParams['Caption'] = "- $($TableParams.Name)"
                                                 }
                                                 $OutObj | Table @TableParams
+
+                                                if (($HealthCheck.Infrastructure.BestPractice) -and ($OutObj | Where-Object { $_.'Immutability Supported' -eq 'Yes' -and $_.'Immutability Enabled' -eq 'No' })) {
+                                                    Paragraph "Health Check:" -Italic -Bold -Underline
+                                                    Paragraph "Best Practice: Veeam recommend to implement Immutability where it is supported. It is done for increased security: immutability protects your data from loss as a result of attacks, malware activity or any other injurious actions." -Italic -Bold
+                                                }
                                             }
                                         }
                                         catch {

diff --git a/Src/Private/Get-AbrVbrBackupServerInfo.ps1 b/Src/Private/Get-AbrVbrBackupServerInfo.ps1
@@ -145,14 +145,14 @@ function Get-AbrVbrBackupServerInfo {
                                         'BIOS Version' = $HWBIOS.Version
                                         'Processor Manufacturer' = $HWCPU[0].Manufacturer
                                         'Processor Model' = $HWCPU[0].Name
-                                        'Number of CPU Cores' = $HWCPU[0].NumberOfCores
-                                        'Number of Logical Cores' = $HWCPU[0].NumberOfLogicalProcessors
+                                        'Number of CPU Cores' = ($HWCPU.NumberOfCores | Measure-Object -Sum).Sum
+                                        'Number of Logical Cores' = ($HWCPU.NumberOfLogicalProcessors | Measure-Object -Sum).Sum
                                         'Physical Memory (GB)' = ConvertTo-FileSizeString $HW.CsTotalPhysicalMemory
                                     }
                                     $OutObj += [pscustomobject]$inobj
 
                                     if ($HealthCheck.Infrastructure.Server) {
-                                        $OutObj | Where-Object { $_.'Number of CPU Cores' -lt 4} | Set-Style -Style Warning -Property 'Number of CPU Cores'
+                                        $OutObj | Where-Object { $_.'Number of CPU Cores' -lt 2} | Set-Style -Style Warning -Property 'Number of CPU Cores'
                                         if ([int]([regex]::Matches($OutObj.'Physical Memory (GB)', "\d+(?!.*\d+)").value) -lt 8) { $OutObj | Set-Style -Style Warning -Property 'Physical Memory (GB)' }
                                     }
 
@@ -165,6 +165,12 @@ function Get-AbrVbrBackupServerInfo {
                                         $TableParams['Caption'] = "- $($TableParams.Name)"
                                     }
                                     $OutObj | Table @TableParams
+                                    if ($HealthCheck.Infrastructure.BestPractice) {
+                                        if (([int]([regex]::Matches($OutObj.'Physical Memory (GB)', "\d+(?!.*\d+)").value) -lt 8) -or ($OutObj | Where-Object { $_.'Number of CPU Cores' -lt 2})) {
+                                            Paragraph "Health Check:" -Italic -Bold -Underline
+                                            Paragraph "Best Practice: Recommended Veeam Backup Server minimum configuration is two CPU cores and 8GB RAM." -Italic -Bold
+                                        }
+                                    }
                                     #---------------------------------------------------------------------------------------------#
                                     #                       Backup Server Local Disk Inventory Section                            #
                                     #---------------------------------------------------------------------------------------------#

diff --git a/Src/Private/Get-AbrVbrBackupjob.ps1 b/Src/Private/Get-AbrVbrBackupjob.ps1
@@ -6,7 +6,7 @@ function Get-AbrVbrBackupjob {
     .DESCRIPTION
         Documents the configuration of Veeam VBR in Word/HTML/Text formats using PScribo.
     .NOTES
-        Version:        0.7.1
+        Version:        0.7.2
         Author:         Jonathan Colon
         Twitter:        @jcolonfzenpr
         Github:         rebelinux
@@ -53,6 +53,11 @@ function Get-AbrVbrBackupjob {
                     }
                 }
 
+                if ($HealthCheck.Jobs.Status) {
+                    $OutObj | Where-Object { $_.'Latest Result' -eq 'Failed' } | Set-Style -Style Critical -Property 'Latest Result'
+                    $OutObj | Where-Object { $_.'Latest Result' -eq 'Warning' } | Set-Style -Style Warning -Property 'Latest Result'
+                }
+
                 $TableParams = @{
                     Name = "Backup Jobs - $VeeamBackupServer"
                     List = $false

diff --git a/Src/Private/Get-AbrVbrBackupjobHyperV.ps1 b/Src/Private/Get-AbrVbrBackupjobHyperV.ps1
@@ -6,7 +6,7 @@ function Get-AbrVbrBackupjobHyperV {
     .DESCRIPTION
         Documents the configuration of Veeam VBR in Word/HTML/Text formats using PScribo.
     .NOTES
-        Version:        0.7.1
+        Version:        0.7.2
         Author:         Jonathan Colon
         Twitter:        @jcolonfzenpr
         Github:         rebelinux

diff --git a/Src/Private/Get-AbrVbrBackupjobVMware.ps1 b/Src/Private/Get-AbrVbrBackupjobVMware.ps1
@@ -6,7 +6,7 @@ function Get-AbrVbrBackupjobVMware {
     .DESCRIPTION
         Documents the configuration of Veeam VBR in Word/HTML/Text formats using PScribo.
     .NOTES
-        Version:        0.7.1
+        Version:        0.7.2
         Author:         Jonathan Colon
         Twitter:        @jcolonfzenpr
         Github:         rebelinux
@@ -405,6 +405,10 @@ function Get-AbrVbrBackupjobVMware {
                                                     }
                                                     $OutObj = [pscustomobject]$inobj
 
+                                                    if ($HealthCheck.Jobs.BestPractice) {
+                                                        $OutObj | Where-Object { $_.'Enabled Backup File Encryption' -eq 'No'} | Set-Style -Style Warning -Property 'Enabled Backup File Encryption'
+                                                    }
+
                                                     $TableParams = @{
                                                         Name = "Advanced Settings (Storage) - $($Bkjob.Name)"
                                                         List = $true
@@ -414,6 +418,12 @@ function Get-AbrVbrBackupjobVMware {
                                                         $TableParams['Caption'] = "- $($TableParams.Name)"
                                                     }
                                                     $OutObj | Table @TableParams
+                                                    if ($HealthCheck.Jobs.BestPractice) {
+                                                        if ($OutObj | Where-Object { $_.'Enabled Backup File Encryption' -eq 'No'}) {
+                                                            Paragraph "Health Check:" -Italic -Bold -Underline
+                                                            Paragraph "Best Practice: Backup and replica data is a high potential source of vulnerability. To secure data stored in backups and replicas, use Veeam Backup & Replication inbuilt encryption to protect data in backups" -Italic -Bold
+                                                        }
+                                                    }
                                                 }
                                                 catch {
                                                     Write-PscriboMessage -IsWarning $_.Exception.Message

diff --git a/Src/Private/Get-AbrVbrConfigurationBackupSetting.ps1 b/Src/Private/Get-AbrVbrConfigurationBackupSetting.ps1
@@ -80,6 +80,20 @@ function Get-AbrVbrConfigurationBackupSetting {
                         $TableParams['Caption'] = "- $($TableParams.Name)"
                     }
                     $OutObj | Table @TableParams
+                    if ($HealthCheck.Infrastructure.BestPractice) {
+                        if ($OutObj | Where-Object { $_.'Encryption Enabled' -like 'No' -or $_.'Run Job Automatically' -like 'No' -or  $_.'Enabled' -like 'No' }) {
+                            Paragraph "Health Check:" -Italic -Bold -Underline
+                            if ($OutObj | Where-Object { $_.'Encryption Enabled' -like 'No'} ) {
+                                Paragraph "Best Practice: Whenever possible, enable configuration backup encryption." -Italic -Bold
+                            }
+                            if ($OutObj | Where-Object { $_.'Run Job Automatically' -like 'No'}) {
+                                Paragraph "Best Practice: It`s a recommended best practice to activate the 'Run job automatically' option of the Backup Configuration job." -Italic -Bold
+                            }
+                            if ($OutObj | Where-Object { $_.'Enabled' -like 'No'}) {
+                                Paragraph "Best Practice: It`s a recommended best practice to enable the Backup Configuration j ob" -Italic -Bold
+                            }
+                        }
+                    }
                 }
             }
         }

diff --git a/Src/Private/Get-AbrVbrEmailNotificationSetting.ps1 b/Src/Private/Get-AbrVbrEmailNotificationSetting.ps1
@@ -6,7 +6,7 @@ function Get-AbrVbrEmailNotificationSetting {
     .DESCRIPTION
         Documents the configuration of Veeam VBR in Word/HTML/Text formats using PScribo.
     .NOTES
-        Version:        0.7.1
+        Version:        0.7.2
         Author:         Jonathan Colon
         Twitter:        @jcolonfzenpr
         Github:         rebelinux
@@ -26,10 +26,10 @@ function Get-AbrVbrEmailNotificationSetting {
 
     process {
         try {
-            if ((Get-VBRMailNotificationConfiguration).count -gt 0) {
+            $EmailSettings = Get-VBRMailNotificationConfiguration
+            if ($EmailSettings) {
                 Section -Style Heading4 'Email Notification' {
                     $OutObj = @()
-                    $EmailSettings = Get-VBRMailNotificationConfiguration
                     foreach ($EmailSetting in $EmailSettings) {
                         $inObj = [ordered] @{
                             'Email Recipient' = $EmailSetting.Recipient
@@ -63,6 +63,10 @@ function Get-AbrVbrEmailNotificationSetting {
                         $TableParams['Caption'] = "- $($TableParams.Name)"
                     }
                     $OutObj | Table @TableParams
+                    if ($HealthCheck.Infrastructure.BestPractice -and ($OutObj | Where-Object { $_.'Enabled' -eq 'No' })) {
+                        Paragraph "Health Check:" -Italic -Bold -Underline
+                        Paragraph "Best Practice: Veeam recommends configuring email notifications to be able to receive alerts with the results of jobs performed on the backup server." -Italic -Bold
+                    }
                 }
             }
         }

diff --git a/Src/Private/Get-AbrVbrEnterpriseManagerInfo.ps1 b/Src/Private/Get-AbrVbrEnterpriseManagerInfo.ps1
@@ -54,6 +54,10 @@ function Get-AbrVbrEnterpriseManagerInfo {
 
                         if ($OutObj) {
 
+                            if ($HealthCheck.Infrastructure.BackupServer) {
+                                $OutObj | Where-Object { $_.'Skip License Push' -eq 'Yes' } | Set-Style -Style Warning -Property 'Skip License Push'
+                            }
+
                             $TableParams = @{
                                 Name = "Enterprise Manager - $($BackupServer.Name.Split(".")[0])"
                                 List = $true
@@ -63,6 +67,10 @@ function Get-AbrVbrEnterpriseManagerInfo {
                                 $TableParams['Caption'] = "- $($TableParams.Name)"
                             }
                             $OutObj | Table @TableParams
+                            if ($HealthCheck.Infrastructure.BestPractice -and ($OutObj | Where-Object { $_.'Skip License Push' -eq 'Yes' })) {
+                                Paragraph "Health Check:" -Italic -Bold -Underline
+                                Paragraph "Best Practice: Veeam recommends centralized license management through Enterprise Manager." -Italic -Bold
+                            }
                         }
                     }
                 }