You are viewing an offline version of MongoDB documentation. Some page features might be unavailable. To view the latest version of the page or use interactive features, visit the live page.
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
mongoshmethod. This is not the documentation for database commands or language-specific drivers, such as Node.js.For the database command, see the
replSetFreezecommand.For MongoDB API drivers, refer to the language-specific MongoDB driver documentation.
The
rs.freeze()method has the following parameter:ParameterTypeDescriptionsecondsnumber
The duration the member is ineligible to become primary.
Compatibility
This method is available in deployments hosted in the following environments:
MongoDB Enterprise: The subscription-based, self-managed version of MongoDB
MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB