Get-JCSystemInsights

NAME Get-JCSystemInsights



SYNOPSIS

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.





SYNTAX

Get-JCSystemInsights [-Id] <System.String[]> [[-Fields] <System.Array>] [[-Filter] <System.String>] [[-Limit]

<System.Int32>] [[-Skip] <System.Int32>] [[-Paginate] <System.Boolean>] -Table {kernel_info | system_controls |

uptime | etc_hosts | logical_drives | disk_info | bitlocker_info | patches | programs | apps | browser_plugins |

chrome_extensions | disk_encryption | firefox_addons | groups | interface_addresses | mounts | os_version |

safari_extensions | system_info | users} [<CommonParameters>]



Get-JCSystemInsights [-Name] <System.String[]> [[-Fields] <System.Array>] [[-Filter] <System.String>] [[-Limit]

<System.Int32>] [[-Skip] <System.Int32>] [[-Paginate] <System.Boolean>] -Table {kernel_info | system_controls |

uptime | etc_hosts | logical_drives | disk_info | bitlocker_info | patches | programs | apps | browser_plugins |

chrome_extensions | disk_encryption | firefox_addons | groups | interface_addresses | mounts | os_version |

safari_extensions | system_info | users} [<CommonParameters>]





DESCRIPTION

Using Get-JCSystemInsights will allow you to easily query JumpCloud's RESTful API to return information from your

fleet of JumpCloud managed systems.





PARAMETERS

-Fields <System.Array>

An array of the fields/properties/columns you want to return from the search.



Required? false

Position? 95

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Filter <System.String>

Filters to narrow down search.



Required? false

Position? 96

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Id <System.String[]>

The unique id of the object.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Limit <System.Int32>

The number of items you want to return per API call.



Required? false

Position? 97

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Name <System.String[]>

The name of the object.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Paginate <System.Boolean>

Whether or not you want to paginate through the results.



Required? false

Position? 99

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Skip <System.Int32>

The number of items you want to skip over per API call.



Required? false

Position? 98

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Table <System.String>

The SystemInsights table to query against.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String





System.String[]





System.Array





System.Int32





System.Boolean







OUTPUTS

System.Object







NOTES









-------------------------- Example 1 --------------------------



PS C:\\> Get-JCSystemInsights -Table:('os_version');



Return os_version data for all systems that have system insights enabled.

-------------------------- Example 2 --------------------------



PS C:\\> Get-JCSystemInsights -Table:('os_version') -Id:('5d0917420905f70e36e3c0d3');



Return os_version data for a system with a specified id.

-------------------------- Example 3 --------------------------



PS C:\\> Get-JCSystemInsights -Table:('os_version') -Id:('5d0917420905f70e36e3c0d3', '5d0bc68b8e41442ccd10254a');



Return os_version data for systems with specific ids.

-------------------------- Example 4 --------------------------



PS C:\\> Get-JCSystemInsights -Table:('os_version') -Name:('MacBook-Pro.local_TEST');



Return os_version data for a system with a specified name.

-------------------------- Example 5 --------------------------



PS C:\\> Get-JCSystemInsights -Table:('os_version') -Name:('MacBook-Pro.local_TEST', 'Holly-Flax-Mac.local_TEST');



Return os_version data for systems with specific names.

-------------------------- Example 6 --------------------------



PS C:\\> Get-JCSystemInsights -Table users -Filter username:eq:jcadmin



Filters the users table for any system with the username jcadmin.



RELATED LINKS

Online Version: https://github.com/TheJumpCloud/support ... emInsights