Skip to main content
Hitachi Vantara Knowledge

Deployment of UCP Advisor

It is important to ensure that the hardware, software, and resources are in place before deploying the UCP Advisor VM components.

Deploying the UCP Advisor virtual appliance

Install and deploy the UCP Advisor Controller virtual appliance on a given management node.

Before you begin

There are several methods for deploying the UCP Advisor virtual appliance as follows:

  • Using a Hitachi supplied 2U4N management node (Quanta T41S).
  • Using an already existing customer supplied management node where UCP Advisor and the necessary components can be installed.
  • Using an optional configuration where the UCP Advisor Gateway VM is installed on the compute node, while the UCP Advisor Controller VM resides on the customer management node.

Prior to the deployment, ensure that the management node provided by Hitachi (or the customer) has met all the required pre-requisites described earlier in this document. When using a customer supplied management node, the Windows 2016 standard vm and license must be set up by the customer using the prerequisites described in UCP Advisor Controller VM requirements.

For systems deployed with optional Hitachi management nodes, the distribution center will have deployed ESXi on these hosts and provided the windows OVF on the ESXi datastores.

NoteUCP Advisor should be deployed on VMware high availability clustered servers and may coexist with non-mission-critical applications. UCP Advisor should not manage the servers that it is deployed on, with the exception of the UCP Advisor Gateway VM.
NoteUCP Advisor Gateway VM must be migrated to another server before performing disruptive operation (power control, firmware update etc.,) if its not residing on the management node. Once disruptive operation is complete AGW VM should be migrated back to original server to retain command device configuration.

The following procedure describes how to deploy the UCP Advisor controller VM on a Hitachi supplied management node.


  1. Download the following files from management node ESXi datastore, then copy the files to a windows desktop or laptop. Hitachi_Windows_Server_2016_OEM.ovf Hitachi_Windows_Server_2016_OEM-1.vmdk
  2. Log in to the vSphere client.

  3. From the Navigator, click Hosts and Clusters.

    The Host and Clusters data center list displays and expands.
  4. Right click the vCenter IP address at the top of the Navigator window.

    The vSphere client menu appears.
  5. Select the Deploy OVF Template option.

  6. Click Local file.

  7. Click Browse. The vSphere Web Client displays a directory of OVF files (with .ovf, .mf, and .vmdk extensions).

  8. Click Next. A window appears with fields for the VM name and datacenter location.

  9. Enter the VM name, and then select the inventory location.

  10. Select the target ESXi host on which the VM is to be deployed.

  11. Choose Select Storage with the Thin provision option and click Next.

  12. Select the required VM network and click Next.

  13. In the Ready to complete window, click Finish.

  14. Power on the UCP Advisor appliance VM.

  15. Open the UCP Advisor appliance VM console.

    1. Configure the time zone.

    2. Retrieve the license key from the COA sticker that is attached to the pull out tab on any of the management nodes. Refer to the UCP CI Build Guide under the section Copying Windows OEM Package onto Local Datastore (Conditional) and section no.11 and Apply the Microsoft Windows Server 2016 standard license.

    3. Configure the administrator password.

    4. Log on to the VM with administrator credentials.

Installing UCP Advisor components and services

Make sure that Windows 2016 is deployed on the target ESXi host (management node). Power it on and ensure that VM boots.

Installing VMWare tools

Install the VMWare tools on the Windows 2016 VM.

  1. Right-click the virtual machine instance on the ESXi host.

  2. Select Guest OS > Install VMware Tools.

  3. Click Mount.

  4. At the virtual machine console, connect to Console and right-click DVD Drive, select Install or run the program from your media, and select the Complete option to install.

    The VM prompts for a reboot when the VMware tools are installed. Click reboot to complete the installation.

    Confirm that the status of the VM tools is Running on the vSphere client.

(Optional) Enabling the remote desktop

Setting up the remote desktop is optional, and depends on the security profile of the customer.

  1. From Server Manager > Local Server, click the Remote tab.

  2. Select Allow remote connection to this computer.

Setting up the IP address of the UCP Advisor controller VM

Enables the administrator to remotely access the UCP Advisor virtual machine.


  1. Use Ipconfig /all before setting new IP addresses so you can recover them. The default setting is Obtain an IP address automatically.

  2. Set up a static IP address on the Windows server.

  3. Click OK.

Setting up the UCP Advisor Controller VM

Execute the install script to install UCP Advisor on the management node.

  1. Make sure that the management node (Windows VM) is not configured in an active directory (AD) environment.

    Group policies and user management operations related to active directory can affect UCP Advisor installation.
  2. Mount only these ISO images to the Windows 2016 VM.

    1. Windows Server 2016 ISO (This ISO image is located on the Hitachi supplied ESXi management node datastore). If the customer has provided their own management node, please use the windows ISO that was part of that installation.
    2. UCP_Advisor_Installation_Media_2.0_Patch1.ISO. (Media bundle available under TISC as shown below).

    The screenshot below shows mounted ISO images.

  3. Open the Administrator command prompt from PowerShell, and set the PowerShell Execution Policy to Bypass using the following command: Set-ExecutionPolicy -ExecutionPolicy Bypass.

    NoteThis command starts a PowerShell session that allows for running scripts and keeps the lowered permissions isolated to just the current running process. The ExecutionPolicy must be set to Yes to enable the install script to run.
  4. Execute Install.ps1.

  5. After the install script has completed successfully, reboot the VM.

  6. Confirm that the following software programs are installed:

    • Hitachi Unified Compute Platform Advisor
    • Hitachi Unified Compute Platform Advisor API
    • Java 8 Update 151 (64-Bit)
    • Python 2.7.6 (64-bit)
    • OpenSSH
    • RAID Manager
    NoteIf the UCP Advisor controller VM setup fails, use the Manually setting up UCP Advisor controller VM to install UCP Advisor on the management node.
    NoteIf the install script fails to start the OpenSSH service, run the OpenSSH service manually and then run the Initialize script located under UCP Advisor controller VM

    C:\Program Files\Hitachi\UCP Advisor\Support\InitializeUcpAdvisorRunningEnvironment.bat Refer to 1081 in the Known Issue section of the Release Notes for more information

Phase 2: Performing a Windows patch update

Ensure that the Windows patching is done to the highest level. This process usually takes time depending on the number of Windows patches.

Deploying the UCP Advisor Gateway Virtual Appliance

