26
HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26 HP Backup and Recovery Manager Software Provider Design Specification Chethana Das [email protected] 281.514.9165 document level: 0.21 document date: 07.11.2007 HP Confidential Documents PDF Complete Click Here & Upgrade Expanded Features Unlimited Pages

Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

  • Upload
    others

  • View
    2

  • Download
    0

Embed Size (px)

Citation preview

Page 1: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 1 of 26

HP Backup and Recovery ManagerSoftware Provider

Design Specification

Chethana [email protected]

281.514.9165

document level: 0.21document date: 07.11.2007

HP Confidential

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 2: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 2 of 26

© Copyright 2006 Hewlett-Packard Development Company, L.P

The information contained herein is subject to change without notice.

HP and the HP Invent logo are registered trademarks of Hewlett-Packard Company.

SoftThinks is trademark or registered trademark of SoftThinks USA, Inc or its subsidiaries in the United States and othercountries.

Microsoft, Windows, Windows XP and Windows Vista are U.S. registered trademarks of Microsoft Corporation.

The only warranties for HP products and services are set forth in the express warranty statements accompanying suchproducts and services. Nothing herein should be construed as constituting an additional warranty. HP shall not be liablefor technical or editorial errors or omissions contained herein.

This document contains proprietary information that is protected by copyright. No part of this document may bephotocopied, reproduced, or translated to another language without the prior written consent of Hewlett-PackardCompany.

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 3: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 3 of 26

Table of ContentsTABLE OF CONTENTS..............................................................................................3

ADDITIONAL CONTRIBUTORS .................................................................................4

REVISION HISTORY ................................................................................................4

OVERVIEW.............................................................................................................4

REQUIRED FUNCTIONALITY ....................................................................................5

WMI INTERFACE .....................................................................................................5

HP_RECOVERYPOINT ..........................................................................................................5MOF Definition .....................................................................................................................5Properties.............................................................................................................................6Example...............................................................................................................................6

HP_SCHEDULEDBACKUP.......................................................................................................6MOF Definition .....................................................................................................................8Example...............................................................................................................................9

HP_SCHEDULERSERVICE .....................................................................................................10Description .........................................................................................................................10MOF Definition ...................................................................................................................10Parameters ........................................................................................................................10Example.............................................................................................................................10

HP_SCHEDULERSERVICE.UPDATETASK() ..................................................................................10Description .........................................................................................................................10MOF Definition ...................................................................................................................11Parameters ........................................................................................................................11Example.............................................................................................................................12

HP_SCHEDULERSERVICE.CREATETASK() ..................................................................................13Description: ........................................................................................................................13MOF Definition ...................................................................................................................13Example.............................................................................................................................15

HP_SCHEDULERSERVICE.REMOVETASK() .................................................................................15Description: ........................................................................................................................15MOF Definition ...................................................................................................................15Example.............................................................................................................................16

METHOD ERROR CODES.....................................................................................................16

CONFIGURATION FILE FORMAT ............................................................................16

STRUCTURE OF NETUSERDIFF.LST/USERDIFF.LST ..................................................................17SAMPLE NETUSERDIFF.LST/USERDIFF.LST...........................................................................17STRUCTURE OF FULLIMAGE.LST..........................................................................................18SAMPLE FULLIMAGE.LST ..................................................................................................18

SOFTTHINKS SCHEDULING PROCESS ...................................................................19

STRUCTURE OF SCHEDULER.INI.............................................................................................19SAMPLE SCHEDULER.INI .....................................................................................................21

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 4: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 4 of 26

CHANGES IN HP BACKUP AND RECOVERY MANAGER V4.1.5 FOR VISTA.............24

SAMPLE IMAGES.LST .........................................................................................................24SAMPLE SCHEDULER.INI .....................................................................................................25

END OF DOCUMENT.............................................................................................26

Additional ContributorsThe following individuals have all contributed ideas, material and comments to this specification.

• Christoph Graham ([email protected])

Revision HistoryRev. Date Description of Changes Contributor0.10 2006-08-25 Initial draft. CDas0.11 2006-08-29 Minor corrections CGraham0.12 2006-08-31 Added HP_SchedulerService.RemoveTask() CGraham0.13 2006-09-14 Extend support for multi-user Scheduler.ini

files, AddedHP_SchedulerService.CreateTask()

CDas

0.14 2006-10-12 Provided more details on Method input andoutput parameters and minor corrections

CDas

0.15 2006-10-13 Changed provider namespace to beconsistent with marketing name

