How do I install and configure the ADSM backup client for Mac OS X?

This page has instructions on how to install and configure the TSM client, and to run a manual backup. Before you begin, you need to do some initial steps like registering your node and making sure your password is up to date.

Download Backup Client

Go to our client download page and click the appropriate selection for which version of Mac OS X you currently have installed. What version of Mac OS X you have installed can be figured out by clicking on the Apple menu and selecting About this Mac.

Install the Client

It is recommended to uninstall any previous version of Tivoli Storage Manager before installing the new version, unless you are installing the latest version over the version just before it.

  1. Double-click on the Tivoli Storage Manager .dmg that you downloaded from the client download page.
  2. Double-click on the Tivoli Storage Manager package file inside the .dmg file.
  3. Click Continue once the Welcome screen appears.
  4. A window will appear displaying the Readme file. The Readme is an HTML file containing information about the backup client. It will also be available in the Tivoli Storage Manager folder in your Applications folder. It has a lot of useful information in it. Click Continue.
  5. Next choose the install location. The default location is your Macintosh HD. We recommend that you leave it set to default. Press Install to continue.
  6. When the install begins, you will be asked to enter the Administrative username and password for your computer, please do this and press OK.
  7. A screen will open showing the progress of the backup client's installation.
  8. When the install is finished, a screen saying the Install Succeeded will open. Click Close.

Configuring your Backup Client

You will need your ADSM node name, server name, and to know or have your ADSM password to continue, which you should have gotten on the main installation page.

It is recommended to use the instructions for the wizard below to configure your TSM client but you can also edit the sample dsm.sys and dsm.opt files as well. You do not need to follow the configuration instructions if you have dsm.sys and dsm.opt files backed up from a previous version or installation.

TSM Client Configuration Wizard

If you copy the sample files as instructed above, the TSM Client Configuration Wizard will not open, so you can skip these steps and move onto Setting TSM Client Preferences.

  1. Open your TSM client folder in your Mac X Applications folder: double-click Tivoli Storage Manager folder, then double-click on TSM Tools for Administrators to set up TSM.
  2. When the TSM Tools for Administrators dialog box opens, click Tivoli Storage Manager, and click OK.
  3. You will be asked to enter your local Administrator Name and Password. Enter those and click OK.
  4. Unless you are installing over a previous version and you were using Passwordaccess Generate before (Password Generate is one of the options we will set up later for a new install), you will be asked to "Login into a TSM server" at this point. Your UserID is NetID.adsm1 (your NetID - dot - adsm1) and the Password: your ADSM password.
  5. You will login to the TSM main menu. Select Edit then Client Preferences.
  6. The General tab.
    Mac ADSM Preferences General
    • Node Name: yourNetID.adsm1 (your NetID - dot - adsm1), so example1's is example1.adsm1
    • You will probably want to prune the log entries, we recommend 5 days.
    • Server Information will already be set and you won't be able to change it on this tab.
  7. The Backup tab.
    Mac ADSM Preferences Backup
    • Check Compress objects
    • Do not check Continue compressing if object grows
    • Do backup only your local file systems, not any network file systems you might have attached.
      Put a check beside: /
      By default, only your Macintosh HD -- / -- will be backed up. If you have other file systems that have your personal data on it, you must send email to datasave@uic.edu explaining this to arrange to have them backed up. We do not back up network or removable drives.
  8. The Restore tab.
    Mac ADSM Preferences Restore
    • Leave the default Ask user before replacing -- this is the behavior when you are restoring files that already exist.
  9. The Include-Exclude tab. There is a default Include-Exclude on the server, but you can add custom instructions to it.
    Mac ADSM Preferences Include Exclude
    Use Utilities then Preview Include-Exclude to see which files you will be including and excluding. (This can take awhile to run.)
    • Note that this example has an Include.Encryption directory, which instructs TSM to encrypt the directory /Users/../Stickey Notes:
      Include.Encryption "/Users/.../Stickey Notes"
  10. The Scheduler tab.
    Mac ADSM Preferences Restore
    • Keep the default Schedule Mode Polling.
    • Leave the Query Schedule Interval at 12 hours and the Retry Settings at 2 retries, 20 minutes apart.
    • All the TSM logs are in /Macintosh HD/Library/Logs/tivoli/tsm/ by default.
    • Leave the Schedule Commands blank.
  11. The Communications tab.
    Mac ADSM Preferences Communication
    • Leave the Common Options at the defaults, Duration 60 minutes, Interval 15 seconds.
    • For TSM Client/Server Communications, keep the default TCP/IP.
    • Your Server Address is of the form: NetID.adsm1.adsmserv.uic.edu
      Thus the server name for example1's example1.adsm1 ADSM account is:
      example1.adsm1.adsmserv.uic.edu
      (Note that the ".adsm1" has nothing to do with the number of the ADSM server you are using, it's the number of your ADSM account. )
    • The Port in all cases is 1500.
    • Leave the rest as is, Buffer 32 KB, Window 63 KB, Send transactions to the server immediately.
  12. Regional Settings are up to your personal preference: how time, dates, and numbers are displayed.
  13. The Authorization tab. This is for passwords.
    Mac ADSM Preferences Authorization
    • Click Password Generate.
    • For Authorization for TSM Services. If you want to limit TSM services to specific users on your Mac or groups, select them in this section. If you don't specify any group from the Groups list or any user from the Users list then all users can request TSM service. This is probably what you want.
    • Check Save encryption key locally.
  14. Leave the rest of the tabs -- Web Client, Command Line, Diagnostics, Performance Tuning -- at their defaults.
  15. Important: Click OK to save your changes and Quit TSM.
  16. Start TSM Tools for Administrators up again, login, and log back out again. This should create an encrypted password file in the directory TSM Preferences:
     /Macintosh HD/Library/Preferences/Tivoli Storage Manager/tsm/TSM.PWD 

    You can tell if you have this file by not being asked to enter a TSM password when you open the TSM client. If you don't have a TSM.PWD file, try changing your ADSM password with the ACCC Password Changing Utility and logging in with the new ADSM password.

Editing Configuration Files

You can edit the sample configuration dsm.sys and dsm.opt files or use the wizard located above to configure your TSM client, you do not need to do both. It is recommended to use the wizard in the section above to configure TSM.

The TSM client ships with sample preferences files, dsm.sys.smp and dsm.opt.smp. (Formerly known as TSM System Preferences and TSM User Preferences, respectively.) The sample dsm.sys file has the TSM-recommended Exclude rules already in it and has some required options as well. There is also an option that you need to put in dsm.opt, and the TSM client appears to need it in place to start.

Copy the sample file to your TSM preferences directory, and rename them to remove the .smp. Most of the options that will go into the dsm.sys file will be put in automatically, in the following steps. But there are a few changes you will make yourself. Note that the client option files must be plain text files. By default, TextEdit does not save files as plain text. Select Format then Make PlainText to save the client options files as a plain text files, and do not add the .txt extension.

  1. Copy the dsm.sys.smp file to your TSM Preferences directory.
    Sample file is at: Macintosh HD/Library/Application Support/tivoli/tsm/client/ba/dsm.sys.smp
    Copy it to: Macintosh HD/Library/Preferences/Tivoli Storage Manager/dsm.sys and rename it from dsm.sys.smp to dsm.sys.
  2. Open Macintosh HD/Library/Preferences/Tivoli Storage Manager/dsm.sys with TextEdit: Right-click or Control-click on its name, select Open with, and select TextEdit from the list of applications.
  3. Change these lines at the top:
    * At a minimum, you must specify the following options:
    * SErvername server_a
    * COMMmethod TCPip
    * TCPPort 1500 
    * TCPServeraddress node.domain.company.comTo the following:

    To the following:

    * At a minimum, you must specify the following options:
    SErvername  NetID.adsm1.adsmserv.uic.edu
    COMMmethod         TCPip
    TCPPort            1500
    TCPServeraddress    NetID.adsm1.adsmserv.uic.edu
  4. Add a line that says NODENAME followed by your ADSM nodename, which is your NetID-period-adsm1.
    NODENAME NetID.adsm1
  5. If you have a TSM.PWD file that you saved from a previous installation, also add the line:
    PASSWORDACCESS GENERATE
    

    and move your old TSM.PWD file to the Macintosh HD/Library/Preferences/Tivoli Storage Manager/ directory.

  6. Also add the line:
    AUTOFSRENAME 
    YES

    AutoFSrename YES renames copies of file systems as they are used for the transfer to Unicode. If you are first beginning to use ADSM now and have never used older versions, you don't need it, but it doesn't hurt. If you have used older versions, you need it.

  7. The bottom of the sample file are directories and files that Tivoli suggests that you might not want to back up, hence the "Exclude". The top group, which are not commented out, are suitable for everyone. The bottom group, which are commented out, are suggestions, you can uncomment them by removing the asterisk from the beginning of the line.
  8. Save the file File then Save As
    1. Add .sys to the name, so it's dsm.sys and make sure that it says you are saving a plain text file.
    2. Unclick If no extension is provided, use .txt (Don't worry; if you forget, you will just have to say you really meant the .sys.)
    3. Click Save and a dialog box will open saying that dsm.sys already exists, do you want to replace it. Click Replace and quit TextEdit.
  9. Then copy the dsm.opt.smp file to your TSM Preferences directory.
    Sample file is at: Macintosh HD/Library/Application Support/tivoli/tsm/client/ba/dsm.opt.smp
    Copy it to: Macintosh HD/Library/Preferences/Tivoli Storage Manager/dsm.opt and rename it from dsm.opt.smp to dsm.opt.
  10. Open Macintosh HD/Library/Preferences/Tivoli Storage Manager/dsm.opt with TextEdit: Right-click or Control-click on its name, select Open with, and select TextEdit from the list of applications.
  11. Remove the * in front of SERVERNAME and put in your server name.
    SERVERNAME NetID.adsm1.adsmserv.uic.edu
  12. Add:
    MEMORYEFFICIENTBACKUP NO

    This tells TSM not to take special care to conserve on your machine's memory. Unless, of course, your Mac really does have very little memory and it needs all of it, in which case, just leave it out. This option can make the difference between an incremental backup taking 4-6 hours and it taking less than an hour.

  13. Save the file File then Save As
    1. Add .opt to the name, so it's dsm.opt and make sure that it says you are saving a plain text file.
    2. Unclick If no extension is provided, use .txt (Don't worry; if you forget, you will just have to say you really meant the .opt.)
    3. Click Save and a dialog box will open saying that dsm.opt already exists, do you want to replace it. Click Replace then Quit TextEdit.

Turn on the TSM Client Acceptor Daemon

Turning on the TSM Client Acceptor Daemon, CAD, is all you need to set up your Mac to automatically run incremental backups once a day. After that, all you have to do is leave your Mac running and attached to the UIC network when you leave for the day and all the changes you make, every day, will be backed up. Well, you might have to play with your firewall also. Note: the ADSM server will automatically be configured to work with the CAD when you register for ADSM.

  1. Open your TSM client folder in your Mac X Applications folder: double-click Tivoli Storage Manager folder, then double-click on TSM Tools for Administrators.
  2. When the TSM Tools for Administrators dialog box opens, click Start the Client Acceptor Daemon, and click OK.
  3. A dialog box opens saying it takes a few minutes to start the CAD. Click OK.
    You will be asked to enter your local Administrator Name and Password. Click OK.
  4. Wait a bit, and a dialog box should open saying the CAD has started successfully.
    Mac ADSM Client Acceptor Daemoon Successfully Started
  5. Leave your computer running and connected to the network overnight. Check the logs tomorrow to make sure the backup ran.

TSM Scheduler Logs

When the TSM scheduler wakes up, it will negotiate with the ADSM server to choose a start time for your daily backup. The backup will occur at a random time. Your machine must be up and running for the backup to actually run, but you don't actually have to be logged in. Don't turn your Mac off when you leave for the day.

You can verify the results of your backup by keeping and reviewing a copy of your TSM Schedule Log file:

	Macintosh HD/Library/Logs/tivoli/tsm/TSM Schedule Log

(If you don't find it in that directory, use Finder and search for it. It's there, but sometimes it isn't listed there.)

Figure 1: A sample log file (from a long time ago), showing the end of an incremental backup and querying the server for the next backup time. Notice that at the end of the incremental backup, the Schedule log was pruned. This is a good thing, because the logs can get very big.
TSM Log

If you have the Mac OS X Firewall Turned on

Uou probably will have to allow the TSM client to accept incoming connections for the scheduler to work.

  1. Apple menu then System Preferences then Security then Firewall tab.
  2. If you have Allow all incoming connections selected, which is not a suggested option and leaves your computer vulnerable, you won't need to do anything else.
  3. Otherwise, select Set access for specific services and applications.
    Mac Security Firewall
  4. Click the + sign at the bottom left of the box; it opens a standard Mac file browse dialog.
    Mac Security Firewall Options
    The CAD scheduled backup ran with this firewall setting. It did not work with Allow only essential services, which is what I had before I opened these programs.
    Use it to pick the following:
    • From the Applications folder: Tivoli Storage Manager
    • From the Applications folder: TSM Tools for Administrators
    • From Macintosh HD/Library/Application Support/tivoli/tsm/client/ba/bin: dsmcad
    • From Macintosh HD/Library/Application Support/tivoli/tsm/client/ba/bin: dsmagent
    • From Macintosh HD/Library/Application Support/tivoli/tsm/client/ba/bin: dsmj
    • From Macintosh HD/Library/Application Support/tivoli/tsm/client/ba/bin: dsmtca
    • After I added dsmagent by hand, Mac OS X asked me again in a dialog box if it could received incoming connections. I said yes again, and it's in my list a second time.
    • Mac OS X also asked me if I would allow java, I said yes, and it is also on my list.

Start your first backup manually

  1. Open your TSM client folder in your Mac X Applications folder: double-click Tivoli Storage Manager folder, then double-click on TSM Tools for Administrators. Select Tivoli Storage Manager from the list of Applications.
  2. Click on the Backup button (the computer with the large arrow pointing out).
  3. Now you should see the Backup screen.
    Mac ADSM Manual Backup
    You will be given the choice to make backups of your Local, Network, or Removable drives. Click on the small gray box to the left of the Local choice so that local is checked. Note: Do not click on the network drives box because that will cause a backup of files on your Novell or NT file server!
  4. Click the Backup button to start the backup.
  5. The Task List popup screen list the files that are being checked and backed up; click the Details button to see detailed information about the transactions. In the first backup that you run, you should back up all the files on your Mac; it will take many hours. After the first run, only files that have been created or changed since the last backup need to be backed up and the backups will take considerably less time.
  6. When the backup is completed, you should see the ADSM Backup completed window.
  7. Click OK and the Backup Report screen will open. You can now exit the client.

How to Check on Your ADSM Backups

The ACCC ADSM Status Web utility shows you when the last time you successfully backed up using ADSM and which allows you to sign up for daily automatic email messages to keep you up to date with this information. Enter your email address in the box in the Watcher column to request the email message be sent to you.

Need help?

Last updated: 

September 20, 2016

Browse by tag