Installing and Configuring the Commvault Plug-In for VMware vSphere Web Client

If you are installing the plug-in for the first time, perform the tasks listed under Preparing the Environment.

Registering the Plug-In in the Command Center

From the Virtualization application in the Command Center, perform the following steps to register the plug-in:

  1. From the navigation pane, go to Manage > System > Plugins.

    The Manage vsphere plugin dialog box appears.

  2. Enter the following information:
    • Plugin action: Select Register.
    • Hostname: Enter the hostname for the vCenter server.
    • Username: Enter the user name that can be used to access the vCenter server.

      Enter the user that was defined in User Configuration in vSphere. The user must have privileges sufficient to manage client plug-ins and single sign-on settings.

    • Password: Enter the password for the user.
    • vCenter version: Select 6.0 or earlier.
    • Enable SAML: Select this option.
  3. Click Submit.

After the Manage vsphere plugin dialog box redisplays with the message indicating that the plug-in is registered successfully, click SPMetaData to download the XML configuration file for the plug-in to the default download directory for the browser. The plug-in is automatically added as an application in the Identity Management listing of the CommCell Console.

Configuring Access to the Plug-In through vSphere

  1. Log on to vSphere Web Client with the user account that was defined in User Configuration in vSphere.
  2. Import the plug-in configuration file that was created in Registering the Plug-In in the Command Center using the following options: Administration > SSO > Configuration > SAML Service Providers > Import.
  3. Log off the vSphere Web Client.
  4. Go to the vCenter server and restart the VMware vSphere Web Client service.
  5. Verify that the plug-in is present in the following folder:


    Where plug_in_folder_name is the name of the plug-in (for example, commvault.vwebvsphereplugin-1.0.0).

Enabling Single Sign-On in CommCell Console

  1. On the Home tab of the CommCell Console, click Control Panel.
  2. Under CommCell, click Identity Management.
  3. Click the application name for the vCenter to which the plugin was registered and then click Edit.

    The Edit SAML Application Info dialog box appears.

  4. On the Association tab, select any users who need access to the plug-in and click OK.

Note: If a user is configured to use SAML for authentication, the user is automatically redirected to a SAML authentication site after logging on to the Web Console. The user can click Cancel or press the Esc key to cancel the redirection, or click Back to return to the previous page, and then continue logging on to the Web Console.

Last modified: 10/21/2019 7:29:54 PM