Join us at MongoDB.local London on 7 May to unlock new possibilities for your data. Use WEB50 to save 50%.
Register now >
Docs Menu
Docs Home
/ /

Parámetros de configuración de automatización

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} es el mismo que el ID de tu proyecto. Para los grupos existentes, el ID de grupo/proyecto permanece igual. Esta página utiliza el término más familiar «grupo» al referirse a las descripciones. El punto final se mantiene como se indica en el documento.

Esta página describe los parámetros que componen la configuración de automatización.

Para revisar ejemplos adicionales, consulta ejemplos-de-api-mms.

Aquí se 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.

Ops Manager descarga versiones automáticas y ejecuta scripts de inicio en el directorio establecido 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 plataformas Linux y UNIX para descargas automáticas de versiones y scripts de inicio.

La matriz mongoDbVersions[n] define objetos de especificación para las instancias de MongoDB que se encuentran en la matriz processes. Cada instancia de MongoDB de la matriz processes debe tener un objeto de especificación en esta matriz.

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. Ops 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 de la DLL de tiempo de ejecución de Microsoft Visual C++ que debe estar presente para omitir la instalación del paquete redistribuible de Microsoft Visual C++.

agentVersion especifica la versión del MongoDB Agent.

Nota

Si bien puede actualizar la versión del Agente MongoDB a través de esta propiedad de configuración, debe utilizar el Actualice el punto final de versiones del agente para garantizar 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.

La matriz de procesos determina la configuración de sus instancias de MongoDB. Con esta matriz, puede:

  • 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 el administrador de Ops Manager. Cada objeto define una instancia diferente.

processes[n].args2_6

Objeto

Requerido

Objeto de configuración de MongoDB para versiones de MongoDB 2.6 y posteriores.

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.

  • Ops Manager acepta 3 y 5 para este parámetro.

  • Los clústeres de MongoDB 3.x y 4.x tienen por defecto 5.

  • El número predeterminado de clústeres de MongoDB 2.6 es 3.

Para obtener más información, consulte SCRAM en el manual de bases de datos.

procesos[n].backupRestoreUrl

string

Opcional

URL de entrega para la restauración. Ops Manager la establece al crear una restauración. Para cancelar una restauración en curso, configure esta opción CANCEL en.

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 con el mismo valor que el del parámetro sharding.name en la matriz de mongos fragmentación para.

PreocupaciónRWpredeterminada.preocupaciónLecturapredeterminada.nivel

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 confirmar una operación de escritura en conjuntos de réplicas y fragmentos de conjuntos 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].deshabilitados

Booleano

Opcional

Marca que indica si este proceso debe detenerse. Establézcalo como verdadero para detenerlo.

procesos[n].featureCompatibilityVersion

string

Requerido

Versión de MongoDB con la que este proceso es compatible con las características. Cambiar este valor puede habilitar o deshabilitar ciertas características que persisten datos incompatibles con versiones de MongoDB anteriores o posteriores a la featureCompatibilityVersion que elija.

  • Ops Manager acepta 5.0, 6.0 y 7.0 como valores de parámetro. Si tienes una implementación existente, Ops Manager solo acepta una featureCompatibilityVersion igual o una versión anterior a la que has implementado en MongoDB. Para aprender qué valores de estos parámetros son compatibles con cada versión de MongoDB, y qué funcionalidades cada uno de estos valores habilita o desactiva, consulta setFeatureCompatibilityVersion en el Manual de MongoDB.

  • Ops Manager establece este parámetro para que coincida con la versión de MongoDB para nuevas implementaciones.

  • El Gestor de operaciones no incrementa automáticamente este parámetro cuando se actualiza 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 el formato de fecha y hora en UTC cuando Ops Manager recuperó espacios libres de los discos de un clúster. Durante ciertas operaciones, MongoDB podría mover o borrar datos, pero no libera el espacio actualmente no utilizado. Ops Manager recupera el espacio en disco de forma gradual entre los nodos 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, configure este valor para un futuro ISO 8601 timestamp. Ops Manager recupera el espacio después de que la hora actual pase la marca de tiempo proporcionada.

