getClusterParameter (comando de base de datos)

Esta versión de la documentación se archivó y ya no se admite. Para actualizar tu implementación de 6.0, consulta el Procedimientos de actualización de MongoDB.7.0

Definición

getClusterParameter

getClusterParameter es un comando administrativo para recuperar los valores de los parámetros del clúster. Estos parámetros son configurables y afectan a todos los nodos de un clúster fragmentado.

Para ejecutar getClusterParameter, utilice el método db.adminCommand( { command } ).

El comando getClusterParameter solo está disponible en instalaciones autogestionadas. El comando getClusterParameter no está disponible en MongoDB Atlas.

Compatibilidad

Este comando está disponible en implementaciones alojadas en los siguientes entornos:

MongoDB Atlas: El servicio totalmente gestionado para implementaciones de MongoDB en la nube

Nota

Este comando es compatible con todos los clústeres de MongoDB Atlas. Para obtener información sobre el soporte de Atlas para todos los comandos, consulte Comandos no compatibles.

MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB
MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.

Sintaxis

El comando tiene la siguiente sintaxis:

db.adminCommand(
   {
     getClusterParameter: <parameter> | [<parameter>, <parameter>] | "'*'"
   }
)

Campos de comandos

El comando toma los siguientes campos:

Campo	Tipo	Descripción
`<parameter>`	string o arreglo de strings	Puede especificar uno de los siguientes: El nombre del parámetro que desea recuperar. Un arreglo con los nombres de múltiples parámetros. `'*'`para devolver valores para todos los parámetros disponibles en `getClusterParameter`.

Comportamiento

Solo se puede ejecutar getClusterParameter en la base de datos admin. Si se ejecuta el comando en cualquier otra base de datos, MongoDB devuelve un error.
Puedes ejecutar getClusterParameter en cualquier nodo de un set de réplicas o clúster.
Cuando ejecutas getClusterParameter en mongod, getClusterParameter devuelve valores de parámetros almacenados en caché.
Cuando ejecuta getClusterParameter mongosen, getClusterParameter devuelve el valor duradero del parámetro de clúster del servidorde configuración.

Control de acceso

Cuando se habilita la autenticación, getClusterParameter sólo funciona cuando se autentica como un usuario con un rol que tiene acceso a la acción getClusterParameter.

Ejemplos

Nota

La salida de los siguientes ejemplos puede variar según la configuración específica de la implementación de MongoDB en ejecución.

Retrieve Single Cluster Parameter

La siguiente operación ejecuta getClusterParameter en la base de datos admin usando un valor de hostName para recuperar el valor de un parámetro de clúster hipotético llamado hostName:

use admin
db.adminCommand( { getClusterParameter : "hostName" } )

Retrieve Multiple Cluster Parameters

La siguiente operación ejecuta getClusterParameter en la base de datos admin utilizando los valores hostName y testParameter para recuperar los valores de los parámetros de clúster hipotéticos denominados hostName y testParameter:

use admin
db.adminCommand( { getClusterParameter: [ "hostName", "testParameter" ] } )

Retrieve All Cluster Parameters

La siguiente operación ejecuta getClusterParameter con un valor de '*' para recuperar los valores de todos los parámetros del clúster:

use admin
db.adminCommand( { getClusterParameter : '*' } )

Tip

setClusterParameter para obtener más información sobre estos parámetros.

Volver

fsyncUnlock

getDefaultRWConcern