Skip to content
This repository has been archived by the owner on Nov 23, 2022. It is now read-only.

Using The JumpCloud Dashboard Module

Jump to bottom
scottd3v edited this page Apr 8, 2020 · 6 revisions

Using the JumpCloud Dashboard Module

Basic Usage

Need to install the module? See Installing the JumpCloud.Dashboard PowerShell Module

Launching the JumpCloud Dashboard

After the JumpCloud module is installed run the command:

Start-JCDashboard

Authenticate the module to JumpCloud using a JumpCloud API key.

Locate your JumpCloud API key within the JumpCloud admin console. Need help finding your JumpCloud API key? Follow this link.

Example:

/Users/buster> Start-JCDashboard

cmdlet Connect-JCOnline at command pipeline position 1
Supply values for the following parameters:
(Type !? for Help.)
JumpCloudApiKey:

If there is an update available for the module you will be asked if you would like to update.

The dashboard will load inside your default web browser.

Displaying Systems That Have Been Online Within The Last X Days

The -LastContactDays parameter of the Start-JCDashboard function can be used to specify which systems to load into dashboard components based on the systems last contact date.

Start-JCDashboard -LastContactDays 10

Launches the JumpCloud Dashboard and only displays systems that have contacted JumpCloud in the last 10 days.

Start-JCDashboard -LastContactDays 30

Launches the JumpCloud Dashboard and only displays systems that have contacted JumpCloud in the last 30 days.

Configuring the Refresh Interval of the Dashboard Components

The -RefreshInterval parameter of the Start-JCDashboard function can be used to specify how often dashboard components refresh. This parameter value is defined in seconds. If your organization has a high number of users and systems increasing this value can improve overall performance of the dashboard.

The default value for the refresh interval is 60 seconds.

Start-JCDashboard -RefreshInterval 30

Launches the JumpCloud Dashboard and sets the component refresh interval to 30 seconds.

Start-JCDashboard -RefreshInterval 300

Launches the JumpCloud Dashboard and sets the component refresh interval to 5 minutes (300 seconds).

Layout Options

The components of the JumpCloud Dashboard can be viewed together on a single dashboard page (default view) or one at a time on standalone pages (singleComponent view) the -Layout parameter of Start-JCDashboard can be used to toggle between layout options.

Viewing Dashboard Components One At A Time

Start-JCDashboard -Layout singleComponent

When calling Start-JCDashboard with the singleComponent layout the dashboard will load only one dashboard component at a time and cycle through the specified dashboard components. Find below a list of all dashboard components. If the -includeComponent or -excludeComponent parameters are not specified all components will be cycled.

Setting The Component Cycle Interval

The default cycle interval when viewing more then one component with the singleComponent layout is 60 seconds. The cycle interval can be specified using the -CycleInterval parameter.

Start-JCDashboard -Layout singleComponent -CycleInterval 15

Launches all components of the JumpCloud dashboard one at a time with a 15 second page cycle interval.

Start-JCDashboard -Layout singleComponent -CycleInterval 300

Launches all components of the JumpCloud dashboard one at a time with a 300 second page cycle interval.

Viewing Specific Dashboard Components One At A Time

The parameters -IncludeComponent or -ExcludeComponent can be used to view specific dashboard components when calling -Layout singleComponent.

User Dashboard Components

Component Name Component Type Description
user_mfaStatus Doughnut chart Displays user MFA configuration state
user_newUsers List Displays users created in last 7 days
user_passwordChanges List Displays recent password changes
user_passwordExpirations List Displays users with upcoming password expirations
user_privilegedUsers List Displays users configured with privileged JumpCloud access
user_userStates List Displays users in actionable states (locked out, expired, suspended)

System Dashboard Components

Component Name Component Type Description
system_agentVersion Bar chart Displays systems agent version
system_lastContact Bar chart Displays systems last contact date
system_mfaStatus Doughnut chart Displays system MFA configuration state
system_newSystems List Displays systems created in last 7 days
system_os Doughnut chart Displays systems operating system
system_version Bar chart Displays systems operating system version

Associations Dashboard Components

Component Name Component Type Description
associations_o365 Doughnut chart Displays Office 365 bound users
associations_gsuite Doughnut chart Displays Google Suite bound users
associations_ldap Doughnut chart Displays LDAP bound users
associations_radius List Displays Radius servers and Group associations
associations_useractivationstatus Doughnut chart Displays active and inactive users
associations_syspolicy List Displays system policy user and group associations

Using IncludeComponent

The -IncludeComponent parameter can be used when calling -Layout singleComponent to view specific dashboard components.

Start-JCDashboard -Layout singleComponent -IncludeComponent user_mfaStatus, system_mfaStatus

Launches the JumpCloud dashboard in single component layout mode and only cycles between the user_mfaStatus and system_mfaStatus components

Using ExcludeComponent

The -ExcludeComponent parameter can be used when calling -Layout singleComponent to exclude viewing specific dashboard.

Start-JCDashboard -Layout singleComponent -ExcludeComponent system_os, system_version, user_mfaStatus

Launches the JumpCloud dashboard in single component layout mode and launches all components except the system_os, system_version, and user_mfaStatus components

Troubleshooting Tips

Unable to run Start-JCDashboard? If you're running PowerShell core make sure your PowerShell core version is at least version 6.2 or above.

The command $PSVersionTable can be used to check the version of PowerShell installed.

/Users/buster> $PSVersionTable

Name                           Value
----                           -----
PSVersion                      6.2.4
PSEdition                      Core
GitCommitId                    6.2.4
OS                             Darwin 18.7.0 Darwin Kernel Version 18.7.0: Sun Dec  1 18:59:03 PST 2019; root:xnu-4903.278.19~1/REL…
Platform                       Unix
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

The module PSCoreUpdate can be used to update PowerShell Core directly from the PowerShell terminal

Install-Module PSCoreUpdate -force -Scope CurrentUser
Update-PowerShellCore

Quick Links

Command Reference

Clone this wiki locally