Skip to main content
Outside service Partner
Hitachi Vantara Knowledge

Upgrading UCP Advisor

This procedure is for upgrading the UCP Advisor management node instance from version 2.0 or 2.0 Patch 1 to version 2.5.0. Upgrading from versions 1.2 and earlier is not supported.

Preparing for the upgrade

Preparing for the upgrade will help ensure that the upgrade process goes smoothly and efficiently.

Before you go to the customer site:

  • Prepare a list of credentials for the system components you are upgrading.
  • Download the upgrade installation media and related documentation in case you do not have web access at the customer site.

At the customer site:

  • Ensure that the system you are upgrading is up and running with no active alerts, alarms, or unresolved issues.
  • Back up the UCP Advisor software configuration data.
  • Take snapshots of all of the management VMs for recovery.

Preparing a credentials list

Prepare a list of user credentials for each system component.

Work with the customer to provide a list of user credentials, either beforehand or available when you arrive on site. This list should include all user names and passwords for the current system components listed below, and will help save time when at the customer site.

  • vSphere (both vCenter root and vCenter SSO)
  • vCenter Management Port (root password for https://<vSphereIP>:5480)
  • Management Hosts (root password for ESXi hosts hosting management VM URL https://<ManagementHostIP>/ui)
  • UCP Advisor controller VM
  • UCP Advisor Gateway VM
  • Hitachi Automation Director (if installed)
  • vRealize Orchestrator (if installed)
  • vRealize Log Insight (if installed)
  • Hi-Track Monitor
  • BMC IP and credential for compute servers
NoteAsk the customer if any of the UCP Advisor software configuration XML has been updated.

Verifying the UCP Advisor system

Prior to upgrading, verify that the UCP Advisor system is up and running with no active alerts or alarms, including its network and switches. All issues must be resolved before starting the upgrade. If you find any issues, discuss with the customer about how to resolve them before continuing with the upgrade.

  1. Verify compliance of the vCenter host profile. For details, see the VMware document, Checking compliance of a host profile.

  2. Verify that there are no active alarms in the vSphere Web Client. For details, see the VMware document, View and Edit Alarms.

  3. Create a list of all devices (network, Fibre Channel, compute, and storage) that are onboarded, online, and visible in UCP Advisor. Verify that there are no issues with any of the devices.

  4. Make sure the firmware versions of each device (switches, compute servers, storage) match the firmware version given in the release notes for that version.

  5. Fix any issues prior to the upgrade.

Downloading the UCP Advisor installation media ISO package

Download the media installation ISO package before going to the customer site because you might not have web access at the site where the upgrade is to be performed.

Procedure

  1. Log on to the Support.hds.com portal.

  2. Click Product Downloads.

  3. In Find a Download, enter UCP Advisor.

  4. Under Available Software, click UCP Advisor.

  5. Click Download the UCP Advisor installation media for version 2.5.0.

  6. Verify that the media downloaded properly.

Backing up the UCP Advisor software configuration data

Back up the .xml files used to configure the UCP Advisor software so that you can use them to restore the pre-upgrade configuration, if necessary. Verify with the customer if the .xml files were modified from the standard installation version. If they were, you can use these backup files to reconfigure the software after the upgrade.

Procedure

  1. Log on to the UCP Advisor controller VM.

  2. Open an administrator CMD window.

  3. Run the following commands:

    md c:\temp\AdvisorConfigBackupFor2_5
    cd "C:\Program Files\Hitachi\UCP Advisor"
    xcopy /fcedy *.config c:\temp\AdvisorConfigBackupFor2_5
    			 
    For reference, the .xml files for UCP Advisor 2.0 and 2.0 Patch 1 are shown below.

Taking VM snapshots

Take snapshots of all management node VMs to enable recovery if needed.

  1. Log on to all management hosts, as the VMs may be spread across multiple management hosts.

  2. Shut down each VM in the following sequence. Allow each VM to shut down completely before shutting down the next one.

    1. UCP Advisor controller VM

    2. UCP Advisor Gateway VM

    3. Hitachi Automation Director, if present

    4. vRealize Orchestrator, if present

    5. vRealize Log Insight, if present

    6. vSphere VM

  3. In the Navigator pane, select Virtual Machines.

  4. Right-click the UCP Advisor controller VM, then select Snapshot > Manage Snapshots.

  5. Enter a name for the snapshot; for example, BeforeAdvisorUpgrade2_5.

  6. Click Take Snapshot.

  7. Repeat steps 4 through 6 to take a snapshot of each VM.

Upgrading UCP Advisor system components

Upgrade the software and VM components in the UCP Advisor system:

  • VMware vSphere
  • Hitachi Automation Director, if present
  • vRealize Orchestrator, if present
  • vRealize Log Insight, if present
  • UCP Advisor Gateway VM
  • UCP Advisor controller VM
  • Third-party software
  • UCP Advisor software

Upgrading vSphere

Use the vCenter Server Appliance to upgrade the vSphere components to the level supported by the UCP Advisor upgrade version, as specified in the Release Notes.

Before you begin

Access the Release Notes for the upgrade version: https://knowledge.hds.com/Documents/Converged/UCP_Advisor.

For details on using this appliance, see Patching the vCenter Server Appliance and Platform Services Controller Appliance, available from VMware Docs at https://docs.vmware.com/en/VMware-vSphere/6.5/com.vmware.vsphere.upgrade.doc/GUID-043EF6BD-78F7-412F-837F-CBDF844F850C.html.

Procedure

  1. Log on to the vCenter Server Appliance using the management URL. This step assumes that the upgrade ISO image is attached to the vCenter VM as CD/DVD.

  2. In the Navigator pane, click Update.

  3. In the Available Updates area, click Install Updates.

  4. When the installation is done, click OK.

  5. Restart the vSphere VM.

Next steps

Verify that vSphere updated correctly.

  1. Log on to the vSphere Web Client: https://<vSphereVM_IP>vsphere-client/?csp.
  2. Verify that the Hitachi UCP Advisor for VMware vCenter plug-in is present on the home page. Note that other appliances are not displayed because all of the other VMs were shut down in a previous step.
  3. In the Navigator pane, click Administration > Client Plug-Ins, and check to see that the old version is installed. See the Release Notes for current versions.

Upgrading optional software components

The following optional software components do not require upgrading for the current release of the UCP Advisor software:

  • Hitachi Automation Director, if present
  • vRealize Orchestrator, if present
  • vRealize Log Insight, if present

Upgrading the vRealize Orchestrator plug-in

Upgrade the vRealize Orchestrator plug-in VM.

Procedure

  1. If present, bring vRealize Orchestrator online.

  2. Log on to the vRO control center at https://%3CvRO-IP%3E:8283/vco-controlcenter/.

  3. Navigate to Manager Plug-ins, located under the plug-in section. Verify the plug-in build number from the latest release notes.

  4. Click Browse, and navigate to the UCP Advisor installed directory at C:\Program Files\Hitachi\UCP Advisor\vRO\plugin.

  5. Select the Hitachi Storage Connector plug-in o11nplugin-HSC.dar and install.

  6. Once installed, choose Save Changes.

  7. Repeat steps 4 and 5 to install Hitachi Compute Connector plug-in o11nplugin-HiVCOServer.dar.

  8. Go to the Home screen, and select Startup Options.

  9. Restart the vRealize Orchestrator server service and wait for the service to respond.

Next steps

Verify that the vRealize Orchestrator plug-in updated correctly.

  1. Navigate to Manage Plug-ins, located under the plug-in section.
  2. Verify that the appropriate plug-ins are enabled, as shown below.
  3. Verify that the plug-in installation has completed and that all Hitachi storage and compute workflows are available from the vRealize Orchestrator client.

Upgrading the UCP Advisor Gateway VM

Upgrade the software on the UCP Advisor Gateway VM.

Before you begin

Procedure

  1. Bring the UCP Advisor Gateway VM on-line.

  2. From a vCenter host, log on to the UCP Advisor Gateway VM console.

  3. Verify the currently installed version of the REST server:

    1. On the command line, enter puma_adm -pc to display the configuration information.

    2. Verify that the REST Server version is 5.2.0.2971.

  4. Bring the UCP Advisor Gateway VM on-line.

  5. Start a Remote Desktop session, then log on to the UCP Advisor controller VM.

  6. Copy the UCP Advisor installation media ISO package you previously downloaded to the following VM directory. If this directory does not exist, create it.

    C:\temp
  7. Mount the directory listed above as F: drive.

  8. From an administrator CMD window, use the PSCP tool to copy the .rpm file to the UCP Advisor Gateway VM. If you are prompted for an RSA key, enter y.

    "c:\Program Files\Hitachi\UCP Advisor\HivSphereConverged\InstallerUtil\putty\PSCP.EXE" -pw <UCP Advisor Gateway VM Password> F:\Software\AdvisorGatewayOVA\puma-6.0.0-el7.x86_64.rpm root@<UCP Advisor Gateway VM IP>:/root/

    In some cases, you may be prompted for the RSA keys.

    The server's host key is not cached in the registry. You have no guarantee that the server is the computer you think it is. The server's rsa2 key fingerprint is: ssh-rsa 2048 34:58:4b:9b:7c:cf:88:27:ae:52:93:1d:3a:03:fc:83 If you trust this host, enter "y" to add the key to PuTTY's cache and carry on connecting. If you want to carry on connecting just once, without adding the key to the cache, enter "n". If you do not trust this host, press Return to abandon the connection. Store key in cache? (y/n) y

    When copying is completed, the following line is displayed:

    puma-6.0.0-el7.x86_64.rpm | 119392 kB | 29848.2 kB/s | ETA: 00:00:00 | 100%
  9. From the UCP Advisor Gateway VM console, run the following command to update the software:

    puma_adm -r<rpm_file>
  10. At the Upgrade all [BFNS] prompt, press Enter.

Next steps

Verify that the UCP Advisor Gateway VM upgraded correctly.

  1. Enter puma_adm -ck | more, then verify that the command device is attached. If any of the services are listed as FAIL, restart the VM, then repeat this step.
  2. Enter puma_adm -pc to display the configuration information, then verify that the REST Server version matches the upgrade version as listed in the Release Notes.

Upgrading the UCP Advisor controller VM

Upgrade the UCP Advisor controller VM in multiple steps: verify that the UCP Advisor services are running, upgrade the third-party software, upgrade the UCP Advisor software, then upgrade the UCP Advisor REST API.

Verifying UCP Advisor services

Verify that the UCP Advisor services are running on the UCP Advisor controller VM before upgrading the software.

Before you begin

Verify that the UCP Advisor controller VM is online.

Procedure

  1. Start a Remote Desktop session, then log on to the UCP Advisor controller VM.

  2. Open the Services panel, then verify that the following services are running:

    • Hitachi UCP Advisor Ghost
    • Hitachi UCP Advisor Hi-Track Web Service
    • HitachiUCP Advisor Service Registry
    • Hitachi UCP Advisor Services
    • Hitachi UCP Advisor Sidecar
    • Hitachi UCP VI Service
    • Hitachi vRO Converge Web Service
    • Hitachi Watchdog Service

Upgrading third-party software

Upgrade third-party software before upgrading the UCP Advisor software.

Upgrade the Java 8 software to Update 161.

Procedure

  1. On the UCP Advisor controller VM, browse to the following directory:

    F:\Software\Java8
  2. Double-click jre-8u161-windows-x64.exe.

  3. Click Install to set up Java with the default settings.

  4. Select the following out-of-date version(s) of the Java 8 update, then click Uninstall:

    • Java 8 Update 144 (64-bit) for UCP Advisor 2.0
    • Java 8 Update 151 (64-bit) for UCP Advisor 2.0 Patch 1
    The Java Setup - Complete window opens.
  5. Click Next, then follow the remaining prompts to complete the upgrade installation.

Next steps

Verify that the Java software has been upgraded.

  1. In the Control Panel, browse to Control Panel > All Control Panel Items > Programs and Features.
  2. Verify that the Java 8 Update 161 (64-bit) has been installed.

Upgrading UCP Advisor

Upgrade the UCP Advisor software.

Before you begin

Upgrading the UCP Advisor 2.5.0 software requires upgrading the following two components:

  • UCP Advisor
  • UCP Advisor API
NoteThe UCPAdvisorOnBoardSheet.csv sheets cannot be used as is after the upgrade. A new template file is put in same location (C:\Program Files\Hitachi\UCP Advisor\Documentation).

Procedure

  1. Browse to the location of the UCP Advisor installation media:

    F:\Software\UCPAdvisor25
  2. Double-click the UCPAdvisor-Master-setup-02.5.0-(x64.exe file.

  3. Click Yes to confirm the upgrade.

  4. Click Next.

    The software is validated and installed.
  5. Select Yes, I want to restart my computer now, then click Finish.

  6. In the Upgrade vCenter Plugin window, enter the vCenter credentials and click Submit to re-register the upgraded plugin.

    Wait for the re-registration to complete, it takes 2-3 minutes.
  7. Click OK.

Results

The UCP Advisor software is upgraded and the plugin is registered.
Troubleshooting

If registration of the upgraded plugin fails, register it using UCP Advisor Toolbox:

  1. From the desktop, launch UCP Advisor Toolbox.
  2. In the vCenter plugin pane, enter the vCenter plugin credentials, then click Submit.

Upgrading the UCP Advisor REST API

Upgrade the UCP Advisor REST API.

  1. Browse to C:\Program Files\Hitachi\UCP Advisor\RestAPI.

  2. Double-click setup.exe.

  3. Click Yes to confirm the upgrade of the UCP Advisor REST API.

  4. Click Next.

  5. Click OK to continue the installation.

  6. Click Finish.

  7. Manually reboot the system.

Updating UCP Advisor configuration files

If the customer modified the UCP Advisor .xml configuration files after installing the previous version of the UCP Advisor software, you need to update the upgraded .xml configuration files using the .xml files you backed up when preparing for this upgrade. Skip this procedure if the customer did not modify the configuration files.

Before you begin

Locate the .xml configuration files you backed up when preparing for this upgrade. They should be located in C:\temp\AdvisorConfigBackupFor2_5.

Procedure

  1. In an administrator CMD window, compare each of the old and new .xml configuration files for differences between them.

  2. Manually update the new files with the values found in the old files. The new files are located in C:\Program Files\Hitachi\UCP Advisor\.

    For example, a comparison of the old and new versions of the App.config file shows a difference in the values for the CommunicationType key. The old value is HTTPS but the new value is HTTP. You would update this key in the new App.config file with the value from the old App.config file.

     fc "C:\Program Files\Hitachi\UCP Advisor\HiLogInsightConverged\SyslogAgent\App.config"
    C:\temp\AdvisorConfigBackupFor2_5\HiLogInsightConverged\SyslogAgent\App.config
    ***** C:\PROGRAM FILES\HITACHI\UCP ADVISOR\HILOGINSIGHTCONVERGED\SYSLOGAGENT\App.config
    			<!-- CommunicationType possible value: HTTP or HTTPS -->
       <add key="CommunicationType" value="HTTP"/>
       <add key="httpsPort" value="2054"/>
    ***** C:\TEMP\ADVISORCONFIGBACKUPFOR2_5\HILOGINSIGHTCONVERGED\SYSLOGAGENT\APP.CONFIG
       <!-- CommunicationType possible value: HTTP or HTTPS -->
       <add key="CommunicationType" value="HTTPS"/>
       <add key="httpsPort" value="2054"/>
    *****

Verifying UCP Advisor plugin status

Verify the status of the UCP Advisor plugin upgrade and all onboarded devices. Verify that the version numbers match those listed in the Release Notes.

Before you begin

Access the Release Notes for the upgrade version: https://knowledge.hds.com/Documents/Converged/UCP_Advisor.

Procedure

  1. From the UCP VM, open Control Panel > Add Remove Programs.

  2. In the Version column, verify that the version of the UCP Advisor plugin matches the version listed in the Release Notes.

  3. Log on to the vSphere Web Client.

  4. In the Navigator pane, click Administration > Client Plug-Ins.

  5. In the Version column, verify that the version of the UCP Advisor plugin matches the version listed in the Release Notes.

  6. Navigate to the UCP Advisor plugin.

    The UCP Advisor Dashboard shows all onboarded devices. The status for all onboarded devices may appear as Unreachable. Wait for the database to refresh, possibly 30-45 minutes. The status will refresh to Normal, indicating that the software upgrade is complete.

Upgrading the firmware of onboarded devices

Upgrade the firmware for each onboarded device. For a list of devices that support firmware upgrades, consult the UCP Advisor 2.5 Administration Guide or the UCP Advisor 2.5 Deployment Guide.

  1. From the previously downloaded UCP Advisor Media ISO, extract the UCPAdvisorFirmwareBundleSkylake firmware zip file. This file is for UCP CI and UCP HC (Skylake).

  2. Upload the firmware zip to the Appliance | Administration in Advisor plugin and update the firmware.

  3. Make sure the firmware on all devices matches the firmware version given in the UCP Advisor 2.5 Release Notes.

Upgrading ESXi hosts

Make sure that the ESXi hosts are updated to the latest version.

Procedure

  1. Verify that the management hosts are clustered, so they can failover the management VM for the dedicated management host.

  2. Verify that the compute host in the cluster has sufficient spare capacity to handle at least one node being down. If not, verify that the customer can accept the workload.

  3. Follow the VMware's standard practice to upgrade the host. For supported versions, see the UCP Advisor 2.5 Release Notes here: https://knowledge.hds.com/Documents/Converged/UCP_Advisor.

    Recommended patch: https://kb.vmware.com/s/article/2151102.

    For details on using the update manager for patch updates, see: https://docs.vmware.com/en/VMware-vSphere/6.5/com.vmware.vsphere.update_manager.doc/GUID-F7191592-048B-40C7-A610-CFEE6A790AB0.html.

Performing a final validation and cleanup

Verify that each device on the list you created when preparing for the upgrade is up and running.

Repeat the visual validation of vSphere for compliance and other issues to ensure consistency of the UCP Advisor system before and after the upgrade. Remove the VM snapshots taken before starting the upgrade.

Troubleshooting

Tips are provided for troubleshooting the upgrade process.

Manually upgrading the DS120/DS220 firmware

UCP Advisor 2.5 is currently only certified to run version 3.16.06 or 3.75.06 of the DS120/220 firmware. Upgrade from 3.16.06 to 3.75.06 is not recommended. However, in some exceptional situations, an upgrade to a later version of the firmware may be possible through a manual upgrade process. These steps need to be followed for each blade as appropriate.

Procedure

  1. Find out from the customer whether they have any specific BIOS settings for the DS120/DS220-Skylake servers that need to be preserved. These settings need to reinstated after the firmware upgrade.

  2. Download the server firmware from Support.hds.com.

  3. Power off the server.

  4. Use the web UI (connect to BMC IP) to manually deploy and upgrade the BMC firmware. Use the "No Preserve" setting for BMC.

    This will erase the BMC settings.
  5. Connect the monitor and keyboard to the server.

  6. Reboot the server and then press the F2 or Del keys to access the BIOS and reconfigure the BMC IP.

  7. Press F10 to save and restart.

  8. Use web UI (connect to BMC IP) to manually deploy and upgrade BIOS firmware. Use the "No Preserve" setting for BIOS. This will erase the BIOS settings

Restoring the DS120/DS220 Skylake server BIOS

The BIOS settings for the DS120/DS220 server must be restored after a firmware upgrade. Additional, customer-specific BIOS settings must be updated manually.

Following are the steps for restoring the commonly used DS120/DS220 BIOS settings.

Procedure

  1. From the UCP Advisor Controller VM, browse to C:\Program Files\Hitachi\UCP Advisor\HivSphereConverged\InstallerUtil\putty

  2. Double-click Putty.exe.

  3. Use UCP Advisor Gateway VM IP for the Host Name, then click Open.

  4. Log in as root.

  5. Open Notepad on the UCP Advisor Controller VM and copy/paste the following command:

    curl -k -s -H "Accept: application/json" -H "Content-Type:application/json" -X PUT https://<BLADE_BMC_IP>/redfish/v1/Systems/Self/Bios/SD --user <BLADE_BMC_ADMIN_USER>:<BLADE_BMC_ADMIN_PASSWORD> -d "{\"Attributes\":{\"FBO101\":\"Hard Disk\",\"FBO102\":\"USB\",\"FBO103\":\"CD\/DVD\",\"FBO104\":\"Network\",\"FBO201\":\"Hard Disk\",\"FBO202\":\"USB\",\"FBO203\":\"CD\/DVD\",\"FBO204\":\"Network\",\"CRCS005\":\"Enable\",\"IIOS1FE\":\"Enable\",\"IPMI100\":\"Disabled\"}}"
  6. Replace <BLADE_BMC_IP>, <BLADE_BMC_ADMIN_USER>, and <BLADE_BMC_ADMIN_PASSWORD> with the specific blade information.

  7. Copy this updated command and paste it in the Putty session, then press ENTER to update the blade.

  8. From within vCenter, cycle the power on the blade using the UCP Advisor client plug-in.

  9. Restore customer-specific BIOS settings as required.

Using a snapshot to recover a previous VM version

You can restore a previous VM version from the snapshot taken during the upgrade process.

  1. Power off all of the VMs according to the order specified in Taking VM snapshots.

  2. Restore all of the VMs based on the snapshot procedure described in Taking VM snapshots.

  3. Power VMs back on in the following order:

    1. vSphere VM (Wait approximately 15 minutes after power on for all services to start up)

    2. vRealize Log Insight (VRLI , if installed)

    3. vRealize Orchestrator (VRO, if installed)

    4. Hitachi Automation Director (HAD, if installed)

    5. UCP Advisor Gateway VM

    6. UCP Advisor controller VM (wait 5 minutes)

      You should wait 1-2 minute before starting the next VM.
    NoteRestoring snapshots can cause the host to go out of synchronization. See Fixing host synchronization errorsfor details.

Fixing host synchronization errors

When reverting to a VM snapshot, vCenter can generate an error indicating that the host cannot be synchronized. You can fix these synchronization errors using the following procedure.

  1. From the vSphere Web Client, right-click on host, then click Connection>Disconnect.

  2. Follow the UI and wait for the current task to complete.

  3. Cick Connection>Connect.

  4. Provide the appropriate credentials to reconnect.

    The synchronization error message should be resolved.