Para evitar cualquier ambigüedad sobre cuándo pretende recuperar el espacio en los discos del clúster, especifique una zona horaria con su marca 8601 de tiempo ISO. Por ejemplo, para establecer process.lastCompact en el de 28 enero 2021 de 2 a43 las::52 p. m., hora estándar del centro de EE. UU., utilice."processes.lastCompact" : "2021-01-28T14:43:52-06:00"

procesos[n].lastRestart

string

Opcional

Marca de tiempo en ISO 8601 formato de fecha y hora en UTC la última vez que Ops Manager reinició este proceso. Si estableces este parámetro con la marca de tiempo actual, el Ops Manager obliga a reiniciar este proceso después de cargar esta configuración. Si configura este parámetro para varios procesos en el mismo clúster, Ops Manager reinicia los procesos seleccionados de manera progresiva en todos los nodos del set de réplicas o particiones.

procesos[n].lastResync

string

Opcional

Marca de tiempo en formato ISO 8601 de fecha y hora en UTC del último proceso de sincronización inicial que Ops 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 mayo 2021 a las 2:43:52 p. m., hora estándar central de EE. UU., utilice:

    "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 Ops Manager rotó por última vez la clave maestra KMIP. Si configura este parámetro con la marca de tiempo actual, Ops Manager rotará la clave después de que cargue esta configuración.

procesos[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 retiene Ops Manager. Si no se establece este valor, el número total de entradas de registro por defecto es 0. Ops Manager basa la rotación en los demás ajustes de processes.logRotate.

procesos[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.

processes[n].logRotate. porcentaje del espacio del disco

Número

Opcional

Porcentaje máximo del espacio total en disco que Ops Manager puede utilizar para almacenar las entradas de registro expresado como decimal. Si se supera este límite, Ops Manager borra las entradas de registro comprimidas hasta cumplirlo. Ops 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 un archivo de registro individual antes de que Ops Manager lo rote. Ops Manager rota el archivo de registro inmediatamente si alcanza el valor especificado en sizeThresholdMB o en el límite de procesos.logRotate.timeThresholdHrs.

processes[n].logRotate. timeThresholdHrs

entero

Requerido

Duración máxima en horas de un archivo de registro individual antes de la siguiente rotación. El tiempo transcurrido es desde la última rotación.

Ops Manager rota la entrada de registro una vez que el archivo cumpla con este timeThresholdHrs o el processes.logRotate.sizeThresholdMB límite.

processes[n].manualMode

Booleano

Opcional

Bandera que indica si MongoDB Agent automatiza este proceso.

  • El valor predeterminado es falso.

  • Establezca este valor en verdadero para suspender la automatización en este proceso. El agente de MongoDB no realizará ninguna otra acción en este proceso hasta que se reanude la automatización.

  • 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

Número de núcleos a los que el gestor de operaciones debe asignar este proceso. El Agente de MongoDB distribuye los procesos entre los núcleos de la manera más equitativa posible.

procesos[n].tipoDeProceso

string

Requerido

Tipo de proceso de MongoDB que se está ejecutando. Ops Manager acepta mongod o mongos para este parámetro.

procesos[n].versión

string

Requerido

Nombre de la especificación mongoDbVersions utilizada con esta instancia.

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 del flujo de cambios que se aplican al conjunto de réplicas o al clúster fragmentado. El Agente de MongoDB solo comprueba si esta configuración tiene un formato JSON válido, 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.

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

conjuntos 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, consulte 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 nodos.host debe especificar el nombre del host tal como aparece en processes.name. El MongoDB Agent expande el campo host para crear una configuración válida de set de réplicas.

Para obtener más información, consulte replSetGetConfig.

replicaSets[n].members[m]._id

entero

Requerido

Cualquier entero positivo que indique el miembro del conjunto 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].members[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.

réplicasConjuntos[n].miembros[m].ocultos

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 Ops Manager seleccione este miembro del conjunto de réplicas como principal. Un número mayor aumenta la elegibilidad. Este valor puede estar entre 0 y 1000, inclusive para los nodos que contienen datos. Los árbitros pueden tener valores de 0 o 1.

réplicasConjuntos[n].miembros[m].etiquetas

Objeto

Opcional

Lista de etiquetas definidas por el usuario y sus valores aplicados a este set de réplicas.

replicaSets[n].members[m].secondaryDelaySecs

entero

Opcional

Cantidad de tiempo en segundos que este miembro del conjunto de réplicas debe estar detrás del principal.

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.

réplicas[n].force

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.

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" : false,
4 "name" : "<string>",
5 "configServerReplica" : "<string>",
6 "shards" : [
7 {
8 "_id" : "<string>",
9 "rs" : "<string>",
10 "tags" : [ "<string>", ... ]
11 },
12 ...
13 ],
14 },
15 ...
16]
Nombre
Tipo
Necesidad
Descripción

