Deploying the Commvault vRealize Plugin for VMware

To use the Commvault VMware vRealize version 8.x Plugin with VMware Aria Automation (formerly vRealize Automation), you must deploy a workflow using the VMware vRealize Orchestrator, and then use the CommCell Console to configure supporting objects.

vRealize supports a multi-tenant environment.

Note

To deploy a new version of a plugin, uninstall the previous version and then deploy the new version.

The Commvault - Install CV Workflows 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 vRA Project, Cloud Account, CV Storage Plan, CV VM Group 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 template and deploys a new VM using the template. The workflow also creates a workflow subscription called CommvaultDataProtectionEventSubscription, which checks for life cycle events of VMs that are associated with the template. When a user deploys a new VM that is associated with the template, the VM is automatically added to the Commvault VM Group for backup.

Requirements

VMware vRealize Appliance including the following software:
- VMware Aria Automation (formerly vRealize Automation) version 8.x
- VMware vRealize Orchestrator version 8.5
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 Plugin for the installed service pack from the Commvault Store at Commvault Store > Virtualization > vRealize.
To use data replication features, download vRealize Data Replication Plugin 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:

To import the Commvault - Install CV Workflows workflow, go to the Assets > Packages view, then under the Packages section in the center, choose Import , and select the com.commvault.dataprotection package.
Under CommvaultDataProtection, right-click Commvault - Install CV Workflows and then, in the left menu, select Workflows.
In the main display area, under the Commvault- Install CV Workflows pane, select Run.
On the Commvault - Install CV Workflows parameters page, provide the following information:
- vRA host: Select the vRealize server.
- CVRESTHostURL: Enter an address for the Web Service associated with the CommServe system. Enter the address in the following format:
```
 
http://web_server_host_name:port_number/SearchSvc/CVWebService.svc
```
  Where
  - web_server_host_name is the name or IP address for the Web Service.
  - <port_number> is the standard port on the Web Service. For Windows, the port number is 81 and 5000 for Linux.
- Select bCVCreds.
- CVUser: 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 one time for TDES (Triple Data Encryption Standard) encryption of the Commvault password. Any phrase/key is acceptable.
  
  Important
  
  For data protection operations, the vRealize Plugin always uses the first host entry found under HTTP-REST. When multiple host entries are under HTTP-REST, plugin operations might fail.

Result

Based on the value you entered for the VMware Aria Automation (formerly vRealize Automation) CVRESTHostUrl, the Commvault workflow creates a host entry under HTTP-REST for vRealize Orchestrator. You can see the host entry under VRA Orchestrator > Administration > Inventory > HTTP-REST.

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. If this happens, Run the deployment workflow again with the correct information.