/ /

Configuración de automatización

Cloud Manager dejará de admitir la Automatización, la Copia de seguridad y la Supervisión para MongoDB 3.6 y 4.0 después del 30de agosto de 2024. Por favor actualiza tu implementación de MongoDB o migra a Atlas.

Overview

La Automatización utiliza una configuración de automatización para determinar el estado deseado de una implementación del MongoDB y efectuar cambios según sea necesario. Si modifica la implementación a través de la interfaz web Cloud Manager, nunca necesitará manipular esta configuración.

Si utilizas la automatización sin Cloud Manager, puedes construir y distribuir la configuración manualmente.

Los campos opcionales están marcados como tal.

Un campo que toma un <number> ya que su valor puede tomar números enteros y números de punto flotante.

Versión de configuración

Esto muestra la versión de la configuración de automatización.

"version" : "<integer>"

Nombre	Tipo	Necesidad	Descripción
Versión	entero	Requerido	Revisión de este archivo de configuración de automatización.

Descargar Base

Cloud Manager descarga las versiones automáticas y ejecuta los scripts de inicio en el directorio configurado en options.downloadBase.

"options" : {
  "downloadBase" : "<string>",
}

Nombre	Tipo	Necesidad	Descripción
opciones	Objeto	Requerido	Ruta para descargas automáticas de nuevas versiones.
options.downloadBase	string	Requerido	Directorio en las plataformas Linux y UNIX para descargas automáticas de versiones y scripts de inicio.

Especificaciones de versiones de MongoDB

El arreglo mongoDbVersions[n] define objetos de especificación para las instancias de MongoDB encontradas en el arreglo processes. Cada instancia de MongoDB en el arreglo processes debe tener un objeto de especificación en este arreglo.

1 "mongoDbVersions[n]" : [
2   {
3    "name" : "<string>",
4     "builds" : [
5       {
6        "platform" : "<string>",
7         "url" : "<string>",
8         "gitVersion" : "<string>",
9         "modules" : [ "<string>", ... ],
10         "architecture" : "<string>",
11         "bits" : "<integer>",
12         "win2008plus" : "<Boolean>",
13         "winVCRedistUrl" : "<string>",
14         "winVCRedistOptions" : [ "<string>", ... ],
15         "winVCRedistDll" : "<string>",
16         "winVCRedistVersion" : "<string>"
17       },
18       ...
19     ],
20   },
21   ...
22 ]

Nombre	Tipo	Necesidad	Descripción
mongoDbVersions[n]	Arreglo de objetos	Requerido	Objetos de especificación para las instancias de MongoDB que se encuentran en el arreglo processes. Cada instancia de MongoDB en procesos debe tener un objeto de especificación en mongoDbVersions[n].
mongoDbVersions[n].name	string	Requerido	Nombre del objeto de especificación. El objeto de especificación se adjunta a una instancia de MongoDB mediante el parámetro processes.version de la instancia en esta configuración.
mongoDbVersions[n].builds[k]	Arreglo de objetos	Requerido	Compilaciones disponibles para esta instancia de MongoDB.
mongoDbVersions[n].builds[k].platform	string	Requerido	Plataforma para esta instancia de MongoDB.
mongoDbVersions[n].builds[k].url	string	Requerido	URL de donde descargar MongoDB para esta instancia.
mongoDbVersiones[n].builds[k].gitVersion	string	Requerido	Identificador de confirmación que identifica el estado del código que se utiliza para compilar el proceso de MongoDB. El comando buildInfo de MongoDB devuelve el identificador de gitVersion.
mongoDbVersions[n].builds[k].modules	arreglo	Requerido	Lista de módulos para esta versión. Corresponde al parámetro módulos que devuelve el comando buildInfo.
mongoDbVersions[n].builds[k].architecture	string	Requerido	Arquitectura del procesador. Cloud Manager acepta amd64 o ppc64le.
mongoDbVersions[n].builds[k].bits	entero	Obsoleto	Ancho de bus del procesador. No remueva ni realice modificaciones a este parámetro.
mongoDbVersions[n].builds[k].win2008plus	Booleano	Opcional	Configúralo en verdadero si se trata de una versión de Windows que requiere Windows 7 o una versión posterior, o Windows servidor 2008 R2 o una versión posterior.
mongoDbVersions[n].builds[k].winVCRedistUrl	string	Opcional	La URL desde la cual se puede descargar la versión requerida del Microsoft Visual C++ Redistributable.
mongoDbVersions[n].builds[k].winVCRedistOptions	Arreglo de cadenas	Opcional	Valores de cadena que enumeran las opciones de línea de comandos que se deben especificar al ejecutar el instalador redistribuible de Microsoft Visual C++. Cada opción de línea de comandos se encuentra en el arreglo como una string separada.
mongoDbVersions[n].builds[k].winVCRedistDll	string	Opcional	Nombre del archivo DLL de Microsoft Visual C++ runtime que el agente verifica para determinar si se necesita una nueva versión del redistribuible de Microsoft Visual C++.
mongoDbVersions[n].builds[k].winVCRedistVersion	string	Opcional	Versión mínima del archivo DLL del tiempo de ejecución de Microsoft Visual C++ que debe estar presente para omitir la instalación del paquete redistribuible de Microsoft Visual C++.

Automatización

agentVersion especifica la versión del MongoDB Agent.

Nota

Si bien puedes actualizar la versión del MongoDB Agent a través de esta propiedad de configuración, deberías usar el Actualice las versiones del agente endpoint para asegurarse de que sus versiones estén actualizadas.

"agentVersion" : {
  "name" : "<string>",
  "directoryUrl" : "<string>"
}

Nombre	Tipo	Necesidad	Descripción
agentVersion	Objeto	Opcional	Versión del Agente MongoDB a ejecutar. Si la versión que se está ejecutando no coincide con esta configuración, el Agente MongoDB descarga la versión especificada, se apaga y comienza la nueva versión.
agentVersion.name	string	Opcional	Versión deseada del Agente de MongoDB.
agentVersion.directoryUrl	string	Opcional	URL desde la cual descargar el MongoDB Agent.

Monitoring

El arreglo monitoringVersions especifica la versión del agente de supervisión. Cloud Manager ha hecho que este parámetro quede obsoleto. Para actualizar la configuración del registro de supervisión, usa el endpoint Actualizar configuración de supervisión.

1 "monitoringVersions" : [
2   {
3     "name" : "<string>",
4     "hostname" : "<string>",
5     "urls" : {
6       "<platform1>" : {
7         "<build1>" : "<string>",
8         ...,
9         "default" : "<string>"
10       },
11       ...
12     },
13     "baseUrl" : "<string>",
14     "logPath" : "<string>",
15     "logRotate" : {
16       "sizeThresholdMB" : <number>,
17       "timeThresholdHrs" : <integer>,
18       "numUncompressed": <integer>,
19       "percentOfDiskspace" : <number>,
20       "numTotal" : <integer>
21     }
22   },
23   ...
24 ]

Nombre	Tipo	Necesidad	Descripción
monitoringVersions	Arreglo de objetos	Opcional	Objetos que definen información de versión para cada agente de supervisión.
monitoringVersions.name	string	Requerido	Versión del agente de supervisión. Para obtener más información, consulta la Matriz de compatibilidad de MongoDB. IMPORTANTE: Esta propiedad es de solo lectura. Cualquier modificación realizada a esta propiedad no se refleja al actualizar el agente de supervisión a través de la API. Para actualizar la versión del agente de supervisión, consulta este endpoint.
monitoringVersions.hostname	string	Requerido	FQDN del host que ejecuta el agente de supervisión. Si el agente de supervisión no se está ejecutando en el host, Cloud Manager instala el agente desde la ubicación especificada en monitoringVersions.urls.
monitoringVersions.urls	Objeto	Requerido	URL URLs específicos de la plataforma y la compilación desde dónde descargar el agente de supervisión.
monitoringVersions.urls.<platform>	Objeto	Requerido	Etiqueta que identifica un sistema operativo y su versión. El campo contiene un objeto con pares clave-valor, donde cada clave es el nombre de una compilación o por defecto y cada valor es un URL para descargar el agente de supervisión. El objeto debe incluir la clave default establecida con el URL de descarga por defecto para la plataforma.
monitoringVersions.baseUrl	string	Requerido	URL base utilizado para la configuración de mmsbaseurl.
monitoringVersions.logPath	string	Opcional	Directorio donde el agente almacena sus registros. La opción por defecto es almacenar los registros en /dev/null.
monitoringVersions.logRotate	Objeto	Opcional	Habilita la rotación de registros para los registros de MongoDB de un proceso.
monitoringVersions.logRotate.sizeThresholdMB	Número	Requerido	Tamaño máximo en MB para una entrada de registro individual antes de la rotación.
monitoringVersions.logRotate.timeThresholdHrs	entero	Requerido	Tiempo máximo en horas para una entrada de registro individual antes de la rotación.
monitoringVersions.logRotate.numUncompressed	entero	Opcional	Número máximo de entradas de registro totales que se dejarán sin comprimir, incluida la entrada de registro actual. El valor por defecto es 5. En versiones anteriores de Cloud Manager, este campo se denominaba maxUncompressed. El nombre anterior todavía se reconoce, aunque se prefiere la nueva versión.
Porcentaje de espacio en disco para la rotación de logs	Número	Opcional	Porcentaje máximo del espacio total en disco que deben ocupar todas las entradas de registro antes de su eliminación. El valor por defecto es .02.
monitoringVersions.logRotate.numTotal	entero	Opcional	Número total de entradas de registro. Si no se especifica un número, la cantidad total de entradas de registro se establece por defecto en 0 y es determinada por otras configuraciones de monitoringVersions.logRotate.