fragmentación

Arreglo de objetos

Opcional

Objetos que definen la configuración de cada clúster fragmentado. Cada objeto de la matriz contiene las especificaciones de un clúster. El agente de MongoDB comprueba periódicamente el estado de cada clúster con respecto a 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 provocar que el balanceador migre fragmentos.

particionado.managedSharding

booleano

Opcional

Bandera que indica si la Automatización de Ops Manager administra todas las colecciones particionadas y etiquetas en la implementación. A partir de la versión 7.0 de Ops Manager, esto solo se puede establecer en false.

particionado.name

string

Condicional

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

fragmentación.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 ejecuta servidores de configuración reflejados heredados que no se ejecutan como un conjunto de réplicas, utilice 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.particiones

Arreglo de objetos

Condicional

Fragmentosdel cluster.

particionado.shards._id

string

Condicional

Nombre de la partición.

fragmentación.fragmentos.rs

string

Condicional

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

fragmentación.fragmentos.etiquetas

Arreglo de cadenas

Condicional

Zonas asignadas a esta partición.

Puede agregar este parámetro de matriz si utiliza fragmentación por zonas.

El objeto balanceador es opcional y define la configuración del balanceador para cada clúster.

1"balancer": {
2 "<clusterName1>": {},
3 "<clusterName2>": {},
4 ...
5}
Nombre
Tipo
Necesidad
Descripción

balanceador

Objeto

Opcional

Parámetros con nombre para cada clúster, donde cada parámetro contiene un objeto con la configuración del balanceador para ese clúster. El objeto utiliza los parámetros `stopped` y `activeWindow`. Para obtener más información, consulte «Administrar el balanceador de clústeres fragmentados» en el manual de MongoDB.

Para activar la autenticación, configura el objeto auth. Este objeto es opcional y 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

autorización

Objeto

Opcional

Define configuraciones relacionadas con la autenticación.

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

Conjunto autorizado

booleano

Condicional

Establece si Ops Manager aplica, o no, un conjunto coherente de usuarios y funciones gestionados de MongoDB en todas las implementaciones gestionadas en el Proyecto.

auth.authoritativeSet tiene como valor predeterminado falso.

Obligatorio si habilita la autenticación.

auth.autoUser

string

Condicional

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

Obligatorio si habilita la autenticación.

auth.autoPwd

string

Condicional

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

Obligatorio si habilita la autenticación.

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 habilita la autenticación.

Especificar:

Valor
Mecanismo de autenticación

MONGODB-CR

SCRAM-SHA-256

MONGODB-X509

PLANO

GSSAPI

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 habilita la autenticación.

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-256

MONGODB-X509

PLANO

GSSAPI

clave de autorización

string

Condicional

Contenido del archivo de claves que Ops Manager utiliza para autenticar los procesos de MongoDB.

Obligatorio si habilitas la autenticación 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 de clave que Ops Manager utiliza para autenticar los procesos de MongoDB.

Obligatorio si habilitas la autenticación 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:

  1. Establezca auth.newAutoPwd y deje auth.autoPwd con su contraseña actual.

  2. Espere al estado objetivo.

  3. 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 desea que Ops Manager utilice para autenticarse en los procesos de MongoDB.

Cuando activas esta opción, el Ops Manager rota la clave que la aplicación utiliza para autenticarse en los procesos MongoDB de tu implementación. Cuando todos los MongoDB Agents utilizan la nueva clave, Ops Manager reemplaza el valor de auth.key con la nueva clave que proporcionaste en auth.newKey y remueve auth.newKey de la configuración de automatización.

auth.usersEliminados

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 del usuario que Ops Manager debería borrar.

auth.usersDeleted[n].dbs

Arreglo de cadenas

Opcional

Enumere los nombres de las bases de datos de las que Ops Manager debe eliminar el usuario autenticado.

auth.usuariosBuscados

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

Base de datos a la que agregar el usuario.

