Docs Menu
Docs Home
/ /
Atlas CLI
/ /

atlas liveMigrations create

On this page

  • Syntax
  • Options
  • Inherited Options
  • Output

Create a new push live migration.

To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/.

Command Syntax
atlas liveMigrations create [options]
Name
Type
Required
Description
--clusterName
string
true
Human-readable label that identifies the Atlas destination cluster.
--drop
false
Flag that indicates whether this process should drop existing collections from the destination (Atlas) cluster given in --destinationClusterName before starting the migration of data from the source cluster.
--force
false
Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action.
-h, --help
false
help for create
--migrationHost
strings
true
List of hosts running the MongoDB Agent that can transfer your MongoDB data from the source (Cloud Manager or Ops Manager) to destination (Atlas) deployments. Each live migration process uses its own dedicated migration host.
-o, --output
string
false
Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
--projectId
string
false
Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
--sourceCACertificatePath
string
false
Path to the CA certificate that signed TLS certificates use to authenticate to the source Cloud Manager or Ops Manager cluster. Omit this value if --sourceSSL is not passed.
--sourceClusterName
string
true
Human-readable label that identifies the source Cloud Manager or Ops Manager cluster.
--sourceManagedAuthentication
false

Flag that indicates whether MongoDB Automation manages authentication to the source Cloud Manager or Ops Manager cluster. If you set this to true, don't provide values for --sourceUsername and --sourcePassword.

Mutually exclusive with --sourceUsername.

-p, --sourcePassword
string
false
Password that authenticates the username to the source Cloud Manager or Ops Manager cluster. Omit this value if --sourceManagedAuthentication is passed.
--sourceProjectId
string
true
Unique 24-hexadecimal digit string that identifies the source project.
--sourceSsl
false
Flag that indicates whether data source has TLS enabled.
-u, --sourceUsername
string
false

Human-readable label that identifies the SCRAM-SHA user that connects to the source Cloud Manager or Ops Manager cluster. Omit this value if --sourceManagedAuthentication is set.

Mutually exclusive with --sourceManagedAuthentication.

Name
Type
Required
Description
-P, --profile
string
false

If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.

ID LAGTIME READY FOR CUTOVER STATUS
<Id> <LagTimeSeconds> <ReadyForCutover> <Status>
← liveMigrations
cutover →