How to install vCloud Hybrid Service (vCHS) plugin for web client

Posted by on January 6, 2014 in vCHS | 0 comments

Last week VMware announced the availability of a web client plugin to help manage vCloud Hybrid Service (vCHS). This sounded pretty cool, but what really interested me was getting to try a plugin for the vSphere web client. There are very few plugins available for the web client at this point, as vendors are working on updating their existing plugins to work in the new world. Plugin documentation link.

For this write up I setup a test instance of the vCenter server appliance and will be using an existing vCHS account. I will install the plugin and connect it to my account.

1 register plugin

 

Exporting vCHS web certificate

The first phase of this install is to download a copy of the web certificate from https://vchs.vmware.com. This will be imported into the cert store on the vCenter appliance so that it will trust vCHS. To accomplish this I browsed to the web link using Firefox. Then as shown in the image below clicked on the secure lock and choose more information.

1 save cert

vCHS Certificate

 

I was then presented with the following window, from which you should choose the View Certificate option. This will show you details about the web certificate.

2 save cert

vCHS Certificate

 

The image below is now showing the details about the certificate from the vCHS site. At the bottom of the window there is an Export button, click to begin the export of the certificate.

3 save cert

vCHS Certificate

 

You should now be presented with a window similar to the one below, the image was captured from my Mac and might look a little different for Windows users. From here you will need to enter the name of the file you want saved. The install instructions from VMware suggest the name of vchs.cer to keep things easy.

At the bottom you will also need to select the format that you want to export the certificate in. The recommended choice from documentation was the X.509 format.

4 save cert

Save vCHS certificate

 

Import vCHS certificate

The next step that we need to accomplish is to import the certificate into our vCenter appliance. To do this I have already copied the vchs.cer file to a directory on the appliance.

We now need to run the command that will import the certificate into the keystore. The example below is taken from the Linux based vCenter appliance.

Linux Command:

/usr/java/jre-vmware/bin/keytool -alias vchs -v -keystore /usr/lib/vmware-vsphereclient/server/configuration/keystore -storepass changeit -import -file path_to_file/vchs.cer

Windows Command:

“C:\Program Files\Java\jre7\bin\keytool.exe” -alias vchs -v -keystore “C:\Program

Files\VMware\Infrastructure\vSphereWebClient\server\configuration\keystore” -storepass changeit -import -file c:\vchs.cer

1 vchs cert

 

Once you execute the command you will be presented with the following screen or one similar on Windows. This will ask you to trust the certificate so that it can be imported into the keystore.

2 vchs cert

 

After answering yes to the previous question the certificate should now be added to the keystore. The image below shows the confirmation of the process.

3 vchs cert

 

Install vCHS plugin

So now we have downloaded the certificate and imported it into the keystore. We are now ready to begin the install of the vCHS plugin. I have already downloaded the installer file and plug file and copied them to a folder on the vCenter appliance.

There is an install file for Linux servers and one for Windows server, use the appropriate one for your system.

1 vchs plugin

 

Upon running the installer I was presented with a very long EULA that I needed to move through all the screens,  before I could eventually accept.

2 vchs plugin

 

After accepting the EULA that first step is to choose if you are going to register the Plugin or if already installed you can unregister to remove it. We are installing so I will select 1 and move forward.

3 vchs plugin

 

I was then prompted to enter the URL for the vCenter server that the plugin will be registered to. Since this was a quick lab test I am using the IP address rather than a FQDN.

4 vchs plugin

 

After the vCenter URL you will next be prompted to enter a username and password for access to the vCenter for the Plugin install.

5 vchs plugin

 

The next step is the installer needs to know the folder location of the vSphere web client install. On the appliance its located in the default locations which is shown.

On Linux, the path is typically /usr/lib/vmware-vsphere-client.

On Windows, the path is typically C:\Program Files\VMware\Infrastructure\vSphereWebClient

6 vchs plugin

 

The next question is whether we have already downloaded the plugin file. In my case I did and already copied it to the install folder on the appliance. It seemed easier to download in advance and use for the install. If you did not download you can provide the download link to the installer and it will download the plugin for you. But having to go out and find the proper download link seemed like extra work.

After answering Yes, it was prompted to provide the path to the zip file for the plugin shown in the image below.

7 vchs plugin

 

This step is asking if we have already downloaded the web certificate from vCHS. The process will go smoother since we did this in advance.

8 vchs plugin

 

Last up the installer is ready to finish and just needs to confirm that it can restart the web client service.

9 vchs plugin

 

Upon completing the install you should see a confirmation like the image below. Showing the the install finished and the service was stopped and restarted. Now we can open up a browser and head back to the vSphere web client.

10 vchs plugin

 

Register vCHS plugin

Upon logging back into our test web client instance we now see the new plugin is there. An icon for the vCHS plugin is now listed in the inventories section.

1 register plugin

vShere web client plugin

 

Upon clicking on the new plugin you will see an screen like the image shown below. This shows the plug is installed but not registered to vCHS. So next up is the click the link to register the plugin with vCHS.

2 register plugin

vCHS plugin

 

I was then presented with the window shown below to enter in my vCHS details. The plugin just needs the vCHS web link and your login credentials.

3 register plugin

vCHS account

 

The install is completed. You will now see your virtual data centers that are in vCHS in your web client. They do not show up in the normal inventory list and are only shown in the plugin section.

 

About Brian Suhr

Brian is a VCDX5-DCV and a Sr. Tech Marketing Engineer at Nutanix and owner of this website. He is active in the VMware community and helps lead the Chicago VMUG group. Specializing in VDI and Cloud project designs. Awarded VMware vExpert status 6 years for 2016 - 2011. VCP3, VCP5, VCP5-Iaas, VCP-Cloud, VCAP-DTD, VCAP5-DCD, VCAP5-DCA, VCA-DT, VCP5-DT, Cisco UCS Design

Leave a Reply

%d bloggers like this: