Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Tip. DPX Master Server can be deployed before or after installing the DPX Client. It does not interfere with the process in any way.
The following instructions assume you have a dedicated virtual machine host and are not deploying on your personal computer, which is used only to deploy DPX on the host.
Download the OVA file from the Catalogic MySupport page:
Login to Catalogic MySupport using the provided credentials.
From the product list, select DPX 4.10.
Click DPX Server and Clients under Software.
Click the link to start downloading the .OVA file.
Once the file is downloaded, log in to vSphere.
Right-click on the folder where you want to deploy your virtual machine.
Deploy OVF Template wizard will initiate.
Select an OVF template In this step, provide the .OVA file destination, either as a URL to a remote server or by downloading the file. In our scenario, we’ve downloaded the file. In such case, select “Local file” and browse to the file location. Click Next.
Select a name and folder Specify the name for your virtual machine and its location. Please remember machine names on vCenter must be unique. Click Next.
Select a compute resource Select the computer resource that will be available to your virtual machine. Click Next.
Review details Verify the template details. Click Next.
License agreements In this step, you must accept the license agreements. Check the checkbox and click Next.
Select storage Define where the virtual machine’s disk will be stored, and choose between thin and thick provisioning. This setting determines whether all disk storage defined for the machine will be exclusively available (thick), or only the disk space actually occupied is used (thin). Click Next.
Select networks Select the network for your virtual machine. Click Next.
Customize template Here you are required to fill in some parameters.
Hostname Configuration
Hostname
Please remember that hostname must be unique within the network, domain and Enterprise.
Connection Configuration
Provide all parameters for static IP address. Leave all blank in case of DHCP.
Network IP Address
Fill in, if you want to have a static IP address.
Network Prefix
If you want to have a static IP address, you must provide all connection parameters, including network prefix.
Default Gateway
The default gateway address for this VM.
DNS Servers
Comma-separated domain name servers for this VM.
Keyboard Language Configuration
Keboard Language
Type in two-characer language code.
Timezone Configuration
Set to “America/New_York” by default. Can be changed afterwards.
Click Next.
Ready to complete This screen contains a summary of the previous steps. Please review all the information before you click Finish.
You have now completed the deployment of DPX.
Catalogic DPX delivers unprecedented speed and savings with a single unified data protection solution making backup and disaster recovery smarter, faster, and more efficient. It is uniquely designed to handle the most common data protection use cases that are challenging for IT departments.
You can deploy Catalogic DPX quickly and it scales easily to match the needs of rapidly growing cloud infrastructures. Additionally, the software exploits modern server virtualization and is optimized for the backup and recovery of virtual systems.
Catalogic DPX Block Data Protection provides rapid and efficient backup, restore, Bare Metal Recovery, application protection and tape archiving. A complex backup environment can have multiple backup Enterprises, each with more than one secondary system, including NetApp storage and Catalogic DPX Open Storage.
A basic DPX environment consists of a DPX Master Server, a DPX Client and a storage device.
The master server is typically deployed on a virtual machine. It manages data transfer between the machines from which data are backed up, and the devices where backed up data are stored and where they are restored from.
The DPX Client is an agent deployed on the machine (either physical or virtual) containing data you are backing up. It allows the DPX Master Server to access the data on the machine to create backups and restore data.
There is also a method to back up virtual machines under a hypervisor without backup agents on the virtual machines. This backup method is called agentless.
Each machine, whether physical or virtual, is referred to as a node. The master server is a DPX node that contains DPX software, including the Catalog and modules that control scheduling, media management, and distributed processing. There is one master server per data protection Enterprise. Any machine the master server communicates with must be added to the Enterprise as a node. Nodes where DPX Client is installed are called client nodes. The master is also visible as a node and thus can back up data from itself.
The Catalogic DPX environment features two graphical user interfaces for managing backup and restore activities called jobs. One interface is a Java-based desktop application. To run it, you need to install the Java environment first. The other interface is an HTML5-based web application that does not require additional installation apart from a supported web browser.
The desktop interface provides access to most DPX features but is gradually replaced with the new web interface and will be deprecated in the future.
The web interface only requires a web browser to run. This interface covers most typical DPX functionalities and is continuously developed to finally replace the old desktop application.
Some features described in this guide are optional and separately licensable. For inquiries regarding licensing of optional features, contact your data protection account representative.
Catalogic DPX data protection software does not currently support Unicode for DPX-specific objects such as jobname, devicepath, qtree name, etc. Use the English character set only.
Note. Screen illustrations shown in this guide may not exactly match those found in your product implementation due to variations in customization or updates.
Currently, Catalogic DPX offers access either through the web (HTML5-based) interface from your browser or through the desktop (Java-based) application requiring a Java environment installed on the machine you are accessing the Catalogic DPX from. The desktop application is older and will be soon deprecated. The web interface is continuously developed and currently supports all typical Catalogic DPX functionalities, as well as some new features that will never be available using the desktop interface.
You may log in to the DPX Master Server through either of the user interfaces, as described below.
See also. For more details concerning logging in and detailed handling of either user interface, go to the respective documentation sections:
To launch the Catalogic DPX Master Server web interface, do the following:
Open a web browser on a machine with access to the same network the Master Server has been deployed in.
Type the Master Server IP address into the web browser’s address bar and press Enter.
In the login screen, enter the username and password for the Catalogic DPX Master Server. The default login credentials are:
login
sysadmin
password
sysadmin
Click the Login button. The DPX Master Server Dashboard will appear.
When logging in for the first time, you will be prompted to change the password. Your new password must:
contain from 6 to 48 characters,
contain at least 1 number and 1 letter,
not contain your username or the keyword admin.
After changing the password, you won’t need to log in again; you will be taken to the DPX dashboard.
To launch the Catalogic DPX Master Server desktop interface, you need to have a Java environment installed on your machine. We recommend downloading the OpenWebStart framework to open the .jnlp file (see below).
If you are launching the desktop interface for the first time, select Run the DPX Java User Interface. This will start the download of the dpx.jnlp file which is used to launch the desktop interface app. If you already have the file downloaded, proceed to step 2.
Run the dpx.jnlp file. It is an executable file, so for security reasons, you may be prompted whether you still want to launch it. Select OK.
Restrictions. In some versions of Java, the application might be blocked by Java Security. In such case, follow the Java environment provider’s instructions to change the security settings or add the application to the exceptions list.
In the Connect to DPX window, enter the server name or IP address (you can also select it from the list, if you have logged into the server in the past), then provide the username and password for the Catalogic DPX Master Server.
The default login credentials are:
login
sysadmin
password
sysadmin
Click the Login button. The DPX desktop dashboard will appear.
Note. Further instructions concerning interactions with the DPX interfaces are presented in the form of selectable tabs, describing the same action for each interface separately.
Step-by-step instructions for the web interface.
Step-by-step instructions for the desktop interface.
You can deploy the Catalogic DPX Master Server virtual appliance in the Microsoft Hyper-V environment.
See also. To deploy the Catalogic DPX Master Server virtual appliance for VMware, see .
Take the following steps to deploy the Catalogic DPX Master Server for Microsoft Hyper-V:
From your workstation, open a web browser and log in to the Catalogic website.
Go to the product page for DPX v.4.10 and see the section DPX Master Server appliance template. Download the Microsoft Hyper-V template file.
Log in to Microsoft Windows Server Hyper-V to deploy the Catalogic DPX Master Server virtual appliance. Copy the .ISO file to the system.
Attention! Do not attempt to deploy the Catalogic DPX Master Server virtual appliance on your regular workstation for daily tasks. Always use a dedicated machine.
Verify the file integrity of the .ISO file by comparing the MD5 checksum values. Open either Microsoft PowerShell or Microsoft Windows PowerShell. You can use a command similar to the following example:
Compare this value with the original MD5 checksum value in the product page.
In Microsoft File Explorer, open the folder to which you downloaded the .ISO image file.
Right-click the .ISO image file and click Mount.
Open the disk image drive DPX, and open DPX-setup.exe as Administrator to open the DPX 4.10 Setup Wizard window. Click Next to proceed.
Read the Software License Agreement. If you accept this agreement, select I accept the agreement and click Next.
Ensure that the product directory is set to the default path: C:\Program Files\DPX\
. Or select another empty folder to install the product.
Select one of the Virtual Switches in the list and click Next.
Configure the network settings of the virtual appliance.
Click Next to proceed.
Specify the keyboard layout and time zone (TZ) of the Linux operating system for the Catalogic DPX Master Server.
In the Keyboard Language field, enter either one of the available keyboard layouts for the Catalogic DPX Master Server: us
for US English, uk
for UK English, de
for German, fr
for French, pl
for Polish, or cn
for Chinese. Or leave the default value us
.
Enter the time zone (TZ) variable for the system. The default value is America/New_York
for the US Eastern Time. You can use either one of the TZ values that are listed on the WorldTimeAPI website: .
Click Next to proceed.
In the Ready to Install page, click Next to start installing the Catalogic DPX Master Server programs for Microsoft Windows.
Open Microsoft Hyper-V Manager. Ensure you can see the new VM for the Catalogic DPX Master Server virtual appliance.
The DPX Master Server is deployed as an Open Virtualization Format (OVF) template in a VMware environment. The recommended method for installing DPX Client and OSS is to download an .ISO file from the customer service website, mount the .ISO at a shared network location, open the .ISO file, and launch the appropriate installer. If an .ISO image is not suitable for you, request physical DVDs from the Catalogic Software Data Protection Technical Support.
You can deploy the Catalogic DPX Master Server virtual appliance on either VMware or Microsoft Hyper-V by using the template file (.OVA or .ISO, respectively). The default deployment template will include the following configuration:
DPX Master Server can be deployed either using VMware’s vSphere, or Microsoft’s Hyper-V solutions:
Hostname
Enter the host name or fully qualified domain name (FQDN) of the virtual appliance. The default value is dpx-master
.
dpx-master-singapore1
Network IP Address
Assign a static IPv4 address of the virtual appliance. Or, leave this field blank so that a dynamic IPv4 address is automatically assigned via the Dynamic Host Configuration Protocol (DHCP) in the network.
10.0.0.100
Network Prefix
Enter the subnet prefix for IPv4 and the Classless Inter-Domain Routing (CIDR) notation. Or, leave this field blank so that a dynamic IPv4 address is automatically assigned via the DHCP in the network.
16
Default Gateway
Enter the IPv4 address of the gateway in the network. Or, leave this field blank so that a dynamic IPv4 address is automatically assigned via the DHCP in the network.
10.0.0.1
DNS Servers
Enter the IPv4 addresses of the domain name system (DNS) servers. You can enter multiple addresses by separating these with a comma ,
. Or leave this field blank so that a dynamic IPv4 address is automatically assigned via the DHCP in the network.
10.0.0.10
10.0.0.11
CPU
Four virtual CPUs
Memory (RAM)
16 GB
Operating system
AlmaLinux 8.8 for Catalogic DPX Master Server (included in the package)
Data Disk Subsystem
Required: 270 GB HDD space
Network adapter
Recommended: 10 Gbps Minimum: 1 Gbps
See also. For documentation of previous versions of DPX, go to:
For compatibility specifications, go to:
For other Catalogic Software products, see:
Or go back to the Catalogic Software Documentation Portal.
This Basic Configuration section will help you get started with setting up your DPX environment, understanding its key components, and configuring backup and restore operations.
Data Protection Management: DPX Master Server The central control unit for managing and monitoring all backup and restore operations. Typically, the DPX Master Server is deployed from an .OVA as a dedicated virtual machine.
Backup Agents/Connectors:
DPX Client Agent software installed on the systems that are being backed up. DPX Client executes backup and restore tasks on the client machine.
Hyper-V Agent Agent software installed on Hyper-V hypervisor to communicate with VMs during backup and restore tasks. With Hyper-V Agent, there is no need to install DPX Client software on individual Hyper-V machines.
DPX Proxy Server A dedicated intermediary for backup and restore operations in VMware environments. The DPX Proxy Server helps in offloading tasks from the Master Server and optimizing data flow between backup sources and storage devices.
Storage: vStor vStor is a virtual storage appliance consolidating backup data into a scalable, efficient storage solution. vStor is smoothly integrated with the Catalogic DPX environment. It supports deduplication, compression and encryption, optimizing storage usage and data security. (other non-Catalogic storage solutions compatible with DPX are possible, such as tape libraries, DiskDirectory, cloud storage or NetApp)
Security: GuardMode Provides early detection of possible ransomware events and data anomalies to protect backups from being compromised. It monitors file systems on backup clients, identifying potential threats and alerting administrators to ensure the integrity of backup data, employing strategies such as blocklist monitoring, honeypot files, and threshold monitoring to detect and mitigate possible ransomware activities.
DPX Master Server
DPX Client on source machine
Storage device (tape library or DiskDirectory)
DPX Master Server
DPX Client on source machine
Storage device (vStor or NetApp)
DPX Master Server
DPX Client on source machine (DPX Client automatically detects supported applications)
Storage device (tape library, Disk Directory, vStor or NetApp)
DPX Master Server
VMware hypervisor (Agent installation not required)
DPX Proxy Server
Storage device (vStor or NetApp)
DPX Master Server
Microsoft Hyper-V Agent installed on the hypervisor
Storage device (vStor or NetApp)
Ensure ports required by DPX are open:
6123 on DPX Master Server, DPX Client, DPX Proxy Server for communication
9101 on DPX Master Server for autoupdates
9104, 9202 on DPX Client for autoupdates
Stable network connectivity between all components
DNS resolution for all servers and clients (recommended)
Sufficient storage space for backups
Properly configured storage devices and pools
The Catalogic DPX Client is a component of the Catalogic DPX data protection solution. DPX Clients are installed on systems that need to be backed up. They allow users to define and run backup, copy, and restore jobs for these systems. DPX Client installed on destination machines also provides features for controlling tape devices, managing reports and logs, and performing maintenance tasks on the Catalog.
You can install the DPX Client on Microsoft Windows and Linux machines. There are separate releases of the DPX Client application for Windows and Linux operating systems. Before installing, make sure all necessary software and hardware requirements are met.
For details concerning the installation procedures for a specific operation system, see the appropriate sections below.
To uninstall the Catalogic DPX Client from your Microsoft Windows system, click Start in the taskbar, locate the program group for Catalogic DPX, click Uninstall, and follow the instructions in the subsequent dialog boxes.
Tip. To confirm the uninstalling process was successful, after uninstalling Catalogic DPX for Microsoft Windows, you can check the uninstall log file: %userprofile%/DPXuninstall.log
.
Your DPX is ready to use the moment you log in to it for the first time. However, there are two things worth configuring, namely your password (if you haven’t changed it already) and e-mail settings.
Restrictions. Currently, only insecure e-mail servers are supported, i.e. servers using SSL/TLS protocol cannot be used.
Changing your password:
Click on the user name on the top menu bar and then click Change Password.
The new password must:
contain from 6 to 48 characters,
contain at least 1 number and 1 letter,
not contain username or keyword ‘admin’.
After changing the password, you won’t need to log in again; you will be taken to the DPX dashboard.
Adding Administrator E-mail Settings:
Click the Settings ( ) button on the top menu bar. You will be taken to the Enterprise Information panel.
Select Administrator E-mail Settings and click Add.
To change the password or edit Administrator E-mail settings:
Select Configure from the tab menu.
From the Configuration Operations menu on the left, click on Enterprise.
Select Edit Enterprise from the Enterprise Tasks menu below.
the Edit Enterprise menu will open on the right. There, you can change the password and edit Administrator E-mail Settings.
Remember that the new password must:
contain from 6 to 48 characters,
contain at least 1 number and 1 letter,
not contain username or keyword ‘admin’.
Click Apply.
See also. For more information about the administrator e-mail settings, see Administrator E-mail Settings.
Go to the Catalogic website and log in.
Navigate to the product page and go to Software Download > New installations or deployments > Client Software Installation.
Download the installation program (full or client-only) of the DPX Client for Windows.
Copy the installation program to the Windows system you want to protect.
Close all programs and ensure that the Windows Installer service is active.
Right-click the installation program and select Run as administrator.
Follow the instructions in the installation dialog window, including accepting the Software License Agreement.
If you are using the full version installer, you can select and install additional components, such as the Virtualization Proxy Server application or OSS Server.
In the Add Node to Enterprise page, select Yes, add this node to the Enterprise checkbox to register this client node to the Enterprise and thus make it visible for the DPX Master Server. If you are installing on a cluster node, note that each cluster requires a dedicated node group. Add a cluster node to its dedicated node group. Add only cluster nodes to a cluster node group. If you do not want to add the node to the Enterprise, clear the checked option. You can always add the node later from the Master Server interface. See .
Leave the Logical Node Name which is the computer name of this Microsoft Windows system by default. Or, you can rename the logical node name in the input field.
Leave the Node Group Name field DefaultGroup which is the default node group. Or enter a different node group name either to create a new node group in the Enterprise or to specify an existing node group with the same name. Click Next to proceed.
On the Master Server page, enter the Master Server Hostname. This is the resolvable name of the master server. Optionally, you can enter the Master Server IP address. Click Next.
Attention. This field cannot be left blank. If you do not want to or are unable to provide the Master Server Hostname, go back to the previous step and uncheck the Yes, add this node to the Enterprise box.
Click Install to start the installation.
(Optional) If you are installing on a SharePoint node, a message alerts you to later complete the configuration of the SharePoint node by using the Configure function of the management console.
(Optional) If you are installing the DPX Client on a cluster node, the Cluster Setup dialog appears. A cluster dry run should be executed to run a test of the cluster configuration. Enter a Virtual Cluster IP and the appropriate Subnet IP. Cluster Dry Run. Enter the required information to define the cluster node.
Domain Administrator. Populate all information for the cluster domain administrator.
Cluster Name. Enter a unique name, up to 15 characters, for the virtual resource. This is the DNS name of the virtual node. This name must not be the Windows cluster name that appears under the field.
Physical Node IP. Select the IP address for the node.
Virtual Node IP. Enter the IP address for the virtual resource. This must be an available public network address different from the cluster IP address. When you install on other nodes in the cluster, supply this same IP for each node. This IP cannot be the Windows cluster IP or IP used by any other cluster service.
Subnet mask. Enter the subnet mask for the virtual resource. This field is enabled only for the final cluster node.
Cluster Network. Select the local network name to use. This field is enabled only for the final cluster node. Click Next.
In the Ready to Install Program dialog, click Install to start installing the DPX Client for Microsoft Windows. You may be warned that you do not have enough disk space to successfully install the software.
After the installation completes, the Completion dialog appears. Select the Read additional requirements and install summary check box. This instructs InstallShield to display a summary of the file instNote.txt, which can be found in the logs directory. This file and the summary contain important information about your installation, including any non-fatal errors during installation. Leave it checked and click Finish.
The file instNote.txt appears, along with a prompt to reboot the machine. Click Yes to restart Microsoft Windows immediately or No to restart later.
Important. You need to restart the machine after installation before running any backup jobs.
For the installation of the DPX Client application, the minimum recommended version of Windows is Microsoft Windows 2012 R2. For details, see the DPX 4.10 .
The minimum hardware requirements are as follows:
Note. For Windows clients with limited disk space, a client-only installer is available, which requires only 1.2 GB of temporary free space on the system drive. For details and restrictions, see the .
Before installing the DPX Client for Microsoft Windows, review the following prerequisites:
See also. For the latest requirement of firewalls in the Catalogic DPX solution, see in the Catalogic Knowledge Base.
Tip. To protect Microsoft Windows VMs on either VMware or Microsoft Hyper-V, also consider the which does not require the DPX Client application on the Microsoft Windows system.
Memory
2 GB minimum, 4 GB recommended for Enterprise applications
Processor
1 core minimum
Architecture
x64
Disk space
4 GB minimum free space on system drive for installation
This section will guide you through the process of installing and configuring the Catalogic DPX Client for Linux.
Install the DPX Client on your client machines and register these client nodes with the DPX Master Server so that DPX will be able to protect data in these client nodes. Refer to this section to install the DPX Client on either one of the following UNIX and UNIX-like systems:
Linux
Novell (Micro Focus) Open Enterprise Server (OES)
IBM AIX
Note. For each OS there is a dedicated installer. Be sure to download the right one.
For Microsoft Windows, see DPX Client for Microsoft Windows.
Tip. To protect Linux VMs on either VMware or Microsoft Hyper-V, also consider the Agentless Backup which does not require the Catalogic DPX Client application on the Linux system. See Agentless Backup.
Attention! Do not install DPX Client on virtual machines (VMs) that will be backed up by using Agentless Backup for VMware or Microsoft Hyper-V.
To install the DPX Client for Linux, follow these steps:
Go to the Catalogic MySupport website and log in.
Navigate to the product page and go to Software Download > New Installations or deployments > Client Software Installation.
Download the Linux ISO file to your workstation.
Copy the ISO image file to the client system, say, the home directory (~
).
Verify the MD5 checksum value of the ISO image file by comparing it with the value on the product web page:
Mount the ISO image file in the client system and go to this disk image. For example, use the following commands:
Run the installation program with the root privilege:
Tip. You can run the installation program either from a command-line interface or a graphical interface with X Window system. In the graphical interface, the installer appears in a graphical dialog window.
The installation program prompts you to read the Software License Agreement; proceed to the next step if you agree.
Follow the instructions to set up the configurations:
Product directory to install the DPX Client application (default: /opt/DPX/
)
DPX virtualization proxy server for VMware. Enter Y
if you are using DPX on the VMware environment and you want to install this proxy server program on the client machine. (default: Do not install the proxy server.)
Logical node name (default: the hostname of the client system)
Host name or the IPv4 address of the client node (default: the IPv4 address of the client system)
Group name. Enter the name of an existing node group to add this client node to the node group. Or, enter a new node group name so that DPX creates a new node group with this name and adds the client node to this new node group. (default: DefaultGroup)
Registering this client node with the DPX Master Server as part of an Enterprise. If you answer 1 for Yes, enter the hostname of the DPX Master Server. (Default: Yes). You will need to provide the following node configuration details:
Logical Node name (specify the name of your choice);
Hostname or IP address of your machine;
Group name for the node: enter a name of an existing node group to add this client node to the node group. Or, enter a new node group name so that DPX creates a new node group with this name and adds the client node to this new node group. (default: DefaultGroup);
Hostname of master server (default: localhost);
Registering this client node with the DPX Master Server as part of an Enterprise. If you answer 1 for Yes, enter the hostname of the DPX Master Server. (Default: Yes)
For Micro Focus Open Enterprise Server: enter the root password, eDirectory user name, and eDirectory password. Enter the eDirectory distinguished user name and password which contain the context of the user object.
Block Data Protection to create block-level snapshot backups on this client node. (default: Enable)
Complete the installation. If you have not added the client node to the DPX Master Server, you can add the client node later from the Master Server interface (web or desktop), following the instructions in Adding a Client Node from the Master Server Level.
See also. If you encounter any trouble while installing the DPX Client for UNIX or UNIX-like systems, see Troubleshooting Installation of the Catalogic DPX Client on UNIX and UNIX-like Systems.
Log in to a shell session of the Linux system that has DPX to remove, typically, by using an SSH client.
Run the uninstall script from <product-directory>/uninstall/uninstall_DPX
with a root privilege. Typically, run the following shell command:
The product version is now uninstalled.
Once installed and properly configured, the DPX Client does not require any further actions, such as logging in. If you have added your DPX Client as a node to the DPX Master Server during the installation process, you are ready to create your first backup job. If you do not have any client nodes added to your DPX Master Server yet, you can do it through the DPX web interface (recommended) or DPX desktop interface.
Open your web browser and go to your Master Server’s IP address.
In the login box, enter the username and password for the Catalogic DPX Master Server.
Note. Default credentials are username: sysadmin, password: sysadmin. You will be prompted to change the password upon the first login.
Click the Login button. The DPX Master Server Dashboard will appear.
See also. For more information about the web interface, see the Web Interface section.
Ensure you have a Java environment on your computer to be able to run .jnlp files. If not, download Java or Open Web Start (recommended) and install the environment on your machine, following the provider’s instructions.
Restrictions. While it is technically possible to run the desktop interface on Linux, we recommend using Windows, as Linux distributions are not officially supported.
Open your web browser and go to your Master Server’s IP address.
At the bottom of the login box, click Run the DPX Java User Interface. This will download the dpx.jnlp file.
Run the downloaded dpx.jnlp file. The Connect to DPX dialog box will appear:
Make sure the Server Name or IP of your master server is correct, then provide the master server credentials to log in. The Catalogic DPX desktop interface opens.
From here, you have access to most Catalogic DPX functionalities, as described further.
See also.
Before installing the DPX Client on Linux, review the following prerequisites:
The minimum hardware requirements are as follows:
Memory
2 GB minimum, 4 GB recommended for Enterprise applications
Processor
1 core minimum
Architecture
x64
Disk space
4 GB minimum free space on system drive for installation
Ensure your client system is included in the DPX 4.10 .
The system resources and configurations of your client machine must meet the requirements as shown on the DPX product web page.
Your client system must have the libnss3 plug-in. For example, you can install the libnss3 plug-in package in Red Hat Enterprise Linux 8 or supported variants of it by using the following command:
Your client system must have the iSCSI packages for the Instant Access (IA) mapping which is one of the features for the Block Backup of DPX. The package name and installation steps may vary. For example, you can install the iSCSI packages in Red Hat Enterprise Linux 8 or supported variants of it by using the following command:
Allow all required ports for the Catalogic DPX Client:
TCP: 3260, 6123, 6124, 9104, 9202, 10000, 10001, 10566, and 15660.
UDP: 6123 and 6124.
See also. For advanced requirements for firewall settings in the Catalogic DPX solution, see the following knowledge base article Firewall Support Requirements and Implementation.
The storage volume to install the DPX Client for Linux must be part of an LVM group.
The physical extent (PE) of the LVM volume group to install the DPX Client for Linux must have free PE of at least 10%.
Tip. Enable the Block Data Protection option to use the block-level snapshot technology that backs up only updated blocks. Block Data Protection may reduce backup time, transmission loads, CPU impacts, and storage requirements.
If you opt out of this option, DPX protects data by using the file-level backup instead.
The DPX Hyper-V Agent is designed to facilitate efficient backup and recovery operations for virtual machines hosted on Microsoft Hyper-V servers. By integrating seamlessly with the Hyper-V environment, it provides robust data protection capabilities, including full VM backups and application-consistent snapshots. The agent ensures minimal disruption to running virtual machines while delivering reliable and quick restore options to meet diverse recovery requirements.
Before you back up any data from your Hyper-V VMs, you need to install the DPX Backup Agent on the host machine to enable agentless access to all VMs under this host.
From your Hyper-V host, go to Catalogic MySupport website. On the DPX 4.10 product page, under Software Download, find the Microsoft Hyper-V Agent installer and download it on your Hyper-V host machine.
Run the installer and go through the wizard steps.
In the Welcome step, click Next.
In the License Agreement step, read the entire License Agreement carefully. You must accept the terms to continue. Click Next.
In the Installation Directory step, specify the directory where the DPX Hyper-V Agent will be installed. The default directory is usually C:\Program Files\DPX\Hyper-V Agent
.
Click Next.
Leave default parameters and click Next.
Specify the Username and Password of an account with Domain Administrator Privileges on the Hyper-V Host. If the agent is installed on a cluster environment, this must be a domain account (user needs to have remote access between the nodes in a cluster). For a standalone machine, a local administrator account is fine. The Authorization Key is used for secure communication with the agent.
Note. The Authorization Key established in this step will be required when adding Hyper-V as a node in DPX and for further communication with the node. Ensure it is kept safe and at hand.
Click Next.
Review the details in the Summary screen and click Next.
The wizard is now ready to install the DPX Hyper-V Agent on your computer. Click Next to begin the installation.
The installation process will take a few minutes.
Click Finish to complete the process and exit the wizard. If the View Readme File box is checked, the readme file will be displayed in a separate window.
Upon successful installation, the DPX Hyper-V Agent service should be up and running on your Hyper-V host:
Important. Particular attention must be paid when providing credentials for the Hyper-V host, as the Installation wizard does not verify the credentials. As a result, even though the installation may seem successful, invalid credentials will prevent the DPX Hyper-V Agent service from installing, thus making the Hyper-V host unusable.
You should also be able to see a new firewall rule added for inbound traffic:
After successfully installing DPX Hyper-V Agent on the Hyper-V host, proceed with Adding a Configured Hyper-V Host as a DPX Node.
If you prefer to install the Hyper-V Agent without using the Wizard and without any output, you can do it via powershell. The Hyper-V Agent installer requires the following parameters:
--mode
--password
(Note: this is the authorization key)
--adminUsername
--adminPassword
The installer also accepts the following optional parameters:
--port
– port number (default: 50881)
--installDir
– custom installation directory (default: C:\Program Files\DPX\Hyper-V Agent)
--firewallRuleName
– custom name for firewall rule added by the installer (default: DPX Hyper-V Agent)
Here is an example with all required and optional parameters:
If an additional parameter --unattendedmodeu
i minimal
is used, a small dialog with a progress bar will be shown during the entire installation process.
When the installation is completed, you can add the Hyper-V as a node to DPX Master Server.
See also. For more information, see Adding Hyper-V Nodes.
DPX Proxy Server is a component used in VMware environments for processing VMware backups without the need to install backup agents on VMs. It creates backup snapshots and transfers data to the specified destination, communicating with the master server. From version 4.8.1, it can be deployed as a virtual appliance. You can still use proxy server applications installed with the DPX Client on client nodes in the VMware environment, but it is recommended to deploy proxy servers for each vCenter as virtual appliances.
Unlike the application edition, the DPX Proxy Server virtual appliance includes a web interface, allowing the user to operate and monitor the proxy server from a web browser. You can also access the Linux shell in the web browser instead of using an SSH client.
Note. DPX does not support proxy servers for Microsoft Hyper-V.
Before deploying the OVF template for the DPX Proxy Server virtual appliance on your VMware environment, ensure that you have enough hardware resources in the VMware ESXi server. The following is the default configuration of the virtual appliance:
Default hardware configurations of the DPX 4.10 Proxy Server virtual appliance for VMware
This procedure describes adding an already existing DPX Client machine as a node to the DPX Master Server. This procedure is only possible if a DPX Client is already installed on the machine you want to add as a node. The DPX Client and the DPX Master Server must also be in the same network.
The Catalogic DPX Master Server is deployed and can be accessed through either web or desktop interface
At least one Catalogic DPX Client is deployed within the same network
Open a web browser and go to the Master Server’s IP address.
Go to the Nodes section in the sidebar. A list of all nodes added to the DPX Master Server will be shown. At least one node, master, should be already on the list. This is the Master Server itself – compare the IP address in the list and in the web browser’s address bar. The Master Server can also serve as a client to back up data from itself.
Tip. If you expect a node to be already on the list but you cannot find it, try refreshing the view and then search for the node by its name, group or type.
Click the Add Node button in the upper right corner.
Fill in all other required fields: specify the name for the new node, provide a valid resolvable hostname or IP address, and select the group for the node.
Note. The Node Name must be unique throughout the Enterprise, regardless of the Node Group it is saved in.
Tip. Providing the hostname is recommended over providing an IP address – in case the IP address changes, the hostname can still be resolved to the new IP address, and the connection between the server and the client will remain functional.
Click Save. The node is now added and is visible in the nodes list.
Go to the Configure tab and select Enterprise under Configuration Operations.
There should be at least one node group already visible, the DefaultGroup. You can add a new node to one of the existing node groups or create a new node group (see the next section).
Right-click the node group name or icon to display the context menu. Then select Add Node. The selection check box next to the node group icon indicates the selection and the Add Node dialog appears.
Complete the fields in the ADD NODE pane.
Enter the logical name for the node. You can use up to 48 characters, no spaces. This is the name that DPX uses for the node. Note the following:
Any node that uses an iSCSI initiator must conform to iSCSI initiator and Microsoft machine naming limitations. Some characters may be impermissible in the node name. For example underscore (_
) should not be used.
On Windows, DPX does not support nodes using names reserved by Windows for specific devices: CON, PRN, AUX, NUL. Note also that the string BMR is reserved.
Enter the node hostname. Alternatively, you may provide its network IP address.
Select Add. The node is now added. You can see it in your Enterprise tree, and its parameters are visible in the EDIT NODE pane.
The Catalogic DPX Proxy Server virtual appliance includes the web (HTML5-based) interface. It allows the user to operate and monitor the proxy server from the web browser. The user can also access the Linux shell in the web browser window instead of using an SSH client.
In most cases, you can access the Linux shell of the DPX Proxy Server from your web browser. Log in to the web interface as instructed in the and select Terminal from the side panel.
If you want to connect to the Linux shell via SSH, use the same credentials as for the web interface.
Note. You will be prompted to change the default password when you log in for the first time.
After creating the Catalogic DPX Proxy Server virtual appliance in the VMware environment, you can access its web interface from your web browser.
From a web browser on your workstation, open the following URL:
Note. You must allow connections between your workstation and the Catalogic DPX Proxy Server via TCP 9090.
On the log-in page, enter the default user name and password for the Catalogic DPX Proxy Server:
User name: dpxadmin
Password (only for the first time): dpxadmin
You can open the following pages from the navigation pane:
You can see the system information and resource monitors for the machine’s health, CPU utilization, system information, and configuration. You can also restart or shut down the system.
In the Logs page, you can view the records of the Linux system log (/var/log/messages
). You can specify the time range, event severity, and service such as kernel and systemd.
Note. The timestamps in the Logs page use our browser’s time zone (TZ), typically the system TZ of your workstation. For example, set the system TZ to the US Eastern Time (America/New_York) when you deploy this virtual appliance from VMware vSphere Client, open the Logs page from a workstation in San Francisco, and you see the time stamps in Pacific Time which is 3 hours behind Eastern Time.
Monitor the throughput of the sending packets and receiving packets. You can also see the Networking Logs for network-related services such as NetworkManager and firewall.
Do not enable the firewall from this page or you will lose access to the Cockpit interface immediately. To disable the firewall and regain access to the Cockpit interface, log in to the Linux shell and stop the firewall by using the following command:
Manage accounts such as root and dpxadmin in this Linux system. You need to log in with the privileged access to use this page.
View a list of system services that are usually managed by systemd. Click either service and you can see the details of this system service such as the status: active, inactive, and so on. You can also start, stop, or restart the system service.
Attention! Do not make any changes to these system services unless instructed by the Catalogic Technical Support Team.
You can browse and view files in this Linux system.
See and manage all applications installed or available on this Linux system.
You can download the system files and log files that are usually helpful to troubleshoot system issues. These files are archived and compressed in tar.xz
format.
DPX Proxy
You can see the product information of the Catalogic DPX Proxy server application on this virtual appliance: the product version number, the patch level, and so on. In addition, you can check the server status, stop the server, and start it again.
Software updates
Check for system update status and automatic update settings.
Terminal
Access the Linux shell from your web browser without using the machine monitor or an SSH client.
Nodes other than DPX Client nodes must be added manually from the DPX Master Server. The procedure is similar to . There are differences in naming conventions and feature handling between the web interface and desktop interface.
Note. The IPX access method may be displayed for selection in the desktop interface. However, this protocol and Netware servers that implement it are no longer supported.
Proceed with adding a node as described in .
Depending on the selected access method, different fields need to be completed.
A Hyper-V cluster is a group of multiple physical servers clustered together, each running the Hyper-V hypervisor. The clustering enables automatic failover, load balancing, and simplified management of VMs across the cluster, ensuring continuity of services in case of hardware or software failures.
If you select Hyper-V Cluster as the node type, complete the following additional fields:
Port Number The default port number for Hyper-V Agent is 50881. It is recommended to leave the default setting.
Authorization Key Provide the Authorization Key specified when configuring the DPX Hyper-V Agent.
A Hyper-V host is a single physical server that runs the Hyper-V hypervisor. It hosts and manages virtual machines, providing them with the necessary resources like CPU, memory, storage, and network connectivity. The Hyper-V host ensures VMs can run isolated from one another while sharing the physical hardware efficiently. In the event of a failure on this host, VMs may experience downtime unless failover mechanisms, like those in a cluster, are in place.
If you select Hyper-V Host as the node type, complete the same additional fields as in Hyper-V Cluster:
Port Number The default port number for Hyper-V Agent is 50881. Leave the default setting unless the port has been changed during the installation process.
Authorization Key Provide the Authorization Key specified when configuring the DPX Hyper-V Agent.
The NetApp SVM node serves as a destination node for agentless backup operations. When adding NetApp SVM node do the DPX Enterprise, define the node at the data SVM level, not the cluster level.
If you select NetApp SVM as the node type, complete the additional fields:
User Name
Enter the User ID to log into the node.
Password
Enter the password to log into the node with the User ID above.
If you select the VMware as the node type, complete the additional fields:
Port No.
The default port number is 443, the standard secure port number used by vCenter. It is recommended to leave the default setting.
User Name
Enter the User ID to log into the vCenter node. The User ID determines the resources that DPX has access to in the vCenter enterprise. Use an ID with access to all the virtual machines you want to back up.
Password
Enter the password to log into the vCenter node with the User ID above.
Click Test to verify the details and credentials, and to confirm the vCenter can be reached.
If you select vStor as the node type, complete the additional fields:
User Name
Enter the User ID to log into the vStor node.
Password
Enter the password to log into the vStor node with the User ID above.
Click Test to verify the details and credentials, and to confirm the connectivity with the vStor.
Depending on the selected access method, different fields need to be completed.
DPX communicates with NDMP-compliant nodes, including NetApp storage systems, NetApp OSSV nodes, and other third-party storage appliances. Such NAS devices are referred to as NDMP nodes. DPX software is not installed on NDMP nodes; the NDMP service is provided directly by third-party hardware or software.
To communicate with an NDMP node, there must be at least one non-NDMP client node licensed to run the NDMP client “proxy” module. This module is included with Windows or Linux DPX client installation. An NDMP node communicates with DPX through the NDMP module on the client node.
You can use NDMP nodes for local backups, three-way (remote) backups, or appliance-to-server backups. For NetApp 7-Mode controllers, the node can be used as a destination for Block backups.
DPX allows non-root accounts to scan NDMP nodes into the Enterprise and to perform NDMP backup and restore operations. Consult your third-party vendor documentation for setting up the appropriate login, permissions, authentication style, and password required for coordinating NDMP backups.
If a tape library is attached to a NAS device or NetApp storage system, any node specifying the tape library as a backup destination must be added to the Enterprise as an NDMP node.
If you select the NDMP access method, complete the additional NDMP dialog fields:
Resolvable Node Name or IP Address
Enter either the network IP address of the NDMP node or the host name (including domain name, for example: dcserver.abc_corp.com
).
Client Node
Select the node name for the node that is running the NDMP module. This field specifies a server that has client software on it. The node acts as an NDMP agent, transmitting commands between DPX and the NAS appliance.
In a three-way backup, data from one NDMP appliance is backed up through another NDMP appliance that is locally attached to a storage device. If the two NDMP nodes have different client nodes, the client for the NDMP node connected to the storage device is the controlling node for both NDMP nodes in the three-way backup operation.
Click Test to the right of the Client Node field to test NDMP communication with the client node. DPX issues a message informing you whether the test passed or failed.
Port No
The port number default is 10000, which is the standard port number reserved for NDMP. It is strongly recommended to accept the default setting.
User Name
Enter the User ID to log into the NDMP node. The User ID determines the files and directories that DPX has access to on the NDMP node. Use an ID that has access to all the data you want to back up (for example, the system administrator account).
Password
Enter the password to log into the NDMP node with the User ID above.
After entering the User Name and Password, select Add. The Define Node Feature dialog box will appear.
Make your selections from the pull-down menus and click OK to add the NDMP node.
After clicking Add, the following additional fields will appear:
Authentication Type
Specifies how user and password information is encoded. The following values may be defined, depending on the authentication methods configured on the NDMP node.
Backup Type
Select the backup method for NDMP backup. The pull-down menu displays the valid NDMP backup types supported by the NDMP server. NDMP backup types depend on the manufacturer of the configured node hardware. Appropriate licensing from the manufacturer may be required. See the documentation from the manufacturer for definitions of backup types and licensing requirements.
The most common backup types for storage systems are Dump and SMTape. In general, Dump is essentially a file system backup of the volume and SMTape is a block-level image of the volume. The Dump protocol is generally used when backup of specific (but not all) files, folders, or qtrees are desired and selective file restore is a priority. The SMTape protocol is generally used when a full volume restore is necessary for disaster recovery or for seeding a secondary remote storage system for subsequent SnapMirror synchronization.
Volume Snapshot Count Error Level
Specify the maximum number of backup snapshots on the secondary volume. Accept the default value unless you have a specific need to lower it. Backups fail if the limit of the storage system is exceeded.
Volume Snapshot Count Warning Level
Specify the number of backup snapshots on the secondary volume that triggers a warning message. Accept the default value unless you have lowered the Volume Snapshot Count Error Level.
Volume Low Space Error (%)
Enter the minimum percentage of free space you require on the secondary volume to run a backup. The minimum setting is 1 percent.
Volume Low Space Warning (%)
Enter the percentage space remaining on the secondary volume that triggers a warning message. The minimum setting is 15 percent.
If you select the VMware access method, complete the additional VMware node fields:
Port No.
The default port number is 443, the standard secure port number used by vCenter. It is recommended to leave the default setting.
User Name
Enter the User ID to log into the vCenter node. The User ID determines the resources that DPX has access to in the vCenter enterprise. Use an ID with access to all the virtual machines you want to back up.
Password
Enter the password to log into the vCenter node with the User ID above.
Agentless Backup
A STORAGE_CTL node can be added for agentless backups of virtual machines. The STORAGE_CTL node serves as the destination node for the agentless backup operation.
When adding NetApp Clustered Data ONTAP to the DPX Enterprise, define the STORAGE_CTL node at the data SVM level, not the cluster level.
Note. To protect a STORAGE_CTL node, you can add the same node as an NDMP node, then define and run an NDMP backup job where that node is the client.
Agent-Based Clustered Data ONTAP Backup
vStor Backup
To define an agent-based backup to a vStor node, scan the destination vStor server as a STORAGE_CTL node.
If you select the STORAGE_CTL access method, complete the additional STORAGE_CTL node fields:
Storage Controller Type
Select either NetApp or vStor
Resolvable Node Name or IP Address
Enter the network IP address or the hostname (including the domain name). If adding NetApp Clustered Data ONTAP, define the node at the data SVM level, not the cluster level.
User Name
Enter the User ID to log into the node.
Password
Enter the password to log into the node with the User ID above.
Volume Snapshot Count Error Level
Specify the maximum number of backup snapshots on the STORAGE_CTL node. Backups fail if the limit is exceeded.
Volume Snapshot Count Warning Level
Specify the number of backup snapshots on the STORAGE_CTL node that triggers a warning message. Accept the default value unless you have lowered the Volume Snapshot Count Error Level.
Volume Low Space Error (%)
Enter the minimum percentage of free space you require on the STORAGE_CTL node to run a backup. The minimum setting is 1 percent.
Volume Low Space Warning (%)
Enter the percentage space remaining on the STORAGE_CTL node that triggers a warning message. The minimum setting is 15 percent.
Some Linux distributions listed in the DPX 4.10 support Block Data Protection in addition to file-level protection. To enable Block Data Protection, review the following additional prerequisites before installing the DPX Client on Linux:
The Add Node dialog will open. Select the node Type: DPX Client. For other node types, see .
Tip. If you encounter a timeout error or the hostname provided cannot be resolved to a valid IP address, double-check your machine’s firewall settings, ensuring all for the DPX Client deployment are met, including the ports allowed.
See also. .
Select the Access Method. For DPX Client nodes, this is TCPIP. For other node types, see .
See also. .
See also. This graphical interface is based on Red Hat Cockpit. For more information, see .
See also. For more information about every function in Red Hat Cockpit, see the Red Hat Customer Portal: .
VMware is a special node type used for scanning in a VMware vCenter server. The vCenter server is used to coordinate agentless Block backup and restore operations. See and .
Catalogic vStor server is a virtual or physical data storage appliance, acting as the primary backup destination for DPX. For more information, refer to the .
Proceed with adding a node as described in .
See also. For the latest system compatibility details regarding supported hardware, file systems, applications, operating systems, and service packs, see the DPX 4.10 .
You must enter a user name with root privileges when you configure a NetApp storage system for use with DPX Block Data Protection. For NDMP Tape backup and restore, a non-root account can be used. in the DPX 4.9.x Reference Guide.
For additional information about Dump and SMTape, see in the DPX 4.9.x Deployment Guide and read the knowledge base article .
For details on the enforced volume low space fields, read the knowledge base article .
VMware is a special node type used for scanning in a VMware vCenter server. The vCenter server is used to coordinate agentless Block backup and restore operations. See and .
To define an agent-based backup to NetApp Clustered Data ONTAP, scan the destination data SVM as a STORAGE_CTL node instead of an NDMP node. When adding NetApp Clustered Data ONTAP to the DPX Enterprise, define the STORAGE_CTL node at the data SVM level, not the cluster level. See If you select the STORAGE_CTL access method in .
For details on the enforced volume low space fields, read the knowledge base article .
CPUs
Two virtual CPUs
Memory (RAM)
16 GB
Operating system
CentOS Linux 7.9
Hard disk
70 GB
NDMP_AUTH_TEXT
User and password information is unencrypted.
NDMP_AUTH_MD5
User and password information uses key-to-the-hash encryption.
DPX Client
TCPIP
unsupported
NDMP
See NDMP Backup and NDMP Restore
Hyper-V Cluster
unsupported
Hyper-V Cluster nodes will only be visible in the web UI
Hyper-V Host
unsupported
Hyper-V Host nodes will only be visible in the web UI
NetApp SVM
STORAGE_CTL
Select controller storage type: NetApp in the desktop UI
VMware vCenter/ESXi
VMWARE
vStor
STORAGE_CTL
Select controller storage type: vStor in the desktop UI
Each machine, be it virtual or physical, server or client, is considered a node of the Enterprise’s network it belongs to. The master server is a DPX node that contains DPX software, including the Catalog and modules that control scheduling, media management, and distributed processing. There is one master server per data protection Enterprise.
In order for the DPX to be able to perform any backup or restore jobs, a logical relation must be established between the Master Server and other nodes, such as Client or storage nodes.
Typically, you will deploy the DPX Master Server first, providing its hostname, network IP address, credentials and several other parameters. In the second step, you will deploy a DPX Client on each machine you want to back up from. During this process, you will provide the DPX Master Server’s hostname or IP address and credentials, thus adding the Client as a node to the Master Server.
You may also deploy DPX clients first, and add the client nodes to the Master Server later, using either web or desktop interface.
Note. Nodes other than DPX Client nodes must be added from the DPX Master Server.
Important. Generally, removing valid nodes from DPX is not recommended, as this may result in inconsistencies in job definitions. Please also note that if you remove a node and try to add the same or another node under the removed node’s name, an error will be thrown because the name has already been taken in the database. To avoid this issue, run Catalog Condense before attempting to re-use the removed node’s name.
This section will guide you through the process of installing and configuring the Catalogic DPX Client for Microsoft Windows.
There are two versions of the Catalogic DPX Client installer for Microsoft Windows: the client-only version and the full version.
In most cases, the client-only version suffices. To protect VMs in a VMware virtual environment, deploy the Catalogic DPX Proxy Server virtual appliance in the same VMware environment. See DPX Proxy Server.
Instead of deploying the Catalogic DPX Proxy Server virtual appliance, you can install the proxy server as an application along with the Catalogic DPX Client on the same Microsoft Windows machine. In other words, if you are planning to deploy the proxy server virtual appliance in the VMware environment or if you are not using the VMware solution at all, use the client-only version.
See also. Virtualization proxy servers coordinate operations for Agentless Backups of other virtual machines. As mentioned, do not install the Catalogic DPX Client on this virtual machine if you are planning to use the Agentless Backup with this client node. For more information about the Catalogic DPX Virtualization Proxy Server for VMware, see the following topic:
A tape library device is a single media drive in a tape library (for example, a DLT drive). supports backups to tape libraries on LANs, WANs, or SANs. For information on adding standalone devices, see Adding a Device.
A tape library device always belongs to a previously defined tape library.
A tape library device cannot belong to more than one tape library.
All devices in a tape library must use the same media (for example, DLT).
Tape drives must be capable of writing in variable block size mode. For some operating systems (for example, IRIX) the default device driver is for fixed block size; in such case, you must obtain and install a tape device driver with variable block size writing capability. These are often available from the manufacturers’ websites.
Warning! DPX uses a default tape block size of 64 KB for Windows device servers. Although current tape drives can handle this block size, there are a few older tape drives, such as an IBM QIC, that can only handle a maximum of 32 KB block size. With the default setting of 64 KB blocks, the backup will be successful on these older tape drives, but the data cannot be restored. If you suspect that any tape drives added to your Enterprise are designed for 32 KB blocks, it is a good idea to run a small test backup and restore to verify that data backed up to that drive can be restored. If the test fails, you may refer to the Knowledge Base for directions on verifying the block size capacity of tape drives and changing the block size setting. For more information about this issue, read the knowledge base article 39108.
Click Configure on the Function Tab bar of the window, then click Devices.
Open the Add Device dialog in the right pane by doing one of the following:
Right-click the tape library name or icon to display a context menu. The selection is indicated by the selection check box next to the tape library icon. Then select Add Device.
In the left pane, select the tape library to which you want to add the device and do one of the following:
From the menu bar, select Device > Add Device.
On the task panel, click Add Device.
The Add Tape Library Device dialog appears.
Complete the active fields in the Add Device dialog:
Device Name Enter a name for the device (up to 48 alphanumeric characters, no spaces). This is a logical name used to conveniently refer to the device (for example, SALES_DRIVE1).
Logical Node Name (non-SAN device only)
Note. For SAN devices, you must define Logical Node Name in the Add Device Path dialog. See Adding a SAN Device Path in the DPX 4.10 Reference Guide.
Select the name of the node to which the device is attached (for example, SALES_SERVER1) from the pull-down menu. This node must have been previously defined (via the Configure Enterprise window). You can have multiple devices on a node, up to the limit the hardware supports.
On the Device Resource Tree, the non-SAN device appears as device_name@logical_node_name
.
Device Number This field identifies a device within the tape library. The first storage device is usually 0. For each additional device, the Device Number increments (i.e., your second device would be 1).
There is a critical relationship between Device Number and Device ID for tape library devices. See Determining Device Number and Device ID.
Device ID (non-SAN device only)
Note. For SAN devices, you must define Device ID in the Add Device Path dialog. See Adding a SAN Device Path in the DPX 4.10 Reference Guide.
For devices on UNIX, Linux and OES Linux, enter the path to the device file. For example, for Linux, the first storage device is usually /dev/nst0
. For each additional device, the number in the path increments, thus your second device would be /dev/nst1
.
The following table lists common Device ID nomenclature for various flavors of UNIX:
Solaris
/dev/sync_sa/t1d0
Sun PC
/dev/sync_sa/t1d0
Linux
/dev/nst0
OES Linux
/dev/nst0
HP-UX
/dev/rmt/c2t0d2BESTn
AIX
/dev/rmt0.smc
Warning! Support for some of the documented operating systems may have been discontinued.
For devices on supported versions of Windows, the first device is normally called \\.\Tape0
. For each additional device, the number in the ID increments (i.e., your second device is \\.\Tape1
). You can find this information displayed in Tape Devices in the Control Panel of the Windows node. To do so, go to the Control Panel, select Tape Devices, choose the Properties tab, select the device, and click Properties. The Device ID is referred to as the Device Map.
See also. Device Detection
Unique ID
Tip. This field is enabled only if you first set the Allow to Update Unique ID option using the Option menu. An asterisk indicates the option is enabled.
This optional field identifies a device uniquely. Generally, it is the hardware serial number.
Comment Enter an optional comment up to 48 characters.
Select Add on the task menu at the top right of the right pane. If you are unable to see the task menu, resize the right pane.
Note. After defining a SAN device, you need to add SAN device paths. Adding a SAN Device Path in the DPX 4.9.x Reference Guide.
Storage devices (also referred to as “devices”) are physical or virtual drives on which media volumes, such as tape cartridges, are processed. Devices are grouped in clusters. To add a device, you need to have a device cluster defined first. Device clusters can only contain devices of similar type, e.g. LTO4 tape drives. See Adding a Device Cluster.
Note. For DISK DIRECTORY backups, devices are logical entities mimicking the structure and logic of tape storage. They are required by the DPX logic but are of minor interest on the user’s part.
When you create a node group, you may specify the default device cluster or tape library for the group. Later, you can override this default when you define a backup or migrate job.
There are two types of storage device groupings, each having two setup variations. The groupings are device clusters and tape libraries. The variations are SAN (Storage Area Network) and non-SAN devices. A device cluster is a collection of devices logically grouped by the system administrator. A tape library is a collection of devices that are grouped physically. From a functional viewpoint, a tape library is analogous to a device cluster. Thus, tape libraries displayed in the desktop interface are often listed along with device clusters under the heading Device Cluster.
Media, or media volume, is a storage unit such as tape or Disk Directory
Media volumes are physical media, such as tape cartridges, or logical storage units, such as Disk Directories, to which data can be backed up or duplicated. Data can only be backed up or duplicated to volumes that have been defined.
A media volume has a unique volume name (also abbreviated to volser = volume serial number) and must be a member of a media pool. You can define media pools and their member media volumes, as well as modify and delete those definitions.
When creating a node group, specify, from the media pools you have created, a default media pool for the node group. Later, when you define a backup or migrate job, you can override this default. During a backup, DPX issues prompts to the media operator or media changer to mount media volumes from the default or specified media pool. The specific volume is chosen from the media pool by DPX and cannot be predicted.
Note. Media pools are also called tape pools. Media volumes are also called tapes or media.
This topic describes how to test communication between the tape library and the controller node containing the installed media changer device file. For DPX, verification is recommended if you installed your media changer device file by using the manual installation procedures described in Manual Tape Library Installation.
The tape library media changer test program JItest.exe (or ./jitest* depending on platform) is used to test the tape library installation. The test program requires as an argument the media changer device file name created during the installation procedure in the preceding chapter. The example here uses a Windows device name. The only difference between this example and other platforms is the device name which can be /dev/sync_sa0, /dev/rchg/c000t0d0s0, etc. For UNIX and Linux environments, run ./bin/bexenv prior to running the jitest utility.
At the command line, type jitest sync_sa0 (or ./jitest /dev/sync_sa/0 for UNIX). This produces the following output:
Please type the command.
Enter the command open to open communications. Sample output follows:
The output lists information about this particular tape library. An explanation of some of the parameters follows:
NUM_ARMS
Number of media changers and the address of the first media changer (FIRST_ARM_ADDR).
NUM_CARTS
Number of tape cartridges and the first cartridge (FIRST_CART_ADDR).
NUM_DRIVES
Number of tape drives and the first drive (FIRST_DRIVE_ADDR).
NUM_XPORTS
Number of CAPs (Cartridge Access Ports) and the first CAP (FIRST_XPORT_ADDR).
In our example, the address of the first drive is 1030. The second drive therefore has an address of 1031. The same holds for the cartridges. The first cartridge has an address of 0, the second has an address of 1, and so on.
Type setup 0.
Type quit to quit JItest, or type help for other useful commands.
If the media changer accepts these commands without obvious error, the tape library is ready to be configured for use. Proceed to Manual Tape Library Configuration for the tape library configuration procedure.
A device cluster is a logical grouping of non-tape library (standalone) backup devices. For information about adding a tape library, see Adding a Tape Library.
Every device must be a member of one and only one device cluster.
All devices in a cluster must use the same media. For example, devices that use disk directories and devices that use tape cannot be in the same device cluster.
A single device cluster cannot contain both devices on a Storage Area Network (SAN) and devices directly connected to a server. They must be in separate device clusters.
Go to Devices & Pools in the sidebar. Then select the Add Device Cluster button in the upper right corner.
The Add Device Cluster dialog will open.
Choose the Device Cluster Type. In the Device Cluster Configuration section, provide the following parameters:
Toggle on/off to choose whether to automatically create a corresponding media pool. For DISK DIRECTORY backup, it is recommended to have this toggle on.
Provide the Device Cluster Name.
The name may only include alphanumeric characters (a-z
, A-Z
, 0-9
), underscores (_
) and hyphens (-
). No other special characters are allowed. The name cannot be longer than 48 characters. No two device clusters within the Enterprise can have the same name.
Indicate the Storage node.
Specify the Directory Path. This must be a valid path existing on the Storage node indicated above.
Optionally, you can add a brief description (max. 48 characters).
Under Devices configuration, specify at least one name for a new device that will be created with the cluster. Select Add Next Device to add more devices. Click the X symbol to the right of the new Device Name to cancel adding this device.
Click Save. The Device Cluster is now added.
Select the Configure tab, then click Devices.
Open the Add Device Cluster dialog in the right pane by doing one of the following:
Right-click the Enterprise name or icon to display the Enterprise context menu. The selection check box indicates the selected Enterprise. Then select Add Device Cluster.
Or, in the left pane, select the Enterprise to which you want to add the device cluster.
From the menu bar, select Device > Add Device Cluster [Ctrl + Shift + C].
On the task panel, under the Device Cluster Tasks section, select Add Device Cluster.
The Add Device Cluster dialog appears in the pane on the right.
Complete the active fields in the ADD DEVICE CLUSTER pane:
Device Cluster Name
Specify the name. The name may only include alphanumeric characters (a-z
, A-Z
, 0-9
), underscores (_
) and hyphens (-
). No other special characters are allowed. The name cannot be longer than 48 characters. No two device clusters in the Enterprise can have the same name.
Storage Area Network
Specify whether devices in the device cluster are connected to a Storage Area Network (SAN). A single device cluster cannot contain both devices on a SAN and devices directly connected to a server.
Device Type
Select a storage device type from the pull-down menu (for example, DLT). For backing up to a DiskDirectory, select DISKDIRECTORY.
Comment
Enter an optional comment – up to 48 characters.
Select Add. If you are unable to see the Add button, resize the pane.
The new device cluster name appears in the device resource tree in the left pane and is indicated by the selection check box. The ADD DEVICE CLUSTER dialog in the right pane becomes the EDIT DEVICE CLUSTER dialog for the newly created device cluster.
Before adding a Hyper-V Host as a node to DPX, make sure you have a Hyper-V host with a DPX Hyper-V Agent installed. For details, see DPX Hyper-V Agent.
Restrictions. Hyper-V backup and restore features are only supported by the web interface. The desktop interface does not allow for handling Hyper-V nodes and such nodes will not be visible in the desktop interface.
The procedure below describes adding a Hyper-V host as a node to the DPX Master Server.
Open the DPX Master Server web interface in a web browser.
In the left-hand side menu pane, go to the Nodes section.
Click the Add Node button in the upper right corner.
The Add Node dialog will open. As Type, select Hyper-V Host. Specify the name for the new node (it must be unique throughout the Enterprise), provide a valid resolvable hostname or IP address, and select the group for the node.
Click Save. The node is now added and is visible in the nodes list.
Important. DPX does not verify the connection with the Hyper-V host when the node is added. If you encounter an authorization or connection error with the Hyper-V host, you might need to remove the node and add it again, paying special attention to providing a hostname or IP address that is valid within your network.
See also. For more general information about nodes, see Nodes.
To manage your nodes better, you may organize them in node groups. To add a new node group, follow the procedure specific for the interface you are using.
For any cluster, it is highly recommended to create a separate node group.
Tip. It is advantageous to create a separate node group for nodes connected using Network Data Management Protocol (NDMP nodes). Although DPX does not prevent you from having node groups containing both NDMP and non-NDMP nodes, there are limitations placed on NDMP nodes that make it difficult to properly define backups and privileges for a mixed group.
Go to Nodes in the sidebar. Switch to the Node Groups tab. Then select the Add Node Group button in the upper right corner.
The Add Node Group dialog will open.
Provide the Node Group Name.
The name may only include alphanumeric characters (a-z
, A-Z
, 0-9
), underscores (_
) and hyphens (-
). No other special characters are allowed. The name cannot be longer than 48 characters.
Note. No two node groups within the Enterprise can have the same name. Do not use the reserved string BMR.
Optionally, select a device cluster (or tape library) from the drop-down list.
A device cluster is a set of storage devices, such as tape drives. If there are no device clusters or tape libraries in the pull-down menu, you can edit the node group later to add one.
The device cluster you select here is the default backup destination for certain backup types of the nodes in the node group. During backups, DPX automatically chooses available devices in the default device cluster and prompts the operator for mounts.
When you define a backup, you can override this default device cluster and choose an individual destination device. However, it is usually preferable to accept the default device cluster and let DPX choose the destination device from that cluster.
For NDMP node groups, it is best to choose an NDMP device cluster. For non-NDMP node groups, it is best to choose a non-NDMP device cluster. You could choose a SAN device cluster for either if it has both NDMP and non-NDMP devices.
Optionally, select a media pool from the drop-down list.
A media pool is a grouping of media volumes, such as tape cartridges. If there are no media pools in the pull-down menu, you can edit the node group later to add one.
The media pool you select here is the default pool for nodes in the node group. You can override this default media pool when you define backups.
Optionally, you can add a brief Descripition (max. 48 characters).
Click Save. The Node Group is now added.
Go to the Configure tab on the Function Tab bar, then click or right-click Enterprise.
Open the Add node group dialog in the right pane by doing one of the following:
Right-click the Enterprise name or icon to display a context menu. The selection check box will appear full next to the Enterprise icon, and the Edit Enterprise dialog will appear in the right pane. Then select Add Node Group.
In the left pane, select the Enterprise to which you want to add the node group.
From the menu bar, select Enterprise > Add Node Group.
On the task panel, click Add Node Group.
The Add Node Group dialog appears in the right pane.
Complete the active fields in the Add Node Group dialog:
Group Name Enter a name for the node group (for example, SALES). You can use up to 48 alphanumeric characters, no spaces.
Note. No two node groups within the Enterprise can have the same name. Do not use the reserved string BMR.
Device Cluster Name (optional) - Select a device cluster (or tape library) from the drop-down list. A device cluster is a set of storage devices, such as tape drives. If there are no device clusters or tape libraries in the pull-down menu, you can edit the node group later to add one. - The device cluster you select here is the default backup destination for certain backup types of the nodes in the node group. During backups, DPX automatically chooses available devices in the default device cluster and prompts the operator for mounts. - When you define a backup, you can override this default device cluster and choose an individual destination device. However, it is usually preferable to accept the default device cluster and let DPX choose the destination device from that device cluster. - For NDMP node groups, it is best to choose an NDMP device cluster. For non-NDMP node groups, it is best to choose a non-NDMP device cluster. You could choose a SAN device cluster for either if it has both NDMP and non-NDMP devices.
Media Pool Name (optional) Select a media pool from the pull-down menu. A media pool is a grouping of media volumes, such as tape cartridges. If there are no media pools in the pull-down menu, you can edit the node group later to add one. The media pool you select here is the default pool for nodes in the node group. You can override this default media pool when you define backups.
Comment Enter an optional comment (description) of up to 48 characters.
Select Add. The Node Group is now added to the Enterprise.
It is desirable for media pools to correspond to logical groups, such as business components (SALES_POOL, MARKET_POOL, etc.) or physical locations (EAST_POOL, WEST_POOL, etc.).
It is advantageous to locate a pool of media volumes near the backup devices where the volumes are mounted. This avoids the delay that can result when an operator must search elsewhere for the media volume requested by Catalogic DPX.
If the media pool is used for multiple device clusters, the device clusters and the media pool must be near each other. As you cannot predict the media volumes in the pool for which Catalogic DPX prompts, all free volumes in a pool must be easily available to all device clusters that might need it.
Go to Devices & Pools in the sidebar.
Switch to the Media Pools tab, then select the Add Media Pool button in the upper right corner.
If you have added a device cluster through the web interface and kept the Automatically create corresponding media pool toggle on, some media pools (with the mp-
prefix may already be on the list. They will be of Disk Directory type. Otherwise, the list is empty. See Adding a Device Cluster.
The Add Media Pool dialog will open.
Specify the Media Pool Name.
The name may only include alphanumeric characters (a-z
, A-Z
, 0-9
), underscores (_
) and hyphens (-
). No other special characters are allowed. The name cannot be longer than 48 characters. The field is case-insensitive.
Select Media Pool Type. Currently, only two types are available in the web interface:
Disk Directory
Cloud
For other types, head to the desktop interface.
If you select Cloud, an additional AWS S3 Storage Class drop-down will appear. There are three classes to choose from:
STANDARD
GLACIER
DEEP_ARCHIVE
These are just types of AWS S3 subscription plans. You can learn more from the provider’s website.
Optionally, you can add a brief description (max. 48 characters).
Click Save. The Media Pool is now added.
Note. For Disk Directory, media pools are automatically created with 100 volumes.
Select the Configure tab, then click Media.
In the main pane, select New_Enterprise and click Add Media Pool in the Media Pool Tasks section of the task panel to open the ADD MEDIA POOL dialog pane.
In the Add Media Pool dialog, enter the following fields:
Media Pool Name
Specify the name of the new pool. The name may only include alphanumeric characters (a-z
, A-Z
, 0-9
), underscores (_
) and hyphens (-
). No other special characters are allowed. The name cannot be longer than 48 characters.
If your scratch pool name contains more than one number, only one of the numbers can be used to associate the scratch pool to a scratch pool on the tape library server. You can specify which end of the scratch pool name should be parsed for the associating number using either the -A right
or -A left
option. -A right
(the default) will use the first number from the right of the scratch pool name, and -A left
will use the first digit from the left. For example, use the option -A left
to associate scratch pool BEXI_2_aug29 with scratch pool2 on your tape library server, and use -A right
to associate scratch pool BEXS_US7year_1 with scratch pool1 on your tape library server. On Windows, add either -A right
or -A left
to the SSJUKER registry entry. On UNIX, add either -A right
or -A left
to the SSJUKER file in the bin subdirectory of the directory in which Catalogic DPX is installed.
Attention! Do not update registries or environmental variables unless you fully understand what changes you are making. Bad registries or environmental variables can adversely affect applications or operating systems. You can Contact Catalogic Software Data Protection Technical Support for assistance.
Note. Media pools used with libraries controlled by the interface of the manufacturer require special naming conventions. For more information, see Special Media Pool Naming Conventions below.
Media Type
Select one of the following media types to register:
DISKDIRECTORY
Use this media type to back up to DiskDirectory.
LTO
CLOUD
Use this media type to register the Amazon S3 storage or a supported storage compatible with the Amazon S3 interface. You can use either the Amazon S3 Standard, Glacier, or Deep Glacier.
See also. For more information about registering cloud storage with Catalogic DPX, see Chapter 8: Cloud Storage in the DPX 4.9.x User’s Guide.
DLT
GENERIC
3480
9840
All media volumes in a pool must be the same media type.
See also. For more information about registering DiskDirectory with Catalogic DPX, see Specifying Destinations for the Backup Job in the DPX 4.9.x User’s Guide.
Minimum Number Free Volumes
Enter the minimum number of free media volumes allowed in the pool. When the number of free volumes falls below this number, Catalogic DPX issues a warning message. A practical threshold value is 2 times the number of drives. This quantity ensures you receive warnings early enough to acquire new media volumes.
Comment (optional)
Enter an optional comment up to 48 characters.
Alternate Tape Pools
You can specify the alternate tape pools for the tape libraries. This option is not available for the cloud media.
Recycle Expired Tape
When Catalogic DPX uses a tape from an alternate pool, it becomes part of the primary pool. Catalogic DPX allows you to recycle those volumes back to the alternate pool upon expiration.
Select Yes to recycle expired volumes for the alternate pool. Or, select No so that the volumes in the alternate pools remain in the primary pool upon expiration.
Available Tape Pools
Select an alternate pool in the Enterprise.
Append Offsite
Select Yes so that DPX appends tape libraries with the Offsite status to the alternate pool. In this case, you must enable the Append Offsite option in the backup’s Job Destinations. Or, select No so that DPX does not append the tape library with the Offsite status to the alternate pool.
Click Add to add the new media pool in the Enterprise.
For Disk Directory devices, adding more devices to a device cluster is not required, as devices perform only a logical function in backup and restore operations. For tape devices, the device cluster includes physical devices available for backup and restore operations within the cluster. See Adding a Tape Library Device for details.
Go to Devices & Pools in the sidebar. Click the Device Cluster name you want to add devices to.
In the device cluster’s detailed view, select Add Device.
Specify the new device’s name.
The name may only include alphanumeric characters (a-z
, A-Z
, 0-9
), underscores (_
) and hyphens (-
). No other special characters are allowed. The name cannot be longer than 48 characters. No two devices within the cluster can have the same name.
Click Add. The new device has been added.
Select the Configure tab, then click Devices.
Open the Add Device Cluster dialog in the right pane by doing one of the following:
Right-click the device cluster name or icon to display the device cluster context menu. The selection check box indicates the selected device cluster, and the device cluster details are visible in the pane to the right. Select Add Device.
Or, in the left pane, select the device cluster to which you want to add the device.
From the menu bar, select Device > Add Device [Ctrl + Shift + D].
On the task panel, under the Device Tasks section, select Add Device.
The Add Device dialog appears in the pane on the right.
Complete the active fields in the ADD DEVICE CLUSTER pane:
Device Name
Specify the name. The name may only include alphanumeric characters (a-z
, A-Z
, 0-9
), underscores (_
) and hyphens (-
). No other special characters are allowed. The name cannot be longer than 48 characters. No two devices within the cluster can have the same name.
Comment Enter an optional comment – up to 48 characters.
All other fields, such as Logical Node Name, Device ID and Device Type are disabled, as these parameters are inherited from the device cluster.
Select Add. If you are unable to see the Add button, resize the pane.
The new device name appears in the device resource tree in the left pane and is indicated by the selection check box. The ADD DEVICE dialog in the right pane becomes the EDIT DEVICE dialog for the newly created device.
For Windows non-clustered nodes, you can install DPX client software from a single point in your Enterprise rather than by running the installation program from the installation image on each remote machine. This single-point installation procedure is referred to as remote deployment.
Note. Remote deployment is for initial installations; you cannot use it if you are upgrading DPX. For upgrades and updates, see Updating DPX.
Remote deployment automatically adds installed nodes to the Enterprise, with each node in a separate node group.
For database servers, you can install remotely, but you must install database support locally. For this reason, you may want to install locally for such servers just before installing the database support.
If you have Windows 10 clients, be aware of the following. The administrative account on Windows 10 is inactive by default and needs to be enabled before DPX can be installed via Remote Deployment. Therefore, if you run Remote Deployment from the master server, some Windows 10 client nodes might fail with “Access Denied” error. In that case, log into each of the Windows 10 client nodes that fail and enable the Administrator Account. Then rerun Remote Deployment from the master server.
See also. For more information on automated deployment, please refer to the Automated Deployment section in the DPX 4.9.x Reference Guide.
See also. For the latest system compatibility details regarding supported hardware, file systems, applications, operating systems, and service packs, see the DPX 4.10 .
Before defining a tape library to DPX, you must install the tape library driver on the node to which the tape library is attached. Follow the instructions in Chapter 33: Device Configuration Wizard in the DPX 4.9.x Reference Guide.
Note. The DPX tape library driver enables DPX to control the tape library media changer. Do not confuse this driver with tape drive drivers, which are supplied by tape device manufacturers and are available from their websites.
A single tape library cannot contain both devices on a storage area network (SAN) and devices directly connected to a server.
Restrictions. Currently, tape library management is only available through the desktop interface. The tape library management functionality through the web interface will be implemented in future versions of DPX.
Click Configure on the Function Tab bar of the window, then click Devices.
Open the Add Tape Library dialog in the right pane by doing one of the following:
Right-click the Enterprise name or icon to display the Enterprise context menu. The selection is indicated by the selection check box next to the Enterprise icon. Then select Add Tape Library.
In the left pane, select the Enterprise to which you want to add the tape library and do one of the following:
From the menu bar, select Device > Add Tape Library.
On the task panel, click Add Tape Library. The Add Tape Library dialog appears.
Complete the active fields in the Add Tape Library dialog:
Tape Library Name
Enter a name (up to 14 alphanumeric characters) for the tape library (for example, New Tape Library). No two tape libraries in the Enterprise can have the same name.
Storage Area Network Specify whether devices in the tape library are connected to a Storage Area Network (SAN). A tape library cannot contain both devices on a SAN and devices directly connected to a server.
Tape Library Type Select a tape library type (for example, EXB210) from the pull-down menu. (For an ADIC SDLC tape library, select ADIC_AML.)
If you select either ACSLS for a StorageTek Automated Cartridge System (ACS), ADIC_AML for an AML Automated Storage Library, IBMATL for an IBM Magstar 3494 Tape Library (IBM 3494), the Using Slot and Cleaning Slot fields disappear and the Storage Area Network field is forced to No.
If you select ACSLS, the Controller ID field disappears and the ACS Number field appears. If you select IBMATL, the Category field appears in the dialog. If you select ADIC_AML, the pull-down menu on the Device Type field is disabled.
Controller Node The controller node is a node that communicates with and controls the tape library media changer. The controller node is a special case of a device server. This is also the node where you have installed the tape library device driver. See Device Configuration Wizard.
Select the node name of the controller node (for example, SALES_SERVER_1). The controller node is connected to the tape library media changer either directly or over a SAN.
Although this node must be running one of the operating systems specified in Manual Tape Library Installation, tape library devices (tape drives) can be attached to any controller node or NDMP node in your regular network or SAN.
Note. Even in a SAN, you need to choose one node as the primary controller node for the tape library. This node manages the robotics and messages. The drives in the tape library can be accessed from any node that can access the SAN.
Tip. A tape library media changer can be controlled by the NDMP node, eliminating the need for a separate Windows or UNIX controller node. To enable a tape library media changer to be controlled by the NDMP node, select the NDMP node name in the Controller Node field in the Add Tape Library dialog.
Controller ID
Enter the complete path and name to the media changer device file on the controller node. The media changer device file contains the file handle for the tape library driver. For example, the media changer device file could be /dev/sync_sa/t0d0
for Sun or C:\backex\bin\JB\sync_sa0
for Windows. This file is created by DPX during tape library driver installation. See Device Configuration Wizard.
For IBM 3494, this is the logical name of the library control point that you specified when you first configured IBM 3494. This field does not appear if you choose ACSLS in the Tape Library Type field.
ACS Number This field only appears if you choose ACSLS in the Tape Library Type field. Enter the ACS Number. The ACS Number was specified in ACSLS when the ACS was first configured, and its valid range is 0-126. For more information on ACS, see Chapter 41: Using Oracle StorageTek Automated Cartridge System Library in the DPX 4.9.x Reference Guide.
Category This field appears if you choose IBMATL in the Tape Library Type field.
Device Type Select a device type (for example, 4 mm) from the pull-down menu. All devices in a tape library must be the same type. If you chose ACSLS from the Tape Library Type pull-down menu, the Device Type DLT appears in this field.
Using a Slot
Enter the starting and ending slot numbers to use for media volumes. For example, entering 1
and 11
means for DPX that slot numbers 1 through 11 are reserved for media volumes.
Note. If the slot numbers start at zero (0), slot number 1 is the 2nd slot.
Cleaning a Slot Enter the slot(s) used for the cleaning media. If there is only one cleaning slot, enter the slot number twice; for example, 0 through 0 indicates that slot number 0 contains a cleaning media (the default value). If there is no cleaning slot, enter -1 in each field.
Cleaning Threshold Enter the number of times a drive can be used before it is cleaned. An internal counter is incremented each time a media volume is inserted in the drive. For example, if you enter 50, a media volume can be inserted in the drive 50 times. Just before the next use, the cleaning media is inserted to clean the drive head. After the drive is cleaned, the counter is reset to 0.
Comment Enter an optional comment of up to 48 characters.
Select Add on the task menu at the top right of the right pane. If you are unable to see the task menu, resize the right pane. The new tape library name appears in the device resource tree in the left pane and is indicated by the selection check box. The add tape library dialog in the right pane becomes the edit tape library dialog for the new tape library.
A media volume is an individual backup medium, such as a tape cartridge. Each media volume is identified by volume name. Another term for volume name is volser (volume serial number).
Tip. DPX allows you to define a set of consecutively named media volumes in one pass.
A media volume must be a member of a media pool.
A media volume cannot belong to more than one media pool.
All media volumes in a media pool must be of the same type (for example, a 4 mm tape cartridge).
Data can only be backed up to defined volumes. However, it can be labeled on the fly if you choose the global default option for doing so.
For a media pool used with a StorageTek ACS, an IBM 3494, or an ADIC AML or SDLC, you do not use DPX to add media volumes to the pool. Instead, you add tapes through the hardware interface of the manufacturer. When you later perform a backup, DPX automatically adds the new media volumes to the appropriate media pools.
Restrictions. Currently, media volumes can only be added via the desktop interface. This feature will be extended to the web interface in future releases.
To define a new media volume or a set of media volumes:
Click the Configure tab on the Function Tab bar of the window, then click Media in the task panel.
Open the Add Media Volume dialog in the right pane by doing one of the following:
Right-click the media pool name or icon to display a context menu. The selection is indicated by the check box next to the media pool icon. Then select Add Media Volumes.
In the left pane, select the media pool to which you want to add the media volume(s) and do one of the following:
From the menu bar, select Media > Add Media Volume.
On the task panel, click Add Media.
The Add Media Volume dialog appears.
Complete the active fields in the Add Media Volume dialog:
Capacity
Tells the native storage capacity of the media volume(s). Enter a number, then select the unit of measure from the pull-down menu: megabytes (MB), gigabytes (GB) or terabytes (TB). DPX uses this field to estimate free space on a media volume, but this field does not affect the amount of data DPX can actually store on the media volume.
Maximum Number Passes Allowed
Tells DPX the number of times a media can be written to, including second passes. Enter a number recommended by the manufacturer (for example, 500). After the specified number of passes, DPX no longer requests the media volume for backups and will not accept it if it is mounted for backup. It is still available for restores. This option is not always enforced.
Volume Serial Number
Enter a volume name (up to 6 alphanumeric characters, no spaces). The name cannot be the same as an existing media volume.
If you are defining a set of consecutively named volumes, this must be the name of the first volume in the set. To define a set, the value you enter in this field must end with a number (for example, ENG001
). DPX automatically creates consecutively named volumes (ENG002
, ENG003
, etc.), depending on the number you enter in the Number Volumes field (described immediately below).
If you enter “1” in the Number Volumes field, Volume Serial Number is simply the name of the single volume you are adding.
Number Volumes
Use this field to define a set of consecutively numbered media volumes. DPX automatically names and incrementally numbers the volumes, beginning with the volume entered in the Volume Serial Number field. For example, if the entry in Volume Serial Number is ENG001
and you specify 3 for Number Volumes, DPX accepts ENG001
and automatically creates volumes ENG002
and ENG003
. To define only one media volume, enter “1” in this field.
The following are non-alterable fields:
Media Pool Name
This read-only field indicates the name of the selected media pool.
Media Type
This read-only field indicates the type of media in the pool (for example 4 mm).
Click Add. The media volumes are now added and are visible in the tree view. At the same time, as the media pool is selected, the pane to the right shows the EDIT MEDIA POOL dialog.
A physical node in the Enterprise is available to control the tape library’s media changer. This can be a Windows server, Linux server, or the NetApp storage controller. A virtualized node cannot be used for media changer control. This controller node must have a host bus adapter. Note that a media changer is also referred to as a robotic arm and a host bus adapter is also referred to as an HBA.
The media changer is attached to a SAN (storage area network) and zoned to the master server. Therefore the master server acts as the tape library’s controller node.
The tape drives are attached to the SAN and zoned to the NetApp storage system. Therefore the NetApp storage system acts as the device server.
The tape library is a modern, vendor-supported library with tape drives capable of writing in variable block size mode. The media changer is SMC-2 compliant and supports the DVCID option of the Read Element Status command. The tape drives are SCSI-2 compliant and support variable length records and extended file marks. The tape library and tapes support bar coding. Most modern tape libraries fit these requirements. DPX does not support libraries and tape drives currently unsupported by the device vendor.
For DPX purposes, the media changer device and associated tape drives must belong to only one Enterprise controlled by a single master server. Tape library media changer control cannot be shared with other backup products and cannot be accessed by more than one master server.
See also. For the latest system compatibility details regarding supported hardware, file systems, applications, operating systems, and service packs, see the DPX 4.10 .
If, in conjunction with the customer, a strategic determination is made to attach the media changer or tape drives differently, you can do so. However, the practices described in Recommended Best Practices for Tape Libraries are highly recommended to maximize reliability and minimize troubleshooting challenges.
There are several supported ways to attach the tape library’s media changer and tape drives to the Enterprise. They can be connected through a fiber channel SAN, iSCSI SAN, direct fiber channel attachment, or legacy parallel SCSI cable attachment.
If the connection is through a fiber channel SAN, the media changer must be controlled by a device server, not by a NetApp storage system, and the tape drives can be controlled by any node or NetApp storage system.
If direct attachment through a fiber channel or legacy parallel SCSI is required, it is highly recommended for the media changer and at least one tape drive to be attached directly to the master server to support media changer control and Catalog backups. If a tape drive cannot be connected or accessed through the master server, an alternate strategy must be used to move Catalog backups to a safe medium that can be recovered in the event of a site disaster.
iSCSI SAN connections are generally not recommended due to latency and connection reliability. If iSCSI is absolutely necessary, for example, if no physical server with HBA is available for media changer control, great care must be taken by the site administrators to ensure such connections are very reliable. Any disruption in connection will impact backup and media control operations.
Though it is possible to attach a tape library directly to a NetApp storage system for exclusive control of media changer and all tape devices, it is not recommended as an alternate strategy for Catalog backups is required. Additionally, media changer reliability and troubleshooting may be problematic, requiring moving the media changer device to a node with an HBA physical server. NetApp media changer control is also limited to tape libraries with 600 total slots or less; larger tape libraries do not work properly due to SCSI limitations.
This topic describes the procedures required to set up an LTO4, 5, or 6 tape device for hardware encryption. The procedures that apply depend on the tape device manufacturer and operating system, as indicated in the following table:
Note. The three procedures are described in .
See also. For the latest system compatibility details regarding supported hardware, file systems, applications, operating systems, and service packs, see the DPX 4.10 .
Note the following:
For HP and Quantum tape devices on Windows device servers, the Bexsptape device driver is required for hardware encryption. Implementing Bexsptape is done in .
For IBM tape devices, Bexsptape is not needed. An IBM device driver supporting hardware encryption is required. Only applies to IBM drives.
For Linux and UNIX operating systems, Bexsptape is not required.
Follow the procedures that apply to your tape device and operating system; thus, for IBM devices, skip to ; for Linux and UNIX device servers, omit .
Launch the Device Configuration Wizard.
In the Select Nodes to Scan dialog, select the node where the drive is installed, and then click Options. The Node Options dialog displays.
Select the check box Check here to enable DPX LTO Encryption options.
From the Please select drop-down menu, select Enable/Update.
Click OK.
If the drives are already added to the Enterprise, click Exit. If the drives are not added to the Enterprise, continue to use the Device Configuration Wizard to add them.
See also.
In the Windows Device Manager, locate the tape device to associate with the Bexsptape driver. Note the following:
If the tape device already has a driver associated with it, uninstall the driver. If a selection displays to permanently delete the driver, it is recommended to select it. This ensures that the driver is not available for the device in the future, eliminating possible conflict with Bexsptape.
Tape devices that do not have a driver associated with it are in the Other Devices container of the display.
Right-click the appropriate tape device, and then select Update Driver Software from the pop-up menu. The first page of a wizard appears.
You are asked how you want to search for driver software. Select Browse my computer for driver software.
On the next wizard page, select Let me pick from a list of device drivers on my computer. Click Next.
From the display list, select your device type, Tape drives. Click Next.
On the next page, enter the location of the Bexsptape device driver. Select Have Disk.
Browse to <product-directory>/bin/drivers/<Osver>, where <Osver> is specific to the version of Windows the device is installed on.
From the display list, select bexsptape. Click Open.
Select the tape drive manufacturer and model in the Model list. Click Next.
A success window appears, confirming that the driver software is updated. Click Close.
Confirm that the tape drive appears in the Tape drives container in the Windows Device Manager display.
Run the Detect utility to record the device id and update your data protection Enterprise to use the Bexsptape driver.
The Bexsptape type of device file is formulated as: bexsptape_vp<0123456789>_cn or bexsptape_vp<0123456789>_n, where
v and p are the first character of the vendor ID and product ID reported by the SCSI Inquiry command.
<0123456789> is the ten-digit unit serial number reported from the tape device.
n denotes no rewind.
c denotes compression enabled.
Either device id format, ending in _cn
or _n
, may be used when configuring the tape device in your Enterprise.
Once the Detect utility completes, the tape device is available for hardware-encrypted tape backups.
See also.
A tape library is a hardware unit comprised of multiple physical or virtual tape drives and tape slots with a media changer for automatically inserting and removing tapes. The device is sometimes referred to as an automated tape library or jukebox.
Catalogic DPX supports tape devices and media changers compliant with the SCSI-2 standard. Tape drives must support variable-length records and allow a minimum transfer size of 32 KB. Additionally, media changer support on Microsoft Windows requires Microsoft Windows NT SCSI Pass-Through support from the HBA driver or a vendor-supplied media changer driver supporting Microsoft Windows NT SCSI Pass-Through.
Unless otherwise advised by Catalogic Data Protection Technical Support, the operating system of the Device Server that connects the tape or tape library device should have properly installed drivers as recommended by the device manufacturer.
Note. No troubleshooting or bug-fix support is offered for devices that are no longer supported by the hardware vendor. Minimal troubleshooting and no new development will be done for devices connected to operating systems that are no longer supported by the vendor.
Catalogic DPX treats a Virtual Tape Library (VTL) device as a regular tape library and supports it the same way it does for tape libraries.
Note. The LTO Generation 9 (LTO-9) mandates the “initial calibration” for every LTO-9 media cartridge when used for the first time. The media initialization process may take up to 2 hours. New LTO-9 media cartridges must be initialized before using them with Catalogic DPX write operations (labeling and backup).
Manual tape library installation involves creating, on the controller node, a device file for the tape library media changer. This media changer device file is a handle used by DPX to identify the hardware address of the media changer. It thereby allows communication with the media changer. Once that communication is established, the tape library driver controls the media changer.
This chapter explains how to manually install the media changer device file. This procedure is required if you are setting up your tape library using Manual Setup (Process B).
The manual installation procedure for the media changer device file varies according to the operating system installed on the controller node. To see specific installation instructions for a particular operating system, refer to the topic that applies to the controller node of your tape library:
Important. DPX support for some of the documented operating systems has been discontinued.
See also. For the latest system compatibility details regarding supported hardware, file systems, applications, operating systems, and service packs, see DPX 4.10 .
Furthermore, if you are using third-party software no longer supported by the vendor, Catalogic Software Data Protection Technical Support may be limited for functions dependent on that software. To address certain issues, the analyst may recommend you upgrade the relevant software.
This procedure explains how to install a tape library for a Windows controller node. Before you begin, make sure the tape library is in random mode (not sequential or stacker mode) and that the media changer is not claimed by the operating system. See .
DPX supports both 32-bit and 64-bit versions of Windows.
To install the media changer device file on your controller node, run detect -i at the command prompt. This will automatically generate media changer device files of the form sync_saX, where X is a non-negative integer starting with 0.
Device files are placed in the bin\JB folder. detect -i also creates a symbolic link for each sync_saX device, allowing it to be used as a native Windows device name.
Warning! Running detect -i will overwrite existing device files created by previous runs of install or detect.
Sample output for detect -i follows:
This procedure explains how to install a tape library for a Linux controller node. You need to have Linux release 2.2.14 or later. The procedure below is for Linux on Intel-compatible architectures.
For Linux, device files of the media changers are generated by the operating system and are located in /dev/sgX, where X is a non-negative integer starting with 0. Device files of the tape drives are located in /dev/stX or /dev/nstX where X is a non-negative integer starting with 0. The tape drives must be set to no rewind and variable block size, which are commonly not the default. For more information, see the man pages for “st” and “stinit” in addition to consulting the drive manufacturer.
The following is the procedure for tape library installation on Linux:
On your controller node, run detect -q at the command prompt. detect -q displays the file names and other information about all SCSI devices accessible by the node on which you are running detect. If everything was connected properly, you will see a media changer device that represents your tape library. Sample output follows:
If you do not see any devices, ensure that the kernel has generic SCSI support and tape drive support installed. For more information, see the man pages for “sgen” and “mtx.”
If necessary, run detect -i from the bin/JB subdirectory to create any additional device mappings.
This chapter provides an overview of how to manually configure a tape library for DPX after the media changer device file is installed. The detailed instructions can be found in in the DPX 4.9.x Reference Guide. Manual configuration is not needed for tape libraries that were successfully set up using Automatic Setup (Process A). However, Automatic Setup does not configure media pools, assign media, or define backup jobs, all of which are also summarized at the end of this topic.
All the manual configuration steps are performed from the management console.
The following steps are required if you set up your tape library by using Manual Setup (Process B):
If you have not already defined your Enterprise, do so now.
If you have not already added your controller node(s) and device server nodes to your Enterprise, do so now.
See also.
in the DPX 4.9.x Reference Guide
The following steps are required if you set up your tape library by using Manual Setup (Process B):
Add the tape library to your Enterprise. Use the Adding a Tape Library function in the management console. You need to supply information about the controller node. Follow the instructions in .
Assign the tape drives to the tape library.
Note. Although the media changer controller node must be running one of the operating systems specified in , tape drives can be attached to any device server (client node) or NDMP node in your Enterprise, either directly or via a SAN. Tape library tape drives do not need to connect to the same node as their media changer (the controller node).
To add the tape drives, use the Adding a Tape Library Device function in the management console. Follow the instructions in .
You need to supply information about the Device ID of the tape drive and the Device Number of the drive bay. See the following section for a discussion about Device ID and Device Number mappings.
Each tape drive in a tape library resides in a unique drive bay. The tape library drive bay is designated by the Device Number and the tape drive driver is designated by the Device ID.
This mapping between the drive bay and tape drive driver is critical for proper tape library operation.
Note. DPX requires that the first drive bay is designated with the number 0, not 1. If your tape library has only a single drive bay, the Device Number is 0.
Generally, the first drive bay (Device Number 0) is mapped to the first tape drive. So for Windows, the mapping would be as follows:
\\.\Tape0
is mapped to Drive Bay 0 (Device Number 0)
\\.\Tape1
is mapped to Drive Bay 1 (Device Number 1)
etc.
Similarly, for Solaris, the mapping would be as follows:
/dev/rmt/0cn
is mapped to Drive Bay 0 (Device Number 0)
/dev/rmt/1cn
is mapped to Drive Bay 1 (Device Number 1) etc.
To confirm this, configure the tape drives in this manner, then try to load and unload a tape.
If you determine that it is not the case that the drive bays are mapped to the tape drives in order, do the following to manually map the device bays to the tape drives:
Find out how the tape library numbers the drive bays internally. For example, top down, bottom up, or other. Consult the tape library documentation or manufacturer.
Load the tape drives with tapes (preferably scratch tapes).
Use the tapedump utility to acquire one of the tape drives and unload the tape. For example:
$ ./tapedump
tape /dev/rmt/0cn
open rdonly
unload
Look inside the tape library and determine which tape ejected. Make note of:
The tape library drive bay number (Device Number) of the tape that physically ejects.
The Device ID you used to acquire this tape drive (/dev/rmt/0cn in our example)
The device server node for this tape drive.
Quit tapedump and cycle through the device drivers on this and other device servers to map the tape library in its entirety.
Note. After opening a tape drive, you will have to quit tapedump to try another device driver. If the open operation fails, there is a rudimentary problem communicating with the tape drive via the device driver or the device driver is not valid. If necessary, consult the hardware manufacturer of the tape drive or Catalogic Software Data Protection Technical Support.
The following steps are required regardless of whether you set up your tape library using Automatic Setup (Process A) or Manual Setup (Process B):
Associate media volumes (tapes) with the media pools and label the media volumes. You usually want to add tape volumes in sets of consecutively named volsers. DPX provides several methods for assigning media volumes to media pools and labeling media volumes.
This procedure describes adding a client node to an already deployed Master Server within the same Enterprise. This procedure is only possible if the DPX Client is not yet installed on the machine you want to add as a node.
A Catalogic DPX Master Server is deployed within the same network
The Master Server’s hostname / IP address and credentials are known
The Catalogic DPX Client is not yet deployed on the machine you want to add as a node
Download the Catalogic DPX Client installer for your platform and follow the installation instructions. For details, see DPX Client installation on or .
In the Add node to DPX Enterprise section, choose Yes to add this node to the Enterprise. You will need to provide the Master Server Hostname or IP address.
Attention! The installer does not validate the Master Server Hostname or IP address. If invalid data are provided, the node will not be added to the Master Server. To ensure the node was added successfully, connect to your Catalogic DPX Master Server via the web or desktop interface and check the list of all available nodes. See also .
Log in to the Catalogic website.
Go to the DPX 4.10 product page and download the OVA file for the DPX Proxy Server.
The file name is structured as shown:
dpx-proxy-<version-number>-<build-number>.ova
Once the file is downloaded, log in to vSphere.
Right-click on the folder where you want to deploy your virtual machine.
Follow the instructions in the Deploy OVF Template wizard. In the License Agreements page, read the Software License Agreement (SLA), select I accept all license agreements if you agree, and proceed to the next steps.
In the Customize template page, enter the following values:
Hostname Configurations
Hostname: The hostname of this DPX Proxy Server virtual appliance. The hostname must be unique.
Connection Configuration
Network IP Address: Enter the static IPv4 address of this virtual appliance. Or, leave it blank so that the dynamic IPv4 address is given via the DHCP.
Network Prefix: Enter 24 for the network prefix of this network interface if you are using the static IPv4 address.
Default Gateway
DNS Servers
Keyboard Language Configuration
Keyboard Language: Select either one of the keyboard layouts for the Linux shell from US English (us), UK English (uk), German (de), French (fr), Chinese (cn), or Polish (pl). The default keyboard layout is US English.
Timezone Configuration
Timezone: Enter the time zone (TZ) value for the Linux operating system. The default TZ is the US Eastern Time (America/New_York).
DPX Proxy Configuration
DPX Master FQDN/IPv4 Address
DPX Master Node Group: DefaultGroup
DPX Master UI Username: A user name of the DPX Management Interfaces. The user must be in the Administrator role. The default user is sysadmin.
DPX Master UI Password: The password for this user.
Review the configurations and launch the deployment of the virtual appliance of the DPX Proxy Server for VMware. Ensure that the new VM for the DPX Proxy Server has been created in VMware vSphere Client. Click Next.
Review all the data in the final Ready to complete screen and click Finish.
Upon successful deployment, power on the DPX Proxy Server virtual appliance. The appliance should be visible as a node added to the Master Server specified in Step 7.
Tip. Add the Proxy Server node as DPX Client.
Catalogic DPX is designed with comprehensive tape library support in mind.
Tape library setup involves two major procedures: installation and configuration. Each of these procedures is described below.
Tape Library installation entails creating the media changer device file needed to enable communication between DPX and the tape library media changer.
Tape Library configuration entails defining the tape library properties so DPX can back up to and restore from media (tapes) accessible to the tape library.
See also. For the latest system compatibility details regarding supported hardware, file systems, applications, operating systems, and service packs, see DPX 4.10 .
For more information about tape libraries in the NetApp environment, read knowledge base article – Configuring Tape Library Connected to NetApp Appliance.
Before beginning the tape library setup process, use the Detect utility to ensure DPX can communicate with the medium changer and that the medium changer status is zero.
The recommended starting point is Unknown Medium Changer disabled, which displays in the Windows Device Manager. If Detect can communicate with the medium changer, the status is zero. For each Detect attempt, the goal is to validate that Detect can see a medium changer and that the status is zero. If those states are not displayed, make a change and run Detect again.
Ensure the following conditions are met before using Detect:
SCSI support and tape drive support are enabled on the operating system. Physically connect each tape library to its controller node and device servers. You can do this directly or through a SAN.
The tape device drivers, which are supplied by tape drive manufacturers, are properly installed. Drivers are often available from the manufacturer’s website. Additionally:
Drivers are compatible with the operating system of the device server. Consult the documentation provided by your hardware vendor.
Tape drivers are capable of writing in variable block size mode.
On Windows platforms, tape drives are visible in Device Manager and the drives are enabled.
DPX client software is installed on controller nodes and device servers. Client software is installed on the master server by default.
For controller nodes, the media changer is not claimed by the operating system or any other software. The media changer must be available for DPX to claim.
The media changer device is disabled in the Device Manager. On Windows Server, the media changer is usually displayed in Device Manager as an Unknown Medium Changer.
Use either of the following methods to navigate to Device Manager:
Click Start > Settings > Control Panel > Administrative Tools > Computer Management > Device Manager.
Right-click My Computer, then select Properties > Hardware > Device Manager.
Right-click on the media changer (usually Unknown Medium Changer). Select Disable.
If you see the message Disabling this device will cause it to stop functioning. Do you want to disable? Select Yes.
Note that disabling the device does not cause the tape library to stop functioning; rather, it removes control of the device by Windows. This enables DPX to claim, detect, and control the device.
Use the Detect utility to validate the status of the medium changer before using the DPX Device Control Wizard. For UNIX and Linux environments, run ./bin/bexenv before running the Detect utility.
On the Controller node, click Start > All Programs > DPX Command Prompt (Run as Administrator).
Tip. You can also log in to the Controller node via SSH.
From the DPX command prompt, navigate to <product-directory>\bin\JB.
Run detect -i.
The expected result is Device ID \\.\sync_sa# and status 0.
If the expected result is displayed, go to step 6.
If the expected result does not display, enable the Unknown Medium Changer and proceed to the next step.
Run detect -i again.
The expected result is Device ID \\.\sync_sa# and status 0.
If the expected result is displayed, go to step 6.
If the expected result does not display, install the hardware manufacturer driver for the arm of the tape library. This resolves the Device ID and status of the Medium Changer. Proceed to the next step.
Run detect -i again.
The expected result is Device ID \\.\Changer# and status 0.
If the expected result is displayed, go to step 6.
If the expected result does not display, contact Catalogic Software Data Protection Technical Support.
If you have not already defined your Enterprise, do it now.
Add controller nodes and device servers to your Enterprise.
The DPX Device Configuration Wizard allows you to bypass many of the manual steps otherwise required for setting up tape libraries.
When possible, the Device Configuration Wizard generates, maps and names device drivers for each tape drive and tape library media changer. It then adds the tape libraries and tape drives to the Enterprise.
You can apply the Device Configuration Wizard to an existing installation. If you do, the Device Configuration Wizard may update those devices for which it detects a Unique ID, which is the unique identifier assigned to a device by the vendor or agency, usually the device’s serial number.
The Device Configuration Wizard is supported by any DPX client running an operating system supported for DPX device servers. An exception is Linux OES, which does not support the wizard.
Tape libraries on platforms that do not support the Device Configuration Wizard must be set up manually, using the procedures described in this instruction set.
You should be aware of the following caveat before executing the wizard:
The Device Configuration Wizard may set up some, but not all of the tape drives and media changers in your Enterprise. For example, a device (tape drive or media changer) might not be configurable by the wizard if DPX cannot detect a Unique ID for that device.
Before executing the Device Configuration Wizard, confirm that all pre-setup steps have been completed. The Device Configuration Wizard can be run from any machine that can ping your master server. Set the environmental variable SSICMAPI so that it points to the master server.
For example:
or
To launch the Device Configuration Wizard from Windows:
Click Start > DPX > Device Configuration Wizard
To launch the Device Configuration Wizard from UNIX:
Change to the bin directory under the installation directory. In addition, you may need to set the DISPLAY environment variable to your local host.
Enter ./devconfwizard at the shell prompt.
The Device Configuration Wizard window is launched.
The wizard asks you to log into your Enterprise. Log into the master server as an administrator. After entering your credentials, click next.
The Device Configuration Wizard uses an intuitive graphical user interface to guide you through the device configuration process. The wizard probes your Enterprise and detects information about your nodes, devices, tape libraries, and connections.
The following is a sample session of the Device Configuration Wizard for illustrative purposes. This sample session sets up a SAN with three heterogeneous servers and one six-drive tape library, as depicted in the following diagram:
The wizard displays all nodes in the Enterprise that can serve as device controller nodes.
Use the checkboxes to select one or more controller nodes for which you want to install and configure devices.
Clicking the Options… button will display a dialogue box with a list of configurable scan options.
The following options can be adjusted:
Show all the nodes
There may be nodes on the Enterprise whose configuration options indicate they are not compatible with scanning. By default, these nodes are not displayed in the list of potential device controllers. Selecting this option will include those nodes in the list.
Concurrent Nodes to Scan
This setting affects how many nodes the wizard will communicate with concurrently while performing the scan. This can affect scan speed.
NDMP Port NDMP-capable. This setting allows you to set a port number for communicating with NDMP-capable NAS nodes.
Check here to enable Catalogic DPX LTO Encryption Option Clicking this check box will activate the Please Select pull-down menu, which you can use to enable, update or disable LTO hardware encryption functionality. The Enable/Update option enables the encryption option for nodes that support this feature or updates the list of tape devices to which the node can encrypt data.
Click OK to confirm your options choice.
Clicking the Assign Peer Nodes… button displays any other nodes that can communicate with devices in the SAN. (These nodes are not running one of the supported platforms listed at the beginning of this chapter).
When finished configuring options and selecting devices, click next. At this point, the wizard scans the selected node(s) for SCSI devices.
When the nodes have been successfully scanned, “Done” appears in the status column, and the next button becomes enabled. Click next to continue.
The wizard displays all unconfigured tape libraries accessible by the selected nodes. In this example, there is only one tape library, and it is accessible by both nodes. Select the tape library that corresponds to the server (controller node) that will control the media changer. You can either click anywhere in the entry’s row and then click the Add to Enterprise button (which becomes enabled once a selection is made), or you click the entry’s associated check box, which will advance you to the next step without the need to click Add to Enterprise
The wizard requests information about the tape library you selected.
Complete the active fields in the dialog:
Configure As SAN
This check box gives you the option to configure the device as a SAN. The check box appears if the device is seen by only one node. If multiple nodes see the device, it is automatically configured as a SAN and the check box does not appear.
Tape Library Name
Enter a name (up to 14 alphanumeric characters) for the tape library (for example, DEC_TL810). No two tape libraries in the Enterprise can have the same name.
Tape Library Type
Select the tape library type (for example, DEC_TL810) from the pull-down menu. If your tape library type is not shown, select the type that most closely matches yours.
Controller ID
The Device Configuration Wizard generates a media changer device file and installs it on your controller node. The name of that file, assigned by DPX, is displayed in this field.
Data Slots
From the pull-down menu, select the starting and ending slot numbers to use for media volumes. Note that slot numbers start at zero (0). Thus, the first slot is slot number 0, and the final slot is slot number (n-1), where n is the number of slots in your tape library.
Cleaning Slots
From the pull-down menu, select the starting and ending slot numbers to use for cleaning tapes. To configure a single cleaning slot (typical setup), enter the slot number twice. If no cleaning slots exist, leave these fields blank.
Device Type
Select a device type (for example, LTO) from the pull-down menu. All devices in a tape library must be the same type.
Cleaning Threshold
Enter the number of times a drive can be used before it is cleaned.
Comment
Optionally enter an alphanumeric string of up to 48 characters.
When you have filled in all the required information, click next.
The wizard displays a list of devices attached to the newly added tape library. If you need to change the device names, you can do so on this screen. Click inside the device name field and enter a new one.
When you are finished changing device names, click next.
The wizard indicates that the tape library has been added by placing a checkmark in the box in the leftmost column on the New Tape Libraries window. If you have additional tape libraries to add to the Enterprise (in this case we do not), repeat steps 3 through 5 for each.
Note. For a SAN, the tape library needs to be added only once.
Click next when you are finished adding tape libraries. The wizard shows the devices that were added, as well as other detected devices that were not part of a configurable tape library. Use this window to add additional devices, as well as to remove any of the devices added in previous steps.
To add additional listed devices, select a device and click Add to Enterprise, assign the device to a tape library or device pool, then specify a device name. To remove a device you have already added, select the device and click Remove from Enterprise.
Note. If you encounter an error, click View Log. A log file, which can be used for troubleshooting, is displayed. Save the log file by clicking Save….
Click Exit to exit the Device Configuration Wizard.
Later, when you log into the management console and navigate to the Configure Devices window, you can open the device clusters to view all the devices and device paths for a given tape drive.
You can edit the information for any of these devices in the management console under Configure Devices.
If you set up your tape library using Manual Setup (Process B), detection is the first step. The DPX Detect utility is also a handy tool for troubleshooting down the road.
The Detect utility allows you to display and map media changers and tape drives accessible from a given device server or controller node. This utility is found in the /bin/JB
subdirectory of the main directory.
Detect can be run from any machine on your network under an administrative User ID.
If you are using third-party software no longer supported by the vendor, Catalogic Software Data Protection Technical Support may be limited for functions dependent on that software. To address certain issues, the Catalogic Software Data Protection Technical Support may recommend you upgrade the relevant software.
The AIX platform offers limited support, meaning that the configuration phase is not supported and the detection phase may miss some properties such as the World Wide Name or Serial Number. Other platforms offer full support meaning that the Detect utility can detect devices and obtain their vendor ID, product ID, SCSI Target, LUN, etc., plus their World Wide Name and Serial Number. Besides the detection phase, this utility can create (configure) device files.
Some versions of UNIX detect require running in a shell that has the appropriate environment setup. For details contact Catalogic Software Data Protection Technical Support.
You can use either detect -q or detect --query. They are different formats of the same command.
As the first step to every manual tape library installation on the above platforms, you should run the following on your tape library controller node:
detect -q gathers and displays information about media changers and tape drives that are accessible from the node on which you are running Detect. detect -q does not create or install any new devices and does not modify any files. Thus, it is always safe to run Detect with the -q command line option. The following is an example of output from detect -q:
Note that the output contains two tables. The rows in both tables are identified by the Device ID field. The device representing the media changer is identified by Media Changer Device or simply Medium in the Device Type field. So, in the tables above, the third row (\\.\sync_sa0
) is the row representing the media changer.
The output displayed above is for a Windows platform, but the content would be similar on any platform. (For Solaris, a freshly connected tape library might not be detected by detect -q, in which case you should use detect -i as described in the next chapter). The following describes the fields (columns) in the output from detect -q, specifically with regard to the media changer device:
Note that the Detect output does not have a specific field indicating whether the device is claimed. However, if the appropriate driver does not claim a device, its name will not appear in the Device ID column and -1
will appear in the status column.
The Detect utility also has a debug option, -d.
For all platforms listed in the introduction to this chapter, there are three debug levels: 1, 2, and 3, with level 3 being the most comprehensive. For example, you can run:
The Detect utility -f N options (where N is 1, 2, 3, or 4) allow you to bypass some operations of detect -q.
detect -f 1 processes only media changer devices.
detect -f 2 processes only sequential access devices (tape drives).
detect -f 3 processes media changer and sequential access devices.
detect -f 4 processes only devices that are not changers or tape drives.
Tip. You can remove it by clicking theicon visible upon hovering over the device record.
in the DPX 4.9.x Reference Guide
in the DPX 4.9.x Reference Guide
This concludes the installation of the tape library media changer device file under Windows. To test the installation, proceed to . Use the media changer device file name (for example, sync_sa0
) as the argument for the tape library interface test program (JItest).
This concludes the installation of the tape library media changer device file under Linux. To test the installation, proceed to . Use the media changer device file name (for example, /dev/sg1
) as the argument for the tape library interface test program (JItest).
Before backups can be performed using the tape library, media pools (also called tape pools) for the tape library must be created. Use the Adding a Media Pool function in the management console. Media pools should be set up in a way that makes sense for your Enterprise. Follow the instructions in .
Follow the instructions in or in the DPX 4.9.x Reference Guide.
Now that DPX recognizes your tape library, tape drives, and media and is able to control the tape library media changer, you are ready to perform backups to media associated with your tape library. For details about defining, scheduling, and running backups and restores, see the and sections.
See also. Refer to a list of TZ values, e.g. from WorldTimeAPI page.
Note. It may take several minutes for the DPX Proxy Server to be visible as a node in Master Server. If you cannot see the node, you may add it manually from the Master Server. See .
This section is intended for system administrators who are setting up their tape libraries by using Automatic Setup (Process A). If you are setting up your tape library by using Manual Setup (Process B), proceed to .
See also. For the latest system compatibility details regarding supported hardware, file systems, applications, operating systems, and service packs, see the DPX 4.10 .
Before starting the Device Configuration Wizard, you can determine whether a given device is configurable by the wizard by running “detect -q” from a device server node accessible to the device. The Detect utility is described in detail in . The Auto field on the output report produced by Detect indicates whether the device can be set up with Device Configuration Wizard.
See also. , in DPX 4.9.x Reference Guide.
See also. For the latest system compatibility details regarding supported hardware, file systems, applications, operating systems, and service packs, see Catalogic DPX 4.10 .
For all platforms listed in the introduction to this topic, you can use detect -i or detect --install, to install the media changer device file. This is discussed in greater detail in .
HPE LTO-5, HPE LTO-6, HPE LTO-7, HPE LTO-8, HPE LTO-9*
IBM LTO-5, IBM LTO-6, IBM LTO-7
Dell PowerVault TL2000
HPE StoreEver MSL3040, HPE StoreEver MSL6480
Oracle StorageTek SL150
Overland Tandberg NEOxl 80
Quantum Scalar i500, Quantum Scalar i6000
Device ID
The file handle of the device driver for this particular device.
Adapter ID
The adapter associated with this device.
BUS
The bus number on this adapter. One adapter may have more than one bus.
Target ID
SCSI Target identifier (SCSI ID).
LUN
Logical Unit Number.
Status
Status values may have different meanings for different platforms. In general, 0 = no problems. Other values are described below, by platform.
For Windows:
-1
Media Changer: device has already been claimed by another driver. Tape Drive: Detect has failed to acquire a handle for device.
-2
Media Changer: Unit attention required. Tape Drive: device is not claimed by a driver and thus is unusable by the OS.
-3
Device will not report unique IDs of its tape drives, but still could be used.
-16
Library may be claimed by a driver on a 64-bit system.
For Solaris:
-3
Device will not report unique IDs of its tape drives, but still could be used.
-5
I/O Error.
-16
Device Busy.
For Linux:
-1
Media Changer: device has not responded properly on a SCSI inquiry command. Tape Drive: drive is not loaded.
-3
Device will not report unique IDs of its tape drives, but still could be used.
For HP-UX:
-1
The media changer or a tape drive has not responded to a SCSI inquiry command.
For AIX:
-1
The media changer or a tape drive failed to open.
Device Type
The type of device, according to SCSI-2 specifications.
String
Vendor and product identification information.
Serial Number/Unique ID
Unique identifier assigned to a device by the vendor or agency (for example, ANSI or SNIA).
World Wide Name
A 64-bit number, assigned by IEEE, used to identify a product. It is often used as a port number on Fibre Channel networks.
DPX Auto
Flag indicating whether the Auto-Configuration utility can be applied to this device.
In DPX, all standard users are referred to as administrators.
Administrators are the authorized users of a DPX Enterprise. Each administrator has a password which is used for authentication.
Administrators are organized under administrator groups. Each administrator is a member of one administrator group.
Resources are assigned to administrator groups.
Privilege Classes are assigned to administrators.
Restrictions. Currently, full user management is only available through the desktop interface. The user management functionality through the web interface will be implemented in future versions of DPX.
By default, a special administrator named SYSADMIN exists, who is a member of the SYSADMIN administrator group. The SYSADMIN administrator group is always present in DPX.
All members of the SYSADMIN administrator group are special administrators and are not restricted in any way in DPX. All resources are automatically assigned to the SYSADMIN administrator group and full privileges are automatically assigned to the system administrators in the SYSADMIN group.
The SYSADMIN administrator cannot be created or deleted by a user and it is not displayed on the Configure Administrators window as a member of the SYSADMIN administrator group. The password for the SYSADMIN administrator is determined in the Administrator Password field on the Configure Enterprise window when the Enterprise is added or edited.
For administrator configuration, there are several types of resources in DPX:
Device Clusters
Node Groups
Job Folders
Tape Libraries
Media Pools
Administrator Groups
Keyrings
Each resource type can be viewed as a container containing objects in DPX. When you assign a resource, you are in fact assigning all the objects contained in it. For example, if you assign a node group called Sales to an administrator group, all the nodes within Sales will be assigned to that administrator group.
When a resource is assigned to an administrator group, each member of that group can potentially access that resource. However, the access may be restricted due to each member’s privilege classes.
If a new resource (such as a node group) is created by an administrator in an administrator group, that resource is automatically assigned to that administrator group. An existing resource may be assigned to additional existing administrator groups by an administrator with the appropriate privileges.
Note. If you assign an NDMP node to an administrator group, it is important that the proxy node also be assigned to that administrator group.
DPX comes pre-configured with the following default privilege classes:
Backup Job Admin
The administrator can define backup jobs.
Copy Job Admin
The administrator can define copy jobs.
Device Admin
The administrator can configure device clusters, tape libraries, and devices.
Device Operator
The administrator can operate devices.
Job Operator
The administrator can reschedule and run jobs.
License Admin
The administrator can update a license key.
Media Admin
The administrator can configure media pools and media volumes.
Migrate Job Admin
The administrator can define migration jobs.
Node Admin
The administrator can configure node groups and nodes.
Restore Job Admin
The administrator can define restore jobs.
Restricted Restore Job Admin
This special administrator is just like the Restore Job Admin, except they cannot change the destination of the job.
Site Admin
The administrator has all the assignable privileges.
View Only Admin
The administrator can view all the windows in the management console.
Note that some privilege classes overlap in their privileges, but in general, they can be viewed as corresponding to different roles that a real user of DPX may play. Thus, one or more privilege classes should be assigned to each administrator.
It is possible to configure additional privilege classes in DPX, but this is only advisable for advanced users and with the help of Professional Services.
The following are example configurations based on some common scenarios.
The easiest configuration is to have only the SYSADMIN group in your Enterprise. This may be appropriate if you have a small Enterprise. All the resources are automatically assigned to the SYSADMIN group. You may assign trusted users as administrators to the SYSADMIN group.
If your Enterprise is small enough that you do not want to break up the resource assignments, but you have untrusted users, then you should configure one administrator group. This may be appropriate for small to medium enterprises where operations-level personnel needs to interact with DPX to load and unload tapes, for example.
All the resources you have configured should be assigned to one administrator group, and administrators with varying privilege classes should be created within that administrator group.
If you have a large Enterprise where you need to distinguish resources due to geography or business needs, it is best to create multiple administrator groups, each corresponding to such a distinction. A resource can be assigned to more than one administrator group, enabling selected resources to be shared among administrator groups.
If you have a large Enterprise where you expect to have layers of administrators for DPX, you may want to create a hierarchy of administrator groups. For example, if you want to create an administrator group that is in control of two geographically isolated administrator groups (AGx and AGy), you can create a new administrator group (AGa) with both administrator groups assigned to it. Any resource that is assigned to either AGx or AGy is automatically assigned to the members of AGa.
Note. This method updates the DPX Master Server’s Core, Microservices and Infrastructure. It does not update individual DPX Clients.
This update method is performed by using an ISO image along with the accompanying update script. Both files can be downloaded from the Catalogic MySupport website after logging in with your user credentials.
Important. Before running the DPX update script, take a full VM snapshot of the Catalogic DPX Master Server virtual appliance.
Typically, both files will follow the same naming convention, i.e. dpx-master.core-
<core_version_no>
.svc-
<microservices_version_no>
.infra-
<insfrastructure_version_no>
followed by _update.sh
or -update.iso
. In the examples below, for the sake of clarity, they have been renamed to 4-10_update.sh
and 4-10-update.iso
accordingly.
The procedure described below assumes the 4-10_update.sh
and the 4-10-update.iso
files are available from within the DPX Master Server machine, in the same location.
Log in to your DPX Master Server via SSH. The login is dpxadmin
and the default password is dpxadmin
. If you logged into the same Master Server in the past, you may have been forced to change the password. In such case, provide the current password, not the default one.
Use sudo su
to gain root user permissions.
Change permissions to the 4-10_update.sh
file:
Call the 4-10_update.sh script, specifying the 4-10-update.iso image file as argument:
The following prompt will appear:
If you have no jobs running and wish to proceed with the update process, type Yes
.
The update procedure will start. This process may take a long while to complete. Some progress steps will be printed in the terminal.
Upon completion, the installer will ask if you want to reboot your master server.
Select Y
to reboot the master server now or N
to do it later.
This ends the updating procedure. Wait for your updated DPX Master Server to reboot, then you can resume using it.
The Catalogic DPX suite encompasses additional tools designed to enhance DPX’s data protection and management capabilities. These tools include vStor, which provides efficient backup and recovery options, and GuardMode, which offers advanced ransomware detection. Both are designed to seamlessly integrate with the DPX environment to ensure a comprehensive and secure data management solution.
Catalogic vStor, developed by Catalogic Software, is a robust server designed for efficient, safe, and versatile data protection and recovery. It is intended to serve as the primary backup destination for Catalogic DPX, connecting to disk storage pools. The vStor server can be installed on either a virtual or physical appliance at any stage post-deployment of the Catalogic DPX Master Server.
Catalogic vStor servers can be deployed:
on a physical machine
in a VMware environment
in a Hyper-V environment
You can use vStor both for backup and recovery, with Block and Agentless backups. For File backups, a DPX Client must be installed on the target machine.
See also. To learn more about the Catalogic vStor, see the vStor 4.10 Documentation.
Since version 4.8.1, Catalogic DPX bundles the Catalogic DPX GuardMode, which provides early detection of ransomware or data-related anomalies before you back up your data.
GuardMode Agent monitors filesystem activity for:
Ransomware-specific patterns and extensions
Processes that are consistently altering data on the system for longer periods
Rapid file renames and modifications
Attempts to modify decoy files
Files with high entropy and unreadable metadata
Unlike traditional ransomware detection solutions, GuardMode is designed with the backup administrator in mind, providing easy-to-configure detection mechanisms and guidance for data recovery. It complements endpoint and edge protection by monitoring file shares and system behavior over the network, maintaining and regularly updating over 5000 known ransomware threat patterns, and assessing affected files.
See also. To learn more about the Catalogic GuardMode, see the GuardMode Documentation.
In File backup, DPX backs up data logically file by file. File backup is what you normally think of when you think of backups.
In this backup type, you back up information at the node group, node, disk, directory, or file level. The following list describes each level:
Node Group
Set of nodes that have been explicitly organized into a named group by the System Administrator.
Node
A single machine such as a PC, a workstation, or a server.
Disk
A logical disk or file system such as C:
or D:
on a node running Windows, /
on UNIX or Linux.
Directory
A UNIX or Linux directory or a Windows folder.
File
Any file.
Temporary space is required on the backup source node(s) for File backup. A rule of thumb for approximating the temporary space (in bytes) is 150–200 times the number of files being backed up. The temporary file, created in the directory where DPX was installed, is deleted after the backup.
Files or directories included in the backup definition will not be backed up if they are excluded through a Windows registry entry. The Windows registry excludes some files by default. If you want to back up these files, remove the exclusions in the registry.
To check for exclusions in the Windows registry, run Microsoft Registry Editor (regedit) and drill down to HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\BackupRestore\FilesNotToBackup
. Remove any undesired exclusions.
Warning! Changes to registries or environmental variables should be done only by qualified administrators. If done incorrectly, such changes can adversely affect applications or operating systems. Contact the Catalogic Software Data Protection Technical Support if you need assistance.
To add exclusions, use DPX rather than the Windows registry.
The DPX environment consists of several elements, each requiring periodical updates:
DPX Master Server
Core (the underlayer and the desktop interface)
Microservices (the web interface with its unique functionalities)
Infrastructure (the operating system of the machine where DPX is installed)
DPX Clients and DPX Proxies
DPX agents installed on virtual or physical machines
Storages
Third-party software of virtual or physical storages used for storing DPX backups. This software is updated using dedicated third-party tools (not covered in this section – please refer to the particular solution’s documentation).
Note. The recommended update scenario consists of two steps:
Updating the DPX Master Server using Command Line Update.
Updating DPX Clients and Proxies using the Autoupdate Method.
It is also possible to update each Client and Proxy individually by downloading dedicated .jar
files, however this scenario is not recommended.
If in doubt, contact the Catalogic Software Data Protection Technical Support team.
Important. To update your DPX environment to the 4.10 version, you need to have any version of DPX 4.9 installed. Updating from previous versions requires installing certain versions in between, e.g. for version 4.8.0, you first need to update DPX Master Server to 4.8.1, then update all Clients and Proxies to 4.8.1. Only then you can proceed with updating the entire environment to any version of 4.9 (4.9.2 is recommended). From then, proceed with updating the environment to the latest 4.10 version as described herein.
Updating Catalogic DPX requires the following steps:
Note. This step updates the DPX Master Server’s Core, Microservices and Infrastructure. It does not update individual DPX Clients or Proxies.
In this method, the user copies update files to the designated directory of the DPX Master Server and invokes the software update from the shell. Follow the instructions in Command Line Update.
Warning! This step updates the DPX Clients and Proxies. If you skip Step 1, it will also update the DPX Master Server’s Core but not the Microservices or Infrastructure. This may lead to unexpected results.
Note. Autoupdate is currently only supported through the desktop interface.
This step can be performed in either of two manners: as online autoupdate or offline autoupdate.
With the Online Autoupdate method, the DPX Master Server automatically downloads the latest update package files and sends them to the Clients for automatic update. This method requires Internet access for the DPX Master Server. Follow the instructions in Online Update Method.
The Offline Autoupdate method does not require Internet access for the DPX Master Server. Instead, manually copy the update package files to the designated directory (or “repository”) on the DPX Master Server – typically by using an SCP client on your workstation. Then install and update the package files. Follow the instructions in Offline Update Method.
Catalogic DPX Block Data Protection assures minimal business interruption and maximum data integrity in the event of any data resource loss – large or small. The Catalogic DPX Block Data Protection utilizes proprietary Catalogic technologies for block-level backup and fast, reliable recovery.
Block backup is the backup component of the Catalogic DPX Block Data Protection. In the desktop interface, block backups are implemented through the Block Backup Wizard. In the web interface, block backups are defined in the Job Manager section just like any other backup type.
Block backups interact with the NetApp deduplication (Advanced Single-Instance Storage) for the NetApp storage systems.
The Catalogic DPX Block Data Protection processing automatically invokes block deduplication after the data transfer; all data at the root of the volume is deduplicated at that time. Due to differences in deduplication support between Data ONTAP versions, it is strongly recommended that Data ONTAP 8.0.1 or later be used with 64-bit aggregates to maximize deduplication and processing efficiency.
Deduplication is a feature that is enabled per volume. It is recommended to start deduplication backup jobs on newly created empty NetApp volumes as the NetApp deduplication will not deduplicate data already retained in existing snapshots. For volumes with A-SIS enabled, deduplication processing is automatic and occurs immediately after the backup job completes. Scheduled volume deduplication should be disabled within Data ONTAP as the backup automatically invokes the deduplication process, and any additional scheduling is redundant and an unnecessary drain on system resources. There is no option to defer deduplication until a later time.
NetApp deduplication requires a NetApp A-SIS license.
Procedures
Tape Device Manufacturer
Device Server Operating System
Procedure 1. Enable hardware encryption (Device Configuration Wizard)
HP Quantum
Windows Linux UNIX
Procedure 2. Configure the Device Server for Bexsptape (Windows Device Manager)
HP Quantum
Windows
Procedure 3. Run the Detect utility
HP Quantum IBM
Windows Linux UNIX
If your DPX Master Server has Internet access, you can update it by taking the steps described below.
Launch the desktop interface (see Connect to DPX Window).
Click Help > Autoupdate DPX in the menu bar or press [Ctrl + E] to open the Autoupdate dialog.
In the Autoupdate dialog, select Check the online service for updates (default). Use this option if the Catalogic DPX Master Server has access to the Internet, and you want to install the latest update packages on the system with fewer steps.
Enter the Catalogic Software Online User ID and Password in the Authentication section. If you enter an invalid User ID or Password, you will get an information message dialog saying MySupport Authentication failed in the next step.
Attention! Always use your own customer service account of Catalogic Software. Do not reuse other credentials, such as those of your distributors, resellers, etc. Credentials, which may be cached, need to be consistent for future software updates.
Additionally, you can configure the advanced options for automatic update checking with notification emails every week, after checking the Disabled. Click to Enable field:
Administrator E-Mail Address Enter an email address for the recipient who receives the update notification message.
SMTP Host Name The host name of the SMTP server for the email notification.
SMTP Port The port number of the SMTP server for the email notification. A typical port for SMTP servers is 25.
Day of the Week Select a day of the week to receive the weekly notification email: Sunday, Monday, and so on.
Hour of the Day Specify the time of the day, based on the system clock of the Catalogic DPX Master Server.
Tip. The time zone (TZ) depends on the system clock of the DPX Master Server. Typically, you can check the system time zone using the timedatectl
command for the Linux shell or the Get-TimeZone
command for Microsoft PowerShell.
Software Site URL Enter a valid URL for updating the DPX Master Server. Use the following default string unless otherwise instructed by the Catalogic Software specialists:
Click OK. You can see the progress bar and the number of available update packages. As the node scanning process continues through the following steps, progress is indicated with a message at the bottom of the Autoupdate dialog. Any nodes in the Enterprise that the software update system fails to successfully check because of connectivity issues are reported. This step could take a while as it performs a sequential scan of the backup Enterprise.
The Catalogic DPX Master Server automatically tests if it can update all nodes in its Enterprise. If the test succeeds, you will see another Autoupdate dialog.
Tip. If the update test fails, the Node Scanning Failure dialog will be displayed with a list of all nodes of the DPX Master Server that cannot be updated. In the dialog, see a test result for each failed item. Click Quit to cancel the update, and fix these issues.
In the Autoupdate dialog, you can see a list of all available software update packages and a list of applicable nodes, including the DPX Master Server, with checkboxes. By default, all nodes are selected to update. You can clear any checkboxes to skip updating the systems. Click Update Now and follow the instructions in the dialog. The top pane lists software update packages found for the Enterprise. The name of the update is listed as well as the level of the update. The bottom pane lists nodes to be updated with the various software update packages selected in the top pane. By default, all packages and nodes are selected for update, indicated by check marks. Select All Updates and Select All Nodes are also initially selected. For initial deployment, accept these defaults.
Note. The reboot behavior of the updated nodes is shown in the Reboot column on the right side of the bottom pane. When reboot is set to Yes, the node automatically reboots after all updates are applied. If you do not want the automatic node reboot, select No, but ensure you manually reboot the node before you attempt a backup.
Click the Update Now button at the bottom of the dialog box. You will receive several informational messages:
Click Continue or OK.
The next window will display the progress of the software package updates. On the node selected for update, the software update package is placed in the \updates\packages
directory in the installation directory.
Important. Clicking Abort at the left of the progress bar cancels installations that have not yet been performed but does not roll back those installations that have already occurred.
Do not click Abort to stop updating the selected nodes unless absolutely necessary or instructed by Catalogic specialists.
After the Abort button changes to Done, click it.
Follow the instructions in the dialog. You will be prompted to reboot some nodes, including the DPX Master Server.
Important. After the autoupdate process, all updated client nodes require reboot before any backup or restore operations are performed.
If your DPX Master Server has limited Internet access, you have to store the update package files in the repository directory in it and invoke the autoupdate. Take the following steps so that the autoupdate can load and install the update package files from the repository directory.
Note. Autoupdate is currently supported only through the desktop interface.
From your web browser, sign in to the Catalogic Software MySupport website.
Go to the product page for Catalogic DPX 4.10. See the section Software Updates and the table DPX Core Updates. Download the Java archive (JAR) file for the Master Server and for all operating system types within your enterprise where DPX Clients are installed. This information can be found in the Nodes Info.
Tip. You will apply the update files to every node in your backup Enterprise.
On your DPX Master Server, locate the repository directory:
<product directory>/updates/packages/
For Catalogic DPX for Microsoft Windows, replace the slashes (/
) with backslashes (\
).
Copy the JAR file to the repository directory in the system to update.
Attention! Do not rename the .JAR
file.
Launch the desktop interface (see Connect to DPX Window).
Click Help > Autoupdate DPX in the menu bar or press [Ctrl + E] to open the Autoupdate dialog.
In the Autoupdate dialog, select Check for updates using already downloaded patches. Use this option if your DPX Master Server has limited access to the Internet, and you want to manually download and copy the update package files in the repository directory.
Click OK without entering the User ID or password, and follow the instructions so that you can install the software update packages in the repository directory. There is a known issue (in DPX 4.8 only) that the password field does nothing (DPXN-5104).
Attention! Always use your own customer service account of Catalogic Software. Do not reuse other credentials, such as those of your distributors, resellers, etc. Credentials, which may be cached, need to be consistent for future software updates.
Additionally, you can configure the advanced options for automatic update checking with notification emails every week, after checking the Disabled. Click to Enable field:
Administrator E-Mail Address Enter an email address for the recipient who receives the update notification message.
SMTP Host Name The host name of the SMTP server for the email notification.
SMTP Port The port number of the SMTP server for the email notification. A typical port for SMTP servers is 25.
Day of the Week Select a day of the week to receive the weekly notification email: Sunday, Monday, and so on.
Hour of the Day Specify the time of the day, based on the system clock of the Catalogic DPX Master Server.
Tip. The time zone (TZ) depends on the system clock of the DPX Master Server. Typically, you can check the system time zone by using the timedatectl
command for the Linux shell or the Get-TimeZone
command for Microsoft PowerShell.
Software Site URL Enter a valid URL for updating the Catalogic DPX Master Server. Use the following default string unless otherwise instructed by the Catalogic Software specialists:
Click OK. You can see the progress bar and the number of available update packages. As the node scanning process continues through the following steps, progress is indicated with a message at the bottom of the Authentication dialog. Any nodes in the Enterprise that the software update system fails to successfully check because of connectivity issues are reported. This step could take a while as it performs a sequential scan of the backup Enterprise. The Catalogic DPX Master Server automatically tests if it can update itself and all nodes in its Enterprises. If the test succeeds, you will see the Update dialog.
Tip. If the update test fails, the Node Scanning Failure dialog will be displayed with a list of all nodes of the DPX Master Server that cannot be updated. In the dialog, see a test result for each failed item. Click Quit to cancel the update, and fix these issues.
In the Update dialog, you can see a list of all available software update packages and a list of applicable nodes, including the Catalogic DPX Master Server, with checkboxes. By default, all nodes are selected to update. You can clear any checkboxes to skip updating the systems. Click Update Now and follow the instructions in the dialog. The top pane lists those software update packages found for the Enterprise. The name of the update is listed as well as the level of the update. The bottom pane lists nodes updated with the various software update packages selected in the top pane. Initially, all packages and nodes are selected for update, indicated by check marks. Select All Updates and Select All Nodes are also initially selected. For initial deployment, accept these defaults. Note the reboot settings in the Reboot column on the right side of the bottom pane. When reboot is set to Yes, the node automatically reboots after all updates are applied. If you do not want the automatic node reboot, select No, but ensure you manually reboot the node before you attempt a backup.
Click the Update Now button at the bottom of the dialog box. You may receive several informational messages.
Click Continue or OK.
The next window will display the progress of the software package updates. On the node selected for update, the software update package is placed in the \updates\packages
directory in the installation directory. Clicking Abort, at the left of the progress bar, cancels installations that have not yet been performed but does not roll back those installations that have already occurred.
After the Abort button changes to Done, click it.
Important. While updating the selected nodes, do not click Abort to stop updating the selected nodes unless absolutely necessary or instructed by the Catalogic specialists.
Follow the instructions in the dialog. You will be prompted to reboot some nodes, including the DPX Master Server.
Note. The autoupdate applies to all nodes in the DPX Master Server’s Enterprises. The update and system restart operations for the DPX Master Server take place at the end, after updating all other nodes.
Catalogic DPX offers a variety of source options for File backup. All of them are available from both interfaces, but the access thereto may slightly differ. See details for each interface below.
To access the job source options, do the following:
Go to Job Manager in the sidebar.
Open an already existing backup job. Or create a new File backup job, by clicking the New Backup Job button in the upper right corner and then selecting Backup Type File.
Go to the Advanced Options section at the bottom (scroll down if necessary) and expand it. Click any of the following section headers to expand it. Each field and the available choices are explained below.
Note. The Advanced Options section in the web interface also includes job destination options which are discussed in a separate section for the sake of clarity. See Job Destination Options for File Backup.
Controls the data verification technique for writing data to a media volume. The higher the verification level, the greater the safety and the longer a backup takes. Each verification level builds upon the preceding level. For example, level 3 performs level 1 and level 2 verification as well. Select one of the following options:
No Verification
Writes data to the media volume without verification. This is the fastest option and relies on the tape device for data verification.
Level 1
Reads the tape to ensure that it is readable.
Level 2
Reads the tape and ensures that the SIDF headers are present and contain the correct information.
Level 3 Ensures that the checksum of each file on the tape matches the one contained in the SIDF header for that file. This verification is only performed if the Checksum Files toggle is set to Enabled in the Job Destination Options section. The tape and SIDF headers are also read and verified (levels 1 and 2).
Compresses data prior to network transmission.
Toggle on
Compress data prior to transmission at the node being backed up. This setting is recommended if there is processing power available on the client nodes and network bandwidth is limited. The setting minimizes the impact of data transmission on data lines.
Toggle off
Disable data compression.
Determines expected behavior when encountering an NFS (network file system) volume during a backup operation. NFS volumes are remotely mounted volumes owned by another node. This option also controls the backup behavior of drives mapped to the Microsoft Windows node (CIFS mount point).
Toggle on
Back up NFS volumes and drives mapped to the Microsoft Windows nodes.
Toggle off
Do not back up NFS volumes or drives mapped to the Microsoft Windows nodes.
If you are not using an open file manager, this option controls how many times DPX attempts to back up an open file. If you enter zero, DPX skips open files. If you enter a number, DPX waits until all the files on the node have been backed up then tries again to save the open files. DPX attempts this the number of times you enter here.
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.
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.
If you are not using an open file manager, this option tells Catalogic DPX whether to catalog open files encountered on UNIX systems. On UNIX nodes, Catalogic DPX backs up the file and then checks to determine if it has been modified while the backup transpired. If it has, the file is considered open. Cataloging open files is not generally recommended.
Toggle on
Catalog the backed-up file if detected that the file has been modified during the backup process and the number specified in the Open File Retries field has been reached. DPX catalogs its last attempt to back up an open file if it finds the file is still open. Note that cataloging a file that has been modified during the backup can compromise the integrity of the file when that file is restored.
Toggle off
Do not save the backed-up file if DPX detects that the file has been modified during the backup process and the number specified in the Open File Retries field has been reached.
Tells DPX whether to back up data on a mounted drive (volume). This field only applies to NTFS volume mount points on Windows 2000 and higher machines.
Toggle on
Data on a mounted drive is backed up through a volume mount point.
Toggle off
Data on a mounted drive is not backed up through a volume mount point. Whether the directory is restored as a volume mount point or not depends on the Set Job Destination Options.
Note. If the toggle is set to On, and if you select both a volume mount point and the drive itself, duplicate backups might occur.
Remote Storage Service (RSS) is the Hierarchical Storage Management (HSM) system for Windows 2000 and higher, which automatically migrates files from disk to remote media, like tape. If the Windows administrator configures this service and disk space becomes low, files not modified for a specified period of time are sent to remote storage. A link (stub file) to the remote storage is kept in their place. Users can recall these stub files by accessing their links. This field determines whether DPX should back up links to these files or the files themselves.
Toggle on
Files on remote storage are backed up by DPX. In this case, files are backed up from tape to tape. At restore, files are restored to disk. However, because file dates are not affected by backup and restore, it is likely that the files will automatically be sent back to remote storage.
Toggle off
Files on remote storage are not backed up. DPX backs up their links.
Note. The tape devices and the media pool used by Windows for remote storage service cannot be shared with DPX.
Tells DPX whether to back up System Protected Files as part of the System State Backup. This applies only to Windows 2000 and higher backups.
Toggle on
System-protected files are backed up as part of System State.
Toggle off
System-protected files are not backed up as part of System State.
Restrictions. This option applies only to 32-bit Windows XP or higher.
If this option is selected, DPX first creates a snapshot of the current state of all data to be backed up. Then, DPX backs up the snapshot to the destination server. This enables DPX to back up open files.
Toggle on
Take a snapshot of the current data condition, then back up the snapshot.
Toggle off
Do not take a snapshot first.
Tells DPX to run a consistency check on SQL Server before backing up a SQL Server database. The check runs three utilities that Microsoft recommends before a backup: DBCC CHECKDB, DBCC CHECKALLOC, and DBCC CHECKCATALOG.
Toggle on
Performs the consistency check.
Toggle off
Does not perform the consistency check.
Tells DPX whether to expand compressed data. This applies only to supported versions of NetWare.
Toggle on
Expand compressed data when performing the backup. Select this option if you want to restore to an uncompressed volume. DPX cannot restore compressed data to an uncompressed volume.
Toggle off
Do not expand the compressed data. If you choose this option, you can restore this data only to a compressed volume.
Controls whether Exchange backup occurs at the database or individual message level.
Database Level Backup
EXCHANGE
and EXCH2000
disks appear on the Backup File definition screen; EXCHANGEFS
and EXCH2000FS
disks do not appear. If you back up an entire server, database level backups are performed; folder level backups are not. Database Level Backup is the default.
Folder Level Backup
EXCHANGEFS
and EXCH2000FS
disks appear on the Backup File definition screen; EXCHANGE
and EXCH2000
disks do not appear. If you back up an entire server, folder level backups are performed; database level backups are not.
Both Database and Folder Level Backup
All Exchange disks appear on the Backup File definition screen. If you back up an entire server, both database and folder level backups of Exchange disks are performed.
Controls the routing of NDMP server-generated log messages to the job log file.
Toggle on
All NDMP server log messages will be routed to the master server’s job log file. Yes is the default.
Toggle off
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.
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:
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.
Enter the name of a script to execute prior to the actual job.
Basic usage: <script>@<node_name> <argument_list>
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
The action to be taken if the Job fails to successfully complete:
Run Post-Job Script
Skip Post-Job Script
Enter the name of a script to execute after the actual job.
Basic usage: <script>@<node_name> <argument_list>
See also. For detailed information about pre- and post-job scripts, including all valid definitions, see Pre-Scripts and Post-Scripts.
To access the job source options for File backup, do the following:
Go to the Backup tab.
In the Backup Modes section, select File.
Open an already existing backup job by selecting Open Backup Job in the Job Tasks section. Or go directly to step 4 to set source options for the new job you will be defining directly afterward.
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.
Controls the data verification technique for writing data to a media volume. The higher the verification level, the greater the safety and the longer a backup takes. Each verification level builds upon the preceding level. For example, level 3 performs level 1 and level 2 verification as well. Select one of the following options:
No Verification
Writes data to the media volume without verification. This is the fastest option and relies on the tape device for data verification.
Level 1
Reads the tape to ensure that it is readable.
Level 2
Reads the tape and ensures that the SIDF headers are present and contain the correct information.
Level 3 Ensures that the checksum of each file on the tape matches the one contained in the SIDF header for that file. This verification is only performed if the Checksum Files feature is set to Yes in Set Job Destination Options. The tape and SIDF headers are also read and verified (levels 1 and 2).
Compresses data prior to network transmission.
Select Yes to compress data prior to transmission at the node being backed up. This setting is recommended if there is processing power available on the client nodes and network bandwidth is limited. This setting minimizes the impact of data transmission on data lines.
Or, select No to disable the data compression.
Determines expected behavior when encountering an NFS (network file system) volume during a backup operation. NFS volumes are remotely mounted volumes owned by another node. This option also controls the backup behavior of drives that are mapped to the Microsoft Windows node (CIFS mount point).
Select No to back up NFS volumes and drives that are mapped to the Microsoft Windows nodes.
Or, select Yes so as not to back up NFS volumes or drives that are mapped to the Microsoft Windows nodes.
If you are not using an open file manager, this option controls how many times DPX attempts to back up an open file. If you enter zero, DPX skips open files. If you enter a number, DPX waits until all the files on the node have been backed up then tries again to save the open files. DPX attempts this the number of times you enter here.
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.
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.
If you are not using an open file manager, this option tells Catalogic DPX whether to catalog open files encountered on UNIX systems. On UNIX nodes, Catalogic DPX backs up the file and then checks to determine if it has been modified while the backup transpired. If it has, the file is considered open. Cataloging open files is not generally recommended.
Select No so as not to save the backed-up file if DPX detects that the file has been modified during the backup process and the number specified in the Open File Retries field has been reached.
Or, select Yes to catalog the backed-up file if it detects that the file has been modified during the backup process and the number specified in the Open File Retries field has been reached. Catalogic DPX catalogs its last attempt to back up an open file if it finds the file is still open. Note that cataloging a file that has been modified during the backup can compromise the integrity of the file when that file is restored.
Tells DPX whether to back up data on a mounted drive (volume). This field only applies to NTFS volume mount points on Windows 2000 and higher machines.
Yes
Data on a mounted drive is backed up through a volume mount point.
No
Data on a mounted drive is not backed up through a volume mount point. Whether the directory is restored as a volume mount point or not depends on the Set Job Destination Options.
Note. If set to Yes, and if you select both a volume mount point and the drive itself, duplicate backups might occur.
Remote Storage Service (RSS) is the Hierarchical Storage Management (HSM) system for Windows 2000 and higher, which automatically migrates files from disk to remote media, like tape. If the Windows administrator configures this service and disk space becomes low, files not modified for a specified period of time are sent to remote storage. A link (stub file) to the remote storage is kept in their place. Users can recall these stub files by accessing their links. This field determines whether DPX should back up links to these files or the files themselves.
Yes
Files on remote storage are backed up by DPX. In this case, files are backed up from tape to tape. At restore, files are restored to disk. However, because file dates are not affected by backup and restore, it is likely that the files will automatically be sent back to remote storage.
No
Files on remote storage are not backed up. DPX backs up their links.
Note. The tape devices and the media pool used by Windows for remote storage service cannot be shared with DPX.
Tells DPX whether to back up System Protected Files as part of the System State Backup. This applies only to Windows 2000 and higher backups.
Yes
System protected files are backed up as part of System State. Yes is the default.
No
System protected files are not backed up as part of System State.
Take Snap Shot
Restrictions. This option applies only to 32-bit Windows XP or higher.
If this option is selected, DPX first creates a snapshot of the current state of all data to be backed up. Then, DPX backs up the snapshot to the destination server. This enables DPX to back up open files.
Yes
Take a snapshot of the current data condition, then back up the snapshot.
No
Do not take a snapshot first.
Tells DPX to run a consistency check on SQL Server before backing up a SQL Server database. The check runs three utilities that Microsoft recommends before a backup: DBCC CHECKDB, DBCC CHECKALLOC, and DBCC CHECKCATALOG.
Yes
Performs the consistency check.
No
Does not perform the consistency check.
Controls whether Exchange backup occurs at the database or individual message level.
Database Level Backup
EXCHANGE
and EXCH2000
disks appear on the Backup File definition screen; EXCHANGEFS
and EXCH2000FS
disks do not appear. If you back up an entire server, database level backups are performed; folder level backups are not. Database Level Backup is the default.
Folder Level Backup
EXCHANGEFS
and EXCH2000FS
disks appear on the Backup File definition screen; EXCHANGE
and EXCH2000
disks do not appear. If you back up an entire server, folder level backups are performed; database level backups are not.
Both Database and Folder Level Backup
All Exchange disks appear on the Backup File definition screen. If you back up an entire server, both database and folder level backups of Exchange disks are performed.
Tells DPX whether to expand compressed data. This applies only for supported versions of NetWare.
Yes
Expand compressed data when performing the backup. Select this option if you may want to restore to an uncompressed volume. DPX cannot restore compressed data to an uncompressed volume.
No
Do not expand the compressed data. If you choose this option, you can restore this data only to a compressed volume.
Controls file history generation for NDMP and Block backup tasks.
For information on using Instant Access for file-level restore, see Instant Access as a File History Alternative in the DPX 4.9.x User’s Guide.
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.
See also. Generic NDMP Restore with File History Processing in the DPX 4.9.x Reference Guide
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.
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:
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.
Enter the name of a script to execute prior to the actual job.
Basic usage: <script>@<node_name> <argument_list>
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
The action to be taken if the Job fails to successfully complete:
Run Post-Job Script
Skip Post-Job Script
Enter the name of a script to execute after the actual job.
Basic usage: <script>@<node_name> <argument_list>
See also. For detailed information about pre- and post-job scripts, including all valid definitions, see Pre-Scripts and Post-Scripts.
In simple terms, a backup is a copy of data saved and stored in a location other than the original one, which can be used to restore the original data in case of a software or hardware failure resulting in data loss.
Our Catalogic DPX solution features several types of backup to suit your business needs and allow for efficient data recovery should you need one.
Before backing up any of your data, you need to understand what backup type you should use. Catalogic DPX offers several backup types, as specified below:
File
In a File backup, data is logically backed up by file and directory. File backup is what you normally think of when you think of backups. For more information, see .
Block
A DPX Block Data Protection backup provides seamless block-level backup from primary NetApp storage systems and other primary systems (such as Windows-, UNIX-, or Linux-based operating systems) to secondary storage systems. For a comprehensive discussion about Block backup, see .
NDMP
An NDMP backup backs up data on Network Attached Storage (NAS) appliances using Network Data Management Protocol (NDMP). DPX handles the details of communication between nodes running NDMP-compliant software. For a comprehensive discussion about NDMP Backup, see .
Image
Image backup performs a block-level backup, typically to tape. Free space is not backed up. Image backup is used only to provide a base backup for remote seeding and to protect Catalogic DPX Open Storage Server. For remote seeding, Image runs only as a base backup; for protection of Catalogic DPX Open Storage Server, Image runs as an initial base backup followed by incrementals. Image backup is not supported for incremental or differential backup of clients. However, if incremental or differential Image backup information exists in the Catalog from an upgraded environment and the Image backups are preserved, the backups can be used for restores. For Linux users, note that only base backup is supported for remote seeding purposes. For more details, see .
Agentless
Agentless backup provides robust protection in VMware and Hyper-V environments. All backups are done through one or more proxy servers, which communicate with VMs. Backup agents are not required on individual VMs, thus VM data protection is referred to as “agentless”. For more details, see .
Catalog Backup is a special mode for backing up the Catalog, which is the DPX Master Server metadata container. For more information about Catalog Backup, see Catalog Backup.
Note. For all backup types, sparse files on Linux are not treated as sparse files during backup or restore.
To run a backup of any kind in Catalogic DPX, you need to define a backup job first. You can set backup source, destination, encryption, and job notification options, or use the default values, depending on the specific backup type. The default parameters can be customized to facilitate the job definition process for new jobs.
The topics below describe setting source and destination job options and other parameters for different backup types. The setting process and particular functionalities available may differ depending on the interface you are using. Currently, Catalogic DPX offers access either through the web (HTML5-based) interface from your browser or through the desktop (Java-based) application requiring a Java environment installed on the machine you are accessing the Catalogic DPX from. The desktop application is older and will be deprecated in the future. The web interface is continuously developed and currently supports all typical Catalogic DPX functionalities.
Apart from source and destination options, DPX offers some additional backup job options, such as Job Encryption Options and Job Notification Options. They are available from both interfaces as presented below.
The Encryption options section controls how and when a job is encrypted.
To access the job encryption options, do the following:
Go to Job Manager in the sidebar.
Open an already existing backup job. Or create a new File backup job, by clicking the New Backup Job button in the upper right corner and then selecting Backup Type File.
Go to the Advanced Options section at the bottom (scroll down if necessary) and expand it. Click the Encryption options header to expand it. Each field and the available choices are explained below.
Encrypt data while transmitting it through networks to enhance security. Typically, the encrypted data transfer can lower the data transfer speed.
Toggle on
Enables encrypted data transfer.
Toggle off
Data transfer without encryption.
Specifies if the data written to tape is encrypted. This option does not relate to data transport. If network transport encryption is important, use the Network Encryption option.
No data encryption
Data is not encrypted at the device server.
Encrypt data at the device server (primary and twin tape)
Data is encrypted at the device server of both the primary and twin tapes. Hardware compression does not matter if same tape model/media is used.
Encrypt data at the device server (primary tape only)
For the primary tape, data is encrypted at the device server. Hardware compression does not matter.
Encrypt data at the device server (twin tape only)
For the twin tape, data is encrypted at the device server. Hardware compression must be disabled during original backup job.
The Notification Options section controls who receives messages pertaining to the current job when it is run.
To access the job notification options, do the following:
Go to Job Manager in the sidebar.
Open an already existing backup job. Or create a new File backup job, by clicking the New Backup Job button in the upper right corner and then selecting Backup Type File.
Go to the Advanced Options section at the bottom (scroll down if necessary) and expand it. Click the Notification options header to expand it. Each field and the available choices are explained below.
The Notification options consist of a radio button selection with three possible options.
No notifications
No e-mail notifications will be sent.
Default e-mail notifications
Custom e-mail notifications
If the Custom e-mail notifications option is selected, Four additional entry fields appear:
Subject
The subject of your message. The subject line usually contains a combination of straight text and variable elements. Variables, which must begin with %
, are replaced with actual corresponding values. If you enclose variables in double quotation marks, those variables are treated as literal values. You can embed the following variables:
%JOBNAME
%JOBID
%JOBTYPE
%RC
Use %RC to include the return code in the message for this run of the job, when applicable.
To
The email address of the primary recipient of your message. Only one “To” address is permitted.
Cc
Carbon Copy. The email address(es) of the secondary recipient(s) of your message. Use a semicolon to delimit multiple email addresses.
Bcc
Blind Carbon Copy. The email address(es) of the secondary recipient(s) not identified to other recipients. Use a semi-colon to delimit multiple email addresses.
Note. Note that the following characters are invalid in all fields: <
>
;
and '
.
Note. DPX emailing must be enabled when you first configure your Enterprise. At that time, you supply general system information, including SMTP Host Name and SMTP Port. See Configuring Enterprise Information.
The Set Job Encryption Options dialog controls how and when a job is encrypted.
To set backup encryption options:
Open the Set Job Encryption Options dialog box by doing one of the following:
Right-click the Enterprise name or icon to display a context menu. Then select Set Encryption Options.
From the menu bar, select Backup > Set Encryption Options.
On the task panel, click Set Encryption Options.
The Set Job Encryption Options dialog box appears.
Complete the Set Job Encryption Options dialog box as needed.
Encrypt data while transmitting it through networks to enhance security. Typically, the encrypted data transfer can lower the data transfer speed.
Yes
Enables encrypted data transfer.
No
Data transfer without encryption.
Specifies if the data written to tape is encrypted. This option does not relate to data transport. If network transport encryption is important, use the Network Encryption option.
No data encryption
Data is not encrypted at the device server.
Encrypt data at the device server (primary and twin tape)
Data is encrypted at the device server of both the primary and twin tapes. Hardware compression does not matter if same tape model/media is used.
Encrypt data at the device server (primary tape only)
For the primary tape, data is encrypted at the device server. Hardware compression does not matter.
Encrypt data at the device server (twin tape only)
For the twin tape, data is encrypted at the device server. Hardware compression must be disabled during original backup job.
The Set Job Notification Options dialog controls who receives messages about the current job when it is run.
To set backup job notification options:
Open the Set Job Notification Options dialog box by doing one of the following:
Right-click the Enterprise name or icon to display a context menu. Then select Set Notification Options.
From the menu bar, select Backup > Set Notification Options.
On the task panel, click Set Notification Options.
The Set Job Notification Options dialog box appears.
Complete the Set Job Notification Options dialog box as needed.
An explanation of each field and the available choices follows:
Two sets of mail information can be specified:
Output Email
Specifies that the subsequent fields apply to reports that are sent when a job has completed.
Operator Email
Specifies that the subsequent fields apply to mount requests, error messages, and informational messages that are sent during a job.
To
The email address of the primary recipient of your message. Only one “To” address is permitted.
Cc
Carbon Copy. The email address(es) of the secondary recipient(s) of your message. Use a semicolon to delimit multiple email addresses.
Bcc
Blind Carbon Copy. The email address(es) of the secondary recipient(s) not identified to other recipients. Use a semi-colon to delimit multiple email addresses.
Subject
The subject of your message. The subject line usually contains a combination of straight text and variable elements. Variables, which must begin with %
, are replaced with actual corresponding values. If you enclose variables in double quotation marks, those variables are treated as literal values. You can embed the following variables:
%JOBNAME
%JOBID
%JOBTYPE
%RC
Use %RC to include the return code in the message for this run of the job, when applicable.
Selecting this check box option temporarily disables notifications for the job without deleting the currently defined job notification data.
Note. Note that the following characters are invalid in all fields: <
>
;
and '
.
Note. DPX emailing must be enabled when you first configure your Enterprise. At that time, you supply general system information, including SMTP Host Name and SMTP Port. See Editing an Enterprise Configuration.
Open the Assign File Exclusion Rule dialog box by doing one of the following:
Right-click on the Enterprise name or icon (in the SOURCES pane) to display the context menu. Then select Edit File Exclusion Rule.
From the menu bar, select Backup > Edit File Exclusion Rule.
On the task panel, click Edit File Exclusion Rule under the Other Tasks section.
The Edit File Exclusion Rules dialog box appears.
In the New Rule Name field, enter the name of your new rule. Click the Add button next to it.
Add an exclusion pattern to that rule:
In the New Exclusion Patterns field, enter the file name or file pattern that describes the files you want to exclude.
Select Add from the task menu at the lower left of the dialog box. The new exclusion pattern is added to the Exclusion Patterns For list.
Repeat Steps 3.1 and 3.2 for each additional exclusion pattern you want to add.
See also. For more information about the exclusion pattern syntax, see Guidelines for setting exclusion patterns.
Click OK. The new file exclusion rule is created and appears in the Rule Names list.
Note. The rules are now created and globally available for various jobs, but they are not assigned to any specific job yet.
Assign the file exclusion rule to a job definition by following the steps in the Assign File Exclusion Rule section below.
To assign an existing file exclusion rule to the current job definition:
Open the Assign File Exclusion Rule dialog box by doing one of the following:
Right-click on the enterprise name or icon to display a context menu. Then select Assign File Exclusion Rule.
From the menu bar, select Backup > Assign File Exclusion Rule.
On the task panel, click Assign File Exclusion Rule.
The Assign File Exclusion Rule dialog box appears.
From the Rule Names list, select the rule to assign to this backup job definition. If you want no file exclusion rule to apply, select None from the list.
Click OK.
Note. File exclusion rules apply to base, incremental, and differential components of the backup job.
DPX automatically tracks the relationship of tapes to tape library tape slots. For example, when a tape is added to a tape library through an import/export port, DPX is aware of the new tape and the slot it occupies; that is, the Catalog assigns the tape to a slot.
However, the Catalog can become unsynchronized if, for example, a tape is physically removed from a tape library. In such cases, you can use the assign/unassign function of DPX to update the Catalog.
On the Configure Device window, click Display Slots and Media Controls.
The Assign/Unassign Tapes window appears. Tape libraries are displayed in the left pane and media pools are displayed in the right pane.
In the left pane, expand the desired tape library to the tape slot level. In the right pane, expand the desired media pools to the tape level. The following shows one tape library with six defined slots (all of which have tapes assigned) and three media pools, with the JBLPool expanded.
In the right pane, select the unassigned tapes you want to assign.
See also. For more information about how to use the navigation trees in the Java-based DPX Management Interface, see Common Function Window Tasks.
Do one of the following:
In the left pane, select the “empty” slots to which you want to assign the tapes. For multiple selections, use CTRL-click and SHIFT-click.
Then click Assign Tapes to Slots.
Drag and drop the tapes to one “empty” slot. If you selected multiple tapes, the slot should be the first slot that you want to assign tapes to.
DPX assigns the tapes to the slots in volume number and slot number order.
On the Configure Device window, click Display Slots and Media Controls.
The Assign/Unassign Tapes window appears. Tape libraries are displayed in the left pane and media pools are displayed in the right pane.
In the left pane, expand the desired tape library to the tape slot level.
In the left pane, select the “filled” slots that you want to unassign. For multiple selections, use CTRL-click and SHIFT-click.
Do one of the following:
Click Unassign Tapes from Slots.
Drag and drop the selected tapes to any media pool.
DPX unassigns the slots. Each tape remains in the media pool to which it had been added.
The following should be considered when assigning media to slots or unassigning media from slots:
Irregular tape libraries, such as ACSLS, IBM ATL, or AML, do not appear on the Assign/Unassign Tapes window.
A tape cannot be assigned to a slot that already has a tape assigned to it.
An already assigned tape cannot be reassigned unless it is unassigned first.
When you assign media using drag-and-drop, tapes cannot be assigned to slots that have not been rendered to the Assign/Unassign Tapes window. (DPX renders slots and tapes to the management console in batches of 200; scrolling renders the next batch). Selected tapes that do not get assigned remain selected for user convenience.
When assigning media by using the Assign Tapes to Slots button:
If more slots than tapes are selected, only the necessary number of slots receive tape assignments.
If more tapes than slots are selected, the selected tapes that do not get assigned remain selected for user convenience.
Editing a File backup job allows you to change some parameters of an already defined job (Save), or to create a new job based on the definition of an existing one (Save as…). The procedure is similar to creating a backup job from scratch.
In the main web interface view, go to Job Manager in the sidebar. Then select the file backup job you want to edit from the list.
Tip. You can control this view by ordering items by Job Name, Type, Created Date, Description, or Job Folder. Just click the column header to enable ascending/descending ordering.
Note also the Items per page value and navigation buttons at the bottom of the list, which can be useful when managing the display of many jobs.
Save the job by clicking Save (the changes will be saved under the current job’s name, overwriting previous settings), or Save As (you will be prompted to provide a new name for the job).
Restrictions. The new job name must be unique throughout the entire DPX, regardless of the folder the job is stored in.
In the main desktop interface window, go to the Backup tab, and from the Backup Modes section in the task panel, choose File.
Under Job Tasks in the side panel, select Open Backup Job. The Open Job dialog will appear.
Note. The Job List includes all File backup job names, regardless of the folders they are stored in. The Folder field indicates the actual folder where the selected job is stored.
Select the job you want to edit from the list. Click OK. The Open Job dialog will close and the settings of the selected job will be loaded to the main window view.
When finished, save the job by doing one of the following:
Select File > Save Job
Select Save Backup Job in the Job Tasks section of the side panel
Press [Ctrl + S]
The Save Job dialog will appear.
Restrictions. The new job name must be unique throughout the entire DPX, regardless of the folder the job is stored in.
Click OK. If you choose the same name, you will be prompted to confirm the replacement of an already existing job. Select Yes to change the job definition, or No to return to the previous step and specify another name for the job.
Before running a file backup, you need to create a File Backup Job. To do this, use either of the .
In the main web interface view, go to Job Manager in the sidebar. Then select the New Backup Job button in the upper right corner.
Specify the Job Name. You can also add an optional description (both fields may contain up to 48 characters).
Click Add Source in the SOURCES pane to specify which volumes you want to back up. The Source selection dialog will appear. Select the desired volumes and click Select.
Tip. You may view your current selection at any moment, using the Selected Items button next to the search field.
You can clear each item using the “X” symbol next to the item, or clear all items at once using the Clear All button.
Optionally, set exclusion rules for files of a certain type. Click Assign Exclusion Rule in the EXCLUSIONS pane to select one of the already existing exclusion rules.
In the BASE BACKUP DESTINATION pane, click Set Destination to choose the destination for the base backup.
The INCREMENTAL BACKUP DESTINATION and DIFFERENTIAL BACKUP DESTINATION panes are pre-populated as per the base backup destination. You may change that by clicking Set Destination in respective panes. Note that both these destinations are required for saving the job.
Set advanced options as desired, selecting them from the Advanced Options drop-down at the bottom of the screen (scroll down if necessary).
See also. For more information about file backup job options, see the following sections:
Click Save. The job can now be viewed, run, edited or deleted from the Job Manager section.
In the main desktop interface window, go to the Backup tab, and from the Backup Modes section in the task panel, choose File.
Two additional panes will appear. You are already in the defining new file backup job view, so there is no need to click the Define New Backup Job button under Job Tasks in the task panel.
Specify the File backup source in the middle pane. Expand the tree as necessary.
Empty checkboxes indicate a directory that will not be included. Checkboxes marked in red indicate a directory that will be fully included. Half-red checkboxes indicate that only some subdirectories/files of a given directory will be included.
Specify the File backup destination in the right-hand side pane. Expand the tree as necessary.
Note. Before running a backup job, you need to save it. Once saved, a previously defined job can be modified, run, or deleted. If you try to leave the job creation view without saving the changes, you will be prompted to either save or discard changes before leaving.
If you select Define New Backup Job, all unsaved changes will be lost.
Set advanced options as desired, selecting appropriate items in the Other Tasks section of the side panel. Scroll down if necessary.
See also. For more information about file backup job options, see the following sections:
Save the job by doing one of the following:
Select File > Save Job
Select Save Backup Job in the Job Tasks section of the side panel
Press [Ctrl + S]
The Save Job dialog will appear.
Restrictions. The new job name must be unique throughout the entire DPX, regardless of the folder the job is stored in.
Click OK. The job is now saved.
In the web interface, block backups are defined in the Job Manager section. In the desktop interface, block backups are implemented through a backup wizard.
In the main web interface view, go to Job Manager in the sidebar. Then select the New Backup Job button in the upper right corner.
Specify the Job Name (this field may contain up to 16 characters). Add an optional, brief description (this field may contain up to 48 characters).
Click Add Source in the SOURCES pane to specify which volumes you want to back up. The Source selection dialog will appear. Select the desired volumes and click Select.
Tip. If you want to perform a Bare Metal Recovery (BMR) backup which allows for further recovery of the entire machine, select the BMR volume.
Tip. You may view your current selection at any moment, using the Selected Items button next to the search field.
You can clear each item using the “X” symbol next to the item, or clear all items at once using the Clear All button.
Click Set Destination in the DESTINATION pane to choose the destination for the backup.
If you want to add an Archive backup to your backup job, click Add Archive in the ARCHIVE pane. The Add Archive dialog will appear.
Click Save. The Run Job prompt will be shown, where you may determine the retention period (default: 90 days) and choose whether to run the job immediately. Either way, the job will be available in the Job Manager section.
Go to the Backup tab.
From the Backup Modes section in the side panel, choose Block.
In the Job Tasks section of the task panel, find and click Block Backup Wizard.
The Block Backup Wizard window will appear.
By default, the creator allows you to select from the drop-down list and edit an already existing job. If you want to create a new block backup job, click the New Job button in the lower right corner.
In the Select Source step, choose the volumes you want to include in the backup. Click Next.
Tip. If you want to perform a Bare Metal Recovery (BMR) backup which allows for further recovery of the entire machine, select the BMR volume.
In the Select Destination step, choose the destination for the backup job. Click Next.
In the Job Options step, define the job options for the backup job. See details below.
In the Job Schedule dialog, you can also schedule Archive jobs for the Block backup.
The following considerations apply to Block backup to the legacy Catalogic Open Storage Server, vStor or the NetApp storage:
For any volume backed up in a Block backup job, the initial backup is a base backup, and all subsequent backups are incremental, where only changed blocks are transferred.
An instance of a Block backup (base or incremental) is a virtual image of the entire source volume at a particular point in time.
Defining a new Block backup job with a new job name directs Catalogic DPX to perform a base backup.
Some conditions may require a base backup instead of an incremental one. See .
A Block backup of a volume that is currently being backed up by an Image backup or a different backup may fail. Ensure you do not run Image and Block backups of the same volume at the same time.
System State and System Table are supported for Block backups. See in the DPX 4.9.x Reference Guide.
Note. By default, the Catalogic DPX Block Data Protection System State restore does not restore SPF files because of the time and storage required. For SPF restores, BMR is recommended. If you must restore SPF files without using BMR, contact the team.
For Block backup jobs, the status of a job must be Waiting before you can suspend it.
After five minutes (300 seconds), if there is no progress on a file backup job, the job will be canceled. This is to prevent file hangups from holding up additional jobs that may be waiting to run.
If your backup source (primary system) is in a remote location and is to be backed up over a slow link, contact Catalogic Software Data Protection Technical Support for possible alternatives to improve performance.
In NetApp environments, Catalogic DPX provides two levels of backup instance verification for the Catalogic DPX Block Data Protection. These are described in in the DPX 4.9.x User’s Guide. Verification procedures for applications are described in in the DPX 4.9.x User’s Guide.
A failure, such as a system error or communication interruption, that occurs during the Catalogic DPX Block Data Protection processing on a node may cause all the Catalogic DPX Block Data Protection application backups (Oracle, SQL Server, Exchange, Bare Metal Recovery) to fail on that node. If the problem occurs during the preliminary phase of the Catalogic DPX Block Data Protection processing, all backup tasks on the node will fail. If it occurs during backup processing, other backup tasks on the node will generally run successfully. In either case, backups on other nodes are not affected.
The following considerations apply only to Block backup to the NetApp storage:
The number of concurrent backups is limited by the number of NDMP connections supported by the destination NetApp storage system. Each volume in a backup job requires a connection. Consult the NetApp documentation to determine the maximum connections supported by your NetApp storage system.
Due to the NetApp storage system limitations, Block backup job names should be kept short. The job name becomes part of the qtree name on the NetApp storage system. If a qtree name is too long, you may be prevented from seeing volumes on the NetApp storage system.
There is a one-to-one relationship between a backup job and a volume on the NetApp storage system. Each defined backup job must be associated with a destination volume dedicated to that job, even though the job may back up multiple servers. Do not use a single destination volume to store backups from more than one Catalogic DPX backup job. For additional details on best practices related to configuring and using the NetApp volumes and creating the Catalogic DPX backup jobs, see the DPX Best Practices Guide in the .
When you open a previously saved Block backup job and change either the source or destination, the management console is aware of changes to the job definition and automatically attempts to delete qtrees through the Catalogic DPX condense operation. For additional information, see in the DPX 4.9.x User’s Guide and read the knowledge base article .
DPX 4.4.0 or later is required for Block backup support of Clustered Data ONTAP 8.3.1 RC1 and later.
To run a Block backup to the Catalogic Open Storage Server, storage must be made available to the DPX open storage server as physical or logical volumes. A typical setup provisions storage at one or more Windows drive letters, like D:
and E:
. Do not use system drives, such as the C:
drive, for the Catalogic DPX Open Storage Server.
Catalogic DPX offers a variety of source options for File backup. All of them are available from both interfaces, but the access thereto may slightly differ. See details for each interface below.
To access the job destination options, do the following:
Go to Job Manager in the sidebar.
Open an already existing backup job. Or create a new File backup job, by clicking the New Backup Job button in the upper right corner and then selecting Backup Type File.
Go to the Advanced Options section at the bottom (scroll down if necessary) and expand it. Click any of the following section headers to expand it. Each field and the available choices are explained below.
Determines whether or not to accept a tape with data on it.
Determines expected behavior when an unlabeled tape is found in the tape drive.
Determines whether a backup tape is stored offsite. DPX adds the Offsite status to the tape.
Determines if a backup tape with status Offsite can be appended to.
The Offsite status of a tape can be viewed through the Operate Tape Library function, the Configure Media function, or in the media volume report. Note that when you use the Operate Tape Library function to import a tape with status Offsite, the Offsite status is cleared and the tape becomes available for use.
Enables the twinning option. The twinning option creates two sets of backups simultaneously, eliminating the need for separate tape duplication for off-site vaulting.
Indicates in the Catalog the location of twinned tapes, if twinning is on.
Determines what to do with the tape when the backup job is complete.
Attention! In some cases, a backup job may fail if the Export option is used for the first job following a system restart, especially if the initial job is a File backup with the Export setting.
Checksum Files
Generates a checksum value for each file that is backed up. The checksum value is written to the SIDF header.
Indicates the desired performance option. This option helps control the number of tasks running concurrently within a backup job. The appropriateness of each selection depends upon the backup you are running.
Sets a threshold for file splitting. File splitting is the ability to split a file into smaller pieces and back up those pieces simultaneously. File splitting is designed for large files or raw partitions. If Split Large Files/Partitions is selected in Performance Options and the file exceeds the size entered here, the file splits automatically. If the file does not exceed the size entered here, the file does not split. Keep the threshold large enough (2 GB) so that file splitting is reserved for truly large files.
Note. This option applies only to UNIX systems. It is not available for Windows.
Sets the maximum number of tasks that can have files backed up to a single device. The default is 1.
Note. Increasing concurrency to values >1 during backups slows restore performance and requires more memory on the master server during restore.
Limits the number of storage devices valid for use with this job. Use this option if you want to stop DPX from using all the drives in the selected device cluster so that some drives will be available for other purposes.
Holds tasks within a job until the number of drives specified are available for each task to use.
The maximum number to check a tape in a standalone tape device.
The number of seconds to wait between checking the availability of a tape in a standalone tape device.
Controls tape drive usage.
To access the job destination options, do the following:
Go to the Backup tab.
In the Backup Modes section, select File.
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.
Go to the Other Tasks section in the task panel (scroll down if necessary) and select Set Destination Options. The Set Job Destination Options dialog will appear.
The Set Job Destination Options dialog allows you to set options related to backup destinations. This section provides an explanation of each field in the dialog and the available choices.
Note. All three tabs, i.e. Base, Incremental and Differential, feature exactly the same options, only referring to different backup types.
Determines whether or not to accept a tape with data on it.
Determines expected behavior when an unlabeled tape is found in the tape drive.
Determines whether a backup tape is stored offsite. DPX adds the Offsite status to the tape.
Determines if a backup tape with status Offsite can be appended to.
The Offsite status of a tape can be viewed through the Operate Tape Library function, the Configure Media function, or in the media volume report. Note that when you use the Operate Tape Library function to import a tape with status Offsite, the Offsite status is cleared and the tape becomes available for use.
Enables the twinning option. The twinning option creates two sets of backups simultaneously, eliminating the need for separate tape duplication for off-site vaulting.
Indicates in the Catalog the location of twinned tapes, if twinning is on.
Determines what to do with the tape when the backup job is complete.
Attention! In some cases, a backup job may fail if the Export option is used for the first job following a system restart, especially if the initial job is a File backup with the Export setting.
Checksum Files
Generates a checksum value for each file that is backed up. The checksum value is written to the SIDF header.
Indicates the desired performance option. This option helps control the number of tasks running concurrently within a backup job. The appropriateness of each selection depends upon the backup you are running.
Sets a threshold for file splitting. File splitting is the ability to split a file into smaller pieces and back up those pieces simultaneously. File splitting is designed for large files or raw partitions. If Split Large Files/Partitions is selected in Performance Options and the file exceeds the size entered here, the file splits automatically. If the file does not exceed the size entered here, the file does not split. Keep the threshold large enough (2 GB) so that file splitting is reserved for truly large files.
Note. This option applies only to UNIX systems. It is not available for Windows.
Sets the maximum number of tasks that can have files backed up to a single device. The default is 1.
Note. Increasing concurrency to values >1 during backups slows restore performance and requires more memory on the master server during restore.
Limits the number of storage devices valid for use with this job. Use this option if you want to stop DPX from using all the drives in the selected device cluster so that some drives will be available for other purposes.
Holds tasks within a job until the number of drives specified are available for each task to use.
The maximum number to check a tape in a standalone tape device.
The number of seconds to wait between checking the availability of a tape in a standalone tape device.
Controls tape drive usage.
E-mail notifications will be sent to the e-mail account specified in the Administrator E-mail Settings tab on the ENTERPRISE INFORMATION page under on the top menu bar. See Administrator E-mail Settings.
Make all required changes to the job definition. The workflow is the same as in .
Proceed with editing the job. See for more details.
Select Job Type – File and the Job Folder to store the job in (see the section for more information). By default, all jobs are stored in the SS_DEFAULT job folder.
See also. For more information about backup source options, see .
See also. For more information about file exclusion rules and how to define them, see .
See also. To learn more about incremental and differential backups, see .
You may also add a schedule in the SCHEDULES pane for the backup to be run on a regular basis. See .
Select Job Type – Block and the Job Folder to store the job in (see the section for more information). By default, all jobs are stored in the SS_DEFAULT job folder.
For more information, see and .
You may also add a schedule in the SCHEDULES pane for the backup to be run regularly. See .
Important. Before using this functionality, read the section in the Backup chapter.
Specify Advanced Options. For details, see .
For more information, see and .
See also. For more information about block backup job options, see .
In the final Save step, you must enter the Job Name (max. 16 characters) and specify the Job Folder to store the job in (the default folder is SS_DEFAULT). You may also add a comment to the job definition or set up a schedule (See ).
Important. Before using this functionality, read the section in the Backup chapter.
Click Finish. The Final Job Run Settings dialog box will appear. You may choose to run the job immediately or save it without running. You may also change the retention period (default: 90 days).
Snapshot verification is available for DPX open storage. By running snapshot verification, you can quickly detect snapshot corruption. For more information, read the knowledge base article .
The Catalogic DPX Archive destinations are optionally selected when the Catalogic DPX Block Data Protection job is scheduled. See in the DPX 4.9.x User’s Guide.
In DPX open storage environments, occasionally there is the need to transfer data to a different open storage volume or server. For procedural details, read the knowledge base article . The process facilitates the transfer of data on DPX open storage to a different volume or storage server and provides the ability to replace or upgrade the Catalogic DPX Open Storage Server itself.
Note. The Advanced Options section in the web interface also includes job source options which are discussed in a separate section for the sake of clarity. See .
Note. All three sections, i.e. Base, Incremental and Differential Backup Job Destination Options, feature exactly the same options, only referring to different backup types. For more information, see .
Use a new tape
Requires media with status New or Empty from the selected media pool. Media with status New will only be used if the option Unlabeled Tape Usage (defined below) is set to Allow unlabeled tapes and label them.
Attempt to append data to available tape
Accepts a backup tape from the selected media pool with data on it (status Appendable) and writes to the unused portion of the tape. The appended data can have a retention period that differs from the data preceding it on the tape.
Label unlabeled tapes
Label the unlabeled tape. This saves the step of labeling a tape beforehand.
Reject unlabeled tapes
Do not use the unlabeled tape.
Toggle on
Indicates in the Catalog that the tape is stored offsite.
Toggle off
Indicates in the Catalog that the tape is stored onsite.
Toggle on
Tapes in the library with status Offsite can be appended to. The Append Offsite field in the Edit Media Pool dialog must also be set to Yes.
Toggle off
Tapes in the library with status Offsite cannot be appended to.
Toggle on
Backs up data simultaneously to two tapes.
Toggle off
Disables twinning.
Toggle on
Indicates that the twinned tape (second tape) is stored offsite.
Toggle off
Indicates in the Catalog that the tape is stored onsite.
Rewind Tapes
For a standalone tape device, this option rewinds the tape and leaves it in the drive. For a tape library tape drive, this option rewinds, unloads, and returns the tape to its slot.
Unload Tapes
For a standalone tape device, this option rewinds the tape and ejects it from the drive. For a tape library tape drive, this option rewinds, unloads, and returns the tape to its slot.
For DiskDirectory, this option causes empty volsers to be used before new volsers.
Leave Tapes
In the case of standalone tape drives, the tape remains wound to the point where the job ended and stays in the drive. However, for tape library drives, the tape is always attempted to be returned to its slot after the backup operation is completed. The next job attempts to use the tape in the drive instead of mounting a new tape. In the case of standalone drive, if the currently mounted tape is unacceptable (for example, if the next backup requires a tape from a different media pool), the operator is prompted to mount another tape. In the case of a tape library, if the tape in the drive is rejected for any reason, it unloads the tape, returns it to its slot, and proceed to select another tape.
Export Tapes
Automates the export of tapes to an I/O port, eliminating manual processes and preparing tapes for their next destination. In environments with physical tape libraries, the availability of an empty I/O port is essential. The system will alert and will return an error code if no port is available, prompting user action. A rescan of ports is recommended to ensure availability.
Toggle on
Generates a checksum value for backed-up files.
Toggle off
Turns off checksum generation. If you turn checksum generation off, level 3 verification cannot be performed. For more information on level 3 verification, see the source option Verify Backup.
Standard
Backs up UNIX nodes and Windows disks concurrently. Use this option when memory on the master or device server(s) is limited or when you will not derive benefit from any of the other choices.
Split Job by Partitions
Backs up UNIX partitions (mount points) and Windows disks concurrently. Use this option when backing up multiple partitions and there are no device or memory limitations.
Split Job by Files
Use this option when backing up single partitions (disks or volumes) that contain many files. This selection will create a task for every available tape drive in this job. Note. This option is not supported for Linux OES.
Split Large Files/Partitions
Splits files that exceed the Split Size threshold. Each part of the split file is backed up concurrently. Use this with large raw partition backups or when you are backing up very large files and the number of files or partitions is less than the number of devices.
Toggle on
The tape drive is released after the current task with a tape drive finishes so that the next job can use the same tape drive before completing the entire job.
Toggle off
The tape drive is not made available for the next job until the entire job is completed.
Use a new tape
Requires media with status New or Empty from the selected media pool. Media with status New will only be used if the option Unlabeled Tape Usage (defined below) is set to Allow unlabeled tapes and label them.
Attempt to append data to available tape
Accepts a backup tape from the selected media pool with data on it (status Appendable) and writes to the unused portion of the tape. The appended data can have a retention period that differs from the data preceding it on the tape.
Label unlabeled tapes
Label the unlabeled tape. This saves the step of labeling a tape beforehand.
Reject unlabeled tapes
Do not use the unlabeled tape.
Yes
Indicates in the Catalog that the tape is stored offsite.
No
Indicates in the Catalog that the tape is stored onsite.
Yes
Tapes in the library with status Offsite can be appended to. The Append Offsite field in the Edit Media Pool dialog must also be set to Yes.
No
Tapes in the library with status Offsite cannot be appended to.
Yes
Backs up data simultaneously to two tapes.
No
Disables twinning.
Yes
Indicates that the twinned tape (second tape) is stored offsite.
No
Indicates in the Catalog that the tape is stored onsite.
Rewind Tapes
For a standalone tape device, this option rewinds the tape and leaves it in the drive. For a tape library tape drive, this option rewinds, unloads, and returns the tape to its slot.
Unload Tapes
For a standalone tape device, this option rewinds the tape and ejects it from the drive. For a tape library tape drive, this option rewinds, unloads, and returns the tape to its slot.
For DiskDirectory, this option causes empty volsers to be used before new volsers.
Leave Tapes
In the case of standalone tape drives, the tape remains wound to the point where the job ended and stays in the drive. However, for tape library drives, the tape is always attempted to be returned to its slot after the backup operation is completed. The next job attempts to use the tape in the drive instead of mounting a new tape. In the case of standalone drive, if the currently mounted tape is unacceptable (for example, if the next backup requires a tape from a different media pool), the operator is prompted to mount another tape. In the case of a tape library, if the tape in the drive is rejected for any reason, it unloads the tape, returns it to its slot, and proceed to select another tape.
Export Tapes
Automates the export of tapes to an I/O port, eliminating manual processes and preparing tapes for their next destination. In environments with physical tape libraries, the availability of an empty I/O port is essential. The system will alert and will return an error code if no port is available, prompting user action. A rescan of ports is recommended to ensure availability.
Yes
Generates a checksum value for backed-up files.
No
Turns off checksum generation. If you turn checksum generation off, level 3 verification cannot be performed. For more information on level 3 verification, see the source option Verify Backup.
Standard
Backs up UNIX nodes and Windows disks concurrently. Use this option when memory on the master or device server(s) is limited or when you will not derive benefit from any of the other choices.
Split Job by Partitions
Backs up UNIX partitions (mount points) and Windows disks concurrently. Use this option when backing up multiple partitions and there are no device or memory limitations.
Split Job by Files
Use this option when backing up single partitions (disks or volumes) that contain many files. This selection will create a task for every available tape drive in this job. Note. This option is not supported for Linux OES.
Split Large Files/Partitions
Splits files that exceed the Split Size threshold. Each part of the split file is backed up concurrently. Use this with large raw partition backups or when you are backing up very large files and the number of files or partitions is less than the number of devices.
Yes
The tape drive is released after the current task with a tape drive finishes so that the next job can use the same tape drive before completing the entire job.
No
The tape drive is not made available for the next job until the entire job is completed.
Many database applications open their data files and leave the on-disk versions in an open, temporary, or inconsistent state until either the application synchronizes unwritten (cached) data, closes and saves the data file in use, or performs specific internal backup procedures. Similar situations can occur with applications that open and share data across a network; network-attached nodes will often cache data and not necessarily update the on-disk version until a later time. If you have backed up data from an application that was open and/or shared on the network, those files may not be usable on restore. To guarantee data consistency, it is good practice to perform cold backups or to ensure the corresponding jobs have appropriate pre-scripts. Pre-Scripts and Post-Scripts. A cold backup is a backup of any application data where the application has been closed down properly and its data backed up when the application is offline.
DPX provides a backup solution for a variety of enterprise applications, including database applications. DPX supports the following applications:
Oracle Database
Microsoft SQL Server
SAP HANA
SAP R/3
Microsoft Exchange Server
Microsoft SharePoint Server
Micro Focus GroupWise
HCL Notes and HCL Domino
Application backup in DPX functions similarly to block backup, with the system automatically detecting the application. On Windows, DPX detects SQL Server installations and other applications through registry settings and the Volume Shadow Copy Service (VSS) framework.
See also. For detailed information on compatible versions of your application and operating systems, see DPX 4.10 Compatibility Matrix.
Catalogic DPX delivers robust backup solutions tailored for Microsoft Exchange Server environments, ensuring critical communication data is securely backed up and protected. With its support for block-level backups, DPX enables efficient safeguarding of Exchange Server data, including support for recovery to alternate locations. DPX supports Microsoft Exchange Server's high-availability features, including Database Availability Groups (DAG) and IP-less DAG configurations, ensuring continuous protection of your Exchange environment.
Before you start your Microsoft Exchange Server backup, ensure the following conditions are met:
Ensure the DPX agent is installed on the Exchange server.
Verify that the Exchange server is properly registered within DPX.
Adequate backup storage is allocated and accessible for storing the Exchange Server backups.
See also. For detailed information on supported Exchange Server versions and operating systems, see DPX 4.10 Compatibility Matrix.
DPX provides comprehensive backup solutions for SQL Server environments, enabling organizations to protect their critical data efficiently. With support for file-level and block-level backups, DPX ensures that your SQL Server databases are safeguarded against data loss. DPX extends its support to Microsoft SQL Server AlwaysOn Availability Groups for block-level backups, offering enhanced protection for high-availability configurations. Additionally, DPX facilitates instant availability and robust cluster support, accommodating both Active/Active and Active/Passive clusters.
Before you start your Microsoft SQL Server backup, ensure the following conditions are met:
Ensure the DPX agent is installed on the SQL server.
SQL Server node is visible in DPX.
The user account used for DPX should have the necessary permissions, including SQL sysadmin privilege.
Adequate backup storage is allocated and accessible for storing the Microsoft SQL Server backups.
See also. For detailed information on supported SQL Server versions and operating systems, see DPX 4.10 Compatibility Matrix.
This chapter provides a comprehensive guide on how to perform backups for SAP HANA applications using the Catalogic DPX plugin. The Catalogic DPX plugin is easily installed and configured on the SAP HANA system using a script named dpxhdbinst
. This script is available in the /opt/DPX/misc/
directory after the Catalogic DPX Client is installed on the SAP HANA system.
Before running the installation and configuration script, ensure that you have the following information available from your environment:
The hostname or IP of the DPX Master Server.
The username of the DPX administrator account (default: dpxadmin
).
The password of the DPX administrator account (default: dpxadmin
).
The fully qualified path to the DPX root directory.
The logical hostname of the SAP HANA node.
The name of the DPX media pool that will be used.
The name of the DPX device cluster that will be used as a backup target.
The name of the DPX device that will be used as a backup target.
The System ID (SID) of the SAP HANA database being installed and configured.
To install and configure the DPX plugin, follow these steps:
Using the secure shell protocol (SSH), log in to the SAP HANA node host.
At the command line, navigate to the misc
directory, using:
Run the installation and configuration script to install the DPX plugin, using:
When prompted, enter the following information:
The hostname or IP address of the DPX Master Server.
The DPX administrator account username.
The DPX administrator account password.
The DPX root directory (default: /opt/DPX/
).
Enter the System ID (SID) of the SAP HANA database. This will set the HDBbackint directory to /usr/sap/<xxx>/SYS/global/hdb/opt/
, where <xxx>
represents the SID of the SAP HANA database to be protected.
Proceed with installation of the DPX plugin, press 1. Installation will create a link and change permissions of three files and one directory as indicated on the screen.
To continue with configuration, press 2.
Enter the configuration information. When prompted, enter the following:
The logical name of the SAP HANA node.
The DPX tape pool to use with the SAP HANA database.
The DPX device pool to use with the SAP HANA database.
The DPX device to use with the SAP HANA database. During configuration, a template file is edited and copied to /opt/DPX/bin/dpxhdb.utl
, a link is created, and the file /usr/sap/<SID>/SYS/global/hdb/custom/config/global.ini
is updated, where <SID>
is the System ID.
Press 3 to exit the script.
To configure the SAP HANA system for backup, follow these steps:
In Eclipse IDE, click Open Perspective > SAP HANA Administration Console.
Right-click on Systems tab and select Add system.
Add your SAP Hana database to Eclipse IDE, using the following settings:
Host Name: Hostname of your SAP HANA machine
Instance Number: SAP HANA instance number
Mode: Multiple containers > System database
Click Next.
Select options:
Authentication by database user and log in using username SYSTEM
Enable SAP start service connection
Click Finish.
Log in to the database.
Double-click on Backup button.
Go to Configuration tab.
Expand section Backint Settings and change the following settings:
Backint Agent: /opt/DPX/bin/ssdpxhdb
Backint Parameter File: /usr/sap/<xxx>/SYS/global/hdb/opt/hdbconfig/dpxhdb.utl
, where <xxx>
represents the SID of the SAP HANA database
To perform backups, follow these steps:
Open Eclipse IDE and log in to the system database.
Right-click on the system database and select Backup and Recovery > Backup System Database.
Select Backint as the destination type.
Click Finish to start the backup.
Note. The backup log is located in the /opt/DPX/bin/dpxhdb.utl
file. Make sure the backup log is the same as the one specified in the dpxhdb.utl
file.
Once you created and ran SAP HANA Backup Job, you can monitor jobs using DPX:
In the main web interface view, go to Job Monitor in the sidebar.
You should see a new job with status Running, type Application Backup and Name containing the IP address of the SAP HANA node.
The first time you run a backup job, it will be a base backup. Subsequent runs are automatically incremental, and only changed blocks are backed up. A change journal on the client node tracks block-level changes.
In rare cases, such as disruption caused by a sudden power failure or virus, the change journal may stop or become inconsistent. The change journal then does not precisely track changed blocks. A repeatable backup failure may be evidence of damage to the change journal.
To recover from damage to a change journal, a base backup is required. That is, you must force a base backup. This forced base is sometimes referred to as a re-base.
A forced base is usually done in communication with a support analyst. However, it can be done by knowledgeable users. A base backup is forced in the following ways:
This method does not permit the selection of backup sources within the backup job. It forces a base backup of every source defined in the job. This method is practical only for jobs that are not backing up multiple sources that contain large amounts of data.
This is the preferred method and is described below. It enables the selection of backup sources requiring a base backup. The utility clears change journaling for the selected source. This forces a base backup of that source the next time the backup job is run. Note that this method is supported only for Windows clients. For other clients, contact Catalogic Software Data Protection Technical Support.
Take the following steps to force a base backup with bexsnapmgr
:
Examine the job log to identify sources that failed to be backed up.
On the Windows client where the backup of a source failed, launch the DPX command prompt from the Windows Start menu:
For Windows earlier than 2008, click Start > All Programs > DPX > DPX Command Prompt.
For Windows 2008 and later, click Start > All Programs > DPX. Then right-click DPX Command Prompt. From the context menu, select Run as Administrator.
The DPX command prompt appears.
Enter bexsnapmgr
. The user interface appears.
Click Change Journal Configuration. The Change Journal Configuration window appears.
Next to Disable, select from the pull-down list the affected backup source (node, drive, or volume). Click Disable. A message indicates that the source is disabled. At this point, you cannot run a backup of the disabled source. Repeat this step if there are additional sources to disable.
Next to Enable, select from the pull-down list the same backup source disabled in the previous step. Click Enable. At this point, you can run a backup of the source. Repeat this step for any additional sources disabled in the previous step.
Close the user interface.
Change journaling for the selected backup source or multiple sources, is now cleared. The next time a backup job using the source runs, the backup of the source is a base backup. Backups of all other sources defined in the job continue to run as incrementals.
Attention! Do not use other functions of the utility except under the direction of Catalogic Software Data Protection Technical Support.
If you want to run certain backup jobs on a regular basis, it is best to create a schedule for them.
You may add a schedule to an existing job and save it, add a schedule to an existing job and save it under another name (thus creating a new job without affecting the job you have made edits to), or create a completely new job, adding a schedule to it.
To add a schedule to a File backup job, create a new job or open an existing one from the Job Manager.
In the job creation/editing view, scroll down to the SCHEDULES pane and click Add Schedule. The Schedule dialog will open. Depending on the selected frequency, the dialog will display slightly different parameters to select. Below, the Weekly schedule view is shown.
Select all required parameters, such as the schedule starting time and date, day of the week (if applicable), repetition period, backup retention time, etc.
Click Add.
Important. The schedule is now added to the job, but the job is not saved yet. Continue with the procedure to save the job.
Save the job. If you have added the schedule by modifying an existing job, two options will be available.
Click Save to apply changes to the existing job; or
Click Save As to create a copy of the modified job, with the schedule added, under a new name.
Restrictions. The new job name must be unique throughout the entire DPX, regardless of the folder the job is stored in.
To add a schedule to a File backup job, start creating a new job or open a saved job to edit it.
Go to the Backup tab and from the Backup Modes section in the task panel, choose File.
Under the Job Tasks section, select Schedule Backup Job. The Job Schedule dialog will open.
The Schedule tab allows you to define the dates and times you want the current job to run.
The Exceptions tab allows you to list any exceptions to that schedule.
The Preview tab allows you to view all jobs scheduled for a specified future date.
Note. For File, Image, and NDMP backup jobs only, you can use the scheduler to define a Migrate operation. See Specifying an Automatic Migrate Operation in the DPX 4.9.x Reference Guide.
Select the Schedule tab. Using the Schedule window, you systematically define the schedule for the particular job you are defining. A single schedule definition for a single job can include many schedule description items or job schedule elements, which can be for different frequencies and different backup types. The following illustrates a schedule definition that contains three job schedule elements. Note that after defining the schedule, you will have an opportunity to exclude particular events by using the Exceptions tab.
Add job schedule elements one by one. To do so:
Click New.
In the New Schedule box, select a frequency. The following list describes your choices:\
Once
To schedule a job to run once, on a particular date and at a particular time in the future.
Daily
To schedule a job to run every day at a particular time.
Weekly
To schedule a job to run weekly on a particular day of the week, or to schedule a job to run in a particular week of each month.
Monthly
To schedule a job to run monthly on a particular day of the month.
Scheme
To schedule rudimentary base/incremental or base/differential schemes. These are weekly schedules that run a Base backup once a week and Incremental or Differential backups on the remaining days. This option is not available for Block backup jobs.
Fill in the relevant details. The following table provides an overview of the field definitions. The field definitions may vary depending on the frequency you selected.
Once
Run [Backup Type]
Backup at [Time]
Enter the time of day you want this job element to commence.
On [Date]
Select from the display calendar the date you want this job element to run.
Retention
Daily
Run [Backup Type]
Backup at [Time]
Enter the time of day you want this job element to commence.
On [Date]
Select from the display calendar the first date you want this job element to run.
Repeat every [Days]
Select the repeat frequency in days.
Retention
End Date
This field is optional. To enable this field, select the check box, then select from the display calendar the final date you want this job element to run.
Weekly
Run [Backup Type]
Backup at [Time]
Enter the time of day you want this job element to commence.
On [Day of Week]
Select the day of the week you want this job element to run. You can select more than one day.
Repeat
Choose either Select Weeks or Week Day in Month.
Every
With the Select Weeks option selected in the Repeat field, select the frequency of weeks that this job should repeat.
The
With the Week Day in Month option selected in the Repeat field, select the week in each month that you would like this job element to run. You can select more than one week. Note that Week Day in Month refers to the set of 7 days starting from the first day in the month, not the calendar week containing the first day of the month.
Retention
Start Date
This field is optional. To enable this field, select the check box, then select from the display calendar the first date you want this job element to run.
End Date
This field is optional. To enable this field, select the check box, then select from the display calendar the final date you want this job element to run.
Monthly
Run [Backup Type]
Backup at [Time]
Enter the time of day you want this job element to commence.
On [Day of Month]
Select the numeric day of the month you want this job element to run. You can also choose last day of month.
Repeat every [Months]
Select the repeat frequency in months.
Retention
Start Date
This field is optional. To enable this field, select the check box, then select from the display calendar the first date you want this job element to run.
End Date
This field is optional. To enable this field, select the check box, then select from the display calendar the final date you want this job element to run.
Scheme
Run [Backup Type]
Backup at [Time]
Enter the time of day you want the base backup of this job to commence.
On [Day of Week]
Select the day of the week you want the base backup of this job to run.
Retention
Run [Backup Type]
Backup at [Time]
Enter the time of day you want the differential or incremental backups of this job to commence.
On [Scheme]
Select the scheme for the differential and incremental runs of this job. Your choices are displayed on the drop down list.
Retention
Click Apply. The job schedule element is added to the “Schedule Description” list at the top of the window.
Repeat steps 4.1 through 4.4 as needed to define the schedule for the particular job you are defining.
Select the Exceptions tab if exclusions are desired. This window allows you to exclude any future scheduled runs of the job. Add exclusion description items one by one. To do so:
Click New.
In the New Exclusion box, select from the display calendar the date of your desired exclusion. In the display calendar, the dates for which the current job is scheduled are denoted in purple. The job elements scheduled for that date appear in the box.
To exclude certain job elements scheduled for that date, click Select one or more entries to exclude, then select the desired jobs from the entries listed in the box. To exclude all job elements scheduled for your selected date, click Exclude whole day.
Click Apply. The exclusion description item is added to the Schedule Description list at the top of the window.
Repeat steps 5.1 through 5.4 as needed to define the exceptions for the particular job you are defining.
You can also indicate whether or not scheduled jobs should be skipped on holidays by clicking to select or unselect Skip Run if Holiday.
Click OK. The schedule and exceptions you just defined are associated with the job you are defining.
Tip. Remember to save the job definition after you specify a job schedule.
Editing a Block backup job allows you to change some parameters of an already defined job (Save), or to create a new job based on the definition of an existing one (Save as…). The procedure is similar to creating a backup job.
In the main web interface view, go to Job Manager in the sidebar. Then select the block backup job you want to edit from the list.
Tip. You can control this view by ordering items by Job Name, Type, Created Date, Description, or Job Folder. Just click the column header to enable ascending/descending ordering.
Note also the Items per page value and navigation buttons at the bottom of the list, which can be useful when managing the display of many jobs.
Make all required changes to the job definition. The workflow is the same as in Creating a Block Backup Job.
Save the job by clicking Save (the changes will be saved under the current job’s name, overwriting previous settings), or Save As (you will be prompted to provide a new name for the job).
Restrictions. The new job name must be unique throughout the entire DPX, regardless of the folder the job is stored in.
Attention! Changing Block backup job name forces DPX to create a new base backup when the job is run, rather than an incremental or a differential backup. See also Forcing a Base Backup.
In the desktop interface, block backups are defined and edited exclusively through the block backup wizard.
Go to the Backup tab.
From the Backup Modes section in the side panel, choose Block.
In the Job Tasks section of the task panel, find and click Block Backup Wizard.
The Block Backup Wizard window will appear:
Select an existing Block backup job you want to edit and click Edit Job.
Make all required changes to the job definition. The workflow is the same as in Creating a Block Backup Job.
In the final Save screen, you may either save the changed job under the same name, or specify a new name to save the changes as a new job. You may also specify the Job Folder to store the job in (the default folder is SS_DEFAULT), as well as add a comment to the job definition or set up a schedule (See Scheduling a Block Backup Job).
Restrictions. The new job name must be unique throughout the entire DPX, regardless of the folder the job is stored in.
Attention! Changing Block backup job name forces DPX to create a new base backup when the job is run, rather than an incremental or a differential backup. See also Forcing a Base Backup.
Note. If you select Cancel, the job will be saved anyway, it will not be run and the retention period will remain 90 days.
You may add a schedule to an existing Block backup job and save it, add a schedule to an existing job and save it under another name (thus creating a new job without affecting the job you have made edits to), or create a completely new job, adding a schedule to it.
To add a schedule to a Block backup job, create a new job or open an existing one from the Job Manager.
In the job creation/editing view, scroll down to the SCHEDULES pane and click Add Schedule. The Schedule dialog will open. Depending on the selected frequency, the dialog will display slightly different parameters to select. Below, the Weekly schedule view is shown.
Select all required parameters, such as the schedule starting time and date, day of the week (if applicable), repetition period, backup retention time, etc.
Click Add.
Important. The schedule is now added to the job, but the job is not saved yet. Continue with the procedure to save the job.
Save the job. If you have added the schedule by modifying an existing job, two options will be available.
Click Save to apply changes to the existing job; or
Click Save As to create a copy of the modified job, with the schedule added.
Attention! When editing an existing Block backup job, bear in mind that any change to the backup source or destination will result in creating a new base backup rather than an incremental or differential backup, as the relation between the job definition and the previous base backup job will be lost.
This also requires running a Condense job before running the edited Block backup job. See also Condense job.
In the desktop interface, block backups are defined and edited exclusively through the block backup wizard. This also concerns creating and editing job schedules.
Go to the Backup tab.
From the Backup Modes section in the side panel, choose Block.
In the Job Tasks section of the task panel, find and click Block Backup Wizard.
Select an existing Block backup job you want to add a schedule to and click Edit Job.
Jump through all the steps clicking Next until you reach the Save screen. Click Schedule Job.
In the Job Schedule dialog, define all the schedules you require for the job. You may add schedule exceptions, e.g. for holidays, in the Exceptions tab.
Click OK to save the schedule.
Note. If you select Cancel, the job will be saved anyway, it will not be run and the retention period will remain 90 days.
Catalogic DPX offers a variety of job options for Block backup. All of them are available from both interfaces, but the access thereto may differ. See details for each interface below.
In the web interface, backup job options are defined in the Advanced Options section. To access them, do the following:
Go to Job Manager in the sidebar.
Open an already existing backup job. Or create a new Block backup job, by clicking the New Backup Job button in the upper right corner and then selecting Backup Type Block.
Go to the Advanced Options section at the bottom (scroll down if necessary) and expand it. Click any of the following section headers to expand it. Each field and the available choices are explained below.
Tells DPX to run a consistency check on SQL Server before backing up a SQL Server database. The check runs three utilities that Microsoft recommends before a backup: DBCC CHECKDB, DBCC CHECKALLOC, and DBCC CHECKCATALOG.
Toggle on
Performs the consistency check.
Toggle off
Does not perform the consistency check.
This option controls the truncation of SQL Server Transaction Logs during a Block backup. This option must be set to On in order to enable Point-in-Time restore.
Toggle on
SQL Server transaction logs are truncated on the source database server after the backup completes. To find the backed-up SQL logs, refer to the message “BACKUP LOG <database-instance> TO DISK...” in the Job Log or to Event 18265 in the Application Event Log.
Toggle off
SQL Server transaction logs are not truncated and will therefore continue to grow on the source database server. To truncate translation logs, run SQL Server maintenance on the source machine. No is the default.
This option controls the truncation of Microsoft Exchange Logs during a Block backup.
Toggle on
After the backup is complete, DPX deletes the old Exchange logs. Yes is the default.
Toggle off
DPX does not delete any Exchange logs.
Determines whether DPX will back up Exchange DAG from a passive node or an active node.
Toggle on
Default setting. Back up Exchange DAG from a passive node.
Toggle off
Back up Exchange DAG from an active node.
For Oracle backups, this option determines whether to synchronize the RMAN catalog after the job is completed. Yes is the default.
Toggle on
Synchronize the RMAN catalog after the job completes.
Toggle off
Do not synchronize the RMAN catalog after the job is completed. If you choose this option, the job is not cataloged in RMAN.
This section includes the following radio button selection:
Disable File History
Process File History on Local Client (default selection)
Process File History on Master Server
This section includes the following options:
Task Data Retry Count (default: 5)
Task Retry Interval (default: 1)
Throttle (default: 0)
Resolution Auto Cancel Timeout [Minutes] (default: 180)
Resolution Retry Count (default: 3)
Wait Interval Between Replies [Minutes] (default: 1)
Data Transfer Auto Cancel Interval [Minutes] (default: 0)
And one toggle:
Backup IA Mapped Drives (default: disabled)
The Notification Options section controls who receives messages pertaining to the current job when it is run.
This section includes the Job e-mail notification toggle.
Toggle on
The notification is sent as specified below the toggle (additional fields will appear – see below).
Toggle off
Subject
The subject of your message. The subject line usually contains a combination of straight text and variable elements. Variables, which must begin with %
, are replaced with actual corresponding values. If you enclose variables in double quotation marks, those variables are treated as literal values. You can embed the following variables:
%JOBNAME
%JOBID
%JOBTYPE
%RC
Use %RC to include the return code in the message for this run of the job, when applicable.
To
The email address of the primary recipient of your message. Only one “To” address is permitted.
Cc
Carbon Copy. The email address(es) of the secondary recipient(s) of your message. Use a semicolon to delimit multiple email addresses.
Bcc
Blind Carbon Copy. The email address(es) of the secondary recipient(s) not identified to other recipients. Use a semi-colon to delimit multiple email addresses.
Note. Note that the following characters are invalid in all fields: <
>
;
and '
.
Note. DPX emailing must be enabled when you first configure your Enterprise. At that time, you supply general system information, including SMTP Host Name and SMTP Port. See the Administrator E-mail Settings section.
Enter the name of a script to execute prior to the actual job.
Basic usage: <script>@<node_name> <argument_list>
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
The action to be taken if the Job fails to successfully complete:
Run Post-Job Script
Skip Post-Job Script
Enter the name of a script to execute after the actual job.
Basic usage: <script>@<node_name> <argument_list>
See also. For detailed information about pre- and post-job scripts, including all valid definitions, see Pre-Scripts and Post-Scripts.
In the desktop interface, backup jobs are defined exclusively through the Block Backup Wizard. See Creating a Block Backup Job. The last but one step of the Wizard, the Job Options screen contains five tabs. Each of them is explained below.
Task Data Transfer Retry Count
Controls the number of checkpoint retries of an interrupted Block backup. The retries attempt to resume the job from the last successfully backed-up data block. Enter the number of checkpoint restart attempts.
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.
Throttle
Enter a value in KB/s (kilobytes per second) to set the maximum transmission rate per backup task. The value 0, the default, allows the task to use the maximum bandwidth available. See Catalogic DPX Block Data Protection in the DPX 4.9.x User’s Guide.
Resolution Auto Cancel Interval (Minutes)
This option comes into play when DPX attempts to retry a failed snapshot. If the retry is unresponsive, DPX initiates job auto-cancel after this interval, in minutes, has lapsed.
Resolution Retry Count
Determines how many times to retry a failed snapshot attempt.
Wait Interval Between Retries (Minutes)
Determines the amount of time (in minutes) to wait between retry attempts for a failed snapshot attempt.
Data Transfer Auto Cancel Interval (Minutes)
This option comes into play if a job does not get an indication of “active” status during the data transfer phase of the job. DPX initiates job cancellation after this interval, in minutes, has lapsed.
Backup IA-Mapped Drive
This is an option to backup IA-Mapped drives from DPX snapshots. Note: The default setting is No and should be changed to Yes to back up the drives.
MSSQL DB Consistency Check
Tells DPX to run a consistency check on SQL Server before backing up a SQL Server database. The check runs three utilities that Microsoft recommends before a backup: DBCC CHECKDB, DBCC CHECKALLOC, and DBCC CHECKCATALOG.
No
Does not perform the consistency check.
Yes
Performs the consistency check.
Backup and Truncate SQL Logs
This option controls the truncation of SQL Server Transaction Logs during a Block backup. This option must be set to Yes to enable Point-in-Time restore.
Yes
SQL Server transaction logs are truncated on the source database server after the backup completes. To find the backed up SQL logs, refer to the message “BACKUP LOG <database-instance> TO DISK...” in the Job Log or to Event 18265 in the Application Event Log.
No
SQL Server transaction logs are not truncated and will therefore continue to grow on the source database server. To truncate translation logs, run SQL Server maintenance on the source machine. No is the default.
Exchange DAG Passive Copy
Determines whether DPX will back up Exchange DAG from a passive node or an active node.
Yes
Default setting. Back up Exchange DAG from a passive node.
No
Back up Exchange DAG from an active node.
Truncate Exchange Logs
This option controls the truncation of Microsoft Exchange Logs during a Block backup.
Yes
After the backup is complete, DPX deletes the old Exchange logs. Yes is the default.
No
DPX does not delete any Exchange logs.
Oracle RMAN Cataloging Control
For Oracle backups, this option determines whether to synchronize the RMAN catalog after the job is completed. Yes is the default.
Yes
Synchronize the RMAN catalog after the job completes.
No
Do not synchronize the RMAN catalog after the job is completed. If you choose this option, the job is not cataloged in RMAN.
NDMP File History Handling
Controls file history generation for NDMP and Block backup tasks. For Block backups, recovery through the use of Instant Access provides for granular file-level restore regardless of whether file history was generated or not. Instant Access allows Block backups to be run very frequently by eliminating the need to include file histories during backup. For information on using Instant Access for file-level restore, see Instant Access as a File History Alternative in the DPX 4.9.x User’s Guide.
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
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:
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.
Enter the name of a script to execute prior to the actual job.
Basic usage: <script>@<node_name> <argument_list>
The action to be taken if the Pre-Job Script fails to complete successfully:
Run Job/Run Post-Job Script
Skip Job/Run Post-Job Script
Skip Job/Skip Post-Job Script
The action to be taken if the Job fails to complete successfully:
Run Post-Job Script
Skip Post-Job Script
Enter the name of a script to execute after the actual job.
Basic usage: <script>@<node_name> <argument_list>
See also. For detailed information about pre- and post-job scripts, including all valid definitions, see Pre-Scripts and Post-Scripts.
Two sets of mail information can be specified:
Output Email
Specifies that the subsequent fields apply to reports that are sent when a job has completed.
Operator Email
Specifies that the subsequent fields apply to mount requests, error messages, and informational messages that are sent during a job.
The email address of the primary recipient of your message. Only one “To” address is permitted.
Carbon Copy. The email address(es) of the secondary recipient(s) of your message. Use a semicolon to delimit multiple email addresses.
Blind Carbon Copy. The email address(es) of the secondary recipient(s) not identified to other recipients. Use a semi-colon to delimit multiple email addresses.
The subject of your message. The subject line usually contains a combination of straight text and variable elements. Variables, which must begin with %
, are replaced with actual corresponding values. If you enclose variables in double quotation marks, those variables are treated as literal values. You can embed the following variables:
%JOBNAME
%JOBID
%JOBTYPE
%RC
Use %RC to include the return code in the message for this run of the job, when applicable.
Selecting this check box option temporarily disables notifications for the job without deleting the currently defined job notification data.
Note. Note that the following characters are invalid in all fields: <
>
;
and '
.
Note. DPX emailing must be enabled when you first configure your Enterprise. At that time, you supply general system information, including SMTP Host Name and SMTP Port. See Editing an Enterprise Configuration.
To launch the Configure Administrators window, click the Configure tab on the Function Tab bar of the window, then click Administrators in the task panel.
The first time the system administrator opens the Configure Administrators window, the sysadmin administrator group is visible in the Administrator tree in the left pane.
Below is a sample view of the Configure Administrators window.
Configure Administrators allows you to add new administrator groups to fulfill limited or broad functions.
Make sure you are in the Configure tab, and the Administrators section is selected.
In the left pane, select the Enterprise.
Add a new administrator group by doing one of the following:
Right-click the Enterprise icon to bring up the context menu and select Add Administrator Group.
From the menu toolbar, select Administrators > Add Administrator Group.
On the task panel select, click Add Administrator Group.
The Add Administrator Group dialog appears in the right pane of the Configure Administrators window.
Complete the active fields in the Add Administrator Group dialog.
AdminGroupName
Enter the name for the new administrator group. You can use up to 48 alphanumeric characters, no spaces.
Maximum Password Age
The Password Age is the number of days that a password can be used by an administrator before it expires.
Selecting Use Enterprise Setting imports the default password age set in the Edit Enterprise dialog. Selecting Set Password Age exposes an edit field in which you must enter a password applicable to this administrator group. The password age must be between 0 and 999, where 0 means “never expire”. For more information, see Editing an Enterprise Configuration in the DPX 4.9.x Reference Guide.
Comment
Enter an optional comment. You can use up to 48 alphanumeric characters, no spaces.
Select Add on the task menu at the top right of the right pane. If you are unable to see the task menu, resize the right pane.
The new administrator group appears in the Administrator tree in the left pane. The right pane changes to Edit Administrator Group.
Make sure you are in the Configure tab, and the Administrators section is selected.
Open the Edit Administrator Group dialog in the right pane by doing one of the following:
Right-click the administrator group name or icon to display a context menu. The selection is indicated by the selection check box next to the administrator group icon. Then select Edit.
In the left pane, select the administrator group you want to edit and do one of the following:
From the menu bar, select Administrators > Edit Administrator Group.
On the task panel, click Edit Administrator Group.
The Edit Administrator Group dialog appears in the right pane.
Revise the fields as needed.
Select Apply. The changes are now implemented.
Note. Before you can delete an administrator group, you must delete all of its administrators. See Deleting an Administrator below.
The SYSADMIN administrator group cannot be deleted.
Make sure you are in the Configure tab, and the Administrators section is selected.
Do one of the following:
Right-click the administrator group name or icon to display a context menu. The selection is indicated by the selection check box next to the administrator group icon. Then select Delete.
In the left pane, select the administrator group you want to delete and do one of the following:
From the menu bar, select Administrator > Delete Administrator Group.
On the task panel, click Delete Administrator Group.
The Proceed with administrator group deletion message box appears.
Click Yes. The administrator group disappears from the Administrator tree.
DPX allows you to add new administrators to administrator groups.
Make sure you are in the Configure tab, and the Administrators section is selected.
In the left pane, select the Administrator Group that you want to add the new administrator to.
Add a new administrator by doing one of the following:
Right-click the Administrator Group icon to bring up the context menu and select Add Administrator.
From the menu toolbar, select Administrator > Add Administrator.
On the task panel select, click Add Administrator.
The Add Administrator dialog appears in the right pane of the Configure Administrators window.
The fields displayed in the Add Administrator dialog depend on the Authentication Mode selected in the Edit Enterprise function: Native or LDAP. If a field is displayed in only one of the authentication modes, the applicable mode is indicated in brackets []
after the field name in the description below. Otherwise, the field is common to both modes.
For more information about Authentication Mode, see Editing an Enterprise Configuration in the DPX 4.9.x Reference Guide.
AdminGroupName
This field is populated automatically based on the administrator group previously selected.
Administrator Name [Native authentication mode]
Enter the user name for the new administrator. You can use up to 48 alphanumeric characters. If the name exists in native mode and you want to use it in LDAP mode, you must first remove the name from native mode.
Password [Native authentication mode]
Enter a password for the new administrator.
A valid password must meet the following criteria:
The password is between six and fourteen characters.
The password cannot include the user name or the strings “sysadmin”, “administrator” or “admin”.
The password contains English characters and at least one digit.
Confirm Password [Native authentication mode]
Enter the password again to confirm it.
LDAP Username [LDAP authentication mode]
The username is provisioned from the LDAP server, thus no password is necessary. DPX validates the username. UTF-8 encoded usernames are supported. The supported length of the username is up to 48 bytes ASCII or approximately 24 double bytes, depending on the language. Spaces are not supported in the username.
Forest walking or referral chasing is supported with AD.
The username must conform to the type selected in the Username Attribute field in the Edit Enterprise pane.
This field only appears when the LDAP mode is enabled.
Comment
Enter an optional comment.
Select Add. The new administrator appears in the Administrator tree in the left pane. You might need to refresh the view by clicking Administrators in the task panel.
An administrator can change the administrator group by using drag-and-drop in the left pane of the Configure Administrators window. If so privileged, an administrator can temporarily become a system administrator by being dragged to the SYSADMIN administrator group. In this case, the administrator’s original privilege classes will be preserved so that when they are dragged back to a different administrator group, they still have the same privilege classes.
Make sure you are in the Configure tab, and the Administrators section is selected.
Open the Edit Administrator dialog in the right pane by doing one of the following:
Right-click the administrator name or icon to display a context menu. The selection is indicated by the selection check box next to the administrator icon. Then select Edit.
In the left pane, select the administrator you want to edit and do one of the following:
From the menu bar, select Administrator > Edit Administrator.
On the task panel, click Edit Administrator.
The Edit Administrator dialog appears in the right pane.
Revise the Password and/or optional Comment fields as needed.
Select Apply. The changes are now implemented.
Note. Before you can delete an administrator you must unassign all of its resources.
Make sure you are in the Configure tab, and the Administrators section is selected.
Do one of the following:
Right-click the administrator name or icon to display a context menu. The selection is indicated by the selection check box next to the administrator icon. Then select Delete.
In the left pane, select the administrator you want to delete and do one of the following:
From the menu bar, select Administrator > Delete Administrator.
On the task panel, click Delete Administrator.
The Proceed with administrator deletion message box appears.
Click Yes. The administrator disappears from the Administrator tree.
Assigning resources to an administrator group involves giving that group access to various objects within DPX that are necessary for carrying out tasks such as backup, restore, and migrate. Resources such as Device Clusters, Node Groups, Tape Libraries, Media Pools, Job Folders, Administrator Groups, and Keyrings can be assigned to an administrator group. When a resource is assigned to a group, all members of that group can potentially access the resource, subject to their individual privilege classes.
Note. Resources are assigned to administrator groups. Privilege Classes are assigned to individual administrators.
Device Clusters, Node Groups, Tape Libraries, and Media Pools
These are the resources that an administrator can use in carrying out tasks such as backup, restore, and migrate.
Job Folders
Job folders contain the defined jobs that a particular administrator can carry out.
Administrator Groups
Keyrings
Keyrings contain keys for data-encrypted jobs.
In the left pane of the Configure Administrator window, click the Enterprise (globe) icon or select Administrator > Show Assignable from the menu bar. The Resource Tree will appear in the right pane.
Expand the left pane until you see the administrator group to which you want to assign resources.
Expand the Resource Tree in the right pane until you can see the resource you want to assign.
Select the checkbox of the resource you want to assign.
With your mouse, drag the resource to the left pane and drop it on the administrator group you want to assign the resource to. When you release the mouse button, the resource is assigned and appears in the left pane beneath the administrator group.
Note. The SYSADMIN administrator group is not draggable from the right pane.
In the left pane of the Configure Administrator window, click the Enterprise (globe) icon or select Administrator > Show Assignable from the menu bar. The Resource Tree will appear in the right pane.
Expand the left pane until you see the administrator to which you want to assign privilege classes.
Expand the privilege class tree in the right pane until you can see the privilege class you want to assign.
Select the checkbox of the privilege class you want to assign.
With your mouse, drag the privilege class to the left pane and drop it on the administrator you want to assign the privilege class to. When you release the mouse button, the privilege class is assigned and appears in the left pane beneath the administrator.
Note. You can also assign privilege classes by dragging them from one administrator to another in the left pane of the Configure Administrators window.
Make sure you are in the Configure tab, and the Administrators section is selected.
Do one of the following:
In the left pane, select the assigned resource you want to unassign. Then, from the menu bar, select Administrator > Unassign Resources.
A Confirm unassign resources message box appears.
Click Yes.
The resource disappears from the Administrator tree.
Make sure you are in the Configure tab, and the Administrators section is selected.
Do one of the following:
In the left pane, select the assigned privilege class you want to unassign. Then, from the menu bar, select Administrator > Unassign Privilege Classes.
A Confirm unassign privilege class message box appears.
Click Yes. The privilege class disappears from the Administrator tree.
Open the Administrator Group Report by doing one of the following:
Click the Reports Tab and select Administrator Group Report.
Right-click Reports on the Function Tab Bar and select Administrator Group Report from the context menu.
In the left pane of the Configure Administrators window, right-click on any administrator group name or icon to display a context menu. Then select Report.
From the menu bar of the Configure Administrators window, select Administrators > Administrator Group Report.
The Administrator Group Report window appears. The fields in this report are Name and Resources.
Click Create PDF File.
Complete the Generate Report dialog:
Enter the filename in the Title field.
Select the orientation.
Enter the full path to a directory that contains the font arialuni.ttf
. If no directory is specified, the default font is applied to the report.
Select the Yes radio button to generate the report as a Microsoft Excel readable file with the .csv
extension.
Click OK to generate the report. The report will open in an Acrobat window. To print the report, click the Acrobat Print icon.
When a report is generated, an Acrobat file named BEXReportReportName.pdf
and, optionally, a Microsoft Excel readable file named BEXReportReportName.csv
are created on your local disk. The report files are created in your computer’s default temporary directory, as defined by the environmental variable %TEMP%
or %TMP%
.
Open the Administrator Report by doing one of the following:
Click the Reports Tab and select Administrator Report.
Right-click Reports on the Function Tab Bar and select Administrator Report from the context menu.
In the left pane of the Configure Administrators window, right-click on any administrator name or icon to display a context menu. Then select Report.
From the menu bar of the Configure Administrators window, select Administrators > Administrator Report.
The Administrator Report window appears. The fields in this report are Name, Group Name, and Privilege Classes.
Click Create PDF File.
Complete the Generate Report dialog:
Enter the filename in the Title field.
Select the orientation.
Enter the full path to a directory that contains the font arialuni.ttf
. If no directory is specified, the default font is applied to the report.
Select the Yes radio button to generate the report as a Microsoft Excel readable file with a .csv
extension.
Click OK to generate the report. The report will open in an Acrobat window. To print the report, click the Acrobat Print icon.
When a report is generated, an Acrobat file named BEXReportReportName.pdf
and, optionally, a Microsoft Excel readable file named BEXReportReportName.csv
are created on your local disk. The report files are created in your computer’s default temporary directory, as defined by the environmental variable %TEMP%
or %TMP%
.
Catalogic DPX delivers robust backup solutions tailored for Microsoft SharePoint Server environments, ensuring critical collaboration data is securely backed up and protected. With its support for block-level backups, DPX enables efficient safeguarding of SharePoint Server data, including support for recovery to alternate locations. DPX supports Microsoft SharePoint Server's high-availability features, including SQL Server AlwaysOn Availability Groups, ensuring continuous protection of your SharePoint environment. With farm configurations, Microsoft SQL Server can be any supported configuration, providing flexibility and compatibility with various SQL Server setups.
Before you start your Microsoft SharePoint Server backup, ensure the following conditions are met:
Ensure the DPX agent is installed on the SharePoint server.
Verify that the SharePoint server is properly registered within DPX.
Adequate backup storage is allocated and accessible for storing the SharePoint Server backups.
See also. For detailed information on supported SharePoint Server versions and operating systems, see .
Backing up Microsoft SharePoint Server is essential for preserving critical collaboration and content management data within an organization. Catalogic DPX offers a streamlined approach to backing up SharePoint Server, leveraging its application-aware capabilities to facilitate the process.
In the main web interface view, go to Job Manager in the sidebar. Then select the New Backup Job button in the upper right corner.
Specify the Job Name (this field may contain up to 16 characters). Add an optional, brief description (this field may contain up to 48 characters).
Select Job Type – Block and the Job Folder to store the job in. By default, all jobs are stored in the SS_DEFAULT folder.
Click Add Source in the SOURCES pane to specify which volumes you want to back up. DPX detects Sharepoint Server installations through registry settings and the VSS (Volume Shadow Copy Service) framework. You will see a separate virtual object for the Sharepoint Server, indicating that DPX can perform application-consistent backups. Select your Sharepoint Server and click Select.
Attention! When backing up an Sharepoint object with DPX, all local volumes referenced by the object will also be included in the backup. This may result in a larger backup size than initially anticipated.
Tip. You may view your current selection at any moment, using the Selected Items button next to the search field.
Click Set Destination in the DESTINATION pane to choose the destination for the backup.
You can also add a schedule in the SCHEDULES pane for the backup to be run regularly.
If you want to add an Archive to your backup job, click Add Archive in the ARCHIVE pane.
Select the Archive destination.
Determines whether a backup tape is stored offsite. DPX adds the Offsite status to the tape.
Determines if a backup tape with status Offsite can be appended.
The Offsite status of a tape can be viewed through the Operate Tape Library function, the Configure Media function, or in the media volume report. Note that when you use the Operate Tape Library function to import a tape with status Offsite, the Offsite status is cleared and the tape becomes available for use.
Limits the number of storage devices valid for use with this job. Use this option if you want to stop DPX from using all the drives in the selected device cluster so that some drives will be available for other purposes.
This is an alternate location where backup data resides. This alternate location could be a replica of the original data using NetApp SnapMirror, copied through Data ONTAP commands, or restored from a tape backup. Data can be restored from an alternate secondary data source directly from the management console.
If the toggle is on, two additional drop-down selection fields are shown, requiring to specify the Alternate Secondary Node and Volume.
Add schedules for Base, Incremental, and Differential Archive backups according to your requirements.
Click Add to save the current schedule.
Multiple schedules may be added using the Add Another Schedule button which will be displayed upon adding the first schedule.
Specify Advanced Options.
Click Save.
Enter the retention period and choose whether to run the job immediately. Your job will be now available in the Job Manager section.
Go to the Backup tab.
From the Backup Modes section in the side panel, choose Block.
In the Job Tasks section of the task panel, find and click Block Backup Wizard.
The Block Backup Wizard window will appear:
By default, the creator allows you to select from the drop-down list and edit an already existing job. If you want to create a new block backup job, click the New Job button in the lower right corner.
In the Select Source screen, choose the Sharepoint databases you want to include in the backup. Click Next.
In the Select Destination screen, choose the destination for the backup job. Click Next.
In the Job Options screen, define the job options for the backup job.
Note. If you select Cancel, the job will be saved anyway, it will not be run and the retention period will remain 90 days.
In the web interface, SQL Server backups are defined in the Job Manager section. In the desktop interface, block backups are implemented through a backup wizard.
In the main web interface view, go to Job Manager in the sidebar. Then select the New Backup Job button in the upper right corner.
Specify the Job Name (this field may contain up to 16 characters). Add an optional, brief description (this field may contain up to 48 characters).
Select Job Type – Block and the Job Folder to store the job in. By default, all jobs are stored in the SS_DEFAULT folder.
Click Add Source in the SOURCES pane to specify which volumes you want to back up. DPX detects SQL Server installations through registry settings and the VSS (Volume Shadow Copy Service) framework. You will see a separate virtual object for every SQL Server database, indicating that DPX can perform application-consistent backups. Select your SQL Server and click Select.
Attention! When backing up an SQL object with DPX, all local volumes referenced by the SQL object will also be included in the backup. This may result in a larger backup size than initially anticipated.
Tip. You may view your current selection at any moment, using the Selected Items button next to the search field.
Click Set Destination in the DESTINATION pane to choose the destination for the backup.
You can also add a schedule in the SCHEDULES pane for the backup to be run regularly.
If you want to add an Archive to your backup job, click Add Archive in the ARCHIVE pane.
Select the Archive destination.
Determines whether a backup tape is stored offsite. DPX adds the Offsite status to the tape.
Determines if a backup tape with status Offsite can be appended to.
The Offsite status of a tape can be viewed through the Operate Tape Library function, the Configure Media function, or in the media volume report. Note that when you use the Operate Tape Library function to import a tape with status Offsite, the Offsite status is cleared and the tape becomes available for use.
Limits the number of storage devices valid for use with this job. Use this option if you want to stop DPX from using all the drives in the selected device cluster so that some drives will be available for other purposes.
This is an alternate location where backup data resides. This alternate location could be a replica of the original data using NetApp SnapMirror, copied through Data ONTAP commands, or restored from a tape backup. Data can be restored from an alternate secondary data source directly from the management console.
If the toggle is on, two additional drop-down selection fields are shown, requiring to specify the Alternate Secondary Node and Volume.
Add schedules for Base, Incremental, and Differential Archive backups according to your requirements.
Click Add to save the current schedule.
Multiple schedules may be added using the Add Another Schedule button which will be displayed upon adding the first schedule.
Specify Advanced Options. There are 2 SQL Server-specific options:
Tells DPX to run a consistency check on SQL Server before backing up a SQL Server database. The check runs three utilities that Microsoft recommends before a backup: DBCC CHECKDB, DBCC CHECKALLOC, and DBCC CHECKCATALOG.
This option controls the truncation of SQL Server Transaction Logs during a Block backup.
Attention! If you want to perform Point-in-Time restore, make sure to disable this option.
Click Save.
Enter the retention period and choose whether to run the job immediately. Your job will be now available in the Job Manager section.
Go to the Backup tab.
From the Backup Modes section in the side panel, choose Block.
In the Job Tasks section of the task panel, find and click Block Backup Wizard.
The Block Backup Wizard window will appear:
By default, the creator allows you to select from the drop-down list and edit an already existing job. If you want to create a new block backup job, click the New Job button in the lower right corner.
In the Select Source screen, choose the SQL Server databases you want to include in the backup. Click Next.
In the Select Destination screen, choose the destination for the backup job. Click Next.
In the Job Options screen, define the job options for the backup job. There are 2 SQL Server-specific options available in the Application tab:
Tells DPX to run a consistency check on SQL Server before backing up a SQL Server database. The check runs three utilities that Microsoft recommends before a backup: DBCC CHECKDB, DBCC CHECKALLOC, and DBCC CHECKCATALOG.
This option controls the truncation of SQL Server Transaction Logs during a Block backup.
Attention! If you want to perform Point-in-Time restore, make sure to disable this option.
Note. If you select Cancel, the job will be saved anyway, it will not be run and the retention period will remain 90 days.
Backing up Microsoft Exchange Server is essential for ensuring the availability and integrity of email communications within an organization. Catalogic DPX offers a streamlined approach to backing up Exchange Server, leveraging its application-aware capabilities to facilitate the process.
In the main web interface view, go to Job Manager in the sidebar. Then select the New Backup Job button in the upper right corner.
Specify the Job Name (this field may contain up to 16 characters). Add an optional, brief description (this field may contain up to 48 characters).
Select Job Type – Block and the Job Folder to store the job in. By default, all jobs are stored in the SS_DEFAULT folder.
Click Add Source in the SOURCES pane to specify which volumes you want to back up. DPX detects Exchange Server installations through registry settings and the VSS (Volume Shadow Copy Service) framework. You will see a separate virtual object for the Exchange Server, indicating that DPX can perform application-consistent backups. Select your Exchange Server and click Select.
Tip. DPX supports backing up Exchange Server databases in both Active/Active and Active/Passive cluster configurations. This is particularly important for environments utilizing Database Availability Groups (DAGs) or IP-less DAG configurations, ensuring continuous protection for your data.
Attention! When backing up an Exchange object with DPX, all local volumes referenced by the object will also be included in the backup. This may result in a larger backup size than initially anticipated.
Tip. You may view your current selection at any moment, using the Selected Items button next to the search field.
Click Set Destination in the DESTINATION pane to choose the destination for the backup.
You can also add a schedule in the SCHEDULES pane for the backup to be run regularly.
If you want to add an Archive to your backup job, click Add Archive in the ARCHIVE pane.
Select the Archive destination.
Determines whether a backup tape is stored offsite. DPX adds the Offsite status to the tape.
Determines if a backup tape with status Offsite can be appended.
The Offsite status of a tape can be viewed through the Operate Tape Library function, the Configure Media function, or in the media volume report. Note that when you use the Operate Tape Library function to import a tape with status Offsite, the Offsite status is cleared and the tape becomes available for use.
Limits the number of storage devices valid for use with this job. Use this option if you want to stop DPX from using all the drives in the selected device cluster so that some drives will be available for other purposes.
This is an alternate location where backup data resides. This alternate location could be a replica of the original data using NetApp SnapMirror, copied through Data ONTAP commands, or restored from a tape backup. Data can be restored from an alternate secondary data source directly from the management console.
If the toggle is on, two additional drop-down selection fields are shown, requiring to specify the Alternate Secondary Node and Volume.
Add schedules for Base, Incremental, and Differential Archive backups according to your requirements.
Click Add to save the current schedule.
Multiple schedules may be added using the Add Another Schedule button which will be displayed upon adding the first schedule.
Specify Advanced Options. There are 2 Exchange Server-specific options:
This option controls the truncation of Microsoft Exchange Logs during a Block backup.
Attention! If you want to perform Point-in-Time restore, make sure to disable this option.
This option is designed for use in environments where Exchange is deployed in a high-availability configuration, such as a Database Availability Group (DAG). In a DAG setup, there are multiple copies of the Exchange databases across different servers or nodes, which can be active (serving client requests) or passive (standby copies). Enabling this option reduces the resource load and potential performance impact on the active server, which is handling client requests.
Click Save.
Enter the retention period and choose whether to run the job immediately. Your job will be now available in the Job Manager section.
Go to the Backup tab.
From the Backup Modes section in the side panel, choose Block.
In the Job Tasks section of the task panel, find and click Block Backup Wizard.
The Block Backup Wizard window will appear:
By default, the creator allows you to select from the drop-down list and edit an already existing job. If you want to create a new block backup job, click the New Job button in the lower right corner.
In the Select Source screen, choose the Exchange databases you want to include in the backup. Click Next.
In the Select Destination screen, choose the destination for the backup job. Click Next.
In the Job Options screen, define the job options for the backup job. There are 2 Exchange-specific options available in the Application tab:
This option controls the truncation of Microsoft Exchange Logs during a Block backup.
Attention! If you want to perform a Point-in-Time restore, make sure to disable this option.
This option is designed for use in environments where Exchange is deployed in a high-availability configuration, such as a Database Availability Group (DAG). In a DAG setup, there are multiple copies of the Exchange databases across different servers or nodes, which can be active (serving client requests) or passive (standby copies). Enabling this option reduces the resource load and potential performance impact on the active server, which is handling client requests.
Note. If you select Cancel, the job will be saved anyway, it will not be run and the retention period will remain 90 days.
Catalogic DPX offers a comprehensive backup and recovery solution for Oracle Database environments, ensuring the protection and availability of critical database information. By supporting both block-level and file-level backups, DPX facilitates efficient and reliable safeguarding of Oracle Database data, including support for Oracle Recovery Manager (RMAN) through the standard SBT API. With DPX, you can utilize Block and File Level backup and restore capabilities, including Bare Metal Recovery (BMR) and instant and full virtualization restore features.
Before initiating an Oracle Database backup with Catalogic DPX, it is crucial to ensure the following prerequisites are met:
The DPX agent must be installed on the server hosting the Oracle Database.
The Oracle Database must be properly registered within the DPX environment.
Adequate backup storage should be allocated and accessible for storing the Oracle Database backups.
See also. For detailed information on supported Oracle Database versions and operating systems, see .
Backing up Oracle databases is essential for ensuring the availability and integrity of critical business data within an organization. Catalogic DPX offers a streamlined approach to backing up Oracle databases, leveraging its application-aware capabilities to facilitate the process.
In the main web interface view, go to Job Manager in the sidebar. Then select the New Backup Job button in the upper right corner.
Specify the Job Name (this field may contain up to 16 characters). Add an optional, brief description (this field may contain up to 48 characters).
Select Job Type – Block and the Job Folder to store the job in. By default, all jobs are stored in the SS_DEFAULT folder.
Click Add Source in the SOURCES pane to specify which volumes you want to back up. DPX detects Oracle DB installations through registry settings and the VSS (Volume Shadow Copy Service) framework. You will see a separate virtual object for the Oracle DB application, indicating that DPX can perform application-consistent backups. Select your database and click Select.
Attention! When backing up an Oracle DB object with DPX, all local volumes referenced by the object will also be included in the backup. This may result in a larger backup size than initially anticipated.
Tip. You may view your current selection at any moment, using the Selected Items button next to the search field.
Click Set Destination in the DESTINATION pane to choose the destination for the backup.
You can also add a schedule in the SCHEDULES pane for the backup to be run regularly.
If you want to add an Archive to your backup job, click Add Archive in the ARCHIVE pane.
Select the Archive destination.
Determines whether a backup tape is stored offsite. DPX adds the Offsite status to the tape.
Determines if a backup tape with status Offsite can be appended.
The Offsite status of a tape can be viewed through the Operate Tape Library function, the Configure Media function, or in the media volume report. Note that when you use the Operate Tape Library function to import a tape with status Offsite, the Offsite status is cleared and the tape becomes available for use.
Limits the number of storage devices valid for use with this job. Use this option if you want to stop DPX from using all the drives in the selected device cluster so that some drives will be available for other purposes.
This is an alternate location where backup data resides. This alternate location could be a replica of the original data using NetApp SnapMirror, copied through Data ONTAP commands, or restored from a tape backup. Data can be restored from an alternate secondary data source directly from the management console.
If the toggle is on, two additional drop-down selection fields are shown, requiring to specify the Alternate Secondary Node and Volume.
Add schedules for Base, Incremental, and Differential Archive backups according to your requirements.
Click Add to save the current schedule.
Multiple schedules may be added using the Add Another Schedule button which will be displayed upon adding the first schedule.
Specify Advanced Options. There is 1 Oracle DB-specific option:
This option determines whether to synchronize the RMAN Catalog after the job completes. You have access to the following options:
Click Save.
Enter the retention period and choose whether to run the job immediately. Your job will be now available in the Job Manager section.
Go to the Backup tab.
From the Backup Modes section in the side panel, choose Block.
In the Job Tasks section of the task panel, find and click Block Backup Wizard.
The Block Backup Wizard window will appear:
By default, the creator allows you to select from the drop-down list and edit an already existing job. If you want to create a new block backup job, click the New Job button in the lower right corner.
In the Select Source screen, choose the Oracle databases you want to include in the backup. Click Next.
In the Select Destination screen, choose the destination for the backup job. Click Next.
In the Job Options screen, define the job options for the backup job. There is 1 Oracle DB-specific option available in the Application tab:
This option determines whether to synchronize the RMAN Catalog after the job completes. You have access to the following options:
Note. If you select Cancel, the job will be saved anyway, it will not be run and the retention period will remain 90 days.
The section below describes the scenarios for implementing DPX in a GroupWise environment.
Note. The scenarios are for standalone nodes. GroupWise backups do not support clusters.
Although standard file-level backups can back up GroupWise files, this method is not recommended. For such backups, from the normal directory view you would select the domain and post office directory.
Then you would define the backup as for any other file-level backup. However, standard file-level backups use the general TSA, are not GroupWise aware, and back up more data than is required. GroupWise support, on the other hand, uses the GroupWise TSA, is GroupWise aware, and backs up only the data necessary for GroupWise recoveries of accounts, users, and data.
The following sections explain how to implement GroupWise backups in Linux OES environments. The key is to ensure that TSAFSGW is running on the client node, where the source data resides. This is accomplished in two steps:
Step 1: Load TSAFS with GroupWise functionality on Linux OES.
Step 2: Load TSAFSGW on Linux OES. (This step does not apply to GroupWise 2012 or 2014.)
The backup scenario described below assume the following environment:
Node: oes-linux-test (this node is added to DefaultGroup) Root password: sysadmin edirectory tree: admin.abc Tree password: sysadmin GroupWise Domain Directory: oes-linux-test:/groupwise_message/ GroupWise Post Office Directory: oes-linux-test:/Post_Office/
Note. The procedures below are based on Micro Focus documentation. Since procedures may change, we recommend checking for current procedures at .
Verify that the daemon is running:
/opt/Micro Focus/sms/bin/smsconfig –t
Make sure you are logged in as root.
Change to the directory where the SMS executables are located:
cd /opt/Micro Focus/sms/bin
Stop TSAFS:
./smsconfig -u tsafs
Start TSAFS with GroupWise functionality:
./smsconfig -l tsafs –-EnableGW
Verify that TSAFS is running with GroupWise functionality:
./smsconfig –t
The following is displayed:
Make GroupWise functionality the default by modifying the SMS configuration file, as follows:
Change to the directory where the SMS configuration file is located:
cd /etc/opt/Micro Focus/sms
In a text editor, open the smdrd.conf file.
Change autoload: tsafs to autoload: tsafs --EnableGW
Save the file and exit.
Restart SMS services to ensure the changes made to the SMS configuration file smdrd.conf
take effect:
/etc/init.d/service Micro Focus-smdrd restart
Because TSAFSGW depends on SMS, you use the smsconfig command in the /opt/MicroFocus/sms/bin directory with one or more home switches to specify the domains and post offices to back up. Note that this step does not apply to GroupWise 2012 or 2014.
Make sure you are logged in as root.
Change to the directory where the SMS executables are located:
cd /opt/Micro Focus/sms/bin
Use the following command to specify GroupWise locations to back up:
./smsconfig -l tsafsgw --home /domain_directory --home /post_office_directory
For example:
./smsconfig -l tsafsgw --home /groupwise_message --home /Post_Office
Verify TSAs currently running:
./smsconfig –t
The following is displayed:
Modify the SMS configuration file to establish the specified GroupWise locations as defaults for automatic backups in the future, as follows:
Change to the directory where the SMS configuration file is located:
cd /etc/opt/Micro Focus/sms
In a text editor, open the smdrd.conf file.
Locate the following line:
autoload: tsafs –-EnableGW
Add another line beneath it for TSAFSGW:
autoload: tsafsgw --home /groupwise_message --home /Post_Office
Save the file and exit.
Restart SMS services to ensure the changes made to the SMS configuration file smdrd.conf
take effect:
/etc/init.d/service Micro Focus-smdrd restart
After configuring the TSAFS with GroupWise functionality, open DPX and browse the node. You will see the following extra volumes under the node:
These volumes contain the GroupWise data that needs to be backed up. You can now select items to browse the volume and select items to back up.
On the desktop interface choose Backup > File.
Define a backup file of GroupWise volumes: 1[DOM]groupwise_message
, 2[PO]Post_Office
, 3[DMS]lib0001
.
Run the saved backup job.
Verify the backup job.
DPX supports backups and restores of OpenText GroupWise in a non-clustered environment. When you install a client on an OpenText Open Enterprise Server (OES) machine that GroupWise runs on, the GroupWise disks will be viewable in DPX.
The following is an extract from a File Backup window of a node that is running GroupWise 2014. This depicts a minimal GroupWise environment containing one GroupWise domain and one GroupWise post office. Additional GroupWise components would appear as additional volumes on the File Backup window. Note that the display may be different for other versions of GroupWise.
DPX supports GroupWise through the Target Service Agents (TSAs) recommended by OpenText for each OpenText and GroupWise platform. For more information on recommended TSAs and their required switches and flags, see the .
DPX supports GroupWise and OES as supported by OpenText. If you are using OpenText or Micro Focus software no longer supported by OpenText, our Technical Support assistance may be limited for functions dependent on that software. To address certain issues, the analyst may recommend you upgrade the relevant OpenText software.
For information about OpenText or GroupWise verification utilities, refer to your Micro Focus or GroupWise documentation.
To define backups and restores of GroupWise components, use the web or desktop interface just as you would for any simple backup or restore.
When restoring any files or components involving a GroupWise domain, including GroupWise post offices, you may need to bring down the MTAs, the POAs, the Micro Focus user interface, and Micro Focus Web Access. However, GroupWise DMS restores can occur while those agents are running.
To test basic backups on OES Linux, use the nbackup utility. To test the TSAFS connection on OES Linux, use the de utility. The de utility might not be included in a standard OpenText installation, but it can be acquired from OpenText.
Note. The discussions in the remainder of this chapter reflect GroupWise 7.0. They may be different in some details from other versions of GroupWise.
The following is a brief overview of GroupWise logical and physical layouts.
Each NDS tree in a network can have an associated GroupWise system. At a minimum, the GroupWise system has a primary domain and a post office. Like NDS, the logical framework of GroupWise is hierarchical, with GroupWise domains at the top level, post offices underneath, and libraries defined within the post offices. Further, storage areas can be created for libraries that store library documents in an area other than underneath the post office.
There is also a physical layout of a GroupWise system. GroupWise is flexible enough to allow each GroupWise system process to reside on a separate server. In most organizations, each post office has its dedicated server. Thus, a system with 3 domains, 6 post offices and 6 libraries (3 with separate storage areas) can involve 18 different servers. Additional servers may be used to house various gateway processes, but that is beyond the scope of DPX documentation (most gateways do not need to be restored, even in a disaster recovery scenario).
GroupWise services can be mixed and matched as well. For instance, on a server containing one domain and two post offices, one of the post offices may not be defined in that particular domain. However, Micro Focus strongly recommends that you run only one post office agent per server. It will be rare for more than one post office to run on a given server.
The following represents a typical GroupWise service scenario:
Usually, gateways appear under their own domains (logically) and on one server (physically).
For GroupWise resources, there is an NDS/system name for a resource, and a corresponding top-level directory. On the windows, the GroupWise resource is shown as [resource_type]directory_name: or numeric_prefix[resource_type]:, depending on GroupWise versions.
DPX supports GroupWise through the Target Service Agents (TSAs) recommended by OpenText for each GroupWise platform. As a general rule, the following TSAs support the functionality described.
TSANDS, when running, allows the treename and Schema resources to be shown.
TSAFS, when running, allows the server volumes to be shown.
TSAFSGW, when running, allows GroupWise Domain and Post Office volumes to be shown. Note that TSAFSGW does not apply to GroupWise 2012 and later.
GroupWise 2014 and GroupWise 2012 SP3 have been qualified for DPX with OES 11 SP2 x64.
The System State feature of Windows can be backed up using DPX.
Active Directory (domain controllers only)
Boot files
COM+ class registration database
Registry
System volume (SYSVOL) (domain controllers only)
Certificate server (Certificate Authority only)
System protected files
Performance counter configuration
IIS metabase
Cluster Quorum
The Backup window displays System State and all its components. You can select System State for backup as if it were an ordinary disk. You cannot select individual components. System State components are always backed up collectively, never individually.
Consider backing up the entire node, which includes the BMR object. You can use BMR to recover the entire node, including System State and its components.
For information about backing up and restoring Active Directory, see Microsoft article
For DPX, User Profile is not a component of the Registry within System State. User Profile is part of the System Table. As such, it can be individually backed up and restored. For more information, see .
The System Table is a collection of the following Windows components, which can be backed up and restored individually:
Event Logs
Removable Storage Manager
User Profiles
Terminal Server
Windows Management Instrumentation Repository
Back up these components using the ordinary backup job definition procedures: clicking the components to back up in the Backup source tree structure.
The following is a sample section of a backup definition window showing both System State and System Table selected in the desktop interface:
The components listed under System State cannot be selected individually, but components listed under System Table can be selected individually. System Table is a DPX concept, unlike System State, which is a Windows concept.
Install the .
Disabling the change journal requires correct permissions. If attempting to disable the change journal displays an error, read the knowledge base article .
This dialog box contains three tabs along the top: Schedule, Exceptions, and Preview.
Select the backup type (base, differential, or incremental) for this job element. See . For File, Image and NDMP, you can also select Migrate.
Enter the number of days you would like the backed-up data for this element of this job to be saved in the Catalog. See in the DPX 4.9.x Reference Guide.
Select the backup type (base, differential, or incremental) for this job element. See . For File, Image and NDMP, you can also select Migrate.
Enter the number of days you would like the backed up data for this element of this job to be saved in the Catalog. See in the DPX 4.9.x Reference Guide.
Select the backup type (base, differential, or incremental) for this job element. For more information, see . For File, Image and NDMP, you can also select Migrate.
Enter the number of days you would like the backed up data for this element of this job to be saved in the Catalog. See in the DPX 4.9.x Reference Guide.
Select the backup type (base, differential, or incremental) for this job element. See . For File, Image and NDMP, you can also select Migrate.
Enter the number of days, months, or years that you would like the backed up data for this element of this job to be saved in the Catalog. See in the DPX 4.9.x Reference Guide.
Select the backup type Base. See .
Enter the number of days you would like the backed-up data for the base backups of this job to be saved in the Catalog. See in the DPX 4.9.x Reference Guide.
Select either Differential or Incremental. See .
Enter the number of days you would like the backed up data for the differential or incremental backups of this job to be saved in the Catalog. See in the DPX 4.9.x Reference Guide.
Click Finish. The Final Job Run Settings dialog box will appear. You may choose to run the job immediately or save it without running. You may also change the retention period (default: 90 days).
Click Finish to save changes made to the job. The Final Job Run Settings dialog box will appear. You may choose to run the job immediately or save it without running. You may also change the retention period (default: 90 days).
The notification is sent to the default e-mail address configured in the section.
Administrator groups (other than the SYSADMIN administrator group) can be assigned to other administrator groups. See .
In the left pane, right-click an assigned resource to display a context menu. The selection is indicated by the selection check box next to the assigned resource icon. Then select Unassign.
Right-click the assigned privilege class to display a context menu. The selection is indicated by the selection check box next to the assigned resource icon. Then select Unassign.
See also. For more details on scheduling options, see .
See also. For more details on archiving options, see and .
See also. To learn more about available options, see .
See also. For more information about block backup job options, see .
In the final Save screen, you must enter the Job Name (max. 16 characters) and specify the Job Folder to store the job in (the default folder is SS_DEFAULT). You may also add a comment to the job definition or set up a schedule (See ).
Click Finish. The Final Job Run Settings dialog box will appear. You may choose to run the job immediately or save it without running. You may also change the retention period (default: 90 days).
See also. For more details on scheduling options, .
See also. For more details on archiving options, see and .
See also. To learn more about other available options, see .
See also. For more information about block backup job options, see .
In the final Save screen, you must enter the Job Name (max. 16 characters) and specify the Job Folder to store the job in (the default folder is SS_DEFAULT). You may also add a comment to the job definition or set up a schedule (See ).
Click Finish. The Final Job Run Settings dialog box will appear. You may choose to run the job immediately or save it without running. You may also change the retention period (default: 90 days).
See also. For more details on scheduling options, see .
See also. For more details on archiving options, see and .
See also. To learn more about other available options, see .
See also. For more information about block backup job options, see .
In the final Save screen, you must enter the Job Name (max. 16 characters) and specify the Job Folder to store the job in (the default folder is SS_DEFAULT). You may also add a comment to the job definition or set up a schedule (See ).
Click Finish. The Final Job Run Settings dialog box will appear. You may choose to run the job immediately or save it without running. You may also change the retention period (default: 90 days).
See also. For more details on scheduling options, see .
See also. For more details on archiving options, see and .
See also. To learn more about other available options, see .
See also. For more information about block backup job options, see .
In the final Save screen, you must enter the Job Name (max. 16 characters) and specify the Job Folder to store the job in (the default folder is SS_DEFAULT). You may also add a comment to the job definition or set up a schedule (See ).
Click Finish. The Final Job Run Settings dialog box will appear. You may choose to run the job immediately or save it without running. You may also change the retention period (default: 90 days).
See also. For more information on defining file backup jobs, see .
The information in the remainder of this chapter assumes the reader has a strong grasp of OpenText GroupWise, including post offices, domains, libraries, and storage areas. A list of files needed for complete backup of these components can be found in the GroupWise Administration Guide available at . The reader is also assumed to have an understanding of GroupWise startup files.
See also. For information about restoring System State, see in the DPX 4.9.x Reference Guide.
Toggle on
Indicates in the Catalog that the tape is stored offsite.
Toggle off
Indicates in the Catalog that the tape is stored onsite.
Toggle on
Tapes in the library with status Offsite can be appended to. The Append Offsite field in the Edit Media Pool dialog must also be set to Yes.
Toggle off
Tapes in the library with status Offsite cannot be appended to.
Toggle on
Indicates in the Catalog that the tape is stored offsite.
Toggle off
Indicates in the Catalog that the tape is stored onsite.
Toggle on
Tapes in the library with status Offsite can be appended to. The Append Offsite field in the Edit Media Pool dialog must also be set to Yes.
Toggle off
Tapes in the library with status Offsite cannot be appended to.
Toggle on
Performs the consistency check.
Toggle off
Default option. Does not perform the consistency check.
Toggle on
SQL Server transaction logs are truncated on the source database server after the backup completes. To find the backed up SQL logs, refer to the message “BACKUP LOG <database-instance> TO DISK...” in the Job Log or to Event 18265 in the Application Event Log.
Toggle off
SQL Server transaction logs are not truncated and will therefore continue to grow on the source database server. To truncate translation logs, run SQL Server maintenance on the source machine.
Yes
Performs the consistency check.
No
Default option. Does not perform the consistency check.
Yes
SQL Server transaction logs are truncated on the source database server after the backup is completed. To find the backed-up SQL logs, refer to the message “BACKUP LOG <database-instance> TO DISK...” in the Job Log or to Event 18265 in the Application Event Log.
No
SQL Server transaction logs are not truncated and will therefore continue to grow on the source database server. To truncate translation logs, run SQL Server maintenance on the source machine.
Toggle on
Indicates in the Catalog that the tape is stored offsite.
Toggle off
Indicates in the Catalog that the tape is stored onsite.
Toggle on
Tapes in the library with status Offsite can be appended to. The Append Offsite field in the Edit Media Pool dialog must also be set to Yes.
Toggle off
Tapes in the library with status Offsite cannot be appended to.
Toggle on
Default option. After the backup is complete, DPX deletes the old Exchange logs.
Toggle off
DPX does not delete any Exchange logs.
Yes
Default option. After the backup is complete, DPX deletes the old Exchange logs.
No
DPX does not delete any Exchange logs.
Toggle on
Indicates in the Catalog that the tape is stored offsite.
Toggle off
Indicates in the Catalog that the tape is stored onsite.
Toggle on
Tapes in the library with status Offsite can be appended to. The Append Offsite field in the Edit Media Pool dialog must also be set to Yes.
Toggle off
Tapes in the library with status Offsite cannot be appended to.
Toggle on
Synchronize the RMAN Catalog after the job completes.
Toggle off
Do not synchronize the RMAN Catalog after the job completes. If you choose this option, the job is not cataloged in RMAN.
Yes
Synchronize the RMAN Catalog after the job completes.
No
Do not synchronize the RMAN Catalog after the job completes. If you choose this option, the job is not cataloged in RMAN.
Domain (DOM)
DPX has the ability to back up the entire GroupWise domain structure. DPX can restore entire domains or individual files to their original location or to an alternate location.
Post Offices (PO)
DPX can back up entire post offices or individual files within a post office. DPX can restore entire post offices or individual files to their original location or to an alternate location.
Documentation Management Services (DMS)
DPX can perform backups at the library level or at the file level. DPX can restore entire libraries or individual files to their original location or to an alternate location.
Binary Large Object (BLB)
Binary large objects (blobs) are the database structures for storing message attachments and DMS documents. Binary large objects may be stored separately from the post office. DPX can perform backups of GroupWise binary large objects and can restore entire binary large objects to their original location or to an alternate location.
GWServer1
GWDom1 and GWDom2
GWServer2
GWPO1
GWServer3
GWPO2
GWServer4
GWPO3
GWServer5
GWPO4
GWServer6
Storage areas for GWPO4 Library2
Catalog is a database that stores all job information, retention information, and information about all backed-up data. The Catalog is on the master server. Catalog protection and maintenance are vital to the success of your Catalogic DPX data protection implementation. The Catalog contains all the information important to managing resources, such as tape media and on-disk storage. The Catalog is also essential for keeping track of available protected data and displaying such data in the management console. All of the Enterprise nodes, tapes, schedules, retentions, user accounts, and backup job definitions are stored in the Catalog. The Catalog backup process is a vital part of protecting and recovering the master server, and the Catalog Condense process is vital to pruning and maintaining the Catalog.
See also. For more information about the Catalog Condense job, see Condense.
The following are strongly recommended best practices for maintaining and protecting the Catalog:
Perform a Catalog backup at least once a day.
Retain a Catalog backup for at least as long as the longest retained archive.
Run a Catalog condense at least once a day.
Schedule Catalog backup and Condense jobs for a time when system activity is relatively low.
Each Enterprise has its own Catalog located on the master server. The Catalog is a set of files stored on the master server within the directory where Catalogic DPX is installed. The important Catalog resources are contained in the following subdirectories:
db
sched
cat
The logs folder is not a vital part of the Catalog but is an important resource to add to your data protection plan. Logs are used by the management console for reviewing the state of jobs that previously ran, and in some cases, logs can be used to help find and recover data that is missing in the Catalog. Job log files are typically trimmed on a 30-day cycle; other diagnostic logging data is trimmed on a 7-day cycle. Logs are not included in a Catalog backup, and the Catalogic DPX installation directory is usually excluded from file-level backups. Therefore, it is strongly recommended to do one of the following to preserve the logs: set up e-mail job notifications, periodically copy the job logs to an alternate location, or protect the job logs with a master server Block backup.
Attention! Hosting the master server installation, including the Catalog, on a CIFS or NFS share is not recommended. It is also not recommended to use soft links (Linux) or junction points (Windows) to redirect access to the core master server database files which include the db, cat, and sched folders. Network outage or latency can disrupt master server functionality. Hosting the Catalog data on CIFS/NFS and attempting to use Catalog backup with the option Skip NFS Volumes set to No might be successful, but that operation is strongly discouraged and is not supported. Note that the Skip NFS Volumes option is set to Yes by default.
Whenever you perform a backup or make a configuration change to your Enterprise, the Catalog is updated. In particular, a backup job updates the Catalog with information identifying the location on tape of every file backed up. This information is crucial during restores.
Catalogic DPX provides a comprehensive backup and recovery solution for SAP HANA environments, ensuring the protection and availability of critical database information. By supporting file-level backups through the Backint interface, DPX facilitates efficient and reliable safeguarding of SAP HANA data. With DPX, you can utilize file-level backup and restore capabilities, including support for SAP HANA multitenant databases and cluster configurations.
Before initiating a SAP HANA backup with Catalogic DPX, it is crucial to ensure the following prerequisites are met:
The DPX client must be installed on the server hosting the SAP HANA database.
The SAP HANA database must be properly registered within the DPX environment.
Adequate backup storage should be allocated and accessible for storing the SAP HANA backups.
See also. For detailed information on supported Oracle Database versions and operating systems, see DPX 4.10 Compatibility Matrix.
DPX backs up and restores data from NAS appliances that use NDMP, an industry-standard protocol co-developed by NetApp. NDMP enables the communication of backup and restore commands between NDMP-compliant software, such as DPX and NDMP appliances.
You do not need to know much about the inner workings of NDMP because DPX handles all the details. Basically, NDMP creates data streams by reading data from either tape or disk. These data streams are then written to either tape or disk. Most backup and restore functions are implemented from within the management console.
NDMP is a control protocol, not a data format. Hardware vendors supporting NDMP interfaces write and read data in proprietary formats specific to their platform. For this reason, DPX cannot restore data between different vendor NDMP implementations. To restore data through NDMP, the destination NDMP appliance must be a device compatible with the data source device, typically from the same vendor.
Note that NDMP is not an appropriate method to back up the Catalog. To protect the Catalog, see Catalog Backup.
Beginning with DPX release 4.5.2, NDMP backup and recoveries to Write-Once-Read-Many (WORM) media are supported. To enable WORM support for NDMP backup, you must add the option -worm
to SSNDMPC on the NDMP proxy server.
Catalogic DPX supports both generic and NetApp-specific NDMP:
Note. The term generic NDMP in DPX documentation refers to core NDMP capabilities shared by non-NetApp and NetApp implementations.
DPX includes generic NDMP control logic, which supports a wide variety of vendor devices. For details, see the DPX 4.10 Compatibility Matrix.
For data protection with generic NDMP, see the following topics:
Backup and Restore with Generic NDMP in the DPX 4.9.x Reference Guide;
Restoring with Generic NDMP in the DPX 4.9.x Reference Guide.
DPX includes specialized logic for NetApp Data ONTAP to interface with extended NDMP capabilities and to support DPX block-level client backup to tape. For NetApp-specific information, see the following topics:
DPX with NetApp Data ONTAP 7-Mode in the DPX 4.9.x Reference Guide;
DPX with NetApp Clustered Data ONTAP in the DPX 4.9.x Reference Guide;
NetApp NDMP Hardware Encryption in the DPX 4.9.x Reference Guide.
Note the following considerations for NDMP backups:
If the status of a disk object is offline, you cannot browse the disk in the management console or select it for backup.
The software operating on your NDMP storage system determines the maximum number of NDMP incremental backups of a specific path. For example, NetApp storage systems running supported versions of Data ONTAP support infinite incremental backups. Other appliances support eight true incremental backups of a given path; thereafter, incremental backups behave like DPX differential backups until the next base backup of that path. Consult your NDMP device vendor documentation for specific information on NDMP backup limitations.
File selection is only supported for NDMP nodes that are running NetApp Clustered Data ONTAP 8.3 or later. For other NDMP node types, you cannot select a descendant resource for exclusion in the source pane of the NDMP backup window.
Note. This capability requires that the NetApp cluster have vServer aware NDMP mode enabled and the following NetApp options also enabled:
On the source pane, a node expands to the directory/folder level. Underlying files may display but cannot be selected. For NDMP earlier than version 4, the level of expansion is more limited.
For NDMP appliances that do not support browsing beyond the volume level, such as nodes running NetApp Clustered Data ONTAP 8.2 or earlier, you can right-click on the volume name and use the Specify New Path option to manually enter the path to back up.
If you select multiple subdirectories as source objects, DPX backs up the entire common ancestor.
The NDMP device vendor may limit or restrict backup and recovery of certain files and folders. These limitations are inherently vendor-specific. Consult your NDMP vendor documentation for access limitations imposed on storage system objects.
NDMP backup cannot be used to directly protect the master server Catalog. The Catalog restore function does not support restoring data from NDMP archives.
Catalog DPX offers several job options for Catalog backup. All of them are available from both interfaces but the access thereto may differ. See details for each interface below.
In the web interface, backup job options are defined in the Advanced Options section. To access them, do the following:
Go to Job Manager in the sidebar.
Open an already existing backup job. Or create a new Catalog backup job, by clicking the New Backup Job button in the upper right corner and then selecting Backup Type Catalog.
Go to the Advanced Options section at the bottom (scroll down if necessary) and expand it. Click any of the following section headers to expand it. Each field and the available choices are explained below.
Controls the data verification technique for writing data to a media volume. The higher the verification level, the greater the safety and the longer a backup takes. Each verification level builds upon the preceding level. For example, level 3 performs level 1 and level 2 verification as well. Select one of the following options:
No Verification
Writes data to the media volume without verification. This is the fastest option and relies on the tape device for data verification.
Level 1
Reads the tape to ensure that it is readable.
Level 2
Reads the tape and ensures that the SIDF headers are present and contain the correct information.
Level 3 Ensures that the checksum of each file on the tape matches the one contained in the SIDF header for that file. This verification is only performed if the Checksum Files toggle is set to Enabled in the Job Destination Options section. The tape and SIDF headers are also read and verified (levels 1 and 2).
Compresses data prior to network transmission.
Toggle on to compress data prior to transmission at the node being backed up. This setting is recommended if there is processing power available on the client nodes and network bandwidth is limited. This setting minimizes the impact of data transmission on data lines.
Or, toggle off to disable the data compression.
Determines expected behavior when encountering an NFS (network file system) volume during a backup operation. NFS volumes are remotely mounted volumes owned by another node. This option also controls the backup behavior of drives that are mapped to the Microsoft Windows node (CIFS mount point).
Toggle on
Back up NFS volumes and drives that are mapped to the Microsoft Windows nodes.
Toggle off
Do not back up NFS volumes or drives that are mapped to the Microsoft Windows nodes.
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.
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.
If you are not using an open file manager, this option tells Catalogic DPX whether to catalog open files encountered on UNIX systems. On UNIX nodes, Catalogic DPX backs up the file and then checks to determine if it has been modified while the backup transpired. If it has, the file is considered open. Cataloging open files is not generally recommended.
Toggle on
Catalog the backed-up file if it detects that the file has been modified during the backup process and the number specified in the Open File Retries field has been reached. Catalogic DPX catalogs its last attempt to back up an open file if it finds the file is still open.
Toggle off
Do not save the backed-up file if DPX detects that the file has been modified during the backup process and the number specified in the Open File Retries field has been reached.
Note. Cataloging a file that has been modified during the backup can compromise the integrity of the file when that file is restored.
Enter the name of a script to execute prior to the actual job.
Basic usage: <script>@<node_name> <argument_list>
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
The action to be taken if the Job fails to successfully complete:
Run Post-Job Script
Skip Post-Job Script
Enter the name of a script to execute after the actual job.
Basic usage: <script>@<node_name> <argument_list>
See also. For detailed information about pre- and post-job scripts, including all valid definitions, see Pre-Scripts and Post-Scripts.
Determines whether or not to accept a tape with data on it.
Use a new tape
Requires media with status New or Empty from the selected media pool. Media with status New will only be used if the option Unlabeled Tape Usage (defined below) is set to Allow unlabeled tapes and label them.
Attempt to append data to available tape
Accepts a backup tape from the selected media pool with data on it (status Appendable) and writes to the unused portion of the tape. The appended data can have a retention period that differs from the data preceding it on the tape.
Determines expected behavior when an unlabeled tape is found in the tape drive.
Label unlabeled tapes
Label the unlabeled tape. This saves the step of labeling a tape beforehand.
Reject unlabeled tapes
Do not use the unlabeled tape.
Determines whether a backup tape is stored offsite. DPX adds the Offsite status to the tape.
Toggle on
Indicates in the Catalog that the tape is stored offsite.
Toggle off
Indicates in the Catalog that the tape is stored onsite.
Determines if a backup tape with status Offsite can be appended to.
Toggle on
Tapes in the library with status Offsite can be appended to. The Append Offsite field in the Edit Media Pool dialog must also be set to Yes.
Toggle off
Tapes in the library with status Offsite cannot be appended to.
The Offsite status of a tape can be viewed through the Operate Tape Library function, the Configure Media function, or in the media volume report. Note that when you use the Operate Tape Library function to import a tape with status Offsite, the Offsite status is cleared and the tape becomes available for use.
Enables the twinning option. The twinning option creates two sets of backups simultaneously, eliminating the need for separate tape duplication for off-site vaulting.
Toggle on
Backs up data simultaneously to two tapes.
Toggle off
Disables twinning.
Indicates in the Catalog the location of twinned tapes, if twinning is on.
Toggle on
Indicates that the twinned tape (second tape) is stored offsite.
Toggle off
Indicates in the Catalog that the tape is stored onsite.
Determines what to do with the tape when the backup job is complete.
Rewind Tapes
For a standalone tape device, this option rewinds the tape and leaves it in the drive. For a tape library tape drive, this option rewinds, unloads, and returns the tape to its slot.
Unload Tapes
For a standalone tape device, this option rewinds the tape and ejects it from the drive. For a tape library tape drive, this option rewinds, unloads, and returns the tape to its slot.
For DiskDirectory, this option causes empty volsers to be used before new volsers.
Leave Tapes
In the case of standalone tape drives, the tape remains wound to the point where the job ended and stays in the drive. However, for tape library drives, the tape is always attempted to be returned to its slot after the backup operation is completed. The next job attempts to use the tape in the drive instead of mounting a new tape. In the case of standalone drive, if the currently mounted tape is unacceptable (for example, if the next backup requires a tape from a different media pool), the operator is prompted to mount another tape. In the case of a tape library, if the tape in the drive is rejected for any reason, it unloads the tape, returns it to its slot, and proceed to select another tape.
Export Tapes
Automates the export of tapes to an I/O port, eliminating manual processes and preparing tapes for their next destination. In environments with physical tape libraries, the availability of an empty I/O port is essential. The system will alert and will return an error code if no port is available, prompting user action. A rescan of ports is recommended to ensure availability.
Attention! In some cases, a backup job may fail if the Export option is used for the first job following a system restart, especially if the initial job is a File backup with the Export setting.
Generates a checksum value for each file that is backed up. The checksum value is written to the SIDF header.
Toggle on
Generates a checksum value for backed-up files.
Toggle off
Indicates the desired performance option. This option helps control the number of tasks running concurrently within a backup job. The appropriateness of each selection depends upon the backup you are running.
Standard
Backs up UNIX nodes and Windows disks concurrently. Use this option when memory on the master or device server(s) is limited or when you will not derive benefit from any of the other choices.
Split Job by Partitions
Backs up UNIX partitions (mount points) and Windows disks concurrently. Use this option when backing up multiple partitions and there are no device or memory limitations.
Split Job by Files
Use this option when backing up single partitions (disks or volumes) that contain many files. This selection will create a task for every available tape drive in this job. Note. This option is not supported for Linux OES.
Split Large Files/Partitions
Splits files that exceed the Split Size threshold. Each part of the split file is backed up concurrently. Use this with large raw partition backups or when you are backing up very large files and the number of files or partitions is less than the number of devices.
Sets the maximum number of tasks that can have files backed up to a single device. The default is 1.
Note. Increasing concurrency to values >1 during backups slows restore performance and requires more memory on the master server during restore.
Limits the number of storage devices valid for use with this job. Use this option if you want to stop DPX from using all the drives in the selected device cluster so that some drives will be available for other purposes.
Holds tasks within a job until the number of drives specified are available for each task to use.
The maximum number to check a tape in a standalone tape device.
The number of seconds to wait between checking the availability of a tape in a standalone tape device.
Controls tape drive usage.
Toggle on
The tape drive is released after the current task with a tape drive finishes so that the next job can use the same tape drive before completing the entire job.
Toggle off
The tape drive is not made available for the next job until the entire job is completed.
Encrypt data while transmitting it through networks to enhance security. Typically, the encrypted data transfer can lower the data transfer speed.
Toggle on
Enables encrypted data transfer.
Toggle off
Data transfer without encryption.
The Notification Options section controls who receives messages pertaining to the current job when it is run.
Important. The Catalog backup notification is essential. It enables you to quickly locate your latest Catalog backup. The information you need is contained in the backup report generated when you perform a backup.
The easiest way to ensure you have a copy of the Catalog backup report is to have it e-mailed automatically when the Catalog backup completes.
The Notification options consist of a radio button selection with two possible options.
If the Custom e-mail notifications option is selected, four additional entry fields appear:
The subject of your message. The subject line usually contains a combination of straight text and variable elements. Variables, which must begin with %
, are replaced with actual corresponding values. If you enclose variables in double quotation marks, those variables are treated as literal values. You can embed the following variables:
%JOBNAME
%JOBID
%JOBTYPE
%RC
Use %RC to include the return code in the message for this run of the job, when applicable.
The email address of the primary recipient of your message. Only one “To” address is permitted.
Carbon Copy. The email address(es) of the secondary recipient(s) of your message. Use a semicolon to delimit multiple email addresses.
Blind Carbon Copy. The email address(es) of the secondary recipient(s) not identified to other recipients. Use a semi-colon to delimit multiple email addresses.
Note. Note that the following characters are invalid in all fields: <
>
;
and '
.
Note. DPX emailing must be enabled when you first configure your Enterprise. At that time, you supply general system information, including SMTP Host Name and SMTP Port. See Configuring Enterprise Information.
To access the job source options for Catalog backup, do the following:
Go to the Catalog tab.
In the Catalog Operations section, select Backup.
Open an already existing backup job by clicking Open Backup Job in the Job Tasks section. Or go directly to step 4 to set source options for the new job you will be defining directly afterward.
Go to the Other Tasks section in the task panel (scroll down if necessary) and select one of the following to open the corresponding options dialog.
The Set Job Source Options dialog allows you to set options related to the backup source. This section provides an explanation of each field in the dialog and the available choices.
Verify Backup
Controls the data verification technique for writing data to a media volume. The higher the verification level, the greater the safety and the longer a backup takes. Each verification level builds upon the preceding level. For example, level 3 performs level 1 and level 2 verification as well. Select one of the following options:
No Verification
Writes data to the media volume without verification. This is the fastest option and relies on the tape device for data verification.
Level 1
Reads the tape to ensure that it is readable.
Level 2
Reads the tape and ensures that the SIDF headers are present and contain the correct information.
Level 3 Ensures that the checksum of each file on the tape matches the one contained in the SIDF header for that file. This verification is only performed if the Checksum Files feature is set to Yes in Set Job Destination Options. The tape and SIDF headers are also read and verified (levels 1 and 2).
Data Compression
Compresses data prior to network transmission.
Select Yes to compress data prior to transmission at the node being backed up. This setting is recommended if there is processing power available on the client nodes and network bandwidth is limited. This setting minimizes the impact of data transmission on data lines.
Or, select No to disable the data compression.
Network Encryption
Encrypt data while transmitting it through networks to enhance security. Typically, the encrypted data transfer can lower the data transfer speed.
Yes
Enables encrypted data transfer.
No
Data transfer without encryption.
Skip NFS Volumes
Determines expected behavior when encountering an NFS (network file system) volume during a backup operation. NFS volumes are remotely mounted volumes owned by another node. This option also controls the backup behavior of drives that are mapped to the Microsoft Windows node (CIFS mount point).
Select No to back up NFS volumes and drives that are mapped to the Microsoft Windows nodes.
Or, select Yes so as not to back up NFS volumes or drives that are mapped to the Microsoft Windows nodes.
Open File Retries
If you are not using an open file manager, this option controls how many times DPX attempts to back up an open file. If you enter zero, DPX skips open files. If you enter a number, DPX waits until all the files on the node have been backed up then tries again to save the open files. DPX attempts this the number of times you enter here.
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.
Catalog Open Files
If you are not using an open file manager, this option tells Catalogic DPX whether to catalog open files encountered on UNIX systems. On UNIX nodes, Catalogic DPX backs up the file and then checks to determine if it has been modified while the backup transpired. If it has, the file is considered open. Cataloging open files is not generally recommended.
Select No so as not to save the backed-up file if DPX detects that the file has been modified during the backup process and the number specified in the Open File Retries field has been reached.
Or, select Yes to catalog the backed-up file if it detects that the file has been modified during the backup process and the number specified in the Open File Retries field has been reached. Catalogic DPX catalogs its last attempt to back up an open file if it finds the file is still open. Note that cataloging a file that has been modified during the backup can compromise the integrity of the file when that file is restored.
Note. For Catalog Backup, do not configure this option but keep the default settings.
Pre-Job Script
Enter the name of a script to execute before 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 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 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>
See also. For detailed information about pre- and post-job scripts, including all valid definitions, see Pre-Scripts and Post-Scripts.
To access the job destination options:
Open the Set Job Destination Options dialog box by doing one of the following:
Right-click the Enterprise name or icon to display a context menu. Then select Set Destination Options.
From the menu bar, select Backup > Set Destination Options [Ctrl + E].
Go to the Other Tasks section in the task panel (scroll down if necessary) and select Set Destination Options.
The Set Job Destination Options dialog box appears.
Complete the Set Job Destination Options dialog box as needed (see descriptions below) and click OK.
Backup Type
This drop-down includes only one item, which is Base Backup, as incremental nor differential backups are not possible for Catalog backup.
Tape Usage
Determines whether or not to accept a tape with data on it.
Use a new tape
Requires media with status New or Empty from the selected media pool. Media with status New will only be used if the option Unlabeled Tape Usage (defined below) is set to Allow unlabeled tapes and label them.
Attempt to append data to available tape
Accepts a backup tape from the selected media pool with data on it (status Appendable) and writes to the unused portion of the tape. The appended data can have a retention period that differs from the data preceding it on the tape.
Unlabeled Tape Usage
Determines expected behavior when an unlabeled tape is found in the tape drive.
Label unlabeled tapes
Label the unlabeled tape. This saves the step of labeling a tape beforehand.
Reject unlabeled tapes
Do not use the unlabeled tape.
Mark Original Offsite
Determines whether a backup tape is stored offsite. DPX adds the Offsite status to the tape.
Yes
Indicates in the Catalog that the tape is stored offsite.
No
Indicates in the Catalog that the tape is stored onsite.
Append Offsite
Determines if a backup tape with status Offsite can be appended to.
Yes
Tapes in the library with status Offsite can be appended to. The Append Offsite field in the Edit Media Pool dialog must also be set to Yes.
No
Tapes in the library with status Offsite cannot be appended to.
The Offsite status of a tape can be viewed through the Operate Tape Library function, the Configure Media function, or in the media volume report. Note that when you use the Operate Tape Library function to import a tape with status Offsite, the Offsite status is cleared and the tape becomes available for use.
Twin Tapes
Enables the twinning option. The twinning option creates two sets of backups simultaneously, eliminating the need for separate tape duplication for off-site vaulting.
Yes
Backs up data simultaneously to two tapes.
No
Disables twinning.
Mark Twin Offsite
Indicates in the Catalog the location of twinned tapes, if twinning is on.
Yes
Indicates that the twinned tape (second tape) is stored offsite.
No
Indicates in the Catalog that the tape is stored onsite.
Tape EOJ Usage
Determines what to do with the tape when the backup job is complete.
Rewind Tapes
For a standalone tape device, this option rewinds the tape and leaves it in the drive. For a tape library tape drive, this option rewinds, unloads, and returns the tape to its slot.
Unload Tapes
For a standalone tape device, this option rewinds the tape and ejects it from the drive. For a tape library tape drive, this option rewinds, unloads, and returns the tape to its slot.
For DiskDirectory, this option causes empty volsers to be used before new volsers.
Leave Tapes
In the case of standalone tape drives, the tape remains wound to the point where the job ended and stays in the drive. However, for tape library drives, the tape is always attempted to be returned to its slot after the backup operation is completed. The next job attempts to use the tape in the drive instead of mounting a new tape. In the case of standalone drive, if the currently mounted tape is unacceptable (for example, if the next backup requires a tape from a different media pool), the operator is prompted to mount another tape. In the case of a tape library, if the tape in the drive is rejected for any reason, it unloads the tape, returns it to its slot, and proceed to select another tape.
Export Tapes
Automates the export of tapes to an I/O port, eliminating manual processes and preparing tapes for their next destination. In environments with physical tape libraries, the availability of an empty I/O port is essential. The system will alert and will return an error code if no port is available, prompting user action. A rescan of ports is recommended to ensure availability.
Attention! In some cases, a backup job may fail if the Export option is used for the first job following a system restart, especially if the initial job is a File backup with the Export setting.
Checksum Files
Generates a checksum value for each file that is backed up. The checksum value is written to the SIDF header.
Yes
Generates a checksum value for backed-up files.
No
Performance Options
Indicates the desired performance option. This option helps control the number of tasks running concurrently within a backup job. The appropriateness of each selection depends upon the backup you are running.
Standard
Backs up UNIX nodes and Windows disks concurrently. Use this option when memory on the master or device server(s) is limited or when you will not derive benefit from any of the other choices.
Split Job by Partitions
Backs up UNIX partitions (mount points) and Windows disks concurrently. Use this option when backing up multiple partitions and there are no device or memory limitations.
Split Job by Files
Use this option when backing up single partitions (disks or volumes) that contain many files. This selection will create a task for every available tape drive in this job. Note. This option is not supported for Linux OES.
Split Large Files/Partitions
Splits files that exceed the Split Size threshold. Each part of the split file is backed up concurrently. Use this with large raw partition backups or when you are backing up very large files and the number of files or partitions is less than the number of devices.
Split Size (MB)
Sets a threshold for file splitting. File splitting is the ability to split a file into smaller pieces and back up those pieces simultaneously. File splitting is designed for large files or raw partitions. If Split Large Files/Partitions is selected in Performance Options and the file exceeds the size entered here, the file splits automatically. If the file does not exceed the size entered here, the file does not split. Keep the threshold large enough (2 GB) so that file splitting is reserved for truly large files.
Note. This option applies only to UNIX systems. It is not available for Windows.
Concurrency Per Device (Nodes)
Sets the maximum number of tasks that can have files backed up to a single device. The default is 1.
Note. Increasing concurrency to values >1 during backups slows restore performance and requires more memory on the master server during restore.
Max Devices (Devices)
Limits the number of storage devices valid for use with this job. Use this option if you want to stop DPX from using all the drives in the selected device cluster so that some drives will be available for other purposes.
Min Devices (Devices)
Holds tasks within a job until the number of drives specified are available for each task to use.
Tape Mount Attempts
The maximum number to check a tape in a standalone tape device.
Mount Interval (Seconds)
The number of seconds to wait between checking the availability of a tape in a standalone tape device.
Early Device Release
Controls tape drive usage.
Yes
The tape drive is released after the current task with a tape drive finishes so that the next job can use the same tape drive before completing the entire job.
No
The tape drive is not made available for the next job until the entire job is completed.
The Set Job Encryption Options dialog controls the encryption of the backup data.
To change the encryption setting:
Open the Set Job Encryption Options dialog box by doing one of the following:
Right-click the Enterprise name or icon to display a context menu. Then select Set Encryption Options.
From the menu bar, select Backup > Set Encryption Options [Ctrl + Y].
On the task panel, click Set Encryption Options.
The Set Job Encryption Options dialog box appears.
Complete the Set Job Encryption Options dialog box as needed and click OK.
Network Encryption
Encrypt data while transmitting it through networks to enhance security. Typically, the encrypted data transfer can lower the data transfer speed.
The Set Job Notification Options dialog controls who receives messages pertaining to the current job when it is run.
To set backup job notification options:
Open the Set Job Notification Options dialog box by doing one of the following:
Right-click the Enterprise name or icon to display a context menu. Then select Set Notification Options.
From the menu bar, select Backup > Set Notification Options [Ctrl + T].
On the task panel, click Set Notification Options.
The Set Job Notification Options dialog box appears.
Complete the Set Job Notification Options dialog box as needed and click OK.
Mail information
Two sets of mail information can be specified:
Output Email
Specifies that the subsequent fields apply to reports that are sent when a job has completed.
Operator Email
Specifies that the subsequent fields apply to mount requests, error messages, and informational messages that are sent during a job.
To
The email address of the primary recipient of your message. Only one “To” address is permitted.
Cc
Carbon Copy. The email address(es) of the secondary recipient(s) of your message. Use a semicolon to delimit multiple email addresses.
Bcc
Blind Carbon Copy. The email address(es) of the secondary recipient(s) not identified to other recipients. Use a semi-colon to delimit multiple email addresses.
Subject
The subject of your message. The subject line usually contains a combination of straight text and variable elements. Variables, which must begin with %
, are replaced with actual corresponding values. If you enclose variables in double quotation marks, those variables are treated as literal values. You can embed the following variables:
%JOBNAME
%JOBID
%JOBTYPE
%RC
Use %RC to include the return code in the message for this run of the job, when applicable.
No Notification
Selecting this check box option temporarily disables notifications for the job without deleting the currently defined job notification data.
Note. Note that the following characters are invalid in all fields: <
>
;
and '
.
Note. DPX emailing must be enabled when you first configure your Enterprise. At that time, you supply general system information, including SMTP Host Name and SMTP Port. See Editing an Enterprise Configuration.
In the web interface, block backups are defined in the Job Manager section. In the desktop interface, block backups are implemented through a backup wizard. This also applies to BMR block backups.
To create a BMR Backup job, follow the instructions below.
In the main web interface view, go to Job Manager in the sidebar. Then select the New Backup Job button in the upper right corner.
Specify the Job Name (this field may contain up to 16 characters). Add an optional brief description (this field may contain up to 48 characters).
Select Job Type – Block and the Job Folder to store the job in (see the Job Manager section for more information). By default, all jobs are stored in the SS_DEFAULT job folder.
Click Add Source in the SOURCES pane to specify which volumes you want to back up. The Source selection dialog will appear. Select the desired volumes and click Select.
Click Set Destination in the DESTINATION pane to choose the destination for the backup.
You may also add a schedule in the SCHEDULES pane for the backup to be run on a regular basis. See Scheduling a Block Backup Job for detailed instructions.
If you want to add an Archive backup to your backup job, click Add Archive in the ARCHIVE pane. The Add Archive dialog will appear.
Select the Archive destination (see Devices and Media for more details).
Determines whether a backup tape is stored offsite. DPX adds the Offsite status to the tape.
Toggle on
Indicates in the Catalog that the tape is stored offsite.
Toggle off
Indicates in the Catalog that the tape is stored onsite.
Determines if a backup tape with status Offsite can be appended to.
Toggle on
Tapes in the library with status Offsite can be appended to. The Append Offsite field in the Edit Media Pool dialog must also be set to Yes.
Toggle off
Tapes in the library with status Offsite cannot be appended to.
The Offsite status of a tape can be viewed through the Operate Tape Library function, the Configure Media function, or in the media volume report. Note that when you use the Operate Tape Library function to import a tape with status Offsite, the Offsite status is cleared and the tape becomes available for use.
Limits the number of storage devices valid for use with this job. Use this option if you want to stop DPX from using all the drives in the selected device cluster so that some drives will be available for other purposes.
This is an alternate location where backup data resides. This alternate location could be a replica of the original data using NetApp SnapMirror, copied through Data ONTAP commands, or restored from a tape backup. Data can be restored from an alternate secondary data source directly from the management console.
If the toggle is on, two additional drop-down selection fields are shown, requiring to specify the Alternate Secondary Node and Volume.
Add schedules for Base, Incremental and Differential Archive backups according to your requirements.
Click Add to save the current schedule.
Multiple schedules may be added using the Add Another Schedule button which will be displayed upon adding the first schedule.
Specify Advanced Options. For details, see Job Options for Block Backup.
Click Save. The Run Job prompt pane will be shown, where you may determine the retention period (default: 90 days) and choose whether to run the job immediately. Either way, the job will be available in the Job Manager section.
In the desktop interface, block backups are defined and edited exclusively through the block backup wizard.
Go to the Backup tab.
From the Backup Modes section in the side panel, choose Block.
In the Job Tasks section of the task panel, find and click Block Backup Wizard.
The Block Backup Wizard window will appear:
By default, the creator allows you to select from the drop-down list and edit an already existing job. If you want to create a new block backup job, click the New Job button in the lower right corner.
In the Select Source screen, select BMR. Click Next.
In the Select Destination screen, choose the destination for the backup job. Click Next.
In the Job Options screen, define the job options for the backup job. See details below.
See also. For more information about block backup job options, see Job Options for Block Backup.
In the final Save screen, you must enter the Job Name (max. 16 characters) and specify the Job Folder to store the job in (the default folder is SS_DEFAULT). You may also add a comment to the job definition or set up a schedule (See Scheduling a Block Backup Job).
Note. If you select Cancel, the job will be saved anyway, it will not be run and the retention period will remain 90 days.
Note.
To edit a BMR backup job, follow the procedure described in Editing a Block Backup Job.
To schedule a BMR backup job, follow the procedure described in Scheduling a Block Backup Job.
Note. Creating a Catalog backup requires that there is at least one device and at least one media added to your DPX.
Creating a dedicated media pool for Catalog backups enables you to quickly locate your latest Catalog backup. It also makes it easy to keep a set of tapes for Catalog backup with a shorter retention period than your normal backup tapes.
See Adding a Device and Adding a Media Pool.
In the main web interface view, go to Job Manager in the sidebar. Then select the New Backup Job button in the upper right corner.
Specify the Job Name (this field may contain up to 16 characters). Add an optional, brief description (this field may contain up to 48 characters).
Select Job Type – Catalog and the Job Folder to store the job in (see the Job Manager section for more information). By default, all jobs are stored in the SS_DEFAULT job folder.
The SOURCES pane shows Catalog as the source. This setting cannot be edited, as this type of job is used to back up the Catalog only.
In the DESTINATION pane, click Set Destination to choose the destination for the backup.
Note. It is recommended to use a dedicated device cluster and media pool so that you can quickly locate your latest Catalog Backup.
You may also add a schedule in the SCHEDULES pane for the backup to be run on a regular basis. See Scheduling a Catalog Backup Job.
Note. It is strongly recommended to create a regular schedule for Catalog Backup, as the Catalog is vital for managing any backups you might need to restore.
Set Advanced Options as desired. For details, see Job Options for Catalog Backup Job.
Important. When you define a Catalog backup, ensure you go to Catalog Backup Job Options and select the option to e-mail the backup report to a user or group accessible even when the master server is down. It is advisable to send a copy offsite. For details, see Catalog Backup Notification Options.
Click Save. The Run Job prompt will be shown, where you may determine the retention period (default: 90 days) and choose whether to run the job immediately. Either way, the job will be available in the Job Manager section.
In the main desktop interface window, go to the Catalog tab, and from the Catalog Operations section in the task panel, choose Backup. Catalog backup is all about backing up the Catalog, so the source selection is disabled for this type of job.
Note. For Catalog backup, the source is already defined, therefore the SOURCES pane is disabled for selection. For more information, see Catalog Backup.
In the DESTINATIONS pane, select a device and a media pool. Expand the tree as necessary.
Note. Before running a backup job, you need to save it. Once saved, a previously defined job can be modified, run, or deleted. If you try to leave the job creation view without saving the changes, you will be prompted to either save or discard changes before leaving.
If you select Define New Backup Job, all unsaved changes will be lost.
Set advanced options as desired, selecting appropriate items in the Other Tasks section of the side panel. Scroll down if necessary.
See also. For more information about file backup job options, see Job Options for Catalog Backup.
Save the job by doing one of the following:
Select File > Save Job
Select Save Backup Job in the Job Tasks section of the side panel
Press [Ctrl + S]
The Save Job dialog will appear.
Restrictions. The new job name must be unique throughout the entire DPX, regardless of the folder the job is stored in.
Click OK. The job is now saved.
Click Save Backup Job in the Job Tasks section. You can now run the Catalog Backup job.
When running a Catalog Backup job, you will be prompted to specify the retention period for the backup. The default value is 90 days.
Editing a Catalog backup job allows you to change some parameters of an already defined job (Save), or to create a new job based on the definition of an existing one (Save as…). The procedure is similar to creating a backup job from scratch.
In the main web interface view, go to Job Manager in the sidebar. Then select the catalog backup job you want to edit from the list.
Tip. You can control this view by ordering items by Job Name, Type, Created Date, Description, or Job Folder. Just click the column header to enable ascending/descending ordering.
Note also the Items per page value and navigation buttons at the bottom of the list, which can be useful when managing the display of many jobs.
Make all required changes to the job definition. The workflow is the same as in Creating a Catalog Backup Job.
Save the job by clicking Save (the changes will be saved under the current job’s name, overwriting previous settings), or Save As (you will be prompted to provide a new name for the job).
Restrictions. The new job name must be unique throughout the entire DPX, regardless of the folder the job is stored in.
In the main desktop interface window, go to the Catalog tab, and from the Catalog Operations section in the task panel, choose Backup.
Under Job Tasks in the side panel, select Open Backup Job. The Open Job dialog will appear.
Note. The Job List includes all Catalog backup job names, regardless of the folders they are stored in. The Folder field indicates the actual folder where the selected job is stored.
Select the job you want to edit from the list. Click OK. The Open Job dialog will close and the settings of the selected job will be loaded to the main window view.
Proceed with editing the job. See Creating a Catalog Backup Job for more details.
When finished, save the job by doing one of the following:
Select File > Save Job
Select Save Backup Job in the Job Tasks section of the side panel
Press [Ctrl + S]
The Save Job dialog will appear.
Restrictions. The new job name must be unique throughout the entire DPX, regardless of the folder the job is stored in.
Click OK. If you choose the same name, you will be prompted to confirm the replacement of an already existing job. Select Yes to change the job definition, or No to return to the previous step and specify another name for the job.
To access the job destination options, do the following:
Go to the Backup tab.
In the Backup Modes section, select NDMP.
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.
Go to the Other Tasks section in the task panel (scroll down if necessary) and select Set Destination Options. The Set Job Destination Options dialog will appear.
The Set Job Destination Options dialog allows you to set options related to backup destinations. This section provides an explanation of each field in the dialog and the available choices.
Note. All three tabs, i.e. Base, Incremental and Differential, feature exactly the same options, only referring to different backup types.
Determines whether or not to accept a tape with data on it.
Use a new tape
Requires media with status New or Empty from the selected media pool. Media with status New will only be used if the option Unlabeled Tape Usage (defined below) is set to Allow unlabeled tapes and label them.
Attempt to append data to available tape
Accepts a backup tape from the selected media pool with data on it (status Appendable) and writes to the unused portion of the tape. The appended data can have a retention period that differs from the data preceding it on the tape.
Determines expected behavior when an unlabeled tape is found in the tape drive.
Label unlabeled tapes
Label the unlabeled tape. This saves the step of labeling a tape beforehand.
Reject unlabeled tapes
Do not use the unlabeled tape.
Determines whether a backup tape is stored offsite. DPX adds the Offsite status to the tape.
Yes
Indicates in the Catalog that the tape is stored offsite.
No
Indicates in the Catalog that the tape is stored onsite.
Determines if a backup tape with status Offsite can be appended to.
Yes
Tapes in the library with status Offsite can be appended to. The Append Offsite field in the Edit Media Pool dialog must also be set to Yes.
No
Tapes in the library with status Offsite cannot be appended to.
The Offsite status of a tape can be viewed through the Operate Tape Library function, the Configure Media function, or in the media volume report. Note that when you use the Operate Tape Library function to import a tape with status Offsite, the Offsite status is cleared and the tape becomes available for use.
Determines what to do with the tape when the backup job is complete.
Rewind Tapes
For a standalone tape device, this option rewinds the tape and leaves it in the drive. For a tape library tape drive, this option rewinds, unloads, and returns the tape to its slot.
Unload Tapes
For a standalone tape device, this option rewinds the tape and ejects it from the drive. For a tape library tape drive, this option rewinds, unloads, and returns the tape to its slot.
For DiskDirectory, this option causes empty volsers to be used before new volsers.
Leave Tapes
In the case of standalone tape drives, the tape remains wound to the point where the job ended and stays in the drive. However, for tape library drives, the tape is always attempted to be returned to its slot after the backup operation is completed. The next job attempts to use the tape in the drive instead of mounting a new tape. In the case of standalone drive, if the currently mounted tape is unacceptable (for example, if the next backup requires a tape from a different media pool), the operator is prompted to mount another tape. In the case of a tape library, if the tape in the drive is rejected for any reason, it unloads the tape, returns it to its slot, and proceed to select another tape.
Export Tapes
Automates the export of tapes to an I/O port, eliminating manual processes and preparing tapes for their next destination. In environments with physical tape libraries, the availability of an empty I/O port is essential. The system will alert and will return an error code if no port is available, prompting user action. A rescan of ports is recommended to ensure availability.
Attention! In some cases, a backup job may fail if the Export option is used for the first job following a system restart, especially if the initial job is a File backup with the Export setting.
Max Devices (Devices)
Limits the number of storage devices valid for use with this job. Use this option if you want to stop DPX from using all the drives in the selected device cluster so that some drives will be available for other purposes.
The maximum number to check a tape in a standalone tape device.
The number of seconds to wait between checking the availability of a tape in a standalone tape device.
Amazon S3 Object Lock prevents your archive data in the cloud storage from being deleted or overwritten. Set S3 Object Lock to Yes to make your archive data the write-once-read-many (WORM) model. Beginning from Version 4.8.1, you can also use the legal hold for cataloged job instances that use the Amazon S3 Object Lock.
If Yes is selected, another radio button selection will appear.
Set S3 Lock Mode for the retention modes of Amazon S3 Object Lock to either Governance or Compliance.
Restrictions. Some features of Amazon S3 Object Lock are not available in Catalogic DPX. For example, you cannot use the default retention period in Amazon S3 instead of the backup or archive jobs that are defined in Catalogic DPX.
DPX provides generic NDMP support that can back up and restore data for NDMP NAS appliances in several ways.
High-Speed Local Backup
The NAS appliance is directly connected to a SCSI-attached or fiber-attached storage device (typically a tape drive). The NAS appliance must be defined in DPX as a node that uses the NDMP access method. DPX documentation refers to these nodes as NDMP nodes. Data is backed up and restored directly via the local device.
Three-Way Backup
The NAS appliance sends data over the LAN to a storage device attached to a second NDMP appliance. Both NDMP devices (source and destination) must be defined in DPX as nodes that use the NDMP access method.
Appliance-to-Server Backup
The NAS appliance sends or receives data over the LAN to a DPX device server. The NAS appliance must be defined in DPX as a node that uses the NDMP access method. The DPX device server is defined in DPX as system type TCP/IP, though DPX device servers can exchange data with supported NDMP devices.
In the main desktop interface window, go to the Backup tab, and from the Backup Modes section in the task panel, choose NDMP.
Two additional panes will appear. You are already in the defining new file backup job view, so there is no need to click the Define New Backup Job button under Job Tasks in the task panel.
Specify the NDMP backup source in the middle pane. Expand the tree as necessary.
Empty checkboxes indicate a directory that will not be included. Checkboxes marked in red indicate a directory that will be fully included. Half-red checkboxes indicate that only some subdirectories/files of a given directory will be included.
Specify the NDMP backup destination in the right-hand side pane. Expand the tree as necessary.
Note. Before running a backup job, you need to save it. Once saved, a previously defined job can be modified, run, or deleted. If you try to leave the job creation view without saving the changes, you will be prompted to either save or discard changes before leaving.
If you select Define New Backup Job, all unsaved changes will be lost.
Set advanced options as desired, selecting appropriate items in the Other Tasks section of the side panel. Scroll down if necessary.
See also. For more information about NDMP backup job options, see the following sections:
Other Job Options for NDMP Backup (includes encryption and notification options)
Save the job by doing one of the following:
Select File > Save Job
Select Save Backup Job in the Job Tasks section of the side panel
Press [Ctrl + S]
The Save Job dialog will appear.
Restrictions. The new job name must be unique throughout the entire DPX, regardless of the folder the job is stored in.
Click OK. The job is now saved.
Editing an NDMP backup job allows you to change some parameters of an already defined job (Save), or to create a new job based on the definition of an existing one (Save as…). The procedure is similar to creating a backup job from scratch.
In the main desktop interface window, go to the Backup tab, and from the Backup Modes section in the task panel, choose NDMP.
Under Job Tasks in the side panel, select Open Backup Job. The Open Job dialog will appear.
Note. The Job Lit includes all NDMP job names, regardless of the folders they are stored in. The Folder field indicates the actual folder where the selected job is stored.
Select the job you want to edit from the list. Click OK. The Open Job dialog will close and the settings of the selected job will be loaded to the main window view.
When finished, save the job by doing one of the following:
Select File > Save Job
Select Save Backup Job in the Job Tasks section of the side panel
Press [Ctrl + S]
The Save Job dialog will appear.
Restrictions. The new job name must be unique throughout the entire DPX, regardless of the folder the job is stored in.
Click OK. If you choose the same name, you will be prompted to confirm the replacement of the already existing job. Select Yes to change the job definition, or No to return to the previous step and specify another name for the job.
Apart from source and destination options, DPX offers some additional backup job options, such as Job Encryption options and Job Notification options. They are available from both interfaces as presented below.
The Set Job Encryption Options dialog controls how and when a job is encrypted.
To set backup encryption options:
Open the Set Job Encryption Options dialog box by doing one of the following:
Right-click the Enterprise name or icon to display a context menu. Then select Set Encryption Options.
From the menu bar, select Backup > Set Encryption Options.
On the task panel, click Set Encryption Options.
The Set Job Encryption Options dialog box appears.
Complete the Set Job Encryption Options dialog box as needed.
Encrypt data while transmitting it through networks to enhance security. Typically, the encrypted data transfer can lower the data transfer speed.
Specifies if the data written to tape is encrypted. This option does not relate to data transport. If network transport encryption is important, use the Network Encryption option.
The Set Job Notification Options dialog controls who receives messages pertaining to the current job when it is run.
To set backup job notification options:
Open the Set Job Notification Options dialog box by doing one of the following:
Right-click the Enterprise name or icon to display a context menu. Then select Set Notification Options.
From the menu bar, select Backup > Set Notification Options.
On the task panel, click Set Notification Options.
The Set Job Notification Options dialog box appears.
Complete the Set Job Notification Options dialog box as needed.
An explanation of each field and the available choices follows:
Two sets of mail information can be specified:
The email address of the primary recipient of your message. Only one “To” address is permitted.
Carbon Copy. The email address(es) of the secondary recipient(s) of your message. Use a semicolon to delimit multiple email addresses.
Blind Carbon Copy. The email address(es) of the secondary recipient(s) not identified to other recipients. Use a semi-colon to delimit multiple email addresses.
The subject of your message. The subject line usually contains a combination of straight text and variable elements. Variables, which must begin with %
, are replaced with actual corresponding values. If you enclose variables in double quotation marks, those variables are treated as literal values. You can embed the following variables:
%JOBNAME
%JOBID
%JOBTYPE
%RC
Use %RC to include the return code in the message for this run of the job, when applicable.
Selecting this check box option temporarily disables notifications for the job without deleting the currently defined job notification data.
Note. Note that the following characters are invalid in all fields: <
>
;
and '
.
Bare Metal Recovery in Catalogic DPX is a disk-based disaster recovery solution that enables administrators to restore an entire system environment for an individual computer. Using this feature, a full recovery includes the operating system, point-in-time backed-up data, and Microsoft Exchange, Microsoft SQL Server, and Oracle Database applications if applicable. You can use Bare Metal Recovery for disaster recovery and replicating the environment, applications, node data, and so on.
The purpose of Bare Metal Recovery is to restore an entire system environment for an individual computer. A full recovery using Bare Metal Recovery includes the operating system, point-in-time backed-up data, and Oracle, SharePoint, SQL Server, and Exchange data if applicable. If the computer being recovered is a master server, Bare Metal Recovery additionally restores the application.
In order to be able to perform a Bare Metal Recovery, you need to create a particular type of block backup, by defining a block backup job. See the procedures below.
Perform all the steps as in .
In step 4 (source selection), select the BMR volume.
Perform all the steps as in , going through all the steps of the Block Backup Wizard.
In step 6 (Source Options), select the BMR volume.
It is very important to back up the Catalog regularly. It is equally important to know where the Catalog backup resides. Specifically, you need to know the destination media volume and the location of the Catalog backup on the media. However, the location of the backup Catalog is kept in the Catalog itself; thus, if the Catalog is lost, the location information is lost as well.
To be prepared for a disaster recovery situation where the Catalog is lost, you need to take the following critically important steps:
Define a Catalog backup job and schedule it to run daily.
Enable e-mail reporting in the Catalog backup job definition. Emailing the Catalog backup job report and archiving that report off-site will help identify tapes and partitions needed for Catalog restore.
Also, note the following important recommendations:
Set Catalog backup retention to be as long as your longest data protection archives. For example, if you are required to retain server backups for 5 years on tape media, retain Catalog backups for at least that long. If you cannot retain all Catalog backups for this long, consider defining multiple backup schedules in the Schedule Job dialog to retain some archives long-term.
Create a separate media pool for Catalog backup media. This step is not essential, but it is strongly recommended. It can help you locate media quickly.
Retain an offsite copy of your Catalogic DPX installation media. The installation media can always be downloaded from your account; however, ready access to the media and patch sets helps to speed the recovery process and avoid challenges with Internet connectivity during a disaster recovery situation.
The destination media can be tape or Disk Directory. You can also employ BMR as part of the protection strategy. BMR provides high-performance bare metal disaster recovery capability. You must still perform catalog backups, however BMR can assist in recovering the server quickly. See .
Important. Backing up to a local disk does not protect your data if the disk fails.
See also. For the latest system compatibility details regarding supported hardware, file systems, applications, operating systems, and service packs, see the DPX 4.10 .
There are several different strategies for protecting catalog data. The most important items are to back up the catalog frequently, move the catalog backup data to a safe location, keep record of where the catalog data is, and retain the catalog backup to cover the retention period of your longest archives.
The recommended strategies for catalog backup are as follows:
Tape drive attached to the master server
Tape drive attached to a remote device server
DiskDirectory dedicated for Catalog backup
Directly attach at least one tape drive to the master server. Back up the Catalog directly to a tape and send this tape offsite. Retain the catalog backup job log with this Catalog backup media.
It is strongly recommended to use a separate media pool dedicated to Catalog backup operations and to retain Catalog backup job reports, which should be emailed or copied to a location where they can be easily accessed. These steps facilitate finding and recovering the master server data in the event of a disaster.
If you do not follow the recommendation to use a dedicated media pool and decide to mix Catalog backups with other file-level backups, be aware that backup retentions could prevent tapes from being free if the Catalog backup is retained on a long retention cycle. If you nevertheless decide to mix backups on media, it is recommended to use a new tape for each Catalog backup. This is done by setting the Tape Usage option to Use a new Tape. Setting the option ensures that the Catalog backup is always on the first tape partition, making it much easier to locate and restore from the tape when no other data is available. Ensure you retain a record of the Catalog backup and send media offsite.
This is similar to a tape drive attached to the master server. If the device server is located at the same site as the master server, ensure the Catalog backups are sent offsite. If you have a device server at a remote location, you can accomplish the Catalog backup and offsite storage simultaneously. Always retain the Catalog backup job logs, especially if the offsite Catalog backup media mix with other tape backups or if the media pool reuses Catalog backup media for multiple catalog backups.
The Catalogic DPX Open Storage Server environments typically have a tape library attached to the Catalogic DPX Open Storage Server for the Catalogic DPX Archive capability. The Catalogic DPX Open Storage Server is a device server like any other and can handle Catalog backups to tape.
DiskDirectory (tape backup to disk) can be used for Catalog backup.
Attention! Ensure the DiskDirectory volumes are protected so that if the master server is lost, the desired DiskDirectory volser files can be copied to the new master server for master server recovery.
Note the following considerations when using DiskDirectory for Catalog backup:
DiskDirectory volsers only contain a single partition, do not have any specific bounds that limit space usage, and disk space used is not reclaimed at Condense time, though the volser is Empty and flagged for re-use for new data.
DiskDirectory volser storage can easily grow to consume all available volume space, so it is important to make sure that running out or DiskDirectory space does not affect other unrelated server functions.
It is very important to host DiskDirectory volsers on a volume that does not compete for disk space with other local machine needs. For example, do not host DiskDirectory storage on the volume that contains the master server software or Catalog, and do not host DiskDirectory volsers on any volumes shared with application data such as SQL Server, Oracle, or Exchange.
If DiskDirectory volsers are hosted on the Catalogic DPX Open Storage Server, use a separate volume and do not attempt to share storage between DiskDirectory and the Catalogic DPX Open Storage Server backups, since the two types of backup use disk space in different ways and ultimately interfere with one another.
DiskDirectory backup can be hosted either on the master server, or on a remote device server, if necessary.
The data protection administrator must arrange for DiskDirectory volsers to be copied, moved, or otherwise archived to a safe location where they can be accessed in the event of a disaster recovery. Long-term archival of catalog data by a secondary process such as NDMP is not a valid strategy because NDMP restore requires catalog data to find and direct the restore process.
When using DiskDirectory, it is recommended to set the Job Destination Options Tape EOJ Usage to Unload Tapes. This allows any empty volsers to be used even if new volsers exist. Otherwise, new volsers are always preferred until no new volsers are remaining. With DiskDirectory, it is a good practice to use the first tapes marked Empty. This helps reclaim disk space held by the expired backup data.
In this method, the master server performs Catalog backup to local storage and then uses Block backup for protection. Perform a Block backup to an offsite NetApp storage system. Alternatively, use SnapMirror to replicate a Block backup to another NetApp storage system.
In this method, a NetApp LUN is connected to the master server, and the LUN is used to hold Catalog backup DiskDirectory volsers. SnapMirror is configured to replicate this LUN to another offsite NetApp storage system after the Catalog backup is completed.
For recovery, the backup administrator must know where the Catalog backup LUN exists and must arrange for it to be mounted to the new master server. Once the LUN is presented and the data is visible, the administrator needs to know which volser to use for Catalog restore. Typically this is the volser with the most recent modification date.
Another server is used to present a CIFS or NFS share to the master server. This share is used to hold the Catalog backup DiskDirectory volsers. This share could be a NetApp storage system or any other suitable storage server. The storage server replicates the DiskDirectory volsers offsite. For NetApp storage systems, you can use Snapmirror or SnapVault. You can also use a server with the NetApp OSSV agent to perform Snapvault backups to NetApp storage. Additionally, you can run automated jobs on a Windows or Linux machine to copy new data to an alternate location.
For recovery, you need to know the location of volser files, and you need to arrange for the required volser files to be copied back to the new master server for Catalog restore. If you use a network share for DiskDirectory storage and you need to run a tape backup of this as well, ensure you set the source job option Skip NFS Volumes to No.
In this method, you run Catalog backup to DiskDirectory hosted on the master or a remote device server and then use tape backup to archive this data offsite. This method retains a local copy for convenience and a remote copy for disaster recovery. It is essential to know where the tapes and partitions for the second stage backup are located. To ensure you have this information, save e-mail job reports or archive the job logs. Archive job logs on a long-term basis, as they may be needed at recovery time for reference.
For recovery, the backup administrator must configure the new master server to run a tape mode restore from the second stage backup. The information for the required tapes and partitions must be recovered from the previous backup job log. Once the necessary volser is recovered, you can then run a Catalog restore from DiskDirectory.
The following are Catalog backup strategies that are not recommended. Although Catalog backup in some of these cases may succeed, the recovery may not be possible if the master server is not available to coordinate the restore process.
The Catalog cannot be backed up directly to an NDMP-attached tape drive. In cases where a tape drive cannot be attached to the Catalogic DPX device server, ensure you know where the catalog backup is retained and how to recover it. Do not move Catalog backups to NDMP attached storage. NDMP restore requires Catalog data on the master server. You cannot recover NDMP data unless the master server has the NDMP tape backup in its Catalog. Thus, in a disaster where the primary catalog backup media (DiskDirectory) is lost, the archive via NDMP will not help, since you will have no way to directly recover that data without the master server Catalog.
Consumer-grade removable USB storage is not an ideal medium for DiskDirectory management. Backups may succeed, but they would require very careful administration, and you would need to maintain a detailed accounting of backups and devices. Volser file names will likely be duplicated across multiple devices, adding to restore time confusion.
Agent-based and agentless virtualization generally requires a master server with a viable Catalog to run the restore. For disaster recovery testing, other testing, or temporary needs requiring older Catalog data, you can virtualize a master server if that is followed with the desired Catalog restore. However, note that you generally cannot perform virtualization to the original IP address. This limitation may cause local cmagent
configuration issues, and the virtualization will likely invalidate the licensing. For real disaster recovery scenarios, BMR followed by a Catalog restore is preferred.
Turns off checksum generation. If you turn checksum generation off, level 3 verification cannot be performed. For more information on level 3 verification, see the source option .
E-mail notifications will be sent to the e-mail account specified in the Administrator E-mail Settings tab on the ENTERPRISE INFORMATION page under on the top menu bar. See Administrator E-mail Settings.
Turns off checksum generation. If you turn checksum generation off, level 3 verification cannot be performed. For more information on level 3 verification, see the source option .
Click Finish. The Final Job Run Settings dialog will appear. You may choose to run the job immediately or save it without running. You may also change the retention period (default: 90 days).
Proceed with editing the job. See for more details.
Note. DPX emailing must be enabled when you first configure your Enterprise. At that time, you supply general system information, including SMTP Host Name and SMTP Port. See .
For recovery, restore the entire master server with BMR, then restore the Catalog from the local DiskDirectory repository. If a BMR backup of the master server is not included or available, then you can manually manipulate the Block backup data to present the DiskDirectory data via an iSCSI LUN to the new master server and perform the restore. For more details, See .
Block backup can be used to protect the master server, but that does not guarantee that the Catalog is in a consistent state. You must perform a separate Catalog backup. See above.
Yes
Enables encrypted data transfer.
No
Data transfer without encryption.
No data encryption
Data is not encrypted at the device server.
Encrypt data at the device server (primary and twin tape)
Data is encrypted at the device server of both the primary and twin tapes. Hardware compression does not matter if same tape model/media is used.
Encrypt data at the device server (primary tape only)
For the primary tape, data is encrypted at the device server. Hardware compression does not matter.
Encrypt data at the device server (twin tape only)
For the twin tape, data is encrypted at the device server. Hardware compression must be disabled during original backup job.
Output Email
Specifies that the subsequent fields apply to reports that are sent when a job has completed.
Operator Email
Specifies that the subsequent fields apply to mount requests, error messages, and informational messages that are sent during a job.
To access the job source options, do the following:
Go to the Backup tab.
In the Backup Modes section, select File.
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.
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.
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.
For information on using Instant Access for file-level restore, see Instant Access as a File History Alternative in the DPX 4.9.x User’s Guide.
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:
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.
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>
See also. For detailed information about pre- and post-job scripts, including all valid definitions, see Pre-Scripts and Post-Scripts.
If you want to run certain backup jobs on a regular basis, it is best to create a schedule for them.
You may add a schedule to an existing job and save it, add a schedule to an existing job and save it under another name (thus creating a new job without affecting the job you have made edits to), or create a completely new job, adding a schedule to it.
Important. It is strongly recommended to create a regular schedule for Catalog Backup, as the Catalog is vital for managing any backups you might need to restore.
To add a schedule to a File backup job, create a new job or open an existing one from the Job Manager.
In the job creation/editing view, scroll down to the SCHEDULES pane and click Add Schedule. The Schedule dialog will open. Depending on the selected frequency, the dialog will display slightly different parameters to select. Below, the Weekly schedule view is shown.
Select all required parameters, such as the schedule starting time and date, day of the week (if applicable), repetition period, backup retention time, etc.
Click Add.
Important. The schedule is now added to the job, but the job is not saved yet. Continue with the procedure to save the job.
Save the job. If you have added the schedule by modifying an existing job, two options will be available.
Click Save to apply changes to the existing job; or
Click Save As to create a copy of the modified job, with the schedule added, under a new name.
Restrictions. The new job name must be unique throughout the entire DPX, regardless of the folder the job is stored in.
To add a schedule to a Catalog Backup job, do the following:
Go to the Catalog tab and from the Catalog Operations section in the task panel, choose Backup.
Under the Job Tasks section, select Schedule Backup Job. The Job Schedule dialog will open.
The Schedule tab allows you to define the dates and times you want the current job to run.
The Exceptions tab allows you to list any exceptions to that schedule.
The Preview tab allows you to view all jobs scheduled for a specified future date.
Note. For File, Image, and NDMP backup jobs only, you can use the scheduler to define a Migrate operation. See Specifying an Automatic Migrate Operation in the DPX 4.9.x Reference Guide.
Select the Schedule tab. Using the Schedule window, you systematically define the schedule for the particular job you are defining. A single schedule definition for a single job can include many schedule description items or job schedule elements, which can be for different frequencies and different backup types. The following illustrates a schedule definition that contains four job schedule elements. Note that after defining the schedule, you will have an opportunity to exclude particular events by using the Exceptions tab.
Add job schedule elements one by one. To do so:
Click New.
In the New Schedule box, select a frequency. The following list describes your choices:\
Once
To schedule a job to run once, on a particular date and at a particular time in the future.
Hourly
To schedule a job to run more than once a day. This option is available only for Block backup jobs and Agentless VMware backup jobs.
Daily
To schedule a job to run every day at a particular time.
Weekly
To schedule a job to run weekly on a particular day of the week, or to schedule a job to run in a particular week of each month.
Monthly
To schedule a job to run monthly on a particular day of the month.
Scheme
To schedule rudimentary base/incremental or base/differential schemes. These are weekly schedules that run a Base backup once a week and Incremental or Differential backups on the remaining days. This option is not available for Block backup jobs.
Fill in the relevant details. The following table provides an overview of the field definitions. The field definitions may vary depending on the frequency you selected.\
Once
Run [Backup Type]
Backup at [Time]
Enter the time of day you want this job element to commence.
On [Date]
Select from the display calendar the date you want this job element to run.
Retention
Hourly
Run Backup at [Time]
Enter the time of day you want this job element to commence.
On [Date]
Select from the display calendar the date you want this job element to run.
Repeat every [Hours]
Select the repeat frequency in hours.
Retention
Daily
Run [Backup Type]
Backup at [Time]
Enter the time of day you want this job element to commence.
On [Date]
Select from the display calendar the first date you want this job element to run.
Repeat every [Days]
Select the repeat frequency in days.
Retention
End Date
This field is optional. To enable this field, select the check box, then select from the display calendar the final date you want this job element to run.
Weekly
Run [Backup Type]
Backup at [Time]
Enter the time of day you want this job element to commence.
On [Day of Week]
Select the day of the week you want this job element to run. You can select more than one day.
Repeat
Choose either Select Weeks or Week Day in Month.
Every
With the Select Weeks option selected in the Repeat field, select the frequency of weeks that this job should repeat.
The
With the Week Day in Month option selected in the Repeat field, select the week in each month that you would like this job element to run. You can select more than one week. Note that Week Day in Month refers to the set of 7 days starting from the first day in the month, not the calendar week containing the first day of the month.
Retention
Start Date
This field is optional. To enable this field, select the check box, then select from the display calendar the first date you want this job element to run.
End Date
This field is optional. To enable this field, select the check box, then select from the display calendar the final date you want this job element to run.
Monthly
Run [Backup Type]
Backup at [Time]
Enter the time of day you want this job element to commence.
On [Day of Month]
Select the numeric day of the month you want this job element to run. You can also choose last day of month.
Repeat every [Months]
Select the repeat frequency in months.
Retention
Start Date
This field is optional. To enable this field, select the check box, then select from the display calendar the first date you want this job element to run.
End Date
This field is optional. To enable this field, select the check box, then select from the display calendar the final date you want this job element to run.
Click Apply. The job schedule element is added to the Schedule Description list at the top of the window.
Repeat steps 4.1 through 4.4 as needed to define the schedule for the particular job you are defining.
Select the Exceptions tab if exclusions are desired. This window allows you to exclude any future scheduled runs of the job. Add exclusion description items one by one. To do so:
Click New.
In the New Exclusion box, select from the display calendar the date of your desired exclusion. In the display calendar, the dates for which the current job is scheduled are denoted in purple. The job elements scheduled for that date appear in the box.
To exclude certain job elements scheduled for that date, click Select one or more entries to exclude, then select the desired jobs from the entries listed in the box. To exclude all job elements scheduled for your selected date, click Exclude whole day.
Click Apply. The exclusion description item is added to the Schedule Description list at the top of the window.
Repeat steps 6.1 through 6.4 as needed to define the exceptions for the particular job you are defining.
You can also indicate whether or not scheduled jobs should be skipped on holidays by clicking to select or unselect Skip Run if Holiday.
Click OK. The schedule and exceptions you just defined are associated with the job you are defining.
This dialog box contains three tabs along the top: Schedule, Exceptions, and Preview.
Select the backup type (base, differential, or incremental) for this job element. See . For File, Image and NDMP, you can also select Migrate.
Enter the number of days you would like the backed-up data for this element of this job to be saved in the Catalog. See in the DPX 4.9.x Reference Guide.
Enter the number of days you would like the backed-up data for this element of this job to be saved in the Catalog. See in the DPX 4.9.x Reference Guide.
Select the backup type (base, differential, or incremental) for this job element. See . For File, Image and NDMP, you can also select Migrate.
Enter the number of days you would like the backed up data for this element of this job to be saved in the Catalog. See in the DPX 4.9.x Reference Guide.
Select the backup type (base, differential, or incremental) for this job element. For more information, see . For File, Image and NDMP, you can also select Migrate.
Enter the number of days you would like the backed up data for this element of this job to be saved in the Catalog. See in the DPX 4.9.x Reference Guide.
Select the backup type (base, differential, or incremental) for this job element. See . For File, Image and NDMP, you can also select Migrate.
Enter the number of days, months, or years that you would like the backed up data for this element of this job to be saved in the Catalog. See in the DPX 4.9.x Reference Guide.