Docs Menu
Docs Home
/ /

Configuración de automatización

La automatización utiliza una configuración para determinar el estado deseado de una implementación de MongoDB y realizar los cambios necesarios. Si modifica la implementación a través de la interfaz web de Ops Manager, no necesitará manipular esta configuración.

Si está utilizando Automation sin Ops Manager, puede construir y distribuir la configuración manualmente.

Los campos opcionales están marcados como tal.

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

Nota

Ops Manager no admite la configuración y administración del servidor MongoDB Opciones de net.unixDomainSocket.enabled net.unixDomainSocket.pathPrefixnet.unixDomainSocket como, y net.unixDomainSocket.filePermissions utilizando la configuración de automatización de Ops Manager.

La automatización de Ops Manager no valida la siguiente configuración de MongoDB. Si proporciona un valor incorrecto, podría causar problemas, tiempo de inactividad o ambos:

  • __exec

  • __rest

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.

opciones.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

versiones de mongoDb[n]

matriz de objetos

Requerido

Objetos de especificación para las instancias de MongoDB que se encuentran en la matriz de procesos. Cada instancia de MongoDB en procesos debe tener un objeto de especificación en mongoDbVersions[n].

mongoDbVersions[n].nombre

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]

matriz 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 cual descargar MongoDB para esta instancia.

mongoDbVersions[n].builds[k].gitVersion

string

Requerido

Identificador de confirmación que identifica el estado del código utilizado para compilar el proceso de MongoDB. El comando buildInfo de MongoDB devuelve el identificador gitVersion.

mongoDbVersions[n].builds[k].modules

arreglo

Requerido

Lista de módulos para esta versión. Corresponde al parámetro de 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 del bus del procesador. No elimine ni modifique este parámetro.

mongoDbVersions[n].builds[k].win2008más

Booleano

Opcional

Establezca como verdadero si se trata de una compilación de Windows que requiere Windows 7 o posterior o Windows Server 2008 R2 o posterior.

mongoDbVersions[n].builds[k].winVCRedistUrl

string

Opcional

URL desde la que se puede descargar la versión requerida del paquete redistribuible de Microsoft Visual C++.

mongoDbVersions[n].builds[k].winVCRedistOptions

matriz 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 tiempo de ejecución de Microsoft Visual C++ que el agente comprueba para determinar si se necesita una nueva versión del paquete 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 agente MongoDB.

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 MongoDB.

agentVersion.directoryUrl

string

Opcional

URL desde la que descargar el Agente MongoDB.

El arreglo monitoringVersions especifica la versión del agente de supervisión. Ops Manager ha hecho obsoleto este parámetro. Para actualizar la configuración del registro de supervisión, usa el endpoint Actualizar la 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

versiones de monitoreo

matriz de objetos

Opcional

Objetos que definen información de versión para cada agente de monitoreo.

monitoringVersions.name

string

Requerido

Versión del Agente de Monitoreo.

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

string

Requerido

FQDN del host que ejecuta el Agente de Monitoreo. Si el Agente de Monitoreo no se está ejecutando en el host, Ops Manager lo instala desde la ubicación especificada en monitoringVersions.urls.

monitoringVersions.urls

Objeto

Requerido

URLespecíficas de la plataforma y la compilación desde las cuales descargar el agente de monitoreo.

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 el valor predeterminado, y cada valor es una URL para descargar el Agente de Monitoreo. El objeto debe incluir la clave predeterminada establecida en la URL de descarga predeterminada para la plataforma.

monitoringVersions.baseUrl

string

Requerido

URL base utilizada para la configuración mmsbaseurl.

monitoringVersions.logPath

string

Opcional

Directorio donde el agente almacena sus registros. El valor predeterminado es /dev/null.

monitoringVersions.logRotate

Objeto

Opcional

Habilita la rotación de registros para los registros de MongoDB para un proceso.

monitoringVersions.logRotate.sizeThresholdMB

Número

Requerido

Tamaño máximo en MB para un archivo de registro individual antes de la rotación.

monitoringVersions.logRotate.timeThresholdHrs

entero

Requerido

Tiempo máximo en horas para un archivo de registro individual antes de la rotación.

monitoringVersions.logRotate.numUncompressed

entero

Opcional

Número máximo de archivos de registro que se dejarán sin comprimir, incluido el archivo de registro actual. El valor predeterminado es. En versiones anteriores de 5 Ops Manager, este campo se llamaba maxUncompressed. El nombre anterior aún se reconoce, aunque se prefiere la nueva versión.

monitoringVersions.logRotate.porcentajeDeEspacioDeDisco

Número

Opcional

Porcentaje máximo del espacio total en disco que deben ocupar todos los archivos de registro antes de su eliminación. El valor predeterminado 02es.

monitoringVersions.logRotate.numTotal

entero

Opcional

Número total de archivos de registro. Si no se especifica un número, el número total de archivos de registro 0 predeterminado es y se determina mediante otras opciones de monitoringVersions.logRotate.

La matriz backupVersions especifica la versión del agente de backup. Ops Manager ha dejado este parámetro obsoleto. Para actualizar la configuración del registro de backup, utilice el punto de conexión "Actualizar configuración de backup".

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

versiones de respaldo[n]

matriz de objetos

Opcional

Objetos que definen información de versión para cada agente de respaldo.

backupVersions[n].nombre

string

Requerido

Versión del agente de copia de seguridad.

Para obtener más información, consulte la Matriz de compatibilidad de MongoDB.

IMPORTANTE: Esta propiedad es de solo lectura. Las modificaciones realizadas en ella no se reflejan al actualizar el Agente de Backup mediante la API. Para actualizar la versión del Agente de Backup, consulte este punto de conexión.

backupVersions[n].nombrehost

string

Requerido

FQDN del host que ejecuta el Agente de Backup. Si el Agente de Backup no se está ejecutando en el host, Ops Manager lo instala desde la ubicación especificada en backupVersions[n].urls.

backupVersions[n].urls

Objeto

Requerido

URLespecíficas de la plataforma y la compilación desde las cuales descargar el Agente de respaldo.

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 el valor predeterminado, y cada valor es una URL para descargar el Agente de Backup. El objeto debe incluir la clave predeterminada establecida en la URL de descarga predeterminada 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. El valor predeterminado es /dev/null.

backupVersions[n].logRotate

Objeto

Opcional

Habilita la rotación de registros para los registros de MongoDB para un proceso.

backupVersions[n].logRotate.sizeThresholdMB

Número

Requerido

Tamaño máximo en MB para un archivo de registro individual antes de la rotación.

backupVersions[n].logRotate.timeThresholdHrs

entero

Requerido

Tiempo máximo en horas para un archivo de registro individual antes de la rotación.

backupVersions[n].logRotate.numUncompressed

entero

Opcional

Número máximo de archivos de registro que se dejarán sin comprimir, incluido el archivo de registro actual. El valor predeterminado 5 es.

backupVersions[n].logRotate.porcentajeDeEspacioDeDisco

Número

Opcional

Porcentaje máximo del espacio total en disco que deben ocupar todos los archivos de registro antes de su eliminación. El valor predeterminado 02es.

backupVersions[n].logRotate.numTotal

entero

Opcional

Si no se especifica un número, el número total de archivos de registro predeterminado es y está determinado por otras 0 configuraciones de backupVersion.logRotate.

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

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 que Ops Manager supervisa. Cada objeto define una instancia mongod diferente.

procesos[n].args2_6

Objeto

Requerido

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

El processes.args2_6 objeto acepta la mayoría de las configuraciones y parámetros de MongoDB para las versiones 2.6 y posteriores. Para obtener más información, consulte Configuración y compatibilidad con automatización de MongoDB.

procesos[n].alias

string

Opcional

Alias ​​del nombre de host (normalmente un CNAME DNS) del host donde se ejecuta el proceso. Si se especifica un alias, el agente de MongoDB lo prefiere al nombre de host especificado en processes.hostname al conectarse al host. También puede especificar este alias en replicaSets.host y sharding.configServer.

procesos[n].authSchemaVersion

entero

Requerido

Versión del esquema de las credenciales de usuario para los usuarios de la base de datos MongoDB. Debe coincidir con todos los demás elementos de la matriz de procesos que pertenecen al mismo clúster.

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

  • Los clústeres MongoDB.x 3 y.x tienen como valor 4 5 predeterminado.

  • Los clústeres MongoDB 2.6 tienen como valor 3 predeterminado.

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 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, consulte 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 consistencia y aislamiento establecidas para los datos leídos desde conjuntos de réplicas y fragmentos de conjuntos de réplicas. MongoDB Atlas acepta los siguientes valores:

  • "disponible"

  • "local"

  • "mayoría"

PreocupaciónRW predeterminada.preocupaciónEscrita predeterminada.j

booleano

Opcional

Bandera que indica si el acuse de recibo de escritura debe escribirse en el diario del disco.

PreocupaciónRWpredeterminada.preocupaciónEscritapredeterminada.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"

PreocupaciónRWpredeterminada.PreocupaciónEscriturapredeterminada.tiempodeespera

Número

Opcional

Límite de tiempo deseado para la escritura, expresado en milisegundos. Establezca este valor cuando configure defaultRWConcern.defaultWriteConcern.w con un valor mayor 1 que.

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 5.0 acepta, 6.0 y como valores de parámetro. Si ya 7.0 tiene una implementación, Ops Manager solo acepta una featureCompatibilityVersion igual o anterior a la versión de MongoDB que implementó. Para saber cuáles de estos valores de parámetro son compatibles con cada versión de MongoDB y qué funciones habilita o deshabilita cada uno de ellos, consulte setFeatureCompatibilityVersion en el Manual de MongoDB.

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

  • Ops Manager no incrementa automáticamente este parámetro cuando actualiza un host de una versión de MongoDB a la siguiente.

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

procesos[n].nombrehost

string

Requerido

Nombre del host que atiende este proceso. El valor predeterminado es localhost.

procesos[n].lastCompact

string

Opcional

Marca de tiempo en ISO 8601Formato de fecha y hora en UTC de 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 no utilizado. Ops Manager recupera el espacio en disco de forma continua entre los miembros del conjunto de réplicas o fragmentos.

Para recuperar este espacio:

  • Inmediatamente, establezca este valor en la hora actual como una marca de 8601 tiempo ISO.

  • 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 formato ISO 8601 de fecha y hora UTC de la última vez que Ops Manager reinició este proceso. Si configura este parámetro con la marca de tiempo actual, Ops Manager forzará el reinicio de este proceso después de cargar esta configuración. Si configura este parámetro para varios procesos en el mismo clúster, Ops Manager reiniciará los procesos seleccionados de forma continua en todos los miembros del conjunto de réplicas o fragmentos.

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 establece este parámetro:

  • En el nodo secundario, el agente MongoDB 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 de inicialización 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 principal, el Agente MongoDB espera hasta que le solicite al nodo principal que se convierta en secundario con el rs.stepDown() método y luego inicia la sincronización de inicio 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, consulte 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 archivos de registro que se dejarán sin comprimir, incluido el archivo de registro actual. El valor predeterminado 5 es.

procesos[n].logRotate.porcentajeDeEspacioDeDisco

Número

Opcional

Porcentaje máximo del espacio total en disco que Ops Manager puede usar para almacenar los archivos de registro, expresado en decimales. Si se supera este límite, Ops Manager elimina los archivos de registro comprimidos hasta alcanzarlo. Ops Manager elimina primero los archivos de registro más antiguos.

El valor por defecto es 0,02.

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

procesos[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 el archivo de registro una vez que el archivo alcanza este límite timeThresholdHrs o el límite de process.logRotate.sizeThresholdMB.

procesos[n].manualMode

Booleano

Opcional

Bandera que indica si MongoDB Agent automatiza este proceso.

  • El valor predeterminado es falso.

  • Establézcalo como verdadero para deshabilitar la automatización en este proceso. El agente de MongoDB no realiza ninguna otra acción en este proceso.

  • Establézcalo como falso para habilitar la automatización en este proceso. El agente de MongoDB automatiza las acciones en este proceso.

procesos[n].nombre

string

Requerido

Nombre único para identificar la instancia.

procesos[n].numCores

entero

Opcional

Número de núcleos que Ops Manager debe vincular a este proceso. El agente de MongoDB distribuye los procesos entre los núcleos de la forma más uniforme posible.

procesos[n].processType

string

Requerido

Tipo de proceso MongoDB en ejecución. Ops Manager acepta mongod o para este mongos parámetro.

procesos[n].versión

string

Requerido

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

clusterWideConfigurations especifica los parámetros que se deben configurar en un conjunto de réplicas o un clúster fragmentado sin necesidad de un reinicio continuo.

1"clusterWideConfigurations" : {
2 "<replicaSetID/clusterName>": {
3 "changeStreamOptions": {
4 "preAndPostImages": {
5 "expireAfterSeconds": <integer>
6 }
7 }
8 }
9}
Nombre
Tipo
Necesidad
Descripción

replicaSetID/nombre del clúster

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.

cambiarOpcionesDeTransmisión.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 elimina este valor, MongoDB Agent solo elimina este parámetro de su configuración de automatización, pero no del servidor.

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

La matriz replicaSets define la configuración de cada conjunto de réplicas. Este campo es obligatorio para implementaciones con conjuntos 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 conjunto de réplicas. El agente de MongoDB utiliza los valores de esta matriz para crear documentos de configuración válidos de conjuntos de réplicas. 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. La matriz puede contener los siguientes campos de nivel superior de un documento de configuración de conjuntos de réplicas: _id; versión; y miembros.

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

conjuntos de réplicas[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.

réplicasSets[n].miembros

arreglo

Opcional

Objetos que definen cada miembro del conjunto de réplicas. El campo members.host debe especificar el nombre del host, tal como aparece en processes.name. El Agente de MongoDB expande el campo host para crear una configuración válida del conjunto de réplicas.

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

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

entero

Requerido

Cualquier entero positivo que indique el miembro del conjunto de réplicas.

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

string

Opcional

Nombre de host y número de puerto, cuando corresponda, que sirve a este miembro del conjunto de réplicas.

replicaSets[n].members[m].arbiterOnly

booleano

Opcional

Bandera que indica si este miembro del conjunto de réplicas actúa como árbitro.

replicaSets[n].members[m].buildIndexes

booleano

Opcional

Bandera que indica si el proceso crea índices en este miembro del conjunto de mongod réplicas.

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

booleano

Opcional

Bandera que indica si el conjunto de réplicas permite que este miembro acepte operaciones de lectura.

réplicasConjuntos[n].miembros[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, ambos 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 miembro del conjunto 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.

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

Número

Opcional

Cantidad de votos que este miembro del conjunto de réplicas puede emitir para una elección del conjunto de réplicas. Todos los nodos con datos pueden tener 0 o 1 votos. Los árbitros siempre tienen 1 votos.

réplicas[n].force

Objeto

Opcional

Instrucciones al agente MongoDB para forzar que un conjunto de réplicas utilice la versión de configuración especificada en replicaSets.force.CurrentVersion.

Con este objeto, el Agente MongoDB puede forzar a un conjunto de réplicas a aceptar una nueva configuración para recuperarse de un estado en el que una minoría de sus miembros están disponibles.

replicaSets[n].force.currentVersion

entero

Opcional

Versión de configuración que el agente de MongoDB obliga al conjunto de réplicas a usar. Se establece en -1 para obligar 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 la mayoría de las escrituras confirmadas. Proceda con precaución. Contacte con el soporte de MongoDB si tiene alguna pregunta sobre el posible impacto 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

matriz 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.

fragmentación.fragmentación gestionada

booleano

Opcional

Marca que indica si Ops Manager Automation administra todas las colecciones y etiquetas fragmentadas en la implementación. A partir de la versión de Ops Manager,7.0 solo se puede configurar false en.

nombre de fragmentación

string

Condicional

Nombre del clúster. Debe coincidir con el valor en `processes.cluster` para un mongos valor.

fragmentación.configServerReplica

string

Condicional

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

Puede agregar este parámetro de matriz si su servidor de configuración se ejecuta como un conjunto de réplicas.

Si ejecuta servidores de configuración reflejados heredados que no se ejecutan como un conjunto de réplicas, utilice sharding.configServer.

fragmentación.configServer

matriz de cadenas

Condicional

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

IMPORTANTE: MongoDB 3.4 ya no admite servidores de configuración reflejados. Si su clúster fragmentado ejecuta MongoDB o una versión 3.4 posterior, utilice sharding.configServerReplica.

fragmentación.fragmentos

matriz de objetos

Condicional

Fragmentosdel cluster.

fragmentación.fragmentos._id

string

Condicional

Nombre del fragmento.

fragmentación.fragmentos.rs

string

Condicional

Nombre del conjunto de réplicas del fragmento. Se especifica en el parámetro replicaSets._id.

fragmentación.fragmentos.etiquetas

matriz 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 nombrados según los clústeres. Cada parámetro contiene un objeto con la configuración de balanceo deseada para el clúster. El objeto utiliza los parámetros "stopped" y "activeWindow", como se describe en el procedimiento para programar la ventana de balanceo en este tutorial del manual de MongoDB.

Para habilitar la autenticación, configure el auth objeto. Este objeto es opcional y define la configuración de 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 omite este parámetro, omita el resto de esta sección.

conjuntoautoritario

booleano

Condicional

Establece si Ops Manager aplica o no un conjunto consistente de usuarios y roles de MongoDB administrados en todas las implementaciones administradas en el proyecto.

auth.authoritativeSet tiene como valor predeterminado falso.

Obligatorio si habilita la autenticación.

auth.autoUser

string

Condicional

Nombre de usuario que utiliza la Automatización al 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.

autenticación deshabilitada

booleano

Opcional

Bandera que indica si la autenticación está deshabilitada. Si no se especifica, el valor predeterminado es "deshabilitado".

Mecanismos de autenticación de implementación de autenticación

matriz 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

matriz de cadenas

Condicional

Establece el mecanismo de autenticación utilizado por la automatización. Si no se especifica, el valor predeterminado es "deshabilitado".

Obligatorio si habilita la autenticación.

Este parámetro contiene más de un elemento solo 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 clave que Ops Manager utiliza para autenticarse en los procesos de MongoDB.

Obligatorio si habilita la autenticación y "auth.disabled": falso.

Si cambia el valor de auth.key, debe cambiar el valor de auth.keyfile.

archivo de claves de autenticación

string

Condicional

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

Obligatorio si habilita la autenticación y "auth.disabled": falso.

Si cambia el valor de auth.keyfile, debe cambiar el valor de auth.key.

auth
.newAutoPwd

string

Opcional

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

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

  2. Espere el estado objetivo.

  3. auth.newAutoPwd copia automáticamente la contraseña auth.autoPwd.

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

auth.nuevaclave

string

Opcional

Contenido de un nuevo archivo de clave que desea que Ops Manager utilice para autenticarse en los procesos de MongoDB.

Al configurar esta opción, Ops Manager rota la clave que la aplicación usa para autenticarse en los procesos de MongoDB en su implementación. Cuando todos los agentes de MongoDB usan la nueva clave, Ops Manager reemplaza el valor de auth.key con la nueva clave proporcionada en auth.newKey y la elimina de la configuración de automatización.

auth.usersEliminados

matriz de objetos

Opcional

Objetos que definen los usuarios autenticados que se eliminarán de las bases de datos especificadas o de todas las bases de datos. Esta matriz debe contener auth.usersDeleted.user y auth.usersDeleted.dbs.

auth.usersDeleted[n].usuario

string

Opcional

Nombre de usuario del usuario que Ops Manager debe eliminar.

auth.usersDeleted[n].dbs

matriz de cadenas

Opcional

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

auth.usuariosBuscados

matriz de objetos

Opcional

Contiene objetos que definen usuarios autenticados para agregarlos a bases de datos específicas. Cada objeto debe tener los parámetros auth.usersWanted[n].db, auth.usersWanted[n].user y auth.usersWanted[n].roles, 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 del usuario, que se especifica en auth.usersWanted[n].db.

auth.usersWanted[n].pwd

string

Condicional

32-carácter hexadecimal SCRAM-SHA-1 hash de la contraseña actualmente asignada al usuario.

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

Requerido si:

  • Habilitas la autenticación

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

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

auth.usersWanted[n].initPwd

string

Condicional

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

Requerido si:

  • Habilitas la autenticación

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

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

auth.usersWanted[n].userSource

string

Obsoleto

Ya no se admite.

auth.usersWanted[n].otherDBRoles

Objeto

Opcional

Si asigna la base de datos del usuario "auth.usersWanted[n].db": "admin", puede usar este objeto para asignar roles de usuario también desde 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 una matriz de valores de cadena que enumera los roles que se asignarán desde esa base de datos.

auth.usersWanted[n].restricciones de autenticación

conjunto 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, quedará inutilizable. Por ejemplo, si un usuario hereda un rol cuyo clientSource campo es [198.51.100.0] y otro cuyo clientSource campo [203.0.113.0] es, el servidor no podrá autenticarlo. Para obtener más información sobre la autenticación en MongoDB, consulte Autenticación.

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

matriz 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

matriz de cadenas

Condicional

Matriz de direcciones IP separadas por comas 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 de la matriz dada. Si la conexión se aceptó desde una dirección IP desconocida, el host no autentica al usuario.

El ldap objeto habilita la autorización LDAP. Este objeto es opcional. Para obtener más información, consulte Habilitar 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 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 <host>:<port> formato para ejecutar consultas. Puede usar setParameter para configurar esta opción en un sistema en ejecución. Para la autorización LDAP, debe especificar esta opció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.

Método ldap.bind

string

Opcional

Cadena legible que indica si se debe usar autenticación simple o un protocolo SASL para autenticarse. Puede especificar simple saslo. De forma predeterminada, MongoDB usa autenticación simple.

ldap.bindSaslMechanisms

string

Opcional

Cadena que contiene una lista separada por comas de mecanismos SASL para que MongoDB intente la autenticación con el servidor LDAP durante el enlace. De forma predeterminada, MongoDB usa para el DIGEST-MD5 enlace.

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 al conectarse a un servidor LDAP. Puede usar setParameter para configurar esta opción en un sistema en ejecución. Para que MongoDB se vincule con una contraseña, debe especificar esta opción.

Periodo de invalidación de caché de usuario ldap

entero

Opcional

Intervalo que MongoDB espera entre vaciados de caché de usuario. Cuando se vacía la caché de usuario externa, la siguiente operación que realiza un usuario autorizado LDAP requiere la readquisición de roles. Si especifica un valor alto, podría reducir la carga en sus servidores LDAP y aumentar el tiempo necesario para sincronizar los roles de MongoDB con la pertenencia a grupos LDAP. De forma predeterminada, MongoDB espera 30 segundos entre vaciados de caché.

Plantilla de consulta ldap.authz

string

Condicional

URLcon formatoRFC 4516 de la consulta LDAP que se ejecutará para obtener grupos LDAP relativos a la ldap.server configuración. En esta URL, la cadena de token de marcador de posición {USER} se reemplaza por el nombre de dominio del usuario adquirido. Puede usar setParameter para configurar esta opción en un sistema en ejecución. Para la autorización LDAP, debe especificar esta opción.

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 SSL habilita TLS para cifrar conexiones. Este objeto es opcional.

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

ssl

Objeto

Opcional

Habilita TLS para cifrar conexiones. Para usar TLS, elija un paquete compatible con TLS.

Todas las plataformas que admiten MongoDB Enterprise también admiten TLS.

Modo de certificado de cliente ssl

string

Condicional

Indica si las conexiones a Ops Manager requieren un certificado TLS. Los valores son OPCIONAL y REQUERIDO.

ssl.CAFilePath

string

Condicional

Ruta absoluta del archivo al certificado utilizado para autenticarse a través de TLS en un host Linux o UNIX.

Ops Manager requiere ssl.CAFilePath o ssl.CAFilePathWindows si:

  • Está utilizando509 autenticación TLS o X. y

  • El archivo CA no está en los certificados raíz de su sistema operativo.

ssl.CAFilePathWindows

string

Condicional

Ruta de archivo absoluta al certificado utilizado para autenticarse mediante TLS en un host de Windows.

Ops Manager requiere ssl.CAFilePath o ssl.CAFilePathWindows si:

  • Está utilizando509 autenticación TLS o X. y

  • El archivo CA no está en los certificados raíz de su sistema operativo.

Ruta del archivo de clave ssl.autoPEM

string

Condicional

Ruta de archivo absoluta al archivo de clave privada del cliente (PEM) que autentica la conexión TLS en un host Linux o UNIX.

Ops Manager requiere ssl.autoPEMKeyFilePath o ssl.autoPEMKeyFilePathWindows si utiliza509 autenticación TLS o X..

ssl.autoPEMKeyFilePathWindows

string

Condicional

Ruta de archivo absoluta al archivo de clave privada del cliente (PEM) que autentica la conexión TLS en un host de Windows.

Ops Manager requiere ssl.autoPEMKeyFilePath o ssl.autoPEMKeyFilePathWindows si utiliza509 autenticación TLS o X..

ssl.autoPEMKeyFilePwd

string

Condicional

Contraseña del archivo de clave privada (PEM) especificada en ssl.autoPEMKeyFilePath o ssl.autoPEMKeyFilePathWindows. Ops Manager requiere esta contraseña si el archivo PEM está cifrado.

La matriz roles es opcional y describe 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

papeles

matriz 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].rol

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

conjunto 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].privilegios[k].acciones

string

Condicional

Acciones permitidas en el recurso.

Para obtener más información,consulte Acciones de privilegio.

roles[n].roles

conjunto de documentos

Condicional

Roles de los cuales este rol hereda privilegios.

roles[n].restriccionesdeautenticación

conjunto 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, quedará inutilizable. Por ejemplo, si un usuario hereda un rol cuyo clientSource campo es [198.51.100.0] y otro cuyo clientSource campo [203.0.113.0] es, el servidor no podrá autenticarlo. Para obtener más información sobre la autenticación en MongoDB, consulte Autenticación.

roles[n].restriccionesdeautenticación[k].fuentedelcliente

matriz de cadenas

Condicional

Si está presente, al autenticar a un usuario, el servidor MongoDB verifica que la dirección IP del cliente esté en la lista dada 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].restriccionesDeAutenticación[k].direcciónDelServidor

