Src/Private/Get-AbrHRZFarm.ps1
|
function Get-AbrHRZFarm { <# .SYNOPSIS PowerShell script which documents the configuration of VMware Horizon in Word/HTML/XML/Text formats .DESCRIPTION Documents the configuration of VMware Horizon in Word/HTML/XML/Text formats using PScribo. .NOTES Version: 1.1.4 Author: Chris Hildebrandt, Karl Newick Twitter: @childebrandt42, @karlnewick Editor: Jonathan Colon, @jcolonfzenpr Twitter: @asbuiltreport Github: AsBuiltReport Credits: Iain Brighton (@iainbrighton) - PScribo module .LINK https://github.com/AsBuiltReport/AsBuiltReport.VMware.Horizon #> [CmdletBinding()] param ( ) begin { Write-PScriboMessage "Farm InfoLevel set at $($InfoLevel.Inventory.Farms)." Write-PScriboMessage "Collecting Farm information." } process { try { if ($Farms) { if ($InfoLevel.Inventory.Farms -ge 1) { Section -Style Heading3 "Farm Pools" { Paragraph "The following section details the Farms configuration for $($HVEnvironment.toUpper()[0]) server." BlankLine $OutObj = @() foreach ($Farm in $Farms) { Write-PScriboMessage "Discovered Farms Information." $inObj = [ordered] @{ 'Name' = $Farm.Data.displayName 'Type' = $Farm.Type 'Enabled' = $Farm.Data.Enabled } $OutObj += [pscustomobject](ConvertTo-HashToYN $inObj) } if ($HealthCheck.Farms.Status) { $OutObj | Where-Object { $_.'Enabled' -eq 'No' } | Set-Style -Style Warning -Property 'Enabled' } $TableParams = @{ Name = "Farms - $($HVEnvironment.toUpper()[0])" List = $false ColumnWidths = 34, 33, 33 } if ($Report.ShowTableCaptions) { $TableParams['Caption'] = "- $($TableParams.Name)" } $OutObj | Sort-Object -Property 'Name' | Table @TableParams try { if ($InfoLevel.Inventory.Farms -ge 2) { Section -Style Heading4 "Farm Pools Details" { foreach ($Farm in $Farms) { Section -Style NOTOCHeading5 $($Farm.Data.name) { # Find out Access Group for Applications $AccessgroupMatch = $false $AccessgroupJoined = @() $AccessgroupJoined += $Accessgroups $AccessgroupJoined += $Accessgroups.Children foreach ($Accessgroup in $AccessgroupJoined) { if ($Accessgroup.Id.id -eq $Farm.data.accessgroup.id) { $AccessGroupName = $Accessgroup.base.name $AccessgroupMatch = $true } if ($AccessgroupMatch) { break } } # Farm AD Container $FarmContainerName = '' if ($Farm.AutomatedFarmData.CustomizationSettings.AdContainer.id) { foreach ($ADDomain in $ADDomains) { $ADDomainID = ($ADDomain.id.id -creplace '^[^/]*/', '') if ($Farm.AutomatedFarmData.CustomizationSettings.AdContainer.id -like "ADContainer/$ADDomainID/*") { $ADContainers = $hzServices.ADContainer.ADContainer_ListByDomain($ADDomain.id) foreach ($ADContainer in $ADContainers) { if ($ADContainer.id.id -eq $Farm.AutomatedFarmData.CustomizationSettings.AdContainer.id) { $FarmContainerName = $ADContainer.rdn break } } } } } # Farm Customization Type $Customizations = ('') If ($Farm.AutomatedFarmData.CustomizationSettings.SysprepCustomizationSettings.CustomizationSpec) { Foreach ($vCenterServer in $vCenterServers) { $Customizations = $hzServices.CustomizationSpec.CustomizationSpec_List($vCenterServer.id) Foreach ($Customization in $Customizations) { if ($Farm.AutomatedFarmData.CustomizationSettings.SysprepCustomizationSettings.CustomizationSpec.id -eq $Customization.id.id) { $FarmCustomization = $($Customization.CustomizationSpecData.Name) } } } } try { Section -ExcludeFromTOC -Style NOTOCHeading5 "General" { $OutObj = @() Write-PScriboMessage "Discovered $($Farm.Data.name) General Information." $inObj = [ordered] @{ 'Pool Name' = $Farm.Data.name 'Display Name' = $Farm.Data.displayName 'Description' = $Farm.Data.description 'Access Group' = $AccessGroupName 'Type' = $Farm.Type 'Source' = $Farm.Source 'Enabled' = $Farm.Data.Enabled 'Deleting' = $Farm.Data.Deleting 'Desktop' = $Farm.Data.Desktop 'App Volumes Server' = $Farm.Data.AppVolumesManagerGuid 'Default Display Protocol' = $Farm.Data.DisplayProtocolSettings.DefaultDisplayProtocol 'Allow Users to Choose Protocol' = $Farm.Data.DisplayProtocolSettings.AllowDisplayProtocolOverride 'HTML Access' = $Farm.Data.DisplayProtocolSettings.EnableHTMLAccess 'Enable Grid GPUs' = $Farm.Data.DisplayProtocolSettings.EnableGridGpu 'vGPU Profile' = $Farm.Data.DisplayProtocolSettings.VGPUGridProfile } $OutObj = [pscustomobject](ConvertTo-HashToYN $inObj) if ($HealthCheck.Farms.Status) { $OutObj | Where-Object { $_.'Enabled' -eq 'No' } | Set-Style -Style Warning -Property 'Enabled' } $TableParams = @{ Name = "General Information - $($Farm.Data.name)" List = $true ColumnWidths = 50, 50 } if ($Report.ShowTableCaptions) { $TableParams['Caption'] = "- $($TableParams.Name)" } $OutObj | Table @TableParams } } catch { Write-PScriboMessage -IsWarning $_.Exception.Message } try { Section -ExcludeFromTOC -Style NOTOCHeading5 "Load Balancing Settings" { $OutObj = @() Write-PScriboMessage "Discovered $($Farm.Data.name) Load Balancing Settings." $inObj = [ordered] @{ 'Use Custom Script' = $Farm.Data.LbSettings.UseCustomScript 'Include Session Count' = $Farm.Data.LbSettings.LbMetricsSettings.IncludeSessionCount 'CPU Usage Threshold' = $Farm.Data.LbSettings.LbMetricsSettings.CpuThreshold 'Memory Usage Threshold' = $Farm.Data.LbSettings.LbMetricsSettings.MemThreshold 'Disk Queue Length Threshold' = $Farm.Data.LbSettings.LbMetricsSettings.DiskQueueLengthThreshold 'Disk Read Latency Threshold' = $Farm.Data.LbSettings.LbMetricsSettings.DiskReadLatencyThreshold 'Disk Write Latency Threshold' = $Farm.Data.LbSettings.LbMetricsSettings.DiskWriteLatencyThreshold } $OutObj = [pscustomobject](ConvertTo-HashToYN $inObj) $TableParams = @{ Name = "Load Balancing Settings - $($Farm.Data.name)" List = $true ColumnWidths = 50, 50 } if ($Report.ShowTableCaptions) { $TableParams['Caption'] = "- $($TableParams.Name)" } $OutObj | Table @TableParams } } catch { Write-PScriboMessage -IsWarning $_.Exception.Message } try { Section -ExcludeFromTOC -Style NOTOCHeading5 "Provisioning Settings" { $OutObj = @() Write-PScriboMessage "Discovered $($Farm.Data.name) Settings." $inObj = [ordered] @{ 'Provisioning Enabled' = $Farm.AutomatedFarmData.VirtualCenterProvisioningSettings.EnableProvisioning 'Stop Provisioning on Error' = $Farm.AutomatedFarmData.VirtualCenterProvisioningSettings.StopProvisioningOnError 'Disconnected Session Timeout Minutes' = $Farm.Data.settings.DisconnectedSessionTimeoutMinutes 'Disconnected Session Timeout Policy' = $Farm.Data.settings.DisconnectedSessionTimeoutPolicy 'Empty Session Timeout Minutes' = $Farm.Data.settings.EmptySessionTimeoutMinutes 'Empty Session Timeout Policy' = $Farm.data.Settings.EmptySessionTimeoutPolicy 'Log off After Timeout' = $Farm.data.Settings.LogoffAfterTimeout } $OutObj = [pscustomobject](ConvertTo-HashToYN $inObj) if ($HealthCheck.Farms.Status) { $OutObj | Where-Object { $_.'Provisioning Enabled' -eq 'No' } | Set-Style -Style Warning -Property 'Provisioning Enabled' } $TableParams = @{ Name = "Provisioning Settings - $($Farm.Data.name)" List = $true ColumnWidths = 50, 50 } if ($Report.ShowTableCaptions) { $TableParams['Caption'] = "- $($TableParams.Name)" } $OutObj | Table @TableParams } } catch { Write-PScriboMessage -IsWarning $_.Exception.Message } try { Section -ExcludeFromTOC -Style NOTOCHeading6 "vCenter Server Settings" { $OutObj = @() Write-PScriboMessage "Discovered $($Farm.Data.name) vCenter Server Settings Information." $inObj = [ordered] @{ 'VM folder' = $Farm.AutomatedFarmData.VirtualCenterNamesData.VmFolderPath 'Host Or Cluster Path' = $Farm.AutomatedFarmData.VirtualCenterNamesData.HostOrClusterPath 'Resource Pool' = $Farm.AutomatedFarmData.VirtualCenterNamesData.ResourcePoolPath 'Golden Image' = $Farm.AutomatedFarmData.VirtualCenterNamesData.ParentVmPath 'Snapshot' = $Farm.AutomatedFarmData.VirtualCenterNamesData.SnapshotPath 'Datastore Paths' = ($Farm.AutomatedFarmData.VirtualCenterNamesData.DatastorePaths | ForEach-Object { $_.Split('/')[4] }) -join ', ' 'Networks' = Switch ($Farm.AutomatedFarmData.VirtualCenterNamesData.NetworkLabelNames) { $null { 'Golden Image network selected' } default { $Farm.AutomatedFarmData.VirtualCenterNamesData.NetworkLabelNames } } } $OutObj = [pscustomobject](ConvertTo-HashToYN $inObj) $TableParams = @{ Name = "vCenter Settings - $($Farm.Data.name)" List = $true ColumnWidths = 50, 50 } if ($Report.ShowTableCaptions) { $TableParams['Caption'] = "- $($TableParams.Name)" } $OutObj | Table @TableParams } } catch { Write-PScriboMessage -IsWarning $_.Exception.Message } try { Section -ExcludeFromTOC -Style NOTOCHeading5 "Guest Customization" { $OutObj = @() Write-PScriboMessage "Guest Customization $($Farm.Data.name) Settings." $inObj = [ordered] @{ 'Guest Customization' = $Farm.AutomatedFarmData.CustomizationSettings.CustomizationType 'Guest Customization Domain and Account' = ($InstantCloneDomainAdmins | Where-Object { $_.Id.id -eq $Farm.AutomatedFarmData.CustomizationSettings.InstantCloneEngineDomainAdministrator.id }).Base.UserName 'Allow Reuse of Existing Computer Accounts' = $Farm.AutomatedFarmData.CustomizationSettings.ReusePreExistingAccounts 'AD Container' = $FarmContainerName 'Farm Customization Specification' = $FarmCustomization 'Power Off Script Name' = $Farm.AutomatedFarmData.CustomizationSettings.CloneprepCustomizationSettings.PowerOffScriptName 'Power Off Script Parameters' = $Farm.AutomatedFarmData.CustomizationSettings.CloneprepCustomizationSettings.PowerOffScriptParameters 'Post Sync Script Name' = $Farm.AutomatedFarmData.CustomizationSettings.CloneprepCustomizationSettings.PostSynchronizationScriptName 'Post Sync Script Parameters' = $Farm.AutomatedFarmData.CustomizationSettings.CloneprepCustomizationSettings.PostSynchronizationScriptParameters 'Priming Computer Account' = $Farm.AutomatedFarmData.CustomizationSettings.CloneprepCustomizationSettings.PrimingComputerAccount } $OutObj = [pscustomobject](ConvertTo-HashToYN $inObj) if ($Farm.AutomatedFarmData.CustomizationSettings.SysprepCustomizationSettings.CustomizationSpec -eq "SYS_PREP") { $inObj.Remove('Power Off Script Name') $inObj.Remove('Power Off Script Parameters') $inObj.Remove('Post Sync Script Name') $inObj.Remove('Post Sync Script Parameters') $inObj.Remove('Priming Computer Account') } $TableParams = @{ Name = "Guest Customization - $($Farm.Data.name)" List = $true ColumnWidths = 50, 50 } 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 } } end {} } |