Menu Docs
Página inicial do Docs
/
MongoDB Atlas
/
MongoDB CLI

Configurar o MongoDB CLI

Nesta página

  • Pré-requisitos
  • Procedimento
  • Próximos passos

Você pode definir as configurações que a MongoDB CLI usa para interagir com serviços do MongoDB , como Atlas, Cloud Manager e MongoDB Ops Manager usando o comando mongocli auth login ou mongocli config . Na primeira vez que você executa um desses comandos, o MongoDB CLI cria um arquivo de configuração chamado config.toml para armazenar suas configurações.

Pré-requisitos

Para configurar o MongoDB CLI:

  • Adicione seu blocoIP ou CIDR do à lista de acesso da API do seu serviço MongoDB.

  • Gere uma chave de API programática se ainda não tiver uma.

    Observação

    As chaves de API programáticas são baseadas em funções. Funções diferentes têm privilégios e capacidades diferentes, e alguns comandos do MongoDB CLI estão disponíveis para algumas funções, mas não para outras. Certifique-se de que as funções atribuídas à sua chave de API programática sejam adequadas para os comandos que você pretende usar.

    Para saber mais sobre como gerar uma chave de API programática para seu serviço MongoDB, consulte a seguinte documentação:

    • Atlas API Access

    • Acesso à API do Cloud Manager

    • Acesso à API do Ops Manager

  • Configure a variável de ambiente HTTP_PROXY ou HTTPS_PROXY se a instalação do MongoDB CLI estiver atrás de um firewall e você quiser usar uma URL proxy. O MongoDB CLI suporta esquemas http, https e socks5 . Além disso, especifique cloud.mongodb.com/ como a URL de destino principal na lista de acesso do serviço de proxy. Você também deve especificar o nome de usuário e senha se a configuração de proxy permitir a autenticação.

    Para saber mais,consulte Servidor proxy.

Procedimento

1

Autenticar no Atlas.

  1. Execute o comando mongocli auth login :

    mongocli auth login

    O comando abre uma janela do navegador e retorna um código de ativação único. Este código expira após 10 minutos.

  2. Se você ainda não estiver registrado, entre na sua conta do Atlas no navegador.

  3. Cole seu código de ativação no navegador e clique em Confirm Authorization.

2

Crie um Perfil.

No seu terminal, pressione Enter para criar um perfil chamado default no arquivo de configuração do MongoDB CLI .

3

Escolha sua organização padrão .

  1. Selecione sua organização.

    • Pressione as teclas Down Arrow e Up Arrow para realçar a organização desejada, ou

    • Digite o nome da organização para filtrar as organizações disponíveis.

    ? Choose a default organization:  [Use arrows to move, type to filter]
    > Org1 (5e39bf1212121e685774c81c)

  2. Pressione Enter.

4

Escolha seu projeto padrão.

  1. Selecione seu projeto:

    • Pressione as teclas Down Arrow e Up Arrow para realçar o projeto desejado, ou

    • Digite o nome do projeto para filtrar os projetos disponíveis.

    ? Choose a default project:  [Use arrows to move, type to filter]
      Project1 (5e5ebffd0c04a97009061234)
      Project2 (5cfacee6014b761b07f15678)
    > Project3 (5e39bf4979358e6857741212)
      Project4 (5c815cc7014b768fb67e3434)

  2. Pressione Enter.

5

Escolha seu formato de saída padrão.

  1. Pressione as teclas Down Arrow e Up Arrow para destacar o formato de saída padrão desejado:

    ? Default Output Format:  [Use arrows to move, type to filter]
    > plaintext
      json
    Opção
    Descrição
    plaintext
    Saída legível por humanos que inclui todos os campos que a CLI MongoDB retorna.
    json
    Saída JSON que inclui todos os campos que o MongoDB CLI retorna.

  2. Pressione Enter.

6

Especifique o caminho para o MongoDB Shell, , em seumongosh sistema.

O MongoDB CLI usa o caminho mongosh especificado para que você possa acessar suas implantações. O valor padrão é /usr/local/bin/mongosh. Pressione Enter para aceitar o padrão ou:

  1. Especifique o caminho para mongosh em seu sistema.

    ? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh)

  2. Pressione Enter.

7

Opcional: adicione chaves de API ao seu perfil.

Após a autenticação bem-sucedida, você permanece conectado ao MongoDB CLI por 12 horas. Para uma conta que precisa de acesso programático por mais de 12 horas, configure as chaves de API para o perfil com o comando mongocli config set:

mongocli config set public_api_key abcdef
mongocli config set private_api_key a123bc45-ab1c-234d-5678-f91234a5bc6d

Observação

As chaves de API programáticas são baseadas em funções. Funções diferentes têm privilégios e capacidades diferentes, e alguns comandos do MongoDB CLI estão disponíveis para algumas funções, mas não para outras. Certifique-se de atribuir funções à sua chave de API programática que sejam apropriadas para os comandos que você pretende usar.

Para saber mais sobre como gerar uma chave de API para o Atlas, consulte Chave de API programática.

8

Verifique seu perfil.

