You are using an ad blocker that is interfering with our web typography and internal javascript. Please whitelist our domain to live in a more beautiful world. No ads here, just really great software!

April 2nd Webinar: Remote Working – Putting the Employee First Register Now

cookie alert

We use cookies to offer you a better browsing experience, analyze site traffic, personalize content, and serve targeted advertisements. If you continue to use this site, you consent to our use of cookies.

Nexthink Library

Citrix Management

Investigate Citrix platform usage in the environment and retrieve Virtual Applications round-trip time.

Get Citrix VDI Connection Details Get Virtual Apps Session Response Time

Content

Remote actions - 2

Required Modules

Nexthink Act

Platforms

Windows 7 and 10
Windows server
Citrix XenDesktop

Compatibility

V6.14 and later
Install

Description

This pack helps Nexthink users to investigate further Citrix usage in their environment. Includes action related to Virtual Desktop Infrastructure (VDI).Includes also an action to retrieve the round-trip time delay from the opened sessions in servers.

  • 2.0.0.0 - 19 Feb 2020 - Added "Get Virtual Apps Session Response Time" remote action
  • 1.0.0.0 - 11 Feb 2019 - Initial release

Get Citrix VDI Connection Details

Script Description

Retrieves Citrix connections metrics from ICA device. Useful for troubleshooting performance degradation, or network latency issues.

Execution context and suggested scheduling

Run the script as 'interactive user'. The script should be executed manually.

A timeout of 720 seconds is recommended.

Parameters

Label Description
Maximum Delay In Seconds Maximum random delay set to avoid overloading server hosting virtual machines. Provide number of seconds less than 600

Outputs

Label Type Description
Session ID Int Identification number of a current user session on a device
Roundtrip Time Int Latency metric between user action and graphical response
Network Latency Int Latency metric between ICA client device and the Citrix VDI session over the network
Input Bandwidth Available Int Bandwidth estimation, from client to the Citrix VDI session
Input Bandwidth Used Int Average Bytes/Second sent, from client to the Citrix VDI session
Output Bandwidth Available Int Bandwidth estimation, from Citrix VDI session to the client
Output Bandwidth Used Int Average Bytes/Second sent, from Citrix VDI session to the client

Further Information

The script works in a VDI mode of XenDesktop. It is not designed for using in the shared desktop mode of XenApp.

Get Virtual Apps Session Response Time

Script Description

Retrieves user experience statistics from the current Citrix Virtual Applications sessions and categorize them as good, acceptable or degraded according to their response time.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 720 seconds is recommended.

Parameters

Label Description
Maximum Delay In Seconds Maximum random delay set to avoid network overload. Provide number of seconds lower than 600
Good Threshold Maximum value in milliseconds below which round-trip time user experience is considered as good. Provide number of milliseconds lower than 10000
Acceptable Threshold Maximum value in milliseconds below which round-trip time user experience is considered as acceptable. Provide number of milliseconds lower than 10000 and greater than GoodThreshold

Outputs

Label Type Description
Good User Experience Sessions Int Total count of user sessions with round-trip time below the GoodThreshold value
Acceptable User Experience Sessions Int Total count of user sessions with round-trip time between GoodThreshold and AcceptableThreshold values
Degraded User Experience Sessions Int Total count of user sessions with round-trip time exceeding the AcceptableThreshold value
Degraded User Experience Sessions Ratio Ratio Ratio of degraded user sessions vs all user sessions
Degraded Sessions Details StringList List of properties of degraded user experience sessions, separated by colon. Each list item will describe separate user session. The expected output format is CSV

Test Scenarios

ThresholdDefinedProperly
Test Case The threshold is defined with valid ranges.
Environment Windows Server 2012
Results Success - No errors are shown.
ThresholdValuesAreEqual
Test Case The threshold is not defined with valid values.
Environment Windows Server 2012
Results Failure - An error about the user experience threshold incorrectly defined is shown.
ThresholdBeginningGreaterThanEnd
Test Case GoodThreshold is greater than AcceptableThreshold.
Environment Windows Server 2012
Results Failure - An error about the user experience threshold incorrectly defined is shown.
GoodSession
Test Case The round trip time of the session is better than the defined threshold.
Environment Windows Server 2012
Results Success - The GoodUserExperienceSessions output is increased.
AcceptableSession
Test Case The round trip time of the session is included in the defined threshold.
Environment Windows Server 2012
Results Success - The AcceptableUserExperienceSessions output is increased.
DegradedSession
Test Case The round trip time of the session is degraded.
Environment Windows Server 2012
Results Success - The DegradedUserExperienceSessions output is increased, the ratio is modified and the details filled with the session information.