An App that allows techs to manage printers assigned to "buildings" (categories) in Jamf Pro and automatically create/delete policies. Ain't nobody got time for that.
Forked from MLBZ521/JamfProPrinterTool as I needed it for buildings, not sites.
This application utilizes Python and the Qt for Python Library to create a GUI that allows techs to provide full life-cycle management of their printers without needing assistance from Full Jamf Pro Admins. They are able to Create, Update, and Delete printers for any categories. In addition, they can review the printer configurations, both local and how they are currently configured in Jamf Pro.
Obviously this functionality is not built into Jamf Pro, so to "assign" printers to a building, I have a category for each building and printer policies are assigned to buildings. Helpful for our 200+ printers.
From MLBZ521:
I took this approach so that I could pass an authorized set of credentials that would be able to utilize the Jamf Pro Classic API to be able manage Printers within Jamf Pro.
This is my first project of this type and scale with Python as well as my first use of Qt for Python (PySide2). I believe I've tried to follow all best practices with PySide2 and have added proper flow control and threading. I have also included multi-threading when querying for each printer from Jamf Pro. In my environment with slightly over 400 printers at the current time, this reduced the lookup period from over 3.5 minutes to under thirty seconds (on a Mac with twelve cores).
All that said, it's not perfect and I'm sure there are improvements to be had.
Feature Requests and Pull Requests are welcome. Feel free to contribute!
These are the current items I plan to add based on items I did not implement before releasing:
- After creating a printer, add to local list
- After deleting a printer, remove from local list
- Editable Device Details (update without having local printer of same name)
- Retry getting a printers' details if the API call fails
- ? Client side verbosity/debugging (GUI Enabled) ?
- Move between "buildings" without having to re-pull all printers
- Better error checking for error codes in jamf (printer name exists, etc...)
- [complete - creates policy in jamf when printer added] Policy creation
jamf Pro categories that include the name "Printers" (for sorting printers in each building)
The script was written using Python 3.8.5, but I believe most Python 3 versions should be supported.
This tool requires the following packages and their dependencies:
- cryptography
- PySide2
- requests
Please see the requirements.txt file for additional information.
Obviously, Python 3 and the above required Libraries will be required on any system that runs this script. You can deploy a relocatable Python framework to support this. See Greg Neagle's Relocatable Python Framework and the MacAdmins Python for details.
Then you'll need a Jamf Pro Account with CRUD to the Printer Object type.
- Add CRUD to Policies as well for policy creation/deletion when a printer is created/deleted
- This is designed to work if you have Category as "$BUILDING Printers" and Building as "$BUILDING"
I encrypt the credentials using the cryptography.fernet module. To encrypt your credentials:
from cryptography.fernet import Fernet
key = Fernet.generate_key()
f = Fernet(key)
encoded_username = "<username>".encode()
encoded_password = "<password>".encode()
encrypted_username = f.encrypt(encoded_username)
encrypted_password = f.encrypt(encoded_password)
print("key: {}".format(key))
print("encrypted_username: {}".format(encrypted_username))
print("encrypted_password: {}".format(encrypted_password))Simply pass these strings as Script Parameters in a Policy, and you're good to go.
Parameters:
--api-username | -u API_USERNAME--api-password | -p API_PASSWORD--secret | -s SECRET
Test locally by:
./PrinterTool.py -s 'encryption_key' -u 'encrypted_username' -p 'encrypted_password'
The code that generates the "Jamf Pro Printer Tool" is licensed under the MIT License.
This application utilizes the Qt Framework (specifically PySide2) to generate the GUI portion of the application. Qt and Qt for Python (PySide2) are licensed under the GNU (L)GPLv3. Please see qt.io/licensing for an overview of Qt licensing.
The current image used in this project is property of Jamf.