Upgrade Guide

Overview

This guide describes how to upgrade RAMP DCIM to a later version. The primary audience is IT professionals who are experienced in setting up and configuring Windows Server environments. From a high level, the following tasks are involved in the upgrade process:

  1. Perform pre-upgrade steps.
  2. Uninstall RAMP DCIM Application Manager, Images, and Data Collectors from your servers.
  3. Download and run the RAMP DCIM database migration script.
  4. Download and install later versions of RAMP DCIM Application Manager, Images, and Data Collectors.
  5. Apply the license key and verify that the upgrade was successful.

Before you upgrade

Request a new license

Contact us to request a new license for RAMP DCIM. We will subsequently email you the license key.

Back up your database

You should back up your database in case your upgrade has unforeseen consequences, and you need to roll back changes.

  1. Open SQL Server Management Studio and connect to the database server instance.
  2. Expand Databases in the Object Explorer.
  3. Right-click on the database used by RAMP DCIM, then click Tasks, then Back Up….
upgrade_1
  1. Update backup properties as required and click OK. We strongly recommend that you perform a full backup.
upgrade_2
  1. Click OK in the backup completion pop-up.

Back up your configuration file

Browse to your RAMP DCIM Web.config file (located by default at C:\Program Files\Tuangru\Web\api), and copy it to a folder on your local machine or network which will not be affected by the upgrade. You will need to use connection string values from your Web.config file when you install the newer version of the DCIM Manager.

Save a RAMP Services Status screenshot

Go to your RAMP Services Status page (open DCIM Manager, click Settings i.e. the gear icon, and click RAMP Services Status), then take a screenshot for reference purposes.

agent_status_1

RAMP DCIM uninstallation

  1. Go to Control PanelProgramsPrograms and Features in Windows Server.
  2. Select RAMP DCIM Data Collector and click Uninstall.
  3. Follow the prompts to complete the uninstallation.
  4. Repeat steps 2 and 3 to uninstall RAMP DCIM Manager (ignore any restart prompts), then uninstall RAMP DCIM Manager Images.

Database migration

  1. Go to Hyperview Downloads. If you cannot log in, please contact us.
  2. Browse to public/RAMP/Current/database or public/RAMP/Archive/x.x.x/database, where “x.x.x” represents a version number.
  3. Click and save databaseMigrations-xxxxx.zip, where “xxxxx” represents the version number without the dots.
  4. Unzip the file.
  5. Open Windows PowerShell or PowerShell ISE
  6. cd to the unzipped databaseMigrations-xxxxx folder.
  7. Run the following command using connection string details from the saved Web.config file: DatabaseMigrations.exe –s {server} –d {database} –u {username} –p {password} --current-version {version}

An overall PowerShell example is shown below.

cmd
cd Downloads\databaseMigrations-31100
DatabaseMigrations.exe -s WIN-80PMDETU619 -d ramp -u sa -p Passw0rd! --current-version 3900

Tip

You do not need to use the current-version argument for subsequent migrations. For named SQL instances you will need to clarify this, IE: SERVERNAMESQLEXPRESS All parameters are case sensitive (servername, password, etc)

DCIM Manager installation

Once you have installed Windows Server, IIS, and SQL Server (or SQL Server Express), proceed to download and install the DCIM Manager. The installation process will also cover product configuration.

  1. Go to Hyperview Downloads.
  2. Go to public/RAMP/Current/installers.
  3. Click manager-xxxxx.zip to download the installer, where “xxxxx” represents the current DCIM Manager version number.
  4. Unzip the file and double-click Setup.exe to launch the Manager Setup utility.
  5. Click Accept to accept the terms of the EULA.
  6. If .NET Framework 4.5 or 4.5.x cannot be found on your system, you will be prompted to install it. Proceed to install .NET using default settings.
  7. Click Next to start RAMP DCIM Manager Setup.
manager_1
  1. Read and accept the terms of the EULA by selecting I accept… then click Next.
manager_2
  1. Choose a different installation folder, or click Next to accept the default location.
manager_3
  1. Click Install.
manager_4
  1. Click Finish to complete the installation. The RAMP Configuration Tool will automatically run.
manager_6
  1. Click Next to start the RAMP DCIM Configuration Tool.
manager_7
  1. At Application Identity, provide login credentials for the account that will be used by RAMP DCIM Windows Services. Available identity types are:
    • Local System (recommended)
    • Domain Account, which will use a Windows Domain Account with server admin privileges.
manager_8
  1. At Database Setup, select either of the following setup methods:
    • Automatically create database (recommended for new installations)
    • Setup database separately (required if you are retaining an existing database, for example if you are upgrading RAMP DCIM)
manager_9

Tip

If you selected Setup database separately, click Get Files to browse to ReadMe-en.txt, which contains relevant information.

  1. At Generate Database Setup Information, provide values for:
    • Server: Specify the SQL Server server instance by doing one of the following:
      • Provide . if SQL Server is running on the same Windows Server as DCIM Manager.
      • Provide the name of the Windows Server that is running SQL Server if SQL Server and DCIM Manager are not running from the same server.
      • If a named SQL Server instance has not been defined, provide it in WindowsServerName\SQLServerInstance or WindowsServerName\SQLServerInstance,PortNumber format, such as db01\SQLServer or db01\SQLServerExpress,15422.
      • If you are upgrading RAMP DCIM, provide the exact Data Source value noted in your Web.config file.
    • Database Name: Enter a name for the database. If you are upgrading RAMP DCIM, the database name must match the Initial Catalog value noted in your Web.config file. For example: ramp.
    • Runtime connection credentials: Select one of the following options:
      • Windows Authentication will use a Windows Domain Account.
      • SQL Authentication using automatically created user will auto-generate a local SQL Server user. This is the recommended option for new installations.
      • If you use this option on an instance where ramp was previously installed, you may need to first remove the “Ramp” user from SQL under Security -> Logins.
      • SQL Authentication will create a SQL Server user using a username and password you have provided.
    • Credentials for creating database: Select either of the following options:
      • Windows Authentication will use a Windows Domain Account. If this is selected, the user must be an Administrator with SQL Server read/write permissions.
      • SQL Authentication will use a local SQL Server user. You will have to provide the username and password. The user must have the dbcreator and securityadmin roles in SQL Server. If you are upgrading RAMP DCIM, the username and password values must match the User and Password values noted in your Web.config file.
      • You cannot use the “sa” account if you’ve chosen SQL for both the runtime connection and creating the database.
manager_10

Tip

By default the Web.config file is located at C:\Program Files\Tuangru\Web\api.

Important

For runtime connection credentials, the Windows Authentication option will only work if you selected Mixed Mode authentication during SQL Server installation. Do not select the SQL Authentication option unless guided by Hyperview Support.

  1. Under Confirm, click Next to apply settings.
  2. Click Finish to complete the installation.
manager_13

DCIM Images installation

The Images installer includes all the virtual images used by RAMP DCIM, such as for default device configurations. Images must be installed on the same server running the DCIM Manager.

  1. Go to Hyperview Downloads.
  2. Go to public/RAMP/Current/installers.
  3. Click Images.msi to download the installer.
  4. Run the Images installer. The installer will automatically exit once it has finished running.
images_1

DCIM Data Collector installation

This installation must be performed on every Data Collector server. For example, if your company has data centers in Vancouver, Seattle, and Tokyo, and you decide to deploy a Data Collector in each site, then you will install Data Collector on a server in each of those three locations.

  1. Go to Hyperview Downloads.

  2. Go to public/RAMP/Current/installers.

  3. Click dataCollector-xxxxx.zip (the “xxxxx” represents the current Data Collector version number) to download the installer.

  4. Unzip the file and double-click setup.exe to launch the Manager Setup utility.

  5. Depending on your setup environment, you may get a prompt to install Visual C++ 2010 Runtime Libraries and WinPCap. If you do:

    1. Click Install.
    2. Click Next to set up WinPCap 4.1.3.

data_collector_2

  1. Click I Agree to accept the license terms.
  2. Select Automatically start… and click Next.
  3. Click Finish to complete the installation.
  1. Click Next to start RAMP DCIM Data Collector Setup.
data_collector_6
  1. Read and accept the terms of the EULA by selecting I accept…, then click Next.
data_collector_7
  1. Choose a different installation folder, or click Next to accept the default location.
data_collector_8
  1. Click Install to start the installation.
data_collector_9
  1. Enter the API URL and click Register. The API URL is the endpoint where Data Collectors will send data. If the Data Collector is being installed on the same server as the DCIM Manager, provide http://localhost/api. If the DCIM Manager is on a different server:
  • http://DcimManagerServerName/api, such as http://MANAG01275/api
  • http://DcimManagerIpAddress/api, such as http://172.217.25.78/api

data_collector_10

  1. Click Finish to complete the installation.
data_collector_11

Post-upgrade steps

After you have completed installing the RAMP DCIM components, you will need to apply the new license key and verify the upgrade.

Apply the new license key

  1. Open the DCIM Manager by going to http://localhost (if you are on the DCIM Manager server) or its IP address (if you are accessing the server remotely).
  2. Enter admin and ramp as the username and password values, respectively, then click Login.
login_1
  1. Enter the license key you received via email from support@hyperviewhq.com and click OK.
  2. Re-login into the application using the same credentials. The default screen for the application opens.
default_screen_1

Verify the new version number

In DCIM Manager, click the ? drop-down, then click About. Verify that the version number matches the version you upgraded to.

upgrade_3

Verify the RAMP Services Status

In DCIM Manager, click Settings i.e. the gear icon, then click RAMP Services Status. Verify that the page matches the screenshot you had taken right before the upgrade.

agent_status_1