Ahsay Systems Corporation Limited Page 1 of 6 May 22, 2009
Ahsay® Online Backup v5.5
AutoUpdateAgent Guide
We back up your business
Ahsay® Online Backup
AutoUpdateAgent GuideAhsay Systems Corporation Limited Page 2 of 6 May 22, 2009
Copyright Notice
The use and copying of this product is subject to a license agreement. Any other use is prohibited. No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system or translated into any language in any form by any means without the prior written consent of us. Information in this manual is subject to change without notice and does not represent a commitment on the part of the vendor. We do not warrant that this document is error-free. If you find any errors in this document, please report to us in writing.
This product includes software developed by the Apache Software Foundation (http://www.apache.org).
Trademarks
© 2008 Ahsay Systems Corporation Ltd. All rights reserved.
Ahsay, Ahsay Online Backup Suite, Ahsay Offsite Backup Server, Ahsay Online Backup Manager, Ahsay A-Click Backup, Ahsay Replication Server, Ahsay NAS Client Utility are trademarks of Ahsay Systems Corporation Limited.
Microsoft, Windows, Microsoft Exchange Server and Microsoft SQL Server and all Windows-based trademarks are registered trademarks of Microsoft Corporation. Sun, Solaris, SPARC, Java and Java Runtime Environment and all Java-based trademarks are registered trademarks of Sun Microsystems, Inc.
Oracle, Oracle 8i, Oracle 9i are registered trademarks of Oracle Corporation. Lotus, Domino, Notes are registered trademark of IBM Corporation.
Red Hat is the registered trademark of Red Hat, Inc. Linux is the registered trademark of Linus Torvalds.
Apple and Mac OS X are registered trademarks of Apple Inc. NetWare® is a trademark of Novell, Inc.
All other product names are registered trademarks of their respective owners.
Disclaimer
Ahsay Systems Corporation Limited Page 3 of 6 May 22, 2009
1 Introduction
To simplify client software upgrades, we had introduced AutoUpgrade in previous versions of Ahsay. But there were a number of limitations. In v5.2, we have built an automated system to help updating the client software and keep track of the versions. The new feature, “AutoUpdateAgent” (abbreviated as AUA), is intended for performing “UPDATES” (bi-direction, upgrade or downgrade) on the client side running as a service. It is more powerful and gives greater flexibility to system administrators. However, at the moment only the “UPGRADE” mode is enabled for AUA. Depending on the user preference, AUA would update the client side software whenever an updated version is found on the server. AutoUpdate can be enabled on AhsayOBS, and the steps are outlined below.
2 Creating Upgrade Files
The upgrade files windows.zip, linux.zip and solaris.zip are already bundled with AhsayOBS 5.2.x or above (at [OBS HOME]/webapps/obs/liveUpdate/obm5210)
2.1 Customizing Upgrade Files
Simply include the customized *.properties files for you backup client (i.e. the contents of your obm.zip) to the bin directory of windows.zip, linux.zip and solaris.zip.
2.2 Edit /obs/liveUpdate/index.xml
For upgrade from v5.1 to v5.2, add an entry of <AutoUpdate> to [OBS HOME]/webapps/obs/liveUpdate/index.xml as shown below.
<AutoUpdate product="obm" version="5.2.1.0" compatible="5.1.X.X" host="">
<patch os="Windows" url="/obs/liveUpdate/obm5210/windows.zip" include-users="*" exclude-users="" force="false" /> <patch os="Linux" url="/obs/liveUpdate/obm5210/linux.zip" include-users="*" exclude-users="" force="false" /> <patch os="Solaris" url="/obs/liveUpdate/obm5210/solaris.zip" include-users="*" exclude-users="" force="false" /> </AutoUpdate>
2.2.1 Insert TAG for Normal Upgrade (non-OS specific, same behavior as the previous auto upgrade logic)
Add an entry of <AutoUpdate> as shown in the following to /obs/liveUpdate/index.xml
<AutoUpdate product="obm" version="5.2.2.0" compatible="5.2.X.X" host="">
We back up your business
Ahsay® Online Backup
AutoUpdateAgent GuideAhsay Systems Corporation Limited Page 4 of 6 May 22, 2009
2.2.2 Filter value settings in index.xml:
Administrator is allowed to manipulate the update patch to be installed in target platforms according to the filter values in 1) product: Specify the product id (e.g. acb, obm) for different update patch according to their product id 2) compatible: Specify the compatible version (current version of obm)
3) host: Specify the hostname as viewed from client machine
4) os Specify the OS Family or exactly the OS Name of client machine 5) include-users: Specify the username you want to include
6) exclude-users: Specify the username you want to exclude
2.2.2.1 Filtering by <product> and <compatible>
We can basically identify a matching update from the <product> (product id) and <compatible> (compatibility) attributes. The following two TAGs will instruct the AUA to upgrade all acb and obm 5.2.1.X versions to 5.2.2.0, exclude all 5.2.0.X and 5.1.X.X
<AutoUpdate product="acb" version="5.2.2.0" compatible="5.2.1.X" host="">
<patch os="*" url="/obs/liveUpdate/acb5220.zip" include-users="*" exclude-users="" force="false" /> </AutoUpdate>
<AutoUpdate product="obm" version="5.2.2.0" compatible="5.2.1.X" host="">
<patch os="*" url="/obs/liveUpdate/obm5220.zip" include-users="*" exclude-users="" force="false" /> </AutoUpdate>
2.2.2.2 Filtering by <host>
We can apply update to specific host which is used by the client as the serving AhsayOBS hostname.
<AutoUpdate product="obm" version="5.2.2.0" compatible="5.2.X.X" host="www.companyA.com">
<patch os="*" url="/obs/liveUpdate/companyA/obm5220.zip" include-users="*" exclude-users="" force="false" /> </AutoUpdate>
<AutoUpdate product="obm" version="5.2.2.0" compatible="5.2.X.X" host="www.companyB.com">
Ahsay Systems Corporation Limited Page 5 of 6 May 22, 2009
2.2.2.3 Filtering by <os>
We can apply update to specific Operating System, We can apply FAMILY name or the exact name, as retrieved from java property “os.name”
<AutoUpdate product="obm" version="5.2.1.1a" compatible="5.2.1.1" host=""> <!-- The patch contains special components for Linux users only -->
<patch os="Linux" url="/obs/liveUpdate/obm5211a.zip" include-users="*" exclude-users="" force="false" /> </AutoUpdate>
<AutoUpdate product="obm" version="5.2.1.1b" compatible="5.2.X.X" host=""> <!-- The patch contains special components for Windows XP users only -->
<patch os="Windows XP " url="/obs/liveUpdate/obm5211b.zip" include-users="*" exclude-users="" force="false" /> </AutoUpdate>
2.2.2.4 Filtering by <include-users>
We can apply update to specific users, by including their name, or prefix of the name, to the <include-users> attribute. The following we are applying a patch to all testing accounts for testing purpose by including the prefix (testing.).
<AutoUpdate product="obm" version="5.2.1.1b" compatible="5.2.X.X" host="localhost">
<!-- The TAG is used for testing only, on the accounts e.g. testing.windows, testing.linux, testing.solaris .. etc -->
<!-- All other user will NOT use this TAG-->
We back up your business
Ahsay® Online Backup
AutoUpdateAgent GuideAhsay Systems Corporation Limited Page 6 of 6 May 22, 2009
3 Appendix – TAG Definition of http://hostname/obs/liveUpdate/index.xml
ATTRIBUTE Description
Examples
Used by TAG “AutoUpdate”
<AutoUpdate product="obm" version="5.2.1.0 " compatible="5.1.X.X" host="">
product Product ID of software
Must not change unless your customized version is using another ID. Used for naming in config folder in USER_HOME (.obm, .acb)
“obm”,”acb”
version Version No of the update patch In Version No. Format X.X.X.X
“5.2.1.0” ”5.2.1.0a” compatible Compatibility of the update patch, in Version No. Format X.X.X.X or superset X.X.X ,
X.X or X
“4.X” (== “4.X.X.X”) “5.1.X” (== “5.1.X.X) “5.1.1.X”
host Hostname of the server providing for updated patch, used for the Virtual-Hosting purpose
“eval.ahsay.com” “qa2.ahsay.com” Used by TAG “patch”
<patch os="Windows" url="/obs/liveUpdate/upgrade51/windows.zip" include-users="*" exclude-users="" force="false" /> <patch os="Mac" url="/obs/liveUpdate/upgrade51/mac.zip" include-users="*" exclude-users="" force="false" /> <patch os="Linux" url="/obs/liveUpdate/upgrade51/linux.zip" include-users="*" exclude-users="" force="false" /> <patch os="Solaris" url="/obs/liveUpdate/upgrade51/solaris.zip" include-users="*" exclude-users="" force="false" /> <patch os="NetWare" url="/obs/liveUpdate/upgrade51/netware.zip" include-users="*" exclude-users="" force="false" />
os The target OS name as retrieved by java property "os.name" Accept Family Name and Exact Name 1) Windows
Windows 95, 98, Me
Windows NT, 2000, XP, 2003, CE 2) Linux
3) Mac OS
Mac OS, Mac OS X 4) Solaris
Solaris, SunOS 5) NetWare NetWare 6.50.06 include-users Username filter to include related users “vip.*”, “*.vip” exclude-users Username filter to exclude related users “eval.*”, “*.eval”