Navigation

mongocli atlas cluster start

The cluster start command resumes a paused cluster in the specified project. You can also start a cluster with the Atlas UI.

mongocli atlas cluster start <cluster-name>
[ --output|-o <output-format> ]
[ --projectId <project-ID> ]
[ --profile|-P <profile-name> ]
Note

Use -h or --help to view the command-line help for this command.

Option
Type
Description
Required?
<cluster-name>
string
Name of the cluster you want to start.
yes
--output, -o
string

Command output format. Valid values are:

  • json for output in JSON format
  • go-template for custom output using the Go template
  • go-template-file for custom output specified using the Go template file

If omitted, the command returns output in the default format.

no
--profile, -P
string
Name of the profile where the public and private keys for the project are set. If omitted, uses the default profile. To learn more about creating a profile, see Configure the MongoDB CLI.
no
--projectId
string

Unique identifier of the project. If omitted, uses the project ID in the profile or environment variable.

no

The command prints the following fields in the specified format to the terminal if the command succeeds. If the command prints an error, see Troubleshooting for recommended solutions.

Field
Returned Value
autoScaling
Configuration for automatically scaling cluster storage and tier.
autoscaling
.diskGBEnabled

State of this cluster's disk auto-scaling:

  • true if enabled
  • false if disabled

By default, Atlas disables disk auto-scaling.

backupEnabled

State of cloud backup for this cluster:

  • true if enabled
  • false if disabled
biConnector
Configuration for BI Connector for Atlas on the cluster.
biConnector
.enabled

State of BI Connector for the cluster:

  • true if enabled
  • false if disabled

The default value is false.

biConnector
.readPreference

Read preference for BI Connector on the cluster:

clusterType

Type of cluster:

  • REPLICASET
  • SHARDED
  • GEOSHARDED
diskSizeGB
Capacity, in GB, of the host's root volume.
encryptionAtRestProvider
Configuration for encryption at rest.
id
Unique identifier of the cluster.
groupId

Unique identifier of the project.

Note

Your project ID equals groupId.

labels
Returns identifying tags for the cluster. As of version 1.0.0, MongoDB uses this field to track use of monogcli.
mongoDBVersion
MongoDB version that is deployed.
mongoDBMajorVersion
Major version of MongoDB that is deployed.
mongoURI
Base connection string for the cluster.
MongoURIUpdated
Timestamp in Timestamp in ISO 8601 date and time format in UTC when someone last updated the connection string.
name
Name of the cluster.
numShards

Number of shards in the cluster:

  • 1: replica set.
  • Between 2 and 12 inclusive: sharded cluster.
paused

State of the cluster:

  • true if cluster is paused.
  • false if cluster is active.
providerBackupEnabled

State of Cloud Backup for the cluster:

  • true if enabled.
  • false if disabled.
providerSettings
Configuration for the provisioned servers on which MongoDB runs.
providerSettings
.backingProviderName

Cloud provider service on which the servers are provisioned:

  • AWS for Amazon AWS
  • GCP for Google Cloud Platform
  • AZURE for Microsot Azure
providerSettings
.instanceSizeName

Name of the cluster tier used for Atlas cluster:

Cluster Tiers
Default Storage
Default RAM
M2
2 GB
Shared
M5
5 GB
Shared
M10
10 GB
2 GB
M20
20 GB
4 GB
M30
40 GB
8 GB
M40 or R40
80 GB
16 GB
M40_NVME
380 GB
15.25 GB
M50 or R50
160 GB
32 GB
M50_NVME
760 GB
30.5 GB
M60 or R60
320 GB
64 GB
M60_NVME
1.6 TB
61 GB
M80
760 GB
131 GB
R80
750 GB
122 GB
M80_NVME
1.6 TB
122 GB
M100
1 TB
160 GB
M140 1
1 TB
192 GB
M200 or R200
1.5 TB
256 GB
M200_NVME
3.1 TB
244 GB
M300 1
2 TB
384 GB
R300
2 TB
384 GB
R400
3 TB
488 GB
M400_NVME 2
4 TB
512 GB
R700
4 TB
768 GB

1 Unavailable if providerSettings.regionName equals AP_SOUTHEAST_2.

2 Availability limited to the following regions:

  • US_EAST_1
  • US_EAST_2
  • US_WEST_2
  • EU_WEST_1
  • EU_CENTRAL_1
  • AP_NORTHEAST_1
providerSettings
.providerName

Name of the cloud service provider on which Atlas provisioned the MongoDB host:

  • AWS for Amazon AWS
  • GCP for Google Cloud Platform
  • AZURE for Microsot Azure
providerSettings
.regionName

Physical location of the cluster.

For a complete list of regions, see cloud provider reference:

