ADSM TSM Backup for Mac OS X 10.3.9 to 10.4.6: Installation

Click here to read the ACCC ADSM/Policy and to download TSM Backup client installer

The ACCC ADSM Mac Clients directory has a subdirectory with the latest client appropriate for Mac Classic, Mac OS X from 10.3.9 to 10.4.6, Mac OS X 10.4.7 to 10.4.11, and Mac OS 10.5. (Other Mac OS X's are not supported.)

This page describes the client used for Mac OS X 10.3.9 (Panther) to 10.4.6 (Tiger).

Click on the appropriate directory and download the .dmg file appropriate for your Mac OS X. In this case, click OSX10.3.9
As of November, 2008, the version of the TSM client for Mac OS 10.3.9 to 10.4.6 is 5.3.6.2. However, whatever you find is in the download directory is up to the current date.

Double-click on .dmg you downloaded to open the TSMInstaller "disk" with the TSMInstaller in it.

TSM Versions 5.2 and lower must be uninstalled when you upgrade to any higher version. However, the IBM documentation says:

Note: Due to differences between this and prior versions of Tivoli Storage Manager, the installation will remove prior versions of Tivoli Storage Manager. The prior installations that will be removed include the following:

• /Applications/Tivoli Storage Manager v5.1
• /Applications/Tivoli Storage Manager v5.2
• /Applications/Tivoli Storage Manager v5.2.2
• /Applications/Tivoli Storage Manager v5.2.3
• /Applications/Tivoli Storage Manager v5.2.4
• /Applications/Tivoli Storage Manager v5.2.5

If versions prior to Version 5.3.2 are installed in some other location, the following must be done before installation:

1. Remove or rename the existing TSM System Preferences and TSM User Preference files in /Library/Preferences/Tivoli Storage Manager.
2. Delete the prior versions.

So if this is to be believed, the newer versions will uninstall previous 5.2 versions for you if you installed them in the usual place. I can't confirm this because I had Version 5.3.4 on my Mac and Version 5.4.1.2 installed without any problems over it.

If you decide to uninstall it yourself,See The ADSM Mac FAQ How do I un-install TSM?

Regardless of what you decide to do, you might want to keep a copy of your:

/Macintosh HD/Library/Preferences/Tivoli Storage Manager/TSM System Preferences

file, which has in it all the Preferences that you set in your old TSM installation. Copy it to your desktop or somewhere easy to get to.
Then you can use open the old option files in a text editor and use the Configuration Assistant and the Preferences editor to set your Preference options to the values in the old preference file. You can't just copy it, the include/exclude file format has changed.

Note that the order of these steps seems to vary from time to time, in particular when it asks you to login to TSM. Please keep an open mind and if you see something that seems out of place, read a few steps ahead to see if you can find it there.

1. Double-click on the TSMInstaller icon (Step 2 above) to start the installation. You will be asked to enter the name and password of a Mac administrator account; do so and click OK to continue.
   
   
   
2. Click Continue on the TSM welcome screen.
   
   
   
   
3. Read the displayed Read Me text; you might also want to print it. Click Continue to continue.
   
   
   
   
4. Next you'll be asked which "install type" you wish to perform. We recommend you choose the default Easy Install. The install location is selected on the same screen. The default location is the Tivoli Storage Manager folder in the Applications folder in your Macintosh HD. We recommend that you keep that default also.
   
   
   
5. Click Install to continue.
   
   
6. A popup screen showing the progress as the TSM files are installed will open. When the install finished, a screen saying the software has been successfully installed will open. Click Quit when it finishes.
   
   
   
7. You will be left in your Tivoli Storage Manager folder in your Applications folder.
   
   
   

Notes:

The TSM Installation Manual and User's Guide is in the Tivoli Storage Manager folder in your Mac X Applications folder: double-click on TSM HTML Manual. It's well written and has an easy-to-use table of contents.

The TSM Preferences are written into the following files, where Macintosh HD is your current Startup volume:

• Macintosh HD/Library/Preferences/Tivoli Storage Manager/TSM System Preferences
• Macintosh HD/Library/Preferences/Tivoli Storage Manager/TSM User Preferences

The default permissions on the Tivoli Storage Manager folder are 755 (u=rwx, g=rx, o=rx); if you need to change the permissions, use the Darwin shell command:

sudo chmod 775 "Tivoli Storage Manager"

Make sure you have your ADSM nodename and password before you open TSM:

You need your ADSM node name and know or have your ADSM password for this step. See ADSM TSM Backup for Apple Macintosh: Getting Started for register and password information. You must also know which ACCC ADSM server you are assigned to.

• If you have just signed up for ADSM, your server is adsm-2.cc.uic.edu.
• If you have been using ADSM and haven't moved to the new ADSM server yet, please do it now. You can move to ADSM-2 yourself, any time you want, just by registering your machine for it, installing the newest version of TSM for your operating system, and configuring it to use ADSM-2 as described below.

Important Note: I've done this install a number of times, and it seems that the order of some of the requests can vary. So if something happens that isn't what you expected, read ahead or behind to see if you can find it.

The files being modified by the TSM setup process are (where Macintosh HD is your startup Volume):

• Macintosh HD/Library/Preferences/Tivoli Storage Manager/TSM System Preferences
• Macintosh HD/Library/Preferences/Tivoli Storage Manager/TSM User Preferences

1. If necessary, open your TSM client folder in your Mac X Applications folder: double-click Tivoli Storage Manager folder, then double-click on TSM Backup for Administrators to set up TSM.
   
2. You will be asked to enter the name and password of a Mac administrator account; do so and click OK to continue.
   
   
   
3. The TSM Client Configuration Assistant selection screen will open. If it doesn't, select Setup Assistant from the Utilities menu.
   You want to configure how your files will be backed up and also want to set up automatic scheduled backups (that way your files will get backed up on a regular basis even if you forget to do it yourself -- a very good thing).
   
4. A popup screen might tell you that the TCA file permissions are not correct. Click Yes that you want to correct them.
   
   
   
5. Click both Help me configure the TSM Backup Archive Client and Help me configure the TSM Client Acceptor Daemon and the TSM Client Scheduler. The assistant will help you configure the backup client and then the scheduler.
   Click OK to continue.
   
   
   

At some point in each task you will be asked to log in to "a TSM server". Your nodename will be filled in; type your ADSM password and click Login. Make sure you use the correct ADSM password; the TSM client can not tell you if you have not.

Continuing on,

1. The TSM Client Configuration Assistant will ask what you want to do. If you're first setting up your TMS client, then you want Set options for all users. If you're modifying previous work, then you want Update options for all users. Whichever is appropriate for your case will be selected by default.
   Click the right arrow in the bottom right to go to the next screen.
   
   
   
2. Next add the name of your ADSM server:
   • If you are first registering for ADSM now or if you have re-registered to use the new adsm-2 server or if you have received an email message from the ACCC that you have been switched to the new ACCC ADSM server, then your server is adsm-2.cc.uic.edu and you use TCPPort 1502.
   • However, if you have been using ADSM for a while and you have not re-registered to use the new adsm-2 server, then your server is adsm.cc.uic.edu and you use TCPPort 1500.
     
   Click the New Server button, type the name of your ADSM server in the TSM server name: box, then click OK.
   Click the right arrow in the bottom right to go to the next screen.
   
   
   
3. Next it asks for TCP/IP address of the TSM server. Enter your ADSM server's name again.
   
   • If you are first registering for ADSM now or if you have re-registered to use the new adsm-2 server or if you have received an email message from the ACCC that you have been switched to the new ACCC ADSM server, then your server is adsm-2.cc.uic.edu and you use TCPPort 1502.
   • IfIf you have been using ADSM for a while and you have not re-registered to use the new adsm-2 server, then your server is adsm.cc.uic.edu and you use TCPPort 1500.
   Click the right arrow in the bottom right of the screen.
   
   
   
4. A popup screen will open complaining that the node name contains periods and asking whether you want to remove them.
   Click No to continue.
   
   
   
5. For TSM authentication, enter your TSM node name; it will be your netid followed by .adsm1. So Ada Byron, whose netid is adabryon, would have the node name: adabyron.adsm1
   Type your node name in the What is the TSM node name to use? box and click the right arrow in the bottom right to go to the next screen.
   
   
   
6. The next three panels define which directories and files that TSM will backup. For now, it's easiest to just take TSM's defaults by clicking on the right arrow to go to the next window. These panels are Domain and Include-Exclude lists. Leave everything that is selected selected. We will modify them in TSM Preferences.
     
      
   
   
   
   
7. Click Finish on the Completing the TSM Client Configuration Assistant screen.
   
   
   

TSM Scheduling is a process that enables your Mac to automatically run incremental backups once a day. You don't have to do this, but face it -- if you don't have ADSM back up your Mac automatically will it realistically get backed up on a regular basis at all? Set it up. Running the scheduler won't cost you anything. All you have to do is leave your Mac running and attached to the UIC network when your leave the office in the afternoon.

Note: the ADSM server will automatically be configured to work with your client's scheduler when you register.

1. Repeat the first three steps if necessary to open the TSM Scheduler Wizard. If you have to login again, make sure you use your correct ADSM password; the TSM client can't tell you if you use the wrong one.
   
   
2. If you're first setting up your TMS scheduler, then you want to Install a new scheduler. If you're modifying previous work, then you want to Update a previously installed scheduler. The appropriate one will be selected by default.
   Click the right arrow in the bottom right to go to the next screen.
   
   
   
3. The Schedule Preferences screen opens.
   
   The defaults for these settings are correct:
   • Retry period: 20 Minutes
   • Maximum command retries: 2
   • Client Acceptor Port: 1000
   • Click Select... beside Schedule Log:
     • Schedule log location: Macintosh HD:Library:Logs:tivoli:tsm:TSM Schedule Log and
     • Prune the log at a reasonable time interval.
   • No need to click Define... beside Schedule Command:
   • Sched Mode: Polling
   • Query Schedule Interval: 12 Hours.
     
     
4. TSM can be quite prolific with its logs; it's useful to purge older logs. To set this up, click the Select... button beside Schedule Log on the Scheduler Preferences screen.
   The default location for the logs is /Macintosh HD/Library/tivoli/tsm/TSM Schedule Log. (Where Macintosh HD is your startup volume. The TSM Error Log is in that folder too.) This is a good place for them.
   Click Prune Old Entries, then decide how long you want to keep old entries and fill in the Keep pruned entries for box.
   Click OK to return to the Preferences screen .
   
   
   
5. The rest of the Schedule Preferences are correct, including Polling Schedule Mode (which tells the TSM client to wake up every so often and tell the Client Acceptor Daemon to check whether it should run a backup) and Client Acceptor Port 1000.
   Click OK to select the defaults on the Scheduler Preferences screen.
   
   
   
6. Click Finish. Restart your Mac.
   
   
   
7. If you get a warning that "an item in the Startup Items folder does not have proper security settings.", click Fix.
   
   
   
8. If you had to fix the security settings, you will be asked for your Mac password, after which your will have to Restart your Mac.
   

You can set all of the options that you set using the TSM Client Configuration Assistant individually in TSM Preferences. Open the TSM for Administrators Backup Client and select Preferences from the TSM Backup menu.

One option we need to talk about is the Authorization option passwordaccess. passwordaccess is automatically set to Password Generate when you install the client scheduler using the Setup Assistant. That is the setting that we recommend you use.

Password Generate encrypts and stores your password locally in a file -- TSM.PWD, kept in the directory with the TSM logs -- and generates a new password when your old password expires. The bottom line is, when you open the TSM client on your Mac, you will not need to know or enter your ADSM password for the your node. But you will have access to your files and to the files that other users have granted you access to. You will be a virtual root user for your machine when you use TSM Backup for Administrators.

Using Password Generate protects you from having anyone else sniff your password over the Internet and login to your ADSM backups without your knowledge. (There is no limitation to logging into to your backup files by IP address or anything like that. If there were, you couldn't use ADSM to recall files when you get a new computer or when you're using a backup computer when your regular computer is unavailable or being repaired.)

So long as you set your TSM up to use Password Generate, you won't have to enter your ADSM password when you open TSM Backup. You will have to enter your Mac account password when you open TSM Backup for Administrators.

You will need your ADSM password to set up Password Generate. If you need your ADSM password and don't know it, use your netid and ACCC password to change it to something that you know; see Already have an ADSM account but don't know your ADSM password?. If there is something wrong with your password file -- which happens -- or if you just want to, you can change your ADSM password to something you know and use that instead of Password Generate.

Now we'll go into TSM Preferences make a few changes to the Include/Exclude lists and check a few other preferences.

1. Open the TSM for Administrators Backup Client and select Preferences from the TSM Backup menu.
   
   
   
2. The first preference panel is General; that has your node name and if you click Select beside Error Log:, you can select pruning for your TSM Error Log file, which is at HD/Library/Logs/tivoli/tsm/TSM Error Log. Also select Rename non-Unicode filespaces during backup/archive. This is necessary when switching to a Unicode system such as TSM Client Version 5.3.
   
   
3. On the Backup panel, click the Compress objects option. Select root ("/") for the Domain List, and select anything that isn't root in the Exclude these domain(s) from backup box. Use Command-click to select multiple items.
   
   
4. On the Restore panel click the Ask user before replacing radio button.
   
   
5. I'm going to tell you how to add and Include/Exclude rule in Preferences because you should know. But I don't suggest you actually do it now. At the beginning, you have a lot of rules to add, and it's easier to paste them into your TSM Systems Preferences file directly. See INCLUDE/EXCLUDE System Preferences below for a list and instructions.
   
   If you were adding Include-Exclude rules now, here is how you would do it. On the Include-Exclude panel, if you use Firefox browser, you would add its cache:
   
   • With Backup selected from the Category dropdown list,
   • Pick Exclude.Dir from the Type dropdown list.
   • Type: /.../Library/Application Support/Firefox/.../Cache
     in the box. (Or cut -and-paste.) Note that there are no quotation marks.
   • Click Add. Note that the added Exclude rule has quotation marks.
   • Make sure what gets added looks exactly like the bottom statement in the illustration:
     EXCLUDE.DIR "/.../Library/Application Support/Firefox/.../Cache"
     If it doesn't match exactly, you probably won't be able to open TSM.
   • In the same way, also add the following; it was left out from the list in the TSM manual:
     EXCLUDE.DIR "/private/var/db/netinfo/local.nidb"
     
     
     See INCLUDE/EXCLUDE System Preferences below for these and lots more additions.
     
6. On the Scheduler panel click the Select button beside Schedule Log, then you can enter the filename of the TSM Schedule Log: /Library/Logs/tivoli/tsm/TSM Schedule Log and click Prune old entries and select a reasonable number of days to keep the entries.
   
   
   
7. The next preference panel that needs attention is Authorization.
   • Click Password Generate
   • Click Save Encryption key password locally.
   • Location: /Library/Logs/tivoli/tsm (same place as the log files)
   • Leave the Groups and Users alone. These specify which groups and users on your Mac may use TSM. The default is everyone, which is probably what you want.
     
     
     
8. Click OK, then quit TSM.
   
   
9. Start TSM for Administrators up again, login, and log back out again. This should create an encrypted password file in the directory with the TSM logs,
   /Macintosh HD/Library/tivoli/tsm/TSM.PWD
   Search in Finder for: tivoli to find this directory. 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. (TSM on the Mac doesn't seem to be able to tell a good password from a bad one, but a bad one won't create a TSM.PWD file.)

There are a bunch of other excludes that you'll probably want to enter into your TSM System Preferences file. These are the ones recommended in the TSM manual. I spent a fair while entering them and making sure they were right; so here is a list that you can cut and paste into:

/Macintosh HD/Library/Preferences/Tivoli Storage Manager/TSM System Preferences

EXCLUDE "/.../TSM Sched*"
EXCLUDE "/.../TSM Error*"
EXCLUDE "/.../Norton FileSaver Data"
EXCLUDE "/.../Norton VolumeSaver Data"
EXCLUDE "/.../Norton VolumeSaver Index"
EXCLUDE "/.../OpenFolderListDF"
EXCLUDE "/.../VM Storage"
EXCLUDE "/.../.hotfiles.btree"
EXCLUDE "/.../TheFindByContentIndex"
EXCLUDE "/.../.TheInvisiblePropertyStore"
EXCLUDE.DIR "/.vol"
EXCLUDE.DIR "/Network"
EXCLUDE.DIR "/dev"
EXCLUDE.DIR "/private/tmp"
EXCLUDE.DIR "/private/var/tmp"
EXCLUDE.DIR "/private/var/vm"
EXCLUDE.DIR "/private/var/db/netinfo/local.nidb"
EXCLUDE.DIR "/.../.Trashes"
EXCLUDE.DIR "/.../.Trash"
EXCLUDE.DIR "/.../.Spotlight-*"
EXCLUDE.DIR "/.../.Temporary Items"
EXCLUDE.DIR "/TheFindByContentFolder"
EXCLUDE.DIR "/TheVolumeSettingsFolder"
EXCLUDE.DIR "/System/Library/Caches"
EXCLUDE.DIR "/Users/.../Library/Cashes"
EXCLUDE.DIR "/.../Library/Application Support/Firefox/.../Cache"
EXCLUDE.DIR "/System Folder/Preferences/netscape A/Cache/"
EXCLUDE.DIR "/System Folder/Preferences/Explorer/Temporary Files/"
EXCLUDE.DIR "/System Folder/Preferences/cashe-cache/"
EXCLUDE.DIR "/System Folder/Preferences/netscape users/.../Cache/"

Make sure they are all right; a misplaced quotation mark will cause TSM not to open.

Here is a brief explanation of what the wildcard characters mean; for more information, see the manual, pp 25-33.

* matches at least 1 of any character

? matches exactly 1 of any character except /

/... matches matches zero or more directories; if it is used at the beginning of a filename, it can include a volume name

So, an example:

EXCLUDE /.../*.doc
INCLUDE "Volumes/La Pomme/Documents/*.doc"

Means "exclude all files that end in '.doc'", except "the include the files that end in .doc in the Documents folder of the La Pomme volume."

Note:

In addition to these files and directories, the TSM client will automatically add the following exclude statements to the include-exclude list in your TSM System Preferences file:

EXCLUDE.BACKUP "/.../Desktop DB"
EXCLUDE.BACKUP "/.../Desktop DF"
EXCLUDE.BACKUP "/.vol "
EXCLUDE.BACKUP "/automount"
EXCLUDE.BACKUP "/Network"
EXCLUDE.BACKUP "/dev"
EXCLUDE.BACKUP "/.vol/.../*"
EXCLUDE.BACKUP "/automount/.../*"
EXCLUDE.BACKUP "/Network/.../*"
EXCLUDE.BACKUP "/dev/.../*"
EXCLUDE.DIR "/.vol"
EXCLUDE.DIR "/automount"
EXCLUDE.DIR "/Network"
EXCLUDE.DIR "/dev"

Testing your include-exclude list.

After you make the modifications to your include-exclude list, you can use the Preview Include-Exclude ... command in the Utilities menu in TSM for Administrators to see which files will be sent to ADSM.

Preview opens a window on which you choose the type of function you're testing. That is always Backup for us. Then you can select whether you want to test Include, Exclude, or the default, All. In the lower half of the window is the kind of directory tree you will see when you backup using TSM. Use Local to select Macintosh HD (or whatever you normally run backups on).

At the bottom, you'll see the name of the file where the results will be written into: /Library/Logs/tivoli/tsm/dsmprev.txt
Click OK.

TSM User Preferences File and Some Necessary Changes:

Open: Macintosh HD/Library/Preferences/Tivoli Storage Manager/TSM User Preferences
by Control-Clicking on its name in Finder, selecting Open With, then selecting your favorite text editor (TextEdit.app, for example).

Add the following to it, after the SERVERNAME adsm.cc.uic.edu

MEMORYEFFICIENTBACKUP NO

MEMORYEFFICIENTBACKUP NO 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 it, in which case, just leave it out. Putting this option in is the difference between an incremental backup taking 4-6 hours and it taking less than an hour. The choice is obvious. When you save the file, make sure it doesn't get a .txt added to its filename.

Another thing that might need modified is the DOMAIN. It should be: DOMAIN "/"
which means the root volume, or, if you have more than one volume, all your volumes. If you had any other "volumes" mounted when you set TSM up, they will listed in your TSM User Preferences file; you should remove them.

Ada Byron's TSM User Preferences File looks like this:

SERVERNAME adsm-2.cc.uic.edu
COMPRESSALWAYS NO
MEMORYEFFICIENTBACKUP NO
DOMAIN "/"

TSM System Preferences File:

Open: Macintosh HD/Library/Preferences/Tivoli Storage Manager/TSM System Preferences
by Double-clicking on its name in Finder. You shouldn't have to make any additional changes to it.

Ada Byron's TSM System Preferences File looks like this:

SERVERNAME adsm-2.cc.uic.edu
AUTOFSRENAME YES
PASSWORDDIR /Library/Logs/tivoli/tsm
COMPRESSION YES
ERRORLOGRETENTION 5 D
SCHEDLOGRETENTION 5 D
PASSWORDACCESS GENERATE
MANAGEDSERVICES SCHEDULE

EXCLUDE "/.../TSM Sched*"
EXCLUDE "/.../TSM Error*"
EXCLUDE "/.../Norton FileSaver Data"
. . .
EXCLUDE.DIR "/System Folder/Preferences/Explorer/Temporary Files/"
EXCLUDE.DIR "/System Folder/Preferences/cashe-cache/"
EXCLUDE.DIR "/System Folder/Preferences/netscape users/.../Cache/"

NODENAME adabyron.adsm1
TCPSERVERADDRESS adsm-2.cc.uic.edu

The grayed out text in the center is the exclude statements listed in INCLUDE/EXCLUDE System Preferences above.

The 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. You should have set it when you were setting preferences in TSM. If not, you can add it here.

Most of the options were added by choices we made while setting preferences in the TSM GUI command.

1. Open your TSM client folder in your Mac X Applications folder and double-click on TSM Backup.
   
   If you set your TSM up to use Password Generate, you won't have to enter your ADSM password when you open TSM Backup. If you need your ADSM password and don't know it, use your netid and ACCC password to change it; see Already have an ADSM account but don't know your ADSM password?.
   
   
2. Click on the Backup button (the computer with the large arrow pointing out).
   
   
   
3. Now you should see the Backup screen. 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 checkmarked.
   
   
   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.
   
   (This image is for an incremental incremental backup, not a full one, which explains the only 373 files being backed up.)
   
   
8. Exit the TSM client: TSM Backup -> Quit TSM Backup

That's it for manual backups. You can run a manual backup whenever you please, but automated backups, which you are already set up for, are really the way to go. You just have to remember to leave your Mac on when you leave for the evening.

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 between 4 PM and 4 AM. 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. I don't know why.)

Figure 1: A sample log file, 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.

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. Type your email address in the box in the Watcher column to request the email message be sent to you.

A complete set of IBM/Tivoli manuals for ADSM are available online; there are links in the Related Links page.