注
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
Important
Databricks SSH Tunnel は ベータ版です。
ssh 内の コマンド グループを使用すると、Databricks コンピューティングとワークスペースへの SSH 接続を設定して確立できます。
SSH トンネルを使用した Databricks への接続を参照してください。
databricks ssh connect
SSH 経由で Databricks コンピューティングとワークスペースに接続します。 このコマンドは、Databricks コンピューティングへの SSH 接続を確立し、SSH サーバーを設定し、接続プロキシを処理します。
databricks ssh connect [flags]
オプション
--accelerator string
AI ランタイムに接続するときの GPU アクセラレータの種類。
GPU_1xA10 または GPU_8xH100 を指定できます。
--auto-approve
IDE 拡張機能をインストールし、IDE 設定を適用するときに、確認プロンプトをスキップします。 既定値: false。
--auto-start-cluster
クラスターが実行されていない場合は、自動的に起動します。 既定値: true。
--base-environment string
サーバーレス コンピューティングに接続するときに、Python依存関係を事前に構成するためのワークスペースの基本環境。 サーバーレス環境バージョン 4 以降でサポートされています。サーバーレス環境バージョン 5 はサポートされていません。 次のいずれかの形式を受け入れます。
- 表示名 (例:
my-workspace-env - YAML ファイル パス (例:
/Workspace/path/to/env.yaml - リソース ID (例:
workspace-base-environments/dbe_123
このフラグを --clusterと組み合わせることはできません。
--cluster string
専用のシングル ユーザー クラスターの Databricks ID。 このオプションを省略すると、Databricks SSH Tunnel はサーバーレス コンピューティングに接続します。
このフラグを --base-environmentと組み合わせることはできません。
--ide string
セッション用に起動する IDE。
vscode または cursor を指定できます。 ターミナルでセッションを開始するには、このフラグを省略し、 cd /Workspace/Users/someone@example.com を使用してワークスペースにアクセスします。
--max-clients int
SSH クライアントの最大数。 既定値: 10。
--name string
セッション間で再利用する接続名。 サーバーレス コンピューティングのみ。
--shutdown-delay duration
最後のクライアントの切断後にサーバーをシャットダウンするまでの遅延。 既定値: 10m0s。
例示
次の例では、サーバーレス コンピューティングに接続します。
databricks ssh connect
次の例では、GPU アクセラレータを使用して AI ランタイムのサーバーレス コンピューティングに接続します。
databricks ssh connect --accelerator GPU_1xA10
次の例では、Python依存関係が事前に構成されているワークスペース基本環境を使用して、サーバーレス コンピューティングに接続します。
databricks ssh connect --base-environment my-workspace-env
次の例では、専用クラスターに接続します。
databricks ssh connect --cluster 0123-456789-abcdefgh
次の例では、特定のプロファイルを使用してクラスターに接続します。
databricks ssh connect --cluster 0123-456789-abcdefgh --profile my-profile
次の例では、カスタムのシャットダウン遅延を設定します。
databricks ssh connect --cluster 0123-456789-abcdefgh --shutdown-delay 30m
databricks ssh のセットアップ
クラシック コンピューティングへの接続用に SSH 構成を設定します。 専用 (シングル ユーザー) クラスターへの接続のみがサポートされます。 このコマンドは、SSH ホスト構成を SSH 構成ファイルに追加します。 セットアップを実行した後、 ssh <name>に接続できます。
サーバーレス接続の場合は、 databricks ssh connect を使用します。 セットアップ手順は必要ありません。
databricks ssh setup [flags]
オプション
--auto-approve
既存の SSH ホスト構成を再作成するときに、確認プロンプトをスキップします。 既定値: false。
--auto-start-cluster
SSH 接続を確立するときにクラスターを自動的に起動します。 既定値: true。
--cluster string
専用のシングル ユーザー クラスターの Databricks ID。
--name string
SSH 構成で使用するホスト名。
--shutdown-delay duration
アクティブな接続がない場合、SSH サーバーはこの遅延後に終了します。 既定値: 10m0s。
--ssh-config string
SSH 構成ファイルへのパス。 既定値: ~/.ssh/config。
例示
次の例では、クラスターの SSH 構成を設定します。
databricks ssh setup --name my-cluster --cluster 0123-456789-abcdefgh
セットアップを実行した後、標準の SSH クライアントを使用して接続できます。
ssh my-cluster
グローバル フラグ
--debug
デバッグ ログを有効にするかどうかを指定します。
-h または --help
Databricks CLI、または関連コマンド グループ、または関連コマンドのヘルプの表示。
--log-file 文字列
出力ログを書き込むファイルを表す文字列。 このフラグが指定されていない場合、既定では stderr に出力ログが書き込まれます。
--log-format 形式
ログ形式の種類、 text 、または json。 既定値は text です。
--log-level 文字列
ログ形式レベルを表す文字列。 指定しない場合、ログ形式レベルは無効になります。
-o, --output 型
コマンド出力の種類( text または json)。 既定値は text です。
-p, --profile 文字列
コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。 このフラグが指定されていない場合は、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。
--progress-format 形式
進行状況ログを表示する形式: default、 append、 inplace、または json
-t, --target 文字列
該当する場合は、使用するバンドル ターゲット