CDas

0.16 2006-10-19 -Added ScheduleType = 6 to create a onetime backup.-Write the updates to disk immediately afterthe method calls instead of in the destructor.-Check for atleast one Full Drive Backupbefore allowing to schedule a Recovery Point.

CDas

0.17 2006-10-31 -Fixed syntax error in mof file CDas0.18 2006-11-30 Added format of INI files used by provider CDas0.19 2006-11-30 Additional edits CGaham0.20 2007-04-19 Added support for v4.5.1 of HP Backup and

Recovery Manager software for VistaCDas

Table 1: Document Revision History and Details.

OverviewThis document outlines the supporting capabilities to facilitate management of HP Backup andRecovery features on remotely deployed computer systems throughout an enterpriseenvironment. This interface provides access to HP Backup and Recovery data through standardsbased mechanisms like WMI and is accessible by other programmatic or scripting tools.

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 5: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 5 of 26

The capabilities include enumeration of ISOs created by factory during the pre-install process,Restore Points and Full Drive Backups and any scheduled backup tasks created using the HPBackup and Recovery interface(s). Also supported are creation of new scheduled tasks, updatesand deletes of existing tasks.

HP systems are deployed with factory created images, called ISOs, on a recovery media, usuallya hidden partition on the hard drive. These images are used to restore the system to the factoryinstalled state if need be. HP Backup manageability interface provides a list of these ISOs.

SoftThinks, the vendor of HP Backup and Recovery utility, manages the backups viaconfiguration files in the system. HPQBackup instrumentation uses these configuration files toprovide access to the nature and number of backups on the system.

The scheduled tasks are also managed through configuration files. Thees tasks are managed peruser in a configuration file in the user specific application data folder. All and any of these ini filesare parsed and the backup tasks are aggregated. This aggregated task list is then replicated toall scheduler.ini files of all valid users on the system.

Required FunctionalityThis instrumentation provides the following functionality:

• Provide a public, accessible interface to the HP Backup and Recovery features.• Support listing of factory created ISOs, Full Drive Backups and Recovery points created by

HP Backup and Recovery Manager.• Support listing of all backup tasks scheduled through the HP Backup and Recovery

Scheduler.• Support creation of new tasks, exposing only a subset of the original parameter set provided

by the Scheduler and modification and deletion of existing tasks.

WMI InterfaceAll the interfaces are defined in the namespace “root\HP\BackupAnd Recovery” in the CIM objectrepository. There are 3 classes defined to expose the required functionality: HP_RecoveryPoint,HP_ScheduledBackup and HP_SchedulerService.

HP_RecoveryPointThis class is used to render the backup recovery points on the system. There are 3 types ofRecovery Points: ISOs, full drive backups and any differential recovery points. These instancesare sorted by their time of creation, from the latest to the earliest. There can be one or more ofeach type of Recovery Point. Recovery Points cannot be changed or deleted.

MOF Definition[ dynamic: ToInstance, provider("WMIProvider_HPQBackupAndRecovery"): ToInstance]class HP_RecoveryPoint{ [key, read] datetime Date; [read, ValueMap { , , , , .. }: ToInstance, Values { Unknown , "Factory ISO", "Full Partition Backup",

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 6: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 6 of 26

"Recovery Point", Reserved }: ToInstance] uint32 Type; [read] string Location; [read] string Description; [read] uint64 Size;};

PropertiesProperty Description

Date Key property uniquely identifying the backup instance. This is the datethe backup was created.

Type Denotes the type of the backup.0: Unknown or uninitialized value.1: Factory ISO2: Full Partition Backup3: Differential Backup

Location Path where backup is created. This can be the string “Local” if thebackup is on the local drive, or UNC path if on the network.

Description Description of the backup as entered in the HP Backup Manager.

Size Size of backup in bytes.

ExampleHere are some sample instances of HP_RecoveryPoint:

instance of HP_RecoveryPoint{ Date = "20060817102544.000000-300"; Type = 1; Location = "Local"; Description = "First Full Image Backup"; Size = 8488379951;};

instance of HP_RecoveryPoint{ Date = "20060821152500.000000-300"; Type = 2; Location = "\\backupserver\share\differential"; Description = "First Recovery Point"; Size = 40103456;};

HP_ScheduledBackup

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 7: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 7 of 26

This class is used to manage instances of scheduled backup tasks created through the HPBackup and Recovery Scheduler interface. There can be 4 types of backup tasks, "Daily","Weekly", "Monthly" and "At System Start".

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 8: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 8 of 26

