Deployment - SharePoint Server iDataAgent

Overview Deployment Configuration Decision

Where to Install

On the SharePoint farm, install the software on the Application Server with Search Service Application. The Application Server should have the same custom configurations as that of the Front End Web Servers.

The computer will be added as a client in the CommCell as soon as the installation completes successfully.

Planning Your Installation

The software installation may require a system reboot if a pending rename operation from a previously installed application is found in the operating system, hence, plan your installation at a convenient time.

Prerequisites

Accounts Permissions Required
User account (generally the domain account) selected during the SharePoint Server Agent installation which is used to run Communications Service (GxCVD) and Client Event Manager (GxEvMgrC).
  • Local administrative rights
  • FARM administrator rights
  • Full permission to SnapProtect registry key
  • SP Shell administrator permissions
  • Full control under Policy for Web Application for every Web Application
  • SQL System Admin Server Role for the instance where SharePoint Databases resides
  • Site Administrator permissions for all Site Collections
SnapProtect Services account Full permissions to the Job Results and Log Files folders.
SQL Server Services account for the SharePoint instance Full permissions to the Job Results and Log Files folders.
SharePoint Services Timer account Full permissions to the Job Results and Log Files folders.
All Web Application Pools accounts Full permissions to the Job Results and Log Files folders.

SnapProtect services account, also known as the SharePoint Administrator account, is used to run the SharePoint backup operation.

Run CVSPCompatibilityCheck tool to ensure that all the above mentioned permissions are set properly. For detailed information, see KB article SP0001.

Ensure to meet the following prerequisites before running the CVSPCompatibilityCheck tool:

  • SnapProtect services account must be a member of the local administrators group.
  • Log in to the SharePoint server as a SnapProtect service account user to run this tool.

    Add-SPShellAdmin -username DOMAIN\YourUser

  • Restart the SnapProtect services account to update service account information after assigning permissions, else it will use old information in the cache.
  • Use the same user account to run the SQL agent and the SQL server account.
  • SnapProtect user should be a sysadmin user on the SQL server where the configuration database resides.

Before You Begin

System Requirements

Verify that the computer in which you wish to install the software satisfies the minimum requirements specified in System Requirements.


Download Software Packages

Download the latest SnapProtect® software using the Download Manager application. The Download Manager bundles an installation package from the SnapProtect components that you chose to download. Use the installation package to launch the software installer on a client computer.

See Download Manager - Getting Started for instructions on creating an installation package.

Installation

The software can be installed using one of the following methods:

Method 1: Remote Installation Using CommCell Console

Use this procedure to install remotely on a client computer.

Method 2: Interactive Installation - Standard

Use this procedure to directly install the software from the installation package or a network drive.

Method 3: Interactive Installation - Custom

Use this procedure to install the software by specifying installation settings and options.

Method 1: Remote Installation Using CommCell Console

