Auto Client Registration

Overview

The Automatic Client Registration feature allows you to simplify the installation of many client computers when having more than one CommServe running in your environment. Using this feature, you can deploy the same installation package to all computers and each can be made to automatically register with the appropriate CommServe of your choice. The list of clients to be installed can be administered from a central web interface.

The following section describes the steps involved in installing the required components and creating a custom package that can be used to automatically register a client computer to any CommServe.

  1. Install the Components
  2. Configure the Master CommServe
  3. Create the Custom Installation Package
  4. Register Clients
  5. Install the Custom Software Package on a client
  6. View Client Details

Install the Components

Install the CommServe, Web Server and Web Client on a computer that satisfies the minimum requirements specified in System Requirements.

To install the CommServe, follow the steps described in Install the CommServe Software.

To install the Web Server, follow the steps described in Install the Web Server.

To install the Web Client, follow the steps described in Install the Web Client.

Configure the Master CommServe

The Master CommServe will serve as a central location maintaining all information about the available Target CommServes as well as the potential client computers to be installed. Administrators can add client computers using a web interface assigning them a Target CommServe, client group, and policies. When a client is finished installing using the single customized package, it will be able to retrieve its own saved configuration from the Master CommServe and use this information to register itself with the designated Target CommServe automatically.

In order to prepare for this feature, you must designate one of the CommServes to be the master. Once you’ve decided, perform the following steps to set up the Master and Target CommServes:

  1. Log on to each Target CommServers.
  2. Navigate to the following registry key location and make a note of the value of the registry key pACCESS:

    HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance001\Database\pACCESS

  3. Log on to the Master CommServe computer, open SQL Server Management Studio and run the following query for each one of the target CommServes:

    insert into APP_CommCell values (1021902,0,1,'<target CS client name>',2,0,'','','','','',0,0,'','','',1)

    After this command has been run once for each of the target CommServes, run the following query to verify if the changes have been saved correctly:

    select * from APP_CommCell

  4. Note the “id” of each of the target CommServes and run the following command for each of the target CommServes:

    insert into APP_CommCellInfo values (<target CS “id”>,'<target CS hostname>','Commvault','<pAccess value string>',0,NULL,NULL,0)

    After running this command for each of the target CommServes, run the following query to verify if the changes have been saved correctly:

    Select * from APP_CommCellInfo

    This query should list all target CommServes along with the sqlInstance and access information.

The web console can be used to verify connectivity with all target CommServes.

Create the Custom Installation Package

Create a custom installation package which can later be used to easily deploy the software with a single-click and automatically register the client to any CommServe.

Use the following procedure to create the installation package:

1. Log on a computer as an Administrator or as a member of the Administrator group on that computer.

You can use any computer to create the custom installation package.

 
2. Run Setup.exe from the Software Installation Package.  
3. Select the required language.

Click Next.

4. Click Advanced options.
5. Click Create a custom install package.
6. Select the CPU type corresponding to the binaries that you want to use for the custom package.

Click Next.

  Select Win32 for a 32-bit package and WinX64 for a 64 bit package.
7. Specify the location where you wish to create the custom package. By default the custom package is created at C:\CustomInstallPackageName.

NOTES

  • Specify a folder under any drive. If the folder does not exist, it is automatically created.
  • Do not use the following characters when specifying the destination path:
     / : * ? " < > |
    It is recommended that you use alphanumeric characters only.

Click Browse to change directories.

Click Next to continue.

8. Select Create a new instance, to install the Agents on separate instance.

Click Next.

9.
  • Expand Client Modules | Backup & Recovery | File System and select Windows File System iDataAgent.
  • Click Next.
10.
  • Select Include service pack and Pre-Install software Components [decouple mode].
  • Click Next.

CommServe Host Name

11. If this computer and the CommServe is separated by a firewall, select the Configure firewall services option and then click Next to continue.

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

If firewall configuration is not required, click Next to continue.

12. Enter the fully qualified domain name of the Master CommServe in the CommServe Host Name field. This should be TCP/IP network name. e.g., computer.company.com.

NOTES

The CommServe client name is the name of the computer.  This field is automatically populated.

 

13.

Click Next to continue.

14. Click Next to continue.

Client Group Selection

15. Click Next to continue.

Global Filters Selection

15. Select the necessary Global Filter option for the default subclient and Click Next to continue.

NOTES

  • Select Use Cell level Policy to inherit the global filter policy configuration set for the CommCell, i.e., if the Use Global Filters on All Subclients option is selected in the Global Filters dialog box (from the CommCell Console’s Control Panel), then this policy will be applied to the default subclient as well. If is not selected, then the global filters will not be applied to the default subclient.
  • Select 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 to disregard applying the global filters to the default subclient regardless of the policy set for the CommCell.
Click Next to continue.

Storage Policy Selection

 
  • Select the Configure for Laptop or Desktop Backup check box to enable the Laptop Backup features.
  • Select the Contact the CommServe to perform automatic registration check box.
  The following Laptop Backup features are enabled:
  • Automatic Ownership
  • Automatic Scheduling
  • Backup Monitor Tool

For more information, refer to FAQs.

Verify Summary of Install Options

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

20. Specify the name and location of the self-extracting executable file.

Select the option Cleanup custom package folders and only retain the self-extracting exe to clean up the installation files and folders in the custom package destination folder.

Click Next to proceed.

21. The self-extracting executable file is created in the specified location. Click OK to exit.

The generated self-executable file can be used to install the Custom installation package that you have created above.

Register Clients

Before installing the custom package on any computer, register the client name for the computer and assign a Target CommServe for the client.  You can use web interface to perform this task.

Follow the steps given below to access the web interface and register the clients:

  1. Open a web browser, type the following URL and press Enter:

    http://<client hostname>:82/customreports

  2. Click the Register tab
  3. In the Client Name box, type the client name for the computer where you want to install the custom package.
  4. In the Target CommServer drop-down box, select a CommServe.

    The File System Agent on the client will use the assigned CommServe for all backup and restore operations.

  5. Select a Subclient Policy or a Storage Policy.

    The File System Agent on the client will use the assigned subclient policy or storage policy for all backup and restore operations.

  6. In the Client Group box, select a Client Group.

    All the settings of the assigned client group will be applied to the client. For example, Firewall configuration or data encryption settings etc.

  7. Click Save.

Registering multiple clients

Depending on your needs, you can register multiple client computers at once. Use the following steps to do so:

  1. Create an Excel sheet with the required fields as following:
    • Specify the client computer name in the first field.
    • Specify the Target CS id (CommCell id) in the second field.

      CS ids can be viewed by executing the following query from SQL Server Management Studio on the Master CommServe.

      select * from APP_CommCellInfo

    • Third and fourth fields must be left blank. Do not specify anything in these fields.
    • Specify the required client group in the fifth field.
    • Specify the Sub Client Policy in the sixth field.
    • Specify the desired Storage policy in the seventh field.
    • Eighth field must be left blank.
    • Specify the Unix time stamp in the ninth field. Specify the Unix time stamp only if you want to know the time at which this entry is created. If you do not want to specify the Unix time stamp, this field can be left blank.
    • Tenth field must exist, and must be left blank (empty space is mandatory).

Repeat the above steps to add multiple client computers to the excel sheet.

  1. Save this excel file as as a .csv file.

    If you have added details of a single client computer, then the contents of the csv file would appear as shown in the example.

  1. Log on to the Master CommServe, and run the following query in SQL studio:

    use CommServ
    bulk
    insert APP_RegisterClient
    from 'C:\Clients.csv'
    with
    (
    FIELDTERMINATOR = ',',
    ROWTERMINATOR = '\n',
    KEEPNULLS
    )
    GO

 

 

Where:

C:\Clients.csv is the path to the csv file.

 

Install the Custom Software package on a Client

Install the custom software package on your client using the installation package provided by your System Administrator.

1. Locate the CustomPackage provided by administrator and double-click the .exe file to start the installation.  
2. Click Next.
3. Verify the default location for Custom Package extract files.

Click Browse to change the default location.

Click Next.

4. The silent installation procedure begins with the command prompt option. Press any key to proceed with the installation.

The installation proceeds silently with the message, "Please Wait...". This might take several minutes to complete.

View Client Details

You can view the list of all the clients using the web interface. A client name will be added to the list in the following scenarios:

You can edit the client details for all the clients which are not registered with a Target CommServe.

  1. Open a web browser, type the following URL and press Enter:

    http://<client hostname>:82/customreports

    The Client Details tab of web interface will display list of all clients using automatic registration feature.

    The Record_ Creation_Time indicates the time when the client details were saved.

    The Registration_Time is the time when client successfully registered with the Target CommServe.

    Click under Actions column to edit the client details.

    Click under Actions column to delete the client details.