Visualize o arquivo de configuração ou execute o comando mongocli config describe para verificar seu perfil.

Exemplo

O comando a seguir retorna as configurações no perfil padrão:

mongocli config describe default

O comando anterior retorna as seguintes configurações. Para fins de segurança, o comando edita as chaves de API na saída.

SETTING           VALUE
mongosh_path      /usr/local/bin/mongosh
org_id            5f1f39ffc902201990f12345
private_api_key   redacted
project_id        7ehf04abc10defb66c7d1234c
public_api_key    redacted
service           cloud

Exemplo

O seguinte comando retorna as configurações no perfil denominado myMongoDB:

mongocli config describe myMongoDB

O comando retorna as seguintes configurações. Por motivos de segurança, o comando edita chaves API na saída.

SETTING           VALUE
org_id            5f1f39ffc902201990f12345
private_api_key   redacted
project_id        7ehf04abc10defb66c7d1234c
public_api_key    redacted
service           cloud
1

Autentique-se no MongoDB Cloud Manager.

  1. Execute o comando mongocli auth login :

    mongocli auth login --cm

    O comando abre uma janela do navegador e retorna um código de ativação único. Este código expira após 10 minutos.

  2. Se você ainda não estiver conectado, conecte-se à sua conta do MongoDB Cloud Manager no navegador.

  3. Cole seu código de ativação no navegador e clique em Confirm Authorization.

2

Crie um Perfil.

No seu terminal, pressione Enter para criar um perfil chamado default no arquivo de configuração do MongoDB CLI.

3

Escolha sua organização padrão .

  1. Selecione sua organização.

    • Pressione as teclas Down Arrow e Up Arrow para realçar a organização desejada, ou

    • Digite o nome da organização para filtrar as organizações disponíveis.

    ? Choose a default organization:  [Use arrows to move, type to filter]
    > Org1 (5e39bf1212121e685774c81c)

  2. Pressione Enter.

4

Escolha seu projeto padrão.

  1. Selecione seu projeto:

    • Pressione as teclas Down Arrow e Up Arrow para realçar o projeto desejado, ou

    • Digite o nome do projeto para filtrar os projetos disponíveis.

    ? Choose a default project:  [Use arrows to move, type to filter]
      Project1 (5e5ebffd0c04a97009061234)
      Project2 (5cfacee6014b761b07f15678)
    > Project3 (5e39bf4979358e6857741212)
      Project4 (5c815cc7014b768fb67e3434)

  2. Pressione Enter.

5

Escolha seu formato de saída padrão.

  1. Pressione as teclas Down Arrow e Up Arrow para destacar o formato de saída padrão desejado:

    ? Default Output Format:  [Use arrows to move, type to filter]
    > plaintext
      json
    Opção
    Descrição
    plaintext
    Saída legível por humanos que inclui todos os campos que a CLI MongoDB retorna.
    json
    Saída JSON que inclui todos os campos que o MongoDB CLI retorna.

  2. Pressione Enter.

6

Especifique o caminho para o MongoDB Shell, , em seumongosh sistema.

O MongoDB CLI usa o caminho mongosh especificado para que você possa acessar suas implantações. O valor padrão é /usr/local/bin/mongosh. Pressione Enter para aceitar o padrão ou:

  1. Especifique o caminho para mongosh em seu sistema.

    ? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh)

  2. Pressione Enter.

7

Opcional: adicione chaves de API ao seu perfil.

Após a autenticação bem-sucedida, você permanece conectado ao MongoDB CLI por 12 horas. Para uma conta que precisa de acesso programático por mais de 12 horas, configure as chaves de API para o perfil com o comando mongocli config set:

mongocli config set public_api_key abcdef
mongocli config set private_api_key a123bc45-ab1c-234d-5678-f91234a5bc6d

Observação

As chaves de API programáticas são baseadas em funções. Funções diferentes têm privilégios e capacidades diferentes, e alguns comandos do MongoDB CLI estão disponíveis para algumas funções, mas não para outras. Certifique-se de atribuir funções à sua chave de API programática que sejam apropriadas para os comandos que você pretende usar.

Para saber mais sobre como gerar uma chave de API para o MongoDB Cloud Manager, consulte Chaves de API.

8

Verifique seu perfil.

Visualize o arquivo de configuração ou execute o comando mongocli config describe para verificar seu perfil.

Exemplo

O comando a seguir retorna as configurações no perfil padrão:

mongocli config describe default

O comando anterior retorna as seguintes configurações. Para fins de segurança, o comando edita as chaves de API na saída.

SETTING           VALUE
mongosh_path      /usr/local/bin/mongosh
org_id            5f1f39ffc902201990f12345
private_api_key   redacted
project_id        7ehf04abc10defb66c7d1234c
public_api_key    redacted
service           cloud-manager

Exemplo

O seguinte comando retorna as configurações no perfil denominado myMongoDB:

mongocli config describe myMongoDB

O comando retorna as seguintes configurações. Por motivos de segurança, o comando edita chaves API na saída.

