Deploying the Commvault vRealize Plug-in for VMware

To use the Commvault VMware vRealize plug-in with VMware vRealize Automation v7.3, 7.4, 7,5, or 7.6, you must deploy a workflow using the VMware vRealize Orchestrator, and then use the CommCell Console to configure supporting objects.

The InstallCVWorkflows workflow creates resource actions for data protection operations that users can perform on a virtual machine, including resource actions such as Backup VM and In-Place Full VM Restore. After the workflow creates the resource actions, it adds them to the entitlement that you specify for the workflow. The workflow also creates property definitions called CV Plan, CV VM Group, Client Name, and Tenant Name, and then adds those properties to a property group called CommvaultDataProtectionPolicy. Those properties are visible when a user adds the CommvaultDataProtectionPolicy property group to a vRealize blueprint and deploys a new VM using the blueprint. The workflow also creates a workflow subscription called CommvaultDataProtectionEventSubscription, which checks for life cycle events of VMs that are associated with the blueprint. When a user deploys a new VM that is associated with the blueprint, the VM is automatically added to the Commvault VM Group for backup.

Similarly, the InstallDRworkflows workflow creates definitions that are used for replication operations.

Requirements

• VMware vRealize Appliance including the following software:

  • VMware vRealize Automation 7.3, 7.4, 7.5, 7.6

  • VMware vRealize Orchestrator 7.3, 7.4, 7.5, 7.6

• VMware using vCenter 6.5 or later (all updates)

• Run this workflow using the vRO webclient only but not a vRO legacy client., as the Encryption Pass Phrase key and value are only supported from vRO webclient 7.6 and later.

Before You Begin

• Configure the vRealize endpoint. Use exactly the same name as the VMware hypervisor.

  For example, if you use the fully qualified domain name for the hypervisor or virtualization client, you must use exactly the same name for the vRealize endpoint.

• Download vRealize Data Protection Plug-in for the installed service pack from the Commvault Store at Commvault Store > Virtualization > vRealize.

• To use data replication features, download vRealize Data Replication Plug-in from the Commvault Store at Commvault Store > Virtualization > vRealize.

• The user account specified for the workflow must have the master role with Administrative Management permissions for the CommServe system.

Deploying the Workflow Using vRealize Orchestrator

Perform the following steps from the VMware vRealize Orchestrator:

1. To import the InstallCVworkflows workflow, go to Packages view, choose Import package, and select the com.commvault.dataprotection package.

2. Under CommvaultDataProtection, right-click InstallCVWorkflows, then select Start Workflow

3. On the Start Workflow or Run / Common Parameters page, provide the following information:

   • vRA CAFE host: Select the vRealize server.

   • Entitlement: Select one or more entitlements to identify the permissions for the user who is running the operation. You can select the Default Entitlement that is provided with vRealize or custom entitlements that are created for your environment.

   • CV Webservice URL: CV Webservice URL: Enter an address for the Web Service associated with the CommServe system. Enter the address in the following format:

     http://web_server_host_name:81/SearchSvc/CVWebService.svc

     Where web_server_host_name is the name or IP address for the Web Service, and :81 is the standard port on the Web Service.

   • CV username: Enter the user name that will be used to access the Web Service. The user must have the master role with Administrative Management permissions for the CommServe system.

   • CV password: Enter the password for the user.

   • Encryption Pass Phrase: Enter an encryption pass phrase/key that will be used for TDES (Triple Data Encryption Standard) encryption of the Commvault password

     Important

     For data protection operations, the vRealize Plug-in always uses the first host entry found under HTTP-REST. If there are multiple host entries under HTTP-REST, plug-in operations might fail.

4. To use data replication features, perform the following steps:

   1. To import the InstallDRworkflows workflow, go to Packages view, choose Import package, and select the com.commvault.datareplication package.

   2. Under CommvaultDataProtection, right-click InstallDRWorkflows and then select Start workflow.

   3. In the Start Workflow : InstallDRWorkflows page, provide the following information:

      • VRA server: Select the vRealize server.

      • Entitlements: Select one or more entitlements to identify the permissions for the user who is running the operation. You can select the Default Entitlement that is provided with vRealize or custom entitlements that are created for your environment.

      • Commvault WebService URL

        Enter an address for the Web Service associated with the CommServe system. Enter the address in the following format:

         
        http://web_server_host_name:81/SearchSvc/CVWebService.svc

        Where web_server_host_name is the name or IP address for the Web Service, and :81 is the standard port on the Web Service.

      • CV User: Enter the user name that will be used to access the Web Service. The user must have the master role with Administrative Management permissions for the CommServe system.

      • CV Password: Enter the password for the user.

Result

Based on the value you entered for the vRealize Automation 7.5 and earlier Commvault WebService URL, the Commvault workflow creates a host entry under HTTP-REST for vRealize Orchestrator. You can see the host entry under the Design view

If the workflow cannot validate the connection to the Web Service host, because the URL is not in the correct form or because the credentials are incorrect, the workflow removes the invalid host entry. Run the deployment workflow again with the correct information.