Install the SharePoint Server iDataAgent

Click on a link below to go to a specific section of the software installation:

Install Requirements
The MS SharePoint Server iDataAgent is installed on a Microsoft Office SharePoint Server (Front-End Web Server only) or Windows SharePoint Services computer. The machine on which the MS SharePoint Server iDataAgent is installed is referred to as the Client computer in this install procedure.

Verify that the computer in which you wish to install the software satisfies the minimum system requirements; refer to System Requirements - Microsoft SharePoint iDataAgent and System Requirements - Microsoft Windows File System iDataAgent.

The following procedure describes the steps involved in installing the Windows File System and SharePoint Server iDataAgent. If you choose to install additional components simultaneously, refer to the appropriate procedures for installation requirements and steps specific to the component.

Review the following Install Requirements before installing the software:

General

  • Agents should be installed only after the CommServe and at least one MediaAgent have been. Also, keep in mind that the CommServe® software and MediaAgent must be installed and running (but not necessarily on the same computer), before you can install the Agent.
  • This software should be installed in a CommCell component with current versions of the CommServe Server and MediaAgent software.
  • Close all applications and disable any programs that run automatically, including anti-virus, screen savers and operating system utilities. Some of the programs, including many anti-virus programs, may be running as a service. Stop and disable such services before you begin. You can re-enable them after the installation.
  • Ensure there is an available license on the CommServe software for the Agent.
  • Verify that you have the software installation disc that is appropriate to the destination computer’s operating system.
    Make sure that you have the latest software installation disc before you start to install the software. If you are not sure, contact your software provider.

Firewall

  • If the CommServe® Server, MediaAgent and/or Clients communicate across two-way firewall(s):
    • Ensure port 8400 is allowed connections through the firewall.
    • In addition a range of bi-directional ports (consecutive or discrete) must also be allowed connections through the firewall.

     For information on configuring the range of ports, see Port Requirements for Two-way Firewall.

  • If the CommServe Server, MediaAgent and/or Clients communicate across one-way firewall(s):
    • Identify a range of outbound ports (consecutive or discrete) for use by the software.

     For information on configuring the range of ports, see Port Requirements for One-way Firewall.

  • If the MediaAgent/Client communicates with the CommServe Server across a one-way firewall, you must add the MediaAgent/Client host name (or the IP address) in the CommServe computer before installing the necessary software on the MediaAgent/Client computer.

Multi Instancing

  • By utilizing the Multi Instancing feature, the same Agent and MediaAgent software can be installed on a computer multiple times, but not all components support Multi Instancing. This limitation can apply to the component you are installing, or to one already installed on the computer. Prior to installing multiple instances of a software component on the same computer, carefully review the information contained in Multi Instancing, and follow the instructions in the How to Use Multi Instancing section for the additional screens that will appear during the installation process.

Agent Specific

  • If the SharePoint Server iDataAgent is installed on the same machine as the CommServe, Media Agent, or File Archiver for Windows, ensure that all services are running under the same SharePoint Administration Account that is specified below.
  • If the SharePoint Server iDataAgent is installed on the same machine as Microsoft Office SharePoint Portal Server 2003, all servers in the server farm will be upgraded to Microsoft .NET Framework version 2.0.
  • The SharePoint Server iDataAgent should be installed only on a Front End Web Server. If the farm contains more than one Front End Web Server, then the SharePoint Server iDataAgent must be installed on all of them.
  • The configuration and topology of any server farm must be one that is supported by SharePoint Server.
  • In a SharePoint server farm (i.e., where SQL Server runs on a remote machine), the SQL Server iDataAgent must be installed on the SQL Server machine.
  • If the Single Sign-on Service is configured in the SharePoint server farm then the SharePoint Server iDataAgent can be installed on the job server.

Install Checklist
Collect the following information before installing the software. Use the space provided to record the information, and retain this information in your Disaster Recovery binder.
1. Install folder location:________________________________________________________________

See Select Components for Installation for more information.
2. If the CommServe Server and the client computer communicate across a firewall:

Firewall ports: ______________________________________________________________________

