[Updated] Prepare XenApp 6.x Server for Imaging with PVS

Hello again,

today I want to share a small PowerShell script that I use to semi-automatically prepare a XenApp 6.x server for imaging with PVS. It automates the following steps:

• Investigate the PVS’ Personality.ini in the root of the system drive in order to determine the disk mode (read-write, read-only, or started from local HD)
• Start the Citrix IMA service
• Query XenApp Server Load. Exit if the query fails. Exit if the XenApp server count is below 3.
• Run XenAppConfigConsole to prepare the server for imaging. (Based on the script user’s choice locally stored XenApp database information will be either kept or cleared from mf20.dsn and LGPO. Default is keep db information. If you choose to clear them you need to provide DB information through GPO.)
• Clear XenApp related caches (LHC and RADE)
• Clear Citrix User Profile Manager’s cache
• Resync time
• Update GPO settings
• Clear network related caches (DNS and ARP)
• Clear WSUS Client related settings
• Clear event logs
• Based on the findings in Step 1, suggest a convenient main action, that is either “Exit” (if we’re in maintenance/private w/ read-write vdisk access), or “Invoke ImagingWizard” (if we started from local HD), or “Invoke XenConvert” (reverse imaging scenario w/ read-only vdisk access)

# XenAppPrep.ps1
# --------------
# http://www.out-web.net/?p=1164

$DISK_MODE_READ_WRITE = 0
$DISK_MODE_LOCAL_HD = 1
$DISK_MODE_READ_ONLY = 2

$ANSWER_YES = 0
$ANSWER_NO = 1

function Read-Choice
{
    param (
        $Caption,
        $Message,
        $Option = $(throw 'Please specify some options.'),
        $HelpText,
        $Default = 0
    )
    [Management.Automation.Host.ChoiceDescription[]] $Choices = @()
    for ($i = 0; $i -lt $Option.Length; $i++)
    {
        $OptionText = $Option[$i]
        $Choice = New-Object Management.Automation.Host.ChoiceDescription $OptionText
        if($HelpText -and $HelpText[$i])
        {
            $Choice.HelpMessage = $HelpText[$i]
        }
        $Choices += $Choice
    }
    $host.UI.PromptForChoice($Caption, $Message, $Choices, $Default)
}


# ------------------------------------------------------------------------------

Write-Host 'Provisioning Server Image Prepare Script for XenApp 6.x' -ForegroundColor White

$Choice = Read-Choice -Caption 'PVS XenApp Image Prep' `
    -Message 'Are you ready to start?' `
        -Option '&Yes','&No' -HelpText 'Yes, execute this script','No, exit this script' `
            -Default 1
if ($Choice -eq $ANSWER_NO)
{
    return
}


# ------------------------------------------------------------------------------

if (Test-Path -Path ${env:SystemDrive}\Personality.ini)
{
    [string] $DiskName = & "${env:ProgramFiles}\Citrix\Provisioning Services\GetPersonality.exe" `$DiskName /o
    Write-Host "Disk Name: $DiskName"

    [int] $WriteCacheType = & "${env:ProgramFiles}\Citrix\Provisioning Services\GetPersonality.exe" `$WriteCacheType /o
    switch ($WriteCacheType)
    {
        0
        {
            $Mode = $DISK_MODE_READ_WRITE
            Write-Host "Disk Mode: Private/Maintenance (Read-Write)"
        }

        default
        {
            $Mode = $DISK_MODE_READ_ONLY
            Write-Host "Disk Mode: Standard (Read-Only)"
        }
    }
}
else
{
    $DiskName = ''
    $Mode = $DISK_MODE_LOCAL_HD
    Write-Host "Disk Mode: Local Hard Disk"
}


# ------------------------------------------------------------------------------

Write-Host '1. Checking IMA-Server Status (must be Running)'

$IMAservice = Get-Service -Name imaservice -ErrorAction SilentlyContinue
if ($IMAservice.Status -eq 'Stopped')
{
    Write-Host 'Start Citrix IMA service'
    $IMAservice.Start()
    $IMAservice.WaitForStatus('Running')
}


# ------------------------------------------------------------------------------

Write-Host '2. Import XenApp 6.5 PowerShell SnapIns. This may take a while.'

Add-PSSnapIn Citrix.XenApp.Commands -ErrorAction SilentlyContinue


# ------------------------------------------------------------------------------

Write-Host '3. Query Farm for correct IMA Communication'

$Qfarm_Status = Get-XAServerLoad -ErrorAction SilentlyContinue
if ($Qfarm_Status.Count -gt 2)
{
    Write-Host 'Query Farm succesfully finished.' -ForegroundColor DarkGreen
}
else
{
    Write-Host 'Error querying XenApp Farm' -ForegroundColor Red
    Write-Host $Qfarm_Status
    Write-Host "Script will be closed in less than 15 seconds. Check XenApp Status for running Script again." -ForegroundColor Red
    Start-Sleep -Seconds 15
    return
}


# ------------------------------------------------------------------------------

$Choice = Read-Choice -Caption '4. Prepare XenApp for imaging' `
    -Message 'Clear database information (name and server) from mf20.dsn and LGPO?' `
        -Option '&Yes','&No' -HelpText 'Yes, I provide database and zone information through GPO','No, please keep mf20.dsn' `
            -Default 1
