AsBuiltReport.Veeam.VB365

0.1.1

Src/Private/Get-AbrVb365BackupRepository.ps1

function Get-AbrVB365BackupRepository {
    <#
    .SYNOPSIS
    Used by As Built Report to retrieve Veeam VB365 Backup Repository
    .DESCRIPTION
        Documents the configuration of Veeam VB365 in Word/HTML/Text formats using PScribo.
    .NOTES
        Version: 0.1.1
        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 "Repository InfoLevel set at $($InfoLevel.Infrastructure.Repository)."
    }

    process {
        try {
            $Repositories = Get-VBORepository | Sort-Object -Property Name
            if (($InfoLevel.Infrastructure.Repository -gt 0) -and ($Repositories)) {
                Write-PscriboMessage "Collecting Veeam VB365 Backup Repository."
                Section -Style Heading2 'Backup Repositories' {
                    $RepositoryInfo = @()
                    foreach ($Repository in $Repositories) {
                        $inObj = [ordered] @{
                            'Name' = $Repository.Name
                            'Path' = $Repository.Path
                            'Object Storage Repository' = Switch ([string]::IsNullOrEmpty($Repository.ObjectStorageRepository)) {
                                $true {"Disabled"}
                                $false {$Repository.ObjectStorageRepository}
                                default {'Unknown'}
                            }
                            'Object Storage Encryption Key' = Switch ($Repository.EnableObjectStorageEncryption) {
                                $true {(Get-VBOEncryptionKey -id $Repository.ObjectStorageEncryptionKey.id).Description}
                                $false {"Disabled"}
                                default {"Unknown"}
                            }
                            'Is Outdated' = ConvertTo-TextYN $Repository.IsOutdated
                            'Is Out Of Sync' = ConvertTo-TextYN $Repository.IsOutOfSync
                            'Capacity' = ConvertTo-FileSizeString $Repository.Capacity
                            'Free Space' = ConvertTo-FileSizeString $Repository.FreeSpace
                            'Used Space' = ConvertTo-FileSizeString ($Repository.Capacity - $Repository.FreeSpace)
                            'Is Long Term' = ConvertTo-TextYN $Repository.IsLongTerm
                            'Retention Type' = Switch ($Repository.RetentionType) {
                                'SnapshotBased' {'Snapshot Based'}
                                'ItemLevel' {'Item Level'}
                                default {$Repository.RetentionType}
                            }
                            'Retention Period' = Switch ($Repository.RetentionPeriod) {
                                "Years1" {'1 Year'}
                                "Years2" {'2 Years'}
                                "Years3" {'3 Years'}
                                "Years5" {'5 Years'}
                                "Years7" {'7 Years'}
                                "Years10" {'10 Years'}
                                "Years25" {'25 Years'}
                                "KeepForever" {'Keep Forever'}
                                default {$Repository.RetentionPeriod}
                            }
                            'Retention Frequency Type' = $Repository.RetentionFrequencyType
                            'Description' = $Repository.Description

                        }
                        $RepositoryInfo += [PSCustomObject]$InObj
                    }

                    if ($HealthCheck.Infrastructure.Repository) {
                        $RepositoryInfo | Where-Object { $_.'Is Outdated' -eq 'Yes'} | Set-Style -Style Warning -Property 'Is Outdated'
                        $RepositoryInfo | Where-Object { $_.'Object Storage Repository' -ne 'Disabled' -and $_.'Object Storage Encryption Key' -eq 'Disabled'} | Set-Style -Style Warning -Property 'Object Storage Encryption Key'
                    }

                    if ($InfoLevel.Infrastructure.Repository -ge 2) {
                        Paragraph "The following sections detail the configuration of the backup repository within $VeeamBackupServer backup server."
                        foreach ($Repository in $RepositoryInfo) {
                            Section -ExcludeFromTOC -Style NOTOCHeading3 "$($Repository.Name)" {
                                $TableParams = @{
                                    Name = "Repository - $($Repository.Name)"
                                    List = $true
                                    ColumnWidths = 50, 50
                                }
                                if ($Report.ShowTableCaptions) {
                                    $TableParams['Caption'] = "- $($TableParams.Name)"
                                }
                                $Repository | Table @TableParams
                            }
                        }
                    } else {
                        Paragraph "The following table summarises the configuration of the backup repository within within the $VeeamBackupServer backup server."
                        BlankLine
                        $TableParams = @{
                            Name = "Repositories - $VeeamBackupServer"
                            List = $false
                            Columns = 'Name', 'Path', 'Retention Type', 'Capacity', 'Free Space'
                            ColumnWidths = 28, 27, 20, 12, 13
                        }
                        if ($Report.ShowTableCaptions) {
                            $TableParams['Caption'] = "- $($TableParams.Name)"
                        }
                        $RepositoryInfo | Table @TableParams
                    }
                }
            }
        } catch {
            Write-PscriboMessage -IsWarning "Repository Section: $($_.Exception.Message)"
        }
    }

    end {}
}