A File Recovery Enabler for Linux enables virtual machine data to be browsed from a backup for the source virtual machine (VM), with support for ext2, ext3, ext4, XFS, JFS, HFS, HFS Plus, and Btrfs file systems. Use the open virtual appliance (OVA) template supplied by Commvault to create a virtual machine that contains the File Recovery Enabler.
- Before creating a virtual machine 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 File Recovery Enabler template. The template version must match the installed service pack version.
- To verify the version of VMware software that is required to support this feature, see System Requirements.
- Requirements for the ESX server where the File Recovery Enabler is deployed:
- Deployment uses 4 GB of RAM
- Deployment uses 4 vCPUs
- Disk requirements: 80 GB (thin or thick provisioned)
- Verify that network communication is enabled so that the VMware servers, the CommServe system, and the machine where the File Recovery Enabler is deployed can communicate with each other.
- If a firewall is used, see Entering Required Firewall Settings.
- The virtualization client must refer to a vCenter user with permissions defined as described in Configure User Accounts.
- The following vSphere permissions are required to enable deployment or reconfiguration of a File Recovery Enabler for Linux:
Category Available Permissions vApp Import vApp vApp application configuration vApp vApp instance configuration
- The following Commvault permissions must be assigned for the CommServe user account in the CommCell Console:
Category Permission Usage Global Administrative Management Enables the CommServe user (identified as CS User Name below) to deploy the File Recovery Enabler in the CommServe system. Client Agent Management Enables the File Recovery Enabler to be added to a client computer group.
- The File Recovery Enabler can be deployed on the same vCenter and ESX server that is used for VMware backup, or on any other vCenter or ESX server with which the File Recovery Enabler can establish a connection.
- Live recovery is only supported for recovery from backups using magnetic disk libraries, not from backups to tape libraries.
- Live browse and file recovery operations are not supported for XFS realtime subvolumes.
- With Service Pack 8 or later, live browse and recovery is supported for subvolumes of Btrfs file systems.
- The File Recovery Enabler for Linux supports NFS version 3.
- After deploying the File Recovery Enabler, download and install HotFixes for the installed service pack.
- Go to Cloud Services, log in, access the Download Center, and select Virtualization under Category. Download the File Recovery Enabler for Linux package that is at the same service pack level as the installed service pack, and save it to a location that is accessible from the vCenter.
- In vCenter, click the File menu and select Deploy OVF Template.
- Browse to the location where the File Recovery Enabler for Linux template file is located and select that file; then click Next.
- Review the OVF Template Details dialog and click Next.
- On the Name and Location dialog, enter a name for the virtual machine (for example, VM_LinuxFileRecoveryEnabler); then click Next.
- On the Host / Cluster dialog, select a data center and ESX server; then click Next.
- On the Resource Pool dialog (optional), select a resource pool and click Next.
- On the Storage dialog, select a datastore and click Next.
- On the Disk Format dialog, click Next to accept the default format.
- On the Network Mapping dialog, select the source and destination networks as needed; then click Next.
- On the Properties dialog, enter the following information:
- CS Configuration:
- CS Client Name - Short name for the CommServe system. This entry is case sensitive.
- CS Hostname - Host name or IP address for the CommServe system. This entry is case sensitive.
- CS User Name - User name for the CommCell Console. The user must have the Global > Administrative Management permission for the CommServe system.
- CS Password - Password for the CommCell Console user.
- Client Configuration:
- Client Name - Short name for the virtual machine (for example, VM_LinuxFileRecoveryEnabler).
- Client Hostname – Host name or IP address for the client.
- New root password - Password for the root user of the virtual machine.
- Client Group Name – Name of a client computer group; the File Recovery Enabler is assigned to that group if the group exists (the name is case sensitive).
- IP Configuration:
The following fields need to be entered when the File Recovery Enabler is being deployed using a static IP address, or with DHCP if there is a possibility that the DHCP server in your environment provides incorrect or incomplete DNS information. The fields below override any DNS configuration that is obtained from the DHCP servers.
- Use DHCP - Select this option or enter values for the Static IP Address, Netmask, and Gateway.
- DNS Search Suffix - Identifiers for domains to be supported. You can enter multiple search suffixes separated by whitespaces.
- Name Server 1 - IP address for the primary name server.
- Name Server 2 - IP address for the secondary name server.
- Firewall Configuration - Indicate whether the CommServe system is behind a firewall and enter values for Option 1, Option 2, or Option 3:
- Is CS behind a firewall? - Select this option if a firewall is enabled on the CommServe system.
- [Option 1] CS f/w tunnel port (client can connect to CS) - Enter the tunnel port number the client can use to open a connection to the CommServe system.
- [Option 2] Client f/w tunnel port (CS can connect to client) - Enter the tunnel port number the CommServe system can use to open a connection toward the client.
- For Option 3, enter all of the following values:
- [Option 3] Proxy Hostname (CS reachable via proxy)
- [Option 3] Proxy Clientname (CS reachable via proxy)
- [Option 3] Proxy port number (CS reachable via proxy)
- If an HTTP proxy is used for communication between the CommServe host and the File Recovery Enabler, provide the following information:
- HTTP Proxy Hostname
- HTTP Proxy Port
- CS Configuration:
- After verifying the information, click Next.
- On the Ready to Complete dialog, review the deployment options and click Finish.
- Configure a default File Recovery Enabler for Linux to use for UNIX-based file restores as described in Specify the Default File Recovery Enabler for Linux for a Virtual Server Instance, and an ESX server to host the NFS datastore as described in Identify the Proxy ESX Server.
If you still experience connection issues after deployment, you can also add fully qualified host names and IP addresses for the File Recovery Enabler and the CommServe system to the /etc/hosts files for both machines to ensure that both systems can resolve host names locally.
If the File Recovery Enabler is visible in the CommCell Console, you do not need to perform this procedure.
- Power on the virtual machine and log in.
- Verify that the virtual machine is displayed in the CommCell Browser. If not, the VM might have failed to register with the vCenter.
- Before registering or re-registering the File Recovery Enabler:
- Stop services on the File Recovery Enabler.
- If there is a previously registered virtual machine client with the same name in the CommCell Console, delete the client to revoke the certificate for the previous registration.
- To register the File Recovery Enabler:
- Open a command line window on the virtual machine.
- Go to the /etc/ folder.
- Enter the following command:
- If the VM is still not displayed in the CommCell after a short time interval, verify the connection to the vCenter and run the /etc/initfbr_sc command again.
- Verify connectivity among the CommServe system, the proxy, and the virtual machine that has the File Recovery Enabler installed.
- If incorrect information is entered for the OVF template deployment (for example, a CS user name with insufficient privileges), the init_fbr.log file might include the following lines:
SIMCallWrapper registration failed!
Correct OVA settings and reboot
Perform the following additional steps in the vSphere Client:
- Power off the VM that has the File Recovery Enabler installed.
- Use Edit Settings to modify the properties of that VM.
- On the Options tab, correct the OVA properties.
- Power on the OVA.
If the modified properties are correct, the OVA registration will be successful and that client will be set as a File Recovery Enabler.
By default, Network Time Protocol (NTP) is disabled for the File Recovery Enabler. To enable NTP:
- Log in as root user to the File Recovery Enabler.
- Enter the following command with appropriate values for area and location:
systemctl enable chronyd ; systemctl start chronyd ; ln -sf /usr/share/zoneinfo/area/location /etc/localtime
systemctl enable chronyd ; systemctl start chronyd ; ln -sf /usr/share/zoneinfo/America/New_York /etc/localtime
As needed, the OVA template for the File Recovery Enabler is updated to include operating system updates and enhancements. To ensure that the File Recovery Enabler contains all critical fixes and features, upgrade the CommServe host and Virtual Server Agent to the latest service pack, and download the latest OVA template for the File Recovery Enabler to deploy the File Recovery Enabler.
If you have deployed an older version of the File Recovery Enabler for Linux, decommission the older version and deploy a new one as described in Deploy a Virtual Machine for UNIX-Based File Restores.
The /opt/ directory of the File Recovery Enabler is reserved for storing cache data for snapshot mounts. Do not configure a disk library to use space under the /opt/ directory.
- For Live Recovery for VMs, cache data is stored in /opt/3dfs (20 GB minimum).
- For Live File Recovery (IntelliSnap for VMware), cache data is stored in /opt/FBR (40 GB minimum).
A Linux MediaAgent can be installed as a guest agent on a virtual or physical machine to provide backup services for Linux virtual machines. To enable extended file system support, a Linux MediaAgent running on a supported Linux guest operating system can be transformed into a File Recovery Enabler for Linux. This enables the Linux MediaAgent to mount virtual machine backup data for Live Browse and Live Recovery operations, without requiring that granular recovery metadata be collected during backups.
Before You Begin
- This solution is supported for a Linux MediaAgent on a virtual or physical machine running any of the following operating systems:
- Oracle Linux 6 Update 4 (OEL6U4) Red Hat Compatible Kernel
- Red Hat Enterprise Linux (RHEL) 6.4, 6.5, 6.6, 6.7, or 7.2
- CentOS 6.4, 6.5, 6.6, 6.7, or 7.2
- Use an isolated virtual machine or physical machine for this deployment, not an existing Linux MediaAgent that is used for backup operations.
- To deploy this solution on a new Linux machine, install the Linux MediaAgent and file system agent in restore only mode as described in Installing Restore Only Agents.
- Ensure that RPC services are running (for example, rpcbind).
- Download and install XFS file system packages on the machine where the Linux MediaAgent is installed.
- Add two disks or volumes with the XFS file system and create two mount points for cache data:
- For FBR cache: 40 GB minimum
- For 3DFS cache: 20 GB minimum
- Stop Commvault services.
- Create a 3Dfs directory in the /etc/CommVaultRegistry/Galaxy/Instance001/ directory.
- Create a .properties file in the /etc/CommVaultRegistry/Galaxy/Instance001/3Dfs/ directory.
- Add the following required registry keys to configure FBR and 3DFS mount paths:
- For /etc/CommVaultRegistry/Galaxy/Instance001/Session/.properties:
nFBRDELAYEDINIT 1 nFBRSkipFsck 1 dFBRDIR Path for the FBR cache mount point sLNFBR /opt/commvault/Base/libCvBlkFBR.so (if not already present)
- For /etc/CommVaultRegistry/Galaxy/Instance001/Session/.properties:
- Create the s3dfsRootDir additional setting on the Linux MediaAgent and specify the path for the 3DFS cache mount point.
- Start Commvault services.
- Run the following script to validate the configuration and settings:
- When prompted, provide administrator management user login credentials for the CommCell Console.
After validating the configurations, the script marks the Linux MediaAgent as a File Recovery Enabler for Linux, and the MediaAgent can be used for Live Browse and Live Recovery operations.