Upgrading NAM Server

The report server installation program will detect any older version and offer to upgrade it to the current release. Optionally, the upgrade preserves the configuration information and traffic monitoring data contained in the report server database.

To upgrade an earlier version of the report server to the latest version, fulfill the prerequisites described below, and then run the installer for the latest version of the report server. The installer will detect the earlier software and display your upgrade options.

Planning and preparation

  • Read the upgrade guidelines for essential planning information:

    • The general order of upgrade activities is important. For example, you must upgrade the console before installing the report server.
    • Hardware requirements and recommendations.
    • Licensing requirements, including third-party licensing. You need licenses for Microsoft Windows Server and Microsoft SQL Server hosting the report server software and database. You need to make decisions related to SQL Server licensing in particular.
    • Network preparation.
  • When you run the installer, have the Internal API token or console administrator credentials handy. The installer will prompt you for an API token or for console administrator credentials so it can retrieve a token automatically. See API tokens for more information.

  • Back up the database. See Backing up Microsoft SQL Server databases.

Upgrading farm deployments

Components in deployments utilizing the farm-cluster method should be upgraded to the same release version in a particular order.

If you are creating a failover report server installation, do not use this procedure. Instead, apply report server installation procedure (Install the report server), add the report server to the cluster and assign to it the failover role (Configuring a failover node).

Moving the report server to a new machine

To migrate the report server from one platform to another, including the local database:

  1. Make backups of your databases and configurations from your old machine.
  2. Install the software on the new machine.
  3. Restore your databases and configurations on the new machine.

Upgrading CAS or ADS from 12.4 to 2017

All DC RUM components need to be authenticated within a particular deployment. This authentication was performed via an internal user. Starting with DC RUM 2017, authentication is performed via internally generated tokens. Because the RUM Console contains token generating and authentication functionality, make sure that you first upgrade the RUM Console.

Upgrading CAS 2017 to NAM Server

The CAS is the primary reporting engine and the whole configuration for NAM is maintained by the RUM Console. An ADS is a discontinued NAM component replaced by new functionality within CAS server. Upgrading deployments with ADS component require additional upgrade steps.

The installation wizard walks you through all steps in the correct order.

Exit all other programs before running the setup program.
Some Windows programs, such as anti-virus software, may interfere with the upgrade process.

Note
If other Dynatrace products are currently active on the target machine, their services are stopped automatically before CAS or ADS is installed.

Double-click the setup file.
Depending on your release the file name should be similar to CAS_setupAMD64.exe .

On the License Agreement screen, indicate that you have read and accepted the license agreement and click Next.

The installer will guide you through the upgrade of the RUM Console. Click Next to advance the wizard.
If you selected to upgrade your software without changing settings, most of these screens are not displayed.

Existing installation detected


If an existing installation is detected, you have two options.

  • Quick will skip installation screens you don't need to update when installing the software. If a feature is new or changed, however, it will display that installation screen for you to configure.
  • Full will step you through all installation screens so you can review the current settings and change them as necessary.

Both options will upgrade the software (or reinstall) from the installer but preserve all of your configuration settings where possible. The difference is in whether you want to review (and possibly change) your configuration.

Easy upgrade

We recommend that you use the Quick option for typical deployments. Some of the Quick upgrade panels will contain automatically detected values from the existing installation. If you do not want to change these values, click Next to continue the upgrade.

If you want to use the Full option with all options, refer to the server installation topic where all of the installation steps are described.

NAM Console connection


This screen defines the address on which this NAM Server will connect to the NAM Console for internal management processes.

  • NAM Console private address
    Enter a NAM Console address through which this NAM Server can be managed.

  • Enter token
    If you have a token, you can paste it into the Internal API token box.

  • Get token automatically
    Instead of entering a token, you can provide the NAM Console credentials here and the installer will retrieve the API token for you. For more information, see API tokens.

If you need to change this information after installation, you can run the installer/uninstaller in Windows to show this screen again and make your changes. For more information, see Changing settings after you install the software.

SSO key and certificate


If this screen is displayed, specify the encryption key information for communication between NAM components.

