Configuring Manager Backup

This solution backs up key configurations required to rebuild the Manager components of the system, and transfers the file to a specified agent. This is not a system backup; the job does not perform a complete backup of everything on the Manager. If you wish to use the system to store your own files, or for other purposes, you should have the appropriate backup and recovery procedures in place. This system backup includes backing up job template libraries and workflows. This job does not back up the Signiant software. You will need a copy of the original media to restore a complete system, not just the backup file created here.

The file is named: DTMBackup<hostname>_<#>.jar
If the file is encrypted, the name is: DTMBackup_<hostname>_<#>.jar.des3

By default, the backup file is saved to the Manager. It is strongly recommended that the default setting be modified to transfer the backup file to a different Agent to protect against data loss in the event of failure of the Manager hardware. For more information, see Installing Agents.

If you lose the password, you will not be able to recover the backed up file. The backup job allows you to specify the number of backups to keep. However, turning encryption on or off may result in more backups in the backup directory than you specify to keep. Once the specified number of backup files to keep is reached, the backup job removes the oldest file. Backup files have the following name format: DTMBackup_<hostname>_<#>.jar. Encrypted files have the following name format: DTMBackup_<hostname>_<#>.jar.des3. If you turn encryption on or off, backups created in the new mode (encrypted or not encrypted) will have a different file name from the original mode, and will therefore not overwrite the original backups.

It is recommended that you schedule the backup job to run once a day. If you do not schedule a backup job, if a backup job fails, or if a backup job does not complete in a timely manner, a system alarm is generated. On a fresh install, Signiant creates a default log maintenance and Manager backup job, with a default schedule and preferences. You will want to modify these jobs to suit your own scheduling needs, particularly changing the storage location for the backup file and adding an email address to both jobs for notification in the case of job failure.

The default backup job is scheduled to run at 1:05 in the morning, based on the server's default time zone. If, for example, the server's time zone is set to Eastern Standard Time (EST), and the difference is 5 hours between EST and GMT, the schedule for the backup job 6:05 GMT. The default schedule specifies the Manager as the location for the backup (which you should change), and does not include an email notification address. You may want to alter the schedule of the job and set the time zone. It is recommended that you run the backup job during the time of least possible activity to reduce the number of files that may change when the backup runs.

Do not run the backup job at the same time as you are running the Manager maintenance job. Since the maintenance job is changing (rotating) and deleting old log files, this may cause problems while you are backing up the system. Files may disappear while the backup is running, because the maintenance job is deleting old logs, which may cause the backup to fail.

To schedule the template to backup the Manager:

  1. From the Manager, select Administration>Manager>Backup.
  2. Click the Add button from the action bar to create a new backup job or click the Edit button to modify its properties. You must select a remote host to which the backup is transferred from the drop-down menu. Set the scheduling and notification information outlined below.
  3. Click Add Job.

Backup Specification

Backup Working Directory
Use this to specify the location where the backup is run from. Ensure this directory has adequate space to store temporary files.

Transfer backup to Agent
The Agent to which you want to save the backup data file. The file will be saved in the Agent's default directory. See 'Specifying Agent Environment Information' to determine or configure an Agent's default directory.You can optionally select multiple Agents on which to save the backup data file. When multiple Agents are selected, the Agent backup target directory defaults to ddsdefaultdirectory.

Agent backup target directory
To specify the folder where backup files are stored on the target Agent, click the icon to browse to the folder location. When multiple Agents are selected, this defaults to ddsdefaultdirectory.

Number of backups to keep
The number of copies of the backup file to keep. The default is 7. When the specified limit is reached, Signiant removes the oldest copy of the backup.

Notification and Logging

Mail notification to
In the notification section, type the email addresses of the people who you want to receive notification when the job runs. Separate multiple addresses with a comma.

Email Condition
The conditions under which an email is sent. Choose from Always, On Transfer, On Error or None.

Log Detail Level
The type of logging information for this job. Choose from Error, Warn (warning), Info (Information) or Debug. Debug provides the greatest level of detail while Error provides the least. Use debugging only when investigating a problem, as it can create a verbose log.

Transport Options

Use UDP Control Channel
Allows you to specify that job control information will be communicated using UDP instead of TCP. This includes both the communication between the Manager and primary Agent, and the primary Agent to any secondary Agent(s). This functionality is intended to be used for firewall traversal when the TCP port cannot be opened. If this is not a requirement, then it is recommended that Use UDP Control Channel be disabled. This setting applies to all Manager/Agent job control communication across the entire job. UDP versus TCP communication for Agent administration via the GUI is controlled separately as part of Agent configuration. When Use UDP Control Channel is enabled, all file transfers will use UDP WAN acceleration, overriding any other WAN Accelerator settings.

