SQL Server Support

You can now persist jobs, identities and app tokens in a SQL server database to allow for multi-node instances that provide high availability and load balancing.

Improved Editing Experience

Features such as live logging and advanced dashboard and repository editors of the admin console have been added to make editing scripts in PowerShell Universal easier to develop and debug.

Desktop Features

PowerShell Universal Desktop now offers integrations like file associations, hot keys, system events and custom protocols to trigger scripts when certain things happen on your system.

Translations

A built in translation provider is available in your dashboards, scripts, and APIs to provide the proper language when returning data back to your end users.

New Dashboard Components

New dashboard components such as the data grid, stack, badge, timeline and schema form allow you to bring even more functionality to your user interfaces.

A single pane of glass for managing and delegating access to your automation environment.

Universal provides an Administrator console, management REST API, PowerShell cmdlets and an idempotent configuration system using PowerShell scripts.

Featured Template: Active Directory

Curious what you can do with PowerShell Universal? Check out our featured Active Directory template.

This template includes features such as:

• Object Search

• User Management and Reports

• Group Management

• Infrastructure Reports

APIs

Expose scripts as RESTful HTTP APIs for integration from any platform.

Automation

Execute, schedule, secure and audit scripts in an easy-to-use, web-interface.

User Interfaces

Build web-based tools for internal users with highly interactive user interfaces that run your scripts.

Hosting

PowerShell Universal is cross-platform and can be hosted on-premise, in the cloud or even on a Raspberry Pi.

• ac

• and

Security

Grant role-based access to different aspects of your automation environment with your choice of authentication and authorization integrations.

Desktop

Create desktop automation and user interfaces that integrate with features of Windows.

Development

Take advantage of rich development tools such as IntelliSense, code formatting, error checking and debugger integration without leaving your browser.

Platform

Configure the platform to meet the needs of your environment.

Community

Join the growing community of users managing their automation environments with PowerShell Universal.

Licensing

Universal is licensed per server. Visit our on pricing.

Many features of PowerShell Universal are .

Run Scripts

You can run scripts in PowerShell Universal. PowerShell Universal integrates deeply with the PowerShell host to provide a UI for param blocks, output rich objects, display progress and even allow the user to provide feedback.

Schedule Jobs

You can schedule jobs to , or even within the PowerShell Universal platform.

Ad-Hoc Commands

Run ad-hoc commands in in any of your configured environments and, optionally, as alternate credentials.

Downloads

Download the latest version of PowerShell Universal.

Training

Watch our free PowerShell Universal training course.

The Ironman Software blog has articles about PowerShell Universal.

Connect with the PowerShell Universal community.

Purchase a license for the features of PowerShell Universal.

File a bug report or feature request for PowerShell Universal.

Samples that can be inserted into your PowerShell Universal system using the .

Check out video tutorials for PowerShell Universal.

You can assign computers to queues by using application settings. By default, every computer is assigned to the default queue and a queue specific to the computer itself. When you assign a computer to a custom queue, that queue will be available in the admin console and you can use the queue for ad-hoc script execution and schedules.

Configure a Queue

To a configure a computer to a specific queue, use the UniversalAutomation \ Queues setting.

appsettings.json

Assign a machine to a queue using an appsettings.json file.

Environment Variable

Assign a machine to a queue using an environment variable.

Using a Custom Queue

Custom queues will be available within the Computer drop down in the script Run dialog, and trigger, script and schedule properties.

The New-UDErrorBoundary component is used for isolating portions of a dashboard to contain components that may throw an error. Many Universal Dashboard components use the error boundary component internally.

If you'd like to isolate a portion of your dashboard to prevent the entire page from failing to load, you can use the following syntax.

New-UDErrorBoundary -Content {
    throw "Oh no!"
}

If any error is thrown from the content, you will see an error such as thing.

API

Tooltips display informative text when users hover over an element.

Basic Tooltip

New-UDTooltip -Content {
    New-UDIcon -Icon 'User'
} -TooltipContent {
    "User"
}

Placement

Place the tooltip on top, bottom, left or right.

Custom Content

Tooltip content can contain any UD element.

Tooltip Type

Tooltips can be over various types including: "dark", "success", "warning", "error", "info", "light"

System events subscribe to WMI events within Windows and run scripts. You can then take action by running scripts.

Defining a System Event

To define a system event, you can use the New-PSUSystemEvent cmdlet within the systemEvents.ps1 file. The following example triggers the systemEvent.ps1

Windows

• Optional*: or greater

• Optional*: PowerShell v7.2 or greater

