AsBuiltReport.Veeam.VB365

0.4.0

Src/Private/Get-AbrVb365BackupCopyJob.ps1

function Get-AbrVb365BackupCopyJob {
    <#
    .SYNOPSIS
    Used by As Built Report to retrieve Veeam VB365 Backup Copy Jobs
    .DESCRIPTION
        Documents the configuration of Veeam VB365 in Word/HTML/Text formats using PScribo.
    .NOTES
        Version: 0.4.0
        Author: Jonathan Colon
        Twitter: @jcolonfzenpr
        Github: rebelinux
        Credits: Iain Brighton (@iainbrighton) - PScribo module
 
    .LINK
        https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VB365
    #>
    [CmdletBinding()]
    param (
    )

    begin {
        Write-PScriboMessage -Message "BackupCopyJob InfoLevel set at $($InfoLevel.Jobs.BackupCopyJob)."
    }

    process {
        try {
            if ($InfoLevel.Jobs.BackupCopyJob -le 0) {
                return
            }

            if ($script:BackupCopyJobs) {
                Write-PScriboMessage -Message 'Using cached Veeam VB365 Backup Copy Jobs inventory.'
                $BackupCopyJobs = $script:BackupCopyJobs
            } else {
                Write-PScriboMessage -Message 'Collecting Veeam VB365 Backup Copy Jobs inventory.'
                $script:BackupCopyJobs = Get-VBOCopyJob | Sort-Object -Property Name
                $BackupCopyJobs = $script:BackupCopyJobs
            }

            if (($InfoLevel.Jobs.BackupCopyJob -gt 0) -and ($BackupCopyJobs)) {
                $BackupCopyJobRepositoryLookup = Get-AbrVb365ExternalBackupCopyJobRepositoryMap
                Write-PScriboMessage -Message 'Collecting Veeam VB365 Backup Copy Jobs.'
                Section -Style Heading3 'Backup Copy Jobs' {
                    $BackupCopyJobInfo = @()
                    foreach ($BackupCopyJob in $BackupCopyJobs) {
                        Write-PScriboMessage -Message "Processing backup copy job '$($BackupCopyJob.Name)'."
                        $CopyJobName = Invoke-AbrVb365TimedValue -Label "backup copy job '$($BackupCopyJob.Name)' Name property" -ScriptBlock { $BackupCopyJob.Name }
                        $CopyJobId = Get-AbrVb365PropertyValue -InputObject $BackupCopyJob -Name 'Id'
                        $CopyJobLookupKey = ConvertTo-AbrVb365LookupKey -Id $CopyJobId
                        $CopyJobRepository = if ($CopyJobLookupKey -and $BackupCopyJobRepositoryLookup.ContainsKey("id:$CopyJobLookupKey")) {
                            $BackupCopyJobRepositoryLookup["id:$CopyJobLookupKey"]
                        } elseif ($CopyJobName -and $BackupCopyJobRepositoryLookup.ContainsKey("name:$CopyJobName")) {
                            $BackupCopyJobRepositoryLookup["name:$CopyJobName"]
                        } else {
                            '--'
                        }
                        $CopyJobSchedulePolicy = Invoke-AbrVb365TimedValue -Label "backup copy job '$CopyJobName' SchedulePolicy property" -ScriptBlock { ConvertTo-AbrVb365DisplayValue -InputObject $BackupCopyJob.SchedulePolicy }
                        $CopyJobLastStatus = Invoke-AbrVb365TimedValue -Label "backup copy job '$CopyJobName' LastStatus property" -ScriptBlock { $BackupCopyJob.LastStatus }
                        $CopyJobIsEnabled = Invoke-AbrVb365TimedValue -Label "backup copy job '$CopyJobName' IsEnabled property" -ScriptBlock { $BackupCopyJob.IsEnabled }

                        $inObj = [ordered] @{
                            'Name' = $CopyJobName
                            'Repository' = $CopyJobRepository
                            'Schedule Policy' = $CopyJobSchedulePolicy
                            'Last Status' = $CopyJobLastStatus
                            'Is Enabled' = $CopyJobIsEnabled
                        }

                        if ($InfoLevel.Jobs.BackupCopyJob -ge 2) {
                            $CopyJobLastRun = Invoke-AbrVb365TimedValue -Label "backup copy job '$CopyJobName' LastRun property" -ScriptBlock { $BackupCopyJob.LastRun }
                            $CopyJobNextRun = Invoke-AbrVb365TimedValue -Label "backup copy job '$CopyJobName' NextRun property" -ScriptBlock { $BackupCopyJob.NextRun }
                            $CopyJobLastBackup = Invoke-AbrVb365TimedValue -Label "backup copy job '$CopyJobName' LastBackup property" -ScriptBlock { $BackupCopyJob.LastBackup }
                            $CopyJobDescription = Invoke-AbrVb365TimedValue -Label "backup copy job '$CopyJobName' Description property" -ScriptBlock { $BackupCopyJob.Description }

                            $inObj.Add('Last Run', $CopyJobLastRun)
                            $inObj.Add('Next Run', $CopyJobNextRun)
                            $inObj.Add('Last Backup', $CopyJobLastBackup)
                            $inObj.Add('Description', $CopyJobDescription)
                        }

                        $BackupCopyJobInfo += [pscustomobject](ConvertTo-HashToYN $inObj)
                    }

                    if ($HealthCheck.Jobs.BackupCopyJob) {
                        $BackupCopyJobInfo | Where-Object { $_.'Is Enabled' -eq 'No' } | Set-Style -Style Warning -Property 'Is Enabled'
                        $BackupCopyJobInfo | Where-Object { $_.'Last Status' -eq 'Success' } | Set-Style -Style Ok -Property 'Last Status'
                        $BackupCopyJobInfo | Where-Object { $_.'Last Status' -eq 'Warning' } | Set-Style -Style Warning -Property 'Last Status'
                        $BackupCopyJobInfo | Where-Object { $_.'Last Status' -eq 'Failed' } | Set-Style -Style Critical -Property 'Last Status'
                    }

                    $chartFileItem = $null
                    if ($Options.EnableCharts -ne $false) {
                        try {
                            $Alljobs = @()

                            if ($BackupCopyJobInfo.'Last Status') {
                                $Alljobs += $BackupCopyJobInfo.'Last Status'
                            }

                            $sampleData = [ordered]@{
                                'Success' = ($Alljobs | Where-Object { $_ -eq 'Success' } | Measure-Object).Count
                                'Warning' = ($Alljobs | Where-Object { $_ -eq 'Warning' } | Measure-Object).Count
                                'Failed' = ($Alljobs | Where-Object { $_ -eq 'Failed' } | Measure-Object).Count
                                'Stopped' = ($Alljobs | Where-Object { $_ -eq 'Stopped' } | Measure-Object).Count
                            }

                            $sampleDataObj = $sampleData.GetEnumerator() | Select-Object @{ Name = 'Category'; Expression = { $_.key } }, @{ Name = 'Value'; Expression = { $_.value } }

                            $chartLabels = [string[]]$sampleDataObj.Category
                            $chartValues = [double[]]$sampleDataObj.Value

                            $statusCustomPalette = @('#DFF0D0', '#FFF3C4', '#FECDD1', '#ADACAF')

                            $chartFileItem = New-BarChart -Title 'Backup Copy Jobs Latest Results' -Values $chartValues -Labels $chartLabels -LabelXAxis 'Status' -LabelYAxis 'Results' -EnableCustomColorPalette -CustomColorPalette $statusCustomPalette -Width 600 -Height 400 -Format base64 -EnableLegend -LegendOrientation Horizontal -LegendAlignment UpperCenter -AxesMarginsTop 0.5 -TitleFontBold -TitleFontSize 16

                        } catch {
                            Write-PScriboMessage -IsWarning -Message "Backup Copy Chart Section: $($_.Exception.Message)"
                        }
                    }

                    if ($InfoLevel.Jobs.BackupCopyJob -ge 2) {
                        Paragraph "The following sections detail the configuration of the backup copy job within $VeeamBackupServer backup server."
                        if ($chartFileItem) {
                            Image -Text 'Backup Copy Job - Diagram' -Align 'Center' -Percent 100 -Base64 $chartFileItem
                        }
                        foreach ($BackupCopyJob in $BackupCopyJobInfo) {
                            Section -ExcludeFromTOC -Style NOTOCHeading4 "$($BackupCopyJob.Name)" {
                                $TableParams = @{
                                    Name = "Backup Copy Job - $($BackupCopyJob.Name)"
                                    List = $true
                                    ColumnWidths = 40, 60
                                }
                                if ($Report.ShowTableCaptions) {
                                    $TableParams['Caption'] = "- $($TableParams.Name)"
                                }
                                $BackupCopyJob | Table @TableParams
                            }
                        }
                    } else {
                        Paragraph "The following table summarizes the configuration of the backup copy jobs within the $VeeamBackupServer backup server."
                        BlankLine
                        if ($chartFileItem) {
                            Image -Text 'Backup Copy Job - Diagram' -Align 'Center' -Percent 100 -Base64 $chartFileItem
                        }
                        $TableParams = @{
                            Name = "Backup Copy Job - $VeeamBackupServer"
                            List = $false
                            Columns = 'Name', 'Repository', 'Schedule Policy', 'Is Enabled', 'Last Status'
                            ColumnWidths = 28, 27, 15, 15, 15
                        }
                        if ($Report.ShowTableCaptions) {
                            $TableParams['Caption'] = "- $($TableParams.Name)"
                        }
                        $BackupCopyJobInfo | Table @TableParams
                    }
                }
            }
        } catch {
            Write-PScriboMessage -IsWarning -Message "Backup Copy Jobs Section: $($_.Exception.Message)"
        }
    }

    end {}
}