MongoDB CLI の設定
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.
前提条件
MongoDB CLI を設定するには、次の手順に従います。
IPまたはCIDRブロックを MongoDB サービスのAPIアクセス リストに追加します。
プログラマティック API キーがまだ持っていない場合は、 生成します 。
注意
プログラマティック API キーはロールベースです。 異なるロールには異なる特権と機能があり、一部の MongoDB CLI コマンドは一部のロールでは使用できますが、他のロールでは使用できません。 プログラマティック API キーに割り当てられたロールが、使用するコマンドに適していることを確認してください。
MongoDB サービス用のプログラム API キーの生成の詳細については、次のドキュメントを参照してください。
手順
mongocli configコマンドは、MongoDB CLI を構成する MongoDB サービスによって若干異なります。
プロファイルを作成します。
このコマンドは、 MongoDB CLI 構成ファイル に という プロファイル を作成します。default
次のようにmongocli コンフィギュレーションコマンド を実行します。
mongocli config
このコマンドは、 MongoDB CLI 構成ファイル にカスタム名の プロファイル を作成します。このプロファイルを コマンドで使用するには、 --profileフラグを使用してプロファイルを指定する必要があります。
次のようにmongocli コンフィギュレーションコマンド を実行します。
mongocli config --profile <profile-name>
Optional: Enter your Programmatic API Key.
プロンプトが表示されたら、Atlas 配置のPublic API KeyとPrivate API Keyを入力します。
? Public API Key: [? for help] abcdef ? Private API Key: [? for help] ************************************
デフォルトの組織を選択します。
If you entered API keys, the command displays the name and ID of organizations that your API key can access.
組織を選択します。
Press the
Down ArrowandUp Arrowkeys to highlight the desired organization, or組織名を入力して、利用可能な組織をフィルタリングします。
? 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の入力を求めるメッセージが表示されます。
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:
システム上の
mongoshへのパスを指定します。? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh) Enterを押します。
プロファイルを確認します。
プロファイルを検証するには、構成ファイルを表示するか、 mongocli config describeコマンドを実行します。
重要
Your API keys are like passwords. The configuration file stores API keys in plaintext, so ensure that you secure the configuration file appropriately.
例
次のコマンドは、デフォルトの プロファイルの 設定を返します。
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>
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] ************************************
デフォルトの組織を選択します。
If you entered API keys, the command displays the name and ID of organizations that your API key can access.
組織を選択します。
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の入力を求めるメッセージが表示されます。
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:
システム上の
mongoshへのパスを指定します。? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh) Enterを押します。
プロファイルを確認します。
プロファイルを検証するには、構成ファイルを表示するか、 mongocli config describeコマンドを実行します。
重要
Your API keys are like passwords. The configuration file stores API keys in plaintext, so ensure that you secure the configuration file appropriately.
例
次のコマンドは、デフォルトの プロファイルの 設定を返します。
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>
Enter the URL you use to access Ops Manager.
? URL to Access Ops Manager: http://mms.example.com:8080
Optional: Enter your API keys.
プロンプトが表示されたら、 MongoDB Ops Manager配置の Public API Key と Private API Key を入力します。
? Public API Key: [? for help] abcdef ? Private API Key: [? for help] ************************************
デフォルトの組織を選択します。
If you entered API keys, the command displays the name and ID of organizations that your API key can access.
組織を選択します。
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の入力を求めるメッセージが表示されます。
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:
システム上の
mongoshへのパスを指定します。? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh) Enterを押します。
プロファイルを確認します。
プロファイルを検証するには、構成ファイルを表示するか、 mongocli config describeコマンドを実行します。
重要
Your API keys are like passwords. The configuration file stores API keys in plaintext, so ensure that you secure the configuration file appropriately.
例
次のコマンドは、デフォルトの プロファイルの 設定を返します。
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
次のステップ
構成ファイルを編集して、プロファイルを追加または変更します。
より簡単なスクリプトを作成するには、環境変数を設定します。