A Gateway VM must be deployed for each UCP converged infrastructure (UCP CI), UCP hyper-converged (UCP HC), UCP Rack Scale(UCP RS) and UCP 2000 system.

  1. Download the UCP Advisor Installation Media from TISC filename: UCP Advisor Installation Media_2.0_Patch1.iso.

  2. Mount UCP Advisor Installation Media_2.0_Patch1.iso on the windows desktop or laptop.

  3. From the Navigator, click Hosts and Clusters.

    The Hosts and Clusters data center list displays and expands.
  4. Right-click the vCenter IP address at the top of the Navigator.

    The vSphere client menu appears
  5. Select the Deploy OVF Template option.

  6. Click the local file.

  7. Click Browse.

    The vSphere Web Client displays a directory and navigate to the UCP Advisor installation media mounted path. For example:F:\Software\AdvisorGatewayOVA\Hitachi-UCP-Advisor-Gateway-Appliance-5.2.2971.ova.
  8. Select the following file: Hitachi-UCP-Advisor-Gateway-Appliance-5.2.2971.ovaand deploy OVA

  9. Click Next and accept the license agreements.

  10. From Select Storage, choose Thin Provisioning, and then select the datastore for deployment.

  11. Select the appropriate VM Network. This should be the the user defined management network for UCP Advisor Gateway VM.

  12. Customize the template with the appropriate hostname and static IPv4 network details.

  13. Review and complete the deployment.

  14. Power on UCP Advisor Gateway VM after a successful deployment.

    Note Refer to:Setting up a command device using the UCP Advisor Toolbox. This is only required for UCP CI and UCP 2000 systems that have Hitachi Storage Arrays. If the system does not have Hitachi Storage Arrays, (for example, UCP HC and UCP RS, then you can skip this step.

Setting up a command device using the UCP Advisor Toolbox

You can use the UCP Advisor Toolbox to create a command device, present it to an ESXi host, and add RDM (raw disk mapping) to the UCP Advisor Gateway VM.

Before you begin

Make sure that zoning and host groups have already been configured according to the build guide. If this fails, make sure that the zoning is correct.


  1. On the UCP Advisor Virtual Appliance Windows desktop, double-click the UCP Advisor Toolbox deployment tool icon .

    The UCP Advisor Toolbox window appears.
  2. Provide the following information for Toolbox to facilitate this workflow:

    • ESXi Address: The IP address of the ESXi host to which the command device will be added. In this case, this refers to the management/compute node where the UCP Advisor Gateway VM is hosted.
    • ESXi User name: The user name and password of the ESXi host.
    • VM Name: The name of the VM that is hosted on the ESXi host that wants the RDM of the command device; in a management node setup, this refers to the UCP Advisor Gateway VM.
    • Storage IP: The IP address of the storage system on which the command device is created. If the storage system is a VSP Gx00 or Fx00 series, provide the Controller IP 1 or Controller IP 2 address.
    • Storage User name, Storage Password: The user name and password of the storage system.
    • Dynamic Pool ID: The ID of the storage pool from where the command device is created.
    • Storage Port 1: One of the ports on the storage system that is connected to the ESXi host.
    • Storage Port 2: A second port on the storage system that is connected to the ESXi host.
    • Command Device Name: A name for the command device.
    NoteIf the storage system command device is not detected, reboot the ESXi host as instructed by Toolbox. After rebooting, add the command device to the UCP Advisor Gateway Virtual Appliance as a Raw Device Mapping (RDM).
  3. Click Submit.

    The UCP Advisor Toolbox operation is completed. Review the operation status and then close the UCP Advisor Toolbox window when you are done.

Uninstalling the UCP Advisor system

Uninstall UCP Advisor when the reinstallation of UCP Advisor is necessary to recover from a system failure. You can uninstall and delete the following UCP Advisor components and its services:

  • UCP Advisor Controller VM
  • UCP Advisor Gateway VM

The following table describes the results of deleting UCP Advisor services and components.

Management component State Uninstall considerations
UCP Controller VM Stateful VM

You lose the state and data from the database and from the management system.

UCP Advisor Gateway VM Stateless VM You can safely replace a UCP Advisor Gateway VM.

Verify that a Hitachi representative is consulted before you uninstall. The uninstall operation can lead to loss of data and configuration.

The following figure shows the process diagram for removing the UCP Advisor VM from the management infrastructure.

Step 1: Unregistering UCP Advisor service

The first step in removing the UCP Advisor service is to remove the UCP Advisor plugin from the VMware vCenter instance. This step ensures that any subsequent steps do not affect future installation of UCP Advisor.

  1. Log on to the Advisor VM using RDP, and select Add-Remove Programs.

  2. Search for UCP Advisor and click Uninstall.

    The UCP Advisor uninstall dialog box appears.
  3. Click Yes to launch the uninstall program.

  4. In the Unregister vCenter Plugin dialog window, enter the VMware vCenter IP address, vCenter user name, and the vCenter password.

  5. Click Submit.

Step 2: Deleting the UCP Advisor VM

Verify that the UCP Advisor plugin has been successfully removed, before deleting the UCP Advisor virtual machine from VMware vCenter.

  1. Verify that the UCP Advisor service is unregistered and uninstalled from VMware vCenter.

  2. Log on to the vCSA appliance.

  3. Select the Management Node.

  4. Power down the UCP Advisor Controller VM.

  5. Right-click Delete from Disk.

    This procedure sets the state of the UCP Advisor VM and the environment for redeployment.

Step 3: Deleting residual files from vCenter

Remove residual UCP Advisor Controller VM files after completing the uninstallation process in Step 1 and Step 2.

The uninstallation process removes most of the existing UCP Advisor recent installation files. However, it does not remove all files. Run the following commands to remove the remaining content.


  1. Log in to vCenter Server Appliance (vCSA) using the root credentials.

  2. Execute the following commands to remove content the uninstallation script did not remove:

    1. rm /tmp/vmware-root/

    2. rm /etc/vmware/vsphere-client/vc-packages/vsphere-client-serenity/

    3. rm /etc/vmware-vpx/extensions/

    4. rm /etc/vmware-vpx/locale/

    5. rm /etc/vmware/vsphere-client/cmCatalog/

  3. Access the VMware virtual center web client.

  4. Select hitachi.ucp.advisor extension and unregister the extension.

  5. Go to vCSA and execute the following commands to restart the web client service:

    1. Service-control -stop vsphere-client

    2. Service-control -start vsphere-client

    The same steps can be used to delete the Advisor Gateway VM.

Setting up Hitachi Automation Director

Automation Director is an optional management component and must be installed after UCP Advisor is deployed and configured.

To configure Automation Director with UCP Advisor, make sure that you have deployed UCP Advisor successfully. The following diagram provides an overview of the Automation Director setup steps.

Automation Director is used as an independent management platform to create service templates and workflows. The workflows pertinent to UCP Advisor can be tagged under Advisor so that all those workflows are displayed in the UCP Advisor UI, as shown below.

When a workflow is initiated, UCP Advisor sends a context message for the specific components (Server, Ethernet, Fibre Channel, or Storage). Automation Director can use this information to create a custom workflow to access the UCP Advisor REST API or third-party services to create a custom workflow.

An Automation Director task ID is shown for tracking purposes. See the following examples.

Resource ID Resource Type Appliance ID
Serial number example: 56919 Storage UCP Advisor Appliance ID example: 4c5c7831-051b-4a03-ae0d-9c09ada8475a
IP address example: Ethernet UCP Advisor Appliance ID example: 4c5c7831-051b-4a03-ae0d-9c09ada8475a
IP address example: Fibre Channel UCP Advisor Appliance ID example: 4c5c7831-051b-4a03-ae0d-9c09ada8475a
BMC IP address example: Server UCP Advisor Appliance ID example: 4c5c7831-051b-4a03-ae0d-9c09ada8475a

Configuring Hitachi Automation Director

You can configure Hitachi Automation Director to enable the execution of service templates from UCP Advisor.

  1. In the Navigator window, click Administration.

  2. Click the Configuration tab.

  3. Scroll down to Hitachi Automation Director and click the Add icon.

  4. Enter the relevant details in the Hitachi Automation Director dialog as follows:

    • Hostname or IP Address: Host name or IP address for the Automation Director server.
    • Port: Port for Automation Director.
    • Username: User name identifying the user with administrator privileges who is to access Automation Director. Enter system.
    • Password: The Automation Director administrator password. Enter manager.
  5. Click Submit.

Automation Director parameters

Automation Director parameters are passed from UCP Advisor for each managed resource, such as the following:

  • Resource ID: A unique identifier that specifies a device
  • Resource Type: Identifies the Storage, Ethernet, Fibre Channel, or Server device resource type
  • Appliance ID: A unique identifier that specifies a UCP Advisor appliance
  • Resource ID: Serial number example: 56919
  • Resource Type: Storage
  • Appliance ID: Advisor Appliance ID example: 4c5c7831-051b-4a03-ae0d-9c09ada8475a
  • Resource ID: IP address example:
  • Resource Type: Ethernet
  • Appliance ID: Advisor Appliance ID example: 4c5c7831-051b-4a03-ae0d-9c09ada8475a
Fibre Channel
  • Resource ID: IP address example:
  • Resource Type: FC
  • Appliance ID: Advisor Appliance ID example: 4c5c7831-051b-4a03-ae0d-9c09ada8475a
  • Resource ID: BMC IP ADDRESS example:
  • Resource Type: Server
  • Appliance ID: Advisor Appliance ID example: 4c5c7831-051b-4a03-ae0d-9c09ada8475a

Setting up Automation Director workflows

Create custom workflows with UCP Advisor parameters that are passed for managed UCP Advisor resources.

When you are creating workflows in Automation Director, you must tag the workflow as a UCP Advisor workflow. The UCP Advisor tag enables the workflow to be visible in the Automation Director view window of UCP Advisor.

For more information about how to create workflows or templates in Automation Director, and detailed information about this product, see

Hitachi Hi-Track installation

Hi-Track Monitor is an optional component with UCP Advisor. It is used as a “call-home” service and can monitor most of the hardware components in the UCP appliance. The recommendation is to install Hitachi Hi-Track on a UCP Advisor windows VM.

The UCP Advisor VM must have connection to the HDS Support Center by means of a modem or an Internet connection. In the event of a component failure, Hi-Track reports the failure to the Support Center, with no action required on the part of the user. Hi-Track enables most problems to be identified and fixed prior to actual failure.

Use this section as a guide for discussing the capabilities and requirements of Hi-Track. If the customer agrees to a Hi-Track installation, use the following link for installation instructions, then click the Hi-Track Monitor Installation Guide.

Hi-Track installation prerequisites

The minimum version of Hi-Track Monitor required is 8.0 or greater. There must be TCP/IP LAN connectivity between Hi-Track Monitor and the monitored hardware. Hi-Track Monitor must be deployed on an UCP Advisor VM, and this VM must have connectivity to the Internet.

For a list of required ports and a list of supported modems, see the Hi-Track Monitor Installation Guide.

Required installation guides

Refer to the following installation guides for Hi-Track monitor information:

Software installation

Get the latest Hi-Track software under the Downloads section of the Hi-Track website.

The Hi-Track Monitor Installation Guide is located in the Installation Guides section of the Hi-Track website:

After downloading the Hi-Track Monitor Installation Guide, follow the instructions to configure the Hi-Track monitoring software on the UCP Advisor VM.

Configuring Hi-Track monitor

These directions are for the simplest and most common Hi-Track configuration.

For detailed step-by-step installation instructions and explanations, see the Hi-Track Monitor Installation Guide at:


  1. Open a web browser and navigate to http://localhost:6696/CGI-LOGON; the default password is hds.

  2. Verify that the Site ID and Transport Agents are set in the configuration, and that users have been created and successfully configured under the User Management tab.

  3. In the Summary tab, begin adding devices to the UCP Advisor as well as components (for example: Fibre Channel Switches, Ethernet Switches, etc.)

    1. To add new components, click Item, then select a Device Type, and click Add.

Upgrading Hi-Track

Get the latest version of Hi-Track Monitor from the Hi-Track website.

The latest version of Hi-Track Monitor (HTM) software is located at:, in the Downloads section.

Stop the current Hi-Track Monitor by selecting About > Shutdown and following the steps provided.

Verify in the Services.msc field that the Hi-Track Monitor service is not running.

Follow the instructions provided in Hi-Track Monitor Installation Guide located at: to complete the upgrade.

Finally, you need to enable monitoring by clicking the item number in the Item list and then clicking Enabled.

Additional reference

More information is available in the HiTrackHelp.chm, which is part of the file.

This zip file contains the Hi-Track Monitor software, located under the Downloads section at: