To register your plug-in package as an extension with vCenter Server, you must create an Extension data object and register this data object with the vCenter Server ExtensionManager.

You can create and register an Extension data object in the following ways:

■

Use a utility application or script to create the Extension data object programmatically, and register that data object using the vSphere API. You can use the ExtensionManager.registerExtension() method to register the data object.

■

Use the Managed Object Browser (MOB) application for your vCenter Server system. For more information about how to use the MOB to register your extension, see the procedure bellow.

Procedure
1

Create the vim.Extension data object in an XML file, and place that file in a file system available to the vSphere Web Client.

2

In a Web browser, navigate to the Managed Object Browser of your vCenter Server.

https://<vcenter_server_ip_address_or_fqdn>/mob/?moid=ExtensionManager

3

Log in with your vCenter Server credentials.

4

On the ManagedObjectReference:ExtensionManager page, under Methods, click RegisterExtension.

5

On the void RegisterExtension page, in the text box inside the Value column, enter the XML data of your vSphere Web Client extension.

6

Click Invoke Method to register the extension.

For an example about how to define your Extension data object, see Creating the vCenter Server Extension Data Object.

What to do next

Check whether your extension is registered successfully with the vCenter Server instance by using one of the following approaches:

■

In the vSphere Web Client, go to Administration and under Solutions, select Client Plug-Ins and click Check for New Plug-Ins.

■

Log out and log in again to the vSphere Web Client. The vSphere Web Client checks for new plug-ins for each new user session.

Note

If you try to upgrade an existing plug-in with a new version and you do not follow the best practices and recommendations for developing vSphere Web Client plug-ins, you might need to restart the vSphere Web Client service to see your plug-in. This additional step is required in the following two cases:

■

The new version of your plug-in has a different plug-in ID.

■

The plugin-package.xml manifest file and the vCenter Server extension data object have different plug-in IDs or versions specified.

For more information about verifying the deployment of your plug-in package, see Verifying Your Plug-In Package Deployment.