Home
- What is the JumpCloud.Dashboard PowerShell Module
- How does the JumpCloud.Dashboard Module Work?
- Getting Started with the JumpCloud.Dashboard PowerShell Module
The JumpCloud.Dashboard PowerShell module contains a single PowerShell function Start-JCDashboard.
When the Start-JCDashboard function is called dashboards containing valuable JumpCloud directory information load within the default web browser on the local system.
The PowerShell terminal that calls the Start-JCDashboard command becomes the web server which hosts the webpage for the system that called the Start-JCDashboard function in the systems default browser.
The PowerShell terminal acts as a webserver using the PowerShell Universal Dashboard web framework and only hosts the web page for the local machine.
No external systems can reach the web page hosted by the PowerShell terminal.
The webpage will continue to refresh as long as the PowerShell terminal which calls the Start-JCDashboard command stays open and operational.
The default port used by the JumpCloud.Dashboard module is 8003 on local host 127.0.0.1.
The default refresh time is 30 seconds for the users dashboard 60 seconds for the systems dashboard.
When the Start-JCDashboard function is called users are prompted to authenticate with a JumpCloud API key.
This API key is used to query and compile data from a JumpCloud organization using functions in the JumpCloud Powershell module.
- Note the JumpCloud.Dashboard module only gathers data using "GET" commands. No calls to modify directory objects are made using this module.
Data is displayed in dashboards using functions in the Universal Dashboard Community module. Dashboards load graphic using the UniversalDashboard.UDunDraw module.
The JumpCloud.Dashboard PowerShell module is dependant on and requires the below modules to run:
For more information on the install process, check out the Installing the JumpCloud Dashboard Module wiki article.
For more information on running the JumpCloud Dashboard, check out the Running the JumpCloud Dashboard Module wiki article and the Start-JCDashboard documentation.