Application Files

Depending on how you installed PowerShell Universal, you will need to uninstall the application files.

ZIP Installation

The New-UDDateTime component is used for formatting dates and times within the client's browser. By using the client's browser, you can format the time based on the local time zone and locale settings for the user.

The date and time component uses DayJS. For a full list of custom formatting options, visit the .

Basic Formatting

By default, the date and time will be formatted using the LLL localized formatting template.

Lists are continuous, vertical indexes of text or images.

Lists are a continuous group of text or images. They are composed of items containing primary and supplemental actions, which are represented by icons and text.

List

Alerts provide a simple way to communicate information to a user.

Simple Alerts

Alerts have four different severities and can include text or other content.

You can define static HTML using New-UDHtml. This cmdlet does not create React components but rather allows you to define static HTML. Any valid HTML string is supported.

The following creates an unordered list.

API

New-UDMarkdown accepts a markdown string and renders it as HTML elements within a dashboard.

API

• New-UDMarkdown

New-UDTreeView allows you to create a tree of items and, optionally, dynamically expand the list when clicked.

Basic Tree View

Create a basic tree view by using the New-UDTreeNode cmdlet.

Universal uses a variety of modern web frameworks and can have issues with older browsers such as Internet Explorer.

The current version of the following web browsers is supported: , , , and

The Protect-UDSection cmdlet hides it's content if a user does not have the specified roles.

Protect-UDSection -Role @("Administrator") -Content {
   New-UDTypography -Text 'Only Administrators see this'
}

PowerShell Universal provides two ways of creating User Interfaces: Dashboards and Pages. Dashboards are highly interactive interfaces authored in PowerShell. Pages are simple drag and drop interfaces that can call scripts and APIs.

Dashboards

Dashboards offer a higher level of customization, interactivity and complexity. They are developed using the PowerShell Universal Dashboard module.

Some examples of interfaces you can create:

• Wizard-like input forms with validation and custom step logic

• Highly interactive tables that can sort, filter, export and page directly from a SQL server

• Continuously updating charts that monitor server performance or resource usage

• Web pages that behave much like desktop applications with feedback like modals, notifications and interaction between controls.

Pages

Pages provide a basic method of creating user interfaces with a drag and drop designer. The controls are more limited, and the logic of your interface is limited to scripts or APIs that you have created with PowerShell Universal.

Some examples of interfaces you can create:

• Simple forms that accept various parameters, return output and display progress

• Charts that display data generated from APIs or scripts

• Simple tables that sort, page and export data generated by scripts or APIs.

Which do I use?

This will depend on your use case. Pages are much easier to get started with and do not have the learning curve of dashboards. Dashboards are much more robust but will require learning a new PowerShell module to create them.

If you are looking to expose simple forms that perform actions, return simple results and display data that has been generated in scripts, then Pages will be for you.

If you are looking to create a web interface that is similar to Windows Forms or WPF, then Dashboards are likely what you will want to use.

Note, you can .

Universal provides the ability to define REST API endpoints using PowerShell. When the endpoints are executed by a compatible HTTP client, the PowerShell script will execute and return the result to the end user.

Execution Environment

The REST API execution environment runs in your default PowerShell version. Unlike Automation jobs, which can also be run via the Universal management API, APIs that you define are run in a single PowerShell process. Because the PowerShell process is not started and stopped for each call to the endpoint, the API is much faster.

You can define the that runs the PowerShell Universal API process by specifying the -ApiEnvironment on Set-PSUSetting. Changing this setting will cause the API process to restart.

Per Endpoint Environment

You can also define the environment used by specifying the Environment on the endpoint itself.

Performance

Performance is relative to the hardware and network conditions that you are running Universal on. That said, in ideal conditions you can expect the Universal APIs to service about 500 requests per second. This is with an entirely empty endpoint so any script that you add to that endpoint will reduce the throughput. The reduction of throughput will depend on the cmdlets and script executed within the API endpoint. There is no hard limit.

See for detailed information about benchmark tests on Universal APIs.

Variables

Variables are listed on the .

API

Image by URL

Display an image based on a URL. You can host URLs using Published Folders.

New-UDImage -Url "https://ironmansoftware.com/img/ps-logo.png"

Image by Path

Display an image based on a file local to the server.

Image Size

Change the size of the image using the -Width and -Height parameters.

Attributes

Apply additional attributes to the image.

API

The autocomplete is a normal text input enhanced by a panel of suggested options.

Static List of Options

Creates a basic autocomplete with a static list of options

