mongocli atlas liveMigrations create
On this page
mongocli atlas
commands are now deprecated because there's a new, dedicated CLI available for Atlas users. Migrate to the Atlas CLI to enjoy the same capabilities and the latest features. You can use mongocli atlas
commands until April 30, 2023.Create one new migration.
Your API Key must have the Organization Owner role to successfully run this command.
Syntax
mongocli atlas liveMigrations create [options]
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. | |
-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. |
--orgId | string | false | Organization ID to use. Overrides the settings in the configuration file or environment variable. |
-o, --output | string | false | Output format. Valid values are json, json-path, go-template, or go-template-file. |
--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. | |
-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. |
Inherited Options
Name | Type | Required | Description |
---|---|---|---|
-P, --profile | string | false | Profile to use from your configuration file. |