3.1.1

Changed

  • Updated Alpine Linux version in docker container

3.1.0

Changed

  • Removed the Tomcat Service name configuration flag. The setting from the config file will be used if it is set, and can be manually updated by editing the file.

3.0.0

Changed

  • Added support for Tomcat 9

  • Removed support for Tomcat 8.5.x

2.7.15

Changed

  • Fixed issue when backing up databases that contain views

2.7.14

Changed

  • Updated rpm artifacts to be signed with SHA256

2.7.13

Changed

  • Updated dependency versions and Gradle version

2.7.12

Changed

  • Masked database password in "server config list" command

2.7.11

Changed

  • Updated dependency tracking

2.7.10

Changed

  • Fixed issue when backing up databases that contain json data blobs

2.7.9

Changed

  • Updated release pipeline to deploy the GUI to Jamf Account

2.7.8

Changed

  • Updated release pipeline to Jamf Account

2.7.7

Fixed

  • Jamf Pro Server Tools can now backup databases that contain virtual columns

2.7.6

Changed

  • Updated download and tracking inner dependencies

2.7.5

Changed

  • Updated Go version to Go 1.15

2.7.4

Changed

  • Fixed Jamf Nation download links

2.7.3

Changed

  • Now distributing binaries via Jamf Nation

2.7.2

Fixed

  • Trim backups no longer produces an error when the backup directory has changed and attempts to delete an old backup in the previous directory.

Changed

  • The backup directory is no longer set by default.

  • Updated error messages to be more descriptive and provide instructions for resolving the issues.

2.7.1

Fixed

  • The time and day selections on the Scheduled Backups pane of the Jamf Pro Server Tools GUI now persist when the GUI is closed and reopened.

2.7.0

Fixed

  • Jamf Pro Server Tools will send backup notifications to Jamf Pro, and users that have elected to receive database backup notifications will be notified by email from Jamf Pro.

2.6.3

Fixed

  • Schedules now work when there are spaces or escape characters in file paths

2.6.2

Fixed

  • The backup limit now deletes the correct backup regardless of filename

  • Backup timestamps for filenames now display the actual 24-hour time

  • Prefer TLS when using TCP

2.6.1

Fixed

  • jamf-pro database backup will lock all tables when MyISAM tables exist or set a transaction at the start of the backup to provide a consistent state backup.

Note
Logical backups are not guaranteed to be consistent.

2.6.0

What’s New

  • Windows

    • Scheduling backups now allows additional flags to be passed to schtasks.exe

    • A new flag --highest can be used to schedule backups as SYSTEM

Note
To take advantage of this change you have to remove and recreate your scheduled backup. This change now requires you to launch the command prompt as Administrator first. As well as scheduling it like this you will need to move jamf-pro config file to %ProgramData%\Jamf\tools.yaml to use the setting that you set.
Warning
Scheduling as the SYSTEM account on Windows can expose your MySQL credentials or database backups by other accounts that are allowed to run as admin or view %ProgramData%\Jamf\tools.yaml or your backups

2.5.0

What’s New

  • All

    • After the database is initialized, a prompt now allows you to save the database connection settings to the Jamf Pro Server DataBase.xml file.

Fixed

  • Linux

    • The service status command now correctly reports "running" when the startup produces errors.

2.4.3

What’s New

  • The server tools GUI now runs on Java 11.

2.4.2

What’s New

  • You can now add a custom MySQL installation path for finding the my.cnf or my.ini file.

    • Set this with jamf-pro config set --mysql-home D:\example\path

  • You can now use environmental variables to override any variable in the config file, for example:

    • JAMF_MYSQL_HOME=/usr/local/mysql

    • JAMF_DATABASE_USER=jamf JAMF_DATABASE_PASSWORD=test

2.4.1

What’s New

  • You can now edit the Jamf Pro DataBase.xml easily with the server tools and view connection info from the GUI.

2.4.0

What’s New

  • You can now edit the Jamf Pro DataBase.xml easily with the server tools and view connection info from the command line.

    • Use jamf-pro server config to configure the DataBase.xml and the tomcat environment.

2.3.2

Fixed

  • You can now back up databases of any size.

  • Fixed an issue that prevented the configuration file from being read when a password was not defined.

