smitpi / XDHealthCheck

Citrix XenDesktop HTML Health Check Report

XDHealthCheck

Description

Creates daily health check and config reports for your on-premise Citrix farm. To get started, you need to run Install-ParametersFile. This will capture and save needed farm details, to allow scripts to run automatically.

Getting Started

• Install from PowerShell Gallery PS Gallery

Install-Module -Name XDHealthCheck -Verbose

• or run this script to install from GitHub GitHub Repo

$CurrentLocation = Get-Item .
$ModuleDestination = (Join-Path (Get-Item (Join-Path (Get-Item $profile).Directory 'Modules')).FullName -ChildPath XDHealthCheck)
git clone --depth 1 https://github.com/smitpi/XDHealthCheck $ModuleDestination 2>&1 | Write-Host -ForegroundColor Yellow
Set-Location $ModuleDestination
git filter-branch --prune-empty --subdirectory-filter Output HEAD 2>&1 | Write-Host -ForegroundColor Yellow
Set-Location $CurrentLocation

• Then import the module into your session

Import-Module XDHealthCheck -Verbose -Force

• or run these commands for more help and details.

Get-Command -Module XDHealthCheck
Get-Help about_XDHealthCheck

Documentation can be found at: Github_Pages

Functions

• Get-CitrixConfigurationChange -- Show the changes that was made to the farm
• Get-CitrixConnectionFailures -- Creates a report from monitoring data about machine and connection failures
• Get-CitrixEnvTestResults -- Perform and report on tests on catalogs, delivery groups, hypervisor and Infrastructure
• Get-CitrixFarmDetail -- Get needed Farm details.
• Get-CitrixLicenseInformation -- Show Citrix License details
• Get-CitrixMonitoringData -- Connects and collects data from the monitoring OData feed.
• Get-CitrixObjects -- Get details of citrix objects
• Get-CitrixResourceUtilizationSummary -- Resource Utilization Summary for machines
• Get-CitrixServerEventLog -- Get windows event log details
• Get-CitrixServerPerformance -- Collects perform data for the core servers.
• Get-CitrixSessionIcaRtt -- Creates a report of users sessions with a AVG IcaRttMS
• Get-CitrixVDAUptime -- Calculate the uptime of VDA Servers.
• Get-CitrixWorkspaceAppVersions -- Reports on the versions of workspace app your users are using to connect
• Get-RDSLicenseInformation -- Report on RDS License Usage
• Import-ParametersFile -- Import the config file and creates the needed variables
• Install-ParametersFile -- Create a json config file with all needed farm details.
• Set-XDHealthReportColors -- Set the color and logo for HTML Reports
• Start-CitrixAudit -- Creates and distributes a report on Catalog, groups and published app config.
• Start-CitrixHealthCheck -- Creates and distributes a report on citrix farm health.