Build and Deploy the vSphere HTML SDK Sample Plug-in

The vSphere Client SDK contains a sample plug-in that demonstrates the use of several extension points. Use this procedure after you modify the sample.

After you modify the sample plug-in, you must re-build and re-deploy it. To build the html-sample, do the following steps from the command line.

Prerequisites

Before you modify the sample, see vSphere Client SDK Setup for instructions to install and configure all required components. In particular, you need the following tools installed:
  • nodejs, versions 6.9.x to 11.15.x, inclusive
  • npm 5.x.x
  • Angular-CLI
Also you must set the following environment variables:
  • Set the environment variable ANT_HOME to your Apache Ant folder.
  • Set the environment variable VSPHERE_SDK_HOME to your vSphere Client SDK folder.

Procedure

  1. In a command shell, change to the html-sample-ui directory.
    cd samples/html-sample-ui
  2. Build the modified sample.
    On a MacOS system, run ./build-plugin-package.sh.
    On a Windows system, run build-plugin-package.bat.
    The build output is in samples/html-sample-ui/target.
  3. Copy the output folders to the plugin-packages directory, confirming that you want to replace existing files.
    cp -r samples/html-sample-ui/target vsphere-ui/plugin-packages
    The vsphere-ui/plugin-packages directory is where local plug-ins are picked up automatically when the server starts.