|
OpenSim
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
|
OpenSim
|
AutoBackupModule: save OAR region backups to disk periodically More...
Properties | |
| bool | IsSharedModule [get] |
| Required by framework. More... | |
 Properties inherited from OpenSim.Region.Framework.Interfaces.IRegionModuleBase | |
| string | Name [get] |
| Type | ReplaceableInterface [get] |
| If this returns non-null, it is the type of an interface that this module intends to register. This will cause the loader to defer loading of this module until all other modules have been loaded. If no other module has registered the interface by then, this module will be activated, else it will remain inactive, letting the other module take over. This should return non-null ONLY in modules that are intended to be easily replaceable, e.g. stub implementations that the developer expects to be replaced by third party provided modules. More... | |
Additional Inherited Members |
AutoBackupModule: save OAR region backups to disk periodically
Config Settings Documentation. Each configuration setting can be specified in two places: OpenSim.ini or Regions.ini. If specified in Regions.ini, the settings should be within the region's section name. If specified in OpenSim.ini, the settings should be within the [AutoBackupModule] section. Region-specific settings take precedence.
AutoBackupModuleEnabled: True/False. Default: False. If True, use the auto backup module. This setting does not support per-region basis. All other settings under [AutoBackupModule] are ignored if AutoBackupModuleEnabled is false, even per-region settings! AutoBackup: True/False. Default: False. If True, activate auto backup functionality. This is the only required option for enabling auto-backup; the other options have sane defaults. If False for a particular region, the auto-backup module becomes a no-op for the region, and all other AutoBackup* settings are ignored. If False globally (the default), only regions that specifically override it in Regions.ini will get AutoBackup functionality. AutoBackupInterval: Double, non-negative value. Default: 720 (12 hours). The number of minutes between each backup attempt. If a negative or zero value is given, it is equivalent to setting AutoBackup = False. AutoBackupBusyCheck: True/False. Default: True. If True, we will only take an auto-backup if a set of conditions are met. These conditions are heuristics to try and avoid taking a backup when the sim is busy. AutoBackupSkipAssets If true, assets are not saved to the oar file. Considerably reduces impact on simulator when backing up. Intended for when assets db is backed up separately AutoBackupKeepFilesForDays Backup files older than this value (in days) are deleted during the current backup process, 0 will disable this and keep all backup files indefinitely AutoBackupScript: String. Default: not specified (disabled). File path to an executable script or binary to run when an automatic backup is taken. The file should really be (Windows) an .exe or .bat, or (Linux/Mac) a shell script or binary. Trying to "run" directories, or things with weird file associations on Win32, might cause unexpected results! argv[1] of the executed file/script will be the file name of the generated OAR. If the process can't be spawned for some reason (file not found, no execute permission, etc), write a warning to the console. AutoBackupNaming: string. Default: Time. One of three strings (case insensitive): "Time": Current timestamp is appended to file name. An existing file will never be overwritten. "Sequential": A number is appended to the file name. So if RegionName_x.oar exists, we'll save to RegionName_{x+1}.oar next. An existing file will never be overwritten. "Overwrite": Always save to file named "${AutoBackupDir}/RegionName.oar", even if we have to overwrite an existing file. AutoBackupDir: String. Default: "." (the current directory). A directory (absolute or relative) where backups should be saved. AutoBackupDilationThreshold: float. Default: 0.5. Lower bound on time dilation required for BusyCheck heuristics to pass. If the time dilation is below this value, don't take a backup right now. AutoBackupAgentThreshold: int. Default: 10. Upper bound on # of agents in region required for BusyCheck heuristics to pass. If the number of agents is greater than this value, don't take a backup right now Save memory by setting low initial capacities. Minimizes impact in common cases of all regions using same interval, and instances hosting 1 ~ 4 regions. Also helps if you don't want AutoBackup at all.
Definition at line 104 of file AutoBackupModule.cs.
|
get |
Required by framework.
Definition at line 133 of file AutoBackupModule.cs.
1.8.6