rs.conf.txt

=========
rs.conf()
=========

.. default-domain:: mongodb

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 1
   :class: singlecol

Definition
----------

.. method:: rs.conf()

   Returns a document that contains the current :term:`replica set`
   configuration.

   .. |dbcommand| replace:: :dbcommand:`replSetGetConfig` command
   .. include:: /includes/fact-mongosh-shell-method-alt

   .. include:: /includes/extracts/4.4-replSetGetConfiguration-commitmentStatus.rst
   
.. |moreinfo| replace:: The option is only available with the :dbcommand:`replSetGetConfig`
   command.

Compatibility
-------------

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

.. include:: /includes/fact-environments-atlas-only.rst
.. include:: /includes/fact-environments-atlas-support-no-free.rst
.. include:: /includes/fact-environments-onprem-only.rst

Output Example
--------------

.. include:: /includes/replica-set-conf-document-output.rst

For description of the configuration settings, see
:doc:`/reference/replica-configuration`.

.. method:: rs.config()

   :method:`rs.config()` is an alias of :method:`rs.conf()`.