Backup

El arreglo backupVersions especifica la versión del agente de copias de seguridad. Cloud Manager ha hecho que este parámetro quede obsoleto. Para actualizar la configuración del registro de copia de seguridad, utilice el endpoint Actualizar configuración de copia de seguridad.

1 "backupVersions[n]" : [
2   {
3    "name" : "<string>",
4     "hostname" : "<string>",
5     "urls" : {
6      "<platform1>" : {
7        "<build1>" : "<string>",
8         ...,
9         "default" : "<string>"
10       },
11       ...
12     },
13     "baseUrl" : "<string>",
14     "logPath" : "<string>",
15     "logRotate" : {
16      "sizeThresholdMB" : "<number>",
17       "timeThresholdHrs" : "<integer>",
18       "numUncompressed": "<integer>",
19       "percentOfDiskspace" : "<number>",
20       "numTotal" : "<integer>"
21     }
22   },
23   ...
24 ]

Nombre	Tipo	Necesidad	Descripción
backupVersions[n]	Arreglo de objetos	Opcional	Objetos que definen la información de la versión para cada agente de copias de seguridad.
backupVersions[n].name	string	Requerido	Versión del agente de copia de seguridad. Para obtener más información, consulta la Matriz de compatibilidad de MongoDB. IMPORTANTE: Esta propiedad es de solo lectura. Cualquier cambio realizado en esta propiedad no se refleja al actualizar el agente de copias de seguridad a través de la API. Para actualizar la versión del Agente de copia de seguridad, consulta este endpoint.
backupVersions[n].hostname	string	Requerido	FQDN del host que ejecuta el Agente de Copias de Seguridad. Si el agente de copia de seguridad no se está ejecutando en el host, Cloud Manager instala el agente desde la ubicación especificada en backupVersions[n].urls.
backupVersions[n].urls	Objeto	Requerido	URLs específicasde la plataforma y de la versión de las que se puede descargar el agente de copias de seguridad.
backupVersions[n].urls.<platform>	Objeto	Requerido	Etiqueta que identifica un sistema operativo y su versión. El campo contiene un objeto con pares clave-valor, donde cada clave es el nombre de una compilación o por defecto y cada valor es un URL para descargar el agente de copias de seguridad. El objeto debe incluir la clave default establecida con el URL de descarga por defecto para la plataforma.
backupVersions[n].baseUrl	string	Requerido	Base URL utilizada para la mothership y configuraciones https en la Configuración personalizada. Por ejemplo, para "baseUrl"=https://cloud.mongodb.com, los campos de configuración de copia de seguridad tendrían estos valores: mothership=api-backup.mongodb.com y https"=true.
backupVersions[n].logPath	string	Opcional	Directorio donde el agente almacena sus registros. La opción por defecto es almacenar los registros en /dev/null.
backupVersions[n].logRotate	Objeto	Opcional	Habilita la rotación de registros para los registros de MongoDB de un proceso.
backupVersions[n].logRotate.sizeThresholdMB	Número	Requerido	Tamaño máximo en MB para una entrada de registro individual antes de la rotación.
backupVersions[n].logRotate.timeThresholdHrs	entero	Requerido	Tiempo máximo en horas para una entrada de registro individual antes de la rotación.
backupVersions[n].logRotate.numUncompressed	entero	Opcional	Número máximo de entradas de registro totales que se dejarán sin comprimir, incluida la entrada de registro actual. El valor por defecto es 5.
backupVersions[n].logRotate.percentOfDiskspace	Número	Opcional	Porcentaje máximo del espacio total en disco que deben ocupar todas las entradas de registro antes de su eliminación. El valor por defecto es .02.
backupVersions[n].logRotate.numTotal	entero	Opcional	Si no se especifica un número, el número total de archivos de registro es por defecto 0 y se determina mediante otras configuraciones de backupVersion.logRotate.

Instancias de MongoDB

El processes arreglo determina la configuración de tus instancias de MongoDB. Con este arreglo, puedes:

Restaurar una instancia.
Inicia un proceso de sincronización inicial en una o más instancias de MongoDB.

1 "processes": [{
2   "<args>": {},
3   "alias": "<string>",
4   "authSchemaVersion": "<integer>",
5   "backupRestoreUrl": "<string>",
6   "cluster": "<string>",
7   "defaultRWConcern": {
8     "defaultReadConcern": {
9       "level": "<string>"
10     },
11     "defaultWriteConcern": {
12       "j": "<boolean>",
13       "w": "<string>",
14       "wtimeout": "<integer>"
15     }
16   }
17   "disabled": "<Boolean>",
18   "featureCompatibilityVersion": "<string>",
19   "hostname": "<string>",
20   "lastCompact" : "<dateInIso8601Format>",
21   "lastRestart" : "<dateInIso8601Format>",
22   "lastResync" : "<dateInIso8601Format>",
23   "lastKmipMasterKeyRotation" : "<dateInIso8601Format>",
24   "logRotate": {
25     "sizeThresholdMB": "<number>",
26     "timeThresholdHrs": "<integer>",
27     "numUncompressed": "<integer>",
28     "percentOfDiskspace": "<number>",
29     "numTotal": "<integer>"
30   },
31   "manualMode": "<Boolean>",
32   "name": "<string>",
33   "numCores": "<integer>",
34   "processType": "<string>",
35   "version": "<string>"
36 }]

Nombre	Tipo	Necesidad	Descripción
Procesos	arreglo	Requerido	Contiene objetos que definen las instancias `mongos` y `mongod` que supervisa Cloud Manager. Cada objeto define una instancia diferente.
processes[n].args2_6	Objeto	Requerido	Objeto de configuración de MongoDB para las versiones 2.6 y posteriores de MongoDB. El objeto `processes.args2_6` acepta la mayoría de los ajustes y parámetros de MongoDB para las versiones 2.6 y posteriores de MongoDB. Para obtener más información, consulte Configuración de MongoDB y soporte de automatización.
processes[n].alias	string	Opcional	Alias de nombre de host (a menudo un DNS CNAME) para el host en el que se ejecuta el proceso. Si se especifica un alias, el Agente de MongoDB prefiere este alias sobre el nombre de host especificado en processes.hostname al conectarse al host. También puedes especificar este alias en replicaSets.host y particionado.configServer.
processes[n].authSchemaVersion	entero	Requerido	Versión de esquema de las credenciales de usuario para los usuarios de base de datos de MongoDB. Esto debería coincidir con todos los demás elementos del arreglo processes que pertenecen al mismo clúster. Cloud Manager acepta 3 y 5 para este parámetro. Los clústeres de MongoDB 3.x y 4.x tienen por defecto 5.
procesos[n].backupRestoreUrl	string	Opcional	Entrega URL para la restauración. Cloud Manager establece esto al crear una restauración. Para cancelar una operación de restauración en curso, configura esta opción en `CANCEL`. Para obtener más información, consulta Automatizar la restauración de copias de seguridad a través de la API.
processes[n].clúster	string	Condicional	Nombre del clúster fragmentado. Establezca este valor al mismo valor en el parámetro particionado.name en el arreglo particionado para el `mongos`. Requerido para un `mongos`. No se necesita para un `mongod`.
nivel.defaultRWConcern.defaultReadConcern	string	Opcional	Propiedades de coherencia y aislamiento establecidas para los datos leídos de sets de réplicas y particiones de sets de réplicas. MongoDB Atlas acepta los siguientes valores: "disponible" "local" "mayoría"
defaultRWConcern.defaultWriteConcern.j	booleano	Opcional	Indicador que indica si el reconocimiento de escritura debe guardarse en el registro en disco.
defaultRWConcern.defaultWriteConcern.w	string	Opcional	Número deseado de instancias de MongoD que deben reconocer una operación de escritura en un set de réplicas y en particiones del set de réplicas. MongoDB Atlas acepta los siguientes valores: Cualquier número 0 o mayor "mayoría"
defaultRWConcern.defaultWriteConcern.wtimeout	Número	Opcional	Límite de tiempo deseado para el nivel de confirmación de escritura (write concern) expresado en milisegundos. Establece este valor cuando configuras defaultRWConcern.defaultWriteConcern.w a un valor mayor que 1.
procesos[n].desactivado	Booleano	Opcional	Indicador que indica si este proceso debe cerrarse. Configúrelo en verdadero para apagar el proceso.
processes[n].featureCompatibilityVersion	string	Requerido	Versión de MongoDB con la que este proceso tiene compatibilidad de funcionalidades. Cambiar este valor puede habilitar o deshabilitar ciertas funcionalidades que persisten datos incompatibles con versiones de MongoDB anteriores o posteriores a la featureCompatibilityVersion que elijas. Cloud Manager acepta 3.2, 3.6, 4.0 y 4.2 como valores de parámetros. Si tienes una implementación existente, Cloud Manager solo acepta una featureCompatibilityVersion igual o una versión anterior a la versión de MongoDB que desplegaste. Para aprender cuáles de estos valores de parámetros son compatibles con cada versión de MongoDB y qué funcionalidades activa o desactiva cada uno de estos valores, consulta setFeatureCompatibilityVersion en el Manual de MongoDB. Cloud Manager establece este parámetro para que coincida con la versión de MongoDB en nuevas implementaciones. Cloud Manager no incrementa automáticamente este parámetro al actualizar un host de una versión de MongoDB a la siguiente. Para saber más, consulta setFeatureCompatibilityVersion.
processes[n].hostname	string	Requerido	Nombre del host que sirve este proceso. Por defecto, este valor es localhost.
processes[n].lastCompact	string	Opcional	Marca de tiempo en ISO 8601 formato de fecha y hora en UTC cuando Cloud Manager reclamó por última vez espacio libre en los discos de un clúster. Durante ciertas operaciones, MongoDB podría mover o borrar datos, pero no libera el espacio actualmente no utilizado. Cloud Manager recupera el espacio en disco de forma progresiva entre los miembros del set de réplicas o particiones. Para reclamar este espacio: De inmediato, establece este valor en la hora actual como una marca de tiempo ISO 8601. Después, ajusta este valor a una futura ISO 8601 marca de tiempo. Cloud Manager recupera el espacio después de que la hora actual haya pasado la fecha y hora proporcionadas. Para remover cualquier ambigüedad sobre cuándo pretende reclamar el espacio en los discos del clúster, especifique una zona horaria con su ISO 8601 marca de tiempo. Por ejemplo, para configurar processes.lastCompact para el 28 de enero de 2021 a las 2:43:52 p. m., hora estándar central de los EE. UU., usa `"processes.lastCompact" : "2021-01-28T14:43:52-06:00"`
processes[n].lastRestart	string	Opcional	Marca de tiempo en ISO 8601 formato de fecha y hora en UTC cuando Cloud Manager reinició este proceso por última vez. Si configura este parámetro con la marca temporal actual, Cloud Manager forzará un reinicio de este proceso después de cargar esta configuración. Si configuras este parámetro para varios procesos en el mismo clúster, el Cloud Manager reiniciará los procesos seleccionados de forma secuencial en los nodos del set de réplicas o particiones.
processes[n].lastResync	string	Opcional	Marca de tiempo en ISO 8601 formato de fecha y hora en UTC del último proceso de sincronización inicial que Cloud Manager realizó en el nodo. Para activar inmediatamente el proceso de sincronización inicial en el nodo, establece este valor en el momento actual como una marca de tiempo ISO 8601. ADVERTENCIA: utiliza este parámetro con precaución. Durante la sincronización inicial, Automation elimina todo el contenido del directorio `dbPath` del nodo. Si estableces este parámetro: En el nodo secundario, el MongoDB Agent comprueba si la marca de tiempo especificada es posterior al momento de la última resincronización y, si se confirma, inicia la sincronización inicial en este nodo. Por ejemplo, para establecer `processes.lastResync` en el nodo secundario en 28 de mayo 2021 a las 2:43:52 PM hora estándar central de EE. UU., use: `"processes.lastResync" : "2021-05-28T14:43:52-06:00"` Si el MongoDB Agent confirma que esta marca de tiempo es posterior al tiempo registrado de la última resincronización, iniciará la sincronización inicial en el nodo. En el nodo primario, el MongoDB Agent espera hasta que se le solicite al nodo primario convertirse en secundario con el método `rs.stepDown()` y luego inicia la sincronización inicial en este nodo. En todos los nodos en el mismo clúster, incluido el primario, el MongoDB Agent verifica si la marca de tiempo especificada es posterior a la hora de la última resincronización y, si se confirma, inicia la sincronización inicial en los nodos secundarios de forma progresiva. El MongoDB Agent espera que solicite al nodo primario que se convierta en secundario mediante el método `rs.stepDown()`, y luego inicia la sincronización inicial en este nodo. Para obtener más información, consulta Sincronización inicial.
processes[n].lastKmipMasterKeyRotation	string	Opcional	Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando Cloud Manager realizó la última rotación de la clave maestra KMIP. Si configuras este parámetro con la marca de tiempo actual, Cloud Manager rotará la clave después de que subas esta configuración.
processes[n].logRotate	Objeto	Opcional	Objeto de configuración de MongoDB para rotar los registros de MongoDB de un proceso.
procesos[n].logRotate. numTotal	entero	Opcional	Número total de entradas de registro que Cloud Manager conserva. Si no estableces este valor, el número total de archivos de registro se configura por defecto en 0. Cloud Manager basa la rotación en tus otros ajustes de processes.logRotate.
procesos[n].logRotate. numNoComprimido	entero	Opcional	Número máximo de entradas de registro totales que se dejarán sin comprimir, incluida la entrada de registro actual. El valor por defecto es 5.
processes[n].logRotate. porcentaje del espacio del disco	Número	Opcional	Porcentaje máximo del espacio total en disco que Cloud Manager puede utilizar para almacenar las entradas de registro expresado como decimal. Si se supera este límite, Cloud Manager eliminará los archivos de registro comprimidos hasta que se cumpla este límite. Cloud Manager elimina primero los archivos de registro más antiguos. El valor por defecto es 0,02.
processes[n].logRotate. sizeThresholdMB	Número	Requerido	Tamaño máximo en MB para una entrada de registro individual antes de que Cloud Manager lo rote. Cloud Manager rota la entrada de registro inmediatamente si cumple con el valor dado tanto en este sizeThresholdMB como en processes.logRotate.timeThresholdHrs límite.
processes[n].logRotate. timeThresholdHrs	entero	Requerido	Duración máxima en horas para una entrada de registro individual antes de la siguiente rotación. El tiempo es desde la última rotación. Cloud Manager rota la entrada de registro una vez que el archivo cumple con este timeThresholdHrs o el processes.logRotate.sizeThresholdMB límite.
processes[n].manualMode	Booleano	Opcional	Bandera que indica si el MongoDB Agent automatiza este proceso. Esto se establece por defecto en false. Especifique true para desactivar la Automatización en este proceso. El MongoDB Agent no realiza más acciones sobre este proceso. Configure en false para habilitar la Automatización en este proceso. El Agente de MongoDB automatiza las acciones en este proceso.
processes[n].name	string	Requerido	Nombre único para identificar la instancia.
procesos[n].numCores	entero	Opcional	Cantidad de núcleos que Cloud Manager debe vincular a este proceso. El MongoDB Agent distribuye los procesos entre los núcleos de la manera más uniforme posible.
procesos[n].tipoDeProceso	string	Requerido	Tipo de proceso de MongoDB que se está ejecutando. Cloud Manager acepta `mongod` o `mongos` para este parámetro.
procesos[n].version	string	Requerido	Nombre de la especificación mongoDbVersions utilizada con esta instancia.

En todo el clúster

La configuracionesClusterWide especifica los parámetros que se deben configurar en un set de réplicas o en un clúster sin requerir un reinicio en secuencia.

1 "clusterWideConfigurations" : {
2   "<replicaSetID/clusterName>": {
3     "changeStreamOptions": {
4       "preAndPostImages": {
5         "expireAfterSeconds": <integer>
6       }
7     }
8   }
9 }

Nombre	Tipo	Necesidad	Descripción
replicaSetID/clusterName	Objeto	Opcional	Las opciones de flujo de cambios que se aplicarán al set de réplicas o clúster. MongoDB Agent solo verifica si esta configuración tiene un formato válido de JSON, pero no verifica la corrección de los valores.
changeStreamOptions.preAndPostImages.expireAfterSeconds	Número	Requerido	Política de retención de las pre- y postimágenes del flujo de cambios en segundos. Si omites el valor, el clúster retiene las pre- y postimágenes hasta que remueve los eventos correspondientes del flujo de cambios del oplog. Si remueves este valor, MongoDB Agent solo remueve este parámetro de su configuración de automatización, pero no del servidor. Para obtener más información, consulta changeStreamOptions.

Sets de réplicas

El arreglo replicaSets define la configuración de cada set de réplicas. Este campo es obligatorio para implementaciones con sets de réplicas.

