Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/BIG-RAT/Prune

Remove unused items from your Jamf server
https://github.com/BIG-RAT/Prune

Last synced: about 2 months ago
JSON representation

Remove unused items from your Jamf server

Lists

README 

        
# Prune

![GitHub release (latest by date)](https://img.shields.io/github/v/release/BIG-RAT/prune?display_name=tag) ![GitHub all releases](https://img.shields.io/github/downloads/BIG-RAT/prune/total)  ![GitHub latest release](https://img.shields.io/github/downloads/BIG-RAT/prune/latest/total)

 ![GitHub issues](https://img.shields.io/github/issues-raw/BIG-RAT/prune) ![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/BIG-RAT/prune) ![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/BIG-RAT/jamfcpr) ![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed-raw/BIG-RAT/prune)



Download: [Prune](https://github.com/BIG-RAT/prune/releases/latest/download/prune.zip)



As your Jamf server ages it often accumulates more and more unused items, such as outdated packages, unscoped policies, mobile device apps...  Use Prune to help identify and remove those unused items.



![alt text](./images/pruneApp.png "Prune")



In the event the server reply indicates an error occurred reading an object it will be logged and you will receive an alert indicating the results may be inaccurate.



![alt text](./images/pruneWarning.png "prune warning")




Once the list of unused items is generated you can edit it within the app.  If you see an object you wish to keep, say some policy, simply option-click the item in the list.  The item will be removed from the list, and hence not removed from the server.  Perhaps you'd like to review the item on the server before deleting, not a problem, just double click the item and you'll be taken to it on the Jamf server (may need to authenticate first).



![alt text](./images/edit.png "modify/review")



### Usage:

* Enter the server URL you wish to query along with valid credentials.  To simply generate a list you can use an auditor account.  To remove items an account with delete permissions is also required.

* Select the item(s) you'd like to scan.  You can option-click to select/de-select all the object types; packages, scripts, computer groups...

* Click Scan.

* Once the processing is complete review/edit the list.

* Click Delete if you wish to delete the listed items from the server.

* To delete one specific object type after scanning multiple object types change the View option to the desired object type then click Delete.

* Click Export if you wish to save (to your Downloads folder) the lists of objects, one file per object type, to remove for review/editing later.  These lists can then be imported into the application by either clicking the import button or dragging the file onto the button.

* Option-click Export to export all items to a single CSV in your downloads folder.

 





### Usage Calculations



    

        

            Object

            Determine Usage

        

    

    

        

            Packages

            Check for usage in policies, patch policies, computer prestages

        

        

            Scripts

            Check for usage in policies

        

        

            Computer Groups

            Check for usage in policies, computer configuration profiles, computer groups, eBooks, restricted software, advanced searches, app installers, enabled state

        

        

            Computer Profiles

            Check scope, computer prestages

        

        

            Policies

            Check scope

        

        

            Mac Apps

            Check scope

        

        

            Restricted Software

            Check scope for computer groups

        

        

            Computer Extension Attributes

            Check scope for computer groups, advanced searches (also checks display tab), enabled state

        

        

            eBooks

            Check scope

        

        

            Mobile Device Groups

            Check for usage in mobile device apps, mobile device configuration profiles, mobile device groups, eBooks, classes

        

        

            Mobile Device Profiles

            Check scope

        

        

            Classes

            Check scope, only looks for students/student groups/mobile device assignements

        

        

            Mobile Device Extension Attributes

            Check scope for mobile device groups, advanced searches

        

    











### Important:

* This application deletes stuff, use with caution!  It is recommended you have a valid backup before deleting any objects.  You could either perform a database backup (if on prem) or use [Jamf Migrator](https://github.com/jamf/JamfMigrator) and export the (full) XML of all objects, or do both.

* **Policies** scoped only to users and/or user groups will show as unused due to an issue with the API (it doesn't list the users or user groups).

* **Mac App** enabled/disabled state is not available via the API and thus not used to determine usage.

* **Bookmarks** are not accessible via the API.  As a result groups that are only used to scope bookmarks will show as unused.



Logging information is written to: ```~/Library/Containers/com.jamf.pse.prune/Data/Library/Logs/Prune.log```








### History:

2024-02-09 - v3.2.1: Query App Installers for groups used for scoping.



2024-02-04 - v3.2.0: Update login window.  Add support for bearer token.  Provide an alert if some lookups fail, which may result in inaccurate results.



2023-10-15 - v3.1.1: Fix issue #42.  Updated token refresh process to address issue #41 and update logging.



2023-09-16 - v3.1.0: Fix issue #39, double quotes in display name.  Better handling of bearer token expiration.  Fix issue export to csv policies.  Enable the sharing of keychain items created with this app to other apps I write.



2023-07-14 - v3.0.2: Guard against faulty package configurations in computer prestages.  Check for extension attributes used only on the display tab of an advanced search.



2023-04-07 - v3.0.1: Updated logging to prevent potential looping.



2023-03-21 - v3.0.0: Updated UI.  Add ability to export results to a CSV (option-Export).



2023-03-08 - v2.4.0: Add scanning of Mac Apps.



2022-11-18 - v2.3.3: Fix issue where extension attributes used as creteria in smart groups were listed as unused.



2022-11-18 - v2.3.2: Fix computer/mobile device extension attributes not deleting (#29).



2022-11-16 - v2.3.1: Fix issue where policies that are disabled and scoped were not showing up as unused (#27).



2022-11-15 - v2.3.0: List policies that are disabled and still scoped (#27).  List computer extension attributes that are disabled.  The item will have '    [disabled]' appended to its name.  Scan advanced searches (#26) for groups and extension attributes used as criteria.  Adjust URL to view unused scripts based on Jamf Pro version.



2022-07-27 - v2.2.5: Resolve crash when import  



2022-04-25 - v2.2.4: Fix crash when scanning only computer (configuration) profiles.  Add keyboard shortcut and menu bar item (View --> Logs Folder) to open logs folder.



2022-04-21 - v2.2.3: Fix some potential authentication issues.  Add deterministic progress wheel to provide current status while deleting items.



2022-02-17 - Add token authentication to the classic API for Jamf Pro 10.35+. Add feedback while items are being deleted from the Jamf Pro server. Resolved removal warning always showing 0 items (#13 ) and items not getting deleted when importing files (#14 ). Resolve crash that could occur if computer groups was not scanned, issue #15.  Resolve issue #16, packages in patch policies not being picked up.



2022-01-17 - Apologies in advance.  Layout changed as a dedicated login window was added.  Added restricted software as an item to query.  Changed Remove button to Delete.



2021-09-23 - Fixed issue where ebooks and classes were not getting deleted.



2021-09-23 - Updated URL used for a token request from Jamf Pro API, corrected extra comma in exported items, added export summary.



2021-05-30 - Scan computer prestages for packages and configuration profiles.  Remove check against computer configurations.  Fix app crash whem only classes is selected.  Fix issue of duplicate API calls.  Additional error handling.



2021-05-23 - Version 1.3.0: Added scan against eBooks and Classes.



2020-10-06 - Version 1.2.0: Guard against corrupt policies/scripts (having no name).  Added warning before deleting is initiated.  Write logging information to: ```~/Library/Containers/com.jamf.pse.prune/Data/Library/Logs/Prune.log```