Hostnames and/or IP Addresses and corresponding GxCVD port numbers of computers on the other side of the firewall:______________

Keep Alive Interval minutes:____________________________________________________________

Hostname for outgoing tunnel connections:_________________________________________________

Tunnel Initialization Interval seconds:_____________________________________________________

See Firewall Configuration for more information.
3. CommServe Host Name or the CommServe IP address:______________________________________

See Configuration of Other Installation Options for more information.
4. Client computer's Host name (NetBIOS name) or IP address____________________________________

See Configuration of Other Installation Options for more information.
5. Job result folder location:________________________________________________________________

If necessary, Name and Password for the specified folder:_______________________________________

See Configuration of Other Installation Options for more information.
6. Client Group to which this Client will be associated:_____________________________________________

See Client Group Selection for more information.
7. Storage Policy used by the default subclient:________________________________________________

See Storage Policy Selection for more information.

8. SharePoint Server Name:_____________________________________________________________

See SharePoint Server Information for more information.
9.

Administrative Group Account / iDataAgent Account:_________________________________________

Account Password:______________________________________________________________________

See SharePoint Administration Account for more information.
10. Time and frequency for Install of Automatic Updates:_________________________________________

See Schedule Automatic Update for more information.
11. (Database Backup Sets only)

Index Backup/Restore path:_______________________________________________________________

See Post-Install Considerations for more information.
   

Before You Begin
  • Log on to the client as local Administrator or as a member of the Administrators group on that computer.

Install Procedure

Getting Started
1. Place the software installation disc for the Windows platform into the disc drive.

After a few seconds, the installation program is launched.

If the installation program does not launch automatically:

  • Click the Start button on the Windows task bar, and then click Run.
  • Browse to the installation disc drive, select Setup.exe, click Open, then click OK.

NOTES

  • If you are installing on a x64 version of Windows 2008 Server Core R2, go to the AMD64 folder and run Setup.exe.
  
2. In this screen, you choose the language you want to use during installation. Click the down arrow, select the desired language from the pull-down list, and click Next to continue.  
3. Select the option to install software.

NOTES

  
4. Select the option to install software on this computer.

NOTES

  • The options that appear on this screen depend on the computer in which the software is being installed.
  
5. Read the Welcome screen.

Click Next to continue, if no other applications are running.

  
6. Read the virus scanning software warning.

Click OK to continue, if virus scanning software is disabled.

  
7. Read the license agreement, then select I accept the terms in the license agreement.

Click Next to continue.

 

Select Components for Installation
8. Select the component(s) to install.

NOTES

  • Your screen may look different from the example shown.
  • Components that either have already been installed, or which cannot be installed, will be dimmed. Hover over the component for additional details.
  • The Special Registry Keys In Use field will be enabled when GalaxyInstallerFlags registry keys have been enabled on this computer. Hover over the field to see which keys have been set, as well as their values. For more information, see Registry Keys.

Click Next to continue.

To install the Microsoft SharePoint Server iDataAgent, expand the Client Modules folder, the iDataAgents folder, and select:

  • SharePoint iDataAgent

When you select the SharePoint Server iDataAgent for install, the appropriate Windows File System iDataAgent is automatically selected for install.
note.gif (292 bytes) The install program checks your Windows user account for the following necessary operating system rights:
  • Right to increase quotas (this is referred to as adjust memory quotas for a process on Windows Server 2003).
  • Right to act as a part of the operating system.
  • Right to replace a process level token.
9. Specify the location where you want to install the software.

NOTES

  • Do not install the software to a mapped network drive.
  • Do not use the following characters when specifying the destination path:
     / : * ? " < > |
    It is recommended that you use alphanumeric characters only.
  • If you intend to install other components on this computer, the selected installation directory will be automatically used for that software as well.
  • If a component has already been installed, this screen may not be displayed if the installer can use the same install location as previously used.

  • If you intend to use the SnapProtect™  feature for Windows File System iDataAgent, the agent should be installed on a non-system drive and not a filer volume.

Click Browse to change directories.

Click Next to continue.

