rs.freeze()

Description

rs.freeze(seconds)

Makes the current replica set member ineligible to become primary for the period specified.

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 replSetFreeze command.

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

For the legacy mongo shell documentation, refer to the documentation for the corresponding MongoDB Server release:

mongo shell v4.4

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

Parameter	Type	Description
seconds	number	The duration the member is ineligible to become primary.