Thursday, September 15, 2022

Citrix Application Performance Reports

 A user had the following request:

I have a Citrix XA/XD 7.15 LTSR environment and would like to write performance data for two applications (Ex: App1, App2) to an Excel spreadsheet using a Powershell script with the following information:
- Application launch and load times
- Application usage report with the number of users for a particular timespan

Please see the linked PowerShell scripts below. You will need to modify the variables $SQLServer and $SQLDBName for your environment and run the scripts as a Citrix Admin with rights to the Director Monitoring database.

Get-AppLogonDuration.ps1 - will create a report on logon duration for the specified applications for the past x days (defaults to 7).

Examples:

    >.\Get-AppLogonDuration.ps1 -days 3

    Will display information for ALL applications for the past 3 days

    >.\Get-AppLogonDuration.ps1 -apps "'Notepad','SnippingTool'" | Sort StartDate -Desc

    Will display information for the applications 'Notepad' and 'SnippingTool' for the past 7 days (default),
    and sort latest entries first
   
   >.\Get-AppLogonDuration.ps1 -days 30 | Sort LogonSecs -Desc | Select -first 10

    Will show the longest 10 logon times over the past 30 days


Get-UniqueAppCounts.ps1 - will create a report on the number of unique users executing the specified applications for the specified duration

Examples:
    >.\Get-UniqueAppCounts.ps1 -days 3

    Will display counts for all applications for the past 3 days

    >.\Get-UniqueAppCounts.ps1 -apps "'Notepad','SnippingTool'"

    Will display counts for the applications 'Notepad' and 'SnippingTool' for the past 7 days (default).

Thursday, June 2, 2022

Kill a User's Citrix Desktop or Application Session

 A user asked for an easy way via PowerShell to kill a user's Citrix application or desktop session.

On one of the Delivery Controllers, save the below script as Logoff-Sessions.ps1, and execute it. 

You will be prompted for the username (entered as domain\username), and then all of the user's sessions will be listed.

You will be asked for confirmation when you make your selection before logging the session off.

Function Logoff-Session {

    # logoff a specified user's session

    asnp Citrix*

    $user = Read-Host -Prompt "Enter User Name (domain\user format)"
    if ($user -ne '') {
        $sessions = @(Get-BrokerSession | ? username -eq $user |
            Select  @{n='SessionKey'; e={$_.SessionKey}},
                    @{n='Host/Desktop'; e={$_.MachineName}},
                    @{n='Application(s)'; e={$_.ApplicationsInUse}})

        if ($sessions.count -eq 0) {
            Write-Host "Sorry ... there are no applications active for $($user)."
        } else {
            Write-Host 'Session#'.Padright(10) 'Host/Desktop'.PadRight(30) 'Application(s)'
            for ($i=0; $i -lt $sessions.Count; ++$i) {
                $sessnum = $i + 1
                Write-Host $sessnum.ToString().PadLeft(5) '    ' $sessions[$i].'Host/Desktop'.PadRight(30) $sessions[$i].'Application(s)'
            }
            $logoff = Read-Host "Which session would you like to log off (0 to exit)?"

            if ($logoff -eq 0 -or $logoff -eq '') {
                return
            }
            if ($logoff -le $sessions.Count) {
                $sessnum = $logoff - 1
                Write-Host $sessions[$sessnum].'Host/Desktop'.PadRight(30) $sessions[$sessnum].'Application(s)'
                $yn = Read-Host "Is this the session you would like to logoff (Y/N)?"
                if ($yn -eq 'Y') {
                    Stop-BrokerSession $sessions[$sessnum].SessionKey
                }
            }
        }
    }
}

Tuesday, March 29, 2022

Request from a forum user:

I'm running Citrix 7.15 Enterprise edition. Can I get a PowerShell script to retrieve a count of disconnected sessions and available machines in each delivery group ? I would like to send the output to a .csv file.

Here is a very simple way to accomplish this via PowerShell:

