AsBuiltReport.VMware.SRM

0.3.1

Src/Private/Get-AbrSRMProtectionGroupInfo.ps1

function Get-AbrSRMProtectionGroupInfo {
    <#
    .SYNOPSIS
    Used by As Built Report to retrieve VMware SRM Protection Group information.
    .DESCRIPTION

    .NOTES
        Version: 0.3.1
        Author: Jonathan Colon
        Twitter: @jcolonfzenpr
        Github: rebelinux
    .EXAMPLE

    .LINK

    #>
    [CmdletBinding()]
    param (
    )

    begin {
        Write-PScriboMessage "Protection Group Site InfoLevel set at $($InfoLevel.ProtectionGroup)."
        Write-PscriboMessage "Collecting SRM Protection Group information."
    }

    process {
        try {
            Section -Style Heading2 'Protection Groups Summary' {
                if ($Options.ShowDefinitionInfo) {
                    Paragraph "In Site Recovery Manager, protection groups are a way of grouping VMs that will be recovered together. A protection group contains VMs whose data has been replicated by either array-based replication (ABR) or vSphere replication (VR). A protection group cannot contain VMs replicated by more than one replication solution and, a VM can only belong to a single protection group."
                    BlankLine
                }
                Paragraph "The following table provides a summary of the Protection Group configured under $($LocalSRM.Name.split(".", 2).toUpper()[0])."
                BlankLine
                try {
                    $ProtectionGroups = $LocalSRM.ExtensionData.Protection.ListProtectionGroups()
                    if ($ProtectionGroups) {
                        $OutObj = @()
                        foreach ($ProtectionGroup in $ProtectionGroups) {
                            try {
                                if ($ProtectionGroup.ListRecoveryPlans()) {
                                    $RecoveryPlan = $ProtectionGroup.ListRecoveryPlans().getinfo().Name
                                }

                                $ProtectionGroupInfo = $ProtectionGroup.GetInfo()
                                Write-PscriboMessage "Discovered Protection Group $($ProtectionGroupInfo.Name)."
                                $inObj = [ordered] @{
                                    'Name' = $ProtectionGroupInfo.Name
                                    'Type' = $ProtectionGroupInfo.Type.ToUpper()
                                    'Protection State' = $ProtectionGroup.GetProtectionState()
                                    'Recovery Plan' = ConvertTo-EmptyToFiller $RecoveryPlan
                                }
                                $OutObj += [pscustomobject]$inobj
                            }
                            catch {
                                Write-PscriboMessage -IsWarning $_.Exception.Message
                            }
                        }
                    }
                    $TableParams = @{
                        Name = "Protection Group Information - $($ProtectionGroupInfo.Name)"
                        List = $False
                        ColumnWidths = 35, 15, 15, 35
                    }
                    if ($Report.ShowTableCaptions) {
                        $TableParams['Caption'] = "- $($TableParams.Name)"
                    }
                    $OutObj | Table @TableParams
                }
                catch {
                    Write-PscriboMessage -IsWarning $_.Exception.Message
                }
                try {
                    Section -Style Heading3 "Protection Groups" {
                        Paragraph "The following section provides detailed Protection Group informattion on $($LocalSRM.ExtensionData.GetLocalSiteInfo().SiteName) ."
                        BlankLine
                        $ProtectionGroups = $LocalSRM.ExtensionData.Protection.ListProtectionGroups()
                        if ($ProtectionGroups) {
                            Section -Style Heading4 "VMRS Protection Groups" {
                                if ($InfoLevel.ProtectionGroup -eq 1) {
                                    $OutObj = @()
                                    foreach ($ProtectionGroup in $ProtectionGroups) {
                                        try {
                                            $ProtectionGroupInfo = $ProtectionGroup.GetInfo() | Where-Object {$_.Type -like "VR"}
                                            if ($ProtectionGroupInfo) {
                                                Write-PscriboMessage "Discovered Protection Group $($ProtectionGroupInfo.Name)."
                                                if ($ProtectionGroup.ListProtectedVMs()) {
                                                    $ProtectedVMs = ConvertTo-VIobject $ProtectionGroup.ListProtectedVMs().vm.MoRef
                                                }

                                                $inObj = [ordered] @{
                                                    'Name' = $ProtectionGroupInfo.Name
                                                    'Type' = $ProtectionGroupInfo.Type.ToUpper()
                                                    'Protection State' = $ProtectionGroup.GetProtectionState()
                                                    'Protected VMs' = ConvertTo-EmptyToFiller (($ProtectedVMs | Sort-Object -Unique) -join ', ')
                                                }
                                                $OutObj += [pscustomobject]$inobj
                                            }
                                        }
                                        catch {
                                            Write-PscriboMessage -IsWarning $_.Exception.Message
                                        }
                                    }
                                    $TableParams = @{
                                        Name = "VRMS Protection Group - $($ProtectionGroupInfo.Name)"
                                        List = $false
                                        ColumnWidths = 35, 15, 15, 35
                                    }

                                    if ($Report.ShowTableCaptions) {
                                        $TableParams['Caption'] = "- $($TableParams.Name)"
                                    }
                                    $OutObj | Table @TableParams
                                }
                                if ($InfoLevel.ProtectionGroup -ge 2) {
                                    foreach ($ProtectionGroup in $ProtectionGroups) {
                                        $OutObj = @()
                                        try {
                                            $ProtectionGroupInfo = $ProtectionGroup.GetInfo() | Where-Object {$_.Type -like "VR"}
                                            if ($ProtectionGroupInfo) {
                                                Write-PscriboMessage "Discovered Protection Group $($ProtectionGroupInfo.Name)."
                                                if ($ProtectionGroup.ListProtectedVMs()) {
                                                    $ProtectedVMs = ConvertTo-VIobject $ProtectionGroup.ListProtectedVMs().vm.MoRef
                                                }
                                                if ($ProtectionGroup.ListAssociatedVms()) {
                                                    $AssociatedVMs = ConvertTo-VIobject $ProtectionGroup.ListAssociatedVms().MoRef
                                                }

                                                $inObj = [ordered] @{
                                                    'Name' = $ProtectionGroupInfo.Name
                                                    'Description' = ConvertTo-EmptyToFiller $ProtectionGroupInfo.Description
                                                    'Type' = $ProtectionGroupInfo.Type.ToUpper()
                                                    'Protection State' = $ProtectionGroup.GetProtectionState()
                                                    'Associated VMs' =  (($AssociatedVMs | Sort-Object -Unique) -join ', ')
                                                    'Protected VMs' = ConvertTo-EmptyToFiller (($ProtectedVMs | Sort-Object -Unique) -join ', ')
                                                }
                                                $OutObj = [pscustomobject]$inobj

                                                $TableParams = @{
                                                    Name = "VRMS Protection Group - $($ProtectionGroupInfo.Name)"
                                                    List = $true
                                                    ColumnWidths = 30, 70
                                                }
                                                if ($Report.ShowTableCaptions) {
                                                    $TableParams['Caption'] = "- $($TableParams.Name)"
                                                }
                                                $OutObj | Table @TableParams
                                            }
                                        }
                                        catch {
                                            Write-PscriboMessage -IsWarning $_.Exception.Message
                                        }
                                    }
                                }
                            }
                        }
                        try {
                            if ($ProtectionGroups) {
                                Section -Style Heading4 "SAN Protection Groups" {
                                    $OutObj = @()
                                    if ($InfoLevel.ProtectionGroup -eq 1) {
                                        foreach ($ProtectionGroup in $ProtectionGroups) {
                                            try {
                                                $ProtectionGroupInfo = $ProtectionGroup.GetInfo() | Where-Object {$_.Type -like "SAN"}
                                                if ($ProtectionGroupInfo) {
                                                    Write-PscriboMessage "Discovered Protection Group $($ProtectionGroupInfo.Name)."
                                                    if ($ProtectionGroup.ListProtectedVMs()) {
                                                        $ProtectedVMs = ConvertTo-VIobject $ProtectionGroup.ListProtectedVMs().vm.MoRef
                                                    }

                                                    if ($ProtectionGroup.ListProtectedDatastores()) {
                                                        $ProtectedDatastores = ConvertTo-VIobject $ProtectionGroup.ListProtectedDatastores().MoRef
                                                    }
                                                    $inObj = [ordered] @{
                                                        'Name' = $ProtectionGroupInfo.Name
                                                        'Type' = $ProtectionGroupInfo.Type.ToUpper()
                                                        'Protection State' = $ProtectionGroup.GetProtectionState()
                                                        'Protected Datastores' = ConvertTo-EmptyToFiller (($ProtectedDatastores | Sort-Object) -join ', ')
                                                        'Protected VMs' = ConvertTo-EmptyToFiller (($ProtectedVMs | Sort-Object -Unique) -join ', ')
                                                    }
                                                    $OutObj += [pscustomobject]$inobj
                                                }
                                            }
                                            catch {
                                                Write-PscriboMessage -IsWarning $_.Exception.Message
                                            }
                                        }
                                        $TableParams = @{
                                            Name = "SAN Protection Group - $($ProtectionGroupInfo.Name)"
                                            List = $False
                                            ColumnWidths = 26, 10, 11, 26, 27
                                        }
                                        if ($Report.ShowTableCaptions) {
                                            $TableParams['Caption'] = "- $($TableParams.Name)"
                                        }
                                        $OutObj | Table @TableParams
                                    }
                                    if ($InfoLevel.ProtectionGroup -ge 2) {
                                        foreach ($ProtectionGroup in $ProtectionGroups) {
                                            try {
                                                $ProtectionGroupInfo = $ProtectionGroup.GetInfo() | Where-Object {$_.Type -like "SAN"}
                                                if ($ProtectionGroupInfo) {
                                                    Write-PscriboMessage "Discovered Protection Group $($ProtectionGroupInfo.Name)."
                                                    if ($ProtectionGroup.ListProtectedVMs()) {
                                                        $ProtectedVMs = ConvertTo-VIobject $ProtectionGroup.ListProtectedVMs().vm.MoRef
                                                    }

                                                    if ($ProtectionGroup.ListProtectedDatastores()) {
                                                        $ProtectedDatastores = ConvertTo-VIobject $ProtectionGroup.ListProtectedDatastores().MoRef
                                                    }
                                                    $inObj = [ordered] @{
                                                        'Name' = $ProtectionGroupInfo.Name
                                                        'Description' = ConvertTo-EmptyToFiller $ProtectionGroupInfo.Description
                                                        'Type' = $ProtectionGroupInfo.Type.ToUpper()
                                                        'Protection State' = $ProtectionGroup.GetProtectionState()
                                                        'Protected Datastores' = ConvertTo-EmptyToFiller (($ProtectedDatastores | Sort-Object -Unique) -join ', ')
                                                        'Protected VMs' = ConvertTo-EmptyToFiller (($ProtectedVMs | Sort-Object -Unique) -join ', ')
                                                    }
                                                    $OutObj = [pscustomobject]$inobj

                                                    $TableParams = @{
                                                        Name = "SAN Protection Group - $($ProtectionGroupInfo.Name)"
                                                        List = $true
                                                        ColumnWidths = 30, 70
                                                    }
                                                    if ($Report.ShowTableCaptions) {
                                                        $TableParams['Caption'] = "- $($TableParams.Name)"
                                                    }
                                                    $OutObj | Table @TableParams
                                                }
                                            }
                                            catch {
                                                Write-PscriboMessage -IsWarning $_.Exception.Message
                                            }
                                        }
                                    }
                                }
                            }
                        }
                        catch {
                            Write-PscriboMessage -IsWarning $_.Exception.Message
                        }
                        if ($InfoLevel.ProtectionGroup -ge 2) {
                            try {
                                if ($RemotevCenter) {
                                    Section -Style Heading3 'Virtual Machine Protection Properties' {
                                        Paragraph "The following section provides detailed VM Recovery PlaceHolder informattion on $($LocalSRM.ExtensionData.GetLocalSiteInfo().SiteName) ."
                                        BlankLine
                                        $ProtectionGroups = $LocalSRM.ExtensionData.Protection.ListProtectionGroups()
                                        foreach ($ProtectionGroup in $ProtectionGroups) {
                                            try {
                                                Section -Style Heading4 "$($ProtectionGroup.GetInfo().Name)" {
                                                    $OutObj = @()
                                                    if ($ProtectionGroups) {
                                                        if ($ProtectionGroup.ListProtectedVMs()) {
                                                            $ProtectedVMs = $ProtectionGroup.ListProtectedVMs()
                                                        }
                                                        if ($InfoLevel.ProtectionGroup -eq 2) {
                                                            foreach ($ProtectedVM in $ProtectedVMs) {
                                                                try {
                                                                    $PlaceholderVmInfo = $ProtectionGroup.GetPlaceholderVmInfo($ProtectedVM)
                                                                    $inObj = [ordered] @{
                                                                        'VM Name' = Switch ($PlaceholderVmInfo.Vm) {
                                                                            "" {"-"}
                                                                            $Null {"-"}
                                                                            default {get-vm -id $PlaceholderVmInfo.Vm | Sort-Object -Unique}
                                                                        }
                                                                        'Resource Pool' = Switch ($PlaceholderVmInfo.ResourcePool) {
                                                                            "Resources" {"Root Resource Pool"}
                                                                            default {ConvertTo-VIobject $PlaceholderVmInfo.ResourcePool}
                                                                        }
                                                                        'Folder Name' = Switch ($PlaceholderVmInfo.Folder) {
                                                                            "" {"-"}
                                                                            $Null {"-"}
                                                                            default {(get-folder -Id $PlaceholderVmInfo.Folder | Sort-Object -Unique).Name}
                                                                        }
                                                                        'Is Repair Needed' = ConvertTo-TextYN $PlaceholderVmInfo.RepairNeeded
                                                                        'Placeholder Creation Fault' = ConvertTo-EmptyToFiller $PlaceholderVmInfo.PlaceholderCreationFault
                                                                    }
                                                                    $OutObj += [pscustomobject]$inobj
                                                                }
                                                                catch {
                                                                    Write-PscriboMessage -IsWarning $_.Exception.Message
                                                                }
                                                            }
                                                            $TableParams = @{
                                                                Name = "VM Recovery PlaceHolder - $($ProtectionGroup.GetInfo().Name)"
                                                                List = $False
                                                                ColumnWidths = 20, 25, 25, 10, 20
                                                            }

                                                            if ($Report.ShowTableCaptions) {
                                                                $TableParams['Caption'] = "- $($TableParams.Name)"
                                                            }
                                                            $OutObj | Table @TableParams
                                                        }
                                                        if ($InfoLevel.ProtectionGroup -eq 3) {
                                                            foreach ($ProtectedVM in $ProtectedVMs) {
                                                                try {
                                                                    $PlaceholderVmInfo = $ProtectionGroup.GetPlaceholderVmInfo($ProtectedVM)
                                                                    $inObj = [ordered] @{
                                                                        'VM Name' = Switch ($PlaceholderVmInfo.Vm) {
                                                                            "" {"-"}
                                                                            $Null {"-"}
                                                                            default {get-vm -id $PlaceholderVmInfo.Vm | Sort-Object -Unique}
                                                                        }
                                                                        'Data Center' = ConvertTo-VIobject $PlaceholderVmInfo.Datacenter

                                                                        'Compute Resource' = ConvertTo-VIobject $PlaceholderVmInfo.ComputeResource
                                                                        'Host Name' = ConvertTo-VIobject $PlaceholderVmInfo.Host
                                                                        'Resource Pool' = Switch ($PlaceholderVmInfo.ResourcePool) {
                                                                            "Resources" {"Root Resource Pool"}
                                                                            default {ConvertTo-VIobject $PlaceholderVmInfo.ResourcePool}
                                                                        }
                                                                        'Folder Name' = Switch ($PlaceholderVmInfo.Folder) {
                                                                            "" {"-"}
                                                                            $Null {"-"}
                                                                            default {get-folder -Id $PlaceholderVmInfo.Folder | Sort-Object -Unique}
                                                                        }
                                                                        'Is Repair Needed' = ConvertTo-TextYN $PlaceholderVmInfo.RepairNeeded
                                                                        'Placeholder Creation Fault' = ConvertTo-EmptyToFiller $PlaceholderVmInfo.PlaceholderCreationFault
                                                                    }
                                                                    $OutObj = [pscustomobject]$inobj

                                                                    $TableParams = @{
                                                                        Name = "VM Recovery PlaceHolder - $($ProtectionGroup.GetInfo().Name)"
                                                                        List = $true
                                                                        ColumnWidths = 30, 70
                                                                    }

                                                                    if ($Report.ShowTableCaptions) {
                                                                        $TableParams['Caption'] = "- $($TableParams.Name)"
                                                                    }
                                                                    $OutObj | Table @TableParams
                                                                }
                                                                catch {
                                                                    Write-PscriboMessage -IsWarning $_.Exception.Message
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                            catch {
                                                Write-PscriboMessage -IsWarning $_.Exception.Message
                                            }
                                        }
                                    }
                                }
                            }
                            catch {
                                Write-PscriboMessage -IsWarning $_.Exception.Message
                            }
                        }
                    }
                }
                catch {
                    Write-PscriboMessage -IsWarning $_.Exception.Message
                }
            }
        }
        catch {
            Write-PscriboMessage -IsWarning $_.Exception.Message
        }
    }
    end {}
}