To install software from the CommCell Console:

  1. Open CommCell Console:

    • Click Start and point to All Programs.
    • Click NetApp .
    • Click SnapProtect  Administrative Console.
  2. From the CommCell Browser, click Tools | Add/Remove Software | Install Software.

  3. Click Next.

  4. Click Next.

  5. Click Manually Select Computers.

    Click Next.

  6. Enter the fully qualified domain name of the client computer.

    For example: mycomputer.mydomain.mycompany.com

    Click Next.

    • Do not use space and the following characters when specifying the Host Name:

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

  7. Choose one of  the following:

    • Click Next if you want to use the default cache location
    • Click Override Software Cache and specify a new location in the Software Cache box and then click Next

    • The software cache is the location from where the remote install program installs the software.
    • This screen will not appear if the remote cache is not configured. For more information, see Managing Cache - Remote Cache.

  8. Specify the User Name and Password that must be used to access the client computer, and then click Next.

    • The user must be an Administrator or a member of the Administrator group on that computer.
    • Account information is required while performing remote installs for the first time on a client. For subsequent remote installs on that client, click Next without specifying the account information.

  9. Click SharePoint iDataAgent.

    Click Next

  10. Select the following:

    • Select a client group from the available Client Groups, and then click Add.
    • From the Global Filters list, select one of the following:
      • Use Cell level Policy to inherit the global filter policy configuration set for the CommCell.
      • Always use Global Filters to apply the global filters policy to the default subclient regardless of the policy set for the CommCell.
      • Do not use Global Filters if you plan to define specific filters for the Agent.
    • From the Storage Policy To Use list, select a storage policy.
    • Click Next.

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

  11. In the Server Name box, enter the name of the SharePoint Server.

    Click Change.

  12. Type the login credentials for the SharePoint Farm Administrator and click OK.

  13. Click Next.

  14. Click Next.

    If necessary you can select additional options. Click the Help button to get more information on the available options.

  15. Click Next.

    If necessary you can select additional options. Click the Help button to get more information on the available options.

  16. Select one of the following:

    • If firewall configuration is not required, click Next.
    • If this computer and the CommServe is separated by a firewall, click Configure firewall services.

    For firewall options and configuration instructions, see Firewall Configuration and continue with the installation.

  17. Select Immediate.

    Click Next.

  18. Click Finish.

    This screen will reflect the components you selected for install, and may look different from the example shown.

  19. You can track the progress of the job from the Job Controller window of the CommCell console.
    • From the Home menu, click Job Controller.

    • Once the job is complete, view the job details from the Admin Job History.

      • Right-click the <CommServe>, point to View and then click Admin Job History.
      • Click Select Install/Upgrade/Remove/Repair Software.
      • Click OK.

    • You can view the following by right-clicking the job:
      • Details of the job
      • Option to Resubmit the job
      • Events associated with the job
      • Logs associated with the job
      • Option to send the Logs associated with the job

  20. To create a storage policy, you must have configured a library in the CommCell.

    Disk Library Creation

    1. From the CommCell Browser, navigate to Storage Resources, right-click the Libraries, point to Add and then click Disk Library...

      Alternatively, you can also navigate to MediaAgents, right-click <MediaAgent>, point to All Tasks | Create Library and then click Disk Library...

    2. From the Add Disk Library dialog box, specify the following:
      • In the Name box, specify name of the disk library.
      • From the MediaAgent list, select the MediaAgent.

      Perform one of the following:

      • Select Local Path if you wish to specify a local path in the MediaAgent computer.

        In the Disk Device box, type the name of the folder in which the disk library must located or click button to select the folder.

      • Select Network Path, if you wish to specify a network path as the target share.

        In the Connect As box, type the user name.

        In the Password and Verify Password box, type the password to access the network share.

        In the Folder box, type the mount path or click button to select a mount path.

      • Click OK.
    3. The newly created disk library will be displayed under Libraries node.

    This will create a library and Storage Policy. Proceed to the next page.

    Storage Policy Creation

    1. From the CommCell Browser, navigate to Policies.
    2. Right-click the Storage Policies and then click New Storage Policy.
    3. Follow the prompts displayed in the Storage Policy Wizard. The required options are mentioned below:
      • Select the Storage Policy type as Data Protection and Archiving and click Next.
      • Enter the name in the Storage Policy Name box and click Next.
      • From the Library list, click the name of a disk library to which the primary copy should be associated and then click Next.

        Ensure that you select a library attached to a MediaAgent operating in the current release.

      • From the MediaAgent list, click the name of a MediaAgent that will be used to create the primary copy and then click Next.
      • For the device streams and the retention criteria information, click Next to accept default values.
      • Review the details and click Finish to create the Storage Policy.

    This will create a storage policy. Proceed to the next page.

Several additional options are available for remotely installing the software from CommCell Console, refer to Install Software from the CommCell Console (Remote Install) for more information.

