---
title: "oatcli | OceanBase 文档中心"
description: "oatcli oatcli 是管理 OAT 资源的命令行工具。使用方法如下： $ oatcli [OPTIONS] COMMAND [ARGS]... 选项说明 ： --install-completion ：为当前 shell 设置命令补全（暂不可用）。 --show-completion ：显示当前 shell …"
---
切换语言

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

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*jLd4SamEcM0AAAAAAAAAAAAADiGDAQ/original) 管理者工具 OATV 4.1.1 企业版

# oatcli

更新时间：2023-06-14 11:11:46

oatcli 是管理 OAT 资源的命令行工具。使用方法如下：

```bash
$ oatcli [OPTIONS] COMMAND [ARGS]...

```

**选项说明**：

- `--install-completion`：为当前 shell 设置命令补全（暂不可用）。
 - `--show-completion`：显示当前 shell 的命令补全脚本，以便将其复制或进行自定义安装。
 - `--help`：显示此消息并退出。

**命令说明**：

- `config`：配置 OAT API 服务器地址、用户名等。
 - `create`：在 OAT 中创建资源。
 - `dagrun`：在 OAT 中操作 dagrun 和任务状态。
 - `delete`：在 OAT 中删除资源。
 - `describe`：在 OAT 中获取资源详细信息。
 - `get`：在 OAT 中获取资源信息。

## `oatcli config`

配置 OAT API 服务器地址、用户名和密码。

**使用方法**：

```bash
$ oatcli config [OPTIONS] COMMAND [ARGS]...

```

**选项说明**：

- `--help`：显示此消息并退出。

**命令说明**：

- `get`：获取请求 OAT API 的配置。
 - `set`：设置 OAT API 地址、用户名和密码。

### `oatcli config get`

获取请求 OAT API 的配置。

**使用方法**：

```bash
$ oatcli config get [OPTIONS]

```

**选项说明**：

### `oatcli config set`

设置 OAT API 地址、用户名和密码。

**使用方法**：

```bash
$ oatcli config set [OPTIONS]

```

**选项说明**：

- `-s, --api-server TEXT`：api_server，例如：127.0.0.1:7000。
 - `-u, --username TEXT`：用户名。
 - `-p, --password TEXT`：密码。
 - `--help`：显示此消息并退出。

## `oatcli create`

在 OAT 中创建资源。

**使用方法**：

```bash
$ oatcli create [OPTIONS] COMMAND [ARGS]...

```

**选项说明**：

**命令说明**：

- `component`：使用配置文件创建新组件。
 - `credential`：为服务器连接添加 SSH 凭证。
 - `idc`：为服务器添加机房信息。
 - `image`：添加组件/产品镜像，可扫描本地镜像，也可手动添加镜像信息。
 - `product`：使用配置文件创建新产品。
 - `server`：添加并初始化新服务器。

### `oatcli create component`

使用配置文件创建新组件。

**使用方法**：

```bash
$ oatcli create component [OPTIONS]

```

**选项说明**：

- `-t, --type [metadb]`：组件类型，目前仅支持 metadb [必需]。
 - `-f, --file PATH`：通过配置文件创建组件。
 - `--help`：显示此消息并退出。

### `oatcli create credential`

为服务器连接添加 SSH 凭证。

**使用方法**：

```bash
$ oatcli create credential [OPTIONS] NAME AUTH_TYPE:{password|pubkey|external}

```

**参数说明**：

- `NAME`：凭证标识名称 [必需]。
 - `AUTH_TYPE:{password|pubkey|external}`：[必需]。

**选项说明**：

- `-u, --username TEXT`：[默认值：root]。
 - `-p, --password TEXT`：密码。
 - `-k, --key-file PATH`：SSH 私钥文件。
 - `--help`：显示此消息并退出。

### `oatcli create idc`

为服务器添加机房信息

**使用方法**：

```bash
$ oatcli create idc [OPTIONS] NAME REGION

```

**参数说明**：

