-
Notifications
You must be signed in to change notification settings - Fork 154
Installing the JumpCloud PowerShell Module
If you're on a Windows machine Windows PowerShell comes preinstalled and can be accessed by typing 'PowerShell' into the Windows search bar and selecting the PowerShell application.
In order to install the JumpCloud module from the PowerShell gallery, you must be running Windows Powershell version 5.0 or have the PowerShellGet module installed.
The JumpCloud PowerShell module is supported on Windows PowerShell version 4.0 and newer as well as PowerShell core.
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.
PS C:\Users\buster> $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
If you are on Mac or Linux follow this link to download the installation package for your desired platform by clicking on the hyperlink for the installation media under the 'Downloads' header of the linked table.
If you wish to install PowerShell via the command line find steps for competing this on Mac using Homebrew here.
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>
From a Windows PowerShell window or a terminal window on Mac and Linux which you have launched PowerShell by calling pwsh run the command:
PS /Users/sreed> Install-Module JumpCloud -Scope CurrentUser
Press Y at the prompt to install
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"):
To see the available commands in the JumpCloud Module run:
PS /Users/sreed/Git/support> Get-Command -Module JumpCloud
CommandType Name Version Source
----------- ---- ------- ------
Function Add-JCSystemGroupMember 1.1.0 JumpCloud
Function Add-JCSystemUser 1.1.0 JumpCloud
Function Add-JCUserGroupMember 1.1.0 JumpCloud
Function Connect-JCOnline 1.1.0 JumpCloud
Function Get-JCCommand 1.1.0 JumpCloud
Function Get-JCCommandResult 1.1.0 JumpCloud
Function Get-JCGroup 1.1.0 JumpCloud
Function Get-JCSystem 1.1.0 JumpCloud
Function Get-JCSystemGroupMember 1.1.0 JumpCloud
Function Get-JCSystemUser 1.1.0 JumpCloud
Function Get-JCUser 1.1.0 JumpCloud
Function Get-JCUserGroupMember 1.1.0 JumpCloud
Function Import-JCUsersFromCSV 1.1.0 JumpCloud
Function Invoke-JCCommand 1.1.0 JumpCloud
Function New-JCImportTemplate 1.1.0 JumpCloud
Function New-JCSystemGroup 1.1.0 JumpCloud
Function New-JCUser 1.1.0 JumpCloud
Function New-JCUserGroup 1.1.0 JumpCloud
Function Remove-JCCommandResult 1.1.0 JumpCloud
Function Remove-JCSystem 1.1.0 JumpCloud
Function Remove-JCSystemGroup 1.1.0 JumpCloud
Function Remove-JCSystemGroupMember 1.1.0 JumpCloud
Function Remove-JCSystemUser 1.1.0 JumpCloud
Function Remove-JCUser 1.1.0 JumpCloud
Function Remove-JCUserGroup 1.1.0 JumpCloud
Function Remove-JCUserGroupMember 1.1.0 JumpCloud
Function Set-JCSystem 1.1.0 JumpCloud
Function Set-JCSystemUser 1.1.0 JumpCloud
Function Set-JCUser 1.1.0 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:
PS /Users/sreed> Help Get-JCUser -Full
Or run Help 'The Command' -online' to see the help in a web browser
Example:
PS /Users/sreed> Help Get-JCUser -Online
If you get stuck inside the help press 'Q' to exit
<U+FEFF>
(END)
- Wiki Home
- Installing the JumpCloud PowerShell module
- Using the JumpCloud PowerShell Module
- Using the JumpCloud PowerShell Module with AWS Lambda
- PowerShell Commands Example Library
- JumpCloud Commands Gallery
- JumpCloud PowerShell YouTube Channel
- The JumpCloud Dashboard PowerShell Module
Authentication
Import and Backup
- Get JCAssociation
- New JCImportTemplate
- Import JCUsersFromCSV
- Update JCUsersFromCSV
- Get JCBackup
- Send JCPasswordReset
- Backup JCOrganization
RADIUS Reply Attributes
- Add JCRadiusReplyAttribute
- Get JCRadiusReplyAttribute
- Update JCUsersFromCSV
- Set JCRadiusReplyAttribute
- Remove JCRadiusReplyAttribute
User Functions
Administrator Functions
System Functions
- Get JCSystem
- Get JCSystemApp
- Get JCSystemKB
- Set JCSystem
- Remove JCSystem
- Get JCSystemUser
- Set JCSystemUser
- Add JCSystemUser
- Remove JCSystemUser
Command Functions
- New JCCommand
- Get JCCommand
- Import JCCommand
- Remove JCCommand
- Set JCCommand
- Invoke JCCommand
- New JCDeploymentTemplate
- Invoke JCDeployment
- Get JCCommandResult
- Remove JCCommandResult
- Get JCCommandTarget
- Add JCCommandTarget
- Remove JCCommandTarget
Group Functions
- Get JCGroup
- New JCUserGroup
- Remove JCUserGroup
- Get JCUserGroupMember
- Add JCUserGroupMember
- Remove JCUserGroupMember
- New JCSystemGroup
- Remove JCSystemGroup
- Get JCSystemGroupMember
- Add JCSystemGroupMember
- Remove JCSystemGroupMember
- Set-JCUserGroupLDAP
Policy Functions
- Get JCPolicy
- Get JCPolicyResult
- Get JCPolicyTargetSystem
- Get JCPolicyTargetGroup
- New JCPolicy
- Set JCPolicy
Event Functions