' # Open container div
#region Grid Container (2) Dropdown and Button
New-UDGrid -Container -Content {
New-UDPaper -Elevation 1 -Content {
#endregion Grid Item (2) Dropdown and Button
#region Grid Item (2.1) Dropdown and Button
New-UDGrid -Item -ExtraSmallSize 3 -Content {
#endregion Grid Item (2.1) Dropdown and Button
#region Dropdown Select
New-UDDynamic -Id "DropDownDynamic" {
New-UDSelect -Id 'DropDown' -DefaultValue 'Bulk Decisions' -Option {
New-UDSelectOption -Name "Bulk Decisions$Page:TickedCount" -Value "Bulk Decisions"
New-UDSelectOption -Name 'Approve' -Value 'Approve'
New-UDSelectOption -Name 'Revoke' -Value 'Revoke'
} -OnChange {
$Choice = $EventData
$DecisionBit = if ($Choice -eq 'Approve') { 1 } else { 0 }
$Selected = $Session:Selections
# Show-UDToast ('{0}' -f $Session:Selections | Out-String) -Persistent
foreach ($Row in $Selected) {
$Query = @"
UPDATE Certificates
SET Decision = $DecisionBit
WHERE CertificateId = $Row;
"@
Invoke-DbaQuery -SqlInstance '(localdb)\MSSQLLocalDB' -Database PSU -Query $Query
}
Start-Sleep -Seconds 1
$Page:TickedCount = ''
$Session:Selection = @()
Sync-UDElement -Id 'DropDownDynamic'
Sync-UDElement -Id 'DynamicTable'
}
}
}
#endregion Dropdown Select
}
}
#region Grid Container (3) Table
New-UDGrid -Container -Content {
#endregion Grid Container (3) Table
#region Grid Item (3.1) Table
New-UDGrid -Item -ExtraSmallSize 12 -Content {
New-UDPaper -Elevation 1 -Content {
#endregion Grid Item (3.1) Table
#region Table + Filter and Sorts
New-UDDynamic -Id "DynamicTable" {
New-UDDataGrid -ShowPagination -PageSize 10 -RowsPerPageOptions @(10, 25, 50, 100, 200) -CheckboxSelection -LoadRows {
function ConvertTo-ProperCase {
param($Field)
switch ($Field) {
"username" { "UserName" }
"groupname" { "GroupName" }
}
}
$Context = $EventData
$SqlFilter = ""
if ($Context.Filter.Items.Count -gt 0) {
$count = 1
foreach ($filter in $Context.Filter.Items) {
if ($count -gt 1) {
$SqlFilter += " $($Context.Filter.logicOperator) "
}
else {
$SqlFilter += " WHERE "
}
switch ($filter.Operator) {
"contains" { $SqlFilter += " $(ConvertTo-ProperCase $filter.Field) LIKE '%$($filter.Value)%' " }
"equals" { $SqlFilter += " $(ConvertTo-ProperCase $filter.Field) = '$($filter.Value)' " }
"startsWith" { $SqlFilter += " $(ConvertTo-ProperCase $filter.Field) LIKE '$($filter.Value)%' " }
"endsWith" { $SqlFilter += " $(ConvertTo-ProperCase $filter.Field) LIKE '%$($filter.Value)' " }
"isAnyOf" {
$count = 1
foreach ($val in $filter.Value) {
if ($count -gt 1) {
$list += ", '$val'"
}
else {
$list += "'$val'"
}
$count += 1
}
$SqlFilter += " $(ConvertTo-ProperCase $filter.Field) IN ($($list)) "
}
"isempty" { $SqlFilter += " TRIM ($(ConvertTo-ProperCase $filter.Field)) IS NULL " }
"isnotempty" { $SqlFilter += " TRIM ($(ConvertTo-ProperCase $filter.Field)) IS NOT NULL " }
"notequals" { $SqlFilter += " $(ConvertTo-ProperCase $filter.Field) != '$($filter.Value)' " }
"notcontains" { $SqlFilter += " $(ConvertTo-ProperCase $filter.Field) NOT LIKE '%$($filter.Value)%' " }
}
$count += 1
}
}
$PageSize = $Context.PageSize
# Calculate the number of rows to skip
$Offset = $Context.Page * $PageSize
#endregion Table + Filter and Sorts
#region Create Table Query Herestring
$Query = @"
SELECT
CertificateId,
CertificateId as id,
Decision,
GroupName,
UserName,
AppName
FROM
dbo.Certificates
"@
#endregion Create Table Query Herestring
#region Table Construct Database Query with `Where`, `Paging`, and `Count`
if ($Context.Sort[0].field -ne $null) {
$sqlSort = "ORDER BY $(ConvertTo-ProperCase $Context.Sort[0].field) $($Context.Sort[0].sort) "
}
else {
$sqlSort = "ORDER BY (SELECT NULL)"
}
$sqlPage = "OFFSET $Offset ROWS FETCH NEXT $($Context.PageSize) ROWS ONLY;"
$Query = '{0} {1}' -f $Query, "$SqlFilter $sqlSort $sqlPage"
$Count = Invoke-DbaQuery -SqlInstance '(localdb)\MSSQLLocalDB' -Database PSU -As SingleValue -Query "SELECT COUNT(*) as count FROM dbo.Certificates $SqlFilter"
Show-UDToast $Query -Persistent
#endregion Table Construct Database Query with `Where's` and `Paging`
#region Query the Database and Pass `$Session:Data` to Out-UDTableData
$Session:Data = Invoke-DbaQuery -SqlInstance '(localdb)\MSSQLLocalDB' -Database PSU -As PSObjectArray -Query $Query
@{
rows = [Array]$Session:Data
rowCount = $Count
}
#endregion Query the Datbase and Pass `$Session:Data` to Out-UDTableData
#region Table Columns
} -Columns @(
New-UDDataGridColumn -HeaderName 'User' -Field 'UserName' -Filterable -Sortable -Description 'UserName'
New-UDDataGridColumn -HeaderName 'Group' -Field 'GroupName' -Filterable -Sortable
New-UDDataGridColumn -HeaderName 'App' -Field 'AppName' -Filterable -Sortable
New-UDDataGridColumn -HeaderName 'Decision' -Field 'Decision' -MinWidth 300 -Render {
New-UDDynamic -Id $EventData.CertificateId -Content {
function New-DecisionButton {
param(
$Text,
$Icon,
$Style,
$CertificateId,
$Decision
)
New-UDButton -Text $Text -Icon $Icon -Style $Style -OnClick {
$Session:updateButton = $true
$Query = @"
UPDATE Certificates
SET Decision = $Decision
WHERE CertificateId = $CertificateId;
"@
Invoke-DbaQuery -SqlInstance '(localdb)\MSSQLLocalDB' -Database PSU -Query $Query
Sync-UDElement -Id $CertificateId
} -ShowLoading
}
if ($Session:updateButton) {
$item = Invoke-DbaQuery -SqlInstance '(localdb)\MSSQLLocalDB' -Database PSU -Query ('SELECT * FROM [dbo].[Certificates] WHERE CertificateId = {0}' -f $EventData.CertificateId)
$EventData.Decision = $item.Decision
$Session:updateButton = $false
}
if ($EventData.Decision -eq 1) {
New-DecisionButton -Text 'Approve' -Icon $Page:IconApprove -Style $Page:BtnGreenApprove -CertificateId $EventData.CertificateId -Decision 'NULL'
New-DecisionButton -Text 'Revoke' -Icon $Page:IconRevokeNeutral -Style $Page:BtnWhiteRevoke -CertificateId $EventData.CertificateId -Decision '0'
}
elseif ($EventData.Decision -eq 0) {
New-DecisionButton -Text 'Approve' -Icon $Page:IconApproveNeutral -Style $Page:BtnWhiteApprove -CertificateId $EventData.CertificateId -Decision '1'
New-DecisionButton -Text 'Revoke' -Icon $Page:IconRevoke -Style $Page:BtnRedRevoke -CertificateId $EventData.CertificateId -Decision 'NULL'
}
else {
New-DecisionButton -Text 'Approve' -Icon $Page:IconApproveNeutral -Style $Page:BtnWhiteApprove -CertificateId $EventData.CertificateId -Decision '1'
New-DecisionButton -Text 'Revoke' -Icon $Page:IconRevokeNeutral -Style $Page:BtnWhiteRevoke -CertificateId $EventData.CertificateId -Decision '0'
}
}
}
#region Table OnRowSelection
) -OnSelectionChange {
$Session:Selections = $EventData
if ($Session:Selections.Count -le 0) {
$Page:TickedCount = ''
}
else {
$Page:TickedCount = ' ({0})' -f $Session:Selections.Count
}
Sync-UDElement -Id 'DropDownDynamic'
}
}
}
}
}
#endregion Table OnRowSelection
}
}
}
}
[PreviousTree View Font Size](https://docs.powershelluniversal.com/v4-beta/samples/apps/tree-view-font-size)
[NextChangelog](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog)
Last updated 1 year ago
Was this helpful?
---
# Extension Changelog | PowerShell Universal
[](https://docs.powershelluniversal.com/v4-beta/changelogs/extension-changelog#id-4.2.3-5-21-2024)
4.2.3 - 5/21/2024
-------------------------------------------------------------------------------------------------------------------------
* Added support for version 5 of PowerShell Universal
[](https://docs.powershelluniversal.com/v4-beta/changelogs/extension-changelog#id-4.2.2-5-8-2024)
4.2.2 - 5/8/2024
-----------------------------------------------------------------------------------------------------------------------
* Fixed an issue where an error would be thrown during extension activation
[](https://docs.powershelluniversal.com/v4-beta/changelogs/extension-changelog#id-4.2.1-12-8-2023)
4.2.1 - 12/8/2023
-------------------------------------------------------------------------------------------------------------------------
* Fixed an issue where updating dashboard or pages would cause issues if the service was restarted while the extension was activated.
[](https://docs.powershelluniversal.com/v4-beta/changelogs/extension-changelog#id-4.2.0-12-6-2023)
4.2.0 - 12/6/2023
-------------------------------------------------------------------------------------------------------------------------
* Added remote debugger support (requires PSU 4.2.6 or later)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/extension-changelog#id-4.1.0-9-12-2023)
4.1.0 - 9/12/2023
-------------------------------------------------------------------------------------------------------------------------
* Added support for creating and editing app pages
* Added support for app terminals
* Added support for viewing app sessions and tabs
* Added support viewing modules
* Added support for creating and editing custom modules
[](https://docs.powershelluniversal.com/v4-beta/changelogs/extension-changelog#id-4.0.2-6-20-2023)
4.0.2 - 6/20/2023
-------------------------------------------------------------------------------------------------------------------------
* Fixed an issue working with multiple connections
* Fixed an issue with loading job output
[](https://docs.powershelluniversal.com/v4-beta/changelogs/extension-changelog#id-4.0.1-6-13-2023)
4.0.1 - 6/13/2023
-------------------------------------------------------------------------------------------------------------------------
* Fixed an issue where the Configurations node would not work properly with v4
[](https://docs.powershelluniversal.com/v4-beta/changelogs/extension-changelog#id-4.0.0-6-13-2023)
4.0.0 - 6/13/2023
-------------------------------------------------------------------------------------------------------------------------
* Added support for PSU v4
* Remove Dashboard Frameworks and Components
[PreviousChangelog](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog)
Last updated 1 year ago
Was this helpful?
---
# What's New in v5? | PowerShell Universal
[](https://docs.powershelluniversal.com/whats-new-in-v5#new-admin-console)
New Admin Console
-------------------------------------------------------------------------------------------------
The admin console has been rebuilt using Blazor for ASP.NET. The look and feel are the same but more tightly associated with the backend Universal platform.
[](https://docs.powershelluniversal.com/whats-new-in-v5#portal)
Portal
---------------------------------------------------------------------------
The [PowerShell Universal Portal](https://github.com/ironmansoftware/universal-docs/blob/v5/broken-reference/README.md)
provides a simple-to-use access point for consumers of PSU resources. You can assign resources by role, and they will be grouped by tags in a searchable interface without the complexities of the admin console.
###
[](https://docs.powershelluniversal.com/whats-new-in-v5#pages-and-widgets)
Pages and Widgets
Portal [Pages](https://docs.powershelluniversal.com/portal/portal-pages)
and [Widgets](https://docs.powershelluniversal.com/portal/portal-widgets)
provide easy-to-use UI components that you can visually position on pages, which can be assigned to roles. Widgets are built using Blazor and PowerShell accept parameters, and they are interactive.
[](https://docs.powershelluniversal.com/whats-new-in-v5#powershell-universal-gallery)
PowerShell Universal Gallery
-----------------------------------------------------------------------------------------------------------------------
The PowerShell Universal Gallery is now integrated directly in PowerShell Universal. Access pre-built solutions for your PowerShell Universal environment.
You can view the [Gallery repository here](https://github.com/ironmansoftware/gallery)
.
[](https://docs.powershelluniversal.com/whats-new-in-v5#granular-permissions)
Granular Permissions
-------------------------------------------------------------------------------------------------------
Authorization within the platform is now configured via a [granular permission system](https://docs.powershelluniversal.com/security/enterprise-security/permissions)
that controls which users have access to which resources. This also includes new roles for specific feature groups, so administrators do not need to configure privileges for every scenario.
[](https://docs.powershelluniversal.com/whats-new-in-v5#postgresql-support)
PostgreSQL Support
---------------------------------------------------------------------------------------------------
PostgreSQL is now supported as a persistence store. PostgreSQL is open source and free.
[](https://docs.powershelluniversal.com/whats-new-in-v5#updated-runtimes)
Updated Runtimes
-----------------------------------------------------------------------------------------------
PowerShell Universal v5 is built on .NET 9 and PowerShell 7.5.
[](https://docs.powershelluniversal.com/whats-new-in-v5#grpc-cmdlets)
gRPC Cmdlets
---------------------------------------------------------------------------------------
The Universal module now uses gRPC for all communication with the system. gRPC is an interprocess communication technology that is fast and runs over HTTP. By unifying on a single technology, the cmdlets now take advantage of all the granular privileges and help reduce technical debt in the platform.
[](https://docs.powershelluniversal.com/whats-new-in-v5#windows-powershell-5.1-and-powershell-7-environments)
Windows PowerShell 5.1 and PowerShell 7 Environments
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------
The Agent environment has been replaced with Windows PowerShell 5.1 and PowerShell 7 environments. These environments host the PowerShell engine, but they allow for better control of assembly loading to ensure more modules are compatible with PowerShell Universal.
[PreviousAbout](https://docs.powershelluniversal.com/)
[NextGet Started](https://docs.powershelluniversal.com/get-started)
Last updated 3 months ago
Was this helpful?
---
# Changelog | PowerShell Universal
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#downloads)
[Downloads](https://ironmansoftware.com/release/powershell-universal)
-----------------------------------------------------------------------------------------------------------------------------------------------------------
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.5.5-7-25-2025)
4.5.5 - 7/25/2025
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#cve)
CVE
* \[CVE-2025-54552\] - Apps Docs > Variables includes database connection string with plain text password [#5026](https://github.com/ironmansoftware/powershell-universal/issues/5026)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.5.4-6-3-2025)
4.5.4 - 6/3/2025
-------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis)
APIs
* \[4.5.3\] Restarting API Button Not Available in One Way Git Sync [#4704](https://github.com/ironmansoftware/powershell-universal/issues/4704)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps)
Apps
* Fixed an issue with the Sync-UDElement docs [#4443](https://github.com/ironmansoftware/powershell-universal/issues/4443)
* Add Excel Filter Pattern to select more than on filter to New-UDTableColumn -FilterType [#4694](https://github.com/ironmansoftware/powershell-universal/issues/4694)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation)
Automation
* Added Running to job status filter selector [#4534](https://github.com/ironmansoftware/powershell-universal/issues/4534)
* Fixed an issue displaying error message from Invoke-PSUScript [#4563](https://github.com/ironmansoftware/powershell-universal/issues/4563)
* \[4.5.2\] Editing schedule results in invalid parameter when using ValidateSet [#4450](https://github.com/ironmansoftware/powershell-universal/issues/4450)
* AppToken with Reader role can archive jobs [#4755](https://github.com/ironmansoftware/powershell-universal/issues/4755)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#module)
Module
* Added -AsObject to Get-PSUJobOutput [#4496](https://github.com/ironmansoftware/powershell-universal/issues/4496)
* Parameter defined multiple times when calling New-PSUSchedule [#4359](https://github.com/ironmansoftware/powershell-universal/issues/4359)
* Added Add-PSUComputerTag\\Remove-PSUComputerTag
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.5.3-2-27-2025)
4.5.3 - 2/27/2025
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-1)
APIs
* Built-in variables are now read-only
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#admin-console)
Admin Console
* Fixed an issue where Executor and Reader roles could not view scripts (#4302, #3486)
* Fixed an issue with the re-run job button not populating the correct job parameters (#4303)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-1)
Automation
* Fixed an error thrown when running scripts (#4235)
* Added -DefaultScriptListView to Set-PSUSettings (#4204)
* Fixed an issue with one-time schedules in schedules.ps1 (#4428)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.5.2-1-29-2025)
4.5.2 - 1/29/2025
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#cve-1)
CVE
* [Fixed a directory traversal issue with Published Folders (CVE TBD)](https://docs.powershelluniversal.com/changelogs/cves#cve-tbd-1-29-2025-information-disclosure)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#installer)
Installer
* Fixed an issue where the installer would log the service account in plain text (#4246)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.5.1-1-15-2025)
4.5.1 - 1/15/2025
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-2)
APIs
* Fixed an issue with event hub client reconnect (#4126)
* Fixed an issue with endpoint paths (#4194)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-1)
Apps
* Fixed an issue with New-UDDataGrid quick filters (#3951)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-2)
Automation
* Fixed an issue creating scripts with periods in the name (#4077)
* Fixed an issue with multiple default values for string array parameters (#4181)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform)
Platform
* Fixed an issue with -SessionTimeout not being honored (#4175)
* Added error script stack trace to logs (#4198)
* Fixed an issue with the file system watcher and apps without file paths (#4166)
* Fixed an issue with Revoke-PSUAppToken (#4205)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.5.0-12-10-2024)
4.5.0 - 12/10/2024
-----------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-3)
APIs
* Added support for API parameter sets (#3798)
* Fixed an issue where event hub connections didn't list the remote computer name (#3980)
* Fixed an issue with event hub client logging
* Added automatic reconnect to event hub client
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-2)
Apps
* New-UDTooltip now sets a CSS class name based on the type of tooltip (#3899)
* Removed the need to call Invoke-UDEndpoint with -Session for it to work (#2139)
* Fixed an issue setting default app theme (#3943)
* Fixed an issue with the admin console logged out page (#4090)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-3)
Automation
* Fixed an issue copying pipeline output (#3825)
* Added -Silent to Invoke-PSUScript and Wait-PSUJob
* Fixed an issue with grooming child jobs (#3884)
* Fixed an issue with Wait-PSUJob returning duplicate output (#4013)
* Fixed an issue where Get-PSUJob would not include the identity or parameters (#4063)
* Fixed an issue where module scripts would disappear when adding\\removing other scripts (#4112)
* Fixed an issue with module scripts and Script Base Folder (#4092)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-1)
Platform
* Fixed an issue where the Reader role could clear logs (#3880)
* Fixed an issue where errors in configuration files could cause them to disappear (#3850)
* Fixed an issue with case sensitivity and logging target scopes (#3998)
* Fixed an issue where the service could crash if losing connection to the database (#4012)
* Fixed an issue where licenses would duplicate when installed as an environment variable (#3984)
* Fixed an issue with variable types when stored in the database (#4113)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.4.1-10-1-2024)
4.4.1 - 10/1/2024
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-4)
APIs
* Fixed an issue with OpenAPI docs default value for properties (#3430)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-3)
Apps
* Added example to New-UDEditor (#3410)
* Added -PreventCollapse to New-UDTreeView (#2252)
* Fixed an issue were logging out in a nested IIS site would redirect to the root site (#3229)
* Fixed Ant Design styling of New-UDExpansionPanel and New-UDTreeView (#3408)
* Fixed a rendering issue with dropdown buttons in a data grid cell (#3327)
* Fixed an issue with New-UDFloatingActionButton not staying in the bottom right corner of the screen (#3720)
* Fixed an issue with -IdentityColumn in New-UDDataGrid (#3832)
* Fixed an issue rendering a nested table.
* Fixed an issue with Nivo chart tool tips (#3718)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-4)
Automation
* Fixed an issue with running one-time schedules in multi-node environments
* Fixed an issue with running scripts over 30 minutes
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#cmdlets)
Cmdlets
* Fixed an issue with New-PSUVariable where it wouldn't create a string secret unless the type was explicitly set (#3656)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#git)
Git
* Fixed an issue with running git pack on an empty repository folder (#3744)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-2)
Platform
* Fixed an issue with the log configuration system (#3261)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.4.0-9-4-2024)
4.4.0 - 9/4/2024
-------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-4)
Apps
* Fixed an issue with transfer list documentation (#3506)
* Added -Enhanced to New-UDTransferList (#2888)
* Added search box to the right hand list in New-UDTransferList
* Fixed an issue with New-UDTimePicker documentation (#3505)
* Added dark mode support for New-UDEditor (#3502)
* Fixed an issue with New-UDCard -Image example (#3509)
* Fixed an issue with autocomplete formatting (#3570)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-5)
Automation
* Fixed an issue where Invoke-PSUScript -Wait would not return the correct output (#3508)
* Fixed an issue with exception output in Python (#3586)
* Fixed an issue with excessive database growth when using LiteDB (#3672)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-3)
Platform
* Fixed an issue where the ComputerTag collection will fill when using LiteDB (#3671)
* Fixed an issue with background job scheduling when using multi-node configurations
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.3.4-7-29-2024)
4.3.4 - 7/29/2024
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-6)
Automation
* Fixed an issue where an unauthorized error would be shown when using Invoke-PSUScript (#3491)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-5)
Apps
* Fixed an issue with data grid columns not rendering properly (#3443)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-4)
Platform
* Fixed an issue where online module help was not being updated correctly. (#3475)
* Added -MaximumTokenLifetime to settings.ps1
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.3.3-7-22-2024)
4.3.3 - 7/22/2024
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-7)
Automation
* Fixed an issue where calling Get-PSUJob over HTTP would return all child jobs (#3445)
* Moved Script Base Folder setting from Data to Automation (#3447)
* Fixed an issue where new jobs would not pass roles when the logged if user was Policy Defined (#3452)
* Fixed an issue creating schedules on some machines (#3453)
* Fixed an issue where jobs would queue up when all computers were in maintenance mode (#3458)
* Fixed an issue where paused schedules would still run in some circumstances (#3450)
* Fixed an issue where job parameters were not provided in triggers (#3382)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-6)
Apps
* Fixed an issue filtering rows with a space in the field name (#3432)
* Fixed an issue where app pages would not update properly during git sync (#3436)
* Fixed an issue where all apps would reload when anything changed in the repository (#3442)
* Fixed an issue where New-UDEditor image uploads wouldn't work when hosted in a nested IIS site (#3449)
* Fixed an issue loading the app designer (#3454)
* Fixed an issue using filters with number columns in New-UDDataGrid (#3459)
* Added deprecation warning for app designer
* Fixed an issue where it wasn't possible to link to a tab wish a hash in the URL (#3426)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-5)
Platform
* Fixed an issue with the /api/v1/notification POST API (#3462)
* Added a clearer error message to the IIS WebSocket health check when it fails (#3404)
* Fixed an issue with adding files with spaces in the name when using git sync and an external client (#3465)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.3.2-7-2-2024)
4.3.2 - 7/2/2024
-------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-8)
Automation
* Fixed an issue with Get-PSUJob not returning child jobs (#3433)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-7)
Apps
* Fixed an issue with route parameters in pages (#3434)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-6)
Platform
* Fixed an issue with the author in git commits using external git client (#3431)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.3.1-6-26-2024)
4.3.1 - 6/26/2024
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#api)
API
* Fixed an issue with wildcard rate limits (#3420)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-9)
Automation
* Fixed an issue with the job table becoming locked when grooming jobs when using SQL (#3414)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-8)
Apps
* Fixed an issue with Add-UDElement and New-UDGrid (#3413)
* Fixed an issue with query strings and page navigation (#3355, #3405)
* Fixed an issue with -Options on New-UDTableColumn when using -FilterType autocomplete
* Fixed an issue with the default values for -Views in New-UDDatePicker (#3429)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-7)
Platform
* Added Kestrel\_\_AddServerHeader appsettings option (#3417)
* Fixed an issue grooming log entries
* Fixed an issue where the git service could attempt to pull\\push before the server was completely started
* Added Kestrel\_\_Headers to appsettings.json (#3418)
* Fixed an issue with Get-PSUStats when using -Integrated (#3428)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.3.0-6-17-2024)
4.3.0 - 6/17/2024
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-5)
APIs
* Added -AnonymousApiDocumentation to Set-PSUSettings (#3294)
* Added support for bool parameters in API docs (#3349)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-10)
Automation
* Fixed an issue with module parameters
* Fixed an issue with deleting a terminal (#3358)
* Fixed an issue with error stack traces on the jobs page (#3380)
* Fixed an issue with access controls and scripts (#3385)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#powershell-apps)
PowerShell Apps
* Added -StripedRows to New-UDDataGrid (#3212)
* Added -HeaderFilters to New-UDDataGrid (#3214)
* Added -AutoSizeColumns to New-UDDataGrid (#3296)
* Fixed an issue with Nivo line charts (#3318)
* Added -ArcLinkLabel to New-UDNivoChart (#3293)
* Added -ShowLoading, -LoadingIndicator, and -LoadingPosition to New-UDButtonGroupItem (#3247)
* Fixed an error updating app pages (#3333)
* Added -Sx and -Style to New-UDTabs and New-UDTab
* Fixed an issue when viewing All items in a UDDataGrid (#3334)
* Fixed an issue with case sensitivity in New-UDDataGrid (#3354)
* Added a progress bar to New-UDTab when -Dynamic was used (#3357)
* Fixed an issue with Get-UDTheme where it would not work without any parameters specified (#3363)
* Fixed an issue with UDDataGrid -OnEdit duplicate IDs (#3316)
* Fixed an issue with -ShowQuickFilter in New-UDDataGrid (#3394)
* Added -Sx and -Style to New-UDListItem
* Fixed an issue with boolean header filters in New-UDDataGrid (#3395)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-8)
Platform
* Fixed an issue with commit author when using git and external git clients (#3322)
* Fixed an issue initializing an empty git repository (#3335)
* Fixed an issue that could cause PSU to fail to start properly (#3351)
* Added logging to debugging service
* Fixed an issue with the copy button and published folders in nested IIS sites (#2655)
* Fixed a case-sensitivity issue with the default environment and scripts
* Fixed an issue with SQL connection string exhaustion in multi-node environments.
* Fixed an issue deleting computers (#3364)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.2.21-5-6-2024)
4.2.21 - 5/6/2024
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-6)
APIs
* Fixed an issue with the roles field in the endpoint docs modal (#3303)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-11)
Automation
* Fixed an issue where error messages would be written twice in the output log (#3305)
* Added -ComputerGroup alias for -Queue on Invoke-PSUScript
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-9)
Platform
* Fixed an issue where the system would open an unnecessary amount of runspaces on startup
* Fixed an issue where runspaces would not always be garbage collected
* Added Jwt\_\_RoleClaimType to appsettings.json to support alternate claim types for roles
* Fixed an issue where configuration scripts would run twice (#3304)
* Fixed an issue where system logs would be verbose if SystemLogLevel was not defined (#3282)
* Fixed an issue with CookiePrefix and BasePath (#3307)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.2.20-4-30-2024)
4.2.20 - 4/30/2024
-----------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-7)
APIs
* Fixed an issue with the default endpoints.json Swagger documentation (#3287)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-12)
Automation
* Fixed an issue where Invoke-PSUScript -Wait wouldn't work with -UseDefaultCredentials (#3290)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#powershell-apps-1)
PowerShell Apps
* Fixed an issue with including -1 in -RowsPerPageOptions to create an All option (#3240)
* Fixed an issue with default pagination info and New-UDTable -LoadRows (#3228)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-10)
Platform
* Added Authentication:OIDC:AcceptAnyServerCertificate to appsettings.json (#3285)
* Fixed a memory leak
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.2.19-4-22-2024)
4.2.19 - 4/22/2024
-----------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-8)
APIs
* Fixed an issue where swagger types could show up in multiple documents (#2830)
* Fixed an issue with OpenAPI types in Swagger documents (#2948)
* Fixed an issue with authenticated OpenAPI docs and JWT tokens
* Fixed an issue with OpenAPI docs not reloading types properly (#3193)
* Fixed an issue using tabs in OpenAPI docs (#3180)
* Added error messages when OpenAPI docs fail to load
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-13)
Automation
* Added -InformationAction and -ErrorAction support for Invoke-PSUScript -Wait
* Added script name to the Script \\ Jobs page to support nested jobs (#3272)
* Fixed an issue where showing the timestamp in a job log would cause an error (#3277)
* Fixed an issue where canceled job could get stuck in cancelling state even after a server restart (#3164)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#powershell-apps-2)
PowerShell Apps
* Fixed an issue where scheduled endpoints would not run properly (#3273)
* Fixed an issue using -OnRowStyle, OnRowExpand and -LoadData with New-UDTable (#2848)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-11)
Platform
* Setting git sync interval to 0 will now disable the automatic sync (#3232)
* Fixed an issue with proxy configuration
* Fixed an issue where Remove-PSUVariable would not work in -Integrated mode (#3281)
* Fixed an issue with logs for roles (#3227)
* Fixed an issue with log entry timestamp display in the admin console
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.2.18-4-15-2024)
4.2.18 - 4/15/2024
-----------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-9)
APIs
* Fixed an issue where the endpoint doc page didn't have an authorize button (#3262)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-14)
Automation
* Fixed an issue viewing job log files.
* Changed the language of the Jobs run stat on the homepage (#3235)
* Fixed an issue where Wait-PSUJob could throw an error based on job output (#3260)
* Fixed an issue where the Get-PSJobOutput cmdlet returned a different data format in v4.2.16 (#3259)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#powershell-apps-3)
PowerShell Apps
* Fixed an issue with how memory usage was reported (#3217)
* Fixed an issue with $Query scoping (#3267)
* Fixed an issue with New-UDTextbox object result formats (#2838)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-12)
Platform
* Fixed an issue with variables stored in the database (#3250)
* New PSU versions are now automatically published to WinGet
* Fixed Set-PSUCache example (#3265)
* Fixed a display issue with app token expiration (#3097)
* Fixed an issue where $UserInfo was not defined in role scripts when using Okta (#3241)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.2.17-4-8-2024)
4.2.17 - 4/8/2024
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-15)
Automation
* Fixed an issue with Wait-PSUJob and Get-PSUJobOutput (#3249)
* Fixed an issue where jobs may be cancelled if Hangfire reset server status between heartbeats
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-13)
Platform
* Fixed an issue with the logging documentation link (#3236)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.2.16-4-5-2024)
4.2.16 - 4/5/2024
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-16)
Automation
* Fixed an issue with computer maintenance mode (#3198)
* Fixed a performance problem with job logs in SQL
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#powershell-apps-4)
PowerShell Apps
* Fixed an issue with New-UDDataGridColumn code completion (#3147)
* Fixed an issue with -TimeZone on New-UDTimePicker and New-UDDatePicker (#3126)
* Fixed an issue with spacing of icons in New-UDList (#3173)
* Added -Style to New-UDTransition (#2836)
* Fixed a JavaScript error with New-UDTable (#3234)
* Added -MaximumLength to -New-UDTextbox (#3239)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.2.15-3-28-2024)
4.2.15 - 3/28/2024
-----------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-17)
Automation
* Fixed an issue with Invoke-PSUScript -Wait and Wait-PSUJob (#3226)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-10)
APIs
* Fixed an issue where roles weren't displayed in the API Docs or the Event Hub modal (#3194)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#powershell-apps-5)
PowerShell Apps
* Added -Hide to New-UDDataGridColumn (#3213)
* Fixed an issue with New-UDDataGrid -ShowQuickFilter and wildcards (\*) (#3211)
* Added -DefaultSortDirection example to docs for New-UDTable (#3216)
* Fixed an issue where apps could be duplicated in multi-node SQL setups (#3102)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-14)
Platform
* Fixed an issue with displaying git commit timestamps (#3206)
* Added an error message when the database encryption key was missing (#3222)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.2.14-3-22-2024)
4.2.14 - 3/22/2024
-----------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-11)
APIs
* Fixed route matching for variable routes that also match static routes (#3181)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-18)
Automation
* Fixed an issue where app tokens could duplicate due to schedules
* Fixed an issue with the Hide Run As setting (#3187)
* Fixed a performance issue with writing job logs to SQL (#3200)
* Fixed an issue with calling Get-Acl (#2482)
* Fixed an issue loading Microsoft.PowerShell.Utility (#2423)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-9)
Apps
* Fixed an issue where -Style wouldn't apply when using -Disabled with New-UDCheckbox (#2144)
* Fixed an issue where the $Query hashtable was case sensitive (#3169)
* Added -Views to New-UDDatePicker (#2005)
* Fixed an issue with a stepper with no steps (#3188)
* Fixed an issue with the docs app stopping when editing other apps (#3174)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-15)
Platform
* Pinned to the Az.Accounts 2.12.5 version to avoid breaking changes in the module container image
* Fixed an issue with manually reloading dashboards.ps1
* Fixed documentation links (#3178)
* Removed manual garbage collection that could cause a service hang
* Fixed an issue with creating file system items in Linux (#3136)
* Fixed an issue with the Disabled Drives option for Disk Space Health Check (#3137)
* Encrypted git token\\password in database (#3182)
* Fixed an issue with storing the git repository in the database (#3127)
* Fixed an issue with installing modules on a nested IIS site (#3186)
* Fixed an issue with computers being marked offline (#3197)
* Added computer name to notifications in multi-node setups (#3195)
* Computers are now listed under computer groups (#3196)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.2.13-3-6-2024)
4.2.13 - 3/6/2024
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#api-1)
API
* Fixed an issue where gRPC commands and endpoint could fail when a proxy was configured (#3086)
* Added logging to event hub client (#3114)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-10)
Apps
* Added -PaperStyle to Show-UDModal (#2832)
* Fixed an issue where -Sx would not apply to New-UDTooltip (#3095)
* Added -ValueOptions to New-UDDataGrid
* Fixed an issue where when a PSU node was stopped, apps would stop on all other running nodes (#3119)
* Fixed an issue where nested navigation more than one level deep would not expand when navigating to a page (#3107)
* Fixed an issue with duplicate app pages and deleting app pages (#3120)
* Fixed an issue where page icons might not be shown in the header (#3105)
* Fixed an issue where New-UDRadioGroup -Label would have no affect (#3111)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-19)
Automation
* Fixed an issue where $Job.Script was null in triggers (#3087)
* Added support for -InformationAction on Invoke-PSUScript.
* Improved performance when loading many scripts at startup (#2859)
* Fixed an issue where an invalid app token could be selected when running scripts.
* Fixed an issue where the job page could throw a JavaScript error in the admin console (#3109)
* Fixed an issue where default values for DateTime objects would not be honored in the admin console schedules (#2802)
* Fixed an issue where Get-PSUJob wouldn't work in Windows PowerShell with certain parameter sets (#3138)
* Fixed an issue where One Time schedules would not survive a restart in SQL (#3135)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-16)
Platform
* Fixed an issue where resources in read-only regions could be duplicated (#3082/#3090)
* Fixed a race condition with module discovery that could cause inconsistent IDs and duplicate modules (#3088)
* Fixed an issue where the version field would be empty on the computers page (#3089)
* Fixed an issue when displaying large variable values (#3074)
* Fixed an issue where Computer Groups would not show in the admin console (#3101)
* Fixed an issue where INSTALLPATH wasn't honored when specified on the command line of the MSI (#1494/#3028)
* Fixed an error deleting app tokens in the groom job
* Fixed an issue where git bundles would not work with SQLite (#3108)
* Fixed an issue where computers could fail to delete (#2812)
* Fixed an issue where the ARM64/v8 docker image had the wrong platform set (#1024)
* Fixed an issue launching PSU from the Okta dashboard when using SAML2
* Fixed an issue were a service in a multi-node setup may not start when upgrading (#3103)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.2.12-2-1-2024)
4.2.12 - 2/1/2024
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-12)
APIs
* Fixed an issue with nested IIS sites and the API tester with variables (#3051)
* Fixed an issue where syntax errors in endpoint docs would cause them to disappear from the admin console (#3056)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-11)
Apps
* Fixed an issue where New-UDChartJS would ignore -Options when using -Line (#2871)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-20)
Automation
* Added Set-PSUSchedule (#3055)
* Fixed an issue where Max Job Memory would roll over if set above 2GB causing all jobs to terminate
* Fixed an issue updating a terminal (#3070)
* Fixed an issue where jobs could be stuck in a running state after finishing successfully
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-17)
Platform
* Fixed an issue where $UserInfo would be $null when using Auth0 and OIDC
* Fixed an issue where basic auth wouldn't correctly apply claims to the user
* Added better reporting of when the admin console is disabled
* Fixed an issue where configuration files would re-load twice when saved
* Fixed an issue where New-PSUVariable wouldn't correctly create PSCredential's in some circumstances
* Fixed an issue where disabling Local Account in an identity wouldn't change the status (#3077)
* Fixed an issue where identities could duplicate when using SQL persistence (#3054)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.2.11-1-22-2024)
4.2.11 - 1/22/2024
-----------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#api-2)
API
* Fixed an issue where APIs could only return a maximum of 4MB of data when using an external environment
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-21)
Automation
* **CRITICAL:** Fixed an issue where the Server Started trigger could cause PowerShell Universal to fail to start (#3065)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.2.10-1-20-2024)
4.2.10 - 1/20/2024
-----------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-13)
APIs
* Fixed an issue where $ClaimsPrincipal would be $null in endpoints when using Basic authentication
* Fixed an issue where swagger documentation would show required if Mandatory was set to false (#3040)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-12)
Apps
* Status Description is now displayed when using Write-Progress in an app (#2768)
* Fixed an example in the New-UDDatePicker documentation (#3041)
* Fixed an issue with $AppFullUrl when using HTTPS with the default port (#3013)
* Fixed an issue where New-UDAutocomplete with empty options would return a JavaScript error
* Fixed an issue where New-UDDatePicker would not always send a DateTime object
* Fixed an issue where a UDTransferList with no items would display a JavaScript error (#3048)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-22)
Automation
* Added -RandomDelayMaximum to New-PSUSchedule (#2886)
* Added $Job variable to the Job Timed Out trigger (#2704)
* Fixed an issue where One Time schedules would be deleted before run when using One-Way Git Sync and SQL persistence
* Fixed an issue where canceling a job could result in an exception and the job becoming stuck in a canceling state
* Fixed an issue where the job status sort and filter icons would overlap (#2893)
* Fixed an issue where jobs would still run on computers in maintenance mode (#3034)
* Fixed an issue where jobs listed on a script page wouldn't link properly to a JobRunId (#2852)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-18)
Platform
* Retrying module lookup during startup when it fails due to an internal PowerShell state (#2813)
* Added Run Schedule and Job Diagnostics to the admin console when git one-way and manual mode are enabled (#3032)
* Fixed an issue where -SessionTimeout for New-PSUSetting would not be applied (#2914)
* Fixed an issue where the login page logo would fail to load over HTTP (#3037)
* Fixed an issue where health checks wouldn't be shown on the home page in some cases (#3043)
* Added PowerShell Universal version to the computer table (#3050)
* Removed license check for installing modules from the PowerShell Gallery
* Fixed an issue where updates to authentication methods could update the wrong method and cause authentication to fail (#3033)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.2.9-1-10-2024)
4.2.9 - 1/10/2024
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-14)
APIs
* Added Event Hub Client installer (#3003)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-13)
Apps
* Fixed an issue where the New-UDButton -Loading would not display properly in the dark theme (#2875)
* Fixed an issue where the UDApp variable is null (#3014)
* Fixed an issue where the create page dialog would clear on refocus (#2725)
* Fixed an issue where $AppFullUrl would not be correct for nested IIS sites (#3013)
* Fixed an issue where refreshing a Dynamic with a Table with an ID wouldn't refresh the table data (#2782)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-23)
Automation
* Fixed an issue expanding errors in the admin console (#3017)
* Fixed an issue where Reader and Execute roles could view the contents of a script by typing in the URL
* Improved the performance of the schedules page when using SQL persistence.
* Fixed an issue where retried jobs would queue forever when using SQL persistence
* Added HangfireWorkerCount configuration option to appsettings.json
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-19)
Platform
* Fixed an error the groom job could fail clearing child jobs when using LiteDB (#3021)
* Added support for local files as admin console login page logos (#2705)
* Fixed warnings on server startup (#3023)
* Libgit2sharp now logs to the system log (#3026)
* Filters for health checks in the admin console (#3016)
* Fixed an issue where Get-PSUComputer -Integrated would return a gRPC error when using SQL persistence (#3018)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.2.8-1-3-2024)
4.2.8 - 1/3/2024
-------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-15)
APIs
* Fixed an issue where the API tester in the admin console wouldn't work in a nested IIS site (#3004)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-14)
Apps
* Fixed an issue where -Locale on New-UDDatePicker and New-UDTimePicker had no effect (#2988)
* Added Variables page to live documentation (#2991)
* Added -IgnoreResult to Invoke-UDJavaScript to work around a hang in certain circumstances (#2922)
* Fix issue with New-UDTextbox date hand enter (#3006)
* Fixed an issue with one of the examples for New-UDDataGrid
* Fixed an issue with one of the examples for New-UDForm (#2990)
* Added -DisableArcLinkLabels and -DisableArcLabels to New-UDNivoChart (#2907)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-24)
Automation
* Fixed an issue where the System Event page would show an error in the admin console (#2996)
* Fixed an issue where the job timer wouldn't display days (#3008)
* Fixed an issue where the admin console would display an error viewing a job (#2361)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-20)
Platform
* Fixed an issue where Azure DevOps git repositories could lose there tracking branch when clicking Synchronize Now
* Fixed a warning at startup about Computer Groups (#2989)
* Fixed an issue where the User Name computer tag would duplicate (#2997)
* Changed the default sort direction for Notifications (#3000)
* Fixed an issue with HTTPS certificate thumbprint lookups (#3002)
* Added support for custom computer tags (#2998)
* Fixed an issue where an extra new line character would be added to script scripts when splatting was enabled (#2995)
* Added the git repo link to the git commit page (#2956)
* Partial git commits now perform a git push (#2957)
* Fixed an issue where users could create app tokens for the system account (#3010)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.2.7-12-18-2023)
4.2.7 - 12/18/2023
-----------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-15)
Apps
* Fixed an issue with -Schema parameter of New-UDForm's example in cmdlet help (#2896)
* Added Start Time and Deploy Time to app information (#2950)
* Added $AppRoot and $AppFullUrl variables (#2928)
* Fixed an issue where integrated apps didn't report memory usage (#2969)
* Value must be unique for New-UDTransferList (#2952)
* Fixed an issue where New-UDMap did not work with Get-UDElement (#2971)
* Fixed an issue where New-UDMap did not work with Add-UDElement (#2973)
* Fix issue with value on date type New-UDTextbox (#2961)
* Fixed an issue where where the PSU icon would not show up in in the app live docs in a nested IIS site (#2953)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-25)
Automation
* Fixed an issue where scheduled jobs run using schedules without a name would not behave properly when filtering scheduled jobs (#2955)
* Fixed an issue where rerunning jobs with date\\time parameters would not populate correctly (#2944)
* Fixed an issue where Get-PSUJob -Id would not return the identity of the user that ran the script (#2945)
* Fixed an issue where the Job Completed trigger would not run on failed jobs (#2967)
* Fixed an issue concurrency issue that could occur when starting jobs using SQL persistence (#2964)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-21)
Platform
* Fixed an issue with SQL errors while grooming jobs with child jobs (#2894)
* Fixed an issue grooming idle terminals instances when the terminal was deleted (#2960)
* Added Delete All Notifications button (#2959)
* Fixed an issue where SQLite logging wouldn't work when using environment variables in the connection string (#2966)
* Added CertificateTypes configuration option for Certificate Authentication (#2985)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.2.6-12-11-2023)
4.2.6 - 12/11/2023
-----------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-16)
APIs
* Fixed an issue where $Body was not available if param was specified (#2923)
* Fixed an issue where the Roles property didn't populate properly when editing an endpoint in the Admin Console (#2920)
* Fixed an issue where API Docs wouldn't handle basic types property for .INPUT and .OUTPUT (#2935)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-16)
Apps
* Fixed an issue where the live docs page logo wouldn't load properly in a nested site (#2919)
* Fixed an issue where the live docs page would not render properly when a user had many roles (#2919)
* Improved uncached client-side load time (#2926)
* Fixed an issue where apps memory would usage was miscalculated (#2941)
* Fixed an issue where pages would disappear if a PSU module with pages was installed (#2942)
* Fixed an issue where the PSU service could crash when attempting to serialize the results of Get-Service (#2940)
* Added support for custom app and page templates (#2927)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-26)
Automation
* Fixed an issue where the groom job could delete one time schedules before they ran (#2912)
* Removed Suspend from Error Action script property (#2924)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-22)
Platform
* Fixed an issue where not all cookies would be prefixed by the Kestrel \\ CookiePrefix setting (#2846)
* Fixed an issue where git sync could lose its remote tracking branch
* Authentication and Role pages now use the log viewer (#2929)
* Log viewer defaults to text. Setting is now sticky (#2930)
* Fixed an issue where JWT, Cookies and Basic auth would not work against APIs when Windows Auth was enabled (#2254)
* Fixed an issue where PSEditorServices module was missing files
* Fixed an issue where adding Computer Groups wouldn't update in the Admin Console until refreshing the page (#2938)
* Fixed an issue where published folders would not work on Unix systems (#2947)
* Added View Repository and Status buttons on the git commit page (#2917)
* Verified PowerShell 7.4 support (#2860)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.2.5-12-4-2023)
4.2.5 - 12/4/2023
---------------------------------------------------------------------------------------------------------------
**Known Issues**
* [KB0054 - Git Sync: There is no tracking information for the current branch](https://support.ironmansoftware.com/portal/en/kb/articles/git-sync-there-is-no-tracking-information-for-the-current-branch)
* [KB0055 - Blank Admin Console or No Updates After Upgrade](https://support.ironmansoftware.com/portal/en/kb/articles/kb0055-blank-admin-console-or-no-updates-after-upgrade)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-17)
APIs
* Fixed an issue where endpoint docs would not show the required tag on required parameters
* Fixed an issue where endpoint docs would not show array parameters properly
* Fixed an issue where Connect-PSUEventHub would not work in Windows PowerShell
* Fixed an issue with using basic authentication with endpoints
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-17)
Apps
* Fixed an issue where Write-Progress wouldn't work properly with multiple connected clients (#2881)
* Fixed an issue where apps would not remain running on multi-node systems (#2854)
* Fixed an issue where New-UDUpload data would not be available in New-UDStepper (#2865)
* Fixed an issue where dashboards would not start if they had ps1 files in the pages folder that did not return New-UDPage
* Fixed an issue were the date filter type did not work in New-UDTable (#2898)
* Fixed an issue where New-UDDatePicker and New-UDTimePicker could not be cleared (#2892)
* Fixed an issue where New-UDDatePicker and New-UDTimePicker -TimeZone would have no effect. -TimeZone requires an IANA time zone ID. See https://mui.com/x/react-date-pickers/timezone/#supported-timezones for a list of valid time zones. (#2891)
* Fixed an issue with UDMap not rendering properly (#2535)
* Fixed an issue where New-UDSelect would fail when only a single item was present (#2916)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-27)
Automation
* Fixed an issue where certain views would not show scheduled jobs
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-23)
Platform
* Fixed an issue where old git statuses would not be removed when resetting the git settings (#2884)
* Fixed an issue where /api/v1/cache/keys returned keys with a PSUCache prefix.
* Fixed an issue where logging targets would not honor the minimum level
* Disabled progressive web app for management console
* Fixed an issue where the -Minimal parameter couldn't be specified for environments in the Admin Console (#2908)
* Fixed an issue with the git commit file selector (#2877)
* Fixed an issue with published folders that started with a slash in the path (#2655)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.2.4-11-24-2023)
4.2.4 - 11/24/2023
-----------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-18)
Apps
* Fixed an issue where Get-UDPage could return pages from the wrong app.
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-28)
Automation
* Fixed an issue with the PowerShell serializer when saving schedules with splatting enabled (#2866)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#pages)
Pages
* Fixed an issue with submitting forms on Pages
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-24)
Platform
* Fixed an issue with Windows authentication in IIS when attempting to access the admin console.
* Fixed an issue where creating a new module in the admin console would return the error "Value Cannot Be Null (Parameter ‘s’)"
* Fixed an issue where using the certificate thumb print for a certificate with a subject that didn't start with "CN=" would fail to load the certificate.
* Fixed an issue where New-PSULoggingTarget could not be called remotely.
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.2.3-11-21-2023)
4.2.3 - 11/21/2023
-----------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-29)
Automation
* Fixed an issue where Get-PSUJob would not return scheduled jobs (#2867)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-19)
Apps
* Fixed an issue where nested files changes would not cause an autodeploy (#2863)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-25)
Platform
* Fixed an issue where Windows Auth logins would not work with the admin console
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#desktop)
Desktop
* Fixed an issue where Desktop mode would not start properly.
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#known-issues)
Known Issues
* There is a known issue with Windows Auth and IIS that will be resolved in 4.2.4.
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.2.2-11-20-2023)
4.2.2 - 11/20/2023
-----------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-20)
Apps
* Increased max websocket size to fix an issue with Get-UDElement failing on large objects like tables
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-26)
Platform
* Fixed an issue where SAML2 logins would not work with the admin console (#2853)
* Added Kestrel:CookiePrefix setting to allow for multiple instances of PSU to run on the same server without sharing cookies (#2846)
* Fixed an issue where the git commit page would reload every second
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.2.1-11-16-2023)
4.2.1 - 11/16/2023
-----------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#critical)
Critical
* Security Vulnerability Remote code execution in PowerShell Universal APIs (CVE-TBD) - [More Information](https://blog.ironmansoftware.com/powershell-universal-apis-cve/)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-21)
Apps
* Disabled service worker registration for apps to prevent caching of the index.html file (#2855)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.2.0-11-14-2023)
4.2.0 - 11/14/2023
-----------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-18)
APIs
* Added -Local to Get-PSUEventHubConnection (#2715)
* Added support for calling Send-PSUEvent remotely (#2719)
* Improved API performance
* Added C# API plugin
* Added Set-PSUEndpoint
* Fixed an issue where renaming endpoint paths would not have any effect (#2737)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-22)
Apps
* Added -OnClick to New-UDCard (#2697)
* Removed the Mandatory flag for -Text on New-UDMenuItem (#2685)
* Fix style issue with -Multiple and -Icon on New-UDAutocomplete (#2632)
* Added -Variant to New-UDIconButton (#2363)
* Fixed styling issues with New-UDToggleButton (#2532)
* Get-UDPage -Name now works with Page names and file names (#2543)
* Added -CountDescription and -RowsPerPage to New-UDTableTextOption (#2219)
* Fixed name issues with New-UDSelectGroup (#2701)
* Improved performance of Get-UDElement (#2733)
* Apply -Dense to all sub-list items (#2749)
* Fixed an issue where New-UDDatePicker would return a string rather than a DateTime object (#2716)
* Make New-UDTransferList search case-insensitive (#2729)
* Added -FullHeight to Show-UDModal (#2722)
* Fixed an issue with Out-UDDataGridData where it would not filter properly
* Added -Dense, -LeftTitle, -LeftSubTitle, -RightTitle, -RightSubTitle to New-UDTransferList (#2714)
* Improved App Designer properties layout (#2793)
* Automatic navigation now uses -Title as the link for the navigation link (#2758)
* Improved the performance of New-UDDataGrid checkbox selection
* Added -Wait to Sync-UDElement
* Added -Sx to New-UDSelect
* Fix issue with single char issue on New-UDTextbox (#2800)
* Fix variant when using -Mask on New-UDTextbox (#2807)
* Added app page properties (#2757/#2567)
* Added -Icon to New-UDButtonGroupItem (#2789)
* Added -Color, -Disabled, -FullWidth, -Orientation, -Size, -Sx, and -Variant to New-UDButtonGroup (#2789)
* Added live docs for New-UDButtonGroup (#2789)
* Fixed an issue with New-UDDataGridColumn default values (#2828)
* Fixed an issue where using the logout button would not forward back to the app after logging in again (#2642)
* Added -OnRowStyle and -HeaderStyle to New-UDTable (#156, #758)
* Fixed an issue where Sync-UDElement could throw an exception
* Added -IdentityColumn, -RowHeight, -HideExport and -DisableRowSelectionOnClick to New-UDDataGrid
* Fixed card margin issue (#2801)
* Fixed issue with -ShowLoading with dark themes (#2691)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-30)
Automation
* Added a filter for job status (#2694)
* Added support for minimal job environments
* Added support for hiding scheduled jobs (#2710)
* Fixed an issue with Invoke-PSUScript and SecureString parameters
* Wait-PSUJob now supports -JobId
* Wait-PSUJob now returns pipeline output and terminating errors
* Invoke-PSUScript now supports -WaitTimeout
* Added -Schedule to Get-PSUJob
* Fixed an issue starting terminals in the Agent environment
* Added -Parameters to New-PSUSchedule and updated the serializer to use this format by default
* Fixed an issue where Get-PSUSchedule -Integrated would not return the NextExecutionTime
* Added -Parameters to Invoke-PSUScript
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-27)
Platform
* Added New-PSUHealthCheck and New-PSUHealthCheckResult (#2522)
* Added Conflict Module Health check (#2700)
* Adjusted the authentication re-check on the login page to reduce 401s (#2688)
* Dashboard and API endpoint files are now deleted when the resource is removed. (#2676)
* Added the ability to configure disabled drives for the Drive Space health check (#2476)
* Fixed an issue with overlapping tooltips on the computer delete button (#2707)
* Added reserve proxy plugin (YARP)
* Added OpenTelemetry plugin
* Added reload configuration file dropdown
* Added a minimap toggle to the editor
* Fixed an issue with loading Az.Accounts in PSU
* Updated Swashbuckle NuGet package (##2682)
* Included PSResourceGet GA module and remove pre-release PSGet (#2740)
* PowerShell Universal can now be installed as a Progressive Web App
* Added static PowerShell 7 environment to prevent issues when upgrading the underlying PowerShell version (#2765)
* Fixed an issue with array variables (#2693)
* Fixed an issue where the agent environment wouldn't work on Linux
* Added support for Computer Groups and accompanying cmdlets
* Added -FileEncoding to Set-PSUSetting
* Added Basic authentication
* Added Get-PSUGitSetting, Set-PSUGitSetting and Remove-PSUGitSetting
* Added Merge-PSUGitEdit, Start-PSUGitEdit and Stop-PSUGitEdit
* Added Sync-PSUGit
* Added -Commits, -UncommittedChanges, -EditInProgress to Get-PSUGitStatus
* Fixed an issue with -DefaultRoute on New-PSURole not working with forms authentication
* Modified variable properties (#2778)
* Added Clear-PSUCache
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#deprecated)
Deprecated
* Queues configured in appsettings.json - Replaced with computer groups
* Browser based debugging tools - Replaced with VS Code extension
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.1.10-11-16-2023)
4.1.10 - 11/16/2023
-------------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#critical-1)
Critical
* Security Vulnerability Remote code execution in PowerShell Universal APIs (CVE-TBD)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.1.8-10-30-2023)
4.1.8 - 10/30/2023
-----------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-23)
Apps
* Fixed an issue where clicking off the Read-Host dialog would not be treated as a cancel
* Fixed an issue where clicking cancel in PromptForChoice would result in an exception (#2806)
* Fix issue with single char issue on New-UDTextbox (#2800)
* Added $ENV:PSU\_APP\_PAGE\_MAX to allow for customizing the max number of page (tab) states are stored in memory per session, per dashboard.
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-31)
Automation
* Fixed an issue where Invoke-PSUScript could throw an exception when -Wait is specified in a non-integrated environment while using SQL persistence
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-28)
Platform
* Added -File to Sync-PSUConfiguration
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.1.7-10-23-2023)
4.1.7 - 10/23/2023
-----------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-24)
Apps
* Fixed an issue where Read-Host Cancel would return an error when clicking the cancel button (#2769)
* Fixed an issue where dashboards would fail to start or stop with a 500 error
* Fixed an issue with variable scoping in rendered table rows (#2776)
* Fixed an issue where New-UDAutocomplete -Value wouldn't work when -Multiple was specified (#2698)
* Fixed an issue where certain formats of $EventData would return a DateTime rather than the expected string
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-32)
Automation
* Fixed an issue where credential variables with roles could throw an exception when starting a job (#2762)
* Fixed an issue where Invoke-PSUScript -Wait would throw an error (#2777)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-29)
Platform
* Fixed an issue where the secret provider did not honor environment variables (#2753)
* Fixed an issue where logging for roles was not displaying properly (#2766)
* SystemLogLevel now defaults to Information
* Added error handling around PSScriptAnalyzer formatting
* Enabled gRPC logging
* Fixed a file locking issue with configuration files
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.1.6-10-16-2023)
4.1.6 - 10/16/2023
-----------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-19)
APIs
* Fixed an issue where the $Data variable was not populated.
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-25)
Apps
* Fixed an issue where Windows authentication would display as anonymous in User Sessions for apps.
* Fixed an issue where Sync-UDElement + New-UDElement cause event handlers to fail. (#2747)
* Fixed an issue where New-UDDatePicker would return the current day rather than $null when no date was selected. (#2734)
* Fixed an issue where New-UDDatePicker would return a string rather than a DateTime object (#2716)
* Fixed vertical alignment of New-UDAlert -Dense (#2724)
* Fixed an issue where Read-Host would return the previous value if Cancel was clicked the second time
* Fixed an issue where Ok and Cancel would both return an empty string from Read-Host. Now cancel returns $null and Ok returns an empty string.
* Make New-UDTransferList search case-insensitive (#2729)
* $Query is now case-insensitive (#2752)
* Fixed an issue where -Variant fullWidth didn't work on New-UDTabs
* Add a delete pages button and tab to the admin console (#2755)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-33)
Automation
* Fixed an issue where Get-PSUJob -Id-RunId would behave differently depending on where you were running it (#2750)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-30)
Platform
* Adjusted the admin console build to avoid inline JavaScript
* Removed Policy Defined from the App Token Role selector since it is not a valid value for tokens (#2739)
* Fixed an issue where updating git settings would clear out the username and password (#2742)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.1.5-10-9-2023)
4.1.5 - 10/9/2023
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-20)
APIs
* Improved API performance
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-26)
Apps
* Push -Dense down to children on New-UDList (#2677)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-31)
Platform
* Fixed a concurrency issue during authentication when using SQL persistence that could result in SQL exceptions
* Fixed an issue where SQLite persistence would create an errant file and folder in the repository directory
* Fixed an issue where SQLite persistence did not properly support environment variables.
* Remote access is now supported for developer licenses.
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.1.4-10-2-2023)
4.1.4 - 10/2/2023
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-32)
Platform
* Rolling back a change made to support Az.Accounts in the integrated environment as it was causing problems with OIDC and JWT authentication (#2718)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.1.3-10-2-2023)
4.1.3 - 10/2/2023
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-34)
Automation
* Fixed an issue where viewing script properties with tags assigned would show a JavaScript error.
* Fixed an issue where the rerun job button wasn't present for jobs with a warning status (#2708)
* Fixed an issue where scripts edited in the admin console wouldn't reload parameters
* Fixed an issue where retrying jobs wouldn't work when using SQL persistence (#2706)
* Fixed an issue where parameter sets would not be available in the create schedule dialog (#2712)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-27)
Apps
* Fixed an issue where the View Code button would not work in the App Designer.
* Fixed an issue where extra lines were added to event handlers in the App Designer.
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-33)
Platform
* Fixed an issue where the ModuleRefreshInterval setting would not work after a restart of the service.
* Fixed an issue where Az.Accounts could not be loaded into the integrated environment (#2681)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.1.2-9-25-2023)
4.1.2 - 9/25/2023
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-28)
Apps
* Fixed an issue where -OnLoading of New-UDPage would not have an affect
* Fixed an issue where New-UDElement would leak event handlers (#2692)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-35)
Automation
* Fixed an issue where saving scripts would be slow if there were many scripts defined
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-34)
Platform
* Fixed the default connection string in the MSI to work with SQLite.
* Fixed an issue with viewing log entries in the admin console when using SQLite.
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.1.1-9-18-2023)
4.1.1 - 9/18/2023
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-29)
Apps
* Fixed an issue where the admin link would not work properly in a nested IIS site (#2672)
* Fixed an issue where Get-UDElement would display errors when a property did not exist instead of returning $null
* Fixed an issue where the date picker would not be visible in dark themes (#2669)
* Fixed an issue where PromptForChoice wouldn't behavior properly when run twice on the same page
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-21)
APIs
* Fixed aan issue where Send-PSUEvent hub did not work out of the integrated environment (#2674)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-35)
Platform
* Fixed an issue where certain roles would forward to a missing page rather than the admin console
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.1.0-9-12-2023)
4.1.0 - 9/12/2023
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-22)
APIs
* Added Get-PSUEventHubConnection
* Added -ConnectionId to Send-PSUEvent
* Send-PSUEvent can now return data when using -ConnectionId
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-30)
Apps
* Adding BackgroundImage and BackgroundRepeat to New-UDPage (#2325)
* Adding Disabled to New-UDSelectOption (#2491)
* Adding md to Size to New-UDIcon (#2528)
* Added -Label to New-UDProgress (#2553)
* Added -OpenInNewWindow to New-UDListItem (#2540)
* Added -Minimum and -Maximum to New-UDTextbox (#2455)
* Fixing issues with Show-UDToast -MessageSize (#1000)
* Fixing issues with Show-UDToast -Icon (#1913)
* Added additional configuration options to apps in the admin console
* Added Show-UDSnackbar\\Hide-UDSnackbar (#2561)
* Fixing issue with New-UDDataGrid pagination (#2546)
* Fixed an issue where row selection in New-UDDataGrid wasn't available in Get-UDElement (#2573)
* Added -OnSelectionChanged to New-UDDataGrid
* Fixed an issue where schema forms -OnSubmit would not run
* Added -DefaultSortColumn and -DefaultSortDirection to New-UDDataGrid (#2011)
* Fix issue with min\\max on New-UDDatePicker (#2580)
* Fixed an issue with New-UDSwitch -LabelPlacement should be start not left (#2601)
* Added Restart and Admin Console links to dashboards of admins (#2362)
* Added Get-UDTheme -Current (#2508)
* Fix New-UDAutocomplete to look at options for defaults (#2583)
* Added -ArgumentList to Sync-UDElement (#1815)
* Clear autocomplete with Set-UDElement (#2631)
* Fixed an issue where row selection wouldn't always work when filtering with New-UDTable (#2630)
* Added -Disabled to New-UDAutocomplete (#2639)
* Fixed an issue where links in New-UDMarkdown didn't follow the theme (#2296)
* Added $TimeZone variable to apps (#2646)
* Added missing New-UDAutoCompleteOption to live docs (#2640)
* Power Managing a dashboard will now do so on all nodes when using SQL Server (#1360)
* Fixed an issue where the nivo chart docs were not present on the live docs (#2640)
* Fixed an issue with -CirclePacking and -TreeMap in New-UDNivoChart
* Fixed an issue with -Heatmap in New-UDNivoChart
* Added New-UDTheme (#2653)
* Fixed an issue where several components (tables, pickers, charts) would not update when using within a UDDynamic (#2661)
* Improved the behavior of New-UDButtonGroup (#2651)
* Fixing issue with New-UDAvatar -Variant not supporting default round (#2633)
* Fixed an issue where New-UDUpload did not work in a nested IIS site (#2657)
* Fixed an issue where autocomplete would fail to render if it was pass a single value that wasn't an array (#2668)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-36)
Automation
* Added Error status for jobs that succeed but have errors
* Added a Create Scheduled button to the Scripts \\ Schedules tab. (#2541)
* Added support for cmdlets in -Command in New-PSUScript (#2605)
* Fixed an issue with editing schedules in the admin console (#2659)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-36)
Platform
* Add configurable git sync timeout (#2466)
* Added git to the linux docker container (#2472)
* Updated the integrated and agent environments to 7.3.6 (#2494)
* Administrator role now defaults to $false (#2492)
* Added a Run Module Discovery button to the module page (#2486)
* Added $RefreshToken to access the OIDC refresh token
* Added support for SQLite
* Updated to Microsoft.Data.SqlClient version 5.1.1
* Added loaded Assemblies to the process view
* Added additional branding settings
* Added Remove-PSUCache
* Added ModuleDiscoveryFrequency to Set-PSUSettings (#2595)
* Added Get-PSUPublishedFolder (#2622)
* Added SystemLogLevel to appsettings.json
* Fixed an issue where the default theme setting would not take effect (#2292)
* The secret variable credential dialog now suggests including the domain in the user name (#2625)
* Fixed an issue where Grant-PSUAppToken would generate tokens with invalid roles besides the first role specified.
* Fixed an issue where modules in the Modules directory were imported into the PSU server during startup
* Fixed an issue with editing modules when a Universal extension module was installed
* Fixed an issue where readonly resources could show up in configuration files
* Added support for PSScriptAnalyzer settings files (#2658)
* Fixed an issue where the module REST API did not work with app tokens.
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.0.12-8-31-2023)
4.0.12 - 8/31/2023
-----------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-37)
Automation
* Fixed an issue where scripts provided by modules would not be visible in folder view
* Fixed an issue where job output could be malformed when storing in SQL causing an error in the admin console (#2644)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.0.11-8-28-2023)
4.0.11 - 8/28/2023
-----------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-23)
APIs
* Endpoints will now attempt to read form data even if the HTTP client doesn't specify a Content-Type header (#2612)
* Fixed an issue where authenticated event hub clients would not receive events.
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-31)
Apps
* Fixed an issue where the app designer would add 2 IDs when the ID of a component was changed (#2589)
* Fixed an issue where the default choice for PromptForChoice would throw an exception (#2607)
* Fixed an issue where Get-UDPage would throw an exception if the page was not found causing the entire app to fail to load (#2610)
* Fixed an issue where UDTreeView selected items were not visible in the default dark theme (#2613)
* Fixed an issue where expired tokens would cause -GrantAppToken to fail to generate a new token
* Fixed an issue where recursive object paths could cause an app crash (#2627)
* Fixed an issue where -OnLoadOptions and -Multiple wouldn't show selections in New-UDAutocomplete (#2604)
* Added -Options to New-UDTableColumn (#1097)
* Fix New-UDAutocomplete to look at options for defaults (#2583)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#pages-1)
Pages
* Fixed an issue where unauthenticated pages would clear out the form data after 3 seconds (#2611)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-37)
Platform
* Fixed an issue where no error was shown when there was a failure to save a translation file (#2618)
* Fixed an issue where database git sync could run into an OutOfMemory exception (#2620)
* Fixed an issue where an exception was thrown while attempting to groom an expired apptoken that was used by a job (#2621)
* Added universal-modules docker image tag (#2624)
* Added Download System Logs button
* Implemented a database recovery feature if the LiteDB database is corrupted
* Resources are now marked readonly in the admin console (#2587)
* Fixed an issue where variables with a role wouldn't show up for admins unless it had the Administrator role
* Fixed an issue with the log viewer not retaining filters when sorting or paging.
* Fixed an issue with the documentation links in the admin console
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.0.10-8-14-2023)
4.0.10 - 8/14/2023
-----------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-24)
APIs
* Fixed an issue where specifying an invalid environment could cause multiple API to fail to load. Now falls back to integrated and shows a warning (#2591)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-32)
Apps
* Fix issue with min\\max on New-UDDatePicker (#2580)
* Fixed an issue where the MUI X license key was expired
* Fixed an issue with New-UDSwitch -LabelPlacement should be start not left (#2601)
* Breaking: Query string values are now passed in via a $Query dictionary rather than as variables to avoid potential injection issues
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-38)
Automation
* Added -PreformattedJobOutput to Set-PSUSettings to improve performance of large job output
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#pages-2)
Pages
* Fixed an issue where default values for form textboxes didn't work (#2592)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-38)
Platform
* Fixed an issue where deleted computers could be displayed in the Run As dropdown (#2593)
* Fixed an issue where 1 day rate limits would actually define a 24 day rate limit (#2594)
* Fixed an issue where canceling a git edit with a missing repo directory would fail (#2599)
* Fixed an issue where TCP and UDP logging targets would not configure properly through the admin console (#2600)
* Fixed an issue where app tokens set to never expire would not authenticate properly (#2598)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.0.9-7-30-2023)
4.0.9 - 7/30/2023
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-25)
APIs
* Fixed an issue where the event hub edit modal would be empty
* Fixed an issue with connecting to event hubs that had authentication but did not specify roles
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-33)
Apps
* Fixed an issue adding images to the app designer
* Fixing issue with New-UDDataGrid pagination (#2546)
* Fixed an issue where row selection in New-UDDataGrid wasn't available in Get-UDElement (#2573)
* Added -OnSelectionChanged to New-UDDataGrid
* Fixed an issue where schema forms -OnSubmit would not run
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-39)
Automation
* Job output is now set at verbose for the log level to avoid duplicating the output in the database by default to avoid performance issues. Job output is still logged to the job output tables.
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-39)
Platform
* Fixed an issue where the access control and app token dialog would not allow edits (#2576)
* Fixed an issue where the home page of the admin console could show a JavaScript error if the health checks failed to return a value (#2575)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.0.8-7-23-2023)
4.0.8 - 7/23/2023
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-40)
Automation
* Fixed an issue where rerun job would not populate string array parameters correctly. (#2434)
* Fixed an issue where rerun job would not select the correct parameter set
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-34)
Apps
* Fixed an issue where New-UDTickPicker didn't display the picker component (#2551)
* Fixed an issue where New-UDToolTip didn't have a -Type parameter
* Fixed an issue where New-UDAutoComplete would display the value rather than the name of New-UDAutoComplete option when using -OnLoadOptions
* Fixed an issue where the export and delete logging buttons would not work for nested IIS sites (#2554)
* Fixed an issue where -Scrollable on didn't work on New-UDTabs (#2557)
* Fixed an issue where -Size for New-UDButton didn't display properly on the live docs (#2462)
* Fixed an issue where Get-UDElement would return an invalid value from New-UDAutoComplete
* Fixing issues with Show-UDToast -MessageSize (#1000)
* Fixing issues with Show-UDToast -Icon (#1913)
* Fixed a JavaScript error in the App Designer
* Fixed an issue where boolean parameters would not be serialized properly by the app designer (#2562)
* Fixed an issue where templates wouldn't work on Linux due to case sensitivity
* Fixed visual issues with textbox and autocomplete (#2419)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-40)
Platform
* Published folders now set the Cache-Control and Last-Modified headers
* Fixed an issue with creating and edit roles in the admin console (#2563)
* Fixed a concurrency issue with $Cache scope (#2564)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.0.7-7-17-2023)
4.0.7 - 7/17/2023
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-41)
Automation
* Fixed an issue where the Run Script button could throw a JavaScript error in the admin console
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-41)
Platform
* Fixed an issue where the role selector would not populate in some circumstances in the admin console (#2545)
* Fixed an issue where environments would disappear if clicking cancel in manual git sync when no environments.ps1 file was defined.
* Fixed an issue where read only items (PSUHeader) would be recreated when adding new items to the same config file (#2454)
* Fixed an issue where read only items would have edit and delete buttons in the admin console
* Updated to Microsoft.Identity.Client 4.54.1 to support Pnp.PowerShell 2.2.0
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.0.6-7-11-2023)
4.0.6 - 7/11/2023
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-42)
Platform
* Fixed an issue where X-Forwarded headers were not processed correctly by the Kestrel server when a remote reverse proxy was used.
* Added -LogGroomDays to Set-PSUSetting
* Fixed an issue where log messages would not be groomed properly
* Fixed an issue where the LiteDB database could become corrupt after some time when running in Azure using Azure File Shares.
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-35)
Apps
* Fixed an issue where -Height on New-UDCodeEditor wouldn't have an affect (#2525)
* Adding md to Size to New-UDIcon (#2528)
* Fixed an issue with -Options in New-UDChartJS wouldn't apply properly
* Fixed an issue where saving an app page would return a 500 error (#2531)
* Fixed an issue that was causing the App Live Docs to display an error toast on some pages.
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.0.5-7-6-2023)
4.0.5 - 7/6/2023
-------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-42)
Automation
* Fixed an issue with One Time schedules and boolean parameters
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-43)
Platform
* Fixed an issue with PSModulePath in external PowerShell hosts.
* Fixed an issue where Format On Save would throw an exception when removing the last item in a collection
* Fixed an issue starting external PowerShell processes when running as Local System and no alternate credentials are specified.
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.0.4-7-4-2023)
4.0.4 - 7/4/2023
-------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-36)
Apps
* Fixed an issue where Get-UDPage wouldn't work on Linux
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-43)
Automation
* Fixed an issue where running scripts as alternate users could result in an error about Out-PSUPipeline not being found.
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-44)
Platform
* Fixed an issue where the logging system would fail to initialize if the SystemLogPath value was not set.
* Fixed an issue where running processes as alternate users would require the SeTcbPrivilege in some environments (#2521)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.0.3-7-2-2023)
4.0.3 - 7/2/2023
-------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-37)
Apps
* Fixed an issue where New-UDChartJS would not fill a line chart when a dataset was used by default
* Fixed an issue where the page editor would jump to the top on save (#2502)
* Fixed an issue where custom FavIcon would not load from URLs
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-44)
Automation
* Fixed an issue where Invoke-PSUScript did not work with SecureStrings.
* Fixed an issue where the System Default time zone would cause One-Time schedules to display the wrong time in the admin console (#2495)
* Fixed an issue where unauthenticated event hubs would not connect properly
* Fixed an issue where terminals could not be started when One-Way git sync was enabled (#2504)
* Fixed an issue where schedules could not be deleted
* Fixed an issue where One-Time schedules created with New-PSUSchedule would have parameters double serialized (#2500)
* Fixed an issue where the Job Diagnostics button wouldn't redirect to the correct page in a nested site (#2506)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-45)
Platform
* Fixed an issue where navigating to the PowerShell Universal Modules list would throw a JavaScript error on the modules page.
* Cookies are now prefixed with the base URL to allow for different sessions to the same host running multiple PSU instances
* Fixed an issue with creating logging targets in the admin console
* Fixed an issue where loading multiple apps from a module would fail and only load the first app (#2511)
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.0.2-6-25-2023)
4.0.2 - 6/25/2023
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apis-26)
APIs
* Fixed concurrency issues when adding or removing APIs
* Fixed an issue where API docs would not work if authentication was enabled but no roles were defined.
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-45)
Automation
* Fixed an issue where Job Handshake Timeout was not being set properly (#2476)
* Fixed an issue with editing scripts with tags (#2489)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-38)
Apps
* Button shouldn't default text to button (#2468)
* Fixed an issue where the code editor would switch to light theme when updated (#2477)
* Fixed an issue where the code editor wouldn't resize when the window resized (#2478)
* Fixed an issue where autocomplete would break once a value was selected and navigated away when using name\\value in New-UDAutoCompleteOption
* Fixed an issue where the default ChartJS line chart wasn't filled or have any tension applied to the line
* Fixed an issue where New-UDLink -Children would not render properly (#2490)
* Removed default card title and text
* Designer: Fixed an issue where the code view wouldn't display anything
* Designer: Fixed an issue where editing an icon would throw a JavaScript error
* Designer: Fixed an issue where the component resize handles were not visible in dark mode
* Designer: Added fields for component positioning.
* Designer: General fixes and improvements to the property and layout editor
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#pages-3)
Pages
* Fixed an issue where pages would not display correctly.
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-46)
Platform
* Fixed an issue where external app token validation did not work.
* Fixed an issue where Set-PSUVariable would not update secret values (#2475)
* Rolled back a change that set the PSModulePath on startup that was causing unexpected behavior
* Fixed an issue where git mode would always be Manual if configured from appsettings.json
* Fixed an issue where the heartbeat job would retry indefinitely in the event of a failure and fill up the hangfire job queue
* Fixed an issue where the roles drop down was empty (#2483)
* Fixed an issue where searching for modules would throw an exception in the admin console
* Fixed an issue where the module action buttons were obscured by the module name
* Added support for specifying a license via environment variable
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.0.1-6-14-2023)
4.0.1 - 6/14/2023
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-39)
Apps
* Fixed an issue where ChartJS would not display data properly (#2463)
* Fix small size for switch (#2354)
* Fixed an issue where apps with -Component parameters would not load properly (#2458)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-46)
Automation
* Fixed an issue with viewing scripts in folders (#2418)
* Fixed an issue with folders when a module was installed via the admin console
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-47)
Platform
* Fixed an issue where log entry time stamps were not displayed correctly (#2460)
* Fixed an issue where Demo mode wouldn't display the default dashboard correctly (#2461)
* SameSite=None cookies are now optional
* Fixed an issue where accessing PSU remotely would not work with some browsers
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#id-4.0.0-6-13-2023)
4.0.0 - 6/13/2023
---------------------------------------------------------------------------------------------------------------
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#api-3)
API
* API endpoint documentation now only shows endpoints the user has access to (#363)
* Added Event Hubs
###
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#apps-40)
Apps
* Replaced react-tooltip with MUI tooltip
* Added -Sx, -Arrow, -FollowCursor, -EnterDelay, -LeaveDelay to New-UDTooltip
* Removed -Type and -Effect from New-UDTooltip
* Added -Truncate to New-UDTypography
* Added New-UDBreadcrumbs (#2150)
* Added support for validation, help text and display messages to New-UDForm -Script (#2043)
* Added -ShowBackButton to New-UDForm -Script (#2044)
* Added -ShowSearch to New-UDTransferList (#2340)
* Fixed an issue where $EventData -OnEdit in New-UDDataGrid would be a string (#2071, #2070, #1978)
* Removed -PopOut from New-UDExpansionPanelGroup (#2373)
* Fixed -Type Accordion on New-UDExpansionPanelGroup (#2373)
* Removed New-UDCodeEditor -Autoresize and set the default to autoresize (#2146)
* Added -Dense to New-UDAlert (#2214)
* Added New-UDButtonGroup and New-UDButtonGroupItem (#2180)
* Added -HelperText to New-UDTextbox (#2285)
* Added -OnChange to New-UDTextbox (#2287)
* Added -Content and Content parameter set to New-UDIcon (#640)
* Added New-UDHelmet
* Added GitHub-Flavored Markdown to New-UDMarkdown
* Added App Designer
* Added Test-UDConnected
* Added -NoData to New-UDTableTextOption (#2112)
* Added -JustifyContent to New-UDStack (#2189)
* Added the ability to disable session time out (#296)
* Added -Width and -Height to New-UDTransferList (#1452)
* Added New-UDDataGridColumn (#2258)
* Added Out-UDDataGridData (#2266)
* Added New-UDSpeedDial and New-UDSpeedDialAction (#2157)
* Added -Dense to New-UDList (#2300)
* Added -Dense to New-UDAlert (#2214)
* Added New-UDButtonGroup and New-UDButtonGroupItem (#2180)
* Added -HelperText to New-UDTextbox (#2285)
* Added -OnChange to New-UDTextbox (#2287)
* Apps now start asynchronously on server startup
* Fixed issue with New-UDAppBar -Footer (#2176)
* Remove support for Universal Dashboard Marketplace
* Renamed Dashboards to Apps
* Theme is now persisted per app (#2156)
* Fixed an issue where New-UDListItem -Label couldn't be a number (#2107)
* Added cursor pointer to Nivo charts with onClick handlers
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#automation-47)
Automation
* Breaking: One Time schedules are no longer written to schedules.ps1
* Added support for SecureString parameters (#1467)
* Added support for markdown in script descriptions (#2128)
* Added -Queue to Invoke-PSUScript
* Added support for IValidateSetValuesGenerator (#472)
* Script page now uses tabs for each section (#551)
####
[](https://docs.powershelluniversal.com/v4-beta/changelogs/changelog#platform-48)
Platform
* Added support for nested roles (#2442)
* Added Claim Type and Value autocomplete (#2201)
* Added Roles to secret variables (#2350)
* Added support for setting the Content-Security-Policy header (#2395)
* Added support for wildcard subdomains in CORS (#2408)
* Added --appsettings and --windowTitle to desktop mode
* Added buttons to run, clear and refresh health checks.
* Added -HideRunOn and -HideEnvironment to Set-PSUSetting (#2294)
* Added -Truncate Disables text wrapping and adds ellipsis for overflow (#2332)
* Fixed an issue where docker images would not run properly (#2359)
* Added groom job health check (#1839)
* Added export button for logs (#2318)
* Added Database (LiteDB and SQL), UDP, TCP and HTTP logging targets
* Added log viewer in admin console
* Added PSScriptAnalyzer and forwardWindowsAuthToken health checks
* Added -Reset to Sync-PSUConfiguration
* Added Suspend-PSUFileWatcher and Resume-PSUFileWatcher
* Added -Module, -Command to New-PSUApp
* Added -Module, -Command to New-PSUScript
* Added -Module, -Command to New-PSUEndpoint
* Added support for loading resources from modules.
* Added Health Checks
* Added LastUsed property to AppTokens (#2173)
* Added -LogoutUrl to OIDC (#764)
* Added -Credential to Environments (#1683)
* Added middleware.ps1
* Added logging header (#2286)
* Updated to PowerShell 7.3.1
* Updated to .NET 7.0.102
* Removed PowerShell Protect support.
* Removed templates
[PreviousSQL Data Grid](https://docs.powershelluniversal.com/v4-beta/samples/apps/sql-data-grid)
[NextExtension Changelog](https://docs.powershelluniversal.com/v4-beta/changelogs/extension-changelog)
Last updated 13 days ago
Was this helpful?
---
# Video Library | PowerShell Universal
[](https://docs.powershelluniversal.com/video-library#agents)
Agents
-------------------------------------------------------------------------
* [Sending Events](https://youtu.be/BK7XvIMnVss)
[](https://docs.powershelluniversal.com/video-library#automation)
Automation
---------------------------------------------------------------------------------
* [Script Parameters](https://youtu.be/iIlcc9Jhejs)
* [Inline Debugger](https://youtu.be/gteP8BpZj84)
[](https://docs.powershelluniversal.com/video-library#git)
Git
-------------------------------------------------------------------
* [Development and Production Environments](https://youtu.be/YFD-bIMUf10)
[](https://docs.powershelluniversal.com/video-library#hosting)
Hosting
---------------------------------------------------------------------------
* [Azure](https://youtu.be/tHB8hqvHhlU)
[](https://docs.powershelluniversal.com/video-library#platform)
Platform
-----------------------------------------------------------------------------
* [Module](https://youtu.be/tWHwcDXlKdY)
* [Variables](https://youtu.be/u06v9t7pkfg)
[](https://docs.powershelluniversal.com/video-library#portal)
Portal
-------------------------------------------------------------------------
* [Assigning Scripts to the Portal](https://youtu.be/sna8La-hrDs)
* [Script Forms and Tables](https://youtu.be/JV6GPD3dJZ0)
[PreviousGet Started](https://docs.powershelluniversal.com/get-started)
[NextAdditional Resources](https://docs.powershelluniversal.com/additional-resources)
Last updated 3 months ago
Was this helpful?
---
# Get Started | PowerShell Universal
[](https://docs.powershelluniversal.com/get-started#install-powershell-universal)
Install PowerShell Universal
-------------------------------------------------------------------------------------------------------------------
You'll need to install the PowerShell Universal server. [There are a lot of ways to do so,](https://docs.powershelluniversal.com/getting-started)
but you can use the command line below to get started quickly:
Windows
[](https://docs.powershelluniversal.com/get-started#tab-windows)
Linux
[](https://docs.powershelluniversal.com/get-started#tab-linux)
Mac OS X
[](https://docs.powershelluniversal.com/get-started#tab-mac-os-x)
Raspberry PI OS
[](https://docs.powershelluniversal.com/get-started#tab-raspberry-pi-os)
You can install PowerShell Universal as a service. Ensure that PowerShell is running as administrator, or the service won't install correctly.
Copy
Install-Module Universal
Install-PSUServer
You can install PowerShell Universal using the following shell script:
Copy
Install-Module Universal
Install-PSUServer
You can install PowerShell Universal using the Universal PowerShell module:
Copy
Install-Module Universal
Install-PSUServer -AddToPath
Start-PSUServer -Port 5000
Copy
wget https://imsreleases.blob.core.windows.net/universal/production/2.4.0/Universal.linux-arm.2.4.0.zip
unzip Universal.linux-arm.2.3.2.zip -d ./PSU
chmod +x ./PSU/Universal.Server
./PSU/Universal.Server
[](https://docs.powershelluniversal.com/get-started#open-powershell-universal)
Open PowerShell Universal
-------------------------------------------------------------------------------------------------------------
By default, PowerShell Universal runs on port 5000 of localhost.
###
[](https://docs.powershelluniversal.com/get-started#first-run-wizard)
First Run Wizard
The first run wizard will step you through the basic settings of PowerShell Universal. This includes the default admin username and password, security settings, telemetry settings and license.
####
[](https://docs.powershelluniversal.com/get-started#admin-account)
Admin Account
The admin account is used to login to PowerShell Universal. It will display a warning if the password does not match the complexity requirements. You can always change it later.
####
[](https://docs.powershelluniversal.com/get-started#security-settings)
Security Settings
Select from the drop down of security settings. They tweak certain features of PowerShell Universal in different levels of security. If you plan on cloning from a git repository, skip this step or set it to default.
####
[](https://docs.powershelluniversal.com/get-started#telemetry)
Telemetry
PowerShell Universal can [send anonymous telemetry data](https://docs.powershelluniversal.com/platform/telemetry)
if you opt-in to do so. If you plan to clone from a git repository, skip this setting.
####
[](https://docs.powershelluniversal.com/get-started#license)
License
Add your license file. This is optional and needs to be an account-based license key.
[](https://docs.powershelluniversal.com/get-started#create-an-api)
Create an API
-------------------------------------------------------------------------------------
APIs allow you to call PowerShell scripts over HTTP. To create an API, click API \\ Endpoints and click Create New Endpoint. Specify a URL.
Next, click details on your new API and enter the following command into the editor:
Copy
Get-ComputerInfo
Save the script and then click the Execute button to test it out.
You can also execute the API via `Invoke-RestMethod`.
Copy
PS C:\Users\adamr> Invoke-RestMethod http://localhost:5000/hello-world
WindowsBuildLabEx : 22000.1.amd64fre.co_release.210604-1628
WindowsCurrentVersion : 6.3
WindowsEditionId : Professional
WindowsInstallationType : Client
WindowsInstallDateFromRegistry : 8/6/2021 4:05:12 PM
WindowsProductId : 00330-52452-93139-AAOEM
WindowsProductName : Windows 10 Pro
WindowsRegisteredOrganization :
[](https://docs.powershelluniversal.com/get-started#create-a-script)
Create a Script
-----------------------------------------------------------------------------------------
To create a script, click Automation \\ Scripts and then click Create New Script.
Enter the following script into the editor and save:
Copy
Read-Host "What should I say?"
1..100 | ForEach-Object {
Write-Progress -PercentComplete $_ -Activity "Processing..."
}
Get-Service
Once the script is saved, click Run.
[](https://docs.powershelluniversal.com/get-started#create-an-app)
Create an App
-------------------------------------------------------------------------------------
To create a new PowerShell-based user interface (app), you can click User Interfaces \\ Apps and then Create New App.
After clicking Ok, click the Details button to edit the PowerShell script. Add the following script to the editor:
Copy
New-UDApp -Title "Hello, World!" -Content {
New-UDButton -Text "Click Me" -OnClick {
Show-UDToast -Message 'Success!!'
}
}
Save the app, click the Restart button and then click the View button. Click the Click Me button.
Learn more about the various features of PowerShell Universal:
* [APIs](https://docs.powershelluniversal.com/api/about)
* [Automation](https://docs.powershelluniversal.com/automation/about)
* [Apps](https://docs.powershelluniversal.com/apps/building-dashboards)
[PreviousWhat's New in v5?](https://docs.powershelluniversal.com/whats-new-in-v5)
[NextVideo Library](https://docs.powershelluniversal.com/video-library)
Last updated 6 months ago
Was this helpful?
---
# Additional Resources | PowerShell Universal
[](https://docs.powershelluniversal.com/additional-resources#blog)
[Blog](https://blog.ironmansoftware.com/tags/powershelluniversal/)
-------------------------------------------------------------------------------------------------------------------------------------------
The Ironman Software blog has articles about PowerShell Universal.
[](https://docs.powershelluniversal.com/additional-resources#demo)
[Demo](https://demo.powershelluniversal.com/)
----------------------------------------------------------------------------------------------------------------------
Demo instance of PowerShell Universal.
[](https://docs.powershelluniversal.com/additional-resources#discord)
[Discord](https://discord.gg/Sb5ngcjkj4)
--------------------------------------------------------------------------------------------------------------------
Chat with other PowerShell Universal users.
[](https://docs.powershelluniversal.com/additional-resources#downloads)
[Downloads](https://ironmansoftware.com/downloads)
--------------------------------------------------------------------------------------------------------------------------------
Download the latest version of PowerShell Universal.
[](https://docs.powershelluniversal.com/additional-resources#forums)
[Forums](https://forums.ironmansoftware.com/)
------------------------------------------------------------------------------------------------------------------------
Connect with the PowerShell Universal community.
[](https://docs.powershelluniversal.com/additional-resources#issue-tracker)
[Issue Tracker](https://github.com/ironmansoftware/issues)
--------------------------------------------------------------------------------------------------------------------------------------------
File a bug report or feature request for PowerShell Universal.
[](https://docs.powershelluniversal.com/additional-resources#pricing)
[Pricing](https://ironmansoftware.com/pricing/powershell-universal)
-----------------------------------------------------------------------------------------------------------------------------------------------
Purchase a license for the features of PowerShell Universal.
[](https://docs.powershelluniversal.com/additional-resources#scripts)
[Scripts](https://github.com/ironmansoftware/scripts)
---------------------------------------------------------------------------------------------------------------------------------
Examples and full solutions for PowerShell Universal.
[PreviousVideo Library](https://docs.powershelluniversal.com/video-library)
[NextInstallation](https://docs.powershelluniversal.com/getting-started)
Last updated 3 months ago
Was this helpful?
---
# Installation | PowerShell Universal
[](https://docs.powershelluniversal.com/getting-started#msi-install-windows)
MSI Install (Windows)
-------------------------------------------------------------------------------------------------------
The MSI install creates a PowerShell Universal service. By default, PowerShell Universal listens on port 5000. You can navigate to `http://localhost:5000`
MSI downloads are available on our [download page](https://ironmansoftware.com/downloads)
.
System installs run as a Windows service. User installs run when the user logs in to the machine. The user install runs in the user's context.
###
[](https://docs.powershelluniversal.com/getting-started#msi-parameters)
MSI Parameters
The following table contains the parameters you can specify if running `msiexec` against our MSI install for automation purposes:
Parameter
Description
Default Value
INSTALLFOLDER
The installation folder for PowerShell Universal
%ProgramFiles(x86)%\\Universal
TCPPORT
The TCP port the HTTP server will be listening on.
5000
REPOFOLDER
The repository folder to save the configuration files to.
%ProgramData%\\UniversalAutomation\\Repository
CONNECTIONSTRING
The SQL, SQLite, or PostgreSQL connection string.
Data Source=%ProgramData%\\UniversalAutomation\\database.db
DATABASETYPE
SQL, SQLite, or PostgreSQL
SQLite
STARTSERVICE
Whether to start the service after install (0 or 1)
1
SERVICEACCOUNT
The service account to set for the Windows service. Use the format of domain\\username.
None
SERVICEACCOUNTPASSWORD
The service account password to set for the Windows Service. The password will be masked with \*\*\*'s in the installer log.
None
TELEMETRY
Anonymous telemetry collection
0
ADDPSMODULEPATH
Adds the PowerShell Universal module directory to the PSModulePath environment variable.
1
STARTSERVICE
Whether to start the service after install.
1
INSTALLTYPE
Whether to perform a server or user install.
Server
###
[](https://docs.powershelluniversal.com/getting-started#example)
Example
The example below shows how to run `msiexec.exe` to install PowerShell Universal and provide parameters to the installer:
Copy
Start-Process msiexec.exe -ArgumentList "/I C:\Users\adamr\Downloads\PowerShellUniversal.5.5.2.msi /q /norestart /L*V `"C:\users\adamr\desktop\msi.log.txt`" STARTSERVICE=0 SERVICEACCOUNT=contoso\service_account SERVICEACCOUNTPASSWORD=ThisPasswordWillBeReplacedWithAsterisksInTheMSILogs" -Wait -NoNewWindow
[](https://docs.powershelluniversal.com/getting-started#zip-install)
ZIP Install
-------------------------------------------------------------------------------------
You can also download the ZIP from our [Downloads page](https://ironmansoftware.com/downloads/)
if you would like to xcopy deploy the files on Windows or Linux.
###
[](https://docs.powershelluniversal.com/getting-started#windows)
Windows
You can start Universal by unzipping the contents, unblocking the files and then executing `Universal.Server.exe`.
Copy
Expand-Archive -Path .\Universal.zip -DestinationPath .\Universal
Get-ChildItem .\Universal -Recurse | Unblock-File
Start-Process .\Universal\Universal.Server.exe
###
[](https://docs.powershelluniversal.com/getting-started#linux)
Linux
You can use the following command line on Linux to install and start PowerShell Universal:
Copy
wget https://imsreleases.blob.core.windows.net/universal/production/5.5.2/Universal.linux-x64.5.2.1.zip
sudo apt install unzip
unzip Universal.linux-x64.5.5.2.zip -d PSU
chmod +x ./PSU/Universal.Server
./PSU/Universal.Server
[](https://docs.powershelluniversal.com/getting-started#linux-service)
Linux Service
-----------------------------------------------------------------------------------------
You can use `systemd` to start PowerShell Universal as a service. The below script is an example of downloading a version of PowerShell Universal and installing it as a service:
Copy
# ----
# This script will install PowerShell Universal on Linux as a service
# This has been tested on Ubuntu 20.04 (ARM64) on a Raspberry Pi 4
# ----
# Dependencies:
# wget
# unzip
#
# Make sure they are installed
# ----
# These are used to derive the download URL
PSU_VERSION="5.5.2" # Change this to the current version
PSU_ARCH="arm64" # Change this to your desired architecture
PSU_FILE="Universal.linux-${PSU_ARCH}.${PSU_VERSION}.zip"
PSU_URL="https://imsreleases.blob.core.windows.net/universal/production/${PSU_VERSION}/${PSU_FILE}"
# These are used for installing PowerShell Universal
# If you'd like to use a different path, change this
PSU_PATH="/opt/psuniversal"
PSU_EXEC="${PSU_PATH}/Universal.Server"
# These are for installing it as a service
PSU_SERVICE="psuniversal"
PSU_USER="psuniversal"
# ----
# BEGIN
# ----
echo "Creating $PSU_PATH and granting access to $USER"
sudo mkdir $PSU_PATH
sudo setfacl -m "u:${USER}:rwx" $PSU_PATH
echo "Creating user $PSU_USER and making it the owner of $PSU_PATH"
sudo useradd $PSU_USER -m
sudo chown $PSU_USER -R $PSU_PATH
echo "Downloading PowerShell Universal $PSU_VERSION ($PSU_ARCH)"
wget -q $PSU_URL -O $PSU_FILE
echo "Extracting $PSU_FILE to $PSU_PATH"
unzip -o -qq $PSU_FILE -d $PSU_PATH
echo "Make $PSU_EXEC executable"
sudo chmod +x $PSU_EXEC
echo "Creating service configuration"
cat <
~/$PSU_SERVICE.service
[Unit]
Description=PowerShell Universal
[Service]
ExecStart=$PSU_EXEC
SyslogIdentifier=psuniversal
User=$PSU_USER
Restart=always
RestartSec=5
[Install]
WantedBy=multi-user.target
EOF
echo "Creating and starting service"
sudo cp -f ~/$PSU_SERVICE.service /etc/systemd/system
sudo systemctl daemon-reload
sudo systemctl enable $PSU_SERVICE
sudo systemctl start $PSU_SERVICE
sudo systemctl status $PSU_SERVICE --no-pager
# If you don't use UFW, you can comment this out
echo "Allow port 5000/tcp"
sudo ufw allow 5000/tcp
# ----
# END
# ----
[](https://docs.powershelluniversal.com/getting-started#powershell-module)
PowerShell Module
-------------------------------------------------------------------------------------------------
You can use the PowerShell Universal PowerShell module to install the Universal server. To install the module, use `Install-Module`.
Copy
Install-Module Universal
To install the Universal server, you can use `Install-PSUServer`.
Copy
Install-PSUServer -LatestVersion
Running this command on Windows creates and starts a Windows service on your machine. Running this command on Linux creates and starts a systemd service on your machine. Running this command on Mac OS downloads and extracts the PowerShell Universal server.
[](https://docs.powershelluniversal.com/getting-started#docker)
Docker
---------------------------------------------------------------------------
See the [Docker page](https://docs.powershelluniversal.com/getting-started/docker#installation)
.
[](https://docs.powershelluniversal.com/getting-started#iis-install)
IIS Install
-------------------------------------------------------------------------------------
Please visit the [IIS hosting documentation](https://docs.powershelluniversal.com/config/hosting/hosting-iis)
for information on how to configure PowerShell Universal as an IIS website.
[](https://docs.powershelluniversal.com/getting-started#antivirus-configuration)
Antivirus Configuration
-------------------------------------------------------------------------------------------------------------
PowerShell Universal takes full advantage of PowerShell and the PowerShell SDK. It includes PowerShell scripts directly in the product. Consider configuring antivirus to allow execution of PowerShell scripts in PowerShell Universal.
###
[](https://docs.powershelluniversal.com/getting-started#directories)
Directories
The following directories contain examples from a standard Windows system of scripts and executable files that you may need to exclude from antivirus checks. Changing paths within appsettings.json or within the installer requires changing which directories are excluded.
Path
Description
%ProgramData%\\PowerShellUniversal
Contains log files and appsettings.json
%ProgramData%\\UniversalAutomation
Contains PowerShell scripts and artifacts. Contains the single file database when not using SQL integration.
%ProgramFiles(x86)\\Universal
Contains PowerShell Universal application executables, libraries and modules.
###
[](https://docs.powershelluniversal.com/getting-started#executables)
Executables
It may be necessary to exclude certain executables that run PowerShell scripts. The below is a list of executables that run PowerShell from PowerShell Universal.
Name
Description
Universal.Server.exe
The PowerShell Universal core service.
PowerShellUniversal.Host.exe
The PowerShell Universal host environment executable.
pwsh.exe
PowerShell 7.x
PowerShell.exe
PowerShell 5.x
[](https://docs.powershelluniversal.com/getting-started#default-admin-name-and-password)
Default Admin Name and Password
-----------------------------------------------------------------------------------------------------------------------------
You can use the `$ENV:PSUDefaultAdminName` and `$ENV:PSUDefaultAdminPassword` environment variables to change this behavior. These values are only used if no administrator account already exists. This is useful for cloud-based installations.
[](https://docs.powershelluniversal.com/getting-started#agent)
Agent
-------------------------------------------------------------------------
The PowerShell Universal Agent executes Event Hub actions. Install it depending on your environment:
###
[](https://docs.powershelluniversal.com/getting-started#windows-msi)
Windows (MSI)
The PowerShell Universal Agent MSI is on our download page. After installing the MSI, a PowerShell Universal Agent service runs on your machine. [Configure it](https://docs.powershelluniversal.com/api/event-hubs)
to connect to PowerShell Universal.
###
[](https://docs.powershelluniversal.com/getting-started#zip)
ZIP
ZIP files for each platform we support are on our downloads page. Each ZIP contains a `PowerShellUniversal.Agent.exe` or `PowerShellUniversal.Agent` file that can start an agent. Run the process as a service for it to start whenever the machine reboots.
[](https://docs.powershelluniversal.com/getting-started#next-steps)
Next Steps
-----------------------------------------------------------------------------------
At this point, Universal is up and running. Visit `http://localhost:5000` or your default port to navigate to the admin console. Log in with the default admin name and password or create a default admin account.
[PreviousAdditional Resources](https://docs.powershelluniversal.com/additional-resources)
[NextDocker](https://docs.powershelluniversal.com/getting-started/docker)
Last updated 3 months ago
Was this helpful?
---
# Docker | PowerShell Universal
[](https://docs.powershelluniversal.com/getting-started/docker#docker)
Docker
----------------------------------------------------------------------------------
###
[](https://docs.powershelluniversal.com/getting-started/docker#confirming-docker-is-installed-correctly)
Confirming Docker is installed correctly
> **NOTE:** Apple M1 devices: At the time of writing there are some issues on Apple M1 devices and, some ARM64/ARMv8 devices. Please review [this forum thread](https://forums.ironmansoftware.com/t/docker-image-not-working/8781/15)
> before proceeding.
####
[](https://docs.powershelluniversal.com/getting-started/docker#docker-1)
Docker
Run the following command to confirm Docker is installed:
Copy
docker version
Example Output:
Copy
Client: Docker Engine - Community
Version: 23.0.1
API version: 1.42
Go version: go1.19.5
Git commit: a5ee5b1
Built: Thu Feb 9 19:47:01 2023
OS/Arch: linux/amd64
Context: default
Server: Docker Engine - Community
Engine:
Version: 23.0.1
API version: 1.42 (minimum version 1.12)
Go version: go1.19.5
Git commit: bc3805a
Built: Thu Feb 9 19:47:01 2023
OS/Arch: linux/amd64
Experimental: false
containerd:
Version: 1.6.18
GitCommit: 2456e983eb9e37e47538f59ea18f2043c9a73640
runc:
Version: 1.1.4
GitCommit: v1.1.4-0-g5fd4c4d
docker-init:
Version: 0.19.0
GitCommit: de40ad0
####
[](https://docs.powershelluniversal.com/getting-started/docker#docker-compose)
Docker Compose
Docker Compose v1 uses the command `docker-compose`. As of June 2023, support ends for Docker Compose v1.
Docker Compose v2 uses the command `docker compose`.
If you are using Docker Compose v1 please adjust the commands accordingly. More information on Docker Compose can be found [here](https://docs.docker.com/compose/)
.
Run one of the following commands to confirm that Docker Compose is installed:
Docker Compose v1:
Copy
docker-compose version
Docker Compose v2:
Copy
docker compose version
Example Output:
Copy
Docker Compose version v2.16.0
####
[](https://docs.powershelluniversal.com/getting-started/docker#a-docker-hello-world)
A Docker Hello-World
To ensure that Docker has the ability to pull and run container images run the following command:
Copy
docker run hello-world
Example Output:
Copy
Unable to find image 'hello-world:latest' locally
latest: Pulling from library/hello-world
2db29710123e: Pull complete
Digest: sha256:ffb13da98453e0f04d33a6eee5bb8e46ee50d08ebe17735fc0779d0349e889e9
Status: Downloaded newer image for hello-world:latest
Hello from Docker!
This message shows that your installation appears to be working correctly.
To generate this message, Docker took the following steps:
1. The Docker client contacted the Docker daemon.
2. The Docker daemon pulled the "hello-world" image from the Docker Hub.
(amd64)
3. The Docker daemon created a new container from that image which runs the
executable that produces the output you are currently reading.
4. The Docker daemon streamed that output to the Docker client, which sent it
to your terminal.
To try something more ambitious, you can run an Ubuntu container with:
$ docker run -it ubuntu bash
Share images, automate workflows, and more with a free Docker ID:
https://hub.docker.com/
For more examples and ideas, visit:
https://docs.docker.com/get-started/
###
[](https://docs.powershelluniversal.com/getting-started/docker#installation)
Installation
###
[](https://docs.powershelluniversal.com/getting-started/docker#using-the-pre-built-container)
Using the pre-built Container
In order to run PowerShell Universal, use the provided container image. The docker image is available on [Docker Hub](https://hub.docker.com/r/ironmansoftware/universal)
.
The prebuilt version supports both free & paid features of PowerShell Universal.
Start the container by pulling the image and then running a container with the default port bound.
####
[](https://docs.powershelluniversal.com/getting-started/docker#running-a-basic-image)
Running a basic image
Copy
docker pull ironmansoftware/universal
docker run --name 'PSU' -it -p 5000:5000 ironmansoftware/universal
####
[](https://docs.powershelluniversal.com/getting-started/docker#present-an-image-to-a-different-port)
Present an image to a different port
If port 5000 is unavailable on your host, switch to another port.
e.g. Present on port 80
Copy
docker pull ironmansoftware/universal
docker run --name 'PSU' -it -p 80:5000 ironmansoftware/universal
####
[](https://docs.powershelluniversal.com/getting-started/docker#mount-a-volume)
Mount a volume
The `docker run` command allows you to mount a volume for persistent storage. Mount the volume to the /root folder.
**Mount a volume on container in Windows**
The following command mounts the folder `C:\docker\volumes\PSU` to `/root` on your container:
Copy
docker pull ironmansoftware/universal
docker run --name 'PSU' -it -p 5000:5000 -v C:\docker\volumes\PSU:/root ironmansoftware/universal
**Mount a volume on Container on Mac and Linux**
The following command mounts the folder `/docker/volumes/PSU` to `/root` on your container:
Copy
docker pull ironmansoftware/universal
docker run --name 'PSU' -it -p 5000:5000 -v /docker/volumes/PSU:/root ironmansoftware/universal
####
[](https://docs.powershelluniversal.com/getting-started/docker#stopping-a-container)
Stopping a Container
The following command removes a stopped container named `PSU`:
Copy
docker stop PSU
####
[](https://docs.powershelluniversal.com/getting-started/docker#removing-a-container)
Removing a Container
The following command stops a container named `PSU`:
Copy
docker rm PSU
The `--force` flag can remove a running container:
Copy
docker rm --force PSU
###
[](https://docs.powershelluniversal.com/getting-started/docker#docker-compose-1)
Docker Compose
Docker Compose allows you to use a yaml text file to standardize your build and script the deployment (or build) or multiple containers.
The default name for any compose file is `docker-compose.yml`. It is recommended you use this as your compose filename.
####
[](https://docs.powershelluniversal.com/getting-started/docker#creating-a-compose-script-for-windows)
Creating a Compose Script for Windows
The following compose file runs a Powershell Universal container in Windows:
Copy
version: "5.2.1"
services:
PSU:
container_name: PSU
image: ironmansoftware/universal:latest
ports:
- 5000:5000
restart: unless-stopped
environment:
- TZ=Europe/London
volumes:
- C:\docker\volumes\PSU:/root
####
[](https://docs.powershelluniversal.com/getting-started/docker#creating-a-compose-script-for-mac-linux)
Creating a Compose Script for Mac / Linux
The following compose file runs a Powershell Universal container on Mac and Linux:
Copy
version: "5.2.1"
services:
PSU:
container_name: PSU
image: ironmansoftware/universal:latest
ports:
- 5000:5000
restart: unless-stopped
environment:
- TZ=Europe/London
volumes:
- /docker/volumes/PSU:/root
####
[](https://docs.powershelluniversal.com/getting-started/docker#starting-containers-using-compose-scripts)
Starting Containers using Compose Scripts
Using a Terminal shell or PowerShell for Windows. Use the cd command to change the working directory with your `docker-compose.yml` script.
Run the following command:
Copy
docker compose up -d
Example Output:
Copy
Creating network "PSU_default" with the default driver
Pulling PSU (ironmansoftware/universal:latest)...
latest: Pulling from ironmansoftware/universal
7608715873ec: Pull complete
4e66273c6cfb: Pull complete
2649c52300c2: Pull complete
a20175666bc7: Pull complete
65ce93bc0653: Pull complete
Digest: sha256:d7ff98e6197d21070aac325c2efbefa393a4952d2e8ba6b1327dc97824ec4d55
Status: Downloaded newer image for ironmansoftware/universal:latest
Creating PSU ... done
####
[](https://docs.powershelluniversal.com/getting-started/docker#stopping-containers-using-compose-scripts)
Stopping Containers using Compose Scripts
Using a Terminal shell, or PowerShell for Windows. cd to the directory with your `docker-compose.yml` script.
Run the following command
Copy
docker compose down
Example Output:
Copy
[+] Running 2/2
⠿ Container PSU Removed 0.5s
⠿ Network PSU_default Removed 0.4s
####
[](https://docs.powershelluniversal.com/getting-started/docker#using-environment-variables-and-sql-persistence)
Using Environment Variables and SQL Persistence
You can add Environment variables into your Compose Scripts. Below is an example of:
* Setting a node name
* Adding SQL persistence
* Adding a SQL Connection String
Copy
version: "5.2.1"
services:
PSU:
container_name: PSU
image: ironmansoftware/universal:latest
ports:
- 5000:5000
restart: unless-stopped
environment:
- TZ=Europe/London
- Plugins__0=SQL
- Data__ConnectionString=Data Source=sql1.domain.com;Initial Catalog=PSUTicketBridge;User Id=psu_ticketbridge_dbo;Password=Password123;TrustServerCertificate=True;Trusted_Connection=True;integrated security=false;
- NodeName=mynodename
volumes:
- /docker/volumes/PSU:/root
####
[](https://docs.powershelluniversal.com/getting-started/docker#using-environment-variables-and-postgresql-persistence)
Using Environment Variables and PostgreSQL Persistence
You can add Environment variables into your Compose Scripts. Below is an example of:
* Setting a node name
* Adding PostgreSQL persistence
* Adding a PostgreSQL Connection String
Copy
version: "5.2.1"
services:
PSU:
container_name: PSU
image: ironmansoftware/universal:latest
ports:
- 5000:5000
restart: unless-stopped
environment:
- TZ=Europe/London
- Plugins__0=PostgreSQL
- Data__ConnectionString=Host=PGhostname; Database=PGdatabase; User Id=PGusername; Password=PGpassword!;Port=5432
- NodeName=mynodename
volumes:
- /docker/volumes/PSU:/root
###
[](https://docs.powershelluniversal.com/getting-started/docker#building-a-custom-container)
Building a Custom Container
If you wish to build more features, modify, or hardcode Environment Variables into your container, then create a `Dockerfile`
> _**NOTE:**_ Dockerfiles' are case-sensitive and must start with a capital 'D'.
To create a Docker image that can persist the Universal data, create a dockerfile like the one below.
This Dockerfile exposes port 5000, creates a /data volume, sets configuration environment variables to store the Universal repository and database in the volume and then sets the Universal.Server as the entry point to the container.
####
[](https://docs.powershelluniversal.com/getting-started/docker#writing-a-dockerfile-script-for-linux)
Writing a Dockerfile script for Linux
Copy
FROM ironmansoftware/universal:latest
LABEL description="Universal - The ultimate platform for building web-based IT Tools"
EXPOSE 5000
VOLUME ["/home/data"]
ENV Data__RepositoryPath /home/data/Repository
ENV Data__ConnectionString Data Source=/home/data/database.db
ENV UniversalDashboard__AssetsFolder /home/data/UniversalDashboard
ENV Logging__Path /home/data/logs/log.txt
ENTRYPOINT ["./Universal/Universal.Server"]
####
[](https://docs.powershelluniversal.com/getting-started/docker#building-a-container)
Building a container
From the path that hosts your Dockerfile, run the following command:
Copy
docker build . --tag=universal-persistent
####
[](https://docs.powershelluniversal.com/getting-started/docker#windows)
Windows
Copy
FROM ironmansoftware/universal:5.0.0-windowsservercore-1809
LABEL description="Universal - The ultimate platform for building web-based IT Tools"
EXPOSE 5000
VOLUME ["C:/data"]
ENV Data__RepositoryPath C:/data/Repository
ENV Data__ConnectionString Data Source=C:/data/database.db
ENV UniversalDashboard__AssetsFolder C:/data/UniversalDashboard
ENV Logging__Path C:/data/logs/log.txt
ENTRYPOINT ["C:/ProgramData/Universal/Universal.Server.exe"]
Run a build with the build command:
Copy
docker build . --tag=universal-persistent
Start the docker container with the run command and make sure to specify the volume to mount:
Copy
docker run -it --name powershelluniversal --mount source=psudata,target=/home/data --rm -d -p 5000:5000/tcp universal-persistent:latest
####
[](https://docs.powershelluniversal.com/getting-started/docker#sql)
SQL
To use SQL persistence, define the plugin and connection string as follows:
Copy
ENV Data__ConnectionString=Data Source=ServerName; Initial Catalog=DatabaseName; Integrated Security=SSPI;
ENV Plugins:0=SQL
####
[](https://docs.powershelluniversal.com/getting-started/docker#postgresql)
PostgreSQL
To use PostgreSQL persistence, define the plugin and connection string as follows:
Copy
ENV Data__ConnectionString=Host=PGhostname; Database=PGdatabase; User Id=PGusername; Password=PGpassword!;Port=5432
ENV Plugins:0=PostgreSQL
###
[](https://docs.powershelluniversal.com/getting-started/docker#time-zones)
Time Zones
To properly support time zones on Linux when scheduling jobs, include the `tzdata` package in your dockerfile along with an environment variable that specifies the server time zone.
Copy
ENV TZ Europe/Amsterdam
RUN apt-get install -y tzdata
[](https://docs.powershelluniversal.com/getting-started/docker#tags)
Tags
------------------------------------------------------------------------------
We publish the following tags to Docker Hub:
* latest - Current version using Ubuntu LTS
* 5.x-preview-modules - Nightly build of version 5 using Ubuntu LTS and select AZ modules
* 5.x-preview-- - Nightly build of version 5 with the specified OS and PS version
* 4.x-preview-- - Nightly build of version 4 with the specified OS and PS version
* 5.x-- - Production version 5 with the specified OS and PS version
* 5.x-modules - Current production version on Ubuntu LTS with select AZ modules installed
* 4.x-- - Current production version 4 with the specified OS and PS versions
###
[](https://docs.powershelluniversal.com/getting-started/docker#included-modules)
Included Modules
The module container images include the following modules:
* Az.Accounts
* Az.Compute
* Az.KeyVault
* Az.Resources
* Invoke-SqlCmd2
[](https://docs.powershelluniversal.com/getting-started/docker#summary)
Summary
------------------------------------------------------------------------------------
This basic "How to Get Started" enables you to start running or building PSU Containers. This references section links all sources for commands:
[](https://docs.powershelluniversal.com/getting-started/docker#references)
References
------------------------------------------------------------------------------------------
###
[](https://docs.powershelluniversal.com/getting-started/docker#running-containers)
Running Containers
https://docs.docker.com/engine/reference/commandline/run/
https://docs.docker.com/engine/reference/commandline/stop/
https://docs.docker.com/engine/reference/commandline/rm/
https://docs.docker.com/compose/
###
[](https://docs.powershelluniversal.com/getting-started/docker#building-containers)
Building Containers
https://docs.docker.com/engine/reference/commandline/build/
[PreviousInstallation](https://docs.powershelluniversal.com/getting-started)
[NextUpgrade](https://docs.powershelluniversal.com/getting-started/upgrading)
Last updated 6 months ago
Was this helpful?
---
# Uninstall | PowerShell Universal
[](https://docs.powershelluniversal.com/getting-started/uninstall#application-files)
Application Files
-----------------------------------------------------------------------------------------------------------
Depending on how you installed PowerShell Universal, you will need to uninstall the application files.
###
[](https://docs.powershelluniversal.com/getting-started/uninstall#zip-installation)
ZIP Installation
If you installed using a provided ZIP file, you can simply stop the PowerShell Universal process or service and delete the folder you extracted to.
###
[](https://docs.powershelluniversal.com/getting-started/uninstall#msi-installation)
MSI Installation
If you installed with the Windows MSI, uninstall the application from Add\\Remove Programs.
###
[](https://docs.powershelluniversal.com/getting-started/uninstall#module-installation)
Module Installation
The Universal module installs the application files to the following locations by default.
####
[](https://docs.powershelluniversal.com/getting-started/uninstall#windows)
Windows
* `%ProgramData%\PowerShellUniversal`
####
[](https://docs.powershelluniversal.com/getting-started/uninstall#linux-and-mac-os)
Linux and Mac OS
* `%HOME%/.PowerShellUniversal`
[](https://docs.powershelluniversal.com/getting-started/uninstall#configuration-files)
Configuration Files
---------------------------------------------------------------------------------------------------------------
Configuration files are stored in the repository folder. Once you have removed the application files, you can delete the configuration files. They are stored in the following locations by default:
###
[](https://docs.powershelluniversal.com/getting-started/uninstall#windows-1)
Windows
* `%ProgramData%\PowerShellUniversal`
* `%ProgramData%\UniversalAutomation`
###
[](https://docs.powershelluniversal.com/getting-started/uninstall#linux)
Linux
* `%HOME%/.PowerShellUniversal/`
###
[](https://docs.powershelluniversal.com/getting-started/uninstall#mac-os)
Mac OS
* `%HOME%/.PowerShellUniversal/`
###
[](https://docs.powershelluniversal.com/getting-started/uninstall#desktop)
Desktop
* `%AppData%\PowerShellUniversal`
[](https://docs.powershelluniversal.com/getting-started/uninstall#database)
Database
-----------------------------------------------------------------------------------------
Removing the database depends on the database type used.
###
[](https://docs.powershelluniversal.com/getting-started/uninstall#sqlite)
SQLite
SQLite databases are stored in a single file on the file system.
####
[](https://docs.powershelluniversal.com/getting-started/uninstall#windows-2)
Windows
* `%ProgramData%\PowerShellUniversal\database.db`
####
[](https://docs.powershelluniversal.com/getting-started/uninstall#linux-and-mac-os-1)
Linux and Mac OS
* `%HOME%/.PowerShellUniversal/database.db`
###
[](https://docs.powershelluniversal.com/getting-started/uninstall#postgresql-and-sql)
PostgreSQL and SQL
PostgreSQL and SQL databases are stored on your SQL server and will require you to manually remove the database.
[](https://docs.powershelluniversal.com/getting-started/uninstall#iis)
IIS
-------------------------------------------------------------------------------
You need to remove the IIS App Pool and Website when removing PowerShell Universal. Note that App Pools can be shared amongst websites and caution should be taken when doing so.
[PreviousUpgrade](https://docs.powershelluniversal.com/getting-started/upgrading)
[NextDowngrade](https://docs.powershelluniversal.com/getting-started/downgrade)
Last updated 11 months ago
Was this helpful?
---
# Upgrade | PowerShell Universal
[](https://docs.powershelluniversal.com/getting-started/upgrading#overview)
Overview
-----------------------------------------------------------------------------------------
This document will cover the upgrade process for production PowerShell Universal instances. We will cover the following topics.
1. Data Backup
2. Upgrade Process
3. Upgrade Validation
The Universal application binaries can generally be upgraded without having to change the configuration or database manually, but we do recommend backups of production data.
[](https://docs.powershelluniversal.com/getting-started/upgrading#recommendations)
Recommendations
-------------------------------------------------------------------------------------------------------
For production environments, we recommend deploying PowerShell Universal to a staging or development environment prior to major upgrades. This allows for testing before end users are affected. You can use [Development Licenses](https://docs.powershelluniversal.com/licensing#developer-licenses)
to test changes in PowerShell Universal instances without purchasing another license.
[](https://docs.powershelluniversal.com/getting-started/upgrading#id-1.-data-backup)
1\. Data Backup
---------------------------------------------------------------------------------------------------------
PowerShell Universal uses a script-based configuration system alongside a database used for retention of entities such as app tokens, job history and identities. If possible, you will want to backup these items before running an upgrade for easy rollback in case an issue is encountered during validation.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#database)
Database
Backing up the database ensures that all apptokens, job history, identities and database secrets are retained in the case of an upgrade failure. SQL databases also may adjust the schema of the database and may require a rollback of not only the data, but also the schema of the tables in the database.
####
[](https://docs.powershelluniversal.com/getting-started/upgrading#sqlite)
SQLite
By default, PowerShell Universal uses a single file database called SQLite. Unless configured otherwise, the database is stored in `%ProgramData%\UniversalAutomation`. You should have a `database.db` and possibility a `database-log.db`. Both of these files should be backed up. The service must be stopped in order to back up the files.
####
[](https://docs.powershelluniversal.com/getting-started/upgrading#sql)
SQL
When using SQL for persistence, backup the entire database (including schema). There isn't necessarily a need to stop the PowerShell Universal service when backing up the database, but it may continue to write to the database (for example when running scheduled jobs) after the backup has been completed.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#configuration-scripts)
Configuration Scripts
Scripts make up the main configuration data to backup when upgrading a production PowerShell Universal instance. For production, we recommend using a version control system. You can also take advantage of the built-in git integration. If you are using a two-way sync for PowerShell Universal git integration, consider tagging your git branch prior to the upgrade to allow for easy rollback to unexpected changes within the git repository.
[](https://docs.powershelluniversal.com/getting-started/upgrading#id-2.-upgrade-progress)
2\. Upgrade Progress
-------------------------------------------------------------------------------------------------------------------
Below are sections for each type of system upgrade and the steps that you should take based on how you originally installed PSU.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#msi)
MSI
When installing via the MSI, you will want to follow the same backup procedures above.
####
[](https://docs.powershelluniversal.com/getting-started/upgrading#appsettings.json)
appsettings.json
You will want to back up the `appsettings.json` file stored in `%ProgramData%\PowerShellUniversal`. This file contains information such as port, data storage location and other server settings. Typically, the MSI will not make changes to this file once created. It will use the settings found for the upgraded version. That said, if necessary, the MSI will make changes to the appsettings file. These changes are considered breaking and will be listed in the changelog for the release.
####
[](https://docs.powershelluniversal.com/getting-started/upgrading#service-account)
Service Account
When running an MSI upgrade, the PSU service is not uninstalled, and thus, the service account will still be set once the service starts up.
If you perform an uninstall and then an install using the MSI, then the service account will be removed.
####
[](https://docs.powershelluniversal.com/getting-started/upgrading#upgrade-process)
Upgrade Process
Once all the configuration files and the database are backed up, you can run the new MSI installer.
For major upgrades (e.g. v4.3.4 to v5.0.4 etc), you will need to uninstall the previous version prior to running the new version.
The installer may prompt for a restart of the machine if files are locked. The PSU MSI will uninstall all the files in the installation directory and install entirely new files.
Once the MSI has completed, you can navigate to your PowerShell Universal admin console to perform installation validation.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#iis)
IIS
Below you will find information about upgrading an IIS install.
####
[](https://docs.powershelluniversal.com/getting-started/upgrading#web.config)
web.config
In addition to the files listed to backup above, you will also want to consider backing up your `web.config` file. If you have made no changes to this file, you do not need to back it up.
The `web.config` file that is included in the application installation directory will be overwritten during upgrades. If you have moved your web.config file to an alternate location, it will not be overwritten. When creating an IIS website, you can simply include the `web.config` file in the web app's directory and have the [binaries stored in a different location](https://docs.powershelluniversal.com/config/hosting/hosting-iis)
.
####
[](https://docs.powershelluniversal.com/getting-started/upgrading#upgrade-process-1)
Upgrade Process
When upgrading with IIS, you will need to first stop your application pool to ensure that the binaries used by IIS are no longer in use and then replace the binaries with the new ones. To ensure that the upgrade works as expected, it's recommended to delete all the application files and then unzip the new ones into the same directory to avoid assembly conflicts.
As with any installation from a ZIP file, make sure that you run `Get-ChildItem -Recurse | Unblock-File` from an elevated command prompt across the PowerShell Universal files to ensure they can be executed properly.
Once you have copied the new files and unblocked them, start the app pool, navigate to the PowerShell Universal Admin Console and perform installation validation.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#universal-module)
Universal Module
The Universal module can be used to upgrade installations of PowerShell Universal previously installed by the module.
Do not use the Universal module to upgrade instances installed via MSI.
Follow the backup procedures above and then perform the upgrade.
First, upgrade the local PowerShell Universal module and verify the expected version is installed.
Copy
Update-Module Universal
Import-Module Universal -PassThru
Next, run `Update-PSUServer` to download and unzip the new PSU instance.
Copy
Update-PSUServer
After the upgrade is complete, navigate to the PowerShell Universal Admin Console and begin upgrade validation.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#zip)
ZIP
Perform the necessary backup procedures and download the latest ZIP of PowerShell Universal.
Stop the PowerShell Universal service. Delete the existing PowerShell Universal application files. Extract the ZIP files to the same directory. Finally, run `Unblock-File` against the directory to ensure that PSU can execute properly. Always run this command as administrator.
Copy
Get-ChildItem -Recurse | Unblock-File
After the upgrade is complete, navigate to the PowerShell Universal Admin Console and begin upgrade validation.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#database-1)
Database
By default, the PSU service will migrate to the latest database version during the startup process.
The database can also be upgraded before upgrading the application. This is recommended for larger installations that may require some time for the schema update to take place. In some environments, allowing the service to upgrade the database can result in a timeout, like with Service Control Manager in Windows.
If you are using SQL, you can find SQL files generated and placed in the SQL folder within the PSU installation media. Run these scripts against your database before upgrading.
All types of databases support the `psu` command line tool for upgrades.
Copy
psu db schema latest --connection-string "Data Source=C:\ProgramData\UniversalAutomation\database.db"
[](https://docs.powershelluniversal.com/getting-started/upgrading#id-3.-upgrade-validation)
3\. Upgrade Validation
-----------------------------------------------------------------------------------------------------------------------
After running an upgrade, you should perform basic validation against your PSU server to ensure that it is fully functional.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#notifications)
Notifications
Verify that there are no errors within the notification drop down. They may be a sign of issues during the upgrade.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#modules)
Modules
Upgrades to PowerShell Universal may change assembly versions of DLLs shipped with the platform. This can cause other modules to fail to load. While this may not be obvious at first, you may consider taking an inventory of modules used in your platform to ensure that the versions are consistent before and after the upgrade to limit changes.
If you have installed a version of the `Universal` module outside of PowerShell Universal (for example, with `Install-Module`), you must make sure to update the module or it can conflict with the new one installed with PowerShell Universal.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#apps)
Apps
The most common upgrade issues come due to changes in the Universal App framework. Apps can be complex and bug fixes or features can sometimes cause for certain user's app while fixing issues pertaining to another user's app. Please read the changelog before upgrading to understand the impact of changes made to the app framework and consider testing the app with development data before upgrading in production.
[](https://docs.powershelluniversal.com/getting-started/upgrading#nightly-builds)
Nightly Builds
-----------------------------------------------------------------------------------------------------
When using nightly builds, you cannot upgrade from one nightly version to another. You can upgrade from a generally available version to a nightly version. In order to test a new nightly build, you will need to uninstall the current nightly build, rollback the database schema and then install the new version. You can roll back the database schema with `psu.exe` .
Copy
.\psu.exe db schema --schema-version 5.4.0
[](https://docs.powershelluniversal.com/getting-started/upgrading#common-upgrade-issues)
Common Upgrade Issues
-------------------------------------------------------------------------------------------------------------------
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#iis-app-pool-does-not-start-after-upgrade)
IIS App Pool Does Not Start After Upgrade
The most common upgrade issue is that `Unblock-File` is not called properly on the extracted files when performing an upgrade of a IIS ZIP install. Also make sure to run the `Unblock-File` command recursively and from within an administrative session.
Another command issue is extracting the files over the top of the existing files. This can cause assembly conflicts and puts the application in an unknown state. Follow the IIS upgrade documentation and delete the files before extracting them.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#command-not-found-errors)
Command Not Found Errors
When new functionality is added to PowerShell Universal it is typically done using new cmdlets. If older versions of the PowerShell Universal module are installed on the system, it can cause conflicts with the one shipped within the installation media. Ensure that you have removed older versions of the `Universal` module if you encounter these errors.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#table-column-not-found-error-when-using-sql-persistence)
Table\\Column Not Found Error when using SQL Persistence
This can happen if SQL schema upgrades are not being run during upgrades. If you set the `RunMigrations` setting to `false` in `appsettings.json`, you must run the migrations manually or the PowerShell Universal service will not function properly.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#breaking-app-component-change)
Breaking App Component Change
These changes can be visual or functional. Please ensure that you review the changelog for items that may be related to the change you are seeing. Consider posting the forums or opening a GitHub issue to see if the issue is as designed and if there is a viable workaround.
We make the best possible effort to support everyone's' apps without breaking changes. That said, every configuration is pretty unique so we are more than happy to address issues you may encounter. Please, just let us know.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#license-issues-after-upgrade)
License Issues after Upgrade
The licensing model of PowerShell Universal provides licensed users the ability to upgrade to whatever is the newest version as long as they have an active perpetual or subscription license. If you attempt to upgrade a server that is no longer within the license window, the server will not function as expected. You will need to downgrade back to the previous version to restore functionality.
Additionally, you may encounter issues due to the PSU service restart. When the service starts, it verifies license subscription status. If it fails to do so, it may not be licensed properly and cause other issues. The root cause is typically networking issues while attempting to access the IronmanSoftware.com website for activation. Offline license keys do not contact the IMS website for activation and will not encounter this issue.
[](https://docs.powershelluniversal.com/getting-started/upgrading#id-5.0-breaking-changes)
5.0 Breaking Changes
--------------------------------------------------------------------------------------------------------------------
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#removal-of-pages)
Removal of Pages
The drag and drop page designer has been removed in favor of [Portal Pages](https://docs.powershelluniversal.com/portal/portal-pages)
and [Widgets](https://docs.powershelluniversal.com/portal/portal-widgets)
.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#removal-of-app-pages-designer)
Removal of App Pages Designer
The drag and drop page designer for apps has been removed. Apps created with the designer will still function.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#removal-of-access-controls)
Removal of Access Controls
Access Controls have been removed in favor of [Permissions](https://docs.powershelluniversal.com/security/enterprise-security/permissions)
. You can also use the [Portal](https://github.com/ironmansoftware/universal-docs/blob/v5/getting-started/broken-reference/README.md)
to assign resources, like scripts, to users without the need for complicated permissions.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#cmdlet-communication-channel-and-authorization-changes)
Cmdlet Communication Channel and Authorization Changes
Prior to v5, cmdlets would send data over HTTP or by using an internal gRPC channel. Now, all cmdlets use an externally facing gRPC Channel that is protected by authentication and authorization. It no longer uses standard REST API HTTP calls.
This can be a problem for PowerShell Universal instances behind [reverse proxies](https://docs.powershelluniversal.com/config/hosting/reverse-proxy)
and requires that the proper header values are sent.
Please review the [Module](https://docs.powershelluniversal.com/config/module)
documentation for more information.
####
[](https://docs.powershelluniversal.com/getting-started/upgrading#common-cmdlet-errors-you-may-encounter-during-upgrade)
Common cmdlet errors you may encounter during upgrade
####
[](https://docs.powershelluniversal.com/getting-started/upgrading#http-status-code-403)
HTTP Status Code 403
The cmdlet you are calling does not have access to the PowerShell Universal APIs. You will need to specify an -AppToken parameter on the cmdlets in order to use them.
You can also enable the [permissive API security model](https://docs.powershelluniversal.com/config/module#authorization-security-model)
to allow internally called cmdlets from PowerShell Universal without the need for authorization.
####
[](https://docs.powershelluniversal.com/getting-started/upgrading#uri-not-defined)
URI Not Defined
The cmdlets are unable to determine how to call the PowerShell Universal APIs. You will need to either specify a -ComputerName parameter or setup the API URL in appsettings.json.
Copy
{
"API" : {
"URL": "http://localhost:5000"
}
}
####
[](https://docs.powershelluniversal.com/getting-started/upgrading#ssl-certificate-error)
SSL Certificate Error
If you are using a self-signed certificate, you will need to specify the `-TrustCertificate` parameter of the cmdlets.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#powershell-7-environment-no-longer-uses-pwsh.exe)
PowerShell 7 Environment No longer Uses Pwsh.exe
The default PowerShell 7 environment uses a .NET version of Universal.Agent.exe executable running PowerShell 7.5. This allows for the greatest compatibility with PowerShell Universal libraries and other modules.
It's still possible to use the pwsh.exe process in custom environment configurations.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#iis-hosting-package)
IIS Hosting Package
If you are hosting in IIS, ensure that you install the [.NET 9.0 hosting bundle](https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-aspnetcore-9.0.4-windows-hosting-bundle-installer)
.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#integrated-environment-powershell-version)
Integrated Environment PowerShell Version
The integrated environment now uses PowerShell 7.5.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#sqlite-by-default)
SQLite by Default
SQLite is the default persistence method. You will need to perform a manual conversion from LiteDB before installing version 5.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#litedb-support-removed)
LiteDB Support Removed
LiteDB has been removed as a supported database engine. Included with the PowerShell Universal installation files, you will find `psu.exe`. It can be used to convert a LiteDB database into a SQLite database. Use the following command line.
Copy
.\psu.exe db convert --Path "$ENV:ProgramData\UniversalAutomation\database.db"
The tool will create a `database.bak` file before performing the conversion. Progress will be reported in the console.
####
[](https://docs.powershelluniversal.com/getting-started/upgrading#converting-a-database-for-a-msi-upgrade)
Converting a Database for a MSI Upgrade
In order for the PowerShell Universal installer to run successfully, you will need to update the database before running the MSI installer. Below are the steps to take to do so.
1. Download the ZIP package for Windows and extract to a local directory.
2. Stop the PowerShell Universal service
3. Run the psudb.exe command from the ZIP directory, as stated above, to convert the database file in %ProgramData%\\UniversalAutomation
4. Update the %ProgramData%\\PowerShellUniversal\\appsettings.json file to use the SQLite plugin rather than the LiteDB plugin
5. Run the PowerShell Universal v5 installer to upgrade the application files.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#desktop-mode-removed)
Desktop Mode Removed
Desktop mode has been removed. Resources such as hot keys, file associations and shortcuts are no longer supported. The MSI now supports User scope installs that will run as the current user and start upon login.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#install-psuserver-on-windows-installs-from-the-msi)
Install-PSUServer on Windows Installs from the MSI
In previous versions of PowerShell Universal, this command would install to a directory and create the service manually. This command now installs from MSI. If you previously installed with this module, you would need to remove the existing install with a previous version of the module and then install with the new version of the module.
Copy
Install-Module Universal -RequiredVersion 4.4.0
Remove-PSUServer
Open a new command prompt and run the following.
Copy
Uninstall-Module Universal
Install-Module Universal
Install-PSUServer
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#git-database-storage-removed)
Git Database Storage Removed
PowerShell Universal no longer supports storing the git repository directly in the database. We recommend using a remote git provider like GitHub, GitLab, or Gitea. PowerShell Universal v5 does support local git repositories without the need to sync to a remote. This allows for storing file history directly on the PowerShell Universal server.
###
[](https://docs.powershelluniversal.com/getting-started/upgrading#removed-heatmap-and-marker-cluster-from-new-udmap)
Removed Heatmap and Marker Cluster from New-UDMap
Maps no longer support heatmaps or marker clusters.
[PreviousDocker](https://docs.powershelluniversal.com/getting-started/docker)
[NextUninstall](https://docs.powershelluniversal.com/getting-started/uninstall)
Last updated 3 months ago
Was this helpful?
---
# Downgrade | PowerShell Universal
In some scenarios it may be required to roll back the version of PowerShell Universal. This could be due to a feature change or bug that affects the system in a way too impactful to continue with the version. We [always recommend](https://docs.powershelluniversal.com/getting-started/upgrading)
validating a version in a development or quality assurance environment before upgrading in production to avoid having to perform a downgrade.
Downgrading can be complicated and error prone. We recommend restoring from a backup or snapshot instead of downgrading.
[](https://docs.powershelluniversal.com/getting-started/downgrade#configuration-files)
Configuration Files
---------------------------------------------------------------------------------------------------------------
Downgrading the configuration files will require removing or altering the `.universal` repository files to remove or rename new parameters. New cmdlets will be ignored by PowerShell Universal. If a cmdlet was renamed, it may have to be updated as well. You will need to refer to the [changelog](https://docs.powershelluniversal.com/changelogs/changelog)
to see which cmdlets have changed in each version.
Major versions may include breaking changes. Minor versions may have additional cmdlets or parameters but will not have any breaking changes.
You can find information about each configuration file in the [Repository page](https://docs.powershelluniversal.com/config/repository)
.
It is much easier to restore from a backup of the configuration files before the upgrade rather than manually updating files.
[](https://docs.powershelluniversal.com/getting-started/downgrade#database)
Database
-----------------------------------------------------------------------------------------
Restoring the database to a previous version requires downgrading the schema. This can be accomplished with [PSU CLI](https://docs.powershelluniversal.com/config/psucli)
. Using the `schema` command, you will be able to select the down-level version.
Downgrading the database schema can be a destructive operation. You may remove tables and columns that contain data. Always backup a database before performing these operations.
Below is an example of downgrading the schema of a SQLite database to version 5.3.0. You will need to stop the PowerShell Universal services before doing so.
Copy
.\psu.exe schema --target-version '5.3.0' --connection-string "Data Source=C:\ProgramData\UniversalAutomation\database.db" --database-type "SQLite"
You can downgrade a nightly build version of the database to a stable version of the database to allow for an upgrade to the stable build of the target version. You will lose any data found in new columns or tables.
[](https://docs.powershelluniversal.com/getting-started/downgrade#application-files)
Application Files
-----------------------------------------------------------------------------------------------------------
Downgrading the application files is typically a simple process and depends on how you installed the product. You will need to perform the configuration file and database downgrades before performing the application downgrade.
###
[](https://docs.powershelluniversal.com/getting-started/downgrade#msi)
MSI
To downgrade an MSI installation, you will need to first uninstall the current version. PowerShell Universal will not allow you to run a downgrade. After the uninstall is complete, perform an installation of the target version.
If you have configured a service account, you will need to set the service account again after install. This will require the service account credentials.
###
[](https://docs.powershelluniversal.com/getting-started/downgrade#zip)
ZIP
To downgrade a ZIP installation, simply delete the PowerShell Universal application files. Once the directory is clear unzip the target version's ZIP into the installation directory. Ensure that you run `Get-ChildItem -Recurse | Unblock-File` after doing so.
###
[](https://docs.powershelluniversal.com/getting-started/downgrade#iis)
IIS
Similar to the ZIP installation, remove the old version's files and unzip and unblock the target version's files. Ensure that the web site and App Pool are stopped before attempting so.
[PreviousUninstall](https://docs.powershelluniversal.com/getting-started/uninstall)
[NextMigrate and Restore](https://docs.powershelluniversal.com/getting-started/migration)
Last updated 3 months ago
Was this helpful?
---
# Migrate and Restore | PowerShell Universal
It is often desirable to migrate a PowerShell Universal server configuration from one machine to another. This can be due to change of infrastructure or restoring from backup. This can be for operating system upgrades or general data center maintenance.
This document explains the steps necessary to migrate PowerShell Universal configuration to another machine.
We recommend stopping the PowerShell Universal service before performing the migration or restore.
Copy
Stop-Service 'PowerShellUniversal'
Depending on the type of migration or restoration, you may not need to perform all of these actions.
[](https://docs.powershelluniversal.com/getting-started/migration#configuration-data)
Configuration Data
-------------------------------------------------------------------------------------------------------------
The configuration data files are stored in `%ProgramData%\UniversalAutomation\Repository` by default. These will consist of features such as APIs, Scripts and Apps. The entire directory is necessary for the configuration of the target system to function.
You can either copy the folder manually or via PowerShell. Ensure that you include all subdirectories.
Copy
Copy-Item $ENV:ProgramData\UniversalAutomation\Repository \\newServer\C$\ProgramData\UniversalAutomation\Repository -Recurse
[](https://docs.powershelluniversal.com/getting-started/migration#database)
Database
-----------------------------------------------------------------------------------------
The database migration will depend on the type of database used.
###
[](https://docs.powershelluniversal.com/getting-started/migration#sqlite)
SQLite
You will need to copy the SQLite database file to the configured, or default, database location. On a default installation, this will be `%ProgramData%\UniversalAutomation\database.db`. The target machine account or service account will need read and write access to this database file.
Copy
Copy-Item $ENV:ProgramData\UniversalAutomation\database.db \\newServer\C$\ProgramData\UniversalAutomation\database.db
If you are restoring from backup, you may need to [Downgrade](https://docs.powershelluniversal.com/getting-started/downgrade)
the schema if you upgraded the version.
###
[](https://docs.powershelluniversal.com/getting-started/migration#sql-and-postgresql)
SQL and PostgreSQL
Because these databases are stored outside of the PowerShell Universal server, you do not need to perform a migration of the database itself. You will need to ensure that the target server has network access to the SQL host.
If you are restoring from backup, you may need to [Downgrade](https://docs.powershelluniversal.com/getting-started/downgrade)
the schema if you upgraded the version.
[](https://docs.powershelluniversal.com/getting-started/migration#application-settings)
Application Settings
-----------------------------------------------------------------------------------------------------------------
The PowerShell Universal `appsettings.json` file is necessary for providing the appropriate server settings to the platform. By default, this is stored in `%ProgramData%\PowerShellUniversal\appsettings.json`. You will need to copy this to the new server in the same location.
This file contains configuration settings such as HTTP certificate, authentication, git sync settings, API configuration options and more.
Copy
Copy-Item $ENV:ProgramData\PowerShellUniversal\appsettings.json \\newServer\C$\ProgramData\PowerShellUniversal\appsettings.json
appsettings.json files do not change between upgrades and you likely not need to perform this action during a restore.
[](https://docs.powershelluniversal.com/getting-started/migration#secret-vaults)
Secret Vaults
---------------------------------------------------------------------------------------------------
PowerShell Universal includes 3 built-in secret vaults that may need to be migrated. The database vault is included with the database migration and does not require extra steps. If you are performing a restore, it's unlikely you will need to perform these restore operations unless the secret vaults have become corrupted.
###
[](https://docs.powershelluniversal.com/getting-started/migration#psusecretstore)
PSUSecretStore
The `PSUSecretStore` vault uses the Microsoft's [SecretStore module](https://learn.microsoft.com/en-us/powershell/utility-modules/secretmanagement/get-started/using-secretstore?view=ps-modules)
. This module stores secrets, on disk, using symmetric encryption. A default encryption key is included with PowerShell Universal installations. If the key was updated, the new key will be in the appsettings.json file you migrated in the previous step. You will also need to move the physical secret store to the new server's file system.
The SecretStore module uses a user-specific storage location to ensure that ACLs are enforced on the files themselves. You will need to ensure that you copy the vault's contents to the account of the user that will be running PowerShell Universal on the new system.
Copy
Copy-Item $Env:LOCALAPPDATA\Microsoft\PowerShell\secretmanagement\localstore \\newServer\C$\Users\myServiceAccount\AppData\Local\Microsoft\PowerShell\secretmanagement\localstore
###
[](https://docs.powershelluniversal.com/getting-started/migration#builtinlocalvault)
BuiltInLocalVault
The `BuiltInLocalVault` is only available on Windows and uses Credential Manager to store secrets. You will need to recreate these secrets in the Credential Manager store on the new system.
Within Credential Manager, you will find PowerShell secrets stored with a `ps:` prefix.
While it's not possible to extract credentials directly from the Credential Manager UI, you can use the Secret Management modules directly. To retrieve secrets, you can do the following.
Copy
Install-Module Micorosoft.PowerShell.SecretManagement
Install-Module SecretManagement.JustinGrote.CredMan
Register-SecretVault -Name 'BuiltInLocalVault' -ModuleName SecretManagement.JustinGrote.CredMan
Get-SecretInfo -Vault BuiltInLocalVault
$Secret = Get-Secret -Name 'TestApiKey' -Vault 'BuiltInLocalVault' -AsPlainText
On the new server, you can do the reverse and call `Set-Secret`. Note that these commands need to run as the service account running PowerShell Universal in order to store them properly in the Credential Manager account for the user.
[](https://docs.powershelluniversal.com/getting-started/migration#authentication)
Authentication
-----------------------------------------------------------------------------------------------------
Certain authentication types will require configuration outside of PowerShell Universal. Unless you are moving the machine running PowerShell Universal or changing the accessible URLs, you will not need to perform these actions.
###
[](https://docs.powershelluniversal.com/getting-started/migration#openid-connect)
OpenID Connect
Ensure that the proper sign-on URLs are configured in your Identity provider (e.g. Azure AD or Okta) if the host name of the server is changing. Without properly configured sign-on URLs, users will not be able to sign on the new system.
###
[](https://docs.powershelluniversal.com/getting-started/migration#windows)
Windows
[Windows authentication](https://docs.powershelluniversal.com/security/enterprise-security/windows-sso)
requires the setup of an SPN for the service account running the PowerShell Universal service. Ensure this SPN is in place before attempting to use Windows authentication with the new system.
[](https://docs.powershelluniversal.com/getting-started/migration#other-resources-and-considerations)
Other Resources and Considerations
---------------------------------------------------------------------------------------------------------------------------------------------
There may be other resources that PowerShell Universal uses on the system that should be taken into account when migrating or restoring servers. Typically, you will not need to worry about these resources during a restore as they should remain the same if the machine has not changed.
* PowerShell Modules
* Environment Variables
* Local Account Privileges
* File System Permissions
* Proxy Configuration
* Certificates
* Git SSH keys or credentials
* DNS Settings
[](https://docs.powershelluniversal.com/getting-started/migration#application-files)
Application Files
-----------------------------------------------------------------------------------------------------------
Once all the following steps have been taken, you can now install PowerShell Universal on the new server. If you are downgrading during a restore, please follow the [Downgrade](https://docs.powershelluniversal.com/getting-started/downgrade)
documentation.
###
[](https://docs.powershelluniversal.com/getting-started/migration#msi-kestrel)
MSI \\ Kestrel
The MSI package for PowerShell Universal installs the platform as a Windows service that hosts its own web server called Kestrel. To install the service, [download the MSI](https://powershelluniversal.com/downloads)
and run it. We recommend using the exact same version as the source server.
During the MSI install, leave all settings as default. We recommend leaving the service account blank and unchecking the box that states to start the PowerShell Universal service after the installation is complete.
After the installation completes, the service will be created but not running. Open Service Control Manager (`services.msc`) and set the service account for the PowerShell Universal service. Start the service.
[](https://docs.powershelluniversal.com/getting-started/migration#debugging-issues)
Debugging Issues
---------------------------------------------------------------------------------------------------------
When migrating a PowerShell Universal service, you may run into issues the arise from configuration differences between the two systems. The following are places to look for more information.
###
[](https://docs.powershelluniversal.com/getting-started/migration#event-viewer)
Event Viewer
if the service starts and stops, there may be an issue with the database access. We recommend looking in the Application log within Event Viewer. PowerShell Universal will report two application Errors that will include .NET in the name. The second of the two errors will provide a human readable exception with more details.
###
[](https://docs.powershelluniversal.com/getting-started/migration#system-logs)
System Logs
PowerShell Universal will write system logs to the %ProgramData%\\PowerShellUniversal directory. Search for strings starting with `[ERR]` to gather more information about issues with the installation.
###
[](https://docs.powershelluniversal.com/getting-started/migration#notifications)
Notifications
After migrating the service, check for any error notifications that may indicate misconfiguration of the system.
[PreviousDowngrade](https://docs.powershelluniversal.com/getting-started/downgrade)
[NextLicensing](https://docs.powershelluniversal.com/licensing)
Last updated 5 months ago
Was this helpful?
---
# Licensing | PowerShell Universal
PowerShell Universal is licensed per server. We provide licenses for individuals and organizations.
You can purchase a license on [our website](https://ironmansoftware.com/pricing/powershell-universal)
.
[](https://docs.powershelluniversal.com/licensing#whats-a-server)
What's a server?
---------------------------------------------------------------------------------------
A server is a single running instance of PowerShell Universal.
###
[](https://docs.powershelluniversal.com/licensing#what-if-i-have-multiple-containers)
What if I have multiple containers?
The license applies to each container instance and not the container host. For example, if you have 10 container instances running, you will need 10 licenses.
###
[](https://docs.powershelluniversal.com/licensing#what-if-i-have-multiple-sites-on-a-single-iis-server)
What if I have multiple sites on a single IIS server?
Each website running PowerShell Universal will need a license and not a single license for the entire IIS server.
[](https://docs.powershelluniversal.com/licensing#install-a-license)
Install a License
-------------------------------------------------------------------------------------------
To install a license, click Settings \\ License. Click the Add License button to upload your license file. You can also install licenses using the `Set-PSULicense` cmdlet. Offline licenses do not require an internet connection but will need to be reinstalled when the subscription expires, in you wish to update the version of PowerShell Universal. Online licenses require an internet connection and access to `https://ironmansoftware.com` in order to verify subscription status.
You can use the `PSULICENSE` environment variable to set a license. The value of this environment variable needs to be the contents of the license file.
Proxy configuration can be done by clicking Settings \\ General and configuring the proxy URI and, optionally, credentials. You can also configure proxy settings with the `Set-PSUSetting` cmdlet.
###
[](https://docs.powershelluniversal.com/licensing#account-based-licensing)
Account-Based Licensing
When using account-based licensing, you will enter your account's license key. Whenever you activate a PowerShell Universal server, it will assign a license to computer. This license key does not change so there is no need to install a new license when renewing. You can view the assigned computers and account license key in your Ironman Software account.
The PowerShell Universal server needs to have access to ironmansoftware.com.
###
[](https://docs.powershelluniversal.com/licensing#offline-licenses)
Offline Licenses
Offline license files are required for environments that do not have internet access. You will need to install a new license file when you plan to upgrade to a version past the expiration date of the license.
###
[](https://docs.powershelluniversal.com/licensing#online-licenses)
Online Licenses
Online licenses work the same as offline but check the subscription status on ironmansoftware.com. The license is tied to a specific subscription and may require a change after renewal. We recommend account-based licensing over online licenses.
[](https://docs.powershelluniversal.com/licensing#developer-licenses)
Developer Licenses
---------------------------------------------------------------------------------------------
When a server license is purchased, you will be able to generate developer licenses for users building solutions for your team. Their intent is to be used by individual developers in their local environments. Do not use developer licenses when hosting a server for remote access for testing or production. Instances of PowerShell Universal running with a Developer License will display a water mark in the admin console and any apps stating they are intended only for development purposes.
You can generate a developer license on the Settings \\ License page by clicking the Generate Developer License button.
Generate Developer License
[](https://docs.powershelluniversal.com/licensing#licensed-features)
Licensed Features
-------------------------------------------------------------------------------------------
The following features of PowerShell Universal require a license.
* Debugging Tools
* Enterprise Authentication
* OpenID Connect
* SAML2
* WS-Federation
* Windows Authentication
* Custom Authentication Scripts
* Client Certificate
* App Tokens
* Enterprise Authorization
* Permissions
* Custom Authorization Scripts
* Platform
* Git Support
* Module Management
* Non-Database Credential Vaults
* SQL Support
* PostgreSQL Support
* Published Folders
* Cache Management
* Computer Groups
* Translations
* Settings
* Branding
* Tags
* APIs
* Event Hubs
* OpenAPI Documentation
* Automation
* Triggers
* Terminals
* Tests
* Apps
* App Page Editor
* App Function Editor
[PreviousMigrate and Restore](https://docs.powershelluniversal.com/getting-started/migration)
[NextSystem Requirements](https://docs.powershelluniversal.com/system-requirements)
Last updated 8 days ago
Was this helpful?
---
# System Requirements | PowerShell Universal
[](https://docs.powershelluniversal.com/system-requirements#hardware)
Hardware
-----------------------------------------------------------------------------------
Hardware recommendations are based on use and depend on how many scripts are running on the PowerShell Universal server and how many users are accessing the machine. Unix based machines typically require less hardware requirements than Windows based machines. The below recommendations are based on low use of the system.
###
[](https://docs.powershelluniversal.com/system-requirements#minimum)
Minimum
This is the base line for a Universal server with very minimal server load. It should be used for trial or development purposes only.
* 2 CPU
* 4 GB
* 250 GB
* SQLite Database
###
[](https://docs.powershelluniversal.com/system-requirements#recommended)
Recommended
This is the base line for a Universal server running several jobs an hour, hosting APIs with fewer than 100 requests per hour and a single App. It will support up to 10 concurrent users.
* 4 CPU
* 16 GB
* 500 GB
* MS SQL\\PostgreSQL Database
###
[](https://docs.powershelluniversal.com/system-requirements#performance)
Performance
This is the base line for a Universal server running dozens of jobs an hour, hosting APIs with greater than 100 requests per hour and up to 5 Apps. It will support up to 50 concurrent users.
* 16 CPU
* 32 GB
* 1 TB
* MS SQL\\PostgreSQL Database
###
[](https://docs.powershelluniversal.com/system-requirements#distributed)
Distributed
A distributed system employs multiple instances of PowerShell Universal connected to the same database. It requires either Git or managed deployments to share configuration data. We recommend this for widely used production instances. It provides the best performance, stability and redundancy.
This configuration can support hundreds of jobs per hour, thousands of API requests and many apps. The number of concurrent users will depend on the number of PSU servers in the cluster.
* 32 CPU
* 64 GB
* 1 TB
* MS SQL\\PostgreSQL Database
[](https://docs.powershelluniversal.com/system-requirements#software)
Software
-----------------------------------------------------------------------------------
###
[](https://docs.powershelluniversal.com/system-requirements#windows)
Windows
* Optional\*: [Windows PowerShell v5.1](https://www.microsoft.com/en-us/download/details.aspx?id=54616)
or later
* Optional\*: PowerShell v7.2 or later
* .NET Framework v4.8.0 or later (only for Windows PowerShell)
###
[](https://docs.powershelluniversal.com/system-requirements#linux)
Linux
* Optional\*: PowerShell v7.2 or later
* Validated Distributions: Ubuntu 18.04 and 20.04
###
[](https://docs.powershelluniversal.com/system-requirements#mac-os)
Mac OS
* Optional\*: PowerShell v7.2 or later
\*PowerShell Universal packages a version of the PowerShell SDK. If you do not have a version of PowerShell installed, the integrated versions of PowerShell will be used.
[](https://docs.powershelluniversal.com/system-requirements#network)
Network
---------------------------------------------------------------------------------
PowerShell Universal communicates on the port configured during installation and\\or configuration.
###
[](https://docs.powershelluniversal.com/system-requirements#web-server-front-end)
Web Server Front End
* Default Port: 5000
* Typical Configured Ports: 443, 80
###
[](https://docs.powershelluniversal.com/system-requirements#tcp-backend)
TCP Backend
* Dynamically assigned local port on loopback
###
[](https://docs.powershelluniversal.com/system-requirements#database)
Database
* MS SQL: 1433
* PostgreSQL: 5432
###
[](https://docs.powershelluniversal.com/system-requirements#agent)
Agent
* Web Server Front End Port, default 5000
###
[](https://docs.powershelluniversal.com/system-requirements#git)
Git
* Standard HTTP Ports, typically 443
###
[](https://docs.powershelluniversal.com/system-requirements#online-licensing)
Online Licensing
Online licensing requires access to www.ironmansoftware.com on port 443. Offline licenses do not require internet access.
###
[](https://docs.powershelluniversal.com/system-requirements#proxy)
Proxy
PowerShell Universal provides proxy configuration settings in the Settings \\ General page. These are used for communication with remote git, database or internet services.
[PreviousLicensing](https://docs.powershelluniversal.com/licensing)
[NextSupported Browsers](https://docs.powershelluniversal.com/supported-browsers)
Last updated 1 month ago
Was this helpful?
---
# Supported Browsers | PowerShell Universal
Universal uses a variety of modern web frameworks and can have issues with older browsers such as Internet Explorer.
Recent versions of the following web browsers are supported: [Chrome](https://www.google.com/chrome/)
, [Firefox](http://www.mozilla.org/firefox/)
, [Safari](http://www.apple.com/safari/)
, and [Microsoft Edge](https://www.microsoft.com/en-us/windows/microsoft-edge)
.
When considering a browser, you will need to understand that certain features are required. They include:
* [WebSocket](https://caniuse.com/?search=websocket)
* [CSS Flexbox](https://caniuse.com/?search=flexbox)
* [Fetch](https://caniuse.com/?search=fetch)
[PreviousSystem Requirements](https://docs.powershelluniversal.com/system-requirements)
[NextRelease Support Policy](https://docs.powershelluniversal.com/release-support-policy)
Last updated 11 months ago
Was this helpful?
---
# Release Support Policy | PowerShell Universal
PowerShell Universal recently migrated from a static, two-year support policy for releases to a standard and long-term support policy based on the underlying frameworks that the platform is built upon.
[](https://docs.powershelluniversal.com/release-support-policy#support-policy)
Support Policy
--------------------------------------------------------------------------------------------------
Starting with version 6, PowerShell Universal will provide long term support options pinned to the underlying support policy of the .NET SDK. Microsoft provides support for .NET versions for 18 months on standard support releases and 36 months on long-term support releases. PowerShell Universal runs on a similar support policy.
Version 5 is the last version on the historical, arbitrary support policy per major version. It will be supported until August 2026. Please see the below table for upcoming release support. Support is the same for each release type but varies based on the life time.
Version
Release Date
End of Support
Support Type
v4
6/23
6/26
Legacy
v5
8/24
8/26
Legacy
v6
3/26
3/29
Long Term
v7
3/27
9/28
Standard
v8
3/28
3/31
Long Term
v9
3/29
9/32
Standard
[PreviousSupported Browsers](https://docs.powershelluniversal.com/supported-browsers)
[NextAbout](https://docs.powershelluniversal.com/api/about)
Last updated 4 days ago
Was this helpful?
---
# About | PowerShell Universal
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.
This feature is for developing custom APIs run by Universal. It is not required for managing Universal. Universal provides a set of management APIs that are included with the platform.
[](https://docs.powershelluniversal.com/api/about#execution-environment)
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 [environment](https://docs.powershelluniversal.com/config/environments)
that runs the PowerShell Universal API process by specifying the `-ApiEnvironment` on `Set-PSUSetting`. Changing this setting will cause the API process to restart.
Copy
Set-PSUSetting -ApiEnvironment '7.1'
###
[](https://docs.powershelluniversal.com/api/about#per-endpoint-environment)
Per Endpoint Environment
You can also define the environment used by specifying the Environment on the endpoint itself.
Copy
New-PSUEndpoint -Url /environment -Environment Integrated -Endpoint {
$PSUEnvironment
}
###
[](https://docs.powershelluniversal.com/api/about#performance)
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 [https://blog.ironmansoftware.com/webapp-benchmark-siege/](https://blog.ironmansoftware.com/webapp-benchmark-siege/)
for detailed information about benchmark tests on Universal APIs.
###
[](https://docs.powershelluniversal.com/api/about#variables)
Variables
Variables are listed on the [variables page](https://docs.powershelluniversal.com/platform/variables#api)
.
[](https://docs.powershelluniversal.com/api/about#api)
API
---------------------------------------------------------------
* [New-PSUEndpoint](https://github.com/ironmansoftware/universal-docs/blob/v5/cmdlets/New-PSUEndpoint.txt)
* [Get-PSUEndpoint](https://github.com/ironmansoftware/universal-docs/blob/v5/cmdlets/Get-PSUEndpoint.txt)
* [Remove-PSUEndpoint](https://github.com/ironmansoftware/universal-docs/blob/v5/cmdlets/Universal/Remove-PSUEndpoint.md)
* [Set-UASetting](https://github.com/ironmansoftware/universal-docs/blob/v5/cmdlets/Universal/Set-UASetting.md)
[PreviousRelease Support Policy](https://docs.powershelluniversal.com/release-support-policy)
[NextEndpoints](https://docs.powershelluniversal.com/api/endpoints)
Last updated 4 days ago
Was this helpful?
---
# OpenAPI | PowerShell Universal
[](https://docs.powershelluniversal.com/api/openapi#about)
About
---------------------------------------------------------------------
API documentation can be produced for your endpoints by creating a new OpenAPI definition and assigning endpoints to it. OpenAPI is a standard format and can be consumed by tools, such as the [OpenAPI Generator](https://openapi-generator.tech/)
or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/)
, to create clients. The Swagger dashboard is also integrated into PowerShell Universal to provide interactive documentation.
[](https://docs.powershelluniversal.com/api/openapi#management-api-documentation)
Management API Documentation
-------------------------------------------------------------------------------------------------------------------
You can view the Managment API documentation by visiting the built in Swagger dashboard.
Copy
http://localhost:5000/swagger/index.html
[](https://docs.powershelluniversal.com/api/openapi#create-an-openapi-document)
Create an OpenAPI Document
---------------------------------------------------------------------------------------------------------------
To create an OpenAPI definition, click APIs \\ Documentation and then Create new Endpoint Documentation. You can set the name, URL, description and authentication details for the documentation.
Endpoint Documentation Dialog
Once created, you can assign endpoints to the documentation by editing the endpoint.
Edit Endpoint
The documentation for your endpoint will appear within the Swagger dashboard. Select the definition with the Select a definition dropdown.
All your custom endpoints will be listed.
Swagger Documentation for APIs
[](https://docs.powershelluniversal.com/api/openapi#help-text)
Help Text
-----------------------------------------------------------------------------
You can specify help text for your APIs using comment-based help. Including a synopsis, description and parameter descriptions will result in each of those pieces being documented in the OpenAPI documentation and Swagger age.
For example, with a simple `/get/:id` endpoint, we could have comment-based help such as this.
Copy
<#
.SYNOPSIS
This is an endpoint
.DESCRIPTION
This is a description
.PARAMETER ID
This is an ID.
#>
param($ID)
$Id
The resulting Swagger page will show each of these descriptions.
[](https://docs.powershelluniversal.com/api/openapi#input-and-output-types)
Input and Output Types
-------------------------------------------------------------------------------------------------------
Types can be defined within an endpoint documentation ScriptBlock. Click the Edit Details button on the API documentation record.
Endpoint Documentation Editor
APIs can also be documented using input and output types by creating a PowerShell class and referencing it within your comment-based help. PowerShell Universal takes advantage of the `.INPUTS` and `.OUTPUTS` sections to specify accepted formats and define status code return values.
Within the `.INPUTS` and `.OUTPUTS` , you will define a YAML block to provide this information. To create types, use the Endpoint Documentation editor. This file is loaded when reading OpenAPI documents. This information is stored in `endpointsDocumentation.ps1`.
Copy
[Documentation()]
class MyReturnType {
[string]$Value
}
###
[](https://docs.powershelluniversal.com/api/openapi#inputs)
Inputs
Input types are defined in the `.INPUTS` section. This section is a YAML block that defines if the input is required, provides a description and specifies the content type. This is a content type followed by the PowerShell class you defined in the endpoint documentation.
Copy
<#
.INPUTS
Required: false
Description: This is an input value.
Content:
application/json: MyReturnType
#>
param()
###
[](https://docs.powershelluniversal.com/api/openapi#outputs)
Outputs
Output types are similar to input but are specified on return codes as well as their content type and PowerShell class. The below example returns an ADAccountType class when a HTTP OK (200) is returned from the API. A 400 (Bad Request) does not return data but does provide a description that will be displayed in the API documentation.
Copy
<#
.OUTPUTS
200:
Description: This is an output value.
Content:
application/json: ADAccountType
400:
Description: Invalid input
#>
param()
[PreviousEndpoints](https://docs.powershelluniversal.com/api/endpoints)
[NextEvent Hubs](https://docs.powershelluniversal.com/api/event-hubs)
Last updated 6 months ago
Was this helpful?
---
# Event Hubs | PowerShell Universal
Event Hubs require a [license](https://docs.powershelluniversal.com/licensing)
.
Event Hubs provide the ability to connect client to the PowerShell Universal server. Once connected, the PowerShell Universal server can send messages to the connected clients and they will run a local PowerShell script block.
[](https://docs.powershelluniversal.com/api/event-hubs#creating-an-event-hub)
Creating an Event Hub
--------------------------------------------------------------------------------------------------------
To create an event hub, click APIs \\ Event Hub and click Create New Event Hub. Event Hubs are named and can choose to enforce authentication and authorization.
[](https://docs.powershelluniversal.com/api/event-hubs#agent)
Agent
------------------------------------------------------------------------
You will need to install and configure the [PowerShell Universal Agent](https://docs.powershelluniversal.com/config/agent)
to use Event Hubs.
[](https://docs.powershelluniversal.com/api/event-hubs#send-events)
Send Events
------------------------------------------------------------------------------------
From within the PowerShell Universal server, you can send events from a hub to connected clients using the `Send-PSUEvent` cmdlet.
Copy
Send-PSUEvent -Hub 'MyHub' -Data "Hello!"
The `-Data` parameter accepts an object and will be serialized using CLIXML and send to the client. The data will be deserialized before passing to the script block.
You can also run commands. This does not require defining a script on the event hub client. You can also use the `Invoke-PSUCommand` alias to mimic native PowerShell behavior.
Copy
Invoke-PSUCommand -Hub "MyHub" -Command "Start-Process" -Parameters @{
FilePath = "Notepad"
}
[](https://docs.powershelluniversal.com/api/event-hubs#receive-data-from-clients)
Receive Data from Clients
----------------------------------------------------------------------------------------------------------------
This feature is only available when sending data to an individual client, rather than all clients connected to a hub.
Copy
$Connection = Get-PSUEventHubConnection | Where-Object UserName -eq 'Admin'
$Result = Send-PSUEvent -Hub 'Hub' -Data 'Say Hello!' -Connectionid $Connection.ConnectionId
Show-UDToast $Result
[](https://docs.powershelluniversal.com/api/event-hubs#example-running-scripts-on-remote-machines)
Example: Running Scripts on Remote Machines
---------------------------------------------------------------------------------------------------------------------------------------------------
This example provides a way to run scripts on remote machines without having to install another instance of PowerShell Universal.
This example allows for sending scripts to remote machines and executing them with a generic event hub script.
First, create an event hub in PowerShell Universal. This example does not use authentication.
Next, install the PowerShell Universal Agent on the remote machine. Create a configuration file in `%ProgramData%\PowerShellUniversal\agent.json`.
Copy
{
"Connections": [\
{\
"Url": "http://localhost:5000",\
"Hub": "eventHub",\
"ScriptPath": "script.ps1"\
}\
]
}
Next, create a helper script.ps1 to receive the event hub data and process requests from PSU to invoke scripts. It creates a new temporary PS1 file and uses the `$EventData` passed down from the event hub message with the contents and parameters for the script.
Copy
$TempFile = (New-TemporaryFile).FullName + ".ps1"
$EventData.Contents | Out-File -FilePath $TempFile
$Parameters = $EventData.Parameters
& $TempFile @Parameters
In PowerShell Universal, add a script that you want to run on the remote machine. In this example, it simply starts a process.
Copy
param($Name)
Start-Process $Name
Finally, add another script that sends the event down to the client. This could be from an API or an App as well. Because the script on the agent is generic, it will just run whatever is passed to it.
Copy
param($TargetComputer, $ProcessName)
Send-PSUEvent -Computer $TargetComputer -Data @{
Contents = Get-Content StartAProcess.ps1 -Raw
Parameters = @{
Name = $ProcessName
}
}
From here you could event use the script to schedule jobs to run on the remote machines using the agent.
[PreviousOpenAPI](https://docs.powershelluniversal.com/api/openapi)
[NextSecurity](https://docs.powershelluniversal.com/api/security)
Last updated 3 months ago
Was this helpful?
---
# Endpoints | PowerShell Universal
Endpoints are defined by their URI and HTTP method. Calls made to the Universal server that match your defined API endpoint and method execute the API endpoint script.
Copy
New-PSUEndpoint -Url '/endpoint' -Method 'GET' -Endpoint {
"Hello, world!"
}
To invoke the above method, you can use `Invoke-RestMethod`.
Copy
Invoke-RestMethod http://localhost:5000/endpoint
When defining endpoints in the management API, you can skip the `New-PSUEndpoint` call, as the admin console defines it.
API Properties
The only contents that you need to provide in the editor are the script you wish to call.
API Content
Avoid using endpoint URLs that match internal PowerShell Universal Management API URLs, as this causes unexpected behavior. You can reference the [OpenAPI documentation](https://docs.powershelluniversal.com/api/openapi#management-api-documentation)
for the [Management API](https://docs.powershelluniversal.com/config/management-api)
to verify that none of the URLs match.
[](https://docs.powershelluniversal.com/api/endpoints#http-methods)
HTTP Methods
-------------------------------------------------------------------------------------
Endpoints can have one or more HTTP methods defined. To determine which method is used by an endpoint, use the built-in `$Method` variable.
Copy
New-PSUEndpoint -Url '/user' -Method @('GET', 'POST') -Endpoint {
if ($Method -eq 'GET')
{
Get-User
}
else {
New-User
}
}
[](https://docs.powershelluniversal.com/api/endpoints#variable-url)
Variable URL
-------------------------------------------------------------------------------------
URLs can contain variable segments. You can denote a variable segment using a colon (`:`). For example, the following URL would provide a variable for the ID of the user. The `$Id` variable will be defined within the endpoint when it is executed. Variables must be unique in the same endpoint URL.
Copy
New-PSUEndpoint -Url '/user/:id' -Method 'GET' -Endpoint {
Get-User -Id $Id
}
To call this API and specify the ID, do the following:
Copy
Invoke-RestMethod http://localhost:5000/user/123
[](https://docs.powershelluniversal.com/api/endpoints#query-string-parameters)
Query String Parameters
-----------------------------------------------------------------------------------------------------------
Query string parameters are automatically passed into endpoints as variables that you can then access. For example, if you have an endpoint that expects an `$Id` variable, you can provide it in the query string.
Copy
New-PSUEndpoint -Url '/user' -Method 'GET' -Endpoint {
Get-User -Id $Id
}
The resulting `Invoke-RestMethod` call must then include the query string parameter.
Copy
Invoke-RestMethod http://localhost:5000/user?Id=123
When using multiple query string parameters, ensure that your URL is surrounded by quotes so PowerShell translates it properly. Including an ampersand (&) without quotes will cause issues in both Windows PowerShell and PowerShell 7.
Copy
Invoke-RestMethod "http://localhost:5000/user?Id=123&name=tim"
###
[](https://docs.powershelluniversal.com/api/endpoints#security-considerations)
Security Considerations
When accepting input via Query String parameters you may be vulnerable to [CWE-914: Improper Control of Dynamically-Identified Variables](https://cwe.mitre.org/data/definitions/914.html)
. Consider using a `param` block to ensure that only valid parameters are provided to the endpoint.
Below is an example of CWE-914. Include a `$IsChallengePassed` query string parameter to bypass the challenge.
Copy
New-PSUEndpoint -Url "/api/v1.0/CWE914Test" -Description "Vulnerable to CWE-914" -Endpoint {
if($ChallengeInputData -eq "AcceptableInput") {
$IsChallengePassed = $true
}
if($IsChallengePassed) {
"Challenge passed. Here is Sensitive Information"
} else {
"Challenge not passed"
}
}
In order to avoid this particular issue, you can use a `param` block.
Copy
New-PSUEndpoint -Url "/api/v1.0/CWE914Test" -Description "Not Vulnerable to CWE-914" -Endpoint {
Param(
$ChallengeInputData
)
if($ChallengeInputData -eq "AcceptableInput") {
$IsChallengePassed = $true
}
if($IsChallengePassed) {
"Challenge passed. Here is Sensitive Information"
} else {
"Challenge not passed"
}
}
[](https://docs.powershelluniversal.com/api/endpoints#headers)
Headers
---------------------------------------------------------------------------
Request headers are available in APIs using the `$Headers` variable. The variable is a hashtable. To access a header, use the following syntax:
Copy
$Headers['Content-Type']
[](https://docs.powershelluniversal.com/api/endpoints#cookies)
Cookies
---------------------------------------------------------------------------
Request cookies are available in APIs using the `$Cookies` variable. The variable is a hashtable. To access a cookie, use the following syntax:
Copy
$Cookies['Request-Cookie']
Send back request cookies with the `New-PSUApiResponse` cmdlet. Use the `-Cookies` parameter with a supplied hashtable.
Copy
New-PSUApiResponse -StatusCode 200 -Cookies @{
ResponseCookie = '123'
}
[](https://docs.powershelluniversal.com/api/endpoints#body)
Body
---------------------------------------------------------------------
To access a request body, you will simply access the `$Body` variable. Universal `$Body` variable will be a string. If you expect JSON, you should use `ConvertFrom-Json`.
Copy
New-PSUEndpoint -Url '/user' -Method Post -Endpoint {
$User = ConvertFrom-Json $Body
New-User $User
}
To call the above endpoint, specify the body of `Invoke-RestMethod`.
Copy
Invoke-RestMethod http://localhost:5000/user -Method Post -Body "{'username': 'adam'}"
[](https://docs.powershelluniversal.com/api/endpoints#live-log)
Live Log
-----------------------------------------------------------------------------
You can view the live log information for any endpoint by clicking the log tab. Live logs include URL, HTTP method, source IP address, PowerShell streams, status code, return Content Type, and HTTP content length.
You can write to the live log from within your endpoints with cmdlets like `Write-Host`.
Endpoint Live Log
[](https://docs.powershelluniversal.com/api/endpoints#testing)
Testing
---------------------------------------------------------------------------
You can use the Test tab in the Endpoint editor to test your APIs. Using this Test tool, you can adjust headers, the query string, and body. You can also adjust the Authentication and Authorization for the test.
Endpoint Test Tab
When using the test tab, any changes to the values of the test will result in an updated Code block that you can then use within PowerShell. Click the Code tab to view the test code.
Copy
Invoke-RestMethod -Uri 'http://localhost:5000/test-api?Page=1' -Headers @{'X-Custom-Header' = 'Value';} -Method 'POST'
Additionally, tests performed within the tester will be stored for 30 days to allow for retesting without having to reconfigure all the properties. Clicking the Apply button will setup the Test tool with the same properties.
Test History
[](https://docs.powershelluniversal.com/api/endpoints#form-data)
Form Data
-------------------------------------------------------------------------------
You can pass data to an endpoint as form data. Form data will pass into your endpoint as parameters.
Copy
New-PSUEndpoint -Url '/user' -Method Post -Endpoint {
param([Parameter(Mandatory)]$userName, $FirstName, $LastName)
New-User $UserName -FirstName $FirstName -LastName $LastName
}
You can then use a hashtable with Invoke-RestMethod to pass form data.
Copy
Invoke-RestMethod http://localhost:5000/user -Method Post -Body @{
UserName = "adriscoll"
FirstName = "Adam"
LastName = "Driscoll"
}
[](https://docs.powershelluniversal.com/api/endpoints#json-data)
JSON Data
-------------------------------------------------------------------------------
You can pass JSON data to an endpoint and it will automatically bind to a param block.
Copy
New-PSUEndpoint -Url '/user' -Method Post -Endpoint {
param([Parameter(Mandatory)]$userName, $FirstName, $LastName)
New-User $UserName -FirstName $FirstName -LastName $LastName
}
You can then send JSON data to the endpoint.
Copy
Invoke-RestMethod http://localhost:5000/user -Method Post -Body (@{
UserName = "adriscoll"
FirstName = "Adam"
LastName = "Driscoll"
} | ConvertTo-Json) -ContentType 'application/json'
[](https://docs.powershelluniversal.com/api/endpoints#param-block)
Param Block
-----------------------------------------------------------------------------------
You can use a `param` block within your script to enforce mandatory parameters and provide default values for optional parameters such as query string parameters. Variables such as `$Body`, `$Headers` and `$User` are provided automatically.
In the below example, the `$Name` parameter is mandatory and the `$Role` parameter has a default value of Default.
Copy
New-PSUEndpoint -Url '/user/:name' -Endpoint {
param([Parameter(Mandatory)$Name, $Role = "Default")\
}\
\
When using the `param` block with route parameters like the above example, you must include the route variable in your parameter. If it is not specified, you will not have access to that value.\
\
For example, the following `$Name` variable is always `$null`. The endpoint always returns false.\
\
Copy\
\
New-PSUEndpoint -Url '/user/:name' -Endpoint {\
param($Role = "Default")\
\
$Name -eq 'Adam'\
}\
\
If you use the `CmdletBinding` or `Parameter` attribute within your param block, the endpoint will strictly enforce which parameters are allowed into the endpoint.\
\
For example, the following enforces that the name parameter is specified.\
\
Copy\
\
New-PSUEndpoint -Url '/user' -Endpoint {\
param([Parameter(Mandatory)$Name)\
}\
\
That said, you cannot specify additional parameters to the endpoint. Doing the following will cause an error.\
\
Copy\
\
Invoke-RestMethod http://localhost:5000/user -Method Post -Body (@{ \
Name = "adriscoll"\
DisplayName = 'Adam'\
} | ConvertTo-Json) -ContentType 'application/json'\
\
If you change your endpoint to avoid using the `Parameter` attribute, you can pass in any number of params and they will be bound as variables and not parameters to the endpoint.\
\
Copy\
\
New-PSUEndpoint -Url '/user' -Endpoint {\
param($Name)\
}\
\
[](https://docs.powershelluniversal.com/api/endpoints#returning-data)\
\
Returning Data\
\
\
-----------------------------------------------------------------------------------------\
\
Data returned from endpoints is assumed to be JSON data. If you return an object from the endpoint script block, it is automatically serialized to JSON. If you want to return another type of data, you can return a string formatted however you chose.\
\
[](https://docs.powershelluniversal.com/api/endpoints#processing-files)\
\
Processing Files\
\
\
---------------------------------------------------------------------------------------------\
\
### \
\
[](https://docs.powershelluniversal.com/api/endpoints#uploading-files)\
\
Uploading Files\
\
You can process uploaded files by using the `$Data` parameter to access the byte array of data uploaded to the endpoint.\
\
Copy\
\
New-PSUEndpoint -Url '/file' -Method Post -Endpoint {\
$Data\
}\
\
PS C:\Users\adamr> iwr http://localhost:5000/file -method post -InFile '.\Desktop\add-dashboard.png'\
\
StatusCode : 200\
StatusDescription : OK\
Content : [137,80,78,71,13,10,26,10,0,0,0,13,73,72,68,82,0,0,2,17,0,0,1,92,8,2,0,0,0,249,210,123,106,0,0,0,1,\
115,82,71,66,0,174,206,28,233,0,0,0,4,103,65,77,65,0,0,177,143,11,252,97,5,0,0,0,9,112,72,89,115,0,\
0,…\
\
`The multipart/form-data`content type is not supported for uploading files to APIs.\
\
You can also save the file into a directory.\
\
Copy\
\
New-PSUEndpoint -Url '/file' -Method Post -Endpoint {\
[IO.File]::WriteAllBytes("tempfile.dat", $Data)\
}\
\
### \
\
[](https://docs.powershelluniversal.com/api/endpoints#downloading-files)\
\
Downloading Files\
\
You can send files down using the `New-PSUApiResponse` cmdlet.\
\
Copy\
\
New-PSUEndpoint -Url '/image' -Endpoint {\
$ImageData = [IO.File]::ReadAllBytes("image.jpeg")\
New-PSUApiResponse -ContentType 'image/jpg' -Data $ImageData\
}\
\
[](https://docs.powershelluniversal.com/api/endpoints#returning-custom-responses)\
\
Returning Custom Responses\
\
\
-----------------------------------------------------------------------------------------------------------------\
\
You can return custom responses from endpoints by using the `New-PSUApiResponse` cmdlet in your endpoint. This cmdlet allows you to set the status code, content type and even specify the byte\[\] data for the content to be returned.\
\
Copy\
\
New-PSUEndpoint -Url '/file' -Method Get -Endpoint {\
New-PSUApiResponse -StatusCode 410\
}\
\
You can also return custom body data with the `-Body` parameter of `New-PSUApiResponse`.\
\
Copy\
\
New-PSUEndpoint -Url '/file' -Method Get -Endpoint {\
New-PSUApiResponse -Body "Not what you're looking for." -StatusCode 404\
}\
\
Invoking the REST method returns the custom error code.\
\
Copy\
\
PS C:\Users\adamr\Desktop> invoke-restmethod http://localhost:8080/file\
\
Invoke-RestMethod: Not what you're looking for.\
\
You can control the content type of the returned data with the `-ContentType` parameter.\
\
Copy\
\
New-PSUEndpoint -Url '/file' -Method Get -Endpoint {\
New-PSUApiResponse -Body "12" -ContentType 'text/xml'\
}\
\
You can control the response headers with a hashtable of values that you pass to the `-Headers`parameter.\
\
Copy\
\
New-PSUApiResponse -StatusCode 200 -Headers @{\
"Referrer-Policy" = "no-referrer"\
}\
\
[](https://docs.powershelluniversal.com/api/endpoints#persistent-runspaces)\
\
Persistent Runspaces\
\
\
-----------------------------------------------------------------------------------------------------\
\
Persistent runspaces allow you to maintain runspace state between API calls. This is important for users that perform some sort of initialization within their endpoints that they do not want to execute on subsequent API calls.\
\
By default, runspaces are reset after each execution. This removes variables, modules and functions defined during the execution of the API.\
\
To enable persistent runspaces, you will need to configure an [environment](https://docs.powershelluniversal.com/config/environments)\
for your API. Set the `-PersistentRunspace` parameter to enable this feature. This is configured in the `environments.ps1` script.\
\
Copy\
\
New-PSUEnvironment -Name 'Env' -Path 'powershell.exe' -PersistentRunspace\
\
You can then assign the API environment in the `settings.ps1` script.\
\
Copy\
\
Set-PSUSetting -ApiEnvironment 'Env'\
\
[](https://docs.powershelluniversal.com/api/endpoints#timeout)\
\
Timeout\
\
\
---------------------------------------------------------------------------\
\
By default, endpoints will not time out. To set a timeout for your endpoints, you can use the `New-PSUEndpoint` `-Timeout` parameter. The timeout is set in the number of seconds.\
\
[](https://docs.powershelluniversal.com/api/endpoints#external-endpoint-content)\
\
External Endpoint Content\
\
\
---------------------------------------------------------------------------------------------------------------\
\
You can define the path to an external endpoint content file with the `-Path` parameter of `New-PSUEndpoint`. The path is relative to the `.universal` directory in Repository.\
\
The content of the `endpoints.ps1` file is then this:\
\
Copy\
\
New-PSUEndpoint -Url "/path" -Path "endpoint-path.ps1"\
\
[](https://docs.powershelluniversal.com/api/endpoints#c-apis)\
\
C# APIs\
\
\
--------------------------------------------------------------------------\
\
C# APIs are enabled as a [plugin](https://docs.powershelluniversal.com/platform/plugins#c-api-environment)\
.\
\
There is no UI for creating a C# API, so you need to do so using configuration files. First, create a `.cs` file that runs your API.\
\
You will have access to a `request` parameter that includes all the data about the API request.\
\
Copy\
\
public class ApiRequest\
{\
public long Id;\
public ICollection Variables;\
public IEnumerable Files { get; set; };\
public string Url;\
public ICollection Headers;\
public byte[] Data;\
public int ErrorAction;\
public ICollection Parameters;\
public string Method;\
public ICollection Cookies;\
public string ClaimsPrincipal;\
public string ContentType;\
}\
\
You will also have access to a `ServiceProvider` property that allows you to access services within PowerShell Universal. These are not currently well-documented, but below is an example of restarting a dashboard.\
\
Copy\
\
var dm = ServiceProvider.GetService(typeof(IDashboardManager));\
var dashboard = dm.GetDashboard(1);\
dm.Restart(dashboard);\
\
Some other useful services include:\
\
* IDatabase\
\
* IApiService\
\
* IConfigurationService\
\
* IJobService\
\
\
You can choose to return an `ApiResponse` from your endpoint.\
\
Copy\
\
return new ApiResponse {\
StatusCode = 404\
};\
\
Once you have defined your C# endpoint file, you can add it by editing `endpoints.ps1`.\
\
Copy\
\
New-PSUEndpoint -Url /csharp -Path endpoint.cs -Environment 'C#'\
\
The PowerShell Universal service automatically compiles and runs C# endpoints.\
\
[](https://docs.powershelluniversal.com/api/endpoints#api)\
\
API\
\
\
-------------------------------------------------------------------\
\
* [New-PSUEndpoint](https://github.com/ironmansoftware/universal-docs/blob/v5/cmdlets/New-PSUEndpoint.txt)\
\
* [Get-PSUEndpoint](https://github.com/ironmansoftware/universal-docs/blob/v5/cmdlets/Get-PSUEndpoint.txt)\
\
* [Remove-PSUEndpoint](https://github.com/ironmansoftware/universal-docs/blob/v5/cmdlets/Remove-PSUEndpoint.txt)\
\
* [New-PSUApiResponse](https://github.com/ironmansoftware/universal-docs/blob/v5/cmdlets/New-PSUApiResponse.txt)\
\
* [Set-PSUSetting](https://github.com/ironmansoftware/universal-docs/blob/v5/cmdlets/Set-PSUSetting.txt)\
\
\
[PreviousAbout](https://docs.powershelluniversal.com/api/about)\
[NextOpenAPI](https://docs.powershelluniversal.com/api/openapi)\
\
Last updated 3 months ago\
\
Was this helpful?
---
# Error Handling | PowerShell Universal
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.
[](https://docs.powershelluniversal.com/api/error-handling#automatically-returning-errors)
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.
Copy
New-PSUEndpoint -Url "/error" -Endpoint {
throw "Uh oh!"
} -ErrorAction stop
New-PSUEndpoint -Url /error2 -Endpoint {
Write-Error "Whoa!"
} -ErrorAction Stop
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.
Copy
PS C:\Users\adamr> invoke-restmethod http://localhost:5000/error2
invoke-restmethod : The remote server returned an error: (500) Internal Server Error.
At line:1 char:1
+ invoke-restmethod http://localhost:5000/error2
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : InvalidOperation: (System.Net.HttpWebRequest:HttpWebRequest) [Invoke-RestMethod], Web
Exception
+ FullyQualifiedErrorId : WebCmdletWebResponseException,Microsoft.PowerShell.Commands.InvokeRestMethodCommand
In PowerShell 7, when an error is returned, you will see the error message returned.
Copy
PS C:\Users\adamr\Desktop> invoke-restmethod http://localhost:5000/error
Invoke-RestMethod: Uh oh!
at , : line 2
at , : line 1
PS C:\Users\adamr\Desktop> invoke-restmethod http://localhost:5000/error2
Invoke-RestMethod: Whoa
at , : line 2
at , : line 1
You can retrieve the error message in Windows PowerShell, by using the following syntax.
Copy
PS C:\Users\adamr> try { invoke-restmethod http://localhost:5000/error2 } catch { [System.IO.StreamReader]::new($_.Exception.Response.GetResponseStream()).ReadToEnd()}
Whoa!
at , : line 2
at , : line 1
[](https://docs.powershelluniversal.com/api/error-handling#manually-returning-errors)
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.
Copy
New-PSUEndpoint -Url /broken -Endpoint {
New-PSUApiResponse -StatusCode 404 -Body 'Failed!'
}
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.
Copy
PS C:\Users\adamr\Desktop> invoke-restmethod http://localhost:5000/broken
Invoke-RestMethod: Failed!
If called from Windows PowerShell, you will receive an error similar to the one returned automatically.
Copy
PS C:\Users\adamr> invoke-restmethod http://localhost:5000/broken
invoke-restmethod : The remote server returned an error: (404) Not Found.
At line:1 char:1
+ invoke-restmethod http://localhost:5000/broken
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : InvalidOperation: (System.Net.HttpWebRequest:HttpWebRequest) [Invoke-RestMethod], Web
Exception
+ FullyQualifiedErrorId : WebCmdletWebResponseException,Microsoft.PowerShell.Commands.InvokeRestMethodCommand
You can choose to return error codes if certain conditions are met by using your PowerShell script within the endpoint.
Copy
New-PSUEndpoint -Url /user/:name -Endpoint {
if ($Name -eq 'User')
{
@{ UserName = "Adam" }
}
else
{
New-PSUApiResponse -StatusCode 404 -Body 'Unknown user!'
}
}
[](https://docs.powershelluniversal.com/api/error-handling#api)
API
------------------------------------------------------------------------
* [New-PSUEndpoint](https://github.com/ironmansoftware/universal-docs/blob/v5/cmdlets/New-PSUEndpoint.txt)
* [Get-PSUEndpoint](https://github.com/ironmansoftware/universal-docs/blob/v5/cmdlets/Get-PSUEndpoint.txt)
* [Remove-PSUEndpoint](https://github.com/ironmansoftware/universal-docs/blob/v5/cmdlets/Remove-PSUEndpoint.txt)
* [New-PSUApiResponse](https://github.com/ironmansoftware/universal-docs/blob/v5/cmdlets/New-PSUApiResponse.txt)
* [Set-PSUSetting](https://github.com/ironmansoftware/universal-docs/blob/v5/cmdlets/Set-PSUSetting.txt)
[PreviousSecurity](https://docs.powershelluniversal.com/api/security)
[NextRate Limiting](https://docs.powershelluniversal.com/api/rate-limiting)
Last updated 9 months ago
Was this helpful?
---
# Security | PowerShell Universal
Once enabled, you will be able to enforce authentication and authorization on your endpoints.
[](https://docs.powershelluniversal.com/api/security#defining-secure-endpoints)
Defining Secure Endpoints
--------------------------------------------------------------------------------------------------------------
You can define secure endpoints in the UI by enabling authentication. You will endpoint authentication and authorization under the Security tab of an endpoint's properties.
You can also define secure endpoints using the `.universal/endpoints.ps1` file or the Management API using `New-PSUEndpoint`.
Copy
New-PSUEndpoint -Url '/endpoint' -Method 'GET' -Endpoint {
"Hello, world!"
} -Authentication
When authentication is enabled, it will enforce the use of one of the configured authentication methods. APIs support the following methods.
* JWT App Tokens
* Windows Authentication
* Cookie Authentication
* Basic Authentication
[](https://docs.powershelluniversal.com/api/security#accessing-secure-endpoints)
Accessing Secure Endpoints
----------------------------------------------------------------------------------------------------------------
Once you have defined a secure endpoint, you will need to provide authentication and authorization to access the endpoint.
###
[](https://docs.powershelluniversal.com/api/security#authenticating-with-tokens)
Authenticating with tokens
Note that if you are hosting in IIS and do not have Anonymous Authentication enabled, you will not be able to pass app tokens to the PowerShell Universal server.
To authenticate with tokens, first, you need generate a new app token for use. You can use the `Grant-PSUAppToken` cmdlet to do so remotely or you can create an app token in the UI using the Settings Security AppTokens tab.
Hover over your user name in the top right of the admin console, click Tokens and click Create Application Token.
Once you have created your app token, you can now use it to authenticate against the secure endpoint. To do so, pass the Authorization header along with the request.
Copy
Invoke-RestMethod http://localhost:5000/auth -Headers @{ Authorization = "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQWRtaW4iLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9oYXNoIjoiMWUyY2IzNzAtMmMyNS00ZDU5LTk4YzgtMzc5MTFjMDAyZmI5Iiwic3ViIjoiUG93ZXJTaGVsbFVuaXZlcnNhbCIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFkbWluaXN0cmF0b3IiLCJuYmYiOjE2MDU2NjEyNTUsImV4cCI6MTYzNzM2NzI1OCwiaXNzIjoiSXJvbm1hblNvZnR3YXJlIiwiYXVkIjoiUG" }
####
[](https://docs.powershelluniversal.com/api/security#custom-authorization-header)
Custom Authorization Header
PowerShell Universal provides a custom authorization header to support scenarios with reverse proxies that may require their own Authorization header. If the `X-PSU-Authorization` header is specified, PSU will ignore the `Authorization` header and use this header instead.
Copy
Invoke-RestMethod http://localhost:5000/auth -Headers @{
Authorization = "Bearer msft_xyz_123"
'X-PSU-Authorization' = 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQWRtaW4iLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9oYXNoIjoiMWUyY2IzNzAtMmMyNS00ZDU5LTk4YzgtMzc5MTFjMDAyZmI5Iiwic3ViIjoiUG93ZXJTaGVsbFVuaXZlcnNhbCIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFkbWluaXN0cmF0b3IiLCJuYmYiOjE2MDU2NjEyNTUsImV4cCI6MTYzNzM2NzI1OCwiaXNzIjoiSXJvbm1hblNvZnR3YXJlIiwiYXVkIjoiUG'
}
###
[](https://docs.powershelluniversal.com/api/security#authenticating-with-windows-authentication)
Authenticating with Windows Authentication
To authenticate with [Windows Authentication](https://docs.powershelluniversal.com/security/security#windows-authentication-in-iis)
, you can use the `-UseDefaultCredentials` parameter of `Invoke-RestMethod` and `Invoke-WebRequest` . This will perform negotiate authentication whether you are running inside IIS or a service.
Copy
Invoke-RestMethod http://localhost:5000/auth -UseDefaultCredentials
###
[](https://docs.powershelluniversal.com/api/security#authenticating-with-cookies)
Authenticating with Cookies
To authenticate with cookies, you will first need to call the login API to receive a valid cookie from the system. You can use `Invoke-WebRequest` to do so. Pass the user name and password as the body. Specify the `-SessionVariable` parameter to establish a session.
Copy
Invoke-WebRequest http://localhost:5000/api/v1/signin -Body (@{
UserName = "Admin"
Password = "Any"
} | ConvertTo-Json) -ContentType 'application/json' -SessionVariable mySession -Method POST
Once you have successfully authenticated, you can use your `$mySession` variable to call secure endpoints.
Copy
Invoke-WebRequest http://localhost:5000/auth -WebSession $mySession
[](https://docs.powershelluniversal.com/api/security#enforcing-roles)
Enforcing Roles
------------------------------------------------------------------------------------------
In addition to creating endpoints that require authentication, you can also enforce roles by define a role in the `New-PSUEndpoint` cmdlet or by selecting one in the UI. If a role is selected, it's possess the role.
Windows and Cookie authentication will assign roles based on the Identity of the user and the role policies as they are applied.
JWT app tokens will use the role that was defined when they were generated.
[](https://docs.powershelluniversal.com/api/security#api)
API
------------------------------------------------------------------
* [New-PSUEndpoint](https://github.com/ironmansoftware/universal-docs/blob/v5/cmdlets/New-PSUEndpoint.txt)
* [Get-PSUEndpoint](https://github.com/ironmansoftware/universal-docs/blob/v5/cmdlets/Get-PSUEndpoint.txt)
* [Remove-PSUEndpoint](https://github.com/ironmansoftware/universal-docs/blob/v5/cmdlets/Remove-PSUEndpoint.txt)
* [New-PSUApiResponse](https://github.com/ironmansoftware/universal-docs/blob/v5/cmdlets/New-PSUApiResponse.txt)
* [Set-PSUSetting](https://github.com/ironmansoftware/universal-docs/blob/v5/cmdlets/Set-PSUSetting.txt)
[PreviousEvent Hubs](https://docs.powershelluniversal.com/api/event-hubs)
[NextError Handling](https://docs.powershelluniversal.com/api/error-handling)
Last updated 2 months ago
Was this helpful?
---
# Rate Limiting | PowerShell Universal
Rate limiting requires a [license](https://ironmansoftware.com/pricing/powershell-universal)
.
PowerShell Universal lets you rate limit requests made to the web server. You can configure rate limiting per endpoint and per period. By default, the client IP address rate limits clients.
Configuration data for rate limits are stored in the `ratelimits.ps1` file.
[](https://docs.powershelluniversal.com/api/rate-limiting#configuring-rate-limiting)
Configuring Rate Limiting
-------------------------------------------------------------------------------------------------------------------
To configure rate limiting, visit the APIs / Rate Limiting page. Click the Add button and define a new rate limit rule.
Rate limiting affects all URLs for the server. If you enforce rate limiting that isn't correctly configured, you can negatively affect the management API.
###
[](https://docs.powershelluniversal.com/api/rate-limiting#method)
Method
The method is the HTTP method to for this rule. If you use `*` , this rule affects all HTTP methods. You can also select a single method by picking it from the drop down.
###
[](https://docs.powershelluniversal.com/api/rate-limiting#endpoint)
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 defining the relative path: `/api/user`.
###
[](https://docs.powershelluniversal.com/api/rate-limiting#limit)
Limit
This is the number of requests in the time frame before rate limiting kicks in.
###
[](https://docs.powershelluniversal.com/api/rate-limiting#period)
Period
This is 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.
[](https://docs.powershelluniversal.com/api/rate-limiting#allow-lists)
Allow Lists
---------------------------------------------------------------------------------------
To disable rate limiting for particular IP Addresses, clients, and endpoints, add them to the rate limiting allow lists. Find these by clicking the settings button.
The below example prevents the loopback adapter from being rate limited.
Copy
Set-PSUSetting -RateLimitIpAddressAllowList @("127.0.0.1")
[](https://docs.powershelluniversal.com/api/rate-limiting#example-limit-custom-api)
Example: Limit Custom API
------------------------------------------------------------------------------------------------------------------
Limits callers of the `/api/users` endpoint to 100 requests per minute.
Copy
New-PSURateLimit -Endpoint "GET|/api/users" -TimeSpan "00:01:00" -Limit 100
[](https://docs.powershelluniversal.com/api/rate-limiting#example-limit-management-api)
Example: Limit Management API
--------------------------------------------------------------------------------------------------------------------------
Limits callers of the management API to 100 requests per second.
Copy
New-PSURateLimit -Endpoint "*|/api/v1/*" -TimeSpan "00:00:01" -Limit 100
[](https://docs.powershelluniversal.com/api/rate-limiting#api)
API
-----------------------------------------------------------------------
* [New-PSURateLimit](https://github.com/ironmansoftware/universal-docs/blob/v5/cmdlets/New-PSURateLimit.txt)
* [Set-PSUSetting](https://github.com/ironmansoftware/universal-docs/blob/v5/cmdlets/Set-PSUSetting.txt)
[PreviousError Handling](https://docs.powershelluniversal.com/api/error-handling)
[NextAbout Automation](https://docs.powershelluniversal.com/automation/about)
Last updated 4 days ago
Was this helpful?
---
# Email Protection | Cloudflare
Please enable cookies.
Email Protection
================
You are unable to access this email address docs.powershelluniversal.com
------------------------------------------------------------------------
The website from which you got to this page is protected by Cloudflare. Email addresses on that page have been hidden in order to keep them from being accessed by malicious bots. **You must enable Javascript in your browser in order to decode the e-mail address**.
If you have a website and are interested in protecting it in a similar way, you can [sign up for Cloudflare](https://www.cloudflare.com/sign-up?utm_source=email_protection)
.
* [How does Cloudflare protect email addresses on website from spammers?](https://developers.cloudflare.com/waf/tools/scrape-shield/email-address-obfuscation/)
* [Can I sign up for Cloudflare?](https://developers.cloudflare.com/fundamentals/setup/account/create-account/)
Cloudflare Ray ID: **96be3a3e4e3fde83** • Your IP: Click to reveal 54.237.218.47 • Performance & security by [Cloudflare](https://www.cloudflare.com/5xx-error-landing)
---