- `NAME`：机房名称 [必需]。
 - `REGION`：机房所在地域 [必需]。

**选项说明**：

### `oatcli create image`

添加组件/产品镜像，可扫描本地镜像，也可手动添加镜像信息。

**使用方法**：

```bash
$ oatcli create image [OPTIONS]

```

**选项说明**：

- `-n, --name TEXT`：远程镜像标识名称。
 - `-r, --repo-tag TEXT`：远程镜像 repo:tag 信息。
 - `-a, --arch [x86_64|aarch64]`：远程镜像架构。
 - `--scan / --no-scan`：扫描本地镜像 [默认值：no-scan]。
 - `--help`：显示此消息并退出。

### `oatcli create product`

使用配置文件创建新产品。

**使用方法**：

```bash
$ oatcli create product [OPTIONS]

```

**选项说明**：

- `-t, --type [ocp]`：产品类型，目前仅支持 ocp [必需]。
 - `-f, --file PATH`：通过配置文件创建产品。
 - `--help`：显示此消息并退出。

### `oatcli create server`

添加并初始化新服务器。

**使用方法**：

```bash
$ oatcli create server [OPTIONS] IPS... INIT_TAG:{observer|obproduct|both}

```

**参数说明**：

- `IPS...`：服务器 IP [必需]。
 - `INIT_TAG:{observer|obproduct|both}`：[必需]。

**选项说明**：

- `-i, --idc TEXT`：机房名称:地域，必须已经存在 [必需]。
 - `-c, --credential-name TEXT`：凭证名称，必须已经存在 [必需]。
 - `--add-only / --no-add-only`：仅添加服务器，不执行操作系统配置操作 [默认值：no-add-only]。
 - `--ssh-port INTEGER`：SSH 端口 [默认值：22]。
 - `--docker-root-dir TEXT`：[默认路径：/docker]。
 - `--admin-uid-gid TEXT`：[默认值：500:500]。
 - `--admin-password TEXT`：密码。
 - `--help`：显示此消息并退出。

## `oatcli dagrun`

在 OAT 中操作 dagrun 和任务状态。

**使用方法**：

```bash
$ oatcli dagrun [OPTIONS] COMMAND [ARGS]...

```

**选项说明**：

**命令说明**：

- `retry`：重试 dagrun 中失败的任务。
 - `rollback`：中止并回滚 dagrun。
 - `skip`：跳过 dagrun 中失败的任务。

### `oatcli dagrun retry`

重试 dagrun 中失败的任务。

**使用方法**：

```bash
$ oatcli dagrun retry [OPTIONS] DAGRUN_ID [TASK_ID]

```

**参数说明**：

- `DAGRUN_ID`：dagrun ID [必需]。
 - `[TASK_ID]`：任务 ID，如果为空，将重试所有失败的任务。

**选项说明**：

### `oatcli dagrun rollback`

中止并回滚 dagrun。

**使用方法**：

```bash
$ oatcli dagrun rollback [OPTIONS] DAGRUN_ID

```

**参数说明**：

- `DAGRUN_ID`：dagrun ID [必需]。

**选项说明**：

### `oatcli dagrun skip`

跳过 dagrun 中失败的任务。

**使用方法**：

```bash
$ oatcli dagrun skip [OPTIONS] DAGRUN_ID [TASK_ID]

```

**参数说明**：

- `DAGRUN_ID`：dagrun ID [必需]。
 - `[TASK_ID]`：任务 ID。

**选项说明**：

## `oatcli delete`

在 OAT 中删除资源。

**使用方法**：

```bash
$ oatcli delete [OPTIONS] COMMAND [ARGS]...

```

**选项说明**：

**命令说明**：

- `component`：删除组件。
 - `credential`：删除凭证。
 - `image`：删除镜像。
 - `product`：删除产品。
 - `server`：删除服务器。

### `oatcli delete component`

删除组件。

**使用方法**：

```bash
$ oatcli delete component [OPTIONS] NAME

```

**参数说明**：

- `NAME`：组件名称 [必需]。