Dynamic List of Options

When text is typed, it can be filtered with OnLoadOptions. $Body will contain the current text that is typed.

This example filters the array with Where-Object.

OnChange

$Body contains the currently selected item. The OnChange event will fire when the user selects one or more items.

Icon

You can place an icon before an autocomplete by using the -Icon parameter.

OnEnter

OnEnter is triggered when the user presses the enter key within the autocomplete.

Options

You can use New-UDAutoCompleteOption to specify name and values.

API

Use typography to present your design and content as clearly and efficiently as possible.

Too many type sizes and styles at once can spoil any layout. A typographic scale has a limited set of type sizes that work well together along with the layout grid.

All Typography Types

@("h1", "h2", "h3", "h4", "h5", "h6", "subtitle1", "subtitle2", "body1", "body2", 
"caption", "button", "overline", "srOnly", "inherit", 
"display4", "display3", "display2", "display1", "headline", "title", "subheading") | ForEach-Object {
    New-UDTypography -Variant $_ -Text $_ -GutterBottom
    New-UDElement -Tag 'p' -Content {}
}

Colored Text

You can use the -Style parameter to define colors for your text.

Theme-based Styling

You can use styling by using the -Sx parameter of New-UDTypography. For example, to apply the secondary text color, you can use the following syntax.

API

The Stack component manages layout of immediate children along the vertical or horizontal axis with optional spacing and/or dividers between each child.

Horizontal Stack

Horizontally stacked items.

New-UDStack -Content {
   New-UDPaper -Content { "Item 1" } -Elevation 3
   New-UDPaper -Content { "Item 2" } -Elevation 3
   New-UDPaper -Content { "Item 3" } -Elevation 3
} -Spacing 2

Vertical Stack

Vertically stacked items.

API

• New-UDStack

Create a hyper link in a dashboard.

Basic Link

Create a basic link that goes to a web page.

New-UDLink -Text 'Ironman Software' -Url https://www.ironmansoftware.com

Change Style

Adjust the underline and text style.

Open in a New Window

Open the link a new window when clicked.

OnClick Event Handler

Execute a PowerShell script block when the link is clicked.

API

Time pickers pickers provide a simple way to select a single value from a pre-determined set.

Time Picker

New-UDTimePicker

Locale

Specify the locale of the time picker.

24-Hour Time

You can use the -DisableAmPm parameter to use 24-hour time.

API

A skeleton is a form of a loading component that can show a placeholder while data is received.

Variants

There are three variants that you can use for a skeleton. You can use a circle, text or a rectangle. You can also define the height and width of the skeleton.

New-UDSkeleton
New-UDSkeleton -Variant circle -Width 40 -Height 40
New-UDSkeleton -Variant rect -Width 210 -Height 118

Animations

Skeletons will use the pulsate animation by default. You can also disable animation or use a wave animation.

API

Sliders allow users to make selections from a range of values.

Sliders reflect a range of values along a bar, from which users may select a single value. They are ideal for adjusting settings such as volume, brightness, or applying image filters.

Slider

Chips are compact elements that represent an input, attribute, or action.

Chips allow users to enter information, make selections, filter content, or trigger actions.

While included here as a standalone component, the most common use will be in some form of input, so some of the behavior demonstrated here is not shown in context.

Basic Chips

The UDUpload component is used to upload files to Universal Dashboard. You can process files the user uploads. You will receive the data for the file, a file name and the type of file if it can be determined by the web browser.

This component works with and .

Uploading a File

Uploads a file and shows the contents via a toast.

The body of the OnUpload

A Universal Dashboard website is composed of components. In addition to the core component, you can also extend Universal Dashboard with a large set of community created components.

There are two non-framework components that are built into PSU. These include the Nivo charts library as well as the UDMap component. Additional components can be downloaded from the .

External components are distributed as PowerShell modules and can be used in a dashboard by using Import-Module.

When building a dashboard, you can simply call the PowerShell cmdlets within your dashboard script to create a new component.

Basic Rating

OnChange

The App Bar displays information and actions relating to the current screen.

The top App Bar provides content and actions related to the current screen. It's used for branding, screen titles, navigation, and actions.

AppBar with Custom Drawer

Permanent Drawer

A permanent drawer will be shown at all times. By default, it is show on the left side of the screen.

Buttons allow users to take actions, and make choices, with a single tap.

Contained Button

Contained buttons are high-emphasis, distinguished by their use of elevation and fill. They contain actions that are primary to your app.

The backdrop component places an overlay over the drop of the entire page. It's useful for displaying loading states.

Basic Backdrop

To create a basic backdrop, you can use the New-UDBackdrop cmdlet and include content to show within the backdrop. The content will be centered on the page. To show the backdrop, use the -Open switch parameter.

Expansion panels contain creation flows and allow lightweight editing of an element.

An expansion panel is a lightweight container that may either stand alone or be connected to a larger surface, such as a card.

Simple Expansion Panel

In Material Design, the physical properties of paper are translated to the screen.

The background of an application resembles the flat, opaque texture of a sheet of paper, and an application’s behavior mimics paper’s ability to be re-sized, shuffled, and bound together in multiple sheets.

Paper

A floating action button (FAB) performs the primary, or most common, action on a screen.

A floating action button appears in front of all screen content, typically as a circular shape with an icon in its center. FABs come in two types: regular, and extended.

Only use a FAB if it is the most suitable way to present a screen’s primary action.

Only one floating action button is recommended per screen to represent the most common action.

Floating Action Button

Circular Progress

Linear Indeterminate

Simple Transfer List

Create a simple transfer list.

Switches toggle the state of a single setting on or off.

Switches are the preferred way to adjust settings on mobile. The option that the switch controls, as well as the state it’s in, should be made clear from the corresponding inline label.

Switch

Create a basic switch.

Grid Layout

The Grid Layout component is useful for defining layouts in a visual manner. You can drag and drop components using the web interface to automatically define the layout as JSON.

FontAwesome icons to include in your dashboard. Icon names are slightly different than those shown on the FontAwesome website. For example, if you want to use the network-wired icon, you would use the following string.

Finding an Icon

We include FontAwesome v6 with PowerShell Universal. You can use Find-UDIcon to search through the list of included icons.

Icon

Create icons by specifying their names. You can use the icon reference below to find icons.

Size

Set the size of the icon. Valid values are: xs, sm, lg, 2x, 3x, 4x, 5x, 6x, 7x, 8x, 9x, 10x

Rotation

Rotate icons. The value represents the degrees of rotation.

Border

Add a border to your icon.

Style

Apply CSS styles to your icon.

Visually Search for Icons

Complete Icon List

Custom Icons

You can use custom icon sets available on the page. First, install the module and then use the icon with other components.

Within your dashboard, call the icon cmdlet.

API

By default, endpoints will return a 200 OK message even if there are errors. If an error occurs, you will get a blank response from the endpoint. This document demonstrates different ways to handle errors within APIs.

Automatically Returning Errors

To automatically return errors from APIs, you can change the default behavior by setting the -ErrorAction parameter of New-PSUEndpoint to Stop. Any errors will cause an 500 Internal Server Error to be returned with a list of the errors and stack trace.

Terminating errors will always return a 500 Internal Server Error.

You will notice different behavior in Windows PowerShell and PowerShell 7 when calling REST APIs that return errors. In Windows PowerShell, you will receive a generic error that doesn't return the error message.

In PowerShell 7, when an error is returned, you will see the error message returned.

You can retrieve the error message in Windows PowerShell, by using the following syntax.

Manually Returning Errors

To manually return errors, you need to use the New-PSUApiResponse cmdlet. This cmdlet allows you to define the status code and body for the response.

In this example, we are returning a 404 error code from the endpoint.

Similar to the automatic error codes, error codes returned manually will as display better in PowerShell 7. Here's an example of calling the endpoint.

If called from Windows PowerShell, you will receive an error similar to the one returned automatically.

You can choose to return error codes if certain conditions are met by using your PowerShell script within the endpoint.

API

Display Processes

This example displays processes in a table.

New-UDDashboard -Title 'Processes' -Content {
    $Processes = Get-Process | Select-Object Id, Name
    New-UDTable -Columns @(
        New-UDTableColumn -Property 'Id' -Title 'Id'
        New-UDTableColumn -Property 'Name' -Title 'Name'
    ) -Data $Processes -ShowPagination
}

File System Browser

Create a file system browser with a dynamic tree view.

Create User Form

This example shows how to create a local user account.

Clock

This example shows how to create a clock component in PowerShell Universal Dashboard.

Dashboards can contain one or more pages. The simplest dashboard will contain a single page with some content. You can call any PowerShell cmdlet that is available on your machine to populate your dashboard.

Here's an example of simple dashboard that displays some text.

New-UDDashboard

The top-level cmdlet for dashboards is New-UDDashboard. You need to call it when returning a dashboard. You can use it with or without pages.

Content

