v2.0.0
Universal Dashboard is now a part of PowerShell Universal. This documentation is for reference to the v2 version of Universal Dashboard and is no longer maintained. PowerShell Universal Documentation can be found here.
Released: August 31st, 2018
Universal Dashboard Community Edition is now available on the Gallery. This free and open-source version of Universal Dashboard has no time limits and can be used to create beautiful websites and REST APIs without paying a licensing cost.
Install-Module UniversalDashboard.Community
Universal Dashboard Enterprise Edition builds on top of what's available in Community Edition but extends the platform to enable authentication, authorization and branding support.
Install-Module UniversalDashboard
A tree view control has been added to allow you to expose and navigate tree structures in UD. You can hook into PSProviders and handle click events to display data.
A floating action button is a button pinned to the bottom right of the page. It allows you to put some simple, easy to access controls on your dashboard. They support nested buttons and onClick event handlers.
In previous versions of UD, you could send toast messages view Send-UDToast. In 2.0, you can now create extremely customized toast messages that allow you to configure colors, text size, icons and timing. Using Show-UDToast and Hide-UDToast you have total control over the toast messages.
There was no good way to serve any old file in previous versions of Universal Dashboard. The newly added Publish-UDFolder cmdlet enables just that. You can now publish any folder you'd like and assign a URL to it.
Start-UDRestApi -Port 10001 -PublishedFolder @(
Publish-UDFolder -Path $TempPath -RequestPath "/temp"
)
Invoke-WebRequest http://localhost:10001/temp/myFile.txt
Up until this version of you would use the EndpointInitializationScript to setup the endpoints for UD components. The ScriptBlock was converted into a string and wasn't a good way to actually initialize the endpoints. It made it difficult to import modules, load function and variables into endpoints.
With 2.0, you can now use the New-UDEndpointInitialization cmdlet to create an InitialSessionState object. This object is used to initialize all the runspaces used within UD. This is a standard PowerShell object and can be used to add modules, variables and functions to the runspaces.
$Initialization = New-UDEndpointInitialization -Module MyModule -Variable "MyVariable" -Function 'Get-Stuff'
$dashboard = New-UDDashboard -Title "Test" -Content {
New-UDCounter -Title "Counter" -Id "Counter" -Endpoint {
# Function exported from MyModule
Get-Number
}
New-UDElement -tag "div" -Id "variable" -Content {
$MyVariable
}
New-UDElement -tag "div" -Id "function" -Content {
Get-Stuff
}
} -EndpointInitialization $Initialization
In previous versions of Universal Dashboard, variables were "automatically" added to Endpoints based on the local scope. This meant that you didn't really have to do anything to get variables into an endpoint. It didn't work very well all the time. :( Although this automatic import is still happening, you now have more control over endpoints. You can now use
New-UDEndpoint and a handy new -ArgumentList parameter to pass in values to your endpoints.This will work for event handlers as well as controls with Endpoint callbacks.
$Name = "calc"
New-UDButton -Text 'Start Calc' -Id 'button' -OnClick (
New-UDEndpoint -Endpoint { Start-Process $ArgumentList[0] } -ArgumentList $Name
)
Universal Dashboard has offered authentication for a few versions now via login pages and JSON Web Tokens. In this version we are now introducing authorization. The first type of authorization that you can utilize is role-based access. You can assigning roles to pages and REST API endpoints to allow only certain roles access to those pages or endpoints. Pages that aren't accessible won't even show up in the navigation menu.
When a user logs in, you can assign roles to that user. In the below example, Adam is assigned the Admin role on login. The Home and Settings pages allow Admins to access them while only Users cannot access the Settings page.
$AuthenticationMethod = New-UDAuthenticationMethod -Endpoint {
param([PSCredential]$Credential)
elseif ($Credential.UserName -eq "Adam") {
New-UDAuthenticationResult -UserName "Adam" -Success -Role "Admin"
} else {
New-UDAuthenticationResult -ErrorMessage "You're not Adam!!"
}
}
$LoginPage = New-UDLoginPage -AuthenticationMethod $AuthenticationMethod
$dashboard = New-UDDashboard -Title "Test" -LoginPage $LoginPage -Pages @(
New-UDPage -Name "Home" -Content {
New-UDHeading -Text "Home" -Id "Home"
} -AuthorizedRole @("User", "Admin")
New-UDPage -Name "Settings" -Content {
New-UDHeading -Text "Settings" -Id "Settings"
New-UDElement -Tag "div" -Id "myEndpoint" -Endpoint {
"Test"
}
} -AuthorizedRole "Admin"
)
In addition to role-based authorization, you can also use policy-based authorization. Policy authorization allows you to evaluate a user's claims and decide whether the user has access to a particualr page or endpoint.
Policy-based authorization works well for 3rd party authentication mechanisms. You can check claims provided by services such as Azure Active Directory. This means you don't need to update a dashboard to change the access of users to the dashboard.
In the below example, the policy is checks to see if the user has a groups claim with a value of administrators. If they as part of this group, they have access to the setting page.
$AuthorizationPolicy = New-UDAuthorizationPolicy -Name "Policy" -Endpoint {
param($User)
$User.HasClaim("groups", "administrators")
}
$LoginPage = New-UDLoginPage -AuthenticationMethod $AuthenticationMethod -AuthorizationPolicy @($AuthorizationPolicy)
$dashboard = New-UDDashboard -Title "Test" -LoginPage $LoginPage -Pages @(
New-UDPage -Name "Home" -Content {
New-UDHeading -Text "Home" -Id "Home"
}
New-UDPage -Name "Settings" -Content {
New-UDHeading -Text "Settings" -Id "Settings"
New-UDElement -Tag "div" -Id "myEndpoint" -Endpoint {
"Test"
}
} -AuthorizationPolicy "Policy"
)
New-UDAuthenticationMechanism now supports configuring Azure Active Directory Authentication. Paired with policy-based authentication, you can assign users to groups that have access to particular pages and endpoints within Universal Dashboard.
UD has been upgraded to use ASP.NET 2.1. Because of this the following system requirements are necessary for UD 2.0.
Window PowerShell
- PowerShell v5.1
- .NET 4.7.1
PowerShell Core
- PowerShell Core v6.1
The
-DebugEndpoint parameter has been removed. Guidance is to use Wait-Debugger within Endpoints for debugging.The
-EndpointInitializationScript parameter has been removed from New-UDDashboard cmdlet. It is suggested to use the New-UDEndpointInitialization cmdlet instead.The
-DateTimeFormat parameter has been moved from New-UDTable to Out-UDTableData.With the addition of Hide-UDToast, it made sense to rename Send-UDToast to Show-UDToast.
Last modified 2yr ago