1 "replicaSets":
2 [
3   {
4     "_id": "<string>",
5     "protocolVersion": "<string>",
6     "members":
7     [
8       {
9         "_id": "<integer>",
10         "host": "<string>",
11         "arbiterOnly": "<boolean>",
12         "buildIndexes": "<boolean>",
13         "hidden": "<boolean>",
14         "priority": "<number>",
15         "tags": "<object>",
16         "secondaryDelaySecs": "<integer>",
17         "votes": "<number>"
18       },{
19         "_id": "<integer>",
20         "host": "<string>",
21         "arbiterOnly": "<boolean>",
22         "buildIndexes": "<boolean>",
23         "hidden": "<boolean>",
24         "priority": "<number>",
25         "tags": "<object>",
26         "secondaryDelaySecs": "<integer>",
27         "votes": "<number>"
28       },{
29         "_id": "<integer>",
30         "host": "<string>",
31         "arbiterOnly": "<boolean>",
32         "buildIndexes": "<boolean>",
33         "hidden": "<boolean>",
34         "priority": "<number>",
35         "tags": "<object>",
36         "secondaryDelaySecs": "<integer>",
37         "votes": "<number>"
38       }
39     ],
40     "force":
41     {
42       "currentVersion": "<integer>"
43     }
44   }
45 ]

Nombre	Tipo	Necesidad	Descripción
Sets de réplicas	arreglo	Opcional	Configuración de cada set de réplicas. El MongoDB Agent utiliza los valores de este arreglo para crear documentos de configuración de set de réplicas válidos. El agente comprueba regularmente que los sets de réplicas estén configurados correctamente. Si ocurre un problema, el agente reconfigura el set de réplicas según su documento de configuración. El arreglo puede contener los siguientes campos de nivel superior de un documento de configuración de un set de réplicas: _id; version; y nodos. Para obtener más información, vea replSetGetConfig.
replicaSets[n]._id	string	Requerido	El nombre del set de réplicas.
replicaSets[n].protocolVersion	string	Opcional	Versión de protocolo del set de réplicas.
replicaSets[n].nodos	arreglo	Opcional	Objetos que definen cada nodo del set de réplicas. El campo members.host debe especificar el host Para aprender más, consulta replSetGetConfig y replSetGetConfig.
replicaSets[n].members[m]._id	entero	Requerido	Cualquier número entero positivo que indique el nodo del set de réplicas.
replicaSets[n].members[m].host	string	Opcional	Nombre de host y número de puerto cuando corresponda, que sirve a este miembro del set de réplicas.
replicaSets[n].nodos[m].arbiterOnly	booleano	Opcional	Bandera que indica si este miembro del set de réplicas actúa como un árbitro.
replicaSets[n].nodos[m].buildIndexes	booleano	Opcional	Bandera que indica si el proceso `mongod` construye índices en este miembro del conjunto de réplicas.
replicaSets[n].nodos[m].hidden	booleano	Opcional	Indica si el set de réplicas permite que este nodo acepte operaciones de lectura.
replicaSets[n].members[m].prioridad	Número	Opcional	Elegibilidad relativa para que Cloud Manager seleccione este miembro del conjunto de réplicas como primario. Cuanto mayor el número, mayor la elegibilidad. Este valor puede estar entre 0 y 1000, ambos inclusive, para los nodos de datos. Los árbitros pueden tener valores de 0 o 1.
replicaSets[n].nodos[m].etiquetas	Objeto	Opcional	Lista de etiquetas definidas por el usuario y sus valores aplicados a este set de réplicas.
replicaSets[n].nodos[m].secondaryDelaySecs	entero	Opcional	Cantidad de tiempo en segundos que este miembro del set de réplicas debe tener de retraso respecto al primario.
replicaSets[n].nodos[m].votes	Número	Opcional	Cantidad de votos que este set de réplicas puede emitir en una elección del set de réplicas. Todos los nodos portadores de datos pueden tener 0 o 1 voto. Los árbitros siempre tienen 1 voto.
replicaSets[n].forzar	Objeto	Opcional	Instrucciones al MongoDB Agent para que fuerce a un set de réplicas a usar la Versión de configuración especificada en replicaSets.force.CurrentVersion. Con este objeto, el MongoDB Agent puede forzar a un set de réplicas a aceptar una nueva configuración para recuperarse de un estado en el que solo está disponible una minoría de sus nodos.
replicaSets[n].force.currentVersion	entero	Opcional	Versión de configuración que el MongoDB Agent forza al set de réplicas a utilizar. Establecido a -1 para obligar a un set de réplicas a aceptar una nueva configuración. ADVERTENCIA: Forzar una reconfiguración del set de réplicas podría causar un rollback en las escrituras confirmadas por la mayoría. Proceda con precaución. Contacta con el Soporte de MongoDB si tienes preguntas sobre los posibles impactos de esta operación.

Clústeres fragmentados

El particionado arreglo define la configuración de cada clúster. Este parámetro es obligatorio para implementaciones con clústeres con particionamiento por fragmentos.

1 "sharding" : [
2   {
3     "managedSharding" : <boolean>,
4     "name" : "<string>",
5     "configServerReplica" : "<string>",
6     "collections" : [
7       {
8         "_id" : "<string>",
9         "key" : [
10           [ "shard key" ],
11           [ "shard key" ],
12           ...
13         ],
14         "unique" : <boolean>
15       },
16       ...
17     ],
18     "shards" : [
19       {
20         "_id" : "<string>",
21         "rs" : "<string>",
22         "tags" : [ "<string>", ... ]
23       },
24       ...
25     ],
26     "tags" : [
27       {
28         "ns" : "<string>",
29         "min" : [
30           {
31             "parameter" : "<string>",
32             "parameterType" : "<string>",
33             "value" : "<string>"
34           }
35         ],
36         "max" : [
37           {
38             "parameter" : "<string>",
39             "parameterType" : "<string>",
40             "value" : "<string>"
41           }
42         ],
43         "tag" : "<string>"
44       },
45       ...
46     ]
47   },
48   ...
49 ]

Nombre

Tipo

Necesidad

Descripción

fragmentación

Arreglo de objetos

Opcional

Los objetos que definen la configuración de cada clúster con particionamiento. Cada objeto en el arreglo contiene las especificaciones para un clúster. El agente de MongoDB verifica periódicamente el estado de cada clúster con las especificaciones. Si la especificación y el clúster no coinciden, el agente cambiará la configuración del clúster, lo que podría causar que el balanceador migre fragmentos.

particionado.managedSharding

booleano

Condicional

Indicador que indica si Cloud Manager automatización gestiona todas las colecciones particionadas y las etiquetas en la implementación

particionado.name

string

Condicional

Nombre del clúster. Esto debe corresponder con el valor en processes.clúster para un mongos.

particionado.configServerReplica

string

Condicional

Nombre del set de réplicas del servidor de configuración.

Puede agregar este parámetro de arreglo si su servidor de configuración funciona como un set de réplicas.

Si ejecutas servidores de configuración heredados en modo espejo que no funcionan como un set de réplicas, usa sharding.configServer.

particionado.configServer

Arreglo de cadenas

Condicional

Nombres de los servidores host del servidor de configuración. Los nombres de host coinciden con los nombres utilizados en el parámetro processes.name de cada host.

IMPORTANTE: MongoDB 3.4 elimina el soporte para servidores de configuración en espejo. Si tu clúster ejecuta MongoDB 3.4 o posterior, usa particionado.configServerReplica.

particionado.colecciones

Arreglo de objetos

Condicional

Objetos que definen las colecciones particionadas y sus claves de partición.

particionado.colecciones._id

string

Condicional

namespace de la colección particionada. El namespace es la combinación del nombre de la base de datos y el nombre de la colección. Por ejemplo, testdb.testcoll.

particionado.collections.key

arreglo de arreglos

Condicional

claves shard de la colección. Contiene:

Un arreglo si el clúster utiliza una clave de partición.
Múltiples arreglos si su clúster utiliza una clave de partición compuesta.

particionado.colecciones.únicas

booleano

Condicional

Indicador que señala si MongoDB aplica la exclusividad para la clave de partición.

particionado.particiones

Arreglo de objetos

Condicional

Particiones del clúster.

particionado.shards._id

string

Condicional

Nombre de la partición.

particionado.particiones.rs

string

Condicional

Nombre del set de réplicas de la partición. Esto se especifica en replicaSets._id parámetro.

particionado.particiones.etiquetas

Arreglo de cadenas

Condicional

Zonas asignadas a esta partición.

Puede agregar este parámetro de matriz si utiliza particionado basado en zonas.

particionado.etiquetas

Arreglo de objetos

Condicional

Definición de zonas para particionado zonificado. Cada objeto de esta matriz define una zona y configura el rango de clave de partición para esa zona.

particionado.etiquetas.ns

string

Condicional

namespace de la colección que utiliza partición por zonas. El namespace combina el nombre de la base de datos y el nombre de la colección. Por ejemplo: testdb.testcoll.

particionado.tags.min

arreglo

Condicional

Valor mínimo del rango de clave de partición.

Especifica el nombre del campo, el tipo de campo y el valor en un documento del siguiente formulario.

{
  "field" : <string>,
  "fieldType" : <string>,
  "value" : <string>
}

fieldType debe ser una de las siguientes:

string
integer
long
double
decimal
date
timestamp
oid
minKey
maxKey

value debido a que debe pasarse como un valor de string.

Para utilizar una clave de partición compuesta, especifica cada campo en un documento diferente, como se muestra en el ejemplo después de esta tabla. Para obtener más información sobre claves de partición, consulta Claves de partición en el manual de MongoDB.

particionado.etiquetas.max

arreglo

Condicional

Valor máximo del rango de la clave de partición.

Especifica el nombre del campo, el tipo de campo y el valor en un documento del siguiente formulario.

{
  "field" : <string>,
  "fieldType" : <string>,
  "value" : <string>
}

fieldType debe ser una de las siguientes:

string
integer
long
double
decimal
date
timestamp
oid
minKey
maxKey

value debido a que debe pasarse como un valor de string.

particionado.etiquetas.etiqueta

string

Condicional

Nombre de la zona asociada con el rango de clave de partición especificado por particionado.etiquetas.min y particionado.etiquetas.max.

Ejemplo

El arreglo sharding.tags con clave compuesta de partición

La siguiente configuración de ejemplo define un rango de clave de partición compuesta con un valor mínimo de { a : 1, b : ab } y un valor máximo de { a : 100, b : fg }. El ejemplo define el rango en la colección testdb.test1 y lo asigna a la zona zone1.

1 "tags" : [
2   {
3     "ns" : "testdb.test1",
4     "min" : [
5       {
6         "parameter" : "a",
7         "parameterType" : "integer",
8         "value" : "1"
9       },
10       {
11         "parameter" : "b",
12         "parameterType" : "string",
13         "value" : "ab"
14       }
15     ],
16     "max" : [
17       {
18         "parameter" : "a",
19         "parameterType" : "integer",
20         "value" : "100"
21       },
22       {
23         "parameter" : "b",
24         "parameterType" : "string",
25         "value" : "fg"
26       }
27     ],
28     "tag" : "zone1"
29   }
30 ]

Balanceador de clúster

El objeto balanceador es opcional y define las configuraciones del equilibrador para cada clúster.

1 "balancer": {
2   "<clusterName1>": {},
3   "<clusterName2>": {},
4   ...
5 }

Nombre	Tipo	Necesidad	Descripción
balanceador	Objeto	Opcional	Parámetros nombrados de acuerdo con los clústeres, cada parámetro contiene un objeto con la configuración del balanceador deseado para el clúster. El objeto utiliza los parámetros stopped y activeWindow, tal como se describe en el cronograma para programar la ventana de balanceo en este tutorial en el manual de MongoDB.

Autenticación

Cloud Manager no requiere el objeto auth. Este objeto define los ajustes relacionados con la autenticación.

1 {
2   "auth": {
3     "authoritativeSet": "<boolean>",
4     "autoUser": "<string>",
5     "autoPwd": "<string>",
6     "disabled": "<boolean>",
7     "deploymentAuthMechanisms": ["<string>", "<string>"],
8     "autoAuthMechanisms": ["<string>"],
9     "key": "<string>",
10     "keyfile": "<string>",
11     "newAutoPwd": "<string>",
12     "newKey": "<string>",
13     "usersDeleted": [{
14       "user": "<string>",
15       "dbs": ["<string>", "<string>"]
16     }],
17     "usersWanted": [{
18       "authenticationRestrictions": [{
19         "clientSource": ["(IP | CIDR range)", "(IP | CIDR range)"],
20         "serverAddress": ["(IP | CIDR range)", "(IP | CIDR range)"]
21       }],
22       "db": "<string>",
23       "initPwd": "<string>",
24       "otherDBRoles": {
25         "<string>": ["<string>", "<string>"]
26       },
27       "roles": [{
28         "db": "<string>",
29         "role": "<string>"
30       }],
31       "pwd": "<string>",
32       "user": "<string>"
33     }]
34   }
35 }

Nombre

Tipo

Necesidad

Descripción

auth

Objeto

Opcional

Define los ajustes relacionados con la autenticación.

Si omites este parámetro, omite el resto de esta sección.

Conjunto autorizado

booleano

Condicional

Establece si Cloud Manager aplica o no un conjunto coherente de usuarios y roles administrados de MongoDB en todas las implementaciones administradas del proyecto.

Si "auth.authoritativeSet" : true, entonces Cloud Manager aplica usuarios y roles coherentes.
Si "auth.authoritativeSet": false, entonces Cloud Manager no aplica usuarios y roles consistentes.

auth.authoritativeSet por defecto es false.

Obligatorio si "auth" : true.

auth.autoUser

string

Condicional

Nombre de usuario que Automation utiliza para conectarse a una instancia.

Obligatorio si "auth" : true.

auth.autoPwd

string

Condicional

Contraseña que utiliza Automatización al conectarse a una instancia.

Obligatorio si "auth" : true.

auth.disabled

booleano

Opcional

Indicador de bandera si la autenticación está desactivada. Si no se especifica, disabled se establece por defecto en false.

mecanismos de autenticación de implementación de Auth

Arreglo de cadenas

Condicional

Enumera los mecanismos de autenticación admitidos para los procesos en la implementación.

Obligatorio si "auth" : true.

Especificar:

Valor	Mecanismo de autenticación
MONGODB-CR	SCRAM-SHA-1
SCRAM-SHA-256	SCRAM-SHA-256
MONGODB-X509	Certificado de cliente x.509
SIN FORMATO	LDAP
GSSAPI	Kerberos

auth.autoAuthMechanisms

Arreglo de cadenas

Condicional

Establece el mecanismo de autenticación utilizado por la automatización. Si no se especifica, disabled se establece por defecto en false.

Obligatorio si "auth" : true.

Este parámetro solo contiene más de un elemento cuando está configurado para SCRAM-SHA-1 y SCRAM-SHA-256.

Especificar:

Valor	Mecanismo de autenticación
MONGODB-CR	SCRAM-SHA-1
SCRAM-SHA-256	SCRAM-SHA-256
MONGODB-X509	Certificado de cliente x.509
SIN FORMATO	LDAP
GSSAPI	Kerberos

auth.key

string

Condicional

Contenido del archivo clave que Cloud Manager utiliza para autenticar los procesos de MongoDB.

Es obligatorio si "auth": true y "auth.disabled": false.

Si cambias el valor de auth.key, debes cambiar el valor de auth.keyfile.

auth.keyfile

string

Condicional

Ruta y nombre del archivo clave que Cloud Manager utiliza para autenticarse en los procesos de MongoDB.

Es obligatorio si "auth": true y "auth.disabled": false.

Si cambias el valor de auth.keyfile, debes cambiar el valor de auth.key.

auth

.newAutoPwd

string

Opcional

Nueva contraseña que la Automatización utiliza al conectarse a una instancia. Para rotar contraseñas sin perder la conexión:

Establezca auth.newAutoPwd y deje auth.autoPwd con su contraseña actual.
Espere al estado objetivo.
auth.newAutoPwd copia automáticamente la contraseña auth.autoPwd.

Puede establecer esta opción solo cuando incluya SCRAM-SHA-1 o SCRAM-SHA-256 como uno de los mecanismos de autenticación para la automatización en auth.autoAuthMechanisms.

auth.newKey

string

Opcional

Contenido de un nuevo archivo de clave que Cloud Manager debe usar para autenticar los procesos de MongoDB.

Cuando se activa esta opción, Cloud Manager rota la clave que la aplicación utiliza para autenticarse en los procesos de MongoDB en su implementación. Cuando todos los MongoDB agentes utilizan la nueva clave, Cloud Manager reemplaza el valor de auth.key con la nueva clave que se proporcionó en auth.newKey y elimina auth.newKey de la configuración de automatización.

auth.usuariosEliminados

Arreglo de objetos

Opcional

Objetos que definen a los usuarios autenticados que se borrarán de las bases de datos especificadas o de todas las bases de datos. Este arreglo debe contener auth.usersDeleted.user y auth.usersDeleted.dbs.

auth.usersDeleted[n].user

string

Opcional

Nombre de usuario que Cloud Manager debe borrar.

auth.usersDeleted[n].dbs

Arreglo de cadenas

Opcional

Enumere los nombres de las bases de datos de las que Cloud Manager debe borrar al usuario autenticado.

Se necesitan usuarios

Arreglo de objetos

Opcional

