Skip to main content
Outside service Partner
Hitachi Vantara Knowledge

Deploying UCP Advisor for UCP converged infrastructure (CI) system

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.

Hardware

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

  • The UCP CI appliance complies with the Unified Compute Platform CI for VMware vSphere Build Guide (CTO-SL-011-03).
  • The UCP CI appliance complies with the Unified Compute Platform CI for VMware vSphere Deployment Guide (CTO-SL-024-00).

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

Software

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

  • VCSA has been deployed.
  • 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 Hitachi-supplied 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.
  • A datastore is configured on the management node. For details, see "Configuring Storage Array" in the Unified Compute Platform CI for VMware vSphere Build Guide.

Deploying the UCP Advisor virtual appliance

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

Deploying to a Hitachi-supplied management node

Prior to deployment, ensure that the management node supplied by Hitachi has met all the requirements as specified in the build guide for this system.

The following example shows a multirack deployment using a Hitachi-supplied management node.

Deploying Windows 2016 to a Hitachi-supplied management node

For systems deployed with Hitachi-supplied management nodes, the distribution center will have deployed ESXi on these hosts and provided the Windows 2016 OVF file and Windows 2016 ISO package on the ESXi datastores.

Keep the following two points in mind:
  • UCP Advisor should be deployed on VMware high availability clustered servers and may coexist with nonmission-critical applications. UCP Advisor should not manage the servers on which it is deployed, except the UCP Advisor Gateway VM.
  • UCP Advisor Gateway VM must be migrated to another server before performing disruptive operations (such as power control, and firmware updates) if it is not located on the management node. Once disruptive operations are complete, the UCP Advisor Gateway VM should be migrated back to the 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.

NoteThe Windows 2016 image contains the latest update to Microsoft Windows as of the time this software was released; however, you must install the latest Windows update that is available at the time of this deployment.

Procedure

  1. Download the following files from the management node ESXi datastore, then copy them to a Windows machine:

    • Hitachi_Windows_Server_2016_OEM.mf
    • Hitachi_Windows_Server_2016_OEM.ovf
    • Hitachi_Windows_Server_2016_OEM-1.vmdk
  2. Log on to vSphere Web Client.

  3. In the Navigator pane, click Hosts and Clusters.

  4. Right-click the vCenter IP address, then select Deploy OVF Template.

  5. Click Local file.

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

  7. Select all files with extensions .mf, .ovf, and .vmdk, then click Open.

  8. Click Next.

  9. Enter a name and location, then click Next.

  10. Select the target ESXi host, then click Next.

  11. From the Select virtual disk format list, select Thin provision, then click Next.

  12. Select the required VM network, then click Next.

  13. Review the configuration data, then click Finish.

  14. Power on the UCP Advisor appliance VM.

  15. Configure the UCP Advisor appliance VM.

    1. Open the UCP Advisor appliance VM console.

    2. Configure the time zone.

    3. Retrieve the license key from the COA sticker that is attached to the pull-out tab on any one of the management nodes, then apply the Microsoft Windows Server 2016 standard license. For details, see "Copying Windows OEM Package onto Local Datastore (Conditional)" and "Section No.11" in the Unified Compute Platform CI for VMware vSphere Build Guide.

    4. Configure the administrator password:

      In the desktop Search box, enter Computer Management.

      Select Local Users and Groups > Users.

      Right-click Administrator, then select Set Password.

      Read the warning, then click Proceed.

      Enter a new password, enter it again to confirm, then click OK.

  16. Log on to the UCP Advisor appliance VM with administrator credentials.

Results

The Windows 2016 image is deployed to the Hitachi-supplied management node.

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.

The following example shows 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. This configuration is necessary when there is more than one appliance, as illustrated.

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 16 GB 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 (Hitachi-supplied or customer-supplied management node). The management node must be turned on and the VM running.

Taking a VM snapshot

Take a preinstallation 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.

Enabling the remote desktop (optional)

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.

Procedure

  1. From 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, then 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.

Procedure

  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.8 ISO package.
    UCP Advisor Installation Media 2.7 ISO package.
  3. Open a PowerShell administrator CMD window.

  4. Enter Set-ExecutionPolicy -ExecutionPolicy Bypass to set the PowerShell Execution Policy to 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 the drive letter: F:

  6. Run Install.ps1.

  7. After the .NET framework is installed, the system signs you out and restarts automatically.

  8. Repeat steps 2-6, and then restart the VM.

  9. Verify that the following software programs are installed. For details about the current versions, see Supported software.

    • Hitachi UCP Advisor
    • Hitachi UCP Advisor API
    • Java 8
    • Python
    • OpenSSH
    • RAID Manager
    Note
    • 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 the 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

