Each ingestion method exposes a different set of fields on the Source tab of the dSource creation wizard. The sections below provide a field reference for each supported method. Select the method that best fits your source topology and backup strategy.

onlinemongodump

Uses mongodump against a live source replica set or standalone instance. Delphix initiates the backup directly.

Zero Touch Production: No.

Prerequisites

  • Source and staging instances must meet the requirements in Requirements for MongoDB staging/target environments.

  • For MongoDB Atlas, obtain the MongoDB 3.4 or earlier connection string from the Atlas UI.

Fields

  • dSource Type: Select onlinemongodump from the dropdown

  • Source MongoDB Host Connect String: Connection string for the source MongoDB instance

  • MongoDB Source Database User: Username for the source database

  • MongoDB Password: Password for the source database user

  • Staging Replicaset Name: Replica set name for the staging database. Default: dlpx_rs0

  • Staging MongoDB Host: Hostname or IP of the staging host

  • Mount Path: Mount path for dSource MongoDB instance data files

  • bindIP String: Bind IP for the staging instance. Default: 0.0.0.0

  • Staging Port: Port for the staging MongoDB dSource instance

  • Oplog Size: Size of oplogs in MB

  • Journal Commit Interval: Journal commit interval in ms

  • Storage Engine: Default: wiredTiger

  • Capture oplogs of replicaset: Enable to capture oplogs while running online mongodump

  • Mongodump Tuning Parameters: Parameter name/value pairs for the mongodump command line

  • Mongorestore Tuning Parameters: Parameter name/value pairs for the mongorestore command line

  • Enable Authentication: Enable member and client authentication on the staging database

  • Mongo Admin User: Admin user for the staging database (created on the fly)

  • MongoDB Password (admin): Admin user password for the staging database

  • Cluster Auth Mode: Accepted values: None, keyfile, x509, sendKeyFile, sendX509

  • KeyAuth keyfile name: Absolute path to the keyfile. Required when Enable Authentication is selected

  • Enable SSL/TLS: Enable SSL/TLS member authentication

  • SSL/TLS Parameters: Specify at minimum: tlsMode, tlsCAFile, tlsCertificateKeyFile

  • Enable data encryption: Enable KMIP or keyfile-based encryption

  • Encryption Method: keyfile or KMIP

  • Local Encryption keyfile: Absolute path to the local encryption keyfile

  • KMIP Parameters: KMIP connection details (e.g. kmipClientCertificateFile, kmipPort, kmipServerCAFile, kmipServerName)

  • Client Certificate: Absolute path to the client certificate for connecting to the staging database

offlinemongodump

Restores from a pre-existing mongodump backup placed on the staging host. Delphix does not connect to the source.

Zero Touch Production: Yes.

Prerequisites

  • Source and staging instances must meet the requirements in Requirements for MongoDB staging/target environments.

  • Place mongodump backup files in a directory on the staging host.

  • Create a Backup Metadata File on the staging host containing a single line with the backup datetime in MMDDYYYY_HH24MISS format.

Backups taken using the --archive=<file-path> option are not supported. The subdirectory structure of the backup must remain unchanged.

Fields

  • dSource Type: Select offlinemongodump from the dropdown

  • Staging MongoDB Host: Hostname or IP of the staging host

  • Mount Path: Mount path for dSource MongoDB instance data files

  • Staging Port: Port for the staging MongoDB dSource instance

  • Oplog Size: Size of oplogs in MB

  • Storage Engine: Default: wiredTiger

  • Backup Metadata File Name: Absolute path to the metadata file containing the backup datetime in MMDDYYYY_HH24MISS format

  • Backup directory for Mongodump: Directory on the staging host containing the mongodump backup files

  • Mongorestore Tuning Parameters: Parameter name/value pairs for the mongorestore command line

  • Enable Authentication: Enable member and client authentication on the staging database

  • Mongo Admin User: Admin user for the staging database

  • MongoDB Password (admin): Admin user password for the staging database

  • Cluster Auth Mode: Accepted values: None, keyFile, x509, sendKeyFile, sendX509

  • KeyAuth keyfile name: Absolute path to the keyfile

  • Enable SSL/TLS: Enable SSL/TLS member authentication

  • SSL/TLS Parameters: Specify at minimum: tlsMode, tlsCAFile, tlsCertificateKeyFile

  • Enable data encryption: Enable KMIP or keyfile-based encryption

  • Client CA Certificate: Absolute path to the root CA certificate that signed the client certificate

nonshardedsource

Restores from MongoDB Ops Manager backup files for a non-sharded replica set. Delphix reads from backup files and does not connect to the source.