replicationFactor
Number of replica set members in the cluster: 3, 5, or 7.
replicationSpec
Configuration for each region in the cluster. Each element in this object represents a region where Atlas deployed your cluster.
replicationSpec
.<region>

Physical location of the region.

Each <region> object describes the region’s priority in elections and the number and type of MongoDB nodes Atlas deploys to the region.

replicationSpec
.<region>.analyticsNodes
Number of analytics nodes in the region.
replicationSpec
.<region>.electableNodes
Number of electable nodes in the region.
replicationSpec
.<region>.priority
Election priority of the region as an integer between 0 and 7 inclusive.
replicationSpec
.<region>.readOnlyNodes
Number of read-only nodes in the region.
replicationSpecs

Returns Global Cluster zone. As mongocli can't create Global Clusters, this response includes one zone only.

Each object in this array represents a zone where Atlas deploys nodes for your Global Cluster.

replicationSpecs.id
Unique identifier of the replication object.
replicationSpecs.numShards
Number of shards to deploy in the specified zone.
replicationSpecs.zoneName
Name for the zone.
replicationSpecs.regionConfig
Configuration for the physical location of the region. Each regionsConfig object describes the region’s priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region.
replicationSpecs[n]
.regionsConfig
.<regionName>.analyticsNodes
Number of analytics nodes to deploy in the region.
replicationSpecs[n]
.regionsConfig
.<regionName>.electableNodes
Number of electable nodes for Atlas to deploy to the region.
replicationSpecs[n]
.regionsConfig
.<regionName>.priority
Election priority of the region.
replicationSpecs[n]
.regionsConfig
.<regionName>.readOnlyNodes
Number of read-only nodes for Atlas to deploy to the region.
srvAddress
connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS . The mongoURI parameter lists additional options.
stateName

Current status of the cluster:

  • IDLE
  • CREATING
  • UPDATING
  • DELETING
  • DELETED
  • REPAIRING

The following mongocli atlas cluster start command starts a sample cluster named myCluster. The command uses the default profile.

mongocli atlas cluster start myCluster --output json \
--projectId abcdefghij0fab66c7d4072e

The command prints the following to the terminal. To learn more about these fields, see Output.

{
"autoScaling":{
"diskGBEnabled":true
},
"backupEnabled":false,
"biConnector":{
"enabled":false,
"readPreference":"secondary"
},
"clusterType":"REPLICASET",
"diskSizeGB":40,
"encryptionAtRestProvider":"NONE",
"id":"5eb476f44728ba600b123456",
"groupId":"abcdefecf10fab66c7d4072e",
"mongoDBVersion":"4.4.4",
"mongoDBMajorVersion":"4.4",
"mongoURI":"mongodb://myCluster-shard-00-00.abcde.example.net:27017,myCluster-shard-00-01.abcde.example.net:27017,myCluster-shard-00-02.abcde.example.net:27017",
"mongoURIUpdated":"2020-05-07T21:07:40Z",
"mongoURIWithOptions":"mongodb://myCluster-shard-00-00.abcde.example.net:27017,myCluster-shard-00-01.abcde.example.net:27017,myCluster-shard-00-02.abcde.example.net:27017/?ssl=true\u0026authSource=admin\u0026replicaSet=atlas-1oj3sr-shard-0",
"name":"myCluster",
"numShards":1,
"paused":false,
"pitEnabled":true,
"providerBackupEnabled":true,
"providerSettings":{
"diskIOPS":120,
"encryptEBSVolume":true,
"instanceSizeName":"M30",
"providerName":"AWS",
"regionName":"US_WEST_1",
"volumeType":"STANDARD"
},
"replicationFactor":3,
"replicationSpec":{
"US_WEST_1":{
"analyticsNodes":0,
"electableNodes":3,
"priority":7,
"readOnlyNodes":0
}
},
"replicationSpecs":[
{
"id":"5eb476e89c9a0d07abd98110",
"numShards":1,
"zoneName":"Zone 1",
"regionsConfig":{
"US_WEST_1":{
"analyticsNodes":0,
"electableNodes":3,
"priority":7,
"readOnlyNodes":0
}
}
}
],
"srvAddress":"mongodb+srv://myCluster.abcde.example.net",
"stateName":"UPDATING",
"connectionStrings":{
"standard":"mongodb://myCluster-shard-00-00.abcde.example.net:27017,myCluster-shard-00-01.abcde.example.net:27017,myCluster-shard-00-02.abcde.example.net:27017/?ssl=true\u0026authSource=admin\u0026replicaSet=atlas-1oj3sr-shard-0",
"standardSrv":"mongodb+srv://myCluster.abcde.example.net"
}
}
Give Feedback