The content of the dashboard is a series of components to display on the page. It's a script block that will return all the components in the order they will be rendered on the page. You can use the Grid component to layout items and display things like text with typography.

Header Customization

You can customize the header of the dashboard using several parameters.

To change the navigation layout, use the -Navigation and -NavigationLayout parameters.

Components

Components are the individual widgets that you can place on you dashboard. There are components for displaying data, taking user input, adding text and images and more. Components can be downloaded as PowerShell modules and added to your dashboard.

Components are be caused using the standard verb-name syntax for any PowerShell cmdlet.

Learn more about .

Pages

You can specify multiple pages within a dashboard. Each page defines a route. As for v3, all pages are dynamic. PowerShell will execute on each page load to render the new page. Since UD is a single page application, the web browser does not need to refresh the entire web page when navigating between the different dashboard pages.

Learn more about .

Built-in Variables

Built-in variables can be found on the .

Debugging

When building a dashboard, you will likely run into issues with cmdlet calls or syntax. Dashboards will auto reload as you make changes to the dashboard files. If a dashboard fails to start, you can navigate to the admin page, click Dashboards and click the Info button next to your dashboard.

The Log tab will show all the logging coming from the PowerShell execution from within in your dashboard. This should allow you to easily see errors and warnings coming from your dashboard.

You can use Write-Debug to add additional log messages to your dashboard. To enable debug logging, you will have to set the $DebugPreference variable at the top of your dashboard script.

Menu

You can customize the dashboard menu by using the -Menu parameter.

Radio buttons allow the user to select one option from a set.

Use radio buttons when the user needs to see all available options. If available options can be collapsed, consider using a dropdown menu because it uses less space.

Radio buttons should have the most commonly used option selected by default.

Simple Radio

OnChange

An event handler that is called when the radio group is changed. the $Body variable will contain the current value.

Default Value

Set the default value of the radio group.

Custom Formatting

You can use custom formatting within the radio group. The below example will place the radio buttons next to each other instead of on top of each other.

API

PowerShell Universal provides the ability to rate limit requests made to the web server. Rate limiting can be configured on a per endpoint and per period. By default, the client IP address is used to rate limit clients.

Configuration data for rate limits are stored in the ratelimits.ps1 file.

Configuring Rate Limiting

To configure rate limiting, you can visit the APIs / Rate Limiting page. Click the Add button and define a new rate limit rule.

Method

The Method is the HTTP method to for this rule. If you use * , all HTTP methods will be affected by this rule. You can also select a single method by picking it from the drop down.

Endpoint

The endpoint is the URL that you are rate limiting. You can rate limit all URLs by using a *. You can define specific URLs by define the relative path: /api/user.

Limit

The number of request in the time frame before rate limiting kicks in.

Period

The period over which the rate limit is counted. For example, if you select a period of 10 minutes and a limit of 100, then up to 100 requests can be made to the method and endpoint you have selected.

Allow Lists

To disable rate limiting for particular IP Addresses, clients and endpoints you can add them to the rate limiting allow lists. You will find these by clicking the settings button.

API

Terminals are in-browser PowerShell consoles that you can execute arbitrary commands within. Terminals are configured to target an environment that you select and can optionally us Run As credentials to run as other users. The history of terminals is maintained within the PowerShell Universal database. You can reconnect to disconnected terminals as long as they haven't timed out.

Configure A Terminal

You can configure a new terminal by navigating to Automation \ Terminals and clicking Create New Terminal. You'll be able to select the environment and credential to run the terminal as.

Use a Terminal

To use a terminal, click the Open Terminal button for the terminal you wish to launch. Depending on your configuration, this may start a new PowerShell process based on the environment you selected.

Once the terminal has launched, you'll be able to issue commands.

Stop a Terminal

To stop a terminal, you can navigate to the terminal instances tab on the Terminals page. Click the trash can to stop the terminal.

Reconnect to a Terminal

If you navigate away from PowerShell Universal, the terminal will go idle. You can reconnect to a terminal by clicking the Open Terminal button for the idle terminal instance.

Terminals will time out automatically after 5 minutes. You can customize the timeout by setting the -IdleTimeout parameter of New-PSUTerminal.

History

Terminal history can be enabled per terminal configuration.

When terminal history is enabled, you will be able to view the history of all commands that were executed within the terminal. Click the View Command History button for the instance in question.

You will be able to review what the command was that ran, when it was ran, who started the terminal and what the output of the command was.

