Docs Menu
Docs Home
/
MongoDB Atlas
/
MongoDB CLI

MongoDB CLI の設定

項目一覧

  • 前提条件
  • 手順
  • 次のステップ

が 、 、 MongoDB CLIMongoDBなどの サービスを操作するために使用する設定を定義するには、AtlasCloud ManagerMongoDB Ops Manager mongocli auth login または mongocli config コマンドを使用します。これらのコマンドのいずれかを初めて実行すると、MongoDB CLI は設定を保存するための config.tomlという構成ファイルを作成します。

前提条件

MongoDB CLI を設定するには、次の手順に従います。

  • IPまたはCIDRブロックを MongoDB サービスのAPIアクセス リストに追加します。

  • プログラマティック API キーがまだ持っていない場合は、 生成します 。

    注意

    プログラマティック API キーはロールベースです。 異なるロールには異なる特権と機能があり、一部の MongoDB CLI コマンドは一部のロールでは使用できますが、他のロールでは使用できません。 プログラマティック API キーに割り当てられたロールが、使用するコマンドに適していることを確認してください。

    MongoDB サービス用のプログラム API キーの生成の詳細については、次のドキュメントを参照してください。

    • Atlas API Access

    • Cloud Manager API アクセス

    • MongoDB Ops Manager APIアクセス

  • MongoDB CLI インストールがファイアウォールの背後にあり、プロキシ URL を使用する場合は、HTTP_PROXY または 環境変数HTTPS_PROXY を設定します。MongoDB CLI は、 http 、 https 、 socks5スキームをサポートしています。 さらに、プロキシ サービスのアクセス リストでメインのターゲット URL としてcloud.mongodb.com/を指定します。 プロキシ構成で認証が有効になっている場合は、ユーザー名とパスワードも指定する必要があります。

    詳細については、「 プロキシ サーバー 」を参照してください。

手順

1

