ssh 命令组

注释

Databricks CLI 的使用须遵守 Databricks 许可和 Databricks 隐私声明,包括任何数据使用规定。

重要

SSH 隧道处于 Beta 阶段。

ssh CLI 中的命令组允许设置和建立与 Databricks 计算和工作区的 SSH 连接。 请参阅 使用 SSH 隧道连接到 Databricks。

Databricks SSH Connect

通过SSH连接你的Azure Databricks计算和工作区。 该命令建立与 Azure Databricks 计算的 SSH 连接,设置 SSH 隧道并处理连接代理。

Tip

在Databricks CLI 1.23.0及以上版本中,无服务器计算和专用集群的会话包含claudecodex并预配置了Unity Gateway的命令。 参见 “在 SSH 会话中运行编码代理”。

databricks ssh connect [flags]

选项

--accelerator string

    连接到 AI 运行时时,GPU 加速器类型。 接受“覆盖”或“跳过”GPU_1xA10GPU_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。 如果省略此选项,SSH 隧道将连接到无服务器计算。

    此标志不能与 --base-environment.

--ide string

    要为会话启动的 IDE。 接受“覆盖”或“跳过”vscodecursor。 若要在终端中启动会话,请省略此标志,然后用于 cd /Workspace/Users/someone@example.com 访问工作区。

--keep-detached-processes

    在工作仍在进行时,保持SSH隧道及任何与会话tmuxsetsidnohup分离的进程,或运行中,均由。--server-timeout 支持无服务器和经典计算。 当分离进程运行时,计算会继续运行,经典集群不会自动终止。 参见 保持分离进程运行。 默认值:false。

--max-clients int

    SSH 客户端的最大数目。 默认值:10。

--name string

    用于跨会话重复使用的连接名称。 仅无服务器计算。

--server-timeout duration

    SSH隧道的最大寿命。 隧道在这段时间后会关闭,即使客户端连接。 如果你不设置此标志,寿命是默认 和 --shutdown-delay中较长的。 如果你设置的, --shutdown-delay 不能超过这个数值。 默认值:24h0m0s。

--shutdown-delay duration

    在最后一个客户端断线后关闭隧道前,先延迟。 默认值:10m0s。

--usage-policy-id string

    无服务器SSH隧道的使用策略ID。 仅限服务器。

全局标志

例子

以下示例连接到无服务器计算:

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 连接。 不需要安装步骤。

databricks ssh setup [flags]

选项

--auto-approve

    重新创建现有 SSH 主机配置时跳过确认提示。 默认值:false。

--auto-start-cluster

    建立 SSH 连接时自动启动群集。 默认值:true。

--cluster string

    专用单用户群集的 Databricks ID。

--keep-detached-processes

    在工作仍在进行时,保持SSH隧道及任何与会话tmuxsetsidnohup分离的进程,或运行中,均由。--server-timeout 仅限经典计算。 无服务器连接不需要设置,所以为了让分离进程在无服务器计算上运行,可以把这个标志传递给 Databrick的ssh connect 。 分离进程运行时,集群不会自动终止。 参见 保持分离进程运行。 生成的SSH主机条目每次连接都会应用这个标志。 默认值:false。

--name string

    要用于 SSH 配置的主机名。

--server-timeout duration

    SSH隧道的最大寿命。 隧道在这段时间后会关闭,即使客户端连接。 如果你不设置此标志,寿命是默认 和 --shutdown-delay中较长的。 如果你设置的, --shutdown-delay 不能超过这个数值。 默认值:24h0m0s。

--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 字符串

    如果适用,要使用的捆绑包目标