Method 2: Interactive Installation - Standard

  1. Log on to the client computer as an Administrator or as a member of the Administrator group on that computer.
  2. Run SetupAll.exe from the installation package that was created using the Download Manager.
  3. Click I accept the terms in the license agreement.

    Click Next.

  4. Click Standard.

    Click Next.

  5. Click Join an Existing CommCell.

    Click Next.

  6. Click SharePoint.

    Click Next.

  7. Verify the default location for software installation.

    Click Next.

    If necessary, click Browse... to change the default location.

    • 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

  8. Click Install.

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

  9. Click Yes.

  10. Click Reboot Now.

  11. Select Resume Unfinished Installation and click Next.

  12. Click Next.

  13. Select one of the following:

    • If firewall configuration is not required, click Next.
    • If this computer and the CommServe is separated by a firewall, click Configure firewall services.

    For firewall options and configuration instructions, see Firewall Configuration and continue with the installation.

  14. Enter the fully qualified domain name of the CommServe in the CommServe Host Name box.
    • Do not use space and the following characters when specifying the CommServe Host Name:

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

    Click Next.

  15. Enter the following:
    • The local (NetBIOS) name of the client computer is displayed in the Select a Client name list.

      If necessary you can also type a new (friendly) name for the client in this box. This name will be used in the CommCell and will also be displayed in the CommCell Console.

      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 (NIC card).

      If the computer has multiple network interfaces, select the interface name that is preferred for communication with the CommServe.

    Click Next.

    If a component is already installed on this computer, this screen will not be displayed; instead, the install program will use the same name as previously specified.

  16. Select one of the following options:

    • If you do not want to disable Windows Firewall, click Next.
    • If you want to disable Windows Firewall for all profiles, click Yes, disable Windows Firewall for all profiles and then click Next.

    You will get this screen if you did not configure the firewall settings in step 13.

  17. Select a Client Group.
    Click Next.

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

  18. Select a storage policy from the Storage Policy list.

    Click Next.

    • If you do not have a Storage Policy, the list will not be displayed. You can create the Storage Policy later in step 22.
    • Select the Configure for Laptop or Desktop Backup option to install Backup Monitor utility. This utility allows you to view the backup job summary from the client computer without opening the CommCell Console. See Monitor - Laptop User for more information.

  19. Enter the name of the Microsoft SharePoint Server and click Next.

  20. Enter the Administrator account information for the SharePoint Server and click Next.

  21. Click Finish.

    This screen will reflect the components you selected for install, and may look different from the example shown.

  22. If you already have a storage policy selected in step 18, proceed to the next page.

    If you do not have Storage Policy created, continue with the following step.

  23. To create a storage policy, you must have configured a library in the CommCell.

    Disk Library Creation

    1. From the CommCell Browser, navigate to Storage Resources, right-click the Libraries, point to Add and then click Disk Library...

      Alternatively, you can also navigate to MediaAgents, right-click <MediaAgent>, point to All Tasks | Create Library and then click Disk Library...

    2. From the Add Disk Library dialog box, specify the following:
      • In the Name box, specify name of the disk library.
      • From the MediaAgent list, select the MediaAgent.

      Perform one of the following:

      • Select Local Path if you wish to specify a local path in the MediaAgent computer.

        In the Disk Device box, type the name of the folder in which the disk library must located or click button to select the folder.

      • Select Network Path, if you wish to specify a network path as the target share.

        In the Connect As box, type the user name.

        In the Password and Verify Password box, type the password to access the network share.

        In the Folder box, type the mount path or click button to select a mount path.

      • Click OK.
    3. The newly created disk library will be displayed under Libraries node.

    This will create a library and Storage Policy. Proceed to the next page.

    Storage Policy Creation

    1. From the CommCell Browser, navigate to Policies.
    2. Right-click the Storage Policies and then click New Storage Policy.
    3. Follow the prompts displayed in the Storage Policy Wizard. The required options are mentioned below:
      • Select the Storage Policy type as Data Protection and Archiving and click Next.
      • Enter the name in the Storage Policy Name box and click Next.
      • From the Library list, click the name of a disk library to which the primary copy should be associated and then click Next.

        Ensure that you select a library attached to a MediaAgent operating in the current release.

      • From the MediaAgent list, click the name of a MediaAgent that will be used to create the primary copy and then click Next.
      • For the device streams and the retention criteria information, click Next to accept default values.
      • Review the details and click Finish to create the Storage Policy.

    This will create a storage policy. Proceed to the next page.

Default Options Selected during Standard Install

Listed below are the default options that are automatically selected while performing the Standard Install.

Option Enabled or Disabled Description
Add programs to the Windows Firewall Exclusion List Disabled This option allows you to add SnapProtect programs to the Windows Firewall exclusion list.

This option is not selected.

Global Filter Options Enabled This option is used to filter out specific directories or files from the backups within the CommCell. The filters are set using the Control Panel in the CommCell Console and, if enabled, they will be effective for the default subclient.

Cell level policy is automatically selected.

Components Installed by Default during Standard Install

Listed below are the components that are installed by default while performing the Standard Install:

Selected Package Components Installed
SharePoint Agent
  • SharePoint iDataAgent
  • File System Core
  • Windows File System

