DPX 4.12 Guide
  • Welcome to DPX!
  • Introduction
    • About DPX
  • Installation and Configuration
    • How to Start – Basic Configuration
      • Protocols Used for Backup and Restore Data Transfer
    • DPX Master Server
      • Deploying DPX with VMware vSphere
        • Auxiliary Tasks for VMware Deployment
      • Deploying DPX with Microsoft Hyper-V
        • Auxiliary Tasks for Hyper-V Deployment
      • DPX Master Server Interface
      • Connecting to DPX Master Server via SSH
      • Configuration
    • DPX Client
      • DPX Client for Microsoft Windows
        • Requirements
        • Installation
        • How to Uninstall
      • DPX Client for Linux
        • Requirements
        • Installation
        • How to Uninstall
      • Automated Deployment of DPX Client
      • Further Actions with DPX Client
    • DPX Proxy Server
      • Deploying DPX Proxy Server for VMware
      • DPX Proxy Server Web Interface
    • DPX Hyper-V Agent
    • Nodes
      • Adding a Client Node to the Master Server during Client Deployment
      • Adding a Client Node from the Master Server Level
      • Adding a vStor Storage Node
      • Adding a Configured Hyper-V Host as a DPX Node
      • Adding an S3 Object Storage Node
      • Adding Other Node Types to the Master Server
      • Adding a Node Group
    • Devices
      • Adding a Device Cluster
      • Adding a Device
      • Adding a Tape Library
      • Adding a Tape Library Device
    • Media
      • Adding a Media Pool
      • Adding Media Volumes
    • Tape Libraries
      • Tape Library Deployment
      • Tape Library Setup
      • Manual Tape Library Installation
      • Tape Library Verification
      • Manual Tape Library Configuration
      • Setting up LTO Tape Drives for Hardware Encryption
        • Assigning and Unassigning Media to/from Tape Library Slots
    • User Configuration
      • Configure Administrators Window
    • Other Components of the DPX Suite
  • Storage
    • Backup Destinations
    • Tape Storage
    • vStor
    • Disk Directory
    • NetApp
      • NetApp SnapVault Management
        • Terminology for NetApp SnapVault Management
        • NetApp SnapVault Management Setup and Configuration
    • Cloud Storage
      • Registering AWS S3 Cloud Storage
      • Registering a Generic Cloud Storage
  • Backup
    • Introduction and Backup Types
    • File Backup
      • Creating a File Backup Job
        • Job Source Options for File Backup
        • Job Destination Options for File Backup
        • Other Job Options for File Backup
      • Editing a File Backup Job
      • Scheduling a File Backup Job
    • Block Backup
      • Prerequisites
      • Creating a Block Backup Job
        • Job Options for Block Backup
      • Editing a Block Backup Job
      • Scheduling a Block Backup Job
      • Forcing a Base Backup
      • Backing up System State
      • Backing up System Table
      • NetApp SnapVault Management Backup
    • Application Backup
      • Microsoft SQL Server Backup
        • Creating a Microsoft SQL Server Backup Job
        • AlwaysOn Database Backup
      • Microsoft Exchange Server Backup
        • Creating a Microsoft Exchange Server Backup Job
      • Microsoft SharePoint Server Backup
        • SharePoint Installation and Configuration Requirements
        • Creating a Microsoft SharePoint Server Backup Job
      • SAP HANA Backup
      • Oracle Database Backup
        • Enabling Block Backup for Oracle Databases
        • Creating an Oracle Database Backup Job
          • RMAN Cataloging Control
      • OpenText GroupWise Backup
        • Creating a GroupWise Backup Job
    • Bare Metal Recovery (BMR) Backup
      • Creating a BMR Backup Job
    • Catalog Backup
      • General Considerations
      • Creating a Catalog Backup Job
        • Job Options for Catalog Backup
      • Editing a Catalog Backup Job
      • Scheduling a Catalog Backup Job
    • NDMP Backup (desktop interface only)
      • Prerequisites
      • Creating an NDMP Backup Job
        • Job Source Options for NDMP Backup
        • Job Destination Options for NDMP Backup
        • Other Job Options for NDMP Backup
      • Editing an NDMP Backup Job
      • Scheduling an NDMP Backup Job
    • Image Backup (desktop interface only)
      • Creating an Image Backup Job
      • Editing an Image Backup Job
      • Scheduling an Image Backup Job
    • Agentless Backup for VMware and Hyper-V
      • Agentless Backup for VMware
        • Agentless Backup for VMware Complements Block Data Protection
        • Agentless VMware Backup Architecture and Data Flow
        • Environmental Requirements for Agentless VMware Backup
        • Best Practices for Agentless VMware Backup
        • Creating an Agentless VMware Backup Job
          • Job Source Options for Agentless VMware Backup
          • Other Job Options for Agentless VMware Backup
        • Editing an Agentless VMware Backup Job
        • Scheduling a VMware Backup Job
        • Application-Consistent Protection
        • Architecture and Data Flow
      • Agentless Backup for Microsoft Hyper-V
        • Creating a Hyper-V Backup Job
        • Editing a Hyper-V Backup Job
        • Scheduling a Hyper-V Backup Job
    • 🆕S3 Object Storage Backup
      • Creating an S3 Object Storage Backup
      • Scheduling an S3 Object Storage Backup Job
    • Differential and Incremental Backups
    • Archive
      • Creating an Archive Job for Block Backup
      • Creating an Agentless VMware Archive Job
  • Restore
    • Introduction and Restore Modes
    • Restore Modes in the Web Interface
      • Full VM Restore for VMware
      • Full VM Restore for Hyper-V
      • Instant VM Restore
      • Multi-VM Restore
        • Job Options for Multi-VM Restore
        • Advanced Filters
      • 🆕S3 Object Storage Restore
      • Agentless File Restore
      • File Restore from Block Backup
        • Advanced Job Options
      • Instant Access
      • Virtualization
      • Application Restore
        • Microsoft SQL Server Restore
        • Microsoft Exchange Server Restore
        • Microsoft SharePoint Server Restore
        • Oracle Database Restore
        • OpenText GroupWise Restore
      • File Restore from File Backup
        • Job Options for File Restore from File Backup
    • Restore Modes in the Desktop Interface
      • File Restore
        • Creating a File Restore Job
      • Image Restore
        • Creating an Image Restore Job
      • NDMP Restore
        • Creating an NDMP Restore Job
      • Block Restore
        • Creating a Block Restore Job
          • Block Restore Job Options
        • Specifying Mount Points
        • Restoring Block Data with Instant Access
        • Restoring BMR Data with Virtualization
        • NetApp SnapVault Management Restore
      • Agentless VMware Restore
        • Creating an Agentless VMware Restore Job
          • Agentless VMware Restore Job Operations
        • Rapid Return to Production (RRP)
      • Tape Restore
        • Creating a Tape Restore Job
      • Application Restore
      • Scheduling a Restore Job in the Desktop Interface
        • Previewing Scheduled Jobs in the Desktop Interface
      • Restore Job Source Options
    • Catalog Restore
      • Creating a Catalog Restore Job
    • Bare Metal Recovery (BMR) Restore
    • Recovering Archived Backups
      • Recovering a VMware Archive
  • Web Interface
    • Log-in Page
    • Dashboard
    • Job Monitor
    • Job Manager
    • Schedule Overview
    • Reports
      • Reports Templates
    • Nodes
    • Devices & Pools
    • Events
    • Configuring Enterprise Information
    • Configuring Custom SSL Certificates
  • Desktop Interface
    • Connect to DPX Window
    • Main Window
    • Common Menu Bar Options
    • Function Tabs Desktop Interface
      • Backup Tab
      • Restore Tab
      • Monitor Jobs Tab
      • Control Devices Tab
      • Reports Tab
      • Catalog Tab
      • Copy Tab
      • Manage Tapes Tab
      • Configure Tab
      • [Legacy] Analytics Tab
    • Common Function Window Tasks
    • Configuring Parameters
    • Configuring the Enterprises
      • Editing an Enterprise Configuration
      • Configuring Devices
  • BARE METAL RECOVERY
    • Bare Metal Recovery Overview
    • Bare Metal Recovery for Windows
    • Bare Metal Recovery for Linux
    • Recovery from a Replicated or Alternate Data Resource
  • MAINTENANCE
    • Condense
      • Starting a Condense Job
      • Scheduling a Condense Job (desktop interface only)
    • Job-Related Information
      • Job Return Codes
      • Job Status and Available Actions
    • Collecting Logs
    • Getting Node Information
    • File Exclusion Rules
    • Managing Licenses
    • Pre-Scripts and Post-Scripts
    • Updating DPX
      • Command Line Update
      • Online Autoupdate Method
      • Offline Autoupdate Method
  • Miscellaneous
    • Configuring Keyrings
      • Adding a Keyring
      • Adding a Key
    • SNMP Interface
    • Troubleshooting
      • Troubleshooting Unsuccessful Multi-VM Restore Cleanup
      • Troubleshooting Installation of the Catalogic DPX Client on UNIX and UNIX-like Systems
      • Managing the CMAgent Service
      • VMs Unable to Power On after Full or Instant VM Restore
    • Technical Support
    • Terminology
    • Acronyms
    • Default Ports
