---
title: "obshell 代理命令组 - OceanBase 数据库 V4.4.0 | OceanBase 文档中心"
description: "obshell 代理命令组 本文介绍 obshell 的代理命令组，代理命令组可用于管理 obshell。您可通过在命令中配置 -h / --help 选项查看命令的帮助信息。 obshell agent start 使用该命令可启动 obshell。 ${home_path}/bin/obshell agent s…"
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*P8CuR4UJ_FkAAAAAAAAAAAAADiGDAQ/original) OceanBase 数据库分布式版 - V 4.4.0

# obshell 代理命令组

更新时间：2025-08-12 18:27:34

[编辑](https://github.com/oceanbase/oceanbase-doc/edit/V4.4.0/zh-CN/700.reference/1500.Components-and-Tools/100.manage/100.obshell/300.obshell-clients/100.agent-commands.md)  

本文介绍 obshell 的代理命令组，代理命令组可用于管理 obshell。您可通过在命令中配置 `-h`/`--help` 选项查看命令的帮助信息。

## obshell agent start

使用该命令可启动 obshell。

```shell
${home_path}/bin/obshell agent start [--ip] [-P] [--takeover]

# example
/home/admin/oceanbase/bin/obshell agent start --ip 10.10.10.1 -P 2886

```

`home_path` 为 OceanBase 数据库的安装目录，obshell 默认在 OceanBase 数据库安装目录的 `bin` 目录下。

选项说明见下表：

| 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 |
| --- | --- | --- | --- | --- |
| --ip | 否 | string | 无 | 设置该 obshell 绑定到的 IP 地址 |
| -P/--port | 否 | int | 2886 | 设置该 obshell 绑定到的端口号 |
| --takeover | 否 | int | 1 | 设置值为非 0 值时表示接管启动，值设置为 0 时表示非接管启动。默认为 `1`，即表示接管启动 |

## obshell agent stop

使用该命令可停止 obshell。

```shell
${home_path}/bin/obshell agent stop

```

## obshell agent restart

使用该命令可重启 obshell。

```shell
${home_path}/bin/obshell agent restart

```

## obshell agent upgrade

使用该命令可对 obshell 进行升级。

```shell
${home_path}/bin/obshell agent upgrade -d [-V] [-t] [-y]

# example
/home/admin/oceanbase/bin/obshell agent upgrade -d /home/admin/oceanbase/upgrade/ -V 4.2.2.0-20231224224959

```

选项说明见下表：

| 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 |
| --- | --- | --- | --- | --- |
| -d/--pkg_directory | 是 | string | 无 | 设置升级包的存放路径。 |
| -V/--target_version | 否 | string | 无 | 指定目标版本，需要格式正确，例如 `4.2.2.0` 或者 `4.2.2.0-20231224224959`。不指定则选择 `-d` 目录下的最高版本的 obshell RPM 包。 |
| -t/--tmp_directory | 否 | string | ${home_path}/upgrade | 指定升级过程中的临时目录，用于存放下载的安装包及解压安装过程中产生的所有文件。需配置为绝对路径。 |
| -y/--yes | 否 | 无 | 无 | 配置 `-y`/`--yes` 表示取消二次确认，无需传值。 |
| -v/--verbose | 否 | 无 | 无 | 配置 `-v`/`--verbose` 表示输出详细的执行过程信息，无需传值。 |

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线