Deploying the UCP Advisor Gateway VM

A UCP Advisor Gateway VM must be deployed for each UCP converged infrastructure (UCP CI) system management node and extended CI appliance compute node.

Before you begin

Ensure that you have a flat management networking scheme or that there is a route between the hardware management VLAN and the management VM VLAN.

Procedure

  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 UCP Advisor installation media ISO package on a Windows machine.

  3. Log on to vSphere Web Client.

  4. In the Navigator pane, click Hosts and Clusters.

  5. Right-click the vCenter IP address, then select Deploy OVF Template.

  6. Click Local file.

  7. Click Browse, then browse to the location where you mounted the UCP Advisor installation media ISO package.

  8. Select Hitachi-UCP-Advisor-Gateway-Appliance-7.0.3552.ova. Click Open.

  9. Enter a name and location, then click Next.

  10. Click Next and accept the license agreements.

  11. From Select virtual disk format, select Thin provision, then select the datastore for deployment. Click Next.

  12. Select the required VM network. This should be the user-defined management network for UCP Advisor Gateway VM. Click Next.

  13. Customize the template with the appropriate host name and static IPv4 network details.

  14. Review the configuration data, then click Finish.

  15. Power on the UCP Advisor Gateway VM.

    Note For UCP CI and UCP 2000 systems that use Hitachi storage systems, see Setting up a command device using UCP Advisor Toolbox. Skip this step if the system does not use Hitachi storage systems.

Provisioning a different command device to the UCP Advisor Gateway VM

The command device is created during the build process; however, the customer may want to use a different command device. If so, it must be created in the meta_resource resource group.

Use the following procedure to attach a new command device to the UCP Advisor Gateway VM on the management node. Skip this procedure if the customer will use the default command device.

Procedure

  1. Log on to vCenter Server Appliance.

  2. Right-click UCP Advisor Gateway VM, then select Edit Settings.

  3. In New device, click Select.

  4. Select RDM Disk, then click Add.

  5. Select the target LUN, then click OK.

  6. Click OK.

  7. Restart the UCP Advisor Gateway VM.

Setting up a command device using UCP Advisor Toolbox

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

Before you begin

Verify that zoning and host groups are configured according to the build guide for this UCP Advisor appliance.

Procedure

  1. From the UCP Advisor virtual appliance Windows desktop, launch UCP Advisor Toolbox.

  2. In the Create Storage Array Command Device (Optional) pane, enter the following setting information:

    • ESXi Address: The IP address for the ESXi host to which the command device will be added, in this case, to the management or compute node where the UCP Advisor Gateway VM is hosted.
    • ESXi Username: The user name for the ESXi host.
    • ESXi Password: The password for the ESXi host.
    • VM Name: The name of the VM that is hosted on the ESXi host that requires 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 an Fx00 or Gx00 series, provide the Controller IP 1 or Controller IP 2 address.
    • Storage Username: The user name for the storage system.
    • Storage Password: The password for the storage system.
    • Dynamic Pool ID: The ID of the storage pool where the command device is created. Enter the pool ID that is part of the meta_resource resource group.
    • 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: The name for the command device.
    NoteIf the storage system command device is not detected, restart the ESXi host when prompted, then add the command device to the UCP Advisor Gateway virtual appliance as a raw device mapping (RDM).
  3. Click Submit.

  4. Review the operation status, then close the UCP Advisor Toolbox window.

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.

Procedure

  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. (Optional) In the vRealize Orchestrator pane, 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. (Optional) In the vRealize Log Insight pane, 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.

Results

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 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 descriptor ID for the appliance.
      NoteThe UCP Appliance ID is the number assigned to the system. For UCP CI systems, the five-digit serial number is required (UCP-CI-00000). The serial number is located on a white rectangular label affixed in the top-left corner of the front of the rack.

    • 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, and 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.Deploying UCP Advisor for UCP converged infrastructure (CI) appliance Bare metal prov

    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

Users with administrator-level permissions can use a CSV file to automatically add a chassis (for UCP 4000 systems) and multiple storage, compute, and network switch devices, and server and chassis labels.

Before you begin

Verify that you have administrator-level permissions for the resource you want to add.

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 during the installation process, but you can edit this file, or create a new one, to add devices and labels or change the configuration. However, be sure the number of columns in your CSV file matches the number of columns in the sample spreadsheet that 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. Verify that the user names have the appropriate administrator-level permissions and that the passwords only contain allowed characters.

Procedure

  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.