Skip to main content
Hitachi Vantara Knowledge

Deploying UCP Advisor for UCP rack scale (RS) appliance

The required hardware and software must be in place before deploying the UCP Advisor VM components.

Before you start

The hardware and software must be in place before deploying the UCP Advisor VM components.


Verify that the hardware components at the deployment site comply with the requirements described in the following document:

  • The UCP RS appliance complies with the Unified Compute Platform RS V210-V210F using VMware Cloud Foundation Build Guide (AS-604-01).

For more information, see the UCP RS product documentation webpage on the Knowledge portal. A Hitachi login is required to view the documents.


Verify that the following software requirements have been completed. For additional information, see UCP Advisor predeployment steps.

  • VCSA 6.5U1e has been deployed. This is a required component.
  • Hitachi Automation Director is an optional component. If the customer has purchased this option, see Hitachi Automation Director.
  • vRealize Orchestrator is an optional component. If the customer has purchased this option, see VMware vRealize Orchestrator setup before proceeding.
  • vRealize Log Insight is an optional component.
Management nodes

Verify that the following management node requirements have been completed:

  • Either an RS management cluster or customer-supplied management nodes are configured.
  • ESXi is deployed on the management nodes. If it is not, see UCP Advisor predeployment steps before proceeding.

Deploying the UCP Advisor virtual appliance

The UCP Advisor virtual appliance can be deployed on a customer-supplied management node or RS management cluster.

Deploying to a customer-supplied management node

When using a customer-supplied management node, the customer must set up the Windows 2016 standard VM and license according to the prerequisites described in UCP Controller virtual machine requirements. The management node must be able to accommodate the installation of UCP Advisor and the necessary components.

Customer-supplied management node requirements

Prior to deployment, ensure that the management node supplied by the customer meets the requirements listed in the following table.

Resource Description
Processor 2 Intel Xeon E5 2600 v5 processors or equivalent.
Memory 128 GB
Local Storage 64 GB
HBA Emulex LPe 31002 16GB or equivalent

Deploying Windows 2016 to a customer-supplied management node

For systems deployed with customer-supplied management nodes, the customer must deploy ESXi on these hosts and provide the Windows 2016 ISO package on the ESXi datastores.

  1. Obtain a Windows 2016 standard OEM image and product key from the customer.

  2. Verify that ESXi is already installed on the management node as defined in Predeployment considerations.

  3. Deploy Windows 2016 on the customer-supplied management node on a VM that meets the controller VM requirements. For details, see UCP Controller virtual machine requirements.

Installing UCP Advisor components and services

Prior to installing UCP Advisor components and services, ensure that Windows 2016 is deployed on the target ESXi host (customer-supplied management node). The management node must be turned on and the VM running.

Taking a VM snapshot

Take a pre-installation snapshot of the Windows 2016 VM to enable recovery, if needed.

  1. Log on to the management host.

  2. In the Navigator pane, select Virtual Machines.

  3. Right-click the UCP Advisor controller VM, then select Snapshot > Take Snapshot.

  4. Enter a name for the snapshot.

  5. Click Take Snapshot.

Installing VMware Tools

Install VMware Tools on the Windows 2016 VM.

  1. Log on to the vSphere Web Client.

  2. In the Navigator pane, right-click on the virtual machine instance on the ESXi host.

  3. Select Guest OS > Install VMware Tools.

  4. Click Mount.

  5. On the VM console, connect to Console, right-click DVD Drive, then select Install or run program from your media.

  6. Select the Complete option.

    VMware tools are installed.

  7. Click reboot to complete the installation.

  8. In the vSphere Web Client, verify that the status of VM Tools is Running.

(Optional) Enabling the remote desktop

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

  1. Log on to Windows on the UCP Advisor controller VM.

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

  3. Select Allow remote connection to this computer.

  4. Click OK.

Setting up the IP address of the UCP Advisor controller VM

Set the IP address of the UCP Advisor controller VM to enable the administrator to access it remotely.

Before you begin

  • On the UCP Advisor controller VM, open a CMD window.
  • Create a list of the current IP addresses for recovery, if needed. Use the command Ipconfig /all.


  1. In Desktop > Search, enter Network and Sharing Center.

  2. Click Change adapter settings.

  3. Right-click Ethernet0, then select Properties.

  4. Select Internet Protocol Version 4 (TCP/IPv4), then click Properties.

  5. Select Use the following IP address.

  6. Enter the static IP addresses.

  7. Click OK.

  8. Click Close.

Setting up the UCP Advisor controller VM

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

Before you begin

