sh.setBalancerState.txt

=====================
sh.setBalancerState()
=====================

.. default-domain:: mongodb

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 1
   :class: singlecol

Description
-----------

.. method:: sh.setBalancerState(state)

   Enables or disables the :term:`balancer`. Use
   :method:`sh.getBalancerState()` to determine if the balancer is
   currently enabled or disabled and :method:`sh.isBalancerRunning()`
   to check its current state.

   The :method:`sh.setBalancerState()` method has the following
   parameter:


   .. list-table::
      :header-rows: 1
      :widths: 20 20 80
   
      * - Parameter
   
        - Type
   
        - Description
   
      * - ``state``
   
        - boolean
   
        - Set this to ``true`` to enable the balancer and ``false`` to disable it.
          
          
   


.. seealso::

   - :method:`sh.enableBalancing()`
   - :method:`sh.disableBalancing()`
   - :method:`sh.getBalancerHost()`
   - :method:`sh.getBalancerState()`
   - :method:`sh.isBalancerRunning()`
   - :method:`sh.startBalancer()`
   - :method:`sh.stopBalancer()`
   - :method:`sh.waitForBalancer()`
   - :method:`sh.waitForBalancerOff()`