Zero Touch Production: Yes.

Prerequisites

  • Source and staging instances must meet the requirements in Requirements for MongoDB staging/target environments.

  • Backup files must be in tar.gz or tar format. Keep file names consistent across backups.

  • Create a Backup Metadata File on the staging host in MMDDYYYY_HH24MISS format.

  • If the source database is encrypted, select Source is Encrypted and provide the corresponding encryption details.

Fields

  • dSource Type: Select nonshardedsource from the dropdown

  • Staging Replicaset Name: Replica set name for the staging database. Default: dlpx_rs0

  • Staging MongoDB Host: Hostname or IP of the staging host

  • Mount Path: Mount path for dSource MongoDB instance data files

  • Staging Port: Port for the staging MongoDB dSource instance

  • Backup Metadata File Name: Absolute path to the file containing backup datetime in MMDDYYYY_HH24MISS format

  • Config Backup / Replicaset Backup: Absolute path to the config or replica set backup file

  • Source is Encrypted: Check if the Ops Manager backup was taken from an encrypted source database

  • Source Encryption Method: KMIP or Local Encryption keyfile (visible when Source is Encrypted is selected)

shardedsource

Sets up a MongoSync synchronization pipeline between the staging database and the source sharded cluster. Fastest method for capturing incrementals of a sharded cluster.

Zero Touch Production: No.

When using mongosync ingestion, refer to the Cluster-to-Cluster Sync MongoDB documentation and the standard operating procedures in the Delphix Ecosystem Hub for mongosync-specific requirements and oplog sizing guidance.

Prerequisites

  • Source and staging instances must meet the requirements in Requirements for MongoDB staging/target environments.

  • For MongoDB Atlas, obtain the MongoDB 3.4 or earlier connection string from the Atlas UI.

  • tlsMode must be allowTLS or preferTLS for shardedsource.

Fields

  • dSource Type: Select shardedsource from the dropdown

  • Source MongoDB Host Connect String: Connection string for the source sharded cluster

  • MongoDB Source Database User: Username for the source database

  • MongoDB Password: Password for the source database user

  • Staging MongoDB Host: Hostname or IP of the staging host

  • Mount Path: Mount path for dSource MongoDB instance data files

  • Staging Port: Port for the staging MongoDB dSource instance

  • Mongos Port Number: Port for the MongoDB router (mongos) instance on staging

  • Mongosync Port Number: Available port for the mongosync utility

  • Oplog Size: Size of oplogs in MB

  • Storage Engine: Default: wiredTiger

stagingpush

You manually push source data into the Delphix-mounted path. Delphix does not initiate ingestion. Useful when your backup or replication workflow is managed externally.

Zero Touch Production: Yes.

For Staging Push, Delphix operates at the filesystem level. Use a data synchronization method that leaves data files in place and only modifies or appends them. Methods that replace files entirely may cause unexpected behavior.

After the dSource is created, Delphix only mounts its storage on the staging host. It does not initialize a MongoDB instance. You are responsible for initializing and populating the MongoDB instance on the staging host in the mounted path.

Prerequisites

  • Source and staging instances must meet the requirements in Requirements for MongoDB staging/target environments.

Fields

  • dSource Type: Select stagingpush from the dropdown

  • Staging MongoDB Host: Hostname or IP of the staging host

  • Mount Path: Mount path for dSource MongoDB instance data files. This is the path you will push source data into

  • Staging Port: Port for the staging MongoDB dSource instance

shardedstagingpush

Extends the Staging Push model to sharded cluster topologies. You manually push source sharded cluster data into the Delphix-mounted path across multiple staging nodes. Zero Touch Production: Yes.

Prerequisites

  • Source and staging instances must meet the requirements in Requirements for MongoDB staging/target environments.

Fields

  • dSource Type: Select shardedstagingpush from the dropdown

  • Source MongoDB Host Connect String: Connection string of the database to be created on the staging host

  • MongoDB Source Database User: Database username for the source

  • MongoDB Password: Database password for the source user

  • Staging MongoDB Host: Primary staging host for the sharded dSource

  • Mount Path: Mount path for dSource MongoDB instance data files

  • Staging Port: Port for the staging MongoDB dSource instance (must match the Source MongoDB Host Connect String port)

  • Number of shards in staging database: Number of shards desired in the staging database

  • Additional Nodes: Additional host environments for distributing shards across staging nodes

  • Mongos Port Number: Port for the mongos server on staging

  • Client Certificate (Optional): Absolute path to the client certificate to connect to the staging database

  • Client CA Certificate (Optional): Absolute path to the root CA certificate that signed the client certificate

Last updated
Oct 9, 2026