Get-CUActionSignature: Retrieve Action Parameters
- Print
- DarkLight
- PDF
Get-CUActionSignature: Retrieve Action Parameters
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback!
You can use the Get-CUActionSignature cmdlet to obtain a list of parameters associated with a particular action. This command is helpful because it allows you to examine an action and determine which parameters can be provided to it in JSON format. The parameters included in the list are
- Input parameters required by the action
- Output parameters which return the results of the action
Prerequisites
- ControlUp version 8.8 or higher
Syntax
Get-CUActionSignature [-ActionId] <string> [<CommonParameters>]
Input Parameters
The script parameters are defined in an argument array, where each parameter is identified by its index, starting from zero. For example, the first parameter is referred to as arg_0, the second parameter is arg_1, and so on.
Input Parameters
| Key | Description |
|---|---|
| agentId | Internal Use. The remote machine to run the action on |
| arg | Command line argument for the action |
| creds | Credential set |
Output Parameters
| Key | Description |
|---|---|
| executionStatus | Current status of the action execution. Possible values are
|
| exitCode | Returns the exit code for the action |
| executionStartTime | Epoch timestamp of the start time |
| executionEndTime | Epoch timestamp of the end time |
| stdErr | Shows the error (if thrown by the action) |
| stdOut | Returns the output as you would see in the script output |
Examples
Example 1 - Retrieve the action signature for the Universal EUC Sync Script
One of our most powerful scripts is the Universal EUC Sync Script which requires a couple of input parameters.
- Retrieve the actionID:
$availableactions = Get-CUAvailableActions
$actionID = $availableactions | Where-Object {$_.Title -eq 'Universal EUC Sync'} | Select-object Id
- Retrieve the action signature
Get-CUActionSignature -ActionId $actionID.Id
Was this article helpful?