Skip to content

Remove 'force' terminology from rs.stepdown shell helper #2736

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Remove 'force' terminology from rs.stepdown shell helper #2736

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions source/reference/method/rs.stepDown.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ Description

.. method:: rs.stepDown(stepDownSecs, secondaryCatchUpPeriodSecs)

Forces the :term:`primary` of the replica set to become a
:term:`secondary`, triggering an :ref:`election for primary
Triggers the :term:`primary` of the replica set to become a
:term:`secondary`. This in turn triggers an :ref:`election for primary
<replica-set-election-internals>`. The method steps down the primary
for a specified number of seconds; during this period, the stepdown
member is ineligible from becoming primary.

The method only steps down the primary if an :data:`electable
<~replSetGetConfig.members[n].priority>` secondary is up-to-date
with the primary, waiting up to 10 seconds for a secondary to catch
with the primary, waiting up to 10 seconds, by default, for a secondary to catch
up.

The method is only valid against the primary and will error if run
Expand Down