The JumpCloud PowerShell Module is a powerful tool designed to simplify administrative tasks for IT professionals. By using PowerShell commands, you can create reports for devices, users, System Insights, and more.<\/p>\n\n\n\n
Prerequisites<\/strong>:<\/p>\n\n\n\n
<\/p><\/div>
JumpCloud offers Technical Support and Professional Services. This article is intended to provide guidance and examples for utilizing the JumpCloud PowerShell Module. If you require assistance with custom scripting or specialized solutions, consider contacting your Account Manager.<\/p>\n <\/div><\/div><\/div><\/div>\n\n\n\n
To connect to the PowerShell Module and export CSV reports<\/strong>:<\/p>\n\n\n\n
Connect-JCOnline<\/code><\/li>\n<\/ol>\n\n\n\n
<\/p><\/div>
Tip:<\/strong> \nNeed help finding your JumpCloud API key? See JumpCloud APIs<\/a>.<\/p>\n <\/div><\/div><\/div><\/div>\n\n\n\n
\n- After authenticating, select the appropriate
Get-<\/code> command needed to create the report. In this example, we’ll use Get-JCUser<\/code>.\n
\n- Jump to Understanding Get commands<\/a> for additional examples.<\/li>\n\n\n\n
- For a full list of commands, see PowerShell Module Docs<\/a>. <\/li>\n<\/ul>\n<\/li>\n\n\n\n
- Once you’ve determined the command needed to collect the information, append it using the PowerShell Utility
Export-CSV<\/code>. This converts the results into a series of character-separated value (CSV) strings and saves it to a file.\n
\n- See Microsoft’s Export-Csv<\/u><\/a> to learn more. <\/li>\n<\/ul>\n<\/li>\n<\/ol>\n\n\n\n\n
Get-JCUser -department IT -returnProperties email, firstname, lastname | Export-Csv -Path .\\IT.csv <\/p>\n<\/div><\/div>\n\n\n\n
\n\n- This example creates a CSV file with all the users under the IT department with email, first name, and last name values.<\/li>\n\n\n
- The default save path for the CSV file:\n\n
\n\n- macOS<\/strong>: \/Users\/username<\/li>\n\n\n
- Windows<\/strong>: C:\\Users\\Username from user account you ran the command.<\/li>\n\n<\/ul>\n\n<\/li>\n\n<\/ul>\n\n\n\n
Understanding Get Commands<\/h3>\n\n\n\nThe Get<\/code> parameter in the Get-JCUser<\/code> cmdlet indicates the action of retrieving information. When used without additional parameters, it fetches details about all JumpCloud users within the specified JumpCloud org. Additionally, it enables targeted searching for a particular user by specifying parameters such as username<\/code>, firstname<\/code>, lastname<\/code>, or email<\/code>.<\/p>\n\n\n\n
Example 1:<\/strong> To create a report of users within a specific department, use the parameter -Department \u201cString\u201c<\/code>. Replace the string value with the name of the department.<\/p>\n\n\n\n
The following example returns all users under the IT department with all the properties of the user:<\/p>\n\n\n\n
\nGet-JCUser -Department “IT”<\/p>\n<\/div><\/div>\n\n\n\n
You can limit the results to specific values by leveraging -returnProperties<\/code>. This example shows all the users under the IT department but will return only the email, first name, and last name values:<\/p>\n\n\n\n
\nGet-JCUser -department IT -returnProperties email, firstname, lastname<\/p>\n<\/div><\/div>\n\n\n\n
Example 2<\/strong>: To find a specific application installed on devices, use Get-JCSystemApp<\/code>. The following example will return all macOS devices that have Chrome installed:<\/p>\n\n\n\n
\nGet-JCSystemApp -name chrome -SystemOS macOS<\/p>\n<\/div><\/div>\n\n\n\n
<\/p><\/div>
Note:<\/strong> \nSome properties are case sensitive, so be sure that you’re using the correct value.<\/p>\n <\/div><\/div><\/div><\/div>\n\n\n\n
Additional PowerShell Report Examples<\/h2>\n\n\n\n
The following section contains common JumpCloud PowerShell commands that you can run to collect reporting data for your JumpCloud managed devices and users. For a full list of JumpCloud PowerShell commands available, see Using the JumpCloud PowerShell Module<\/a>.<\/p>\n\n\n\n
Installed Application Reporting<\/h3>\n\n\n\n\n- Find a specific application (Chrome) installed on macOS devices and output to CSV:<\/li>\n<\/ul>\n\n\n\n\n
Get-JCSystemApp -name chrome -Search -SystemOS macOS | Export-Csv -Path .\\Chrome.csv<\/p>\n<\/div><\/div>\n\n\n\n
\n- Find all Chrome Extensions<\/li>\n<\/ul>\n\n\n\n\n
get-jcsysteminsights -table ChromeExtension<\/p>\n<\/div><\/div>\n\n\n\n
\n- Check any other table (use CTRL + Space on windows; TAB on Mac to list all available tables)<\/li>\n<\/ul>\n\n\n\n\n
get-jcsysteminsights -table<\/p>\n<\/div><\/div>\n\n\n\n
\n- Query all installed applications for all macOS devices and output to CSV:<\/li>\n<\/ul>\n\n\n\n\n
Get-JCSystemApp -SystemOS macOS | ConvertTo-CSV | Out-File macOSapps.csv<\/p>\n<\/div><\/div>\n\n\n\n
\n- Query all installed applications for all macOS devices (excluding OS supplied or native applications) and output to CSV:<\/li>\n<\/ul>\n\n\n\n\n
get-jcsystemapp -SystemOS macOS | ?{$_.Path -notlike ‘\/System\/‘ -and $_.Path -notlike ‘\/Library\/<\/em>‘} | export-csv filename.csv<\/p>\n<\/div><\/div>\n\n\n\n
\n- Query all installed applications for all Linux devices and output to CSV:<\/li>\n<\/ul>\n\n\n\n\n
Get-JCSystemApp -SystemOS linux | ConvertTo-CSV | Out-File linuxPackages.csv<\/p>\n<\/div><\/div>\n\n\n\n
\n- Query all installed applications on all Windows devices and output to CSV:<\/li>\n<\/ul>\n\n\n\n\n
Get-JCSystemApp -SystemOS windows | select-object systemid,name,publisher,version,installdate,installsource,identifyingnumber | ConvertTo-CSV | Out-File windowsPackages.csv<\/p>\n<\/div><\/div>\n\n\n\n
Device Reporting<\/h3>\n\n\n\n\n- List devices with drives where Bitlocker is enabled and Auto Unlock is disabled:<\/li>\n<\/ul>\n\n\n\n\n
Get-JCSystemInsights -Table BitlockerInfo | select-object systemid, ProtectionStatus, driveletter | Where-Object {$_.protectionstatus -eq 2}<\/p>\n<\/div><\/div>\n\n\n\n
\n- Query devices with a last contact date within the last 90 days and output to CSV:<\/li>\n<\/ul>\n\n\n\n\n
Get-JCSystem -filterDateProperty lastContact -dateFilter after -date (Get-Date).AddDays(-90) -returnProperties hostname, lastContact, created | Export-Csv JCSystemslastContact.csv<\/p>\n<\/div><\/div>\n\n\n\n
\n- List devices that are bound to a domain:<\/li>\n<\/ul>\n\n\n\n\n
get-jcsystem | select-object hostname,domaininfo | where-object {$_.domaininfo.domainName -ne “”} <\/p>\n<\/div><\/div>\n\n\n\n
\n- Collect device full disk encryption (FDE) keys and output to CSV:<\/li>\n<\/ul>\n\n\n\n\n
Get-JCSystem | ? fde -Like “*keyPresent=True; active=True*” | Select-object hostname, _id, @{Name=’key’;Expression={Get-JCSystem -SystemID $_._id -SystemFDEKey | Select-object -expandProperty key}}<\/span> | Export-CSV JCSystemFDEKeys.CSV<\/p>\n<\/div><\/div>\n\n\n\n
\n- Query devices where FDE is enabled but keys are not escrowed and output to CSV:<\/li>\n<\/ul>\n\n\n\n\n
Get-JCSystem | ? fde -Like “*keyPresent=false; active=True*” | Select-object hostname, ID, FDE | | Export-CSV JCSystemMissingFDEKeys.CSV<\/p>\n<\/div><\/div>\n\n\n\n
User Reporting<\/h3>\n\n\n\n\n- List all users and their password expiration dates:<\/li>\n<\/ul>\n\n\n\n\n
[int]$UTCOffset = ‘-6’ # Update with your locations timezone offset to UTC. 8 = Singapore Standard Time, -5 = EST, – 8 = PST, -6 = MDT
Get-JCUser -returnProperties username, password_expiration_date, password_expired | Select-Object username, @{name = “password_expiration_date”; expression = { ($_.password_expiration_date).addHours($UTCOffset)}}<\/span>, @{name =”day of week”;expression = {(($_.password_expiration_date).addHours($UTCOffset)).DayOfWeek}}<\/span>, password_expired | Sort-Object password_expiration_date<\/p>\n<\/div><\/div>\n\n\n\n
\n- Lists users not bound to a device:<\/li>\n<\/ul>\n\n\n\n\n
$Users = Get-JCUser
$Users |
Where-Object {$_.Id -notin (Get-JCAssociation -Type:(‘user’) -Id:($_.Id) -TargetType:(‘user_group’)).id} | Select-Object username<\/p>\n<\/div><\/div>\n\n\n\n
\n- List users not bound to a user group:<\/li>\n<\/ul>\n\n\n\n\n
$Users = Get-JCUser
$Users |
Where-Object {$_.Id -notin (Get-JCAssociation -Type:(‘user’) -Id:($_.Id) -TargetType: (‘user_group’)).id} |
Select-Object username<\/p>\n<\/div><\/div>\n","protected":false},"excerpt":{"rendered":"
The JumpCloud PowerShell Module is a powerful tool designed to simplify administrative tasks for IT professionals. By using PowerShell commands, […]<\/p>\n","protected":false},"author":218,"featured_media":0,"template":"","meta":{"_acf_changed":false,"_oasis_is_in_workflow":0,"_oasis_original":0,"_oasis_task_priority":"","inline_featured_image":false,"footnotes":""},"support_category":[2856,2916],"support_tag":[3160],"coauthors":[3011],"acf":[],"yoast_head":"\n
Create Reports With the PowerShell Module - JumpCloud<\/title>\n<meta name=\"description\" content=\"Learn how to use the JumpCloud PowerShell module to collect information and create reports on your org.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/jumpcloud.com\/support\/create-reports-with-the-powershell-module\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Create Reports With the PowerShell Module\" \/>\n<meta property=\"og:description\" content=\"Learn how to use the JumpCloud PowerShell module to collect information and create reports on your org.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/jumpcloud.com\/support\/create-reports-with-the-powershell-module\" \/>\n<meta property=\"og:site_name\" content=\"JumpCloud\" \/>\n<meta property=\"article:modified_time\" content=\"2025-01-10T20:32:43+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2024\/07\/202405-MISC-JumpCloudHelpCenter-SiteDisplay-min-2.png\" \/>\n\t<meta property=\"og:image:width\" content=\"890\" \/>\n\t<meta property=\"og:image:height\" content=\"525\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"4 minutes\" \/>\n\t<meta name=\"twitter:label2\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data2\" content=\"nickconrad\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/jumpcloud.com\/support\/create-reports-with-the-powershell-module\",\"url\":\"https:\/\/jumpcloud.com\/support\/create-reports-with-the-powershell-module\",\"name\":\"Create Reports With the PowerShell Module - JumpCloud\",\"isPartOf\":{\"@id\":\"https:\/\/jumpcloud.com\/#website\"},\"datePublished\":\"2024-09-06T22:01:03+00:00\",\"dateModified\":\"2025-01-10T20:32:43+00:00\",\"description\":\"Learn how to use the JumpCloud PowerShell module to collect information and create reports on your org.\",\"breadcrumb\":{\"@id\":\"https:\/\/jumpcloud.com\/support\/create-reports-with-the-powershell-module#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/jumpcloud.com\/support\/create-reports-with-the-powershell-module\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/jumpcloud.com\/support\/create-reports-with-the-powershell-module#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/jumpcloud.com\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Support\",\"item\":\"https:\/\/jumpcloud.com\/support\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create Reports With the PowerShell Module\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/jumpcloud.com\/#website\",\"url\":\"https:\/\/jumpcloud.com\/\",\"name\":\"JumpCloud\",\"description\":\"Daily insights on directory services, IAM, LDAP, identity security, SSO, system management (Mac, Windows, Linux), networking, and the cloud.\",\"publisher\":{\"@id\":\"https:\/\/jumpcloud.com\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/jumpcloud.com\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/jumpcloud.com\/#organization\",\"name\":\"JumpCloud\",\"url\":\"https:\/\/jumpcloud.com\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/jumpcloud.com\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2021\/01\/jc-logo-brand-2021.png\",\"contentUrl\":\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2021\/01\/jc-logo-brand-2021.png\",\"width\":598,\"height\":101,\"caption\":\"JumpCloud\"},\"image\":{\"@id\":\"https:\/\/jumpcloud.com\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"Create Reports With the PowerShell Module - JumpCloud","description":"Learn how to use the JumpCloud PowerShell module to collect information and create reports on your org.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/jumpcloud.com\/support\/create-reports-with-the-powershell-module","og_locale":"en_US","og_type":"article","og_title":"Create Reports With the PowerShell Module","og_description":"Learn how to use the JumpCloud PowerShell module to collect information and create reports on your org.","og_url":"https:\/\/jumpcloud.com\/support\/create-reports-with-the-powershell-module","og_site_name":"JumpCloud","article_modified_time":"2025-01-10T20:32:43+00:00","og_image":[{"width":890,"height":525,"url":"https:\/\/jumpcloud.com\/wp-content\/uploads\/2024\/07\/202405-MISC-JumpCloudHelpCenter-SiteDisplay-min-2.png","type":"image\/png"}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"4 minutes","Written by":"nickconrad"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/jumpcloud.com\/support\/create-reports-with-the-powershell-module","url":"https:\/\/jumpcloud.com\/support\/create-reports-with-the-powershell-module","name":"Create Reports With the PowerShell Module - JumpCloud","isPartOf":{"@id":"https:\/\/jumpcloud.com\/#website"},"datePublished":"2024-09-06T22:01:03+00:00","dateModified":"2025-01-10T20:32:43+00:00","description":"Learn how to use the JumpCloud PowerShell module to collect information and create reports on your org.","breadcrumb":{"@id":"https:\/\/jumpcloud.com\/support\/create-reports-with-the-powershell-module#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/jumpcloud.com\/support\/create-reports-with-the-powershell-module"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/jumpcloud.com\/support\/create-reports-with-the-powershell-module#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/jumpcloud.com\/"},{"@type":"ListItem","position":2,"name":"Support","item":"https:\/\/jumpcloud.com\/support"},{"@type":"ListItem","position":3,"name":"Create Reports With the PowerShell Module"}]},{"@type":"WebSite","@id":"https:\/\/jumpcloud.com\/#website","url":"https:\/\/jumpcloud.com\/","name":"JumpCloud","description":"Daily insights on directory services, IAM, LDAP, identity security, SSO, system management (Mac, Windows, Linux), networking, and the cloud.","publisher":{"@id":"https:\/\/jumpcloud.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/jumpcloud.com\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/jumpcloud.com\/#organization","name":"JumpCloud","url":"https:\/\/jumpcloud.com\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/jumpcloud.com\/#\/schema\/logo\/image\/","url":"https:\/\/jumpcloud.com\/wp-content\/uploads\/2021\/01\/jc-logo-brand-2021.png","contentUrl":"https:\/\/jumpcloud.com\/wp-content\/uploads\/2021\/01\/jc-logo-brand-2021.png","width":598,"height":101,"caption":"JumpCloud"},"image":{"@id":"https:\/\/jumpcloud.com\/#\/schema\/logo\/image\/"}}]}},"_links":{"self":[{"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support\/115242"}],"collection":[{"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support"}],"about":[{"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/types\/support"}],"author":[{"embeddable":true,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/users\/218"}],"version-history":[{"count":2,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support\/115242\/revisions"}],"predecessor-version":[{"id":119887,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support\/115242\/revisions\/119887"}],"wp:attachment":[{"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/media?parent=115242"}],"wp:term":[{"taxonomy":"support_category","embeddable":true,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support_category?post=115242"},{"taxonomy":"support_tag","embeddable":true,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support_tag?post=115242"},{"taxonomy":"author","embeddable":true,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/coauthors?post=115242"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}