PowerShell plugin
Currently only PowerShell v7 is supported for this plugin.
If your scripts are stored on your own servers, or need to reach systems on your private network, use the PowerShell On-Prem plugin instead. This plugin runs scripts that you write in the data stream parameters, so it does not need a relay agent.
Click the following link for additional content such as blogs, videos, use cases, and more:
Run custom PowerShell scripts to retrieve and enhance data. This is useful for accessing third-party APIs and non-trivially manipulating the data you retrieve, beyond the capability of the Web API plugin.
PowerShell or Web API
Use cases for choosing the PowerShell plugin over Web API include:
- Making requests to third-party APIs that require the
timeframeparameter in a format other than ISO 8601 or Unix time, you can convert the timeframe's start and end timestamps to the format expected by the API. - Making calls to multiple third-party APIs and then combining the results.
Adding a data source
To add a data source, open the relevant workspace and then click on the + next to Data Sources on the left-hand menu in SquaredUp. Search for the data source and click on it to open the Add data source page.
Configuring the data source
Display name:
Enter a name for your data source. This helps you to identify this data source in the list of your data sources.- Variables:
Optionally, click Add new variable to create a variable that can be added into your PowerShell data stream scripts. Variables are created as key value pairs and can be encrypted by clicking the padlock icon next to the entry field. Additional variables can be created by clicking Add another variable.
See Configuring variables for more information. Restrict access to this data source:
Optionally, enable this toggle if you only want certain users/groups to have access to the data source, or those with the permission to link it to new workspaces. See data source access control for more information.- Install dashboards:
Select whether you would like to install pre-built dashboards and perspectives with the data source. By default, this is set to on. - Click Add.
Testing and troubleshooting
If you encounter an error refer to the guidance or contact our support team in-app or via SquaredUp Support
For errors on dashboard tiles see Troubleshooting tiles.
Why isn’t my script returning expected data?
We always recommend ensuring that any scripts will successfully run outside of SquaredUp in the first case, and that data is formatted and returned correctly. If everything looks okay, you may wish to review how the columns are being used in the Filter | Group | Sort and Columns tabs in the tile configuration.
Next steps
PowerShell scripts
To write the scripts this data source runs, including how to use variables and the timeframe, see Creating Cloud PowerShell Scripts.
Scripts run in PowerShell 7 on Linux, with no profile loaded. This means:
- Windows-only modules and cmdlets are not available, such as the ActiveDirectory module or WMI and CIM queries against Windows.
- Dates and numbers are formatted with the invariant culture, so localized formats such as month names in your language are not available. Use explicit format strings, for example
Get-Date -Format 'yyyy-MM-dd'.
Data streams
You can use these data streams to create new tiles to show data, or if there are preconfigured dashboards installed you can copy or edit those.
Data streams are named queries targeted at a data source, typically mapped to a specific API endpoint. They define how SquaredUp retrieves live data. By standardizing information from diverse formats into a simple table, data streams provide a consistent starting point regardless of the original source system.
Each plugin includes its own set of data streams. When editing a tile or exploring data, the data stream you choose acts as the entry point to the objects and records within that data source.
Scoped data streams allow you to specify which objects you want to pull data for. Global data streams return general information that is not tied to objects.
Some data streams are configurable, meaning you can configure additional settings on the Parameters tab of the tile editor to create a bespoke query.
When you're creating a tile, you can tweak data streams by grouping or aggregating specific columns.
See Data Streams for more information.
The following data streams are installed with this plugin.