UBT 1.3 © 1997-1998 Gilbert ROBERT

This document describes:

What this package is

The Unix Backup Tool (UBT) is a tool written in Tcl/Tk and using Expect to control the interactive commands like dump. It allows to define automatically from templates descriptions the files system list to backup, and with a nice interface to change the options and follow the backup progress.

Screen Shot of the UBT main interface (Size: 68 Kbytes)


The motivation for UBT arose, as software often does, from frustration. My first impulse was to search the web for an existing backup tool, but the softwares I found, was either commercial or do not correspond to my needs:
I have no much time to improve it, but I think It can be the basis for new features and enhancements. Thus this freeware is available with the Gnu licence and it's recommended to send your comments, feedback and changes to the author. The new versions obtained with the changes will be available as soon as possible.
Please mention the date and the ralease number of the sources you used. This tool has been tested on the Unix machines with Solaris 2.*, SunOs, and Linux 2.*

How to get the package


The most recent version of the package is titled UBT1.3, and can be retrieved in UNIX standard packaging format:



How to install the package

When you get the package type the following commands:

You obtain a directory UBT1.3 with executables and configuration files.





The distribution:


You need to have installed:
Now, you need to configure your template files and adapt the global variables to your site.
For that read the next section.

Configuration

Steps

  1. Edit the bin/Makefile file, and change what has to be changed.
    Change in lib/UBTdefault.tcl the global definitions, to adapt them to your site and needs.
  2. In the bin directory type make. This will change the differents path.
  3. Install the wrapg on all the different system to be backuped (in principle /usr/local/bin). You probably need to be super-user to execute this command.
    • rcp ./bin/wrapg $SolarisServer:/usr/local/bin
    • rcp ./bin/wrapg $SunOSServer:/usr/local/bin
  4. On each different operating system, create a link /usr/local/bin/ubtdump to the dump program. You probably need to be super-user to execute this command :
    • on Solaris: ln -s /usr/sbin/ufsdump /usr/local/bin/ubtdump
    • on SunOs: ln -s /usr/etc/dump /usr/local/bin/ubtdump
    User's Guide
    1. Edit the template files
      Go into the data directory and change the template files.
      In the interface, the backup type list is dynamically contructed from the name (the suffix) of the template files present in this directory.
      Example: data.tpl.full will correspond to the full button.
      Consequently change or create the template files you want to use and delete others.
      The fields must be separated by TAB character.

      Options Comments Default
      machines_to_backup The machine list to backup
      Ex: sparc1,sparc2,sparc3,sun2,sun3
      backup_type This is a file-system filter. If the file system name match this option, it will be selected
      Ex: /export/home or home.
      - To match all file-system use the !all item.
      - To match all file-system excepted:
      Ex. !item1,item2.
      !all
      tape_prog The path of tape control executable. /usr/bin/mt
      tape_prog_opts The options of the tape control program. Ex: "-f"
      ""
      tape_after_action The action the be execute after the backup has been performed: Ex: "rew"
      ""
      tape_before_action The action the be execute before the backup.
      Ex: "eom"
      ""
      operator The operator to execute the commands
      root
      mach_todo_backup The machine to do the backup
      $hostname
      options The options of dump program.
      0ubsdf 126 18000 54000
      backup_wait time in seconds to wait between backup
      10
      tape_device Define the device of the tape installed on the $mach_todo_backup
      /dev/rmt/0cn
      loc_backup_prog The path of the local backup program
      /usr/local/bin/ubtdump
      rem_backup_prog The path of the remote backup program
      /usr/local/bin/ubtdump
      remote_shell The path of the remote shell program
      /usr/bin/rsh
      mail_prog The path of the mail program
      /usr/bin/mail
      mail_to User to be contacted when the backup is done
      $USER environment variable

    2. Execute the backtool command.
    3. In the interface select the type of the backup you want to perform.



    4. type Configuration in the menu, and wait for the option window.
    5. Check and Save the configuration
      1. the commands options.
      2. the name of the log file.
      3. when the backup has to be launched.
      4. the machines and file-systems list. This window is writable and It's possible to add,delete or modify these informations.


    6. type Run command.
      If the time to launch the backup is not now, a window is opened and indicates your choice.
      The output of the command is printing in the log window, and in the right part the two jauges indicate the backup proportion of success and failures.



    7. The backup log is saved in the file you mentionned in the option window. But you can save the full output of dump with the Save Log button in the right corner of the main window.

    Incremental Backup


    • Read and Edit the file data.incr in the data directory.
    • Add the following line in your crontab
      0 1 * * 2-6 /usr/local/pck/backup/UBT1.3/bin/ubtoolcron data.incr > /tmp/backup.log 2>&1
    • or just type ubtoolcron data.incr
    • The tape_name field indicates the suffix of the log file.


    Bugs or Suggestions
    • Abort the backup process is not efficient.
    • The mail report is only send by the cron backup.
    • A documentation worthy of the name (Sorry for my rough english, but you can certainly help me ;-) )
    • The lock file can caused some troubles. Just delete the file: data/.lock. This file is setted to prevent the incremental and a full backup to work simultaneously, but sometimes, depenting of the end of the full backup, this file is not deleted.

    Copyright

    UBT - Unix Backup Tool
    Copyright © 1997-1998 Gilbert ROBERT
    @version 1.3 Released 07-27-98

    This package is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License along with this library; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

    A copy of the GNU Library General Public License is also available on the world-wide-web at the MIT


    Contact
    Name Gilbert ROBERT
    E-mail Gilbert.Robert@issco.unige.ch
    WWW Home Page

    E-mail Please don't hesitate to contact me if you have any suggestions or comments.