NAM Server installation - SSO key and certificate

  • Generate key and certificate
    If you select Generate key and certificate, you need to provide the required data, which varies depending on whether you selected automatic or custom key generation:

    • Country code
    • Locality
    • State/province
    • Organization name
    • Organization unit
    • Common/host name
    • Email address
  • Use custom key and certificate
    If you select Use custom key and certificate, you need to provide the file paths and password to valid certificate and key files.

  • Key Password is the password for the key.

  • Remember the key password specifies whether to remember the password or require it at startup.

    Important:

    • If you do not select Remember the key password, you can instead supply the key password at system startup, but only if you are directly connected to the server. Remember that the dialog box for entering the password will not appear if you are connected to the server using a remote terminal.
    • For the Generate key and certificate option, leave the password empty if you do not want to encrypt the newly generated key.
    • For the Use custom key and certificate option, you must enter the password if the file is encrypted (for verification that the file is valid).

If you need to change this information after installation, you can run the installer/uninstaller in Windows to show this screen again and make your changes. For more information, see Changing settings after you install the software.

NAM Server connectivity options


Use this screen to set the internal address and public URLs for this NAM Server.

NAM Server installation - NAM Server connectivity options

Hostname or IP address (see the installer screen for examples) is the address that the NAM Console will use to connect to this NAM Server for internal communication only (private, component to component). It does not need to be accessible to users. The installer screen shows addresses it detected. You can simply type an IP address or hostname, or you can click Help in the installer if you want to copy and paste one of the detected machine names from the installer help text to the Hostname or IP address box. See NAM component addresses for a fuller explanation of NAM addresses and URLs.

Use HTTPS (HTTP over SSL)
Select this option to use HTTPS for the public URL of this NAM Server. This option (HTTPS) is recommended for better security.

  • HTTPS Port
    When accessing the reports on a port other than 443, remember to supply the selected port number together with the host name in your browser. This number is incremented if the default port is unavailable.
  • Public HTTPS URL
    The public URL of this NAM Server if you choose HTTPS (recommended). To access this server over HTTPS, you will need access to this URL and to the NAM Console public URL.
    • Generate key and certification
      If you select this option, the next installer screen will prompt you for the data (country code, etc.) required to generate the certificate.
    • Use custom key and certificate
      If you select this option, you need to enter the certificate and key file paths on the next screen.
    • Use SSO key and certificate
      If you select this option, the installer applies the SSO key and certificate information.

Use HTTP
(Not recommended) - Select this option to use HTTP for the public URL of this NAM Server. This option (HTTP) is not recommended. HTTPS is the secure option.

  • HTTP Port
    This number is incremented if the default port (80) is unavailable.
  • HTTP public URL
    The public URL of this NAM Server if you choose HTTP (not recommended). To access this server over HTTP, you will need access to this URL and to the NAM Console public URL.
    • Use HTTP for communication
      Use HTTP to transfer and display reports.
    • Redirect HTTP to HTTPS only
      When an attempt is made to connect to this NAM Server using HTTP, automatically redirect that connection to HTTPS.

SSL key generation data


If you select Generate key and certification on the NAM Server connectivity options screen, this screen prompts you for the data needed to generate the key: country code, locality, state/province, organization name, organization unit, common/host name, and email address.

SSL key security


If you select Generate key and certification on the NAM Server connectivity options screen, this screen prompts you to enter the key password and to select whether to remember the key password.

If you do not select Remember the key password, you will have to enter the password every time you start the server.

SSL custom key and certificate


If you select Use custom key and certificate on the NAM Server connectivity options screen, this screen will prompt you for the file paths and password for the custom key.

NAM Server installation - SSL custom key and certificate

  • SSL Certificate File
    The path and name of the certificate file.
  • SSL Private Key File
    The path and name of the private key file.
  • Key Password
    The password associated with the key. You must enter the password if the key is encrypted.
  • Remember the key password specifies whether to remember the password or require it at startup.

If you do not select Remember the key password, you will have to enter the password every time you start the NAM Server.

On the Pre-Installation Summary page, review the summary of your installation choices and click Install.
To change the settings, click Back to return to the appropriate configuration screen.
The amount of time this takes depends on the size of the database and may take between several seconds and, for large databases, several hours. A progress box shows the status of the installation action currently in progress. When all of the required actions are completed, a final post-upgrade information screen is displayed.

On the Installation Summary screen, review the installation summary.
If you prefer, you can click Show postinstall summary to open a file that contains the installation summary.

Indicate whether you want to start CAS, and then click Finish to exit the installation program.

Clear your browser cache.
This ensures that your upgraded CAS configuration is displayed correctly.

What to do next

If you have not already obtained and installed a license, do so now.