Deploying a File Recovery Enabler for Linux with OpenStack

A File Recovery Enabler for Linux (FREL) enables instance data to be browsed from a backup for the source instance, with support for ext2, ext3, ext4, XFS, JFS, HFS, HFS Plus, and Btrfs file systems. Use the QCOW2 template supplied by Commvault to create an instance that contains the FREL.


  • The File Recovery Enabler for Linux package is deployed as a MediaAgent in restore-only mode, and does not consume a license. The client does not appear in the Client Computers list unless the Show Unlicensed with software (Restore only Clients) option is selected in User Preferences.

  • Live browse and file recovery operations are not supported for XFS realtime subvolumes.

  • Live browse and recovery is supported for subvolumes of Btrfs file systems.

Before You Begin

  • Before creating an instance for Linux file restores, install the latest available service pack for Commvault on the CommServe host and Virtual Server Agent.

  • Use the latest available version of the FREL template. The template version must match the installed service pack version.

  • The FREL must be deployed on the same OpenStack cloud and within the same region or domain where the proxy instance is running. Optionally, you can reconfigure the FREL to act as a VSA proxy, in which case the FREL consumes a Virtual Server license.


  1. Go to the Commvault Store on the Cloud Services website and download the V11 OpenStack Ready FREL Image with SPn package for the installed service pack (for example, SP20) to a location that is accessible from OpenStack.

  2. From the OpenStack Horizon dashboard, create an image based on the V11 OpenStack Ready FREL Image template.

    Use the following options when creating the image:

    • Image File: Select the FREL_OpenStack_SP5.qcow2 template.

    • Format: Select QCOW2 - QEMU Emulator.

    • Minimum Disk (GB): Provide at least 40 GB.

    • Minimum RAM (MB): Provide at least 2048 MB RAM.

    The Launch Instance wizard appears. You can use default options except as noted in the following steps.

  3. On the Details page, specify an Availability Zone in the same region as the instances for which the FREL will be used.

  4. On the Flavor page, choose an instance type that provides at least 50 GB disk space and 2048 MB RAM.

  5. On the Networks page, assign a private network if the CommServe system resides outside of OpenStack.

    If you assign a private network, you must also associate a floating IP address with the private network and modify the client that is created in the CommCell Console.

  6. On the Configuration page, paste the following script into the script box and provide values for commserve_host, commserve_client_name, user_name, password, and client_name:

    CS_IP_OR_FQDN=commserve_host CS_SHORT_NAME=commserve_client_name CS_USERNAME=user_name CS_PASSWORD=password FREL_CLIENTNAME=client_name

    The values in the script are case sensitive.

    Script Parameters:

    • CS Hostname: For commserve_host enter the host name or IP address for the CommServe system.

    • CS Client Name: For commserve_client_name enter the short name for the CommServe system. This name must be identical to the Client Name value in the CommServe client properties in the CommCell Console, including exactly the same capitalization.

    • CS User Name: For user_name enter the user name for the CommCell Console.


      The user name must have both Global > Administrative Management and Commcell > Install Client permissions.

    • CS Password: For password enter the password for the CommCell Console user.

    • FREL Client Name: For client_name enter a name for the FREL. The name you enter is used to register the FREL and create a client in the CommCell Console.

  7. After launching the instance, if you assigned a private network, associate a floating IP address with the private network.

    This change is required when the CommServe system cannot reach the newly deployed FREL instance using the fixed IP address. For example, if the CommServe system is outside the OpenStack cloud that hosts the FREL instance, the CommServe system would need to reach the FREL instance using a floating IP address for the private network.

    1. In the CommCell Console, modify the client properties for the FREL client.

    2. On the General tab, edit the Host Name value and replace the fixed IP address with the floating IP address.

  8. Configure a default FREL for Linux to use for UNIX-based file restores as described in Specifying the Default FREL for Linux for a Virtual Server Instance.

  9. To access the FREL machine, ssh to the newly deployed FREL instance with user “centos” and the private key for the keypair specified during deployment. Once logged in, you can enable root access by modifying /etc/ssh/sshd_config to allow root login (PermitRootLogin yes) and or to allow password authentication (PasswordAuthentication yes), and then restarting ssh services. To use password authentication for root, perform the following steps:

    $ sudo su 
     # passwd (enter new password for root)


If you still experience connection issues after deployment, you can also add fully qualified host names and IP addresses for the FREL and the CommServe system to the /etc/hosts files for both machines to ensure that both systems can resolve host names locally.