Menu Docs
Página inicial do Docs
/
MongoDB Atlas
/
Interface da linha de comando do MongoDB

Configurar o MongoDB CLI

Nesta página

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

You can define the settings that the MongoDB CLI uses to interact with MongoDB services like Atlas, Cloud Manager, and Ops Manager by using the mongocli config command. The first time you run this command, the MongoDB CLI creates a configuration file called mongocli.toml to store your settings.

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 role. Funções diferentes têm privilégios e capacidades diferentes, e alguns comandos MongoDB CLI estão disponíveis para algumas funções, mas não para outras. Certifique-se de que as roles atribuídas à sua chave de API programática sejam apropriadas para os comandos que pretende usar.

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

Procedimento

O comando de configuração mongocli varia ligeiramente dependendo do serviço MongoDB para o qual você deseja configurar o MongoDB CLI.

1

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

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  --profile <profile-name>
2

Optional: Enter your Programmatic API Key.

Quando solicitado, insira o Public API Key e o Private API Key para sua implantação do Atlas.

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

Escolha sua organização padrão .

If you entered API keys, the command displays the name and ID of organizations that your API key can access.

  1. Selecione sua organização:

    • Press the Down Arrow and Up Arrow keys to highlight the desired organization, or

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

    ? Default Org ID:  [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.

4

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.

5

Specify the path to the MongoDB Shell, mongosh, on your system.

MongoDB CLI uses mongosh path that you specify to allow you to access your deployments. The default value is /usr/local/bin/mongosh. Press Enter to accept the default or:

  1. Especifique o caminho para mongosh em seu sistema.

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

  2. Pressione Enter.

6

Verifique seu perfil.

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

Importante

Your API keys are like passwords. The configuration file stores API keys in plaintext, so ensure that you secure the configuration file appropriately.

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

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 cloud-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 cloud-manager --profile <profile-name>
2

Optional: Enter your API keys.

When prompted, enter the Public API Key and Private API Key for your MongoDB Cloud Manager deployment.

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

Escolha sua organização padrão .

If you entered API keys, the command displays the name and ID of organizations that your API key can access.

  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.

    ? Default Org ID:  [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.

4

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.

5

Specify the path to the MongoDB Shell, mongosh, on your system.

MongoDB CLI uses mongosh path that you specify to allow you to access your deployments. The default value is /usr/local/bin/mongosh. Press Enter to accept the default or:

  1. Especifique o caminho para mongosh em seu sistema.

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

  2. Pressione Enter.

6

Verifique seu perfil.

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

Importante

Your API keys are like passwords. The configuration file stores API keys in plaintext, so ensure that you secure the configuration file appropriately.

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

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

Enter the URL you use to access Ops Manager.

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

Optional: Enter your API keys.

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]
************************************
4

Escolha sua organização padrão .

If you entered API keys, the command displays the name and ID of organizations that your API key can access.

  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.

    ? Default Org ID:  [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.

5

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.

6

Specify the path to the MongoDB Shell, mongosh, on your system.

MongoDB CLI uses mongosh path that you specify to allow you to access your deployments. The default value is /usr/local/bin/mongosh. Press Enter to accept the default or:

  1. Especifique o caminho para mongosh em seu sistema.

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

  2. Pressione Enter.

7

Verifique seu perfil.

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

Importante

Your API keys are like passwords. The configuration file stores API keys in plaintext, so ensure that you secure the configuration file appropriately.

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

Compatibilidade

Próximo

Arquivo de configuração do MongoDB CLI