Parameter Reference
Complete guide to configuration and runtime parameters
Setting Parameters
Use param <name> <value>; to set parameters. Use show; to view current values.
This documentation applies to Linux and source versions MongoDB 6.0.0, 7.0.0 and 8.0.0. Freeze source copies and launch PDU from a directory outside the sources. State and output use the launch directory without separate path settings. Confirm other versions and special layouts separately.
Configuration File (pdu.ini)
MONGODBDATAComplete frozen WiredTiger data directory. Directory recovery requires matching metadata, catalog and collection files.
MONGODBDATA=/recovery-input/mongodb/source/dbpathDISK_PATHSingle-file or image source, distinct from directory sources.
DISK_PATH=RESTYPERecovery type for scan and restore: delete or update, without positional operation arguments.
RESTYPE=deleteRECOVERY_ATSource MongoDB logical time in SECONDS:INCREMENT, mutually exclusive with recoverytime.
RECOVERY_AT=noneRECOVERY_TIMERequires Z or an explicit time zone and accepts only a unique recorded oplog commit wall-clock boundary, without interpolation.
RECOVERY_TIME=noneCATALOG_SALVAGERetain independent catalog, UUID, ident and WT-definition relationships when metadata is missing, without reconstructing Turtle roots or guessing attribution.
CATALOG_SALVAGE=falseJOURNAL_COMPRESSORChoose snappy, zlib, zstd or none to match the original WT logs, without guessing.
JOURNAL_COMPRESSOR=snappySOURCE_VERSIONRequiredDeclare the exact source version. Source versions covered here are 6.0.0, 7.0.0 and 8.0.0. unknown allows corresponding metadata probing without guessing the version.
SOURCE_VERSION=unknownSOURCE_KINDRequiredcopy denotes a file or directory copy; imagecopy denotes an image copy.
SOURCE_KIND=unknownSOURCE_FROZENRequiredExplicitly declare frozen sources. The declaration does not replace consistency preservation by the source engineer.
SOURCE_FROZEN=falseMIN_FREE_BYTESMinimum free-space guard before execution, in bytes.
MIN_FREE_BYTES=1073741824RESMODEcurrent reads the selected checkpoint; history reads historical sources; all retains physical versions permitted by the selected path. Scope differs by path.
RESMODE=currentEXMODEbson exports BSON; json exports Canonical Extended JSON line files.
EXMODE=bsonHS_SOURCE_ABIRetain limits when the source ABI is unknown. Explicit le64 applies to corresponding reverse MODIFY parsing without automatic assumption.
HS_SOURCE_ABI=unknownDSOFFConfirmed scan start offset, in bytes.
DSOFF=0SCAN_ENDExclusive end position for unmapped imagecopy/all scanning. Set from actual sources without fabricating a file map.
SCAN_END=0SCAN_STEPScan step, in bytes.
SCAN_STEP=512EXTENT_MAPDeclared logical-extent mapping for one file, retaining holes and source relationships.
EXTENT_MAP=DIRECTORY_EXTENTSDeclared block-source manifest for missing directory files. A readable directory root and matching metadata are required.
DIRECTORY_EXTENTS=OPERATION_FROMFor ds preimage only: inclusive lower operation-timestamp bound, formatted SECONDS:INCREMENT.
OPERATION_FROM=noneOPERATION_BEFOREFor ds preimage only: exclusive upper operation-timestamp bound. Reset both bounds to none before ordinary scan/restore.
OPERATION_BEFORE=noneRuntime Path Parameters
datapathstringDefault: unsetComplete frozen WiredTiger data directory. Directory recovery requires matching metadata, catalog and collection files.
param datapath /recovery-input/mongodb/source/dbpath;diskpathstringDefault: unsetSingle-file or image source, distinct from directory sources.
param diskpath /recovery-input/mongodb/source/collection-1.wt;Incident-Time and Source Parameters
restypestringDefault: deleteRecovery type for scan and restore: delete or update, without positional operation arguments.
param restype update;recoveryattimestampDefault: noneSource MongoDB logical time in SECONDS:INCREMENT, mutually exclusive with recoverytime.
param recoveryat 1700000000:1;recoverytimedatetimeDefault: noneRequires Z or an explicit time zone and accepts only a unique recorded oplog commit wall-clock boundary, without interpolation.
param recoverytime 2026-10-04T10:00:00Z;catalogsalvagebooleanDefault: falseRetain independent catalog, UUID, ident and WT-definition relationships when metadata is missing, without reconstructing Turtle roots or guessing attribution.
param catalogsalvage true;journalcompressorstringDefault: snappyChoose snappy, zlib, zstd or none to match the original WT logs, without guessing.
param journalcompressor snappy;Source Parameters
sourceversionstringDefault: unknownDeclare the exact source version. Source versions covered here are 6.0.0, 7.0.0 and 8.0.0. unknown allows corresponding metadata probing without guessing the version.
param sourceversion 8.0.0;sourcekindstringDefault: unknowncopy denotes a file or directory copy; imagecopy denotes an image copy.
param sourcekind copy;sourcefrozenbooleanDefault: falseExplicitly declare frozen sources. The declaration does not replace consistency preservation by the source engineer.
param sourcefrozen true;minfreebytesintegerDefault: 1073741824Minimum free-space guard before execution, in bytes.
param minfreebytes 1073741824;Recovery Parameters
resmodestringDefault: currentcurrent reads the selected checkpoint; history reads historical sources; all retains physical versions permitted by the selected path. Scope differs by path.
param resmode history;exmodestringDefault: bsonbson exports BSON; json exports Canonical Extended JSON line files.
param exmode bson;hssourceabistringDefault: unknownRetain limits when the source ABI is unknown. Explicit le64 applies to corresponding reverse MODIFY parsing without automatic assumption.
param hssourceabi le64;Scan Range Parameters
dsoffintegerDefault: 0Confirmed scan start offset, in bytes.
param dsoff 193;scanendintegerDefault: 0Exclusive end position for unmapped imagecopy/all scanning. Set from actual sources without fabricating a file map.
param scanend 24512;scanstepintegerDefault: 512Scan step, in bytes.
param scanstep 512;extentmapstringDefault: unsetDeclared logical-extent mapping for one file, retaining holes and source relationships.
param extentmap /recovery-input/mongodb/source/collection-extents.json;directoryextentsstringDefault: unsetDeclared block-source manifest for missing directory files. A readable directory root and matching metadata are required.
param directoryextents /recovery-input/mongodb/source/directory-extents.json;Operation Range Parameters
operationfromtimestampDefault: noneFor ds preimage only: inclusive lower operation-timestamp bound, formatted SECONDS:INCREMENT.
param operationfrom 1700000000:1;operationbeforetimestampDefault: noneFor ds preimage only: exclusive upper operation-timestamp bound. Reset both bounds to none before ordinary scan/restore.
param operationbefore 1700000010:1;