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
  1. Backup
  2. NDMP Backup (desktop interface only)
  3. Creating an NDMP Backup Job

Job Source Options for NDMP Backup

PreviousCreating an NDMP Backup JobNextJob Destination Options for NDMP Backup

To access the job source options, do the following:

  1. Go to the Backup tab.

  2. In the Backup Modes section, select File.

  3. Open an already existing backup job. Or go directly to step 4 to set source options for the new job you will be defining directly afterward.

  4. Go to the Other Tasks section in the task panel (scroll down if necessary) and select Set Source Options. The Set Job Source Options dialog will appear.

The Set Job Source Options dialog allows you to set options related to backup sources. This section provides an explanation of each field in the dialog and the available choices.

The Source tab

Down Node Retries

Controls how DPX behaves when it cannot establish contact with a node during a backup operation. If you enter zero, DPX skips unreachable nodes. If you enter a number, DPX waits until all the reachable nodes have been backed up and then retries the nodes that it could not back up on its first attempt. The number you enter determines how many times DPX tries to reach unreachable nodes.

Task Retry Intervals (Minutes)

Determines how long to wait before retrying failed tasks.

When a task fails (due to permission problems, open files, interim job changes, etc.), it waits the number of minutes specified in this field before attempting that task again. Because the same failure might occur if the task is retried too soon, it is better to allow some time for an error to be corrected before retrying the task. A task is only retried once. Failing tasks appear in error message lists in the Job Log. All tasks are subject to retry.

NDMP File History Handling

Controls file history generation for NDMP and Block backup tasks.

Disable File History

Disables NDMP server file history generation.

Process File History on Local Client

Enables NDMP server file history generation and processes the file history data on the NDMP client node. This is the default.

Process File History on Master Server Appliance

Enables NDMP server file history generation but transmits the file history data to the master server node for processing.

Enable NDMP Server Logging

Controls the routing of NDMP server-generated log messages to the job log file.

Yes

All NDMP server log messages will be routed to the master server’s job log file. Yes is the default.

No

The NDMP server log messages will be logged locally in the NDMP client node log file instead of in the master server’s job log file.

Additional NDMP Environment

This option allows you to introduce any additional NDMP environment variables that are necessary for the backup task. Specify your environment variables as an ASCII string with an environment variable name and value pairs using the following syntax:

env1name=value,env2name=value,...

Note. Syntax validation is not performed on the specified value at job definition time, but rather at run time. Only valid entries are added to the NDMP operation environment.

Note. Alternative syntax, e.g. env1name value;env2name value;... (semicolon-delimited, no equal sign) or env1name valueenv2name value... (no delimiter, no equal sign) may be displayed in the interface. However, for the sake of clarity, the env1name=value,env2name=value,... version is strongly recommended.

Attention! Do not specify any of the following NDMP environment variables in your variable string because DPX controls these specifically:

  • BASE_DATE

  • DEBUG

  • DIRECT

  • DUMP_DATE

  • EXTRACT

  • FILES

  • FILESYSTEM

  • HIST

  • LEVEL

  • PREFIX

  • RECOVER_FILEHIST

  • SINCE_TIME

  • TYPE

  • UPDATE

  • VERBOSE

Specifying the variables above may cause unexpected results due to the unpredictability of the order in which they are evaluated.

NDMP servers from different vendors may support different NDMP environment variables. Except for a few well-known environment variable names, there is currently no standardized set of such variables. This option allows you to add environmental variables specific to your NDMP server.

The Script tab

Pre-Job Script

Enter the name of a script to execute prior to the actual job.

Basic usage: <script>@<node_name> <argument_list>

If Pre-Script fails

The action be taken if the Pre-Job Script fails to successfully complete:

  • Run Job/Run Post-Job Script

  • Skip Job/Run Post-Job Script

  • Skip Job/Skip Post-Job Script

If Job fails

The action to be taken if the Job fails to successfully complete:

  • Run Post-Job Script

  • Skip Post-Job Script

Post-Job Script

Enter the name of a script to execute after the actual job.

Basic usage: <script>@<node_name> <argument_list>

For information on using Instant Access for file-level restore, see in the DPX 4.9 User’s Guide.

See also. For detailed information about pre- and post-job scripts, including all valid definitions, see .

Instant Access as a File History Alternative
Pre-Scripts and Post-Scripts