Ensure that the management node (Windows VM) is not configured in an Active Directory (AD) environment.


  1. Download the UCP Advisor installation media ISO package from the Hitachi Support Connect portal. A Hitachi login credential is required.

    1. Log on to Support Connect.

    2. Click Product Downloads.

    3. In Find a Download, enter UCP Advisor.

    4. Under Available Software, click UCP Advisor.

    5. Download the latest version of the UCP Advisor installation media.

    6. Verify that the media downloaded properly.

  2. Mount the following ISO packages to the Windows 2016 VM:

    • Windows Server 2016 ISO package (this ISO image is located on the Hitachi-supplied ESXi management node datastore). If the customer provided their own management node, mount the Windows 2016 ISO package that is part of that installation.
    • UCP Advisor Installation Media 2.5 ISO package.
  3. Open a PowerShell administrator CMD window.

  4. Set the PowerShell Execution Policy to Bypass.

    • Enter Set-ExecutionPolicy -ExecutionPolicy Bypass

      This command starts a PowerShell session that allows for running scripts and keeps the lowered permissions isolated to just the current running process. The Execution Policy must be set to Yes to enable the install script to run.

  5. Enter drive letter: f:

  6. Run Install.ps1.

  7. After the install script completes successfully, restart the VM.

  8. Verify that the following software programs are installed:

    • Hitachi UCP Advisor
    • Hitachi UCP Advisor API
    • Java 8 Update 161 (64-bit)
    • Python 2.7.6 (64-bit)
    • OpenSSH
    • RAID Manager
    • If the UCP Advisor controller VM setup fails, set up the UCP Advisor controller VM manually on the management node. For details, see Manually setting up UCP Advisor controller VM.
    • If the install script fails to start the OpenSSH service, run the OpenSSH service manually, and then run the Initialize script located on the UCP Advisor controller VM.

      C:\Program Files\Hitachi\UCP Advisor\Support\InitializeUcpAdvisorRunningEnvironment.bat

Registering the UCP Advisor vCenter Plugin using UCP Advisor Toolbox

Use the UCP Advisor Toolbox application from within the UCP Advisor controller VM server to register UCP systems, VMware systems, and storage systems from a centralized console through the services of UCP Advisor.

Before you begin

Disable the proxy settings, or bypass them on the UCP Advisor controller VM before registering the UCP Advisor plugin to vCenter.

NoteTo access UCP Advisor, you must have Administrator role permission.


  1. On the UCP Advisor virtual appliance Windows desktop, double-click the UCP Advisor Toolbox.

  2. In the vCenter Plugin pane, enter the following settings:

    • VSCA Address: The vCenter Server Appliance management IP address.
    • Root Password: The password for the root user.
    • SSO Username: The vCenter SSO user name.
    • SSO Password: The vCenter SSO user password.
  3. In the vRealize Orchestrator pane, optionally enter the following settings:

    • vRO Address: The vRealize Orchestrator IP address.
    • Port: Port number (8283 is the default).
    • Username: vRealize Orchestrator user name.
    • Password: vRealize Orchestrator password.
  4. In the vRealize Log Insight pane, optionally enter the following settings:

    • vRLI Address: vRealize Log Insight IP address.
    • Port: Port number (9543 is the default).
    • Username: vRealize Log Insight user name.
    • Password: vRealize Log Insight password.
  5. Click Submit.


The UCP Advisor plugin is registered to vCenter, and (optionally) the vRealize Orchestrator and vRealize Log Insight credentials are saved to UCP Advisor.

Registering a UCP system

Before using UCP Advisor, you must register the appliances that the users can access by configuring the appropriate settings.

  1. Log on to the VMware vSphere Web Client using your vCenter Administrator credentials.

  2. Select Home > UCP Advisor.

  3. Click the + icon.

  4. Enter values for the following settings, then click Submit:

    • Appliance ID:

      The UCP Appliance ID is the number assigned to the system. Currently supported systems use a six-digit identifier as the Appliance ID, such as UCP-RS-123456.

    • UCP System Name:

      The common name used to refer to the UCP system.

    • UCP Controller Host:

      UCP Advisor controller VM IP address.

    • UCP Gateway Host:

      UCP Advisor Gateway VM IP address.

    • Model:

      UCP Advisor supports the following UCP appliance models: UCP CI (converged infrastructure), UCP HC (hyperconverged), UCP RS (rack scale), UCP 2000, UCP 4000, Logical UCP.

    • vCenter Address:

      The vCenter server address.

    • vCenter Username:

      The user name for the vCenter.

    • vCenter Password:

      The password for the vCenter.

    After entering the setting values, the specified UCP system becomes available.

  5. Click the icon representing the UCP system. Compute, storage, and network devices are displayed.

    NoteIf the devices required by the customer are not available, see Automatically adding resources using a CSV file. Add the required devices before proceeding.

Automatically adding resources using a CSV file

You can use a CSV file to automatically add a chassis (for UCP 4000 systems) and multiple storage, compute, and network switch devices.

Before you begin

You must have a CSV file prepared that specifies the chassis (for UCP 4000 systems) and provides the configuration details on how various storage, switch, and compute devices are to be brought onboard. In most cases, a CSV file has already been prepared for the customer's site during the installation process, but you can edit this file, or create a new one, to add devices or change the configuration.

A sample spreadsheet is located in the installation folder (C:\Program Files\Hitachi\UCP Advisor\Documentation\UCPAdvisorOnBoardSheet.csv). Manually enter the connection information for the devices, then save the configuration as a CSV file.


  1. In the Navigator window, click Administration.

  2. Click the Onboard tab.

  3. Click Select Worksheet, then browse to the CSV file for the devices you want to onboard.

  4. Click Upload.

    The configuration details for the devices are uploaded and shown in the Devices to be Onboarded pane.
  5. Verify the device details.

  6. Click On Board.


The devices are onboarded.