Method 3: Interactive Installation - Custom

  1. Log on to the client computer as an Administrator or as a member of the Administrator group on that computer.
  2. Run SetupAll.exe from the installation package that was created using the Download Manager.
  3. Click I accept the terms in the license agreement.

    Click Next.

  4. Click Custom.

    Click Next.

  5. Click Select components to install on this computer and click Next.

  6. Expand SharePoint, and then click SharePoint iDataAgent.

    Click Next.

  7. Verify the default location for software installation.

    Click Next.

    If necessary, click Browse... to change the default location.

    • 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

  8. Click Install.

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

  9. Click Yes.

  10. Click Reboot Now.

  11. Select Resume Unfinished Installation and click Next.

  12. Click Next.

  13. Select one of the following:

    • If firewall configuration is not required, click Next.
    • If this computer and the CommServe is separated by a firewall, click Configure firewall services.

    For firewall options and configuration instructions, see Firewall Configuration and continue with the installation.

  14. Enter the fully qualified domain name of the CommServe in the CommServe Host Name box.
    • Do not use space and the following characters when specifying the CommServe Host Name:

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

    Click Next.

  15. Enter the following:
    • The local (NetBIOS) name of the client computer is displayed in the Select a Client name list.

      If necessary you can also type a new (friendly) name for the client in this box. This name will be used in the CommCell and will also be displayed in the CommCell Console.

      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 (NIC card).

      If the computer has multiple network interfaces, select the interface name that is preferred for communication with the CommServe.

    Click Next.

    If a component is already installed on this computer, this screen will not be displayed; instead, the install program will use the same name as previously specified.

  16. Select one of the following options:

    • If you do not want to disable Windows Firewall, click Next.
    • If you want to disable Windows Firewall for all profiles, click Yes, disable Windows Firewall for all profiles and then click Next.

  17. Select Add programs to the Windows Firewall Exclusion List, to add CommCell programs and services to the Windows Firewall Exclusion List.

    Click Next.

    This option enables CommCell operations across Windows firewall by adding CommCell programs and services to Windows firewall exclusion list.

    It is recommended to select this option even if Windows firewall is disabled. This will allow the CommCell programs and services to function if the Windows firewall is enabled at a later time.

  18. Select a Client Group.
    Click Next.

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

  19. Select one of the following:
    • Click Use Cell level Policy to inherit the global filter policy configuration set for the CommCell.
    • Click Always use Global Filters to apply the global filters policy to the default subclient regardless of the policy set for the CommCell.
    • Select Do not use Global Filters if you plan to define specific filters for the Agent.

    Click Next.

  20. Select a storage policy from the Storage Policy list.

    Click Next.

    • If you do not have a Storage Policy, the list will not be displayed. You can create the Storage Policy later in step 24.
    • Select the Configure for Laptop or Desktop Backup option to install Backup Monitor utility. This utility allows you to view the backup job summary from the client computer without opening the CommCell Console. See Monitor - Laptop User for more information.

  21. Enter the name of the Microsoft SharePoint Server and click Next.

  22. Enter the Administrator account information for the SharePoint Server and click Next.

  23. Click Finish.

    This screen will reflect the components you selected for install, and may look different from the example shown.

    If you already have a storage policy selected in step 20, proceed to the next page.

    If you do not have Storage Policy created, continue with the following step.

  24. To create a storage policy, you must have configured a library in the CommCell.

    Disk Library Creation

    1. From the CommCell Browser, navigate to Storage Resources, right-click the Libraries, point to Add and then click Disk Library...

      Alternatively, you can also navigate to MediaAgents, right-click <MediaAgent>, point to All Tasks | Create Library and then click Disk Library...

    2. From the Add Disk Library dialog box, specify the following:
      • In the Name box, specify name of the disk library.
      • From the MediaAgent list, select the MediaAgent.

      Perform one of the following:

      • Select Local Path if you wish to specify a local path in the MediaAgent computer.

        In the Disk Device box, type the name of the folder in which the disk library must located or click button to select the folder.

      • Select Network Path, if you wish to specify a network path as the target share.

        In the Connect As box, type the user name.

        In the Password and Verify Password box, type the password to access the network share.

        In the Folder box, type the mount path or click button to select a mount path.

      • Click OK.
    3. The newly created disk library will be displayed under Libraries node.

    This will create a library and Storage Policy. Proceed to the next page.

    Storage Policy Creation

    1. From the CommCell Browser, navigate to Policies.
    2. Right-click the Storage Policies and then click New Storage Policy.
    3. Follow the prompts displayed in the Storage Policy Wizard. The required options are mentioned below:
      • Select the Storage Policy type as Data Protection and Archiving and click Next.
      • Enter the name in the Storage Policy Name box and click Next.
      • From the Library list, click the name of a disk library to which the primary copy should be associated and then click Next.

        Ensure that you select a library attached to a MediaAgent operating in the current release.

      • From the MediaAgent list, click the name of a MediaAgent that will be used to create the primary copy and then click Next.
      • For the device streams and the retention criteria information, click Next to accept default values.
      • Review the details and click Finish to create the Storage Policy.

    This will create a storage policy. Proceed to the next page.

  25. If you have installed the software on a clustered computer, install the software on all the physical nodes and then configure the cluster group client. For more information, see Cluster Configuration.

Additional Installation Methods

Custom Package

Create a compact software package for quick deployment to multiple clients.

Decoupled Install

Install the software first and later register the client in the CommCell.

Remote Install

Deploy the software from CommCell Console on multiple clients.

Installing Restore only Agents

Setup a client in the CommCell for restore purposes.

Silent Install

Deploy the software silently on multiple clients.