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.

Deployment overview

The following procedure and flowchart outline UCP Advisor deployment.

  1. Verify that the hardware, software, and other resources are in place before deploying the UCP Advisor VM components.

  2. Download the UCP Advisor Controller VM and the UCP Advisor Gateway OVFs.

  3. Deploy and set up the UCP Advisor Gateway VM on the management node or server node that has direct connection to the Fibre Channel network.

  4. Deploy and set up the UCP Advisor Controller VM on the management node.

  5. When the OVF deployment is complete, set up the UCP Advisor Toolbox on the windows client machine.

UCP Advisor deployment planning

Familiarize yourself with the implementation aspects of the Gateway VM, Controller VM, and UCP Advisor management environment.

The following figure shows the structure and architecture of the UCP Advisor components within a converged infrastructure.

The deployment process uses one of the following procedures:

  • Deploy the UCP Gateway VM on the management compute node or cluster that has access to the command device when implementing a converged infrastructure.
  • Deploy the UCP Advisor Controller VM OVF on the management cluster when implementing a UCP hyperconverged infrastructure.

The following steps are recommended to configure UCP Advisor.

Setting up the management node

Install ESXi 6.5.U1 on the management node before deploying UCP Advisor Controller VM.

The following services must be running before starting the UCP Advisor Controller VM installation.

  • Hitachi Syslog Agent for vRLI
  • Hitachi UCP Advisor Ghost
  • Hitachi UCP Advisor HiTrack Web Service
  • Hitachi UCP Advisor Service Registry
  • Hitachi UCP Advisor Services
  • Hitachi UCP Advisor Sidecar
  • Hitachi UCP VI Service
  • Hitachi vRO Converge Web Service
  • Hitachi Watchdog Service


  1. Install ESXi 6.5.U1 on the host. Make sure the build version is 5969303.

  2. Install vCSA 6.5.U1 Version Build 5973321 (Virtual Center Server Appliance) on the management ESXi host.

  3. Add the ESXi host to vCenter.

    The following figure shows the ESXi host installed and set up.

UCP Advisor controller VM manual setup

Use this procedure when the UCP Advisor controller VM automated setup fails.

NoteMake sure you have access to the OEM license of the Windows 2016 server image.


  1. Download the UCP Advisor controller VM OVF from the distribution media or portal.

  2. Log in to the vSphere client.

  3. In the Navigator, click Hosts and Clusters.

  4. At the top of the Navigator window, right-click the vCenter IP address.

  5. Select the Deploy OVF Template option.

  6. Select the Local file option.

  7. Create Windows VM with the settings listed in the UCP Advisor Controller VM requirements section.

  8. Click Next.

  9. Enter the VM name, then select the inventory location (Datacenter).

  10. Select the ESXi host or cluster, then select the datastore for the UCP Advisor VM.

  11. In the Ready to Complete window, click Finish.

  12. Power on the Windows 2016 Virtual Server VM.

  13. Open the UCP Advisor appliance VM console.

    1. Specify the time zone.

    2. Specify the administrator password.

    3. Log in with administrator credentials.

Planning and preparing for the installation

It is important to stage the installation and take snapshots of the virtual machine at different stages of the installation.

Phase 1: Installing UCP Advisor components and services

Make sure that Windows 2016 (UCP Advisor template) is deployed on the target ESXi host (management node). Power it on and ensure that VM boots up without errors.

Installing VMWare tools

Install the VMware tools on the ESXi host.

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

  2. Select 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 click Complete to install.

    The VM automatically reboots when the VMware tools are installed. The VM automatically receives an IP address if the DHCP server is running.

    Confirm 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 manager, click the Remote tab.

  2. Select Allow remote connection to the 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 settings are Obtain an IP address automatically.

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

  3. Click OK.

Installing roles and features

You must install IIS roles, services, and .NET framework.

Installing the IIS role

