Data for configuration of restore, input and output functions.
List of Global Functions
ActivateBootloader - Activate boot loader configuration if requested. Uses variable Restore::runbootloader
ClearInstalledPackagesCache - Clear cache of installed packages. Next use of GetActualInstalledPackages() function will reread installed packages.
Export - Dump the restore settings to a single map - for use by autoinstallation.
GetActualInstalledPackages - Return installed packages. Result is cached in Restore module, so only first use takes long time
GetArchiveComment - Return user comment stored in archive. Comment is stored in file info/comment.
GetArchiveDate - Return date when backup archive was created. Date is stored in archive in file info/date.
GetArchiveFiles - Return list of files in the backup archive
GetArchiveHostname - Return host name of machine on which backup archive was created. Host name is stored in archive in file info/hostname.
GetArchiveInfo - Return restore configuration
GetArchiveInstalledPackages - Return map with packages installed at backup time (form is $["package name" : "version"]).
GetArchiveName - Return name of backup archive
GetExtraPackages - Return extra packages (packages which are installed at restore time, but at restore time they are installed)
GetInputName - Return name of backup archive
GetMismatchedPackages - Return packages which have different version at backup archive and in system
GetMissingPackages - Return missing packages (packages which were installed at backup time, but at restore time they are not installed)
GetSelectedPackages - Returns selected packages (even partially).
Import - Get all restore settings - for use by autoinstallation
IsMultiVolume - Selected archive has more parts
Modified - Return modified flag
MountInput - Mount input source
Read - Read contents of archive
ReadActualInstalledPackages - Read installed packages.
ReadNextVolume - Read next volume of multi volume archive
ResetAll - Clear all settings (archive and list of installed packages)
ResetArchiveSelection - Clear all archive settings
Set - Set settings
SetRestoreSelection - Change restore selection of package.
SetSelectionProperty - Set selection in _auto client and display properties of archive
Summary - Create restore configuration summary. Used in autoinstallation restore module configuration.
TestAllVolumes - Test all volumes together
TotalFilesToRestore - Return number of files which will be unpacked from archive
TotalPackagesToRestore - Return number of packages which will be restored from archive
Umount - Umount mounted file system.
Write - Restore files from archive
List of Global Variables
restoreRPMdb - Rewrite RPM db - unapack /var/lib/rpm/* files from backup if present
runSuSEconfig - Run SuSEconfig after files are restored
runbootloader - Run lilo after files are restored
Activate boot loader configuration if requested. Uses variable Restore::runbootloader
Return value
boolean - true on success
Clear cache of installed packages. Next use of GetActualInstalledPackages() function will reread installed packages.
Return value
void
Dump the restore settings to a single map - for use by autoinstallation.
Return value
map - Dumped settings (later acceptable by Import ())
Return installed packages. Result is cached in Restore module, so only first use takes long time
Return value
map<string,string> - Map $[ "packagename" : "version" ]
Return user comment stored in archive. Comment is stored in file info/comment.
Return value
string - Archive comment
Return date when backup archive was created. Date is stored in archive in file info/date.
Return value
string - Date
Return list of files in the backup archive
Return value
list - Files in the archive
Return host name of machine on which backup archive was created. Host name is stored in archive in file info/hostname.
Return value
string - Host name
Return restore configuration
Return value
map<string, map<string, any> > - Map $[ "packagename" : $["vers" : "version", "files" : ["files in the archive"], "prefix" : "installprefix", "descr" : "Short description", "sel_type" : "X", "sel_file" : ["selected files to restore"] ] ], possible values for "sel_type" key are: "X" - restore all files from archive, " " - do not restore this package, "P" - partial restore, restore only selected files at "sel_file" key. Package name "" means files not owned by any package.
Return map with packages installed at backup time (form is $["package name" : "version"]).
Return value
map<string,string> - Installed packages at backup time
Return extra packages (packages which are installed at restore time, but at restore time they are installed)
Return value
map<string,map<string,string> > - Map $[ "packagename" : $[ "ver" : "version", "descr" : "Short description of the package"]], key description is present only if decription exists
Return packages which have different version at backup archive and in system
Return value
map<string, map <string, string> > - Map $[ "packagename" : $[ "inst": "installed version", "ver" : "version at backup time, "descr" : "Short description of the package"]], key description is present only if decription exists
Return missing packages (packages which were installed at backup time, but at restore time they are not installed)
Return value
map<string, map<string, string> > - Map $[ "packagename" : $[ "ver" : "version", "descr" : "Short description of the package"]], key description is present only if decription exists
Returns selected packages (even partially).
Return value
map<string, map> - Map with same keys as map returned by GetArchiveInfo()
Get all restore settings - for use by autoinstallation
Function parameters
map settings
Return value
boolean - True on success
Selected archive has more parts
Return value
boolean - boolen True if archive have more than one part.
Mount input source
Function parameters
string input
Return value
map - Map $[ "success" : boolean (true on success), "mpoint" : string (mount point), "file" : string (file name on the local system) ];
Read contents of archive
Function parameters
string input
Return value
boolean - True if archive was succesfully read, otherwise false (file does not exist, not tar archive, broken archive, archive not created by Backup module, ...)
Read installed packages.
Return value
map<string,string> - Map $[ "packagename" : "version" ]
Read next volume of multi volume archive
Function parameters
string input
Return value
map - Map $[ "success" : boolean (true on success), "lastvolume" : boolean (true if archive is last volume) ]
Change restore selection of package.
Function parameters
string pkgname
map selection
Return value
void
Set selection in _auto client and display properties of archive
Function parameters
map<string,map> settings
Return value
void
Create restore configuration summary. Used in autoinstallation restore module configuration.
Return value
string - rich text summary
Test all volumes together
Return value
boolean - True: all volumes are OK, false: an error occured
Return number of files which will be unpacked from archive
Return value
integer - Total selected files
Return number of packages which will be restored from archive
Return value
integer - Total selected packages