DOCS-4801: getBalancerLockDetails

Author: Sam Kleinman

config/htaccess.yaml

@@ -4872,4 +4872,11 @@ outputs:
   - 'after-v2.4'
   - 'master'
   - 'manual'
+---
+from: /reference/method/sh.getBalancerLockDetails
+to: /reference/method/js-sharding
+code: 303
+type: redirect
+outputs:
+  - 'before-v2.6'
 ...

source/includes/ref-toc-method-sh.yaml

@@ -1,7 +1,11 @@
-name: ":method:`sh._adminCommand`"
+name: ":method:`sh._adminCommand()`"
 file: /reference/method/sh._adminCommand
 description: "Runs a :term:`database command` against the admin database, like :method:`db.runCommand()`, but can confirm that it is issued against a :program:`mongos`."
 ---
+name: ":method:`sh.getBalancerLockDetails()`"
+file: /reference/method/sh.getBalancerLockDetails
+description: "Reports on the active balancer lock, if it exists."
+---
 name: ":method:`sh._checkFullName()`"
 file: /reference/method/sh._checkFullName
 description: "Tests a namespace to determine if its well formed."

source/reference/method/sh.getBalancerLockDetails.txt

@@ -0,0 +1,14 @@
+===========================
+sh.getBalancerLockDetails()
+===========================
+
+.. default-domain:: mongodb
+
+.. method:: sh.getBalancerLockDetails()
+
+   Reports on the active balancer lock, if it exists.
+
+   :returns: ``null`` if lock document does not exist or no lock is
+             not taken. Otherwise, returns the lock document.
+
+   :rtype: Document or ``null``.

source/reference/method/sh.status.txt

@@ -190,6 +190,10 @@ Balancer
    process that holds the balancer lock, and the date and time that
    the process obtained the lock.
 
+   If there is an active balancer lock,
+   :data:`~sh.status.balancer.currently-running` also reports the
+   state of the balancer.
+
 .. data:: sh.status.balancer.collections-with-active-migrations
 
    :data:`~sh.status.balancer.collections-with-active-migrations`