Use this preinstallation checklist to prepare the computer where you will install the File System Agent, and to gather all of the information you will need during the installation.
The File System Agent is the combination of the following packages:
|
Package |
Description |
|---|---|
|
File System Core |
Base package which establishes connections between the client computer and the CommServe database. Provides the recursive scan functionality as well as the ability to perform laptop backups and restores. |
|
File System |
Provides advanced features to protect the file system data, which include:
|
Verify System Requirements
Verify that the computer where you will install the File System Agent satisfies the minimum requirements specified in the system requirements page for your operating system:
If you plan to use the archiving solution, review the following system requirements for your operating system:
If you plan to use the 1-Touch solutions, review the following system requirements for your operating system:
If you plan to use snapshot management solutions, review the requirements described in System Requirements - IntelliSnap Backup.
Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the File System Agent.
For information about licensing, see the Commvault Licensing Program Guide.
Determine the Installation Location
Based on your environment, install the File System Agent on an appropriate computer.
|
Environment |
Where to install the software |
|---|---|
|
Non-Clustered |
On the computer that you want to back up. For Oracle Solaris computers, install the File System Agent on one of the following setups:
|
|
Clustered |
On all physical nodes of the cluster. Cluster installations are not supported on FreeBSD and Macintosh computers. |
Gather Installation Data
Refer to the items in this section to gather the information that you will need during the installation. Record the information before you begin installing the software, so you can refer to it during the installation.
You can install the File System Agent using either the CommCell Console or the installation package created by the Download Manager. Any item that applies to only one of these installation methods is noted.
Commvault Package to Install
-
For installations using the CommCell Console, install the File System package, which is under the File System category.
-
For installations using the installation package, install the File System package.
Note
By default, regardless of the installation method, the File System Core package is automatically included in the installation.
For installations on Linux clients that will also serve as a proxy to an OpenVMS client or an IBM i client, also install the File System for OpenVMS package or the File System for IBM i package respectively.
Installation Directory
- By default, the software binaries are installed in /opt/commvault.
You can change the directory to a different local directory or to an NFS share. If you decide to use an NFS share, make sure that it is always mounted and accessible by the Commvault software.
Client Computer Details
-
For installations using the CommCell Console:
Collect the host name (fully qualified domain name) of the computers on which you want to install the software. You also need an administrative account that has access to all the computers. The account details are not required for existing clients.
-
For installations using the installation package:
By default, the installation program uses the local (NetBIOS) name of the computer to configure the client name in the CommServe database as well as the display name in the CommCell Console. Optionally, you can use a different display name to represent the client. Do not include spaces in the name.
The installation program also uses the default network interface name (host name) of the computer to communicate with the CommServe computer. If the computer has multiple network interfaces, select the interface name to use.
Log Directory
By default, all Commvault logs are stored in /var/log/commvault/Log_Files.
You can change the directory, but it must be a local directory or an NFS share with at least 100 MB of free space.
UNIX Group
We recommend that you assign a dedicated UNIX group for all Commvault processes. Users associated to that group are granted access rights over Commvault configuration files, registry, and log files. If you do not assign a group, you must set access permissions for other users during the installation. Only the root group has all access rights by default.
If you plan to install a database agent (for example, Oracle), assign the UNIX group that is used by the database application, and add the database users to the group. The group grants access rights for both Commvault and database application processes.
Access Permissions for the UNIX Group and Other Computer Users
If you do not assign a dedicated UNIX group, you must set sufficient access permissions for other users (other than root users) during the installation. By default, read and execute permissions are granted to other users during installations from the installation package, and read, write, and execute permissions during installations from the CommCell Console.
If you do assign a dedicated UNIX group, you will be able to set the access permissions for the group. By default, read, write, and execute permissions are granted to the UNIX group.
Note
For installations on AIX computers and for 32-bit installations, grant read permissions for other users to ensure that services are started when the installation completes.
Review the writable permissions to other (world) computer users if the last two digits of file permissions are 2, 3, 6, or 7, for potential security vulnerability.
System Configuration Files and Number of Streams on Macintosh
Gather the following details of the Macintosh computer:
-
Determine the number of streams that you will run at the same time to ensure that there are enough semaphores and shared memory configured in the system.
-
For installations using the installation package, verify whether the /etc/sysctl.conf and /boot/loader.conf configuration files can be modified. The installation program makes changes to these files if not enough shared memory and semaphores are available for Commvault processes.
CVD Port for CommCell Communication
By default, CVD uses port number 8400. If the port number is used by other applications, or if you plan to install a new Commvault instance, select a port number that is between 1024 and 65535.
Configure for Laptop or Desktop Backup
- If you configure the agent for laptop backup, access to the CommCell Console is not required, since backup operations can be performed from the Web Console. For more information, see Edge Endpoint Solutions for End-Users.
This configuration also triggers the installation of the Edge Monitor tool, so that end-users can view the backup job summary of their laptop computer. For more information, see EdgeMonitor.
Firewall Services
-
If there is a firewall between the client computer and the CommServe computer, gather the following information based on your firewall setup:
-
Client connects to the CommServe computer (One-Way Firewall)
Select an HTTP or HTTPS port number that can be used to open tunnel connections to the CommServe computer.
If the client is separated from the CommServe computer by an HTTP proxy, collect the host name (or IP address) and the port number of the HTTP proxy through which the CommServe computer can be reached.
-
CommServe computer connects to the client (One-Way Firewall)
Select a local HTTP or HTTPS port number that can be used by the CommServe computer to open tunnel connections towards the client.
-
CommServe computer can be reached only through a Proxy
Collect the following information:
-
Client name of the Commvault proxy (name is case-sensitive).
-
HTTP or HTTPS tunnel port number on which the proxy expects connections.
If the CommServe computer is behind a port-forwarding gateway, collect the port number of the gateway instead.
-
Host name or IP address of the proxy through which the CommServe computer can be reached.
If the CommServe computer is behind a port-forwarding gateway, collect the host name or IP address of the gateway instead.
Note
If the client is separated from the CommServe computer by an HTTP proxy, collect the host name (or IP address) and the port number of the HTTP proxy through which the CommServe computer can be reached.
-
-
Other Firewall Setups
The following firewall setups share the same preparation requirements as those listed under Client Connects to the CommServe Computer:
- Two-way firewall, where the client and CommServe computer connect to each other.
Port-forwarding gateway, where the gateway forwards incoming connections on specific ports.
CommServe Host Name
- Record the host name of the CommServe computer (fully qualified domain name or IP address.) The CommServe host name cannot include spaces or any of the following characters:
\|`~!@#$%^&*()+=<>/?,[]{}:;'"
Note: If there is a firewall between the client computer and the CommServe computer, you also need to record the name of the CommServe client, as seen in the CommCell Browser (the name is case-sensitive). The installation program requires this information for all firewall setups, except for environments where only the CommServe can connect to the client.
Client Certificates
- This information is only applicable to installations using the installation package.
If the CommCell environment is in "lockdown" mode, create a temporary certificate to authenticate the client installation. For more information, see Create a Temporary Certificate for Client Installation.
Note that installations using the CommCell Console are not supported when the CommCell is in "lockdown" mode.
Client Groups
- If you want the computer to share the same properties of a client group, and client groups are configured in your CommCell environment, select a client group to use.
For more information on client groups, see Client Computer Groups.
Subclient Policy
- If you have subclient policies configured in your CommCell environment, select a policy to associate to the default subclient.
For more information on subclient policies, see Subclient Policies - Getting Started.
Storage policy
- If you have storage policies configured in your CommCell environment, select a policy to associate to the default subclient.
If you plan to create a new storage policy for the agent to be installed, see Storage Policy - Getting Started for instructions.