Available Actions

Prev Next

One of ControlUp's most powerful features is the ability to run actions on a remote machine, session, process, etc. in our VDI App and in the Real-Time DX Console. Before reading this article listing the different actions available, see here.

Scripts in draft

The VDI App UI only shows published scripts. Scripts in draft mode can not be run from the VDI App.

Action Context Menu

Right-click a virtual machine, user session, or process to open the context menu for VDI App Actions which consists of the search box (1) and the different categories (2).
Right-click action menu displaying several categories of actions.

Built-in actions

Action NameShort DescriptionRun onCategory
Analyze drive contents with WinDirStatRuns WinDirStat (https://windirstat.net/) to analyze the usage of a driveMachineSystem Health
Analyze GPO Extensions Load TimeShows how long each "Group Policy Client Side Extension" took to completeSessionGroup Policy
Analyze HDX BandwidthMeasures the bandwidth of a given active HDX sessionSessionNetwork Analysis
Analyze High Latency IssuesInitiates a trace route command from the VDI machine to the client deviceSessionNetwork Analysis
Analyze Logon DurationGets a detailed overview of the most recent logon process for a specific userSessionUser Environment
Calculate User Profile SizeCalculates and displays the size of the user profile directory and any subfoldersSessionUser Environment
Clean User Temp folderDeletes all files and folders in user TEMP folder.SessionUser Environment
Clean Windows system driveCleans up a disk by deleting the content of directories which are known to accumulate large amounts of useless dataMachineSystem Health
Cleanup Windows Update clientClears the BITS queued jobs, clears the software distribution folder and clears SUSClient IDMachineSystem Health
Disable Delivery Group
Disables the Delivery Group
Folders
CVAD Management
Disable Drain Mode
Disables the Drain Mode
Machine
AVD Management
Disable GatewayDisables the GatewayGatewaysNetScaler Management
Disable Horizon Farm
Disables the Horizon FarmFolders
Horizon Management
Disable Horizon Pool    
Disables the Horizon Pool    
Folders
Horizon Management
Disable Horizon Pool/Farm Provisioning
Disables the Horizon Pool and the provisioning of the Farm
Folders
Horizon Management
Disable Load BalancerDisables Load BalancerLoad BalancersNetScaler Management
Disable RDS Server
Disables the RDS Server 
Machine
Horizon Management
Disconnect SessionDisconnects a sessionSessionSession Management
Display DLLs loaded by processFor every selected process, displays the list of DLLs currently loadedProcessProcess Management
Enable Delivery Group
Enables Delivery Group    
Folders
CVAD Management
Enable / Disable Maintenance ModeSets a host machine into maintenance mode, or out of maintenance modeHostHost Management
Enable / Disable Connection ServerEnables or disables Horizon Connection ServerMachineHorizon Management
Enable Drain Mode
Enables drain mode    
Machine

AVD Management

Enable GatewayEnables GatewayGatewaysNetScaler Management
Enable Horizon Farm
Enables the Horizon Farm
Folders
Horizon Management
Enable Horizon Pool
Enables the Horizon Pool
Folders
Horizon Management
Enable Horizon Pool/Farm Provisioning
Enables the Horizon Pool and the provisioning of the Farm
Folders
Horizon Management
Enable Load BalancerSets a host machine into maintenance mode, or out of maintenance modeLoadBalancersNetScaler Management
Enable Maintenance Mode
Enables maintenance mode    
Machine
CVAD Management
Enable RDS Server
Enables the RDS Server    
Machine
Horizon Management
End ProcessTerminates the selected process gracefullyProcessProcesses Management
Find Folder Redirection ErrorsLooks for folder redirection errors (Event ID 502) that occurred on the selected machine within the last 30 daysMachineSystem Health
Force Power Off VMForcefully powers off the virtual machineMachinePower Management
Force Reset VMForcefully resets the virtual machineMachinePower Management
FSLogix Log ParserParses the Profile log for FSLogix event for a specific user and displays the resultsSessionUser Environment
Get Citrix MCS RAM / Disk Cache Usagedetailed information on the cache usage on Citrix XenDesktop 7.9 and aboveMachineCVAD Management
Get PVS Write Cache SizeOutputs the amount of PVS RAM cache in useMachineCVAD Management
Get User AD Group MembershipGets a user's Active Directory groupsSession / AccountUser Environment
Get user's SIDGets the user SID for the current usernameSessionUser Environment
HDX Connectivity HealthInitiates an HDX connection against one or more CVAD servers to check the server healthMachineSystem Health
ICA Session RoundTripTimeRuns for 20 seconds and measures (once every 2 seconds) the ICA RTT and network latency of the relevant sessionSessionNetwork Analysis
Identify associated Windows servicesShows the service under which the selected process is runningProcessProcesses Management
IE: URL for specific PIDShows the URL for a given IE processProcessProcess Management
IE: URLsRetrieves process IDs and the URLs associated with themSessionUser Environment
Import Registry
Imports a .reg file to the registry of the managed machine in the selected user session.
Session
Session Management
Kill Policy
Kills the selected policy(es)
Session
Session Management
Kill ProcessKills the selected process(es)ProcessProcesses Management
Kill Process by Force (PSKILL)Runs pskill.exe to kill the processProcessProcess Management
Launch Event ViewerOpen the Microsoft event viewerMachineSystem Health
List Computer GPOsList group policy objectsMachineGroup Policy
List redirected user foldersEnumerates all user shell folders redirected to a non-default location outside the user profileSessionUser Environment
List User GPOsList every "User Group Policy" applied based on the records inside the "Operational" log under "Microsoft-Windows-GroupPolicySessionGroup Policy
List User's Mapped Network DrivesReport the drive letter and UNC path of the user's mapped drivesSessionUser Environment
List User's PrintersDisplay all of the printers in a user session, and note the default printerSessionUser Environment
Log off SessionLogs off the selected user sessionSessionSession Management
Power On VMPowers on the VMMachinePower Management
Power off (stop) for Azure machines
Powers off the Azure machines
Machine

Cloud Management

Process CPU Usage LimitFinds threads over consuming CPU in the selected process and reduces their average CPU consumptionProcessProcess Management
RDP to MachineOpens a RDP connectionMachineSession Management
RDS Drain SessionsPuts RDS hosts into maintenance mode using the chglogon commandMachineSystem Health
Reapply Azure Machine
Reapplies the Azure machine    
Machine
Cloud Management
Reapply Group Policy
Reapplies the session group policy
Session
Group Policy
Reboot MachineReboots the machineMachinePower Management
Rebuild Performance CountersRebuilds Windows performance counters by running lodctr.exe /RMachineSystem Health
Refresh Machine Group PolicyRefreshes the machine group policy using the command 'gpupdate.exe /target:ComputerMachineGroup Policy
Restart for Azure machines
Restarts the Azure machines
Machine
Cloud Management
Restart GuestRestarts the guest OSMachinePower Management
Run procmon and sample file accessRuns for a selected process and you can see which files are most frequently accessedProcessProcess Management
Schedule rebootSchedules a reboot for a number of minutes/hours in the futureMachinePower Management
Screenshot with user approval
Screenshots with user approval required   Session/Process  
Session Management
Screenshot with user notification
Screenshots with user notification
Session/Process  
Session Management
Send MessageSends a message to user session/sMachine/SessionSession Management
Set Process AffinitySets which processors are allowed to run the selected process.ProcessProcess Management
Set Process PrioritySets the base priority of the selected processProcessProcess Management
Shadow session using RDPLeverages MSTSC.exe for shadow and remote control of sessionsSessionSession Management
Show AD user and manager detailsDisplays a user's name, company, title, office, office phone number, mobile phone number and e-mail address if they exist in ADSessionUser Environment
Show All GPO ResultsRuns gpresult for a specific user on a specific computerSessionGroup Policy
Show frequent error eventsShows all error events from all event logs on the selected machineMachineSystem Health
Show GPO logon scriptsRuns gpresult for the selected user to get a list of scripts that ran at logonSessionGroup Policy
Show HDX Adaptive Transport protocolShows the current status of the active HDX sessionsSessionNetwork Analysis
Show modules loaded by processShows details for all modules in use by the chosen process including version, timestamps, size and signing information, grouped by the containing folderProcessProcess Management
Show network connections established in sessionShows established network connections for all processes in a selected user session sorted on the most connectionsSessionNetwork Analysis
Show or delete local user profilesFinds and optionally deletes local user profilesMachineSystem Health
Show page file informationShows configuration for all page files including the path, current and peak usageMachineSystem Health
Show process network connectionsShows established network connections for a process sorted on the most connectionsProcessProcess Management
Show top network destinations by traffic volume (session)Captures and analyzes network traffic sent for all processes in the specified session in a specified time period,SessionNetwork Analysis
Show window titlesDisplays the titles of all visible windows running in the user sessionSessionUser Environment
Shutdown GuestShuts down the guest OSMachinePower Management
Shutdown MachineShuts down the machineMachinePower Management
Start for Azure machines
Starts the Azure machines    
Machine

Cloud Management

Stop (Deallocate) VM for Azure machines
Stops the VM for Azure machines    
Machine
Cloud Management
Take screenshot with user approvalTakes a screenshot of a session only if the session user approvesSession/ProcessSession Management
Take screenshot with user notificationTakes a screenshot of a session and notifies the session userSession/ProcessSession Management
Take screenshot without notifying the userTakes a screenshot of a session without notifying the session userSession/ProcessSession Management
Terminate processForcefully terminates a process using the built-in taskkill commandProcessProcess Management
Trim Process Working SetsCompletely empties or trims a process' working sets to a specific sizeSessionUser Environment

Running your own actions (SBAs)

To perform your own custom action (script-based action), you must add and publish the action in the Real-Time Console. A user can run the action from the VDI App if they have permission to run the script-based action in the security policy.

Selected Actions Explained in Detail

Some actions have prerequisites or are more complex and require additional explanation. Click on an action below to see more details about how to use it.

Analyze High Latency Issues

Using this action, you can identify high latency issues or lost packets from your host to the destination computer (client IP).
Action result window displaying traceroute results.

Analyze Logon Duration

Run the action on one or more user sessions and measure the time it took to log in. Our blog article provides more information about the script.

Right-click a user session or select multiple user sessions > User Environment > Analyze Logon Duration. Don't change the input parameters and click OK.

The following output is shown after the script has completed:
Analyze logon duration action result window displaying the script output.

To learn more about how the Analyze Logon Duration script action can help your organization, use our interactive use cases guide:

startcourse

Clean Windows system drive

To learn more about how the Clean Windows System Drive script action can help your organization, use our interactive use cases guide:

startcourse

Launch Event Viewer

This action downloads a VB script file to your local machine. Run this file to open the Event Viewer as a Management console snap-in.
Windows event viewer

Prerequisites

To use the Launch Event Viewer action, make sure you

  • Open TCP port 135 on the target machine. This port is used by the RPC endpoint mapper service.
  • Run the target machine in the same domain as the machine you run your browser.

List Computer GPOs

Runs the List Computer GPOs SBA that lists the current computer Group Policy Objects applied based on the records inside the "Operational" log under “Microsoft-Windows-GroupPolicy".

Action result window displaying the list of applicable group policy objects.

RDP to Machine

Opens a Remote Desktop session to the selected machine. User credentials used on the current local machine are used to connect to the remote machine. Depending on the browser configuration, a RDP shortcut is downloaded to the machine which you need to click manually to run the RDP session. Note that you can run the RDP to Machine action in the VDI App even if it isn't enabled in the Security Policy pane in the Real-Time Console.

Prerequisites

  • TCP port 3389 must be open from your local machine to the remote machine
  • Only LAN connections are supported

Refresh Machine Group Policy

Updates all policies that have been modified on the target machine by using the gpupdate command.

Input Parameters

The gpudate command can take three input parameters, each of which adds an argument.

  • Force. /force
  • Boot if required. /boot
  • Wait X seconds. /wait:X

You can see how the gpupdate command was executed in the Event Viewer of the remote machine.

Windows event viewer displaying the gpupdate arguments.

Send Message

You can send a message to one or more user sessions by either running the action on selected user session/s or machines. Running the action on a

  • User session sends a message to selected user session/s.
  • Machine sends a message to all user sessions.

Input Parameters

You can configure the message title, the content and an icon.

  • Title. Message Caption. Limited to 40 characters.
  • Message. Message content. Limited to 250 characters.
  • Icon. An icon displayed in the message. You can find more information on the different icons here.

How it works

Enter the input parameters and click OK to send the message to the user session/s.

Screenshot Actions

Disable Screenshot Actions
You can control permissions for screenshot actions, like any other action, in your Console security policy. If you want to disable and hide screenshot actions in your ControlUp environment, contact ControlUp Support.

These actions take a screenshot of the session and display the screenshot in the VDI App. In the action output window, you can:

  • Copy the image
  • Refresh the screenshot to get an updated image
  • Download the image
  • Expand the window to get a better view of the screenshot

You can select up to seven sessions or processes to take screenshots of each session and display them in the same window.

Screenshot without notifying the user

This action takes a session screenshot without notifying or requesting approval from the session user. You can perform this action on a user session or a process. The session user does not know when you perform this action.

Screenshot with user notification

This action takes a session screenshot and notifies the session user that a screenshot has been taken. The notification includes the VDI App user who performed the action.

Refreshing the screenshot to get an updated image sends another notification to the session user.

popup notification with the message 'The user ... has just taken a screenshot of your desktop'.

Screenshot with user approval

This action takes a session screenshot only if the session user approves a screenshot request. The request includes the VDI App user who is making the request, and the session user can choose to approve or decline the request.

Refreshing the screenshot to get an updated image sends another screenshot request to the session user.

Popup notification with the message 'The user ... requested to take a screenshot of your desktop. Click Yes to allow or No to deny the request'.