advertisement
Ahsay Offsite Backup Server
v6
Administrator’s
Guide
Ahsay Systems Corporation
Limited
5 March 2014
Ahsay Offsite Bac kup Server
Ahsay Offsite Backup Server
Administrator’s Guide
Administra tor’s Guide
Copyright Notice
© 2014 Ahsay Systems Corporation Limited. All rights reserved.
The use and copying of this product is subject to a license agreement. Any other use is pr this publication may be reproduced, transmitted, transcribed, stored in a retrie val system or translated into any language in any form by any means without priori written consent of Ahsay Syste
Information in this manual is subject to change without notice and does not repres ohibited. No part of ms Corporation Limited ent a commitment on the part of the vendor, Ahsay Systems Corporation Limited does not warrant that this document is error free. If you find any errors in this document, please report to Ahsay Systems Corporation Limited in writing.
This product includes software developed by the Apache Software Foundation ( http://www.
apache.org/ ).
Trademarks
Ahsay, Ahsay Online Backup Suite, Ahsay Offsite Backup Server, Ahsay Online Backup Manager
Backup, Ahsay Replication Server, Ahsay BackupBox Firmware, Ahsay Universal Backup ademarks of Ahsay Systems Corporation Limited.
, Ahsay A-Click
System, Ahsay NAS
Client Utility are tr
Microsoft, Windows, Microsoft Exchange Server and Microsoft SQL Server are registered trademarks of
Microsoft Corporation.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names ma y be trademarks of their respective owners.
Oracle, Oracle 8i, Oracle 9i, Oracle 10g, Oracle 11g are registered trademarks of Oracle Corporation.
Lotus, Dom ino, Notes are registered trademark of IBM Corporation.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo and JBoss are registered tradema www.redhat.com in the U.S. and other countries. Linux is a registered trademark of Linus T
Apple and Mac OS X are registered trademarks of Apple Computer, Inc.
All o ther product names are registered trademarks of their respective owners. rks of Red Hat, Inc. orvalds.
Disclaimer
Ahsay Systems Corporation Limited will not have or accept any liability, obligation or responsibility whatsoever for any loss, destruction or damage (including without limitation consequential loss, destruction or damage) however arising from or in respect of any use or misuse of reliance on this document. By reading and following the instructions in this document, you agree to accept unconditionally the terms of this Disclaimer and as they may be revised and/or amended from time to time by Ahsay Systems Corporation Limited without prior notice to you.
Ahsay Systems Corporation Limited
V6.17.0
Ahsay Offsite Backup Server
Administrator’s Guide
Revi sion History
Date
8 April 2011
Description
First revision for Ah sayOBS v6.3 Release
30 May 2011
New:
4.17 Use Windows Event Log
15 Multiple Thread Support
16 Create a “Read Only” or Non Admin System User
Up dated:
9.1 My Profile / Edit System User
30 June 2011
30 July 2011
Updated:
1.3 System Requir
4.8 Windows Active
4.9 Redirector ements
Directory (AD) Authentication Setting
5.3 Evaluation Expiry and Free Edition
16.5 AutoUpdate Limitations
24 External API R
25 Further Inform eferences ation
New:
3.19 AhsayOBS Service on AhsayUBS Server with ZFS
16 .6 AutoUpdate Changes
16.6.1 Attributes Changes
16.6.2 Multiple AhsayOBM/A hsayACB Versions Selection
16.6.3 Multiple Host
16.6.4 Backup
Values
User Account Selection
Updated:
3.18 Ahsa yOBS Reseller Panel and AhsayRDR
12.4 Delta Me rge Queue
19.1 Installing a trusted SSL certificate
24.35 Get Backup Job Progress
24.37 List User Gr
24.38 Modify Us
24.43 List Backup Job Mode
24.5 Adding User
24.8 Listing Users oups er Group
25 Further Information
30 September 2011 New:
4.18 Configuration Recovery
4.18.1 Setup
4.18.2 Backup Process
4.18.3 Configuration Archival File Limits
4.18.4 Configuration Archival Storage Retention
4.18.5 Restoring Configuration Files
6.18 Configuration Archival
9.3.1 Customize Reseller Reports
Ahsay Systems Corporation Limited
V6.17.0
Ahsay Offsite Backup Server
Administrator’s Guide
9.6 Recovering a System User/Non-admin Password
9.7
Reseller Backup User Account Restrictions
Update d:
3.18 Ahsa yOBS Reseller Panel and AhsayRDR
4.9 Redirector
8.4 Delta Merge
9 Manage System User (Reseller Panel)
Interface
9.3 Customize
10.4 Managing U ser Profile
12.1 Introducti on
12.2 Delta Merge Policy
Process rge Queue
12.3 Delta Merge
12.4 Delta Me
12.5 Limitations
12.6 Delta Merge E xamples
16.1 How it works
16.2 Using AutoUpdate
16.4 Forcing an extra AutoUpdate
16.5 AutoUpdate Limi
16.6 AutoUpdat tations e Changes
16.6.4 Backup User Account Selection
24.8 Listing Users
2 4.13 Get Backup Set
24.16 Li sting Backup Job Status
24.38 Modify User Group
15 November 20 11
New:
3.21 Maximum Number of Backup Sets for a Backup User
Ac count
9.9 Auto Update
16.7 Enable AutoUpdate on Ahsa tch
3.3 AhsayOBS Java Heap Si
3.9 AhsayOBS S yUBS
Appendix E How can I rebuild an AhsayOBS server from scra
Appen dix F How to start up AhsayRPS as AhsayOBS
Updated: ze Settin g erver Scaling
3.18 AhsayOBS Reseller Panel and AhsayRDR
3.20 AhsayOBS an d AhsayRDR and Wild Card SSL
Certificates
4.9 Redirector
9.1 My Profile / Edit System User
9.6 Recovering a System User/Non-admin Password
11.3 Group Policy Limitations and Restrictions
16.6.4 Backup User Account Selection
24.26 Add Advertisement
17 January 2012
New:
9.10 Change Ownership
Ahsay Systems Corporation Limited
V6.17.0
Ahsay Offsite Backup Server
Administrator’s Guide
9.10.1 Migrating user
9.10.2 Match ed host t s from administrator to reseller ransfer
9.10.3 Mismatched host tr ansfer
9.10.4 Reminder ema il
9.10.5 Suggestions and Best Practice
9.10.6 Common error messages
Updated:
4 Server Configur ation
8 Managing Other Options
12.3 Delta Merge Process
Merge
Authorization s 12.6 Delta
24.4 User
24.5 Adding User
24.6 Modifying Us
24.7 Deleting User
24.8 Listing User s
24.9 Getting User I
24.10 Adding a B er Profile t ackup Set
24.11 Deleting a Back up Set
24.12 Listing Backup S ets
24.13 Get Backu p Set
24.14 Updating a Backup S et up Jobs ing Backup Job Status
R b eport Summary
24.15 Listing Back
24.16 List
24.17 Getting Backup Job Report
24.18 Getting B ackup Jo
24.19 Listing Backu
24.20 Getting Us
24.21 Listing User p Files er Storage Statistics
Storage eplication Mode orgot Password Email
24.22 Get License
24.23 Get R
24.24 Send F
24.25 Delete
24.26 Add
Backup File
Advertisement
24.27 List Advertisem
24.28 Modify
24.29 Delete Ad
24.30 Add AdGr
24.31 List AdG oup roups
24.34 Run Backup ents
Advertisement vertisement
24.32 Modify AdGroup
24.33 Delete AdGroup
24.35 Get Backup Job Progress
24.36 Add User Group
24.37 List User Groups
24.38 Modify User Group
24.39 Delete User Group
24.40 List Policy Groups
24.41 Add User Groups to Policy Group
24.42 Delete User Group from Policy Group
Ahsay Systems Corporation Limited
V6.17.0
Ahsay Offsite Backup Server
Administrator’s Guide
13 February 201 2
24.43 List Backup Job Mode
24 .44 List System Users
Updated:
4 Server Con figuration
4.1 User Languages Setting
4.11 Features Setting
9 Manage System User (Re seller Panel)
9.3.1 Customize Reseller Reports
10.1 Create Backup User
19.1 Installing a trusted SSL certificate
Date Descriptions
23 Apr 201 2 24.3 IP Restrictions
04 May 201 2 9.1 My Profile / Edit System User
07 May 201 2 19.1
Installing a trusted SSL certificate
Type of modification
Modified
4.18.3 Configuration Archival Fi
26 Apr 201 2 4.9 Redirector
6.13 le Limits Modified
Modified
Modified
Modified
Modified
15 May 201 2 19 Secure connection with Ahsa yOBS
10 Jul 2012 12.6 De lta Merge Examples
Modified
19.3 Install code signing cert w ith the restorer applet
New
25 Jun 201 2 3.14 Restricting Acce ss on Adm
Panel inistratio n Modified
3.16 AhsayOBS File System Tuning Typo
Modified
17 Jul 2012
30 Jul 2012
12.3 Delta Merge Process
13.2 Account Lockout Rul es
Modified
Modified
17 Aug 201 2 24.6 Modifying User Profile
29 Aug 201 2 2.1 Setting started
3.14 Restrictin
Panel g Access on Adm
4.6 Email System Setting
Modified
Modified inistration M odified
Modified
5.1 Licensee Name and License Key Modified
9 Managing Sy stem Diagnosis
10.2 SMTP Settings
25.6 Modifying User Profile
25.13 Get Backup Set
New
Modified
Modified
Ty po, modified
Appendix D Error Code 1011 and 1012 Typo, modified
30 Aug 2012 10 Manage System User (Reseller Panel) Modified
10.1 My Profile / Edit System User
10.3 Customize Interface
10.4 Add System User
10.5 List / Remove System User
Modified
Typo
Modified
Typo
Ahsay Systems Corporation Limited
V6.17.0
Ahsay Offsite Backup Server
Administrator’s Guide
10.6 Recovering a System User admin Password
/Non-
10.7 Reseller Backup User Acco unt
Restrictions
25 Sep 201 2 25.8 Listing Users
06 Jun 201 3
25.9 Gettin g User Information
25.21 Listing Users Storage
04 Oct 201 2 Copyright N otice
22 Oct 201 2 25.1 Overvi ew
25.5 - 25.44 (API)
Modified
Modified
Modified
Modified
Modified
Modified
Modified
Modified
Modified
02 Nov 201 2 5 Software License
30 Jan 201 3 5 Software License
08 Feb 201 3 25.13 Get Backup Set
25.16 Listing Backup Job Statu s
Modified
Modified
Modified
Modified
Modified
25.18 Getting Backup Job Repo rt
Summary
14 Feb 201 3 4.18.2 AhsayOBS Configura tion Files
Modified
Modified
4.18.3 Conf iguration Archival Fi le Limits
19 Feb 201 3 U
Modified
Modified
05 Mar 201 3 25.6 Modifying User Profile
11 Mar 201 3 17.7 Enable AutoUpdate o n Ahs ayUB S
19 Apr 201 3 25.13 Get Backup Set
25.34 Run Back up
20.3 Import pfx certificate key store into Java
07 Jun 201 3 3.4 How many co
AhsayOBS are a ncurrents con llowed? nection o n
3.5 AhsayOBS QPS Settings
08 Jul 2013
20.1 Installing a tru sted SSL certificate
20.2 Renew a trusted SSL certi
25.5 Adding User
25.6 Modifying User Pro file ficate
Modified
Modified
Modified
Modified
Modified
New
New
Modified
Typo
Modified
Modified
Modified 23 Sep 201 3 6.17 Cyclic Redu
Checking ndancy Check (CRC)
07 Oct 2013 4.6 Email System Setting
26 Feb 2014 12.1 About Group Policy
12.5.1 Manage Policy Group
12.5.6 Exclude File Size Over Policy
12.5.7 Exclude Network Share Policy
25.9 Getting User Information
25.40 List Policy Groups
28 Feb 2014 25.13 Get Backup Set
Modified
Modified
Modified
New
New
Modified
Modified
Modified
Ahsay Systems Corporation Limited
V6.17.0
Ahsay Offsite Backup Server
Administrator’s Guide
Table of Contents
.........................1
1.2 Definitions, Acronyms and Abbreviation .........................................
.........................1
.........................4
3 B est Practices and Recommendations ......................................................
AhsayOBS Java Heap Size Setting...................................................
How many concurrent connections on AhsayOBS are allowed? .....
6 Use a Static IP Address.....................................................................
.......................11
7 Scheduling of Backup Jobs on AhsayOBS.......................................
.......................12
3.8 Enable Replication on AhsayOBS ....................................................
Server .......................12
3.10 Anti-Virus Software on AhsayOBS......................................................
...................12
3.11 Enable CRC Checking ......................................................................
3.12 Running AhsayOBS as a non-root user ............................................
.......................12
3.13 Expose only TCP port 80 and 443 to the public ...............................
3.14 Restricting Access on Administration Panel.....................................
3.16 AhsayOBS File System Tuning ............................................................
Network Load Balancing Configuration..........................................
..................14
3.18 AhsayOBS Reseller Panel and AhsayRDR ...........................................
..................14
AhsayOBS Service on AhsayUBS Server with ZFS ........................
AhsayOBS and AhsayRDR with Wild Card SSL Certificates .........
.......................14
3.21 Maximum Number of Backup Sets for a Backup User Account...........
..................15
.......................16
4.1 User Languages Setting ....................................................................
4.2 System Login Name/Password .............................................................
...................21
4.3 Host .......................22
4.4 System Home, Policy Home and User Home Directories ....................
...................22
4.5 Single Level Access..........................................................................
4.6 Email System Setting...........................................................................
4.7 Proxy .......................24
4.8 Windows Active Directory (AD) Authentication Setting.................
.......................24
.......................25
4.12 Permission Updated Files ........................................................................................27
4.14 Auto User Home Allocation ....................................................................................28
4.16 Free Trial Setting .....................................................................................................28
4.17 Use Windows Event Log .........................................................................................29
[Ahsay Systems Corporation Limited i
Ahsay Offsite Backup Server
Administrator’s Guide
4.18.3 Configuration Archival File Limits ..............................................
4.18.4 Configuration Archival Storage Retention ...............................
.......................33
4
.18.6 Restoring Configuration Files...................................................
.......................36
.......................38
Licensee Name and License Key ......................................................
Automatic License Renewal .............................................................
5.3 Evaluation Expiry and Free Edition..................................................
.......................42
5.4 Offline License Activation.....................................................................
..................44
5 License Management Portal..............................................................
M anaging Routine Job ..............................................................................
.......................47
.......................49
Online Restore Report.......................................................................
.......................49
Setting Change Report ......................................................................
.......................49
6.4 Missed Backup Report...........................................................................
6.5 Inactive User Report .........................................................................
6.6 Off-line Backup Reminder...................................................................
....................50
6.7 Backup Quota Reminder...................................................................
.......................50
6.8 Trial User Reminder ............................................................................
....................51
...................51
....................51
Error .......................52
6.12 Inactive User Removal..........................................................................
...................52
...................52
Rebuild User Storage ........................................................................
.......................53
.......................53
..................54
6.17 Cyclic Redundancy Check (CRC) Checking.........................................
..................54
.......................55
7 Managing .......................56
..................57
8.1 In-File Delta Settings for all AhsayACB users.................................
.......................58
...................59
...................60
Full .......................60
.......................61
8.8 Advertisements .................................................................................
9 Managing System Diagnosis............................................................................................65
10 Manage System User (Reseller Panel).........................................................................68
10.1 My Profile / Edit System User .................................................................................69
10.3.1 Customize Reseller Reports.............................................................................75
10.4 Add System User .....................................................................................................76
10.5 List / Remove System User......................................................................................77
10.6 Recovering a System User/Non-admin Password ...................................................78
[Ahsay Systems Corporation Limited ii
Ahsay Offsite Backup Server
Administrator’s Guide
10.7 Reseller Backup User Account Restrictions .....................................
10.8 Reseller Web SSL Certificate Installation .............................................
..................80
10.10 Change .......................82
10.10.1 Migrating users from administrator to reseller .....................
.......................83
10.10.2 Matched host transfer..................................................................
.................85
10.10.3 Mismatched host transfer......................................................
.......................85
10.10.4 Reminder .......................89
1
0.10.5 Suggestions and Best Practice ..............................................
.......................90
1
0.10.6 Common error messages.......................................................
11 Managing Backup Users ......................................................................
.......................93
11.1 Create Backup User ..........................................................................
11.2 List / Remove Backup User ..............................................................
11.3 Broadcast messages to backup users....................................................
....................96
11.4 Managing User Profile......................................................................
.......................97
11.5 Managing Backup Set ...........................................................................
1 1.6 Initiating Backup from AhsayOBS..................................................
................103
11.7 Browsing User Backup File ..............................................................
11.8 Reviewing User Backup Report........................................................
11.9 Reviewing User Storage Statistics ....................................................
.................106
12 Group Policy Management .......................................................................
.................107
.................107
12.2 Best Practices for using Group Policy .................................................
..................109
12.3 Group Policy Limitations and Restrictions...........................................
.....................111
.....................113
.................113
12.4.2 Manage User Group..................................................................
.....................114
12.5 Policy .....................120
12.5.1 Manage Policy Group ...............................................................
12.5.2 Shared Quota Policy .................................................................
.....................122
12.5.3 Backup Set Setting Policy.........................................................
1 2.5.4 Backup User Policy Control .....................................................
.....................127
1 2.5.5 Global Filter Policy...................................................................
1 2.5.6 Exclude File Size Over Policy ..................................................
2.5.7 Exclude Network Share Policy .................................................
12.5.8 Shared Backup User Policy ............................................................
12.5.9 System Users Policy Control .......................................................
..................134
13 Delta Merge Technology ..........................................................................
.................136
..................136
13.2 Delta Merge Policy ................................................................................................136
13.3 Delta Merge Process ..............................................................................................136
13.4 Delta Merge Queue ................................................................................................137
13.5 Limitations .............................................................................................................138
13.6 Delta Merge Examples...........................................................................................140
14.1 Configuration .........................................................................................................145
14.2 Account Lockout Rules..........................................................................................146
[Ahsay Systems Corporation Limited iii
Ahsay Offsite Backup Server
Administrator’s Guide
14.4 Account Lockout on AhsayOBS/AhsayRDR ...................................
.....................148
Account Lockout on AhsayOBM/AhsayACB..................................
1
4.6 Account Lockout Auditing ...............................................................
15 Multiple Thread Support.......................................................................
16 Create a “Read Only” or Non Admin System User ..............................
.................153
.................153
.................154
..................154
17.4 Forcing an extra AutoUpdate................................................................
17.5 AutoUpdate .....................154
.....................155
17.6.2 Multiple AhsayOBM/AhsayACB Versions Selection..............
1 7.6.3 Multiple Host Selection ............................................................
.....................157
17.6.4 Backup User Account Selection ...............................................
1
7.7 Enable AutoUpdate on AhsayUBS...................................................
18 Backup / Restore files using off-line media..........................................
18.1 Seed loading backup files (Import)...................................................
18.2 Saving backup files to off-line media (Export).................................
.....................162
19 High Availability & Load-Balancing Configuration ............................
20 Secure connection with AhsayOBS ............................................................
...............164
20.1 Installing a trusted SSL certificate.......................................................
................164
20.2 Renew a trusted SSL certificate...........................................................
20.3 Import pfx certificate into Java keystore ..........................................
20.4 Enforcing SSL to the web interface ..................................................
20.5 Install code signing cert with the restorer applet ..............................
.....................172
.....................176
..................176
21.3 Reviewing Restored File Log ..............................................................
21.4 Reviewing Backup Error log ............................................................
21.5 Reviewing Replication Log ..............................................................
.....................181
22 Branding AhsayOBM & AhsayACB....................................................
23.1 Welcome .....................183
23.2 Different welcome pages for different domains ...............................
.....................183
2
3.3 Customizing the company logo displayed ........................................
.....................183
23.4 Customizing the Look and Feel of the web interface .......................
.....................186
23.6 Customizing email reports .....................................................................................187
23.7 Localizing the software..........................................................................................188
24.1 Listening to non-standard TCP/IP Port..................................................................189
24.2 Listening to a single IP address .............................................................................190
24.3 Restricting access to system page by IP address ...................................................191
25 External API References............................................................................................193
25.1 Overview................................................................................................................193
[Ahsay Systems Corporation Limited iv
Ahsay Offsite Backup Server
Administrator’s Guide
..................193
..................193
.................196
25.6 Modifying User Profile .....................................................................
.................207
25.8 Listing .....................208
9 Getting User Information..................................................................
25.10 Adding a Backup Set ....................................................................
.....................214
25.11 Deleting a Backup Set...................................................................
25.12 Listing Backup Sets ......................................................................
25.13 Get Backup Set .............................................................................
.....................220
25.14 Updating a Backup Set..................................................................
25.15 Listing Backup Jobs......................................................................
.....................228
25.16 Listing Backup Job Status.............................................................
.....................230
Getting Backup Job Report................................................................
Getting Backup Job Report Summary ..........................................
................235
25.19 Listing Backup Files .....................................................................
25.20 Getting User Storage Statistics .....................................................
25.21 Listing Users Storage.........................................................................
................245
25.23 Get Replication Mode ........................................................................
25.24 Send Forgot Password Email .............................................................
................249
................253
.....................258
.....................259
................260
25.34 Run .....................262
25.35 Get Backup Job Progress ..............................................................
25.36 Add User Group............................................................................
Modify User Group.............................................................................
...............270
.....................272
.....................273
25.41 Add User Groups to Policy Group................................................
25.42 Delete User Group from Policy Group .........................................
25.43 List Backup Job Mode .......................................................................................282
25.44 List System Users ..............................................................................................284
Appendix................................................................................................................................288
Appendix A Supported Language Code.........................................................................288
Appendix B Supported Time zone .................................................................................289
Appendix C Product Documentations............................................................................291
Appendix D Error Code 1011 and 1012.........................................................................292
[Ahsay Systems Corporation Limited v
Ahsay Offsite Backup Server
Administrator’s Guide
Appendix E How can I rebuild an AhsayOBS server from scratch..........
.....................294
Appendix F How to start up AhsayRPS as AhsayOBS .................................................295
[Ahsay Systems Corporation Limited vi
Ahsay Offsite Backup Server
Administrator’s Guide
1
Overview
1.1 Conventions
A list of not tions that are used throu ghou t this document.
Convention Descriptions
Bold
Important Information
Italic
[]
%%
$
italic
Folder Path or File Path
Graphical Interface Elem ents
Filepath in Windows format
Filepath in Linux/Unix/BSD form at
Command
Example
WARNIN check obr p roc
G: You must
the timestamp of
A.jar before eeding to step2.
/u sr/local/obs/conf
[Manage L og]
%OBSR_HOME%
$OBSR_HOME
mkdir /usr/local/obs
Notation that are us ed specificially for API section:
Convention Descriptions
<Text Inside bracket s> angle Placeholder for which you must supply a value.
[Text inside square brackets]
{Text insides braces}
Vertical bar (|)
Set of required items; choose one.
Separator for mutually exclusive items; choose one.
Ellipsis (…) Items that can b e repeated.
1.2 Definitions , Acronyms and A bbreviation
Term/Abbreviation Definition
AhsayOBS
AhsayRPS
AhsayRDR Ahsay™ Redirector Server
AhsayOBM
Ahsay™ Offsit e Backup Server
Ahsay™ Online Backup Manager
AhsayACB Ahsay™
OBSR_HOME The
Ahsay Systems Corporation Limited 1
Ahsay Offsite Backup Server
Administrator’s Guide
OBSR_HOME_BA K
Windows
C:\Program Files\AhsayOBS and AhsayRPS
Linux/FreeBSD/Solaris
/usr/local/obs/
Th e backup location of AhsayOBS & AhsayRPS. It is used temporary during the install/upg
Windows rade process.
C:\Program Files\AhsayOBS and AhsayRPS.bak\
CONF_HOME
USER_HOMES
Linux/FreeBSD/Solaris
/usr/local/obs.bak/
The backup used tempora location of AhsayOBS & AhsayRPS. It is ry during the install/upgrade process.
Windows
%OBSR_HOME%\conf
Linux/FreeBS D/Solaris
$OBSR_HOME /conf
The directories where AhsayOBS and Ah the AhsayOBM & AhsayACB users a sayRPS store ccounts.
The default location i s:
%OBSR_HOME%\users
POLICY_HOME The directory whe re AhsayOBS and AhsayRPS store its system users and group policy inform
Windows
% OBSR_HOME%\system\policy
ation.
SYSTEM_HOME
Linux/FreeBS D/Solaris
$OBSR_HOME \system\policy
The directory where AhsayOBS and Ahs ayRPS store its system information.
Windows
%OBSR_HOME%\system\
Linux/FreeBSD/Solaris
$OBSR_HOME\system\
WEBAPPS_HOME Location the webapps directory inside the installation directory of AhsayOBS & AhsayRPS.
2 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
RECEIVER_HOME
Windows
%OBSR_HOME%\webapps.
Linux/FreeBSD/Solaris
$OBSR_HOME\webapps
WEBAPP_HOME_ BAK A backup of the webapps directory inside AhsayOBS and AhsayRPS.
Windows
%OBSR_HOME%\webapps.bak
Linux/FreeBSD/Solaris
$OBSR_HOME\webapps.bak
The location where the replicated data is stored for a particular replication receiver.
JAVA_HOME The
1.3 System Requirements
Please refer to the Ahsay Help Centre Article #2323 for system requirements of AhsayOBS v6.
It is recommended to install AhsayOBS on server grade O/S and hardware platform. However, for evaluation purposes installation on
Windows XP or Windows 7 platforms would be fine for testing.
Ahsay Systems Corporation Limited 3
Ahsay Offsite Backup Server
Administrator’s Guide
2
Quick Start
This chapter describes the minimum steps required to start using AhsayOBS.
Please consult the information in the following chapters for a complete reference to all fe atures available in AhsayOBS.
2.1 Getting started
To setup your AhsayOBS, please do the foll owings:
Setup Your Backup Server
1.
Point your browser to http://<your-obs-server>.
2. Login as AhsayOBS administrator.
The default login name and password are “system” and “system” respectively.
3. Set your hostname.
Ahsay Systems Corporation Limited 4
Ahsay Offsite Backup Server
Administrator’s Guide
Enter a resolvable hostname for your backup server (e.g.
compan
backup.youry.com) into the [Host Name] text field. Although you can supply an IP address here, it is pref erable to use a hostname instead.
If you are using custom TCP port for HTTP/HTTPS conne
80 or 443), you need to append the custom port numbe
Name] field. ction (i.e. non r to the [Host e.g. backup.yourcom
pany.com:8080
If you are not using custom TCP port, open a browser on server and type in the value of [Host Name] as an URL an get the backup server homepage. If you are not able to c
[Host Name] fiel d.
the backup d check if you onnect to the webpage, please try until you can reach it and put this value in the
4.
Set the [User Homes] directory.
[User Homes] ref ers to directories where AhsayOBS stores the backup files and backup log for all its users. You should set [User Homes] to directories where there are lots of free spaces.
5.
Set your SMTP Server.
Enter a resolvable hostname (or an IP address) of your SMTP server into the [SMTP Server] text field. There is a test button at the end of each
SMTP settings to test the connection. The testing result will be displayed next to the test button.
If your SMTP server is not running on standard SMTP ports (i.e. port 25), you can append your custom port number to your SMTP server address to use this server e.g. mail.your-company.com:8025.
5 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
You are only required to enter the [Login Name] a
SM nd [Password] if your
TP server enquires user authentication when sending emails.
Note:
SMTP server with Tr ansport Layer Security (TLS) is not supported.
6. Press the [Update] button.
7. Enter your license key (You ca n skip this step if you are evaluating this software). There is a connection test button underneath th entry box to test the connection to our license server. The will be displayed next to the test button. e license field
testing result
Enter the licensing information printed on [End User License Agreement] pri ntout into the text field provided in the [Manage System] ->
[Software License] panel. Please note that both [License
[License Key] are case sensitive. e Name] and
Note:
By default AhsayOBS service listens to port 80 for h
443 for https. Please make sure your servers co
nfigured to allow incoming access via these ports.
ttp and port
firewall is
Add Backup User
You need to add backup user to the system before you can sta data to A followings: rt backing up hsayOBS. To add a backup user to the system, please do the
1. Click the [Manage User] link available at the top menu and choose [Add user].
2. Enter the user information for the new user account into the form provided.
Ahsay Systems Corporation Limited 6
Ahsay Offsite Backup Server
Administrator’s Guide
Key
Login Name
Password
Alias
Time zone
Description
Login Name of the new account.
Password of the new account.
Another name of th e new account.
Time zone of the new account
Language
Backup Clie nt
Preferred language for email report of the new account.
Choose Ah sayOBM client or AhsayACB client.
Advertise G roup Choose whether advertisements are displayed at the
of the AhsayOBM/AhsayACB client bottom
Type Trial User – Account of this type will be deleted from the system after an inactivity period of 30 days by default.
Paid User – Account of this type will s system until it is removed form the s administrator. tay within the ystem by
Welcome email Check this option to send a welcome email to the user.
User Home
Email address of the new account.
The top directory where the software stores backup files and all other information for the new account.
7 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Backup Quota Backup Quota of the new acc ount.
Bandwidth Bandwidth throttling for this user account.
Add-on modules Add-on modules for this user account.
3. Press the [Add] butto n to create the user.
4. The account is now ready.
Login and Run Backup
1. Point your browser to http://<your-obs-server>/.
2. Click the [User Login] link at the top.
3. Login with the login name and password you have created in previous section.
4. Follow the [Quick Start] information available in the User’s Guide to install the AhsayOBM or AhsayACB onto users computer to start backing up data.
Ahsay Systems Corporation Limited 8
Ahsay Offsite Backup Server
Administrator’s Guide
3
Best Practices and Recommendations
This chapter lists out all best practices and recommendations which should consider before deploying AhsayO
you
BS to a production environment.
3.
1 AhsayOBS Hardware Requirements
AhsayOBS should be installed on a machine supporting 64 bi t multiple CPU and multiple cores. A 64 bit Operating System will allow Ahsa on a 64 bit Java JRE platform, as 64 bit Java is capable of supporting larger
Java heap size settings. This type of configuration will pro yOBS to run vide sufficient capacity for future business expansion, to meet the need customers, and to support new AhsayOBS server features. s of exisiting
A more powerful machine will also reduce the need for freq upgrades, which will require s uent hardware ervice down time for data migration.
It is a good idea to ensure your A hsayOBS server is equipped with some redundancy features, i.e power supply,
UPS (Uninterupterable Power Supply). network card, and is connect it to a
3.2 AhsayOBS Server Configuration
One of the most important factors in determining backup performance is the disk performance of your AhsayOBS backup and restore performance can be attributed to:
and restore
server. Poor i. ii.
The use of network drives for AhsayOBS system and user homes.
The use of a single large disk or volum homes iii. Inadequate balancing of the disk I/O ac e for multiple AhsayOBS user ross multip le physical drives
To improv e performance of your AhsayOBS server, you should consider using: i. ii.
A separate drive dedicated for your O/S installation
A separate local dedicated for your AhsayOBS installatio iii. A separate local dri n home ve for each individual AhsayOBS user home iv. A separate local drive for AhsayOBS system home v. Distribute user accounts across multiple user homes to balance the
I/O load vi. Your AhsayOBS service should be running on a dedicated machine
It is not recommended to use the O/S partition or drive as the
AhsayOBS system or user home. If the O/S partition runs out of space, this will cause your O/S to become unstable and may even crash your AhsayOBS server.
Ahsay Systems Corporation Limited 9
3.3 AhsayOBS Java Heap Size Setting
Ahsay Offsite Backup Server
Administrator’s Guide
Due to features such as CRC checking, delta merging, supp
Hyper-V, VMware backupsets AhsayOBS v6 may require more
Although, there is no exact forumula for calculating the corr size setting for any given AhsayOBS se ort for image,
Java memory ect Java heap rver. In general a maximum Java heap size (-Xmx) setting of at least 2048M is recommend ed, assuming
AhsayOBS is running on a 64 bit Operating System.
When setting the maximum Java heap size for AhsayOBS please ensure this value does not exceed 50% of the RAM on the server, to a memory for O/S processes and operations. llow sufficient
It is not recommended to set excessively high values for the maximum Java heap size, as this could result in AhsayO performance issues during internal Java VM garbag memory
recycling routines.
BS e collection or
3.
4 How many concurrent connections on Ahsay OBS are allowed ?
This is a common question and there is no exact formula for c maximum number of on any AhsayOBS server. As it is dependent not limited to: alculating the user accounts or the number of concurrent connection
on many factors such as but i. ii.
AhsayOBS server hard
The compos ware ition or mix of users accounts, i.e. AhsayOBM or
AhsayACB users iii. The number of backupsets per a user account iv. The type of backupsets per user account v. The backup behavior o f each user vi. The number of concurrent backup jobs vii. The disk I/O on the AhsayOBS viii. Network bandwidth
Also, AhsayOBM/AhsayACB v6 clients a re enhanced to utilize multiple threads for backup and restore. It is recommended to keep the maximum number of concurrent backup jobs on the OB S to 1000, to avoid potential performance problems.
Note:
When the number of concurrent connection increase, the performance on the AhsayOBS may be turn down. To increase the performance, we would recommend modifying the maxThreads value in the
%OBS_HOME%\conf\server.xml in the AhsayOBS.
If you want to support multiple concurrent connections more than 100, you can configure the maxThreads value based on the following formula
Ahsay Systems Corporation Limited 10
Ahsay Offsite Backup Server
Administrator’s Guide maxThreads = Y x 3
(Y= the number of concurrent connections)
Otherwise you are not required to modify the maxThreads valu e.
For example, the number of concurrent connection is 150, the suggested value of the maxThreads is 450.
(Assuming the network environment between the AhsayOBS and
AhsayOBM/AhsayACB is good, and AhsayOBS home on local hard disk with good disk I/O.)
3.
5 AhsayOBS QPS Settings
To ensure user accounts are evenly distributed across your user home drives. It is recommended you configure your QPS setting s, this can be under via your AhsayOBS web console under [Manage System
Configuration] -> [Auto User Home Allocation]. The QPS sett user home drives s
] -> [Server ings for each hould not be set to “unlimited” or “Not Used”.
For AhsayOBS servers with multiple user homes, you should c setting of 50% to 70% for each user home drive. This accounts being concentrated onto one drive, which may cause the drive to run out of disk space very easily. This could result in data corruption on the affected user home(s). onsider a QPS will prevent user
Also, an even distribution of user accounts across your A homes will improve backup performance, by spreadin hsayOBS user g the disk I/O load.
3.
6 Use a Static IP Address
The use of dynamic IP addresses for AhsayOBS domain nam es may result in an unstable backup service whenever the IP address re-cycles.
A static IP address will ensure the remote IP address sent by AhsayOBS to the Ahsay license server will remain the same during daily routine license checks. This will avoid potential license errors, i.e. 1011 or 1012 license errors which could result of the automatic shutdown of your AhsayOBS service.
It is strongly recommended to use a static IP address for your
AhsayOBS server to ensure a stable and reliable backup service.
Ahsay Systems Corporation Limited 11
Ahsay Offsite Backup Server
Administrator’s Guide
3.7 Scheduling of Backup Jobs on AhsayOBS
To improve overall backup performance we recommend th at scheduled backup jobs (by default starts at 09:00pm) should not be confined to a few start times.
The start tim es of scheduled backup jobs should be evenly distributed throughout the day to avoid potential performance bottlenecks on your
AhsayOBS server.
3.
8 Enable Replication on AhsayOBS
To ensure you have a backup of your AhsayOBS server in the event of any hardware issues. We recom mend enabling replication on your AhsayOBS server to a separate AhsayRPS server.
3 .9 AhsayOBS Server Scaling
To cope with business and or data growth, instead of upg hardware to support additional users and data, which co lengthy data migration process. rading to new uld involve a
Your backup service capacity can be upgraded
The advantage of using AhsayRDR is it
using an AhsayRDR solution. allows you to expand your backup service easily by adding new AhsayOBS servers to the curre minimal interruption to your backup service. nt setup with
3.10 Anti-Virus Softwar e on AhsayOBS
If you have anti-virus software installed on your AhsayOBS server, please make sure the user home and system home drives are excluded from scanning, as this may interfere with normal AhsayOBS operation.
3.11
Enable CRC Checking
It is strongly recommended the CRC checking on AhsayOBS is enabled to ensure the integrity of the backup files.
3.12 Running AhsayOBS as a non-root user
If you are running AhsayOBS on Linux, you are advised to run the
AhsayOBS service as non-root user. (AhsayOBS service is run under root by default). This minimizes the impact of damages that could be
Ahsay Systems Corporation Limited 12
Ahsay Offsite Backup Server
Administrator’s Guide done on the system in case the system has been compromised by hackers.
3.13
Expose only TCP port 80 and 443 to the pu blic
It is recommended to expose only TCP port 80 and 443 to the public on your firewall. Please consult the user’s manual of your firewall for more information on how to do so.
3.14
Restricting Access on Administration Pane l
For security reasons, we would recommend that the
Panel of AhsayOBS/AhsayRPS must be hidden from pub range of IP addresse console. For further
Administration lic access, i.e. it should be exposed to local area network only, or you may restrict a s to access your AhsayOBS/AhsayRPS management following chapter “ information, you can follow our instructions in the
Restricting access to system page by IP address ”.
3.15 System Resources
Extra system resourc es may required for the following backup set types:
Windows Syst
Windows 20 em Backup
08 System State
Shadow Protect
Microsoft Exchange
Microsoft SQL Server
Oracle Database
Lotus Domino Server
VMware ESX/ESXi
VMware Server
Microsoft Hyper V
In most cases, the file size of a single file in these backup set types are large, therefore extra system resources (such as mem containing backupsets with delta merge enabled. It is recomm maintain at least 30% to 40% free disk space. ory and disk space) are required for using the delta merging feature. For user homes ended to
3.16 AhsayOBS File System Tuning
In order to ensure optimal performance from an AhsayOBS server file system, please ensure that you:
1. Use local drives instead of network drives, i.e. iSCSi, NFS, SAMBA etc
2. Tune your file system. For example, for NTFS, run the followings:
Ahsay Systems Corporation Limited 13
Ahsay Offsite Backup Server
Administrator’s Guide
fsutil behavior set disable8dot 3 1 fsutil behavior set mftzone 2 fsutil behavior set disablelastaccess 1 fsutil behavior set memoryusage 2
3. Turn off drive indexing [on MS Windows O/S this is used for faster searching] feature for each system and user home drive(s).
4. For Linux/Unix mount points consider mounting them using “noatime”.
3.17
Network Load Balancing Configuration
For AhsayOBS servers which are configured with network i.e. a dual WAN router or Round Robin routing. A static ro configured for your AhsayOBS server connection to the load balancing, ute should be
Ahsay license server (lic.ahsay.com
). This will ensure the remote IP address sent by
AhsayOBS to the Ahsay license server will remain the same during daily routine license checks. This will avoid potential or 1012 license errors which could result of your AhsayOBS service.
license errors, i.e. 1011 the automatic shutdown of
3.18
AhsayOBS Reselle r Panel and AhsayRDR
If the Reseller Panel feature is enabled on your AhsayOBS server and you plan to configure AhsayOBS as part of an Ahsa users accounts created by resellers, AhsayOBM/AhsayAC above clients are only supported. yRDR setup both
AhsayOBS and AhsayRDR must be on v6.7.0.0 or above. For backup
B v6.7.0.0 or
3.19 AhsayOBS Service on AhsayUBS Server with ZFS
For AhsayOBS service which are running on an A above) hsayUBS (v2.3.0.0 or server and is configured with ZFS volume(s). It is strongly recommended to install at least 4 GB RAM, as ZFS vo relatively large amount of memory to run. The amoun lumes require t of memory required is dependent on the size of the ZFS volume and the amount of
I/O activity.
3.20 AhsayOBS and AhsayRDR with Wild Card SSL
Certificates
For AhsayRDR servers installed with a wild card SSL certificate, all member AhsayOBS servers belonging to this setup must be installed with the same wild card SSL certificate. Otherwise AhsayRDR will not be
Ahsay Systems Corporation Limited 14
Ahsay Offsite Backup Server
Administrator’s Guide able to connect to any membe r AhsayOBS server installed with a different wild card SSL certificate via https.
3.21 Max imum Number of Backup Sets for a Backup User
Account
Although there are no restrictions on the maximum number of backup sets that can be created on a backup user account. For administration purposes it is recommended that each backup user account have no more than 10 backup sets.
Ahsay Systems Corporation Limited 15
Ahsay Offsite Backup Server
Administrator’s Guide
4
Server Configuration
This chapter describes how you can use the [Manage System] -> [Server
Configuration] page (shown below) to manage the configuration of your backup server.
Ahsay Systems Corporation Limited 16
Ahsay Offsite Backup Server
Administrator’s Guide
Key
Login
Name/Password
Host Name
System Home
Policy Home
User Homes
Single Level Access
Auto Lock User
SMTP Server
Report Sender
Administrative
Contact
Language of
System Reports
Use Proxy
Description
Username and password of the system account.
A resolvable hostname of this server (e.
b g. ackup.your-company.com). Although you can supply an IP address here, it is preferable to use a host name instead.
The directory where AhsayOBS stores it information. The defau lt directory for [System Home] is
%OBSR_HOME%\system. Normally, yo to modify the value of this setting unles store this information elsewhere. s system u do not need s you want to
The directory where AhsayOBS stor and group es its system user policy information. The default directory for
[Policy Home] is %OBSR_HOME%\syste
Normally you do not need to modify th m\policy. e value of this setting unless you want to store this in formation elsewhere.
The directories where AhsayOBS store the backup files and backup log for all its users. You sh
Homes] to partition where there is lots ould set [User of free space.
It de termines whether system user has been restricted access to own created system users and backup users.
The backup user will be locked automatically after consecutive invalid login attempts v console, Redirector web console.
3 ia AhsayOBS web console and backup client
The SMTP server that AhsayOBS wi ema il reports. ll use to deliver its
The name of email address that will be used as a sender for all outgoing emails.
The name(s) and email address (es) of the system administrator. System reports (e.g. Daily Usage Report and Daily Error Report) will be delivered to these mailboxes.
The language which will be used in all system reports.
Whether to use proxy to access the internet.
17 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Type
Proxy Host/Port
Proxy
Username/Password
The type of proxy to be used (HTTP / SOCKS).
Proxy server host and port number.
Proxy user name and password used. if user authentication is
Use Windows Active
Directory ( AD)
Authentication
Domain Name The domain name to be used for AD authentication.
Domain Control ler The IP address of the doma in controller.
IP
Whether to use Windows Active Directory
Authentication.
Remove AhsayO accou
Use nt
Redirectory(RDR
BS
)
Whether to delete AhsayOBS user account when AD user account is disabled/deleted.
Whether to use redirec tor.
Protocol
Hostname/Port
The type of protocol to be used (HTTP/HTTPS)
Redirector host and port number.
Login
Name/Password
Administrator
Hostname
System username and password for the redirector.
The host name/IP address that backup u by administrator will be used to contact t redirector (e.g. redirector.company.c
sers created his server via om)
Use Windows Event When this option is enabled, this backup server writes
Log the system log message to Windows Event feature is only valid in Windows platform .
Log. This
Language Settin gs It determines whether different langua ges are enabled.
Feature Setting s It determines whether the [HELP], restore link and install link should be available to users.
Permission updated files
Moved Files
Auto User Home
It determines whether the existing files are copied to retention area before updating the permission settings.
It determines whether the existing files are copied to retention are before updating the file paths.
Maximum QPS Ratio can be changed.
Ahsay Systems Corporation Limited 18
Ahsay Offsite Backup Server
Administrator’s Guide
Allocation
Welcome Email It determines if welcome email will be sent to new users and other options on welco me emails.
Enable Fre
Registratio e Tria n l
Backup Quota
Whether to enable free trial user re gistration.
The default backup quota of trial users
Add-on Modules
Remove User
Configuration
Re covery
Date
Path
Mode
The de fault modules available to trial users
Whether to remove trial users an period. d the length of trial
System settings, policies an preferable date can be reco d user profiles of a vered.
Dates of configuration can be recovere copies of configuration will be arch d. At most 30 ived.
Destination of recovered configuration.
Mode of configuration recovery. If "Auto" is selected and OBS user h ome is empty, the configuration including system settings, policies an be decrypted and downloaded to their locations. If "Manual" is selected, the d user profiles will
original configuration will be decrypted and downloaded to destination path.
Refresh
Restore
Reload archival dates
Download configuration to the destination path and perform configuration recovery in either "
"Manual" mode.
Auto" or
4.1 User Languages Setting
The language of the web interface can be easily changed to another language by:
1. Click the [Select Language] link available on the top right hand corner of the web interface.
2. Select the language of your choice.
3. All text messages from the original window are now displayed in the language you have just selected (see example below).
19 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
The languages currently supported by AhsayOBS are listed in Appendix A.
You can limit the list of languages available to users by using the [Manage
System] -> [Server Configuration] -> [Language Setting] options.
If you uncheck all checkboxes for all languages available in [Manage System]
-> [Server Configuration] -> [Language Setting], the [Select Language] will no longer be available on the top right hand corner of the web interface (you need to refresh the top menu bar to see the change). Users will not be able to change the language of the web interface.
20 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
4.2 System Login Name/Password
The [Login Name] and [Password] setting under the [Manage System] ->
[Server Configuration] page sets the login name and password (the default username is system password is system) that you would use to logon the system administration console. Users are strongly recommended to
change both the login name and password to something other than
21 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
the default setting to reduce the possibility of unauthorized access to
the AhsayOBS.
4.3 Host Name
The [Host Name] setting under the [Manager System] ->
Configuration] page sets the h
[Server ostname of the backup server. This entry will be used as a reference to the backup server in all email reports. Please enter expect backup a hostname/IP address (a public hostname/IP address if you request originating from the internet).
Please make sure the [Host Name] entry is resolvable from the backup server itself. This means that if you enter “backup.yourcompany.com”
Name] entry, you can access the backup system welco
into the [Host me page via http://backup.yourcompany.com.
If you are running AhsayOBS on custom TCP port (i.e. Not Port 80 and Port
443), please append your custom TCP port number to the [Host Name] entry.
For example, if you are running AhsayOBS on TCP Port 8080 for HTTP, please enter “backup.your-backup.com:8080” as your [Host Name] en not enter the customer TCP Port for HTTPS, e.g. 8443, into th field as it will not work). try (Please do e [Host Name]
4.4 System Home, Policy Home and User Home Directories
The [System Home], [Policy Home] a nd [User Homes] setting under the
[Manage System] -> [Server Configuration] page sets the syste directory, policy home directory and user home directories for A
( the default values are %OBSR_HOME%\system,
%OBSR_HOME%\system\policy and %OBSR_HOME%\user). m home hsayOBS
The system home directory for AhsayOBS defines a direc
AhsayOBS will store all its system information. tory in which
The policy home directory for AhsayOBS defines a direct
AhsayOBS will store all its system users and group policy inform ory in which ation.
The user home directories for AhsayOBS define a list of direct ories in which
AhsayOBS can be used to store the user folder for each backup user. Each user folder contains the backup setting as well as all backup data owned by this particular user.
AhsayOBS can be configured with multiple user home directories, this allows for the distribution of user accounts across different hard disk partitions or different hard disks. This enables server administrator’s to easily distribute the I/O loading across multiple drives, which helps to improve overall backup server performance. Also, the support of multiple user homes will allow for
22 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide easy expansion of the server storage. For example, if you wan storage to AhsayOBS, you can simply add another hard disk t to add more to the system and add the path to this new drive (e.g. E:\ or E:\Users) to the [User Homes] setting. You can then add new backup users or move existing backup users to this user home drive.
Backup users created by the AhsayOBM or AhsayACB “Free Tria wizard will always use the first [User Homes] entry as the create backup users. If you want to offer free trial to your us enabled the “Free running out of free spac l Registration” user home to ers and have
Trial Registration” option on the [Manage System] ->
[Server Configuration] page, please make sure that there is enough free space available in the first entry of the [User Homes] settings to avoid e.
4.5 Single Level Access
The [Single L evel Access] settings under the [Manage System] -> [Server
Configuration] page defines system user access restriction to own created system users, backup users and backup users of system users. This restriction does not app
Level Access] checkbox, ly to system administrator. If you uncheck [Single system user can access all descendant system users and backup users.
4.6 Email System Setting
The [Email System Setting] settings under the [Manage Syste
Configuration] page defines the various email setting that Ahs to generate ema m] -> [Server ayOBS will use il reports to backup system administrator and backup users.
The [Email System Setting] -> [SMTP Server] -> [Host Name] the SMTP server that will be used by AhsayOBS to deliver its em
entry defines ail reports. If dard TCP port stomer TCP port number for SMTP service to you are using a SMTP server that is not running on SMTP stan
(port25), please append your cu the [SMTP Server] -> [Host Name] entry (e.g
. mail.yourcompany.com:8025).
You are only required to fill in the [SMTP Server] -> [Login Nam
Server] -> [Password] entry if the SMTP server you are us e] and [SMTP ing required user authentication before accepting mail delivery requests. There is a test button at the end of each SMTP settings to test the connection. The testing result will be displayed next to the test button.
Multiple SMTP servers can be setup for AhsayOBS. If the first SMTP server is unavailable, the next SMTP server will be used.
The [Email System Setting] -> [Report Sender] entry defines the “Mail-From” email address that appears in all outgoing emails generated by AhsayOBS.
23 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
The [Email System Setting] -> [Administrator Contact] entr administrative contact of AhsayOBS. AhsayOBS will send dai err y defines the ly usage and or report and all critical system alerts to all email addresses defined here.
Note:
1. Since 6.13.4.0, we support GMAIL with secure SMTP.
2. SMTP on Exchange 2007 or above with administrator as lo not allowed. When gin account is
you setup the SMTP settings, you can either use another normal user account with mail box enabled and relay email permissions, or leave the login name and password field in the SMTP authentication as empty.
4.7 Proxy Setting
The [User Proxy] settings under the [Manage System]
Configuration] page defines whether AhsayOBS should use a p
-> [Server roxy to gain access to the internet.
Two types of proxy, HTTP/HTTPS and SOCKS 4/5, are supported. You can use the [Proxy Host] and [Port] entries to define the location of you r proxy server. please use the xy Password] entries to set the
If the proxy server you are using requires user authentication,
[Proxy Username] and [Pro username/password for your proxy server.
Note:
Please make sure there are no traffic restictions on the proxy s erver, which could affect backup/restore performance.
4.8 Windows Active Directory (AD) Authentication Setting
When Windows Active Directory Authentication is e authentication will be dispatched to Windows Active D nabled, user irectory (AD) automatically if AhsayOBS fails to authenticate a user logon using its own records. This means that if an AD is presented in the network, it is only required to create a user account once in AD and the same user account can also be used in AhsayOBS, because AhsayOBS will create this user account automatically after authenticating this logon using AD. When this user logons to AhsayOBS, AhsayOBS will use Free Trial Registration settings above (even if it is not enabled) as the template of user profile (i.e. backup quota and add-on modules settings, but not Microsoft Exchange Mailbox which will be disabled by default) to be created. The user account created will be of “Paid”
24 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide type and of “AhsayACB” backup client (unless the user logons using
“AhsayOBM”).
To enable this feature, simply ch eck the box of [Use Windows Active
Directory (AD) Authentication] under the [Manage System] -> [Server
Configuration] page (by default it is enabled).
To synchronize AhsayOBS and AD, removal of users can be con user acc removed from AD after 10 days, the user account will be disabled and after
10 more days, the user account will be deleted.
WARNING:
figured. If you want to delete/disable AhsayOBS user account when the user is rem from AD, you can check the boxes in the section of [Remo ve AhsayOBS
Account]. You can have both options checked and create your own
For example, setting [After a user account has been deleted fr days, AhsayOBS will delete this user account automatically] an oved standard. om AD for 20 d [After a user account has been deleted from AD for 10 days, AhsayOBS will disable this ount automatically], can results that when the user account is
AhsayOBS servers with Windows Active Directory Authentication enabled are not supported in an AhsayRDR environment.
4.9 Redirector
The [Use Redirector (RDR)] settings under the [Manage System] -> [Server
Configuration] page defines whether the current AhsayOBS is used behind a redirector. If AhsayOBS is a member machine of an AhsayRD R setup, you must specify the AhsayRDR settings
In order to setup AhsayOBS v6 in an AhsayRDR environment, you must use
AhsayRDR v6.
Note: For users’ connection to the AhsayOBS user console or connection to the AhsayOBM/AhsayACB client agent though AhsayRDR, the hostname must be configured exactly as the AhsayRDR hostname configured in the “Use
Redirector (RDR)” > “Hostname” setting.
WARNING:
Ahsay Systems Corporation Limited 25
Ahsay Offsite Backup Server
Administrator’s Guide
Please make sure on the AhsayRDR server the “UserConsole“ the %RDR_HOME%\webapps\rdr\WEB-INF\web.xml
" file is amended to include the IP address range of all member
servers, as by default the range setting is 127.0.0.1-127
filter in
AhsayOBS
.0.0.1
Otherwise the affected AhsayOBS me mber servers will not be able to
connect to AhsayRDR.
<filter-name>UserConsole</filte
<filter-class>com.ahsay.rdr.www.I
<init-param >
<param-name>Range1</param r-name>
PFilter</filter-class>
-name>
<param-value>localhost</param-value>
</init-para
<initm> param>
<param-name>Range2</param-name>
<param-value>127.0.0.1-127.0.0.1</param-value>
</init-param>
</filter>
4.10 Language Setting
The [Language Setting
Configuration] page de
] settings under the [Manage System] -> [Server fines the list of available languages on the web interface.
4.11 Features Setting
The [Feature Setting] settings under the [Manage System] -> [Server
Configuration] page defines whether some customizable features on the web interface should be enabled or not.
Ahsay Systems Corporation Limited 26
Ahsay Offsite Backup Server
Administrator’s Guide
Key
Show Help link
Description
It defines whether th e [Help] link should appear at the top right hand corner of the web admi nistration console
(user interface only).
Show Restore link It defines whether the [Restore] link should appear at the top right hand corner of the web administration console (user interface only).
Show Install link It defines whether the [Install Software] link should appear at the top right hand corner of the w
. eb administration console (user interface only)
4.12 Permission Updated Files
The [Permission Updated Files] settings under the [Manage System] ->
[Server Configuration] page defines whether AhsayOBS should make a copy of the file to the retention area before the file permission changes. When this option is set, all backup accounts will use more retention space but allows the users to restore the same file with various permissions. When this option is not set, the permission changes are updated to the backup file directly. No copies of the previous version(s) will be available for restore.
Ahsay Systems Corporation Limited 27
Ahsay Offsite Backup Server
Administrator’s Guide
4.13 Moved Files
The [Moved Files] settings under the [Manage System] ->
Configuration] page defines whether AhsayOBS should make a cop file to the retention area before the file path is updated, i.
moved to another location. When this option is set, all backup
[Server y of the e. the files is
accounts will use more retention s pace but allows the users to restore the same file with the correct location. When this option is not set, the file path changes are updated to the backed up file directly. No copies of the previous version(s) will be available for restore.
4.14 Auto User Home Allocation
The [Auto User Hom e Allocation] settings under the [Manage System] ->
[Server Configuration] page defines the quota ratio for each user home.
AhsayOBS will autom allocation and trial us atically select the user home to be used for auto user er registration based on the quota ratio. AhsayOBS will always use the first user home with a QPS ratio smaller t han the value defined by the system user.
4.15 Welcome Email
The [Send welcome email to new users] settings under the [Ma
-> [Server Configuration] page defines whether AhsayOBS s welcome email the new users. nage System] hould send a to new users. If this option is checked, it will send an email to
The [Include encrypted password in welcome email] settings under the
[Manage System] -> [Server Configuration] page defines whet her AhsayOBS should include the encrypted password in the welcome email. When this option is checked, the encrypted password will send with the welcome email to the new users.
4.16 Free Trial Setting
The [Enable Free Trial Registration] settings under the [Manage System] ->
[Server Configuration] page defines various free trial settings available in
AhsayOBS.
Trial users do not count towards the maximum number of users allowed within AhsayOBS by the software license and there can be unlimited number of trial users within AhsayOBS. However, each backup user can have a maximum backup quota of 100GB for a trial period of 30 days. After
Ahsay Systems Corporation Limited 28
Ahsay Offsite Backup Server
Administrator’s Guide expiration of the trial period, the backup quota will reset to a maximum of
500MB automatically.
To allow users to create a trial backup account from AhsayOBM please enable th
or AhsayACB, e [Enable Free Trial Registration] option. If this feature is unchecked, the option to register for a trial account (see below) will not be available to end users.
The [Backup Quota] defines the maximum backup quota o f trial backup accounts upon registration.
The [Add-on Modules] option defines whether you want to allow trial users to
. have different add-on modules
The [Remove User] option defines whether you want to remov users for certain number of days after registration. For example e trial backup
, you can use this option to tell AhsayOBS to remove trial backup users from the system automatically after backup users have registered for 60 days.
4.17 Use Windows Event Log
For AhsayOBS installations on Microsoft Windows platform which have the
“Windows Event Log” service enabled. When this feature is selected all
AhsayOBS system log information, i.e. error, warning, and information message types will be also be written to the Windows event logs. The backup
Ahsay Systems Corporation Limited 29
Ahsay Offsite Backup Server
Administrator’s Guide server administrator’s can view the logs entires using the Windows event viewer. The event log name is limited to 8 characters.
The ID fo r each message type is shown in the following table.
Type ID
Information 201
Warning 305
Error 409
4 .18 Configuration Recovery
AhsayOBS Configuration Recovery feature available from Ahsay onwards. It is designed to faciliate a quick and simple re
OBS v6.7.0.0 covery of an
AhsayOBS server after an outage, to ensure minimum down t ime of backup service. By allowing the backup server administrator to
AhsayOBS instance on another machine, using the backed server configuration downloaded from the Ahsay License Server install a new up AhsayOBS
(ALS).
In order t o backup AhsayOBS server configuration files the backup server administrator, can schedule daily Configuration Archival backups of critical
AhsayOBS server configuration files to the ALS, e.g. system configuration files in the %OBS_HOME%\CONF folder, Policy Home and User Home folders.
The Configuration Archival feature is available to AhsayOBS servers using paid license keys (including keys generated from License Management Portal) and with a valid "Free Upgrade Until" date. This feature is disabled for
AhsayOBS servers using evaluation license keys.
Ahsay Systems Corporation Limited 30
Ahsay Offsite Backup Server
Administrator’s Guide
4.18.1 Setup
The AhsayOBS Configuration Recovery feature is disabled b y default. To enable this feature go to the server configuration page [Manage System ] ->
[Routine Job] -> [S ystem Job] -> [Configuration Archival] and select
“Enable” and press the [Update] button. The default AhsayOBS configuration backup time is at 12:30 PM.
For AhsayOBS servers using evaluation license keys or where the "Free
Upgrade Until" date has already expired, this option will be automatically disabled until license key maintenance is renewed.
For license keys where the "Free Upgrade Until" has expired, the configuration files which have been previously uploade available for restore via the Configuration Recovery featu d to ALS are still re.
4.18.2 AhsayOBS Configura tion Files
The following is a list of critic backed up to the ALS by the al AhsayOB daily Config
S configuration files which are uration Archival backup job.
CONF folder
POLICY HOME
\%OBS_HOME% \conf\
\%PolicyHome%\
acb-config.xml, afc.opt, aut oDiscovery.xml, a utoUpdate.bdb, d ebug.props, keystore, lfsCo nfig.xml, li cense.xml, obs.xml, obsr.opt, rps.xml, rpsLicense.xml, rpsRecv.xml, rpsSend.xml, server.xml policyGroup.xml, sysUser.xml, userGroup.xml,
AcbGlobalFilter\db\Profile.xml, defaultAcbUser\db\Profile.xml,
Ahsay Systems Corporation Limited 31
Ahsay Offsite Backup Server
Administrator’s Guide
USER HOME
%userhome1%
%userhome2%
.
.
\%User Home%\
defaultUser\db\ Profile.xml,
ObmGlobalFilter\db\Pr ofile.xml
The home folder and Profi backup us er accounts: le.xml for all
%Userhome%\test1
%Userhome% \test1\db
%Userhome%\test1\db\Profi le.xml
%Userhome%\test2#12345
%Userhome%\ test2#12345\db
%Userhome%\ test2#12345\db\Profile.xml
4.18.3 Configuration Archival File Limits
Each Configuration Archive file is limited to 6MB after compr ession per an upload.
Fo r example, a 6MB compres sed file can contain configurations files from an
Ah sayOBS server with the following setup:
Number of backup user = 20000
Number of system user = 150
Number of user group = 500
Number of policy group = 250
Average number of backup sets per backup user = 10
If after the configuration file is compressed, the file size exceeds 6MB, the
Configuration Archival job will not upload the file to ALS. The exact nature of the error will be shown in the AhsayOBS system log.
The following example shows the compressed files exceeded 6MB.
Ahsay Systems Corporation Limited 32
Ahsay Offsite Backup Server
Administrator’s Guide
4.18.4 Configuration Archival Storage Retention
The ALS allows each license key to store a maximum o configuration file backups at any one time. When the Configur f 30 days of ation Archival backup j ob uploads the configuration file on the 31 st immediately delete the existing configuration file uploaded on the and so forth.
day, the ALS will
1 st
day
To check how many backup “snapshots” are available on the ALS, on the
AhsayOBS web console go to [Manage System] -> [Server Configuration] -
> [Configuration Recovery]. Click on the [Refresh] button and select the
“Date” combo box.
WARNING:
ALS will only keep one snapshot of the Configuration Ar file per day. If there are more than one Configura backup jobs are run w chive backup tion Archive ithin a 24 hour period, ALS will only keep a
copy of the latest snaphot.
4.18.5 Ba ckup Process
Once the Configuration Archival system job is enabled and the daily backup time configured. AhsayOBS will automatically perform a backup of the configurations files to the ALS.
For each Configuration Archival backup job:
1. The AhsayOBS configuration files are copied to the %OBS_HOME%\temp folder.
2. The files are compressed and encrypted using an AES 256bit encryption algorithm.
Ahsay Systems Corporation Limited 33
Ahsay Offsite Backup Server
Administrator’s Guide
3. The compressed file is renamed according to the following
YYYY-MM-DD.zip.gz and AhsayOBS uploads the file
format dr-
to ALS using https protocol.
4. After a successful backup the dr-YYYY-MM-DD.zip.gz file is then remo ved from the %OBS_HOME%\temp folder.
WARNING:
The encryption key used by AhsayOBS to encrypt the configuration ckup server file is a secret key and cannot be changed by the ba
administrator.
Once the AhsayOBS configuration files are uploaded to ALS, the backup server administrator cannot manually remove these files
from ALS.
The Configuration Archival backup job statuses ar
AhsayOBS system log. e recorded in the
When a Configuration Archival backup job has completed successfully, the following messages will be shown in the AhsayOBS system log:
To verify the current backup of configuration files are available on the ALS, on the AhsayOBS web console go to [Manage System] -> [Server
Configuration] -> [Configuration Recovery]. Click on the [Refresh] button to show the latest snapshot available on the ALS.
Backup Error Handling
If the Configuration Archival backup job encounters any connection issues to the ALS, AhsayOBS will attempt to reconnect to the ALS again upload the configurations file after 15 minutes.
The following messages will be shown in the AhsayOBS system log:
Ahsay Systems Corporation Limited 34
Ahsay Offsite Backup Server
Administrator’s Guide
In tota l AhsayOBS will retry three times in 15 minute intervals to establish a connection to ALS before the backup job is aborted.
First Retry
Second Retry
Third Retry
Ahsay Systems Corporation Limited 35
Ahsay Offsite Backup Server
Administrator’s Guide
If the Configuration Archival backup job does not successfu configuration file to ALS after the third retry, the backup job lly upload the for the current day will end. AhsayOBS will run the Con figuration Archival backup job again on the following day at the scheduled time
4.18.6 Restoring Configuration Files
To restore the configurations files from ALS to AhsayOBS, open the web management console and go to the server configuration page [Manage
System] -> [Server Configuration] -> [Configuration Recovery].
The [Path] is the destination path where the restore from the ALS, when Co d configuration files will be saved on the AhsayOBS server. After the configuration fi le is restored nfiguration Recovery is perfomed using “Manual” mode. The default setting for the [Path] is %OBS_HOME%\SYSTEM_HO ME\dr.
The AhsayOBS server configuration can be restored from ALS by:
1. Clicking the [Refresh] button to obtain a list of the confi guration file snapshots stored on the ALS.
2. Use t he [Date] option, to select the configuration file snapshot to be restored.
3. Select the recovery mode in the [Mode] option. i. If "Auto" mode is selected, AhsayOBS will downlo ad the selected configuration file snapshot from ALS. It will be automatically decrypted and copied to their original locations, only if the AhsayOBS are empty.
user home(s) ii. If "Manual" mode is selected, the configuration files will be decrypted and downloaded to the destination path. The restored files will have to be manually copied to new AhsayOBS user home(s).
4. Click [Restore] button to execute the configuration recovery process.
5. The restored AhsayOBS configuration settings will take effect after the
AhsayOBS service is restarted.
Ahsay Systems Corporation Limited 36
Ahsay Offsite Backup Server
Administrator’s Guide
When a Configuration Recovery has been performe d successfully, the following messages will be shown in the AhsayOBS system log:
WARNING: i. The Configuration Recovery feature does not suppor
Ahs t recovery of ayOBS system configuration on a cross O/S platform environment, i.e. configuration files from a Window cannot be recovered to a Linux/FreeBSD/Solaris Ah s AhsayOBS sayOBS vice versa. ii. To perform a Configuration Recovery to a new installation the license key from the original Ahsay must be applied.
AhsayOBS
OBS server iii. The new AhsayOBS server must be able to connect to the Ahsay
License Server (ALS) in order to perform a Configuration Recovery.
Ahsay Systems Corporation Limited 37
Ahsay Offsite Backup Server
Administrator’s Guide
5
Software License
This chapter describes how you can use the [Manage System] -> [Software
License] page (shown below) to manage software license of AhsayOBS.
Ahsay Systems Corporation Limited 38
Ahsay Offsite Backup Server
Administrator’s Guide
Key
License Name
License Key
Description
Business name of the licensee
License Key to activate this software. Please enter [License
Key] as a printed on the [Software License Agr eement] into the text field provided.
Connection T est Test the connection be tween AhsayOBS and license server.
Company Name The company name used for contact.
Contact Name The name of the contact perso n.
Contact Email
Contact Number The phone number of the contact person.
AhsayOBM
The email address of the contact person.
The maximum number of the AhsayOBM backup account allowed.
The following may be displayed when there are some special arrangement on your AhsayOBM license CAL:
AhsayACB
User Add-on
Modules
Server Add-on
Modules
( number ) - The number in the round bracket is of AhsayOBM used by the AhsayACB. the quota
( number ) - The number in the round b us racket is the quota ed by Microsoft Exchange Server Database Availability Group
One AhsayOBM license CAL with one Exch
Module is deducted from each installation o the DAG environment. ange Server Add-on f the AhsayOBM on
The maximum number of the AhsayACB backup accounts allowed.
It shows w hether different client side add-on modules are enabled for AhsayOBM/AhsayACB. You need to
these modules.
have a new license key to enable
Quota – the total number of licenses of a pa rticular module available.
Used – the total number of licenses of a particular module assigned to users.
Available – the total number of license of a particular module available for future use.
It shows whether different server side add-on modules are enabled for AhsayOBS/AhsayRPS. You need to have a new
Ahsay Systems Corporation Limited 39
Ahsay Offsite Backup Server
Administrator’s Guide license key to enable these modules.
Product Name
Product Version Version number of the licensed product.
Expiry Date
Name of the licensed product.
Free Upgrade
Until
The date when the current license key w ill expire. You will not be able to use AhsayOBS after this date.
The last date you are allowed to upgrade to the latest
Max Quota
AhsayOBS available. You will not be able to upgrade to any software release after this date with your current license key.
The maximum quota for each backup user supported.
Ahsay Systems Corporation Limited 40
5.1 Licensee Name and License Key
Ahsay Offsite Backup Server
Administrator’s Guide
When you click the [Manage System] -> [Software License] link available at the top menu, the [Software License] panel will appear (see above). You can use the form available on this panel to activate the software.
Please remember the following notes when you enter your licen see name and your license key:
Both [Licensee Name] and [License Key] are case sens must b please use copy and paste shortcuts (CTRL-C and CTRL-V) itive and they e entered EXACTLY as stated in your software receipt. If possible,
to enter both vided to avoid the [Licensee Name] and [License Key] into the field pro typo error.
There is a connection test button underneath the license field entry box to test the connection to our license server. The testing result will be displayed next to the test button.
If a proxy server is required to access the Internet fro please setup the [proxy setting] in the [Manager Server] to the Internet is required because the license key must b our license server before it is usable. m AhsayOBS,
page. Access e activated by
If internet connection is not available in your environmen t, you can use the offline activation method to activate your license.
One license key can only be used on one machine once activated. If you use the same license key to activate another copy of
AhsayOBS on another ser ver, you will get an “Internal Error 1011” or
“Internal Error 1012” mess age. You can still run this copy of AhsayOBS for another 7 days without any problems but it will stop this grace period. Please contact us to re-activate your lice run into this situation. it has been
working after nse key if you
5.2 Automatic License Renewal
If AhsayOBS is under a monthly leasing plan, the license key expiry date of 30 days. Upon
will have an
expiration, the license key will be renewed automatically.
In the event of any problems during the license renewal process, i.e.
AhsayOBS is not able to connect to the Ahsay License server. The expired license key will have a grace period of 14 days. AhsayOBS can still function normally using the expired license for an extra 14 days before the service is automaticially shutdown. The 14 day grace period is to allow sufficient time to resolve any license related problems.
Ahsay Systems Corporation Limited 41
Ahsay Offsite Backup Server
Administrator’s Guide
5.3 Evaluation Expiry and Free Edition
After the evaluation period, the evaluation key will expire and will automatically be stopp
the AhsayOBS ed. Although the service will still be alive,
AhsayOBM and AhsayACB cannot do backups anymore. You should get the following screen when it happens:
Online] button to purchase new licenses or contact our Sales
He lp Centre Ticketing System
If you want to continue using AhsayOBS, you can press the [Buy Licenses
Team via our
However, if you have not yet decided to purchase our product, you are welcome to apply for a free license. To apply for a free license, please input all contact details (including [Company Name], [Contact Name], [Contact
Email Address], [Contact Phone Number]), and then press the [Request for free license] button. An email will be sent to your email account in a short time.
42 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Within the email, you will have the licensee name and license
Copy and paste the values to
key received. the fields on the page of [Manage System] ->
[Software License] respectively. After that, press the [Update] button at the end of the page. Then you should be able to continue to use AhsayOBS.
If you have created some backup users in AhsayOBS before, you may get the following message on the license page:
Ahsay Systems Corporation Limited 43
Ahsay Offsite Backup Server
Administrator’s Guide
The system prompts that the quota is exceeded, because version of AhsayOBS has more limitations on number of users features than evaluation version. When it changes to Free Edi users will be suspended and the user accounts will s generally free
, modules and tion, the extra top functioning. Users to be suspended are chosen randomly. We would recommend that you should remove/suspend the extra users before switching to Free Edition .
After you have purchased a new license, you can apply the licen and lice see name nse key as described in previous sections. You can then re-activate the users by using the tools in [Manage User]. For more information on
[Managing User], please refer to the section of Managing User in this document.
5.4 Offline Lic ense Activation
Offline License Activation is a new feature added to AhsayOBS since v5.5.7.0.
It is used to activate the AhsayOBS license for servers that do not have internet connection.
In order to use the offline license activation, you must first install AhsayOBS v5.5.7.0 or above.
After you have finished installing the AhsayOBS, please open the web management console and go to the license page ([Manage System] ->
[Software License]). On that page, you should be able to see the [Advanced
Option] link near the bottom right hand corned. Please click on that link to display the offline license options.
Ahsay Systems Corporation Limited 44
Ahsay Offsite Backup Server
Administrator’s Guide
The offline license options should now be shown on the screen. The next step in the offline license activation process is to generate an offline license request file. This file is an encrypted file that contains all the information required for the activation process, e.g. MAC address and local IP address. To generate the offline license request file, please press the [Generate] button under the [Advanced Option] under of the license page. The offline license request file will then be generated and it will prompt for the location to save the offline license request file.
45 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
When the offline license request file is ready, please send it to our Support team via email. An offline license file will then be generated an you. The offline license file is the license file used in the d sent back to offline license activation process.
After you have received the offline license file, you would need to import it to
importing the the AhsayOBS to complete the offline activation process. Before offline license files to AhsayOBS, you must ensure that it is system home folder of AhsayOBS. Then, you should logon to web interface to import the license from the [So
placed in the the AhsayOBS ftware License] page (i.e.
[Manage System] -> [Software License]) and click on the [Advanced Option] link. Press on the [Browse] button and select the offline license file from
AhsayOBS system home. Click on the [Offline Update] button to complete the process. If there is no error message shown on the [Software License] page, the Offline License Activation process is completed successfully.
5.5 License Management Portal
The License Management Portal is an online license management tool. It provides a convenient method for partners to manage their AhsayOBS license keys online. For more information on this feature, please refer to the online documentation on the License Management Portal.
Ahsay Systems Corporation Limited 46
Ahsay Offsite Backup Server
Administrator’s Guide
6
Managing Routine Job
This chapter describes how you can use the [Manage System
Job] page (shown below) to manage number of system ro
] -> [Routine utine jobs of
AhsayOBS. When you click the [Manage System] -> [Rout ine Jobs] link available at the top menu, th e [Routine Jobs] panel will appear. You can use the form available on this panel to define your preferences of how you want different system routine jobs to run.
Key
Backup Report
Description
Hourly job sending backup reports to ba
users whose ckup job have completed within the last hour.
Online Restore Re port Hourly job sending online file restora tion reports to pleted an online users who have performed and com file restoration action within the last hou r.
Setting Change Re port Hourly job sending setting change r who have updated their backup sett last hour. eports to users ing within the
Missed Backup Report Hourly job checking whether any scheduled backup job has been missed for all backup users and sending missed backup reports to users who have missed their backup jobs.
Inactive User Report Daily job sending inactive user reports to users if their accounts have been inactive for more than 7 days.
47 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Off-line Backup
Reminder
Backup Quota
Reminder
Trial user Reminde r
Daily job sending off-line backup rem who have set the off-line backup opt inders to users ion and have not performed a backup for the required number of days.
Daily job sending backup quota reminders to users whose storage quotas are above a certain percentage.
Daily job sending trial user reminde whose rs to users trial account are about to expire.
Usage Report
Error Report
Replication Error
Report
Inactive User Rem oval
Daily jo b sending system usage reports to system administrators.
Daily j ob sending system error reports to system administrators.
Daily job sending replication error reports to system administrators
Daily job deleting all trial accounts that have been inactive for 60 days.
Retention Policy Job Daily job removing obsolete files area according to each user’s ret setting. from the retention ention policy
Rebuild User Stora ge Weekly job rebuilding all use rs’ storage information by walking through all users’ backup files.
System Log Remo val Daily job removing system logs olde number of days from the system. r than this
Debug Log Remov al
Cyclic Redundancy
Check (CRC) Checking
Daily job removing d ebugging logs older than this number of days from the system.
Routine job that will run at 2 nd
and 4 th
Saturdays of every month. It will verify the CRC of the files backed up to the server.
Force to check all backup files
If selected the CRC job will check all backup files regardless of last checked date.
Configuration Archival Daily job sending system settings, policies and user profiles to a secure remote storage.
Ahsay Systems Corporation Limited 48
Ahsay Offsite Backup Server
Administrator’s Guide
Note:
It is strongly recommended you enable the CRC checking so that
regular file integrity checks are made on the backup data files.
6.1 Backup Report
The [User Report] -> [Backup Report] setting under the [Manag
[Routine Job] page defines the setting of the
The role of the [Backup Report] routine job is to send backup re who have finished one of their back e System] ->
[Backup Report] routine job. ports to users up jobs within the last hour. The backup report is scheduled to run every 57 minutes past the hour.
If you want your users t o receive these reports, please select the [Enable] option. Otherwise, select the [Disable] option.
6.2 Online Restore Report
The [User Report] -> [Online Restore Report] sett
Report] routine job. The role of the ing under the [Manage
System] -> [Routine Job] page defines the setting of the [O nline Restore
[Online Restore Report] routine job is to send online file restoration reports out to users who have performed and completed an online file restoration action within the last hour. The online restore report is scheduled to run every 58 minutes past the hour.
If you want your users to receive these reports, please selec t the [Enable] option. Otherwise, select the [Disable] option.
6.3 Setting Change Report
The [User Report] -> [Setting Cha nge Report] setting under the [Manage
System] -> [Routine Job] page defines the setting of the [Setting Change
Report] routine job. The role of the [Setting Change Report] routine job is to send reports out to users who have updated their profiles or backup set within the last hour. The setting change report is scheduled to run every 59 minutes past the hour.
If you want your users to receive these reports, please select the [Enable] option. Otherwise, select the [Disable] option.
Ahsay Systems Corporation Limited 49
6.4 Missed Backup Report
Ahsay Offsite Backup Server
Administrator’s Guide
The [User Report] -> [Missed Backup Report] setting under
System] -> [Routine Job] page defines the setting of the [M
Report] routine job. The role of the [Missed Backup Report] ro send reminder notice to users who have missed one of th
the [Manage issed Backup utine job is to eir scheduled backup jobs. AhsayOBS defines a scheduled backup job to be a missed backup job if there is no backup run 6 hours after a backup has been scheduled. The missed report is scheduled to run every 56 minutes pa st the hour.
If you want your users option. Otherwise, selec
to receive these reports, please select the [Enable] t the [Disable] option.
6.5 Inactive User Report
The [User Report] -> [Inactive User Report] setting under
System] -> [Routine Job] page defines the setting of the [
the [Manage
Inactive User
Report] routine job. The role of the [Inactive User Report] routine job is to send a reminder notice to users who have been inactive on the system.
This job will run daily as defin time is 09:20 AM. If you wan ed by the [Daily at] setting, the default start t your users to receive these reports, please select the [Enable] option. Otherwise, select the [Disable] optio n.
6.6 Off-line Backup Reminder
The [User Report] -> [Off-line Backup Reminder] setting unde
System] -> [Routine Job] page defines the setting o r the [Manage f the [Off-line Backup
Reminder] routine job. The role of the [Off-line Backup Reminder] routine job is to send a reminder notice to users who have set the off-line backup option in their backup sets but faile d to backup for a certain amount of time.
This job will run daily as defined by the [Daily at] setting, the time is 09:25 AM. If you want your users to receive these r select the [Enable] option. Otherwise, select the [Disable] optio n. default start eports, please
6.7 Backup Quota Reminder
The [User Report] -> [Backup Quota Reminder] setting under the [Manage
System] -> [Routine Job] page defines the setting of the [Backup Quota
Reminder] routine job. The role of the [Backup Quota Reminder] routine job is to send a reminder notice to users whose storage quota usage has hit a pre-defined percentage, the default quota usage setting is more than 90%.
Ahsay Systems Corporation Limited 50
Ahsay Offsite Backup Server
Administrator’s Guide
This job will run daily as defined by the [Daily at] setting, the time is 09:05 AM. If you want your users to receive these r default start eports, please select the [Enable] option. Otherwise, select the [Disable] option. Please this reminder. also set the pre-defined percentage of storage divided by quota that will trigger
6.8 Trial User Reminder
The [User Report] -> [Trial User Reminder] setting under
System] -> [Routine Job] page defines the setting of th
Reminder] routine j send a reminder notice to users whose trial accounts that the the [Manage e [Trial User ob. The role of the [Trial User Reminder] routine job is to ir account will expire. The default setting is to send reminder reports 25 d ays after trial account registration.
This job will run daily as defined by the [Daily at] setting, the default start time is 09:50 AM. If you want your users to receive these reports, please select the [Enable] set the number
option. Otherwise, select the [Disable] option. Please also
of days after registration that the users should get this reminder.
6.9 Usage Repo rt
The [System Report] -> [Usage Report] setting under the [Man
> [Routine Job] page defines the setting of the [Usage Repor age System] t] routine job.
The role of the [Usage Report] routine job is to send usage report, which contains a statistics of all backup users’ activities, to the administrative contacts of AhsayOBS.
This job will run d aily as defined by the [Daily at] setting, the default start time is 09:55 AM. If you want the administrative contacts o f AhsayOBS to receive the usage report, please select the [Enable] option. Otherwise, select the [Disable] option.
6.10 Error Report
The [System Report] -> [Error Report] setting under the [Manage System] -
> [Routine Job] page defines the setting of the [Error Report] routine job.
The role of the [Error Report] routine job is to send error report, which contains a full listing of all system and backup errors, to the administrative contacts of AhsayOBS.
This job will run daily as defined by the [Daily at] setting, the default start time is 09:15 AM. If you want the administrative contacts of AhsayOBS to
Ahsay Systems Corporation Limited 51
Ahsay Offsite Backup Server
Administrator’s Guide receive the erro r report, please select the [Enable] option. Otherwise, select the [Disable] option.
6.11 Replication Error Report
The [System Job] -> [Replication Error Report] setting under
System] -> [Routine Jo
the [Manage b] page defines the setting of the [Replication Error
Report] routine job. The role of the [Replication Error Report] routine job is to errors appear send the replication error report, which contains the list of during the replication process.
This job will run daily as defined by the [Daily at] setting, the default start time is 00:00 AM. If replication is enabled on AhsayOBS and you want the administrative contacts of Ah please select the [Enable] opti sayOBS to receive the replication error report, on. Otherwise, select the [Disable] option.
6.12 Inactive User Removal
The [System Job] -> [Inactive User Removal] setting under
System] -> [Routine Job] page defines the setting of the [
Removal] routine job. The role of the [Ina
the [Manage
Inactive User ctive user Removal routine job is to remove inactive trial users (i.e. no logon or backup traffic from this user) from AhsayOBS as defined by the Free Trial Setting.
This job will run daily as defined by the [Daily at] setting, the default start t the [Enable] time is 09:35 AM. If you want this job to run, please selec option. Otherwise, select the [Disable] option.
6.13 Retention Policy
The [System Job] -> [Retention Poli
> [R cy] setting under the [Manage System] outine Job] page defines the setting of the [Retention Policy] routine job.
The role of the [Retention Policy] routine job is to de retention area for each user according to the retention polic set of each backup user. lete files from the y of each backup
This job will run daily as defined by the [Daily at] setting, the default start time is 09:40 AM. If you want this job to run, please select the [Enable] option. Otherwise, select the [Disable] option.
Note:
The retention policy job would retain data in accordance to the retention policy configured for the corresponding backup set. A formula is used to determine which file should be "retained" in "Days" unit, at "00:00" of each day (NOT the system routine job execution time). For a backup set with a 7
52 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
'days' retention policy, the system routine job would retain modifie data of th d / deleted e past 7 days (oldest data being uploaded after 00:00, 7 days ago).
WARNING:
D isabling the Retention Policy job could result in: i. User accounts exceeding there quota limits an d therefore interrupting normal backup operations. ii. AhsayOBS user home(s) drives running out of space, which could result in your AhsayOBS becoming unstable and or cause
data corruption.
6.14 Rebuild User Storage
The [System Job] -> [Rebuild User Storage] setting under the [Manage
System] -> [Routine Job] page defines the setting of the [Rebuild User
Storage] routine job. The role of the [Rebuild User Storage] routine recalculate all users’ storage information (e.g. data area fil
job is to e size/number, retention area file size/number) by traversing through all backup files users within the system. for all
The job is designed to run weekly and will run at the time defined b
[Every WEEKDAY at] setting, the default start time is every Su
AM. If you want this job to run, please select the [Enable] option select the [Disable] option. y the nday at 09:30
. Otherwise,
Note: i. As the Rebuild Use r Storage job is relatively I/O intensive job, it is recommended to schedule this job to run during off peak periods. ii. When a rebuild user storage is run on a user accou active backupsets, the calculations for the storag may not reflect the actual storage used as all activ are skipped. nt with es statistics e backupsets
6.15 System Log Removal
The [System Job] -> [System Log Removal] setting under the [Manage
System] -> [Routine Job] page defines the setting of the [System Log
Removal] routine job. The role of the [System Log Removal] routine job is to remove all system logs (i.e. all information under the System Home, e.g. system error logs or backup error logs) from AhsayOBS after the [Keep Logs
For] number of days.
53 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
This job is designed to run daily and will run at the time defined at] setting, the default start time is 09:45 AM. If you want
by the [Daily
this job to run, please select the [Enable] option. Otherwise, select the [Disable] option.
6.16 Debug Log Removal
The [System Job] -> [Debug Log Removal] setting under
System] -> [Routine Job] page defines the setting of the [Debug Log
Removal] routine job. The role of the [Debug Log Removal] ro
the [Manage remove all debugging logs (e.g. access logs and web application from AhsayOBS after the [Keep Logs for] number of days. utine job is to
context logs)
This job is designed to run daily and will run at the time defined by the [Daily at] setting, the default start time is 09:10 AM. If please select the [Enable] option. Otherwise, select you want this job to run, the [Disable] option.
6.17 Cyclic Redundancy Check (CRC) Checkin g
The [System Job] -> [Cyclic Redundancy Check (CRC) Checking] setting under the [Manage System] -> [Routine Job] page defines the setting of the
[Cyclic Redundancy Check (CRC) Checking] routine job.
The role of this routine job is to check the CRC of the backup fil
2 nd
and 4 Saturdays every month, the default start time is 12:00 AM.
The “Cyclic Redundancy Check (CRC) Checki
AhsayOBS. When the CRC job checks a file it will update the fi an ‘AhsayOB number of 0 to 60) days, so for existing files which have previously. The next CR days. es on every ng” job will check all new files on le header with
S CRC next check date’. This is calculated as 180 + (random been checked
C check on the file will be performed after 180 to 240
Durin g this checking, it will check the followings things:
The file size of the backup file with the size stored in the header of backup file.
The CRC valu e of the backup file with the checksum value stored in the header of the backup file.
Files will be deleted if it is found to be invalid or corrupted in the retained area and current folder. Other affected files in the delta chain may also be deleted.
To configure the “Cyclic Redundancy Check (CRC) Checking” job to validate all files regardless of the last checked date, please check the [Force to check all backup files] option.
54 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
WARNING:
Using the [Force to check all ba ckup files] option could result in performance issues with your AhsayOBS server. This option may
impact on backup and restore performance.
6.18 Configuration Archival
The [System Job] -> [Configuration Archival] setting under the [Manage
System] -> [Routine Job] page defines the setting of the [Configuration
Archival] routine job. The role of the [Configuration Archival] routine job is to backup critical AhsayOBS configuration files (e.g. CONF folder , Policy Home and User Home) and upload them to the Ahsay License Server
30 days of configuration files will be kept on the ALS.
(ALS). At most
This job is designed to run daily and will run at the time defined by the [Daily at] setting, the default start time is 12:30 PM. This job is disabled by default.
Ahsay Systems Corporation Limited 55
Ahsay Offsite Backup Server
Administrator’s Guide
7
Managing Replication
The replication module is managed by the [Manage System] -> [Replication
Config] page. For more information about this feature, please refer to the
Ahsay Replication Server Administrator’s Guide .
Also, please refer to the AhsayOBS and AhsayRPS Setup Guide for information on how to install the AhsayRPS to work with AhsayOBS.
Ahsay Systems Corporation Limited 56
Ahsay Offsite Backup Server
Administrator’s Guide
8
Managing Other Options
This chapter describes how you can use the [Manage System] -> [Other options] page (shown below) to manage the advertisements for all users and default In-File delta setting for AhsayACB users.
Key
In-file d setting
Description
Select this option to enable and use in-file delta technology for all AhsayACB clients.
Block Size
Minimum Size
Delta Merge
The in-file de lta block size used to detect changes within a file. A smaller block size should produce a smaller delta file but requires more processing power. The default setting of [Auto] will choose the optimal block size for each file based on the file’s original file size.
The minimum size setting defines the small est file size to apply the in-file delta.
To enable delta merging on all users.
In-File Delta Type The In-File delta type to use for calculating the delta file:
Incremental – this option uses the previous uploaded full or incremental file to calculate the delta. It produces the smallest delta for upload but requires the most time and processor power to restore.
Differential – this option always uses the latest uploaded full file to calculate the delta. It
57 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Upload Full Fil e
produces a larger delta but allows for the fastest restore.
The upload full file setting determine s when the full file should be uploaded to the server instead of the delta. It depends on either of the following rules bein g true:
Maximum No. of Delta – the tot deltas uploaded since the las default setting is 100 deltas. al number of t full file. The
Delta Ratio – the ratio of the Delt by the Full file size. The default set a Size divided ting is 50%.
Adgroup for all An adgroup groups multiple advertisements into a logical
AhsayACB and
AhsayOBM users unit which can then be assigned to different users. All advertisements within an adgroup will be presented to all users who have been assigned to this adgro up.
Advertisements Click the [Add] link to add new advertisements.
Note: The compression type option for AhsayACB is not new A hsayACB users created with AhsayOBS version 6.9 or above will use the “Fast” compression setting for default. Fast compression has less compression ratio, the size of the backup sho than those pre-existing AhsayACB users with configurable, uld be larger same amount of backup data. Pre-existing AhsayACB customers will use normal compres sion settings.
8.1 In-File Delta Settings for all AhsayACB users
The [In-File delta settings for all AhsayACB users setting under the [Manage
System] -> [Other Options] page defines a global setting o f In-File Delta
Technology for all AhsayACB clients. Select this option to enable In -File Delta
Technology for AhsayACB clients.
8.2 Block Size
The [Block Size] setting defines the size of data block being used to detect changes between the last full backup file and the file being backed up. In general, the smaller the block size, the more likely a matched data block can be found, hence produces a smaller delta file but will require more processing power to detect these changes. On the other hand, In-File delta backup running with a larger block size will run faster but this will generally produce a larger delta file.
Ahsay Systems Corporation Limited 58
Ahsay Offsite Backup Server
Administrator’s Guide
The default setting [Auto] will select the optimal block size depending on the size o accord ing the fol
for each file f the file. The [Auto] setting will set the block size lowing crite ria:
File Size
< 2 GB
2 GB to 8 GB
> 8 GB
Block Size
4 KB
8 KB
16 KB
8.3 Minimum Size
The [Minimum Size] setting defines the smallest file size a fil value is 25 MB) must have before the use and application o backup technology. e (the default f in-file delta
If the size of a file being backed up is smaller than the [Minim setting, in-file delta backup technology won’t be applied to th um File Size] is file and the whole file, instead of just the delta file, will be uploaded to the backup server.
For backupsets which contain relatively sma ll files, the [Minimum Size] should be increased. As it is not necessary to perform in-file delta backup on small files because backing up the full file doesn’t take too long anyway. The advantage of required to re backing up the full file is it will reduce the amount of time store, i.e. the restore of one small full file is much quicker than the restore a small file with associated incremental delta’s.
8.4 Delta Merge
The [Delta Merge] setting under the [Manage System] -> [O page defines a global setting of delta merging for all AhsayAC ther Options]
B clients. This setting is disabled by default. If delta merge is enabled, it is rec ommended to use the in-file delta type “Incremental”.
WARNING:
When the delta merge option is enabled and the in-file delta type
“Differential” is selected. The Delta merge feature will not merge differential delta files with the full file. Delta merge will only work if there are pre-exisitng incremental delta files in the delta chain. Once the incremental delta’s are merged, the delta merge feature will no longer merge files in the delta chain.
Ahsay Systems Corporation Limited 59
Ahsay Offsite Backup Server
Administrator’s Guide
8.5 In-File Delta Type
The [In-file Delta Type] setting de
There are two diffe fines the way In-File Delta files are handled. rent versions as follows:
Incremental In-File Delta
All delta files are generated with respect to changes made since the last incremental backup. This means that the last full backup file and all related incremental delta backup files are required to restore the latest snapshot of a backup file.
The full backup file, its checksum file and all incremental delta files are always stored in the data area. This means that th by the setting of t ese files are not affected he retention policy and will always be kept on the backup server. But for backupsets with delta merge enabled, the re setting is also used by the delta merge feature to determine wh tention policy en AhsayOBS
. will merge the full and incremental delta files into a new full file
Differential In-File Delta
All differential delta files are generated with respect to change s made since p file and the napshot of a ermediate differential delta files are only required if the last full backup file. This means that only the last full backu last differential delta file are required to restore the latest s backup file. The other int you want to restore intermediate snapshots of a backup file.
The advantage of a differential In-File delta backup is tha t a corrupted f a backup file differential delta file would only make one particular snapshot o non-recoverable. All other snapshots can still be recover remaining differential delta files. ed using the
The full backup file, its ch ecksum file and the last delta file uploaded (if more than one delta files have been uploaded to the backup server) is always stored in the data area. This means that these files are not affected by the setting of the rete ntion policy and will always be kept on the backup server.
It is done this way because all these files are required to get the latest snapshot of the backup file and they should not be removed from th server are stored in the retention area. e backup by the retention area cleanup routine. All other intermediate delta files
8.6 Upload Full File
The [Upload Full File] setting defines when to upload a full file instead of a delta file.
No. of Delta
The [No. of delta] setting defines the maximum number of delta files from the same full backup file to be generated and backed up to the backup server
60 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide before a fu ll backup (the whole file) of this file is uploaded to the backup server instead.
For example, if you have created 100 delta files from the fu already and this [No. of delta] setting is set at 100, the ne ll backup file xt backup will upload a full backup file (the whole file) instead of just the delta if the [No. of delta] setting is set to unlimited. It will keep ge
file. However, nerating delta files and uploading these delta files to the backup server until the oth er delta setting condition (delta ratio exceeded) forces a full backup. This setting is here to m ake sure that there will always be a full backup file after a certain number of delta files have been generated.
Delta Ratio
The [Delta Ratio] setting is defined as the file size of a delta file (the file size of the delta file generated by AhsayOBM on the client computer) an by the file size of its full backup file (the file size of the backup fi d divided le on the disk tween the last of client computer), i.e. the percentage of changes detected be full backup file and the current file.
If the delta ratio calculated from the size of the generated de lta file and the size of the full backup is greater than the [Delta Ratio] setting, the whole instead of just the delta file, will be backed up to the backup
file,
server. It is done this way because the difference between backing up the whole file and the delta file is not significant and it is better to upload the who le file instead.
The default setting of [Delta Ratio] is 50 %. This means that if the changes detected within a file are more than 50%, the whole file, instead of the delta file will be backed up and uploaded to the backup server.
It is recommended for backupsets where the full file size(s) are relatively small:
1. The [No. of delta] settings be kept to a low value
2. The [Del ta Ratio] setting should be less than 50%
3. The [Minimum Size] setting should be increased to more than 25 MB
This will minimize the probability of future restore problems caused b y invalid or corrupted delta files.
8.7 Adgroups
An adgroup groups multiple advertisements into a logical unit which can then be assigned to different users. All advertisements within an adgroup will be presented to all users who have been assigned to this adgroup.
To add a new adgroup, type the name of the adgroup in the empty field located under [Adgroup for all AhsayACB and AhsayOBM users] and next to
Ahsay Systems Corporation Limited 61
Ahsay Offsite Backup Server
Administrator’s Guide the [New] text. Press the [Update] button at the bottom and a new adgroup will be created.
8.8 Advertisements
The [Advertisements] setting defines the advertisements and related information that is displayed at the bottom of a ll AhsayACB clients.
Key
Add
Description
Click this link to add a new advert.
Show Advertisement Log Click this link to view the advertisement log.
Name
Text
The name of the a this ad. dvertisement. Click the link to edit
The text to be displayed at the botto
AhsayOBM/AhsayACB client. m of the
Start Date
Popularity
The data when this ad was created.
Calculated value to indicate which ad
[Hit for this ad.] divided by [To
. Is the most popular. The value is calculated as the percentage of tal Hits].
Hits
Time
Move
Target
Remove
The “Hits” counter indicates the number of times this ad. has been clicked. The se counters are only updated if the option “Enable Tracking” is set. The three values are [Hits within 1 day] / [Hits within the last 7 days] / [Hits within the last 30 d ays].
The number of seconds to display the ad.
The display sequence of the adverts.
Click this link to test the advertisement’s URL. This will open a browser and displays the URL web page.
Click this link to delete the ad.
Ahsay Systems Corporation Limited 62
Ahsay Offsite Backup Server
Administrator’s Guide
Add New Advertisement
Click the [Add] link to add new advertisements. Enter the ad. information into the form provided.
Key
Name
GIF Image
Flash Image
Text
Text Animation
Text Alignment
Description
The name of the advertisement.
It determines if the advertisement should be included in the adgroup(s).
The full pathname of the image file t o be displayed at the bottom of the AhsayOBM / AhsayAC B client. The image size should be 468 x 60, and the format should be in GIF.
The full pathname of the flash image displayed at the bottom of the Ahsa client. The image size should be 468 player must be availab order to display the image. file to be yOBM / AhsayACB x 60. Flash le on the client’s machine in
The text to be displayed at the bottom of the
AhsayOBM / AhsayACB client.
Setting to define whether the text should scroll.
Scroll Left – text scrolls from right to left.
Scroll Right – text scrolls from left to right.
None – do not scroll text.
Setting to define the text alignment.
63 Ahsay Systems Corporation Limited
URL
Enable Tracking
Seconds
Ahsay Offsite Backup Server
Administrator’s Guide
Left – text is alig ned left.
Center – text is cen tered.
Right – text is aligned rig ht.
The URL of th e ad. If the user clicks the ad. in
AhsayOBM / AhsayACB, a browser will open and displays this web page.
When selected, every time the user clicks the advert in the AhsayOBM / AhsayACB client, a “Hits” counter is incremented.
The number of seconds to display the ad.
Ahsay Systems Corporation Limited 64
Ahsay Offsite Backup Server
Administrator’s Guide
9
Managing System Diagnosis
This chapter describes how to manage the function in the [Manage System] -
> [System Diagnosis] page.
The default inspection type on this page is the showing
Information, s and num ber u ch as operating system, physical m of threads on the server. This information i to check o s
the System administrator and it is also u eful for troubleshooting purpose. emory, heap size usage s useful for n the current health status of the AhsayOBS server
Key Description
Operating System The version of the operating system that hosted on. Eg: Windows 2003, Windows XP the AhsayOBS
.
Architecture The CPU architecture (ISA) series for computer processors.
Number Of
Processors
Number of independent actual processors in a single computing component.
Committed Virtual
Memory
Amount of virtual memory guaranteed to be available to the running process.
Total Physical
Memory
Total amount of random-access memory (RAM).
65 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Free Physical
Memory
Total Swap Space Total amount of storage space in the hard disk drive that is used for virtual memory.
Free Swap Space The amount of free space in the hard disk d used for virtual memory. rive that is
Current Heap Size Amount of memory currently occupied by the Java heap.
Maximum H
Size
Threads Current num ber of live daemon and non-daemon
Peak threads.
The highest number of live threads since
Machine (VM) started.
Java Virtual
Daemon Threads Current number of live daemon threads.
Total Threads
Started started, including daemon, non-daemon, and terminated threads.
When the [System Files] inspection is selected, the following screen will be shown.
You can click into the folder path to navigate on your AhsayOBS server and you can click on the download icon to download the file/folder. You have the option to download the file in Zip format or no compression format. For example, if your file that you need to open is only several hundred Kbytes, you can use the no compression option. If the file size is several Mbytes, or
66 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide even Gbytes in size, or you are going to download the who should use the Zip option. The download file will be renamed as need to unzip it by eg: Winzip. Also if the download do wnload spee d will be mu le folder, you
*.zip and you
file is in Zip format, the ch faster than no compression format.
Key
Size
Description
Size of the file (unzip).
Last Modified The last modified date of the file.
Ahsay Systems Corporation Limited 67
Ahsay Offsite Backup Server
Administrator’s Guide
10
Manage System User (Reseller Panel)
This chapter describes how you can use different function under the [Manage
System User] menu to manage the system users or resellers within
AhsayOBS.
The [Manage System User] feature allows backup server administrators to create three types of system users, “Admin”, “Sub Admin” and
System users with the “Admin” role have full control to m system systems, policy sttings and backup user accounts. Syst the “Sub Admin” role have full control to managing their own backup accounts. While “Non-Admin” system users only have read o
users own group policy settings. r details.
“Non-Admin”. anage all the em users with user nly access to the backup user accounts created by the “Sub Admin” system user. System or resellers can independently manage there
Please refer to the chapter Group Policy Management for furthe
The backup server administrator can utilize system user accou on the environmen t where the AhsayOBS server is deployed. nts depending
1. If AhsayOBS is deployed as an internal company ba
The backup server administrator can create system ckup service.
user account with "Sub Admin" role for each department to manage backup users. their own
2. If AhsayOBS is deployed as a commercial backup service. The backup server administrator can create a system user account with
"Sub Admin" role for each of their resellers to manage their own clients.
Each system user (Sub Admin) or reseller account on AhsayOBS supports the following customization features.
1. The look and feel of AhsayOBS web console along with the customized logos.
2. Customized logo for the reports sent to backup users.
3. Customized user guide.
4. Report can be sent via a system users own SMTP server. Each backup client type, i.e. AhsayOBM, AhsayACB can have its own designated report sender and reply email address.
5. Each system user or reseller can install there own web SSL certificate.
From AhsayOBS v6.7.0.0 onwards each system user (Sub Admin) or reseller account has full control in deploying client side upgrades for each backup user account under their control.
Ahsay Systems Corporation Limited 68
10.1 My Profile / Edit System User
Ahsay Offsite Backup Server
Administrator’s Guide
When you click the [Manage System User] - > [My Profile] link the top menu, the [My Profile] form will be shown. You can then up sys panel will
available at date tem user profile to the system by submitting this form to AhsayOBS. The display differently depending on the role of current login system user.
Admin Role
The build-in “system” account is defined as “Admin” role. “Admin” role user has the highest authorization level, all the AhsayOBS settings, backup users settings can be accessed or modified by “Admin” role users at all times.
From 6.11.0.0, new “Admin” role user can be added via the AhsayOBS management console > Manage System User > Add System User
The above user has the “Admin” role and it has the same privilege as the build-in “system” account. For example, you can assign this account for your administrator(s) to configure/administrate the AhsayOBS for you.
69 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Non Admin Role
“Non Admin” role system user shares the similar accessibility as except with read permission only (Descendant system user users of its creator could be accessed). If “Non Admin” role
its creator s and backup
system user needs to have the same User Control Policy Settings as its creator, remember to add the “Non Admin” role system user in the same user group as its creators.
For example, you may assign your operators to login the AhsayOBS to check on the backup reports and AhsayOBS system logs etc, without worrying that they will modify any settings on the AhsayOBS accidentally.
Sub Admin Role
“Sub Admin” role system user can access all descendant system users and backup users. When Single Level Access is enabled, system users are restricted to only accessing their own created system users, backup users of system users. Please refer to the chapter Single Level Access for further details.
Ahsay Systems Corporation Limited 70
Ahsay Offsite Backup Server
Administrator’s Guide
Note:
1. Backup user accou nts created by “sub admin” system users are only supported by AhsayOBM and AhsayACB v6.3.0.0 or above clients.
2. Backup user accounts created by “sub admin” system us an AhsayR ers running in
DR setup, are only supported by AhsayOBM and AhsayACB v6.7.0.0 or above clients.
3.
For sub admin with a different hostname s etting than the default system account, all backup accounts created by that sub admin corresponding hostname when logging into the AhsayOB web interface.
must use the
M/ACB client or
4. If your domain name has already mapped with the port name eg. 19 2.168.1.123:8080 ba ckup.backu
pvault.com the port numb er 8080 is no t required in the client connection settings.
Summary of the privil ege of Admin Subusers s , Admin a nd Non-Admin
Description
General System Settings
Connectivity Testing
System Diagnosis
System Logs
User Management (Profile,
AutoUpdate, Report)
Backup Set Management
Ahsay Systems Corporation Limited
Admin
Read only
Role
Sub-Admin Non-Admin
Read only *
*
Read only
*
Read only
Read only
Read only
71
Ahsay Offsite Backup Server
Administrator’s Guide
Run Backup
Restore via restorer applet
Delete file via restorer applet
Group Policy Management
System User Management
Read only
Read only
* It is valid that the “Non-Admin” is created by the “Admin” but not valid if the “Non-Admin” is created by the “Sub-Admin”.
10.2 SMTP Settings
[SMTP Settings] is available for “Sub Admin” role system use
[SMTP Settings] is enabled, user reports and system reports for def sender contact information can be separated for OBM r only. When
current “Sub
Admin” role system user and the associated backup users will ined at [Manage System] -> [Server Configuration] panel. The report and ACB backup clients.
A maximum of one report sender contact information can be defined for each backup client type.
Note:
SMTP server with Transport Layer Security (TLS) is not supported. be sent through system user defined SMTP server instead of default SMTP server
10.3 Customize Interface
[Customize Interface] is available
This option allows “S
for “Sub Admin" role system users only. ub Admin” role system users to customize their
AhsayOBS web interface, docume ntation and company logo in email report with their own branding.
The default customization files are compressed into custom.zi
p file and can be downloaded from the key section (circled in RED). It con folders for di fferent customization formats: sists of three
1. “css”
2. for web style sheets.
“gif” for AhsayOBS web interface logos.
3. “pdf” for documentation.
When updating the contents of the custom.zip file, please be careful not to change the folder structure or the folder names otherwise the customization cannot be applied to AhsayOBS. The custom.zip should only contain the following folders:
-->css
-->gif
72 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
The language code is enforced on .css and .pdf customization files. Please
.g. jsp_en.css, specify language code and appended it to the end of the file (e jsp_da.css, obs-admin-guide_en.pdf, obs-admin-guide_da.p
df), system default settings will be u sed if language code cannot be found from uploaded files. Previous uploaded customized file can be downloaded again for modification (circled in BLUE). further
AhsayOBS reseller customization will be effective once “custom.zip” is uploaded from [Manage System] -> [Manage System
[%system_user% ] -> [Upload Customization File].
User] ->
Please refer to the section Branding AhsayOBS in this document for the use of customization files.
Password
A description of all fields above is provided in the following table.
Key
Login Name
Description
Login Name of current system user.
Role Role of the current system user.
Password of the current system user used to logon to web interface.
73 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Name Email report contact name of t he current system user.
Host Name
Email address of the current system user.
A resolvable hostname of dedicated for the cu rrent system user. (e.g. backup.compa
ny.com). Although you can supply an IP address here, Login nam duplicated under the same host name. e cannot be
SMTP Server The SMTP server that AhsayOBS will use to de email reports to current system user and ba liver its ckup users of current system user.
Report Sender The name and email address that will be used as a sender
Upload
Customization
File for all outgoing mails to backup users of cu user.
rrent system
A maximum of two different report senders can be defined for AhsayOBM and AhsayACB users separately.
Upload AhsayOBS web customization file ‘ the system. custom.zip’ to
Once the “custom.zip” file has been successfully uploaded to the reseller or
“system user” account, the files will be uncompressed and saved under the
%OBSR_HOME%\system\policy\SystemUser\%systemuser% folder along with a copy of the “custom.zip” file.
Ahsay Systems Corporation Limited 74
Ahsay Offsite Backup Server
Administrator’s Guide
10.3.1 Customize Reseller Reports
In addition to modifying the look and feel of the AhsayOBS web console, each reseller can customize " reports: logo" and "home page link" for the following email
1. Backup Job Remind er Report
2. Backup Quota Reminder Report
3. Backup Report
4. Error report
5. Forgotten Password R eport
6. Inactive User Report
7. New User Report
8. Offline Backup Reminder Report
9. Setting Change Report
10.Trial User Reminder Report
In order to customize the email reports, please replace the "default.large.gif" found in the “gif” folder of the custom.zip file, with the reseller customized logo and rename it to "default.large.gif"
75 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
The following is an example of a customized reseller New User report:
The customized reseller logo will appear on the top left hand corner of each report.
1. The logo is linked to the IP Address/ URL of particular resellers
AhsayOBS web console, when the logo is double clicked the resellers Ahsa default web bro yOBS web console will be loaded on the machines wser.
2. The “installation wizard” link will load the AhsayO BM/AhsayACB installation page using the resellers IP Address/URL.
10.4 Add System User
When you click the [M anage System User] -> [Add System User] link available at the top menu, the [Add System User] panel will be shown. This panel allows “Admin” role user to add an “Admin”, “Sub Admin” and “Non
Admin” role user to the AhsayOBS. A “Sub Admin” role user can also create
“Sub Admin” and “Non Admin” role user using this panel. This panel is similar to the [My Profile] page under [Manage User] setting, except that user has the choice to select the [Role] on this page. The SMTP settings will be inherited to its associated users.
76 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
10.5 List / Remove System User
When you click the [Manage System User] -> [List System Use at the top menu, the [List System User] panel will appear. Th you to list and access all other system users within your auth use the alphabet categories at the top o r] link located is panel allows ority. You can f the user listing to filter the listing to show those users whose login name starting with a certain alph abet. You can also use the [ALL] function to list all system users.
When you click the [Login Name] link available on the system user list, the
[System User Settings] panel will appear for system user pro file editing.
When you click the [Role] link available on the system user list, the system user list will be filtered again by the selected system user. When you click the chain of system user list link under the alphabet categories (circled in RED), the system user list will be filtered again by the selected system user.
Some defin itions of the fields related are shown in the follow ing table:
Description Key
Chain of
System Us
Lo gin Nam er es
It is shown by click on the role column in the
System Users] Page .
You can filter a list of accessible system u select the chain.
[Manage sers of the ed system user by clicking on the login name link on
Login Nam e
Role
Login Name of the syste m user. Clicking [Login Name] link to access system user pro file.
Role of the system user. Select system user by clicking
[Role] link to filter accessible system us ers of selected system user.
Name
Host Name
Backup User
Email report contact name of the system user.
Email address of the system user.
Host name/IP address assigned to the system user.
Display in AhsayOBM and AhsayACB icons to indicate
77 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Owner
Remove system user has one or more backup user the icon to vie s. Clicking on w the list of backup users owned by the selected system user.
The owner of the corresponding system user.
To remove a system user from the system , just press the link next to the system user that you would like to remove. The recycling bin disappears when the system user has created one or more system users or backup users.
For sub admin accounts the link will only be visible if there are no existing dependencies for the sub admin accounts, i.e. system and backup users created by this account. If you wish remove a sub admin account, you will
this particular sub need to remove all system and backup users accounts by admin account.
1 0.6 Recovering a System User/Non-admin Pass word
The “Admin Role” user can reset any “Admin” (except the build-in “system” user), “Sub Admin” and “Non Admin” role user’s password via the AhsayOBS web console [Manage System] -> [Manage System User] -> [List System
User ] -> [%system_user%] -> [System User Settings] -> [Password], then enter a new password and press the [Update] button.
Alternatively, the server administrator can reset any “Admin” (except the build-in “system” user), “Sub Admin” and “Non Admin” role user password using the following procedure:
78 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
1. Op en the %OBS_HOME%\system\policy\sysUser.xml file in a text editor.
2. Locate the entry for the affect system user or non admin account:
<user name="reseller1"
password="6ZoYxCjLONXyYIU2eJIuAw==
hashed-pwd="Y" contact-name="Reseller 1" cont email="re [email protected]" host-name="10.10.1.98"
="Y">
" role="reseller" uid="13512" enable-smtp-setting
<smtp-server host-name="10.1.0.110" login-nam e="" password=""/>
<report-sender name="Reseller 1 Man ager" email="[email protected]" obm="Y" acb="Y"/>
<interface-customization enable="Y"/>
3. Change the hashed-pwd="Y" to hashedpwd="N"
4. Change the password="6ZoYxCjLONXyYIU2eJIuAw password="%New_Password%"
==" to
The %New_Password% must be in clear text.
5. Restart your AhsayOBS service for the changes to tak e effect.
10.7 Reseller Backup User Account Restrictions
Each “Admin” ro le user or reseller is allowed to create their own backup user accounts. However, “Admin” role users or resellers on an Ah sayOBS server which share the same hostname, they cannot create backup user accounts with identical user names.
If an “Admin” role user or reseller tries to create a backup user account whose username already exists under another reseller, the account creation will not be permitted.
The example shows a system user “reseller2” creating a backup user account
“test2”, which has already been created by another system user “reseller1”.
The following error will be shown on the AhsayOBS web console:
Ahsay Systems Corporation Limited 79
Ahsay Offsite Backup Server
Administrator’s Guide
10.8 Reseller Web SSL Certificate Installation
It is possible to install an individual web SSL certificate for ea
AhsayOBS. In order to install a web SSL cert for a reseller, each r ch reseller on eseller must be assigned an individual IP address.
Example 1:
A customer wants to setup an AhsayOBS se rver with the following configuration.
1. AhsayOBS server with URL main.xyzb
ackup.com which resolves to local IP address 10.10.1.7 using ports 80 and 443.
2. Reseller 1 is assigned a URL res1.xyzback
up.com which resolves to local
IP address 10.10.1.97 using ports 80 and 443.
3. Reseller 2 is assigned a URL res2.xyzb
IP address 10.10.1.98 using ports 80 a ackup.com which resolves to local nd 443.
Each individual URL; main.xyzbackup.com, res1.xyzbackup.com, and res2.xyzbackup.com will have its own web SSL certificate.
1. Make copies of the default %OBS_HOME%\conf\keystore file i. %OBS_HOME%\conf\keystore_res1 for Reseller 1 ii. %OBS_HOME%\conf\keystore_res2 for Reseller 1
2. Edit the server.xml file
<Connector address="10.10.1.7" port="80" maxHttpHeaderSize="8192" socketBuffer="65536" maxThreads="1000" minSpareThreads="100" maxSpareThreads="8192" maxKeepAliveRequests="100" enableLookups="false" redirectPort="443" acceptCount="200" connectionTimeout="60000" disableUploadTimeout="true" URIEncoding="utf-8" />
<Connector address="10.10.1.7" port="443" maxHttpHeaderSize="8192" socketBuffer="65536" maxThreads="1000" minSpareThreads="100" maxSpareThreads="8192" maxKeepAliveRequests="100"
80 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide enableLookups="false" redirectPort="443" acceptCount="200" connectionTimeout="60000" disableUploadTimeout="true" URIEncoding="utf-8" SSLEnabled="true" scheme=
<Connector address="10.10.1.97" port="80" maxHttpHeaderSize="8192
"https" secure="true"
keystoreFile="conf/keystore" keystorePass="changeit" clientAuth="false" sslProto
" socketBuffer="65536" maxThreads="1000" minSpareThreads="100" maxSpareThreads="8192" maxKee pAliveRequests="100" enableLookups="false" redirectPort="443" acceptCount="200" connectionTimeout="6 disableUploadTimeout="true" URIEncoding="utf-8" />
<Connector address="10.10.1.97" port="443" maxHttpHeaderSize="8192" socket col="TLS" />
0000"
Buffer="65536" maxThreads="1000" minSpareThreads="100" maxSpareThreads="8192" maxKeepAliv enableLookups="false" redirectPort="443" acceptCount="200" connectionTimeout="6 disableUploadTimeout="true" URIEncoding="utf-8" SSLEnabled="true" scheme="htt
keystoreFile="conf/keystore_res1" key storePass="changeit" clientAuth="false" sslProtocol="TLS" />
<Connector address="10.10.1.98" port="80" maxHttpHeaderSize="8192" socket Buffer="65536" maxThreads="1000" minSpareThreads="100" maxSpareThreads="8192" maxKeepAl enableLookups="false" redirectPort="443" acceptCount="200" connectionTimeout= disableUploadTimeout="true" URIEncoding="utf-8" /> eRequests="100"
0000" ps" secure="true" iveRequests="100"
"60000"
<Connector address="10.10.1.98" port="443" maxHttpHeaderSize="8192" socketBuffer="65536" maxThreads="1000" minSpareThreads="100" maxSpareThreads="8192" maxKeepAliveR enableLookups="false" redirectPort="443" acceptCount="200" connectionTimeout="600 disableUploadTimeout="true" URIEncoding="utf-8" SSLEnabled="true" scheme="https"
keystoreFile ="
conf/keystore_res2" keystorePa equests="100"
00" secure="true" ss="changeit" clientAuth="false" sslProtocol="TLS" />
Create new entries in the server.xml for R
(10.10.1.98). Ensure that each entry for h
10.10.1.7 - eseller 1 (10.10.1.97) and Reseller 2 ttps refers to a unique keystore file. keystoreFile="conf/keystor e"
10.10.1.97 - keystoreFile="conf/keystore_res1"
10.10.1.98 - keystoreFile="conf/keystore_res2"
3. To install the individ ual web SSL certificates for each reseller, please refer to the instructions in Installing a trusted SSL certificate .
10.9 Auto Update
Each reseller can manage the Auto Update of their own back those of their own sub resell up users and ers from the AhsayOBS web console under the
[Manage User] -> [Auto Update] page. The backup users accounts displayed include account created by the reseller and sub resellers, by default all backup users are selected for auto update.
In addition to displaying the list of backup users, when Auto Update is enabled on AhsayOBS. Both the latest available upgrade versions for
AhsayACB and AhsayOBM are shown.
81 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
If the Auto Update feature is disabled on AhsayOBS the [Man age User] ->
[Auto Update] page, will display the status “Auto Update is disab led”. Both the latest available upgrade versions for AhsayACB and AhsayOBM will not be shown.
Note:
If the Auto Update feature is disabled on AhsayOBS, the reselle to contact the AhsayOBS server administrator to enable this fea r(s) will have ture.
10.10 Change Ownership
Users can be relocated between different system administrator and reseller, or relocate between reseller and reseller on the AhsayOBS management console > [Manage System User] > [Change Ownership] page
Ahsay Systems Corporation Limited 82
Ahsay Offsite Backup Server
Administrator’s Guide
10.10.1 Migrating users from administrator to reseller
To transfer users from administrator to reseller, please try the following steps:
1. Select the ‘Transferor’ from the dropdown list to Administrator
2. Select the reseller from the ‘Transferee’ dropdown list (eg: Bob)
3. Select the user to transfer by checking the check box next to the user. (eg:
John) and press the [Update] button.
83 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
4. User John disappeared because it is no longer under the Administrator’s user list. Transfer completed.
Note:
1. Email notification will not be turned on, as the user transfer is within the same host.
2. Backup users can be transferred between the same or different hosts.
Section 9.10.2
shows you how the user is transferred within the same host, while section 9.10.3
shows you how the user is transferred between hosts.
84 Ahsay Systems Corporation Limited
10.10.2 Matched host transfer
Ahsay Offsite Backup Server
Administrator’s Guide
The above example in
between matched hosts. They are all i nsfer a user n the same host name eg: third.backup.com . You need to select the radio button ‘Show Matched Hosts’ and you can transfer users within the same host name.
Matched host transfer has less impact to backup user (ie, user does not require to change the connection host). Below is a diagram to illustrate how the user’s ownership is transferred under a matched host.
Backup user ownership can be transferred to the same hosts without email notification.
10.10.3 Mismatched host transfer
When a user is required to transfer between a different host name, eg: third.back-up.com to fourth.back-up.com
Ahsay Systems Corporation Limited 85
Ahsay Offsite Backup Server
Administrator’s Guide
1. In AhsayO BS management console > [Manage System User] > [Change
Ownership] page
2. Select the radio button ‘Show All Hosts’
3. Select the ‘Transferor’ from the dropdown list to ‘Bob’
In this example, ‘Bob’ has a few users and wants to transfer user ‘Tim’ to reseller ‘Claude’.
4. Select the reseller from the ‘Transferee’ dropdown list to ‘Claude’
Ahsay Systems Corporation Limited 86
Ahsay Offsite Backup Server
Administrator’s Guide
5. Select the user to transfer by checking the check box next to the user. (eg:
Tim) , you can see the ‘Notify’ check box on the right hand side is also checked.
6. Click on the [Update] button.
(A notification email will be sent to backup user ‘Tim’ to remind using a new connection host. All services will resume normal only after backup user relogin with new connection host.)
7. User ‘Tim’ disappeared because it is no longer under the Bob’s user list.
Transfer completed.
87 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Note:
Email notification can be disabled by unchecking the notify check box, user cannot connect to the backup server until the hostname setting is changed on the AhsayOBM/AhsayACB on the user machine.
Below is a diagram to illustrate how the user’s ownership is transferred under a mismatched host.
Ahsay Systems Corporation Limited 88
Ahsay Offsite Backup Server
Administrator’s Guide
Backup user’s ownership can be transferred even when hosts are mismatched.
The above example shows reseller ‘Bob’ and ‘Claude’ are hosts, user ‘Tim’ will receive email notification and must re-log
AhsayOBM/AhsayACB to allow the changes effective.
under two different in
10.10.4 Reminder email
A notification email will be sent to backup user when ‘Notify’ option is selected. This email reminds backup user to change their current backup connection settings to new connection settings on the AhsayOBM/AhsayACB.
The reminder email will only be sent when backup account is transferred successfully.
Ahsay Systems Corporation Limited 89
Ahsay Offsite Backup Server
Administrator’s Guide
The message “[ChangeOwnership.sendEmail] will be logged in the system log and user log when the email is send to “Tim”.
1 0.10.5 Suggestions and Best Practic e
1. When the system is running other process simultaneous user account, ly on the backup such as the following list of operations, change of ownership cannot be performed.
- Backup (includin re g server initiated backup jobs)
- Resto
- Rebuild (including on the fly rebuild, single user rebuild or weekly storage rebuild)
- Delta
- Delete files or backup se
- Undelete t using AhsayOBM/AhsayACB or restore applet
- Retention
- CRC
- Configuration
- Delete backup file using API
- Delete backup set using API
- Delete backup data using API
- Modify backup user using API
2. If a user is using CDP, user should disable the CDP before the ownership transfer. After the change ownership process, user must re-login to the
AhsayOBM/ AhsayACB to enable the CDP.
3. Backup user account cannot be transferred if a duplicated account already exists on the transferee (reseller).
4. Backup user cannot be transferred if the user home is locked by external factor eg: file level access to the original user home.
90 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
5. If the transferred user has been replicated to the the Ahsay after the change ownership process, the replicated user will the retention area on the RPS and the whole user folder of t ownership changed user will be replicated to the AhsayR
RPS server, be moved to he newly
PS again. This will affect users when the replication is running in UNSYNC and SYNC mode.
If it is already in LOGG ING mode, only the changes (e.g. folder rename, cloned policies) will be replicated to AhsayRPS. Please reserve space on the AhsayRPS.
6. When a user is transferred, all associated user groups and
enough disk
policy groups will be cloned under transferee to preserve the settings and uplo aded data.
Due to the current limitation, when another user under the group is transferred, a new policy group will be cloned a same policy gain on the reseller’s policy grou p and this will end up duplicated policy groups. If you move the users one by one, it could end up with many duplicated policy sellers are required to manually re-apply users fter user transfer and remove all those groups, administrator or re to the dedicated policy group a du plicated policy grou ps.
1 r
Error Description
Transferee cannot be e mpty No Transferee is selected.
The host name of transferee cannot be empty
Transferee has no host name entry in the reseller’s setting.
Backup user cannot be transferr running a backup oper ation. ed when user is User ‘xxx’ is running
‘Backup’ operation.
Ownership transfer cannot be proceed unti operation finis l the hed.
User ‘xxx’ is running so operations. Ownership transf er cannot be pro me ceed until all operations finished.
Backup user cannot be tran refer to the AhsayO sferred when running multiple operations. Ac tual reason can
BS system log.
User ‘xxx’ ownership transfer cannot be proceeded.
The backup user, ‘xxx’, already exists in the system user, yyy
E409 – 12345 The backup user, xxx, has been
Backup user cannot be transfer system is locked. red when user home is locked by external factor, eg file
A system administrator cannot transfer a backup user to a reseller because a duplicate user name already exists.
Backup user cannot be transferred because transferee (reseller) is holding a backup client
91 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide reserved. Please co
System ntact
Administrator
the for assistance.
Login Name ‘xxx’ is us ed
User ‘xxx’ ownership transfer is in progress. with the same login n ame.
Note: 12345 is the reseller’s ID.
Backup user cannot be tran sferred because transferee (System Administrat or) is holding a backup client with the same log in name.
Backup users can only be transferred at most one transferee at a time.
Ahsay Systems Corporation Limited 92
Ahsay Offsite Backup Server
Administrator’s Guide
11
Managing Backup Users
This chapter describes how you can use all pages under the [Manage User] menu to manage the backu p users within AhsayOBS.
11.1 Create Backup User
When you click the [Manage User] -> [Add User] link available at the top menu, the [Add User] form will appear (see below). You can then add a backup user to the system by submitting this form to AhsayOBS.
Time zone
Language
Backup Client
Assigned Adgroups
A description of all fields above is provided in the following table.
Key Description
Login Name
Password
Login Name of the new backup user.
Password of the new backup user.
Alias Another name of the new backup user .
Time zone of the new backup user.
Preferred language for all email reports of the new backup user.
Choose AhsayOBM client or AhsayACB client.
Choose whether advertisements are displayed at the bottom of the backup client.
93 Ahsay Systems Corporation Limited
Type
Welcome email
User Home
Backup Quota
Bandwidth
Add-on Modules
Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Either [Trial] or [Paid] type. Trial accounts and paid users differ in the following ways:
1. Trial users can only have a maximum backup quota of 500MB within the trial period.
2. Trial users subject to automa tic removal as defined
(though by the [Free Trial Registration] setting automatic removal can be disa
Other than the differences bled). listed above, both trial and paid users are the same in all other areas.
Email address of the new backup user.
Define whether a welcome email shoul d be sent to the new user email address.
The top dire ctory where the software stores backup files and all other information for the new account. If you want this user to be in another pa another drive), please add another use
AhsayOBS by u
Configuration] page. rtition (or in r home to sing the [Manage System] -> [System
If you want to setup your us er home directories to a network drive, please do refer to Ahsay Help Cen tre for more information.
Backup Quota of the new account.
Bandwidth allowed for the new account.
Whether to enable any of the add-on modules to the new backup user.
The [Microsoft Exchange Mailbox] text field defines the number of exchange mailboxes that is allowed to be backed up under this user account.
94
11.2 List / Remove Backup User
Ahsay Offsite Backup Server
Administrator’s Guide
When you click the [Manage User] -> [List User] link available menu, the [List User] panel will appear. You can use the alpha at the top of the user listing to limit th whose login names starting with a certain alphabet. You can also u t at the top bet categories e listing to show only those users se the [All] function available to list all users within he system.
To remove a user from the system, just press the link next to the user you would like to remove.
Key
By
Description
Define whether alphabetically search appl ied to [Login Name] or [Alias].
should be
User Add-on modules Indicates the add-on modules for this account.
Login Name (Alia s) Login Name of this account. Click the account details. Th
AhsayACB).
link to see e name in blankets is the alias, and the icon indicates the client type (A hsayOBM or
Registration Date Date when this a ccount was created.
Trial Expiry Date
Used/Quota (%)
Owner
The expiry date of trial users. If it expires, the user account will be suspended. Paid users will show
“Never Expire” in this field.
The used/allocated quota (and the quota usage percentage) of this backup user.
Owner of this backup user.
95 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Remove Remove this backup user.
Export Users’ Usage
Statistics to CS
Export all users’ usage statistics to a .csv file.
Broadcast Message Use this option if you want to broadcast messages to backup users.
11.3 Broadcast messages to backup users
After you press the [Broadcast Message] link on the top right hand corner of the [Manage User] -> [List User] panel, you will be brought to the [Broadcast
Message] page. You can use this page to broadcast messages to different types of backup users.
Key
From
To
Description
Sender of this message
Broadcast message to the following us ers types:
All – all backup users
Paid – backup users of [Paid ] user type
Trial – backup users of [Trial] user type
AhsayOBM User - backup users of AhsayOBM client type
AhsayACB User – backup users of AhsayACB client type
Admin – backup administrator, i.e. email address defined on the [Manage System] ->
[System Configuration] -> [Administrator
Contact] list (useful if you want to test the
96 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Subject
Message
Text/HTML broadcast featu messa re before sending the ge out to all users).
Subject of this message
Content of this message
The content type of this messa ge, i.e. whether content should be considered as plain text or HTML.
A file to be broadcasted with this message. Attachment
11.4 Managing User Profile
After you press the user name link on the [Manage User] -> [List User] panel, you will be brought to the [User Profile] for this particular user. You can use this panel to update the profile of this user.
Ahsay Systems Corporation Limited 97
Ahsay Offsite Backup Server
Administrator’s Guide they logon to the user areas except that you can now update the
[Quota] and [Add-on Module] (shown in RED) entries on this pa ge.
This panel is no different to the [User Profile] panel that users will see when
[Type],
Click the [File Validation Option] link to rebuild this user’s storage information.
When a rebuild user jobs is started, AhsayOBS will check if there is an active job running on the backupset before a rebuild is performed on the backupsets.
If a backup job is active, the rebuild user storage job will skip rebuilding the active backupset, this will be recorded in the AhsayOBS system log.
The information message “[info][system][BfsManager.rebuildUserBFS] The
rebuild is skipped on the running backup set ESXi4(13009302
test1” is r ecorded when a backupset is skipped.
61358) of user
From AhsayOBS v6.7.0.0 onwards, for the single user rebuild feature backup users or backup server administrators will have the option of selecting either: i. Rebuilding all backup sets under the backup user account or
Rebuilding a single backup set under the backup user account ii.
By default the single user rebuild will rebuild all backup sets under a backup user account.
98 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
To perform a single user rebuild of a specific backup set, click on the “Backup
Set” combo box and select the desired backup set.
When a rebuild of a single backup set is completed, the following message will be shown in the AhsayOBS system log:
The system log entries will specify that AhsayOBS has “Finished single backup set rebuild.”
Note: i. When a rebuild user storage is run on a user account with active backupsets, the calculations for the storages statistics may not reflect the actual storage used as all active backupsets are skipped. ii. For issues relating to incorrect storage statistics, please make sure the rebuild user storage job is run when no
backup jobs are active.
99 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
iii. If all backup sets under a user accounts need to is recommended that a single rebuild user st started a
backup job.
be rebuilt, it orage job is t least 45 minutes after the completion of the last iv. If a single user rebuild is run for a single backup set, the
“Last Check” date and time will also be updated.
You can reset a user password by entering a new password in [U
> [Password] -> [New] entry and press the [Update] button the user password has been updated, both old and new pass temporarily valid, until the user connects to Ah
AhsayOBM/AhsayACB with the new password. This is be user’s old password is still saved on the client machine. It’
AhsayOBM/AhsayACB scheduler service to connect to AhsayOBS in order to run scheduled backups in the interim period. ser Profile] -
. Even though words will be sayOBS via cause a copy of the s required by
The [Microsoft Exchange Mailbox] text field defines the numbe mailboxes allow to be backed up under this backup accoun message indicates the maximum number of remaining licenses
The [Bandwidth] option
allows you to set a maximum network usage for all running backup sets of this particular backup account. All ba share the same bandwidth defined by r of exchange t. The [Max] available. ckup sets will this setting. If you have set the bandwidth to be 128kbits/second and there are two backup sets running at share roughly half of the bandwidth the same time, each backup set will assigned, i.e. 64kbits/second.
The [Notes] field allows you to attach some other information, e.g. telephone number or billing address, with this backup account.
Any updates made to the user profile will trigger:
i.
A “Settings Change Report” will be sent to the user (if the routine job is enabled).
ii. A log entry of the change will be recorded in the [Manage System] -
> [Manage Log] -> [System Log]
iii. A log entry of the change will be recorded in the [Manage System] -
> [Manage User] -> [%USERNAME%] -> [User Log]
Ahsay Systems Corporation Limited 100
Ahsay Offsite Backup Server
Administrator’s Guide
11.5 Managing Backup Set
After pressing on the link of the selected user on the [Manage User]
User] panel, a
-> [List
[Backup Set] link is now available in the extended user menu.
You can review the backup sets setting of this particular user by clicking the
[Backup Set] link.
To update the backup set setting of this particular user, just make the required changes on the form below and press the [Update] button.
Setting Online Restore IP Restriction
At the bottom of the [Backup Set] panel, you should be able to find the
[Online Restore IP Restriction] section. If you would like to restrict online file restore of this backup set to only a subset of trusted IP addresses, you just need to enter the trusted IP addresses here. Once you have entered some IP addresses into the IP restriction list, online file restore request originating from IP addresses into the IP restriction list, online file restore request originating from IP addresses not listed on this list will no longer be able to restore any files from this backup set. (You can use the IP range of
127.0.0.1 – 127.0.0.1 to disable online restore completely).
101 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Global Backup Set Values
The following values are only valid for Group Policy enforcement and default backupsets only, do not use these values in normal backupsets.
Ahsay Systems Corporation Limited 102
Ahsay Offsite Backup Server
Administrator’s Guide
11.6 Initiating Backup from AhsayOBS
While end users can initiate backup jobs from their compu manual or scheduled backup jobs from AhsayOBM or Ah ters by using sayACB. The
AhsayOBS server administrator can initiate a backup job fro m AhsayOBS web console. In order to initate a backup job go to the [Manage User] -> [Run
Backup], and you will have something similar in the following screenshot:
Some definition s of the fields related are shown in the follow ing table:
Key
No.
Description
Number count of user.
Login Name (A
-> Backup Set lias) The lo gin name of the user with the alias bracketed behind. If there is any backup set, the name of the backup set will be shown under the user lo gin name.
Backup is pending “Yes” if the backup job is pending after pressing [Run
Backup]; Otherw ise “No”.
Backup Type Type of backup. For files only backup, the backup type will be empty.
Used / Quota (%) The used data size of the user on the server and the total quota of data size that the user can use. The percentage of used size over quota is bracketed behind.
Owner Owner of this backup user.
103 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Last Backup The creation time of the latest backup.
In order to use this feature:
The AhsayOBM/AhsayACB scheduler service must be running client machine and can connect to the AhsayOBS serve r. on the
The “Run scheduled backup on computers named” field on the backupset must be filled in with the correct compute r name of the client machine.
To initate a backup job from AhsayOBS, check the box next to each of the required backupsets.Then press the [Run Backup] button at the bottom of the page. The status of [Backup is pending] of the chosen back changed to “Yes”, and after a short time AhsayOBM/ Ahsay backing up the data sources from the specific machine. up sets will be
ACB will start
When the backup is finished, the status of [Backup is pending] will become
“No”, and the [Last backup] will backup job.
be update with date and time of the last
11.7 Browsing User Backup File
You can click the [File Explorer] link available at the extended [Manage User] menu to invoke the [File Explorer] panel. You can use this panel to browse and restore user’s backup files. This panel is the same [File Explorer] panel that users would see when they click the [File Explorer] link after they have logged on to the system. Please refer to the User’s Guide for information on how to restore users’ backup files.
Ahsay Systems Corporation Limited 104
11.8 Reviewing User Backup Report
Ahsay Offsite Backup Server
Administrator’s Guide
You can click the [Report] link available at the extended [Manage U to invoke the [Report] panel. You can use this panel to review ser] menu
users’ backup activities. This panel is the same [Report] panel that users w ould see when they click [Report] link after they have logged on to the system. Please refer to the User’s Guide for information on how to review users’ backup activities.
To review CDP backup reports instead of selecting the backup time, select
“(CDP)”, as CDP backup jobs are constantly active the job status prior to the daily cut off at 12:00 AM is “Backup not yet finished”
Ahsay Systems Corporation Limited 105
Ahsay Offsite Backup Server
Administrator’s Guide
11.9 Reviewing User Storage Statistics
You can click the [Statistics] link available at the extended [Manage menu to invoke the [Statistics] panel. You can use this panel to storage statistics. This panel is the same as the [Statistics] pa would see when t
User]
review users’ nel that users hey click the [Statistics] link after they have logged on to the system. Please refer to the User’s Guide for information on how to review user’ storage statistics.
User statistic job. If the “U s are calculated on a daily basis by the “Usage Report” system sage Report” is disabled or if your AhsayOBS service is offline when the “Usage Report” system job is due to run, no user st calculated for those days. AhsayOBS cannot calculate user sta atistics will be tistics for past days which have been missed.
11.10 User Log
You can click the [Statistics] link available at the extended [Manage User] menu to invoke the [User Log] panel. You can use this panel to review the user specific activities on the AhsayOBS server.
A copy of user related activities can also be seen in the AhsayOBS system log, under [Manage System] -> [Manage Log] -> [System Log].
Ahsay Systems Corporation Limited 106
Ahsay Offsite Backup Server
Administrator’s Guide
12
Group Policy Management
This chapter describes how you can use the [Manager Group Policy] menu to ma nage yo ur user group s on AhsayOBS.
Term Descriptions
Policy Control Areas that are affected by group policy
User Group
A group of preset policy control objects
A group o f users.
12.1 About Group Policy
The Group Policy feature is designed to simplify administration and to reduce the effort required for managing backup users, e.g. security settings and backup set settings. It allows backup server administrator a grea flexibility in tailoring features and services to target spec ter degree of ific customer segments.
User Groups
When Group Policy is implemented on AhsayOBS, the backup use own set of policy groups which govern behaviour of the backu r accounts will be conslidated into common user groups. Each user group will ha ve its p clients. The types of features that can be configured from a policy group are restrictin g or er interface or hiding certain functions or features on AhsayOBM/AhsayACB us the AhsayOBS web console.
For example, a backup service prov service p ider wishes to offer customers a cut rate lan, i.e. “OBM Basic Plan”, which consists of fixed quota limit and where customer cannot change backupset settings. The servic create a user group on AhsayOBS called “OBM Basic Plan”. To features for each group, a policy group will need to be create e provider will customize the d called “OBM
Basic Plan Policy”, which will contain a group share quota setting and a Policy
Control Setting for AhsayOBM to disable access to some AhsayOBM controls.
[OBM Basic Plan Policy] [OBM Basic Plan]
Once the policy group “OBM Basic Plan Policy“ is assigned to user group “OBM
Basic Plan “, it will be effective immediately. Any AhsayOBM users that are assigned to the “OBM Basic Plan” group will be governed by the “OBM Basic
Plan Policy” settings.
Ahsay Systems Corporation Limited 107
Ahsay Offsite Backup Server
Administrator’s Guide
Policy Controls
The policy controls which can be customized for each user group are:
1. Shared Quota Settings
A maximum quota or “Shared Size” ca automatically be alloca percentage of shared size n be specified for each user group via a policy group setting, each backup user assigned to the user group will ted a portion of this quota, according to the “Maximum for each user” value.
2. Backupset Configu ration
Define a default backupset for AhsayOBM/AhsayACB us ers who belong to the group.
Define an who belon enforcement backupset for AhsayOBM/AhsayACB users g to the group. When an Enforcement backupset is configured for a backupset type, it will over overwrite all settings on any pre-exisiting backupset types.
3. Policy Control Setting
The Policy Control Setting allows the backup server administra customize the user interface for AhsayOBM/AhsayACB and Ah web console interface according to each user group. tor to sayOBS user
4. Global Filter Setting
This setting defines a global file filter for AhsayOBM and AhsayACB backupsets which belong to the user group. The backupsets which can be configured with global filtering on AhsayOBM are restricted to F
Domino, and Lotus Notes backupsets. When a global filter i group, any the pre-e filter. ile, CDP, Lotus s applied to a user xisting backupset filters will be overwritten by the global
5. Exclude File Size Over Setting
This setting defines the file size restriction for each individual file in a backup.
When it is applied to a user group, any file size over the threshold will be excluded during backup.
108 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
6. Exclude Network Shares
This setting defines the network share restriction for each backup. When it is applied to a user group, all network shares will be excluded during backup.
12.2 Best Practices for using Group Policy
In order to avoid any confusion and for better Ahs administration, it is recommended as possible: ayOBS server to keep the group policy design as simple
1. One-to-One relationship betw een policy and user group. Each policy group should only be applied to one user group.
2. One-to-One relationship between user account and user gro should only belong to one us er group. up. Each user
3. Active user accounts should not be transferred betwe en user groups.
4. New user groups and policies should be thoroug hly tested before they are implemented on a production server.
5. A separate policy should be created for each type of policy type .
E.g. A policy name “AhsayOBS – Read-only Main Menu” fo r policies that restrict the users to have Read-Only access on main menu.
E.g. a user group named “AhsayOBS – System User Rea d-Only Main
Menu” for a user group with “AhsayOBS – Read-only Main Menu” policy assigned.
6. The naming conven tions for user groups and policies should be meaningful and easily distinguishable. Example: For a new user grou
Premium” group which has some restrictions to the AhsayAC control and features. The associated policy group wo
“ACB_Premium_UI”. p called “ACB
B UI interface uld be called
7. Once a user group is operational, i.e. user accounts have been assigned and backups are running according to the policy settings, there should be no further policy changes.
8. For user groups defined with shared quota policy, please make sure the sum of the individual user backup quota does not exceed the shared size.
For example, a group with a shared quota policy defined as, shared size of
500GB and maximum percentage of shared size for each user of 25%
Ahsay Systems Corporation Limited 109
Ahsay Offsite Backup Server
Administrator’s Guide
(125GB). Should only h ave a maximum of four backup users assigned to it (125GB x 4 users = 500GB).
9. Extreme caution must be excerised when assigning policies to
As a policy will be effective and
user groups. enforced as soon as it is assigned to a group, any errors in policy assignments could result in unfor seen problems for all members of the affected user group.
10.
Any backup user accounts which are using v5.5 AhsayOBM/AhsayACB clients on AhsayOBS v6 should not belong to any user groups. As they are not compatible with group policy features.
12.3 Group Policy Limitations and Restrictions
1. Each user group is restricted to only one shared quota policy .
2. Each user group is restricted to only one set of Default and Enforcement backupsets for each backupset type.
3. Each backup user account is permitted to have one Default Backup Set and one Enforcement Backup Set for each available Backup Set Type.
4. Only one Global Filter is allowed for each backupset type.
5. A backup user cannot be a member of more than one user group with shared quota policy enabled.
6. Only AhsayOBM and AhsayACB v6 or above clients support group policy.
Ahsay Systems Corporation Limited 110
Ahsay Offsite Backup Server
Administrator’s Guide
12.3.1 List Policy Control
There are three main categories for policy control objec
AhsayOBM, and ts AhsayOBS,
AhsayACB. Each control object allows the backup server administrator to configure the controls or features which can be accessible or visible to the end user.
All policy control objects can be found in the [Manage Group Policy] ->
[Policy Control] Page.
AhsayOBS
A group of policy control objects used to control the behaviour of AhsayOBS.
The control area defined on AhsayOBS policy control group is in the format of:
[Menu Name] – [Page Name] – [Section Name] – [Section Detail] (if any)
E.g. The name of the policy to control the System Settings section on Server
Configuration page under the [Manage System] menu is:
“Manage System – Server Configuration – System Settings”
Ahsay Systems Corporation Limited 111
Ahsay Offsite Backup Server
Administrator’s Guide
AhsayOBM
A group of policy control objects used to control the behaviour of
The control area defined on Ahsay
AhsayOBM.
OBM policy control group is in the format of:
[Section Name] – [Section Details] (if any)
E.g. To restrict access to the Recycle Bin under Quota Usage section on the
Main Frame, you should edit the settings in this policy:
“Quota Usage – Recycle Bin”
AhsayACB
A group of policy control objects used to control the behaviour of AhsayACB.
The control area defined on AhsayACB policy control group is in the format of:
[Section Name] – [Section Details] (if any)
E.g. To restrict access to the Recycle Bin under Quota Usage section on the
Main Frame, you should edit the settings in this policy:
“Quota Usage – Recycle Bin”
112 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
12.4 User Group
12.4.1 List User
When you click the [Manage Group Policy] -> [List User] Link available at the top menu, the [List User] panel will appear. An overview of user groups and owner on backup can be listed by default backup users are only shown.
The system user list can also be listed by selecting the “System user” radio button near the top menu.
Press the [Login Name] link to show the details of policy groups, user groups and owner on selected backup user. The system user detail can also be viewed by similar way.
113 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
12.4.2 Manage User Group
[User Group] panel is used to manage the user group’s for both backup users and system users. Please click the [Manage Group Policy] -> [User Group] link to enter the [User Group] panel.
The default view shows th e available user groups for “backup user”. The user group list for “system user” can also be listed by selecting the “System user” radio button near the top menu.
The user group feature can be used obtain information on how many users accounts have been assign to a user group.
Ahsay Systems Corporation Limited 114
Ahsay Offsite Backup Server
Administrator’s Guide
You can use the combo box to list the number of existing user
After selectin groups defined. g the desired user group all user accounts assigned to this group will be displayed.
Ahsay Systems Corporation Limited 115
Create user group
Ahsay Offsite Backup Server
Administrator’s Guide
Please follow the instructions below to create a user group:
1. Go to the [User Group] panel.
2. Select the user group type, i.e. Backup us er or System user.
3. Press the [Add] button.
4. Change the default name to a more descriptive user group name.
5. Press the [Updated] button to complete the process.
Ahsay Systems Corporation Limited 116
Remove an existing user group
Ahsay Offsite Backup Server
Administrator’s Guide
To remove a user group, please do the followings:
1. Go to the [User Group] panel.
2. Sele ct the user group from the drop down list.
3. Press the [Remove] button to remove the user group.
WARNING:
The remove user group feature will remove the selecte d user group from AhsayOBS even if: i. ii.
There are active user accounts assigned to th
There are active policies assig e group ned to the group
All member user accounts upon removal of the user group will be automatically unassigned. Once unassigned, the user accounts will retain the policy restrictions of the removed user group.
It is strongly recommended prior to removing a user group, to ensure
that all member user accounts are re-assigned first.
Ahsay Systems Corporation Limited 117
Assign Users to a user group
Ahsay Offsite Backup Server
Administrator’s Guide
Please follow the instructions below to assign users to a specific user group:
1. Go to the [User Group] panel.
2. Select a user group from the dropdown box.
3. Cli ck the [Assign users] link located in the [Users] section to go to the user list. This option is only shown when the list is empty.
4. If the list is not empty, please click on the [Edit] link in the [User] section.
5. Select users from the user list by checking the checkboxes and vice versa.
6. Press the [Update] button to add selected backup users to backup user group.
Ahsay Systems Corporation Limited 118
Ahsay Offsite Backup Server
Administrator’s Guide
Remove Users from a user group
To remove users from a user group, please do the followings:
1. Go to the [User Group] panel.
2. Select a user group from the dropdown box.
3. Press the press th section.
link next to the backup user you would like to remove or e [Edit] link located in the [Users] section to enter the user list
Note:
You can use the alphabet categories at the top of the backup user list to limit the list to show only those backup users whose login name starting with a certain alphabet. You can also user the [Owner] link to limit the listing to show backup users belong to the selected owner.
Ahsay Systems Corporation Limited 119
Ahsay Offsite Backup Server
Administrator’s Guide
12.5 Policy Group
12.5.1 Manage Policy Group
When you click the [Manage Grou p Policy] -> [Policy Group] link available at the top menu, the [Policy Group] form will appear. This is used to define policies for backup users or system users.
The default view shows the available Policy Groups for “backup user”. The
Policy Groups list for “system user” can also be listed by selecting the
“System user” radio button near the top menu.
Ahsay Systems Corporation Limited 120
Ahsay Offsite Backup Server
Administrator’s Guide
Create a policy group
To create a new policy group, please do the followings:
1. Go to the [Policy Group] form.
2. Select the backup user type, i.e. Backup user o r system user
3. Change the name to a more descriptive policy group name.
4. Press the [Update] button to save th e changes.
Remove an existing policy g roup
Please do the followings to remove a policy group:
1. Go to the [Policy Group] form.
2. Sele ct the policy group from the drop down list.
3. Press the [Re move] button to remo ve the policy.
Below is a table s policy group. howing the available policy typ es that can be assigned to a
Policy Group Type
Backup User
Available Policy Types
- Shared Quota Policy Co
- Backup Set Setti ntrol ng Policy Control
- Backup User Policy Control
- Global Filter Policy Control
- Exclude File Size Over Policy Control
- Exclude Network Share Policy Control
System User - Share Backup Users Policy Control
- System User Policy Control
Ahsay Systems Corporation Limited 121
Ahsay Offsite Backup Server
Administrator’s Guide
12.5.2 Shared Quota Policy
Shared Quota Policy is available for Backup User Policy Group o to define a maximum storage limit for a p nly. It is used articular group, which is evenly allocated to each individual backup user within the group. Each ba ckup user is allocated a fixed percentage of the total storage limit.
The advantage of using a share quota policy is it will simplify user home storage management. For example, if users for a group where assigned an individual user home drive, this setting will ensure the backup users cannot user more disk space than is physically available on the drive.
Assign Shared Quota Policy to a policy group
1. Go to the [Policy Group] form.
2. Select a Backup User Policy Group from the drop down list.
3. Click the [ Show Options] link at the right side of the [Shared Quota
Setting] section. The information of shared quota policy will be shown.
4. Check the ch eckbox next to the [Disk quota share].
5. Fill in the [Shared Siz e] and [Maximum percentage of shared size for each user] field.
6. Press [Update] button to save the changes.
Reset Disk quota share
1. Go to the [Policy Group] form.
2. Select a Backup User Policy Group from the drop down list.
3. Click the [Show Options] link at the right side of the [ Shared Quota
Setting] section. The information of shared quota policy wi ll be shown.
4. Uncheck the checkbox next to the [Disk quota share] to reset it to default.
5. Press [Update] button to update the changes.
When implementing a shared quota policy, you need to take into account any additional users assigned to the group will result in the reduction of backup quota for existing users and therefore impact on the backups operation of
122 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide these users. So the “shared siz e” will have to be adjusted in order to ensure sufficient space for the additional users.
For example, if “Group VIP” was assigned a shared size of 1 maximum percentage of 20% for each user in the grou
00GB, with a p. Initially 5 e backup quota for each lly utilize their
AhsayOBM users are assigned to Group VIP, th individual user will be 20GB. For this setup each user can fu individual backup quotas without affecting others in the group.
But if another 5 users were assigned to Group VIP, they too wi
20GB each of backup quota. This will mean if all users ful ll be allocated ly utilize their backup quota’s (10 users X 20GB = 200GB), it will e xceed the shared size of
100GB. In this scenario, the first 5 backup users to who fully utilize their backup quotas, will cause the other 5 users backup jobs to fail with a “Group
Quota Exceeded. Please contact us to increase your quota.” error.
Ahsay Systems Corporation Limited 123
Ahsay Offsite Backup Server
Administrator’s Guide
12.5.3 Backup Set Setting Policy
Backup Set Setting Policy is available for Backup User Policy Gr used to pre-define the backup settings for backup users. This h oup only. It is elps to pre-fill backup settings when backup users cr
Backup Set”) w eates a new backup set (called “Default hereas other helps to enforce backup setting to backup users.
This is known as an “Enforcement Backu p Set”.
Default Backup Set
Note:
User cannot assign a higher level default backup set to a lower level policy group, i.e. If a user (User1) is created by a sub-admin role system user, and there is a default backup set policy (Policy 1) created by a admin role system user. “Policy 1” cannot be assigned to
User1.
Ahsay Systems Corporation Limited 124
Enforcement Backup Set
Ahsay Offsite Backup Server
Administrator’s Guide
Create a Pre-defined Backup Setting Policy
1. Go to the [Policy Group] form.
2. Select a Backup User Policy Group from the drop down list.
3. Click the [Show Options] link at the right side of [Backu section to show the information of [Default Back
[Enforcement Backup Set] sub-sections. p Set Setting] up Set] and
4. If you are going to create a “Default Backup Set”, click the [Edit] link next to [AhsayOBM Users] or [AhsayAC B Users] in the [Default Backup
Set] sub-section to show the default backup set form. Otherwise, click the [Edit] link next to the [AhsayOBM Users] or [AhsayACB
[Enforcement Backup set form.
Users] in the
Set] sub-section to show the enforcement backup
5. Click the [Add] button to create a new backup set.
6. Fill in the necessary field(s) in the backup set form and click the [Update] button to save the changes.
Ahsay Systems Corporation Limited 125
Ahsay Offsite Backup Server
Administrator’s Guide
Remove a Pre-defined Backup Setting Policy
1. Go to the [Policy Group] form.
2. Click the [Show Options] link at the right side of [Backu p Set Setting] section to show the information of [Default Backup Set] and
[Enforcement Backup Set] sub-section s.
3. To delete a “Default Backup Set” setting, cl ick the [Edit] link next to
[AhsayOBM Users] or [AhsayACB Users] in the [Default Backup Set] sub-section. Otherwise, click the [Edit] link next to [AhsayOBM Users] or
[AhsayACB Users] in the [Enforcement Backup Set] sub-section.
4. Select the backup set from the drop down list.
5. Click the [Remove] button to remove it from the system.
126 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Assign a Pre-defined Backup Set to a Default Backup Setting policy
1. Go to the [Policy Group] form.
2. Click the [Show Options] link at the right side of [Backup Set Setting] section to show the information of [De
[Enforcement Backup Set] sub-sections. fault Backup Set] and
3. Select the pre-defined backup set from drop down.
4.
Click the [Update] button to save the changes.
12.5.4 Backup User Policy Control
Backup User Policy Control is available to Backup User Policy Group only. It is used to restrict the backup users’ access privileges on AhsayOBS, AhsayOBM and AhsayACB. By default, full access privilege is granted. A summary of access permission is listed below:
Permission Meanings
R Read
W Write
E Execute
D Delete
Ahsay Systems Corporation Limited 127
Ahsay Offsite Backup Server
Administrator’s Guide
Edit Policy Control
1. Go to the [Policy Control] form.
2. Click the [Show Options] link at the right side of [Policy Control Setting] section to show the permission information on [AhsayOBS and [AhsayACB] sub-sections.
], [AhsayOBM]
3. Click the [Edit] link next to the [Group] drop down list policy control selection.
to go to the
4. Select the Policy Control that you would like to edit by checkbox on the left side of the Policy Control ID, and the
RWXD checkboxes will be enabled.
checking the corresponding
5.
To as sign ac cess permission to a Policy Control, select/de-select the checkbox under the RWXD section.
Policy Type Permission
Read-only R
Editable RW
Editable and
Executable
RWE
Modifiable RWD
Full RWED
Hidden All checkboxes are unchecked
6. Click the [Update] button to save the changes.
Ahsay Systems Corporation Limited 128
Remove Policy Control
Ahsay Offsite Backup Server
Administrator’s Guide
1. Go to the [Policy Control] form.
2. Click the [Show Options] link at the right side of [Policy Control Setting] section to show the permission informatio and [AhsayACB] sub-sections. n on [AhsayOBS], [AhsayOBM]
3. Press the link next to the policy control that you would like to remove.
4. The Policy Control is now removed from the system.
Ahsay Systems Corporation Limited 129
Ahsay Offsite Backup Server
Administrator’s Guide
12.5.5 Global Filter Policy
Global Filter Policy is applied to sy stem users only. It is used to set predefined backup filter to backup users.
Create global filter policy
1. Go to the [Policy Control] form.
2. Click on the [Show Options] link in the [Global Filter] section.
3. Click the [Edit] link next to [AhsayO
Users] or [AhsayACB Users].
BM Users], [CDP Filter for OBM
4. Click the [Add] button to create a new policy.
5. Select the [Operating System] and [Type], then press the [Update] button.
6. Fill in the required information shown in the page.
7. Press the [Update] button to save the changes.
130 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Delete global filter policy
1. Go to the [Policy Group] panel.
2. Click the [Edit] link next to [AhsayOBM Users], [CDP Filter for OBM
Users] or [AhsayACB Users].
3. Select the policy from the drop down box.
4. Press [Remove] button to re move it from the system.
12.5.6 Exclude File Size Over Policy
Exclude File Size Over Policy is available for Backup User Policy Group only. It is used to define a file size restriction during backup for a particular group, which is allocated to each individual backup user within the group. Files in all backup sets under the backup user will be restricted.
Assign Exclude File Size Over Policy to a policy group
5. Go to the [Policy Control] form.
6. Select a Backup User Policy Group form the drop down list.
7. Check the checkbox next to the [Exclude File Size Over].
8. Fill in the [Exclude File Size Over] field.
9. Press [Update] button to save the changes.
Reset Exclude File Size Over Policy
10. Go to the [Policy Group] form.
11. Select a Backup User Policy Group from the drop down list.
12. Uncheck the checkbox next to the [Exclude File Size Over] to reset it to default.
13. Press [Update] button to update the changes.
131 Ahsay Systems Corporation Limited
12.5.7 Exclude Network Share Policy
Ahsay Offsite Backup Server
Administrator’s Guide
Exclude Network Share Policy is available for Backup User Polic
It is used to define network shares restriction during backup y Group only.
for a particular group, which is allocated to each individual backup user within the group.
Network shares in all backup sets under the backup user will be restricted. p
14. Go to the [Policy Group] form.
15. Select a Backup User Policy Group from the drop down list.
16. Check the checkbox ne xt to the [Exclude Network Share].
17. Press [Update] button to save the changes.
Reset Exclude Network Share Policy
18. Go to the [Policy Group] form.
19. Select a Backup User Policy Group from the drop down list.
20. Uncheck the checkbox next to the [Exclude Network Share] to reset it to default.
21. Press [Update] button to update the changes.
12.5.8 Shared Backup User Policy
Shared Backup User Policy is only available to System Users Policy Group. It helps Sub Admin role system users to share their backup users provided they are under the same creator.
Ahsay Systems Corporation Limited 132
Ahsay Offsite Backup Server
Administrator’s Guide
Edit Shared Backup User Policy
1. Go to the [Policy Group] panel.
2. Select the system user radio button for the user type.
3. Click the [Show Options] link in the [Shared Backup Users Setting] section to show the information of shared backup user policy.
4. Check the [Backup User Share] checkbox to share the backup users, uncheck it to reset to default.
5. Press the [Update] button to update the change.
Ahsay Systems Corporation Limited 133
12.5.9 System Users Policy Control
Ahsay Offsite Backup Server
Administrator’s Guide
The System User Policy Control is available to System User Policy
It is use
Group only. d to restrict the system users’ access privileges on AhsayOBS. By default, full access privilege is granted. A summary of access permission is listed belo w:
Permission Meanings
R Read
W Write
E Execute
D Delete
Edit Policy Control
1. Go to the [Policy Control] form.
2. Select [System User] radio button.
3. Click the [Show Options] link at the right side of [Policy Contr section to show the permission information on [AhsayOBS] ol Setting]
sub-sections.
4.
Click the [Edit] link next to the [Group] drop down list to go to the policy control selection.
5.
Select t check
RWX bo he x
D che
Policy Con on the left s ckbo trol that you would like to edit by checking the ide of the Policy Control ID, and the corresponding xes will be enabled.
6.
To ass check ign access permission to a Policy Control, select/de-select the box under the RWXD section.
Policy Type Permission
Read-only R
Editable RW
Editable and
Executable
RWE
Modifiable RWD
Full RWED
Hidden All checkboxes are unchecked
7. Click the [Update] button to save the changes.
Ahsay Systems Corporation Limited 134
Ahsay Offsite Backup Server
Administrator’s Guide
Remove Policy Control
1. Go to the [Policy Control] form.
2. Select the [System User] radio button.
3. Click the [Show Options] link at the right side of [Policy Co section to show the permission information on [AhsayOBS] ntrol Setting]
sub-sections.
4. Press the link next to the policy control that you would like to remove.
5. The Policy Control is now removed from the system.
Ahsay Systems Corporation Limited 135
13
Delta Merge Technology
Ahsay Offsite Backup Server
Administrator’s Guide
13.1 Introduction
The delta merge feature combines the full, differential, and inc files on AhsayOBS into a single full file. The advantage of usin remental delta g delta merge is it will speed up the restore of files. As a single (merged) file full can be restored faster than a file consisting of full plus related incremental files, which will require a lengthy merging process after restorin g to a client machine.
Delta merge applies to full, differential, and incremental de
area only
lta files which reside in the data . The criteria for file merging is governed by the retention policy setting for the backupset, delta merge will not work if there is more than one encryption key in use for a backup set. It is
AhsayOBM/AhsayACB v6.3 or above clients, there is for Local Copy backups.
supported by no delta merging feature
The delta merge of differential delta with the full file, will only apply if there are incremental delta files present in the delta chain.
1 3.2 Delta Merge Policy
The delta merge process relies on the retention policy setting to decide when to merge delta files with the full file. But delta merge does not ap ply to files in the retention area. Any backup sets configured with advan ced or customized retention policy settings cannot use the delta merg e feature.
Any reference to retention policy in the context of delta merge implies delta merge policy. As backupsets enabled with delta merge share a single setting, any changes in retention policy will impact on the availability of that can be restored from both data and retention area. Befor snapshots e enabling the delta merge feature please review your data restore requirem ents carefully.
1 3.3 Delta Merge Proces s
A delta merge will take place after a backup job is comple
AhsayOBM/AhsayACB will only initiate a delta merge request a ted, t the end of a backup job. As part of the request, AhsayOBM/AhsayACB will upload a copy of the backupset encryption key to AhsayOBS which is hashed for security purposes. Once a merge request is received by AhsayOBS it will be placed in the “delta merge queue”, the information in the delta merge queue only exists in memory for security purposes.
A background job will scan all the files in the backup set. If the file is an incompleted file, the file wil be skipped and the file will not be merged.
AhsayOBS will not change or delete the file. The file will not be marked as bad. The process will also identify any delta files that are out of retention
Ahsay Systems Corporation Limited 136
Ahsay Offsite Backup Server
Administrator’s Guide period and me rge them with the full file, this process handles one merge operation at a time.
When AhsayOBS processes a file merge request, the merge p carried according to the retention policy. Each delta merg rocess will be e operation is recorded in t he AhsayOBS system logs. The following is an example of delta merge activity which is recorded under [Manage System] -> [Manage Log] -
> [System Log].
Although, delta merge requests are submitted to AhsayOBS immediately after the completion of a backup job. In some situat ions it could take a few days before a merge request is finally processed. The actual execution o f the merge requests is dependent factors such as: i. ii.
The number of backupsets with delta merge enabled.
The number of requests pending in the merge queue. iii. The type and size merged, i.e. ESXi,
of full and delta files which are pending to be
Hyper-V, Shadow Protect backupsets which may take longer to merge. iv. Performance of your AhsayOBS server
13.4 Delta Merge Queue
The delta merge que
AhsayOBM/Ahsa ue stores the details of each merge request made by yACB client at the end of each backup job. In order to enhance security, from AhsayOBS v6.5.4.0 onwards, the delta m erge queue will be held in memory only.
Each delta merge queue record includes the following informatio n: i. ii. iii.
backup user a ba ccount ckup set ID hashed encryption key iv. owner (the sub admin account which created the b applicable) ackup user if
Once a job in the delta merge queue is completed, the request will be immediately removed from the merge queue. AhsayOBS will then process the next request in the queue.
WARNING:
As the delta merge queue is only held in memory, if the AhsayOBS service is restarted or stopped, any pending delta merge requests will be lost. These delta merge jobs for the affected backup sets will
Ahsay Systems Corporation Limited 137
Ahsay Offsite Backup Server
Administrator’s Guide
only be processed on the next bac kup job, when
AhsayOBM/AhsayACB submits a new delta merge request.
1 3.5 Limitations
Differential Delta File Merge
The delta merge of differential delta files with the full file, will only apply if there are incremental delta files delta merge will take place for b file delta set to “Differential”.
present in the delta chain. Therefore, no ackup sets with delta merge enabled and in-
Advanced or Customized Retention Policy
Any backup sets which are configured with advanced o retention policy settings cannot use the delta merge feature. r customized
This restriction is enforced on AhsayOBM, if delta merge is enabled on a backup set with advanced retention policy already configured or if you attempt to apply an advanced retention policy setting to a backup set with delta merge enabled. The following error messages will be displayed by
AhsayOBM:
AhsayACB
For AhsayACB user accounts the in-file delta and delta merge features are still dependent on AhsayOBS global settings, under [Manag
[Other Options] -> [In-file delta settings for all AhsayACB user all AhsayACB users are limited to either using delta merge increme ntal/differential delta model. e System] -> s]. Therefore,
or traditional
When the delta merge option is enabled and the in-fi le delta type
“Differential” is selected. The Delta merge feature will not merge
differential delta files with the full file.
Delta merge will only work if there are pre-exisitng incremental delta files in the delta chain. Once the incremental delta files are merged, the delta merge feature will no longer merge the remaining differential delta files with the full file.
It is recommended to set the in-file delta type as “Incremental” for
AhsayACB users.
138 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
AhsayOBS Storage
Even though the delta merge job processes one backupset at a delta merge enabled backupsets which contain very large
time. For files, i.e. indows 2008 Exchange, MS SQL, Domino, Oracle , MS System backup, W
SystemState, ShadowProtect, ESXi, and Hyper-V. It
recommended user home drives containing these should maintain at least 30% to 40% free disk space. As the d merge needs to generate a temporary merged full file home driv is strongly backup sets elta
on the user e during this process. If the user home runs out of disk space, it could result in corruption temporary merged file, in the worse case the data of any other active backup sets could also be
compromised.
Ahsay Systems Corporation Limited 139
13.6 Delta Merge Examples
Ahsay Offsite Backup Server
Administrator’s Guide
The following is som the delta e simple examples to demonstrate the functionality of
merge feature:
Example 1:
The example below shows how delta files are merged into full file using a retention policy (delta merge policy) setting defined as 4 jobs f set. or this backup
A full backup file is stored into data area (F) uploaded by Job 1 incremental delta files I
1
, I
2
, I
3
, and I
4
, followed by
. On the completion Jo b 5 (I
4
),
AhsayOBM/AhsayACB will trigger a delta merge background job to execute the file merging. When the AhsayO merged snapsh
BS delta merge job runs F + I
1
will be
to become a “merged” full file. The data area now contains 4 ots including merged full file after file merging.
ion Policy = 4 Jobs (Delta Merge Policy)
Retent
Job 1 = F
Job 2 = I
Job
Job 4 = I
2
Job 5 = I
4
After
3 = I
1
3
(delta merge initiated) files.
job 5 AhsayOBM/AhsayACB will initiate a delta merge for Job 1 & Job 2
F (F + I
1
) merged full file
I
I
2
3
I
4
Ahsay Systems Corporation Limited 140
Ahsay Offsite Backup Server
Administrator’s Guide
Example 2:
The example below shows how delta files are merged into full file using a retention policy (delta merge policy) setting defined as 7 days for this backup set.
A full backup file is stored into data area (F) uploaded on Day incremental delta files I
1 backup job on Day 9 (I
, I
8
2
, I
3
, I
4
, I
5,
), AhsayOBM/AhsayACB will t
will be merged to bec
I
6,
I
7, and I
8,
. On the com
1, followed by pletion of the rigger a delta merge background job to execute the file merging. When the AhsayOBS delta merge job runs F + I
1 now co ome a “merged” full file. The data area ntains 8 snapshots including merged full file after file merging.
Retention Poli
cy = 7 Days (Delta Merge Policy):
Day 1 =
Day 2 =
Day 3 =
F
I
1
I
2
Day 4 = I
3
Day 5 = I
Day 6 = I
4
5
Day 7 = I
Day 8 = I
6
7
Day 9 = I
8
(delta m erge initiated)
I
I
I
I
4
5
6
7
I
8
After job on day 9 AhsayOBM/AhsayACB will initiate a delta merge for Day 1
& Day 2 files. As the incremental file I
1 policy setting.
F (F + I
1
I
2
I
3
) merged full file
has exceeded the 7 day retention
Ahsay Systems Corporation Limited 141
Ahsay Offsite Backup Server
Administrator’s Guide
Example 3:
The example below shows how differential and incremental delta files are merged into full file using a retention policy (delta merge policy) setting defined as 4 jobs for this backup set.
A full backup file is stored into data increm
Retention Poli
Job 1 = F
Job 2 = I
1 area (F) uploaded by Job 1, followed by ental and differential delta files I
1
, I
2
I
3
and D
cy = 4 Jobs (Delta Merge Policy)
1
.
Job 3 = I
2
Job 4 = I
3
Job 5 = D
1
(delta merge initiated)
After Job 5 AhsayOBM/AhsayACB will initiate a delta merge for
Unfortu nately, diferential delta D
1
Job 1 & Job 2.
is found in delta chain, this creates delta merge sto ppage, the files in Job 1 and Job 2 will not be merged.
The ba ckup job continues with subsequent incremental backups (I
4,
I
5 and I
6
).
Job 1 = F
Job 2 = I
1
Job 3 = I
2
Job 4 = I
3
Job 5 = D
1
(delta merge is initiated and stopped)
Job 6 = I
4
(delta merge is initiated and stopped)
Job 7 = I
5
(delta merge is initiated and stopped)
Job 8 = I
6
(delta merge is initiated)
After Job 8 AhsayOBM/AhsayACB will initiate a delta merge, A merg hsayOBS will e the full file (F) uploaded in Job 1 with the differential delta D upload ed in Job 5 to form the new full file (As the D
1 changes in I
1
+ I
2
+ I
3
). The incremental files I
1
+ I
2
+ I
3
1
differential includes will be moved to the retention area, as they have already exceeded the retention policy of 4 jobs.
These files will be purged on the next retention policy job.
After the delta merge has completed the follow files will be available for restore.
F (F + D
1
)
I
4
I
5
I
6
142 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Example 4:
The example below shows how delta merge handles multiple differential delta files using a retention policy (delta merge policy) setting defined as 4 jobs for this backup set.
A full backup file is stored into data increm
Retention Poli
Job 1 = F area (F) uploaded by Job 1, followed by ental and differential delta files I
1
, I
2
I
3
and D
cy = 4 Jobs (Delta Merge Policy)
1
.
Job 2 = I
1
Job 3 = I
2
Job 4 = I
3
Job 5 = D
1
(delta merge initiated)
After Job 5 AhsayOBM/AhsayACB will initiate a delta merge for
Unfortun ately, diferential delta D merge sto
1 fou
Job 1 & Job 2.
is nd in delta chain, this creates delta ppage, the files in Job 1 and Job 2 will not be merged.
The ba ckup job continues with subsequent differential delta backups (D
D
3
) and incremental delta backups (I
4,
I
5, and I
6
).
2 and
Job 1 = F
Job 2 = I
1
Job 3 = I
2
Job 4 = I
3
Job 5 = D
1
(delta merge is initiated and stopped)
Job 6 = D
2
(delta merge is initiated and stopped)
Job 7 = D
3
(delta merge is initiated and stopped)
Job 8 = I
4
(delta merge is initiated and stopped)
Job 9 = I
5
(delta merge is initiated and stopped)
Job 10 = I (delta merge is initiated)
After merge
Job 10 AhsayOBM/AhsayACB will initiate a delta merge, AhsayOBS will upload changes in I to the
the full file (F) uploaded in Job 1 with the latest differential delta D ed in Job 7 to form the new full file (As the D
3
1
D
3
differential includes
+ I
2
+ I
3 +
D
1
+ D
2
). The files I
1
+ I
2
+ I
3 + 1
+ D
2 will be moved retention area, as they have already exceeded the retention policy of 4 jobs. These files will be purged on the next retention policy job.
After the delta merge has completed the follow files will be available for restore.
F (F + D
3
)
I
4
I
5
I
6
143 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Example 5:
The example below shows how delta merge handles multiple differential delta files with different compression type.
A full backup file is stored into data ar ea (F) uploaded by Job 1, followed by incremental and differentia
t
l delta files I
1
, and I
2
.
(Delta Merge Policy)
Job 1 = F (Fast Compression)
Job 2 = I
1
(Normal Compression)
Job 3 = I
2
(No Compression)
Job 4 = I
3
(Fast Compression, delta merge initiated)
After Job 4 the backup application will initiate a delta merge for Job 1 & Job 2.
When F m erged with I
1
, the new merged file F+ I
1 will be using Normal
Compression,
On the next backup, a n ew delta file is uploaded and delta merge initiated for
Job 2 & Job 3.
Job 2 =
(F + I
1
)
(Normal Compression)
Job 3 = I (No Compression)
Job 4 = I
3
(Fast Compression)
Job 5 = I
4
(Normal Compression, delta merge initiated)
The new merged file F+ I
1
+ I
2 will not use any compression. In conclusion, the compression type will be updated to the last incremental file in the merge list.
Ahsay Systems Corporation Limited 144
Ahsay Offsite Backup Server
Administrator’s Guide
14
Account Lockout
When the account lockout feature is enabled, a backup user a locked after three consecutive failed login attempts. The ac ccount will be count lockout restriction applies unsucessful logins via AhsayOBS web consol e, AhsayOBM,
AhsayACB, and AhsayRDR web console. The account lockout r not apply to “syste estrictions do m”, “sub admin”, and “non admin” account types. To
enhance security on AhsayOBS, the account lockout feature is enabled by default
.
14.1 Configuration
The status of the account lockout feature is shown in the AhsayOBS web console under the [Manage System] -> [Server Configuration] -> [Auto Lock
User].
To disable the AhsayOBS account lockout feature, simply uncheck the “Auto
Lock User” setting and press the [Update] button. This setting will be effective immediately.
Even though the account lockout feature is disabled, any backup user accounts which were locked prior to the disabling of this feature will still remain locked. These backup user accounts will have to be enabled by either a “system” or “sub admin” user.
145 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Note:
For AhsayRDR implementations, the accoun t lockout configuration must be aligned on all member AhsayOBS servers.
14.2 Account Lockout Rules
For each unsuccessfu l login attempt via AhsayOBS web console, AhsayRDR web console, AhsayOBM, or AhsayACB. The account lockout counter will increase by 1. After three consecutive unsuccessful login attemp user account w ill be locked. ts the backup
The account lockout counter will reset to zero if one of the following conditions are met:
User logs on successfully via AhsayOBS web console,
AhsayOBM/AhsayACB or AhsayRDR web console.
Change the user [Status] from “Locked” to “Enabled” or “Suspended” in
[Manage User] -> [User Profile] page.
The “system” or “sub admin” users cannot manually lock a account. An account lockout can only be triggered by con login attempts.
Once an account is locked, all AhayOBM/AhsayACB client sc
backup user secutive failed
CDP service(s) connecting to AhsayOBS using the locked automatically be stopped, they will not re-connect to AhsayO heduler(s) and
account will
BS again until after another six hours, even if the affected account is enabled immediately.
WARNING:
If there are any ba ckup jobs which are scheduled to start within this six hour period they will not be run, these jobs will be c lassified as a missed backups.
If you wish to minimize th e problem of missed backups, you can consider restarting the AhsayOBM/AhsayACB scheduler and CDP services on all affected client machines after affected user account is unlocked.
When a user account is locked after 3 unsuccessful login requests or if the account is suspended by the AhsayOBS administrator. All active backup job under the user account will be stopped
immeditately.
Ahsay Systems Corporation Limited 146
14.3 Unlocking Accounts
Ahsay Offsite Backup Server
Administrator’s Guide
Once a backup user account is locked it can only be enabled by either a
“system” or “sub admin” user.
To reset the status of a “Locked” backup user, please do the following:
1. Login to AhsayOBS Web Admin istration Console using a “system” or
“sub admin” user account.
2. Go to [Manag e Users] -> [List User] page.
3. Find the backup user from the user list and click on the username to view [User Profile].
4. Change the [Status] by checking the [Enable] radio button.
5. Click [Update] to apply the change.
Ahsay Systems Corporation Limited 147
Ahsay Offsite Backup Server
Administrator’s Guide
14.4 Account Lockout on AhsayOBS/AhsayRDR
The following is an example of what is displayed when there is an incorrect user login attempt via AhsayOBS web console.
After three consecutive incorrect login attempts the user account will be automatically locked.
Ahsay Systems Corporation Limited 148
Ahsay Offsite Backup Server
Administrator’s Guide
14.5 Account Lockout on AhsayOBM/AhsayACB
The following is an example of what is displaye d when there is an incorrect user login attempt via AhsayOBM or AhsayACB client.
After three consecutive incorrect login attempts the user account will be automatically locked. The following dialog box will be displayed on the client machine. error “[error] Account locked. Please contac
provider. Retry in 6 hours ...”
AhsayOBM/AhsayACB scheduler logs (debug.log) will show the following
t your backup service
debug.log
[2011/01/28 20:04:32][info] Loading configuration file ...
[2011/01/28 20:04:32][info] Loading configuration file ... Completed
[2011/01/28 20:04:32][info] Loading profile from server ...
[2011/01/28 20:04:33][error] Account locked. Please contact your backup service provider. Retry in 6 hours ...
149 Ahsay Systems Corporation Limited
14.6 Account Lockout Auditing
Ahsay Offsite Backup Server
Administrator’s Guide
Information relating to incorrect logins attempts will be record ed in the
AhsayOBS system log, as well as the AhsayOBS logs located in
%OBS_HOME%\logs.
The following is an example of what is recorded in the syst there is an inco
Login attempts via AhsayOBS web console are identified as “[www][Logon]
‘%user_account%’” em log, when rrect user login attempt via the AhsayOBS web console
The following is an example of what is recorded in the system log, when there is an incorrect user login attempts from an AhsayOBM/AhsayACB client.
Login attempts via AhsayOBM/AhsayACB are identified as “[system]
[getProfileRqt] ‘%user_account%’”
Ahsay Systems Corporation Limited 150
Ahsay Offsite Backup Server
Administrator’s Guide
15
Multiple Thread Support
Multiple thread support is available for the following AhsayO BM/AhsayACB functions; backup, restore, local copy, seed load, and file decrypt fo r all backup sets. In order to utilize this feature AhsayOBM and AhsayACB need to be on version v6.3.0.0 or above. In addition, the web restore applet also supports multiple thread file restores for AhsayOBS v6.3.0.0 or above.
Multiple thread support is enabled by default and cannot be disabled.The maximum number of threads supported is automatically determ number of logical CP U's on a client machine: ined by the
Maximum number of threads = Number of Logical CPU x
2 (up to a
maximum of 8 threads)
Multiple threading will result in increased memory and CPU usage on the
AhsayOBM/AhsayACB client machine, the level of resource usage will be proportion to the number of active threads. In order to fully leverage this feature, it is recommended a client machine should be installed with multiple core processors and sufficient free memory.
WARNING:
Multiple thread backup and restore operations can result in increase loading on your AhsayOBS server and could lead to AhsayOBS performance problems. It is strongly recommended a review of
AhsayOBS hardware and configuration requirements is undertaken, to
determine server suitability before mass deployment of v6 clients.
Ahsay Systems Corporation Limited 151
Ahsay Offsite Backup Server
Administrator’s Guide
16
Create a “Read Only” or Non Admin System User
To crea te a read only admin user or non admin user account, go to the
[Manage System] -> [Manage System User] page and click on “Add System
User” link.
Enter the login name for the new system user account, the password must be at least six characters long, and the role must be “Non Admin”.
To confirm the creation of the new user press the “Add” button. The account will be created and AhsayOBS will list the new and exisiting non admin accounts.
152 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
17
AutoUpdate
This chapter describes how you can use the AutoUpdate feature to automatically updat e AhsayOBM and AhsayACB on all running instances:
17.1 How it works
The AutoUpdate o peration relies on AutoUpdate Agent (AUA) to function properly. It is a service bundled with AhsayOBM/AhsayACB. No new updates will be delivered to a machine running AhsayOBM or AhsayACB if Au toUpdate
Agent service is stopped.
During each Auto Update cycle, AutoUpdate works in the f ollowing sequences:
1. The AutoUpdate Agent running on the client machine will d index file (%OBSR_HOME%\webapps\obs\liveUpdate\inde contains the information of the latest client software availab
AhsayOBS. ownload the x.xml) which le from
2. If the AutoUpdate Agent finds that AhsayOBS contains a patch for
AhsayOBM or AhsayACB which is newer than the current version, it will download and install the patch from AhsayOBS automatically
(%OBSR_HOME%\webapps\obs\liveUpdate\obm????.zip).
3. After the AhsayOBM or AhsayACB client is updated. The scheduled backup job will run using latest version of AhsayOBM/AhsayACB.
Note:
In order for AutoUpdate to work, the “index.xml” file must be renamed from the file “index.xml.disable” inside the directory
“%OBSR_HOME%\webapps\obs\liveUpdate”.
Ahsay Systems Corporation Limited 153
Ahsay Offsite Backup Server
Administrator’s Guide
17.2 Using AutoUpdate
When you install an updated version of AhsayOBS on your ba new version of the AutoUpdate module for AhsayOBM and A already bundled with the updated version of AhsayOBS. This new version of Ahsay machines through the AutoUpdate Agent when you install an updated version of AhsayOBS on your server. ckup server, a hsayACB are means that a
OBM or AhsayACB will be delivered to all your client
17.3 Customizing AutoUpdate
If you want to customize the AutoUpdate patch file that will be delivered to your existing client installations (i.e. sending your own patch file to your client), please refer to the Ahsay Cu stomization Portal User Guide
Ahsay Customization Portal for more information.
from the
17.4 Forcing an extra AutoUpdate
If you want to customize the AutoUpd ate patch file that will be delivered to your existing client installations (i.e. sending your own patch file to your client), please refer to the Ahsay Backup Software Upgrade Guide .
17.5 AutoUpdate Limitations
AutoUpdate is officially su above to v6.7.0.0. pported for AhsayOBM & AhsayACB v5.5.1.0 or
AutoUpdate of AhsayOBM & AhsayACB to v6 is officially supported for O/S
Ahsay Help Centre Article #2323 platforms specified in
AutoUpdate Agent does not support AhsayOBM/AhsayACB upgr ade from v5 to v6 on the following O/S platforms: i. ii.
FreeBSD
Solaris iii. Mac OSX
AutoUpdate Agent may update details on bundled Java that is packaged with
AhsayOBM/AhsayACB installation. Due to this reason, AutoUpdate Agent will not support upgrades on these platforms as propriety Java are in use.
Ahsay Systems Corporation Limited 154
17.6 AutoUpdate Changes
Ahsay Offsite Backup Server
Administrator’s Guide
From AhsayOBS v6.5.0.1 onwards the configuration of AutoUpda
AhsayOBS has been further enhanced, to allow AhsayOBM/Ah upgrades based on a specific
AutoUpgrades of AhsayOBM/AhsayACB clients can also be pe on specific O/S versions (Windows only). te feature on sayACB client
client version or a range of versions. rformed based
The 'force' attribute has been removed from 'index.xml' since the AutoUpdate
Agent GUI has been d isabled.
17.6.1 At trib utes Changes
Attribute
os
Description
Only accepts the OS family name (Windows/Mac OS/NIX) compatible-os Accepts the list of supported OS name separated by ',' (For
Example “Windows XP, Windows 2003, W
Windows Server 2008, Windows
7”)
indows Vista,
The following is an example of an <AutoUpdate> entry in the "index.xml":
<AutoUpdate product="obm" version="6.5.0.0" compatible="5.5.x.
x" host="">
<patch os="Windows" url="/obs/liveUpdate/obm6500-win.zip" compatible-os="Windows XP, Windows 2003, Windows Vista, W
Windows 7 indows Server 2008,
" include-users="*" exclude-users="" force="false"/>
<patch os="Mac OS" url="/obs/liveUpdate/obm6500-mac.zip" compatible-os="Mac
OS X" include-users="*" exclude-users="" force="false"/>
<patch os="NIX" url="/obs/liveUpdate/obm6500-nix.zip" compat
Solaris, SunOS, FreeBSD" include-users="*" exclude-users="" fo ible-os="Linux, rce="false"/>
</AutoUpdate>
17.6.2 Multiple AhsayOBM/AhsayACB Versions Selection
A new value type has been in troduced in the 'compatible' attribute in the
<AutoUpd cl ients on specified version(s) i. ii. ate> tag. So that AutoUpdate
For example: can target AhsayOBM/AhsayACb
5.5.[5-8].x refers to versions 5.5.5.x, 5.5.7.x, and 5.5.8.x
6.5.[0-4].x refers to versions 6.5.0.x,6.5.1.x, 6.5.2.x, and
6.5.4.x
The product version range should be: i. Specified inside brackets, i.e. [5-8]
Ahsay Systems Corporation Limited 155
Ahsay Offsite Backup Server
Administrator’s Guide ii. Be a positive integer,i.e. [5-10], [0-9]. iii. Starting range should be smaller than the range end. i.e [8-5] is an invalid range.
The following are examples of <AutoUpdate> entries in the "index.xml": i. Multiple versions
AhsayOBM/AhsayACB versions from 5.5.3.0 to 5.5.3.3
<AutoUpdate product="obm" version="6.5.0.1" compatible="5 .5.3.x" host=""/>
<AutoUpdate product="acb" version="6.5.0.1" compatible="5.5.3.
x" host=""/>
AhsayOBM/AhsayACB versions from 5.5.5.0 to 5.5.5.5 an d AhsayOBM
5.5.7.0 to 5.5.7.5
<AutoUpdate product="obm" version="6.5.0.1" compa tible="5.5.5.x, 5.5.7.x" host=""/>
<AutoUpdate product="acb" version="6.5.0.1" compatible="5.5.
host=""/>
5.x, 5.5.7.x"
AhsayOBM/AhsayACB versions from 6.3.0.0 to 6.
3.1.0
<AutoUpdate product="obm" version="6.5.0.1" compatible="6.3.x.x
<AutoUpdate product="acb" version="6.5.0.1" compatible="6.3.x.x
"
" host=""/>
host=""/> ii. Version range
AhsayOBM/AhsayACB versions from 5.5.5.0 to 5.5.8.x
<AutoUpdate product="obm" version="6.5.0.1" compatible="5.5.[5-8].x" host=""/>
<AutoUpdate product="acb" versi on="6.5.0.1" compatible="5.5.[5-8].x" host=""/>
AhsayOBM/AhsayACB versions from 5.5.5.0 to 5.5.5.5
<AutoUpdate product="obm" version="6.5.0.1" compatible="5.5.[5].x" host=""/>
<AutoUpdate product="acb" version="6.5.0.1" compatible="5.5.[5].x
" host=""/> iii. Multiple version with version ranges
AhsayOBM/AhsayACB versions from 5.5.5.0 to 5.5.7.5 and
<AutoUpdate product
6.3.x.x" ho st=""/>
5.5.8.0 to 5.5.9.0
="obm" version="6.5.0.1" compatible="5.5.[5-7].x, 5.5.[8-9].0,
<AutoUpdate product="acb" version="6.5.0.1" compatible="5.5.[5-7].x, 5.5.[8-9].0,
6.3.x.x" host=""/>
AhsayOBM/AhsayACB versions from 5.5.5.0 to 5.5.5.5 and 5.5.7.0 to 5.5.7.5
<AutoUpdate product="obm" version="6.5.0.1" compatible="5.5.[5].x, 5.5.7.x,
6.5.x.x" host=""/>
<AutoUpdate product="acb" version="6.5.0.1" compatible="5.5.[5].x, 5.5.7.x,
6.5.x.x" host=""/>
Ahsay Systems Corporation Limited 156
17.6.3 Multiple Host Selection
Ahsay Offsite Backup Server
Administrator’s Guide
The AutoUpgrade can be configured to target AhsayOBM/Ah which are connecting sayACB clients
to certain host names using the ‘host’ attribute. The host attribute can accepted only valid hostnames or “”, no wildcard values are allowed, i.e. host =”*”. i. Single host configu ration
<AutoUpdate product="ob m" version="6.5.0.1" compatible="5.5.8.x" host="backup1.ahsay.com"/>
ii. Multiple hosts configuration
<AutoUpdate product="obm " version="6.5.0.1" compatible="5.5.8.x" host="back up1.ahsay.com, backup2,ahsay,com, backup3.ahsay.com"/>
For AhsayOBS servers configured with multiple resellers and has an individual domain name.
each reseller iii. All hosts
<AutoUpdate product="obm" version="6.5.0.1" compatible="5.5.8.x" host=""/> or
<AutoUpdate product="obm" version="6.5.0.1" compatible="5.5.8
.x"/>
Note:
The use wildcard values are not supported, for example:
<AutoUpdate product="obm" version="6.5.0.1" compatible="5.5.8.x" host="*"/>
Ahsay Systems Corporation Limited 157
17.6.4 Backup User Account Selection
Ahsay Offsite Backup Server
Administrator’s Guide
The Auto Update of AhsayOBM/AhsayACB clients can be ma from the AhsayOBS web console. The AhsayOBS system ad naged directly ministrator or system users will be able to select backup clients to upgrade via
System] -> [Manage User] -> [Auto Update] page. By default a accounts are selected. This information is then sa
%OBS_HOME%\conf\ autoUpdate.bdb file the [Manage ll backup user ved to the
. The “autoUpdate,bdb” file will be automatically created when AhsayOBS is installed or when upgraded to v6.7.0.0 or above during AhsayOBS service startup.
Once selected fo r Auto Update the AhsayOBM/AhsayACB clients connecting to the backup account will be updated. The AhsayOBM/AhsayACB clients will be updated regardless of the status of the backup account, i.e. enabled, suspended, or locked.
The following example is from the [Manage System] -> [Manage User] ->
[Auto Update] page for the “system” user. By default all accounts are selected for Auto Update. In addition to display backup users, when Auto Update is enabled on AhsayOBS. B available upgrade v backup user ing the list of oth the latest ersions for AhsayACB and AhsayOBM are shown.
The “system” user can view and change the auto update status for all
AhsayOBM/AhsayACB user accounts on the AhsayOBS server including those created by resellers. The reseller owned backup user accounts are identified with the ‘Owner” name.
Ahsay Systems Corporation Limited 158
Ahsay Offsite Backup Server
Administrator’s Guide
Some definitions of the fields related are shown in the following table:
Key
No.
Description
Number count of the backup user.
Login Name
(Alias)
Owner
The login name of the user with the alias bracketed behind.
Owner of this backup user.
Registration Date The creation time of user.
Trial Expiry Date The expiry date of trial user.
If the Auto Update feature is disabled on AhsayOBS the [Manage System] ->
[Manage User] -> [Auto Update] page, will display the status “Auto Update is disabled”. Both the latest available upgrade versions for AhsayACB and
AhsayOBM will not be shown.
WARNING:
Please DO NOT modify the attributes “include-users” and “excludeusers” inside the <patch> tag in the file “index.xml” as the values inside the attributes will be replaced by the settings in this page.
159 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
17.7 Enable AutoUpdate on AhsayUBS
To rename the “index.xml” file from “ index.xml.disable” on an AhsayUBS server. Please perform the following steps:
1. Stop the AhsayOBS service from the AhsayUBS web admi
[Backup Server] > [Server Status] and press the [Stop]
2. After the [Backup Server] > [Server Status] > [S
‘Stopped”. Use a ssh c n console under button. tatus] has changed to lient to login to the AhsayUBS server using ‘root’ account.
3. Mount “/ubs/mnt/esosfw” as read write using the “mo unt -uw
/ubs/mnt/esfmfw” command.
4. cd /ubs/mnt/esfmfw/obsr/system/obsr/webapps/obs/liveUpda te
5. Rename the “index.xml.disable” to “index.xml” using the fo llowing command “mv index.xml.disable index.xml”
6. Reboot the AhsayUBS server from the AhsayUBS web adm
[System] > [Reboot] > [N
7. A ow] and press [Yes] to confirm. in console fter AhsayUBS server has rebooted, start the AhsayOBS service from the
AhsayUBS web admin console under [Backup Server] > [Server Status] and press the [Start] button. The [Backup Server] > [Server Status] >
[Status] will change to ‘Running”.
Note:
1. After the AhsayUBS ser ver is rebooted the “/ubs/mnt/esosfw” will be automatically mounted as rea d only.
2. Since AhsayOBS version 6.13, the following files will not the AhsayOBS bundled with the AhsayUBS ins taller: be included in
jvmupdate-160u23-win.zip
jvmupdate-160u23-linux.zip
These are the patch files for the Java virtual machines. If you want to update your clients from 5.5.8.0 (or below) to 6.13 or later versions, please refer to the steps in our Help Centre article 3076
.
Ahsay Systems Corporation Limited 160
Ahsay Offsite Backup Server
Administrator’s Guide
18
Backup / Restore files using off-line media
Backing up large amount of files (e.g. 300GB) online through th very lengthy task. It is sometimes necessary to ship the fir e Internet is a st full backup through off-line media (e.g. removable USB hard disk) to the backu p server.
Once the first full backup is loaded onto the backup server th media, all subse rough off-line quent backups will be able to run and complete successfully in a timely manner because it is only necessary to upload new /updated files to the backup server.
Restoring large amount of fi les (e.g. 300GB) online through the Internet is also a very lengthy process. It is also important to be able to a llow users to restore their b ackup file through offline media to reduce the time required to restore large amount of files.
This chapter describes the steps requir ed to import/export backup files to/from AhsayOBS.
18.1 Seed loading backup files (Import)
A backup user can use the [Seed L oad Utility] to transport its first full backup to an offsite backup server without having to upload a large volume of data through the Internet (Please refer to th e AhsayOBM User’s Guide for more p server informatio
(e in n). When the seed load files are transported to the backu
.g. using removable hard disk), please follow the instruct stall them into the required user account: ions below to
1.
Locate th e home directory of the backup user.
A backup user’s home directory is a directory named the the backup user under one of the AhsayOBS’s [User Home
[Manage System] m console.
login name of
[User Homes] is a system-wide setting which can be acces s] directories. sed under the enu after logging onto the web system management
For example:
The default [Users Homes] directory is “C:\Program Files\Ah
AhsayRPS\user”. If the login name of the backup account sayOBS and is “john”, the home directory of user “john” should be “C:\Program Files\AhsayOBS and AhsayRPS\user\john”.
2. Copy all seed load files to the home directory.
Find the “files” directory from the seed load files, and copy the “files” directory to the backup user’s home directory.
In this example, you should copy the “files” directory to “C:\Program
Files\AhsayOBS and AhsayRPS\user\john”
161 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
If you are running AhsayOBS on Linux under a non-root us please make sure that the “files” directory an owned and writable by the us er (e.g. obs), d all its contents are er running AhsayOBS (e.g. obs).
3.
Check if all files are installed correctly.
Logon to the web interface of AhsayOBS with the backup user account
(“john” in top of the menu. Check if you can see all seed load installed.
this example) and click the [File Explorer] link available at the files correctly
4. Total number of files and total file size imported into t through seed loading is not visible in the profile of this ba
The [User Profile] page still reports no files in the
Admin admin console] -> [Manage User] -> [User Profile] ->
Option]) for the corresponding user with the option “Veri enabled to ensure that all backup files are seed loaded to AhsayOBS correctly. he data area ckup user (i.e.
data area). istrator should run the “File Validation Option” ([AhsayOBS web
[File Validation fy Checksum”
If you need to perform another import (seed loading) when the files on the backup server already, please remove all existin re are backup g backup files from the backup server b y removing the backup set ID directory (i.e. a numerically named directory under the “files” directory under a user directory) before copying all new seed loading files into the system. I than one backup set ID directory under the “files” d f you have more irectory, please take a look at [User Home Directory]\db\Profile.xml to find out the correct Backup
Set ID for the required backup set.
18.2 Saving backup files to off-line media (Expo rt)
If you want to save a copy of all backup files under a backup user account to an offline media, please do the following:
1. Locate the home directory of the backup user.
2. Copy the complete home directory of this backup user to an offline media.
3. Once the offline media is shipped to the user, the user can then use the
[Decrypt File Wizard] available in AhsayOBM to decrypt and restore the backup files available in the offline backup back to its original format.
Ahsay Systems Corporation Limited 162
Ahsay Offsite Backup Server
Administrator’s Guide
19
High Availability & Load-Balancing Configuration
For further information, please refer to the AhsayOBS High Avail ability Option
Setup Guide and Ahsay Redirector Setup Guide available in our document section .
Ahsay Systems Corporation Limited 163
Ahsay Offsite Backup Server
Administrator’s Guide
20
Secure connection with AhsayOBS
This chapter describes how you can use the Management Console to configure various secure connection settings of AhsayOBS.
20.1 Installing a trusted SSL certificate
Default installation of AhsayOBS enables SSL (Secure Socket Layer) using a dummy certificate. For your own security, y
support ou are advised to replace the pre-installed dummy SSL certificate with a secure SSL certificate from a trusted CA (Certificate Authority). To replace the non-secure dummy SSL certificate with a secure SSL certificate, please do the following:
1.
Identify the location of the keystore file.
You need to store your SSL certificate in a keystore file. The default location of the keystore file is % OBSR_HOME%\conf\keystore.
Make a backup of this dummy keystore file, you may use th future. is file in the
2.
Delete dummy certificate from keystore.
You can delete the dummy SSL certificate from the keystore by running:
s tomcat –keystore
%OBSR_HOME%\conf\keystore.
You w ill be prompted for the keystore password. The d
“chang eit”. efault password is
Platform Example
Windows
C:\Program Files\AhsayOBS and AhsayRPS\ conf>
"C:\Program Files\AhsayOBS and
AhsayRPS\java\bin\"keytool –delete -alias tomcat – keystore keystore
Linux
[root]# keytool –delete –alias tomcat –keystore
/Applications/AhsayOBS/conf/keystore
3.
Generate RSA key pair.
A SSL certificate contains a RSA key pair. You can generate a RSA key pair by running:
%OBSR_HOME%\java\bin\keytool –genkey –alias tomcat –keyalg
RSA –keysize 2048 –keystore %OBSR_HOME%\conf\keystore
Also, the key password for the alias “tomcat” must be the same as the keystore password. Please simply press the [Enter] key when you are
164 Ahsay Systems Corporation Limited
4.
Ahsay Offsite Backup Server
Administrator’s Guide prompted for the key password for t omcat (i.e. Press [Enter] when you see the “key password for <tomcat>” prompt).
Note: The keysize value ‘2048’ is now requested by most of the CA.
Please double c heck with your CA on this value.
Platform Example
Windo ws
C:\Program Files\AhsayOBS and Ahs ayRPS\conf>
"C:\Program Files\AhsayOBS and
Linux
AhsayRPS\java\bin\"keytool –genkey –ali as tomcat – keyalg RSA –keysize 20 48 –keystore keystore
[root]# keytool –genkey –alias tomcat –keyalg RSA – keysize 2048 –keystore /usr/ local/OBS/conf/keystore
Create a local Certificate Signing Request (CSR).
You can create a CSR for your SSL certificate by running:
%OBSR_HOME%\ java\bin\keytool –certreq –keyalg RSA –alias tomc at –file ssl.csr –keystore %OBSR_HOME% \conf\keystore
Platform Example
Windo ws
C:\Program Files\ AhsayOBS and AhsayRPS\conf>
"C:\Program Files\AhsayOBS and
AhsayRPS\java\bin\"keytool –certreq –key alg RSA – alias tomcat –keystore keystore
Linux
[root]# $OBSR_HOME/java/bin/keytool –cer keyalg RSA –alias tomcat –keystore
$OBSR_HOME/conf/keystore treq –
5.
Submit the CSR file to a trusted CA of your choice. This process may take several hours to several days.
6.
Download the SS generated step 7.
L certificate from your CA, if your SSL certificate by your CA does not requires intermediate certificate, go to
Please download intermediate certificate(s) if the SS by your CA is required your keystore bef instru for detailed instructions.
L certificate issued
and import the intermediate certificate(s) into ore you import your SSL certificate. Since the ction may be different for different CA, please check with your CA
Sample syntax:
%OBSR_HOME%\java\bin\keytool –import –alias intermediate – trustcacerts –file CA_bundle_intermediate.crt –keystore
%OBSR_HOME%\conf\keystore
Note:
Ahsay Systems Corporation Limited 165
Ahsay Offsite Backup Server
Administrator’s Guide
The alias ‘intermediate’ is used for storing the certificate. If your CA offers more than 1 intermedia you can the command again by entering another intermediate te certificates,
alias such as
‘intermediate2’.
The name o f the bundled intermediate certificates are different between CA, you need to check with your CA and modifiy the name accordingly.
Platform Example
Windo ws
C:\Program Files\AhsayOBS a nd AhsayRPS\conf>
"C:\Program Files\AhsayOBS and
AhsayRPS\java\bin\"keytool –import –a lias intermediate –trustcace rts –file
CA_bundle_intermediate.crt –keystore
%OBSR_HOME%\conf\ keystore
Linux
[root]# $OBSR_HOME/java/bin/keytool –list –alias intermediate –trustcacerts –file
CA_bundle_intermediate.crt –keystore
$OBSR_HOME/conf/keystore
7. Import signed SSL certificate to the keystore from which the CSR was generated by:
%OBSR_HOME%\java\bin\keytool –import –alia s tomcat – trustcacerts –file ssl.crt –keystore
%OBSR_HOME%\conf\keystore
Platform Example
Windows
C:\Program Files\AhsayOBS and AhsayRPS\ conf>
"C:\Program Files\AhsayOBS and
AhsayRPS\java\bin\"keytool –import –alia s tomcat –
Linux
trustcacerts –file ssl.crt –keystore
%OBSR_HOME%\conf\keystore
[root]# $OBSR_HOME/java/bin/keytool –lis t –alias tomcat –keystore $OBSR_HOM E/conf/keystore
If you are getting the “keytool error: java.lan
establish chain from reply” message w
g.Exception: Failed to
hen importing the SSL certificate file from CA, please try double-clicking the ssl.crt file on
Windows to view all intermediate certificates being used to sign your certificate and import all intermediate certificates (downloadable from your CA) into your keystore file before importing your SSL certificate.
You can check with your CA for detailed instructions.
8. Check if you have installed the SSL certificate correctly by:
Ahsay Systems Corporation Limited 166
Ahsay Offsite Backup Server
Administrator’s Guide
%OBSR_HOME%\java\b
%OBS R_ HOME%\ in\keytool –list –alias tomcat –keystore conf\keystore
Platform
Windows
Linux
Example
C:\Program Files\AhsayOBS and AhsayR PS\conf>
"C:\Program Files\AhsayOBS and
AhsayRPS\java\bin"\keytool –list –al ias tomcat – keystore keystore
[root]# $OBSR_HOME/java/bin/keytool –list –alias tomcat –keystore $OBSR_HOME/conf/keystore
Sample Output:
Tomcat, 2003/6/13, keyEntry, Certificate fingerpr xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx int (MD5):
Please make sure that you are getting the type “keyEnt ry” instead of
“trustedCertEntry” from the output above. If you are getting
“trustedCertEntry”, the most likely cause of this is that you are NOT importing the SSL certificate back into the same keystore from which
this keystore the CSR was generated. The only solution to this is to find file and import the certificate(s) to the keystore file again find this file, please repeat the and try a gain.
. If you can’t
instructions in this section from step 1
* When asked for your “first and last name” durin please specify the domain that you will
Please refer to the followin g example: g the key generation, be using this certificate for.
Full Example
C:\Program Files\AhsayOBS and AhsayRPS\conf> "C:\Program
Files\AhsayOBS and AhsayRPS tomcat –keysize 20 48 –keyalg
\java\bin\"keytool –genkey –alias
RSA –keystore keystore
Enter keystore pass word: changeit
What is your first and last name?
[unknown]: www.secure-company.co
m
What is the name of your organization
[unknown]: NOT SECURE al unit?
What is the name of your organization?
[unkn own]: NOT SECURE
What is the name of your C ity or Locality?
[unknown]: NOT SECURE
What is the name of your State or Province?
[unknown]: NOT SECURE
What is the two-letter country code for this unit?
[unknown]: NS
Is <CN=www.secure-company.com, OU=NOT SECURE, O=NOT
SECURE, L=NOT SECURE, ST=NOT SECURE, C=NS> correct?
[no]: yes
Enter key password for <tomcat>
Ahsay Systems Corporation Limited 167
Ahsay Offsite Backup Server
Administrator’s Guide
(RETURN if same as keystore password):
C:\Program Files\AhsayOBS and AhsayRPS\conf> "C
Files\AhsayOBS and Ahsay
:\Program
RPS\java\bin\"keytool –certreq –keyalg
RSA – alias tomcat –file certreq.csr –keystore keystore
Enter keystore password: changeit
When your CA has signed the SSL certificate:
C:\Program Files\AhsayOBS and Ah
Files\AhsayOBS and AhsayRPS\ sayRPS\conf> "C:\Program java\bin\"keytool –import –alias tomcat –keystore keystore –trustcacerts –file ssl.c
rt
Enter keystore password: changeit
Certificate re ply was installed in keystore
C:\Program Files\AhsayOBS and AhsayRPS\conf> "C :\Program
Files\AhsayOBS and AhsayRPS\java\bin\"keytool –list –alias tomcat – keystore keystore
Tomcat 2003/06/13, keyEntry, Certificate fingerpr xx:xx: int (MD5): xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx
When your CA has signed t certificate: he SSL certificate with intermediate
C:\Program Files\AhsayOBS and AhsayRPS\conf> "C:\Program
Files\AhsayOBS and AhsayRPS\java\bin\"keytool – import –alias intermediate –keystore keystore –trustcacerts –file
CA_bundle_intermediate.c
rt
Enter keystore password: chang eit
Re-enter new password: changeit
Certificate was added to keystore
C:\Program Files\Ah sayOBS and AhsayRPS\conf> "C:\Program
Files\AhsayOBS and AhsayRPS\java\bin\"keytoo tomcat –keystore keystore –trustcacerts
Enter keystore password: changeit
Certificate reply was installed in keystore l –import –alias
–file ssl.crt
C:\Program Files\AhsayOBS and AhsayRPS\conf> "C:\Program
Files\AhsayOBS and AhsayRPS\java\bin\"keytool –list –alias tomcat – keystore keystore
Tomcat 2003/06/13, keyEntry, Certificate fingerprint (MD5): xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx
Ahsay Systems Corporation Limited 168
Ahsay Offsite Backup Server
Administrator’s Guide
Note: General SSL cert issued by CA is sufficient for t backup purpose. Extended Validation (EV) cert can is designed for high-security usage, mainly used cost of this cert is more expensive. Unified Comm he need of also be used, it
in browser. The unications
Certificates (UCC) are also supported, please refer to http://support.godaddy.com/he lp/3908 for more information.
20.2 Renew a trusted SSL certificate
When your SSL certificate is due to expire, you can renew you your CA’s website. Your CA may ask you to use existing r SSL cert via
CSR that you submitted previously or submit a new CSR.
- If you decided to use a new CSR, most likely the informat
CSR is not up-to-date. Most CA ion on the old will not consider this as a renew process and you need to start from the beginning of a certificate pro cess described in previous section.
- If you purchase a renew SSL certificate with the existing CSR, wait for your CA to sign the renew SSL certificate.
Note: The renewal process may be different for different CA. You need to follow your CA’s instruction on the renewal process.
Th
SS e import step of a renew SSL certificate is similar to the installation of a
L certificate.
Import signed renew SSL certificate to the keystore from which the CSR was g
%OBSR_HOME%\java\bin\keytool –import –alias tomcat – trustcacerts –file ssl.crt –keystore
%OBSR_HOME%\conf\keystore
Platform Example
Windows
C:\Program Files\AhsayOBS and AhsayRPS\conf>
"C:\Program Files\AhsayOBS and
AhsayRPS\java\bin\"keytool –import –alias tomcat – trustcacerts –file ssl.crt –keystore
%OBSR_HOME%\conf\keystore
Linux
[root]# $OBSR_HOME/java/bin/keytool –import –alias tomcat –trustcacerts –file ssl.crt –keystore
%OBSR_HOME%\conf\keystore
When the CA has signed the renew SSL certificate:
Full Example
Ahsay Systems Corporation Limited 169
Ahsay Offsite Backup Server
Administrator’s Guide
C:\Program Files\AhsayOBS and AhsayRPS\conf>
Files\AhsayOBS and Ahsay RPS\java\bin\" tomcat –keystore keystore –trustca
Enter keystore password: changeit
"C:\Program keytool –import –alias certs –file ssl.crt
Certificate reply was installed in keystore
C:\Program Files\Ah sayOBS and AhsayRPS\conf> "C:\Program
Files\AhsayOBS and AhsayRPS\java\bin\"keytoo l –list –alias tomcat – keystore keystore
Tomcat 2003/06/13, keyEntry, Certificate fingerprint (MD5): xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx
20.3 Import pfx certificate into Java keystore
If you already have a pf x certificate and you want to import it into the Java keystore (JKS). Please do the following.
1.
2.
Put the pfx certificate file to the directory where the keys tore locates. Eg:
%OBS_HOME%\conf .
To import the .pfx file with the keytool comman d in the
%OBS_HOME%\java\bin .
%OBSR_HOME%\java\bin\keytool -importkeystore -deststorepass
<java_keystore_password> -destkeypass <java_key_password> destkeystore <java_keystore_path/filename> -destalias tomcat
-src keystore <pfx_keystore_filename> -srcs toretype PKCS12 srcstorepass <pfx_keystore_password> -srckeypass
<pfx_key_password> -alias <pfx_alias>
Platform Example
Windo ws
C:\Program Files\AhsayOBS and AhsayRPS\ conf>
"C:\Program Files\AhsayOBS and
AhsayRPS\java\bin\"keytool -importkeys tore deststorepass changeit -dest keypass changeit destkeystore my_keystore.pfx -destalias tomcat srckeystore my_keystore.pfx -srcstoretype PKCS12 srcstorepass mypfxpassword -srckeypass mypfxpassword -alias my_alias
Linux
[root]# $OBSR_HOME/java/bin/keytool -importkeystore
-deststorepass changeit -destkeypass changeit destkeystore my_keystore.pfx -destalias tomcat srckeystore my_keystore.pfx -srcstoretype PKCS12 srcstorepass mypfxpassword -srckeypass
170 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
mypfxpassword -alias my_alias
Note:
The pfx file name is my_keystore.pfx
The password of pfx keystore is mypfxpassword
The "-alias my_alias" is the alias of the key used in
the pfx file.
For more information, please refer to the keytool document page at http://docs.oracle.com/javase/6/docs/technotes/tools/solaris/key tool.html
20.4 Enforcing SSL to the web interface
If you want all users to connect to the web interface of AhsayOBS using SSL to enforce secure connection, please do the followings:
1.
Op en %OBSR_HOME%\webapps\obs\WEB-INF\web.xml
2.
Locate the [Enforce SSL] section at the end of “web.xml
”
Web.xml
…
.
< !--
===================================
================================
========================= --> t
=========
===== -->
<
!-- ================================ Enforce SSL
===========
<!-- == Please uncommen the following section to enfo rce SSL for the web interface == -->
<!--
=======================
===============
=====================
====================== -->
<!--
<security-constraint>
<web-resource -collection>
<web-resource-name>Automatic SLL Forwarding</web-resourcename>
<url-pattern>/jsp/user/*</url-pattern>
<url-pattern>/jsp/system/*</url-pattern>
</web-resource-collection>
<user-data-constraint>
<transport-guarantee>CONFIDENTIAL</transport-guarantee>
</user-data-constraint>
</security-constraint>
-->
…
.
Ahsay Systems Corporation Limited 171
Ahsay Offsite Backup Server
Administrator’s Guide
3. Remove the XML co bold above) from “we mment tags (“<!--“ and “-->”, shown in red and b.xml”
4. Restart AhsayOBS.
Please note that this only enforces SSL when users log onto the web interface of AhsayOBS. It does not enforce backup traffic from AhsayOBM to be SSL.
20.5 Install code signing cert with the restorer a pplet
Default in stallation of AhsayOBS includes a dummy code sign cert for the
Java applet for file restoration. To replace t he code sign cert for this applet, please do the following:
Assumptions:
* A JavaSoft Developer Certificate will be purchased.
* Keystore password is "changeit", Certificate Signing Request (CSR) file will be named "codesign.csr".
To sign the restorer applet, we need to first generate a CSR for f veloper Certificate.
Please refer to the following instructions:
the purchase
1. Ope command prompt, browses to the AhsayO d irec tory:
BS configuration
cd %OBSR_HOME%\conf
Platform Example
Windo ws
cd "C:\Program Files\Ah sayOBS and AhsayRPS\conf"
Linux
[root]# cd /usr/local/obsr/conf
2. Make a copy of the keystore file:
Platform Example
Windo ws
Linux
copy keystore keystore_cs
[root]# cp keystore key store_cs
3. Browses to the Java bin directory:
Platform Example
Windows
cd "C:\Program Files\AhsayOBS and
AhsayRPS\java\bin"
Linux
[root]# cd /usr/local/obsr/conf/java/bin or your native Java bin folder path
172 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
4. Enter the followin g command:
Platform Example
Windo ws
keytool -genkey -alias Alias_Name -key size 2048 keyalg RSA -keystore "..\..\conf\keysto re_cs"
Linux
[root]# keytool -genkey -alias Alias_Name -keysize
2048 -keyalg RSA -keystore "../../conf/ keystore_cs"
Note: The Alias_Name is the cert store for your code sign cert, it will be used when you import the code sign cert from your CA.
Full Example
keytool -genkey -alias Alias_Name -keysize 2048 -keyalg RSA –keystore
"../../conf/keystore_cs"
Enter keystore password: changeit
What is your first and last nam
What is the
[Unknown]: Unit Name e?
[Unknown]: backup.server.com
name of your organizational unit?
What is the name of your organization?
[Unknown ]: Company Name
What is the name of your City or Locality?
[Unknown]: City
What is the name of your State or Province?
[Unknown]: State
What is the two-letter country co de for this unit?
[Unknown]: XX
Is CN=backup.server.com, OU=Product Name, O=Company Name,
L=City, ST=State, C=XX?
[no]: ye s
Enter key password for
(RETU RN if same as keystore password):
5. Enter the following command afterward to generate the CSR file:
Platform Example
Windows
keytool -certreq -keyalg RSA -alias Alias_Name file "C:\Program Files\AhsayOBS and
AhsayRPS\conf\codesign.csr" -keystore
"..\..\conf\keystore_cs"
Linux
[root]# keytool -certreq -keyalg RSA -alias
Alias_Name -file
"/usr/local/obsr/conf/codesign.csr" -keystore
"../../conf/keystore_cs"
6. A CSR file should be generated, similar to the example as follow: example:
Ahsay Systems Corporation Limited 173
Ahsay Offsite Backup Server
Administrator’s Guide
-----BEGIN NEW CERTIFICATE REQUEST-----
MIIBzDCCATUCAQAwgYsxCzAJBgNVBAYTAkdCMQ8wDQYDVQQIEwZMb25kb24xD zANBgNVBAcTBkxv bmRvbjEjMCEGA1UEChMaQ2VydWxlYW4gU29sdXRpb25zIExpbWl0ZWQxEjAQB gNVBAsTCURhdGFW
YXVsdDEhMB8GA1UEAxMYZGF0YXZhdWx0LmNlcnVsZWFuLmNvLnVrMIGfMA0GC SqGSIb3DQEBAQUA
A4GNADCBiQKBgQCdc7ehHP0RwSuxVgGlwmGszBjpcX3Gs4mAQUqP3SV2qj5V9 BIExQdj+BEdp2Lr
XW618JTy25zHk/eil5RYfxJ2vFz+Ur/nkofa+H19XkugwMcvzNcnbzuyFMNXC SVwQ4qlwKw1wUIw
TqZKJO5q7TqDmThH9PjbpAGSRv8k3 nHltQIDAQABoAAwDQYJKoZIhvcNAQEEBQADgYEAM6Max4hk
TTfyUwjVWtdECMiRejB1bFbx0cUSW SOXUXzHwTDBemrheq4asKh6DdfGKaK3jh21yhgNrvVtrtNX zaskzKgHhay/PHXDgEx1gc0b3omKW5nOy4Lg3SBxf8ViWYQws7ZHhZENLbVg4pHj5dW0eLqXG1jb
//FpJA5ZQRI=
-----END NEW CERTIFICATE REQUEST-----
7. You can now purchase the JavaSoft Developer Certificate with the CSR generated.
With the can im ort it with the following instructions:
8. Open
purchased JavaSo ft Developer Certificate (e.g. codesign.crt), we
com mand prompt, browses to the Java bin directory:
Platform Example
Windows
cd C:\Program Files\AhsayOBS and AhsayRPS\java\bin
Linux
[root]# cd /usr/local/obsr/java/bin or your native Java bin folder path
9. E nter the following command to import the certific ate:
Platform Example
Windows
keytool -import -trustcacerts -alias Alias_Name file "C:\Program Files\AhsayOBS and
AhsayRPS\conf\codesign.crt" -keystore
"..\..\conf\keystore_cs"
Linux
[root]# keytool -import -trustcacerts -a
Ali as_Name -file lias
"/usr/local/obsr/conf/co design.crt" -keystore
"../../conf/keystore_cs"
Note: The Alias_Name should be the same name when you generate the
CSR in step 4.
10. Prepare to sign the restorer applet (obrA.jar) by following the instructions below:
* Copy the obrA.jar file to a temporary directory,
for example C:\temp_cert (Windows) or /temp_cert (Linux)
* Rename the obrA.jar file to obrA.zip
* Extract obrA.zip and remove all files within the META-INF directory
* Rename the obrA.zip file back to obrA.jar afterward
174 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Note: By default, the obrA.jar file is located in
Windows
C:\Program Files\AhsayOBS and
Ah sayRPS\webapps\obs\jsp\applet\obr\obrA.jar
Linux
/usr/local/obsr/webapps/obs/jsp/applet/obr/obrA.jar
1 1. Download and install Java JDK on t he AhsayOBS server. You can download the Java Development Kit at: http://java.sun.com/javase/downloads/index.jsp
Note: The Java bundled with the AhsayOBS application is Java JRE.
12. Ope n command prompt, browse to Java JD K bin directory:
Platform Example
Windows
cd "C:\Program Files\Java\jdk1.6.0_17\bin"
Linux
[root]# cd /usr/local/jdk1.6.0_17/bin
13. Sign the restorer ap plet (obrA.jar) with the following command:
${Java-
"..\.
.\co
Alias_N
JDK-Location}\jarsigner -keystore nf\keystore_cs" ame
..\..\webapps\obs\jsp\applet\obr\obrA.jar
Platform Example
-keystore
Linux
"..\..\conf\keystore_cs" ..\..\webapps\obs\jsp\applet\obr\obr
A.jar Alias_Name
[root]# jarsigner – keystore ../../conf/keystore_cs ../../webapps/obs/jsp/applet
/obr/obrA.jar Alias_Name
Ahsay Systems Corporation Limited 175
Ahsay Offsite Backup Server
Administrator’s Guide
21
Monitoring System Activities
This chapter describes how you can use the [Manage Log] -> [System Log] page (shown below) to review system and backup activities of AhsayOBS.
21.1 Reviewing System Log
When you click th e [Manage Log] -> [System Log] link available at the top menu, the [System Log] panel will appear. It lists all system messages / warnings / errors logged on any particular date by selecting the required date from the drop down list.
Key
Date
Rows/Page
Timestamp
Login Name
Owner
Message
Description
The date when all messages were logged.
The number of ro ws to display per page.
The time when the message was logged.
The login name of the related user.
The owner of this user.
The system log message.
Ahsay Systems Corporation Limited 176
Ahsay Offsite Backup Server
Administrator’s Guide
21.2 Reviewing Backup Log
When you click the [Manage Log] -> [Backup Log] link availa menu, the [Backup Log] panel will appe ble at the top ar. It lists all backup jobs run on a particular date. You can review the backup jobs run on any particular date by selecting the required date from the drop down list.
Key
Date
Description
The date when all backup jobs listed below were run.
Backup Time Start and end time of this backup job.
Login Nam
Job Numbe
Owner e > Backup Account that ran this backup job. t r
Owner of this backup user.
Client Version The AhsayOBM/AhsayACB version number that this backup user is using.
Upload Size
Status
Size of backup data uploaded.
Overall status of the backup job.
177 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
21.3 Reviewing Restored File Log
When you click the [Manage Log] -> [Restored File] link availa menu, the [Restore Log] panel will appear. It lists all online f ble at the top ile restoration activiti es logged within a date. You can review online file restoration activities recorded on any particular date by selecting the required date from the drop down list.
Key
Date
Restore Time
Login Name
Owner
Size
IP
Description
The date when all online file restoration were recorded.
Start and end time of file restoration a ctivities.
Backup account restoring files from the server.
The owner of this backup user.
Total backup data restored from the server.
IP address to where backup data were restored.
Ahsay Systems Corporation Limited 178
Ahsay Offsite Backup Server
Administrator’s Guide
21.4 Reviewing Backup Error log
When you click the [Manage Log] -> [Backup Error] link availa menu, the [Backup Error] panel will appear. It lists all back ble at the top up errors or warning lo gged within a date. You can review backup errors or warnings logged on any particular date by selecting the required date from the dropdown list.
Key
Date
Timestamp
Login Name
Description
The date when all messages were logged.
The time when this message was logged.
Backup account raising this error or warning.
Owner The owner of this backup user.
Errors/Warnings Details of the error or warning recorded.
Ahsay Systems Corporation Limited 179
Ahsay Offsite Backup Server
Administrator’s Guide
21.5 Reviewing Replication Log
When you click [Manage Log] -> [Replication Log] link availa menu, the [Replication Log] panel will appear. It lists all re ble at the top plication activities logged within a date. You can review the replication activities recorded on any particular date by selecting the required date from the drop down list.
Key
Date
Rows/Page
Timestamp
Message
Description
The date when the replication activities were logged.
The number of rows to display per page.
The time when the replication was displayed.
Details of the activities.
Ahsay Systems Corporation Limited 180
Ahsay Offsite Backup Server
Administrator’s Guide
21.6 Reviewing Advertisement Log
When you click the [Manage Log] -> [Advertisement Log] link a top menu, the [Advertisement Log] panel will appear. It vailable at the
lists all the advertisements displayed by Ah sayOBM/AhsayACB clients for a particular date. You can review displayed adverts on any particular date by selecting the required date from the dropdown list.
Key
Date
Rows/Page
Timestamp
Name
Type
User Name
Owner
Remote IP
URL
Description
The date when the displayed.
advertisements listed below were
T he number of rows to display per page.
T he time when the advertisement was displaye d.
The name of the advertisement.
Advertisement display types:
IMP – Impression, this adve rtisement was displayed.
HIT – Hit, this adve rtisement was displayed and the user clicked the advert to go to the target web page.
The user account name of the AhsayOBM/AhsayACB client.
The owner of this backup user.
The remote IP address of the AhsayOBM/AhsayACB client.
The target URL associated with this ad.
181 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
22
Branding AhsayOBM & AhsayACB
22.1 Customization Portal
The Ahsay Customization Portal ( http://partners.ahsay.com/ ) allows you to do the followings:
1. Buil ding custom installers fo r the followings Ahsay products:
AhsayOBS and AhsayRPS
AhsayACB and AhsayOBM
AhsayNCU (For AhsayOBS v5.5 or below)
2. Set the vendor name, supp ort email and URL to your own values.
3. Put your own company logo and other images int o the software.
4. Set the default backup server hostname, TCP port
(HTTP/HTTPS) to your own values . number and protocol
5. Hide/Show encrypting key checkbox in A hsayACB/AhsayOBM.
6. Hide/Show language selection list in AhsayACB/AhsayOBM.
7.
Hide/Show the backup server URL textbox.
8. Set the default l anguage for AhsayACB/AhsayOBM.
9. Enable/Disable languages for AhsayACB/AhsayOBM.
10. Enable/Disable user account profile update from AhsayACB/AhsayOBM.
11. Customize the terms of u
AhsayACB/AhsayOBM. se statements shown in the installer of
Once you have made all the customization you want, you can download a customized version of AhsayOBSR / AhsayACB / AhsayOBM / AhsayNCU from the download page (shown below) of the customization portal.
Please refer to the Ahsay Customization Portal User Guide from the Ahsay
Customization Portal for more information.
Ahsay Systems Corporation Limited 182
Ahsay Offsite Backup Server
Administrator’s Guide
23
Branding AhsayOBS
This chapter describes how you can customize AhsayOBS to make it look the way you want it to be .
23.1 Welcome Page
If you would like to use your own welcome page on the backup server, simply e
%OBSR_HOME%\webapps\ROOT\index.html, with your come page,
own welcome page.
23.2 Different welcome pages for different domains
If you wan n t to show different welcome pages for req ames, please do the followings: uests to different domain
1.
Rename %OBSR_HOME%\webapps\ROOT\index.htm
%OBSR_HOME%\webapps\ROOT\index_defaultDomain.htm
l l to
2. Create %OBSR_HOME%\webapps\ROOT\index.jsp with the following content. Suppose you have 4 domains
AhsayOBS using the d
“in in total. If you want requests to omain name “domain2.com” to see dex_Domain2.html” and request to AhsayOBS using the domain name “domain3.com” to see “index_Domain3.html”, y highlighted code below. ou should put the
%OBSR_HOME%\webapps\ROOT\index.jsp
<%@ page language="java" %>
<% --
If y ou want to redirect request from different domains
index pages, please modify the "domai
to different n to URL mapping" defined by the
String array declaration below to d efine your own mapping.
--%>
<%
String sURL = "index_defaultDomain
.html";
String sRequestURL request.getRequestURL().toString().toLowerCase();
String[] asMap = {
"domain2.com", "index_Domain2.html",
"domain3.com", "index_Domain3.html",
};
for(int i=0; asMap!=null && i<asMap.length; i+=2) {
String sDomain = asMap[i].toLowerCase();
if(sRequestURL.indexOf(sDomain)!=-1) {
sURL=asMap[i+1];
=
183 Ahsay Systems Corporation Limited
break;
}
} response.sendRedirect(sURL);
%>
Ahsay Offsite Backup Server
Administrator’s Guide
Please note that you need to create both the “index_Domain2.html” and
“index_Domain3.html” yourself and
%OBSR_HOME%\webapps\ROOT directory. place it in the
23.3 Customizing th e company logo displayed
Two different logos are displayed on the bottom left hand corner and bottom right hand corner of every page.
Y b ou can customize the logos shown on the bottom left hand corner and ottom right hand corner of every page by:
the
1. Go to %OBSR_HOME%\webapps\obs\logo
2. To display your image at the bottom left hand corner of every page, simply save your image as “default.small.left.gif” in the directory above.
3. To display your image at the bottom right hand corner of every page, simply save your image as “default.small.right.gif” in the directory above.
184 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
4.
If you do not want to display any images at these
“empty.gif” to “default.small
locations, just rename
.left.gif” or “default.small.right.gif”.
Different logos for different domain names
If you are mapping both domain www.company-A.com
and domain www.company-B.com
to the IP address of the AhsayOBS and you want to display different logos when users are browsing the w eb pages using different domain names, you can archieve that by the use of Reseller Panel feature:
1. Logon to AhsayOBS with the system admin role system use r.
2.
Go to [Manage S ystem User] -> [Add System User] to create two subadmin role system user account, 1 for www.company-A.com
www.company-B.com
.
and
3. Logoff from AhsayOBS.
4. Logon with the Sub-Admin role system account of www.company-A.com
.
5. Go to [Manage System User] -> [My Profile] page to download the default customization file by clickin on the “default customi link. zation file”
6. Unzip the zip file to a temporary direct ory and go to “gif” directory inside.
7. Replace small.right.gif and small.left.gif with the com pany logo of www.company-A.com
.
8. Zip all the customized files with the name custom.zip.
9. On the [My Profile] page, check the [Customize Interface] checkbox.
10. Upload the custom.zip to the AhsayOBS by clicki non the [Browse] button and select the custom.zip file in the dialog.
11. Click the [Update] button to apply the change. This change should be applied to the AhsayOBS immediately.
12. Repeat the Step 4 - 11 for www.company-B.com
.
Ahsay Systems Corporation Limited 185
Ahsay Offsite Backup Server
Administrator’s Guide
23.4 Customizing the Look and Feel of the web interface
The Look and Feel (e.g. font size and color) of the web interfac is defined by a set of rules defined customize the Look and Feel of the web interface to fully integrate AhsayOBS into your website, you can do the followings: e of AhsayOBS
in a cascade style sheet. If you want to
1. Open %OBSR_HOME%\webapps\obs\jsp\lib\jsp_*.css (e.g. sv=Swedish, zh_TW=Traditional_Chinese, zh_CN=Simiplif etc ). en=English, fr=French, cs=Czech, da=Danish, nl=Dutch, de=German, es=Spanish, ied_Chinese
2. Make the changes to the cascade style sheet file to to see.
what you would like
For example, if you want to change the English user menu bar from yellowish color (#FFCC00) to red color. Ple ase do the followings:
Extract of jsp_en.css (Original)
…
.
/* menu bar - background color; text color, weight */
.usermenu_menubar {
}
…
.
#FFCC00;
color: normal
Extract of jsp_en.css (Updated)
…
.
/* menu bar - background color ; text color, weight */
.usermenu_menubar {
background-color:
color: normal
}
…
.
#000000
font-weight:
3. Restart your browser to see the changes.
Ahsay Systems Corporation Limited 186
Ahsay Offsite Backup Server
Administrator’s Guide
23.5 Customizing all text of the web interface
All text displayed on the web interface of AhsayOBS is stored in properties files. If you want to modify any of the text information on the web interface, p lease do the followings:
1. Connect to Ahsay Customizatio n Portal.
2. Go to [Step 1 – Customize Properties].
3. Select “OBS – Web Interface” on the customize properties page.
4. Modify the entries that you wan t to customize.
5.
Press the [Generate and Download All Properties] button to download the customized properties files.
6. Unzip the file downloaded in previous ste p.
7. Copy the generated jsp_*.properties files found in properties.zip\custom-obsr\ app\common\webapps\obs\WEB-INF\classes to %OBSR_HOME%\webapps\obs\WEB-INF\classes.
8. Restart AhsayOBS backup services to apply the changes.
23.6 Customizing email reports
The instructions of customizing all text in all outgoing email reports is the same as the instruction of customizing all text displayed
S imply do this:
on the web interface.
1. Go to Ahsay Customization Portal (AhsayACP).
2. Click on [Step 1. Customize Properties].
3. Select [OBS – Web Interface] from the group drop down men u.
4. Modify the “jsp.report.*” entries that you would like to cusotmize.
5. Press the [Generate and Download All Prop erties] button to download the customized properties files.
6. Unzip the file downloaded in previous step.
7. Copy the generated jsp_*.properties files found in properties.zip\custom-obs\app\common\webapps\obs\WEB-INF\classes to %OBSR_HOME%\webapps\obs\WEB-INF\classes
8. Restart AhsayOBS backup services to apply the changes.
If you are interested in displaying your own logo in all out-going email reports, simply replace %OBSR_HOME%\webapps\obs\logo\default.large.gif
Ahsay Systems Corporation Limited 187
Ahsay Offsite Backup Server
Administrator’s Guide with your own logo. All email reports will carry your customized logo. sent after you have made the changes
23.7 Localizing the software
It is currently possible to have Ah sayOBS localized to another language without the assistance of your development team. The list of supported languages is attached in the appendix section.
If you would like to have AhsayOBS available in languages other than those currently supported, please feel free to contact us to discuss possible arrangement.
Ahsay Systems Corporation Limited 188
Ahsay Offsite Backup Server
Administrator’s Guide
24
Advanced Configuration
The default installation of AhsayOBS setup a typical environme backup server but it is still possible that the de nt to run your fault setting does not fit well s all supported customizations pecial needs.
24.1 Listening to non-standard TCP/IP Port
If you like to run your own web server, or some other services using port 80 a nd 433, on your backup server, yo u can change the listening TCP/IP port of
AhsayOBS from port 80 and 443 to some other port numbers by:
1. Open %OBSR_HOME%\conf\ser ver.xml
Server.xml
<Server p ort="8014" shutdown="SHUTDOWN" debug="0">
<Service name="Tomcat-Standalone">
<!-- Define a non-SSL HTTP/1.1 Conne ctor on port 80 -->
<Connector className="or g.apache.coyote.tomcat5.CoyoteConnector"
address="0.0.0.0" port=" maxKeepAliveRequests="1"
m
80
" maxHttpHeaderSiz axThreads="1000" minSpareThreads=" 25" e="8192" maxSpareThreads="100"
enableLookups="false" redirectPort="443" bu fferSize="32768" acceptCount="1000"
connectionTimeout="600000" dis ableUploadTimeout="true"/>
<!-- Define a SSL HTTP/1.1 Connector on port 443 --
<Conn ector className="org.apache.coyote.tomcat5.CoyoteConn
address="0.0.0.0" port="
443
maxKeepAliveRequests="1"
maxThreads="1000" minSpareThreads="25"
> ector"
" maxHttpHeaderSize="8192" maxSpareThreads="100"
enableLookups="false" disableUploadTimeout="tr ue"
acceptCount="1000" bufferSize="32768" scheme="https " secure="true"
keystoreFile="conf/keystore" keystorePass="changeit"
clientAuth="false" sslProtocol="TLS" connectionTimeout="600000"/>
2. Change the [port] values (shown in red and bold above) to the preferred port numbers. For example, to change the HTTP port from port 80 to
189 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
8080 and HTTPS port from port 443 to port 8443, please do the followings: port=”80” -> port=”8080” redirectPort=”443” -
> redirectPort=”8443” port=”443” -> port “8443”
3.
Restart AhsayOBS.
4.
Logon the System Management Console.
24.2 Listening to a single IP address
If the backup server has more than one network interface in more than one IP address bind to a single network interf configure AhsayO default the TCP port of all IP addre stalled or has ace, you can
BS to use only a single IP address for backup services (by sses available within the system are used and open). This ha s the benefits of sparing other IP addresses for other applications, e.g. Apache Web Server or Microsoft Intern et Information
Se rver (IIS). To do so,
1.
Open %OBSR_HOME%\conf\server.xml
server.xml
<Server port="8014" shutdown="SHUTDOWN" debug
<Service name="Tomcat-Standalone">
="0">
<!-- Define a non-SSL HTTP/1.1 Connector on port 80 -->
<Connector className="org.apache.coyote.tomcat5.CoyoteConnector
address="
0.0.0.0
" port="80" maxHtt maxKeepA liveRequests="1"
maxThreads="1000" minSpareThreads ="25"
" pHeaderSize="8192" maxSpareThreads="100"
enableLookups="false" redirectPo
0" rt="443" bufferSize="32768" acceptCount="100
connectionTimeout="600000" disableUp loadTimeout="true"/>
<!-- Define a SSL HTTP/1.1 Connector on port 443 -->
<Connector className="org.apache.coyote.tomcat5.CoyoteConnector"
address="
0.0.0.0
" port="443" maxHttpHeaderSize="8192" maxKeepAliveRequests="1"
maxThreads="1000" minSpareThreads="25" maxSpareThreads="100"
enableLookups="false" disableUploadTimeout="true"
acceptCount="1000" bufferSize="32768" scheme="https" secure="true"
keystoreFile="conf/keystore" keystorePass="changeit"
190 Ahsay Systems Corporation Limited
clientAuth="false" sslProtocol="TLS" connectionTimeout="600000"/>
Ahsay Offsite Backup Server
Administrator’s Guide
2.
Change the [address] values (shown in red and bold ab addresses that are to be used for AhsayOBS. For ex the IP address, 192.168.1.1, for ba from “0.0.0.0” (means all available ove) to the IP ample, to use only ckup services, change address values
IP addresses) to “192.168.1.1”. address=”0.0.0.0” -> address=”192.168.1.1”
3. Restart AhsayOBS.
If you are going to use IIS along with AhsayOBS on different IP addresses as mentioned here, please make sure that you have configured IIS to spare the
IP address configured above to be used by AhsayOBS ( by default IIS will use all the IP addresses available). Failing to do so will resu both IIS and AhsayOBS at the same time. lt in failing to start
e by IP address
F or better security, you can restrict access to the system administration console by IP addresses. To do so, please do the followings:
1. Open %OBSR_HOME%\webapps\obs\WEB-INF\web.xml.
2.
Locate the SystemConsole filter under “filter” se ction near the beginning of “web.xm
l”.
web.xml
…
.
<filter>
<filter-name>SystemConsole</filter-name>
<filter-class>com.ahsay.obs.www.IPFilter</filter-class>
<in it-param>
<param-name>Range1</param-name>
<param-value>localhost</param-value>
</init-param>
<init-param>
<param-name>Range2</param-name>
<param-value>
0.0.0.0-255.255.255.255
</param-value>
</init-param>
</filter>
…
.
3. Change the “Range2” parameter value from “127.0.0.1-127.0.0.1”
(shown in red and bold above) to a range of IP addresses from where access to the system administration console is allowed.
Ahsay Systems Corporation Limited 191
Ahsay Offsite Backup Server
Administrator’s Guide
For example, changing [Range2] value from “127.0.0.1-
“192.168.1
127.0.0.1” to
.1-192.168.1.255” to allow the 192.168.1.x network to invoke the APIs .
web.xml (Updated)
…
.
<filter>
<filter-name>SystemConsole</filter-name>
<filter-class>com.ahsay.obs.www
.IPFilter</filter-class>
<init-para m>
<param-name>Range1</param-name>
<param-value>localhost</param-value>
</init-pa ram>
<in it-param>
<param-name>Range2</param-name>
<param-value>192.168.1.1-192.168.1.255</param-va
</init-param>
</filter>
…
. lue>
Please note that you can configure more than one additional init parameters (i.e. “Range3”, “Ra filter XML tag. For example:
IP range by adding nge4” and so do) to the
<filter>
<filter-name>SystemConsole</filter-n ame>
<filter-class>com.ahsay.obs.www.IPFilter</filter -class>
<init-para
<param
<in it-para
<paramm>
-name>Range1</param-name>
<param-value>localhost</par
</init-param> m>
<param-name>
</init-param> am-value>
Range2</param-name> value>192.168.1.1-192.168.1.255</param-value>
<init-param>
<param-name>Range3</param-name>
<param-value>192.168.2.1-192.168.2.255</param-value>
</init-param>
</filter>
4. Restart AhsayOBS.
Ahsay Systems Corporation Limited 192
25
External API References
Ahsay Offsite Backup Server
Administrator’s Guide
AhsayOBS contains a set of APIs (Application Programming Interfa allows you to integrate external applicat ce), which ions (e.g. billing system or automated registration system) with AhsayOBS. This chapter describes what
APIs are available and how you can invoke different APIs.
You can find more information on processing XML using JAVA at http://java.sun
.com/xml .
25.1 Overview
AhsayOBS APIs can be invoked by us ing standard HTTP request method (i.e. either POST or GET). For example, to invoke the [Remove User] API, simply use any programming /scripting languages of your choic e to invoke: http://BACKUP_SERVER/obs/api/RemoveUser.do?SysUser=syst em&SysPwd= system&LoginName=test to delete user “test”.
URL encoding must be applied to all non-alphanumeric para submitting the API requests as specified in the HTTP protocol meters when
specification.
For example, a value of “GMT-08:00 (PSL)” must submit to A hsayOBS as
“GMT%2d08%3a00+%28PST%29” via external API.
Since 6.11.0.0, A PI has extended the access permission from system user only to users with administr
“
SysUser and SysPwd are
Admin”. ative role. All the API with the parameters referring to the system users with the role set to
25.2 Limitations
Here is the limitation for using API:
Currently, API only supports modifications related to bac kup users or backup user groups.
25.3 IP Restrictions
To avoid AhsayOBS’s APIs from being exploited by hackers from an unauthorized network, AhsayOBS, by default, accepts and handles only the
API requests originating from the same local machine. To loosen this restriction, please do the followings:
1. Open %OBSR_HOME%\webapps\obs\WEB-INF\web.xml.
2. Locate the ApiAccess filter under the “filter” section.
Ahsay Systems Corporation Limited 193
Ahsay Offsite Backup Server
Administrator’s Guide
3. Change the [Range2] parameter value from “0.0.0.0-255
(shown in red and b where APIs can be invoked.
.255.255.255” old above) to another range of IP addresses from
web.xml
…
<filter>
<filter-name>ApiAccess</filter-name>
<filter-class>com.ahsay.obs.www
m>
.IPFilter</filter-class>
<init-para
<param-name>Range1</param-name>
<param-value>localhost</param-value>
</init-pa
<in ram> it-param>
<param-name>Range2</param-name>
<param-value>
0.0.0.0-255.255.255.255
</param-value>
</init-param>
</filter>
…
For example, changing [Range2] value from “0.0.0.0-255.255.255.255” to “192.168.1.1-192.168.1.255” to allow the 192.168.1.x network to invoke the APIs.
web.xml (Updated)
…
<filter>
<filter-name>ApiAccess</filter-name>
<filter-class>com.ahsay.obs.www.IPFilter</filter-cl
<init-para
<p m> aram-name>Range1</param-name> ass>
<param-value>localhost</param-value>
</init-param>
<init-param>
<param-name>Range2</param-name>
168.1.1-192.168.1.255
</param-value> <param-value>
192.
</init-param>
</fi
… lter>
Please note that you can configure more than two IP ranges by adding additional init parameters (i.e. “Range3”, “Range4” and so on) to the filter XML tag. For example:
…
.
<filter>
<filter-name>ApiAccess</filter-name>
<filter-class>com.ahsay.obs.www.IPFilter</filter-class>
<init-param>
Ahsay Systems Corporation Limited 194
Ahsay Offsite Backup Server
Administrator’s Guide
<param-name>Range1</param
<param
-name>
-value>localhost</param-value>
</init-param>
<init-param>
<param
<param-value> 192.168.1.1-19
<init-para
<p
-name>Range2</param-name>
</init-param> m>
2.168.1.255
aram-name>Range3</param-name>
</param-value>
<param-value>192.168.2.1-192.168.2.255</param-value>
</init-param>
</filter>
…
.
4. Restart AhsayOBS.
Ahsay Systems Corporation Limited 195
Ahsay Offsite Backup Server
Administrator’s Guide
25.4 User Authorization
The following table describes all information required to invoke the [Auth
Use r] API to check whether an existing user is authorized.
URL:
http://BACKUP_SERVER/obs/api/AuthUser.do
Available since
Pre-v6.0
Parameters:
Key
SysUser
SysPwd
LoginName
Owner
Password
Host
Value Descriptions
St ring AhsayOBS’s system users w ince 6.11.0.0) ith admin role
(modified s
String AhsayOBS’s system users password with
String
String admin role (modified since 6.1
1.0.0)
Login name of the user
Owner of backup user
If parameter “Owner” is empty, the ba not used or ckup user is created by system admin.
If parameter “Owner” is used and valid,
String the backup user is created by the specified sub-admin.
Login password of the user
String (Optional : Use with AhsayRDR Only)
AhsayOBS’s URL
Return Value:
If successful, returns <OK/>
If there is an error, returns <err>%ERROR_MESSAGE%</err> i. Login name does not exist or incorrect login name
<err>[UserCacheManager.NoSuchUse
rExpt] User '%USER_NAME%' not found.</err>
ii. Incorrect user password specified
<err>[UserCacheManager.PasswordIncorrectExpt] Incorrect password for user '%USER_NAME%'.</err>
iii. Incorrect system username and or password
<err>Incorrect system username/password</err>
Example:
196 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
To verify the a user with user name “test” and password “abc” http://BACKUP_S ERVER/obs/ap i/AuthUser.do?SysUser=system&SysPwd=s ystem&LoginName=test&Password=abc
Example for AhsayRDR:
To verify the a user with user name “test” and password “a bc” http://REDIRECTOR_SERVER/rdr/api/AuthUser.do?SysUser=system&SysP wd=system&LoginName=test&Password=abc&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 197
Ahsay Offsite Backup Server
Administrator’s Guide
25.5 Adding User
The following table describes all information required to invoke
API to add a new us the [Add User] er to AhsayOBS. For using this API with AhsayRDR, new backup user will be added to first user home defined in AhsayOBS user homes settings by default.
URL:
http://BACKUP_SERVER/obs/api/AddUser.do
Available since v ersio n:
Pre-v6.0
Parameters:
Key
SysUser
SysPwd
LoginName
Owner
Value
String
St ring
String
Descriptions
St ring AhsayOBS’s system users with admin role (modified since 6.11.0.0)
AhsayOBS’s system users pa admin role (modified since 6
New user’s login Name ssword with
.11.0.0)
Owner of new backup user
If parameter “Owner” is empty, th system ad min. not used or e backup user is created by
Language
Type
If par ameter “Owner” is used and valid, the backup user is specified sub-admin.
New user’s password created by the
Password
Alias
AdGroup
String
St ring
String
New user’s alias
New user’s language
New user’s type
St ring Advertisement group. { A LL | NONE |
Nu
<ADGROUP_ID> } mber New user’s quota, e.g. 10 4857600 (for Quota
UserHome t
100MB)
S ring e for the new user
It can be any one of the co nfigured user home. E.g. C:\Program Files\AhsayOBS and AhsayRPS\user
First available user home w not given ill be allocated when UserHome is emptied or
EnableMSSQL Boolean Whether to enable Microsoft SQL Server module for the new user. { Y | N }
EnableMSExchange Boolean Whether to enable Microsoft Exchange
Server module for the new user. { Y |
N }
MsExchangeQuota Number The number of Microsoft Exchange
Server allowed for the new user (added
198 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
EnableOracle since v6.11.0.0) o Whether to enable Oracle m new user. { Y | N } odule for the
EnableLotusNot es o Notes module
EnableLotusDom for the new us er.{ Y | N } o Whether to enable Lotus D omino module
EnableMySQL o for the new user. { Y | N }
B olean Whether to enable MySQL modul new user. { Y | N } e for the
EnableInFileDelta Bo olean Whether to en able In-File Delta Module for the new user. { Y | N }
EnableShadowCopy Bo olean Whether to enable Shadow Copy module for the new user. { Y | N }
EnableExchangeMail box
Bo olean Whether to enable Brick Le
Exch
N } vel Microsoft ange module for the new user. { Y |
EnableCDP Bo olean Whether to enable Con
Protection (CDP) module fo user. { Y | N } tinuous Data r the new
EnableShadowProtec Bo tBareMetal olean Whether to ena ble StorageCraft Shadow
Protect module for the new
N } (added since v5.5.5.0)
user. { Y |
EnableWinServer20
08BareMetal
Bo olean Whether to enable Windows bare metal module for the
| N } (added since v5.5.5.0
Server 2008 new user. { Y
)
ExchangeMailboxQu Nu ota mber The number of Microsoft Exchange mailboxes allowed for the n ew user
EnableNASClient Bo olean Whether to enable Ah sayOBM JVM
Royalty for the new user. { Y | N }
EnableDeltaMerge Bo olean Whether to enable Enab le Delta Merge module for the new user
(added since v6.3.0.0)
. { Y | N }
EnableMsVm B olean Whether to enable HyperV the new user. { Y | N } v6.3.0.0)
module for
(added since
MsVmQuota
EnableVMware
Nu mber The number of H yperV Guest VM allowed for the new user (added sin ce v6.3.0.0)
Bo olean Whether to enable VMwar the new user v6.3.0.0) e module for
. { Y | N } (added since
VMwareQuota
Contact
Number The number of VMware Guest VM allowed for the new user (added since v6.3.0.0)
String Extra contact name. (Max: 9)
Notes: There can be more than one extra name added, extra contact name must be in pair with extra email
String Extra contact e-mail. (Max: 9)
Ahsay Systems Corporation Limited 199
Ahsay Offsite Backup Server
Administrator’s Guide
Timezone String
Notes: There can be more t email added. Extra contac be in pair with extra contac han one extra t email must t name.
New User’s time zone setting. It has to be either one of the followin g entries:
Please make sure the parameter is properly URL en cod ed. E.g. GMT-08:00
(PST) =>
GMT%2d08% 3a00+%28PST%29
Bandwidth Nu mber 0 = Unlimited Bandwidth
Notes String
SendWelcomeM ail
SuspendPaidUser
SuspendPaidUse e
Replicated rDat
St ring New user’s conta ct email o { Y | N }
Bo olea
St ring
Boo n lean
{ Y | N }
A date in yyyy-MM-dd forma t
Whether to replicate the new
N }
user. { Y |
Host
ClientType
Return Value:
String (Optional: Use with AhsayRDR Only)
AhsayOBS’s URL
String Type of client application {OBM | ACB}
If successful, returns <OK/>
If there is an error, returns <err>%ERROR_MESSAGE%</err>
Example:
http://BACKUP_SERVER/obs/api/AddUser.do?SysUser=system&SysPwd=sy stem&LoginName=test&Password=abc&Alias=Testing&Language=en&Emai l=abc%40abc%2Ecom&Type=PAID&Quota=100000&UserHome=E%3A%5
C&EnableMSSQL=Y&EnableMSExchange=Y&EnableOracle=Y&EnableLotusN otes=Y&EnableLotusDomino=Y&EnableMySQL=Y&EnableInFileDelta=Y&En ableShadowCopy=Y&EnableCDP=Y&EnableShadowProtectBareMetal=Y&En ableWinServer2008BareMetal=Y&EnableDeltaMerge=Y&EnableMsVm=Y&
MsVmQuota=10&EnableVMware=Y&VMwareQuota=10&Timezone=GMT%2 d08%3a00+%28PST%29&Contact1=john&Email1=john%40someDomain
%2Ecom&Contact2=paul&Email2=paul%40anotherDomain%2Ecom&Enabl eExchangeMailbox=Y&ExchangeMailboxQuota=10&ClientType=OBM
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/AddUser.do?SysUser=system&SysPw d=system&LoginName=test&Password=abc&Alias=Testing&Language=en&
Email=abc%40abc%2Ecom&Type=PAID&Quota=100000&UserHome=E%3
A%5C&EnableMSSQL=Y&EnableMSExchange=Y&EnableOracle=Y&EnableLo tusNotes=Y&EnableLotusDomino=Y&EnableMySQL=Y&EnableInFileDelta=Y
&EnableShadowCopy=Y&EnableCDP=Y&EnableShadowProtectBareMetal=Y
&EnableWinServer2008BareMetal=Y&EnableDeltaMerge=Y&EnableMsVm=Y
&MsVmQuota=10&EnableVMware=Y&VMwareQuota=10&Timezone=GMT%
2d08%3a00+%28PST%29&Contact1=john&Email1=john%40someDomain
%2Ecom&Contact2=paul&Email2=paul%40anotherDomain%2Ecom&Enabl eExchangeMailbox=Y&ExchangeMailboxQuota=10&ClientType=OBM&Host=
Ahsay Systems Corporation Limited 200
Ahsay Offsite Backup Server
Administrator’s Guide obs.yourserver.com
25.6 Modifying User Profile
The following table describes all information required to invoke the [Modify
User] API to update a user’s profile in an AhsayOBS.
URL:
http://BACKUP_SERVER/obs/api/ModifyUser.do
Available since v ersio n:
Pre-v6.0
Parameters:
Key
SysUser
SysPwd
Value
St ring
St ring
Descriptions
AhsayO BS’s system users with admin role (modif ied since 6.11.0.0)
AhsayOBS’s system users p admin role (modified since 6 assword with
.11.0.0)
Owner
Password
Alias
Language
Type
ClientType
AdGroup
Quota
String
St ring
String
St ring
Owner of backup user
If parameter “Owner” is empty, th system admin. not used or e backup user is created by
If parameter “Owner” is used the backup user is cre specif ied sub-admin. and valid, ated by the
New user’s passwor d
New user’s alias
New user’s language
String
String
Please refer to Appendix A for the list of available languages.
New user’s type
New user’s Client Type
St
Nu ring Advertisement group. { A LL | NONE |
<ADGROUP_ID> } mber New user’s quota, e.g. 10
100MB)
4857600 (for
UserHome St ring User Home to use for the us er (must be one of the configured user home), e.g.
C:\Program Files\AhsayOBS and
AhsayRPS\user
The user status {ENABLE | SUSPENDED} Status String
EnableMSSQL Boolean Whether to enable Microsoft SQL Server module for the user. { Y | N }
EnableMSExchange Boolean Whether to enable Microsoft Exchange
Server module for the user. { Y | N }
MsExchangeQuota Number The number of MS Exchange Server
201 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
EnableOracle o allowed for the user (added since v6.11.0.0)
Whether to enable Oracle m user. { Y | N } odule for the
EnableLotusNot es o for the user. { Y | N }
Notes module
EnableLotusDom
EnableMySQL o Whether to enable Lotus D omino module for the user. { Y | N }
Bo olean Whether to enable MySQL module for the
EnableInFileDelta Bo user. { Y | N } olean Whether to enable In-File Delta Module for the user. { Y | N }
EnableShadowC o for the user. { Y | N }
Copy module
EnableExchangeMail Bo box olean
EnableCDP Bo
Whether to enable Brick Level Microsoft
Exchange module for the us olean Whether to enable Con
Protection (CDP) module
{ Y | N } er. { Y | N } tinuous Data for the user.
EnableShadowProtec Bo tBareMetal olean Whether to enable StorageCraft Shadow
Protect module for the use
(added since v5.5.5.0) r. { Y | N }
EnableWinServer20
08BareMetal o Whether to enable Window bare
(added since v5.5.5.0) s Server 2008 metal module for the user. { Y | N }
ExchangeMailboxQu Nu ota
EnableDeltaMerge mber The number of Microso mailboxes allowed for the u ft Exchange ser elta Merge
EnableMsVm module for the user. { Y since v6.3.0.0) the user. { Y | N } ( v6.3.0.0)
| N } (added
Bo olean Whether to enable HyperV m odule for added since
MsVmQuota
EnableVMware u The number of HyperV Gues for the user (added si t VM allowed nce v6.3.0.0)
B olean Whether to enable VMwar the user. { Y | N } v6.3.0.0) e module for
(added since
VMwareQuota Nu mber The number of VMware allowed for the v6.
3.0.0)
Guest VM new user (added since
EnableNASClient Boolean Whether to enable AhsayOBM JVM
Royalty for the new user. { Y | N }
AppendContact Boolean Append or remove contact according to the value { Y | N }. If Y is set, new contact will be appended while set to N will remove contact. Also refer to the notes section in the next 2 pages.
Contact1-9 String Extra contact name. (Max: 9)
Eg: Contact1
Ahsay Systems Corporation Limited 202
Ahsay Offsite Backup Server
Administrator’s Guide
Email1-9
AppendContact
OldContact1-9
NewContact1-9
Timezone
String
Bo olean Modify an existing contac the value { Y | N }. If Y i
OldContac availa t according to s set, and the t, NewContact info rmation is ble, the OldContact will replace the information with NewContact. Also refer to the notes section in the n ext 2 pages.
St ring Old contact. (Max: 9)
Eg: OldCon tact1
Notes: It is required to work with
AppendContact, also refer section in the next 2 pages.
to the notes
St ring
String
Notes: There can be more t name added, ext b e in pair with extra email. han one extra ra contact name must
Extra contact e-mail. (Max: 9)
Eg: Email1
Notes: There can be more t email added, extra contac han one extra t email must be in pair with extra contact na me.
New contact. (Max: 9)
Eg: NewContact1
Notes: It is required to work with
AppendContact, also refer to the notes section in the next 2 pages.
New User’s time zone setting. It has to be either one of the followin g entries:
Please make sure the parameter is properly URL encoded. E.g. GMT-08:00
Bandwidth
Notes
SuspendPaidUser
SuspendPaidUserDat e
(PST)
GMT%2d08%3a00+%28PST%29
=>
Please refer to Appendix B for the list of available timezone.
Number 0 = Unlimited Bandwidth
String Notes for the user.
String
String
Whether to suspend paid user { Y | N }
A date in yyyy-MM-dd format
Replicated
Host
Boolean Whether to replicate the user. { Y | N }
String (Optional: Use with AhsayRDR Only)
AhsayOBS’s URL
Return Value:
If successful, returns <OK/>
If there is an error, returns <err>%ERROR_MESSAGE%</err>
Example:
203 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
http://BACKUP_SERVER/obs/api/ModifyUser.do?SysUser=sy
=system&LoginName=test&Password=abc&Alias=Testing&Lan ype=PAID&Status=ENABLE&Quota=100000&UserHome=E%
MSSQL=Y&EnableMSExchange=Y&MsExchangeQuota=1&En
EnableLotusNotes=Y&EnableLotusDomino=Y&EnableMySQL= eDelta=Y&EnableShadowCopy=Y&EnableCDP=Y&EnableSha eMetal=Y&EnableWinServer2008BareMetal=Y&EnableDeltaM eMsVm=Y&MsVmQuota=10&EnableVMware=Y&VMwareQuo stem&SysPwd guage=en&T
3A5C&Enable ableOracle=Y&
Y&EnableInFil dowProtectBar erge=Y&Enabl ta=10&Append
Contact=Y&Conta ct1=john.john&Email1=john.john%40someDomain%2Ec om&Contact2=paul&Email2=paul%40anotherDomain%2Eco m&EnableExch angeMailbox=Y&ExchangeMailboxQuota=10&ClientType=OB M
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/ModifyUser.do?SysUse
Pwd=system&LoginName=test&Password=abc&Alias=Testin n&Type=PAID&Status=ENABLE&Quota=100000&UserHome nableMSSQL=Y&EnableMSExchange=Y&MsExchangeQuota= e=Y&EnableLotusNotes=Y&EnableLotusDomino=Y&EnableM eInFileDelta=Y&EnableShadowCopy=Y&EnableCDP=Y&Enabl r=system&Sys g&Language=e
=E%3A%5C&E
1&EnableOracl ySQL=Y&Enabl eShadowProte ctBareMetal=Y &EnableWinServer2008BareMetal=Y&EnableDeltaMerge=Y&
EnableMsVm=Y&MsVmQuota=10&EnableVMware=Y&VMwareQuota=10&Ap pendContact=Y&Contact1=john.john& Email1=john.john%40someDomain
%2Ecom&Contact2=paul&Email2=paul%40anotherDomain% 2Ecom&Enabl eExchangeMailbox=Y&ExchangeMailboxQuota=10&ClientType= obs.yourserver.com
OBM&Host=
Notes about the “AppendContact” parameter:
Set "AppendContact=Y" would add new contacts to the user, the existing contacts untouched. Th while keeping e parameters "ContactX" and "EmailX" (X
= 1,2,3,..., e.g. "Contact1" and "Email1") would also need to be involved in the API call in order to define the new contacts.
Disregarding the number of e and xisting contacts in the user profile, "Contact1"
"Email1" are always used in the API call to add the first new contact to the user. "ContactX" and "Ema ilX" (X = 2,3,4,...) could also be configured afterwards in sequence in the same API call.
If the new contact information defin would be added to the user profi le. ed in "ContactX" and "EmailX" are identical to the existing contacts in the user profile, no duplic ate contacts
Case 1:
If user "admin" has 2 existing contacts:
1. Name: John Email: [email protected]
2. Name: Peter Email: [email protected]
Add a new contact "Mary / [email protected]" and "Jane / [email protected]" to "admin" user.
Ahsay Systems Corporation Limited 204
Ahsay Offsite Backup Server
Administrator’s Guide http://BACKUP_SERVER/obs/api/ModifyUser.do?SysUser=syst em&SysPwd=s ystem&LoginName=admin &AppendContact=Y&Contact1=Mary&Email1=ma
[email protected]&Contact2=Jane&Email2=ja [email protected]
As a result 4 contacts are available in
the admin user account.
1. Name: John Email: john@backup va
2. Name: Peter Email: peter@backup ult.com vault.com
3. Name: Mary Email: [email protected]
4. Name: Jane Email: [email protected]
Set "AppendContact=N" would remove all the existing contacts in the user profile. "AppendContact=N" could be used alone with no "C
"EmailX" parameters defined in the API call. In such case, a contacts in the user profile are deleted. ontactX" and ll the existing
Meanwhile, by calling "AppendContact=N" with "ContactX" defined, the API call would remove all the existing contacts in t and add the new contacts defined in "ContactX" and "EmailX" to and "EmailX" he user profile
the user.
As a result, by configuring "AppendContact=N" with "ContactX" and "EmailX" define d, while "ContactX" and "EmailX" containing the identical contact information as the existing contacts in the user profile, the API call would keep the "ContactX" and "EmailX" defined in the API call undelete d and remove all other contacts.
Case 2a:
Base on the result in case 1, existing contacts can be removed by the ing API in the “admin” user account. follow http://BACKUP_SERVER/obs/api/ModifyUser.do?SysUser=system &SysPwd=s ystem&LoginName=admin&AppendContact=N
As a result, no more contacts remained.
Case 2b:
Base on the result in case 1, replace the existing contact1 “John / [email protected]
” with “Tom / [email protected]
” in the admin user account, and remove other contacts. http://BACKUP_SERVER/obs/api/ModifyUser.do?SysUser=system&SysPwd=s ystem&LoginName=admin&AppendContact=N&Contact1=Tom&Email1=tom
@backupvault.com
205 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Notes about the “ChangeContact” parameter:
The usage is similar to Case 2b in the previous notes, the “ChangeCo ntact” option can replace an existing contact (OldContact) with a new contact information (NewContact).
For example:
Replace the existing contact1 “John / [email protected]
” with “Tom / tom @backupvault.com
” in the admin user account. http://BACKUP_SERVER/obs/api/ModifyUser.do?SysUser=system&SysPwd=s ystem&LoginName=admin&ChangeContact=Y&OldContact1=John&Email1=j
[email protected]&NewContact1=Tom&Email1=[email protected]
om
Ahsay Systems Corporation Limited 206
Ahsay Offsite Backup Server
Administrator’s Guide
25.7 Deleting User
The following table describes all information required to invoke the [Remove
User ] API to remove an existing user from an AhsayOBS.
URL:
http://BACKUP_SERVER/obs/api/RemoveUser.do
Available since
Pre-v6.0
Parameters:
Key
SysUser
SysPwd
LoginName
Owner
Host
Value Descriptions
St ring AhsayOBS’s system users w ince 6.11.0.0) ith admin role
(modified s
String AhsayOBS’s system users password with
String
String admin role (modified since 6.1
1.0.0)
Login name of the user
Owner of backup user
If parameter “Owner” is not used or empty, the backup user is created by system admin.
If parameter “Owner” is used and valid, the backup user is created by the specified sub-admin.
String (Optional: Use with AhsayRDR Only)
AhsayOBS’s URL
Return Value:
If successful, returns <OK/>
If there is an error, returns <er r>%ERROR_MESSAGE%</err> i. LoginName incorrect or does not exist
<err>[UserCacheManager.NoSuchUserExpt] User '%USER_ NAME%' not
found.</err> ii. Blank Login name specified
<err>[Error] Parameter LoginName is null/empty!</err>
Example:
http://BACKUP_SERVER/obs/api/RemoveUser.do?SysUser=system&SysPw d=system&LoginName=test
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/RemoveUser.do?SysUser=system&Sy sPwd=system&LoginName=test&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 207
Ahsay Offsite Backup Server
Administrator’s Guide
25.8 Listing Users
The following table describes all information required to invoke the [List Users]
AP I to get a list of all users available within AhsayOBS.
URL:
http://BACKUP_SERVER/obs/api/ListUsers.do
Available since
Pre-v6.0
Parameters:
Key
SysUser
SysPwd
ClientTypeOnly
Value
St
St ring ring
St ring
Descriptions
AhsayOBS’s system us ers with admin role
(modified since 6.11.0.0)
Ah sayOBS’s system users password with
LoginNameOnly St admin role (mo dified since 6.11.0.0) to display login nam es only
Whether to display client ty names only. pes and login
Owner St ring Owner of backup users
If parameter “Own er” is not used, all backup user accounts will be listed.
If parameter “Owner” is use all ba system d but empty, ckup users created by admin role
users will be listed.
If parameter “Owner” is used and valid, all backup users created by the specified system user (admin or sub admin) will be listed.
Host String
Return Value:
If successful, returns
<users>
<User LoginName="test1" Owner="" Alias="" UserT ype="PAID" ezone="GMT+08:00 (CST)" ClientType="OBM" Quota="10737418240" Tim
Language="en" DataFile="1" DataSize="15
RetainSize="0" EnableMSSQ
36" RetainFile="0"
L="Y" EnableMSExchange="Y"
EnableOracle="Y" EnableLotusNotes="Y" EnableLotusDomino="Y"
EnableMySQL="Y" EnableInFileDelta="Y" EnableShadowCopy="Y"
EnableExchangeMailbox="N" ExchangeMailboxQuota="0"
EnableNASClient="Y" EnableDeltaMerge="Y" EnableMsVm="N"
MsVmQuota="0" EnableVMware="N" VMwareQuota="0" Bandwidth="0"
Notes="" Status="ENABLE" RegistrationDate="1302687743242"
SuspendPaidUser="N" SuspendPaidUserDate="20140503"
LastBackupDate="1302699594652" EnableCDP="Y"
EnableShadowProtectBareMetal="Y"
Ahsay Systems Corporation Limited 208
Ahsay Offsite Backup Server
Administrator’s Guide
EnableWinServer2008BareMetal="Y"
Hostname="123.abc.com" FileSizeLim it="52428800"
Exclu deNetworkShare="Y"
><Contact Name=""Email="[email protected]"/>
</use
… r> sers> </u
If there is an err or, returns <err>%ERROR_MESSAGE%</err>
Where
LoginName = login name
Owner = user’s owner
Alias = user’s alias
UserType = user type { PAID | TRIAL }
ClientType = client type { OBM | ACB
Quota = quota in bytes
Timezone = user’s time zone
Language = user’s language
}
DataFile = total number of files in the data area
DataSize = total amount of bytes in th e data area etention area RetainFile = total number of files in the r
RetainSize = total amount of bytes in the re tention area
EnableMSSQL = MS SQL enabled { Y | N }
EnableMSExchange = MS Exchange Serv er enabled { Y | N }
MsExchangeQuota = MS Exchange Server q uota
EnableOracle = Oracle enabled { Y | N }
EnableLotusNotes = Lotus Notes enabled { Y | N
EnableLotusDomino = Lotus Domino enable
EnableMySQL = MySQL enabled { Y |
} d { Y | N }
N } lta enabled { Y | N } abled { Y | N }
EnableInFileDelta = In-file De
EnableShadowCopy = Shadow Copy en
EnableExchangeMailbox = MS E t = AhsayO xchange Mailbox enabled { Y | N }
BM JVM Royalty enabled { Y | N }
EnableNASClien
EnableDeltaMerge = Delta Merge enabled { Y |
ExchangeMailboxQuota = MS Exchange M
N } ailbox quota
EnableMsVm= HyperV module enable { Y | N }
MsVmQuota= HyperV Guest VM quota
EnableVMware= VMware module enable { Y | N }
VMwareQuota= VMware Guest VM quota
Bandwidth = user’s bandwidth
Notes = user’s notes
Status = status of user account { ENABLE | SUSPENDED }
RegistrationDate = registation date of user account
SuspendPaidUser = Status of the Paid User { Y | N }
SuspendPaidUserDate = Date t o suspend Paid User [yyyy-MM-dd]
LastBackupDate = Date of last backup [Unix time format in millisecond]
EnabledCDP = Continuous Data Protection (CDP) enabled { Y | N }
EnableShadowProtectBareMetal = ShadowProtectBareMetal enabled { Y |
N }
EnableWinServer2008BareMetal = WinServer2008BareMetal enabled { Y |
N }
209 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Hostname = host of backup user resides
FileS izeLimit = file size threshold in bytes
ExcludeNetworkShare = network shares exclusion { Y | N }
Example:
http://BACKUP_SERVER/obs/api/ListUsers.do?SysUser=system&SysPwd=s ystem http://BACKUP_SERVER/obs/api/ListUsers.do?SysUser=system&SysPwd=s ystem&Owner=testing
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/ListUsers.do?SysUser=system&SysPw d=system&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 210
25.9 Getting User Information
Ahsay Offsite Backup Server
Administrator’s Guide
The following table describes al
AP l information required to invoke the [Get User]
I to get a user’s account information.
URL:
http://BACKUP_SERVER/obs/api/GetUser.do
Available since
Pre-v6.0
Parameters:
Key
SysUser
SysPwd
LoginName
Owner
Host
Value
String
String
Descriptions
St ring AhsayOBS’s system us
(modified s ers with admin role ince 6.11.0.0)
String AhsayOBS’s system users password with admin role (modified since 6.1
1.0.0)
The user’s login name
Owner of backup user
If parameter “Owner” is not used or pty, the backup user is created by em system admin.
If parameter “Owner” is used and valid, the backup user is created by the specified sub-admin.
String (Optional: Use with Ah
AhsayOBS’s URL sayRDR Only)
Return Value:
If successful, returns
<User LoginName="test1" Alias="" UserType="PA
Status="ENABLE" Quota="10737418240" Timezone="GM
Language="en" DataFile="1" DataSize="1536" Re
RetainSize="0" UncompressedSize="0" Unco mpressedRetainSize="0"
EnableMSSQL="Y" EnableMSExchange="Y" Enable
ID" ClientType="OBM"
T+08:00 (CST)" tainFile="0"
Oracle="Y"
EnableLotusNotes="Y" EnableLotusDomino="Y" EnableMySQ L="Y"
EnableInFileDelta="Y" EnableShadowCopy="Y"
EnableExchangeMailbox="N
" ExchangeMailboxQuota="0"
EnableNASClient="Y" EnableDeltaMerge="Y" EnableMsVm="N"
MsVmQuota="0" EnableVMware="N" VMwareQuota=
Not
"0" Bandwidth="0" es="" UserHome="E:\AhsayOBS and AhsayRPS\user\test1"
RegistrationDate="1302687743242" MailboxUsage="0"
SuspendPaidUser="N" SuspendPaidUserDate="20140503"
LastBackupDate="1302699594652" Owner="" EnableCDP="Y"
EnableShadowProtectBareMetal="Y" EnableWinServer2008BareMetal="Y"
FileSizeLimit="52428800" ExcludeNetworkShare="Y"><Contact Name=""
Email="[email protected]"/></User>
If there is an error, it returns <err>%ERROR_MESSAGE%</err>
Where
Ahsay Systems Corporation Limited 211
Ahsay Offsite Backup Server
Administrator’s Guide
LoginName = login name
Alias = user’s alias
UserType = user type { PAID | TRIAL }
ClientType = clien t type { OBM | ACB }
Status = status of use r account { ENABLE | SUSPENDED }
Quota = quota in bytes
Timezone = user’s timezone
Language = user’s language
DataFile = total number of files in the data a rea
DataSize = total amount of bytes in the data area
RetainFile = total number of files in the retention area
RetainSize = total amount of bytes in the retention area
UncompressedSize = total amou data area nt (bytes) of uncompressed file size in
UncompressedRetainSize = total amou nt (bytes) of uncompressed file size in retention area
EnableMSSQL = MS SQL enabled { Y | N }
EnableMSExchange = MS Exchan ge Server
MsExchangeQuota = MS Exchange Serv
EnableOracle = Oracle enabled { Y | N }
enabled { Y | N } er quota
EnableLotusNotes = Lotus Notes enabled { Y | N }
EnableLotusDomino = Lotus Domino enabled { Y | N }
EnableMySQL = MySQL enabled { Y | N }
EnableInFileDelta = In-file Delta enab
EnableShadowCopy = Shadow
Copy enabled { Y | N }
EnableExchangeMailbox = MS Exchange
= MS Ex led { Y | N }
Mailbox enabled { Y | N } change Mailbox quota
ExchangeMailboxQuota
EnableNASClien
EnableM t = AhsayO
BM JVM Royalty enabled { Y | N }
EnableDeltaMerge = Delta Merge enabled { Y | N } sVm= HyperV module enable { Y | N }
MsVmQuota= HyperV Guest VM quota
EnableVMware= VMware module enable { Y | N }
VMwareQuota= VMware Guest VM quota
Bandwidth = user’s bandwidth
Notes = user’s n otes
UserHome = the directory where AhsayOBS stores the ba ckup files and backup logs
RegistrationDate = registation date of user account
M
SuspendPaidUser = Status of the Pa ailboxUsage = the number of mailboxes used id User { Y | N }
SuspendPaidUserDate = Date to suspend Paid Us
Last er [yyyy-MM-dd]
BackupDate = Date of last backup [Unix time format in millisecond]
Owner = user’s owner
EnabledCDP = Continuous Data Protection (CDP) enabled { Y | N }
EnableShadowProtectBareMetal = ShadowProtectBareMetal enabled { Y |
N }
EnableWinServer2008BareMetal = WinServer2008BareMetal enabled { Y |
N }
FileSizeLimit = file size threshold in bytes
ExcludeNetworkShare = network shares excludsion { Y | N }
Example:
212 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide http://BACKUP_S ERVER/obs/api/GetUser.do?SysUser=system&SysPwd=sy stem&LoginName=John
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/GetUser.do?SysUser=system&SysPw d=system&LoginName=John&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 213
Ahsay Offsite Backup Server
Administrator’s Guide
25.10 Adding a Backup Set
The following table describes all information required to invoke the [Add
Ba ckup Set] API to add a new backup set.
URL:
http://BACKUP_SERVER/obs/api/AddBackupSet.do
Available since
Pre-v6.0
Parameters:
Key
SysUser
SysPwd
LoginName
Owner
Host
Value Descriptions
St ring AhsayOBS’s system users w ince 6.11.0.0) ith admin role
(modified s
String AhsayOBS’s system users password with
String
String admin role (modified since 6.1
1.0.0)
The user’s login name
Owner of backup user
If parameter “Owner” is not used or empty, the backup user is created by system admin.
If parameter “Owner” is used and valid, the backup user is created by the specified sub-adm in.
String (Optional: Use
AhsayOBS’s URL with AhsayRDR Only)
Return Value:
If successful, returns
<BackupSet ID="1122260638375"></BackupSet >
If there is an error, returns <err>%ERROR_MESSAGE%</err> i. Login name incorrect or does not exist
<err>[UserCacheManager.NoSuchUserExpt] User '%US found.</err>
ER_NAME%' not
ii. Blank Login nam e specified
<err>[Error] Parameter LoginName is null/empty!</err>
iii. Cannot perform an add backup set to AhsayACB user account
<err>[Error] ACB backup user can only have one backup set.</err>
where
ID = new backup set ID
Ahsay Systems Corporation Limited 214
Ahsay Offsite Backup Server
Administrator’s Guide
Example:
http://BACKUP_SERVER/obs/api/AddBackupSet.do?SysUser=system&SysP wd=system&LoginName=John
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/AddBackupSet.do?SysUser=system&
SysPwd=system&LoginName=John&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 215
Ahsay Offsite Backup Server
Administrator’s Guide
25.11 Deleting a Backup Set
The following table describes all information required to invoke the [Delete
Ba ckup Set] API to delete a backup set for a particular user.
URL:
http://BACKUP_SERVER/obs/api/DeleteBackupSet.do
Available since
Pre-v6.0
Parameters:
Key
SysUser
SysPwd
LoginName
Owner
BackupSetID
Host
Value Descriptions
St ring AhsayOBS’s system users w ince 6.11.0.0) ith admin role
(modified s
String AhsayOBS’s system users password with
String
String admin role (modified since 6.1
1.0.0)
The user’s login name
Owner of backup user
If parameter “Owner” is empty, the backup system admin. not used or
user is created by
If parameter “Owner” is used and valid, the backup user is created by the specified
String sub-admin.
The ID of the backup set to delete
String (Optional: Use with AhsayRDR Only)
AhsayOBS’s URL
Return Value:
If successful, returns <OK/>
If there is an error, returns <err>%ERROR_MESSAGE%</err> i. Login name incorrect or does not exist
<err>[UserCacheManager.NoSuchUserExpt] Us found.</err> er '%USER_NAME%' not
ii. Blank Login name specified
<err>[Error] Parameter LoginName is null/empty!</err>
iii. Blank BackupSetID specified
<err>[Error] Parameter BackupSetID is null/empty!</err>
Example:
http://BACKUP_SERVER/obs/api/DeleteBackupSet.do?SysUser=system&Sy sPwd=system&LoginName=John&BackupSetID=1122260638375
Ahsay Systems Corporation Limited 216
Ahsay Offsite Backup Server
Administrator’s Guide
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/DeleteBackupSet.do?SysUser=syste m&SysPwd=system&LoginName=John&BackupSetID=1122260638375&Ho st=obs.yourserver.com
Ahsay Systems Corporation Limited 217
Ahsay Offsite Backup Server
Administrator’s Guide
25.12 Listing Backup Sets
The following table describes all information required to invoke the [List
Ba ckup Sets] API to list all the backup sets for a particular user.
URL:
http://BACKUP_SERVER/obs/api/ListBackupSets.do
Available since
Pre-v6.0
Parameters:
Key
SysUser
SysPwd
LoginName
Owner
Host
Value Descriptions
St ring AhsayOBS’s system users w ince 6.11.0.0) ith admin role
(modified s
String AhsayOBS’s system users password with
String
String admin role (modified since 6.1
1.0.0)
The user’s login name
Owner of backup user
If parameter “Owner” is not used or empty, the backup user is created by system admin.
If parameter “Owner” is used and valid,
String the backup user is created by the specified sub-admin.
(Optional: Use with
AhsayOBS’s URL
AhsayRDR Only)
Return Value:
If successful, returns
<BackupSets>
<BackupSet ID="1302673387980" Name="BackupSet" T
/><BackupSet ID="1302673465574" Name="BackupSet
Type="VMw are Virtualization" /><BackupSet ID="1303955350843"
Name="Backup ype="FILE"
(2)"
Set (3)" Type="Microsoft Windows Virtualization"
/><BackupSet ID="-11302687382211" Name="en forced_test_win"
Type="FILE" /><BackupSet ID="1302682595966" Name="ESXi-demo"
Type="VMware Virtualization" /
><BackupSet ID="1302684999063"
Name="hyperv" Type="Microsoft Windows Virtualization" /><BackupSet
ID="1303205174271" Name="HyperV-VSS" Type="Micro soft Windows
Virtualization" /><BackupSet ID="1303203620407" Name="Volumes"
Type="FILE" />
</BackupSets>
If there is an error, returns <err>%ERROR_MESSAGE%</err> i. LoginName incorrect or does not exist
<err>[UserCacheManager.NoSuchUserExpt] User '%USER_NAME%' not
Ahsay Systems Corporation Limited 218
Ahsay Offsite Backup Server
Administrator’s Guide
found.</err> ii. Blank Login name specified
<err>[Error] Parameter LoginName is null/empty!</err>
Example:
http://BACKUP_SERVER/obs/api/ListBackupSets.do?SysUser=system&SysP wd=system&LoginName=John
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/ListBackupSets.do?SysUser=system&
SysPwd=system&LoginName=John&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 219
Ahsay Offsite Backup Server
Administrator’s Guide
25.13 Get Backup Set
The following table describes all information required to invoke the [Get
Ba ckup Set] API to get a backup set.
URL:
http://BACKUP_SERVER/obs/api/GetBackupSet.do
Available since
Pre-v6.0
Parameters:
Key
SysUser
SysPwd
LoginName
Owner
BackupSetID
ShowStatusOnly
Host
Value Descriptions
St ring AhsayOBS’s system users with ince 6.11.0.0)
admin role
(modified s
String AhsayOBS’s system users password with
String
String admin role (modified since 6.1
The user’s login name
1.0.0)
String
St ring
Owner of backup user
If parameter “Owner” is empty, system admin. not used or the backup user is created by
If parameter “Owne r” is used and valid, the backup user is created by the specified sub-admin.
The backup set ID
String
If Show StatusOnly=”N” (default if no value is specified) the full backup set configuration will be returned.
If ShowStatusOnly=”Y” a summary of the backup set configu ration will be returned
(Optional: Use with AhsayRDR Only)
AhsayOBS’s URL
Return Value:
If
When ShowStatusOnly=”Y”
<BackupSet ID="1303106066451" Name="Exchange 2010 DB"
Type="Microsoft Exchange Server"><RunBackup Run="N" BackupType=""
JobID=""/></BackupSet>
When ShowStatusOnly=”N” or if ShowStatusOnly is omitted from the API
<BackupSet ID="1303106066451" Name="Exchange 2010 DB"
TransferBlockSize="262144" FollowSymbolicLink="N"
WindowsFollowLink="Y" Os="" Type="Microsoft Exchange Server"
AdminUsername="" AdminPassword="" WorkingDir="E:\temp"
Ahsay Systems Corporation Limited 220
Ahsay Offsite Backup Server
Administrator’s Guide
OracleSID="" Port="" Host="" LogRetentio nDays="60" NotesINI=""
BackupSystemState="N" LanDomain="CSMAIL2010"
LanUsername="Administrator" LanPassword=""
LastBackupRun="1305550934179" LastBackupAccess="1
EnableInFileDelta="Y" MinDeltaFileSize="26214400" D
MaxNumOfDelta="100" MaxDeltaRatio="50" EnableSh
305550944476" eltaBlockSize="-1" adowCopy="N" llBackup="N"
EnableOfflineBackup="N" EnableLogoutBackup="N" Fu
LastBackupCompleted="1305550946617" BackupInte
BackupIntervalHour="0" Lo
TotalUncompressedDataSize="6471213979" Numb
TotalBackupSetSize="3124437892"
TotalBSetRetainUncompress="390795288" Total
TotalBsetRetainFileSize="1990505
TotalBsetRestoreNo="0" ScheduleHos t="WIN2008A" rvalDay="1" goutType="" OfflineNotificiationDay="7"
DeleteTempFile="N" SqlServer="" DefaultDeltaType="I" erOfFiles="165"
BSetRetainFileNo="358"
5" TotalBsetRestoreSize="0"
UploadPermission="N" EnableDeltaMerge="N" Version ="14"
OfflineBackupComputerName=""
LogoutBackupReminderComputerName=""
CompressType="GzipBestSpeedCompression">
OfflineShowReminder="Y"><SelectedSource> Microsoft Exchange
Server\Microsoft Information Store</SelectedSource><RunBa
Run="N" BackupType=""/><WeeklySchedule ID="1302495 ckup
192421"
Name="Database Backup Schedule" Sun="N" Mon="N" Tue="N " Wed="N"
Thu="Y" Fri="N" Sat="N" Hour="21" Minute=
"0" Duration="-1"
BackupType="DATABASE" LastUpdated="0" Interval="-1
Name="Transaction log Backup Schedule" Sun=
"
EnableSkipBackup="N"/><WeeklySchedule ID="130562357
Wed="Y" Thu="N" Fri="N" Sat="N" Hour="21" Minute="0
BackupType="LOG" LastUpdated="1305550944476" Interv
7798"
"Y" Mon="Y" Tue="Y"
" Duration="-1" al="-1"
EnableSkipBackup="N"/><RetentionPolicy Unit="DAYS"
Period="7"><RetentionSetting ID="1305623577798" Name=
OverlapSensitive="N"></RetentionSetting></RetentionPolic
Backup ENABLED="N" Zip="Y" BackupTo="C:\LocalBackup"
SkipOffsiteBackup= "N"
SetLocalCopyPermission="N"/><DeltaWeeklySch
"Default" y><ExtraLocal
Tue="" Wed="" Thu="" Fri="" Sat=""/><DeltaMon
Occurrence="" Criteria="" JAN="" FEB="" M
JUL="" AUG="" SEP= edule Sun="" Mon="" thlySchedule Date=""
AR="" APR="" MAY="" JUN=""
"" OCT="" NOV="" DEC=""/><Cdp EnableCDP="N"
CdpTimeMarkInterval="60" CdpMinUpdateInterval="10" Type="all-volume"
ExcludeSystemFiles="N" CdpComputerName="
IdlebkpCpuTsh="0" IdlebkpIsConsiderNwk="N"
IdlebkpI
" IdlebkpIsConsiderCpu="N"
IdlebkpNwkTsh="131072" sConsiderIpt="N"
IdlebkpIptObserveForSecond="60"></Cdp><EncryptingKey
KeyType="PWD" Algorithm="AES" Mode="ECB" Length="256"
Key="6ZoYxCjLONXyYIU2eJIuAw=="/></BackupSet>
If there is an error, returns
<err>[UserCacheManager] User 'Johnny' not found.</err>
<err>Backup Set for ID='1065821983563' not found</err> under
221 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Tag <BACKUP_SET >
ID = backup set ID
Name = backup set name
TransferBlockSize
FollowSymbolicLin
= block size for transfer k = follow symbolic link (Linux only)
Os = Operating System
Type = backup set type nistrator user name dministrator password
AdminUsername = admi
AdminPassword = a
WorkingDir = tem porary working directory
OracleSID = Oracle SID setting
Port = Oracle port number
Host = Oracle hostname ntion day logging n of notes.ini file
LogRetentionDays = rete
NotesINI = path locatio
BackupSystemState = whether t
LanDomain = LAN domain name o backup system state
LanUsername = LAN user name
LanPassword = LAN password
LastBackupRun = time of last backup run
LastBackupAccess = time of last backup
EnableInFileDelta = enabling in-file delta feat u re
MinDeltaFileSize = minimum delta file size setting fiel
DeltaBlockSize = delta block s ize setting field d
MaxNumOfDelta = maximum delta number setting fie ld
MaxDeltaRatio = maximum delta ratio setting field opy feature field ure filed
EnableShadowC opy = enabling shadow c
EnableOfflineBackup = enabling offline copy feat
EnableLogoutBackup = enabling logout back backup field up feature field
FullBackup = enabling full
LastBackupCompleted = time when the last backup was completed
BackupIntervalDay = Offline backup day interval nterval BackupIntervalHour = Offline backup hour i
LogoutType = unused
OfflineNotificiationDay = Offline backup email reminder d ays
DeleteTempFile = Remove temporary files after backup
SqlServer = SQL server hostname
DefaultDeltaType = Default in-file delta type
TotalUncompressedDataSize = Total uncompressed s ize in bytes of the data area
NumberOfFiles = Total number of files in the data area
TotalBackupSetSize = To tal compressed size in bytes of the data area
TotalBSetRetainUncompress = Total uncompressed size in bytes of the retention area
TotalBSetRetainFileNo = Total number of files in the retention area
TotalBsetRetainFileSize = Total compressed size in bytes of the retention area
TotalBsetRestoreFileSize = Total size in bytes of the files restored
TotalBsetRestoreNo = Total number of restoration done
ScheduleHost = Computer name of this backup set that the scheduler will use to determine whether to run
222 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
EnableDeltaMerge = Delta merge enabled { Y | N }
Version = Version number for MS Exchange Server
UploadPermission = Upload the file permission { Y | N }
OfflineBackupComputerName = Computer name of this bac kup set that extra local backup will use to determine whether to run
LogoutBackupReminderComputerName = Computer name of set that the logout backup reminder will use to dete
this backup rmine whether to run
CompressType = File size reduction {<Empty> | Gzip pression }
DefaultCompression |
GzipBestSpeedCom
OfflineShowReminder = Show Offline
Backup Reminder { Y | N }
Tag < SelectedSource >
SelectedSource = selected sources for ba ckup
Tag < DeselectedSource >
DeselectedSource = deselected sources for backup
Tag <RunBackup>
Run = Whether the backup is pending
BackupType = Ba
POWEROFF | SKIP ckup type { DATABASE | LOG | DIFFERENTIAL | COPY |
}
JobID = Server initiated back up job ID in the format of yyyy-MM-dd-hhmm-ss (e.g. 2013-01-16-14-19 -20)
Tag < DailySchedule >
ID = schedule ID
Name = schedule name
for such schedule
Hour = time setting
Minute = tim e setting for such schedule
Duration = how lo
BackupType = ng to run. Use -1 for “Stop on completion”
Backup set type
last updated time of schedule LastUpdated =
Interval = how long to run backup
Tag < Week lySchedule >
ID = schedule ID
Name = schedule name
Sun = enable field
Mon = enable field
Tue = enable field
Wed = enable field
Thu = enable field
Fri = enable field
Sat = enable field
Hour = time setting for such schedule
Minute = time setting for such schedule
Duration = how long to run. Use -1 for “Stop on completion”
BackupType = Backup set type
LastUpdated = last updated time of schedule
Interval = how long to run backup
223 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Tag < MonthSchedule >
ID = schedule ID
Name = schedule name
Date = exact day of the month. When “0” use occurrence an
Occurrence=
Criteria = day to run e.g. Mond
Saturday, Sunday d criteria.
occurrence to run e.g. First, Second, Third, Forth Last ay, Tuesday, Wednesday, Thursday, Friday,
Hour = time setting for such schedule
Minute = time setting for such sche
Duration = how lon
BackupType = Backu
LastUpdated = last upda
Tag < CustomSchedule >
ID = schedule ID dule g to run. Use -1 for “Stop on completion” p set type ted time of schedule
Name = schedule name
BackupType = Backup set type
Date = the date to run this schedul
Hour = ti
Minute =
Duration = ho
Tag < Filter>
ID = filter ID e me setting for such schedule
time setting for such schedule w long to run. Use -1 for “Stop on completion”
LastUpdated = last updated time of sched ule
Name = filter name
Type = filter type
TopDir = the top most direc tory to apply this filter
Include = filter mode
Only = filter mode
ApplyToDir = applying to such directory ng to such file ApplyToFile = applyi
Tag < Patter n>
Pattern = the filter pattern to apply tionPolicy >
retention policy, by JOB, DAYS, or CUSTOMIZE
Tag < Reten
Unit= type for the
Period= days for the policy
Tag < RetentionSetting >
ID = retention ID
OverlapSensitive = enable feature settin g
Tag < Setting>
ID = retention ID
Name = retention name
Type = retention type. Allowed values are { DAILY | WEEKLY | MONTHLY |
QUARTERLY | YEARLY | CUSTOM }
NumOfCopiesToKeep = number of copies to keep
DateType = normally empty. Use “EXACT” when the date is known.
Sun, Mon, Tue, Wed, Thu, Fri, Sat = days enabled
224 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
Day, Week, Month, Ye ar = date enabled
Tag < PreBackupComm and>
ID = pre-command ID
Name = pre-command name
Path = path for such pre
WorkingDir = dir ectory command for such pre-command
Tag < PostBackupCommand
>
ID = post command ID
Name = post
Path = path fo command name r such post command
WorkingDir = directory for such pos
Tag < AllowedIP > t command
ID = allowedIP ID
StartIP = Start of online restore IP range
EndIP = End of online restore I P range
Tag < ExtraLocalBackup >
ENABLED = enable “Extra Local Copy” feature field
Zip = zip the copied file feature
BackupTo = loc ation to save extra copy
SkipOffsiteBackup = wh ether to skip off-site backup
SetLocalCopyPermission = set local copy permission
Tag < DeltaWeeklySchedule>
Sun, Mon, Tue, Wed, Thu, Fri, Sat = advance delta weekly sc hedule enabled. { I | D | F }
Tag < DeltaMonthlySchedule>
Date = exact day of the month. When “0” use occurrence
Occurrence= occurrence to run e.g. First, Second, Third, F and criteria. orth Last
Criteria = day to run e.g. Monday, Tuesday, Wednesday, Thursday, Frida
Saturday, Sunday
Jan, Feb, Mar, A pr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec = advance monthly schedule enabled. { I | D | F }
Tag <Cdp>
EnableCdp = Continuous Dat a Protection (CDP) Enabled { Y | N }
CdpTimeMarkInterval = the interval of point-in -time views generated by
CDP
CdpMinUpdateInterval = the minimum interval that repeatedly updated files are backup again
Type = Continuous Data Protection (CDP) type { all-volume | backupsource | custom-source } y,
ExcludeSystemFiles = exclude system files { Y | N }
CdpComputerName = Computer name of this backup set that the Cdp will use to determine whether to run
IdlebkpIsConsiderCpu = whether to consider Cpu { Y | N }
IdlebkpCpuTsh = the thredhold value of Cpu. If Cpu usage keeps below than the threshold for 1 minute, then Cpu is idle.
225 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
IdlebkpIsConsiderNwk = whether to consider network (only the network activity sending out) { Y | N }
IdlebkpNwkTsh = the thredhold value of network, in unit o f “bytes sent per
2 second, then second”. If network usage is below than the thredhold network is idle
IdlebkpIsConsiderIpt = whether to consider input activity
Id lebkpIptObserveForSecond = how long it observe. If no keyboard stroke and mouse mo
{ Y | N } vement within the observer period, then input activity is idle.
Tag <CdpFilter>
ID = Continuous Data Protection (CDP)
Name = Continuous Data Prote
Type = Continuous Data Pr
TopDir = the top most d
Include = filter mode
ApplyToDir = applying to su ch directory ch file filer ID ction (CDP) filter name otection (CDP) filter type irectory to apply this filter
ApplyToFile = applying to su
Only = Exclude matched op tion
Tag <Pattern>
Pattern = the filter pattern to appl y
Tag <EncryptingKey>
KeyType = encrypting key type { PWD | CUSTOM | NOENC
RYPT }
Algorithm = encrypting key algorithm { TwoFish | DESede | AES }
Mode = encrypting
key mode { ECB | CBC}
Length = encrypting key length
Key = hashed encrypting key
Example:
http://BACKUP_SERVER/obs/api/GetBackupSet.do?SysUser=system&SysP wd=system&LoginName=John&BackupSetID=1077097041763&ShowStatu sOnly=N
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/GetBackupSet.do?SysUser=system&S ysPwd=system&LoginName=John&BackupSetID=1077097041763&ShowSt atusOnly=N&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 226
Ahsay Offsite Backup Server
Administrator’s Guide
25.14 Updating a Backup Set
The following table describes all information required to invok
Backup Set] API to update a backup set. Note, use [Get Ba above to retrieve a backu you e the [Update ckup Set] API p set and save it as an xml file; modify the file as
need, and post it as a content using parameter name “Profile” when calling [Update Backup Set] API.
URL:
http://BACKUP_SERVER
Available since n:
Pre-v6.0
/obs/api/U pdateBackupSet.do
Parameters:
Key
SysUser
SysPwd
LoginName
Owner
Value
St ring
Descriptions
AhsayOBS’ s system users with admin role
(modified since 6.11.0.0)
St ring AhsayOBS’s system users p admin role (modified since 6.
assword with
11.0.0)
St ring
St ring
The u ser’s login name
Owner of backup user
If parameter “Owner” is not used or empty, the backup user i s created by system admin.
If parameter “Owner” is used and valid, the backup user is created by the specified sub-admin.
Profile
Host
String The whole content of backup set in XML format posted up when call ing this API
String (Optional: Use with AhsayRDR Only)
AhsayOBS’s URL
Return Value:
If successful, returns <OK/>
If there is an error, returns <err>%ERROR_MESSAGE%</err>
Example:
http://BACKUP_SERVER/obs/api/UpdateBackupSet.do?SysUser=system&S ysPwd=system&LoginName=John
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/UpdateBackupSet.do?SysUser=syste m&SysPwd=system&LoginName=John&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 227
Ahsay Offsite Backup Server
Administrator’s Guide
25.15 Listing Backup Jobs
The following table describes all information required to invoke the [List
Backup Jobs] API to get a list of all backup jobs for all backup sets.
URL:
http://BACKUP_SERVER/obs/api/ListBackupJobs.do
Available since n:
Pre-v6.0
Parameters:
Key
SysUser
SysPwd
LoginName
Owner
Value
St ring
Descriptions
AhsayOBS’
(modified s s system users with admin role ince 6.11.0.0)
St ring AhsayOBS’s system users p
St ring admin role (modified since 6.
The u ser’s login name assword with
11.0.0)
CDP
SkipEmpty
Host
String Owner of backup user
If parameter “Owner” is not used or empty, the backup u ser is created by system admin.
If par ameter “Owner” is used and valid, the backup user is created by the specified sub-admin.
Boolean Continuous Data Protection { Y | N }
String Skip if backup job has no files { Y | N }
String (Optional: Use with AhsayRDR Only)
Ah sayOBS’s URL
Return Value:
If successful, returns
<BackupSets>
<BackupSet ID="1121746638656">
2-00-00" /> <BackupJob ID="2005-12-29-1
<Bac upJob ID="2005-12-30-12-00-00" />
<BackupJob ID="2005-12-31-12-00-00" />
</BackupSet>
…
</BackupSets>
If there is an error, returns <err>%ERROR_MESSAGE%</err> i. LoginName incorrect or does not exist
<err>[UserCacheManager.NoSuchUserExpt] User '%USER_NAME%' not
Ahsay Systems Corporation Limited 228
Ahsay Offsite Backup Server
Administrator’s Guide
found.</err> ii. Blank Login name specified
<err>[Er ror] Parameter LoginName is null/empty!</err>
Where under
Tag <BackupSet>
ID = backup set ID
Tag <BackupJob>
ID = backup job ID
Example:
http://BACKUP_SERVER/obs/api/ListBackupJobs.do?SysUser=system&SysP wd=system&LoginName=John http://BACKUP_SERVER/obs/api/ListBackupJobs.do?SysUser=system&SysP wd=system&LoginName=John&CDP=Y http://BACKUP_SERVER/obs/api/ListBackupJobs.do?SysUser=system&SysP wd=system&LoginName=John&CDP=Y&SkipEmpty=Y
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/ListBackupJobs.do?SysUser=system&
SysPwd=system&LoginName=John&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 229
Ahsay Offsite Backup Server
Administrator’s Guide
25.16 Listing Backup Job Status
The following table describes all information required to invoke the [List
Ba ckup Job Status] API to get a list of all backup jobs for all backup sets.
URL:
http://BACKUP_SERVER/obs/api/ListBackupJobStatus.do
Available since
Pre-v6.0
Parameters:
Key
SysUser
SysPwd
LoginName
Owner
Value Descriptions
St ring AhsayOBS’s system users with ince 6.11.0.0)
admin role
(modified s
String AhsayOBS’s system users password with
St ring
String admin role (modified since 6.1
(Optional) The user’s login na
1.0.0) me
Owner of backup user
If parameter “Owner” is empty, the backup system admin. not used or
user is created by
If para meter “Owner” is used and valid, the backup user is created by the specified
BackupDate
Cdp
Host
String sub-admin.
A date in yyyy-MM-dd format
Boolean Continuous Data Protection { Y | N }
String (Optional: Use with Ahsay
AhsayOBS’s URL
RDR Only)
Return Value:
If
<BackupJobs BackupDate="2010-06-09" >
<BackupJob ID="20
LoginName="ListBackupJobStatus" StartTime="2010
EndTime="2010-06-09 14:05:02" BackupJobStatus
UploadSize="11456" RunVersion="
10-06-09-14-03-54"
-06-09 14:04:49"
="BS_STOP_SUCCESS"
BackupSetID="1276063418281" BackupSetName="File"
6.0.1.2" SuccessDatabase="Mailbox
Database 2,Mailbox Database 3" MissedDatabase=""
SuccessPublicFolder="" MissedPublicFolder=""/>
</BackupJobs>
If there is a Backup Job in progress, it returns “Backup in progress”.
If there is an error, it returns <err>%ERROR_MESSAGE%</err> i. LoginName incorrect or does not exist
<err>[UserCacheManager.NoSuchUserExpt] User '%USER_NAME%' not
Ahsay Systems Corporation Limited 230
Ahsay Offsite Backup Server
Administrator’s Guide
found.</err>
ii. Blank Login name specified
<err>[Error] Parameter LoginName is null/empty!</err>
iii. Either incorrect backup job date s pecified or No backup job was run for the specified date
<err>[Error] No Backup Job on that day</err>
iv. Incor rect Backupdate format specified. BackupDate=YYYY-MM-DD
<err>[Error] Paramete r BackupDate is not in correct format!</err>
under
Tag <BackupJobs>
BackupDate = date of backup
Tag <BackupJob>
ID = backup job ID
LoginName = user name
StartTime = job start time
EndTime = job end time
BackupJobStatus = the status of the backup job as follo ws:
1. BS_STOP_SUCCESS = backup completed successfu
system error p stopped by scheduler ser lly
2. BS_STOP_BY_SYSTEM_ERROR = backup stopped due to
3. BS_STOP_BY_SCHEDULER = backu
4. BS_STOP_BY_USER = backup stopped by u
5. BS_STOP_BY_QUOTA_EXCEEDED = backup stopped due t o quota exceeded
6. BS_STOP_SUCCESS_WITH_ERROR = backup completed with
7. BS_STOP_SUCCESS_WITH_WARNING = backup comp warnings
8. BS_STOP_MISSED_BACKUP = backup
9. BS_BACKUP_NOT_F
10. BS_MISSED_DATABASAE for MS Exchange Server /
11. BS_MISSED_PUBLIC_
missed
INISHED = backup in progress
= backup completed with missed database(s)
MailLevel Database Availability Group
FOLDER = backup completed with missed public folder(s) for MS Exchange MailLevel Database A
12. BS_MISSED_VIRTUAL_MACHI vailability Group
NE = backup completed with missed virtual machine(s) for MS Hyper-V Server (Failover Cluster)
13. Others = other client errors not defined above.
BackupSetID = backup set ID
BackupSetName = backup set name
UploadSize = total uploaded size
RunVersion = OBM / ACB version
SuccessDatabase = uploaded successfully database names
errors leted with
MissedDatabase = missed database names
231 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
SuccessVirtualMachine = uploaded successfully virtua
MissedVirtualMachine = missed virtual
Succ essPublicFolder = uploaded succe
machine nam l machine names es ssfully public folder names
MissedPublicFolder = missed public folder names
Example:
http://BACKUP_SERVER/obs/api/ListBackupJobStatus.do?SysUser=system
&SysPwd=system&LoginName=John&BackupDate=2007-01-08
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/ListBackupJobStatus.do?SysUser=sys tem&SysPwd=system&LoginName=John&BackupDate=2007-01-
08&Host=obs.yourserver.com
25.17 Getting Backup Job Report
The following table
Backup
describes all information
Job Report] API to get a required to invoke the [Get backup job status.
URL:
http://BACKUP_SERVER/obs/api/GetBackupJobReport.do
Available since n:
Pre-v6.0
Parameters:
Key
SysUser
SysPwd
LoginName
Owner
BackupSetID
BackupJobID
Cdp
Host
Value
String
Descriptions
AhsayOBS’s system users wi th admin role
(modified since 6.11.0.0)
St ring Ahsa yOBS’s system users password with admin role (modified since 6.11.0.0)
String
St ring
The user’s login name
Owner of backup user
If pa rameter “Owner” is not used or empty, the backup u ser is created by system admin.
If parameter “Owner” is used and valid, the backup user is created by the specified sub-admin.
A backup set ID String
String
String
A backup job ID
Continuous Data Protection { Y | N }
String (Optional: Use with AhsayRDR Only)
AhsayOBS’s URL
Return Value:
If
<BackupJob ID="2005-07-19-12-11-20" StartTime=" 2005-07-19
12:11:20" EndTime="2005-07-19 12:21:20"
BackupJobStatus="BS_STOP_SUCCESS"
232 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
NumOfErrorEntries="0" NumOfWarnEntries="0"
NumOfNewFiles="1" TotalNewFilesSize="1328
NumOfUpdatedFiles="1" To
64 "
TotalUnzipNewFilesSize="3951322" NewFilesZipRatio="9 6%" talUpdatedFilesSize="132864"
TotalUnzipUpdatedFilesSize="3951322" UpdatedFilesZipRatio= "96%"
NumOfUpdatedPermissionFiles="1"
TotalUpdatedPermissionFileSize="132864" TotalUnzipUpdatedPermissionFiles
NumOfDeletedFiles="1" TotalDeletedFilesSize="1328 64"
TotalUnzipDeletedFilesSize="3951322" DeletedFilesZipRatio
NumOfMovedFiles="1" TotalMovedFilesSize="132864"
="96%"
TotalUnzipMovedFilesSize="3951322" Moved
NumOfCopiedFiles
FilesZipRatio="96%"
="" TotalCopiedSize="0" TotalUnzipCopiedFilesSize="0"
CopiedFilesZipRatio="0%" SuccessDatabase="Mailbox D
Database 3" MissedDatabase="" SuccessPublicFolder="" atabase 2,Mailbox
MissedPublicFolder="">
<Info Timestamp="2005-12-31 12:59:59" Message= "??????" />
...
<War
... n Timestamp="2005-12-31 12:59:59" Message= "??????" />
<Error Timestamp="2005-12-31 12:59:59" Message="????
...
??" />
<NewFile LastModified="2005-12-31 12:59:59" N
FileS
... ize="374" ame="C:\abc.doc"
Ratio="63%"/>
<UpdatedFile LastModified="2005-12-31 12:59:59" Name="C :\abc.doc"
63%"/>
FileSize="374" 1656"
<UpdatedPermissionFile LastModified="2005-12-31 12:59:
Name="C:\abc .doc"
FileSize="374"
59"
Ra tio="63%"/>
...
<DeletedFi le LastModified="2005-12-31 12:59:59" Name="C:\abc.doc"
FileSize="374" UnzipFilesSize="11656" Ratio="63%"/>
...
<MovedFile Las
ToFile="C:\ab
FileSize="374"
...
</BackupJob> tModified="2005-12-31 12:59:59" FromFile="C:\abc.doc" c.doc"
If there is an error, returns <err>%ERROR_MESSAGE%</err> under
Tag <BackupJob>
ID = backup job ID
StartTime = backup job start time
EndTime = backup job end time
BackupJobStatus = status of backup job
NumOfErrorEntries = number of backup job errors
NumOfWarnEntries = number of backup job warnings
233 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
NumOfNewFiles = number of new files
TotalNewFilesSize = new files size
TotalUnzipNewFilesSize = new files s ize be
NewFilesZipRatio = ratio of new f fore zip iles being zipped
NumOfUpdatedFiles = number of updated files
TotalUpdatedFilesSize = updated files size
TotalUnzipUpdatedFilesSize = updated files size before zip
UpdatedFilesZipRatio = ratio of updated files being zippe d
NumO fUpdatedPermissionFiles = number of updated permission files
TotalUpdatedPermissionFilesSize = updated permission file
TotalUnzipUpdatedPermissionFilesSize = before zip s size
updated permission files size
UpdatedPermissionFilesZipRatio = ratio of up dated permission files being zipped
NumOfDeletedFiles = number of d eleted files
TotalDeletedFilesSize = deleted files size
TotalUnzipDeletedFilesSize = deleted files s i ze before zip
DeletedFilesZipRatio = ratio of deleted files being zip
NumOfMovedFiles = number of m oved files
TotalMovedFilesSize = move files size ped
TotalUnzipMovedFilesSize = moved files size before zip
MovedFilesZipRatio = ratio of moved fi les being zippe
SuccessDatabase = uploaded successfull
MissedDatabase = missed d
SuccessVirtualMachine = up d y database names atabase names loaded successfully virtual machine names
MissedVirtualMachine = missed virtual machine
SuccessPublicFolder = uploaded successfully p
MissedPublic Folder =
Tag <Info>, <Warn>, <Error>
names ublic folder names missed public folder names
TimeStamp = time of this message
Message = message text
Tag <NewFile>, <UpdatedFile>, <UpdatedPermissionFile>,
<DeletedFile>,<MovedFile>
Name = filename
FileSize = filesize
LastModified = last modified time of such file
UnzipFileSize = original file size before zipping
Ratio = ratio of the size being zipped
Example:
http://BACKUP_SERVER/obs/api/GetBackupJobReport.do?SysUser=system
&SysPwd=system&LoginName=john&BackupSetID=1108378758790&Back upJobID=2007-01-08-16-02-07
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/GetBackupJobReport.do?SysUser=sy stem&SysPwd=system&LoginName=john&BackupSetID=1108378758790&
BackupJobID=2007-01-08-16-02-07&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 234
Ahsay Offsite Backup Server
Administrator’s Guide
25.18 Getting Backup Job Report Summary
The following table describes all information req
Ba uired to invoke the [Get ckup Job Report Summary] API to get a backup job status.
URL:
http://BACKUP_SERVER/obs/api/GetBackupJobReportSummary.do
Available since
Pre-v6.0
Parameters:
Key
SysUser
SysPwd
LoginName
Owner
BackupSetID
BackupJobID
Cdp
Host
Value Descriptions
St ring AhsayOBS’s system us
(modified s ers with admin role ince 6.11.0.0)
String AhsayOBS’s system users password with
String
String admin role (modified since 6.1
1.0.0)
The user’s login name
Owner of backup user
If parameter “Owner” is em system admin. not used or pty, the backup user is created by
If parameter “Owner” is use the ba sub-admin.
A backup set ID d and valid, ckup user is created by the specified
String
String A backup job ID
Boolean Continuous Data Protection { Y | N }
String (Optional: Use with AhsayRDR Only)
Ahsay OBS’s URL
Return Value:
If
<BackupJob ID="2007-01-08-16-02-07"
StartTime="2007-01-08 16:02:07"
EndTime="2007-01-08 16:02:12"
BackupJobStatus="BS_STOP_SUCCESS"
NumOfWarnEntries="0" NumOfErrorEntries="0"
Num OfNewFiles="15" TotalNewFilesSize="790256"
NumOfUpdatedFiles="0" TotalUpdatedFilesS
NumOfDeletedFiles="0" TotalDeletedFilesSiz ize="0" e="0"
NumOfMovedFiles="0" TotalMovedFilesSize="0"
NumOfUpdatedPermissionFiles="0"
TotalUpdatedPermissionFilesSize="0" NumOfCopiedFiles="0"
TotalCopiedSize="0"
SuccessDatabase="Mailbox Database 2,Mailbox Database 3"
MissedDatabase="" SuccessPublicFolder="" MissedPublicFolder="">
</BackupJob>
If there is an error, returns <err>%ERROR_MESSAGE%</err>
235 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide under
Tag <BackupJob>
ID = backup job ID
StartTime = backup job s tart time
EndTime = backup job end time
JobStatus = status of backup job of backup job errors kup job warnings
NumOfErrorEntries = number
NumOfWarnEntries = number of bac
NumOfNewFiles = number of new
NumOfUpdatedFiles = number of
TotalUpdatedFilesSize = upda ted f
files
TotalNewFilesSize = new files size updated files iles size
NumOfDeletedFiles = number of deleted files
TotalDeletedFilesSize = deleted files size
NumOfMovedFiles = number of mo ved files
TotalMovedFilesSize = move files size
NumOfUpdatedPermissionFiles = number of upda
TotalUpdatedPermissionFilesSize = updated file permission
NumOfCopiedFiles = number of copied files ted file permission files
files size
TotalCopiedFilesSize = copied files size
SuccessDatabase = uploaded success fully database names edDatabase = missed database names Miss
SuccessVirtualMachine = uploaded successfully virtual machin e names
MissedVirtualMachine = missed virtual machine names
SuccessPublicFolder = uploaded successfully
MissedPublicFolde
public folder names r = missed public folder names
Example:
http://BACKUP_SERVER/obs/api/GetBackupJobReportSummary.do?SysUse
r=system&SysPwd=system&LoginName=john&BackupSetID=1108378758
790&BackupJobID=2007-01-08-16-02-07
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/GetBackupJobReportSummary.do?Sy
sUser=system&SysPwd=system&LoginName=john&BackupSetID=1108378
758790&BackupJobID=2007-01-08-16-02-07&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 236
Ahsay Offsite Backup Server
Administrator’s Guide
25.19 Listing Backup Files
The following table describes all information required to invoke the [List
Ba ckup Files] API to get all backup files by given a directory.
URL:
http://BACKUP_SERVER/obs/api/ListBackupFiles.do
Available since
Pre-v6.0
Parameters:
Key
SysUser
SysPwd
LoginName
Owner
BackupSetID
BackupJobID
Path
ListAll
Host
Value Descriptions
St ring AhsayOBS’s system users w ince 6.11.0.0) ith admin role
(modified s
String AhsayOBS’s system users password with
String
String admin role (modified since 6.1
1.0.0)
The user’s login name
Owner of backup user
If parameter “Owner” is empty system admin. not used or
, the backup user is created by
If parameter “Owner” is us the bac sub-admin.
A backup set ID ed and valid, kup user is created by the specified
String
String
String
A backup job ID
A directory path
String (Optional) List all backup files from root directory
Override
"Y"
{Y | N } the "Path" parameter if it is set to
String (Optional: Use with AhsayRDR Only)
AhsayOBS’s URL
Return Value:
If
When ListAll=”N” or if ListAll is omitted from the API
<Files>
<File Type="DIR" Name="My Document Folder" />
<File Type="FILE"
Name="changeStatus.bat"
OriginalFileSize="187" FileSize="1712"
BackupByJob="2005-07-25-17-07-07"
InBackupJob="Current"
LastModified="1109233592750" />
</Files>
Ahsay Systems Corporation Limited 237
Ahsay Offsite Backup Server
Administrator’s Guide
When ListAll=”Y”
<Files>
<File Type="D" Name="" FullPath= "G:\" OriginalFileSize="0"
26-18" FileSize="1536" BackupedByJob="2010-03-25-17-
InBackupJob="Current" LastModified="0"/>
<File Type="D" Name="Test-Data" FullPath="G:\Test-Da ta"
-03-25-17-26-
OriginalFileSize="0" FileSize="1536" BackupedByJob="2010
18" InBackupJob="Current" LastModif ied="0"/>
<File Type="D" Name="DeltaFiles" FullPath="G:\Test-Data
\DeltaFiles"
OriginalFileSize="0" FileSize="1536" BackupedByJob="2010
18" InBackupJob="Current" LastModified=" 0"/>
<File Type="D" Name="InUse" FullPath="G:\Tes
OriginalFileSize="0" FileSize="1536" BackupedB
-03-25-17-26t-Data\DeltaFiles\InUse" yJob="2010-03-25-17-26-
18" InBackupJob="Current" LastModified="0"/>
<File Type="F" Name="delta.txt" FullPath="G:\Test-
Data\DeltaFiles\InUse\delta.txt" OriginalFileSize="2596204 6"
FileSize="201312" BackupedByJob="2010 -03-25-17-26-18"
InBackupJob="Current" LastModified="1188617569315"/>
<File Type="F" Name="v1.txt" FullPath="G:\Test-Data\DeltaFiles\v1.txt"
OriginalFileSize="3708862" FileSize="31584" BackupedByJo b="2010-03-
25-17-26-18" InBackupJob="Current" LastModified="118861 1847813"/>
<File Type="F" Name="v10.txt" FullPath="G:\Test-
Data\DeltaFiles\v10.txt" OriginalFileSize="37088638" FileS
BackupedByJob="2010-03-25-17-26-18" InBackupJob="Cu ize="286160" rrent"
LastModified="1188618121780"/>
<File Type="F" Name="v2.txt" FullPath="G:\Test-Data\Del taFiles\v2.txt" b="2010-03-
OriginalFileSize="7417726" FileSize="59872" BackupedByJo
25-17-26-18" InBackupJob ="Current" LastModified="1188611989940"/>
<File Type="F" Name="v3.txt" FullPath="G:\Test-Data\Del
OriginalFileSize="11126590" FileSize="88160" BackupedB taFiles\v3.txt" yJob="2010-03rrent" LastModified="1188612049717"/> 25-17-26-18" InBackupJob="Cu
<File Type="F" Name="v4.txt" FullPath="G:\Test-Data\Del
OriginalFileSize="14835454" FileSize="116432" Backuped
03-25-17-26-18" InBackupJob="Current"
LastModified="1188612102929"/> taFiles\v4.txt"
ByJob="2010-
<File Type="F" Name="v5.txt" FullPath="G:\Test-Data\Del
OriginalFileSize="18544318" FileSize="144720" BackupedB
Job="Current" taFiles\v5.txt" yJob="2010-
03-25-17-26-18" InBackup
LastModified="1188612176801"/>
<File Type="F" Name="v6.txt" FullPath="G:\Test-Data\De
OriginalFileSize="22253182" File ltaFiles\v6.txt"
Size="173024" BackupedByJob="2010-
03-25-17-26-18" InBackupJob="Current"
LastModified="1188617475605"/>
<File Type="F" Name="v7.txt" FullPath="G:\Test-Data\DeltaFiles\v7.txt"
OriginalFileSize="25962046" FileSize="201312" BackupedByJob="2010-
03-25-17-26-18" InBackupJob="Current"
LastModified="1188617569315"/>
<File Type="F" Name="v8.txt" FullPath="G:\Test-Data\DeltaFiles\v8.txt"
OriginalFileSize="29670910" FileSize="229584" BackupedByJob="2010-
03-25-17-26-18" InBackupJob="Current"
238 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
LastModified="1188617700799"/>
<File Type="F" Name="v9.txt" FullPath="G:\Test-Data\De
OriginalFileSize="33379774" FileSi
03-25 ltaFiles\v9.txt" ze="257872" BackupedByJob="2010-
-17-26-18" InBackupJob="Current"
LastModified="1188617913849"/>
</Files>
If there is an error, returns <er r>%ERROR_MESSAGE%</err> under
Type = File or Directory { FILE | DIR }
Name = name of the file
OriginalFileSize = the original size
File
of the upl
Size = the actual file size being u oaded file ploaded
BackupByJob = the date when the file was uploaded
InBackupJob = The date when the file was last updated
LastModified = The time of last modification
Example:
http://BACKUP_SERVER/obs/api/ListBackupFiles.do?SysUser=system&Sys
Pwd=system&LoginName=john&BackupSetID=1108378758790&BackupJo bID=2007-001-08-16-02-
07&Path=C:\Documents%20and%20Settings\john.my.company
.
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/ListBackupFiles.do?SysUser=system&
SysPwd=system&LoginName=john&BackupSetID=1108378758790&Backu pJobID=2007-001-08-16-02-
07&Path=C:\Documents%20and%20Settings\john.my.company.
&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 239
Ahsay Offsite Backup Server
Administrator’s Guide
25.20 Getting User Storage Statistics
The following table describes all information required to invoke the [Getting
Use r Storage Statistics] API to get a list of storage information for a user.
URL:
http://BACKUP_SERVER/obs/api/GetUserStorageStat.do
Available since
Pre-v6.0
Parameters:
Key
SysUser
SysPwd
LoginName
Owner
YearMonth
Host
Value Descriptions
St ring AhsayOBS’s system users w ince 6.11.0.0) ith admin role
(modified s
String AhsayOBS’s system users password with
String
String admin role (modified since 6.1
1.0.0)
The user’s login name
Owner of backup user
If parameter “Owner” is empty, the ba system admin. not used or ckup user is created by
If parameter “Owner” is used and valid, the backup user is created by the specified
String sub-admin.
Year and month (yyyy-MM)
String (Optional: Use with AhsayRDR Only)
AhsayOBS’s URL
Return Value:
If successful, returns
<Statistics YearMonth="2005-07"
AvgDataSize="" AvgDataRawSize =”” AvgDataNo=""
AvgRetainSize="" AvgRetainRawSize= “” AvgRetainNo=""
AvgUploadSize="" AvgUp loadRawSize=”” AvgUploadNo=""
AvgTotalStorageSize="" AvgTotalSto rageRawSize=””
AvgTotalStorageNo="" >
<Storage Date="2005-07-25"
DataSize="0" DataRawSize=”0” DataNo="0"
RetainSize="0" RetainRawSize="0" RetainNo="0"
UploadSize="0" UploadRawSize="0" UploadNo="0"
TotalStorageSize="0" TotalStorageRawSize="0" TotalStorageNo="0"
/>
<Storage Date="2005-07-26"
DataSize="0" DataRawSize="0"DataNo="0"
RetainSize="0" RetainRawSize="0" RetainNo="0"
UploadSize="0" UploadRawSize="0"UploadNo="0"
TotalStorageSize="0" TotalStorageRawSize="0"TotalStorageNo="0"
/>
Ahsay Systems Corporation Limited 240
Ahsay Offsite Backup Server
Administrator’s Guide
</Statistics>
If there is an error, returns <err>%ERROR_MESSAGE%</err> where under
Tag <Statistics >
YearMonth = month of a year re
AvgDataRawSize = average size in data area (in b
AvgDataNo = average number of files in data ytes)
area
AvgRetainSize = average size in retention area
AvgRetainRawSize = average size in re
AvgRetainNo = average number of fi tentio les n area (in bytes) in retention area
AvgUploadSize = average uploaded size
AvgUploadRawSize = average uploaded size
AvgUploadNo = average number o
AvgTotalStorageSize = ave
AvgTotalStorageNo =
Tag <Storage> rage s
AvgTotalStorageRawSize = average size
(in bytes) f uploaded files ize in storage
in storage (in bytes)
average number of files in storage
Date = the date of the statistics calculated
DataSize = total data size upload ed
DataRawSize = total data size uploade r d (in bytes)
DataNo = total data numbe
RetainSize = total size in reten tion area
RetainRawSize = total size in retention area
RetainNo = total number in retention
UploadSize = total uploaded size
area
(in bytes)
UploadRawSize = total uploaded size (in bytes
UploadNo = total uploaded number
)
TotalStorageSize = total size of storage
TotalStorageRawSize = total size of storage (in
TotalStorageNo = total
Example:
storage number
bytes) http://BACKUP_SERVER/obs/api/GetUserStorageStat.do?SysUser=system
&SysPwd=system&LoginName=john&YearMonth=2005-07
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/GetUserStorageStat.do?SysUser=sys tem&SysPwd=system&LoginName=john&YearMonth=2005-
07&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 241
Ahsay Offsite Backup Server
Administrator’s Guide
25.21 Listing Users Storage
[List Users Storage] API invokes the [List Users] API with the same parameters to get a list of all users with profile and storage information ava ilable within AhsayOBS.
URL:
http://BACKUP_SERVER/obs/api/ListUsersStorage.do
Available since
Pre-v6.0
Parameters:
Key
SysUser
SysPwd
Value
St
St ring ring
Descriptions
AhsayOBS’s system us ers with admin role
(modified since 6.11.0.0)
AhsayOBS’s system users password with
LoginNameOnly St admin role (mo dified since 6.11.0.0) to display login nam es only
ClientTypeOnly St ring Whether to dis names only. play client types and login
Owner St ring backup users created by system user (admin or s
the specified ub admin) will be listed.
Host String
Return Value:
Owner of backup users
If parameter “Owner” is not used, all backup users will be listed.
If parameter “Owner” is use all ba d but empty, ckup users created by admin role system user will be listed.
If parameter “Owner” is used and valid, all
If successful, returns
<Users>
<User LoginName="abc" Alias="" UserType="PAID
Quota="52428800" Timezone="GMT+08:00 (
" ClientType="OBM"
CST)" Language="en"
DataFile="0" DataSize="0" RetainFile
EnableMSSQL="Y" EnableM
="0" RetainSize="0"
SExchange="Y" EnableOracle="Y"
EnableLotusNotes="Y" EnableLotusDomino="Y" EnableMySQL="Y"
EnableInFileDelta="Y" EnableShadowCopy="Y"
EnableExchangeMailbox="N" ExchangeMailboxQuota="0"
EnableNASClient="Y" EnableDeltaMerge="Y" EnableMsVm="N"
MsVmQuota="0" EnableVMware="N" VMwareQuota="0" Bandwidth="0"
Notes="" Status="ENABLE" RegistrationDate="1290493669199"
SuspendPaidUser="N" SuspendPaidUserDate="20101123"
LastBackupDate="0" Owner="" EnableCDP="Y"
EnableShadowProtectBareMetal="Y"
Ahsay Systems Corporation Limited 242
Ahsay Offsite Backup Server
Administrator’s Guide
EnableWinServe r2008BareMetal="Y"><Contact Name=""
Email="[email protected]"/>
</User>
<User LoginName="xyz" Alias="" UserType=" TRIAL"
Quota="52428800" Timezone="GMT+08:00 (CS
DataFile="0" DataSize="0" RetainFile="0" RetainSize
EnableMSSQL="Y" EnableMSExchange="Y" E
ClientType="OBM"
T)" Language="en"
="0" nableOracle="Y"
EnableLotusNotes="Y" EnableLotusDomino="Y" En ableMySQL="Y"
EnableInFileDelta="Y" EnableShadowCopy="Y"
EnableExchangeMailbox="N" ExchangeMailboxQuot a="0"
EnableNASClient="Y" EnableDeltaMerge="Y" Enable
MsVmQuota="0" EnableVMware="N"
Notes="" Status="ENABLE" RegistrationDate=
SuspendPaidU
MsVm="N"
VMwareQuota="0" Bandwidth="0"
"1290494031805" ser="N" SuspendPaidUserDate="19700101"
LastBac kupDate="0" Owner="" EnableCDP="Y"
EnableShadowProtectBareMetal="Y"
EnableWin
Em
</User>
Server2008BareMetal="Y"><Contact Name="" ail="[email protected]"/>
…
…
</users>
If there is an erro r, returns <err>%ERROR_MESSAGE%</err>
Where
LoginName = login name
Alias = user’s alias
UserType = user type { PAID | TRIAL }
ClientType = client type { OBM | ACB }
Quota = quota in bytes
Timezone = user’s time zone
Language = user’s language
DataFile = total number of files in the data area
DataSize = total amount of bytes in the data are
RetainFile = total number of files in the r
RetainSize = total amount of bytes in the r a etention area etention area
EnableMSSQL = MS SQL enabled { Y | N }
EnableMSExchange = MS Exchange Server enabl r quota ed { Y | N }
MsExchangeQuota= MS Exchange Serve
EnableOracle = Oracle enabled { Y | N }
EnableLotusNotes = Lotus Notes enab led { Y | N }
EnableLotusDomino = Lotus Domino enabled { Y | N }
EnableMySQL = MySQL enabled { Y | N }
EnableInFileDelta = In-file Delta enabled { Y | N }
EnableShadowCopy = Shadow Copy enabled { Y | N }
EnableExchangeMailbox = MS Exchange Mailbox enabled { Y | N }
EnableNASClient = AhsayOBM JVM Royalty enabled { Y | N }
EnableDeltaMerge = Delta Merge enabled { Y | N }
ExchangeMailboxQuota = MS Exchange Mailbox quota
EnableMsVm= HyperV module enable { Y | N }
243 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
MsVmQuota= HyperV Guest VM quota
EnableVMware= VMwa
VMwareQuota= re module
VMware Gue
Bandwidth = user’s bandwidth
enable { Y | N } st VM quota
Notes = user’s notes
Status = status of user account { ENABLE | SUSPENDED }
RegistrationDate = registation date of user account
SuspendPaidUse r = Status of the Paid User { Y | N }
SuspendPaidUserDate = Date t o suspend Paid User [yyy y-MM-dd]
LastBackupDate = Date of last backup [Unix time format in m illisecond]
Owner = user’s owner
EnabledCDP = Continuous Data Protection (CDP) enabled { Y
EnableSha
N }
EnableWinServer2008BareMetal = WinServer2008BareMeta l enabled { Y |
N }
| N } dowProtectBareMetal = ShadowProtectBareMetal enabled { Y |
Example:
http://BACKUP_SERVER/obs/api/ListUsersStorage.do?SysUser=system&Sy sPwd=system http://BACKUP_SERVER/obs/api/ListUsersStorage.do?SysUser=system&Sy sPwd=system&Owner=testing
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/ListUsersStorage.do?SysUser=syste m&SysPwd=system&Host=obs.yourserver.com
244 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
25.22 Get License
The following table describes all information required to in voke the [List
License] API to get version of AhsayOBS used and unused licenses available wit hin AhsayOBS.
URL:
http://BACKUP_SERVER/obs/api/GetLicense.do
Available since
Pre-v6.0
Parameters:
Key
SysUser
SysPwd
Value
St ring
Descriptions
AhsayOBS’s system users w
(modified since 6.11.0.0) ith admin role
String AhsayOBS’s system users password with admin role (modified sinc e 6.11.0.0)
Return Value:
If successful, returns
<License ProductName="Offsite Backup Software, OE
ObsVersion="6.8.2.11" ExpiryDate="2012/12/31"
M Edition"
SupportExpiryDate="2012/12/31" MaxQuota="Unlimited"
LicenseeName="Ahsay-00001" LicenseKey="jkc52-W63wy-l
+A" LicenseType="4"><OBM Quota="2000" Available="199
DAGUsedOBMUsers="0"/><ACB Quota="2000
Used="0" AcbUsedObmUsers="0"/><MSExchange Qu
Available="1999" Used="1"/><MSExchangeMa
9yc-vcVQC-
9" Used="1"
" Available="2000" ota="2000" il Quota="2000"
Available="2000" Used="0"/><MSSQL Quota="2
Used="1"/><Oracle Quota="2000" Available="1999"
Quota="Unlimited" Available="Unlimited"/>
Available="1999"
000" Available="1999"
Used="1"/><MySQL
<LotusDomino Quota="2000"
Used="1"/><LotusNotes Quota="2000"
Available="1999" Used="1"/><InFileDelta Quota=
Ava
Available="1999" Used="1"/><De
Available="1999" Used="1"/>
"2000" ilable="1999" Used="1"/><VolumeShadowCopy Quota="2000" ltaMerge Quota="2000"
<ClientJVMRoyalty Quota="10"
Available="9" Used="1"/><MsVm Quota="2
Used="0"/><VMWare Quota="20
Used="0"/></License>
000" Available="2000"
00" Available=" 2000"
If there is an error, returns < err>%ERROR_MESSAGE%</err>
Where
ProductName = product name of AhsayOBS
ObsVersion = version of AhsayOBS
ExpiryDate = expiry date of AhsayOBS
SupportExpiryDate = support expiry date of AhsayOBS
MaxQuota = maximum quota of AhsayOBS
LicenseeName = License name of Ahsay
LicenseKey = License key of Ahsay
LicenseType = License type of Ahsay
Ahsay Systems Corporation Limited 245
Ahsay Offsite Backup Server
Administrator’s Guide
Quota = quota
Available = unused quota
Used = used quota
AcbUsedObmUsers = number of AhsayACB users which used the quota of
AhsayOBM users
DAGUsedObmUser s = number of additional AhsayOBM quota used by the e Availability Group Microsoft Exchange Server Databas
OBM = AhsayOBM users
ACB = AhsayACB u sers
MSExchange = MS Exchang e Server module
MSExchangeMail = MS Exchang e Mail level module
MSSQL = MSSQL module
OracleUsers = Oracle mod ule
MySQL = MySQL module
LotusDomino = Lotus Dom ino module
LotusNotes = Lotus Notes module
InFileDelta = In-file delta m
Volu meShadowCopy = Volu odule me shadow copy module
DeltaMerge = Delta Merge module
Client JVMRoyalty = AhsayOBM JVM Royalty module
MsVm = Microsoft Wi ndows Virtualization module
VMWare VMware VM Backup module
Example:
http://BACKUP_SERVER/obs/api/GetLicense.do?SysUser=system&SysPwd
=system
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/GetLicense.do?SysUser=system&Sys
Pwd=system&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 246
Ahsay Offsite Backup Server
Administrator’s Guide
25.23 Get Replication Mode
The fol lowing table describes all information required to invoke the [List
Replication Mode] API to get the mode of replication available within
Ah sayOBS.
URL:
http://BACKUP_SERVER/obs/api/GetReplicationMode.do
Available since
Pre-v6.0
Parameters:
Key
SysUser
SysPwd
Value
St ring
String
Descriptions
AhsayO BS’s system users with admin role
(modified since 6.11.0.0)
AhsayOBS’s system users password with admin role (modified since 6.11.0.0)
Host String
Return Value:
If successful, returns
<Replication Mode="DISABLED"/>
Or
<Replication Mode="UNSYNC" File="D:\Test-
Data\obs52\user\kwong\files\1194504073875\Current\0x5f\0x3d\0xd2\0x c3\1103301195"/>
Or
<Replication Mode="SYNC" File="D:\Test-
Dat a\obs52\user\kwong\files\1194504073875\Current\0x5f\0x3d\0xd2\0x c3\1103301195"/>
Or
<Replication Mode="LOGGING
Data\obs52\system\logfil
" File="D:\Testes\log 0001.alf"/>
If th ere is an error, returns <err>%ERROR_MESSAGE%</err>
Where
Mode = mode of replication as follow:
1. DISABLED = disabled replication
2. LOGGING = logging mode
3. UNSYNC = un-synchronization mode
4. SYNC = synchronization mode
File = current replicating file
Example:
http://BACKUP_SERVER/obs/api/GetReplicationMode.do?SysUser=system&
SysPwd=system
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/GetReplicationMode.do?SysUser=syst em&SysPwd=system&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 247
Ahsay Offsite Backup Server
Administrator’s Guide
25.24 Send Forgot Password Email
The following tab
Forgo le describes all information required to invoke the [Send t Password Email] API to invoke the sending forgot password email operation in AhsayOBS.
URL:
http://BACKUP_SERVER/obs/api/SendForgotPwdEmail.do
Available since
Pre-v6.0
Parameters:
Key
SysUser
SysPwd
LoginName
Owner
Value
St ring
Descriptions
AhsayOBS’s
(modified s
system users with admin role ince 6.11.0.0)
St ring AhsayOBS’s system users p
St ring admin role (modified since 6.
Login name of the use assword with
11.0.0)
Host
String Owner of backup user
If parameter “Owner” is empty, the backup user is system admin. not used or
created by
If param eter “Owner” is used and valid, the backup user is sub-admin.
created by the specified
String (Optional: Use with AhsayRDR Only)
AhsayOBS’s URL
Return Value:
If successful, returns <Reply><Success/></Reply>
If there is an error, returns <err>%ERROR_MESSAGE%</err>
Example:
http://BACKUP_SERVER/obs/api/SendForgotPwdEmail.do?SysUser=system
&SysPwd=system&LoginName=test
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/SendForgotPwdEmail.do?SysUser=sy stem&SysPwd=system&LoginName=test&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 248
Ahsay Offsite Backup Server
Administrator’s Guide
25.25 Delete Backup File
The following table describes all information required to invoke the [Delete
Ba ckup File] API to delete backup file in AhsayOBS by a given directory.
URL:
http://BACKUP_SERVER/obs/api/DeleteBackupFile.do
Available since
Pre-v6.0
Parameters:
Key
SysUser
SysPwd
LoginName
Owner
BackupSetName
InBackupJob
Path
Type
Value Descriptions
St ring AhsayOBS’s system users w ince 6.11.0.0) ith admin role
(modified s
String AhsayOBS’s system users password with
String
String
String
St ring admin role (modified since 6.1
1.0.0)
Login name of the user
Owner of backup user
If parameter “Owner” is empty, th system admin. the backup user is cr sub-admin.
A backup set Name not used or e backup user is created by
If paramete r “Owner” is used and valid, eated by the specified
String
St ring
A backup job ID (Date when the file was last updated).
Full path of backup file
{ T | F | I | D | C | CD | LC | LD }
T – Directory
F – Full Backup File (or simply a file)
I – Incremental delta file
D – Differential delta file
C – Checksum file for the ful
CD - Checksum file for th incremental and differential) f
LC – L l file e delta (both ile ink of checksum file (same content but may contain different file permission or full pa th)
LD – Link of backup data file (same content but may contain different file
BackupByJob
Host
String permission or full path)
A backup Job ID (Date when the file was uploaded)
String (Optional: Use with AhsayRDR Only)
AhsayOBS’s URL
Return Value:
If successful, returns <Reply><Success/></Reply>
249 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
If there is an error, returns <err>%ERROR_MESSAGE%</er r>
Example:
http://BACKUP_SERVER/obs/api/DeleteBackupFile.do?SysUser=system&Sy sPwd=system&LoginName=john&BackupSetName=BackupSet -
0&InBackupJob=Current&Path=&Type=D&BackupByJob=2 007-01-08-16-
02-07
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/DeleteBackupFile.do?SysUser=syste m&SysPwd=system&LoginName=john&BackupSetName=BackupSet -
0&InBackupJob=Current&Path=&Type=D&BackupByJob=2007-01-08-16-
02-07&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 250
Ahsay Offsite Backup Server
Administrator’s Guide
25.26 Add Advertisement
The following table describes all information required to invoke the [Add
Ad vertisement] API to add a new advertisement to AhsayOBS.
URL:
http://BACKUP_SERVER/obs/api/AddAdvertisement.do
Available since
v6.1.0.0
Parameters:
Key
SysUser
SysPwd
Advertisement e
DisplayTime
Nam
Value
St ring AhsayOBS’s system us ers with admin role
(modified since 6.11.0.0)
St ring AhsayOBS’s system users password with
St
St ring ring
Descriptions admin role (modified since 6.11.0.0)
The Name of the new Advertisement
The time i n seconds to display, must be an even number between 2 and 60.
Text
TextAnimation
TextAlign
Tracking
AdGroupList
GifImage
SwfImage
St ring The text message to be displ ayed.
St ring Text message animation { scroll-left |
St ring scroll-right | none }
Text message a lignment { Left | Right |
Bo
Center } olean Whether to enable tracking
N }
St ring Advert isement group e.g. { ALL | NONE |
<AdgroupID>}, accept multiple inputs each separated by a comma. or not. { Y |
String
String
The URL of an GIF image, destination file must have .GIF extension
The URL of an SWF image, destination file must have .SWF extension
Return Value:
If successful, returns
<Advertisement ID="1275547136 700" Name="New" />
If there is an error, returns <err>%ERROR_MESSAGE%</err>
where
ID = Advertisement ID
Name = Advertisement name
Example:
http://BACKUP_SERVER/obs/api/AddAdvertisement.do?SysUser=system&S ysPwd=system&AdvertisementName=New&DisplayTime=8&Target=abc.ab
c.com&Text=123456&TextAnimation=scrollright&TextAlign=center&Tracking=Y&AdGroupList=1275362087428,12752
251 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
97492353&GifIm age=D:\Pic\test.GIF&SwfImage=D:\Pic\test.SWF
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/AddAdvertisement.do?SysUser=syste m&SysPwd=system&AdvertisementName=New&DisplayTime=8&Target=a bc.abc.com&Text=123456&TextAnimation=scrollright&TextAlign=center&Tracking=Y&AdGroupList=1275362087428,12752
97492353&GifImage=D:\Pic\test.GIF&SwfImage=D:\Pic\test.SWF&Host=o bs.yourserver.com
Ahsay Systems Corporation Limited 252
25.27 List Advertisements
Ahsay Offsite Backup Server
Administrator’s Guide
The following table describes all information required to in
Ad voke the [List vertisements] API to get a list of all advertisements at AhsayOBS.
URL:
http://BACKUP_SERVER/obs/api/ListAdvertisements.do
Available since
v6.1.0.0
Parameters:
Key
SysUser
Value
St ring
Descriptions
AhsayOBS’s system users w ith admin role
(modified since 6.11.0.0)
AhsayOBS’s system users password with SysPwd St ring admin role (modified since 6.
11.0.0)
AdvertisementID Nu mber The ID of an adv only th
Listed. ertisement. If provided, e specified Advertisement will be
AdvertisementNam Boolean Whether to display names only or full eOnly advertisement details { Y | N }
Host
Return Value:
If
<Advertisements>
<Advertisement
ID="1275443024656"
Name="A
AdGroupList=
Text="Th dvert001"
StartDate=
"1275362087428,1275297492353"
"1275443024656" is is a test"
TextAnimation="scroll-left"
TextAlign="left"
Target="ww w.yahoo.com"
Tracking="N"
DisplayTime="16"
Hits="0/0/0" />
</Advertisements>
If there is an error, returns <err>%ERROR_MESS AGE%</err>
where
ID = Advertisement ID
Name = Advertisement name
AdGroupList = The list of associated AdGroups
StartDate= The starting date of this advertisement.
Text = The text message to be displayed
TextAnimation = Text message animation { scroll-left | scroll-right | none }
TextAlign = Text message alignment { Left | Right | Center }
Target = The target URL
Ahsay Systems Corporation Limited 253
Ahsay Offsite Backup Server
Administrator’s Guide
Tracking = Whether to enable tracking or not
DisplayTime = The time in seconds to display
Hits = The number of times your users clicked this advertisement. Th valu last 30 days } e es are { Hits within 1 day | Hits within the last 7 days | Hits within the
Example:
http://BACKUP_SERVER/obs/api/ListAdvertisements.do?SysUser=system&
SysPwd=system&AdvertisementNameOnly=Y&AdvertisementID=12754430
24656
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/ListAdvertisements.do?SysUser=syst em&SysPwd=system&AdvertisementNameOnly=Y&AdvertisementID=1275
443024656&Host=obs.yourserver.com
254 Ahsay Systems Corporation Limited
25.28 Modify Advertisement
Ahsay Offsite Backup Server
Administrator’s Guide
The following table describes all information requir
Advertisement] API to modify an advertisement a ed to invoke the [Modify t AhsayOBS.
URL:
http://BACKUP_SERVER/obs/api/ModifyAdvertisement.do
Available since
v6.1.0.0
Parameters:
Key
SysUser
SysPwd
AdvertisementID
Advertisement Nam eOnly
DisplayTime
Value
St ring
String
Descriptions
AhsayOBS’s system us ers with admin role
(modified since 6.1
1.0.0)
AhsayOBS’s syste m users password with admin role (modified since 6 .11.0.0)
Nu mber The Advertisement I D
St ring The name of the Advertisement
Target
Text
TextAnimation
Nu mber The time in seconds to display, even number between 2 and
must be an
60.
St ring
St ring The text message to be displ ayed.
St ring Text message animation { scroll-left | scroll-right | none }
TextAlgin
Tracking
AdGroupList
ResetStats
GifImage
SwfImage
St ring Text message a lignment { Left | Right |
Center }
Bo olean Whether to enable tracking or not. { Y |
N }
St ring Advertisement group e.g. {
<AdgroupID>}, each s
accept multiple inputs eparated by a comma.
ALL | NONE |
Boolean Whether to reset the hit counts of the advertisement. { Y | N }
String The URL of a GIF image, destination file must have .GIF extension.
String The URL of a SWF image, must have .SWF extension.
destination file
Host
Return Value:
If successful, returns <OK/>
If there is an error, returns <err>%ERROR_MESSAGE%</err>
Example:
http://BACKUP_SERVER/obs/api/ModifyAdvertisement.do?SysUser=system
&SysPwd=system&AdvertisementID=1275443024656&AdvertisementNam e=Advert001&DisplayTime=16&Target=www.yahoo.com&Text=Testing&Te xtAnimation=scrollleft&TextAlign=left&Tracking=N&AdGroupList=ALL&ResetStats=Y&GifImag e=D:\Pic\test.GIF&SwfImage=D:\Pic\test.SWF
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/ModifyAdvertisement.do?SysUser=sy
255 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide stem&SysPwd=system&AdvertisementID=1275443024656& Advertisement
Name=Advert001&DisplayTime=16&Target=www.yahoo.com&Text=Testin g&TextAnimation=scrollleft&TextAlign=left&Tracking=N&AdGroupList=ALL&ResetStats=Y&GifImag e=D:\Pic\test.GIF&SwfImage=D:\Pic\test.SWF&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 256
25.29 Delete Advertisement
Ahsay Offsite Backup Server
Administrator’s Guide
The following table describes all information require
Ad d to invoke the [Delete vertisement] API to delete an advertisement from AhsayOBS.
URL:
http://BACKUP_SERVER/obs/api/DeleteAdvertisement.do
Available since
v6.1.0.0
Parameters:
Key
SysUser
SysPwd
Value Descriptions
St ring AhsayOBS
(modif
’s system us ied sinc ers with admin role e 6.11.0.0)
String AhsayOBS’s system users password with admin role (modified since 6.11.0.0)
Number The Advertisement ID AdvertisementID
Host
Return Value:
If successful, returns <OK/>
If there is an error, returns <err>%ERROR_MESSAGE%</err>
Example:
http://BACKUP_SERVER/obs/api/DeleteAdvertisement.do?SysUser=system
&SysPwd=system&AdvertisementID=1275374722809
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/DeleteAdvertisement.do?SysUser=sy stem&SysPwd=system&AdvertisementID=1275374722809&Host=obs.your
server.com
Ahsay Systems Corporation Limited 257
Ahsay Offsite Backup Server
Administrator’s Guide
25.30 Add AdGroup
The following table describes all information required to invoke the [Add
Ad Group] API to add a new AdGroup to AhsayOBS.
URL:
http://BACKUP_SERVER/obs/api/AddAdGroup.do
Available since
v6.1.0.0
Parameters:
Key
SysUser
SysPwd
Value Descriptions
St ring AhsayOBS’s system users w ied since 6.11.0.0) ith admin role
(modif
String AhsayOBS’s system users password with admin role (modified since 6.11.0.0)
Number The AdGroup’s name AdGroupName
Host
Return Value:
If successful, returns <OK/>
If there is an error, returns <err>%ERROR_MESSAGE%</er r>
Example:
http://BACKUP_SERVER/obs/api/AddAdGroup.do?SysUser=system&SysPw d=system&AdGroupName=test
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/AddAdGroup.do?SysUser=system&Sy sPwd=system&AdGroupName=test&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 258
Ahsay Offsite Backup Server
Administrator’s Guide
25.31 List AdGroups
The following table describes all information requ
Ad ired to invoke the [List
Group] API to get a list of all AdGroups at AhsayOBS.
URL:
http://BACKUP_SERVER/obs/api/ListAdGroups.do
Available since
v6.1.0.0
Parameters:
Key
SysUser
SysPwd
Value Descriptions
St ring Ahsay
(modi
OBS’s system us ers with admin role fied since 6.11.0.0)
String AhsayOBS’s system users password with admin role (modified since 6.11.0.0)
URL Host
Return Value:
If successful, returns
<AdGroups>
<AdGroup ID="1" Name="Default" />
<AdGroup ID="1275297492353" Name="Test2
<
" />
AdGroup ID="1275297494619" Name="Test3" />
<AdGroup ID="1275297497275" Name="Test4" />
<A dGroup ID="1275362087428" Name="Test1" />
</AdGroups>
If there is an error, returns <err>%ERRO R_MESSAGE%</err>
Example:
http://BACKUP_SERVER/obs/api/ListAdGroups.do?SysUser=system&SysPw d=system
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/ListAdGroups.do?SysUser=system&S ysPwd=system&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 259
Ahsay Offsite Backup Server
Administrator’s Guide
25.32 Modify AdGroup
The following table describes all informati
Ad on required to invoke the [Modify
Group] API to modify an AdGroup at AhsayOBS.
URL:
http://BACKUP_SERVER/obs/api/ModifyAdGroup.do
Available since
v6.1.0.0
Parameters:
Key
SysUser
SysPwd
AdGroupID
AdGroupName
Host
Return Value:
Value Descriptions
AhsayOBS’s system us
(modified ers with admin role since 6.11.0.0)
St ring AhsayO BS’s system users password with admin role (modified since 6.11.0.0)
Number The
String The AdGroup’s name
If successful, returns <OK/>
If there is an error, returns <err>%ERROR_MESSAGE%</err>
Example:
http://BACKUP_SERVER/obs/api/ModifyAdGroup.do?SysUser=system&Sys
Pwd=system&AdGroupID=1275382280645&AdGroupName=TestingAdGrou p2
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/ModifyAdGroup.do?SysUser=system&
SysPwd=system&AdGroupID=1275382280645&AdGroupName=TestingAd
Group2&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 260
Ahsay Offsite Backup Server
Administrator’s Guide
25.33 Delete AdGroup
The following table describes all information required to invoke the [Delete
Ad Group] API to delete an AdGroup from AhsayOBS.
URL:
http://BACKUP_SERVER/obs/api/DeleteAdGroup.do
Available since
Pre-v6.0
Parameters:
Key
SysUser
SysPwd
Value
String
Descriptions
AhsayOBS’s system users w
(modif ied since 6.11.0.0) ith admin role
AhsayOBS’s system users password with admin role (modified since 6.11.0.0)
AdGroupID Number
Return Value:
If successful, returns <OK/>
If there is an error, returns <err>%ERROR_MESSAGE%</err>
Example:
http://BACKUP_SERVER/obs/api/DeleteAdGroup.do?SysUser=system&SysP wd=system&AdGroupID=1275382280645
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/DeleteAdGroup.do?SysUser=system&
SysPwd=system&AdGroupID=1275382280645&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 261
Ahsay Offsite Backup Server
Administrator’s Guide
25.34 Run Backup
The following table describes all information required to invoke the [Run bac kup set] API to initiate backup for a specific backup set.
URL:
http://BACKUP_SERVER/obs/api/RunBackup.do
Available since
6.3.0.0
Parameters:
Key
SysUser
SysPwd
Value
St ring
Descriptions
AhsayOBS’s system users w
(modified s ince 6.11.0.0) ith admin role
String AhsayOBS’s system users password with admin role (modified since 6.1
1.0.0)
Owner
BackupSetID
BackupType
String
String
String
Owner of backup user
If parameter “Owner” is empty, th system ad min. not used or e backup user is created by
If parameter “Owne the backup user is cre sub-admin.
The backup set ID r” is used and valid, ated by the specified
The backup type:
{empty} when backu
"File/MySQL Database p set type is
Server/Lotus
Notes/System State/Microsoft E
Mail Level Backup/Microsoft xchange
Windows
System Backup"
{ DATABASE | LOG type is "Microsoft Exchange
2000/2003/2007 /O
} when backup set
Server racle Database
Server/Lotus Domino"
{ DATABASE | DIFFERENTIA
Server"
L | LOG } when backup set type is "Microsoft SQL
{ COMPLETE | DIFFERENTIAL |
INCREMENTAL } when backup set type is
"ShadowProtect System Backup"
{ DATABASE | DIFFERENTIAL | LOG |
COPY } when backup set type is "Microsoft
Ahsay Systems Corporation Limited 262
Ahsay Offsite Backup Server
Administrator’s Guide
CancelBackup
Host
Exchage Server 2010 / Microsoft Exhcnage
Server Database Availabil ity Group"
{ POWEROFF | SKIP } when type is "VM ware" backup set
St ring (Optional) Whether to cance the sp ecific backup set. l backup for
String (Optional: Use with AhsayRDR Only)
AhsayOBS’s URL
Return Value:
If successful, returns <OK/>
If there is an error, returns <err>%ERROR_MESSAGE%</err >
Example:
http://BACKUP_SERVER/obs/api/RunBackup.do?SysUser=system&SysPwd
=system&LoginName=2916_tester&BackupSetID=1280458302800&Backu pType=COMPLETE&CancelBackup=N
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/RunBackup.do?SysUser=system&Sys
Pwd=system&LoginName=2916_tester&BackupSetID=1280458302800&Ba ckupType=COMPLETE&CancelBackup=N&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 263
Ahsay Offsite Backup Server
Administrator’s Guide
25.35 Get Backup Job Progress
The following table describes all information required to invoke the [Get
Ba ckup Job Progress] API to retrieve the backup job progress.
URL:
http://BACKUP_SERVER/obs/api/GetBackupJobProgress.do
Available since
v6.3.0.0
Parameters:
Key
SysUser
SysPwd
Value
St
St ring ring
Descriptions
AhsayOBS’s system users w ith admin role
(modified since 6.11.0.0)
Ah sayOBS’s system users password with admin role (modified since 6.11.
0.0)
Owner
BackupSetID
BackupJobID
Host
St ring (Opti onal - Use with LoginName) Owner of backup user
If parameter “Owner” is not used or backup user is created by empty, the system admin .
If par ameter “Owner” is used and valid, the backup user is created by the specified sub-admin.
The ID of the backup set String
String The ID of the backup Job
String (Optional: Use with AhsayRDR Only)
AhsayOBS’s URL
Return Value:
If successful, returns
<BackupJob ID="2010-11-30-19-59-03" LoginName="John"
StartTime="2010-11-30 19:59:05" EndTime="2010-11-30 19: 59:17"
BackupSetID ="1289447020102" BackupSetName="testing"
CurrentFilename="C:\Program Files\Kaspersky
Lab\NetworkAgent\Products\E07A4C8CB7A5029D3AA8E87E542DB0D5\~pr ivdata.~ dat~2" FileUploadTime="2010-11-30 19:59:13"
CurrentFileCo unt="26" TotalFileCount="26" UploadedFileSize="1241247"
TotalFileSize="1241247"/>
If the backup is still running, the value of EndTime should become "1970-
01-01 08:00:00"
If there is an error, it returns <err>%ERROR_MESSAGE%</err> where under
Tag <BackupJob>
264 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
ID = backup job ID
LoginName = use r n ame
StartTime = job start t ime
EndTime = job end time
BackupSetID = backup set ID
BackupSetName = Backup set Name
CurrentFilename = Current uploading
CurrentFileCount = Number of up filename loaded files (including uploading file)
TotalFileCount = Number of total uploaded files
Uplo adedFileSize = Size of uploaded files
TotalFileSize = Size of total uploaded files
FileUploadTime= Start time of uploading file (yyyy-MM-dd H H:mm:ss)
Example:
http://BACKUP_SERVER/obs/api/GetBackupJobProgress.do?SysUser=syste m&SysPwd=system&LoginName=John&BackupSetID=1291008667235&Ba ckupJobID=2010-11-30-10-39-01
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/GetBackupJobProgress.do?SysUser=s ystem&SysPwd=system&LoginName=John&BackupSetID=1291008667235
&BackupJobID=2010-11-30-10-39-01&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 265
Ahsay Offsite Backup Server
Administrator’s Guide
25.36 Add User Group
The following table describe
Gro s all information required to invoke the [Add User up] API to add a user group.
URL:
http://BACKUP_SERVER/obs/api/AddUserGroup.do
Available since
v6.3.0.0
Parameters:
Key
SysUser
Value
St ring
SysPwd
UserGroupName
LoginNameList
UserIdList
St
St
St
St ring ring ring ring
Descriptions
AhsayOBS’s system users wit h admin role
(modified since 6.11.0.0)
AhsayOBS’s system users password with admin role (modif ied since 6.11.0.0)
The name of the User Group
(Currently, API only suppor ts modifications related to backup user groups.)
Users assign to the grou p e.g.
[LoginName], accept multip separated by a comma, i.e
user3,..etc le inputs, each
. user1, user2,
It
is highly recommended to use URL encoding for long Login Names
(e.g. User2#12345 -> U ser2%2312345)
Users assign to the group e.g.
[LoginName], accept multiple inputs, each separated by a comma, i.
e. user1, user2, user3,..etc
It is hi ghly recommended to use URL encoding for long Login Names
(e.g. User2#12345 -> User2%2312345)
Same as paramete param r "LoginNameList". If the parameter "Use rIdList" is not used, the eter "LoginNameList" will be used.
Return Value:
If successful, returns:
<UserGroup ID="1275547136700" Name="User Group A" />
If there is an error, returns <err>%ERROR_MESSAGE%</err>: i. User Group Name already exists on AhsayOBS
<err>[PolicyControlException.DuplicatedUserGroupNameException] User
Group Name '%GROUP_NAME%' is used</err>
266 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide ii. User name does not exist on AhsayOBS or an incorrect user specified
<err>[UserCacheManager.NoSuchUserExpt] User '%USER_NAME%' not foun d.</err>
Example:
http://BACKUP_SERVER/obs/api/AddUserGroup.do?SysUser=system&SysP wd=system&UserGroupName=XYZ http://BACKUP_SERVER/obs/api/AddUserGroup.do?SysUser=system&SysP wd=system&UserGroupName=ABC&LoginNameList=GroupUser1,GroupUse r2%2312345
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/AddUserGroup.do?SysUser=system&
SysPwd=system&UserGroupName=XYZ&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 267
Ahsay Offsite Backup Server
Administrator’s Guide
25.37 List User Groups
The following table describes all information required to invoke the [List User
Gro ups] API to list all the available user groups on AhsayOBS.
URL:
http://BACKUP_SERVER/obs/api/ListUserGroups.do
Available since
v6.3.0.0
Parameters:
Key
SysUser
SysPwd
UserGroupID
UserId
UserGroupOnly
Value Descriptions
St
St ring ring
AhsayOBS’s system users w ith admin role
(modified since 6.11.0.0)
Ahsa yOBS’s system users password with admin role (modified since 6.11.
0.0)
Nu mber (Optional) The ID of the U provided, only the specified will be listed. ser Group. If
User Group
(Currently, API only supports modifications related to backup user gro ups.)
St ring (Optional) Filter listed Us specific backup user ( er Group by
Only effective if oupID has not been specified).
UserGr
It is high en ly recommended to use URL coding for user ID.
(e.g. User2#12345 -> User2%2312345)
Boolean Whether to display User Group only or full
User Group details. { Y | N }
Return Value:
If successful, returns (UserGroupOnly = N)
<UserGroups>
<UserGroup ID
Type="bac
="1275897475792" Name="User Group - 3" kup-user" Owner="" >
<Users>
<User Name="GroupUser1" />
</Users>
<PolicyGroups>
<PolicyGroup ID="1275897783056"
Name="Policy Group - 2" />
</PolicyGroups>
</UserGroup>
</UserGroups>
…
..
If successful, returns (UserGroupOnly = Y) or if UserGroupOnly is not specified
Ahsay Systems Corporation Limited 268
Ahsay Offsite Backup Server
Administrator’s Guide
<UserGroups>
<UserGroup ID="1243569613625" Name="Us
Type="backup-user" Owne
<UserGroup ID="1275895771498" Name="Tes
Type="backup-user" Owne
<User r="" /> ting Group"
Group ID="1275897475792" Name="User Group - 3"
Type="backup-user" Owner=""/ >
</Us erGroups> r="" /> er Group - Read Only"
If there is an error, returns <err>%ERROR_MESSAGE%</err>
Example:
http://BACKUP_SERVER/obs/api/ListUserGroups.do?SysUser=system&SysP wd=system http://BACKUP_SERVER/obs/api/ListUserGroups.do?SysUser=system&SysP wd=system&UserGroupOnly=Y&UserGroupID=1275443024656 http://BACKUP_SERVER/obs/api/ListUserGroups.do?SysUser=system&SysP wd=system&UserGroupOnly=N&UserId=test%2332333
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/ListUserGroups.do?SysUser=system&
SysPwd=system&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 269
Ahsay Offsite Backup Server
Administrator’s Guide
25.38 Modify User Group
The following table describes all information required to invoke the [Modify
Use r Group] API to modify the user group.
URL:
http://BACKUP_SERVER/obs/api/ModifyUserGroup.do
Available since
v6.3.0.0
Parameters:
Key
SysUser
SysPwd
Value
St ring
Descriptions
AhsayOBS’s system users with
(modified since 6.11.0.0)
admin role
St ring AhsayOBS’s system users password with
UserGroupID
UserGroupName
Mode admin role (modified since 6.11.
0.0)
Nu mber The ID of the User Group.
(Currently, API on ly support related to backup user group s modifications s.)
St ring (Optional) The name of the U ser Group
St ring This defines whether the AP delete user from the User Gro
(Where A = add , D = delete )
I will add or up { A | D }.
LoginNameList
UserIdList
St ring List of users that will be assigned to the
User Group. [LoginName], acce inputs, each separated by pts multiple
a comma.
List is ONLY Please note that LoginName compatible with this API in A highly recommended to use for log in names
DD mode.It is
URL encoding
St ring List of users that will be as signed to the
User Group. [LoginName], acce inputs, each separated b pts multiple y a comma. eList is ONLY Please note that LoginNam compatible with this highly recommended to use for log in n
Same a
API in ADD mode.It is
URL encoding ames s parameter "LoginNameList". If the parameter "UserIdList" is not used, the
UserId String parameter "LoginNameList" will be used.
The user ID of a specific user that will be assigned / removed from the User Group depending on the value of Mode.
It is highly recommended to use URL encoding for user ID
Host
Return Value:
If successful, returns <OK/>
If there is an error, returns <err>%ERROR_MESSAGE%</err>
Ahsay Systems Corporation Limited 270
Ahsay Offsite Backup Server
Administrator’s Guide
Example:
http://BACKUP_SERVER/obs/api/ModifyUserGroup.do?SysUser=system&Sy sPwd=system&UserGroupID=1275895771498&UserGroupName=Testing_
Group&LoginNameList=GroupUser2&UserId=GroupUser1&Mode=A http://BACKUP_SERVER/obs/api/ModifyUserGroup.do?SysUser=system&Sy sPwd=system&UserGroupID=1275895771498&UserGroupName=TestingGr oup&LoginNameList= Testuser1, Testuser2 &Mode=A http://BACKUP_SERVER/obs/api/ModifyUserGroup.do?SysUser=system&Sy sPwd=system&UserGroupID=1275895771498&UserGroupName=TestingGr oup&UserId=Testuser&Mode=A
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/ModifyUserGroup.do?SysUser=syste m&SysPwd=system&UserGroupID=1275895771498&UserGroupName=Tes ting_Group&LoginNameList=GroupUser2&UserId=GroupUser1&Mode=A&H ost=obs.yourserver.com
Ahsay Systems Corporation Limited 271
Ahsay Offsite Backup Server
Administrator’s Guide
25.39 Delete User Group
The following table describes all information required to invoke the [Delete
Use r Group] API to delete a user group.
URL:
http://BACKUP_SERVER/obs/api/DeleteUserGroup.do
Available since
v6.3.0.0
Parameters:
Key
SysUser
SysPwd
UserGroupID
Value Descriptions
St
St ring ring
AhsayOBS’s system users w ith admin role
(modified since 6.11.0.0)
AhsayOBS’s system users password with admin role (modified since 6.11.0.0)
Number The ID of the User Group.
(Currently, API only supports modifications related to backup u ser groups.)
Return Value:
If successful, returns <OK/>
If there is an error, returns <err>%ERROR_MESSAGE%</ err> i. Incorrect UserGroupID specified
<err >[Error] Parameter UserGroupID, xxxxxxxxx does not existed!</err>
ii. The UserGroupID parameter was o mitted from the API or the value of the UserGroupID is empty
<err>[Error] Parameter UserGroupID is null/empty!</err>
Example:
http://BACKUP_SERVER/obs/api/DeleteUserGroup.do?SysUser=system&Sy sPwd=system&UserGroupID=1275895280730
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/DeleteUserGroup.do?SysUser=syste m&SysPwd=system&UserGroupID=1275895280730&Host=obs.yourserver.
com
272 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
25.40 List Policy Groups
The following table describes all information required to invoke the [List
Pol icy Group] API to list user assigned policy groups.
URL:
http://BACKUP_SERVER/obs/api/ListPolicyGroups.do
Available since
v6.3.0.0
Parameters:
Key
SysUser
SysPwd
LoginName
Owner
Type
PolicyGroupNameO nly
Host
Value
St ring
String
Descriptions
AhsayOB S’s system users with admin role
(modified s ince 6.11.0.0)
AhsayOBS’s system users password with admin role (modified since 6.1
1.0.0)
User’s Login Name String
String
String
Owner of backup user
If parameter “Owner” is empty, the backup system admin. not used or
user is created by
If parameter “Owner” is us ed and valid, the backup user is created by the specified sub-admin.
User’s type, e.g. [ backup-user ]
(Currently, API only supports modifications related to backup user groups.)
String (Optional) will be lis
Only policy ID and policy name ted. { Y | N }
String (Optional: Use with AhsayRDR Only)
AhsayOBS’s URL
Return Value:
If successful, returns
<PolicyGroups>
<PolicyGroup PolicyGroupID="1282186302196"
PolicyGroupName="Policy Group - 4634 -1">
<SharedQuota Enabled="Y" SharedSize ="0"
MaxPercentage="0"/>
<DefaultBackupSets>
<DefaultObmFileWindowsBackupSet ID="-1276842815367"
Name=" BackupSet- Windows - File "/>
<DefaultObmFileMacBackupSet ID="-1282618475562"
Name="BackupSet- Mac - File"/>
<DefaltObmFileLinuxBackupSet ID="-1282618461980"
Name="BackupSet- Linux - File"/>
<DefaultObmMsSqlWindowsBackupSet ID="-
Ahsay Systems Corporation Limited 273
Ahsay Offsite Backup Server
Administrator’s Guide
1282618486349" Name="BackupSet- MSSql - Windo
<DefaultObmMsExchangeWindow
1282618503663" Name="BackupSet- Windows sBa ws"/> ckupSet ID="-
- MsExchange"/>
" <DefaultObmOracleWindowsBackupSet ID=
1282618537197" Name="Ba ckupSet- Windows - Oracle"/>
<DefaultObmOracleMacBackupSet ID="-1282
Name="BackupSet- Mac - Oracle "/>
618572791"
<DefaultObmOracleLinuxBackup
Set ID="-1282618554292"
Name="BackupSet- Linux - Oracle "/> ySqlWindowsBackupSet ID="-
<DefaultObmM
1282618598504" Name="BackupSet- Windows - MySql "/>
<DefaultObmMySqlMacBackupSet
Name="BackupSet- Mac - MySQL "/>
ID="-1282618634395"
<DefaultObmMySqlLinuxBackup Set ID="-1282618611321"
Name="BackupSet- Linux - MySQL"/>
<DefaultObmDominoWindowsBa ckupSet ID="ino"/>
ID="-
1282618650444" Name="BackupSet- Windows - Dom
<DefaultObmDominoLinuxBackupSet
1282618667804" Name="BackupSet- Linux - Domino"/>
<DefaultObmNotesWindowsBackupSet ID="-
1282618683603" Name="BackupSet- Windows - Notes
<DefaultObmSystemStateWindowsB
1282618697264" Name="BackupSet- Windows - Sy ack
"/> upSet ID="stem State"/> dowsBackupSet ID="-
<DefaultObmMsExchangeMailWin
1282618717012" Name="BackupSet- Windows
- MsExchange - Mail"/>
<DefaultObmShadowProtectWindowsBac kupSet ID="-
1282618736574" Name="BackupSet- Windows - Shadow
Protect"/>
<DefaultObmMsWindowsWindowsBackupSet ID
1282618760663" Name="BackupSet- Windows - Windows" /> ultObmVMwareWindowsBackupSet ID="rver2"/>
="-
<Defa
11307586662890" Name="BackupSet-VMware-Se
<DefaultObmMSVirtualizationWindowsBackupS et ID="-
11307586685140" Name="BackupSet-MSVM-HyperV"/>
<DefaultAcbWindowsBackupSet
Name="BackupSet-4748_acb"/>
ID="-1278558712322"
<DefaultAcbMacBackupSet ID="-128 2618821970"
Name="BackupSet- Mac"/>
<EnforcementObmFileWindowsBackupSet ID="-
1282618858299" Name="BackupSet-0"/>
<EnforcementObmFileMacBackupSet ID="-12 82618475562"
Name="BackupSet- Mac - File"/>
<EnforcementObmFileLinuxB ackupSet ID="-
1282618461980" Name="BackupSet- Linux - File"/>
<EnforcementObmMsSqlWindowsBackupSet ID="-
1282618858300" Name="BackupSet- Windows - MSSql "/>
<EnforcementObmMsExchangeWindowsBackupSet ID="-
1282618503663" Name="BackupSet- Windows - MsExchange"/>
<EnforcementObmOracleWindowsBackupSet ID="-
1282618537197" Name="BackupSet- Windows - Oracle"/>
<EnforcementObmOracleMacBackupSet ID="-
1282618572791" Name="BackupSet- Mac - Oracle"/>
274 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
<EnforcementObmOracleLinuxBackup
1282618554292" Name="BackupSet- Linux - Oracl
<EnforcementObmMySqlWindows
1282618598504" Name="BackupSet- MySq
Set ID="e"/>
BackupSet ID="l - Windows"/>
<EnforcementObmMySqlMacBacku pSet ID="-
1282618634395" Name="BackupSet- Mac - MySQL"/>
<EnforcementObmMySqlLinuxBackupS
1282618611321" Name="BackupSet- Linux - MyS
<EnforcementObmDominoWind
QL"/> owsBackupSet ID="-
1282618650444" Name="BackupSet- Windows - Do et ID="mino"/>
<EnforcementObmDominoLinuxBackupSet ID="-
1282618667804" Name="BackupSet- Linux - Domino"/>
<EnforcementObmNotesWindowsBackupS
1282618683603" Name="BackupSet- Windows - Notes" et ID="-
/>
<EnforcementObmSystemStateWindowsBackupSet ID="m State"/> 1282618697264" Name="BackupSet- Windows - Syste
<EnforcementObmMsExchangeMailWi
ID="-1282618717012" Name="BackupSet- Windo
Mail"/>
<EnforcementObmShadowProtectWindowsBack ndo wsBackupSet ws - MsExchange - upSet ID="-
1282618736574" Name="BackupSet- Windows - Shadow P
<EnforcementObmMsWindowsB rotect"/> ackupSet ID="-
1282618760663" Name="BackupSet- Windows - Windows"/>
<EnforcementObmVMwareWindowsBackup
11307586662890" Na
Set ID="me="BackupSet-VMware-Server2"/>
<Enforceme ntObmMSVirtualizationindowsBackupSet ID="-
11307586662890" Name="BackupSet-VMware-Server2"/>
<EnforcementAcbWindowsBackupSet ID="-
1278558712322" Name="BackupSet-4748_acb"/>
<EnforcementAcbMacBackupSet ID="-1282618821970"
Name="BackupSet- Mac"/>
</DefaultBackupSets>
<PolicyControls>
ID="OBS-UUP-10001" Name="Manag
Profile Menu" ShowRead="Y" ShowWrite="N" Sh e User-User-User owExecute="N"
ShowDelete="N" EnableRead="N" EnableWrite="N" Enab leExecute="N"
EnableDelete="N"/>
<PolicyControl ID="OBS-UUP-10002" Name="
User-User-User Profile-User Summary" ShowRead="Y" S
ShowExecute="N" ShowDelete=
Manage howWrite="N"
"N" EnableRead="N" EnableWrite="N"
EnableExecute="N" EnableDelete="N"/>
<PolicyControl ID="OBS-UUP-10003 " Name="Manage
User-User-User Profile-Alias" ShowRead="Y" ShowWrite="Y"
ShowExecute="N" ShowDelete="N" EnableRead="N" EnableWrite="N"
EnableExecute="N" EnableDelete="N"/>
<PolicyControl ID="OBS-UUP-10004" Name="Manage
User-User-User Profile-Language" ShowRead="Y" ShowWrite="Y"
ShowExecute="N" ShowDelete="N" EnableRead="N" EnableWrite="N"
EnableExecute="N" EnableDelete="N"/>
<PolicyControl ID="OBS-UUP-10005" Name="Manage
User-User-User Profile-Timezone" ShowRead="Y" ShowWrite="Y"
275 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
ShowExecute="N" ShowDelete="N" EnableRead="N" Enable Write="N"
EnableExecute="N" EnableDelete="N"/>
<PolicyControl ID="OBS-UUP-10006" Nam e="Manage
ShowRead="Y" ShowWrite="Y" User-User-User Profile-Contact"
ShowExecute="N" ShowDelete="N" EnableRead="N" En ableWrite="N"
EnableExecute="N" EnableDelete="N"/>
<PolicyControl ID="OBS-UUP-10007" Nam
ShowExecute="N" ShowDelete="N" EnableRe
EnableExecute="N" EnableDelete="N"/> e="Manage
User-User-User Profile-Add-on Modules" ShowRead="Y" Sho wWrite="N" ad="N" EnableWrite="N"
<PolicyControl ID="OBS-UUP-10008" Name=" Manage User-
User-User Profile-Quota" ShowRead="Y" ShowWrite="N" bleWrite="N" ShowExecute="N" ShowDelete="N" EnableRead="N" Ena
EnableExecute="N" EnableDelete="N"/>
<PolicyCo ntrol ID="OBS-UUP-10009" Name="Manage User-
User-User Profile-Update Reset Button" ShowRead="Y" ShowW
ShowExecute="N" ShowDelete="N" EnableRead="
</PolicyControls>
N" E
EnableExecute="N" EnableDelete="N"/> rite="Y" nableWrite="N"
<GlobalFilters>
<ObmFileWindowsNormalFilter ID=""
<ObmFileMacNormalFilter ID="" N
<ObmDominoWindowsNormalFilter ID="
<ObmFileLinuxNormalFilter ID
Name=""/> ame=""/>
="" Name=""/>
" Name=""/>
<ObmDominoLinuxNormalFilter ID="" Name=""/>
<ObmNotesWindowsNormalFilter ID="" Na
<ObmFileWindowsCdpFilter ID="" Name=" me=""/
"/>
<ObmFileLinuxCdpFilter ID="" Name=""/>
WindowsNormalFilter ID="-11282635326290" Name="Filter
<ObmFileMacCdpFilter ID="" Name=""/>
<AcbFile
Windows"/>
<AcbFileMacNormalFiler ID="-4128263534618 9" Name="Filter Mac"/>
</GlobalFilters>
<FileSizeFilte
<ExcludeNetworkShare EnableExcludeNetworkShare="Y"/>
</PolicyGroup>
</PolicyGroups> r EnableFileSizeFilter="Y" FileSizeLimit="100"/>
If there is an error, re turns <err>%ERROR_MESSAGE%</err>
Where
PolicyGroupID = policy group id
PolicyGroupName = policy group name
Tag <Shared Quota>
Enabled = share disk quota enabled { Y | N }
SharedSize = disk quota shared size (Gigabytes)
MaxPercentage = Maximum percentage of disk quota shared
Tag <Default Backup Sets>
ID = default backup set ID
Name = default backup set name
DefaultObmFileWindowsBackupSet = OBM file default backup set for
276 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide windows
DefaultObmFileMacBackupSet = OBM file default b ackup set for mac
DefaltObmFileLinuxBackupSet = OBM file default b linux ackup set for
DefaultObmMsSqlWindowsBackupSet = OBM Mi crosft SQL server default backup set for windows
DefaultObmMsExchangeWindowsBackupSet = OBM M icrosoft exchange server default backup set for windows
DefaultObmO set for windows racleWindowsBackupSet = OBM oracle default backup
DefaultObmOracleMacBackupSet = OBM Oracle database server default backup set for mac
DefaultObmOracleLinuxBackupSet = OBM Oracle dat ult backup set for linux abase server defa
DefaultObmMySqlWindowsBackupSet = OBM MySQL d efault backup set for windows
DefaultObmMySqlMacBackupSet = OBM MySQL default backup set for mac
DefaultO bmMySqlLinuxBackupSet = OBM MySQL default backup set for linux
DefaultObmDominoWindowsBackupSet = OBM Lotus Domino default backup set for windows
DefaultObmDominoLinuxBackupSet = OBM Lotus D omino default backup set for linux
DefaultObmNotesWindowsBackupSet = OBM Lotu s Notes default backup set for windows
DefaultObmSystemStateWindowsBackupSet =
OBM System State default backup set for windows
DefaultObmMsEx changeMailWindowsBackupSet = OBM Microsoft
Exchange Mail default backup set for windows
DefaultObmShadowProtectWindowsBackupSet = O BM Shadow
Protect System default backup set for windows
DefaultObmMsWindowsWindowsBackupSet = OBM Microsoft
Windows System default backup set for windows
Defa ultObmVMwareWindowsBackupSet = OBM VMware VM Backup default backup set for windows
DefaultObmMSVirtualizationWindowsBackupSet = OBM Microsoft
Windows Virtualization default backup set for windows
DefaultAcbWindowsBackupSet = ACB File default b ackup set for windows
DefaultAcbMacBackupSet = ACB File default backup s
EnforcementObmFileWindowsB et for mac ackupSet = OBM File default backup set for windows
EnforcementObmFileMacBackupSet = OBM File enforcement backup set for mac
EnforcementObmFileLinuxBackupSet = OBM File enforcement backup set for linux
EnforcementObmMsSqlWindowsBackupSet = OBM Microsoft SQL enforcement backup set for windows
EnforcementObmMsExchangeWindowsBackupSet = OBM Microsoft
Exchange enforcement backup set for windows
277 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
EnforcementObmOracleWindowsBackupSet = OBM Or acle enforcement backup set for windows
EnforcementObmOracleMacBackupSet = OBM Oracle
mac
enforcement backup set for
EnforcementObmOracleLinuxBackupSet = OBM Orac le enforcement backup set for linux
EnforcementObmDominoWindowsBackupSet = OB M Lotus Domino enforcement backup set for windows
EnforcementObmDom inoLinuxBackupSet = OBM Lotus Domino enforcement backup set for linux
EnforcementObmNotesWindowsBackupSet = OB M Lotus Notes enforcement backup set for windows
EnforcementObmSystemStateWindowsBackupSet = O indows
BM System
State enforcement backup set for w
EnforcementObmMsExchangeMailWindowsBackupSe t = OBM
Microsoft Exchange Mail enforcement backup set for windows
EnforcementObmShadowProtectWindowsBackupSe
Protect enforcement backup set for windows t = OBM Shadow
EnforcementObmMsWindowsBackupSet = OBM M icrosoft Windows enforcement backup set for windows
EnforcementObmVMwareWindowsBackupSet = OBM VMware VM
Backup enforcement backup set for windows
Enforcem entObmMSVirtualizationWindowsBackupSet = OBM
Microsoft Windows Vir tualization enforcement backup set for windows
EnforcementAcbWind owsBackupSet = ACB File enforcement backup set for windows
EnforcementAcbMacBackupSet
= ACB File enforcement backup set for linux
Tag <Policy Controls>
ID = policy control ID
Name = policy control name
ShowRead = s how read permission
ShowWrite = show write permission
ShowExecute = show execute permission
ShowDelete = show delete permission
EnableRead = enable read permission
EnableWrite = show write permission
EnableExecute = show execute permission
Global Filters> Tag <
ID = global filter ID
Name = global filter name
ObmFileWindowsNormalFilter = OBM File norm al filter for windows
ObmFileMacNormalFilter = OBM File normal filter for mac
ObmFileLinuxNormalFilter = OBM File normal filter for linux
ObmDominoWindowsNormalFilter = OBM Domino normal filter for windows
ObmDominoLinuxNormalFilter = OBM Lotus Domino normal filter for linux
ObmNotesWindowsNormalFilter = OBM Lotus Notes normal filter for windows
ObmFileWindowsCdpFilter = OBM File cdp filter for windows
278 Ahsay Systems Corporation Limited
Ahsay Offsite Backup Server
Administrator’s Guide
ObmFileMacCdpFilter = OBM File cdp filter for ma
ObmFileLinuxCdpFilter = OBM File cdp filte
AcbFileW indowsNormalFilter = ACB norma
AcbFileMacNormalFiler = ACB normal filter r for c linux l filter for windows for mac
TAG <FilterSizeFilter>
EnableFileSizeFilter = file size restriction enabled
FileSizeLimit = file size threshold setting in mega
TAG <ExcludeNetworkShare>
{Y|N} bytes
EnableExcludeNetworkShare = exclude network shar e enabled
{Y|N}
Example:
http://BACKUP_SERVER/obs/api/ListPolicyGroups.do?SysUser=system&Sys
Pwd=system&LoginName=4632_tester&Type=backupuser&PolicyGroupNameOnly=N
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/ListPolicyGroups.do?SysUser=system
&SysPwd=system&LoginName=4632_tester&Type=backupuser&PolicyGroupNameOnly=N&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 279
Ahsay Offsite Backup Server
Administrator’s Guide
25.41 Add User Groups to Policy Group
The following table describes all in gro formation required to invoke the [Add user ups to policy group] within AhsayOBS.
URL:
http://BACKUP_SERVER/obs/api/AddUserGroupsToPolicyGroup.do
Available since
v6.3.0.0
Parameters:
Key
SysUser
SysPwd
PolicyGroupID
UserGroupIDLi st
Value Descriptions
St ring AhsayOBS’s system us
(modified since 6.11.0
ers with admin role
.0)
String AhsayOBS’s system users password with
St
St ring ring admin role (modified since 6 .11.0.0)
The policy group ID
The us er group ID, separated by “,”
(Currently, API only supports modifications related to backup u ser groups.)
Return Value:
If successful, returns <OK/>
If there is an error, returns <err>%ERROR_MESSAGE%</err>
Example:
http://BACKUP_SERVER/obs/api/AddUserGroupsToPolicyGroup.do?SysUser
=system&SysPwd=system&PolicyGroupID=1280458302800&UserGroupID
List=1280458287815,1282186204737
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/AddUserGroupsToPolicyGroup.do?Sys
User=system&SysPwd=system&PolicyGroupID=1280458302800&UserGrou pIDList=1280458287815,1282186204737&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 280
Ahsay Offsite Backup Server
Administrator’s Guide
25.42 Delete User Group from Policy Group
The following table describes all information required to invoke the [Remove user group from policy group] API to remove user groups from policy group wit hin AhsayOBS.
URL:
http://BACKUP_SERVER/obs/api/DeleteUserGroupFromPolicyGroup.do
Available since
v6.3.0.0
Parameters:
Key
SysUser
SysPwd
PolicyGroupID
UserGroupID
Value Descriptions
St ring AhsayOB
(modifie
S’s system users with admin role d since 6.11.0.0)
St ring AhsayO BS’s system users password with
String
String admin role (modified since 6.11.0.0)
The policy group ID
The user group ID
Return Value:
If successful, returns <OK/>
If there is an error, returns <err>%ERROR_MESSAGE%</err>
Example:
http://BACKUP_SERVER/obs/api/DeleteUserGroupFromPolicyGroup.do?Sys
User=system&SysPwd=system&PolicyGroupID=1280458302800&UserGrou pID=1280458287815
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/DeleteUserGroupFromPolicyGroup.do
?SysUser=system&SysPwd=system&PolicyGroupID=1280458302800&User
GroupID=1280458287815&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 281
Ahsay Offsite Backup Server
Administrator’s Guide
25.43 List Backup Job Mode
The follo wing table describes all information required to invoke the [Listing
Backup Job Mode] API to get a list of all backup jobs for all backup sets or a bac kup set.
URL:
http://BACKUP_SERVER/obs/api/ListBackupJobMode.do
Available since
v6.3.0.0
Parameters:
Key
SysUser
SysPwd
LoginName
Owner
Value Descriptions
St ring AhsayOBS’s system users with admin role
St
(modified since 6.11.0.0) ring AhsayOBS’s system users p assword with
St ring admin role (modified since 6 .11.0.0)
(Optional) The user’s login name. If specified, only the backup jobs of the user is displayed otherwise all bac kup jobs are displayed.
St ring (Opti onal - Use with LoginName) Owner of backup user
If parameter “Owner” is not used or empty, the backup user is created by system admin.
If parameter “Owner” is use the ba sub-admin. d and valid, ckup user is created by the specified
BackupDate
BackupSetID
Host
String A date in yyyy-MM-dd format
– Use with LoginName) The ID of the backup set to listing backup job mode
String (Optional: Use with AhsayRDR Only)
AhsayOBS’s URL
Return Value:
If successful, returns
<BackupJobs BackupDate="2010-11-30" >
<BackupJob ID="2010-11-30-16-39-21" LoginName="John"
StartTime="2010-11-30 16:39:22" EndTime="2010-11-30 16:39:47"
BackupSetID="1291008667235" BackupSetName="1-4991"
BackupJobMode="M"/>
<BackupJob ID="2010-11-30-16-46-42" LoginName="John"
StartTime="2010-11-30 16:46:43" EndTime="2010-11-30 16:47:02"
BackupSetID="1291008667235" BackupSetName="1-4991"
BackupJobMode="M"/>
<BackupJob ID="2010-11-30-16-54-07" LoginName="John"
Ahsay Systems Corporation Limited 282
Ahsay Offsite Backup Server
Administrator’s Guide
StartTime="2010-11-30 16:54:07" EndTime="2
BackupSetID="1291008667235" BackupSetNam
010-11-30 16:58:55" e="1-4991"
BackupJobMode="M"/>
<BackupJob ID="2010-11-30-17-00-29" LoginN ame="John"
-11-30 17:00:30" EndTime="2010-11-30 17:02:59" StartTime="2010
BackupSetI D="1291008667235" BackupSetName="1-4991"
BackupJobMode="M"/>
</Backu pJobs>
If there is an error, it ret urns <err>%ERROR_MESSAGE%</err>
where under
Tag <BackupJobs>
BackupDate = date of backup
Tag <BackupJob>
ID = backup job ID
LoginName = user name
StartTime = job start time
EndTime = job end
BackupSetID = ba
BackupSetNam
2. S = Schedu
time ckup set ID
3. R = Remote backup
4. e = Backup set Name
BackupJobMode = the status of the backup job as follow:
1. M = Manual backup le backup
C = CDP backup
Example:
http://BACKUP_SERVER/obs/api/ListBackupJobMode.do?SysUser=system&
SysPwd=system&LoginName=John&BackupDate=2010-11-30
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/ListBackupJobMode.do?SysUser=syst em&SysPwd=system&LoginName=John&BackupDate=2010-11-
30&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 283
Ahsay Offsite Backup Server
Administrator’s Guide
25.44 List System Users
The following table describes all information required to invoke the [List
Sy stem Users] API to get all system users.
URL:
http://BACKUP_SERVER/obs/api/ListSystemUsers.do
Available since
v6.3.0.0
Parameters:
Key
SysUser
SysPwd
RoleOnly
Value Descriptions
St ring AhsayOBS’s system users w modified since 6.11.0.0) ith admin role
St
( ring AhsayO BS’s system users password with
String admin role (modified since 6.11.0.0)
List the role of system users only {Y | N }
(Optional)
Host
Return Value:
If RoleOnly=Y, returns
<SystemUsers>
<User Nam e="sa1" Role="reseller"/>
<User Name="sa2" Role="reseller"/>
…
</SystemUsers>
If RoleOnly=N or th
<Sys temUsers> e parameter, RoleOnly, does not exists, returns
<User Name="sa1" Password="4QrcOUm6Wau+VuB X8g+IPg=="
Role="reseller" HashedPwd="4QrcOUm6Wau+VuBX8g
ContactName="sa1" ContactEmail="[email protected]" HostNa
+IPg==" me="sa1.a.c"
Uid="41435" EnableSmtpSetting="N">
<InterfaceCustom ization Enable="N"/>
<SubUser Name="sa2"/>
</User>
<User Name="sa2" Password="4QrcOUm6Wau+VuBX8g+I
Role="reseller" HashedPwd="4
Conta
Pg=="
QrcOUm6Wau+VuBX8g+IPg==" ctName="sa2" ContactEmail="[email protected]" HostName="sa2.a.c"
Uid="32441 " EnableSmtpSetting="Y">
<SmtpServer HostName="sa2.a.c" LoginName="s a2.a.c"
Password="sa2.a.c"/>
<ReportSender Name="obm.sa2.a.c" Email="[email protected]" OBM="Y"
ACB="N"/>
<ReportSender Name="acb.sa2.a.c" Email="[email protected]" OBM="N"
ACB="Y"/>
<InterfaceCustomization Enable="N"/>
</User>
</SystemUsers>
If there is an error, returns <err>%ERROR_MESSAGE%</err>
Ahsay Systems Corporation Limited 284
Ahsay Offsite Backup Server
Administrator’s Guide where under
Tag <User>
Name = login name of system user
Password = password of system user
Role = role of system user
HashedPwd = password of system user is hashed or not
of system user ContactName = contact name
ContactEmail = contact email of system user
HostName = host name of system user
Uid = uid of system user
EnableSmtpSetting = enable or disable the SMTP setting of system user
Tag <SmtpServ er>
HostName = host name
LoginName = login nam
of SMTP server e of SMTP server
Password = password of S MTP server
Tag <ReportSender>
Name = name of report sender
Email = e
OBM = OBM user of report send
ACB = mail of report sender
ACB user of report sender
Tag <InterfaceCustomization>
Enable = enab
Tag <SubUser> er le or disable the interface customization of system user
Name = login name of sub-level sys tem user
Example:
http://BACKUP_SERVER/obs/api/ListSystemUsers.do?SysUser=system&Sy sPwd=system
Example for AhsayRDR:
http://REDIRECTOR_SERVER/rdr/api/ListSystemUsers.do?SysUser=system
&SysPwd=system&Host=obs.yourserver.com
Ahsay Systems Corporation Limited 285
Ahsay Offsite Backup Server
Administrator’s Guide
25.45 Additional APIs
If you need additional APIs to automate your business workflow, please feel free to let us know.
Ahsay Systems Corporation Limited 286
Ahsay Offsite Backup Server
Administrator’s Guide
26
Further Information
If you have any question or suggestion about this document, please send an email to our support team via our Help Centre Ticketing System .
Ahsay Systems Corporation Limited 287
Appendix
Appendix A Supported Language Code
Lang uage Co de La nguage
bg Bulgarian ca Ca talan cs Czech
D de German
Ahsay Offsite Backup Server
Administrator’s Guide en English el Span ish eu Basque fi Finnish fr French hu Hun garian is Icelandic it Italian iw Hebr ew ja Japanese ko Korean lt Lithuanian nl Dutch no Norwegian po Polish pt_BR Portugue ro Romanian ru Russian sl Slovenian sv Swedish tr Turkish
(Simplified)
Ahsay Systems Corporation Limited 288
Ahsay Offsite Backup Server
Administrator’s Guide
Appendix B Supported Time zone
Timezone St ring
GMT-11:00 (WST)
GMT-11:00 (NUT)
GMT-11:00 (SST)
GMT-10:00 (HADT)
GMT-10:00 (HST)
GMT-10:00 (TKT)
GMT-10:00 (HST)
GMT-10:00 (CKT)
GMT-10:00 (THAT)
GMT-09:00 (AKST)
GMT-09:00 (GAMT)
Timezone N
Western Sta
Niue Time
ame
ndard Time
Samoa Standard Time
Hawaii-Aleutia
Tok elau Time
Hawaiian St n Daylight Time
Hawaiian Standard Time andard Time
Cook Islands Time
Tahiti Time
Alaska Standard Time
Gambier T ime
GMT-08:00 (PST)
GMT-07:00 (PDT)
GMT-07:00 (MST)
GMT-07:00 (MDT)
GMT-06:00 (CST)
GMT-06:00 (CDT)
GMT-06:00 (EAST)
GMT-06:00 (GALT)
GMT-05:00 (EST)
GMT-05:00 (EDT)
GMT-05:00 (COT)
GMT-05:00 (ECT)
GMT-05:00 (CDT)
Pacific Stand
Pacific Dayli
Mountain ard Time (North America) ght Time (North America)
Standard Time
Mountain Day Time
Central Standard Time
Centra l Daylight Time
Easter Island Time
Galapagos Time
Eastern S tandard Time (North America)
Eastern Daylight Time (North America)
Colombia Tim e
Ecuado r Time
Centra l Daylight Time (North America)
GMT-05:00 (PET)
GMT-05:00 (ACT)
Peru Time
Atla ntic/Proto Acre
GMT-05:00 (GMT-05 :00) GMT -05:00
GMT-04:00 (AST)
GMT-04:00 (PYT)
Atlantic
Paragu
Standard Time ay Time
GMT-04:00 (VET)
GMT-04:00 (GYT)
GMT-04:00 (ADT)
GMT-04:00 (BOT)
GMT-04:00 (AMT)
GMT-04:00 (CLT)
GMT-04:00 (FKT)
GMT-03:00 (ART)
GMT-03:00 (GFT)
GMT-03:00 (BRT)
GMT-03:00 (WGST)
GMT-03:00 (PMDT)
GMT-03:00 (UYT)
GMT-03:00 (SRT)
GMT-02:00 (FNT)
GMT-02:00 (GST)
GMT-01:00 (EGST)
Venezuela
Guya na Time
Acre Daylight Time
Bolivia Time
Armen
Time ia Time
Chile Time
Falkland Islands
Argentina Time
French Guiana Time
Brasilia Time
West Greenland Summer Time
Pierre & Miquelon Daylight Time
Uruguay Time
Suriname Time
Fernando de Noronha Time
Gulf Standard Time
East Greenland Summer Time
Ahsay Systems Corporation Limited 289
Ahsay Offsite Backup Server
Administrator’s Guide
GMT+00:00 (G MT)
GMT+00:00 (WET)
GMT+00:00 (WEST)
GMT+00:00 (IST)
GMT+00:00 (BST)
GMT+00:00 (UTC)
GMT+01:00 (CET)
GMT+01:00 (WAT)
GMT+01:00 (CEST)
GMT+02:00 (EEST)
GMT+02:00 (CAT)
GMT+02:00 (SAST)
GMT+02:00 (EET)
GMT+02:00 (IDT)
GMT+03:00 (EAT)
GMT+03:00 (AST)
GMT+03:00 (ADT)
GMT+03:00 (MSD)
GMT+04:00 (AQTST)
GMT+04:00 (AZST)
GMT+04:00 (GST)
GMT+04:00 (GEST)
GMT+04:00 (AMST)
GMT+04:00 (SAMST )
GMT+04:00 (SCT)
GMT+04:00 (MUT)
GMT+04:00 (RET)
GMT+05:00 (TMT)
GMT+05:00 (KGST)
GMT+05:00 (TJT)
GMT+05:00 (PKT)
GMT+05:00 (UZT)
GMT+05:00 (YEKST)
GMT+05:00 (IDT)
GMT+05:00 (TFT)
GMT+05:00 (MVT)
GMT+06:00 (MAWT)
GMT+06:00 (LKT)
GMT+06:00 (BDT)
GMT+06:00 (NOVST )
GMT+06:00 (BTT)
GMT+07:00 (ICT)
GMT+07:00 (JAVT)
GMT+07:00 (KRAST)
GMT+07:00 (CXT)
GMT+08:00 (HKT)
GMT+08:00 (CST)
GMT+08:00 (BNST)
GMT+08:00 (WST)
Ahsay Systems Corporation Limited
Greenwich Mean Time
Western European Tim e
Western Eu ropean Summer Time
Israel Standard Time
Brazil Standa rd Time
Coordin ate Universal Time
Central European Tim e
West Africa Time
Central Europea n Summer Time
Eastern Euro pean Summer Time
Central Afr ica Time
Soft Africa Standard Time
Eastern E uropean Time
Israel Daylig ht Time
Eas t Africa Time
Acre Standard Time
Acre Dayl ight Time
Moscow Dayl ight Time
Aqta u Time
Azerba ijan Summer Time
Gulf S tandard Time
Georgia T ime
Armenia Summer Time
Samar a Time
Seych elles Time
Mauritiu s Time
Reunion Tim e
Turkmenistan Time
Kirgiz stan Time
Tajikistan Time
Pakistan Time
Uzbekist an Time
Yekater inburg Time
Indian Standard Time
French Southern & Antarctic Lands Time
Maldives Time
Mawson Tim e
Lanka Time
Ban gladesh Time
Novosibi rsk Time
Bhutan Time
Indochina Time
Java Time, Indonesia Time
Krasnoyarsk Time
Christmas Island Time
Hong Kong Time
Cuba Standard Time
Brunei Time
West Samoa Time
290
Ahsay Offsite Backup Server
Administrator’s Guide
GMT+08:00 (I RKST)
GMT+08:00 (MYT)
GMT+08:00 (PHT)
GMT+08:00 (SGT)
GMT+08:00 (BORT)
GMT+08:00 (ULAT)
GMT+08:00 (JAYT)
GMT+09:00 (KST)
GMT+09:00 (JST)
GMT+09:00 (YAKST)
GMT+09:00 (PWT)
GMT+10:00 (EST)
GMT+10:00 (DDUT)
GMT+10:00 (VLAST)
GMT+10:00 (ChST)
GMT+10:00 (PGT)
GMT+10:00 (TRUST)
GMT+11:00 (MAGST)
GMT+11:00 (VUT)
GMT+11:00 (KOSST)
GMT+11:00 (NCT)
GMT+11:00 (PONT)
GMT+12:00 (NZST)
GMT+12:00 (ANAST)
GMT+12:00 (PETST)
GMT+12:00 (FJT)
GMT+12:00 (TVT)
GMT+12:00 (MHT)
GMT+12:00 (NRT)
GMT+12:00 (GILT)
GMT+12:00 (WAKT)
GMT+12:00 (WFT)
Irkuts k Time
Malays ia Time
Philipp
Singap ine Time ore Time
Borneo Time
Ulan Bator T ime
Jayapura Ti me
Korean Standard Time
Japan Standard Time
Yakutsk Tim e
Palau Ti me
Eastern Standa rd Time (Australia)
Dumont-d’Urv ille Time
Vladiv ostok Time
Cham orro Standard Time
Papua New Guinea Time
Truk Time
Magadan Time
Vanu atu Time
Kosrae Time
New Caledonia Time
Ponape Tim e (Micronesia)
New Zealan d Standard Time
Anadyr Ti me
Pet ropavlovsk-Kamchatski Time
Fiji Time
Tuvalu Time
Marshall Islands Time
Nauru Time
Gilbert Island Time
Wake Time
Wallis and Futuna Time
Appendix C Product Documentations
Please visit this link for the documentations of Ahsay Products.
Ahsay Systems Corporation Limited 291
Ahsay Offsite Backup Server
Administrator’s Guide
Appendix D E rror Code 1011 and 1012
T
Internal Error 1011 his error could occur when one of the following con ditions is true:
1.
The license key ha s been used on more than one machine.
2. C hange of network card of the server machine or moving the AhsayBS system to a new server.
Solution:
In the cases where the license key was used on a second serv er for testing purposes, please use an evaluation key instead.
Alternatively, please shutdown the AhsayOBS service on the s and then contact our Support Engineer with your "License econd server,
Name" and
"License Key", and we shall update the license server to allow your ke y to be used again.
In the cases where the network card of the server machine is ch
AhsayOBS relocation has been performed. Please also contac anged, or an t our Support
Engineer with your "License Name" and "License Key", and we shall update the license server to allow your key to be used again.
If the problem still persists, please ensure that there are no connectivity issues from the AhsayOBS server to the internet and that you c lic.ahsay.com with HTTPS from the AhsayOBS backup serve connection test button underne an connect to r. There is a ath the license field entry box to test the connection to our license server. The testing result will be displayed next to the test button.
Please also verify if the machine in concern contain any software that would create virtual MAC address, for example, VPN software. If yes, please disable them such software, and notify us again.
Ahsay Systems Corporation Limited 292
Ahsay Offsite Backup Server
Administrator’s Guide
Internal Error 1012
In ternal Error 1012 can occurs when one of the follo wing conditions is true:
1.
The license key has been used on more than one machine.
2. C hange of the MAC address, local / remote IP address, or local port that
AhsayOBS is insta lled on.
Solution:
Persistent 1012 license errors can occur if your AhsayOBS serv in a network environment where network er is operating traffic is routed to the internet via multiple external IP addresses. For example, network load implemented using, i.e. a dual WAN router, Round Robin routin
balancing is g, or network card with multiple external IP.
For these cases, we would suggest setting up a static route for the server's connection to lic.ahsay.com, so that the remote IP address on the server will remain the same every time a connection to lic.ahsay.com is established.
Ahsay Systems Corporation Limited 293
Ahsay Offsite Backup Server
Administrator’s Guide
Appen dix E How can I rebuild an AhsayOBS server from scratch
To rebuild an AhsayOBS server from backup, please perform the following procedure:
1. Restore the program directory (the default loca tion is shown below) to the new machine. a. Windows – “C:\Program Files\Ahsay Offsite Backup Server” x/FreeBSD/Solaris – “/usr/local/obs” b. Linu
2. Re store the [System Home] directory (back to its original directory if possible)
3. Restore all [User Homes] directories (back to their origina l directories if possible)
4. If you have restored the [System Home] directory or a
Homes] directories to another directory (inste ny of the [User ad of the original directory), please modify the <system-home> and/or <user-home> param eters within the [obs.xml] file to reflect the new locations. a. Windows – “C:\Program Files\Ahsay Offsite Backup Server\conf\obs.xml” b. Linux/FreeBSD/Solaris – “/usr/local/obs/config/obs.xml”
5. (for Windows) Run [C:\Program Files\Ahsay Offsite Backup
Server\bin\Install-Service.bat] to install AhsayOBS as Windows service.
6. Startup the AhsayOBS service.
Ahsay Systems Corporation Limited 294
Ahsay Offsite Backup Server
Administrator’s Guide
Appendix F How to start up AhsayRPS as AhsayOBS
This chapt
Ahsay er describes the information on how you can start up AhsayRPS as
OBS.
S cenario
You want to start AhsayOBS by using the replication data same AhsayOBS & AhsayRPS service on the replication ser
AhsayOBS & AhsayRPS is inst
AhsayRPS on the backup server side. and using the ver side.
alled in C:\Program Files\AhsayOBS and
AhsayOBS & AhsayRPS is installed in C:\Program Files\A
hsayOBS and
AhsayRPS on the replication server side.
The RECEIVER_HOME of the receiver of A
AhsayRPS is D:\RepHome. hsayOBS configured on
The USER_HOMES of AhsayOBS are E:\Users and F:\Users on AhsayOBS.
The SYSTEM_HOME of AhsayOBS is E:\System on AhsayOBS.
The POLICY_HOME of AhsayOBS is E:\Policy on AhsayOBS
.
To startup the replication server as a backup server, please follow the steps below:
3. Shutdo side. wn the AhsayOBS & AhsayRPS service on the replication server
4.
Copy the CONF folder, i.e. copy the D:\RepHome\files\C
Files\AhsayOBS and AhsayRPS\conf
server.xml.
%3A\Program
to C:\Program Files\AhsayOBS and
AhsayRPS\conf, exclude rps.xml, rpsRecv.xml, rpsLice nse.xml and
5. Copy the WEBAPPS folder, i.e. copy D:\RepHome\files\C
Files\AhsayOBS and AhsayRPS\webapps\obs to
Files\AhsayOBS and AhsayRPS\webapps\obs.
%3A\Program
C:\Program
6. Co py the USER_HOMES, i.e. copy D:\RepHome\files\E%3A\Users to
E:\Users, D:\RepHome\files\F%3A\Users to F:\Users
D:\RepHome\files\E%3A\System to E:\System.
and
If the partitions for E:\ or F:\ are not available, you ca directories to any location you want. However, you must open C:\Program Files\Ahs n copy these
remember to
ayOBS and AhsayRPS\conf\obs.xml and modify the entries for “user-home” and “system-home” with the correct paths.
7. Copy the POLICY_HOME, i.e. copy D:\RepHome\files\E%3A\Policy to
E:\Policy.
8. Startup AhsayOBS & AhsayRPS service on the replication server. This service is running both AhsayOBS service from the original backup server and the AhsayRPS service now.
Ahsay Systems Corporation Limited 295
Ahsay Offsite Backup Server
Administrator’s Guide
Please take a look at %OBSR_H
%OBSR_
OME%\logs\obs*.log and
HOME%\logs\cat*.log if you run into any problem.
WARNING:
Do not copy the license.xml, rps.xml, rpsRecv.xml, or rpsSend.xml
file over to the new AhsayOBS instance.
Ahsay Systems Corporation Limited 296
advertisement
* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project