Loading...

Preparing the Environment for the Commvault Plug-In for VMware vSphere Web Client

For the first installation of the Commvault plug-in, perform the tasks in this topic to prepare your environment for the plug-in.

For subsequent updates, you do not need to repeat these tasks. Instead, you can perform only the tasks described in Installing and Configuring the Plug-In.

Enabling the Plug-In to Display in the vSphere Web Client

  • To enable the Web Console to display in an iFrame in the vSphere Web Client, add the disableSameOrigin additional setting on the client computer that is used for Web Console, as shown in the following table.

    For instructions on adding additional settings from the CommCell Console, see Add or Modify an Additional Setting.

    Property

    Value

    Name

    disableSameOrigin

    Category

    WebConsole

    Type

    Boolean

    Value

    true

Customizing the Web Console Configuration

  • Enable HTTPS on the Web Console machine using a self-signed or CA-signed certificate.

    For more information about certificate management, see Configuring Secured Access.

  • Configure HTTPS on the Web Console machine to use port 443.
  • For Service Pack 9 or later, HTTPS is used by default. To use the Commvault Plug-In for vSphere Web Client, configure the forceHttps additional setting on the Web Console machine and set the value to false.

    For instructions about adding additional settings from the CommCell Console, see Adding or Modifying an Additional Setting.

    Property

    Value

    Name

    forceHttps

    Category

    WebConsole

    Type

    Boolean

    Value

    false

Enabling Downloads for vCenter

  • On the vCenter server, open the vcenter_server_install_path\cfg\vsphere-client\webclient.properties file and add the following entries at the end of the file.

    HTTP.DOWNLOAD=true
    allowHttp=true

Note: For vCenter 6.0, by default, the properties file for a Windows machine is hidden under the ProgramData\VMware\vCenterServer\ folder.

Configuring the vCenter Server in Command Center

  • In Command Center, add the vCenter server. Choose VMware as the server type, specify the hostname or IP address for the vCenter server, and provide administrator user credentials.

For more information, see Adding a Server.

Configuring User Definitions

The same user name must be defined for the CommCell Console and the vSphere Web Client. The user definition created in the CommCell Console must have appropriate permissions, which are defined though a user group and an associated role.

User Configuration in the CommCell Console

Perform the following configuration tasks in the CommCell Console:

  1. Create a role for vSphere users.

    Assign the following permissions for the role:

    • Client > Browse
    • Client > In Place Full Machine Recovery
    • Client > In Place Recover
    • Client > Out of Place Full Machine Recovery
    • Client > Out-of-Place Recover

      Note: To enable users to perform live mount operations for VMs from the Web Console, also assign the Global > View permission.

  2. Create a user group for vSphere administrators.

    On the Associations tab, add the role that you created for vSphere administrators.

  3. Create a Commvault user definition for each vSphere user:

Create each user name in the format username@domain, where username is the vSphere username and domain can be the domain name as defined in the CommCell Console or the vCenter name.

  1. On the User Groups tab, assign the user group that you created for vSphere administrators.
  2. Assign users as owners on the virtual machines they should administer.

    You can also configure a subclient to detect VM owners automatically.

User Configuration in vSphere

  • To enable the user to manage client plug-ins, define a role that includes the following permissions:
    • Extension permissions:
      • Register extension
      • Unregister extension
      • Update extension
    • Global permissions:
      • Diagnostics
      • Log event
      • Set custom attribute

Customizing Security Settings for Chrome

You do not need to perform this task if you installed a CA-signed certificate as described in Customizing the Web Console Configuration.

  1. Log on to the Web Console using HTTPS.

    Use the browser that you intend to use to access the vSphere Web Client. The plug-in has been tested with Google Chrome.

  2. When prompted, indicate that you wish to allow security exceptions and proceed to the site.

    Security exceptions must be allowed before using the plug-in. The vSphere Web Client does not present a pop up that enables you to allow security exceptions when exceptions are required.

Last modified: 3/14/2019 6:02:00 PM