> Software > Virtual Machines > VMware > Commvault Plug-Ins for VMware

Commvault Remote Plug-In for vSphere Client

The Commvault vSphere Client plug-in built on the VMware’s remote plug-in framework enables administrators to perform VM-level operations such as backup, restore and modifying the backup plan directly from the vSphere Client UI. This plug-in replaces the deprecated HTML5-based plug-in and offers improved integration, security, and usability.

Note

The Commvault Remote Plug-In for vSphere Client is available starting Commvault Innovation Release 11.42.29.

Requirements

  • HTML5 Client for vSphere vCenter 8.0 Update 1 and above.

  • A Linux access node with the Remote Plugin Server package installed.

  • The 8058 (default) port must be open on the access node to communicate with the vCenter server.

  • The SHA1 CA–signed certificate must be available on the Linux access node for the plug-in server. If the certificate is not available, then the Commvault software uses a self-signed certificate.

  • The vCenter must use a trusted CA-signed SSL certificate. If not, manually add the certificate to the certificate bundle on the Linux access node and sync the bundle.

  • Configure a hypervisor for vCenter in Command Center.

  • Create a plug-in user in Command Center with the following Client permissions:

    • Browse

    • In Place Full Machine Recovery

    • In Place Recover

    • Out of Place Full Machine Recovery

    • Out-of-Place Recover

    For information about creating a user, see Creating a User and Managing Roles.

Deploy and Register the Plug-In

Step 1: Install the Remote Plugin Server Package

  1. On the Linux access node, use either the system console or SSH to go to the installer directory.

  2. Run the following command:

    sudo ./cvpkgadd

  3. Select the Remote Plugin Server package.

  4. Follow the prompts to complete the installation.

  5. After installation, the plug-in files and scripts will be available in: /opt/commvault/vSpherePluginServer folder.

Step 2: Register the Plug-In

  1. On the Linux access node, use either the system console or SSH to go to the /opt/commvault/vSpherePluginServer folder.

  2. Run the following command:

    ./extensionManager.sh --action register --host vcenter_host_name --user vcenter_username --client_id client_id --webservice webservice_url --command_center command_center_url --admin_email email --thumbprint thumbprint --port port --cert cert_path --key key_path --server_host server_host_name

    where:

    • host: The hostname or IP address of the vCenter server.

    • user: The user account with permissions to register plug-in in vCenter.

    • client_id: The hypervisor client ID configured in the Command Center.

    • webservice: The Commvault web service URL.

    • command_center: The URL to access the Command Center.

    • admin_email: The email address where you want to be notified of the plug-in updates.

    • (Optional) thumbprint: The vCenter SSL certificate thumbprint (sha1, required for self-signed certificates).

    • (Optional) cert: The custom SSL certificate path. If this value is not provided, then a self-signed certificate is used.

    • (Optional) port: The port number on the access node to communicate with the vCenter server.

    • (Optional) key: The custom SSL private key path. This value is required if --cert is provided.

    • (Optional) server_host: The hostname of the Linux access node.

  3. Enter password for the vCenter user account when prompted.

Access the Plug-In

You can access the Commvault plug-in from within the vSphere Client.

  1. From the vSphere Client menu, select Inventory.

  2. Navigate to the root folder (hypervisor level), and then click the Configure tab.

  3. Under Commvault Plugin, click Configure, and then Login.

  4. Enter the Command Center credentials for the plug-in user.

  5. After login is successful, the Backup Summary tile appears on the Summary tab.

VM Actions Using Plug-In

To use the plug-in for VM-level operations:

  1. From the vSphere Client UI, go to the VM details.

  2. Click Actions, and then Commvault Plugin.

  3. Select one of the following operations:

    • Backup: Run full or incremental backup jobs.

    • Restore: Supports full VM in-place and out-of-place restores.

    • Modify plan: Change or assign a backup plan.

    • Redirect to Commvault: Opens Command Center in a new browser tab.

  4. Follow the prompts to complete the selected operation.

Re-register or Remove the Plug-In

  • If the SSL certificate of the plug-in server or vCenter thumbprint is modified and you want to re-register the plug-in, then run the following command: 

    ./extensionManager.sh --action reregister --host vcenter_host_name --user vcenter_user_name --client_id client_id --webservice webservice_url --command_center command_center_url --admin_email email --thumbprint thumbprint --port port --cert cert_path --key key_path --server_host server_host_name

  • To remove the plug-in from vSphere Client, run the following command:

    ./extensionManager.sh --action unregister --host vcenter_host_name --user vcenter_user_name --thumbprint thumbprint
×

Loading...