Powered by GitBook
On this page
  • Parameter Configuration Interface
  • Prerequisites for the Parameter Configuration Interface
  • Opening the Parameter Configuration Interface for a Selected Node
  • Advanced Parameter Views and Custom Parameters
  • Applying Parameter Changes
  • Editing Configuration Files in the Catalogic DPX Master Server
  1. Desktop Interface

Configuring Parameters

PreviousCommon Function Window TasksNextConfiguring the Enterprises

Last updated 4 months ago

You can configure various settings for Catalogic DPX as well as the nodes and utilities by editing their configuration parameters. There are two ways to edit the parameters: from the Parameter Configuration Interface in the Java-based DPX Management Interface and by editing the parameter files or registries in the Catalogic DPX Master Server.

Warning! Before configuring parameters in Catalogic DPX, always contact Catalogic Software Data Protection Technical Support. Bad parameters can cause unanticipated consequences including backup failure. Moreover, some configurations can update registry entries, startup scripts, or system files; thus, incorrect parameters can also cause the related systems or applications to fail.

Parameter Configuration Interface

Restrictions. You can edit most parameters from the desktop interface. This functionality is not yet available in the web interface.

Prerequisites for the Parameter Configuration Interface

The following are considerations for the Parameter Configuration Interface:

  • To use the Parameter Configuration Interface, you must have the system administrator privileges.

  • The Parameter Configuration Interface supports all node types with the exception of NDMP-only nodes (such as Filers and UnixWare nodes).