New-UDDynamic allows you to define a dynamic region. Pages themselves are dynamic in nature. This means that every time a page is loaded, it runs the PowerShell for that page. Sometimes, you may want to reload a section of a page rather than the whole page itself. This is when you will want to use dynamic regions.

Basic Dynamic Region

This dynamic region reloads when the button is clicked.

Arguments List

An array of arguments may be passed to the dynamic region.

Auto Refresh

Dynamic regions enable the ability to auto refresh components after a certain amount of time. The entire region's script block will be run when autorefreshing.

Loading Component

Sometimes refreshing a dynamic component may take some time. For example, if you are querying another service's REST API or a data. Dynamic regions support configuration of the component that shows when the region is reloading. By default, nothing is shown. This can be any Universal Dashboard component.

API

Checkboxes allow the user to select one or more items from a set.

Checkboxes

Checkboxes can be disabled and checked by default

Checkboxes with custom icon

Create checkboxes that use any icon and style.

Checkboxes with onChange script block

Create checkboxes that fire script blocks when changed.

Checkbox with custom label placement

You can adjust where the label for the checkbox is placed.

Get the value of a Checkbox

You can use Get-UDElement to get the value of the checkbox. Get-UDElement will also return other properties of the checkbox component.

The following example shows a toast message with the value of the checkbox.

API

Components in PowerShell Universal Dashboard are exposed as functions. You can combine built in components to produce your own custom components.

Example: People Picker

The below example creates a New-UDPeoplePicker component from existing UD components. You can use the New-UDPeoplePicker component in your dashboards. This function can either be defined within your dashboard directly or within a Module.

This example users a published folder of avatars.

Basic Badge

Examples of badges containing text, using primary and secondary colors. The badge is applied to its children.

  New-UDBadge -BadgeContent { 4 } -Children {
      New-UDIcon -Icon Envelope -Size 2x
  } -Color primary

Color

API

Quickly and responsively toggle the visibility value of components and more with the hidden utilities.

How it works

Hidden works with a range of breakpoints e.g. xsUp or mdDown, or one or more breakpoints e.g. -Only 'sm' or -Only @('md', 'xl'). Ranges and individual breakpoints can be used simultaneously to achieve very customized behavior. The ranges are inclusive of the specified breakpoints.

Up

Using any breakpoint -Up parameter, the given children will be hidden at or above the breakpoint.

Down

Using any breakpoint -Down parameter, the given children will be hidden at or below the breakpoint.

Only

Using the breakpoint -Only parameter, the given children will be hidden at the specified breakpoint(s).

The -Only parameter can be used in two ways:

• list a single breakpoint

• list an array of breakpoints

API

REST API authentication requires a Universal API license. Once enabled, you will be able to enforce authentication and authorization on your endpoints.

Defining Secure Endpoints

You can define secure endpoints in the UI by enabling authentication.

You can also define secure endpoints using the .universal/endpoints.ps1 file or the Management API using New-PSUEndpoint

Triggers allow for automation jobs to be started when certain events happen within PowerShell Universal. For example, this allows you to take action when jobs complete, the server starts or dashboards stop. Triggers are useful for assigning global error handling or sending notifications when certain things happen.

Modals inform users about a task and can contain critical information, require decisions, or involve multiple tasks.

Basic

The editor component is based on . It's a block editor that accepts text, links, lists, code and images.

When working with the editor, you can receive data about the current document via the OnChange parameter. By default, data is returned in the Editor.js .

Creating an Editor

To create a basic editor, use the New-UDEditor cmdlet.

Transitions allow you to transition components in and out of view within your dashboard using various animations. You can take advantage of interactive cmdlets like Set-UDElement to change the transition state and cause an element to move in.

In the following example, we have a card that transitions in via a Fade. Clicking the switch the toggle the card in and out.

The resulting effect looks like this.

Collapse

PowerShell Universal is licensed per server. We provide licenses for individuals and organizations.

You can purchase a license on .

What's a server?

A server is a single running instance of PowerShell Universal.

Tabs make it easy to explore and switch between different views.

Tabs organize and allow navigation between groups of content that are related and at the same level of hierarchy.

Tabs

Date pickers pickers provide a simple way to select a single value from a pre-determined set.

Date pickers can be used in and .

OnChange Event Handler

The OnChange event handler is called when the date changes. You can access the current date by using the $Body variable.

PowerShell scripts can be created within PowerShell Universal to execute manually, on a scheudle or when events happen within the platform. They are stored on disk and also persisted to a local or remote Git repository.

Add a New Script

To add a new script, you can click the New Script button within the Automation / Scripts page. There are various settings you can provide for the script.

