Get-CUAvailableActions: Retrieve all Actions in Your ControlUp Environment

The Get-CUAvailableActions cmdlet provides an overview of all available actions in your ControlUp Environment. This includes built-in actions as well as script actions. You can run this cmdlet without any parameter to retrieve a full list of available actions or you can filter actions, as shown in the examples below

Prerequisites

• (Remote) access to one of your ControlUp Monitors

• Administrative privileges in a PowerShell session

How To Run

1. Import the ControlUp.PowerShell.User module into your PowerShell session

$pathtomodule = (Get-ChildItem "C:\Program Files\Smart-X\ControlUpMonitor\*ControlUp.PowerShell.User.dll" -Recurse | Sort-Object LastWriteTime -Descending)[0]
Import-Module $pathtomodule

2. Run the cmdlet without any parameter to retrieve a full list of available actions

Get-CUAvailableActions

Each action has a set of properties which we explain in the Output section

Output

Signature

The signature entity holds relevant user input details such as placeholders, input parameters, and output parameters. Let's take the signature of the Save multiple screenshots to file action which allows to capture screenshots of a user session and to save on the local disk.

InParam

The '“InParam” property defines the structure for input parameters. The Save multiple screenshots to file actions has 4 input parameters.

Each input parameter has additional properties and methods, such as name, caption, or parameterType.

• Name. The position of the input parameter

• Caption. The caption shown

Views

The Views property shows from which view the action can be selected.
For example, the Analyze drive contens with WinDirStat action is available for entities in the Machines (= Computers), Sessions, and Logical Disks view

In the console, the views represent the tab view as illustrated here

AllowedEntities

ExecutionContext

This value represents the Execution Context as shown in the script properties:

Examples

Example 1 - Export all actions to a text file

$actions = Get-CUAvailableActions 
$actions | Out-File -FilePath .\actions.txt

Example 2 - Show all actions that can run on a Session

$actions = Get-CUAvailableActions 
$actions | Where-Object {$_.AllowedEntities -eq '4096'}

Example 3 - Show title, category and allowed entities of all actions

$actions = Get-CUAvailableActions 
$actions | Select-Object Title, Category, AllowedEntities | Sort-Object -Property AllowedEntities

Example 4 - Show on which entities the Flush DNS action is available

$actions = Get-CUAvailableActions 
$actions | Where-Object {$_.Title -eq 'Flush DNS'} | select-object -Property AllowedEntities

In this example, 272 indicates that the Flus DNS is available in the Folders (16) and Machines (256) view. 16 + 256 = 272

Example 5 - Show all actions that run on a user session

$actions = Get-CUAvailableActions 
$actions | Where-Object {$_.ExecutionContext -eq '2'} | Select-Object Title, ExecutionContext 

Example 6 - Show all input parameters of a specific action

$actions = Get-CUAvailableActions 
$actionSignatures = $actions | Where-Object {$_.ExecutionContext -eq '2'} | Select-Object Signature
$inParamScreenshotAction = $actionSignatures.Signature | Where-Object {$_.id -eq '15c99346-e3d1-4dde-a9a7-eb2cbed3bf55'} | select-object -property inParam
$inParamScreenshotAction.inParam