DOCSP-30674 getClusterParameter (#3410) (#3432)

* DOCSP-30674 Adds Atlas notice for getClusterParameter

* Minor typographic edits

* Fixes per Ashley



---------

Co-authored-by: Ashley Brown <[email protected]>

Author: kennethdyer

source/includes/fact-getClusterParameter-availability.rst

@@ -0,0 +1,3 @@
+The ``getClusterParameter`` command is only available in self-managed
+installations. The ``getClusterParameter`` command is not available in
+:atlas:`MongoDB Atlas </>`.

source/reference/command/getClusterParameter.txt

@@ -16,25 +16,27 @@ Definition
 .. dbcommand:: getClusterParameter
 
    :dbcommand:`getClusterParameter` is an administrative command for
-   retrieving the values of **cluster parameters**. Cluster parameters 
-   are configurable parameters which affect all nodes in a sharded cluster. 
-   
-   To run ``getClusterParameter``, use the ``db.adminCommand( { command } )`` 
+   retrieving the values of **cluster parameters**. Cluster parameters
+   are configurable parameters that affect all nodes in a sharded cluster.
+
+   To run ``getClusterParameter``, use the ``db.adminCommand( { command } )``
    method.
-   
+
+   .. include:: /includes/fact-getClusterParameter-availability.rst
+
 Syntax
 ------
-   
+
 The command has the following syntax:
 
 .. code-block:: javascript
-   
-   db.adminCommand( 
-      { 
-        getClusterParameter: <parameter> | [<parameter>, <parameter>] | "'*'" 
+
+   db.adminCommand(
+      {
+        getClusterParameter: <parameter> | [<parameter>, <parameter>] | "'*'"
       }
    )
-    
+ 
 Command Fields
 --------------
 
@@ -54,28 +56,28 @@ The command takes the following fields:
 
        - The name of the parameter you want to retrieve.
 
-       - An array with the names of multiple parameters. 
+       - An array with the names of multiple parameters.
 
        - ``'*'``, to return values for all parameters available to
          ``getClusterParameter``.
- 
+
 Behavior
 --------
 
-- You can only run ``getClusterParameter`` on the ``admin`` database. If 
+- You can only run ``getClusterParameter`` on the ``admin`` database. If
   you run the command on any other database, MongoDB returns an error.
 
-- You can run ``getClusterParameter`` on any node in a replica set or 
+- You can run ``getClusterParameter`` on any node in a replica set or
   sharded cluster.
 
-- When you run ``getClusterParameter`` on :binary:`~bin.mongod`, 
-  ``getClusterParameter`` returns cached parameter values. 
+- When you run ``getClusterParameter`` on :binary:`~bin.mongod`,
+  ``getClusterParameter`` returns cached parameter values.
 
-- When you run ``getClusterParameter`` on :binary:`~bin.mongos`, 
-  ``getClusterParameter`` returns the :term:`durable` value of the 
-  cluster parameter from the :ref:`config server <sharding-config-server>`
+- When you run ``getClusterParameter`` on :binary:`~bin.mongos`,
+  ``getClusterParameter`` returns the :term:`durable` value of the
+  cluster parameter from the :ref:`config server <sharding-config-server>`.
 
-Accesss Control
+Access Control
 ~~~~~~~~~~~~~~~
 
 When :ref:`authentication <authentication>` is enabled, ``getClusterParameter`` 
@@ -85,23 +87,23 @@ only works when authenticated as a user with a role that has access to the
 Examples
 --------
 
-.. note:: 
+.. note::
 
-   The output of the following examples may vary depending on the specific 
+   The output of the following examples may vary depending on the specific
    configuration of the running MongoDB deployment.
 
 Retrieve Single Cluster Parameter
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The following operation runs ``getClusterParameter`` on the ``admin`` 
-database using a value of ``hostName`` to retrieve the value for 
+The following operation runs ``getClusterParameter`` on the ``admin``
+database using a value of ``hostName`` to retrieve the value for
 a hypothetical cluster parameter named ``hostName``:
 
 .. code-block:: javascript
-   
+
    use admin
    db.adminCommand( { getClusterParameter : "hostName" } )
-  
+
 
 Retrieve Multiple Cluster Parameters
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -123,7 +125,7 @@ The following operation runs ``getClusterParameter`` with a value of
 ``'*'`` to retrieve the values from all cluster parameters:
 
 .. code-block:: javascript
-   
+
    use admin
    db.adminCommand( { getClusterParameter : '*' } )