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!

Experience Everywhere On-Demand: Learn how Global 2000 firms are approaching Digital Employee Experience in 2021. Get Access

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

Latest Version: 4.0.1.0
Install

Required Products

Nexthink Act

Platforms

Windows 7 and 10
Windows server
Citrix XenDesktop

Compatibility

V6.14 and later

Description

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

Versions

  • 4.0.1.0 - 15 Dec 2020 - Fixed "Get Citrix Session Client Versions" Remote Action
  • 4.0.0.0 - 17 Nov 2020 - Added "Get Citrix Session Client Versions" Remote Action
  • 3.1.0.0 - 07 Aug 2020 - Improved the "Get Virtual Apps Session Response Time" Remote Action and renamed "Get Citrix Registry Key Values" Remote Action to "Get Citrix Information"
  • 3.0.0.0 - 16 Jul 2020 - Added "Get Citrix Registry Key Values" Remote Action
  • 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 Information

Script Description

Returns the value data of some Citrix Registry properties.

Execution context and suggested scheduling

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

A timeout of 120 seconds is recommended.

Parameters

None.

Outputs

Label Type Description
Agent Status String Status of the Citrix Agent according to the VM registration
Farm Id String ID of the top level Citrix provisional logical group
Farm Name String Name of the top level Citrix provisional logical group
Hostpool String Name of the group of devices which the device belongs to
Server Coordinator String List of FQDNs or IPs belonging to Citrix Controllers and Cloud Connectors

Further Information

Returns the value data of the following Citrix Registry properties:
* AgentStatus
* FarmId
* FarmName
* Hostpool
* ServerCoordinator.

Test Scenarios

AllPropertiesAreAvailable
Test Case All the registry properties hold values
Environment Windows 7 & 10 VMs with various languages
Results Success - The remote action outputs the values of the registry key properties correctly
SomePropertiesAreAvailable
Test Case Only some of the registry properties hold values
Environment Windows 7 & 10 VMs with various languages
Results Success - The remote action outputs the empty values as expected ("-")
RegKeyPathCannotBeReached
Test Case The Registry paths cannot be accessed by current interactive user
Environment Windows 7 & 10 VMs with various languages
Results Success - The remote action outputs the empty values as expected ("-")

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 Citrix Session Client Versions

Script Description

Retrieves the client version from the current Citrix sessions and check their compliance against a provided list of compatible versions.

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
Compatible Versions List Comma-separated list of versions considered as compliant. Provide values which match 'Major.Minor.Build' or 'Major.Minor' format, such as '14.12, 14.12.1'

Outputs

Label Type Description
Incompatible Sessions Int Total count of Citrix sessions considered as incompatible or non-compliant with the compatible version list
Incompatible Sessions Ratio Ratio Ratio of incompatible Citrix sessions
Incompatible Sessions Details StringList List of properties of incompatible Citrix sessions, separated by colon. Each list item will describe separate Citrix session. The expected output format is CSV

Further Information

If the user only logs out from the Citrix Receiver the session will still be open and the Remote Action's results will reveal it. In order to close a session, it would be necessary to perform a proper sign out by connecting to the remote machine through the Citrix Receiver.
In case the build number is not provided in the compliant versions list, all the releases belonging to the 'Major.Minor' version will be considered as compatible.

Test Scenarios

AllSessionsAreCompatible
Test Case Provided compatible version is '14.12' and the clients have versions from '14.12.0' to '14.12.5'.
Environment Virtual Windows end-points
Results Success - The outputs are empty as all the versions are compatible. When the build number is not provided all the patches for those versions are considered as compatible.
SessionsAreInCompatible
Test Case Provided compatible version is '14.13' and the clients have '14.12.0'.
Environment Virtual Windows end-points
Results Success - The outputs are filled with the information about the incompatible sessions. The ratio of incompatible sessions is 100%

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
Internal Subnets List Comma-separated list of IPv4 subnets to define a connection like internal. They must be listed in CIDR notation
VPN Subnets List Comma-separated list of IPv4 subnets to define a connection like VPN. They must be listed in CIDR notation

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
Degraded User Experience External Sessions Ratio Ratio Ratio of degraded user sessions when the connection type is External (not internal nor VPN)
Degraded User Experience VPN Sessions Ratio Ratio Ratio of degraded user sessions when the connection type is VPN

Further Information

If the user only logs out from the Citrix Receiver the session will still be open and the Remote Action's results will reflect it. In order to close a session it would be necessary to perform a proper sign out by connecting to the remote machine through the Citrix Receiver.

Test Scenarios

SessionsAreExternal
Test Case The active sessions are from external connections.
Environment Windows Server 2012
Results Success - No errors are shown and the Degraded User Experience External Sessions Ratio is showing 100%.
SessionsAreInternal
Test Case The active sessions are from internal connections.
Environment Windows Server 2012
Results Success - No errors are shown and the degraded user experience ratios are updated accordingly.
SessionsAreFromVPN
Test Case The active sessions are from VPN connections and are degraded.
Environment Windows Server 2012
Results Success - No errors are shown and the Degraded User Experience VPN Sessions Ratio is showing 100%.
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.