Contiene objetos que definen usuarios autenticados para agregar a bases de datos específicas. Cada objeto debe tener el auth.usersWanted[n].db, auth.usersWanted[n].user, y auth.usersWanted[n].roles parámetros, y luego tener exactamente uno de los siguientes parámetros: auth.usersWanted[n].pwd, auth.usersWanted[n].initPwd, o auth.usersWanted[n].userSource.

auth.usersWanted[n].db

string

Condicional

La base de datos a la que se agregará el usuario.

auth.usersWanted[n].user

string

Condicional

Nombre del usuario que Cloud Manager debe agregar.

auth.usersWanted[n].roles

arreglo

Condicional

Lista de los roles que se asignarán al usuario desde la base de datos de usuarios, registrada en auth.usersWanted[n].db.

auth.usersWanted[n].pwd

string

Condicional

Hash SCRAM-SHA-1 hexadecimal de 32 caracteres de la contraseña actualmente asignada al usuario.

Cloud Manager no utiliza este parámetro para establecer o cambiar una contraseña.

Obligatorio si:

"auth" : true,
"auth.deploymentAuthMechanisms" : "MONGODB-CR", y
"auth.usersWanted[n].initPwd" no está configurado.

auth.usersWanted[n].initPwd

string

Condicional

Contraseña en texto claro que deseas asignar al usuario.

Obligatorio si:

"auth" : true,
"auth.deploymentAuthMechanisms" : "MONGODB-CR", y
“auth.usersWanted[n].pwd” no está configurado.

auth.usersWanted[n].userSource

string

Obsoleto

Ya no se admite.

auth.usersWanted[n].otherDBRoles

Objeto

Opcional

Si asignas la base de datos del usuario "auth.usersWanted[n].db" : "admin", también puedes usar este objeto para asignar los roles de usuario de otras bases de datos. El objeto contiene pares clave-valor donde la clave es el nombre de la base de datos y el valor es un arreglo de valores de string que enumeran los roles que se asignarán desde esa base de datos.

auth.usersWanted[n].authenticationRestrictions

arreglo de documentos

Opcional

Restricciones de autenticación que el host aplica al usuario.

ADVERTENCIA: Si un usuario hereda varios roles con restricciones de autenticación incompatibles, ese usuario se vuelve inutilizable. Por ejemplo, si un usuario hereda un rol en el que el campo clientSource es [198.51.100.0] y otro rol en el que el campo clientSource es [203.0.113.0], el servidor no puede autenticar al usuario. Para obtener más información sobre la autenticación en MongoDB, consulte Autenticación.

auth.usersWanted[n].authenticationRestrictions[k].clientSource

Arreglo de cadenas

Condicional

Si está presente al autenticar a un usuario, el host verifica que la lista dada contenga la dirección IP del cliente rango CIDR. Si la dirección IP del cliente no está presente, el host no autentica al usuario.

auth.usersWanted[n].authenticationRestrictions[k].serverAddress

Arreglo de cadenas

Condicional

Arreglo separado por comas de direcciones IP a las que el cliente puede conectarse. Si está presente, el host verifica que Cloud Manager haya aceptado la conexión del cliente desde una dirección IP en el arreglo proporcionado. Si la conexión fue aceptada desde una dirección IP no reconocida, el host no autentica al usuario.

LDAP

El objeto ldap permite la autorización LDAP. Este objeto es opcional. Para obtener más información, consulte Activar la autenticación LDAP.

 "ldap": {
   "servers": "<host>:<port>, <host>:<port>",
   "timeoutMS": "<time>",
   "bindMethod": "<sasl/simple>",
   "bindSaslMechanisms": "<sasl-mechanism>, <sasl-mechanism>",
   "bindQueryUser": <ldap-dn>",
   "bindQueryPassword": "<password>",
   "userCacheInvalidationPeriod": "<interval>",
   "authzQueryTemplate": "<rfc-4516-url>",
   "userToDNMapping": [
             {
                     "match": "<ECMAScript-regex>",
                     "<substition/ldapQuery>": "<DN-string/RFC4516-encoded-LDAP-query>"
             }
   ]
}

Nombre	Tipo	Necesidad	Descripción
ldap	Objeto	Opcional	Objeto que contiene la configuración para habilitar y configurar la autorización LDAP.
ldap.servidores	string	Condicional	Cadena separada por comas que contiene uno o más servidores LDAP en formato `<host>:<port>` para ejecutar consultas. Puedes utilizar `setParameter` para configurar esta opción en un sistema en ejecución. Para la autorizacion LDAP, debes especificar esta configuración.
ldap.timeoutMS	long	Opcional	Cantidad de tiempo en milisegundos que MongoDB espera a que un servidor LDAP responda a una solicitud antes de que se agote el tiempo de espera. Puedes utilizar `setParameter` para configurar este ajuste en un sistema en funcionamiento. Por defecto, MongoDB agota el tiempo de espera después de diez segundos.
ldap.bindMethod	string	Opcional	string legible por humanos que indica si se debe utilizar una autenticación simple o un protocolo SASL para autenticar. Puede especificar `simple` o `sasl`. Por defecto, MongoDB utiliza una autenticación simple.
ldap.bindSaslMechanisms	string	Opcional	String que contiene una lista separada por comas de mecanismos SASL para que MongoDB intente autenticarse en el servidor LDAP durante la vinculación. De forma por defecto, MongoDB utiliza `DIGEST-MD5` para vincular.
ldap.bindQueryUser	string	Condicional	Nombre de dominio de la entidad LDAP que MongoDB utiliza al conectarse a un servidor LDAP. Puede usar `setParameter` para configurar esta opción en un sistema en funcionamiento. Para que MongoDB se vincule con credenciales de autenticación, debe especificar esta configuración.
ldap.bindQueryPassword	string	Condicional	Contraseña con la que MongoDB se vincula cuando se conecta a un servidor LDAP. Puede usar `setParameter` para configurar este ajuste en un sistema en funcionamiento. Para que MongoDB se vincule con una contraseña, debe especificar esta configuración.
ldap.userCacheInvalidationPeriod	entero	Opcional	Intervalo que MongoDB espera entre purgas del caché de usuario. Cuando el caché de usuario externo se purga, la siguiente operación que un usuario autorizado de LDAP realiza requiere una readquisición de roles. Si se especifica un valor alto, se podría reducir la carga en los servidores LDAP y aumentar el tiempo necesario para sincronizar los roles de MongoDB con la membresía de grupo LDAP. Por defecto, MongoDB espera 30 segundos entre vaciados de caché.
ldap.authzQueryTemplate	string	Condicional	RFC 4516 formato URL del LDAP query a ejecutar para obtener LDAP grupos relativos a la configuración `ldap.server`. En este URL, el string token de marcador de posición `{USER}` es reemplazado por el nombre de dominio del usuario adquirido. Puede utilizar `setParameter` para configurar este ajuste en un sistema en funcionamiento. Para la autorizacion LDAP, debe indicar este ajuste.
ldap.userToDNMapping	arreglo	Opcional	JSON-formato de arreglo que contiene las transformaciones ordenadas que MongoDB aplica para autenticar nombres de usuario de MongoDB y que coincidan con sus nombres de dominio. Puedes especificar esta configuración si utilizas un método de autenticación alternativo, o si el nombre de usuario transmitido a MongoDB para la autenticación no coincide con el nombre de dominio LDAP. Puede utilizar `setParameter` para configurar este ajuste en un sistema en funcionamiento. Por defecto, MongoDB utiliza los nombres de usuario como nombres de dominio para la autorización automática de LDAP.

ssl

El objeto ssl permite TLS para cifrar conexiones. Este objeto es opcional.

"ssl" : {
  "CAFilePath" : "<string>"
}

Nombre	Tipo	Necesidad	Descripción
ssl	Objeto	Opcional	Habilita TLS para cifrar las conexiones. Para utilizar TLS, elije un paquete que sea compatible con TLS. Todas las plataformas que admiten MongoDB Enterprise también admiten TLS.
ssl.clientCertificateMode	string	Condicional	Indica si las conexiones a Cloud Manager requieren un certificado TLS. Los valores son OPCIONALES y REQUERIDOS.
ssl.CAFilePath	string	Condicional	Ruta absoluta del archivo al certificado utilizado para autenticarse a través de TLS en un host Linux o UNIX. Cloud Manager requiere ssl.CAFilePath o ssa.CAFilePathWindows si: Estás utilizando TLS o autenticación X.509, y El archivo CA no está en los certificados raíz de tu sistema operativo.
ssl.CAFilePathWindows	string	Condicional	Ruta de archivo absoluta al certificado utilizado para la autenticación a través de TLS en un host de Windows. Cloud Manager requiere ssl.CAFilePath o ssa.CAFilePathWindows si: Estás utilizando TLS o autenticación X.509, y El archivo CA no está en los certificados raíz de tu sistema operativo.
ssl.autoPEMKeyFilePath	string	Condicional	Ruta de archivo absoluta de la llave privada del cliente (archivo PEM) que autentica la conexión TLS en un host Linux o UNIX. Cloud Manager requiere o bien ssl.autoPEMKeyFilePath o bien ssa.autoPEMKeyFilePathWindows si se utiliza TLS o autenticación X.509.
ssl.autoPEMKeyFilePathWindows	string	Condicional	Ruta absoluta del archivo al archivo de clave privada de cliente (PEM) que autentica la conexión TLS en un host de Windows. Cloud Manager requiere o bien ssl.autoPEMKeyFilePath o bien ssa.autoPEMKeyFilePathWindows si se utiliza TLS o autenticación X.509.
ssl.autoPEMKeyFilePwd	string	Condicional	Contraseña para el archivo de clave privada (PEM) especificado en ssl.autoPEMKeyFilePath o ssa.autoPEMKeyFilePathWindows. Cloud Manager requiere esta contraseña si el archivo PEM está cifrado.