Script Options

Name

Name of the script as shown in Universal Automation. This will also be the name used to persist the script to disk. This setting needs to be unique within the current folder.

Description

A description of the script. This is shown in various places within the UA UI and also returned by the Universal cmdlets.

Disable Manual Invocation

Prevents a script from being run manually. This is enforced in the UI as well as the web server and cmdlets.

Manual Time

This setting is used to track the amount of time saved.

Max Job History

Defaults to 100. It defines the amount of jobs that are stored when running this script. Jobs are also cleaned up based on the server-wide job retention duration setting from within the Settings / General page.

Error Action

Changes how the script reacts when there is an error within the script. By default, terminating and non-terminating errors are ignored and the script will always be successful. You can change this setting to stop to cause scripts to fail immediately when an error is encountered.

If you wish to write errors directly to the error pane without causing changes in how the script is handled (for example in an exception handler), you can use Write-PSUError to output the error record and it will appear in the error tab of the job.

Environment

Allows you to define the required PowerShell environment for the script. By default, it uses the server-wide default PowerShell environment. PowerShell environments are automatically located the first the Universal Server starts up or read from the environments.ps1 file. You can also add Environment on the Settings / Environments page.

Timeout

The number of minutes before the script will timeout. The default value of 0 means the script will run forever. Once a script reaches it's time out, it will be cancelled.

Anonymous

The anonymous setting allows the script to be run when the user is not authenticated. This is useful when using scripts in Pages.

Discard Pipeline

When checked, this will disable the storage of pipeline output. This will greatly reduce the CPU and storage overhead of jobs. The script will still write to the information, warning, and error streams.

Concurrent Jobs

Defines the maximum concurrent jobs the script can be run. Defaults to 100.

Running a Script

You can run a script in the UI by click the Run button the Automation / Scripts page or by clicking View and then Run. In each case, you will be presented with the Run Dialog that allows you to select various settings for the job.

Running a Script With Parameters

PowerShell Universal automatically determines the parameters as defined within your scripts. It takes advantage of static code analysis to determine the type, default values and some validation that is then presented within the UI.

For example, you may have a script with the following parameters.

The result is a set of input options that are based on the types of parameters.

Running a Script as Another User

You can run scripts as another user by configuring . PowerShell Universal uses the Microsoft Secret Management module to integrate with secret providers. See variables for more information on secrets.

To run as another user, simply add or import a PSCredential variable. From there, you can select the credential from within the run dialog.

Running a Script on Another Computer

You can use the Computer drop down to select other machines to run a script on. The default value is to run on any computer that is available.

Running a Script on All Computers

You can run a script on all computers by selecting the All Computers option from the Computer drop down.

Remoting

Note that you can use PowerShell remoting by taking advantage of Invoke-Command . We do not support the use of Enter-PSSession or Import-PSSession.

Comment-Based Help

You can use comment-based to define the description, a synopsis, parameter based help, and links for your scripts. These will be displayed within the PowerShell Universal UI.

This above will yield the following user interface. The synopsis will be shown as the short description and a longer description can be shown in the description section. Links will appear under the description.

API

Schedules can be assigned to scripts and allow you to define frequency and other parameters for a script such as run as credentials.

Scheduling a Job

To schedule a job, you can do so from the Automation / Schedules page and by clicking the New Schedule button. You can also schedule a script by click the Schedule option from the script's page.

Schedules can be defined based on simple selections like Every Minute or Every Hour or you can define CRON expressions yourself for more configurable schedules. You can also run One Time schedules that run once at a later date.

You can also define which user the scheduled job will run under as well as which PowerShell version to use.

Simple Schedules

Simple schedules are really just helpers for various standard CRON schedules. When you select one, it will define a CRON schedule for your script.

CRON

CRON schedules use CRON expressions to define schedules. PowerShell Universal takes advantage of Chronos. For examples of valid expressions, .

One Time

One time schedules will run once in the future. You can select the time and day of when they will run.

Continuous

Continuous schedules will run over and over again. You can define a delay between each scheduled job run.

Parameters

Schedules support setting parameters for scripts. For example, if you have a script that accepts a parameter, you can choose to pass a value to the parameter during the schedule.

Within the modal for defining the schedule, you will have the option to set the parameter value.

When editing schedules from PowerShell, you can define the parameters on the New-PSUSchedule cmdlet. This cmdlet accepts dynamic parameters so that you can pass the values in for your schedule.

Environments

