Installing the JumpCloud PowerShell Module - TheJumpCloud/support GitHub Wiki

• Installing the JumpCloud PowerShell Module
  • Authenticating the JumpCloud PowerShell Module
  • Usage Examples
  • Built In Help
• Installing PowerShell on Mac and Linux
• Windows Troubleshooting Tips
• Visual learner? Navigate To Our YouTube JumpCloud PowerShell Module Installation Tutorials

Installing the JumpCloud PowerShell module can be done by running a single command.

• On a Mac or Linux machine and need to install PowerShell? See Installing PowerShell on Mac and Linux

From a Windows PowerShell window launched as administrator, or a terminal window on Mac and Linux which you have launched in PowerShell by running the command pwsh, enter the command:

Install-Module JumpCloud -Scope CurrentUser

When prompted Press Y to install the JumpCloud PowerShell module

Untrusted repository
You are installing the modules from an untrusted repository. If you trust this repository, change its InstallationPolicy value by running the Set-PSRepository
cmdlet. Are you sure you want to install the modules from 'PSGallery'?
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "N"):

After the JumpCloud module is installed you will authenticate the module to the JumpCloud API using a JumpCloud API key and the function Connect-JCOnline.

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

After locating your JumpCloud API key enter the command Connect-JCOnline and enter your API key when prompted.

Example:

/Users/buster> Connect-JCOnline

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

A success message will indicate that you have successfully connected to the module.

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

Find a matrix of copy and pastable real work PowerShell examples that have been crowd sourced from JumpCloud customers within the JumpCloud PowerShell Commands Example Library.

To see all of the available commands within in the JumpCloud Module run:

Get-Command -Module JumpCloud

PowerShell has a built-in help system. To use this system type' Help 'The Command' -full' to see the full help inside the terminal

Example:

Help Get-JCUser -Full

Or run Help 'The Command' -online' to see the help in a web browser

Example:

Help Get-JCUser -Online

If you get stuck inside the help press 'Q' to exit

<U+FEFF>
(END)

If you are on Mac or Linux follow this link and locate the PowerShell package for your operating system.

Download the installation media by clicking on the hyperlink next to your operating system under the 'Downloads (stable)' header of the linked table.

Install the PowerShell application on your target system using the downloaded installation media.

Need more help? Navigate to the 'How to Install' instruction link for your operating system in the linked table.

Once PowerShell is installed PowerShell can be accessed within the terminal application on Mac or Linux system by typing: pwsh

MBP-d3v:~ scottd3v$ pwsh                                                                

PowerShell v6.0.0-rc
Copyright (c) Microsoft Corporation. All rights reserved.

https://aka.ms/pscore6-docs

Type 'help' to get help.

PS /Users/scottd3v>

You will be able to tell you are running PowerShell because the root of your terminal command line will switch to PS as seen below.

Before calling PowerShell using the pwsh command:

MBP-d3v:~ scottd3v$

After

PS /Users/scottd3v> 

In order to install the JumpCloud module from the PowerShell gallery on Windows, you must be running Windows Powershell version 5.0 or greater and have your Execution Policy set to at least RemoteSigned.

The PowerShell command $PSVersionTable will show what version of PowerShell is installed on a local machine. The 'PSVersion' will reveal the version number when using this command.

$PSVersionTable

Name                           Value
----                           -----
PSVersion                      5.1.16299.64
PSEdition                      Desktop
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}
BuildVersion                   10.0.16299.64
CLRVersion                     4.0.30319.42000
WSManStackVersion              3.0
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1

On Windows Machines the 'Execution Policy' must be set to at least 'RemoteSigned' in order to load the module. The module will install if the Execution Policy is set to 'Unrestricted' or 'ByPass' as well. To see the Execution Policy run the command 'Get-ExecutionPolicy'. To set the Execution Policy run the following command in a Windows PowerShell session launched with Administrator permissions:

Set-ExecutionPolicy RemoteSigned

Windows Server editions may not have .Net 4.7.2 preinstalled. .Net 4.7.2 is required to run the JumpCloud PowerShell Module. In addition, security configurations may be required to first install the JumpCloud PowerShell Module. If it is the case that the Nuget Package Provider is not installed, you will first be required to install Nuget before installing the JumpCloud PowerShell module. The PowerShell session may require TLS 1.2 depending on your server's security settings. Enable TLS 1.2 to search the PSGallery and install the JumpCloud Module.

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
Install-PackageProvider -Name NuGet
Install-Module -Name JumpCloud