SETTING           VALUE
org_id            5f1f39ffc902201990f12345
private_api_key   redacted
project_id        7ehf04abc10defb66c7d1234c
public_api_key    redacted
service           cloud-manager
1

Conclua os pré-requisitos.

Antes de configurar o MongoDB CLI:

  1. Adicione seu bloco de IP ou CIDR à lista de acesso de API do MongoDB Ops Manager.

  2. Gere uma chave de API programática se ainda não tiver uma.

Observação

As chaves de API programáticas são baseadas em funções. Funções diferentes têm privilégios e capacidades diferentes, e alguns comandos do MongoDB CLI estão disponíveis para algumas funções, mas não para outras. Certifique-se de atribuir funções à sua chave de API programática que sejam apropriadas para os comandos que você pretende usar.

Para saber mais sobre como gerar uma chave de programática API para o MongoDB Ops Manager, consulte MongoDB Ops Manager API Acesso à .

2

Crie um Perfil.

Este comando cria um perfil chamado default no arquivo de configuração do MongoDB CLI .

Execute o comando de configuração mongocli :

mongocli config --service ops-manager

Este comando cria um perfil com um nome personalizado no arquivo de configuração MongoDB CLI. Para usar esse perfil em um comando, você deve especificar o perfil com o sinalizador --profile .

Execute o comando de configuração mongocli :

mongocli config --service ops-manager --profile <profile-name>
3

Insira a URL que você usa para acessar o Ops Manager .

? URL to Access Ops Manager: http://mms.example.com:8080/
4

Opcional: insira suas chaves de API.

Quando solicitado, insira o Public API Key e o Private API Key para sua implantação MongoDB Ops Manager .

? Public API Key: [? for help] abcdef
? Private API Key: [? for help]
************************************
5

Escolha sua organização padrão .

Se você inseriu chaves de API , o comando exibirá o nome e o ID das organizações que sua chave de API pode acessar.

  1. Selecione sua organização.

    • Pressione as teclas Down Arrow e Up Arrow para realçar a organização desejada, ou

    • Digite o nome da organização para filtrar as organizações disponíveis.

    ? Choose a default organization:  [Use arrows to move, type to filter]
    > Org1 (5e39bf1212121e685774c81c)

  2. Pressione Enter.

Se você não inseriu chaves API , o comando solicita que você insira seu Default Organization ID.

6

Escolha seu projeto padrão.

Se você inseriu chaves de API , o comando exibirá o nome e o ID dos projetos que sua chave de API pode acessar.

  1. Selecione seu projeto:

    • Pressione as teclas Down Arrow e Up Arrow para realçar o projeto desejado, ou

    • Digite o nome do projeto para filtrar os projetos disponíveis.

    ? Default Project ID:  [Use arrows to move, type to filter]
      Project1 (5e5ebffd0c04a97009061234)
      Project2 (5cfacee6014b761b07f15678)
    > Project3 (5e39bf4979358e6857741212)
      Project4 (5c815cc7014b768fb67e3434)

  2. Pressione Enter.

Se você não inseriu chaves API , o comando solicita que você insira seu Default Project ID.

7

Escolha seu formato de saída padrão.

  1. Pressione as teclas Down Arrow e Up Arrow para destacar o formato de saída padrão desejado:

    ? Default Output Format:  [Use arrows to move, type to filter]
    > plaintext
      json
    Opção
    Descrição
    plaintext
    Saída legível por humanos que inclui todos os campos que a CLI MongoDB retorna.
    json
    Saída JSON que inclui todos os campos que o MongoDB CLI retorna.

  2. Pressione Enter.

8

Especifique o caminho para o MongoDB Shell, , em seumongosh sistema.

O MongoDB CLI usa o caminho mongosh especificado para que você possa acessar suas implantações. O valor padrão é /usr/local/bin/mongosh. Pressione Enter para aceitar o padrão ou:

  1. Especifique o caminho para mongosh em seu sistema.

    ? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh)

  2. Pressione Enter.

9

Verifique seu perfil.

Visualize o arquivo de configuração ou execute o comando mongocli config describe para verificar seu perfil.

Exemplo

O comando a seguir retorna as configurações no perfil padrão:

mongocli config describe default

O comando anterior retorna as seguintes configurações. Para fins de segurança, o comando edita as chaves de API na saída.

SETTING           VALUE
mongosh_path      /usr/local/bin/mongosh
ops_manager_url = https://mms.example.com:8080/
org_id            5f1f39ffc902201990f12345
private_api_key   redacted
project_id        7ehf04abc10defb66c7d1234c
public_api_key    redacted
service           ops-manager

Exemplo

O seguinte comando retorna as configurações no perfil denominado myMongoDB:

mongocli config describe myMongoDB

O comando retorna as seguintes configurações. Por motivos de segurança, o comando edita chaves API na saída.

SETTING           VALUE
ops_manager_url = https://mms.example.com:8080/
org_id            5f1f39ffc902201990f12345
private_api_key   redacted
project_id        7ehf04abc10defb66c7d1234c
public_api_key    redacted
service           ops-manager

Próximos passos

Voltar

Verificar os pacotes

Próximo

Arquivo de configuração