Deploying as a Software Appliance - Factory Setup

Factory Setup User Activation

Overview

Prerequisites

Standard Setup

Silent Install for Software Appliance

Record XML File For Software Appliance

Playback Procedure

Post-Install Considerations

Other Considerations

Overview

Appliancization enables you to present the computer hardware and the data protection software as a single unified solution. Appliancization allows you to install and configure the software modules at the factory, and ship the computer to the user as a software appliance. When the appliance is activated by the user, the software is initiated at the user's environment and the computer is ready for data protection operations.

The software appliance setup can be created on physical as well as virtual computers. Software appliance setup is not supported on clusters.

Prerequisites

Plan your post-install configuration options. You can add additional configurations to the appliance either at the factory, or at the user location.

To add additional configurations at the user location, see Post-Install Considerations.

Standard Setup

This section provides the procedure to setup the appliance with default installation options.

1. Place the Software Installation Disc for the Windows platform into the disc drive. After a few seconds, the installation program is launched.

Click Exit to close the install program.

2. Choose the language you want to use during installation. Click the down arrow and select the desired language from the drop-down list, and click Next to continue.
3. Click the Advanced options.
4. Click Pre-install Appliance Server.
5. Read the license agreement, then select I accept the terms in the license agreement.

Click Next to continue.

6. The following components are pre-selected for install:
  • CommServe
  • CommCell Console
  • CommNet Server
  • CommNet Browser
  • MediaAgent
  • Windows File System iDataAgent

NOTES

  • Your screen may look different from the example shown.
  • The Special Registry Keys In Use field will be highlighted when GalaxyInstallerFlags registry key is enabled. Move the mouse pointer over this field to see a list of registry keys that have been created in this computer.

Click Next to continue.

7. Click YES to install Microsoft .NET Framework package.

NOTES

  • Follow the on-screen prompts for installing the Microsoft .NET Framework package.
  • If you are prompted to install the Service Pack for the Microsoft .NET Framework, click Yes.
  • This prompt is displayed only when Microsoft .NET Framework is not installed.
  • Once the Microsoft .NET Framework is installed, the software automatically installs the Microsoft Visual J# 2.0 package.
8. The System Reboot message may be displayed. If so, select one of the following:
  • Reboot Now
    If this option is displayed without the Skip Reboot option, the install program has found files required by the software that are in use and need to be replaced. If Reboot Now is displayed without the Skip Reboot option, reboot the computer at this point. The install program will automatically continue after the reboot.
  • Exit Setup
    If you want to exit the install program, click Exit Setup.

Set Up Microsoft SQL Server Instance

9. Specify the SQL Server System Administrator password.

NOTES

  • This is the password for the administrator's account created by SQL during the installation.

Click Next to continue.

10. Click Yes to set up a dedicated instance of Microsoft SQL Server for the CommNet Server.

NOTES

  • This prompt will only be displayed if SQL Server database instance is not installed on this computer.
  • Clicking No will exit the install program.
11. Enter the Installation Path for the Database Engine.

NOTES

  • This is the location where you want to setup the Microsoft SQL Server System databases.

Click Browse to change directories.

Click Next to continue.

The install program installs the database instance.

12. Enter the MSSQL Server Installation Path.

NOTES

  • This is the location where you want to install Microsoft SQL Server.

Click Browse to change directories.

Click Next to continue.

This step may take several minutes to complete.

13. Enter the CommServe Client Name and the CommServe Host Name.