Add-PSSnapIn Citrix*
Get-BrokerDesktopGroup | Sort-Object Name | Select-Object Name, 
DesktopsDisconnected, DesktopsAvailable |
Export-Csv -Path "C:\temp\DGinfo.csv" -NoTypeInformation


Sunday, January 16, 2022

Copy Applications from One Delivery Group to Another

A forum user asked if there was an easy way to copy all applications from one delivery group to another. Here is a simple PowerShell script to accomplish this:

Function Select-DG ($DGs, $Title = 'Select Delivery Group'){

    Write-Host ""
    Write-Host "=====   Delivery Groups   ====="
    $menuDGs = @{}
    For ($i=1;$i -le $DGs.count; $i++)
    {
        Write-Host "$i. $($DGs[$i-1].Name)"
        $menuDGs.Add($i,($DGs[$i-1].Name))
    }
    [int]$ansDG = if(($ansDG = Read-Host $Title) -eq ''){0} else {$ansDG}

    if ($ansDG -eq 0) { return 0 }
    if ($ansDG -gt 0 -and $ansDG -lt $DGs.Count) {
        $DGSelected = $menuDGs.Item($ansDG)
        (Get-BrokerDesktopGroup | ? Name -eq "$($DGSelected)").UID
    } else {
        Write-Host "Selection not valid, please make a valid selection between 1 and $($i-1)..."
        return 0
    }
}

# retrieve Delivery Groups and pass to function so you don't have to retrieve them twice
$DeliveryGroups = Get-BrokerDesktopGroup | Sort Name | Select Name, UID

$sourceDG = Select-DG $DeliveryGroups "Select the source Delivery Group (0 to exit)"
if ($sourceDG -ne 0) {
    $targetDG = Select-DG $DeliveryGroups "Select the target Delivery Group (0 to exit)"
}
if ($targetDG -eq 0) { return }
if ($sourceDG -eq $targetDG) {
    Write-Host "Target Delivery Group may not be the same as the Source Delivery Group."
    return
}
$DGApps = Get-BrokerApplication | ? AllAssociatedDesktopGroupUids -contains $sourceDG

$sourceName = (Get-BrokerDesktopGroup | ? Uid -eq $sourceDG).Name
$targetName = (Get-BrokerDesktopGroup | ? Uid -eq $targetDG).Name
Write-Host ""
Write-Host "Source Delivery Group: $($sourceName)"
Write-Host "Target Delivery Group: $($targetName)"

# copy each app
foreach ($app in $DGApps) {
    Write-Host "Copying: $($app.BrowserName)"
    $app | Add-BrokerApplication -DesktopGroup $targetName
}
Write-Host "Done."

Thursday, October 14, 2021

Retrieve Local Administrators from Multiple Computers

 A forum user asked for assistance with a PowerShell script that would read a list of servers from a text file and then either show the list of users in the local administrator groups on each server.

The script below, Get-LocalMembers, takes things a bit further. While it will default to the local administrators group, you can supply any number of groups to the script. It even supports wildcards! By default, the results are displayed on the console, but can also export the results as a .csv file.

The script takes 2 parameters (both optional):

Computers

A list of computers to query. The list may be provided as a parameter to the script, or read from a text file. Default: localhost

Groups

A list of local groups to query on each of the computers. Wildcards are support (see examples below). Default: Administrators

Examples

Get-LocalMembers

    Retrieves the members of the default group (Administrators) on the default computer(localhost).

Get-LocalMembers -Computers (Get-Content -Path "c:\temp\computers.txt")

    Will retrieve the members of the Administrators group on all the computers in the file computers.txt.

Get-LocalMembers -groups 'Remote*','Admin*'

    Will retrieve the members of the Administrators, Remote Desktop Users and Remote Management Users groups on localhost.

Get-LocalMembers | Export-Csv -Path "c:\reports\GroupMembers.csv" -NoTypeInformation

    Retrieves the members of the default group (Administrators) on the default computer(localhost) and exports them to the specified .csv file.

