Editing the Database Connection Using Jamf Pro Server Tools

Updated: 22 March 2022
Product: Jamf Pro

Jamf Pro uses information in the DataBase.xml file to connect to the MySQL database. You can use Jamf Pro Server Tools to edit the database connection details in the DataBase.xml file, as well as test the connection to the database.

General Requirements

  • Jamf Pro 10.0.0 or later

  • Jamf Pro Server Tools 2.4.1 or later

Editing the Database Connection Using Jamf Pro Server Tools GUI

  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. Linux only:
    1. Click Preferences in the sidebar.
    2. Click Run as Admin.
    3. Enter the administrator password for your computer, and then click OK.
    Jamf Pro Server Tools will restart in administrator mode.
  3. Click Jamf Pro in the sidebar.
  4. Edit the connection details you want to change.
  5. Click Test Connection to attempt a connection to the database with the provided credentials.

    A status displays the results of the attempt.

  6. After the database connects successfully, click Save.
  7. A notice displays indicating that Tomcat must be restarted. Click OK.
  8. Click Tomcat in the sidebar.
  9. Click Restart Tomcat.

Editing the Database Connection Using the Jamf Pro Server Tools CLI

  1. Open a command terminal.
  2. Execute the following command to view the current database settings:
    jamf-pro server config list
  3. Change the database connection settings as needed by executing the following command with the applicable flag and value. For example:
    jamf-pro server config set --database-name jamfsoftware
    Note:

    When changing the database password, you can use a secure prompt to enter the password value instead of passing the value to the flag. For example, execute jamf-pro server config set --database-password. Enter the new database password, and then press Enter

    A "configuration was updated" message is displayed.

  4. Restart Tomcat by executing the following command:
    sudo jamf-pro server restart