mongocli atlas quickstart
On this page
This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of MongoCLI.
Create and access an Atlas Cluster.
This command creates a new cluster, adds your public IP to the atlas access list and creates a db user to access your new MongoDB instance.
Syntax
mongocli atlas quickstart [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--accessListIp | strings | false | IP address to be allowed to access the deployment. |
--clusterName | string | false | Name of the cluster. |
-Y, --default | false | Run the Quickstart command with all the auto generated values to deploy and access an Atlas cluster. | |
--force | false | Don't ask for confirmation. | |
-h, --help | false | help for quickstart | |
--password | string | false | User’s password. |
--projectId | string | false | Project ID to use. Overrides configuration file or environment variable settings. |
--provider | string | false | Name of your cloud service provider.
Valid values: AWS|AZURE|GCP. |
-r, --region | string | false | Physical location of your MongoDB cluster.
For a complete list of supported AWS regions, see: https://docs.atlas.mongodb.com/reference/amazon-aws/#amazon-aws
For a complete list of supported Azure regions, see: https://docs.atlas.mongodb.com/reference/microsoft-azure/#microsoft-azure
For a complete list of supported GCP regions, see: https://docs.atlas.mongodb.com/reference/google-gcp/#google-gcp |
--skipMongosh | false | Don't access your deployment with MongoDB Shell. | |
--skipSampleData | false | Don't load sample data into your Atlas Cluster. | |
--tier | string | false | Tier for each data-bearing server in the cluster. (default "M0") |
--username | string | false | Username for authenticating to MongoDB. |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Profile to use from your configuration file. |
Examples
Skip setting cluster name, provider or database username by using the command options $ mongocli atlas quickstart --clusterName Test --provider GCP --username dbuserTest