PowerShell Data Stream Parameters

The PowerShell plugin provides configurable data streams to fetch ticket information and metrics.

Each configurable data stream exposes a set of parameters that lets you filter the data you retrieve. The following information describes the available configurable data streams and their parameters in detail.

Run Script

Runs a PowerShell script in the SquaredUp cloud and returns whatever the script writes to output.

Note

This data stream is for the Cloud plugin version.

Parameter
Description
Script
Enter or paste your PowerShell script into this field. You can use the variables you defined when configuring the data source by entering $variable.variableName. For example, $variable.apiKey or $variable.password.
JSON Depth
Enter the number of nested object levels required in the return payload. This option is useful if the return payload contains a significantly large number of nested objects.

Run Script On-Premise

Runs a PowerShell script on an on-premise agent, so the script can reach systems that are not exposed to the internet.

Note

This data stream is for the On-Prem plugin version.

Parameter
Description
Script Path
Select a script to use. This dropdown displays the scripts you have configured in your scripts folder.
Run Script On-Prem
Optionally, enter any arguments required by the selected script. These are custom arguments set by the script author in the script itself.
Note

If the script is not expecting these parameters, including them will cause the stream to fail.

Arguments are expressed as a JSON object, where the property name is the name of the parameter, and the value is what should be passed to the script. For example:
{ "TopN": 10, "filter": ["**/Bin", "*.zip"] }

Was this article helpful?

Have more questions or facing an issue?
Submit a ticket