Use WAN Accelerator Enabling WAN communication sets a job to use UDP as the underlying transport, and will attempt to use all available bandwidth up to any specified limit, resulting in faster transfers. WAN acceleration should only be used on high-latency, high-bandwidth networks for maximum throughput. Transfers will automatically switch to TCP if throughput drops below 57200 bits per second.

Note: Bandwidth throttles may also be employed by other network devices and policies (e.g., QoS), therefore, a bandwidth throttle (or target maximum) defined here may not be achievable. If you are having difficulty achieving a particular bandwidth target, ensure that other policies are not impacting your ability to reach the desired throughput.

Advanced Options

Backup transfer encryption level
This is a mandatory field. Select from the drop-down list the level of encryption you want for all backups.

Backup password
A password to encrypt the backup file. This field is optional. Make sure you keep track of this password. If you lose it, you will not be able to use the file to restore data to the Manager.

Confirm backup password
Retype the password.

Job Schedule

How often you want the job to run. Choose from once, hourly, daily, weekly, monthly, yearly, month end or none. Signiant recommends you run the job daily.

Start Date/Time
The time at which you want the job to run (in yyyy/mm/ddhh:mm:ss format). Users can also click the calendar icon to select values.

Time Zone
Specifies the time zone in which the displayed times are set in the template. For example, if a solutions developer in an Eastern time zone specifies a start time of 9:00 am and a time zone of PST, the job runs at 9:00 am Pacific Standard Time or noon Eastern Standard Time. Clicking the globe icon displays the time zone selection screen.

Specifying the backup target directory location

To specify the backup folder target location:

  1. Click Target Folder next to Agent Backup Target Directory.
  2. In the File Browser window, select the folder to which you want to back up your data.
  3. Click Select and click OK.

Restoring the Manager

If you are performing regular Manager backups, you will be able to use the backup file to restore the Manager if the need arises. This is not a system backup; the job does not perform a complete backup of everything on the Manager, but only key configuration and binaries required to rebuild the Manager components of the system. If you wish to use the system to store your own files, or for other purposes, you should have the appropriate backup and recovery procedures in place. When preparing to run the disaster recovery process after a system failure, ensure that your drive configuration is the same as the configuration in use when the backup was created. If the configuration is different, the restore may not be able to correctly restore all of your data. The backup program backs up only data files.

When restoring a backup, start with a new Manager installation that is the same version and bit (32 or 64) as the Manager backup. Additionally, the Admin user must have the same username and password as used for the backup. It s important that the version, bit and Admin credentials match to ensure that all data and applications are restored properly.

If you previously upgraded from a 32bit Manager to a 64bit Manager, you must ensure that the restored 64bit Manager is installed in the Program Files x86 directory. The restore expects the software to be installed in the same location as it was originally.

To restore the Manager:

  1. Ensure you have the correct version, bit and Admin credentials. See above for details.
  2. Using secure FTP or some other method, retrieve the DTMBackup<managername>.jar (Linux) or DTMbackup_<hostname>_<#>.jar (Windows) file from the remote system and place it in the backup directory. (Encrypted files have a .des3 extension.)
  3. Run the restore_dtm command (see Restoring Backup Data below).

Restoring Backup Data

Once you have reinstalled the Manager, copy the backup data file to the Manager host, and run the restoredtm command. The restoredtm command takes no parameters and expects the DTMBackup<managername>.jar (Linux) or DTMBackup_<hostname>_<#>.jar (Windows) file to be in the backup directory (Encrypted files have a .des3 extension.). Since a password feature encrypts the backup file, you need to know the password in order to restore the system.

To restore the Manager data:

  1. On the Manager host, login as root.
  2. Type the following:

    • Linux: mkdir /tmp/restore
    • Windows: mkdir \tmp\restore
  3. Place a copy of the backup file in the /tmp/restore or \tmp\restore directory.
  4. Type the following:

    • Linux: cd <installation_directory>/bin
    • Windows (at the command prompt): cd <installation_directory>\bin
      Windows users can also use Windows Explorer to create the directory C:\tmp\restore.
  5. Type the following:

    • Linux: ./restore_dtm --restore /tmp/restore/<backupfilename>
    • Windows: restore_dtm --restore \tmp\restore\<backupfilename>

If you are using the Red Hat clustering feature to run a standby Manager, do the following to restore the backup data:

  1. Suspend the clustered services.
  2. Execute the restore procedure on the active server.
  3. Restart the clustered services.