2.3.1

What’s New

Windows

  • Jamf Pro Server Tools events are now logged in the Windows Event Viewer.

Unix

macOS, Ubuntu, Red Hat, and CentOS

  • The default syslog level was changed from "info" to "notice" to make the events viewable with default configurations on both macOS and Ubuntu.

  • Sockets are now used instead of TCP when communicating with local MySQL instances.

  • Ports are no longer used when connecting to local database instances.

Fixed

  • The restore functionality no longer causes max packet size errors when restoring via localhost.

2.3.0

What’s New

  • External dependencies, including the MySQL binaries, are no longer required for backing up and restoring the database.

  • Improved back up and restore performance.

  • GUI and CLI versions reported in preferences pane

  • Failed backups leave behind logs as err.log files in place of sql.gz files

  • Server tools now logs verbose output to syslog info on Unix systems

  • Errors in the commands are reported to syslog error when not in in a terminal session

Fixed

  • MySQL config paths have been updated to support all MySQL 8.0 locations

  • The GUI will now look in the PATH for the CLI so to get any intentionally installed updates

  • The GUI will not let you schedule backups as root anymore

  • The GUI now shows cron schedules correctly when including Sunday

2.2.7

Fixed

  • Fixed an issue that caused the InnoDB validation check to display the wrong status of InnoDB database tables. This caused the GUI to display an InnoDB status of 'Ready to Convert' and the CLI to display an error message even though the InnoDB conversion process completed successfully.

2.2.6

Fixed

  • [PI-006638] Fixed an issue that prevented all scheduled backups from displaying in the GUI.

2.2.5

Fixed

  • Fixed an issue that caused the encryption module to read locally administered MAC addresses instead of the main hardware address.

2.2.4

Fixed

  • When running a database backup or InnoDB conversion the database size is now reported correctly.

2.2.3

What’s New

  • When running an InnoDB conversion with some InnoDB tables it will now only convert the tables that were not yet converted.

2.2.2

Changed

  • When setting the database password with config the --database-password flag will now prompt if a value is not provided.

2.2.1

Changed

  • Removed the prompt that verified the database is running locally before performing the InnoDB conversion.

2.2.0

What’s New

  • On Windows the configuration file is now located in standard Windows directories

    • New default user-based location: %LOCALAPPDATA%\Jamf\tools.yaml (a typical path is: C:\Users\<username>\AppData\Local\Jamf\tools.yaml)

    • New (optional) global location: %ProgramData%\Jamf\tools.yaml (a typical path is C:\ProgramData\Jamf\tools.yaml)

  • On Windows a global configuration file can now be used if desired instead of a user-based configuration file

Note
By default the config file is not encrypted and if put in the global location it can be read by all other users on the machine.

2.1.2

Fixed

  • Fixed an issue with Red Hat 6.10 and MySQL 5.6 environments that prevented the MySQL database from starting, stopping or restarting. The default MySQL service name can be 'mysql' or 'mysqld', depending on the installation. A detailed message is now returned when Jamf Pro Server Tools is unable to find the correct service name.

2.1.1

Fixed

  • Fixed an issue where the GUI would freeze on startup if using an encrypted config file.

  • Fixed scheduling backups via the GUI.

2.1.0

Added

  • database convert-to-innodb sub-command prompts users to set InnoDB buffer pool size before running the conversion.

  • The GUI now includes a workflow for converting databases from MyISAM to InnoDB.

2.0.1

Fixed

  • Fixed an issue that prevented the Jamf Pro Server Tools GUI from starting or stopping the Tomcat and MySQL services.

  • Fixed an issue where jumbled characters were appearing near database test-connection statuses.

Note
To use the GUI tool on Windows, you will need to start the program as an Administrator. To do this, open a command prompt session as Administrator, then run the following command: java -jar …​/path/to/server-tools.jar

2.0.0

What’s New

The encryption mechanism used to secure the configuration file has changed in Jamf Pro Server Tools version 2.0.0. Full encryption is now an optional feature, and an encryption key prompt is no longer required to read or write the configuration file.

This release also features support for MySQL 8.0.

Explanation of Security Mechanisms

Default Security