Firewall Configuration
10. Select from the following:
  • If this Client communicates with the CommServe Server and/or MediaAgent across a firewall, select Yes, configure firewall services, and then click Next to continue. Proceed to the next Step.
  • If firewall configuration is not required, click No, do not configure firewall services and then click Next to continue. Proceed to the next section.

NOTES

  • Operating systems, such as Windows 2008 and Windows Vista, may have more than one profile present. When you select No to configure firewall services, verify that firewall settings are not enabled in the profile(s).
  • If the system detects firewall settings are present in the profile(s), you must select from the following:
    • Disable firewall for ALL profiles: Employ caution when choosing this option; firewall settings will be disabled in all profiles. This requires a system reboot; installation automatically resumes after reboot.
    • No, Firewall is not enabled: Select this option if your firewall settings allow communication with the CommServe computer.
      Click Back to configure firewall services.
11. Click the Specify list of machine across the firewall option and then specify the list of hosts separated from this computer by a firewall. Make sure you correctly describe whether the firewall allows two-way communication (but on a limited range of ports), or one-way communication (with either only remote host being able to make connections to this computer, or vice versa).

For all one-way firewalls allowing incoming connections and those one-way firewalls allowing outgoing connections without additional port filtering, skip this step.

Click Next to continue.

NOTES

  • Consider the following:
    • On the CommServe Server, this list should include all the MediaAgents and Clients that are on the other side of the firewall.
    • On the MediaAgents/Clients this should include the CommServe computer, and any other Clients/MediaAgents on the other side of the firewall with which communications will be established.
  • For each machine on the other side of the firewall that you want to configure, choose the type of firewall configuration based on the firewall setup in your environment. Choose from the following options:
    • Click on 2-way firewall if you can open certain ports as bi-directional ports.
    • Click 1-way firewall; host is reachable from this machine on the machine that is on the secure side of the firewall.
    • Click 1-way firewall; host is NOT reachable from this machine on the machine that is on the public / DMZ side of the firewall.
  • If you wish to communicate with computers in a clustered environment, ensure that you add the Host Name/IP Address of all physical nodes in the cluster (even if no CommCell components are installed) and all the virtual nodes in which CommCell components are installed.
  • Type the host name or the IP address and the GxCVD port number of the host name, and click Add to place it in the Host Name/IP Address List.
12. Click the Specify list of restricted open ports option and then specify the port range. Add the starting and ending port range and then click Add to place it in the Open Port List. Repeat as needed.

If firewall separating this computer from others allows incoming connections, but these connections can be made only on a limited set of ports, then configure the appropriate port range here. For all other scenarios, skip this step.

Note that if you do not specify hostname(s) as well as port number(s), then the firewall services will not be configured.

NOTES

  • Typically in a two-way firewall, the open ports must be indicated for all computers. In a one-way firewall, the ports must be specified on computers in the open side, if they are open in a restricted way. Note that the port ranges are not required for computers that are fully closed in the one-way firewall. For example, laptops which are configured as clients in the Workstation Backup Agent.
  • In a clustered environment, make sure the firewall ports specified here are open for communication on all the physical nodes as well as the virtual nodes.

Click Next to continue.
13. If desired, modify the Keep Alive interval.

Click Next to continue.
14. Optionally, select Advanced Firewall Configuration and specify a local host name interface to use for outgoing tunnel connections through the firewall. Otherwise, the interface and port is automatically selected for you by the OS.

Click Next to continue.
15. If desired, modify the Tunnel Initialization interval.

Click Next to continue.

Configuration of Other Installation Options
16. Enter the fully qualified domain name of the CommServe computer. (TCP/IP network name. e.g., computer.company.com)

NOTES

  • Do not use spaces when specifying a new name for the CommServe Host Name.
  • If a component has already been installed, this screen will not be displayed; instead, the installer will use the same Server Name as previously specified.

Click Next to continue.
17. Enter the username and password information for an external domain user account or a CommCell user account. This authorizes the installation of an agent on the CommCell.

NOTES

  • This window is only displayed when the Require Authentication for Agent Installation option is selected in the CommCell Properties. Users must belong to a User Group with Administrative Management capabilities to enable this feature. For more information, see Authentication for Agent Installs.