Roles de MongoDB

La arreglo roles es opcional y describe los roles definidos por el usuario.

1 "roles" : [
2   {
3     "role" : "<string>",
4     "db" : "<string>",
5     "privileges" : [
6       {
7         "resource" : { ... },
8         "actions" : [ "<string>", ... ]
9       },
10       ...
11     ],
12     "roles" : [
13       {
14         "role" : "<string>",
15         "db" : "<string>"
16       }
17     ]
18     "authenticationRestrictions" : [
19      {
20       "clientSource": [("<IP>" | "<CIDR range>"), ...],
21       "serverAddress": [("<IP>" | "<CIDR range>"), ...]
22     }, ...
23   ]
24   },
25   ...
26 ]

Nombre	Tipo	Necesidad	Descripción
Roles	Arreglo de objetos	Opcional	Roles y privilegios que MongoDB ha asignado a los roles definidos por el usuario de un clúster. Cada objeto describe un rol definido por el usuario diferente. Los objetos de este arreglo contienen los mismos campos que los documentos en la colección de roles del sistema, excepto por el campo _id.
roles[n].role	string	Condicional	Nombre del rol definido por el usuario.
roles[n].db	string	Condicional	Base de datos a la que pertenece el rol definido por el usuario.
roles[n].privilegios	arreglo de documentos	Condicional	Privilegios que este rol puede realizar.
roles[n].privilegios[k].recurso	string	Condicional	Especifica los recursos sobre los que se aplican las acciones de privilegios.
roles[n].privileges[k].actions	string	Condicional	Acciones permitidas sobre el recurso. Para obtener más información, consulta Acciones de privilegio.
roles[n].roles	arreglo de documentos	Condicional	Funciones desde las que este rol hereda privilegios.
roles[n].authenticationRestrictions	arreglo de documentos	Opcional	Restricciones de autenticación que el servidor MongoDB aplica en este rol. ADVERTENCIA: Si un usuario hereda varios roles con restricciones de autenticación incompatibles, ese usuario se vuelve inutilizable. Por ejemplo, si un usuario hereda un rol en el que el campo `clientSource` es `[198.51.100.0]` y otro rol en el que el campo `clientSource` es `[203.0.113.0]`, el servidor no puede autenticar al usuario. Para obtener más información sobre la autenticación en MongoDB, consulte Autenticación.
roles[n].authenticationRestrictions[k].fuenteCliente	Arreglo de cadenas	Condicional	Si está presente, al autenticar a un usuario, el servidor de MongoDB verifica que la dirección IP del cliente esté en la lista proporcionada o pertenezca a un rango CIDR en la lista. Si la dirección IP del cliente no está presente, el servidor de MongoDB no autentica al usuario.
roles[n].authenticationRestrictions[k].serverAddress	Arreglo de cadenas	Condicional	Arreglo de direcciones IP separadas por comas a las que el cliente puede conectarse. Si está presente, el servidor MongoDB verifica que haya aceptado la conexión del cliente desde una dirección IP en el arreglo dado. Si el servidor de MongoDB acepta una conexión desde una dirección IP no reconocida, el servidor de MongoDB no autentica al usuario.

Kerberos

El Kerberos objeto es opcional y define un nombre de servicio de Kerberos que se utiliza en la autenticación.

"kerberos": {
  "serviceName": "<string>"
}

Nombre	Tipo	Necesidad	Descripción
kerberos	Objeto	Opcional	Par clave-valor que define el nombre del servicio kerberos que los agentes utilizan para autenticar a través de kerberos.
kerberos.serviceName	string	Requerido	Etiqueta que define: El nombre del servicio que los agentes utilizan para autenticarse en un `mongod` o `mongos` por medio de Kerberos. La opción saslServiceName en los MongoDB Server Parameters.

Indexes

El arreglo indexConfigs es opcional y define los índices que se crearán para específicos sets de réplicas.

1 "indexConfigs": [{
2   "key": [
3     ["<string>", "<value>"]
4   ],
5   "rsName": "<string>",
6   "dbName": "<string>",
7   "collectionName": "<string>",
8   "collation": {
9     "locale": "<string>",
10     "caseLevel": <boolean>,
11     "caseFirst": "<string>",
12     "strength": <number>,
13     "numericOrdering": <boolean>,
14     "alternate": "<string>",
15     "maxVariable": "<string>",
16     "normalization": <boolean>,
17     "backwards": <boolean>
18   },
19   "options": {
20     "<key>": "<value>"
21   }
22 }]

Nombre

Tipo

Necesidad

Descripción

indexConfigs

Arreglo de objetos

Opcional

Índices específicos que deben compilarse para sets de réplicas específicos.

indexConfigs.key

arreglo de arreglos

Requerido

Claves en el índice. Este "arreglo de arreglos" contiene un solo arreglo si el índice tiene solo una clave.

indexConfigs.rsName

string

Requerido

set de réplicas en el que MongoDB establece el índice.

indexConfigs.dbName

string

Requerido

Base de datos que MongoDB indexa.

indexConfigs.collectionName

string

Requerido

Colección que MongoDB indexa.

indexConfigs.intercalación

Objeto

Opcional

Reglas específicas del lenguaje que se deben usar al ordenar y comparar cadenas si el índice utiliza intercalación.

Si incluyes el objeto indexConfigs.collation, debes incluir el parámetro indexConfigs.collation.configuración regional. Todos los demás parámetros son opcionales.

Si no se incluye el objeto indexConfigs.collation, el índice no puede incluir intercalación.

indexConfigs.intercalación.localización

string

Requerido

Localización que define la ICU.

El manual del servidor MongoDB enumera las localizaciones admitidas en su sección Localizaciones de intercalación y parámetros por defecto.

Para especificar una comparación binaria simple, configura este valor en simple.

indexConfigs.intercalación.caseLevel

booleano

Opcional

Bandera que indica cómo el índice utiliza la comparación entre mayúsculas y minúsculas.

Si estableces este parámetro en true, el índice utiliza la comparación por mayúsculas y minúsculas.

Este parámetro se aplica solo si se establece indexConfigs.intercalación.strength en 1 o 2.

Para obtener más información, consulta Intercalación.

indexConfigs.intercalación.caseFirst

string

Opcional

Orden de clasificación de las diferencias de mayúsculas y minúsculas durante comparaciones a nivel terciario.

El manual del MongoDB Server enumera los valores posibles en su Sección de intercalación.

indexConfigs.intercalación.strength

Número

Opcional

Nivel de comparación a realizar. Corresponde a Niveles de comparación ICU.

El manual del MongoDB Server enumera los valores posibles en su Sección de intercalación.

indexConfigs.intercalación.numericOrdering

booleano

Opcional

Indicador que señala cómo comparar cadenas numéricas.

Valor	Método de intercalación	Ejemplo
true	cadenas numéricas comparadas como números	10 > 2.
false	cadenas numéricas comparadas como cadenas	10 < 2.

El valor por defecto es false.

Para obtener más información, consulta Intercalación.

indexConfigs.intercalación.alternate

string

Opcional

Configuración que determina cómo la intercalación debe considerar el espacio en blanco y la puntuación como caracteres base durante las comparaciones.

El manual del MongoDB Server enumera los valores posibles en su Sección de intercalación.

indexConfigs.intercalación.maxVariable

string

Opcional

Caracteres que el índice puede ignorar. Este parámetro solo se aplica si indexConfigs.intercalación.alternate está configurado en shifted.

El manual del MongoDB Server enumera los valores posibles en su Sección de intercalación.

intercalación.normalización

booleano

Opcional

Indicador que indica si el texto debe ser normalizado.

Si configura este parámetro como true, intercalación:

Verifica si el texto requiere normalización.
Realiza la normalización

Para obtener más información, consulta Intercalación.

indexConfigs.intercalación.backwards

booleano

Opcional

Marca que indica cómo el índice debe gestionar las cadenas con diacríticos.

Para obtener más información, consulta Intercalación.

indexConfigs.options

Documento

Requerido

Opciones de índices que admite el MongoDB Go Driver.

Volver

