Build the vSphere Client Remote Plug-in Sample

You deploy the remote plug-in sample with a Maven build directed by the sample's pom.xml file. This procedure builds the sample and deploys it on the plug-in server.

After you download the vSphere Client SDK, you must build the remote plug-in sample before you can run it.

Prerequisites

Before building the remote plug-in sample, you must have the following:
  • You need Java 8 to compile the code for this sample.
  • You need Maven 3 to build the plug-in package.
  • You need to download and unzip the SDK. See About the vSphere Client SDK for information about the structure of the SDK archive.

Procedure

  1. Change to the root directory of the remote plug-in sample.
    For example: cd /HD/sdk/html-client-sdk/samples/remote-plugin-sample
  2. mvn validate
  3. mvn clean install
    For a production build, substitute the command mvn clean install -Dproduction.build=true

Results

These steps install the Web Services API library into the local Maven repository, download and build the sample executable, download the Clarity design system, and build the JAR file that contains the sample components. The sample is a Spring Boot Application that will start an embedded Tomcat server when you run the sample in a command shell.

Choose a production build for the client code to run more efficiently. Choose a development build for a better debugging experience.

What to do next

After you build the remote plug-in sample, you need to run the plug-in server and register the plug-in with vCenter Server.