Try the Remote Plug-in Sample Starter

Build and run the remote plug-in sample starter for a quick introduction to the process of deploying and viewing a remote plug-in for the vSphere Client.

The plug-in sample starter demonstrates a very simple plug-in that serves only static HTML content. This is the easiest way to be introduced to the remote plug-in environment, including only a few components that extend the vSphere Client user interface with a full-screen view available for plug-in content.

What To Do First

Check the dependencies on your development machine:
  • Java Development Kit 8
  • Maven 3
Install the vSphere Client SDK:
  1. Download the SDK from https://code.vmware.com/sdk/client
  2. In a PowerShell window, unzip the SDK file:

    PS C:\> Get-Item vsphere-client-sdk-*zip | Foreach-Object { Expand-Archive -Path $_ -DestinationPath C:\ }

Build the Remote Plug-in Sample Starter

  1. Navigate to the sample starter directory:

    PS C:\> cd html-client-sdk/samples/remote-plugin-sample-starter

  2. Issue the Maven build command:

    PS C:\html-client-sdk\samples\remote-plugin-sample-starter> mvn clean install

Start the Remote Plug-in Sample Starter

  1. Navigate to the target directory:

    PS C:\html-client-sdk\samples\remote-plugin-sample-starter> cd target

  2. Issue the Java command to run the plug-in server:

    PS C:\html-client-sdk\samples\remote-plugin-sample-starter\target> java -jar remote-plugin-sample-starter-7.0.1.00000-SNAPSHOT.jar

  3. Use a browser to verify that the remote plug-in server can supply its manifest. Enter the following URL:

    https://localhost:8443/sample-ui/plugin.json

    Leave the browser window open for the next step.

Save the Thumbprint of the Plug-in Server

  1. Find the certificate thumbprint of the plug-in server.

    Click the padlock icon next to the URL at the top of the browser window. View certificate details and copy the thumbprint or fingerprint (depending on the browser).

  2. Save the certificate thumbprint in a file or a variable.

    The thumbprint must be formatted with a colon separating each pair of characters. If it is not, edit the string to add the separators before you use it.

Register the Remote Plug-in Sample Starter

  1. Navigate to the directory containing the registration script:

    PS C:\html-client-sdk\samples\remote-plugin-sample-starter\target> cd 'C:\html-client-sdk\tools\vCenter plugin registration\prebuilt'

  2. Run the registration script for the plug-in. Use the name of your vCenter Server instance in the URL and use valid credentials to authenticate. Example:
    PS C:\html-client-sdk\tools\vCenter plugin registration\prebuilt> .\extension-registration.bat `
 -action registerPlugin -remote `
 -url https://myvcenter.example.com/sdk `
 -username [email protected] `
 -key com.vmware.sample.remote.starter -version 1.0.0 `
 -pluginUrl https://mydevbox:8443/sample-ui/plugin.json `
 -serverThumbprint 19:FD:2B:0E:62:5E:0E:10:FF:24:34:7A:81:F1:D5:33:`
 19:A7:22:A0:DA:33:27:07:90:0F:8E:8D:72:F1:BD:F1 `
 -c 'Example, Inc.' -n 'Remote Plug-in' -s 'This is a sample plug-in'

    Enter the password for [email protected] when prompted.

View the Plug-in User Interface

  1. Connect a web browser to the vCenter Server instance and log in to the vSphere Client. Example URL:

    https://myvcenter.example.com/ui/

  2. Navigate to the Home screen (for example, use ctrl-alt-home) or the Shortcut screen.
  3. In the object navigator pane on the left of the home screen, click on the remote plug-in sample starter.

    The vSphere Client displays a plug-in welcome screen.