Loading...

Preinstallation Checklist for the Windows File System Agent

The File System Agent protects and restores the file system data on Windows computers. You can also configure the agent to incorporate archiving and snap management solutions. For more information, see Overview - Windows File System Agent.

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 ability to perform laptop backups and restores.

File System Provides advanced features to protect the file system data, which include:
  • All backup and restore capabilities, such as SnapProtect backups.
  • Ability to generate Discovery and File Level Analytics reports.
  • Ability to perform 1-Touch and OnePass operations.

Use this preinstallation checklist to prepare the computer where the File System Agent will be installed and to gather all of the information you will need during the installation.

  • 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 more information, see License Requirements - Windows File System Agent

    If you plan to use the OnePass solution, review the license information in License Requirements - OnePass for Windows File System.

    Remember: The File System Agent is a dependency for most agents. If required by an agent, the File System Agent is installed automatically without consuming any license.

  • Determine the Installation Location

    Based on your environment, install the File System Agent on the appropriate computer.

    Environment Where to install the software
    Non-Clustered On the computer that you want to back up.
    Clustered On all physical nodes of the cluster.
  • 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.

    SnapProtect package to install
    Install the File System package, which is listed under the Microsoft Windows category.

    Regardless of the installation method, the File System Core package is automatically included in the installation.

    Destination folder for the software installation
    By default, the software is installed in C:\Program Files\##_DOC_OEM_INSTALL_DESTINATION_COMPANY_FOLDER_##\SnapProtect.

    You can change the destination folder, but it cannot be on a mapped network drive.

    The installation program uses the C:\%allusersprofile% folder as a temporary location to copy the installation files. This location does not change, even if you choose to install the software on a drive other than C:.

    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 SnapProtect instance, select a port number that is between 1024 and 65000.
    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 SnapProtect 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.

      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.
    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.
    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:

    \|`~!@#$%^&*()+=<>/?,[]{}:;'" 

    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 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.

    Windows Firewall for Computer Profiles
    This information is only applicable to installations using the installation package.

    If Windows Firewall is enabled for some profiles (PublicProfile, DomainProfile, and StandardProfile), decide whether you want to disable Windows Firewall for all profiles.

    Windows Firewall Exclusion List
    If the computer has Windows Firewall turned on, you can add the SnapProtect programs and services to the Windows Firewall exclusion list during the installation. We recommend this configuration which enables CommCell operations across the firewall.
    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.

    Configure for laptop 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 Overview - End-User Operations.

    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 Edge Monitor.

    By default, the installation program creates a shortcut to access the Edge Monitor tool. If you decide not to create the shortcut, the tool can be accessed from the Installation_Directory/Base folder, by double-clicking Laptop2Taskbaricon.exe.