Jamf Pro Server Tools Overview

Starting with Jamf Pro 10.9.0, the Jamf Pro installers include the Jamf Pro Server Tools software utility, which includes a GUI version and a command-line interface (CLI) version. This article describes the Jamf Pro Server Tools GUI version. For information about the CLI version, see the The Jamf Pro Server Tools Command-Line Interface article.
Warning:

The installers for Jamf Pro 10.33.x–10.34.0 include a version of Jamf Pro Server Tools that creates unrestorable database backups. You must use Jamf Pro Server Tools 2.7.10 or later to perform database backups.

To identify which version of Jamf Pro Server Tools you have installed, do one of the following:

  • For the CLI: Execute the following command: jamf-pro --version

  • In the GUI: Open the Preferences pane and verify the installed versions of the GUI and CLI.

If you do not have Jamf Pro Server Tools 2.7.10 or later installed, see the instructions below to install the latest version of the GUI. For instructions on installing the latest version of the CLI, see the The Jamf Pro Server Tools Command-Line Interface article.

You can use Jamf Pro Server Tools to perform the following server and database maintenance tasks:

  • Set up MySQL database connection information and test the MySQL database connection
  • Backup the Jamf Pro database
  • Restore Jamf Pro database backups
  • Start and stop Tomcat, and modify Tomcat web app memory settings
  • Start and stop MySQL, and modify MySQL settings
  • Set Jamf Pro Server Tools preferences

Jamf Pro Server Tools Requirements

  • Jamf Pro 10.0.0 or later

  • Linux, Windows, or Intel-based Mac computer
    Note:

    The Jamf Pro Server Tools GUI is not supported on Macs with Apple silicon.

Installing the Jamf Pro Server Tools GUI

The Jamf Pro Server Tools GUI is installed automatically when you run the Jamf Pro installer. It is located at:

  • Linux: /usr/local/jss/bin/server-tools-gui.jar
  • Mac: /Library/JSS/bin/server-tools-gui.jar
  • Windows: C:\Program Files\JSS\bin\server-tools-gui.jar

You can also download the latest version of the Jamf Pro Server Tools GUI by doing one of the following:

Note:

Jamf Pro Server Tools GUI 2.4.3 or later requires Java 11. If you need Jamf Pro Server Tools for Java 8, you must use Jamf Pro Server Tools GUI 2.4.2, which you can download by clicking the following link: https://archive.services.jamfcloud.com/jamf-pro-server-tools/release/2.4.2/gui/server-tools.jar

Opening the Jamf Pro Server Tools GUI

  1. Open a command terminal and enter the following:
    java -jar
  2. Drag the Jamf Pro Server Tools .jar file into the window to add the path to the .jar file to the java -jar command.
  3. Press Enter.

Jamf Pro Server Tools Settings

The following table provides an overview of the settings available in Jamf Pro Server Tools:

Settings PaneDescriptionScreen

Backup and Restore

Use this pane to back up the Jamf Pro database and restore database backups.

Scheduled Backups

Use this pane to schedule Jamf Pro database backups.

For more information, see the Backing Up the Database Using Jamf Pro Server Tools article

Server Tools Database Connection

Use this pane to update the MySQL database connection settings for backing up and restoring the database. You can also test the database connection to make sure it works.

Jamf Pro Database Connection

Use this pane to edit the database settings that are stored in the DataBase.xml file, such as the database name, database username, and database password.

Editing the Database Connection Using Jamf Pro Server ToolsFor more information, see the article.

Tomcat Settings

Use this pane to start, stop, and restart Tomcat.

You can also set the minimum and maximum Tomcat memory that the server will use. Current system values are displayed, but you can configure the settings as needed.

Note:

(Linux and Mac only) Administrator privileges are required to make changes on this pane. See "Preferences" below for details.

For more information, see the Starting and Stopping Tomcat article.

MySQL Settings

Use this pane to start, stop, and restart the MySQL server. You can also view current MySQL database system values and adjust them as needed.
Note:

(Linux and Mac only) Administrator privileges are required to make changes on this pane. See "Preferences" below for details.

For more information, see the following webpage: https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html

Preferences

Use this pane to perform the following tasks:
  • Specify a custom path to the command-line interface (CLI) executable for use with Jamf Pro Server Tools.
  • Set the title bar style for the Jamf Pro Server Tools window to show or hide the title bar.
    Note:

    The title bar must be visible to adjust the window size.

  • View and change the Tomcat and MySQL service names and folders.
  • View the current version of Jamf Pro Server Tools GUI and CLI.
  • (Linux and Mac only) Click the Run as Admin button to enter your administrator password. This allows you to perform advanced tasks, including starting and stopping Tomcat, or restoring a database backup.