Backing Up the Database Using Jamf Pro Server Tools

You can use Jamf Pro Server Tools to create backups of the Jamf Pro database or schedule automated database backups.

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 installation instructions in the following articles:

Note:

The time it takes to create a backup depends on the size of the database.

General Requirements

Creating a Database Backup

  1. Open the Jamf Pro Server Tools GUI by performing the following steps:
    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.
  2. Click Database Connection in the sidebar.
  3. Configure the settings to match your database configuration, and then click Test Connection.
    • If successful, the message "Successfully Connected" appears, continue with Step 4 below.
    • If the connection is not successful, an error message will be displayed.
  4. Click Backup and Restore in the sidebar.
  5. Click Save Backup Now.
  6. Choose a location to save the backup and click Open. Jamf Pro Server Tools saves the backup as a .sql.gz file.

Scheduling Database Backups

You can schedule database backups to occur on an ongoing basis. You can also specify the number of backup files you want to keep. When the number of files in the backups folder exceeds the limit you set, the oldest file will be automatically deleted.

  1. Open Jamf Pro Server Tools.
  2. Click Scheduled Backups in the sidebar.
  3. Select the Enable scheduled backups checkbox.
  4. Choose the hour and the days that you want backups to occur.
  5. (Optional) To limit the number of backups that are retained, enter the number of backups that you want to keep in the Number of backups to keep field. All older backup files will be deleted when the scheduled backups run. To retain all backups, enter "0".
    Note: The backup file limit is based on the backup file dates and not the backup filenames. The backup file limit includes manual backups and any other .sql.gz files in the backups folder.
  6. To save the backups in a custom location, click Browse and select a different location.
    Note:

    It is recommended that you store the backups on a separate drive.

  7. For Windows, complete the following additional steps:
    1. Open Task Scheduler.
    2. In the Task Scheduler Library, select jamf-pro database backup JamfProServerToolsGui
    3. Click Properties in the Actions pane.
    4. On the General tab, select Run whether user is logged on or not.
    5. (Optional) Select or deselect the Do not store password checkbox as needed for your organization. For example, if your organization has everything on the local computer, you should not need to store the password. However, if you need the password to access protected folders, you may need to save the password.
    6. (Optional) If the folder you are using for backups is protected and you need administrator privileges, select Run with highest privileges.
    7. Click OK.

Stopping Scheduled Database Backups

  1. Open Jamf Pro Server Tools.
  2. Click Scheduled Backups.
  3. Deselect the Enable scheduled backups checkbox.