You must add roles in Web Server IIS when deploying UCP Advisor.


  1. From the Server Manager dashboard, select Add-Role and Features.

  2. Select role-based or feature-based installation.

  3. Select the Web Server IIS.

  4. Add the IIS features, then click Next.

  5. Select .NET Framework 4.6 Features, then click Next.

  6. Select Web Server Role (IIS).

  7. Click Next.

  8. In the Select Role Services dialog box, make sure that the default Web Server option is selected.

  9. Confirm the installation selections and click Yes to allow automatic restart.

  10. After the service is installed, reboot the VM.

Installing .NET features

Make sure that the .NET Versions 3.5 and 4.6 features are enabled.

If you see the error message “Do you need to specify an alternate source path? One or more installation selections are missing source …”, you can install the .NET framework features using an ISO package, as shown in GUID-E6C20716-0576-4FA7-925F-B4993D7794D9 section.

Manually install .NET 3.5

Use the following to install the .NET framework features using an ISO package.


  1. Attach the Windows 2016 Enterprise ISO package to the virtual machine.

  2. Click Save.

  3. When you enable CD/DVD, installation files and folders appear on the UCP Advisor virtual machine.

  4. Select Specify an alternate source path and set it to a DVD drive, for example, d:\sources\sxs. Also select to restart the destinations server automatically, if required.

    The above screenshot shows how to navigate to the .NET 3.6 framework package on the Windows ISO package. Note that both versions of the .NET package (3.6 and 4.5) are required for the correct functioning of the UCP Advisor Services environment and UCP Advisor services.

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.

Verifying Windows patches

Once the Windows patches are installed, make sure that all the patches are installed correctly.

  1. Go to Control panel > Programs > Programs and Features > Installed Updates.

  2. Verify that the correct patches are installed.

  3. Repeat the updates command.

  4. Continue to update the Windows patches until all patches are current.

Opening firewall ports

You must configure ports to enable inbound and outbound traffic.

Enable the following TCP ports.

TCP ports
Port Service
23011 UCP Advisor/vCenter
23021 VRO
443 Hi-Track
2055 Syslog
23031 VI
31001 Logbundle
22 OpenSSH
23015 REST API
22015 Hitachi Automation Director

Enable the following UDP ports.

UDP ports
Service Port
IPMI 623
SNMP 161
SNMP 162
Setting up inbound firewall rules

Define the inbound add-on firewall rules.


  1. In administrator mode, open a command prompt.

  2. Enter WF.msc.

  3. Select Inbound Rules > Rule Type, then select Port to create a new rule.

  4. Select TCP and enter the port numbers for the specific local ports.

  5. Click Next and select Allow the connection, then click Next.

  6. Select Domain, Private, and Public , then click Next.

  7. Enter a name and optional description for the new rule.

  8. Click Finish.

Installing supporting applications

Take a snapshot of your configuration before installing UCP Advisor bits for easy revert and rebuild. Install the following supporting applications:

Application Version
Java 8.0.1440.1
Python 2.7.6
VMware PowerCLI 6.5.2
Installing Java

Install Java from the UCP Advisor ISO package.


  1. In the UCP Advisor ISO package, locate and double-click the .exe file to install Java.

  2. On the Update tab, set up Java using the default setup.

Installing Python

Install Python from the UCP Advisor ISO package.

  1. Run the Python installer from the UCP Advisor ISO package.

    Python version 2.7.6 is also available at:
  2. Follow the default steps to install Python.

  3. Add Python to the PATH variable as follows: C:\Windows\system32>path.

Installing VMware PowerCLI

Download the VMware PowerCLI from the VMware website.

NoteMake sure you install VMware PowerCLI version 6.5.2 for VMware Tools 10.1.7.


  1. Copy all folders under VMware PowerCLI to C:\Program Files\WindowsPowerShell\Modules

  2. Open PowerShell window and execute the following command:

    Import-Module -Name VMware.PowerCLI
  3. Execute Get-Command-Module VMware to validate that it has installed the 6.5.2 command.

  4. Alternatively, execute Get-VICommand to get the list.

(Optional) Create PowerCLI desktop shortcut

