Additional Settings - Overview

Table of Contents

Overview

Additional settings are advanced options which can be used to perform troubleshooting and other environment specific configurations.

Additional settings can be added, modified, enabled/disabled, deleted from the CommCell Console. These operations can be performed for both Windows or Unix client computers.

Starting SnapProtect version 10, registry keys are referred as Additional Settings and can be completely managed from the CommCell Console.

We do not recommend to edit the registry keys using Regedit.exe or Regedt32.exe on Windows computers and the .properties file on Unix computers.

Advantages of This Process

Managing additional settings from the CommCell Console provides the following benefits:

  • Additional settings can be managed for every client and client group in the CommCell.

    When you want to apply the same additional settings to a group of clients, you can do this in a single operation from the client group level.

  • Spend less time providing the details of an additional setting during creation as most of these settings are pre-defined in the CommServe database.

    The CommCell Console automatically validates the values before populating them in the client registry. Hence, you can avoid the possibility of causing serious problems, such as reinstallation of the operating system.

  • When an additional setting is added to a client using the CommCell Console, it is stored in the CommServe database and then pushed to the client computer, whenever the client is reachable.
  • Global parameters (CommServDB.GlobalParam) as well as Console settings (CommServDB.Console) are defined in the same way as additional settings configured in the CommCell Console.

    These settings are defined at the CommServe level.

  • You can temporarily disable an additional setting and then enable it when it is needed, as opposed to deleting and re-creating the additional setting.
  • All operations - additions, modifications or deletions - are tracked in the Audit Trail.
  • Debug levels can be set on a client to manage the type of log entries that appear in a specific log file. See Additional Settings for Debug Levels for more information.

Managing Additional Settings from the CommCell Console

Additional Settings can be modified from a specific CommCell entity - CommServe, MediaAgent, Clients or Client Groups - in the CommCell Console.

In a clustered environment, you must specify the additional settings in the physical nodes (client computers), and not in the cluster server.

Add or Modify an Additional Setting

Use the following steps to add an additional setting:

  1. From the CommCell Browser, right-click the icon associated with the CommServe, MediaAgent, client or client group and then click Properties.
  2. If you are adding or modifying additional setting for a MediaAgent or client, in the properties dialog box, click Advanced.
  3. Click the Additional Settings tab and click Add.
  4. On the Add Additional Settings dialog box, perform the following:
    1. In the Name box, type the name of the additional setting. The Category and Type details will be automatically populated.

      Alternatively, you can click Lookup and search for the additional setting using the Find box.

    2. In the Value box, type the value of the additional setting.
  5. Optional: Enter any user comments about the additional setting in the Comment box. User comments can include notes about the usage, characteristics, and so on.
  6. Click OK to save the additional setting configuration.

    To change the value of an existing additional setting, select the additional setting from the list and then click Edit.

  7. Click OK.

Delete an Additional Setting

Use the following steps to delete an additional setting:

  1. From the CommCell Browser, right-click the icon associated with the CommServe, MediaAgent, client or client group and then click Properties.
  2. If you are deleting the additional setting for a MediaAgent or client, in the properties dialog box, click Advanced.
  3. Click the Additional Settings tab.
  4. Select the additional setting from the list and click Delete.
  5. Click Yes to remove the additional setting from the CommServe database.
  6. Click OK.

Managing Additional Settings from the Command Line Interface

Use the following steps to modify (add, edit, or delete) the additional setting details for one or more clients.

  1. Download the additional_settings.xml file and save it on the computer from where the command will be executed.
  2. Open the .xml file and provide the respective values for the XML parameters listed in the table below.

    Notes:

    • The additional setting is added if it does not exist and the registryKeys/deleted parameter is set to 0.
    • The additional setting is updated if it does exist and the registryKeys/deleted parameter is set to 0.
  3. Run the qlogin command to log on to the CommServe computer.
  4. Execute the following command after updating the XML file:

    qoperation execute -af additional_settings.xml

  1. You can verify the changes that you performed on the clients using the steps below:
    1. From the CommCell Browser, right-click the client and then click Properties.
    2. Click Advanced.
    3. Click the Additional Settings tab. The changes should be displayed.

The following table displays the XML parameters that need to be provided before running the qoperation command:

Parameter Description of Parameter Values
clientName Name of the client computers for which you want to add, modify or delete an additional setting.
keyName Name of the additional setting.
type Type of the additional setting. Valid values are:
  • INTEGER
  • STRING
  • BOOLEAN
value Value of the additional setting. Depending on type, the value could be numerical, a numeric range, or character string.
relativepath The relative location of the additional setting in the instance. For example, if the additional setting is created on the CommServe, then the relative path will be CommServe.
registryKeys/deleted Option to remove the additional setting. Valid values are:
  • 1, to remove the additional setting
  • 0, to retain the additional setting
registryKeys/enabled Option to enable the additional setting. Valid values are:
  • 1, to enable the additional setting
  • 0, to disable the additional setting

Additional Settings

The following section provides a list of links under which the additional settings are categorized. To view the complete list of additional settings, go to the Additional Settings database.

CommCell

Media Management

CommServe

Backup & Recovery