Skip to content

What is the JumpCloud PowerShell Module

Scott Reed edited this page Jan 29, 2020 · 2 revisions

What is the JumpCloud PowerShell Module?

If you read the article on What is PowerShell? then you know that PowerShell is is a task automation and configuration management framework from Microsoft that was made open-source and cross-platform on August 18th 2016.

A PowerShell module is a set of related PowerShell commands that are grouped together and can be installed on a machine running PowerShell.

The JumpCloud PowerShell Module is a set of PowerShell commands that allow JumpCloud administrators to interact with their JumpCloud directory.

The JumpCloud PowerShell module is at its core a wrapper for the JumpCloud API and communicates with the JumpCloud API using the Invoke-RestMethod PowerShell command over HTTPS.

Common administrative tasks that can be automated or scripted using the JumpCloud PowerShell module include

  • Importing JumpCloud users from a .csv file
  • Exporting JumpCloud user and system information to a .csv file
  • Creating and removing JumpCloud users
  • Resetting a JumpCloud user password
  • Unlocking or locking a JumpCloud user account
  • Disabling and enabling JumpCloud user accounts
  • Adding or removing members from a JumpCloud Group
  • Triggering JumpCloud Commands
  • Reading the output of JumpCloud Commands

PowerShell Misconceptions

PowerShell only works on Windows

PowerShell comes preinstalled on Windows but can easily be installed on both Mac and Linux.

Find a full list of support platforms with download instructions here

You have to have programming experience to use PowerShell

This could not be farther from the truth. PowerShell uses a verb-noun naming convention for executing PowerShell commands. This verb-noun syntax makes PowerShell both easy to learn and understand.

Commands within in the JumpCloud module can perform actions like creating a new JumpCloud user (New-JCUser) or getting information on a JumpCloud managed system (Get-JCSystem).

Sold?

Check out Installing the JumpCloud PowerShell Module

Quick Links

Command Reference

Authentication

Import and Backup

RADIUS Reply Attributes

User Functions

Administrator Functions

System Functions

Command Functions

Group Functions

Policy Functions

Event Functions

Clone this wiki locally