diff --git a/source/reference/command/replSetMaintenance.txt b/source/reference/command/replSetMaintenance.txt new file mode 100644 index 00000000000..846e41c44a1 --- /dev/null +++ b/source/reference/command/replSetMaintenance.txt @@ -0,0 +1,32 @@ +================== +replSetMaintenance +================== + +.. default-domain:: mongodb + +.. dbcommand:: replSetMaintenance + + The :dbcommand:`replSetMaintenance` command enables/disables the maintenance + mode. + + The command has the following prototype format: + + .. code-block:: javascript + + { replSetMaintenance: } + + Consider the following behavior when running the + :dbcommand:`replSetMaintenance` command: + + - You cannot run the command on the Primary. + + - You must run the command against the ``admin`` database. + + - When enabled ``replSetMaintenance: 1``, the member will change + state to ``RECOVERING``. While the member is in ``RECOVERING`` state: + + - The member is not accessible for read operations. + + - The member continues to sync its :term:`oplog` from the Primary. + + .. admin-only diff --git a/source/reference/commands.txt b/source/reference/commands.txt index efcd7af7279..a73172e66e8 100644 --- a/source/reference/commands.txt +++ b/source/reference/commands.txt @@ -387,6 +387,9 @@ Internal Use .. include:: command/replSetFresh.txt :start-after: mongodb +.. include:: command/replSetMaintenance.txt + :start-after: mongodb + .. include:: command/replSetTest.txt :start-after: mongodb