DPX Documentation
  • DPX Documentation
  • Deployment Guide
    • Introduction to Catalogic DPX Deployment
      • Audience and Purpose
      • Documents, Knowledge Base, and Technical Support
        • Official Documents of Catalogic DPX
        • Knowledge Base and Best Practices
        • Contacting Catalogic Software Data Protection Technical Support
      • Important Considerations
      • Infrastructure Setup
    • Chapter 1: Base Product Deployment
      • Deploying Catalogic DPX
      • Installation Components
      • Preinstallation Requirements
      • Getting Virtual Appliance Files of Catalogic DPX Master Server
      • Deploying the Catalogic DPX Master Server in VMware Environments
        • Before You Begin
        • Procedure
        • Results
      • Deploying the Catalogic DPX Master Server Virtual Appliance for Microsoft Hyper-V
      • Uninstalling Catalogic DPX
      • User Names and Passwords for Catalogic DPX Master Server
        • Default User Names and Passwords for the Catalogic DPX Master Server
        • Changing Shell Password of the Catalogic DPX Master Server
        • Changing the sysadmin Password of the DPX Management Interfaces
        • Password Requirements for the Catalogic DPX Master Server
      • Deploying Catalogic vStor Virtual Appliance for VMware
        • Prerequisites for Catalogic vStor Virtual Appliance for VMware
        • Deploying Catalogic vStor Virtual Appliance on VMware Environment
      • The Catalogic DPX Proxy Server Virtual Appliance for VMware
        • Prerequisites for the Catalogic DPX Proxy Server Virtual Appliance for VMware
        • Deploying the Catalogic DPX Proxy Server Virtual Appliance for VMware
        • Connecting to the HTML5-based DPX Proxy Server UI
        • Connecting to the Linux Shell of the Catalogic DPX Proxy Server Virtual Appliance
      • Deploying vStor Server in Hyper-V Environments
        • Before You Begin
        • Procedure
        • Results
      • Installing a Physical vStor Server
        • Before You Begin
        • Procedure
    • Deploying Catalogic vStor from the ISO Image File
      • Deploying Catalogic vStor from the Installer in the ISO Image File
      • Troubleshooting: Unable to Boot from the Catalogic vStor Disk Image
      • User Names and Passwords for Catalogic vStor
        • Default User Names and Passwords for Catalogic vStor
        • Changing Passwords of Catalogic vStor
        • Password Requirements for Catalogic vStor
      • Installing the Catalogic DPX Client on Microsoft Windows
        • Prerequisites for Installing the Catalogic DPX Client for Microsoft Windows
        • The Catalogic DPX Client for Microsoft Windows: client-only vs. full version
        • Installing the Catalogic DPX Client for Microsoft Windows
      • Installing the Catalogic DPX Client on Linux, Micro Focus OES, or IBM AIX
        • Prerequisites for Installing the Catalogic DPX Client on Linux, Micro Focus Open Enterprise Server,
        • Additional Prerequisites for Installing the Catalogic DPX Client on Linux
        • Installing the Catalogic DPX Client on Linux, Micro Focus Open Enterprise Server, or IBM AIX
        • Uninstall or Reinstall the DPX Client for Linux, MicroFocus Open Enterprise Server, or IBM AIX
      • Installing the Catalogic DPX Client on FreeBSD
        • Prerequisites for Installing the Catalogic DPX Client on FreeBSD
        • Installing the Catalogic DPX Client for FreeBSD
        • Uninstall or Reinstall the Catalogic DPX Client for FreeBSD
      • Troubleshooting Installation of the Catalogic DPX Client on UNIX and UNIX-like Systems
        • Installation Failed on Linux Because of Insufficient free PE
        • Adding a Client Node and Getting the Error: "No network route to the host"
        • Adding a Client Node and Getting the Error: "Did not register with CMAGENT"
        • Installation Logs of the Catalogic DPX Client for UNIX-like Systems
    • Chapter 2: Configure DPX
      • Add DPX Open Storage Server to Enterprise
      • Add NetApp Storage System to Enterprise
        • 1. Scan Secondary Storage System into Enterprise
        • 2. Enable Asynchronous Deduplication on Master Server
    • Chapter 3: Test Backup and Restore
      • Test 1. Backup
        • Set Up Destination Storage Volume for Open Storage
        • Setting up the NetApp Storage for the Destination Storage Volume
        • Run DPX Backup
      • Test 2. Restore
        • Test 2a. Restore – Standard Method
        • Test 2b. Restore – Instant Access
    • Chapter 4: Tape Media
      • Configuring Media Pools
      • Labeling and Assigning Tapes
        • Assigning Bar-coded Tapes
        • Assigning Tapes Without Bar-coding
      • Test Backup and Restore to Tape for Open Storage
      • Test Backup and Restore to Tape for NetApp Storage
        • Setting the Backup Type to Dump or SMTape
        • Setting the Backup Type Option
        • Testing a Backup and Restore from Storage System to Tape
        • Backing Up and Restoring Using the SMTape Option
    • Chapter 5: Updating Catalogic DPX Virtual Appliances 4.8.0 to 4.8.1
      • Prerequisites for Updating Catalogic DPX 4.8.0 Virtual Appliances to 4.8.1
        • Planning a Maintenance Window
      • Catalog Considerations for Product Upgrade
      • Tape Considerations for Product Upgrade
      • Upgrade Considerations for Windows Agent-based Block Backups to NetApp Clustered Data ONTAP Storage
      • Preparations for Virtual Appliances on VMware
        • Checking SCSI Controllers of VMs
        • Adding VMware PVSCSI Controllers in VMs
      • Preparations for Virtual Appliances on Microsoft Hyper‑V
      • Updating Catalogic DPX Master Server Virtual Appliance 4.8.0 to 4.8.1
        • Preparing the Product Update Files in the Catalogic DPX Virtual Appliance
        • Updating the Operating System of the Catalogic DPX Master Server Virtual Appliance
        • Updating Catalogic DPX 4.8.0 Master Server Application Components to Version 4.8.1
        • Preparing the Java Web Start Environment on Workstations
    • Chapter 6: Updating Catalogic DPX
      • Overview of Update Procedures for Catalogic DPX
      • Prerequisites for Updating Catalogic DPX
      • Updating Catalogic DPX Using Autoupdate
        • Online Autoupdate Method
        • Offline Autoupdate Method
      • Autoupdate with Local Repositories
        • Updating the Catalogic DPX Master Server from a Local Repository
        • Updating the Catalogic DPX nodes from a Local Repository
        • Upgrading the Catalogic DPX Master Server Offline
          • Prerequisites for Upgrading the Catalogic DPX Master Server
          • Upgrading the Catalogic DPX Master Server
    • Chapter 7: Updating Catalogic vStor
      • Upgrading Catalogic vStor 4.8.0 to 4.8.1
        • Updating Catalogic vStor Virtual Appliance for Microsoft Hyper-V
        • Prerequisites for Upgrading Catalogic vStor 4.8.0 to Version 4.8.1
        • Verifying the Hardware Compatibility with Red Hat Enterprise Linux (RHEL) 8
        • Preparing the Product Update Files in the Catalogic vStor Appliance
        • Updating the Operating System of the Catalogic vStor 4.8.0
        • Updating Catalogic vStor 4.8.0 to Version 4.8.1
      • Upgrading Catalogic vStor 4.7.1 or Earlier to Version 4.8.0
    • Addendum
      • Linux Change Journal Driver Installation
      • Software Update System Configuration File Requirements
        • Configurable Parameters
      • Verifying a Block Backup by Using iSCSI Mapping
      • Considerations for Clustered Data ONTAP Targets
        • Adding a Clustered Data ONTAP SVM Node
          • Licensing Requirements for Agent-based NetApp Clustered Data ONTAP Backups and Restores
          • Considerations for NetApp Clustered Data ONTAP SVMs
          • Configuring Clustered Data ONTAP for NOSB
          • Exploiting Space Efficiency for SVM
      • Catalogic DPX Plug-In for VMware vSphere Client
        • Prerequisites for Catalogic DPX Plug-In for VMware vSphere Client
        • Reloading the Catalogic DPX Environment in the Shell Session
        • Installing Catalogic DPX Plug-in for VMware vSphere Client
        • Updating Catalogic DPX Plug-in for VMware vSphere Client
        • Uninstalling Catalogic DPX Plug-in for VMware vSphere
    • ACRONYMS AND TERMINOLOGY
      • Acronyms
      • Terminology
    • Trademarks
  • User Guide
    • PREFACE
      • Audience and Purpose
    • PRODUCT OVERVIEW
    • Chapter 1: Catalogic DPX Overview
      • About Catalogic DPX Product License
      • Documents, Knowledge Base, and Technical Support
      • Important Considerations
    • Chapter 2: HTML5-based DPX Management Interface
      • Supported Releases of the Catalogic DPX Master Server
      • Supported Web Browsers and Operating Systems for Workstations
      • Accessing the HTML5-based DPX Management Interface
        • Accessing the DPX Management Interface Portal via HTTPS
    • Chapter 3: Java-based DPX Management Interface
      • Workstation Requirement for the Java-based DPX Management Interface
      • Installing the Java Web Start Runtime Environment on Your Workstation
      • Launching the Java-based DPX Management Interface
        • Launching the Java-based DPX Management Interface from a Web Browser
        • Launching the Java-based DPX Management Interface from the Catalogic DPX Master Server or Client
        • Troubleshooting the Java-based DPX Management Interface: Firewalls
      • Logging into the Java-based DPX Management Interface
      • Main Graphical Interface Objects in the Java-based DPX Management Interface
      • Common Menu Bar Options
        • File in the Menu Bar
        • Edit in the Menu Bar
        • Window in the Menu Bar
        • Help Menu
      • Common Function Window Tasks
        • Navigation Trees for Resources
        • Function Context Menu
      • Function Tabs in the Java-based DPX Management Interface
        • The Backup Tab
        • The Restore Tab
        • The Monitor Jobs Tab
        • The Control Devices Tab
        • The Reports Tab
        • The Catalog Tab
        • The Copy Tab
        • The Manage Tapes Tab
        • The Configuration Tab
        • The Analytics Tab
    • BACKUP STORAGE REPOSITORIES
  • Chapter 4: Catalogic vStor
    • Installation
      • Installing Catalogic vStor Application for Linux
      • Deploying Catalogic vStor Virtual Appliance for VMware
      • Deploying Catalogic vStor virtual appliance for Microsoft Hyper-V
      • Required Ports for Catalogic vStor Server
      • Updating Catalogic vStor
    • Quick start
      • Catalogic vStor for VMware
      • Catalogic vStor for Hyper-V
    • Basic Configuration
      • Initializing vStor
      • Adding Catalogic vStor Node to Catalogic DPX
      • Configuring vStor system settings
      • Configuring Network Settings of Catalogic vStor
      • Backing up Configuration Settings of Catalogic vStor
      • Restoring Configuration Settings of Catalogic vStor
    • Storage Management
      • Adding Disks to Catalogic vStor
      • Managing Storage Pools in Catalogic vStor
      • Managing Volumes in Catalogic vStor
      • Migrating Volumes in Catalogic vStor
      • Managing Shares in Catalogic vStor
    • Data Protection
      • Catalogic vStor Backup and Recovery
      • Creating vStor Partnerships
      • Enabling Volume Encryption
    • Advanced Configuration
      • Using Multipath Storage for Catalogic vStor
      • Certificates in Catalogic vStor
      • Adding Encryption URLs to Catalogic vStor
      • MinIO Buckets in Catalogic vStor
      • Assigning an E-mail to the vStor account
      • Managing vStor User Accounts
      • Using multi-factor authentication in vStor
    • Best Practices
      • Hardware configurations: Best Practices
      • Data backup: Best Practices
      • Data archiving: Best Practices
      • Backup storage: Best Practices
      • Frequently Asked Questions: Best Practices
  • Chapter 5: vStor Command Line Interface Reference
  • Chapter 6: Catalogic DPX Open Storage Server (OSS)
    • Migrating from Catalogic DPX OSS to Catalogic vStor Server
    • Remote Seeding with Catalogic DPX OSS
      • Prerequisites for Remote Seeding
      • Seeding Stage 1
      • Seeding Stage 2
      • After Seeding
  • Chapter 7: NetApp SnapVault Management
    • Terminology for NetApp SnapVault Management
    • NetApp SnapVault Management Setup and Configuration
      • Pre-configuring NetApp Storage Systems
      • Pre-configuring Open Systems
      • Configuring ONTAP Primary and OSSV SnapVault Nodes for Catalogic DPX
    • NetApp SnapVault Management Backup
      • NetApp Primary to NetApp Secondary Backup
      • NetApp OSSV Agent to NetApp Secondary Backup
      • Selecting the SnapVault Management Backup Destination
      • Scheduling a SnapVault Management Backup: Overview
      • Other SnapVault Management Backup Considerations
    • Backing Up NetApp SnapVault Management Backups
    • NetApp SnapVault Management Restore
      • Restoring to a Primary Storage System
    • Selecting a SnapVault Restore Destination
    • Scheduling a SnapVault Restore
    • Using a Command-line Script to Protect a NetApp Snapshot
      • Creating and Running NDMP Backup Jobs by Using the BEX Command
      • Return Codes (RC) for the BEX command-line interface
      • Building the Definition File
  • Chapter 8: Cloud Storage
    • Prerequisites for Registering Cloud Storage with Catalogic DPX
    • Configuring the NIB_PORT_RANGE Parameter
    • Registering AWS S3 Cloud Storage
      • Registering Amazon S3 Cloud Storage with Catalogic DPX
    • Registering Generic Cloud Storage
      • Registering Generic Cloud Storage with Catalogic DPX from the Java-based DPX Management Interface
    • Registering Microsoft Azure Blob Storage
      • Registering Microsoft Azure Blob Storage with Catalogic DPX
      • Enabling Object Lock in Catalogic DPX
    • Archiving Block Data to Cloud Storage
      • Prerequisites for Archiving Block Data to Cloud Storage
      • Archiving Block Data to Cloud Storage by Using the Java-based DPX Management Interface
    • Archiving Agentless VMware Data in Cloud Storage
      • Prerequisites for Archiving VMware Data in Cloud Storage
      • Archiving VMware Data in Cloud Storage by Using the Java-based DPX Management Interface
    • Enabling Amazon S3 Object Lock
      • Enabling Amazon S3 Object Lock
      • Enabling the Amazon S3 Object Lock Legal Hold
  • DISK-TO-DISK DATA PROTECTION
  • Chapter 9: Overview of the Disk-to-Disk Data Protection
    • Catalogic DPX Block Data Protection
    • Prerequisites for Catalogic DPX Block Backup
    • Prerequisites for Block Backup to Catalogic DPX Open Storage Servers
    • Prerequisites for Block Backup with NetApp Storage
      • Pre-Configuring Nodes for Block Backup to NetApp Storage
      • Configuring Nodes for Block Backup to NetApp Storage
      • Backing Up a SnapVault Primary
  • Chapter 10: Block Backup
    • Prerequisites for Catalogic DPX Block Backup
      • NetApp Deduplication Interface Considerations
      • Checkpoint Restart Considerations
      • Prerequisites for Block Backup Jobs
      • Forcing a Base Backup
    • Configuration Requirements for Agent-Based Clustered Data ONTAP Backup
      • Licensing Requirements for Agent-Based NetApp Clustered Data ONTAP Backups and Restores
      • Considerations for NetApp Clustered Data ONTAP SVMs
      • Configuring Clustered Data ONTAP for NOSB
      • Exploiting Space Efficiency for SVM
    • Block Backup Wizard
      • Launching the Block Backup Wizard
      • Block Backup Wizard Step 1: Welcome Page
      • Block Backup Wizard Step 2: Select Source
      • Block Backup Wizard Step 3:Select Destination
      • Block Backup Wizard Step 4: Job Options
      • Block Backup Wizard Step 5: Schedule
      • Block Backup Wizard Step 6: Save and Run
    • Running an Existing Backup Job
    • Block Backup Wizard Additional Information
      • Considerations When Selecting a Source in the Block Backup Wizard
      • Considerations When Modifying a Block Backup Job
      • Implementing Pre-Script and Post-Script for Snapshots Operations
      • Requirements for Pre-Script and Post-Script Snapshot
      • Script Definition
    • Protecting Block Backups
      • Protecting a Block Backup Residing on Catalogic vStor
      • Protecting Backups Residing on NetApp Storage
      • Protecting Backups Residing on Catalogic DPX Open Storage Server
    • Archiving Specific Backup Instances
      • Archiving specific backup instances
      • Running an On-demand Archive Job
      • Deleting an Archive Job from the Catalog
  • Chapter 11: Block Restore
    • Selecting Block Source Data to Restore
      • Alternate Secondary as NetApp Restore Source
    • Selecting Block Restore Destinations
      • Specifying a Destination Directory or qtree that Does Not Exist
      • Specifying Mount Points
    • Setting Block Restore Source Options
    • Setting Block Restore Destination Options
      • Existing File Handling
      • Missing Directories
      • Exchange Point-in-Time Recovery
      • Exchange Handling
      • MSSQL With Replace
      • MSSQL New Location
      • MSSQL New Location Logs
      • Point-in-Time Restore
      • SYSVOL Handling
      • Cluster Handling
      • Enable NDMP Server Logging
      • Restart Relationship After Restore Complete
      • Oracle Restore Mode
      • Oracle Files Quick Restore Root Directory
      • Oracle Home
      • Oracle UNIX User Name
      • Oracle Instance Password
      • Oracle Database Open Option
      • Create SharePoint Web Application
      • Setting Restore Encryption Options
    • Setting Restore Job Notification Options
    • Saving Restore Jobs
    • Running Restore Jobs
    • Monitoring a Restore Job
  • Chapter 12: Instant Access to Data
    • Mapping a Block Backup Instance to a Drive Letter
      • Mapping Preparation
      • Mapping Procedure
    • Using Instant Access in a Recovery Strategy
    • Modifying and Recovering
      • Modifying the Backed Up Data
      • Recovering Modified Data
    • Instant Access Mapping to the NetApp Alternate Secondary
      • Pre-mapping Procedure for Alternate Secondary
      • Meet the Requirements for an Alternate Secondary System
        • Perform the Required Procedures on the Alternate Secondary
      • Change Appropriate Node References
      • Using an Alternate Secondary with an Initial Secondary for Recovery
    • Unmapping a Block Backup Instance from a Drive Letter
    • Verifying a Block Backup by Using iSCSI Mapping
    • Snapshot Verification Utility for NetApp Storage Systems
      • Running the Snapshot Verification Utility for NetApp Storage Systems
      • Managing Storage System Credentials for the Snapshot Verification Utility
      • Considerations for Troubleshooting the Snapshot Verification Utility
    • Instant Access as a File History Alternative
  • Chapter 13: Bare Metal Recovery
  • VIRTUAL ENVIRONMENT
  • Chapter 14: Overview of Virtual Environment Protection
    • Special Features for Virtual Environments
      • Terminology Related to Virtualization
    • File Restore for Agentless Backup
      • Prerequisites and Restrictions for File Restore
      • Restoring Files in the HTML5-based DPX Management Interface
    • Deleting Agentless Backup or Restore Jobs
      • Deleting Agentless Backup Jobs
      • Condensing Catalog
      • Delete Backup Instances
      • Deleting the Agentless Restore Job Definition
  • Chapter 15: Agentless Backup for VMware
    • Agentless Backup for VMware: Advantages and Capabilities
      • No Maintenance of Data Protection Software on VMs
      • High-Performance Backups
      • Flexibility, Administrative Simplicity
      • Catalogic Agentless Backup Complements Block Data Protection
        • Data Reduction: Deduplication and Compression
        • Multiple Types of Restore for Agentless VMware Backups
    • Application-Consistent Protection
      • Determining the Consistency State of a Snapshot
    • Architecture and Data Flow
      • Agentless VMware Backup Node Types
      • Backup Architecture: SAN, LAN (NBD), and HotAdd
      • Backup Architecture: Guest-Based and Proxy-Based Backup in a Single Protection System
      • Restore Architecture and Data Flow
    • Restoring VMs
      • Full Virtualization
      • Instant Virtualization
      • Migration from Virtual Snapshot Storage to Local Storage: RRP
    • Creating VMs with Full Virtualization or Instant Virtualization
      • Backing Up A Physical Node For Virtualization Jobs
      • Steps to Restore VMs with Catalogic DPX
      • Steps to Create a VM (Full Virtualization and Instant Access)
        • Virtualization Step 1
        • Virtualization Step 2
      • Steps to Create a Virtual Machine (Full and Instant Virtualization)
    • Virtualization Steps (Full and Instant Virtualization)
      • I. Selecting a Snapshot and Choosing Virtualization Type:
      • II. Specifying Virtual Machine Information
      • Steps to Create a Virtual Machine (Full and Instant Virtualization)
      • Procedure
    • Rapid Return to Production (RRP)
      • Prerequisites for RRP
      • RRP General Considerations
      • Power State Considerations for RRP
      • Completing an RRP Job Despite Master Server Interruption
      • Converting Temporary VM to Production VM by Using RRP
    • Additional tasks after restoring VMs
      • Deleting Virtual Machines After Instant Virtualization
      • Cloning Virtual Machines
    • Agentless Backup and Recovery
      • Catalogic DPX Archive for Agentless Backup with Catalogic vStor
      • Protecting Agentless Backups
      • Recovering an Archived Agentless Backup
        • Step 1: Restore the Backup Instance from Media to a vStor Volume
        • Step 2: Complete the Initially Intended Recovery by Restoring from the vStor
    • VMware vCenter Permission Settings for Agentless Backup
    • Installing Agentless VMware Backup
      • Prerequisites for Agentless VMware Backup
      • Backup Considerations for Agentless VMware Backups
      • Restore Considerations for Agentless VMware Backup
    • Best Practices for Agentless VMware Backup
    • Configuring VMware Protection
      • Prerequisites for Adding VMware vCenters or Proxy Servers to the Enterprise
      • Adding, Editing, or Deleting VMware nodes to the Enterprise from the HTML5-based DPX Management Inte
      • Adding, Editing, or Deleting VMware vCenter to the Enterprise Using the Java-based DPX MI
    • Virtualization Proxy Servers for VMware
      • Setting Virtualization Proxy Servers
      • Adding an Agentless Virtualization Proxy Server
      • Rescanning a Proxy Server Node
    • Backing Up VMware VMs
      • Prerequisites for Backing Up VMware VMs
      • Excluding VMs from Backup
      • Creating the Agentless VMware Backup Jobs from the HTML5-based DPX Management Interface
      • Creating the Agentless VMware Backup Jobs from the Java-based DPX Management Interface
    • Restoring VMware VMs from the HTML5-based DPX Management Interface
    • VMware Restore Wizard for the Java-based DPX Management Interface
      • Step 1. Launching the VMware Restore Wizard
      • Step 2. VMware Restore Wizard: Select Operation
      • Restore Operations
        • Summary of Restore Operations
      • Step 3. VMware Restore Wizard: Select Source
      • Step 4. VMware Restore Wizard: Select Target Host
      • Step 5. VMware Restore Wizard: Select Target Datastore
      • Step 6. VMware Restore Wizard: Virtual Machine Options
      • Step 7. VMware Restore Wizard: Job Information
      • Step 8. VMware Restore Wizard: Set Job Options
      • Step 9. VMware Restore Wizard: Job Schedule
      • Step 10. VMware Restore Wizard: Summary
      • Saving and Running the Restore Job
    • Additional Information About Restoring VMware VMs
      • General Restore Considerations
      • Datastore Considerations
      • VMDK Restore Considerations
      • VMDK Post-Restore Considerations
    • Deleting VMs and VMDKs
      • Considerations for Deleting VMs
      • Delete VM/VMDK Wizard
      • DeleteVM Utility
    • Catalogic DPX Plug-In for VMware vSphere Client
      • Prerequisites for Catalogic DPX Plug-In for VMware vSphere Client
      • Reloading the Catalogic DPX Environment in the Shell Session
      • Installing Catalogic DPX Plug-in for VMware vSphere Client
      • Updating Catalogic DPX Plug-in for VMware vSphere Client
      • Uninstalling Catalogic DPX Plug-in for VMware vSphere
    • Operating Catalogic DPX from VMware vSphere Client
      • Defining a Backup Policy in the Java-based DPX Management Interface
      • Assigning a Policy to VMs in VMware vSphere Client
      • Removing a Policy from VMs in the vSphere Client
      • Performing an On-Demand VM Backup in the vSphere Client
  • Chapter 16: Using Storage for Agentless VMware Backup
    • Agentless VMware Backup with Catalogic vStor
      • Prerequisites for Agentless VMware backup with Catalogic vStor
      • Additional Information about iSCSI Initiators
    • Agentless VMware Backup with Catalogic DPX Open Storage Server (OSS)
      • Prerequisites for VMware Agentless Backup with Catalogic DPX Open Storage Servers
    • Agentless VMware Backup with NetApp Storage Systems
      • Best Practices for Agentless VMware Backup with NetApp Storage Systems
  • Chapter 17: Agentless Backup for Microsoft Hyper-V
    • Installing Catalogic DPX Backup Agent on the Microsoft Hyper-V host
      • Prerequisite for installing Catalogic DPX Backup Agent for Microsoft Hyper-V
      • Installing Catalogic DPX Backup Agent for Microsoft Hyper-V by Using the Graphical Interface
      • Installing Catalogic DPX Backup Agent for Microsoft Hyper-V from Microsoft Windows PowerShell
    • Registering Microsoft Hyper-V with Catalogic DPX
      • Prerequisites for Agentless Microsoft Hyper-V Backup
      • Getting an IPv4 Address of the Microsoft Hyper-V Hosts or Clusters
      • Adding Microsoft Hyper-V Nodes to Catalogic DPX
    • Backing Up Microsoft Hyper-V VMs
      • Prerequisites for backing up the Microsoft Hyper-V assets
      • Backing up the Microsoft Hyper-V Assets
    • Restoring Microsoft Hyper-V Backups
      • Prerequisites for Restoring the Microsoft Hyper-V Backups
      • Restoring the Microsoft Hyper-V VM backups (“Full VM Restore”)
  • APPLICATION SUPPORT
  • Chapter 18: Microsoft SharePoint
    • About Physical and Virtual Nodes
    • Establishing SharePoint Control Nodes
    • DPX SharePoint Object Recovery
    • Considerations and Requirements for SharePoint
      • Supported Operating Systems and Applications
      • General Limitations
      • SharePoint Installation and Configuration Requirements
    • Installation on SharePoint Nodes
      • Installing DPX on SharePoint Control Nodes
      • Adding SharePoint Application Protection Services to an Existing Enterprise
    • SharePoint: Additional Configurations
      • Initial Configuration of the SharePoint Virtual Node
      • Adding Physical SharePoint Nodes to the Enterprise
      • Enabling Microsoft SharePoint Services VSS Writer on SharePoint Control Nodes
      • Updating SharePoint Control Node Configurations
      • Configuring Automatic Failover Functionality for SharePoint Farms
      • Verifying the Configuration of SharePoint Before Using Backup
    • Backing Up SharePoint with DPX Block Data Protection
      • Considerations for SharePoint Application Backups
      • Running a SharePoint Backup
      • Selecting SharePoint Backup Sources
    • Restoring Microsoft SharePoint with the Catalogic DPX Block Data Protection
      • Prerequisites for restoring Microsoft SharePoint
    • Restoring the Microsoft SharePoint Application or its Individual Components
      • Restoring Web Applications to Another Farm
      • Restoring Microsoft SharePoint databases from Microsoft SQL Server backups
  • Chapter 19: Microsoft Exchange Server
    • Architectural Changes in Microsoft Exchange
    • Catalogic DPX Support for Exchange
    • Catalogic DPX Exchange Mailbox Recovery (EMR)
    • Requirements and Considerations for Exchange Backup and Restore
      • Considerations for DAGs
      • Backup Considerations
      • Prerequisites for Restoring Microsoft Exchange Server Assets
      • Restore Destinations
    • DPX Installation on Exchange Nodes
      • General Installation Procedure for Exchange Nodes
      • DPX Installation Scenarios for Exchange
    • Configuring Exchange Nodes
      • Using the Management Console to Configure Exchange Nodes
      • Adding a Standalone Exchange Node to an Existing DAG Node Group
    • Backing Up Exchange with DPX Block Data Protection
      • Defining and Running Exchange Backups
    • Verifying Microsoft Exchange Server Backups
      • Requirements/Considerations for Exchange Verification
      • Setting Verification Options for Microsoft Exchange Server
      • Running the Verification Job
      • Verification and the Job Monitor
      • Determining the Verification State of a Backed Up Job Instance
    • Restoring Microsoft Exchange Server by using Catalogic DPX Block Data Protection
      • Preparing for Restore
    • Restoring Microsoft Exchange Server databases
      • Restoring Microsoft Exchange Server Nodes or Components
      • Optional Configurations
      • Running the Restore Job for Microsoft Exchange Server
    • Post-Restore: Reseeding the Passive DAG Database for Microsoft Exchange Server
    • Restoring to an Exchange Recovery Databases
      • Prerequisites for Restoring Recovery Databases of Microsoft Exchange Server
      • Restoring a Recovery Database of Microsoft Exchange Server
    • Backup and Restore Job Options
  • Chapter 20: Microsoft SQL Server
    • DPX Protecting SQL Server: General Considerations
    • Protecting AlwaysOn Availability Groups: Concepts and Considerations
      • Overview
      • Display of WSFC Resources
      • Backup Considerations
      • Recovery Considerations
      • BMR Recovery Considerations
      • WFSC Limitations
  • Chapter 21: DPX Block Data Protection for AlwaysOn Databases
    • AlwaysOn Database Block Backup Overview
    • AlwaysOn Database Block Restore Overview
    • Microsoft Windows Server Distributed File System (DFS)
      • DFS Namespaces
      • DFS Replication
    • DFS Namespace Block Backup
      • Standalone Namespace Server Considerations
      • Domain-based Namespace Server Considerations
      • Domain Controller Restore
    • DFS Replication Block Backup
      • General Considerations
      • Block Restore Considerations
      • Troubleshooting Considerations
  • Chapter 22: SAP HANA
    • Prerequisites for Protecting SAP HANA Application Data
    • Installing the DPX Client for SAP HANA
    • Installing and Configuring the DPX Plugin for SAP HANA
    • SAP HANA Studio Best Practices for DPX Plugin
    • Running a backup job with SAP HANA Studio
    • Running a restore (recovery) job with SAP HANA Studio
  • Chapter 23: Oracle Databases
    • Prerequisites for Protecting Oracle Databases
      • Advantages of Using the Catalogic DPX Over Traditional RMAN Backups
      • Considerations for Catalogic DPX Block Data Protection
    • Enabling Catalogic DPX Block Data Protection for Oracle Databases
    • Catalogic DPX Block Data Protection for Oracle Backup Workflow
    • Backing up Oracle Databases by using Catalogic DPX Block Data Protection
    • Restoring Oracle Databases by using Catalogic DPX Block Data Protection
    • Logical View Restore: Regular
    • Logical View Restore: Quick Restore
    • Logical View Restore: Cloning
    • Physical View Restore
    • Special Restore Destination Options for Oracle
    • Oracle RMAN Cataloging Control and Catalogic DPX
      • RMAN Operation with Backup Files
      • Prerequisites for RMAN Cataloging
      • Example Job Log
    • Example Disaster Recovery Scenarios about Oracle Databases
      • Restoring an Oracle Instance from a Previous Point-in-Time
      • All Data Files for a Non-System Tablespace are Either Lost or Corrupted
      • Lost a Data File for a Non-System Tablespace
      • Performing a Point-in-Time Restore of the Entire Database
      • Recovering From a Table DROP With a Backup that Contains the Lost Table
      • Recovering From a Table DROP Performed After the Last Backup
      • Recovering Oracle Databases to a New Server
  • Chapter 24: Additional Topics about Application Protection
    • Verifying Application Backups
      • Prerequisites for Verification
      • Verification and the Job Monitor
      • Determining the Verification State of a Backed Up Job Instance
    • Cluster Support for Microsoft Windows and Micro Focus OES
      • Prerequisites for Catalogic DPX Block Data Protection with Clusters
  • MAINTENANCE
  • Chapter 25: Maintaining and Protecting Catalogic DPX Catalogs
    • Condense: Freeing Resources in the Catalog
      • Starting Catalog Condense Jobs
      • Scheduling Catalog Condense Jobs
        • Editing Existing Job Schedules
        • Previewing Scheduled Jobs
    • Job Functions: Managing Catalog Expiration Cycles
      • Elements of the Catalog Job Functions Window
      • Extending the Retention Period of a Cataloged Job
      • Expiring a Cataloged Job Instance
      • Filtering the Cataloged Job List
      • Generating Cataloged Job Reports
    • Backup: Protecting the Catalog Data
      • Disaster Recovery Essentials
      • Catalog Backup: Recommended Strategies
        • Tape drive attached to master server
        • Tape drive attached to remote device server
        • DiskDirectory for Catalog backup
      • Catalog Backup: Strategies to Avoid
      • Overview of Backing Up the Catalog
      • Creating a Media Pool for Catalog Backups
      • Catalog Backup Window: Tasks Overview
      • Launching the Catalog Backup Window
      • Elements of the Catalog Backup Window
    • Creating New Catalog Backup Jobs
      • Specify Destinations for the Catalog Backup Job
      • Schedule Catalog Backup Jobs
      • Catalog Backup Source Options
        • Set Catalog Backup Destination Options
      • Catalog Backup Job Notification Options
    • Editing Catalog Backup Job Definition
      • Opening an Existing Catalog Backup Job Definition
      • Editing an Existing Catalog Backup Job
      • Saving a Catalog Backup Job
      • Running a Catalog Backup Job
      • Deleting an Existing Catalog Backup Job
    • Restore: Recovering Catalog Backup Data
      • Elements of the Catalog Restore Window
      • Defining a Catalog Restore
      • Editing a Catalog Restore
      • Restoring catalogs
      • Monitoring a Catalog Job
  • Chapter 26: Jobs
    • Job Return Codes (RCs)
    • Monitoring jobs in Java-based DPX Management Interface
    • Job Status and Available Actions
      • Suspending Jobs
      • Canceling Jobs
      • Rescheduling a Job’s Time
      • Running a Job from the Job Monitor
    • Holding and Releasing Scheduled Jobs
      • Prerequisites for Holding or Releasing Scheduled Jobs
      • Holding or Releasing Scheduled Jobs in the HTML5-based DPX Management Interface
      • Holding Scheduled Jobs in the Java-based DPX Management Interface
      • Releasing Held Scheduled Jobs in the Java-based DPX Management Interface
    • Displaying a Job Definition
    • Monitoring Jobs
      • Monitoring Multiple Jobs
      • Job Monitor Interval and Maximum Jobs
    • Reviewing Jobs
    • Generating Job Reports
  • Chapter 27: Catalogic DPX Logs
    • Collecting Job Logs
      • Collecting Job Logs on the HTML5-based DPX Management Interface
      • Collecting Job Logs on the Java-based DPX Management Interface
    • Technical Specifications for Catalogic DPX Logs
      • Log Management Models
      • File Sizes of Job Logs
      • File Name Pattern for Catalogic DPX Logs
      • Text Format for Catalogic DPX Logs
  • Chapter 28: Managing Licenses
    • Getting License Information
      • Getting License Information from the HTML5-based DPX Management Interface
      • Getting License Information from the Java-based DPX Management Interface
    • Updating the License Key
      • Updating the License Key Using the HTML5-based DPX Management Interface
      • Updating the License Key Using the Java-based DPX Management Interface
      • Updating the License Key Using the Linux Shell
    • Managing the CMAgent Service
      • Stopping or Starting the CMAgent Service on UNIX or Linux
      • Stopping or Starting the CMAgent Service on Microsoft Windows
  • Chapter 29: Getting Node Information
    • Prerequisites for getting node information
    • Getting Node Information on the Java-based DPX Management Interface
  • Chapter 30: Configuring Parameters
    • Parameter Configuration Interface
      • Prerequisites for the Parameter Configuration Interface
      • Opening the Parameter Configuration Interface for a Selected Node
      • Selecting a Module and Configuring its Parameters
      • Advanced Parameter Views and Custom Parameters
      • Applying Parameter Changes
    • Editing Configuration Files in the Catalogic DPX Master Server for Linux and UNIX
    • Editing Configuration Registry Values in the Catalogic DPX Master Server for Microsoft Windows
  • SECURITY
  • The Catalogic DPX GuardMode
    • Detecting File Renaming with Abnormal File Extensions
    • Counting Write Operations
    • Honeypot and Decoy Files
    • Prerequisites for the Catalogic DPX GuardMode
    • Installing the Catalogic DPX GuardMode Agent
      • Preparing the Installation Program for the Catalogic DPX GuardMode Agent
      • Installing the Catalogic DPX GuardMode Agent
      • Stopping or Restarting the Catalogic DPX GuardMode Agent
      • Uninstalling the Catalogic DPX GuardMode Agent
      • Viewing the Version Number of the Catalogic DPX GuardMode Agent
    • Managing the Catalogic DPX GuardMode Agent in the Graphical Interface
      • Security: Excluded Paths
      • Updating the Block-list for the Blocked Extensions
      • Excluding File Extensions in the Block-list
      • Managing Honeypot
    • The Command-line Interface for the Catalogic DPX GuardMode
      • Getting Started with the Command-line Interface for the Catalogic DPX GuardMode
      • Starting the Catalogic DPX GuardMode Agent
      • Registering the Catalogic DPX GuardMode Agent with the Catalogic DPX Master Server as a Node
      • Adding Catalogic DPX GuardMode Agent with the Catalogic DPX Master Server as a Notification Provider
      • Updating the Catalogic DPX GuardMode Agent with Catalogic DPX as a Notification Provider
      • Viewing the Catalogic DPX Master Servers that Were Registered as Notification Providers
      • Removing the Catalogic DPX Master Server that Was Registered as a Notification Provider
      • Updating Configurations for the Basic Authentication
  • ADDENDUM
  • Chapter 31: Remote Seeding with NetApp Storage
    • Prerequisites for Remote Seeding
    • Microsoft Windows Remote Seeding to 7-Mode Data ONTAP
      • Primary Site Procedures for Windows Remote Seeding to 7-mode
      • Destination Site Procedures for Windows Remote Seeding to 7-mode
        • Define a Block Incremental Backup Job
        • Restore the Base Image Backup and Seed the NetApp Storage System
        • Schedule Block Incremental Backups
    • Microsoft Windows Remote Seeding to Clustered Data ONTAP
      • Primary Site Procedures for Windows Remote Seeding to Clustered Data ONTAP
      • Destination Site Procedure for Windows Remote Seeding to Clustered Data ONTAP
      • Procedures to Prepare the Incremental Job
    • Remote Seeding for the Linux Platform
      • Primary Site Procedures for Linux Remote Seeding
      • Destination Site Procedures for Linux Remote Seeding
  • Chapter 32: Setting Up Tape Library in NetApp Storage Environment
    • Prerequisites for Tape Library Deployment
    • Recommended Best Practices for Tape Libraries
      • Other Tape Library Setup Scenarios
      • Impact of Equipment Upgrades
    • Tape Library Setup using the Device Configuration Wizard
      • 1. Connect the Tape Library
      • 2. Install and Configure the Tape Library by Using the DPX Device Configuration Wizard
        • Devices Not Auto-Configurable
        • Launching the Device Configuration Wizard
        • Using the Device Configuration Wizard
    • Manual Tape Library Setup
      • 1. Connect the Tape Library
      • 2. Get information about tape devices and tape drive bays
      • 3. Add the tape library to the Catalogic DPX Enterprise
      • 4. Add the tape drives to the Enterprise
      • 5. Add the SAN device paths to the Enterprise
  • Chapter 33: Setting Up Tape Library in Catalogic DPX Open Storage Server Environment
    • Prerequisites for Tape Library Deployment
    • Recommended Best Practices for Tape Libraries
      • Tape Library Setup Scenarios
      • Impact of Equipment Upgrades
    • Tape Library Setup using the Device Configuration Wizard
      • 1. Connect the Tape Library
      • 2. Install and Configure the Tape Library by Using the DPX Device Configuration Wizard
        • Devices Not Auto-Configurable
        • Launching the Device Configuration Wizard
        • Using the Device Configuration Wizard
    • Manual Tape Library Setup
      • 1. Connect the Tape Library
      • 2. Get Information about Tape Devices and Tape Drive Bays
      • 3. Add the Tape Library to the Enterprise
      • 4. Add the Tape Drives to the Enterprise
      • 5. Add the SAN Device Paths to the Enterprise
  • Chapter 34: Common operating system tasks
    • Verifying MD5 Hash Values
    • Editing Environment Path Variable
    • Microsoft PowerShell and Microsoft Windows PowerShell
  • ACRONYMS AND TERMINOLOGY
    • Acronyms
    • Terminology
  • Trademarks
  • REFERENCE GUIDE
    • REFERENCE GUIDE OVERVIEW
    • Chapter 1: DPX Overview
      • Documents, Knowledge Base, and Technical Support
        • Official Documents of Catalogic DPX
        • Knowledge Base and Best Practices
        • Contacting Catalogic Software Data Protection Technical Support
      • Important Considerations
    • Chapter 2: Introduction to Reference Guide
      • Audience and Purpose
      • Topics Covered
    • INSTALLATION
    • Chapter 3: Installation Overview
      • Downloading the OVA File and ISO Images
        • Downloading the OVA File or ISO Images
        • Running the Installer for the Client, OSS, or Proxy from the ISO Image
      • Automated Deployment
      • Installation Components and Considerations
        • Installation Components
        • Installation Considerations
          • DPX Open Storage Server Installation Considerations
          • General Installation Considerations
          • iSCSI Initiator and NFS Transport Protocol
        • Considerations for Installation on Clusters
          • Cluster Name Account Permissions for Installing on Clusters
      • Workflow for New Installation
    • Chapter 4: Product Upgrade/Update
    • Chapter 5: Local Installation
      • Deploying the Catalogic DPX Master Server in the VMware Environment
        • Installing the Catalogic DPX Master Server Appliance
        • Assigning or Changing an IP Address
        • Changing the System Hostname
      • Deploying the Catalogic DPX Master Server in the Microsoft Hyper-V Environment
        • Installing the DPX Master Server Appliance
        • Assigning or Changing an IP Address
        • Changing the System Hostname
      • Installing on Windows – New or Upgrade
        • Windows Installation on Non-SharePoint Nodes
        • Windows Installation on SharePoint Nodes
      • Silent installation on the Microsoft Windows Systems
        • Silent Installation Procedure on the Microsoft Windows Systems
        • Files and Folders that are Installed with Catalogic DPX for Microsoft Winodws
        • Uninstalling on Windows
      • Installing on UNIX and Linux – New or Upgrade
        • Pre-Installation Considerations for UNIX or Linux
        • Using the Installation Wizard to Install on UNIX or Linux
        • Using the Command Line to Install and Uninstall on UNIX or Linux
        • Silent Install, Upgrade, and Uninstall on UNIX or Linux
    • Chapter 6: Remote Deployment
      • System Requirements for Remote Deployment
        • Running a Test Listing
      • Procedure for Remote Deployment
    • Chapter 7: Catalogic DPX Software Update System
      • Prerequisites for the Catalogic DPX Software Update System
      • Software Update System Considerations
      • Installing Catalogic DPX Software Update Packages
      • Manually Populating the Software Update Package Repository
      • Additional Features in Catalogic DPX Software Update System
        • Traceability of Software Updates
        • Notification of Software Updates
      • Software Update System Configuration File Requirements
        • Restarting Service/Agents
        • Configurable Parameters
      • Manual Software Update Installation
        • Manual Software Update Installation Procedure
        • Manual Software Update Uninstallation Procedure
        • Procedure for Opening a Command Prompt
    • Chapter 8: The Importance of Catalog Protection and Maintenance
      • Key Steps to Protecting the Catalog
        • Define a Catalog Backup
        • Ensure You Have a Catalog Backup Report
    • Chapter 9: Administrative Privileges and Security Considerations
      • Default Ports
      • NIB Port Range for NDMP and Image Backups
      • Changing the SSH Port on the Catalogic DPX Master Server
        • Changing the SSH Port on the Catalogic DPX Master Server
      • Permissions Needed for Operating Systems
        • Permissions for Windows
        • Permissions for Windows Clusters
        • Permissions for UNIX / Linux
        • Permissions for OES2 Linux
      • Permissions Needed for Devices
        • Permissions for NetApp Storage Systems
        • Permissions for Other NDMP Storage Systems
      • Permissions Needed for Application Interfaces
        • Permissions for VMware (Virtualization Features)
        • Permissions for SQL
        • Permissions for SharePoint
        • Permissions for Microsoft Exchange
        • Permissions for Oracle: File Level, RMAN, All Platforms
        • Permissions for Oracle: Block Level, Windows, Linux, Solaris
        • Permissions for DB2
        • Permissions for Lotus Notes / Domino
        • Permissions for SAP R/3
        • Permissions for Micro Focus eDirectory
        • Permissions for Micro Focus GroupWise
      • Permissions Needed for Application Restore Tools
        • Permissions for DPX Exchange Mailbox Recovery
        • Permissions for DPX SharePoint Object Recovery
    • CONFIGURATION
    • Chapter 10: Configuration Overview
      • A Note on Environmental Variables
      • Overview of Configuration Functions
      • Field Lengths
    • Chapter 11: Configuring the Enterprises
      • Elements of the Configure Enterprise Window
      • Editing an Enterprise Configuration
        • Importing a LDAP Server Certificate to the DPX Master Server
        • Adding a Node Group
        • Editing a Node Group
        • Deleting a Node Group
        • Adding a Node
          • OES Node Configuration Verification
        • Editing a Node
          • Editing an Advanced Data Agent Port
          • Editing Block Backup Node Information
          • Editing Verification and Cloning Fields for Block Backup Clients
          • Editing SCSI Reserve/Release
          • Update Code Page
        • Moving a Node
        • Deleting a Node
        • Configuring a Virtual Controller
        • File Exclusions
          • Creating New File Exclusion Rules
          • Deleting File Exclusion Rules
        • Generating an Enterprise Report
        • Generating a Node Group Report
        • Generating a Node Report
        • Configuring Parameters
    • Chapter 12: Configuring Devices
      • Elements of the Configure Device Window
      • Configure Device Window Tasks
        • Adding a Device Cluster
      • Registering AWS S3 Cloud Storage
      • Registering Generic Cloud Storage
        • Editing a Device Cluster
        • Deleting a Device Cluster
        • Adding a Device
        • Editing a Device
        • Moving a Device
        • Deleting a Device
        • Adding a Tape Library
        • Editing a Tape Library
        • Deleting a Tape Library
        • Adding a Tape Library Device
        • Editing a Tape Library Device
        • Deleting a Tape Library Device
        • Adding a SAN Device Path
        • Editing a SAN Device Path
        • Deleting a SAN Device Path
        • Assigning and Unassigning Media to/from Tape Library Slots
        • Generating a Device Cluster Report
        • Generating a Tape Library Report
        • Generating a Device Report
    • Chapter 13: Configuring Media
      • Elements of the Configure Media Window
      • Configure Media Window Tasks
        • Adding a Media Pool
        • Editing a Media Pool
        • Deleting a Media Pool
        • Adding a Media Volume
        • Adding Media to a Library Controlled by the Manufacturer’s Interface
        • Editing a Media Volume
        • Moving Media Volumes
        • Filtering the Media Volume List
        • Deleting a Media Volume
        • Generating a Media Pool Report
        • Generating a Media Volume Report
        • Generating a Media Job Report for a Single Media Volume
    • Chapter 14: Configuring Administrators
      • Introduction to Administrator Configuration
      • Resources
      • Privilege Classes
      • Example Configurations
      • Launching the Configure Administrators Window
      • Elements of the Configure Administrators Window
      • Configure Administrator Window Tasks
        • Adding an Administrator Group
        • Editing an Administrator Group
        • Deleting an Administrator Group
        • Adding an Administrator
        • Editing an Administrator
        • Deleting an Administrator
        • Assigning Resources and Privilege Classes
        • Unassigning Resources and Privilege Classes
        • Generating an Administrator Group Report
        • Generating an Administrator Report
    • Chapter 15: Configuring Job Folders
      • Launching the Configure Job Folders Window
      • Elements of the Configure Job Folders Window
      • Configure Job Folders Window Tasks
        • Adding a Job Folder
        • Editing a Job Folder
        • Deleting a Job Folder
        • Deleting a Job
        • Saving Job Definition
    • Chapter 16: Configuring Defaults
      • Elements of the Configure Defaults Window
      • Configure Defaults Window Tasks
        • Setting Backup Default Source Options
        • Setting Backup Default (Base / Incremental / Differential) Destination Options
        • Setting Backup Default Encryption Options
        • Setting Backup Default Job Notification Options
        • Setting Restore Default Source Options
        • Setting Restore Default Destination Options
        • Setting Restore Default Encryption Options
        • Setting Restore Default Job Notification Options
        • Setting Migrate Default Source Options
        • Setting Migrate Default Destination Options
        • Setting Migrate Default Encryption Options
        • Setting Migrate Default Job Notification Options
    • Chapter 17: Configuring Keyrings
      • Introduction to Keyrings
        • Encryption Considerations for Database Applications
        • Software Encryption versus Hardware Encryption
        • Job Options
      • Launching the Configure Keyrings Window
      • Elements of the Configure Keyrings Window
      • Configure Keyrings Window Tasks
        • Adding a Keyring
        • Deleting a Keyring
        • Adding a Key
        • Deleting a Key
    • Chapter 18: Configuring Holidays
      • Elements of the Configure Holidays Window
    • Chapter 19: Configuring Cloud Storage
      • Configuring AWS
      • Configuring AltaVault Storage Appliance
    • OPERATION
    • Chapter 20: Backup
      • Introduction to Backup Functions
        • Quick Overview of Backup Functions
        • Launching the Backup Window
        • Backup Modes
      • Elements of the Backup Window
      • Backup Window Tasks: Overview
      • Defining a New Backup Job
        • Backup Definition: Overview
        • Determining the Backup Mode
        • Begin Defining a New Backup Job
        • Specifying Source Data to Back Up
          • Source Considerations for File Backup
          • Source Considerations for Image Backup
          • Specifying Backup Data on Open Enterprise Server Nodes
          • Backing Up System State
          • Backing Up System Table
          • Backing Up Database Data
        • Specifying Destinations for the Backup Job
        • Defining Backup Options
          • Setting Backup Encryption Options
          • Setting Backup Job Notification Options
        • Specifying File Exclusion Rules for Backups
          • Assigning File Exclusion Rules
          • Revising Existing File Exclusion Rules
          • Creating New File Exclusion Rules
          • Deleting File Exclusion Rules
          • Setting Exclusion Patterns
        • Specifying a Schedule for the Backup Job
          • Planning a Backup Schedule
          • Backup Types
          • Sample Backup Schedules
          • Tape Retention
          • Specifying a Backup Schedule
          • Editing Existing Job Schedules
          • Previewing Scheduled Jobs
        • Specifying an Automatic Migrate Operation
      • Editing an Existing Backup Job
        • Opening an Existing Backup Job Definition
      • Saving a Backup Job
      • Running a Backup Job
        • Monitoring Backup Jobs
      • Rerunning a Failed Backup Job
      • Deleting an Existing Backup Job
    • Chapter 21: Restore
      • Introduction to the Restore Functions
        • Quick Overview of Restore Functions
        • Launching the Restore Window
        • Restore Modes
        • Considerations for Cross-Platform Restores
      • Elements of the Restore Window
      • Restore Window Tasks: Overview
      • Defining a New Restore Job
        • Restore Definition: Overview
        • Determining the Restore Mode
        • Begin Defining a New Restore Job
        • Specifying Source Data to Restore
        • Specifying Source Data for File or Image Restore
          • Filtering Displayed Jobs for a Restore Job
          • Specifying Data to Restore
          • Source Considerations for File Restore
          • Source Considerations for Image Restore
          • Restoring System State
          • Restoring System Table
          • Restoring Single Instance Storage
          • Restoring Databases
        • Specifying Source Data for Tape Restore
          • Choosing Data to Restore for Tape Restore
        • Specifying Source Device Cluster for a Restore
        • Specifying Destinations for the Restore Job
        • Defining Restore Options
          • Setting Restore Encryption Options
          • Defining Restore Job Notification Options
        • Specifying a Schedule for the Restore Job
          • Editing Existing Job Schedules
          • Previewing Scheduled Jobs
      • Opening an Existing Restore Job Definition
      • Editing an Existing Restore Job
      • Saving a Restore Job
      • Searching for Files to Restore
      • Previewing a File Restore Job
      • Running a Restore Job
        • Monitoring a Restore Job
      • Deleting an Existing Restore Job
    • Chapter 22: Master Server Disaster Recovery
      • Introduction to Master Server Disaster Recovery
      • File-Level Recovery of Master Server Operating System
      • Block-level Recovery of Master Server Operating System
      • Obtaining and Using Media to Recover the Master Server Catalog
      • Emergency Licensing
      • Master Server Schedule
      • Resolving Slow Access or Inability to Log In When DNS is Not Functional
      • Resolving Minor Issues Involving Catalog Restore Locking the Management Console from Login
      • Gaps in Catalog Restore and Backup Schedule
      • Continuing Backups and New Base Backups After Master Server Recovery
    • Chapter 23: Copy
      • Introduction to Copy Functions
        • Quick Overview of Copy Functions
        • Launching the Copy Window
      • Elements of the Copy Window
      • Copy Window Tasks: Overview
      • Defining a New Copy Job
        • Copy Definition: Overview
        • Begin Defining a New Copy Job
        • Specifying Source Data to Copy
        • Specifying a Destination for the Data being Copied
        • Creating a New Directory
        • Defining Copy Options
          • Setting Copy Source Options
          • Setting Copy Destination Options
          • Setting Copy Encryption Options
          • Setting Copy Reporting Options
        • Specifying File Exclusion Rules for a Copy Job
        • Specifying a Schedule for the Copy Job
          • Editing Existing Copy Job Schedules
          • Previewing Scheduled Copy Jobs
      • Opening an Existing Copy Job Definition
      • Editing an Existing Copy Job
      • Saving a Copy Job
      • Running a Copy Job
        • Monitoring a Copy Job
      • Deleting an Existing Copy Job
    • Chapter 24: Device Control
      • Introduction to Device Control
      • The Control Devices Window
        • Elements of the Control Devices Window
        • Control Devices Window Tasks
      • Device Operations for Tape Library and Standalone Devices
        • Up-ing a Device
          • Up-ing a Standalone Device
          • Up-ing a Standalone SAN Device
          • Up-ing a SAN Path
          • Up-ing a Tape Library Device
        • Downing a Device
          • Downing a Standalone Device
          • Downing a Standalone SAN Device
          • Downing a SAN Path
          • Downing a Tape Library Device
      • Standalone Device Operations
        • Reading a Label
        • Writing a Label
        • Formatting a Media Volume
        • Verifying a Media Volume
        • Scanning a Media Volume
          • Acquiring a Device
          • Acquiring a Drive in a SAN
          • Releasing a Device
        • Canceling an Operation
        • Monitoring a Selected Device
        • Monitoring All Devices
        • Filtering Displayed Devices in the Control Devices Window
        • Operate Tape Library
      • Using the Operate Tape Library Window
        • Overview of the Tape Library Control Functions
        • Opening the Operate Tape Library Window
        • Elements of the Operate Tape Library Window
        • Operate Tape Library: Tasks
        • Reading a Tape Library Media Label
        • Labeling Tape Library Media
          • Labeling Using Ignore Read Error and Ignore VOLSER Options
        • Formatting Tape Library Media
          • Formatting Using Ignore Read Error
        • Verifying Tape Library Media
        • Scanning Tape Library Media
        • Loading Media to a Tape Library Device
        • Unloading Media from a Tape Library
        • Importing Media Into a Tape Library
        • Exporting Media
        • Refreshing Import/Export Ports
        • Assigning Media in a Tape Library to a Media Pool
        • Canceling the Last Operation
        • Monitoring Operations
      • Cleaning Tape Library Drives
    • Chapter 25: Reports
      • Introduction to Report Generation
      • Report Tasks
      • Additional Considerations for Reports
      • Analytics
    • Chapter 26: Manage Tapes
      • Introduction to Manage Tapes
      • The Migrate Function
        • Considerations for Migration
        • Quick Overview of the Migrate Function
        • Launching the Migrate Window
      • Elements of the Migrate Window
      • Migrate Window Tasks: Overview
      • Defining a New Migrate Job
        • Begin Defining a New Migrate Job
        • Determine Source Pane View
        • Specifying Source Media Volumes or Source Jobs
        • Specifying a Source Device
        • Specifying the Destination Media Pool and Destination Device Cluster
        • Defining Migrate Options
          • Setting Migrate Source Options
          • Setting Migrate Destination Options
          • Setting Migrate Job Notification Options
        • Specifying the Schedule for the Migrate Job
        • Editing Existing Job Schedules
        • Previewing Scheduled Jobs
      • Opening an Existing Migrate Job Definition
      • Editing an Existing Migrate Job
      • Saving a Migrate Job
      • Running a Migrate Job
        • Monitoring a Migrate Job
      • Deleting an Existing Migrate Job
    • Chapter 27: Backup Job Options
      • Define Backup Options: Introduction
      • Job Options for File Backup
        • Setting File Backup Source Options
          • Job Source Options for File Backup
        • Setting File Backup Destination Options
          • Job Destination Options for File Backup
      • Job Options for Image Backup
        • Setting Image Backup Source Options
          • Job Source Options for Image Backup
        • Setting Image Backup Destination Options
      • Job Options for NDMP Backup
        • Setting NDMP Backup Source Options
        • Setting NDMP Backup Destination Options
    • Chapter 28: Restore Job Options
      • Define Restore Options: Introduction
      • Job Options for File Restore
        • Set File Restore Source Options
          • Job Source Options for File Restore
        • Set File Restore Destination Options
          • Job Destination Options for File Restore
      • Job Options for Image Restore
        • Set Image Restore Source Options
          • Job Source Options for Image Restore
        • Set Image Restore Destination Options
          • Job Destination Options for Image Restore
      • Job Options for NDMP Restore
        • Set NDMP Restore Source Options
          • Job Source Options for NDMP Restore
        • Set NDMP Restore Destination Options
          • Job Destination Options for NDMP Restore
      • Job Options for Tape Restore
        • Set Tape Restore Source Options
          • Job Source Options for Tape Restore
        • Set Tape Restore Destination Options
          • Job Destination Options for Tape Restore
    • Chapter 29: Pre-Scripts and Post-Scripts
      • Job Definition Scripting Fields
      • Using Pre-Scripts and Post-Scripts on UNIX or Windows
      • Retrieve Backup Information using Pre-Scripts and Post-Scripts Variables
        • Variables
      • Pre-Script and Post-Script Snapshot for Block Backups
    • Chapter 30: Log Management
      • Collecting Job Logs by Using the Management Console
      • Introduction to Log Management Models
      • Purpose and Scope
      • File Size Considerations
      • Log File Name and Format
      • The BEXCollect Utility
        • Running BEXCollect
      • Setting Environmental Variables for Logging Model and BEXCollect
        • Additional Variable Information
    • TAPE LIBRARY SETUP
    • Chapter 31: Introduction to Tape Library Setup
      • About the Tape Library Topics
      • Key Concepts
      • Process Overview
    • Chapter 32: Tape Library Pre-Setup
      • Before You Start
        • Prepare to Use Detect
        • Run Detect
    • Chapter 33: Device Configuration Wizard
      • Introduction
        • Platform Considerations
        • Devices Not Auto-Configurable
      • Executing the Device Configuration Wizard
        • Launching the Device Configuration Wizard
        • Using the Device Configuration Wizard
    • Chapter 34: Device Detection
      • Introduction
      • detect -q
      • More About the Detect Utility
    • Chapter 35: Manual Tape Library Installation
      • Tape Library Installation on Windows
      • Tape Library Installation on Solaris
      • Tape Library Installation on Linux
      • Tape Library Installation on HP-UX
        • Installing a Tape Library on an HP S800 Running HP-UX 10.x
        • Installing a Tape Library on an HP S700 Running HP-UX 10.x
      • Tape Library Installation on AIX
        • Procedure 1
        • Procedure 2
    • Chapter 36: Tape Library Verification
      • Testing the Tape Library Installation
    • Chapter 37: Overview of Manual Tape Library Configuration
      • Introduction to Manual Tape Library Configuration
      • Overview: Defining Tape Libraries and Tape Drives
        • Before You Begin
        • Adding Tape Library and Tape Drives to the Enterprise
        • Determining Device Number and Device ID
      • Overview: Media Configuration
      • Overview: Backing Up Data to the Tape Library
    • Chapter 38: Setting Up LTO Tape Drives for Hardware Encryption
      • Overview of Setting Up LTO Tape Drives for Hardware Encryption
      • Procedures for Setting Up LTO Tape Drives for Hardware Encryption
        • Procedure 1. Enable Hardware Encryption
        • Procedure 2. Configure the Windows Device Server to Use the Bexsptape Device Driver
        • Procedure 3. Run Detect
    • CLUSTERS
    • Chapter 39: Windows Clusters
      • Introduction to Windows Clusters
        • Physical Representation of a Windows Cluster
        • Logical Representation of a Windows Cluster
      • Setting Up a Windows Cluster
      • Configuring Windows Clusters
      • SQL Server and Exchange Support in Clusters
        • Considerations for SQL Server Restores in a Cluster
        • Exchange Folder Level Setup in a Cluster
      • Windows Cluster Support in a SAN
      • Backup and Restore for Windows Clusters
      • Manual Setup Procedure for Clusters
      • Clustered Shared Volumes
        • CSV Configuration in DPX
        • CSV Backup and Recovery in DPX
        • Additional Considerations for CSV in DPX
    • Chapter 40: Micro Focus OES Clusters
      • A Micro Focus OES Cluster Example
      • Setup and Configuration of OES Clusters
      • Cluster Support in a SAN
      • Backup and Restore for Open Enterprise Server Clusters
    • SPECIAL PROCEDURES
    • Chapter 41: Using Oracle StorageTek Automated Cartridge System Library
      • ACS Concepts and Terminology
      • Configuration Overview for ACS
        • Configuring the ACSLS Server
        • Configuring the Client
        • Configuring the Tape Library
        • Configuring the ACS Device
        • Configuring ACS Media Pools and Volumes
        • ACSLS Interactions
          • Backup Process
          • Restore Process
      • Removing and Inserting Tapes
      • Cleaning ACS Drives
      • Unique Features
      • Running Backups
    • Chapter 42: Using Quantum ADIC AML or SDLC Automated Storage Library
      • Configuration for AML
        • Configuration Overview for AML/SDLC
        • DAS Configuration File
        • Configuration Files
        • Adding an AML/SDLC Virtual Tape Library
        • Partitioning an AML/SDLC Virtual Tape Library
        • Adding an AML/SDLC Device
        • Adding AML Media Pools and Volumes
      • Operation
        • AML/SDLC Tape Library Control
        • Cleaning Considerations
        • AML/SDLC Interaction
      • Special Features
    • INTERFACES
    • Chapter 43: Introduction to Interfaces
      • Considerations for Interfaces
    • Chapter 44: Command Line Interface
      • Message Log
      • Conventions
      • Setting Environmental Variables for the Command Line Interface
      • BEX
        • BEX Command Overview
      • BEX Commands
        • backup define
        • backup run
        • restore define
        • restore run
        • restore report
        • restore reportnext
        • migrate define
        • migrate run
      • Job Definition Language
        • A Quick Reference
        • Options Statement
        • Backup Statement
        • Restore Statement
        • Migrate Statement
      • Examples of Command Line Interface
      • Running Backup Jobs from the Command Line
        • Running a Backup Job Using the BEX Utility
        • Setting Backup Retention
        • Defining Backup Jobs
    • Chapter 45: SNMP Interface
      • Enabling DPX SNMP Traps
      • Setting Up DPX to Run with Management Software
      • DPX SNMP Trap References
    • Chapter 46: NDMP Backup and Restore
      • Backup and Restore with Generic NDMP
        • Generic NDMP Backup and Restore Variations
        • Generic NDMP Backup and Restore Protocol Access
        • Considerations for Generic NDMP Backups
        • Scheduling an NDMP Backup
      • Restoring with Generic NDMP
        • Considerations for Restoring with Generic NDMP
        • Browsing Generic NDMP Restore Source Data with File History Processing
        • Generic NDMP Restore with File History Processing
        • Generic NDMP Restore without File History Processing
        • Previewing a Generic NDMP Restore Job
        • Direct Access Recovery with Generic NDMP
        • Scheduling NDMP Restores
      • DPX with NetApp Data ONTAP 7-Mode
        • NetApp Configuration with DPX for 7-Mode
        • NDMP Backup and Restore Variations for 7-Mode
        • NDMP Backup and Restore Protocol Access for 7-Mode
        • Defining a DPX NDMP Backup of the Latest Snapshot for 7-Mode
        • Defining a DPX NDMP Dump Backup of Predictable Snapshot Names for 7-Mode
        • DPX NDMP Restore for 7-Mode
      • DPX with NetApp Clustered Data ONTAP
        • Backing Up Data ONTAP Clusters
        • Restoring Data ONTAP Clusters
        • Troubleshooting Restore Errors
      • NDMP Backup and Restore: Dump and SMTape
      • NetApp NDMP Hardware Encryption
        • Requirements and Considerations for NDMP Hardware Encryption Backups
        • Defining Backups for NDMP Hardware Encryption
        • Running an NDMP Backup with Hardware Encryption
        • Running an NDMP Restore from Encrypted Tapes
    • Chapter 47: Oracle Interface
      • Oracle Interface Background
      • Advantages of Using DPX
        • Performance Advantages
        • Centralized Management
        • Regularly Scheduled Backup
      • About Oracle Backup and Restore
      • Backing Up an Oracle Database
      • Restoring an Oracle Database
      • Oracle Interface Installation
        • Pre-Installation Instructions
        • Pre-Installation Checklist
        • Installation and Configuration Process
        • Creating and Editing RMAN Scripts
        • Editing the Parameter File
    • Chapter 48: Microsoft Exchange Interface
      • Introduction to Exchange Interface
        • Exchange 2007 Considerations
        • DPX Block Data Protection Considerations for Exchange
        • Support Levels for Exchange
        • Cluster Considerations for Exchange
      • Folder Level Setup
        • Option 1 - bexbrick
        • Option 2 - Profile Utilities
      • Backing Up Exchange
        • Folder Level Backup
        • Database Level Backup
      • Restoring Exchange
        • Folder Level Restore
        • Database Level Restore for Exchange 2003/2007
    • Chapter 49: Using EMBR for Rapid Recovery of Exchange Mailbox Items
      • Introduction
      • How EMBR Works
      • How EMBR Works with Instant Access
      • Example Use of EMBR with Instant Access
    • Chapter 50: SQL Server Interface
      • SQL Server Interface Background
      • SQL Server Setup
      • SQL Server Backups
        • Default and Named Instances
        • Running SQL Server Backups
      • SQL Server Restores
        • Running SQL Server Restores
        • Point-in-Time Recovery
    • Chapter 51: SharePoint Interfaces
      • Introduction to SharePoint Interface
      • Backing Up and Restoring SharePoint Portal Server 2007
      • Backing Up and Restoring SharePoint Portal Server 2003 and Windows SharePoint Services
        • Server Farms
        • Backing Up SharePoint Portal 2003 and Windows SharePoint Services Data
      • Restoring SharePoint Portal 2003 and Windows SharePoint Services Data
        • Restoring an IIS Configuration
        • Restoring a SharePoint Configuration
        • Restoring a SharePoint Content Database
      • Backing Up and Restoring SharePoint Portal Server 2001
    • Chapter 52: Using SPOR for Rapid Recovery of SharePoint Objects
      • Introduction
      • How SPOR Works
      • Supported Operating Systems and Applications
        • Considerations for SPOR with SQL Server
      • Additional Requirements
      • How SPOR Works with Instant Access
      • Using SPOR with Instant Access: A Quick Example
    • Chapter 53: DB2 Interface
      • Configuration of DB2 Interface
        • Confirm Setup
      • Backing Up DB2 Databases
        • Option 1 - Using DB2 Control Center GUI
        • Option 2 - Using Scripts
      • Restoring DB2 Databases
        • Using Scripts
      • DB2 Job Control
      • Other Features of DB2 Interface
        • Log Files for DB2
        • Archive Logging
        • Performance Considerations
      • DB2 Backup and Restore Commands on Windows
        • Windows DB2 Backup Commands
        • Windows DB2 Restore Commands
      • bexdb2util/CatView Utility
        • Format of CatView (Windows)
        • Format of bexdb2util (UNIX)
        • Options for bexdb2util and CatView
    • Chapter 54: SAP Interface
      • SAP Interface Background
      • Advantages of Using DPX
      • About SAP Backups
      • About SAP Restores
      • SAP Interface Installation
    • Chapter 55: Lotus Notes/Domino Interface
      • Introduction to Lotus Notes/Domino Interface
      • Lotus Notes/Domino Interface Setup
      • Backing Up Lotus Notes Databases
      • Restoring Lotus Notes Databases
      • Point-in-Time Recovery of Lotus Notes Databases
      • Disaster Recovery of Lotus Domino Server
    • Chapter 56: Micro Focus GroupWise Interface
      • Backups and Restores of GroupWise
      • GroupWise and DPX
      • GroupWise Backup and Restore
      • GroupWise Backup Scenarios
        • Introduction to GroupWise Backup
        • GroupWise Backup Scenario: Linux OES
          • Step 1: Load TSAFS with GroupWise functionality on Linux OES
          • Step 2: Load TSAFSGW on Linux OES
        • Running GroupWise Backups
      • GroupWise Restore Scenarios
        • Restore Scenario 1: Disaster Recovery – All GroupWise Information Lost
        • Restore Scenario 2: Disaster Recovery – One GroupWise Server Lost
        • Restore Scenario 3: Disaster Recovery – Bad Post Office Data
        • Restore Scenario 4: Individual Message Recovery
        • Restore Scenario 5: User Account Recovery
    • ACRONYMS AND TERMINOLOGY
      • Acronyms
      • Terminology
    • Trademarks
  • COMPATIBILITY GUIDE
    • Overview
      • Virtual Environments
      • Operating Systems
      • Applications
    • General Information
      • Scope
      • Terms
      • Backward Compatibility of Catalogic DPX Master Server and Clients
      • Catalogic DPX Master Server and Requirements
      • Catalogic vStor Server Requirements
    • Support Lifecycle Schedule
      • End-of-Support Schedule for Catalogic DPX Versions
      • End-of-Support Announcement
      • Notable Unsupported Solutions
    • Cloud Storage
      • Supported Cloud Storage Services for File-level Backup and NDMP-level Backup
      • Supported Cloud Storage Services for Agentless Archive, Block Archive, and NDMP-level Backups
      • Cloud Storage Features
    • NetApp Support
      • NDMP Backup Support
    • Encryption Support
      • Catalogic DPX Software Encryption Support
      • Catalogic DPX Hardware Encryption Support
      • NDMP Encryption Compatibility
    • Hardware Compatibility
      • Supported CPU Architectures
      • Tape Libraries, Virtual Tape Libraries, and Standalone Tape Device
    • Catalogic DPX Management Interfaces
      • HTML5-based DPX Management Interface
      • Java-based DPX Management Interface
    • Virtual Environment Support
      • Agent-based Block Backup
      • Agentless Backup for VMware
      • Agentless Backup for Microsoft Hyper-V
    • Operating System Support
      • Microsoft Windows
      • Red Hat Enterprise Linux (RHEL)
      • CentOS Linux
      • Oracle Linux
      • SUSE Linux Enterprise Server (SLES)
      • Canonical Ubuntu
      • Debian
      • Micro Focus Open Enterprise Server (OES)
      • IBM AIX
      • FreeBSD
    • Application Support
      • Oracle Database
      • Microsoft SQL Server
      • IBM Db2
      • SAP HANA
      • SAP R/3
      • Microsoft Exchange Server
      • Microsoft SharePoint Server
      • Micro Focus GroupWise
      • HCL Notes and HCL Domino
    • ACRONYMS AND TERMINOLOGY
      • Acronyms
      • Terminology
    • Notices
      • Trademarks
Powered by GitBook
On this page
  1. REFERENCE GUIDE
  2. Chapter 30: Log Management
  3. Setting Environmental Variables for Logging Model and BEXCollect

Additional Variable Information

Last updated 2 years ago

For information about setting variables not handled by the Parameter Configuration Interface, refer to the following resources:

  • The Knowledge Base at .

Setting Environmental Variables for the Command Line Interface
A Note on Environmental Variables
MySupport