rs.conf()¶

On this page

Definition
Output Example

Definition¶

rs.conf()¶

Returns a document that contains the current replica set configuration.

The method wraps the replSetGetConfig command.

The replSetGetConfig command can specify a new option commitmentStatus: true when run on the primary. When run with the option, the command includes in the output a commitmentStatus field. This output field indicates whether the replica set’s previous reconfig has been committed, so that the replica set is ready to be reconfigured again. The option is only available with the replSetGetConfig command.

Output Example¶

The following document provides a representation of a replica set configuration document. The configuration of your replica set may include only a subset of these settings:

copy

{
  _id: <string>,
  version: <int>,
  term: <int>,
  protocolVersion: <number>,
  writeConcernMajorityJournalDefault: <boolean>,
  configsvr: <boolean>,
  members: [
    {
      _id: <int>,
      host: <string>,
      arbiterOnly: <boolean>,
      buildIndexes: <boolean>,
      hidden: <boolean>,
      priority: <number>,
      tags: <document>,
      secondaryDelaySecs: <int>,
      votes: <number>
    },
    ...
  ],
  settings: {
    chainingAllowed : <boolean>,
    heartbeatIntervalMillis : <int>,
    heartbeatTimeoutSecs: <int>,
    electionTimeoutMillis : <int>,
    catchUpTimeoutMillis : <int>,
    getLastErrorModes : <document>,
    getLastErrorDefaults : <document>,
    replicaSetId: <ObjectId>
  }
}

For description of the configuration settings, see Replica Set Configuration.

rs.config()¶: rs.config() is an alias of rs.conf().

← rs.addArb() rs.freeze() →