matriz de cadenas

Condicional

Matriz de direcciones IP separadas por comas a las que el cliente puede conectarse. Si está presente, el servidor MongoDB verifica que aceptó la conexión del cliente desde una dirección IP de la matriz dada. Si acepta una conexión desde una dirección IP desconocida, 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 utilizan los agentes para autenticarse a través de Kerberos.

kerberos.nombreDeServicio

string

Requerido

Etiqueta que establece:

La matriz indexConfigs es opcional y define índices que se crearán para conjuntos de réplicas específicos.

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

matriz de objetos

Opcional

Se crearán índices específicos para conjuntos de réplicas específicos.

indexConfigs.key

matriz de matrices

Requerido

Claves en el índice. Esta "matriz de matrices" contiene una sola matriz si el índice tiene una sola clave.

indexConfigs.rsName

string

Requerido

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

indexConfigs.nombre_base_datos

string

Requerido

Base de datos que indexa MongoDB.

indexConfigs.nombreColección

string

Requerido

Colección que indexa MongoDB.

indexConfigs.collation

Objeto

Opcional

Reglas específicas del idioma que se deben utilizar al ordenar y hacer coincidir cadenas si el índice usa intercalación.

Si incluye el objeto indexConfigs.collation, debe incluir el parámetro indexConfigs.collation.locale. 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

Configuración regional que define 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, configure este valor en simple.

indexConfigs.collation.caseLevel

booleano

Opcional

Bandera que indica cómo el índice utiliza la comparación de casos.

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

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

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

indexConfigs.collation.caseFirst

string

Opcional

Orden de clasificación de las diferencias de casos durante las comparaciones de nivel terciario.

El Manual del servidor MongoDB enumera los valores posibles en su sección Intercalación.

indexConfigs.collation.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 Intercalación.

indexConfigs.collation.numericOrdering

booleano

Opcional

Bandera que indica 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.collation.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.collation.maxVariable

string

Opcional

Caracteres que el índice puede ignorar. Este parámetro solo se aplica si indexConfigs.collation.alternate está configurado como desplazado.

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 establece este parámetro como verdadero,intercalación:

  • Comprueba 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.collation.hacia atrás

booleano

Opcional

Bandera que indica cómo debe el índice manejar las cadenas diacríticas.

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 índice que admite el controlador MongoDB Go.

Volver

Opciones avanzadas

En esta página