rs.initiate() (original) (raw)

rs.initiate(configuration)

Initiates a replica set. Optionally, the method can take an argument in the form of a document that holds theconfiguration of a replica set.

Important

mongosh Method

This page documents a mongosh method. This is _not_the documentation for database commands or language-specific drivers, such as Node.js.

For the database command, see the replSetInitiate command.

For MongoDB API drivers, refer to the language-specificMongoDB driver documentation.

The rs.initiate() method has the following parameter:

This method is available in deployments hosted in the following environments:

• MongoDB Enterprise: The subscription-based, self-managed version of MongoDB
• MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB

Warning

MongoDB binaries, mongod and mongos, bind to localhost by default. If the net.ipv6 configuration file setting or the --ipv6 command line option is set for the binary, the binary additionally binds to the localhost IPv6 address.

By default mongod and mongos that are bound to localhost only accept connections from clients that are running on the same computer. This binding behavior includesmongosh and other members of your replica set or sharded cluster. Remote clients cannot connect to binaries that are bound only to localhost.

To override the default binding and bind to other IP addresses, use thenet.bindIp configuration file setting or the --bind_ipcommand-line option to specify a list of hostnames or IP addresses.

Warning

For example, the following mongod instance binds to both the localhost and the hostname My-Example-Associated-Hostname, which is associated with the IP address 198.51.100.1:

mongod --bind_ip localhost,My-Example-Associated-Hostname

In order to connect to this instance, remote clients must specify the hostname or its associated IP address 198.51.100.1:

mongosh --host My-Example-Associated-Hostname

mongosh --host 198.51.100.1

See Replica Set Configuration Document Example for details of the replica set configuration document.

Important

To avoid configuration updates due to IP address changes, use DNS hostnames instead of IP addresses. It is particularly important to use a DNS hostname instead of an IP address when configuring replica set members or sharded cluster members.

Use hostnames instead of IP addresses to configure clusters across a split network horizon. Starting in MongoDB 5.0, nodes that are only configured with an IP address fail startup validation and do not start.

The following example initiates a new replica set with three members.

The three mongod instances must have started with the--replSet command line option (orreplication.replSetName if using a configuration file) set to myReplSet and the --bind_ip (or net.bindIpif using a configuration file) set appropriately such that other members of the replica set and clients can connect.

Warning

Connect mongosh to one of the mongodinstances and run rs.initiate().

Note

Run rs.initiate() on only one mongod instance for the replica set.

Important

To avoid configuration updates due to IP address changes, use DNS hostnames instead of IP addresses. It is particularly important to use a DNS hostname instead of an IP address when configuring replica set members or sharded cluster members.

Use hostnames instead of IP addresses to configure clusters across a split network horizon. Starting in MongoDB 5.0, nodes that are only configured with an IP address fail startup validation and do not start.

rs.initiate(

   {

      _id: "myReplSet",

      version: 1,

      members: [

         { _id: 0, host : "mongodb0.example.net:27017" },

         { _id: 1, host : "mongodb1.example.net:27017" },

         { _id: 2, host : "mongodb2.example.net:27017" }

      ]

   }

)

For details on replica set configuration, seeReplica Set Configuration Fields.

For details on deploying a replica set, seeDeploy a Self-Managed Replica Set.

See also: