DOCS-15069 getParameter exposes settability for server params (#553)

* command to expose settability for server params

* review feedback

* updates description of "*"

* addresses duplicate target name getParameter-showdetails-all-params

Author: jmd-mongo

source/reference/command/getParameter.txt

@@ -42,17 +42,31 @@ getParameter
 
       * - ``getParameter``
 
-        - int, ``'*'``
+        - int, string, document
 
         - Specify a value of:
 
-          - ``'*'`` to return all parameters available to
-            :dbcommand:`getParameter`, ignoring the ``<parameter>`` field.
-          
-          - any numerical value to return the value for the specified
-            ``<parameter>``.
+          - ``1`` (or any integer value) to return the value for the 
+            specified ``<parameter>``.
 
+          - ``'*'`` to return values for all parameters available to
+            :dbcommand:`getParameter`, ignoring the ``<parameter>`` field.
+
+          - ``{ showDetails: true }`` to return a document containing:
+            
+            .. _showdetails-fields:
+
+            - ``value``, the value that ``<parameter>`` is set to
+            - ``settableAtRuntime``, whether or not ``<parameter>`` can 
+              be set at runtime
+            - ``settableAtStartup``, whether or not ``<parameter>`` can
+              be set at startup  
 
+          - ``{ showDetails: true, allParameters: true }`` to return a 
+            document containing :ref:`showDetails fields 
+            <showdetails-fields>` for **all** parameters.
+
+
 
       * - ``<parameter>``
 
@@ -126,4 +140,45 @@ The following operation runs :dbcommand:`getParameter` with a value of
    :dbcommand:`setParameter` for more about these parameters.
 
 
-   .. slave-ok, admin-only
+.. _getParameter-showdetails-single-param:
+
+Report Details on a Single Parameter
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following example runs :dbcommand:`getParameter` with 
+``{showDetails: true}`` to report :ref:`details <showdetails-fields>` 
+on :parameter:`saslHostName`.
+
+.. code-block:: javascript
+   
+   db.adminCommand( { getParameter : { showDetails: true }, "saslHostName" : 1 } )
+  
+Example output:
+
+.. code-block:: javascript
+   :copyable: false
+
+   {
+     saslHostName: {
+       value: '<hostname>',
+       settableAtRuntime: false,
+       settableAtStartup: true
+     },
+     ok: 1
+   }
+
+.. include:: /includes/note-output-may-vary.rst
+
+
+.. _getParameter-showdetails-all-params:
+
+Report Details for All Parameters
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following example runs :dbcommand:`getParameter` with 
+``{showDetails: true, allParameters: true}`` to report 
+:ref:`details <showdetails-fields>` on **all** parameters.
+
+.. code-block:: javascript
+   
+   db.adminCommand( { getParameter : { showDetails: true, allParameters: true } } )

source/release-notes/5.3.txt

@@ -37,6 +37,20 @@ Starting in MongoDB 5.3, :dbcommand:`serverStatus` includes
 :serverstatus:`connections.loadBalanced` which reports the 
 number of incoming connections received through a load balancer.
 
+``getParameter`` can Report When Parameters can be Set
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Starting in MongoDB 5.3, ``getParameter`` can report:
+
+- whether a parameter can be set at startup
+- whether a parameter can be set during runtime
+
+You can use the ``getParameter`` command to report :ref:`parameter 
+details <showdetails-fields>` by passing ``{ showDetails: true }``. You 
+can use ``getParameter`` to report :ref:`details on all parameters 
+<getParameter-showdetails-all-params>` by passing 
+``{ showDetails: true, allParameters: true }``. 
+
 Security
 --------