Opening the Parameter Configuration Interface for a Selected Node

You can select and configure any supported node in the Enterprise. Take the following steps to open the Parameter Configuration Interface of the node that you want to configure its parameters:

  1. Open the Configure tab in the function tab bar, and select Enterprise in the task pane.

  2. In the navigation tree, right-click the node you want to configure, and click Manage Configuration to open the Parameter Configuration Interface of the selected node.

  1. The Parameter Configuration Interface will open in the right pane, with a very visible warning.

The Parameter Configuration Interface scans the selected node to identify pertinent modules. Some environmental variables are assigned to virtual modules.

  1. Select the module that you want to configure its parameters from the module drop-down list, and you can see the basic parameters of the selected module.

  1. Edit the parameters; you can either enter a value in a text field, select a value item from a drop-down menu, or check or clear a value item to enable or disable it.

  2. Click the question mark icon to show the parameter description in a tooltip when you hover your mouse pointer over the name of each parameter.

Note. Some parameters require the system restart for the node or Catalogic DPX.

The parameters that you configured may show the following icons:

You must restart Catalogic DPX after saving the parameter changes.

You must restart the node that is relevant to the parameter.

You must restart Catalogic DPX on more than one node in the Enterprise. This may be due to firewall configuration changes.

Advanced Parameter Views and Custom Parameters

To show and configure the less common parameters, set Parameter Visibility to Advanced.

At the end of the list of parameters, there is a parameter item with a text input field for the parameter name too (custom parameters).

Applying Parameter Changes

After configuring parameters in the Parameter Configuration Interface, take the following steps to apply new parameters:

  1. Click Apply to save the parameters in all modules. Or, click Exit to discard all changes that you made.

  2. Click OK to close the dialog window.

  3. Restart the Catalogic DPX Master Server or relevant nodes to load the new parameters.

Important. The Parameter Configuration Interface does not restart Catalogic DPX or nodes automatically.

Editing Configuration Files in the Catalogic DPX Master Server

Some parameters are not available in the Parameter Configuration Interface of the desktop interface, and you have to edit the parameter files in the Catalogic DPX Master Server.

Log in to a shell session of the Catalogic DPX Master Server as dpxadmin, typically using an SSH client. Go to the product path.

To find the product path, run the following command in a shell session:

$ echo "Product path: $(find / -type d -path "*/catalogic/DPX" 2>/dev/null)/"

Usually, you should see the following output:

Product path: /catalogic/DPX/

In the product path directory, you should see the following configuration files:

  • <product path>/bin/<module name>

  • <product path>/misc/SSICMAPI

  • <product path>/bin/bexenv

  • <product path>/misc/bexads

These configuration files can be overwritten during the product upgrade.

In addition, you can create and add or edit parameters in the following permanent configuration files by using a text editor such as Vi:

  • <product path>/bin/bexenv.conf

  • <product path>/misc/bexads.conf

Unlike bexenv or bexads which does not have the .conf file extension, contents in bexenv.conf and bexads.conf are preserved after the product upgrade.

(“Need to restart Catalogic DPX”)

(“Need to restart the node”)

(“Restart Catalogic DPX in Enterprise”)

The custom parameter field can be used for undisclosed parameters and values. Do not use custom parameters unless otherwise instructed by Catalogic Software Data Protection Technical Support or instructed in .

Ensure that you see the following notification dialog:

Click OK to close the dialog window and see an additional information dialog:

After adding or editing a parameter, restart the SSCMAGENT service by following the instructions in .

Catalogic Software Knowledge Base
Managing the CMAgent Service