NOTES

  • The CommServe client name is the name of the computer.  This field is automatically populated.
  • The CommServe host name is the TCP/IP network interface name of the CommServe computer.  This field is automatically populated.
  • Do not use the following characters in the CommServe client name or the CommServe host name:
    \|`~!@#$%^&*()+=<>/?,[]{}:;'"

Click Next to continue.

14. Select Add programs to the Windows Firewall Exclusion List, if you wish to add CommCell programs and services to the Windows Firewall Exclusion List.

NOTES:

  • If Windows Firewall is enabled on the computer, this option is selected by default and must be enabled to proceed with the installation.
  • If Windows Firewall is disabled on the computer, you can select this option to add the programs and services to enabled CommCell operations across the firewall, if the firewall is enabled at a later time.

    You can either select this option during install or add the programs and services after installation. For adding the programs and services after installation, see Configure Windows Firewall to Allow CommCell Communication.

Click Next to continue.

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

Click Browse to change directories.

Click Next to continue.

16. Specify the location of the database.

NOTES

  • Do not specify a mapped network drive.
  • You can either accept the default or select a different location on a local disk drive. However, you must ensure that the drive has at least 1GB of free space.
  • The directory file path selected should not be located on a FAT drive. A FAT drive cannot be supported as the location for this database because it does not allow a temporary sparse file to be generated when creating the database snapshot, which is required for data verification.
  • If the default metadata database directory is low in disk space, provide a path that is not associated with another application.

Click Browse to change directories.

Click Next to continue.

17. Select the Create a New Database option and click Next to continue.

NOTES

  • This screen may look different from the example shown.
18. Enter the network or local path where Disaster Recovery Backup files should be stored.

NOTES

  • For cluster, specify a shared drive.
  • If you selected Use Network Path, you must enter the Network share username and the Network share password.
    • The Network share username is the domain\username of the user that has administrative rights to the Disaster Recovery Backup destination path.
    • The Network share password is the password of the network share username.

Click Next to continue.

Set User Names and Passwords

19. Enter the CommCell Username and CommCell Password.

NOTES

  • The CommCell username and password will be used by the Administrator user to log on to the CommCell Console.  This user is automatically created during installation and, by default, has the necessary capabilities to perform all functions. Additional CommCell users with the same or less security rights can be created after the installation of the software.

Click Next to continue.

20. Select Setup Software Cache option to download the software updates automatically.

Select Schedule FTP Download of Automatic Updates option to schedule automatic FTP downloading of software updates.

Click Next to continue.

21. Specify the path where the update files from the FTP site should be stored.

NOTES

  • This prompt will only be displayed if the Setup Software Cache option was enabled. 

Click Next to continue.

Schedule Automatic Updates

22. If necessary, select this option to schedule an automatic installation of software updates.

NOTES

  • Schedule Install of Automatic Updates 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.
  • 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.

23. Select Yes to stop Removable Storage Services on the MediaAgent.

NOTES

  • This prompt will not appear if Removable Storage Services are already disabled on the computer.

Click Next to continue.

Setup Complete

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

25. Click Yes to seal the license of the appliance server and continue the installation.

Click No to exit the setup, restart the services, and configure the CommServe using the CommCell Console.

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

Silent Install for Software Appliance

A silent install consists of two distinct phases. In the recording phase, an install is recorded, saving your install options to an .xml file. In the playback phase, the .xml file is played back by the install program, which installs the software with the recorded options without any prompting. Through this method, the deployment of the software can be automated.

Record XML File For Software Appliance

This section provides the steps to record the options for silent install.

1. Place the software installation disc for the Windows platform into the disc drive. After a few seconds, the installation program is launched.

Click Exit to close the install program.

 
2. Choose the language you want to use during installation. Click the down arrow and select the desired language from the drop-down list, and click Next to continue.
3. Select the Advanced options to install software.

NOTES

The options in the installation menu depends on the computer in which the software is being installed, and may look different from the example shown.

4. Select Create a recording of user selections - Record Mode option to start the recording of the install.
5. The install options will be recorded to a file called UserInput.xml which will be located in the C:\Documents and Settings\Company\LogFiles\ folder.

Click Browse to change directories.

Click Next to continue.

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

Click Next to continue.

Select Components for Installation

7. Select CommServe, MediaAgent software by expanding the Common Technology Engine folder and CommServe Modules folder.

The CommNet Server, CommNet Browser, CommCell Console, Java Runtime Environment and Microsoft Windows File System iDataAgent will be selected by default.

NOTES

  • Your screen may look different from the example shown.
  • The Special Registry Keys In Use field will be highlighted when GalaxyInstallerFlags registry key is enabled. Move the mouse pointer over this field to see a list of registry keys that have been created in this computer.

Click Next to continue.

Configuration of Other Installation Options

8. 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 is already installed in this computer, this screen may not be displayed. The software will be automatically installed in the same location that was previously specified.

Click Browse to change directories.

Click Next to continue.

9. Specify the location of the database.

NOTES

  • Do not specify a mapped network drive.
  • You can either accept the default or select a different location on a local disk drive. However, you must ensure that the drive has at least 1GB of free space.
  • The directory file path selected should not be located on a FAT drive. A FAT drive cannot be supported as the location for this database because it does not allow a temporary sparse file to be generated when creating the database snapshot, which is required for data verification.
  • If the default metadata database directory is low in disk space, provide a path that is not associated with another application.

Click Browse to change directories.

Click Next to continue.

10. Enter the network or local path where Disaster Recovery Backup files should be stored.

NOTES

  • For cluster, specify a shared drive.
  • If you selected Use Network Path, you must enter the Network share username and the Network share password.
    • The Network share username is the domain\username of the user that has administrative rights to the Disaster Recovery Backup destination path.
    • The Network share password is the password of the network share username.

Click Next to continue.

Set User Names and Passwords

11. Enter the CommCell Username and CommCell Password.

NOTES

  • The CommCell username and password will be used by the Administrator user to log on to the CommCell Console.  This user is automatically created during installation and, by default, has the necessary capabilities to perform all functions. Additional CommCell users with the same or less security rights can be created after the installation of the software.

Click Next to continue.

12. Select Setup Software Cache option to download the software updates automatically.

Select Schedule FTP Download of Automatic Updates option to schedule automatic FTP downloading of software updates.

Click Next to continue.

13. Schedule to download the latest software updates from the FTP site.

NOTES

  • This screen will appear, when you select the Schedule FTP Download of Automatic Updates option in the above step.
  • Automatic Updates Schedule allows automatic downloading of software updates on a single or weekly basis.
  • If you do not select this option, you can schedule these updates later from the CommCell Console.

Click Next to continue.

14. Specify the path where the update files from the FTP site should be stored.

NOTES

  • This prompt will only be displayed if the Setup Software Cache option was enabled. 

Click Next to continue.

Configure the CommCell® Console for Web-Based Administration

15. Click Yes to configure the CommCell Console for web administration, or Click No to continue without configuring the CommCell Console for web administration.

NOTES

  • The Internet Information Server (IIS) must be installed on this computer in order to configure for web administration.
  • Configuring this computer for web administration allows you to:
    • Access the CommCell Console and Books Online from a remote computer using a Web browser.
    • View CommCell reports via a Web browser.
    • Access Books Online by clicking the Help button (the icon with a ?) in the CommCell Console.

Verify Summary of Install Options

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

Setup Complete

17. Click OK.

This completes the recording.

Playback Procedure

The UserInput.xml file created during the record mode can be edited to meet particular needs, such as using the generated file as a base, and customizing it for many different install.

See XML Input File for Silent Install of Appliance Software for the example of the contents of a default xml input file generated during the record mode of a CommServe and for the list of parameters, the default values and description.

To start the installation, perform the following

  1. Click the Windows Start button, point to Programs, point to Accessories, then click Command Prompt.
  2.  Type the following command:

    QInstaller.exe /Appliance /play "path\filename.xml"

    For example, if you type QInstaller.exe /Appliance /play "C:\Documents and Settings\Company\LogFiles\UserInput.xml", the file called UserInput.xml located in the C:\Documents and Settings\Company\LogFiles\ folder will be played back, installing the software with all the recorded options to the local computer.

      If you set forceReboot value as 1 in the UserInput.xml file, specify the absolute path of the QInstaller.exe to auto run the installation after the reboot.

    The syntax you specify in the command line is as follows:

    <installation drive>\<platform specific folder>\QInstaller.exe /Appliance /play "path\filename.xml"

    For example:

    D:\Company\Win32\QInstaller.exe /Appliance /play "path\filename.xml"

Post-Install Considerations

Review the following considerations:

You can define post-install configuration commands that can be executed at the user location, upon activating the software appliance. You can add your configurations to the ActivateAppliance.bat file located at <Software Installation Path>\Base folder. Commands added to this file would be executed upon activation.

The commands can be added in one of the following ways:

Ensure that the batch file returns error code '0' upon successful completion. Any non-zero error code might be reported as a failure.

Other Considerations

Review the following considerations: