Skip to main content
Outside service Partner
Hitachi Vantara Knowledge

Manually installing UCP Advisor software components

Perform these manual software component installation procedures when the automated installation fails, or one or more software components requires installation.

Manually setting up UCP Advisor controller VM

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.

Procedure

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

  2. Log on 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 on with administrator credentials.

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.

Procedure

  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.

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
TFTP 69
IPMI 623
SNMP 161
SNMP 162

Setting up inbound firewall rules

Define the inbound add-on firewall rules.

Procedure

  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 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 REST API

Install the REST API.

Procedure

  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.

Procedure

  1. Mount UCP Advisor Media ISO.

  2. Mount Windows 2016 ISO.

  3. Run install.p1 located under the mounted UCP Advisor media path (E:\install.ps1) user powershell window.

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.

Procedure

  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: https://www.python.org/downloads/windows/.
  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.

Procedure

  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) Creating a PowerCLI desktop shortcut

Create a desktop shortcut for access to PowerCLI.

  1. Right-click on the 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".

    Take a snapshot of the UCP AdvisorController VM.

Setting up a command device using Hitachi Device Manager - Storage Navigator (Optional)

Set up the command device using Device Manager - Storage Navigator with the information and procedures in the following sections. This procedure is used only if Toolbox provisioning is failing, or manual provisioning of the command device is chosen.

Creating a virtual volume on Device Manager - Storage Navigator

Create a virtual volume with Device Manager - Storage Navigator.

  1. Create LDEVs from a parity group.
  2. Create a storage pool.
  3. Create a virtual volume.
  4. Convert the virtual volume to a command device.

Before you begin

In a browser, navigate to storage systems on the Storage Navigator of the storage system. Check if one or more parity groups have been created in the internal storage. If they have, proceed with creating LDEVs from one of the parity groups.

Creating LDEVs from a parity group

Create LDEVs from a selected parity group to begin the process of creating a virtual volume for conversion to a command device.

  1. Create two LDEVs, each with equal and maximum capacity based off the parity group.

  2. In the left panel, select Logical Devices.

  3. In the center panel, select Create LDEVs.

  4. Complete the following steps using the default entries:

    1. Verify that the Provisioning Type is Basic.

    2. Under Parity Group Selection, select Select Free Spaces, then select an internal parity group.

    3. Create two LDEVs, and select the maximum capacity under LDEV Capacity.

    4. Under Format Type, select Quick Formatting.

  5. Click Add > Finish > Apply.

    LDEV creation can take some time.

Creating a storage pool

Create a storage pool of logical devices from physical parity groups.

  1. In the left panel, select Pools.

  2. In the center panel, select Create Pools.

  3. Complete the following substeps using the default entries:

    1. Select the Provisioning Type as Dynamic Provisioning.

    2. Disable Multi-Tier Pool.

    3. Under Pool Volume Selection, click on Select Pool VOLs. Choose one of the LDEVs that was provisioned in the previous procedure, select Add, and click OK.

    4. Select an appropriate name for the storage pool.

  4. Click Add > Finish > Apply.

    Storage Pool creation can take some time.

Creating a virtual volume

A virtual volume carved out of the previously created storage pool is eventually converted to a command device.

  1. In the left panel, expand Pools and select the Storage Pool.

  2. In the center panel, select Virtual Volumes.

  3. Complete the following substeps using the default entries:

    1. Set the Provisioning Type to Dynamic Provisioning.

    2. Set LDEV Capacity to a small size: 50 MB.

    3. Enter an appropriate name for the virtual volume.

  4. Click Add > Finish > Apply.

    Virtual volume creation can take some time.

Creating Fibre Channel zones

You can create Fibre Channel zones from the UCP Advisor UI. Alternatively, you can use the corresponding switch CLI commands.

The setup assumes two management hosts and two Fibre Channel switches connected to four storage ports; use the following diagram as reference.

  • HBA port 2 on each management host connects to two storage ports through Fibre Channel switch 2.

Procedure

  1. SSH into the Fibre Channel switch that connects the host to the storage array.

  2. Run switchshow to get information about what ports are connected and available to create zones around:

    1. Ports 0-31: Compute (Skylake) servers

    2. Ports 32-43: Storage

    3. Ports 44-47: Management hosts

  3. On the UCP Advisor user interface, perform the following steps:

    1. Add the Fibre Channel switches to the network inventory.

    2. Create a zone alias for each member in the setup for each switch. (Obtain WWN information from the result of switchshow, and map the port ID CLx-x using the Device Manager - Storage Navigator as reference.)

    3. Create a zone in each Fibre Channel switch with the following composition: two HBA ports and two storage ports.

  4. Enable the zone configuration on each switch using the switch CLI commands or on the UCP Advisor user interface.

    NoteZone creation on the UCP Advisor user interface currently does not automatically enable the zone configuration after successful zone creation.
  5. Using the switch CLI, perform the following steps:

    1. SSH into the Fibre Channel switch.

    2. Run zoneshow. If the newly created zone is visible under Effective configuration, stop here; otherwise, continue with the next steps.

    3. Create a new zone configuration that will hold information about the newly created zone: cfgcreate zone_config_name, zone_name.

    4. Enable the zone configuration created in the previous step: cfgenable zone_config_name.

    5. Check if the zone is effective on the switch using: zoneshow.

  6. Create four host groups with the following composition:

    1. Host Group 1: Storage port 1 connected to Fibre Channel switch 1, HBA port 1 on host 1, HBA port 1 on host 2.

    2. Host Group 2: Storage port 2 connected to Fibre Channel switch 1, HBA port 1 on host 1, HBA port 1 on host 2.

    3. Host Group 3: Storage port 1 connected to Fibre Channel switch 2, HBA port 2 on host 1, HBA port 2 on host 2.

    4. Host Group 4: Storage port 2 connected to Fibre Channel switch 2, HBA port 2 on host 1, HBA port 2 on host 2.

    5. In a browser, navigate to Storage Systems on the Device Manager - Storage Navigator of the storage system.

    6. In the left panel, select Ports > Host Groups > iSCSI Targets.

    7. In the center panel, select Create Host Groups.

    8. Perform the following steps using the default entries:

      • Resource Group Name (ID) should be the same as that of the created command device.
      • Host Mode should be [21] VMware Extension.
      • Expand Host Mode Options and select Mode No. 54 and 63, then click Enable.
      • Select the Hosts and Ports based on the composition of the host group as described above.
    9. Click Add > Finish > Apply.

Presenting a command device to host groups

You can present a command device to host groups.

  1. In a browser, navigate to Storage Systems on the Device Manager - Storage Navigator of the storage system.

  2. In the left panel, select Ports > Host Groups > iSCSI Targets.

  3. In the main window, select the newly created host groups.

  4. In the center panel, select Add LUN Paths.

  5. In the wizard windows, select the created command device under Available LDEVs on the left.

  6. Click Add, then Next.

  7. Click Finish > Apply.

    This might take a few minutes.
  8. Verify if the operation was successful:

    1. Log in to the vCenter where the host was added.

    2. If you are using the vSphere web client, click the host in the left panel.

    3. In the center panel, click Configure > Storage Devices.

      The newly added command device should be visible in the list of devices.
  9. Add the device RDM to a VM.

    1. In the left panel on the vSphere web client, right-click the VM that requires an RDM of the command device.

    2. Click Edit Settings.

    3. At the bottom of the wizard window, near New Device, select RDM Disk, then click Add.

    4. Select the newly created Command Device and click OK to add the disk to the VM.

    5. Reboot the VM. If the VM is an Advisor Gateway VM, run puma_adm --ckstatus to verify that the command device is recognized by the Advisor Gateway VM.

Verifying installed software

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

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

    Software
    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
    OpenSSH
  2. After verifying that the installation is complete, take the final snapshot of the virtual machine.

    The UCP Advisor installation is now complete.
  3. Take a snapshot of the UCP Advisor Controller VM.

  4. 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.

Manually removing content after uninstallation

After uninstalling older versions of UCP Advisor, some unwanted content may still remain and can be removed by following this procedure.

  1. Log on to vCenter Server Appliance (vCSA) using the root credential.

  2. Run the following commands to remove content that the uninstallation script has not removed:

    rm -rf /tmp/vmware-root/com.hitachi.ucp.advisor-servicespec.prop rm -rf /etc/vmware/vsphere-client/vc-packages/vsphere-client-serenity/com.hitachi.ucp.advisor-2.0.0 rm -rf /etc/vmware-vpx/extensions/com.hitachi.ucp.advisor rm -rf /etc/vmware-vpx/locale/com.hitachi.ucp.advisor_catalog.zip rm -rf /etc/vmware/vsphere-client/cmCatalog/com.vmware.cis.com.hitachi.ucp.advisor.zip
  3. Run the following commands to remove the appliance configuration files:

    rm -rf /usr/lib/vmware-vsphere-client/server/ucpconfiguration.json rm -rf /usr/lib/vmware-vsphere-client/server/UCPConvergeLog.properties
  4. Run the following command to remove old log files:

    rm -rf /storage/log/vmware/vsphere-client/logs/HitachiUCPConverge.log
  5. Browse to the following path:

    https//VCSA_IP_Address/mob
  6. Select the hitachi.ucp.advisor extension and unregister the extension.

  7. Go to vCSA again and run the following commands to restart the web client service:

    Service-control -stop vsphere-client Service-control -start vsphere-client After performing these steps, the leftover content from the UCP Advisor uninstallation process should be successfully removed.