MOF Definition[ dynamic: ToInstance, provider("WMIProvider_HPQBackupAndRecovery"): ToInstance]class HP_ScheduledBackup{ [key, read] uint32 TaskId; [read] datetime CreatedTime; [ValueMap { "0", "2", "3", "4", "5", "6"}: ToInstance, Values { "Unknown", "Daily", "Weekly", "Monthly", "At SystemStartup", "Once" }: ToInstance, read] uint32 ScheduleType; [read] string Name; [ValueMap { "0", "1", "2", "3" }: ToInstance, Values { "Unknown", "Recovery Point", "Entire Drive Backup","File-based" }: ToInstance, read] uint32 BackupType; [read] datetime NextBackup; [read] string Destination; [read] boolean Reschedule; [read] boolean Protected; [read] uint32 Frequency; [ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8","9"}: ToInstance, Values { "Unknown", "1stOfMonth", "15thOfMonth", "Sunday","Monday", "Tuesday", "Wednesday", "Thursday", "Friday","Saturday"}: ToInstance, read] uint32 Days[7]; };

Properties

Property Description

TaskId Key property uniquely identifying the task.

CreatedTime This is the date and time the task was created

ScheduleType Type of the Schedule.0: Unknown2: Daily3: Weekly4: Monthly5: At System Start6: Once

Name Name of the task

BackupType Type of backup.0: Unknown1: Recovery Point2: Full Drive3: File

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 9: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 9 of 26

Property Description

NextBackup Date and time of next backup. This is calculated based on otherproperties.

Destination Path to the destination of the scheduled backup. This value is empty ifthe backup is in the local store.

Reschedule Option to wait for reboot.FALSE: Only run task if system is on at the scheduled timeTRUE: If system is off at the scheduled time, run task as soon assystem is turned on.

Protected Option to protect backup with a password.FALSE: there is no passwordTRUE: there is a password (for Entire Drive backup only)

Frequency Frequency of the schedule for monthly and weekly backups.

Days Day(s) of the Week for a Weekly backup, Sunday=3, Monday=4 etc.For monthly backups, it is an array of a single item with value of 1indicating the 1st day of the month and 2 indicating the 15th day of themonth.

ExampleHere are some sample instances of HP_ScheduledBackup:

instance of HP_Scheduledbackup{ TaskId = 1; CreatedDate = "20060817102544.000000-300"; ScheduleType = 2; //Daily Name = First Daily Backup ; BackupType = 0; //Recovery Point NextBackup = "20060818100000.000000-300"; Destination = ; Reschedule = 1; Protected = 1;};

instance of HP_Scheduledbackup{ TaskId = 2; CreatedDate = "20060818102544.000000-300"; ScheduleType = 3; //Weekly Name = First Weekly Backup ; BackupType = 0; //Recovery Point NextBackup = "20060821160000.000000-300"; Destination = \\server\share\weekly backup ; Reschedule = 1; Protected = 1; Frequency = 2; //Every 2 weeks

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 10: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 10 of 26

Days[0] = Days[1] = ; //Monday and Wednesday};

HP_SchedulerService

DescriptionThe HP_SchedulerService class provides access to methods that support the creation,modification and removal of task objects (HP_ScheduledBackup instances).

As we noticed differences in the INI files in Desktops and Mobile products, we currently supportDesktop versions only. This is accomplished by checking the version ofc:\windows\Sminst\Scheduler.exe. If this version is 1.0.4.0 or above, the methods work asintended. Otherwise they return ‘Method not supported’ errors.

MOF Definition[ dynamic: ToInstance, provider("WMIProvider_HPQBackupAndRecovery"): ToInstance]class HP_SchedulerService{ [key, read] string ServiceName; [read] string ServiceVersion; ...};

ParametersProperty Description

ServiceName Key property identifying the HP Backup and Recovery provider.

ServiceVersion String value representing the version of the HP Backup and Recoveryprovider interface.

ExampleN/A

HP_SchedulerService.UpdateTask()

DescriptionThe UpdateTask method is used to modify the properties of an existing task identified by theparameter TaskId. The return value is a flag indicating the success (E_SUCCESS) or failure(E_FAILED) of the write. The output parameter, Return gives more detailed error code on failure.

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 11: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 11 of 26

This function is reserved for future use. Right now it always returns ‘Method not supported’ error.To update an existing task, create a new one with the updated attributes and delete the existingtask.

MOF Definition[ dynamic: ToInstance, provider("WMIProvider_HPQBackupAndRecovery"): ToInstance]class HP_SchedulerService{ ... [Implemented: ToInstance] uint32 UpdateTask( [out: ToInstance, ValueMap {"0", "1", "2", "3", "4", "5"}:ToInstance, Values {"Success", "Failed", "Invalid Parameters", "ItemNot Found", "Method not Supported", "Invalid Type"}:ToInstance] uint32 Return,

[in: ToInstance] uint32 TaskId,

[in: ToInstance, ValueMap { "0", "2", "3", "4", "5", "6" }: ToInstance, Values { "Unknown", "Daily", "Weekly", "Monthly", "AtSystem Startup", "Once" }: ToInstance] uint32 ScheduleType,

[in: ToInstance, ValueMap { "0", "1", "2", "3" }: ToInstance, Values { "Unknown", "Recovery Point", "Entire DriveBackup", "File-based" }: ToInstance] uint32 BackupType,

[in, Optional: ToInstance] string Name, [in, Optional: ToInstance] datetime StartTime, [in, Optional: ToInstance] string Destination, [in, Optional: ToInstance] uint32 Frequency,

[in, Optional: ToInstance, ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8","9"}: ToInstance, Values { "Unknown", "1stOfMonth", "15thOfMonth", "Sunday","Monday", "Tuesday", "Wednesday", "Thursday", "Friday","Saturday"}: ToInstance] uint32 Days[7] ); ...};

Parameters

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 12: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 12 of 26

Property Description

Return Detailed error code. (See Method Error Codes section)E_SUCCESSE_FAILEDE_INVALID_PARAME_ITEM_NOTFOUNDE_METHOD_NOT_SUPPORTEDE_ INVALID_SCHEDULETYPE

TaskId Key property uniquely identifying the task to be updated. Enter NULLfor a new task.

ScheduleType Type of the Schedule.2: Daily3: Weekly4: Monthly5: At System Start (NOT SUPPORTED)6: Once (run only one time)

BackupType Type of backup.1: Recovery Point2: Full Partiton3: File (NOT SUPPORTED)

Name Name of the task

StartTime Start time of scheduled backup.

Destination Path to the destination of the scheduled backup. Set to empty if thebackup should be created in the local store.

Frequency Frequency of the schedule for monthly and weekly backup tasks. Thisparameter is ignored for daily and ‘once’ backups tasks. Default is 1.

Days This parameter contains a value representing the day that theschedule backup is to occur, relative to the value contained in theproperty ScheduleType.If ScheduleType is 2 (Daily) then this value is ignored.If ScheduleType is 3 (Weekly) then this value indicates the day of theweek to perform a backup on, where a value of 1 indicates Sundayamd a value of 7 indicates Saturday. Values outside the range of 1-7are not supported.If ScheduleType is 4 (Monthly) then this value is used to calculate thenumber of days from the beginning of the month until when the backupis to occur. A value of 0 indicates the backup is to occur on the 1st dayof the month. A value of 1 indicates the backup is to occur on the 15th

day of the month.

ExampleN/A

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 13: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 13 of 26

HP_SchedulerService.CreateTask()

Description:The CreateTask method is used to create a new task. The return value is a flag indicating thesuccess (E_SUCCESS) or failure (E_FAILED) of the write. The output parameter, Return givesmore detailed error code on failure.

MOF Definition[ dynamic: ToInstance, provider("WMIProvider_HPQBackupAndRecovery"): ToInstance]class HP_SchedulerService{ ... [Implemented: ToInstance] uint32 CreateTask( [out: ToInstance, ValueMap {"0", "1", "2", "3", "4", "5"}:ToInstance, Values {"Success", "Failed", "Invalid Parameters", "ItemNot Found", "Method not Supported", "Invalid Type"}:ToInstance] uint32 Return,

[in: ToInstance, ValueMap { "0", "2", "3", "4", "5", "6" }: ToInstance, Values { "Unknown", "Daily", "Weekly", "Monthly", "AtSystem Startup", "Once" }: ToInstance] uint32 ScheduleType,

[in: ToInstance, ValueMap { "0", "1", "2", "3" }: ToInstance, Values { "Unknown", "Recovery Point", "Entire DriveBackup", "File-based" }: ToInstance] uint32 BackupType,

[in, Optional: ToInstance] string Name, [in, Optional: ToInstance] datetime StartTime, [in, Optional: ToInstance] string Destination, [in, Optional: ToInstance] uint32 Frequency,

[in, Optional: ToInstance, ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8","9"}: ToInstance, Values { "Unknown", "1stOfMonth", "15thOfMonth", "Sunday","Monday", "Tuesday", "Wednesday", "Thursday", "Friday","Saturday"}: ToInstance] uint32 Days[7]

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 14: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 14 of 26

); ...};

Parameters

Property Description

Return Detailed error code. (See Method Error Codes section)E_SUCCESSE_FAILEDE_INVALID_PARAME_ITEM_NOTFOUNDE_METHOD_NOT_SUPPORTEDE_ INVALID_SCHEDULETYPE

ScheduleType Type of the Schedule. This parameter is required to create a newtask. If it is not provided, the function returns error.2: Daily3: Weekly4: Monthly5: At System Start (NOT SUPPORTED)6: Once (run only one time)

BackupType Type of backup. This parameter is required to create a new task. If itis not provided, the function returns error.1: Recovery Point2: Full Partiton3: File (NOT SUPPORTED)

Name Name of the task. If this parameter is not provided, a default name isused.

StartTime Start time of scheduled backup. If this parameter is not provided orempty, current date and time are used. To run a backup NOW, setScheduleType to 6 (Once) and set this value to empty.

Destination Path to the destination of the scheduled backup. If this parameter isempty, the backup repository is used as destination.

Frequency Frequency of the schedule for monthly and weekly backup tasks. Thisparameter is ignored for daily and ‘once’ backup tasks. If no value isprovided for weekly and monthly backups, a default value of 1 is used.

Days This parameter contains a value representing the day that theschedule backup is to occur, relative to the value contained in theproperty ScheduleType.If ScheduleType is 2 (Daily) or 6 (Once), then this value is ignored.If ScheduleType is 3 (Weekly) then this value indicates the day of theweek to perform a backup on, where a value of 3 indicates Sundayand a value of 9 indicates Saturday. Values outside the range of 3-9are not supported and ignored. If this value is not provided, thecurrent day is used.

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 15: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 15 of 26

Property Description

If ScheduleType is 4 (Monthly) then this value is used to calculate thenumber of days from the beginning of the month until when the backupis to occur. A value of 1 indicates the backup is to occur on the 1st dayof the month. A value of 2 indicates the backup is to occur on the 15th

day of the month. Any other values are ignored. If this value is notprovided, if current date falls between 1 and 14, 1st is used, otherwise15th is used.

ExampleHere are some sample calls to CreateTask():

1. To create a daily incremental backup at 4pm:

CreateTask(2, Daily incremental backup , 1,20061001160000.000000:000 , );

2. To create a weekly full drive backup on Mondays and Fridays at 7am at \\server\share:

CreateTask(3, Weekly Full drive backup , 2,20061001070000.000000:000 , \\server\share , 1, [4][8]);

3. To create a SINGLE entire drive backup NOW:

CreateTask(6, Entire Drive Backup NOW , 2);

4. To create a ONE TIME recovery point on 10/25/2006 at 8am:

CreateTask(6, One time recovery point , 1,20061025080000.000000:000 );

HP_SchedulerService.RemoveTask()

Description:The RemoveTask method provides a capability to remove HP Backup and Recovery scheduledtask (HP_ScheduledBackup instances).

MOF Definition[ dynamic: ToInstance, singleton, provider("WMIProvider_HPQBackupAndRecovery"): ToInstance]class HP_SchedulerService{ ...

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 16: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 16 of 26

[Implemented: ToInstance] uint32 RemoveTask( [out: ToInstance, ValueMap {"0", "1", "2", "3", "4"}:ToInstance, Values {"Success", "Failed", "Invalid Parameters", "ItemNot Found", "Method not Supported"}: ToInstance] uint32 Return, [in: ToInstance] uint32 TaskId ); ...};

Parameters

Property Description

TaskId Key property uniquely identifying the task to be removed.

ExampleN/A

Method Error Codes

Error Description

0 E_SUCCESSMethod succeeded.

1 E_FAILEDMethod failed. Look at Return output parameter for more details.

2 E_INVALID_PARAMEither one of the required parameters to the function is not provided(empty) or the value is outside the defined range.

3 E_ITEM_NOTFOUNDThe TaskId provided is not found.

4 E_METHOD_NOT_SUPPORTEDMethod is not supported.

5 E_ INVALID_SCHEDULETYPEThere is no Full Drive Backup on the system but a Recovery Point isbeing scheduled which is not allowed.

Configuration File Format

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 17: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 17 of 26

HP Backup and recovery utility, provided by SoftThinks, manages the full backups and recoverypoints in configuration files on the system.

Structure of NETUSERDIFF.LST/USERDIFF.LSTEach time the user creates a new recovery point in a shared folder on a network or in a folderlocated on another hard disk, the features of that recovery point are stored in a specific file,NETUSERDIFF.LST. In case of a local recovery point creation, the file is USERDIFF.LST. Thesefiles are located in the “WINDOWS\SMINST\” folder and in the root of the recovery partition.These files only list the existing recovery points. If some of them were deleted or moved toCD/DVD for example, their entries are simply removed.

The HP Backup and Recovery WMI Provider uses these files to provide programmatic access tobackup and recovery points on the system.

[Network_Path]This section contains all the network paths where recovery pointswere created for the PC. Each path corresponds to a section.

[Path_1]Login=By default, the login value is set to match the login of the current Windows userwho is logged.Password=By default the password value is set to * .Date=Creation date of the first recovery point stored in that location (format:YYYY/MM/DD HH:MM:SS).UserDiff.0=description|date (format: YYYY/MM/DD HH:MM:SS)|size (MB)UserDiff.1= description|date|sizeUserDiff.n= description|date|sizeThese values contain the information about each recovery pointstored in that location, from the first one to the last one.

[Local]This section contains all the local recovery points for the PC.

Sample NETUSERDIFF.LST/USERDIFF.LST[Network_Path]\\testsvr\e$\backup

[\\testsvr\e$\backup]Login=AdministratorPassword=*IP_Adress=16.100.169.6Mask=255.255.252.0Gateway=16.100.168.1DNS1=16.81.3.242DNS2=16.81.3.243Use_DHCP=yesDomain=AMERICAS

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 18: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 18 of 26

Date=2006/08/06 17:15:23UserDiff.0=Second Recovery Point on the network|2006/08/0617:20:54|4156UserDiff.1=Third Recovery Point on the network|2006/08/0617:40:34|4155

[Local]Date=2006/08/05 10:10:43UserDiff.0=First Recovery Point after full backup|2006/08/0510:09:54|2346

Structure of FULLIMAGE.LSTEach time the user creates a new entire drive backup, the features of that backup are stored intoa specific file, FULLIMAGE.LST. This file is located in the “WINDOWS\SMINST\” folder and in theroot of the recovery partition.

[Network_Path]This section contains all the network paths where entire drivebackups were created for the PC. Each path corresponds to asection.

[Path_1]Login=By default, the login value is set to match the login of the current Windows userwho is logged.Password=By default the password value is set to * .Date=Creation date of the entire drive backup stored in that location (format:YYYY/MM/DD HH:MM:SS).Size=Size of the entire drive backup (in bytes). This is thetotal size of all files included in the entire drive backup.Size_INP=Size of the folder where the entire drive backup islocated.

Sample FULLIMAGE.LST[Network_Path]\\testsvr\e$\backupfull

[\\testsvr\e$\backupfull]Login=AdministratorPassword=*IP_Adress=16.100.169.6Mask=255.255.252.0Gateway=16.100.168.1DNS1=16.81.3.242DNS2=16.81.3.243Use_DHCP=yesDomain=AMERICASDate=2006/08/09 17:15:23

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 19: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 19 of 26

Size=11535887610Size_INP=11535887610Description=Second Full Backup on the network

[Local]Date=2006/08/04 10:10:43Size=2144668882Size_INP=2154860154Description= First Full backup

The HP Backup and Recovery WMI Provider uses these files to provide programmatic, read-onlyaccess to backup and recovery points on the system. Below is an enumeration of these backupsby the provider from CIM Studio, showing only the relevant fields.

SoftThinks’ Scheduling ProcessThe SoftThinks’ scheduling process doesn’t use Windows task scheduling but uses a silentexecutable, Scheduler.exe. Recovery Point and Entire Drive Backup creation can be scheduledupon different events (PC start, docking event, etc.) and frequencies (daily, weekly, monthly,etc.).

All the scheduled tasks are stored into an INI file, read each minute by the silent executable. ThisINI file is unique per user, and is stored in the “DOCUMENTS AND SETTINGS\<USER>\LOCALSETTINGS\APPLICATION DATA\SoftThinks” folder.

Structure of Scheduler.INI[GENERAL]Begin of the general schedule

TASK=1Number of tasks scheduled

Date Class Description Location Size Type

08/04/200610:10:43

HP_RecoveryPoint First Full backup Local 2144668882 2

08/05/200610:09:54

HP_RecoveryPoint First Recovery Pointafter full backup

Local 2346 3

08/06/200617:20:54

HP_RecoveryPoint Second RecoveryPoint on the network

\\testsvr\e$\backup

4156 3

08/06/200617:40:34

HP_RecoveryPoint Third RecoveryPoint on the network

\\testsvr\e$\backup

4155 3

08/09/200617:15:23

HP_RecoveryPoint Second Full Backupon the network

\\testsvr\e$\backupfull

11535887610 2

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 20: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 20 of 26

[TASK_1]First schedule

TYPE=4Type of the schedule: 2 = daily 3 = weekly 4 = monthly 5 = at system start

TIME=1000Time of the schedule: 10h amIf it is a daily or weekly schedule, there is the date before thehour

NUMMONTH=032006 (NUMWEEK= + NUMYEAR= + DAY= for a weeklyschedule)Month of the next schedule

REP=4Frequency of the schedules (here every four month)

TYPEMONTH=10 = every first day of the month1 = every 15 of the month

REBOOT=1= 0 if the PC is open at time= 1 if the PC is close at time (option in the scheduler)

PWD=1= 0 if there is no password= 1 if there is a password (for Entire drive Backup)

FULL=1= 0 if it is a Recovery Point= 1 if it is an Entire drive Backup

DISK=1= 0 if the Entire drive Backup is on a partition of the disc= 1 if the Entire drive Backup is on the entire hard disc

[PART=D:=the description of the partition to backup if the DISK=0]

DEST=3= 0 if the destination of the schedule is at last destination= 1 if the destination is on the PC= 2 if it is on network drive= 3 if it is on another drive

DEST_DIRECTORY=D:\New FolderIf the DEST is another drive, description of the folder

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 21: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 21 of 26

If the DEST is network, there are four new lines:

NET_PATH= \\Server\FolderPath on the network

NET_USER=user nameName of the user on the network

NET_DOMAIN=WORKGROUPDomain of the network

NET_PWD= ******Password of user on the network

Sample Scheduler.INI[[GENERAL]TASK=3

[TASK_1]TYPE=2TIME=180820061315REBOOT=0PWD=0FULL=0NAME=Schedule Event #1 - DailyCreated=18/08/2006 08:20DISK=1DEST=1

[TASK_2]TYPE=3TIME=1215NUMWEEK=33NUMYEAR=2006DAY=24REP=2REBOOT=0PWD=1PWD_VALUE="Y8a �h í´"FULL=1NAME=Schedule Event #2 - weeklyCreated=18/08/2006 10:29DEST=1

[TASK_3]TYPE=4TIME=1000NUMMONTH=102006REP=2

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 22: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 22 of 26

TYPEMONTH=1REBOOT=1PWD=0FULL=1NAME=Schedule Event #3 - monthlyCreated=28/08/2006 10:25DISK=1DEST=2NET_PATH=\\testsvr\e$\backup\schedule_backupNET_USER=AdministratorNET_DOMAIN=WORKGROUPNET_PWD="J"

The HP Backup and Recovery WMI Provider uses these files to provide programmatic, read-writeaccess to scheduler tasks. All and any of these ini files are parsed and the backup tasks areaggregated. This aggregated task list is then replicated to all scheduler.ini files of all valid userson the system.

Below is an enumeration of these tasks on 11/30/2006, by the provider from CIM Studio, showingonly the relevant fields. The field NextBackup is the date and time the next back up is scheduledto occur, calculated from other fields depending on the type of schedule.

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 23: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 23 of 26

TaskId Details

1 __Class=HP_ScheduledBackup

BackupType (FULL)=1

CretedTime (Created)=08/18/2006 08:20A

Days (DAY/TYPEMONTH)=Null

Destination (NET_PATH)=Null

Frequency (REP)=Null

Name (NAME)= Schedule Event #1 – Daily

NextBackup=08/19/2006 1:15P

Protected (PWD)=False

Reschedule (REBOOT)=False

SchduleType (TYPE)=2

2 __Class=HP_ScheduledBackup

BackupType (FULL)=2

CreatedTime (Created)=08/18/2006 10:29A

Days (DAY/TYPEMONTH)=4,6

Destination (NET_PATH)=Null

Frequency (REP)=2

Name (NAME)= Schedule Event #2 – weekly

NextBackup=12/04/2006 12:15A

Protected (PWD)=True

Reschedule (REBOOT)=False

SchduleType (TYPE)=3

3 __Class=HP_ScheduledBackup

BackupType (FULL)=2

CreateTime (Created)=08/28/2006 10:25A

Days (DAY/TYPEMONTH)=2

Destination (NET_PATH)=\\testsvr\e$\backup\schedule_backup

Frequency (REP)=2

Name (NAME)= Schedule Event #3 – monthly

NextBackup=12/15/2006 10:00A

Protected (PWD)=False

Reschedule (REBOOT)=True

SchduleType (TYPE)=4

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 24: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 24 of 26

Changes in HP Backup and Recovery Manager v4.1.5 for VistaBoth Entire Drive Backups (EDB) and Recovery point backups are now tracked in a single filenamed Images.LST in the installation directory (Windows\SMINST). The provider uses this newformat if the following 2 conditions are met, the operating system is Vista and the ‘Image.Lst ver4.0’ tag is present in the beginning of the file. Otherwise it is processed in the old format.

Sample Images.LSTImage.Lst ver 4.0

[Images]NbImages=2Image1=ImageSection0000Image2=ImageSection0001[ImageSection0000]Type=EDBLocation=LocalPath=C:\System Recovery\FULLIMAGEDescription=Entire1 by ChetCreationDate=20070413 16:55:35Size=3066183906UncompressedSize=11951055367DiskName=SAMSUNG HD080HJ/P ATA DevicePnP=DiskSAMSUNG_HD080HJ/P_______________________ZH100-46Hash=176200068743PartitionNumber=0Login=LockLogin=noPwd=Domain=Use_DHCP=noIP_Address=Mask=Gateway=DNS1=DNS2=[ImageSection0001]Type=RePoLocation=LocalPath=C:\System Recovery\USERDIFF.0Description=First recovery by chetCreationDate=20070417 17:38:04Size=128647649UncompressedSize=505654919DiskName=SAMSUNG HD080HJ/P ATA DevicePnP=DiskSAMSUNG_HD080HJ/P_______________________ZH100-46Hash=176200068743PartitionNumber=0Login=LockLogin=no

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 25: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 25 of 26

Pwd=Domain=Use_DHCP=noIP_Address=Mask=Gateway=DNS1=DNS2=

Changes in Scheduler.ini include,

- DAILY backup tasks include a frequency parameter stored in the DAYS attribute

- DEST attribute is not used

- TYPE is interpreted differently. For new version, EDB = 0; RP =1 and for old version,EDB = 1; RP =0

- DEST_DIRECTORY attribute is now required for Vista. If this parameter is not specifiedfor a EDB, the HP B&R manager brings up a dialog which waits for user input. If thisparameter is provided, the EDB is created at the scheduled time without any user action.If this parameter is empty in the CreateTask() call, the WMI provider uses a default path,C:\System Recovery. Where as in the XP version if this parameter is empty, the HP B&Rmanager uses a default path and does not wait for user input.

Sample Scheduler.INI[GENERAL]TASK=8[TASK_1]Name=DailyType=2Time=210420072020Day=1FULL=1Reboot=0DEST_DIRECTORY=C:\System RecoveryCreated=20/04/2007 20:21[TASK_2]Name=WeeklyType=3Time=2022Reboot=0Day=1246Rep=3NumWeek=16NumYear=2007FULL=1DEST_DIRECTORY=C:\System RecoveryCreated=20/04/2007 20:23[TASK_3]Name=MonthlyType=4Time=2023

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages

Page 26: Click Here & Upgrade Expanded Features Documents€¦ · HP Backup and Recovery Manager Software Provider PSG bPC R&D Design Specification HP Confidential 11.30.2006 Page 1 of 26

HP Backup and Recovery Manager Software ProviderPSG bPC R&D Design Specification

HP Confidential 11.30.2006Page 26 of 26

Reboot=0TypeMonth=0Rep=5NumMonth=092007FULL=1DEST_DIRECTORY=C:\System RecoveryCreated=20/04/2007 20:23LASTLAUNCH=200420072024[TASK_4]Name=SystemStartType=5AFTERSTART=5ONLYONEPERDAY=1FULL=1DEST_DIRECTORY=C:\System RecoveryCreated=20/04/2007 20:24

End of Document

DocumentsPDFComplete

Click Here & UpgradeExpanded Features

Unlimited Pages