Skip to main content
Pentaho Documentation

Using the Pentaho Upgrade Installer in silent mode

Parent article

If you are upgrading in an environment that does not support the display of a graphical interface, use the Pentaho Upgrade Installer in silent mode from a command line. The command for silent mode has specific parameters.

NoteThe silent mode of the Pentaho Upgrade Installer is not supported for macOS.

Before you begin

Before you begin upgrading from the command line interface, you need to understand how to specify the available silent command line parameters.

The following command line parameters are available for running the Pentaho Upgrade Installer:

ParameterDescription
-help / --helpShow help text for usage.
-i [gui | silent]Specify one of the following methods for running the Pentaho Upgrade Installer:
  • gui

    The default graphical interface.

  • silent

    A non-graphical upgrade method, used for environments that do not support the display of a graphical interface. This method issues no command line prompts. All parameters must be passed from the command line, including the acceptance of the end user license agreement.

-DEULA=<value>Specify your response to the End User License Agreement:
  • <true>

    You accept the End User License Agreement. This setting is required for the silent mode.

  • <false>

    You do not accept the End User License Agreement. Silent mode of the installer will not run if the value is to false.

-DUSER_INSTALL_DIR=<dir>Specify the location of the Pentaho root installation directory. This setting is required for the silent mode.
-DRESTORE=<value>Specify if you are using the silent mode to restore a backup for your original Pentaho products before an upgrade:
  • <true>

    Restore the back up of your original Pentaho 9.0 products before upgrading.

  • <false>

    Upgrade your Pentaho 9.0 products to version 9.1.The default value is false. If this command line option is not set, the silent mode installation will upgrade your Pentaho products.

-DBACKUP_ZIP=<file>Specify the location of the backup ZIP file produced by the upgrade process. This setting is required if you are restoring your original Pentaho 9.0 products.

Use silent mode to upgrade

The silent mode is a non-graphical method for running the Pentaho Upgrade Installer. In silent mode, no prompts are issued throughout the upgrade process.

Perform the following steps to run the Pentaho Upgrade Installer in silent mode:

Procedure

  1. Exit out of any Pentaho products you are currently running.

    If you are upgrading your Pentaho Server, stop the server. For instructions, see Start and stop the Pentaho Server for configuration.
  2. At the command line, enter one of the following commands to run the installer and start the upgrade process:

    • Linux

      ./pentaho-upgrade-9.1.0.0-324.bin -i silent -DEULA=true -DUSER_INSTALL_DIR=<dir>

    • Windows

      .\pentaho-upgrade-9.1.0.0-324.exe -i silent -DEULA=true -DUSER_INSTALL_DIR=<dir>

  3. When the server upgrade process is complete, the console displays an exit code.

  4. If any errors occur, review the log file generated by the installer.

    The default location of the log file is <root installation directory>/Pentaho__Installation/logs.
  5. If you are upgrading your Pentaho Server, restart the server.

Next steps

After upgrading your Pentaho products to version 9.1, complete the Post-upgrade tasks to verify that your Pentaho configuration is ready to use.

Exit codes

After completing the upgrade process, any of the following possible exit codes could appear in the log file.

CodeDescription
0Success.
1The installation completed successfully, but one or more of the actions from the installation sequence caused a warning or a non-fatal error.
-1One or more of the actions from the installation sequence caused a fatal error. The following possible errors could occur:
  • Required parameters were not specifed. For example, you may have not specified the following parameters:
    • The -i interface parameter was not specified.
    • The -DUSER_INSTALL_DIR Pentaho 9.0 root installation directory was not specified.
    • The -DEULA response to the End User License Agreement was not specified.
  • Running in silent mode while previous Pentaho product is still running.
  • Getting an exception during backing up files.
1000The installation was canceled by the end user.
1001The installation includes an invalid command-line option.

See the InstallAnywhere documentation for further possible exit codes.