sh.getBalancerState()
On this page
This version of the documentation is archived and no longer supported. To
upgrade your 5.0 deployment, see the MongoDB 6.0 upgrade procedures.
sh.getBalancerState()Returns: boolean sh.getBalancerState()returnstruewhen the balancer is enabled and false if the balancer is disabled. This does not reflect the current state of balancing operations: usesh.isBalancerRunning()to check the current state of the balancer.
See also:
Compatibility
This method is available in deployments hosted in the following environments:
MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud
Important
This command is not supported in M0, M2, and M5 clusters. For more information, see Unsupported Commands.
MongoDB Enterprise: The subscription-based, self-managed version of MongoDB
MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB