Nota
Grupos y proyectos son términos sinónimos. Su {PROJECT-ID} es el mismo que su ID del grupo. Para los grupos existentes, el ID del grupo se mantiene igual. Esta página utiliza el término más familiar grupo cuando se refiere a descripciones. El endpoint permanece tal como se indica en el documento.
Esta página describe los parámetros que componen la configuración de automatización.
Para consultar ejemplos adicionales, vea mms-api-examples.
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
Ops Manager descarga versiones automáticas y ejecuta scripts de inicio en el directorio establecido en opciones.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 desde la que descargar MongoDB para esta instancia. |
mongoDbVersiones[n].builds[k].gitVersion | string | Requerido | Identificador de confirmación que identifica el estado del código utilizado para construir el proceso de MongoDB. El comando |
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 | URL desde la que se puede descargar la versión necesaria del paquete redistribuible de Microsoft Visual C++. |
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
Para garantizar que sus versiones estén actualizadas, use el punto final Actualizar versiones de agente en lugar de actualizar la versión de MongoDB Agent a través de esta propiedad de configuración.
"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 que descargar el agente de MongoDB. |
Procesos de MongoDB
El processes arreglo determina la configuración de tus instancias de MongoDB. Con este arreglo, puedes:
Restaurar una instancia.
Inicie 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 "certificatesVersion": "<integer>", 7 "cluster": "<string>", 8 "defaultRWConcern": { 9 "defaultReadConcern": { 10 "level": "<string>" 11 }, 12 "defaultWriteConcern": { 13 "j": "<boolean>", 14 "w": "<string>", 15 "wtimeout": "<integer>" 16 } 17 } 18 "disabled": "<Boolean>", 19 "featureCompatibilityVersion": "<string>", 20 "hostname": "<string>", 21 "lastCompact" : "<dateInIso8601Format>", 22 "lastRestart" : "<dateInIso8601Format>", 23 "lastResync" : "<dateInIso8601Format>", 24 "lastKmipMasterKeyRotation" : "<dateInIso8601Format>", 25 "logRotate": { 26 "sizeThresholdMB": "<number>", 27 "timeThresholdHrs": "<integer>", 28 "numUncompressed": "<integer>", 29 "percentOfDiskspace": "<number>", 30 "numTotal": "<integer>" 31 }, 32 "manualMode": "<Boolean>", 33 "name": "<string>", 34 "numCores": "<integer>", 35 "processType": "<string>", 36 "version": "<string>" 37 }]
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
Procesos | arreglo | Requerido | |
processes[n].args2_6 | Objeto | Requerido | Objeto de configuración de MongoDB para las versiones 2.6 y posteriores de MongoDB. El objeto |
processes[n].args2_6.particionado.clusterRole | string | Condicional | Función de este proceso Necesario para los procesos de servidor de configuración y nodo de partición. Si omite este campo, la implementación podría quedarse atascada en el estado objetivo porque MongoDB no puede iniciarse sin la marca de empresa emergente correspondiente. Valores aceptados:
|
processes[n].alias | string | Opcional | Alias del nombre de host (a menudo un CNAME de DNS) para el host donde se ejecuta el proceso. Si se especifica un alias, el Agente de MongoDB lo prioriza sobre el nombre de host especificado en processes.hostname al conectarse al host. También puede especificar este alias en replicaSets.host y sharding.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.
Para obtener más información, consulte SCRAM en el manual de la base de datos. |
procesos[n].backupRestoreUrl | string | Opcional | URL de entrega para la restauración. Ops Manager la configura al crear una restauración. Para cancelar una operación de restauración en curso, establezca esta opción en Para obtener más información, consulta Automatizar la restauración de copias de seguridad a través de la API. |
processes[n].certificatesVersion | entero | Opcional | Contador que activa la rotación de certificados TLS sin tiempo de inactividad. Al incrementar este valor, el Agente de MongoDB ejecuta |
processes[n].clúster | string | Condicional | Nombre del clúster fragmentado. Establezca este valor al mismo valor que en el parámetro sharding.name en la matriz de fragmentación para |
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:
|
defaultRWConcern.defaultWriteConcern.j | booleano | Opcional | Indicador que especifica si la confirmación de escritura debe registrarse en el diario del 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:
|
defaultRWConcern.defaultWriteConcern.wtimeout | Número | Opcional | Límite de tiempo deseado para la preocupación de escritura, expresado en milisegundos. Establezca este valor cuando configure defaultRWConcern.defaultWriteConcern.w con 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.
Para obtener más información, consulte |
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 formato de fecha y hora ISO 8601 en UTC que indica la última vez que Ops Manager recuperó espacio libre en los discos de un clúster. Durante ciertas operaciones, MongoDB puede mover o eliminar datos, pero no libera el espacio actualmente sin usar. Ops Manager recupera el espacio en disco de forma progresiva entre los miembros del conjunto de réplicas o fragmentos. Para reclamar este espacio:
Para eliminar cualquier ambigüedad sobre cuándo pretende recuperar el espacio en los discos del clúster, especifique una zona horaria con su marca de tiempo ISO 8601. Por ejemplo, para establecer processes.lastCompact en 28 enero 2021 a las 2:43:52 PM hora estándar central de EE. UU., utilice |
processes[n].lastRestart | string | Opcional | Marca de tiempo en formato ISO 8601 (fecha y hora UTC) que indica la última vez que Ops Manager reinició este proceso. Si establece este parámetro con la marca de tiempo actual, Ops Manager forzará el reinicio del proceso tras cargar esta configuración. Si establece este parámetro para varios procesos en el mismo clúster, Ops Manager reiniciará los procesos seleccionados de forma secuencial en los miembros del conjunto de réplicas o fragmentos. |
processes[n].lastResync | string | Opcional | Marca de tiempo en formato de fecha y hora ISO 8601 en UTC del último proceso de sincronización inicial que Ops Manager realizó en el nodo. Para activar el proceso de sincronización inicial en el nodo de inmediato, establezca este valor en la hora actual como una marca de tiempo ISO 8601. ADVERTENCIA: Utilice este parámetro con precaución. Durante la sincronización inicial, Automation elimina todo el contenido del directorio Si estableces este parámetro:
Para obtener más información, consulte Sincronización inicial. |
processes[n].lastKmipMasterKeyRotation | string | Opcional | Marca de tiempo en formato ISO 8601 (fecha y hora UTC) que indica la última rotación de la clave maestra KMIP por parte de Ops Manager. Si establece este parámetro con la marca de tiempo actual, Ops Manager rotará la clave después de cargar 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 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. 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 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 una entrada de registro individual antes de que Ops Manager lo rote. Ops Manager rota la entrada de registro inmediatamente si cumple con el valor dado en este sizeThresholdMB o el 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. 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 el MongoDB Agent automatiza 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 | |
procesos[n].version | string | Requerido | Nombre de la especificación mongoDbVersions utilizada con esta instancia. |
En todo el clúster
clusterWideConfigurations especifica los parámetros que se deben configurar en un conjunto de réplicas o en un clúster fragmentado sin necesidad de un reinicio gradual.
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 conjunto de réplicas o al clúster fragmentado. El agente de MongoDB solo comprueba si esta configuración está en 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, consulte |
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 conjunto de réplicas. El agente de MongoDB utiliza los valores de este array para crear documentos de configuración de conjuntos de réplicas válidos. El agente comprueba periódicamente que los conjuntos de réplicas estén configurados correctamente. Si se produce un problema, el agente reconfigura el conjunto de réplicas según su documento de configuración. El array puede contener los siguientes campos de nivel superior de un documento de configuración de conjunto de réplicas: _id, version y members. Para obtener más información, consulte |
replicaSets[n]._id | string | Requerido | El nombre del set de réplicas. |
replicaSets[n].protocolVersion | string | Opcional | Versión del protocolo del conjunto 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 |
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 | Indicador que especifica si el proceso |
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 el Ops Manager seleccione a este set de réplicas como primario. Un número más alto aumenta la elegibilidad. Este valor puede estar entre 0 y 1000, inclusive para nodos que contienen 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 para el agente de MongoDB para forzar a un conjunto 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 agente de MongoDB obliga al conjunto de réplicas a usar. Establézcala en -1 para forzar al conjunto de réplicas a aceptar una nueva configuración. ADVERTENCIA: Forzar la reconfiguración de un conjunto de réplicas podría provocar la reversión de las escrituras confirmadas por la mayoría. Proceda con precaución. Si tiene preguntas sobre las posibles consecuencias de esta operación, póngase en contacto con el soporte técnico de MongoDB. |
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" : 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 en el array contiene las especificaciones de un clúster. El agente de MongoDB comprueba periódicamente el estado de cada clúster comparándolo con las especificaciones. Si las especificaciones y el clúster no coinciden, el agente modificará la configuración del clúster, lo que podría provocar que el balanceador migre fragmentos. |
particionado.managedSharding | booleano | Opcional | Indicador que especifica si Ops Manager Automation gestiona todas las colecciones y etiquetas fragmentadas en la implementación. A partir de la versión 7.0 de Ops Manager, esta opción solo se puede configurar en |
particionado.name | string | Condicional | Nombre del clúster. Este debe corresponder con el valor en processes.cluster para un |
particionado.configServerReplica | string | Condicional | Nombre del conjunto 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.particiones | Arreglo de objetos | Condicional | Fragmentos 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. Puedes añadir este parámetro de matriz si utilizas fragmentación por zonas. |
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 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. |
Autenticación
Para habilitar la autenticación, configure el objeto auth. Este objeto es opcional y define la configuración relacionada 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 la configuración relacionada con la autenticación. Si omites este parámetro, omite el resto de esta sección. |
Conjunto autorizado | booleano | Condicional | Configura si MongoDB Ops Manager aplica un conjunto coherente de usuarios y roles de MongoDB gestionados en todas las implementaciones gestionadas en el Proyecto.
auth.authoritativeSet por defecto es false. 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:
|
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:
|
auth.key | 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 | string | Opcional | Nueva contraseña que la Automatización utiliza al conectarse a una instancia. Para rotar contraseñas sin perder la conexión:
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 | Contenidos de un nuevo archivo de clave que quieres que Ops Manager use 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.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 del usuario que Ops Manager debería borrar. |
auth.usersDeleted[n].dbs | Arreglo de cadenas | Opcional | Enumera los nombres de las bases de datos desde las que Ops 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 debería agregar Ops Manager. |
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:
|
auth.usersWanted[n].initPwd | string | Condicional | Contraseña en texto claro que deseas asignar al usuario. Obligatorio si:
|
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, dicho usuario quedará inutilizable. Por ejemplo, si un usuario hereda un rol cuyo campo |
auth.usersWanted[n].authenticationRestrictions[k].clientSource | Arreglo de cadenas | Condicional | Si está presente al autenticar a un usuario, el host verifica que la lista proporcionada 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. |
LDAP
El objeto ldap habilita la autorización LDAP. Este objeto es opcional. Para obtener más información, consulte la sección «Administrar la autenticación LDAP para su 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 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 |
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. Puede usar |
ldap.bindMethod | string | Opcional | Cadena legible que indica si se debe usar autenticación simple o el protocolo SASL para autenticarse. Se puede especificar |
ldap.bindSaslMechanisms | string | Opcional | Cadena que contiene una lista separada por comas de mecanismos SASL que MongoDB puede usar para intentar autenticarse contra el servidor LDAP durante el enlace. Por defecto, MongoDB usa |
ldap.bindQueryUser | string | Condicional | Nombre de dominio de entidadLDAP que MongoDB utiliza al conectarse a un servidor LDAP. Puede usar |
ldap.bindQueryPassword | string | Condicional | Contraseña que MongoDB utiliza para conectarse a un servidor LDAP. Puede usar |
ldap.userCacheInvalidationPeriod | entero | Opcional | Intervalo de espera de MongoDB entre vaciados de caché de usuario. Cuando se vacía la caché de usuario externa, la siguiente operación que realice un usuario autorizado por LDAP requiere la readquisición de roles. Si especifica un valor alto, podría disminuir la carga en sus servidores LDAP y aumentar el tiempo necesario para sincronizar los roles de MongoDB con la pertenencia a grupos LDAP. Por defecto, MongoDB espera 30 segundos entre vaciados de caché. |
ldap.authzQueryTemplate | string | Condicional | URL conformato RFC 4516 de la consulta LDAP que se ejecutará para obtener grupos LDAP relativos a la configuración |
ldap.userToDNMapping | arreglo | Opcional | Matriz con formatoJSON que contiene las transformaciones ordenadas que MongoDB aplica para autenticar los nombres de usuario 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 que se pasa a MongoDB para la autenticación no coincide con el nombre de dominio LDAP. Puede usar |
TLS
El objeto opcional tls habilita TLS para cifrar las conexiones.
"tls" : { "CAFilePath" : "<string>" }
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
tls | Objeto | Opcional | Habilita TLS para cifrar las conexiones. Para usar TLS, elija un paquete que lo admita. Todas las plataformas compatibles con MongoDB Enterprise también son compatibles con TLS. |
tls.CAFilePath | string | Condicional | Ruta de acceso absoluta al certificado utilizado para la autenticación mediante TLS. Obligatorio si se configura tls.clientCertificateMode. |
tls.clientCertificateMode (Modo de Certificado de Cliente)` | 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. |
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 en 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 puede desempeñar este rol. |
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,consulte Acciones de privilegio. |
roles[n].roles | arreglo de documentos | Condicional | Roles de los 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, dicho usuario quedará inutilizable. Por ejemplo, si un usuario hereda un rol cuyo campo |
roles[n].authenticationRestrictions[k].fuenteCliente | Arreglo de cadenas | Condicional | Si está presente, al autenticar a un usuario, el servidor MongoDB verifica que la dirección IP del cliente se encuentre en la lista proporcionada o pertenezca a un rango CIDR de la lista. Si la dirección IP del cliente no está presente, el servidor 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 objeto kerberos es opcional y define un nombre de servicio 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 autenticarse a través de Kerberos. |
kerberos.serviceName | string | Requerido | Etiqueta que define:
|
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 idioma que se deben usar al ordenar y comparar 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.intercalación.localización | string | Requerido | Localidad definida por la UCI. El manual del servidor MongoDB enumera las configuraciones regionales compatibles en su sección "Configuraciones regionales de intercalación y parámetros predeterminados". 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 la sección de Cotejo. |
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 de intercalación. |
indexConfigs.intercalación.strength | Número | Opcional | Nivel de comparación a realizar. Corresponde a los niveles de comparación de la UCI. El manual del servidor MongoDB 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.
El valor por defecto es false. Para obtener más información, consulte la sección de Cotejo. |
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 servidor MongoDB 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 servidor MongoDB enumera los valores posibles en su sección de intercalación. |
intercalación.normalización | booleano | Opcional | Bandera que indica si se debe normalizar el texto. Si configura este parámetro como true, intercalación:
El valor por defecto es false. Para obtener más información, consulte la sección de Cotejo. |
indexConfigs.intercalación.backwards | booleano | Opcional | Marca que indica cómo el índice debe gestionar las cadenas con diacríticos. Si configuras este parámetro en true, las strings con diacríticos se ordenan de atrás hacia adelante en la string. El valor por defecto es false. Para obtener más información, consulte la sección de Cotejo. |
indexConfigs.options | Documento | Requerido | Opciones de índice que admite el controlador de MongoDB para Go. |