Atlas で認証を行います。

  1. 次のようにmongocli auth loginコマンドを実行します。

    mongocli auth login

    コマンドはブラウザ ウィンドウを開き、1 回限りのアクティベーション コードを返します。 このコードは 10 分後に期限切れになります。

  2. まだサインインしていない場合は、ブラウザで Atlas アカウントにサインインします。

  3. アクティベーション コードをブラウザに貼り付け、[ Confirm Authorizationをクリックします。

2

プロファイルを作成します。

ターミナルで を押して、 MongoDB CLI 構成ファイル に Enterという プロファイル を作成します。default

3

デフォルトの組織を選択します。

  1. 組織を選択します。

    • Down ArrowとUp Arrowキーを押して目的の組織を強調表示するか、 または

    • 組織名を入力して、利用可能な組織をフィルタリングします。

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

  2. Enter を押します。

4

デフォルトのプロジェクトを選択します。

  1. プロジェクトを選択します。

    • Down ArrowキーとUp Arrowキーを押して、目的のプロジェクトをハイライトするか、 または

    • プロジェクト名を入力して、利用可能なプロジェクトをフィルタリングします。

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

  2. Enter を押します。

5

デフォルトの出力形式を選択します。

  1. 希望のデフォルト出力形式を強調表示するには、 Down ArrowキーとUp Arrowキーを押します。

    ? Default Output Format:  [Use arrows to move, type to filter]
    > plaintext
      json
    オプション
    説明
    plaintext
    MongoDB CLI が返すすべてのフィールドを含む、人間が判読可能な出力。
    json
    MongoDB CLI が返すすべてのフィールドを含む JSON 出力。

  2. Enter を押します。

6

システム上のMongoDB Shell、mongosh へのパスを指定します。

MongoDB CLI は指定されたmongoshパスを使用して、配置にアクセスできるようにします。 デフォルト値は/usr/local/bin/mongoshです。 デフォルトの または を受け入れるには、 Enterを押します。

  1. システム上のmongoshへのパスを指定します。

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

  2. Enter を押します。

7

オプション: プロファイルに API キーを追加します。

認証に成功すると、MongoDB CLI に12時間ログインしたままになります。 12時間以上プログラムによるアクセスを必要とするアカウントの場合は、 mongocli コンフィギュレーションセットコマンドを使用してプロファイルの API キーを設定します。

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

注意

プログラマティック API キーはロールベースです。 異なるロールには異なる特権と機能があり、一部の MongoDB CLI コマンドは一部のロールでは使用できますが、他のロールでは使用できません。 使用するコマンドに適したロールを、プログラマティック API キーに割り当ててください。

Atlas の API キーの生成の詳細については、「プログラム API キー 」を参照してください。

8

プロファイルを確認します。

プロファイルを検証するには、構成ファイルを表示するか、 mongocli config describeコマンドを実行します。

例

次のコマンドは、デフォルトの プロファイルの 設定を返します。

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
1

MongoDB Cloud Managerで認証します。

  1. 次のようにmongocli auth loginコマンドを実行します。

    mongocli auth login --cm

    コマンドはブラウザ ウィンドウを開き、1 回限りのアクティベーション コードを返します。 このコードは 10 分後に期限切れになります。

  2. まだサインインしていない場合は、ブラウザでMongoDB Cloud Managerアカウントにサインインします。

  3. アクティベーション コードをブラウザに貼り付け、[ Confirm Authorization ] をクリックします。

2

プロファイルを作成します。

ターミナルで を押して、 MongoDB CLI 構成ファイル に Enterという プロファイル を作成します。default

3

デフォルトの組織を選択します。

  1. 組織を選択します。

    • Down ArrowとUp Arrowキーを押して目的の組織を強調表示するか、 または

    • 組織名を入力して、利用可能な組織をフィルタリングします。

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

  2. Enter を押します。

4

デフォルトのプロジェクトを選択します。

  1. プロジェクトを選択します。

    • Down ArrowキーとUp Arrowキーを押して、目的のプロジェクトをハイライトするか、 または

    • プロジェクト名を入力して、利用可能なプロジェクトをフィルタリングします。

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

  2. Enter を押します。

5

デフォルトの出力形式を選択します。

  1. 希望のデフォルト出力形式を強調表示するには、 Down ArrowキーとUp Arrowキーを押します。

    ? Default Output Format:  [Use arrows to move, type to filter]
    > plaintext
      json
    オプション
    説明
    plaintext
    MongoDB CLI が返すすべてのフィールドを含む、人間が判読可能な出力。
    json
    MongoDB CLI が返すすべてのフィールドを含む JSON 出力。

  2. Enter を押します。

6

システム上のMongoDB Shell、mongosh へのパスを指定します。

MongoDB CLI は指定されたmongoshパスを使用して、配置にアクセスできるようにします。 デフォルト値は/usr/local/bin/mongoshです。 デフォルトの または を受け入れるには、 Enterを押します。

  1. システム上のmongoshへのパスを指定します。

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

  2. Enter を押します。

7

オプション: プロファイルに API キーを追加します。

認証に成功すると、MongoDB CLI に12時間ログインしたままになります。 12時間以上プログラムによるアクセスを必要とするアカウントの場合は、 mongocli コンフィギュレーションセットコマンドを使用してプロファイルの API キーを設定します。

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

注意

プログラマティック API キーはロールベースです。 異なるロールには異なる特権と機能があり、一部の MongoDB CLI コマンドは一部のロールでは使用できますが、他のロールでは使用できません。 使用するコマンドに適したロールを、プログラマティック API キーに割り当ててください。

MongoDB Cloud Managerの API キーの生成の詳細については、「 API キー 」を参照してください。

8

プロファイルを確認します。

プロファイルを検証するには、構成ファイルを表示するか、 mongocli config describeコマンドを実行します。

例

次のコマンドは、デフォルトの プロファイルの 設定を返します。

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
1

前提条件を完了します。

MongoDB CLI を設定する前に、以下の点に注意してください。

  1. または IPCIDR ブロックを のAPI アクセス リストに追加します。MongoDB Ops Manager

  2. プログラマティック API キーがまだ持っていない場合は、 生成します 。

注意

プログラマティック API キーはロールベースです。 異なるロールには異なる特権と機能があり、一部の MongoDB CLI コマンドは一部のロールでは使用できますが、他のロールでは使用できません。 使用するコマンドに適したロールを、プログラマティック API キーに割り当ててください。

の プログラマティック キーの生成の詳細については、「APIMongoDB Ops Manager MongoDB Ops ManagerAPIアクセス 」を参照してください。

2

プロファイルを作成します。

このコマンドは、 MongoDB CLI 構成ファイル に という プロファイル を作成します。default

次のようにmongocli コンフィギュレーションコマンド を実行します。

mongocli config --service ops-manager

このコマンドは、 MongoDB CLI 構成ファイル にカスタム名の プロファイル を作成します。このプロファイルを コマンドで使用するには、 --profileフラグを使用してプロファイルを指定する必要があります。

次のようにmongocli コンフィギュレーションコマンド を実行します。

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

MongoDB Ops Manager にアクセスするために使用するURLを入力します。

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

任意: APIキー を入力します。

プロンプトが表示されたら、 MongoDB Ops Manager配置の Public API Key と Private API Key を入力します。

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

デフォルトの組織を選択します。

APIキーを入力した場合、コマンドにはAPIキーがアクセスできる組織の名前と ID が表示されます。

  1. 組織を選択します。

    • Down ArrowとUp Arrowキーを押して目的の組織を強調表示するか、 または

    • 組織名を入力して、利用可能な組織をフィルタリングします。

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

  2. Enter を押します。

APIキーを入力しなかった場合は、コマンドによってDefault Organization IDの入力を求めるメッセージが表示されます。

6

デフォルトのプロジェクトを選択します。

APIキーを入力した場合、コマンドにはAPIキーがアクセスできるプロジェクトの名前と ID が表示されます。

  1. プロジェクトを選択します。

    • Down ArrowキーとUp Arrowキーを押して、目的のプロジェクトをハイライトするか、 または

    • プロジェクト名を入力して、利用可能なプロジェクトをフィルタリングします。

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

  2. Enter を押します。

APIキーを入力しなかった場合は、コマンドによってDefault Project IDの入力を求めるメッセージが表示されます。

7

デフォルトの出力形式を選択します。

  1. 希望のデフォルト出力形式を強調表示するには、 Down ArrowキーとUp Arrowキーを押します。

    ? Default Output Format:  [Use arrows to move, type to filter]
    > plaintext
      json
    オプション
    説明
    plaintext
    MongoDB CLI が返すすべてのフィールドを含む、人間が判読可能な出力。
    json
    MongoDB CLI が返すすべてのフィールドを含む JSON 出力。

  2. Enter を押します。

8

システム上のMongoDB Shell、mongosh へのパスを指定します。

MongoDB CLI は指定されたmongoshパスを使用して、配置にアクセスできるようにします。 デフォルト値は/usr/local/bin/mongoshです。 デフォルトの または を受け入れるには、 Enterを押します。

  1. システム上のmongoshへのパスを指定します。

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

  2. Enter を押します。

9

プロファイルを確認します。

プロファイルを検証するには、構成ファイルを表示するか、 mongocli config describeコマンドを実行します。

例

次のコマンドは、デフォルトの プロファイルの 設定を返します。

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

次のステップ

戻る

パッケージを検証する

次へ

構成ファイル