Click Next to continue.
18. Enter the following:
  • The local (NetBIOS) name of the client computer.
  • The TCP/IP IP host name of the NIC that the client computer must use to communicate with the CommServe Server.

NOTES

  • Do not use spaces when specifying a new name for the Client.
  • The default network interface name of the client computer is displayed if the computer has only one network interface. If the computer has multiple network interfaces, enter the interface name that is preferred for communication with the CommServe Server.
  • If a component has already been installed, this screen will not be displayed; instead, the install program will use the same name as previously specified.

Click Next to continue.
19. Specify the following and click Next to continue:
  • Type the location of the client's job results directory, or click Browse.

NOTES

  • The Agent uses the job results directory to store the client's backup and restore job results.

Client Group Selection
20. Select a Client Group from the list.

Click Next to continue.

NOTES

  • This screen will be displayed only if Client Groups are configured in the CommCell Console. For more information, see Client Computer Groups.

Storage Policy Selection
21. Select the storage policy through which you want to back up/archive the indicated component (subclient, instance, etc.)

NOTES

  • A storage policy directs backup data to a media library. Each library has a default storage policy.
  • When you install an Agent, the install program creates a default subclient for most Agents.
  • If desired, you can change your storage policy selection at any time after you have installed the client software.
  • If applicable, enable Global Filters for the default subclient.
  • If this screen appears more than once, it is because you have selected multiple agents for installation and are configuring storage policy association for each of the installed agents.

Click Next to continue.

SharePoint Server Information
22. You are prompted for the Microsoft SharePoint Server name. The computer name is displayed by default; if this is not correct, enter the correct name.

Click Next to continue.

SharePoint Administration Account
23. Enter the User Name and Password for the SharePoint Administration Account.

Click Next to continue.

NOTES

  • The Base Services of the client will run under the user account that is specified. Use an account that meets this criteria:

    • member of the local Administrator Group
    • member of the SharePoint Administrator Group
    • System Administrator role on the SQL Server Instance

    In addition, this account must have "Log on as Service" permissions to ensure the Communication (CVD) Services will start. For more information on Base and Communication (CVD) Services, see Services.

    Refer to the Knowledge Base article, ID #10573, Galaxy Service Account User Information for Windows 2003 and Window Server 2003 clients available from the Maintenance Advantage web site.

  • When installing the SharePoint Server iDataAgent on a job server, the user account entered through this screen must have administrative privileges to the Single Sign-On Service.

See the SharePoint Agents section in User Accounts and Passwords for more information.

Download and Install Latest Packs
24. Select Download Pack(s) and Install to download and install the latest service packs and post packs from the software provider.

NOTES

  • Internet connectivity is required to download updates.
  • This step is applicable when installing on the first instance.
  • Updates are downloaded to the following directory: 
    <software installation>/Base/Temp/DownloadedPacks    .
    They are launched silently and installed automatically for the first instance.

Click Next to continue.

Verify Summary of Install Options
25. Verify the summary of selected options.

NOTES

  • The Summary on your screen should reflect the components you selected for install, and may look different from the example shown.

Click Next to continue or Back to change any of the options.

The install program now starts copying the software to the computer. This step may take several minutes to complete.

Schedule Automatic Update
26. If necessary, select this option to schedule an automatic installation of software updates.

NOTES

  • Install Updates Schedule allows automatic installation of the necessary software updates on the computer on a single or weekly basis. If you do not select this option, you can schedule these updates later from the CommCell Console.
  • To avoid conflict, do not schedule the automatic installation of software updates to occur at the same time as the automatic FTP downloading of software updates.
  • You may be prompted to reboot the computer before restarting services.

  • If a component has already been installed, this screen will not be displayed; instead, the installer will use the same option as previously specified.

Click Next to continue.

Setup Complete
27. Click Next to continue.

NOTES

  • Schedules help ensure that the data protection operations for the Agent are automatically performed on a regular basis without user intervention. For more information, see Scheduling.
28. Setup displays the successfully installed components.

NOTES

  • The Setup Complete message displayed on your screen will reflect the components you installed, and may look different from the example shown.
  • If you install an Agent with the CommCell Console open, you need to refresh the CommCell Console (F5) to see the new Agents.
  • If Reboot Now button is displayed make sure to reboot the computer before performing any other operations from the computer.

Click Finish to close the install program.

The installation is now complete.

Post-Install Considerations

General

  • Install post-release updates or Service Packs that may have been released after the release of the software. If you are installing a Service Pack, verify and ensure that it is the same version as the one installed in the CommServe Server. Alternatively, you can enable Automatic Updates for quick and easy installation of updates in the CommCell component.
  • After installing the Agent, you may want to configure the Agent before running a data protection operation. The following list includes some of the most common features that can be configured:
    • Configure your subclients - see Subclients for more information.
    • Schedule your data protection operations - see Scheduling for more information.
    • Configure Alerts - See Alerts and Monitoring for more information.
    • Schedule Reports - See Reports for more information.

The software provides many more features that you will find useful. See the Index for a complete list of supported features.

Agent Specific

  • In a SharePoint environment with more than 500 site collections, it is recommended to increase the size and number of log files with the <logfile>_MaxLogFileSize  and <logfile>_MaxLogFileBackups registry keys. Replace <logfile> with any desired name (e.g., SPDBBackup, SPDocBackup, SPDocArchive, etc.).

  • Remote/ Silent/ Decoupled Installation

    After completing a remote or decoupled installation of a SharePoint Agent, you must manually enter a SharePoint Server Name and SharePoint Administrator Account in the Agent's Properties dialog box. For step-by-step instructions on accounts, see Change Account for Accessing Application Servers/Filers.

  • SharePoint Server

    • If the SharePoint Server is configured to use the Single Sign-on Service, then the administrator account for this service must be entered in the SharePoint Server iDataAgent properties before any backups are run. Perform the following steps:
      1. From the CommCell Console, right-click the SharePoint Server iDataAgent, and select Properties.
      2. In the iDataAgent Properties, click the Change Account button for the SSO Account, and enter the Single Sign-on Account name and password.
    • The following information is not backed up by the system, and must be recorded for use in the event a Full System Restore is required:
      • E-Mail Server Settings
      • Anti-virus Settings
      • Blocked File Types
      • Logging Settings
      • HTML Viewer
      • Usage Analysis Processing
      • Shared Services (SharePoint 2003)

      Record this information and store it in a safe place, as part of your disaster recovery planning. For more information about Full System Restore, refer to Restore Data - SharePoint Server iDataAgents - Full System Restore.

    • In an environment where two different versions of SharePoint Server (e.g., 2003 and 2007) co-exist on the same client with the SharePoint Server iDataAgent, an additional Database type backup set should be created to backup SharePoint Database components for other version.

  • SharePoint Server Farms

    • For SharePoint server farms only (i.e., where SQL Server runs on a remote machine), perform the following steps.
      1. From the CommCell Console, right-click the SharePoint Server iDataAgent, and select Properties.
      2. In the General tab of the iDataAgent Properties, select SQL Databases hosted on a remote SQL Server.

      You must install the Windows and SQL iDataAgents on the remote SQL Server to protect its data; the SharePoint iDataAgent will not do so. Ensure that backups of the SharePoint Server and the remote SQL Server are scheduled to run at about the same time.

    • For medium to large SharePoint Server 2003 farms, create a folder on a machine with enough disk space to temporarily store the Portal Site Index for the farm during backup and restore operations, as well as job results information, and share this folder on the network. (The Services account used by the software, the Front End Web Server, and the Portal Site Index server must all be able to access this folder.) Perform the following steps:
      1. From the CommCell Console, right-click the SharePoint Server iDataAgent, and select Properties.
      2. In the General tab of the iDataAgent Properties, in the Index Backup/Restore field, type the path to the folder you just created.

Disaster Recovery Considerations

  • Before you use your agent, be sure to review and understand the associated full system restore (or disaster recovery) procedure. The procedure for some agents may require that you plan specific actions or consider certain items before an emergency occurs.  See Disaster Recovery for more information regarding your agent.