auth.usersWanted[n].usuario

string

Condicional

Nombre del usuario que Ops 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.

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

Obligatorio si:

  • Usted habilita la autenticación

  • "auth.deploymentAuthMechanisms" : "MONGODB-CR"

  • "auth.usersWanted[n].initPwd" no está definido

auth.usersWanted[n].initPwd

string

Condicional

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

Obligatorio si:

  • Usted habilita la autenticación

  • "auth.deploymentAuthMechanisms" : "MONGODB-CR"

  • "auth.usersWanted[n].initPwd" no está definido

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].restricciones de autenticación

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 el rango CIDR de la dirección IP del cliente. 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 Ops Manager haya aceptado la conexión del cliente desde una dirección IP en el arreglo dado. Si la conexión fue aceptada desde una dirección IP no reconocida, el host no autentica al usuario.

El objeto ldap permite la autorización LDAP. Este objeto es opcional. Para obtener más información, consulta Habilita la autenticación LDAP para tu proyecto de Ops Manager.

"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 las configuraciones para habilitar y configurar la autorización LDAP.

servidores ldap

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

Tiempo en milisegundos que MongoDB espera a que un servidor LDAP responda a una solicitud antes de agotar el tiempo de espera. Puede usar setParameter para configurar este ajuste en un sistema en ejecución. De forma predeterminada, 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 entidadLDAP que MongoDB vincula al conectarse a un servidor LDAP. Puede usar setParameter para configurar este ajuste en un sistema en ejecución. Para que MongoDB se vincule con las credenciales de autenticación, debe especificar este ajuste.

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

Matriz con formatoJSON que contiene las transformaciones ordenadas que MongoDB aplicapara autenticar los nombres de usuario de MongoDB y que coincidan con sus nombres de dominio. Puede especificar esta configuración si utiliza 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 usar setParameter para configurar esta configuración en un sistema en ejecución. De forma predeterminada, MongoDB utiliza los nombres de usuario como nombres de dominio para la autorización LDAP automática.

El objeto tls habilita TLS para cifrar conexiones. Este objeto es opcional.

"tls" : {
"CAFilePath" : "<string>"
}
Nombre
Tipo
Necesidad
Descripción

tls

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.

tls.CAFilePath

string

Condicional

Ruta de archivo absoluta al certificado utilizado para autenticarse a través de TLS. Requerido si configura tls.clientCertificateMode.

tls.clientCertificateMode

string

Condicional

Especifica si las conexiones a Ops Manager requieren un certificado TLS. Ops Manager acepta OPTIONAL y REQUIRE. Es obligatorio si se configura tls.CAFilePath.

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 esta matriz contienen los mismos campos que los documentos de la colección de roles del sistema, excepto 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 privilegio.

roles[n].privileges[k].actions

string

Condicional

Acciones permitidas en el recurso.

Para obtener más información,consulte 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 esta función.

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].restriccionesDeAutenticación[k].direcciónDelServidor

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.

El objeto kerberos es opcional y define un nombre de servicio Kerberos utilizado 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 autenticarse mediante Kerberos.

kerberos.serviceName

string

Requerido

Etiqueta que define:

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.nombreColección

string

Requerido

Colección que MongoDB indexa.

indexConfigs.intercalación

Objeto

Opcional

Reglas específicas del idioma que se deben utilizar al ordenar y hacer coincidir cadenas si el índice usa 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.collation.locale

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, consulte 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 servidor MongoDB enumera los valores posibles en su sección 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 servidor MongoDB enumera los valores posibles en su sección 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 predeterminado es falso.

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

indexConfigs.intercalación.alternate

string

Opcional

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

El Manual del servidor MongoDB enumera los valores posibles en su sección 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 servidor MongoDB enumera los valores posibles en su sección Intercalación.

indexConfigs.collation.normalization

booleano

Opcional

Bandera 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 comparar texto.

El valor predeterminado es falso.

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

indexConfigs.intercalación.backwards

booleano

Opcional

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

Si establece este parámetro como verdadero, las cadenas con signos diacríticos se ordenan desde atrás hacia adelante en la cadena.

El valor predeterminado es falso.

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

indexConfigs.options

Documento

Requerido

Opciones de índices que admite el MongoDB Go Driver.

Volver

Actualizar la configuración de automatización (sin secretos)

En esta página