Function Get-LocalMembers {
<#
.SYNOPSIS
    Gets the members of one or more local groups of the specified computer(s) 
    and optionally outputs the results to a CSV file.

.PARAMETER Computers
    Specifies the computers to query.
    Can be a string or a list retrieved from a file via Get-Content (see examples).
    Default: $env:computername (localhost)

.PARAMETER Groups
    Specifies the groups to query. Supports wildcards. 
    Can be a string or a list retrieved from a file via Get-Content (see examples).
    (e.g. Remote* will enumerate both Remote Desktop Users and Remote Management Users)
    Default: Administrators

.EXAMPLE
    Get-LocalMembers
    Retrieves the members of the default group (Administrators) on the default computer(localhost)

.EXAMPLE
    Get-LocalMembers -Computers (Get-Content -Path "c:\temp\computers.txt")
    Will retrieve the members of the Administrators group on all the computers in the file computers.text

.EXAMPLE
    Get-LocalMembers -groups 'Remote*'
    Will retrieve the members of the Remote Desktop Users and Remote Management Users groups on localhost

.EXAMPLE
    Get-LocalMembers | Export-Csv -Path "c:\reports\GroupMembers.csv" -NoTypeInformation

.LINK
    Heavily modified from script: https://gallery.technet.microsoft.com/223cd1cd-2804-408b-9677-5d62c2964883
#>

    Param(
        [string[]]$Computers,
        [string[]]$Groups
    )

    # defaults
    if ($Computers -eq $null) {
        $Computers = $env:COMPUTERNAME
    }
    if ($Groups -eq $null) {
        $groups = 'Administrators'
    }

    # testing the connection to each computer via ping before executing the script
    foreach ($computer in $Computers) {
        if (Test-Connection -ComputerName $computer -Quiet -count 1) {
            $livePCs += $computer
        } else {
            Write-Host ('Computer {0} is unreachable.' -f $computer) -ForegroundColor DarkRed -BackgroundColor White
        }
    }

    $list = new-object -TypeName System.Collections.ArrayList

    # cycle through each computer in the list
    foreach ($computer in $livePCs) {

        # cycle through each group in the list
        foreach($groupToTest in $groups) {
            $err = @()
            $admins = @(Get-WmiObject -Class win32_groupuser -ComputerName $computer -EA SilentlyContinue -EV err | 
                Where-Object {$_.groupcomponent -like "*`"$($groupToTest)`""})

            if ($err.Count -gt 0) {
                $errMsg =  $err[0].Exception.Message
                Write-Host ('Error accessing WMI on {0} ... {1}' -f $computer, $err[0].Exception.Message) `
                            -ForegroundColor DarkRed -BackgroundColor White
            } else {
               if ($admins.Count -gt 0) {
                    # get the group name
                    $null =  $admins[0].Groupcomponent -match '.+Domain\=(.+)\,Name\=(.+)$'
                    $group = $matches[2].trim('"')

                    # get the members of the group
                    $aAdmins = @() 
                    foreach ($admin in $admins) {
                        $null = $admin.partcomponent -match '.+Domain\=(.+)\,Name\=(.+)$' 
                        $null = $matches[1].trim('"') + '\' + $matches[2].trim('"') + "`n"
                        $aAdmins += $matches[1].trim('"') + '\' + $matches[2].trim('"')
                    }
                    $obj = New-Object -TypeName PSObject -Property @{
                        Computer = $computer
                        Group    = $group
                        Members  = ($aAdmins -join ',')
                    }
                    $null = $list.add($obj)
                }
            }
        }
    }
    $list | select computer, group, members
}

Sam Jacobs is the Director of Technology at Newtek Technology Systems (formerly IPM), the longest standing Citrix Platinum Partner on the East Coast. With more than 30 years of IT consulting, Sam is a NetScaler and StoreFront customizations and integrations industry expert. He holds Microsoft and Citrix certifications, and is the editor of TechDevCorner.com, a technical resource blog for IT professionals. He is one of the top Citrix support Forum contributors, and has earned industry praise for the tools he has developed to make NetScaler, StoreFront and Web Interface easier to manage for administrators and more intuitive for end users. Sam became a Citrix Technology Professional (CTP) in 2015, and can be reached at: sjacobs@newtekone.com or on Twitter at: @WIGuru.


Sunday, September 12, 2021

Log Off Idle Citrix Sessions

The simple PowerShell snippet below will log off any session that has been idle for more than the specified number of hours.


# sessions that have been idle for longer than 
# the below number of hours will be logged off
$maxIdleHours = 24

# load the Citrix snapin
Add-PSSnapin Citrix*

# function to calculate the number of hours
# that a session has been idle
Function Get-IdleHours {
    param ([TimeSpan] $IdleTime)
    ($IdleTime.Days * 24) + $IdleTime.Hours
}

# get sessions that are idle
$sessions = @(Get-Brokersession | ? IdleDuration -ne $null)

# cycle through the list, and log off sessions that
# have been idle for > the specified number of hours
foreach ($sess in $sessions) {
    if ((Get-IdleHours($sess.IdleDuration)) -gt $maxIdleHours) {
        Stop-BrokerSession $sess
    }
}


Sam Jacobs is the Director of Technology at Newtek Technology Systems (formerly IPM), the longest standing Citrix Platinum Partner on the East Coast. With more than 30 years of IT consulting, Sam is a NetScaler and StoreFront customizations and integrations industry expert. He holds Microsoft and Citrix certifications, and is the editor of TechDevCorner.com, a technical resource blog for IT professionals. He is one of the top Citrix support Forum contributors, and has earned industry praise for the tools he has developed to make NetScaler, StoreFront and Web Interface easier to manage for administrators and more intuitive for end users. Sam became a Citrix Technology Professional (CTP) in 2015, and can be reached at: sjacobs@newtekone.com or on Twitter at: @WIGuru.

Monday, October 26, 2020

Quickly Disconnect All ICA Sessions

A client recently asked for a way to quickly and easily disconnect all ICA sessions. This seemed like an easy task, which could be accomplished by enabling the Disconnect button within StoreFront. The problem was that the client wanted the ability for users to disconnect their sessions without logging in! Since we don't know who the user is until after login, how would we know which session(s) to disconnect?

I then found out that the Citrix Receiver Self-Service Plug-in had a parameter that will allow you to disconnect all of your applications by simply running the following:

SelfService.exe -disconnectapps

Then it became a matter of creating a new URL Protocol to invoke the above when browsing to the specified protocol. With the assistance of my colleague Jacques Bensimon, we created the attached .REG file. An explanation of the keys in the .REG file follows.

[HKEY_CLASSES_ROOT\xica] defines a new URL protocol called xica.

[HKEY_CLASSES_ROOT\xica\shell\open\command] specifies the registered handler to execute when the URL protocol is invoked.

The final REG key:

[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Internet Explorer\ProtocolExecute\xica]

eliminates the IE prompt asking permission to run the registered handler. (Note: Other browsers may or may not prompt, and may have their own way of eliminating prompts, including possibly giving the user the option to no longer be prompted for these protocols. Those settings may not be in the Registry at all, but rather in some config files in the user profile.)

To invoke the new protocol, you simply needed to browse to it. This could be accomplished in many ways. For example, you could create a shortcut on the desktop with the URL xica://DisconnectApps. You could also invoke the protocol via a hyperlink or a button on a web page.


Sam Jacobs is the Director of Technology Development at IPM, the longest standing Citrix Platinum Partner on the East Coast. With more than 30 years of IT consulting, Sam is a NetScaler and StoreFront customizations and integrations industry expert. He holds Microsoft MCSD, Citrix and CCP-N certifications, and is the editor of TechDevCorner.com, a technical resource blog for IT professionals. He is one of the top Citrix support Forum contributors, and has earned industry praise for the tools he has developed to make NetScaler, StoreFront and Web Interface easier to manage for administrators and more intuitive for end users. Sam became a Citrix Technology Professional (CTP) in 2015, and can be reached at: sam.jacobs@ipm.com or on Twitter at: @WIGuru.