JumpCloud - TheJumpCloud/support GitHub Wiki

JumpCloud Module

Description

PowerShell functions to manage a JumpCloud Directory-as-a-Service

JumpCloud Cmdlets

Add-JCAssociation

Create an association between two object within the JumpCloud console.

Add-JCCommandTarget

Associates a JumpCloud system or a JumpCloud system group with a JumpCloud command

Add-JCRadiusReplyAttribute

Adds Radius reply attributes to a JumpCloud user group.

Add-JCSystemGroupMember

Adds a JumpCloud System to a JumpCloud System Group

Add-JCSystemUser

Associates a JumpCloud User account with a local account on a JumpCloud managed System.

Add-JCUserGroupMember

Adds a JumpCloud user to a JumpCloud User Group.

Backup-JCOrganization

Backup your JumpCloud organization to local json files

Connect-JCOnline

The Connect-JCOnline function sets the global variable $JCAPIKEY

Copy-JCAssociation

Copy the associations from one object to another.

Get-JCAssociation

The function Get-JCAssociation can be used to query an object's associations and then provide information about how objects are associated with one another.

Get-JCBackup

Backs up JumpCloud directory information to CSV

Get-JCCommand

Returns all JumpCloud Commands within a JumpCloud tenant or a single JumpCloud Command using the -ByID Parameter.

Get-JCCommandResult

Returns all JumpCloud Command Results within a JumpCloud tenant or a single JumpCloud Command Result using the -ByID Parameter.

Get-JCCommandTarget

Returns the JumpCloud systems or system groups associated with a JumpCloud command.

Get-JCEvent

Query the API for Directory Insights events

Get-JCEventCount

Query the API for a count of matching events

Get-JCGroup

Returns all JumpCloud System and User Groups.

Get-JCOrganization

Returns all JumpCloud organizations associated with the authenticated JumpCloud admins account.

Get-JCPolicy

Returns all JumpCloud Policies within a JumpCloud tenant.

Get-JCPolicyResult

Returns all JumpCloud results for a given policy within a JumpCloud tenant.

Get-JCPolicyTargetGroup

Returns all bound groups associated with a JumpCloud Policy within a JumpCloud tenant.

Get-JCPolicyTargetSystem

Returns all bound systems associated with a JumpCloud Policy within a JumpCloud tenant.

Get-JCRadiusReplyAttribute

Returns the Radius reply attributes associated with a JumpCloud user group.

Get-JCRadiusServer

Return JumpCloud radius server information.

Get-JCSystem

Returns all JumpCloud Systems within a JumpCloud tenant or a single JumpCloud System using the -ByID Parameter.

Get-JCSystemApp

Returns the applications/programs/linux packages installed on JumpCloud managed system(s). This function queries separate system insights tables to get data for macOS/windows/linux devices.

Get-JCSystemGroupMember

Returns the System Group members of a JumpCloud System Group.

Get-JCSystemInsights

JumpCloud's System Insights feature provides admins with the ability to easily interrogate their fleet of systems to find important pieces of information. Using this function you can easily gather heightened levels of information from your fleet of JumpCloud managed systems.

Get-JCSystemUser

Returns all JumpCloud Users associated with a JumpCloud System.

Get-JCUser

Returns all JumpCloud Users within a JumpCloud tenant or searches for a JumpCloud User by 'username', 'firstname', 'lastname', or 'email'.

Get-JCUserGroupMember

Returns the User Group members of a JumpCloud User Group.

Import-JCCommand

Imports a Mac, Linux or Windows JumpCloud Command into the JumpCloud admin portal from a URL

Import-JCMSPFromCSV

Imports a list of JumpCloud MSP organizations from a CSV file created using the New-JCMSPImportTemplate function.

Import-JCUsersFromCSV

Imports a set of JumpCloud users from a CSV file created using the New-JCImportTemplate function.

Invoke-JCCommand

Triggers a JumpCloud Command to run by calling the trigger associated with the Command.

Invoke-JCDeployment

Triggers a JumpCloud Command Deployment using the CommandID and a filled out deployment CSV file.

New-JCCommand

Creates a new JumpCloud Mac, Linux, or Windows command

New-JCDeploymentTemplate

A guided walk through that creates a command deployment CSV file on your local machine.

New-JCImportTemplate

A guided walk through that creates a JumpCloud User Import CSV file on your local machine.

New-JCMSPImportTemplate

Creates a CSV file to either create new or update existing MSP organizations in a MSP tenant.

New-JCPolicy

New-JCPolicy creates new JumpCloud Policies in an organization by TemplateID or TemplateNames. JumpCloud policies can be created in three different ways. The New/Set-JCPolicy functions each have a dynamic set of parameters specific to each policy template, this dynamic set of parameters is generated after specifying a valid TemplateID or TemplateName. New/Set-JCPolicy functions can also be set through a valid value parameter which is specific to each template policy. Lastly, New/Set-JCPolicy functions can be set through a guided interface.

TemplateIDs or TemplateNames are required to identify which JumpCloud Policy to be built. TemplateIDs can be found by looking at the JumpCloud Console URL while creating new policies. TemplateNames can be dynamically pulled in while using the New-JCPolicy function by typing: New-JCPolicy -TemplateName *tab* where the tab key is pressed in place of *tab*, if prompted, press 'y' to list all policies. Policies by operating system can be 'searched' by typing darwin (macOS), windows, linux, ios. For example, New-JCPolicy -TemplateName darwin*tab* where the tab key is pressed in place of *tab*, the list of available macOS policies would then be displayed and can be autocompleted through further tab presses.

At a minimum to display the dynamic set of parameters per template, the TemplateID or TemplateName must be specified. Tab actions display the available dynamic parameters available per function. For example, New-JCPolicy -TemplateName darwin_Login_Window_Text -*tab* where the tab key is pressed in place of *tab*, would display available parameters specific to the darwin_Login_Window_Text policy. Dynamic parameters for templates are displayed after the Name and Values parameters, and are generally camelCase strings like LoginwindowText.

New-JCRadiusServer

Creates a JumpCloud radius server.

New-JCSystemGroup

Creates a JumpCloud System Group

New-JCUser

Creates a JumpCloud User

New-JCUserGroup

Creates a JumpCloud User Group

Remove-JCAssociation

Remove an association between two object within the JumpCloud console.

Remove-JCCommand

Removes a JumpCloud command

Remove-JCCommandResult

Removes a JumpCloud Command Result

Remove-JCCommandTarget

Removes the association between a JumpCloud system or a JumpCloud system group from a JumpCloud command

Remove-JCPolicy

Removes a JumpCloud Policy

Remove-JCRadiusReplyAttribute

Removes Radius reply attributes from a JumpCloud user group.

Remove-JCRadiusServer

Removes a JumpCloud radius server.

Remove-JCSystem

Removes a JumpCloud system.

Remove-JCSystemGroup

Removes a JumpCloud System Group

Remove-JCSystemGroupMember

Removes a JumpCloud System from a JumpCloud System Group

Remove-JCSystemUser

Disables a JumpCloud User account on a JumpCloud System.

Remove-JCUser

Removes a JumpCloud User

Remove-JCUserGroup

Removes a JumpCloud User Group

Remove-JCUserGroupMember

Removes a JumpCloud User from a JumpCloud User Group

Send-JCPasswordReset

Sends a JumpCloud activation/password reset email.

Set-JCCommand

Updates an existing JumpCloud command

Set-JCOrganization

Allows a multi tenant admin to update their connection to a specific JumpCloud organization.

Set-JCPolicy

Set-JCPolicy updates existing JumpCloud Policies in an organization by PolicyID or PolicyName. JumpCloud policies can be updated in three different ways. The New/Set-JCPolicy functions each have a dynamic set of parameters specific to each policy template, this dynamic set of parameters is generated after specifying a valid TemplateID or PolicyName. New/Set-JCPolicy functions can also be set through a valid value parameter which is specific to each template policy. Lastly, New/Set-JCPolicy functions can be set through a guided interface.

PolicyIDs or PolicyNames are required to identify which JumpCloud Policy to be built. TemplateIDs can be found by looking at the JumpCloud Console URL on existing policies or running Get-JCpolicy -Name "Some Policy Name to get the policy by ID. PolicyNames can be specified if you know the name of a policy you wish to update or by running Get-JCpolicy -Name "Some Policy Name to get the policy by Name

Set-JCPolicy can display the available parameters per policy if a PolicyName or PolicyID is specified. Tab actions display the available dynamic parameters available per function. For example, Set-JCPolicy -PolicyName "macOS - Login Window Policy" -*tab* where the tab key is pressed in place of *tab*, would display available parameters specific to the macOS - Login Window Policy policy. Dynamic parameters for policies are displayed after the Name and Values parameters, and are generally camelCase strings like LoginwindowText.

Set-JCRadiusReplyAttribute

Updates or adds Radius reply attributes to a JumpCloud user group.

Set-JCRadiusServer

Updates a JumpCloud radius server.

Set-JCSettingsFile

Updates the JumpCloud Module Settings File

Set-JCSystem

Updates an existing JumpCloud System

Set-JCSystemUser

Updates the permissions of a JumpCloud user on a JumpCloud system

Set-JCUser

Updates an existing JumpCloud User

Set-JCUserGroupLDAP

The Set-JCUserGroupLDAP command adds or removes a JumpCloud user group and the members to/from the JumpCloud LDAP directory.

Update-JCModule

Running this function will trigger the update of the JumpCloud PowerShell module.

Update-JCMSPFromCSV

Updates a list of JumpCloud MSP organizations from a CSV file created using the New-JCMSPImportTemplate function.

Update-JCUsersFromCSV

Updates a set of JumpCloud users from a CSV file created using the New-JCImportTemplate function.