if ($Choice -eq $ANSWER_NO)
{
    & "${env:ProgramFiles(x86)}\Citrix\XenApp\ServerConfig\XenAppConfigConsole.exe" /ExecutionMode:ImagePrep /RemoveCurrentServer:True /PrepMsmq:True
}
else
{
    & "${env:ProgramFiles(x86)}\Citrix\XenApp\ServerConfig\XenAppConfigConsole.exe" /ExecutionMode:ImagePrep /RemoveCurrentServer:True /PrepMsmq:True /ClearLocalDatabaseInformation:True
}
if ($LASTEXITCODE -gt 0)
{
    Write-Host 'Error preparing XenApp server' -ForegroundColor Red
    Write-Host "Script will be closed in less than 15 seconds. Check XenApp Status for running Script again." -ForegroundColor Red
    Start-Sleep -Seconds 15
    return
}


# ------------------------------------------------------------------------------

Write-Host '5. Clear Citrix related caches (LHC, RADE, UPM)'

DsMaint.exe RECREATELHC
DsMaint.exe RECREATERADE
$UPMCACHE = "${env:ProgramFiles}\Citrix\User Profile Manager\UserProfileManager_?.cache"
if (Test-Path -Path $UPMCACHE)
{
    $UPMservice = Get-Service -Name ctxProfile -ErrorAction SilentlyContinue
    if ($UPMservice.Status -eq 'Running')
    {
        $IMAservice.Stop()
        $IMAservice.WaitForStatus('Stopped')
    }
    Remove-Item $UPMCACHE -Force
}


# ------------------------------------------------------------------------------

Write-Host '6. Resync time'

Write-Host 'Checking W32Time-Service Status (must be Running)'
$TIMEservice = Get-Service -Name W32Time -ErrorAction SilentlyContinue
if ($TIMEservice.Status -eq 'Stopped')
{
    Write-Host 'Start W32Time service'
    $TIMEservice.Start()
    $TIMEservice.WaitForStatus('Running')
}

w32tm.exe /config /update
w32tm.exe /resync


# ------------------------------------------------------------------------------

Write-Host '7. Update GPO settings'

gpupdate.exe /force


# ------------------------------------------------------------------------------

Write-Host '8. Clear networking related caches (DNS and ARP)'

ipconfig.exe /flushdns
arp.exe -d


# ------------------------------------------------------------------------------

Write-Host '9. Clear WSUS Client related regisrty keys'

$WUservice = Get-Service -Name wuauserv -ErrorAction SilentlyContinue
if ($WUservice.Status -eq 'Running')
{
    Write-Host 'Stop Windows Update service'
    $WUservice.Stop()
    $WUservice.WaitForStatus('Stopped')
}
$WUregkey = 'HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\WindowsUpdate'
Remove-ItemProperty -Path $WUregkey -Name AccountDomainSid -ErrorAction SilentlyContinue
Remove-ItemProperty -Path $WUregkey -Name SusClientId -ErrorAction SilentlyContinue
Remove-ItemProperty -Path $WUregkey -Name PingID -ErrorAction SilentlyContinue
Remove-ItemProperty -Path $WUregkey -Name SusClientIdValidation -ErrorAction SilentlyContinue


# ------------------------------------------------------------------------------

Write-Host '10. Clear event logs'

Get-EventLog -List | ForEach-Object {Clear-EventLog -LogName $_.Log} -ErrorAction Inquire


# ------------------------------------------------------------------------------

$Choice = Read-Choice -Caption '11. PVS XenApp Image Prep' `
    -Message 'Choose between the following options' `
        -Option '&Exit', '&ImagingWizard', '&XenConvert' `
            -HelpText 'Exit the Script to shutdown this machine manually (Private/Maintenance vDisk mode)', `
                      'Invoke PVS ImagingWizard to create a new VHD from this machine (vP2PVS)', `
                      'Invoke XenConvert to image this machine to existing and already mapped vDisk or make a re-image (PVS2vP, vP2PVS)' `
                -Default $Mode
switch ($Choice)
{
    0
    {
        Write-Host 'You chose "Exit". Finishing script with TargetDeviceOptimizer...' -ForegroundColor DarkGreen
        Start-Process "${env:ProgramFiles}\Citrix\Provisioning Services\TargetOSOptimizer.exe"
    }

    1
    {
        Write-Host 'You chose "ImagingWizard". Invoking PVS ImagingWizard...' -ForegroundColor DarkGreen
        Start-Process "${env:ProgramFiles}\Citrix\Provisioning Services\ImagingWizard.exe" -Wait
    }

    2
    {
        Write-Host 'You chose "XenConvert". Invoking Citrix XenConvert...' -ForegroundColor DarkGreen
        Start-Process "${env:ProgramFiles}\Citrix\XenConvert\XenConvert.exe" -Wait
    }
}


# ------------------------------------------------------------------------------

Write-Host 'Script finished. Press any key to exit.' -ForegroundColor Green

$x = $host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown")

Write-Host 'KKTHXBYE' -ForegroundColor DarkGreen

The script raises no claim to completeness. For example, you should consider running chkdsk C: as consistency check and Mark Russinovich’s SDelete to reduce storage needs.

Disclaimer: I hope that the information in this post is valuable to you. Your use of the information contained in this post, however, is at your sole risk. All information on this post is provided “as is”, without any warranty, whether express or implied, of its accuracy, completeness, fitness for a particular purpose, title or non-infringement, and none of the third-party products or information mentioned in the work are authored, recommended, supported or guaranteed by me. Further, I shall not be liable for any damages you may sustain by using this information, whether direct, indirect, special, incidental or consequential, even if it has been advised of the possibility of such damages.