Docs Menu

環境変数

スクリプトを容易にするために、環境変数を使用して構成設定を指定できます。

  • コマンドを実行すると、環境変数で指定した設定は、構成ファイルに保存されているプロファイルよりも優先されます。

  • --projectIdオプションを使用してコマンドを実行すると、コマンドライン オプションは環境変数と構成ファイルに保存されているプロファイルの両方よりも優先されます。

MongoDB CLI は、次の環境変数をサポートしています。

変数
説明

MCLI_PUBLIC_API_KEY

MongoDB サービスを操作するコマンドの公開APIキーを設定します。

MCLI_PRIVATE_API_KEY

MongoDB サービスを操作するコマンドのプライベートAPIキーを設定します。

MCLI_ORG_ID

--orgIdオプションを必要とするコマンドの組織 ID を設定します。

MCLI_PROJECT_ID

--projectIdオプションを必要とするコマンドのプロジェクト ID を設定します。

MCLI_OPS_MANAGER_URL

MongoDB Ops Manager のみの場合、 API 呼び出しのベース URL を設定します。URLはフォワードスラッシュで終わる必要があり( / )。

MCLI_SERVICE

MongoDB サービスの種類を設定します。 有効な値は以下のとおりです。

サービス
cloud
default

cloudgov

cloud-manager

ops-manager

MCLI_OUTPUT

出力フィールドと形式を設定します。 有効な値は以下のとおりです。

出力形式
Empty
default

MongoDB CLI が返すすべてのフィールドを含む、人間が判読可能な出力。

json

MongoDB CLI が返すすべてのフィールドを含む JSON 出力。

json-path

go-template

MCLI_MONGOSH_PATH

MongoDB Shell へのローカル システム上のフルパス、 mongosh

MCLI_SKIP_UPDATE_CHECK

yesに設定すると、MongoDB CLI は新しいバージョンへの更新を要求しません。

MCLI_OPS_MANAGER_CA_CERTIFICATE
Ops Manager only

該当する場合は、クライアントと MongoDB Ops Manager TLS 証明書に署名するために使用される PEM でエンコードされた証明機関(CA)証明書へのローカル システム上のフル パス。

MCLI_OPS_MANAGER_SKIP_VERIFY
Ops Manager only

trueに設定されている場合、 MCLI_OPS_MANAGER_CA_CERTIFICATE TLS 証明書は検証されません。 これにより、無効な証明書が原因で接続が拒否されるのを防ぎます。

重要: MCLI_OPS_MANAGER_SKIP_VERIFYtrueに設定するのは安全でなく、本番環境では推奨されません。

HTTP_PROXY, http_proxy

hostname[:port]形式の絶対URLまたはホスト名とポート。

次の例は、プロキシ構成で認証が必要ない場合に 環境変数を設定する方法を示しています。

HTTP_PROXY=<my.proxy.address>

次の例は、プロキシ構成で認証が必要な場合に 環境変数を設定する方法を示しています。

HTTP_PROXY=username:password@<my.proxy.address>

次の例は、スキームがsocks5の場合に 環境変数を設定する方法を示しています。

HTTP_PROXY=socks5://<my.proxy.address>

HTTPS_PROXY, https_proxy

絶対URLHTTP_PROXYも設定されている場合、これはすべてのリクエストに対してHTTP_PROXYよりも優先されます。

たとえば、次は 環境変数の設定方法を示しています。

HTTPS_PROXY=https://<my.proxy.address>

NO_PROXY, no_proxy

URL にプロキシが構成されていないため、 URLのプロキシがないと表示されます