---
title: "OCP-Agent 运维工具 | OceanBase 文档中心"
description: OCP-Agent 运维工具 为方便用户对 OCP-Agent 进行安装、启动、停止、卸载等操作，OCP 3.2.0 版本在 OCP-Agent 的软件包中内置了 OCP-Agent 的运维工具 ocp_agentctl。完成 OCP-Agent 的软件包安装后，您只需使用简单的命令即可对 OCP-Agent 进行操…
---
切换语言

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

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*lJTmRZ61jSUAAAAAAAAAAAAADiGDAQ/original) 云平台 OCPV 4.0.3 企业版

# OCP-Agent 运维工具

更新时间：2023-08-10 11:45:58

为方便用户对 OCP-Agent 进行安装、启动、停止、卸载等操作，OCP 3.2.0 版本在 OCP-Agent 的软件包中内置了 OCP-Agent 的运维工具 ocp_agentctl。完成 OCP-Agent 的软件包安装后，您只需使用简单的命令即可对 OCP-Agent 进行操作。

## 使用环境

当 OCP-Agent 的软件包安装后，`ocp_agentctl`将存在于 OCP-Agent 目录：`/home/admin/ocp_agent/bin`。

`ocp_agentctl`是一个可执行文件，通过命令行的方式对OCP-Agent进行运维与管理。可以直接在`/home/admin/ocp_agent/bin`目录下执行 `ocp_agentctl`。

#### 说明

- `ocp_agentctl`执行的日志将输出到`/home/admin/ocp_agent/log`目录下的`agentctl.log`文件。
 - 此文件仅可用于本机 OCP-Agent 的运维，暂不支持远程运维。

## 命令行格式

```javascript
ocp_agentctl [COMMAND] [OPTIONS]

```

- COMMAND 为执行的操作命令，如启动（start）或停止（stop）等。
 - OPTIONS为操作的附加选项，如：

     - --help：也可简写为"-h",查询使用帮助。

## 使用样例

### 查询使用帮助

- 查看使用帮助

  ```python
  ./ocp_agentctl -h

  ```

  系统返回该工具的使用方法，支持的操作命令。
 - 查看具体命令的使用帮助

  ```python
  ./ocp_agentctl config -h

  ```

  系统返回 config 命令的使用方法，及可使用的对象与命令。

### 启动 OCP-Agent

```python
./ocp_agentctl start

```

成功执行后，ocp_agentd、ocp_monagent、ocp_mgragent 将一并启动。

### 停止 OCP-Agent

```python
./ocp_agentctl stop

```

成功执行后，ocp_agentd、ocp_monagent、ocp_mgragent 将停止，同时主机状态将为离线，会导致 OCP 监控指标与sql诊断数据缺失，以及 OB 日志告警不可用。

### 重启 OCP-Agent

```python
./ocp_agentctl restart

```

### 查看 OCP-Agent 安装信息

```python
./ocp_agentctl info

```

系统将返回 ocp-agent 的名称、版本、架构、描述等信息。

 上一篇 下一篇 ![有帮助](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) 咨询热线