配置 MongoDB CLI

在此页面上

先决条件

步骤
后续步骤

此版本的文档已存档，不再提供支持。查看最新文档，学习；了解如何升级MongoCLI 版本。

您可以使用 mongocli config 命令定义MongoDB MongoDB CLIMongoDBCLI用于与AtlasAtlas Cloud Manager、 Cloud Manager和MongoDB OpsMongoDB Ops Manager Manager等MongoDB服务交互的设置。首次运行此命令时， MongoDB CLI会创建一个名为 mongocli.toml的配置文件来存储您的设置。

先决条件

要配置 MongoDB CLI，请执行以下操作：

将 IP或CIDR区块添加到 MongoDB 服务的API访问列表。
如果您还没有编程 API 密钥，请生成一个。
注意
编程 API 密钥是基于角色的。不同的角色具有不同的特权和能力，并且某些 MongoDB CLI 命令对某些角色可用，但对其他角色可用。确保分配给您的编程 API 密钥的角色适合您要使用的命令。

要了解有关为 MongoDB 服务生成编程 API Key 的更多信息，请参阅以下文档：

步骤

mongocli config命令略有不同，具体取决于要配置 MongoDB CLI 的 MongoDB 服务。

创建配置文件。

此命令在 MongoDB CLI配置文件中创建一个名为的配置文件。default

运行mongocli 配置命令：

mongocli config

此命令在 MongoDB CLI配置文件中创建具有自定义名称的配置文件。要在命令中使用此配置文件，必须使用--profile标志指定该配置文件。

运行mongocli 配置命令：

mongocli config  --profile <profile-name>

可选：输入您的编程API密钥。

出现提示时，输入 Atlas 部署的Public API Key和Private API Key 。

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

选择您的默认组织。

如果您输入了API密钥，该命令会显示您的API密钥可以访问权限的组织的名称和ID 。

选择您的组织：
- 按 Down Arrow 和 Up Arrow 键突出显示所需的组织，或者
- 键入组织名称来过滤可用的组织。
```
? Default Org ID:  [Use arrows to move, type to filter]
> Org1 (5e39bf1212121e685774c81c)
```
按 Enter。

如果您没有输入API密钥，命令会提示您输入Default Organization ID 。

选择您的默认项目。

如果您输入了API密钥，该命令会显示您的API密钥可以访问权限的项目的名称和ID 。

选择您的项目：

按 Down Arrow 和 Up Arrow 键突出显示所需的项目，或者
输入项目名称以筛选可用项目。

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

按 Enter。

如果您没有输入API密钥，命令会提示您输入Default Project ID 。

指定系统上MongoDB Shell`mongosh` 的路径。

MongoDB CLI使用您指定的mongosh 路径来访问权限部署。默认值为 /usr/local/bin/mongosh 。按 Enter 接受默认，或者：

指定系统中 mongosh 的路径。
```
? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh)
```
按 Enter。

验证您的个人资料。

查看配置文件运行 mongocli config describe 命令以验证您的配置文件。

重要

API密钥就像密码一样。配置文件以明文形式存储API密钥，因此请确保以适当方式保护配置文件。

例子

以下命令返回默认配置文件中的设置：

mongocli config describe default

上述命令返回以下设置。出于安全考虑，该命令会编辑输出中的 API 密钥。

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

例子

以下命令将返回名为myMongoDB的配置文件中的设置：

mongocli config describe myMongoDB

该命令会返回以下设置。出于安全考虑，该命令会编辑输出中的 API 密钥。

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

创建配置文件。

此命令在 MongoDB CLI配置文件中创建一个名为的配置文件。default

运行mongocli 配置命令：

mongocli config --service cloud-manager

此命令在 MongoDB CLI配置文件中创建具有自定义名称的配置文件。要在命令中使用此配置文件，必须使用--profile标志指定该配置文件。

运行mongocli 配置命令：

mongocli config --service cloud-manager --profile <profile-name>

可选：输入您的API密钥。

出现提示时，输入MongoDB Cloud Manager部署的 Public API Key和Private API Key 。

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

选择您的默认组织。

如果您输入了API密钥，该命令会显示您的API密钥可以访问权限的组织的名称和ID 。

选择您的组织：
- 按 Down Arrow 和 Up Arrow 键突出显示所需的组织，或者
- 键入组织名称来过滤可用的组织。
```
? Default Org ID:  [Use arrows to move, type to filter]
> Org1 (5e39bf1212121e685774c81c)
```
按 Enter。

如果您没有输入API密钥，命令会提示您输入Default Organization ID 。

选择您的默认项目。

如果您输入了API密钥，该命令会显示您的API密钥可以访问权限的项目的名称和ID 。

选择您的项目：

按 Down Arrow 和 Up Arrow 键突出显示所需的项目，或者
输入项目名称以筛选可用项目。

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

按 Enter。

如果您没有输入API密钥，命令会提示您输入Default Project ID 。

指定系统上MongoDB Shell`mongosh` 的路径。

MongoDB CLI使用您指定的mongosh 路径来访问权限部署。默认值为 /usr/local/bin/mongosh 。按 Enter 接受默认，或者：

指定系统中 mongosh 的路径。
```
? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh)
```
按 Enter。

验证您的个人资料。

查看配置文件运行 mongocli config describe 命令以验证您的配置文件。

重要

API密钥就像密码一样。配置文件以明文形式存储API密钥，因此请确保以适当方式保护配置文件。

例子

以下命令返回默认配置文件中的设置：

mongocli config describe default

上述命令返回以下设置。出于安全考虑，该命令会编辑输出中的 API 密钥。

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

例子

以下命令将返回名为myMongoDB的配置文件中的设置：

mongocli config describe myMongoDB

该命令会返回以下设置。出于安全考虑，该命令会编辑输出中的 API 密钥。

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

创建配置文件。

此命令在 MongoDB CLI配置文件中创建一个名为的配置文件。default

运行mongocli 配置命令：

mongocli config --service ops-manager

此命令在 MongoDB CLI配置文件中创建具有自定义名称的配置文件。要在命令中使用此配置文件，必须使用--profile标志指定该配置文件。

运行mongocli 配置命令：

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

URLMongoDB Ops Manager 输入用于访问权限MongoDB Ops Manager的URL 。

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

可选：输入您的API密钥。

出现提示时，输入MongoDB Ops Manager部署的 Public API Key 和 Private API Key。

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

选择您的默认组织。

如果您输入了API密钥，该命令会显示您的API密钥可以访问权限的组织的名称和ID 。

选择您的组织：
- 按 Down Arrow 和 Up Arrow 键突出显示所需的组织，或者
- 键入组织名称来过滤可用的组织。
```
? Default Org ID:  [Use arrows to move, type to filter]
> Org1 (5e39bf1212121e685774c81c)
```
按 Enter。

如果您没有输入API密钥，命令会提示您输入Default Organization ID 。

选择您的默认项目。

如果您输入了API密钥，该命令会显示您的API密钥可以访问权限的项目的名称和ID 。

选择您的项目：

按 Down Arrow 和 Up Arrow 键突出显示所需的项目，或者
输入项目名称以筛选可用项目。

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

按 Enter。

如果您没有输入API密钥，命令会提示您输入Default Project ID 。

指定系统上MongoDB Shell`mongosh` 的路径。

MongoDB CLI使用您指定的mongosh 路径来访问权限部署。默认值为 /usr/local/bin/mongosh 。按 Enter 接受默认，或者：

指定系统中 mongosh 的路径。
```
? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh)
```
按 Enter。

验证您的个人资料。

查看配置文件运行 mongocli config describe 命令以验证您的配置文件。

重要

API密钥就像密码一样。配置文件以明文形式存储API密钥，因此请确保以适当方式保护配置文件。

例子

以下命令返回默认配置文件中的设置：

mongocli config describe default

上述命令返回以下设置。出于安全考虑，该命令会编辑输出中的 API 密钥。

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

例子

以下命令将返回名为myMongoDB的配置文件中的设置：

mongocli config describe myMongoDB

该命令会返回以下设置。出于安全考虑，该命令会编辑输出中的 API 密钥。

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

后续步骤

编辑配置文件以添加或修改配置文件。
设置环境变量以简化脚本编写。

后退

兼容性

来年

MongoDB CLI 配置文件

先决条件

注意

步骤

创建配置文件。

可选：输入您的编程API密钥。

选择您的默认组织。

选择您的默认项目。

指定系统上MongoDB Shellmongosh 的路径。

验证您的个人资料。

重要

例子

例子

创建配置文件。

可选：输入您的API密钥。

选择您的默认组织。

选择您的默认项目。

指定系统上MongoDB Shellmongosh 的路径。

验证您的个人资料。

重要

例子

例子

创建配置文件。

URLMongoDB Ops Manager输入用于访问权限MongoDB Ops Manager的URL 。

可选：输入您的API密钥。

选择您的默认组织。

选择您的默认项目。

指定系统上MongoDB Shellmongosh 的路径。

验证您的个人资料。

重要

例子

例子

后续步骤

指定系统上MongoDB Shell`mongosh` 的路径。

指定系统上MongoDB Shell`mongosh` 的路径。

URLMongoDB Ops Manager 输入用于访问权限MongoDB Ops Manager的URL 。

指定系统上MongoDB Shell`mongosh` 的路径。