Create a desktop shortcut for access to PowerCLI.

  1. Right-click on desktop and create a shortcut Set location: C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe -noe -c "Import-Module VMware.PowerCLI"

  2. Click Next.

  3. Set the name to: VMWare PowerCLI 6.5.2.

  4. Click Finish.

  5. Right-click the shortcut again and change "Start in:" to "C:\"

  6. Click OK.

  7. Double-click the shortcut to verify "Get-VICommand".

    Phase 3 is completed. Take a snapshot of the UCP AdvisorController VM.

Installing UCP Advisor software and components

Install UCP Advisor and Rest API.

Installing UCP Advisor

Install UCP Advisor.

  1. Run the UCP Advisor install from the mounted UCP Advisor ISO package.

  2. Double-click UCPAdvisor-Master-setup-02.0.0.*-(x64).exe.

  3. Follow the default settings to install the UCP Advisor software.

  4. Run the initialize script located under the installed UCP Advisor support folder. This creates a self-signed certificate, port binding, and log bundle web service configuration.

Installing RestAPI

Install the REST API.


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

  2. Double-click setup.exe.

  3. Follow the prompts and accept the defaults to complete the installation.

Installing OpenSSH

Install OpenSSH.


  1. Create a folder called C:\AdvisorMediaBundle.

  2. Copy the OpenSSH folder from "ISO location" to C:\Advisor Medial Bundle.

  3. Navigate to the OpenSSH folder.

  4. Execute InstallOpenSSH.bat.

    1. Creates the ucpadmin user.

    2. Adds ucpadmin user to the administrator group.

    3. Installs OpenSSH.

    4. Creates a folder called C:\Program Files\OpenSSH\UCPFirmware.

    5. Restarts the OpenSSH service.

Verifying installed software

After a successful installation, verify the following programs are installed on the host.

  1. Verify that the following programs are installed on the host:

    Hitachi Unified Compute Platform Advisor
    Hitachi Unified Compute Platform Advisor API
    Java 8 Update 144 (64 Bit)
    Python 2.7.6 (64-bit)
    VMware tools
  2. After verifying the installation is completed, take the final snapshot of the Virtual Machine.

    The UCP Advisor installation is now complete. Take a snapshot of the UCP Advisor Controller VM.
  3. Using the VMware vCenter UI, consolidate the snapshots as shown in the following diagram.

    Consolidating the snapshots validates that the virtual machine is working off a single .vdmk.

Verify installed software

After a successful installation, verify the following programs are installed on the host.

After verifying the installation is completed, take the final snapshot of the Virtual Machine.

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 desired 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 the zoning is correct.


  1. Verify that the HORCM on the system running Toolbox is updated to version 1-40-03/03 or later.

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

    The UCP Advisor Management Deployment Toolbox window appears.
  3. 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 a pod setup, this refers to the management host(s).
    • 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 (Raw Disk Mapping) of the command device; in a pod 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 GUM IP address.
    • Storage User name, Storage Password: The user name and password of the storage system.
    • 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 through FC switch 1 to HBA port 1 on the ESXi host.
    • Storage Port 2: One of the ports on the storage system that is connected through FC switch 2 to HBA port 2 on the ESXi host.
    • Command Device Name: A meaningful name for the command device.
  4. Click Submit.

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 (AGW) 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 an 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 in 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 in 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

Content under development. 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 Advisor Appliance ID example: 4c5c7831-051b-4a03-ae0d-9c09ada8475a
IP ADDRESS example: Ethernet Advisor Appliance ID example: 4c5c7831-051b-4a03-ae0d-9c09ada8475a
IP ADDRESS example: Fibre Channel Advisor Appliance ID example: 4c5c7831-051b-4a03-ae0d-9c09ada8475a
BMC IP ADDRESS example: Server 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.

This section can be used 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 deployed on 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 the following location:


  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 in the User Management tab.

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

    1. You can add new components by clicking Item, then selecting a Device Type, and clicking Add.

Upgrading HI-Track

Get the latest version of Hi-Track Monitor from the Download section of 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 at the following Hi-Track Monitor Installation Guide location: to complete the upgrade.

Now, 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: