Script Library

Boost your management, troubleshoot, and remediation capabilities with scripts created by experts in the IT community.

<< Back to Script Library

Tag: xendesktop

(19 Scripts)
Run on a Citrix Delivery Controller as a user with at least read only Studio access to site and license data. It will highlight licenses due to expire within the specified number of days, to allow for the renewal process to commence, or where the maximum number of licenses is in use or has been exceeded.
Version: 1.1.5  |   Created: 2023-04-14  |   Modified: 2023-05-25  |   Creator: Guy Leech  |   Downloads: 31
Performs a test of all the technical requirements for HDX content redirection, which can potentially save bandwidth and CPU. The script's output provides the test results along with recommendations on components that need to be enabled or upgraded for content redirection to work.
Version: 1.4.20  |   Created: 2020-10-07  |   Modified: 2020-10-13  |   Creator: Marcel Calef  |   Downloads: 129
Run on a Delivery Controller or where the CVAD PowerShell snapins are available, e.g. Studio is installed. User running the script must have sufficient permission to chage the enabled state of the selected delivery groups
Version: 1.1.6  |   Created: 2020-10-06  |   Modified: 2020-10-13  |   Creator: Guy Leech  |   Downloads: 45
Run on a Delivery Controller or where the CVAD PowerShell snapins are available, e.g. Studio is installed or on a machine with the DaaS Remote PowerShell SDK (for Cloud). User running the script for on-prem must have sufficient permission to change the enabled state of the selected delivery groups. For Cloud, CU stored credentials must have previously been saved for the local user running the script.

To use this script as an automated action where parameters cannot be passed, copy the script and set the $disable parameter in the Param() block at the top of the script to "true" or "false" depending on whether you are disabling or enabling delivery groups respectively.

The Cloud Customer Id or Delivery Controller is an optional argument which can be used when there are more than 1 credential file for the user running the script so that the correct Cloud customer can be chosen. When used on-prem, the parameter is used to tell the script what delivery controller to connect to when the script is not run on a DDC.
Version: 2.1.13  |   Created: 2020-10-06  |   Modified: 2024-01-26  |   Creator: Guy Leech  |   Downloads: 5
Show how recently (in number of days) delivery groups have had sessions launched from them, by checking the last used property for each machine in a delivery group.
Specify the minimum number of days last launched to show only delivery groups which have not had sessions launched within that number of days and optionally disable them. Specify 0 days to show all delivery groups.

Run on a Delivery Controller or where the CVAD PowerShell snapins are available, e.g. Studio is installed.
Version: 2.6.19  |   Created: 2020-10-02  |   Modified: 2020-10-09  |   Creator: Guy Leech  |   Downloads: 75
Query the selected delivery controller via OData to retrieve connection failure details for a specific user, or all users, within a specified number of days ago
Version: 2.4.10  |   Created: 2020-08-05  |   Modified: 2020-12-01  |   Creator: Guy Leech  |   Downloads: 431
This is a simple script that restarts the BrokerAgent service on a Citrix VDA. This is useful when VDAs become unregistered. It forces them to try to re-register to a Delivery Controller. In some instances a reboot of the VDA may be required, for everything else there's this SBA!
Version: 1.1.8  |   Created: 2019-10-23  |   Modified: 2021-03-18  |   Creator: Rory Monaghan  |   Downloads: 265
Logs off the selected user session
Version: 2.1.2  |   Created: 2019-01-27  |   Modified: 2022-12-14  |   Creator: ek  |   Downloads: 3540
Show the client device Operating System type form for a specific user session.
Use this script without requesting the display of the Receiver version to get the results grouped by client OS (available only as a ControlUp Script Based Action).

Categorization of the Client OS is accomplished by querying the Citrix VDA or XA65 worker for the ClientPlatformId registry value in the appropriate Citrix ICA hive for that user session and follow the conversion described in this document:
https://www.citrix.com/mobilitysdk/docs/clientdetection.html
Version: 2.8.23  |   Created: 2018-12-08  |   Modified: 2018-12-16  |   Creator: Marcel Calef  |   Downloads: 163
Citrix Apps and Desktops (formerly XenApp and XenDesktop) introduced Adaptive transport which automatically chooses between TCP & UDP for the HDX sessions. This script will leverage the ctxsession command to display the current status of the active HDX sessions.
Version: 1.10.23  |   Created: 2018-11-19  |   Modified: 2018-12-20  |   Creator: Marcel Calef  |   Downloads: 522
Show the Citrix Director actions performed in a given time window, optionally filtered on a specific user. Use this SBA to see what actions have been taken which might affect end users such as logging them off.
Arguments:
Start - optional time to show actions from. Can be specified as a date/time or as a number of units of time back from the present such as 7d or 1w where s=second,m=minute,h=hour,d=day,w=week,y=year (default is 7 days)
End - time to stop showing actions after. Can be specified either as a date/time or a number of units of time from the start value specified. (default is the current time)
If date/time values are used, they must be enclosed in double quotes, e.g. "02/02/2018 08:00:00"
Username - optional name of a user to just show changes for
Version: 1.4.6  |   Created: 2018-10-29  |   Modified: 2018-11-26  |   Creator: Guy Leech  |   Downloads: 102
Show the configuration changes made in Citrix Studio in a given time window, optionally filtered on a specific user. Use this SBA to see if any changes have been made which might be affecting end users.
Arguments:
Start - optional time to show changes from. Can be specified as a date/time or as a number of units of time back from the present such as 7d or 1w where s=second,m=minute,h=hour,d=day,w=week,y=year (default is 7 days)
End - time to stop showing changes after. Can be specified either as a date/time or a number of units of time from the start value specified. (default is the current time)
If date/time values are used, they must be enclosed in double quotes, e.g. "02/02/2018 08:00:00"
Username - optional name of a user to just show changes for
Version: 1.4.14  |   Created: 2018-10-29  |   Modified: 2018-11-26  |   Creator: Guy Leech  |   Downloads: 112
Recurses AD groups found to show all user accounts with any access to Citrix Studio.
Needs to be run using an account that has at least read-only Studio access.
Use it to see exactly which users have access and what level.
Arguments:
User Name to Query - an optional username or regular expression to restrict the display to

If a name is specified as a parameter then only that account is reported on
Version: 1.6.11  |   Created: 2018-10-24  |   Modified: 2018-11-26  |   Creator: Guy Leech  |   Downloads: 50
Get a detailed overview of the most recent logon process for a specific user. This script queries the event log for every major event that relates to the logon process. Use this action to track down which phase is responsible for delays during the logon process. Uses WMI to retrieve pre-Windows logon phase data from Citrix so does not use OData and therefore does not need credentials
Version: 19.32.176  |   Created: 2018-07-02  |   Modified: 2023-11-03  |   Creator: Guy Leech  |   Downloads: 67979
Use this script based action to pull detailed information on the cache usage on Citrix XenDesktop 7.9 and above.
Version: 1.0.1  |   Created: 2016-05-31  |   Modified: 2016-05-31  |   Creator: Andrew Morgan  |   Downloads: 660
This script will list all the VMs in a specific XenDesktop site that are listed in maintenance mode in the DDC. It must be run on a XenDesktop broker. The script prompts for and requires at least a XenDesktop read-only admin account.
Version: 1.3.8  |   Created: 2016-05-04  |   Modified: 2016-05-05  |   Creator: Matan Nataf  |   Downloads: 285
Checks the computer registry and displays current ICA Listener binding information - if ICA is enabled, displays the adapters to which ICA is bound
Version: 2.0.3  |   Created: 2016-05-03  |   Modified: 2018-11-05  |   Creator: Trentent Tye  |   Downloads: 150
This script will list all the VMs in a specific XenDesktop site that are powered on in the hypervisor and not registered to any DDC. It must be run on a XenDesktop broker. The script prompts for and requires at least a XenDesktop read-only admin account.
Version: 1.2.8  |   Created: 2016-04-24  |   Modified: 2016-05-01  |   Creator: Matan Nataf  |   Downloads: 290
For a machine streamed using Citrix Provisioning Services, marks the device as down, resets the Active Directory machine account password and reboots the device. This action should be executed on a PVS server with MCLI PowerShell snap-in installed.
Version: 3.3.10  |   Created: 2014-06-22  |   Modified: 2014-07-02  |   Creator: ControlUp Support  |   Downloads: 311