How do I install and configure the ADSM backup client for Windows?
This page describes how to set up the Tivoli Storage Manager/IBM Spectrum Protect client software on your Windows computer, connect it to the UIC backup Server, schedule incremental backups, make sure the program is running properly, and optionally make an initial full backup. Your computer will need to be registered on the UIC backup server before you can begin.
Install the TSM Client Software on Your PC
- Download the installer and select your operating system, please be sure to select the proper operating system or else the install will not work. Save the installation file to your desktop.
- Stop all instances of the Tivoli Storage Manager client (services, interactive clients, etc.) before performing the install. You will need to reboot the your PC after the install if any part of the client is running during the install.
- You may uninstall any previous versions of ADSM or TSM if you wish, but you don't have to.
- Double-click on .exe file you downloaded previously (its name will vary) and confirm that you want to allow it to run. The Publisher is IBM Corporation. This will unpack all its files into a subdirectory of your current directory called TSMClient, and then it will quit.
- Change to folder TSMClient and then double click on file spinstall.exe. This starts the setup wizard which will guide you through the rest of the installation process.
- Location to save files: The first step is to select a location for the expanded installation files. Select a location and click Next. Keep track of this location; you can delete these files after you finish installing TSM.
- A window will open giving the status of the expansion. If you have installed TSM before, you may be asked whether you want to overwrite the files. Click Yes to all. This is important because names are reused from version to version; you don't want to get files from a previous version of TSM.
- Choose Setup Language: After it expands the files, the installer will ask you what language you want it to use for the install. US English is the default. Select the language you want from the drop-down list and click OK.
- You may get a pop-up screen about the installer needing to pre-install Microsoft Visual C++ packages, please install these for the program to function properly.
- After a couple of initialization screens, you will see the InstallShield Welcome screen; click Next.
- On the Destination Folder screen, choose the install location for the program; it is best to use the default: C:\Program Files\Tivoli\TSM\
You will need to know what this is for later in the installation so please take note of the location and click Next.
- On the Setup Type screen, select the Typical option. Click Next.
- On the Ready to Install the Program screen, Click Install to begin the installation.
- An InstallShield Wizard window will open giving the status of the installation, press Finish once it completes. Please restart your computer before proceeding if you are prompted to do so.
Initial Configuration of the TSM Client
Your configuration for the Tivoli Storage Manager Client program will be stored in the file dsm.opt in the folder where you installed the TSM client, typically C:\Program Files\Tivoli\TSM\baclient\. This file contains your ADSM nodeID, the Internet address of our ADSM server, and other information about communication methods and such, and a default set of Excluded files.
- Now open the TSM client and confirm that you want to allow it to run if asked.
Tivoli Storage Manager > Backup-Archive GUI
- We need to open the TSM Client Configuration Wizard.
- If you're starting from scratch, TSM should open the TSM Client Configuration Wizard automatically. If it does, click Next.
- If it does not open automatically, then select: Utilities > Setup Wizard.
- In the Option File Task screen, select Create a new options file if you are starting from scratch, which we assume in these instructions, and click Next. If you have an existing options file, it will give you the option to edit it.
- In the TSM authentication screen, type your ADSM node name in the box. If this is a server node, it will be of the form servername.dept.uic.edu. If it is a personal node, and the NetID is example1, their node name is example1.adsm1. Yours is similar -- your NetID followed by a period and adsm1, and click Next and press Allow if any sort of firewall program asks if you want TSM client to access the internet.
- On the TSM Client/Server Communications screen, keep the default selected TCP/IP and click Next.
- Next enter the Server Address and Port and click Next.
We have given you your own ADSM server associated with you ADSM account, with a Server Address of the form:
Thus the Server Address for the server node servername.dept.uic.edu above should be servername.dept.uic.edu.adsmserv.uic.edu and for example1's example1.adsm1 ADSM account it should be:
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 -- 1. You could have multiple accounts, in which case that number could be 2, 3...)
The Port in all cases is 1500.
- On the Recommended Include/Exclude List screen, click Select All then click Next.
- On the Common File Exclusion Selection screen, you can select the file extensions of the types of files that you never want to backup. Hold down Ctrl while selecting to pick multiple options. When you are done, click Next.
- Set the Domain for Backup screen as shown below then click Next.
- In particular, do not check Back up all local file systems.
- By default, in Windows, we only allow the C: drive to be backed up so only select that. Note that if your personal user data -- which is all the ACCC expects ADSM to be used to back up -- is on a different drive, such as your D: drive, send an email message to firstname.lastname@example.org explaining this and we will fix it for your node ID.
- Backup Type should be Incremental. Do not back up the SYSTEMSTATE.
- On the Confirm and Apply configuration screen, please select the Apply button.
- Please log in with your ADSM password when prompted to then select the Finish button once configuration has completed
- The TSM Main screen will open.
Set up Password Access Password Generate
If you want to use the automatic scheduler, you need to also use the option Password Access Password Generate. Password Generate is completely secure -- except for a situation where your PC is not physically secure. A physically secure computer is in a locked office or a locked suite of offices accessed only by trusted coworkers. A laptop is a physically insecure computer, since they are so frequently stolen. However, protecting an insecure computer with an overall Windows password can make it secure enough to use Password Access Password Generate. And you can always change your ADSM password; that expires the Password Generate password, requiring you to login again with the appropriate new ADSM password.
- Run the TSM Client by opening Backup-Archive GUI
- If the TSM main page opens without prompting you to login, your Password Access Password Generate is already set up and you can skip ahead to Set up the Schedule to Run Automatic ADSM Backups.
- If the login box opens, please type in your ADSM Password and click Login
- One of three things will happen next:
- You next see the Tivoli Storage Manager main window. This means your registration and password are in order.
- You get the error message Node ID unknown to server. This means either:
- This machine is not registered yet, or
- You used the wrong NetID when you generated your dsm.optfile.
If you are certain you typed your NetID correctly and you know your ACCC common password, verify your node name and password. If the confirmation email says you are already registered, record the node name it displays, and go back to double-check your work. The node name from the confirmation email must match the node name in file c:\Program Files\Tivoli\TSM\baclient\dsm.opt. If you did not receive the confirmation email, send a message to email@example.com for further assistance.
- It says Please enter your password again. This means your node name is registered OK, but you didn't type your password correctly. Try a second time. If you do not remember your ADSM password but you do know your ACCC common password, can use the ADSM Status Web utility to set a new ADSM password. If you cannot enter a good password at this point, click Cancel to exit the backup client program.
After you click Cancel, you may see the Tivoli Storage Manager main screen. This does not necessarily mean it worked. Close this instance of the backup client for now.
- After you get logged into the TSM client, on the TSM main screen, select Edit > Client Preferences.
- Click the Authorization tab; for Password Access, click Password Generate. Encryption Key Password should be Save encryption key password locally and Encryption Type should be 128-bit AES then press Okay.
- Close the TSM client.
- Now open the TSM client again:
Tivoli Storage Manager > Backup-Archive GUI
- Type your ASDM password if necessary and click Login. If you selected Password Access Password Generate, this should be the last time you will be asked for your ADSM password, and in fact, you no longer need to know or remember it. (Unless you change your ADSM password, in which case you will be asked for your new password - once.)
Set up the Scheduler to run automatic ADSM Backups
ADSM can be configured to perform an automatic incremental backup each evening after you go home. This automatic backup will create backup copies of any new files you've created or changed since the previous backup. Follow these instructions to enable automatic daily incremental ADSM backups on your PC. In order for the program to be able to run automatic backups, please make sure that you have Password Access Password Generate set up; you will know if it is enabled if the program does not prompt you for a password when you start it.
- On the TSM main screen, select Utilities Setup Wizard.
- From the list of TSM Client Configuration Wizards, check Help me configure the TSM Client Scheduler and then click Next, and then press Next again on the welcome screen.
- On the TSM Scheduler Wizard screen, only the selection for Install a new or additional scheduler should be available to be selected. Select radio button Install a new or additional scheduler and click Next. If Update a previously installed scheduler is not grayed out, use the bottom radio button, Remove a previously installed scheduler to delete it and restart the Wizard.
- On the TSM Scheduler name and Location screen, In the space for the name of the scheduler it should say: TSM Scheduler. Leave the check box for Use the Client Acceptor daemon empty and unchecked and click Next.
- In the Option file name and location screen, The name of the option file should already be filled in with the correct value, which will typically be:C:\Program Files\Tivoli\TSM\baclient\dsm.opt
If not, click Browse and find your dsm.opt file and click Next.
- On the TSM Authorization screen, the TSM node name should already be filled in with your registered ADSM node name, enter your ADSM password, but uncheck Contact the TSM Server to validate password.
- On the Service Login Options screen: For the account, select The System account. For when to start the service, select Automatically when Windows boots. Click Next.
- On the Log file names and locations screen, leave the client scheduler log set to: c:\program files\tivoli\tsm\baclient\dsmsched.log and the client error log c:\program files\tivoli\tsm\baclient\dsmerror.log. Click Enable event logging. Click Next.
- On the Immediate Start Option screen: Click Yes to start the TSM scheduler immediately. Click Next then click Apply on the next screen.
- On the Completing the TSM Client Configuration Wizard screen: Click Finish.
You can verify that the scheduler is set up properly and running as well.
How to Tell What The Scheduler Program Is Doing
During Boot and While the Computer is on
In all modern versions of Windows since XP, the TSM Scheduler will appear as a Local Service; to check: Open Settings and type Services in the Search place, and then in the Services screen find TSM Scheduler and/or TSM Client Acceptor. If only TSM Client Scheduler is present, it should display a status of Running and Startup Type of Automatic. If they are both present, they should both have a status of Running, but only the TSM Client Acceptor should have Startup Type Automatic. In that case where both are present, TSM Client Scheduler should have a Status of Running and Startup Type of Manual, because the Acceptor will start the Scheduler program only when needed.
From now on, do not turn your computer off when you leave for the day. Your TSM Scheduler will negotiate with the server to choose a start time for your daily backup, which will be a random time between 5 PM and 5 AM. (Energy saving tip: If you turn your computer off for weekends, and leave it on all week for backups, that will save half of the energy.) If you are backing up a laptop that you take home at night, send email to firstname.lastname@example.org and request that it be put on the daytime backup schedule for laptops. If your computer is on the daytime backup schedule, your TSM Scheduler will negotiate with the server to choose a start time for your daily backup, which will be a random time between 12 noon and 1 PM, presumably while you are at lunch.
After Each Backup
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.
You can verify the results of your backup locally as well, see any error messages that occurred, or see when the next scheduled backup will occur, by viewing file dsmsched.log that is located in the same folder where you installed the ADSM backup client, typically: C:\Program Files\Tivoli\TSM\baclient\dsmsched.log
To do this, find dsmsched.log in Windows Explorer, double-click it, and when it asks you which program to use to open this type file, select Notepad. After this, double-clicking on it will open the file automatically in Notepad. In Notepad, simply scroll to the bottom of the file to see what is going on, including any error messages, and when it plans to do your next backup. Right-click on dsmsched.log in Windows Explorer and drag it onto your desktop and select Create Shortcut Here to make a convenient desktop icon that will open the log so you can easily check the health of the Scheduler, in one step.
If the Scheduler is running OK, it should be waiting for the next scheduled backup window to start, and the last lines in the dsmsched.log file will look something like this:
01/08/2013 18:03:19 TSM Backup-Archive Client Version 6, Release 4, Level 0.0 01/08/2013 18:03:19 Querying server for next scheduled event. 01/08/2013 18:03:19 Node Name: EXAMPLE1.ADSM1 01/08/2013 18:03:20 Session established with server ADSM-4: AIX 01/08/2013 18:03:20 Server Version 6, Release 2, Level 2.30 01/08/2013 18:03:20 Data compression forced off by the server 01/08/2013 18:03:20 Server date/time: 01/08/2013 18:03:21 Last access: 01/08/2013 18:03:18 01/08/2013 18:03:21 --- SCHEDULEREC QUERY BEGIN 01/08/2013 18:03:21 --- SCHEDULEREC QUERY END 01/08/2013 18:03:21 Next operation scheduled: 01/08/2013 18:03:21 ------------------------------------------------------------ 01/08/2013 18:03:21 Schedule Name: DAILYINC 01/08/2013 18:03:21 Action: Incremental 01/08/2013 18:03:21 Objects: 01/08/2013 18:03:21 Options: 01/08/2013 18:03:21 Server Window Start: 17:00:00 on 01/08/2013 01/08/2013 18:03:21 ------------------------------------------------------------ 01/08/2013 18:03:21 Command will be executed in 2 hours and 16 minutes.
Starting and Stopping the TSM Scheduler
The TSM Scheduler is normally started each time you boot your computer. However, you may need to stop or restart it at other times, such as to force it to use a newly set password.
The TSM Scheduler runs as a Local Service. These are started and stopped by: Move your mouse over to the right side and open up the Search bar, click Settings and type in Services and select View Local Services then find TSM Scheduler and it should display a status of Running. To stop the service from running, right click it and select Stop. If the service is stopped and you want to start it again, right click it and select Start.
Start your first backup, manually.
This is an optional step, to make sure your first backup runs and that your configuration is set up correctly: Your ADSM registration must be complete and if you are not using Password Generate, you must know your ADSM password to perform this step. Note: This might take several hours. Start this initial full backup as the last thing before you leave at the end of the day and allow it to run overnight. Your future backup runs will only back up new and changed files since the last backup, and so will run much more quickly than this one.
- Open the TSM client: Tivoli Storage Manager > Backup-Archive GUI
- You should now see the Tivoli Storage Manager main screen. Click the Backup button.
- Now you should see this Backup window. You will be given the choice to make backups of your local, network, RAW (unformatted), or removable drives, and System Objects (your Registry and the like). Click the small gray box between the "+" and "Local", so that a checkmark appears in it.
The ACCC's policy is only to backup your C: drive. Note that if your user data -- which is the ACCC expects ADSM to be used to back up -- is on a different drive, such as your D: drive, send an email message to email@example.com explaining this and we will fix it for your node ID.
- Click the Backup button, and you should then see this Task List window change as files are backed up. If you have never used ADSM before, all files on your C: drive will be backed up during this first run, so this may take several hours to complete. Future backup runs will be much shorter incremental backups, which will only copy files that have been created or changed since the previous ADSM backup run.
- When the backup has completed, you should see the Backup completed dialog box.
That's it for manual backups. You can run a manual backup whenever you please, but after the first, you should be taken care of by scheduled backups.