Opciones avanzadas de implementación

Configuraciones y automatización

1	"mongoDbVersions[n]" : [
2	{
3	"name" : "<string>",
4	"builds" : [
5	{
6	"platform" : "<string>",
7	"url" : "<string>",
8	"gitVersion" : "<string>",
9	"modules" : [ "<string>", ... ],
10	"architecture" : "<string>",
11	"bits" : "<integer>",
12	"win2008plus" : "<Boolean>",
13	"winVCRedistUrl" : "<string>",
14	"winVCRedistOptions" : [ "<string>", ... ],
15	"winVCRedistDll" : "<string>",
16	"winVCRedistVersion" : "<string>"
17	},
18	...
19	],
20	},
21	...
22	]

1	"monitoringVersions" : [
2	{
3	"name" : "<string>",
4	"hostname" : "<string>",
5	"urls" : {
6	"<platform1>" : {
7	"<build1>" : "<string>",
8	...,
9	"default" : "<string>"
10	},
11	...
12	},
13	"baseUrl" : "<string>",
14	"logPath" : "<string>",
15	"logRotate" : {
16	"sizeThresholdMB" : <number>,
17	"timeThresholdHrs" : <integer>,
18	"numUncompressed": <integer>,
19	"percentOfDiskspace" : <number>,
20	"numTotal" : <integer>
21	}
22	},
23	...
24	]

1	"backupVersions[n]" : [
2	{
3	"name" : "<string>",
4	"hostname" : "<string>",
5	"urls" : {
6	"<platform1>" : {
7	"<build1>" : "<string>",
8	...,
9	"default" : "<string>"
10	},
11	...
12	},
13	"baseUrl" : "<string>",
14	"logPath" : "<string>",
15	"logRotate" : {
16	"sizeThresholdMB" : "<number>",
17	"timeThresholdHrs" : "<integer>",
18	"numUncompressed": "<integer>",
19	"percentOfDiskspace" : "<number>",
20	"numTotal" : "<integer>"
21	}
22	},
23	...
24	]

1	"processes": [{
2	"<args>": {},
3	"alias": "<string>",
4	"authSchemaVersion": "<integer>",
5	"backupRestoreUrl": "<string>",
6	"cluster": "<string>",
7	"defaultRWConcern": {
8	"defaultReadConcern": {
9	"level": "<string>"
10	},
11	"defaultWriteConcern": {
12	"j": "<boolean>",
13	"w": "<string>",
14	"wtimeout": "<integer>"
15	}
16	}
17	"disabled": "<Boolean>",
18	"featureCompatibilityVersion": "<string>",
19	"hostname": "<string>",
20	"lastCompact" : "<dateInIso8601Format>",
21	"lastRestart" : "<dateInIso8601Format>",
22	"lastResync" : "<dateInIso8601Format>",
23	"lastKmipMasterKeyRotation" : "<dateInIso8601Format>",
24	"logRotate": {
25	"sizeThresholdMB": "<number>",
26	"timeThresholdHrs": "<integer>",
27	"numUncompressed": "<integer>",
28	"percentOfDiskspace": "<number>",
29	"numTotal": "<integer>"
30	},
31	"manualMode": "<Boolean>",
32	"name": "<string>",
33	"numCores": "<integer>",
34	"processType": "<string>",
35	"version": "<string>"
36	}]

1	"clusterWideConfigurations" : {
2	"<replicaSetID/clusterName>": {
3	"changeStreamOptions": {
4	"preAndPostImages": {
5	"expireAfterSeconds": <integer>
6	}
7	}
8	}
9	}

1	"replicaSets":
2	[
3	{
4	"_id": "<string>",
5	"protocolVersion": "<string>",
6	"members":
7	[
8	{
9	"_id": "<integer>",
10	"host": "<string>",
11	"arbiterOnly": "<boolean>",
12	"buildIndexes": "<boolean>",
13	"hidden": "<boolean>",
14	"priority": "<number>",
15	"tags": "<object>",
16	"secondaryDelaySecs": "<integer>",
17	"votes": "<number>"
18	},{
19	"_id": "<integer>",
20	"host": "<string>",
21	"arbiterOnly": "<boolean>",
22	"buildIndexes": "<boolean>",
23	"hidden": "<boolean>",
24	"priority": "<number>",
25	"tags": "<object>",
26	"secondaryDelaySecs": "<integer>",
27	"votes": "<number>"
28	},{
29	"_id": "<integer>",
30	"host": "<string>",
31	"arbiterOnly": "<boolean>",
32	"buildIndexes": "<boolean>",
33	"hidden": "<boolean>",
34	"priority": "<number>",
35	"tags": "<object>",
36	"secondaryDelaySecs": "<integer>",
37	"votes": "<number>"
38	}
39	],
40	"force":
41	{
42	"currentVersion": "<integer>"
43	}
44	}
45	]

1	"sharding" : [
2	{
3	"managedSharding" : <boolean>,
4	"name" : "<string>",
5	"configServerReplica" : "<string>",
6	"collections" : [
7	{
8	"_id" : "<string>",
9	"key" : [
10	[ "shard key" ],
11	[ "shard key" ],
12	...
13	],
14	"unique" : <boolean>
15	},
16	...
17	],
18	"shards" : [
19	{
20	"_id" : "<string>",
21	"rs" : "<string>",
22	"tags" : [ "<string>", ... ]
23	},
24	...
25	],
26	"tags" : [
27	{
28	"ns" : "<string>",
29	"min" : [
30	{
31	"parameter" : "<string>",
32	"parameterType" : "<string>",
33	"value" : "<string>"
34	}
35	],
36	"max" : [
37	{
38	"parameter" : "<string>",
39	"parameterType" : "<string>",
40	"value" : "<string>"
41	}
42	],
43	"tag" : "<string>"
44	},
45	...
46	]
47	},
48	...
49	]

1	"tags" : [
2	{
3	"ns" : "testdb.test1",
4	"min" : [
5	{
6	"parameter" : "a",
7	"parameterType" : "integer",
8	"value" : "1"
9	},
10	{
11	"parameter" : "b",
12	"parameterType" : "string",
13	"value" : "ab"
14	}
15	],
16	"max" : [
17	{
18	"parameter" : "a",
19	"parameterType" : "integer",
20	"value" : "100"
21	},
22	{
23	"parameter" : "b",
24	"parameterType" : "string",
25	"value" : "fg"
26	}
27	],
28	"tag" : "zone1"
29	}
30	]

1	"balancer": {
2	"<clusterName1>": {},
3	"<clusterName2>": {},
4	...
5	}

1	{
2	"auth": {
3	"authoritativeSet": "<boolean>",
4	"autoUser": "<string>",
5	"autoPwd": "<string>",
6	"disabled": "<boolean>",
7	"deploymentAuthMechanisms": ["<string>", "<string>"],
8	"autoAuthMechanisms": ["<string>"],
9	"key": "<string>",
10	"keyfile": "<string>",
11	"newAutoPwd": "<string>",
12	"newKey": "<string>",
13	"usersDeleted": [{
14	"user": "<string>",
15	"dbs": ["<string>", "<string>"]
16	}],
17	"usersWanted": [{
18	"authenticationRestrictions": [{
19	"clientSource": ["(IP \| CIDR range)", "(IP \| CIDR range)"],
20	"serverAddress": ["(IP \| CIDR range)", "(IP \| CIDR range)"]
21	}],
22	"db": "<string>",
23	"initPwd": "<string>",
24	"otherDBRoles": {
25	"<string>": ["<string>", "<string>"]
26	},
27	"roles": [{
28	"db": "<string>",
29	"role": "<string>"
30	}],
31	"pwd": "<string>",
32	"user": "<string>"
33	}]
34	}
35	}

1	"roles" : [
2	{
3	"role" : "<string>",
4	"db" : "<string>",
5	"privileges" : [
6	{
7	"resource" : { ... },
8	"actions" : [ "<string>", ... ]
9	},
10	...
11	],
12	"roles" : [
13	{
14	"role" : "<string>",
15	"db" : "<string>"
16	}
17	]
18	"authenticationRestrictions" : [
19	{
20	"clientSource": [("<IP>" \| "<CIDR range>"), ...],
21	"serverAddress": [("<IP>" \| "<CIDR range>"), ...]
22	}, ...
23	]
24	},
25	...
26	]

1	"indexConfigs": [{
2	"key": [
3	["<string>", "<value>"]
4	],
5	"rsName": "<string>",
6	"dbName": "<string>",
7	"collectionName": "<string>",
8	"collation": {
9	"locale": "<string>",
10	"caseLevel": <boolean>,
11	"caseFirst": "<string>",
12	"strength": <number>,
13	"numericOrdering": <boolean>,
14	"alternate": "<string>",
15	"maxVariable": "<string>",
16	"normalization": <boolean>,
17	"backwards": <boolean>
18	},
19	"options": {
20	"<key>": "<value>"
21	}
22	}]