Skip to main content
Pentaho Documentation

Using the Pentaho Server Upgrade Installer with command line parameters

Parent article

If you are upgrading a headless server which does not support the display of a graphical interface, use one of the following methods to upgrade your Pentaho Server. Both methods require access to the command line interface.

Each option has its own set of specific parameters. See Pentaho Server Upgrade Installer command line parameters.

Before you begin

Before you begin upgrading a headless server through the console or silent command line interface, you need to understand how to specify the properties file for the upgrade installer and the available command line parameters.

Specify the path to the Pentaho Server Upgrade Installer properties file

When using the command line tools for running the Pentaho Server Upgrade Installer, you need to specify a path to the properties file for the upgrade installer.

  • The path to the installer.properties file may be either an absolute path or a relative path to the directory in which the installer resides.
  • If an installer.properties file is specified and exists, all other command line options are ignored.
  • If a properties file named either installer.properties or <NameOfInstaller>.properties already resides in the same directory as the installer, it is automatically used, overriding all other command line options. To point to another valid properties file, use the -f option.
  • If an installer properties file is specified but does not exist, the default properties file, if present, is used. Otherwise, any supplied command line options are used, or if no additional options are specified, the installer runs using the default settings.

Pentaho Server Upgrade Installer command line parameters

The following command line options are available for running the Pentaho Server Upgrade Installer.

OptionDescription
-? / -h / -help / --helpShow this help text.
-i [swing | console | silent]Specify one of the following methods for running the Upgrade Installer:
  • swing

    The default graphical interface.

  • console

    A non-graphical upgrade method, used for headless systems. This method issues command line prompts.

  • silent

    A non-graphical upgrade method, used for headless systems. 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.

-D<name>=<value>Specify the installer properties as a key-paired value.
  • <name>

    user install dir

  • <value>

    /target path

    Typically, this path is: /pentaho/server/pentaho-server

For example:

-Duser install dir=/target path

-r <path_to_generate_response_file>Use this option to override the default location of the log file and specify an alternate path. The default location is: pentaho-server/.patch archive
-jvmxms <size>Specify a JVM initial heap size. The minimum heap size is 2048m. For example: -jvmxms2048m
NoteJVM heap size options are only applicable to installers.
-jvmxmx <size>Specify a JVM maximum heap size.
NoteJVM heap size options are only applicable to installers.

Use the console to upgrade

The console option is a non-graphical method for running the version 9.0 Pentaho Server Upgrade Installer and can be used for headless systems. The console option issues prompts throughout the upgrade process. Alternatively, the silent mode issues no user prompts.

Procedure

  1. Log in with the same user account that originally installed the Pentaho Server.

    Most likely, this is the pentaho user or the Pentaho administrator account that is assigned administrative privileges.
  2. Stop the Pentaho Server.

    For instructions, see Start and stop the Pentaho Server for configuration.
  3. At the command line, enter one of the following commands to run the installer and start the Pentaho Server version 9.0 upgrade process:

    • Linux: ./PentahoServer-UP-9.0.0.0-bld.bin -i console
    • Windows: .\PentahoServer-UP-9.0.0.0-bld.exe -i console
  4. To launch the installer, enter the following command:

    PentahoServer-UP-9.0.0.0-bld [-f <path_to_installer_properties_file> | -options]

    To specify the path and its options, see Specify the path to the Pentaho Server Upgrade Installer properties file and Pentaho Server Upgrade Installer command line parameters.

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

  6. If there are errors, review the log file generated by the installer.

    The default location of the log file is: <installation directory>/pentaho-sever/.patch_archive
  7. If there are no errors, restart the Pentaho Server and then start Pentaho.

Next steps

After upgrading your Pentaho Server to version 9.0, complete these Post-upgrade tasks to verify that your Pentaho configuration is ready to use.

Use silent mode to upgrade

The silent mode is a non-graphical method for running the version 9.0 Pentaho Server Upgrade Installer and can be used for headless systems. In silent mode no prompts are issued throughout the upgrade process.

Procedure

  1. Log in with the same user account that originally installed the Pentaho Server.

    Most likely, this is the pentaho user or the Pentaho administrator account that is assigned administrative privileges.
  2. Stop the Pentaho Server.

    For instructions, see Start and stop the Pentaho Server for configuration.
  3. At the command line, enter one of the following commands to run the installer and start the Pentaho Server upgrade process:

    • Linux: ./PentahoServer-UP-9.0.0.0-bld.bin -i silent -DEULA_ACCEPT=true -DUSER_INSTALL_DIR=/TARGET_PATH
    • Windows: .\PentahoServer-UP-9.0.0.0-bld.exe -i silent -DEULA_ACCEPT=true -DUSER_INSTALL_DIR=/TARGET_PATH
  4. To launch the installer, enter the following command:

    PentahoServer-UP-9.0.0.0-bld [-f <path_to_installer_properties_file> | -options]

    To specify the path and its options, see Specify the path to the Pentaho Server Upgrade Installer properties file and Pentaho Server Upgrade Installer command line parameters.

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

  6. If there are any errors, review the log file generated by the installer.

    The default location of the log file is: <installation directory>/pentaho-sever/.patch_archive
  7. If there are no errors, restart the Pentaho Server and then start Pentaho.

Next steps

After upgrading your Pentaho Server to version 9.0, complete these Post-upgrade tasks to verify that your Pentaho configuration is ready to use.

Exit Codes

After completing the Pentaho Server upgrade process, the Pentaho Server Upgrade Installer displays one of the following exit codes.

NoteThe code appears in the console if you use one of the non-graphical modes.
CodeDescription
0Success
64Undefined
65EULA not accepted
66Bad upgrade path (USER_INSTALL_DIR does not exist OR it is not a valid Pentaho Product for the UP Installer)
67Incompatible upgrade version
68Completed with Warnings
69Completed with Non-Fatal Errors
70Completed with Fatal Errors
233(LINUX) Invalid parameter (Forgot the 'D' in a -DXXX parameter?)
1001(WINDOWS) Invalid parameter (Forgot the 'D' in a -DXXX parameter?)