> For the complete documentation index, see [llms.txt](https://help.ppgg.in/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.ppgg.in/docs/miscellaneous/migration-script.md).

# 迁移脚本

{% hint style="success" %}
对应的[官方文档地址](https://bitwarden.com/help/migration-script/)
{% endhint %}

[Bitwarden 公共 API](/docs/admin-console/bitwarden-public-api.md) 允许管理员使用脚本自动执行管理任务。本文所描述的脚本是为了帮助 Bitwarden 客户将现有的设置从之前的 Bitwarden Password Manager 环境迁移到新的组织而编写的，提供了一种将组织密码库数据、群组以及相关联的群组和成员的权限迁移到新安装的方法。

该脚本使用 Python 编写，可以在任何安装了 Python v3 的操作系统上运行。在[此处](https://github.com/bitwarden-labs/admin-scripts/tree/main/Python/admin-tools)下载脚本和示例配置文件。

## 安装和设置 <a href="#installation-and-setup" id="installation-and-setup"></a>

### 系统要求 <a href="#system-requirements" id="system-requirements"></a>

除了大多数 Python 发行版附带的默认库（Linux 和 macOS 上默认包含，Windows 也[可用](https://www.python.org/downloads/windows/)）之外，此脚本还需要安装一个名为 `requests` 的附加模块，然后才能成功运行该脚本。

安装 Python 模块的常用工具称为 pip。要使用 pip 安装此模块：

```shellscript
pip3 install requests
```

{% hint style="info" %}
`pip3` - 有些机器会安装多个版本的 Python。使用 `pip3`（而不仅仅是 `pip`）指定您使用 Python v3 安装 `requests`。如果您的计算机仅安装了一个 Python 版本，请改用 `pip`。
{% endhint %}

### 所需文件 <a href="#required-files" id="required-files"></a>

上述下载包含两个文件：

* `bwAdminTools.py`：这是执行迁移所需的脚本。它需要一个完整配置的配置文件。
* `config-example.cfg`：这是迁移所需的配置文件，您需要在运行脚本之前创建和设置该文件。

解压 `.zip` 并将这些文件保存到同一目录中。完成后，将以下文件添加到同一目录：

* Bitwarden Password Manager [CLI 原生可执行文件](/docs/password-manager/developer-tools/cli/password-manager-cli.md#download-and-install)。

### 创建目标组织 <a href="#create-destination-organization" id="create-destination-organization"></a>

在继续之前，您必须创建要迁移到的目标组织。[了解如何创建组织](/docs/admin-console/organizations-overview.md#create-an-organization)。

{% hint style="info" %}
我们建议在运行迁移脚本前邀请用户。用户必须至少处于被邀请状态，才能迁移群组和权限设置。
{% endhint %}

### 使用自托管实例迁移 <a href="#migrate-with-self-hosted-instance" id="migrate-with-self-hosted-instance"></a>

如果您的组织许可证来自 US 云服务器，并且使用 US 云凭据启用了自托管实例，则需要执行以下步骤才能将自托管实例和组织凭据迁移到 EU：

1、指示所有组织成员[导出他们的个人密码库](/docs/password-manager/import-and-export/export-vault-data.md#export-a-personal-vault)。

{% hint style="success" %}
请单独下载密码库项目的文件附件，并注意它们属于哪个项目。
{% endhint %}

2、[申请新的安装 ID 和密钥](https://bitwarden.com/host/)。确保将**数据区域**设置为您希望将 Bitwarden 实例迁移到的目的地。

3、访问自托管实例上的 `./bwdata/env/global.override.env` 文件。按照[这里](/docs/security/server-geographies.md#connect-your-self-hosted-server)的示例更新环境变量。

4、登录并访问云端组织，使用新的 EU 或 US 安装 ID 下载新的订阅许可证文件。

5、在自托管实例上创建一个新的组织。手动将新的订阅许可证文件应用到新创建的组织。订阅许可证**无法应用到自托管实例上的现有组织**。

6、设置新组织，配置企业策略、SSO 登录、构建群组 - 集合关系以及使用 Directory Connector 或 SCIM 邀请用户等。如需帮助，请参阅[概念验证清单](/docs/admin-console/more/proof-of-concept-project-checklist.md)。

7、指导组织成员导入他们的个人密码库。

### 环境配置 <a href="#environment-configuration" id="environment-configuration"></a>

在运行任何 `bwAdminTools.py` [脚本函数](#script-functions)之前，您需要创建一个配置文件。将 `config-example.cfg` 的内容复制到同一目录中的新 `config.cfg` 文件中，并填写以下变量。请注意，由于这是迁移脚本，因此本文档中的变量分为**源**和**目标**两部分：

| 源组织变量                    | 变量描述                                                                                                                               |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------- |
| bw\_vault\_uri=          | 您的来源网页密码库的 FQDN，例如如果您是自托管，为 `https://company.bitwarden.com`；如果您使用的是美国区域的 Bitwarden 云服务，则为 `https://vault.bitwarden.com`。           |
| bw\_org\_client\_id=     | 源组织 API 密钥客户端 ID。[了解在哪里可以找到它](/docs/admin-console/bitwarden-public-api.md#authentication)。                                         |
| bw\_org\_client\_secret= | 源组织 API 密钥客户端机密。[了解在哪里可以找到它](/docs/admin-console/bitwarden-public-api.md#authentication)。                                          |
| bw\_org\_id=             | 源组织的 GUID。复制 `_client_id=` 值并删除 `organization.` 块。                                                                                 |
| bw\_acc\_client\_id      | 源组织管理员或所有者的个人 API 密钥客户端 ID。[了解在哪里可以找到它](/docs/password-manager/developer-tools/cli/personal-api-key.md#get-your-personal-api-key)。 |
| bw\_acc\_client\_secret= | 源组织管理员或所有者的个人 API 密钥客户端机密。[了解在哪里可以找到它](/docs/password-manager/developer-tools/cli/personal-api-key.md#get-your-personal-api-key)。  |

| 目标组织变量                         | 变量描述                                                                                                                                |
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------- |
| dest\_bw\_vault\_uri=          | 您的目标网页密码库的 FQDN，例如如果您是自托管，为 `https://company.bitwarden.com`；如果您使用的是欧盟区域的 Bitwarden 云服务，则为 `https://vault.bitwarden.eu`。             |
| dest\_bw\_org\_client\_id=     | 目标组织 API 密钥客户端 ID。[了解在哪里可以找到它](/docs/admin-console/bitwarden-public-api.md#authentication)。                                         |
| dest\_bw\_org\_client\_secret= | 目标组织 API 密钥客户端机密。[了解在哪里可以找到它](/docs/admin-console/bitwarden-public-api.md#authentication)。                                          |
| dest\_bw\_org\_id=             | 目标组织的 GUID。复制 `_client_id=` 值并删除 `organization.` 块。                                                                                 |
| dest\_bw\_acc\_client\_id=     | 目标组织管理员或所有者的个人 API 密钥客户端 ID。[了解在哪里可以找到它](/docs/password-manager/developer-tools/cli/personal-api-key.md#get-your-personal-api-key)。 |
| dest\_bw\_ac\_client\_secret=  | 目标组织管理员或所有者的个人 API 密钥客户端机密。[了解在哪里可以找到它](/docs/password-manager/developer-tools/cli/personal-api-key.md#get-your-personal-api-key)。  |

设置好这些变量后，就可以使用 `bwAdminTools.py` [脚本功能](#script-functions)开始迁移了。

## 脚本功能 <a href="#script-functions" id="script-functions"></a>

从存储 `bwAdminTools.py` 文件、`config.cfg` 文件和 Password Manager CLI 可执行文件的目录中，您可以运行以下命令：

{% hint style="info" %}
`python3` - 有些机器会安装多个版本的 Python。使用 `python3`（而不仅仅是 `python`）指定命令使用 Python v3 运行。如果您的计算机仅安装了一个 Python 版本，请改用 `python`。某些发行版还将提供 `python` 而不是 v3 的 `python3` 二进制文件。
{% endhint %}

* 要显示脚本帮助文本：

```shellscript
python3 bwAdminTools.py -h
```

* 要比较源组织和目标组织：

```shellscript
python3 bwAdminTools.py -c diffbw
```

* 要将组织库数据、群组和群组权限从源组织迁移到目标组织：

```shellscript
python3 bwAdminTools.py -c migratebw
```

* 要将成员的权限（群组以外的）从源组织迁移到目标组织：

```shellscript
python3 bwAdminTools.py -c migratebwusers
```

* 要从源组织中删除所有集合：

```shellscript
python3 bwAdminTools.py -c purgecol
```

* 要从目标组织中删除所有集合：

```shellscript
python3 bwAdminTools.py -c purgecoldest
```

* 要从源组织中删除所有群组：

```shellscript
python3 bwAdminTools.py -c purgegroup
```

* 要从目标组织中删除所有群组：

```shellscript
python3 bwAdminTools.py -c purgegroupdest
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.ppgg.in/docs/miscellaneous/migration-script.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.