HowTo Install Mellanox NEO Plugin within vSphere Client/vCenter 5.5

Version 12

    Note: This post is not applicable any more for NEO.

    In case you need vSphese support contact support@mellanox.com

     

    This post explains how to install and register the Mellanox NEO plugin into vCenter and vSphere VMWare Web client applications.

    This post is meant for IT managers and VMware users who want to manage Mellanox switches via the vSphere applications.

     

    Mellanox NEO enables monitoring of Mellanox switches and performs auto-configuration of VLANs as part of the VMware vSphere solution.

     

    References

     

    Prerequisites

    • vCenter 5.5 for Windows

    • HTTP server for internal repositories (optional)

     

     

     

    Plugin Registration

     

    Before you start, edit the webclient.properties file in the following default location:

     

    C:\ProgramData\VMware\vSphere Web Client\webclient.properties

     

    Add:

    allowHttp=true

     

    There are two ways to register your plugin package as an extension with the vCenter server:

    1. Use the HTML MOB interface (link to the header)

    2. Use the Windows vSphere Client

     

    Use the HTML MOB Interface

     

    1. Launch https://<your-vcenter-ip>/mob

       mob1.PNG

    2. Click the "content" link.

     

    mob2.PNG

     

    3. Click the "ExtensionManager" link..

     

    extmgr.PNG

    4. Use the "RegisterExtension" link to enter your extension xml data.

     

    5. Perform cut and paste with the following XML data. You may need to change the URL field if the package is located on a local HTTP server.

    <extension>

    <description>

    <label>NEO Plugin</label>

    <summary>NEO vSphere Client plugin</summary>

    </description>

    <key>com.vmware.mlnx.neoPlugin</key>

    <company>Mellanox</company>

    <version>1.0.0</version>

    <client>

    <version>1.0.0</version>

    <description>

    <label>NEO plugin</label>

    <summary>NEO vSphere Client plugin</summary>

    </description>

    <company>Mellanox</company>

    <type>vsphere-client-serenity</type>

    <url>http://www.mellanox.com/downloads/solutions/neo/neoPlugin.zip</url>

    </client>

    <lastHeartbeatTime>2015-07-06T00:25:52.814418Z</lastHeartbeatTime>

    </extension>

    6. Click the "Invoke Method"  link to finish the installation.

     

    Use the Windows vSphere Client

     

    1. Navigate to "Manage Plug-ins..." in the Plug-ins menu:

     

    win1.PNG

     

    2. Right-click at the bottom of the list and select "New Plug-in...".

     

    Capture2.PNG

    3. Browse to the file containing the xml extension data:

     

    http://www.mellanox.com/downloads/solutions/neo/plugin-package.xml

     

    Capture3.PNG

    4. Click the Register Plug-in button to finish the installation.

     

    Capture4.PNG

     

    Plugin Verification

    You can verify that your plugin has deployed correctly by searching the log file on the vSphere Web Client Virgo server for your plug-in package ID. If the package has deployed correctly, the plug-in package ID is included in a message about a successful package deployment.

    You can also check specific folders on the Virgo server for your expanded .zip files.

    On the Windows operating system, the file appears in the following location:

     

    PROGRAMDATA%/VMware/vSphere%20Web%20Client/vc-packages/vsphere-client-serenity/

     

    Using the MOB ExtentionManager, you should be able to see the new extension (extensionList["com.vmware.mlnx.neoPlugin"]).

     

    Capture5.PNG

    Troubleshooting

    See vsphere_client_virgo.log for detailed information regarding installation/operation errors.

    The file is located at C:\ProgramData\VMware\vSphere Web Client\serviceability\logs\ vsphere_client_virgo.log for Windows servers

    and at /storage/log/vmware/vsphere-client/logs/vsphere_client_virgo.log if you are using a VMware appliance or Linux machine.