Configuração da automação

Nesta página

Visão geral

Versão de configuração
Baixe a Base
Especificações das versões do MongoDB
Automação
Monitoramento
Backup.
Instâncias do MongoDB
Em todo o cluster
Conjuntos de réplicas
Clusters fragmentados
balancer de cluster
Autenticação
LDAP
ssl
Roles do MongoDB
Kerberos
Indexes

Visão geral

A automação usa uma configuração de automação para determinar o estado desejado de uma implantação do MongoDB e efetuar as alterações conforme necessário. Se você modificar o sistema por meio da interface web do Ops Manager, nunca precisará manipular essa configuração.

Se você estiver usando a automação sem o Ops Manager, poderá construir e distribuir a configuração manualmente.

Os campos opcionais são marcados como tal.

Um campo que recebe um <number> como seu valor pode receber inteiros e números de ponto flutuante.

Observação

MongoDB Ops Manager não oferece suporte à configuração e gerenciamento do servidor MongoDB net.unixDomainSocket opções como net.unixDomainSocket.enabled, net.unixDomainSocket.pathPrefix e net.unixDomainSocket.filePermissions usando a configuração de automação do MongoDB Ops Manager .

A automação MongoDB Ops Manager não valida as seguintes configurações do MongoDB . Se você fornecer um valor incorreto, isso poderá resultar em problemas, tempo de inatividade ou ambos:

Versão de configuração

Isso lista a versão da configuração de automação.

"version" : "<integer>"

Nome	Tipo	necessidade	Descrição
Versão	inteiro	Obrigatório	Revisão deste arquivo de configuração de automação.

Baixe a Base

O Ops Manager baixa versões automáticas e executa scripts iniciais no diretório definido em options.downloadBase.

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

Nome	Tipo	necessidade	Descrição
opções	objeto	Obrigatório	Caminho para downloads automáticos de novas versões.
options.downloadBase	string	Obrigatório	Diretório em plataformas Linux e UNIX para downloads automáticos de versões e scripts de inicialização.

Especificações das versões do MongoDB

A matriz mongoDbVersions[n] define objetos de especificação para as instâncias do MongoDB encontradas na matriz processes . Cada instância do MongoDB na array processes deve ter um objeto de especificação nesta array.

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 ]

Nome	Tipo	necessidade	Descrição
mongoDbVersions[n]	Array de objetos	Obrigatório	Objeto de especificação para as instâncias do MongoDB encontradas na matriz de processos . Cada instância do MongoDB em processos deve ter um objeto de especificação em mongoDbVersions[n].
mongoDbVersions[n].name	string	Obrigatório	Nome do objeto de especificação. O objeto de especificação é anexado a uma instância MongoDB por meio do parâmetro concerns.version da instância nesta configuração.
mongoDbVersions[n].builds[k]	Array de objetos	Obrigatório	Compilações disponíveis para esta instância do MongoDB.
mongoDbVersions[n].builds[k].platform	string	Obrigatório	Plataforma para esta instância do MongoDB.
mongoDbVersions[n].builds[k].URL	string	Obrigatório	URL a partir da qual baixar o MongoDB para esta instância.
mongoDbVersions[n].builds[k].gitVersion	string	Obrigatório	Identificador de confirmação que identifica o estado do código usado para construir o processo MongoDB. O comando buildInfo do MongoDB retorna o identificador gitVersion.
mongoDbVersions[n].builds[k].modules	array	Obrigatório	Lista de módulos para esta versão. Corresponde ao parâmetro de módulos que o comando buildInfo retorna.
mongoDbVersions[n].builds[k].arquitetura	string	Obrigatório	Arquitetura do processador. O Ops Manager aceita AMD64 ou ppc64le .
mongoDbVersions[n].builds[k].bits	inteiro	Obsoleto(a)	Largura do barramento do processador. Não remova nem faça modificações neste parâmetro.
mongoDbVersions[n].builds[k].win2008mais	Boolean	Opcional	Defina como verdadeiro se esta for uma compilação do Windows que requer Windows 7 posterior ou Windows servidor 2008 R2 ou posterior.
mongoDbVersions[n].builds[k].winVCRedistUrl	string	Opcional	URL a partir da qual a versão necessária do Microsoft Visual C++ redistribuível pode ser baixada.
mongoDbVersions[n].builds[k].winVCRedistOptions	array de strings	Opcional	Valores de string que listam as opções de linha de comando a serem especificadas ao executar o instalador redistribuível do Microsoft Visual C++. Cada opção de linha de comando é uma string separada na array.
mongoDbVersions[n].builds[k].winVCRedistDll	string	Opcional	Nome do arquivoDLL de tempo de execução do Microsoft Visual C++ que o agente verifica para determinar se uma nova versão do redistribuível do Microsoft Visual C++ é necessária.
mongoDbVersions[n].builds[k].winVCRedistVersion	string	Opcional	Versão mínima daDLL de tempo de execução do Microsoft Visual C++ que deve estar presente para ignorar a instalação do redistribuível do Microsoft Visual C++.

Automação

agentVersion especifica a versão do MongoDB Agent.

Observação

Embora seja possível atualizar a versão do MongoDB Agent por meio dessa propriedade de configuração, você deve usar o endpoint Atualizar versões do agente para garantir que suas versões estejam atualizadas.

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

Nome	Tipo	necessidade	Descrição
AgentVersion	objeto	Opcional	Versão do MongoDB Agent a ser executada. Se a versão em execução não corresponder a essa configuração, o MongoDB Agent baixará a versão especificada, se desligará e iniciará a nova versão.
AgentVersion.name	string	Opcional	Versão desejada do MongoDB Agent.
AgentVersion.directoryUrl	string	Opcional	URL a partir da qual baixar o MongoDB Agent.

Monitoramento

A matriz MonitoringVersions especifica a versão do agente de monitoramento. O Ops Manager tornou este parâmetro obsoleto. Para atualizar as configurações do registro de monitoramento, use o endpoint Atualizar Configurações de Monitoramento .

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 ]

Nome	Tipo	necessidade	Descrição
MonitoringVersões	Array de objetos	Opcional	objeto que definem informações de versão para cada agente de monitoramento.
MonitoringVersions.name	string	Obrigatório	Versão do agente de monitoramento. Para saber mais, consulte a array de compatibilidade do MongoDB . IMPORTANTE: Esta propriedade é somente leitura. As modificações feitas nessa propriedade não são refletidas ao atualizar o agente de monitoramento por meio da API. Para atualizar a versão do agente de monitoramento , consulte este endpoint.
MonitoringVersions.hostname	string	Obrigatório	FQDN do host que executa o agente de monitoramento. Se o agente de monitoramento não estiver em execução no host, o Ops Manager instalará o agente a partir do local especificado em MonitoringVersions.urls.
MonitoringVersions.urls	objeto	Obrigatório	URLs específicas da plataforma e da compilação para baixar o agente de monitoramento.
MonitoringVersions.urls<platform>	objeto	Obrigatório	Etiqueta que identifica um sistema operacional e sua versão. O campo contém um objeto com pares de valor-chave, onde cada chave é o nome de uma compilação ou padrão e cada valor é uma URL para baixar o agente de monitoramento. O objeto deve incluir o conjunto de chaves padrão para a URL de download padrão da plataforma.
MonitoringVersions.baseUrl	string	Obrigatório	URL base usada para a configuração mmsbaseurl .
MonitoringVersions.logPath	string	Opcional	Diretório onde o agente armazena seus registros. O padrão é armazenar registros em /dev/null.
MonitoringVersions.logRotate	objeto	Opcional	Habilita a rotação de registro para os registros MongoDB para um processo.
MonitoringVersions.logRotate.sizeThresholdMB	número	Obrigatório	Tamanho máximo em MB para um arquivo de log individual antes da rotação.
MonitoringVersions.logRotate.timeThresholdHrs	inteiro	Obrigatório	Tempo máximo em horas para um arquivo de log individual antes da rotação.
MonitoringVersions.logRotate.numUncompressed	inteiro	Opcional	Número máximo de arquivos de log totais para deixar descompactados, incluindo o arquivo de log atual. O padrão é 5. Em versões anteriores do Ops Manager, esse campo era chamado de maxUncompressed. O nome anterior ainda é reconhecido, embora a nova versão seja preferida.
MonitoringVersions.logRotate.percentOfDiskspace	número	Opcional	Porcentagem máxima de espaço total em disco que todos os arquivos de log devem ocupar antes da exclusão. O padrão é .02 .
MonitoringVersions.logRotate.numTotal	inteiro	Opcional	Número total de arquivos de log. Se um número não for especificado, o número total de arquivos de log terá como padrão 0 e será determinado por outras configurações MonitoringVersions.logRotate .

Backup.

A matriz backupVersions especifica a versão do agente de backup. O Ops Manager tornou este parâmetro obsoleto. Para atualizar as configurações do log de backup, use o endpoint Atualizar Configurações 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 ]

Nome	Tipo	necessidade	Descrição
backupVersions[n]	Array de objetos	Opcional	objeto que definem informações de versão para cada agente de backup.
backupVersions[n].name	string	Obrigatório	Versão do agente de backup. Para saber mais, consulte a array de compatibilidade do MongoDB . IMPORTANTE: Esta propriedade é somente leitura. Quaisquer modificações feitas nesta propriedade não são refletidas ao atualizar o agente de backup por meio da API. Para atualizar a versão do agente de backup , consulte este endpoint.
backupVersions[n].hostname	string	Obrigatório	FQDN do host que executa o agente de backup. Se o agente de backup não estiver em execução no host, o Ops Manager instalará o agente a partir do local especificado em backupVersions[n].urls.
backupVersions[n].urls	objeto	Obrigatório	URLsespecíficas da plataforma e da compilação para baixar o agente de backup.
backupVersions[n].urls.<platform>	objeto	Obrigatório	Etiqueta que identifica um sistema operacional e sua versão. O campo contém um objeto com pares de chave-valor, onde cada chave é o nome de uma compilação ou padrão e cada valor é uma URL para baixar o agente de backup. O objeto deve incluir o conjunto de chaves padrão para a URL de download padrão da plataforma.
backupVersions[n].baseUrl	string	Obrigatório	URL base usada para as configurações da nave - matriz e https nas configurações personalizadas. Por exemplo, para "baseUrl"=https://cloud.mongodb.com, os campo de configuração de backup teriam estes valores: mothership=API-backup.MongoDB.com e https"=true.
backupVersions[n].logPath	string	Opcional	Diretório onde o agente armazena seus registros. O padrão é armazenar registros em /dev/null.
backupVersions[n].logRotate	objeto	Opcional	Habilita a rotação de registro para os registros MongoDB para um processo.
backupVersions[n].logRotate.sizeThresholdMB	número	Obrigatório	Tamanho máximo em MB para um arquivo de log individual antes da rotação.
backupVersions[n].logRotate.timeThresholdHrs	inteiro	Obrigatório	Tempo máximo em horas para um arquivo de log individual antes da rotação.
backupVersions[n].logRotate.numUncompressed	inteiro	Opcional	Número máximo de arquivos de log totais para deixar descompactados, incluindo o arquivo de log atual. O padrão é 5.
backupVersions[n].logRotate.percentOfDiskspace	número	Opcional	Porcentagem máxima de espaço total em disco que todos os arquivos de log devem ocupar antes da exclusão. O padrão é .02 .
backupVersions[n].logRotate.numTotal	inteiro	Opcional	Se um número não for especificado, o número total de arquivos de log terá como padrão 0 e será determinado por outras configurações do backupVersion.logRotate .

Instâncias do MongoDB

A matriz de processos determina a configuração de suas instâncias MongoDB. Usando esta matriz, você pode:

Restaurar uma instância.
Inicie um processo de initial sync em uma ou mais instâncias do MongoDB.

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

Nome	Tipo	necessidade	Descrição
processes	array	Obrigatório	Contém objetos que definem as instâncias `mongos` e `mongod` que o MongoDB Ops Manager monitora. Cada objeto define uma instância diferente.
process[n].args2_6	objeto	Obrigatório	Objeto de configuração do MongoDB para as versões 2.6 e posterior do MongoDB. O objeto `processes.args2_6` aceita a maioria das configurações e parâmetros do MongoDB para as versões 2.6 e posterior do MongoDB. Para saber mais, consulte Configurações do MongoDB e suporte de automação.
process[n].alias	string	Opcional	Nome de host alias (geralmente um CNAME DNS ) para o host no qual o processo é executado. Se um alias for especificado, o MongoDB Agent preferirá esse alias ao nome do host especificado em processos.hostname ao se conectar ao host. Você também pode especificar este alias em replicaSets.host e sharding.configServer .
processos[n].authSchemaVersion	inteiro	Obrigatório	Versão do esquema das credenciais de usuário para trigger de banco de dados MongoDB. Isso deve corresponder a todos os outros elementos da array de processos que pertencem ao mesmo cluster. O Ops Manager aceita 3 e 5 para este parâmetro. Os clusters MongoDB 3.x e 4.x são padronizados como 5. Os clusters MongoDB 2.6 são padronizados como . Para saber mais, consulte Atualizar para SCRAM-SHA-1 nas notas de versão do MongoDB 3.0 .
processos[n].backupRestoreUrl	string	Opcional	URL de entrega para a restauração. O Ops Manager define isso ao criar uma restauração. Para cancelar uma operação de restauração em andamento, defina esta opção como `CANCEL`. Para saber mais, consulte Automatizar restauração de backup por meio da API.
processos[n].cluster	string	Condicional	Nome do cluster fragmentado. Defina esse valor para o mesmo valor no parâmetro sharding.name na array de sharding para o `mongos`. Necessário para um `mongos`. Não necessário para um `mongod`.
defaultRWConcern.defaultReadConcern.level	string	Opcional	Propriedades de consistência e isolamento definidas para os dados lidos de conjuntos de réplicas e fragmentos de conjuntos de réplicas. O MongoDB Atlas aceita os seguintes valores: "available" "local" "majority"
defaultRWConcern.defaultWriteConcern.j	booleano	Opcional	Sinalizador que indica se a confirmação de gravação deve ser gravada no diário em disco.
defaultRWConcern.defaultWriteConcern.w	string	Opcional	Número desejado de instâncias mongod que devem reconhecer uma operação de gravação em um conjunto de réplicas e fragmentos de conjunto de réplicas. O MongoDB Atlas aceita os seguintes valores: Qualquer número 0 ou superior "majority"
defaultRWConcern.defaultWriteConcern.wtimeout	número	Opcional	Tempo-limite desejado para o write concern expressado em milissegundos. Defina esse valor ao definir defaultRWConcern.defaultWriteConcern.w para um valor maior que 1.
processos[n].desabilitado	Boolean	Opcional	Sinalizador que indica se este processo deve ser encerrado. Defina como verdadeiro para encerrar o processo.
processos[n].featureCompatibilityVersion	string	Obrigatório	Versão do MongoDB com a qual este processo tem compatibilidade de funcionalidades. Alterar esse valor pode habilitar ou desabilitar determinadas funcionalidades que persistem dados incompatíveis com versões do MongoDB anteriores ou posteriores à featureCompatibilityVersion que você escolher. O MongoDB Ops Manager aceita 5.0, 6.0 e 7.0 como valores de parâmetro. Se você tiver uma implantação existente, o MongoDB Ops Manager só aceitará um featureCompatibilityVersion igual ou uma versão mais antiga que a versão do MongoDB que você implantou. Para saber quais desses valores de parâmetro são suportados para cada versão do MongoDB e quais recursos cada um desses valores habilita ou desabilita, consulte setFeatureCompatibilityVersion no Manual do MongoDB. O Ops Manager define este parâmetro para corresponder à versão MongoDB para novas implantações. O Ops Manager não incrementa automaticamente esse parâmetro quando você atualiza um host de uma versão do MongoDB para outra. Para saber mais, consulte setFeatureCompatibilityVersion.
processos[n].hostname	string	Obrigatório	Nome do host que atende a este processo. O padrão é localhost .
processos[n].lastCompact	string	Opcional	Carimbo de data/hora em ISO 8601 formato de data e hora em UTC quando MongoDB Ops Manager o recuperou espaço livre pela última vez nos discos de um cluster. Durante determinadas operações, o MongoDB pode mover ou excluir dados, mas não libera o espaço atualmente não utilizado. O MongoDB Ops Manager recupera o espaço em disco de forma contínua entre os membros do conjunto de réplicas ou fragmentos. Para recuperar este espaço: Imediatamente, defina este valor para o tempo atual como um ISO 8601 carimbo de data/hora. Posteriormente, defina esse valor para um futuro ISO 8601 carimbo de data/hora. O MongoDB Ops Manager recupera o espaço depois que o tempo atual ultrapassa o carimbo de data/hora fornecido. Para remover qualquer ambiguidade sobre quando você pretende recuperar o espaço nos discos do cluster, especifique um fuso horário com seu ISO 8601 carimbo de data/hora. Por exemplo, para definir processos.lastCompact para 28 janeiro 2021 às 2:43:52 PM US Central Standard Time, use `"processes.lastCompact" : "2021-01-28T14:43:52-06:00"`
processos[n].lastRestart	string	Opcional	Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando MongoDB Ops Manager o reiniciou esse processo pela última vez. Se você definir esse parâmetro como o carimbo de data/hora atual, o MongoDB Ops Manager forçará a reinicialização desse processo depois que você carregar essa configuração. Se você definir esse parâmetro para vários processos no mesmo cluster, o MongoDB Ops Manager reiniciará os processos selecionados de forma contínua entre os membros do conjunto de réplicas ou fragmentos.
processos[n].lastResync	string	Opcional	Carimbo de data/hora na ISO 8601 formato de data e hora em UTC do último processo de initial sync que MongoDB Ops Manager o executou no nó. Para trigger o processo de sincronização de inicialização no nó imediatamente, defina esse valor como o tempo atual como um ISO 8601 carimbo de data/hora. AVISO: use este parâmetro com cuidado. Durante a sincronização inicial, a automação remove todo o conteúdo do diretório `dbPath` do nó. Se você definir este parâmetro: No nó secundário, o MongoDB Agent verifica se o carimbo de data/hora especificado é posterior à hora da última ressincronização e, se confirmado, inicia a sincronização de inicialização nesse nó. Por exemplo, para definir `processes.lastResync` no nó secundário como de 28 maio 2021 às 2:43:52 horário central dos EUA, use: `"processes.lastResync" : "2021-05-28T14:43:52-06:00"` Se o MongoDB Agent confirmar que esse carimbo de data/hora é posterior à hora registrada da última ressincronização, ele iniciará a sincronização de inicialização no nó. No nó primary, o MongoDB Agent aguarda até que você solicite ao nó primary para se tornar o secundário com o método `rs.stepDown()` e, em seguida, inicia a sincronização de inicialização nesse nó. Em todos os nós no mesmo cluster, incluindo o primário, o MongoDB Agent verifica se o registro de data/hora especificado é posterior à hora da última ressincronização e, se confirmado, inicia a sincronização de inicialização nos nós secundários de forma contínua. O MongoDB Agent espera até que você solicite ao nó primário para se tornar o secundário com o método `rs.stepDown()` e, em seguida, inicia a sincronização de inicialização nesse nó. Para saber mais, consulte Sincronização inicial.
processos[n].lastKmipMasterKeyRotation	string	Opcional	Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando MongoDB Ops Manager o gira pela última vez a chave mestre KMIP . Se você definir esse parâmetro como o registro de data e hora atual, o MongoDB Ops Manager girará a chave depois que você carregar essa configuração.
processos[n].logRotate	objeto	Opcional	Objeto de configuração do MongoDB para girar os registros do MongoDB de um processo.
processos[n].logRotate. numTotal	inteiro	Opcional	Número total de arquivos de log que o Ops Manager mantém. Se você não definir esse valor, o número total de arquivos de log será padronizado como 0 . O Ops Manager baseia a rotação em seus outros processos.logRotate configurações.
processos[n].logRotate. numUncompressed	inteiro	Opcional	Número máximo de arquivos de log totais para deixar descompactados, incluindo o arquivo de log atual. O padrão é 5.
processos[n].logRotate. percentOfDiskspace	número	Opcional	Porcentagem máxima de espaço total em disco que o Ops Manager pode usar para armazenar os arquivos de log expressos como decimal. Se esse limite for excedido, o Ops Manager excluirá os arquivos de log compactados até atingir esse limite. O Ops Manager exclui primeiro os arquivos de log mais antigos. O padrão é 0,02.
processos[n].logRotate. limite de tamanho MB	número	Obrigatório	Tamanho máximo em MB para um arquivo de log individual antes que o Ops Manager o gire. O Ops Manager gira o arquivo de log imediatamente se ele atender ao valor fornecido neste sizeThresholdMB ou nos processos.logRotate.timeThresholdHrs limite.
processos[n].logRotate. TimeThresholdHrs	inteiro	Obrigatório	Duração máxima em horas para um arquivo de log individual antes da próxima rotação. O tempo é desde a última rotação. O Ops Manager gira o arquivo de log quando o arquivo atende a este timeThresholdHrs ou aos processos.logRotate.sizeThresholdMB limite.
processos[n].manualMode	Boolean	Opcional	Sinalizador que indica se o MongoDB Agent automatiza esse processo. Este padrão é falso. Defina como verdadeiro para desabilitar a automação nesse processo. O MongoDB Agent não realiza mais ação neste processo. Defina como falso para habilitar a automação nesse processo. O MongoDB Agent automatiza ação nesse processo.
process[n].name	string	Obrigatório	Nome único para identificar a instância.
processos[n].numCores	inteiro	Opcional	Número de núcleos que o Ops Manager deve vincular a esse processo. O MongoDB Agent distribui os processos entre os núcleos da forma mais uniforme possível.
processos[n].processType	string	Obrigatório	Tipo de processo MongoDB que está sendo executado. MongoDB Ops Manager aceita `mongod` ou `mongos` para este parâmetro.
processos[n].versão	string	Obrigatório	Nome da especificação mongoDbVersions usada com esta instância.

Em todo o cluster

clusterWideConfigurations especifica os parâmetros a serem definidos em um conjunto de réplicas ou cluster fragmentado sem exigir uma reinicialização contínua.

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

Nome	Tipo	necessidade	Descrição
replicaSetID/clusterName	objeto	Opcional	As opções de change stream a serem aplicadas ao conjunto de réplicas ou cluster fragmentado. O MongoDB Agent só verifica se essa configuração está em um formato JSON válido, mas não verifica a exatidão dos valores.
changeStreamOptions.preAndPostImages.expireAfterSeconds	número	Obrigatório	Política de retenção de pré e pós-imagens do change stream em segundos. Se você omitir o valor, o cluster reterá as imagens anteriores e posteriores até remover o evento de change stream correspondentes do oplog. Se você remover esse valor, o MongoDB Agent removerá esse parâmetro apenas de sua configuração de automação, mas não do servidor. Para saber mais, consulte changeStreamOptions.

Conjuntos de réplicas

A matriz replicaSets define a configuração de cada conjunto de réplicas. Este campo é obrigatório para implantações com 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 ]

Nome	Tipo	necessidade	Descrição
Conjuntos de réplicas	array	Opcional	Configuração de cada conjunto de réplicas. O MongoDB Agent usa os valores nessa array para criar documentos de configuração de conjunto de réplicas válidos . O agente verifica regularmente se os conjuntos de réplica estão configurados corretamente. Se ocorrer um problema, o agente reconfigura o conjunto de réplicas de acordo com seu documento de configuração. A array pode conter os seguintes campos de nível superior de um documento de configuração de conjunto de réplicas: _id; versão; e membros. Para saber mais, consulte replSetGetConfig.
replicaSets[n].ID	string	Obrigatório	O nome do conjunto de réplicas.
replicaSets[n].protocolVersion	string	Opcional	Versão do protocolo do conjunto de réplicas.
replicaSets[n].members	array	Opcional	objeto que definem cada membro do conjunto de réplicas. O campo membros.host deve especificar o nome do host conforme listado emprocess.name. O MongoDB Agent expande o campo do host para criar uma configuração de conjunto de réplicas válida. Para saber mais, consulte replSetGetConfig.
replicaSets[n].members[m].ID	inteiro	Opcional	Qualquer número inteiro positivo que indique o nó do conjunto de réplicas.
replicaSets[n].members[m].host	string	Opcional	Nome do host e número da porta, quando aplicável, que atende a esse membro do conjunto de réplicas.
replicaSets[n].members[m].arbiterOnly	booleano	Opcional	Sinalizador que indica se este membro do conjunto de réplicas atua como árbitro.
replicaSets[n].members[m].buildIndexes	booleano	Opcional	Sinalizador que indica se o processo `mongod` cria índices nesse membro do conjunto de réplicas.
replicaSets[n].members[m].hidden	booleano	Opcional	Sinalizador que indica se o conjunto de réplicas permite que este nó aceite operações de leitura.
replicaSets[n].members[m].prioridade	número	Opcional	Elegibilidade relativa para o Ops Manager selecionar este membro do conjunto de réplicas como primary. Um número maior aumenta a elegibilidade. Esse valor pode estar entre 0 e 1000, inclusive para nós que contêm dados. Os árbitros podem ter valores de 0 ou 1.
replicaSets[n].members[m].tags	objeto	Opcional	Lista de rótulos definidos pelo usuário e seus valores aplicados a este membro do conjunto de réplicas.
replicaSets[n].members[m].secondaryDelaySecs	inteiro	Opcional	Quantidade de tempo em segundos que esse membro do conjunto de réplicas deve ficar atrás do primary.
replicaSets[n].members[m].votes	número	Opcional	Quantidade de votos que este membro do conjunto de réplicas pode lançar para uma eleição de conjunto de réplicas. Todos os nós portadores de dados podem ter 0 ou 1 voto. Os árbitros sempre têm 1 voto.
replicaSets[n].force	objeto	Opcional	Instruções para o MongoDB Agent para forçar um conjunto de réplicas a usar a versão de configuração especificada em replicaSets.force.CurentVersion. Com esse objeto, o MongoDB Agent pode forçar um conjunto de réplicas a aceitar uma nova configuração para se recuperar de um estado no qual uma minoria de seus membros está disponível.
replicaSets[n].force.currentVersion	inteiro	Opcional	Versão de configuração que o MongoDB Agent força o conjunto de réplicas a usar. Defina como -1 para forçar um conjunto de réplicas a aceitar uma nova configuração. AVISO: forçar a reconfiguração de um conjunto de réplicas pode levar a uma reversão das gravações comprometidas pela maioria. Prossiga com cuidado. Entre em contato com o suporte do MongoDB se tiver dúvidas sobre os possíveis impactos dessa operação.

Clusters fragmentados

A array de fragmentação define a configuração de cada cluster fragmentado. Este parâmetro é necessário para implantações com clusters fragmentados.

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 ]

Nome	Tipo	necessidade	Descrição
Fragmentação	Array de objetos	Opcional	Objetos que definem a configuração de cada cluster fragmentado. Cada objeto na array contém as especificações de um cluster. O MongoDB Agent verifica regularmente o estado de cada cluster em relação às especificações. Se a especificação e o cluster não corresponderem, o agente alterará a configuração do cluster, o que pode fazer com que o balancer migre blocos.
sharding.managedSharding	booleano	Opcional	Sinalizador que indica se o MongoDB Ops Manager Automation gerencia todas as coleções e tags fragmentadas no sistema. A partir da versão 7.0 do MongoDB Ops Manager, isso pode ser definido somente como `false`.
sharding.name	string	Condicional	Nome do cluster. Isso deve corresponder ao valor em processos.cluster para um `mongos`.
sharding.configServerReplica	string	Condicional	Nome do conjunto de réplicas do servidor de configuração. Você pode adicionar esse parâmetro de array se o servidor de configuração for executado como um conjunto de réplicas. Se você executar servidores de configuração espelhados legados que não são executados como um conjunto de réplicas, use sharding.configServer .
sharding.configServer	array de strings	Condicional	Nomes dos hosts do servidor de configuração. Os nomes de host correspondem aos nomes usados no parâmetroprocess.name de cada host . IMPORTANTE: o MongoDB 3.4 remove o suporte para servidores de configuração espelhados. Se o cluster fragmentado executar o MongoDB 3.4 ou posterior, use sharding.configServerReplica.
sharding.shards	Array de objetos	Condicional	Fragmentos do cluster .
sharding.shards.ID	string	Condicional	Nome do fragmento.
sharding.shards.rs	string	Condicional	Nome do conjunto de réplicas do shard. Isso é especificado no replicaSets.ID Parâmetro.
sharding.shards.tags	array de strings	Condicional	zona atribuídas a este fragmento. Você pode adicionar esse parâmetro de array se usar fragmentação por zonas.

balancer de cluster

O objeto do balanceador é opcional e define as configurações do balanceador para cada cluster.

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

Nome	Tipo	necessidade	Descrição
balancer	objeto	Opcional	Parâmetros nomeados de acordo com clusters, cada parâmetro contendo um objeto com as configurações de balanceador desejadas para o cluster. O objeto usa os parâmetros parados e ActiveWindow , conforme descrito no procedimento para agendar a janela de balanceamento neste tutorial no manual do MongoDB.

Autenticação

Para habilitar a autenticação, configure o objeto auth . Este objeto é opcional e define as configurações relacionadas à autenticação .

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 }

Nome

Tipo

necessidade

Descrição

auth

objeto

Opcional

Define as configurações relacionadas à autenticação .

Se você omitir este parâmetro, pule o restante desta seção.

auth.autoritativeSet

booleano

Condicional

Define se o Ops Manager impõe ou não um conjunto consistente de usuários e roles managed do MongoDB em todos os sistemas managed no projeto.

Se "auth.autoitativeSet" : true, o Ops Manager imporá usuários e roles consistentes.
Se "auth.autoitativeSet" : false, o Ops Manager não impõe usuários e roles consistentes.

auth.autoritativeSet padroniza para false .

Obrigatório se você habilitar a autenticação.

auth.autoUser

string

Condicional

Nome de usuário que a automação usa ao se conectar a uma instância.

Obrigatório se você habilitar a autenticação.

auth.autoPwd

string

Condicional

Senha que a automação usa ao se conectar a uma instância.

Obrigatório se você habilitar a autenticação.

auth.disabled

booleano

Opcional

Sinalizador que indica se a autenticação está desativada. Se não for especificado, o padrão desabilitado será falso.

auth.deploymentAuthMechanisms

array de strings

Condicional

Lista os mecanismos de autenticação suportados para os processos no sistema.

Obrigatório se você habilitar a autenticação.

Especificar:

Valor	Mecanismo de autenticação
MONGODB-CR	SCRAM-SHA-1
SCRAM-SHA-256	SCRAM-SHA-256
MONGODB-X509	Certificado de cliente x.509
PLAIN	LDAP
GSSAPI	Kerberos

auth.autoAuthMechanisms

array de strings

Condicional

Define o mecanismo de autenticação usado pela automação. Se não for especificado, o padrão desabilitado será falso.

Obrigatório se você habilitar a autenticação.

Este parâmetro contém mais de um elemento somente quando é configurado para SCRAM-SHA-1 e SCRAM-SHA-256.

Especificar:

Valor	Mecanismo de autenticação
MONGODB-CR	SCRAM-SHA-1
SCRAM-SHA-256	SCRAM-SHA-256
MONGODB-X509	Certificado de cliente x.509
PLAIN	LDAP
GSSAPI	Kerberos

auth.key

string

Condicional

Conteúdo do arquivo de chave que o Ops Manager usa para autenticar nos processos do MongoDB.

Obrigatório se você habilitar a autenticação e "auth.disabled" : false.

Se você alterar o valor de auth.key , deverá alterar o valor de auth.keyfile .

auth.keyfile

string

Condicional

Caminho e nome do arquivo de chave que o Ops Manager usa para autenticar nos processos do MongoDB.

Obrigatório se você habilitar a autenticação e "auth.disabled" : false.

Se você alterar o valor do auth.keyfile , deverá alterar o valor do auth.key .

auth

.newAutoPwd

string

Opcional

Nova senha que a automação usa ao se conectar a uma instância. Para rotacionar senhas sem perder a conexão:

Defina auth.newAutoPwd e deixe auth.autoPwd com sua senha atual.
Aguarde o estado do objetivo.
auth.newAutoPwd copia a senha auth.autoPwd automaticamente.

Você pode definir essa opção somente ao incluir SCRAM-SHA-1 ou SCRAM-SHA-256 como um dos mecanismos de autenticação para a automação em auth.autoAuthMechanisms.

auth.newKey

string

Opcional

Conteúdo de um novo arquivo de chave que você deseja que o Ops Manager use para autenticar nos processos do MongoDB.

Ao definir essa opção, o Ops Manager gira a chave que o aplicativo usa para autenticar nos processos do MongoDB em seu sistema. Quando todos os agente MongoDB usarem a nova chave, o Ops Manager substituirá o valor de auth.key pela nova chave que você forneceu em auth.newKey e removerá auth.newKey da configuração de automação.

auth.usersDeleted

Array de objetos

Opcional

Objeto que definem os usuários autenticados a serem excluídos do reconhecimento de data center especificados ou de todos os reconhecimento de data center. Essa matriz deve conter auth.usersDeleted.user e auth.usersDeleted.dbs.

auth.usersDeleted[n].user

string

Opcional

Nome de usuário que o Ops Manager deve excluir.

auth.usersDeleted[n].dbs

array de strings

Opcional

Liste os nomes do reconhecimento de data center dos quais o Ops Manager deve excluir o usuário autenticado.

auth.usersWanted

Array de objetos

Opcional

Contém objeto que definem usuários autenticados para adicionar ao reconhecimento de data center especificados. Cada objeto deve ter o auth.usersWanted[n].db, auth.usersWanted[n].user, e auth.usersWanted[n].roles parâmetros e, em seguida, tem exatamente um dos seguintes parâmetros: auth.usersWanted[n].pwd, auth.usersWanted[n].initPwd, ou auth.usersWanted[n].userSource.

auth.usersWanted[n].db

string

Condicional

Banco de dados ao qual adicionar o usuário.

auth.usersWanted[n].user

string

Condicional

Nome do usuário que o Ops Manager deve adicionar.

auth.usersWanted[n].roles

array

Condicional

Lista das funções a serem atribuídas ao usuário a partir do banco de dados do usuário, especificado em auth.usersWanted[n].db.

auth.usersWanted[n].pwd

string

Condicional

Hash SCRAM-SHA-1 hexadecimal de 32 caracteres da senha atualmente atribuída ao usuário.

O Ops Manager não usa este parâmetro para definir ou alterar uma senha.

Necessário se:

Você habilita a autenticação
"auth.deploymentAuthMechanisms" : "MONGODB-CR"
"auth.usersWanted[n].initPwd" não está definido

auth.usersWanted[n].initPwd

string

Condicional

Senha do texto não criptografado que você deseja atribuir ao usuário.

Necessário se:

Você habilita a autenticação
"auth.deploymentAuthMechanisms" : "MONGODB-CR"
"auth.usersWanted[n].initPwd" não está definido

auth.usersWanted[n].userSource

string

Obsoleto(a)

Não é mais compatível.

auth.usersWanted[n]. otherDBRoles

objeto

Opcional

Se você atribuir o reconhecimento de data center do usuário "auth.usersWanted[n].db" : "admin", poderá usar esse objeto para atribuir as roles do usuário de outros reconhecimento de data center também. O objeto contém pares chave-valor onde a chave é o nome do reconhecimento de data center e o valor é uma array de valores de string que listam as funções a serem atribuídas a partir desse reconhecimento de data center.

auth.usersWanted[n].authenticationRestrictions

matriz de documentos

Opcional

Restrições de autenticação que o host impõe ao usuário.

AVISO: se um usuário herdar múltiplas funções com restrições de autenticação incompatíveis, esse usuário se tornará inutilizável. Por exemplo, se um usuário herdar uma função na qual o campo clientSource é [198.51.100.0] e outra role na qual o campo clientSource é [203.0.113.0], o servidor não poderá autenticar o usuário. Para obter mais informações sobre autenticação no MongoDB, consulte Autenticação.

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

array de strings

Condicional

Se presente ao autenticar um usuário, o host verifica se a lista fornecida contém o intervalo CIDR do endereço IP do cliente. Se o endereço IP do cliente não estiver presente, o host não autenticará o usuário.

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

array de strings

Condicional

Array separada por vírgulas de endereços IP aos quais o cliente pode se conectar. Se estiver presente, o host verifica se o Ops Manager aceitou a conexão do cliente de um endereço IP na array fornecida. Se a conexão foi aceita a partir de um endereço IP não reconhecido, o host não autenticará o usuário.

LDAP

O objeto ldap habilita a autorização LDAP . Este objeto é opcional. Para saber mais, consulte Habilitar autenticação LDAP para seu projeto do 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>"
             }
   ]
}

Nome	Tipo	necessidade	Descrição
ldap	objeto	Opcional	Objeto que contém as configurações para habilitar e configurar a autorização LDAP .
ldap.servers	string	Condicional	String separada por vírgula que contém um ou mais servidor LDAP no formato `<host>:<port>` para executar query. Você pode usar `setParameter` para definir essa configuração em um sistema em execução. Para autorização LDAP , você deve especificar esta configuração.
ldap.timeoutMS	long	Opcional	Quantidade de tempo, em milissegundos, que o MongoDB espera que um servidor LDAP responda a uma solicitação antes de atingir o tempo limite. Você pode usar `setParameter` para definir essa configuração em um sistema em execução. Por padrão, o MongoDB expira após dez segundos.
ldap.bindMethod	string	Opcional	String legível por humanos que indica se a autenticação simples deve ser usada ou um protocolo SASL para se autenticar. Você pode especificar `simple` ou `sasl`. Por padrão, o MongoDB usa autenticação simples.
ldap.bindSaslMechanisms	string	Opcional	String que contém uma lista separada por vírgulas de mecanismos SASL para o MongoDB tentar a autenticação no servidor LDAP durante a ligação. Por padrão, o MongoDB usa `DIGEST-MD5` para vincular.
ldap.bindQueryUser	string	Condicional	Nome de domínio da entidade LDAP que o MongoDB vincula como quando se conecta a um servidor LDAP . Você pode usar `setParameter` para definir essa configuração em um sistema em execução. Para que o MongoDB se vincule com credenciais de autenticação, você deve especificar esta configuração.
ldap.bindQueryPassword	string	Condicional	Senha com a qual o MongoDB se liga quando se conecta a um servidor LDAP . Você pode usar `setParameter` para definir essa configuração em um sistema em execução. Para que o MongoDB se vincule a uma senha, você deve especificar essa configuração.
ldap.userCacheInvalidationPeriod	inteiro	Opcional	Intervalo que o MongoDB espera entre as descargas de cache do usuário. Quando o cache do usuário externo é liberado, a próxima operação que um usuário autorizado pelo LDAP faz exige uma reaquisição de roles. Se você especificar um valor alto, poderá diminuir a carga nos servidores LDAP e aumentar o tempo necessário para sincronizar as funções do MongoDB com a associação ao grupo LDAP . Por padrão, o MongoDB espera 30 segundos entre as descargas de cache.
ldap.authzQueryTemplate	string	Condicional	RFC URL 4516 formatada da consulta LDAP a ser executada para obter grupos LDAP relativos à `ldap.server` configuração . Nessa URL, a string de token do espaço reservado `{USER}` é substituída pelo nome de domínio do usuário adquirido. Você pode utilizar o `setParameter` para definir esta configuração em um sistema em execução. Para autorização LDAP , você deve especificar esta configuração.
ldap.userToDNMapping	array	Opcional	Uma array formatada em JSON que contém as transformações ordenadas que o MongoDB aplica para autenticar os nomes de usuário do MongoDB para que correspondam aos seus nomes de domínio. Você pode especificar essa configuração se usar um método de autenticação alternativo ou se o nome de usuário passado ao MongoDB para autenticação não corresponder ao nome de domínio LDAP . Você pode usar `setParameter` para definir essa configuração em um sistema em execução. Por padrão, o MongoDB usa nomes de usuário como nomes de domínio para a autorização LDAP automática.

ssl

O objeto ssl habilita o TLS para criptografar conexões. Este objeto é opcional.

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

Nome	Tipo	necessidade	Descrição
ssl	objeto	Opcional	Habilita o TLS para criptografar conexões. Para usar o TLS, escolha um pacote compatível com o TLS. Todas as plataformas que oferecem suporte ao MongoDB Enterprise também oferecem suporte ao TLS.
ssl.clientCertificateMode	string	Condicional	Indica se as conexões com o Ops Manager exigem um certificado TLS . Os valores são Opcionais e Exigim .
ssl.CAFilePath	string	Condicional	Caminho de arquivo absoluto para o certificado usado para autenticar por TLS em um host Linux ou UNIX. O Ops Manager exige ssl.CAFilePath ou ssa.CAFilePathWindows se: Você estiver usando a autenticação TLS ou X.509 e O arquivo CA não está nos certificados raiz do seu sistema operacional.
ssl.CAFilePathWindows	string	Condicional	Caminho de arquivo absoluto para o certificado usado para autenticar por TLS em um host Windows. O Ops Manager exige ssl.CAFilePath ou ssa.CAFilePathWindows se: Você estiver usando a autenticação TLS ou X.509 e O arquivo CA não está nos certificados raiz do seu sistema operacional.
ssl.autoPEMKeyFilePath	string	Condicional	Caminho de arquivo absoluto para o arquivo de chave privada do cliente (PEM) que autentica a conexão TLS em um host Linux ou UNIX. O Ops Manager requer ssl.autoPEMKeyFilePath ou ssa.autoPEMKeyFilePathWindows se você estiver usando a autenticação TLS ou X.509.
ssl.autoPEMKeyFilePathWindows	string	Condicional	Caminho de arquivo absoluto para o arquivo de chave privada do cliente (PEM) que autentica a conexão TLS em um host Windows. O Ops Manager requer ssl.autoPEMKeyFilePath ou ssa.autoPEMKeyFilePathWindows se você estiver usando a autenticação TLS ou X.509.
ssl.autoPEMKeyFilePwd	string	Condicional	Senha do arquivo de chave privada (PEM) especificado em ssl.autoPEMKeyFilePath ou ssa.autoPEMKeyFilePathWindows. O Ops Manager exige essa senha se o arquivo PEM for criptografado.

Roles do MongoDB

A matriz roles é opcional e descreve funções definidas pelo usuário.

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 ]

Nome	Tipo	necessidade	Descrição
roles	Array de objetos	Opcional	Roles e privilégios que o MongoDB atribuiu às roles definidas pelo usuário de um cluster. Cada objeto descreve uma função diferente definida pelo usuário. Os objetos nesta array contêm os mesmos campos que os documentos na coleção de funções do sistema, exceto o campo _id .
roles[n].role	string	Condicional	Nome do role definido pelo usuário.
roles[n].db	string	Condicional	Banco de dados ao qual pertence o role definido pelo usuário.
roles[n].privilégios	matriz de documentos	Condicional	Privilégios que esta role pode executar.
roles[n].privilégio[k].recurso	string	Condicional	Especifica os recursos sobre os quais as ações de privilégio se aplicam.
roles[n].privilégio[k].ação	string	Condicional	ação permitidas no recurso. Para saber mais, consulte Ações de privilégio.
roles[n].roles	matriz de documentos	Condicional	Roles dos quais este role herda privilégios.
roles[n].authenticationRestrictions	matriz de documentos	Opcional	Restrições de autenticação que o MongoDB Server impõe a esse role. AVISO: se um usuário herdar múltiplas funções com restrições de autenticação incompatíveis, esse usuário se tornará inutilizável. Por exemplo, se um usuário herdar uma função na qual o campo `clientSource` é `[198.51.100.0]` e outra role na qual o campo `clientSource` é `[203.0.113.0]`, o servidor não poderá autenticar o usuário. Para obter mais informações sobre autenticação no MongoDB, consulte Autenticação.
roles[n].authenticationRestrictions[k].clientSource	array de strings	Condicional	Se presente, ao autenticar um usuário, o MongoDB Server verifica se o IP do cliente está na lista fornecida ou se pertence a uma faixa CIDR na lista. Se o endereço IP do cliente não estiver presente, o servidor MongoDB não autenticará o usuário.
roles[n].authenticationRestrictions[k].serverAddress	array de strings	Condicional	Array separada por vírgulas de endereços IP aos quais o cliente pode se conectar. Se estiver presente, o servidor MongoDB verifica se aceitou a conexão do cliente de um endereço IP na array fornecida. Se o servidor MongoDB aceitar uma conexão de um endereço IP não reconhecido, o servidor MongoDB não autenticará o usuário.

Kerberos

O objeto Kerberos é opcional e define um nome de serviço Kerberos usado na autenticação.

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

Nome	Tipo	necessidade	Descrição
kerberos	objeto	Opcional	Par de valores-chave que define o nome de serviço Kerberos que o agente usa para autenticar via Kerberos.
Kerberos.serviceName	string	Obrigatório	Etiqueta que define: O nome do serviço que os agentes utilizam para autenticar em um `mongod` ou `mongos` via Kerberos. A opção saslServiceName nos parâmetros doMongoDB Server .

Indexes

A matriz indexConfigs é opcional e define índices a serem construídos 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 }]

Nome

Tipo

necessidade

Descrição

indexConfigs

Array de objetos

Opcional

Índices específicos a serem construídos para conjuntos de réplicas específicos.

indexConfigs.key

array de arrays

Obrigatório

Chaves no índice. Esse "array de arrays" contém um único array se o índice tiver apenas uma chave.

indexConfigs.rsName

string

Obrigatório

Conjunto de réplicas no qual o MongoDB cria o índice.

indexConfigs.dbName

string

Obrigatório

Banco de dados que o MongoDB indexa.

indexConfigs.collectionName

string

Obrigatório

collection que o MongoDB indexa.

indexConfigs.collation

objeto

Opcional

Regras específicas do idioma a serem usadas ao classificar e corresponder strings se o índice usar agrupamento.

Se você incluir o objeto indexConfigs.collation , deverá incluir o parâmetro indexConfigs.collation.locale . Todos os outros parâmetros são opcionais.

Se você não incluir o objeto indexConfigs.collation , o índice não poderá incluir o agrupamento.

indexConfigs.collation.locale

string

Obrigatório

Local que a UTI define.

O Manual do MongoDB Server lista os locais suportados em sua seção Locais de agrupamento e parâmetros padrão.

Para especificar uma comparação binária simples, defina este valor como simple.

indexConfigs.collation.caseLevel

booleano

Opcional

Sinalizador que indica como o índice usa a comparação de caso.

Se você definir este parâmetro como true, o índice usará a comparação de caso.

Este parâmetro se aplica somente se você definir indexConfigs.collation.strongth como 1 ou 2.

Para saber mais, consulte Agrupamento.

indexConfigs.collation.caseFirst

string

Opcional

Ordem de classificação das diferenças de casos durante comparações de nível terciário.

O Manual do MongoDB Server lista os valores possíveis em sua seção Agrupamento.

indexConfigs.collation.strongth

número

Opcional

Nível de comparação a ser executado. Corresponde aos Níveis de comparação da ICU .

O Manual do MongoDB Server lista os valores possíveis em sua seção Agrupamento.

indexConfigs.collation.numericOrdering

booleano

Opcional

Sinalizador que indica como comparar strings numéricas.

Valor	Método de agrupamento	Exemplo
true	sequências numéricas em comparação como números	10 > 2.
false	sequências numéricas em comparação como cadeias de caracteres	10 < 2.

O padrão é "falso".

Para saber mais, consulte Agrupamento.

indexConfigs.collation.alternate

string

Opcional

Configuração que determina como o agrupamento deve considerar espaços em branco e pontuação como caracteres básicos durante as comparações.

O Manual do MongoDB Server lista os valores possíveis em sua seção Agrupamento.

indexConfigs.collation.maxVariable

string

Opcional

Caracteres que o índice pode ignorar. Esse parâmetro se aplica somente se indexConfigs.collation.alternate estiver definido como shifted .

O Manual do MongoDB Server lista os valores possíveis em sua seção Agrupamento.

indexConfigs.collation.normalization

booleano

Opcional

Sinalizador que indica se o texto deve ser normalizado.

Se você definir este parâmetro como true , o agrupamento:

Verifica se o texto requer normalização.
Executa a normalização para comparar texto.

O padrão é "falso".

Para saber mais, consulte Agrupamento.

indexConfigs.collation.backwards

booleano

Opcional

Sinalizador que indica como o índice deve lidar com strings diacríticas.

Se você definir este parâmetro como true, as strings com diacríticos serão classificadas da parte de trás para a frente da string.

O padrão é "falso".

Para saber mais, consulte Agrupamento.

indexConfigs.options

documento

Obrigatório

Opções de índice compatíveis com o driver Go do MongoDB .

Voltar

Opções avançadas

Configurações e automação do MongoDB

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

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

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

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

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

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

1	"sharding" : [
2	{
3	"managedSharding" : 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	]

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

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

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

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