**选项说明**：

### `oatcli delete credential`

**使用方法**：

```bash
$ oatcli delete credential [OPTIONS] NAME

```

**参数说明**：

- `NAME`：凭证名称 [必需]。

**选项说明**：

### `oatcli delete image`

删除镜像。

**使用方法**：

```bash
$ oatcli delete image [OPTIONS] NAME

```

**参数说明**：

- `NAME`：镜像名称 [必需]。

**选项说明**：

### `oatcli delete product`

删除产品。

**使用方法**：

```bash
$ oatcli delete product [OPTIONS] NAME

```

**参数说明**：

- `NAME`：产品名称 [必需]。

**选项说明**：

### `oatcli delete server`

删除服务器。

**使用方法**：

```bash
$ oatcli delete server [OPTIONS] IP

```

**参数说明**：

- `IP`：服务器 IP [必需]。

**选项说明**：

## `oatcli describe`

在 OAT 中获取资源详细信息。

**使用方法**：

```bash
$ oatcli describe [OPTIONS] COMMAND [ARGS]...

```

**选项说明**：

**命令说明**：

- `component`：获取组件详细信息和相关的 dagrun 信息。
 - `product`：获取产品详细信息和相关的 dagrun 信息。
 - `server`：获取服务器详细信息和相关的 dagrun 信息。

### `oatcli describe component`

获取组件详细信息和相关的 dagrun 信息。

**使用方法**：

```bash
$ oatcli describe component [OPTIONS] NAME

```

**参数说明**：

- `NAME`：具体组件名称 [必需]。

**选项说明**：

### `oatcli describe product`

获取产品详细信息和相关的 dagrun 信息。

**使用方法**：

```bash
$ oatcli describe product [OPTIONS] NAME

```

**参数说明**：

- `NAME`：具体产品名称 [必需]。

**选项说明**：

### `oatcli describe server`

获取服务器详细信息和相关的 dagrun 信息。

**使用方法**：

```bash
$ oatcli describe server [OPTIONS] IP

```

**参数说明**：

- `IP`：具体服务器 IP [必需]。

**选项说明**：

## `oatcli get`

在 OAT 中获取资源信息。

**使用方法**：

```bash
$ oatcli get [OPTIONS] COMMAND [ARGS]...

```

**选项说明**：

**命令说明**：

- `component`：获取组件信息。
 - `credential`：获取凭证信息。
 - `idc`：获取机房信息。
 - `image`：获取镜像信息。
 - `product`：获取产品信息。
 - `server`：获取服务器信息。

### `oatcli get component`

获取组件信息。

**使用方法**：

```bash
$ oatcli get component [OPTIONS] [NAME]

```

**参数说明**：

- `[NAME]`：具体组件名称。

**选项说明**：

- `-q, --query-params TEXT`：通用查询参数 json。
 - `--help`：显示此消息并退出。

### `oatcli get credential`

获取凭证信息。

**使用方法**：

```bash
$ oatcli get credential [OPTIONS] [NAME]

```

**参数说明**：

- `[NAME]`：具体凭证名称。

**选项说明**：

### `oatcli get idc`

获取机房信息。

**使用方法**：

```bash
$ oatcli get idc [OPTIONS] [NAME]

```

**参数说明**：

- `[NAME]`：具体机房名称。

**选项说明**：

### `oatcli get image`

获取镜像信息。

**使用方法**：

```bash
$ oatcli get image [OPTIONS] [NAME]

```

**参数说明**：

- `[NAME]`：具体镜像名称。

**选项说明**：

### `oatcli get product`

获取产品信息。

**使用方法**：

```bash
$ oatcli get product [OPTIONS] [NAME]

```

**参数说明**：

- `[NAME]`：具体产品名称。

**选项说明**：

### `oatcli get server`

获取服务器信息。

**使用方法**：

```bash
$ oatcli get server [OPTIONS] [IP]

```

**参数说明**：

- `[IP]`：具体服务器 IP。

**选项说明**：

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