The default security mechanism allows commands to be run without prompting for settings or passwords. Database connection settings remain secure and can be used in scripted or automated scenarios like scheduled backups.

By default, there are two layers of security used to secure configuration settings:

  1. On Linux and macOS, the permissions for the configuration file (located at $HOME/.jamf/tools.yaml) are now required to be read/write for only the current user (i.e., rw-------, or mode 600). If insecure permissions are detected, commands will not execute and an error will be displayed.

  2. The database fields in the configuration file are all encrypted using a default key. This is the same level of security MySQL uses for protecting its login configuration settings.

Warning
Configurations using the default encryption key are merely obfuscated. Obfuscation can deter attackers because it makes the settings difficult to read, however, it provides no greater protection than plain text. For this reason, you should make sure the file permissions on the configuration file are always secured.

Full Encryption

For additional security, you can enable full encryption of the configuration. This feature allows the configuration file to be fully encrypted using a custom encryption key (i.e., password) known only to you. You will then be prompted to enter that key anytime the configuration file needs to be read or updated, such as displaying the configuration with jamf-pro config list or backing up and restoring the database.

Note
Using full encryption requires you to enter your encryption key for each command. Automatic scheduled backups are NOT possible with this feature.

To enable full encryption, execute the following command, and create an encryption key password when prompted:

jamf-pro config encrypt
Note
Using this option, data at rest is fully encrypted using AES 256 encryption and a PBKDF2 key generated from the password.

Actions Required Upon Upgrade

  • If you had previously configured your database password, you will need to use jamf-pro config set --database-password to configure it again since the encryption mechanism has changed.

  • You will need to reschedule any previously scheduled tasks. Use jamf-pro database schedules list to view existing scheduled tasks.

1.2.3

Fixed

  • InnoDB conversion no longer prompts for MySQL settings by default.

  • System information is no longer printed during InnoDB conversion.

1.2.2

Fixed

  • Fixed an issue that prevented custom service names from being used on Linux and Windows.

  • Fixed an issue that caused a custom binary path to revert to the default path instead of producing an error.

  • Backing up the database now correctly displays errors.

  • Restoring a database backup now correctly displays errors.

1.2.1

Fixed

  • Fixed an InnoDB buffer pool size calculation error that caused the InnoDB conversion process to fail.

  • Fixed an issue on Windows that caused the jamf-pro server stop command to complete before the stopping process actually completed.

1.2.0

Added

  • Linux distribution packages now support both 32-bit and 64-bit Linux systems.

Fixed

  • Fixed an issue that prevented database backup functionality from working on Linux, macOS, and Windows.

  • Fixed an issue that prevented the CLI from starting or stopping the MySQL server on Red Hat Enterprise Linux 6.x.

  • Fixed an issue that prevented the Tomcat service from being started, stopped, or restarted on macOS. In addition, Tomcat configuration changes were not saved or applied.

Known Issues

  • The InnoDB conversion process may fail due to innodb_buffer_pool_size miscalculation that prevents the database setting validation.

  • On Red Hat Enterprise Linux, the default Tomcat service name continues to be used after a custom Tomcat service name is defined.

  • On Windows, the process for restarting the Tomcat service fails due to the amount of time the stop process takes to complete.

1.1.3

Fixed

  • Unable to backup database on all platforms. This issue has been resolved and now functions properly on all platforms.

1.1.2

Fixed

  • Changing Tomcat settings on Linux did not apply changes. This has been resolved for Linux platforms (Ubuntu, Rhel).

1.1.1

Fixed

  • Restoring the database failed on Linux. The restore functionality now works properly.

Notes

Starting with Jamf Pro 10.8.0, the Jamf Pro installers include the Jamf Pro Server Tools software utility that you can use to perform the following server and database maintenance tasks:

  • Backup and restore the database

  • Schedule database backups

  • Update the MySQL database connection information and test the connection

  • Start and stop the Jamf Pro server (Tomcat), and change Tomcat memory settings

  • Start and stop the MySQL server and adjust MySQL settings

  • Apply a custom CLI

Jamf Pro Server Tools will replace the Jamf Pro database utility in a future release of Jamf Pro. The existing methods using the Jamf Pro database utility will still work.

1.0.0

Initial Release