---
title: "密码命令组 - 安装部署工具 OBD V3.6.0 | OceanBase 文档中心"
description: 密码命令组 obd 自 V3.2.0 起支持对集群的密码信息进行加密，本文介绍功能相关的命令组。您可以在每条命令中使用 -h / --help 选项查看命令的帮助信息。同样的，当命令执行报错时，您亦可使用 -v / --verbose 查看命令的详细执行过程。 说明 该命令设置是对于 obd 而言的，若开启了密码加密…
---
切换语言

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

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*Qq8pT6yBPTcAAAAAAAAAAAAADiGDAQ/original) 安装部署工具 OBDV 3.6.0

# 密码命令组

更新时间：2025-11-10 09:33:55

[编辑](https://github.com/oceanbase/obd-doc/edit/V3.6.0/zh-CN/300.obd-command/590.pwd-commands.md)  

obd 自 V3.2.0 起支持对集群的密码信息进行加密，本文介绍功能相关的命令组。您可以在每条命令中使用 `-h`/`--help` 选项查看命令的帮助信息。同样的，当命令执行报错时，您亦可使用 `-v`/`--verbose` 查看命令的详细执行过程。

#### 说明

该命令设置是对于 obd 而言的，若开启了密码加密，则 obd 管理的全部集群均开启加密，包括当前全部集群和未来新建集群。

## obd pwd encrypt

使用该命令可开启/关闭密码加密功能。

```shell
obd pwd encrypt [enable | disable]

```

当配置为 `enable` 时表示开启密码加密功能，若之前未设置过通行密钥，开启时需配置通行密钥。若已经通过 `obd pwd set-epk` 命令设置过通行密钥，则需配置已有通行密钥作为验证。开启加密后使用 `obd cluster display` 命令查看集群信息时，输出的集群相关密码为加密状态，需在 `obd cluster display` 命令中添加 `--epk`/`--encryption-passkey` 选项指定通行密钥才可查看集群的密码信息。

配置为 `disable` 时表示关闭密码加密功能，关闭密码加密功能时需设置通行密钥用于验证。可通过选项 `--epk`/`--encryption-passkey` 设置，也可执行命令后根据输出内容对应填写。

### 示例

- 开启密码加密

  ```shell
  obd pwd encrypt enable

  ```

  若之前未设置过通行密钥，执行命令后输出如下：

  ```shell
  First time setting the encryption passkey. please enter the encryption passkey:
  Please enter the encryption passkey again:
  First time setting the encryption passkey successful!
  Encrypt password ok
  Trace ID: b96a5f82-0ec2-11f0-8b44-00163e49899d
  If you want to view detailed obd logs, please run: obd display-trace b96a5f82-0ec2-11f0-8b44-00163e49899d

  ```

  开启密码加密后执行 `obd cluster display` 命令查看集群信息时，输出如下所示，`-p` 选项后的密码均为加密状态。

  ```shell
  +-------------------------------------------------+
  |                 oceanbase-ce                    |
  +---------------+---------+------+-------+--------+
  | ip            | version | port | zone  | status |
  +---------------+---------+------+-------+--------+
  | 10.10.10.1    | 4.3.5.0 | 2881 | zone1 | ACTIVE |
  +---------------+---------+------+-------+--------+
  obclient -h10.10.10.1 -P2881 -uroot -p'********' -Doceanbase -A

  +----------------------------------------------------------------+
  |                           obproxy-ce                           |
  +------------+------+-----------------+-----------------+--------+
  | ip         | port | prometheus_port | rpc_listen_port | status |
  +------------+------+-----------------+-----------------+--------+
  | 10.10.10.2 | 2883 | 2884            | 2885            | active |
  +------------+------+-----------------+-----------------+--------+
  obclient -h10.10.10.2 -P2883 -uroot@proxysys -p'********' -Doceanbase -A

  ```
 - 关闭密码加密

  ```shell
  obd pwd encrypt disable --epk=******

  ```

## obd pwd set-epk

使用该命令可设置或修改通行密钥。

```shell
obd pwd set-epk <new decryption passkey>

```

选项说明见下表：

| 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 |
| --- | --- | --- | --- | --- |
| -c/--current-passkey | 否 | string | 无 | 若 obd 已设置过通行密钥，该选项为必选项，需使用该选项配置已设置的通行密钥作为验证。 |
| -f/--force | 否 | bool | 不涉及 | 若您忘记已设置的通行密钥，可在命令中添加 `-f`/`--force` 选项强制修改通行密钥，强制修改时需输入拥有 sudo 权限的用户及密码。 |

### 示例

- 设置通行密钥

  ```shell
  obd pwd set-epk 12345

  ```

  此处以设置通行密钥为 `12345` 为例，输出如下表示已成功设置通行密钥，设置后若执行 `obd pwd encrypt enable` 开启密码加密需指定此处设置的通行密钥用于验证。
 - 修改通行密钥

  ```shell
  obd pwd set-epk 123 -c 12345

  ```

  此处以原通行密钥为 `12345`，修改此通行密钥为 `123` 为例，输出如下表示已成功修改通行密钥。

  ```shell
  Check encryption passkey.
  Update encryption passkey successful.
  Trace ID: fb5e2608-0ec2-11f0-a28b-00163e49899d
  If you want to view detailed obd logs, please run: obd display-trace fb5e2608-0ec2-11f0-a28b-00163e49899d

  ```
 - 强制修改通行密钥

  ```shell
  obd pwd set-epk 123 -f

  ```

  此处以强制将通行密钥修改为 `123` 为例，输出如下：

  ```shell
  Please input username with sudo privileges. (default: root):
  please input root password:
  Update encryption passkey successful.
  Trace ID: 4f3d41f0-0ec3-11f0-919b-00163e49899d
  If you want to view detailed obd logs, please run: obd display-trace 4f3d41f0-0ec3-11f0-919b-00163e49899d

  ```

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