Dashboard Prerequisites

Product: PowerShell Universal
Version: 2.3.0

What are the prerequisites for a dashboard? Seeking clarification on what I can do/look for to ensure high availability during upgrades/reboot of server.

1) What modules need to be installed?
   - I have been running into an issue where I have a functional dashboard but after upgrading a version or rebooting my server, the dashboard displays a the following error message:
"Cannot validate argument on parameter 'Id'. The argument is null. Provide a valid value for the argument, and then try running the command again". 
This happened after upgrading from 2.2.1 to 2.3.0 (dashboard was working normally prior to upgrade). I have seen this before and I think I had to reimport a module or two but seeking clarification to know what is specifically required (and potentially automate that piece).

2) When I update my PSU version, is it required that I update my Universal module package too? Sometimes I see a warning message when running the dashboard script in Visual Studio Code "Module version x does not match server version x.

4) Can the modules be installed automatically or do I have to manually import the modules when I upgrade my PSU version or reboot the server in order for my dashboard to work without errors again?

5) Acknowledging that the PowerShell Universal windows service needs to be in a running state (also verify the account being used on this service is enabled and the password is up to date).

6) Do I need to keep my app token in my dashboard script and insert into the "Connect-PSUServer" -apptoken parameter so that I am connected every time the dashboard is started?
  1. What modules need to be installed?

You shouldn’t have to install additional modules. PowerShell Universal comes with the latest version of both Universal and UniversalDashboard. I’d be curious to locate where this issue is coming from because it seems like we have inadvertently removed an Id parameter somewhere.

  1. When I update my PSU version, is it required that I update my Universal module package too? Sometimes I see a warning message when running the dashboard script in Visual Studio Code "Module version x does not match server version x.

While the PSU modules are installed into the PSU installation directory, they are not included in the $PSModulePath. I’d like to change that so everything is just installed via the MSI. But in the meantime, that means that the Universal and UniversalDashboard modules are not discoverable by PowerShell consoles by default. They are only discoverable by PSU itself.

So you will need to upgrade the modules when updating PSU for this reason.

  1. Can the modules be installed automatically or do I have to manually import the modules when I upgrade my PSU version or reboot the server in order for my dashboard to work without errors again?

Your dashboard should just work after upgrade. The modules are included with PSU and loaded from the PSU directory when the dashboard is started.

  1. Acknowledging that the PowerShell Universal windows service needs to be in a running state (also verify the account being used on this service is enabled and the password is up to date).

Correct.

  1. Do I need to keep my app token in my dashboard script and insert into the “Connect-PSUServer” -apptoken parameter so that I am connected every time the dashboard is started?’

Correct. If you are using any of Universal cmdlets in your dashboard, you will need to use an app token to connect to the PSU management API.

It is possible to grant an app token automatically but this app token will have the same rights as the user accessing the dashboard: Dashboards - PowerShell Universal

The error with the -ID parameter has been located. It had to do with the PSSessions not being created successfully (tracking this is here: PSSession Error in 2.3.0).

  1. Thanks for the clarification on when its recommended to update the modules. I’ll be sure to update them whenever updating the PSU version.

  2. It seems like the dashboards are working better than in times past post upgrades from my experience. I just rebooted for the first time since updating from 2.2.1 to 2.3.0 and my dashboard was working without me having to manually configure anything or import any modules etc. I was previously running into an issue here but things appear to be much better!

  3. Thanks for the confirmation here too on the app token. I’ll be sure to keep that in the dashboard script and update that whenever I change the credentials to a newly created service account (strictly used to run dashboards only).

Thanks for all the insight! Hope it helps others move along in their installs/configurations.