When creating a schedule, you have the option to specify the for your job to run. By default, it will use the default environment. You can define an environment in the UI by using the Environment drop down. You can define an environment using the -Environment parameter in New-PSUSchedule.

Run As

You can define which user to run the schedule as by using the Run As selector in the UI. The Run As selector contains a list of PSCredential you have defined. You will need to define a PSCredential variable before the Run As selector is visible. By default, scheduled jobs will run under the credentials of the user that is running PowerShell Universal.

You can define a Run As user in a script by using the -Credential parameter. The value should be the name of the variable that contains your credential.

Computer

You can select the computer or computers to run the schedule on. By default, schedules will run on any available computer. If you select All Computers, the schedule will run on all computers connect to the PSU cluster. If you select a specific computer, the schedule will run on only that computer.

Conditions

Conditions can be defined that determine whether a schedule should be run. This is useful if you are using the same repository scripts for multiple environments. Currently, conditions cannot be defined within the admin console. Conditions are passed the current script and schedule as parameters. The condition scriptblock is run within the integrated environment.

The condition needs to return true or false. Below is an example of a condition where the schedule will only run if there is an environment variable named Slot that contains the value production.

Pausing Schedules

You can pause a schedule by setting the Paused property. When a schedule is paused, it will not run. This is useful to stop a schedule from running but not delete it.

Time Out

You can set a time out for scheduled jobs. The time out is the number of minutes before the scheduled job is canceled.

Random Delay

The Random Delay property causes a schedule to start anywhere between 0 and 60 seconds from the scheduled time. This is useful when running many schedules at the same time. For example, if you had 10 schedules that start at midnight, you may want to set a random delay to limit resource contention on the PowerShell Universal service.

API

The responsive layout grid adapts to screen size and orientation, ensuring consistency across layouts.

The grid creates visual consistency between layouts while allowing flexibility across a wide variety of designs. Material Design’s responsive UI is based on a 12-column grid layout.

Basic Layout

Spacing

Adjust the spacing between items in the grid

Row and Columns

You can also use the New-UDRow and New-UDColumn functions when working with the grid.

API

Select components are used for collecting user provided information from a list of options.

Simple Select

Create a simple select with multiple options.

Grouped Select

Create a select with groups of selections.

OnChange

Execute a PowerShell event handler when the value of the select is changed. $EventData[0] for the single item that was selected.

Multiple Select

Execute a PowerShell event handler when the more than one value of the select is changed. $EventData is an array of the selected items.

Get-UDElement

Retrieve the value of the select from another component.

API

The menu component can be used to provide a drop down list of options for the user to select.

Basic Menu

Create a basic menu.

Button Styles

You can edit the style of the menu by adjusting the variant parameter.

Values

You can use the value parameter to define a value that differs from the text displayed.

OnChange Event Handler

Use the -OnChange parameter to specify a script block to call when a new value is selected. The value of the selected item will be available in $EventData.

API

The code editor component allows you to host the Microsoft Monaco editor within your dashboards.

Creating a Code Editor

You can create a new code editor with the New-UDCodeEditor cmdlet. Specifying the -Language parameter will enable syntax highlighting for that language. You will need to specify a height in pixels.

Populating Code

Use the -Code parameter to specify code that will be populated within the code editor when it loads.

Retrieving code from another component

You can retrieve code from another component using the Get-UDElement cmdlet and accessing the code property of the hashtable that is returned.

Setting code from another component

You can set code from another component using the Set-UDElement cmdlet. Specify the code value in a hashtable passed to the -Properties parameter.

Options

The Monaco editor supports a wide range of options. If you wish to use options that aren't available on the New-UDCodeEditor cmdlet, you can use the -Options parameter and pass a hashtable of options instead.

For a full list of options, check the interface.

Install PowerShell Universal

You'll need to install the PowerShell Universal server. but you can use the command line below to get started quickly.

The timeline control can be used to display a sequence of events over time.

Basic Timeline

Create a basic timeline with information on both sides of the timeline.

The New-UDElement cmdlet allows you to create custom React elements within your dashboard. Similar to New-UDHtml, you can define HTML elements using New-UDElement. Unlike, New-UDHtml, you can update elements, set auto refresh and take advantage of the React component system.

Create an Element

You need to specify the

Cards contain content and actions about a single subject.

Cards are surfaces that display content and actions on a single topic. They should be easy to scan for relevant and actionable information. Elements, like text and images, should be placed on them in a way that clearly indicates hierarchy.

Simple Card

Although cards can support multiple actions, UI controls, and an overflow menu, use restraint and remember that cards are entry points to more complex and detailed information.