该 vmmigration1 命令行界面（CLI）允许您从终端舒适地使用Google VM迁移服务的大部分功能。

默认情况下，所有输出都打印到标准输出，但可以通过设置标志将其直接导向文件，而与您的shell功能无关。错误将打印到标准错误，并导致程序退出码为非零。

如果请求数据结构，这些将作为格式化的JSON返回，以便作为其他工具的输入。

有关VM迁移服务API的更多信息，请参阅官方文档网站。

安装和源代码

使用cargo安装命令行界面：

cargo install google-vmmigration1-cli

在github上找到源代码。

用法

本文档是根据版本号20240222的VM迁移服务API生成的。CLI版本为5.0.4。

vmmigration1 [options]
        projects
                locations-get <name> [-p <v>]... [-o <out>]
                locations-groups-add-group-migration <group> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-groups-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-groups-delete <name> [-p <v>]... [-o <out>]
                locations-groups-get <name> [-p <v>]... [-o <out>]
                locations-groups-list <parent> [-p <v>]... [-o <out>]
                locations-groups-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-groups-remove-group-migration <group> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-image-imports-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-image-imports-delete <name> [-p <v>]... [-o <out>]
                locations-image-imports-get <name> [-p <v>]... [-o <out>]
                locations-image-imports-image-import-jobs-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-image-imports-image-import-jobs-get <name> [-p <v>]... [-o <out>]
                locations-image-imports-image-import-jobs-list <parent> [-p <v>]... [-o <out>]
                locations-image-imports-list <parent> [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-operations-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-operations-delete <name> [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-operations-list <name> [-p <v>]... [-o <out>]
                locations-sources-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-sources-datacenter-connectors-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-sources-datacenter-connectors-delete <name> [-p <v>]... [-o <out>]
                locations-sources-datacenter-connectors-get <name> [-p <v>]... [-o <out>]
                locations-sources-datacenter-connectors-list <parent> [-p <v>]... [-o <out>]
                locations-sources-datacenter-connectors-upgrade-appliance <datacenter-connector> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-sources-delete <name> [-p <v>]... [-o <out>]
                locations-sources-fetch-inventory <source> [-p <v>]... [-o <out>]
                locations-sources-get <name> [-p <v>]... [-o <out>]
                locations-sources-list <parent> [-p <v>]... [-o <out>]
                locations-sources-migrating-vms-clone-jobs-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-sources-migrating-vms-clone-jobs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-sources-migrating-vms-clone-jobs-get <name> [-p <v>]... [-o <out>]
                locations-sources-migrating-vms-clone-jobs-list <parent> [-p <v>]... [-o <out>]
                locations-sources-migrating-vms-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-sources-migrating-vms-cutover-jobs-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-sources-migrating-vms-cutover-jobs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-sources-migrating-vms-cutover-jobs-get <name> [-p <v>]... [-o <out>]
                locations-sources-migrating-vms-cutover-jobs-list <parent> [-p <v>]... [-o <out>]
                locations-sources-migrating-vms-delete <name> [-p <v>]... [-o <out>]
                locations-sources-migrating-vms-finalize-migration <migrating-vm> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-sources-migrating-vms-get <name> [-p <v>]... [-o <out>]
                locations-sources-migrating-vms-list <parent> [-p <v>]... [-o <out>]
                locations-sources-migrating-vms-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-sources-migrating-vms-pause-migration <migrating-vm> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-sources-migrating-vms-replication-cycles-get <name> [-p <v>]... [-o <out>]
                locations-sources-migrating-vms-replication-cycles-list <parent> [-p <v>]... [-o <out>]
                locations-sources-migrating-vms-resume-migration <migrating-vm> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-sources-migrating-vms-start-migration <migrating-vm> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-sources-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-sources-utilization-reports-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-sources-utilization-reports-delete <name> [-p <v>]... [-o <out>]
                locations-sources-utilization-reports-get <name> [-p <v>]... [-o <out>]
                locations-sources-utilization-reports-list <parent> [-p <v>]... [-o <out>]
                locations-target-projects-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-target-projects-delete <name> [-p <v>]... [-o <out>]
                locations-target-projects-get <name> [-p <v>]... [-o <out>]
                locations-target-projects-list <parent> [-p <v>]... [-o <out>]
                locations-target-projects-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
  vmmigration1 --help

Configuration:
  [--scope <url>]...
            Specify the authentication a method should be executed in. Each scope
            requires the user to grant this application permission to use it.
            If unset, it defaults to the shortest scope url for a particular method.
  --config-dir <folder>
            A directory into which we will store our persistent data. Defaults to
            a user-writable directory that we will create during the first invocation.
            [default: ~/.google-service-cli]

配置

程序将所有持久数据存储在~/.google-service-cli目录中的JSON文件中，文件名以vmmigration1开头。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

以下段落提供了有关各种持久数据的更多信息。

身份验证

大多数API需要用户对请求进行身份验证。如果是这种情况，则作用域确定授予的权限集。这些通常是只读或完全访问。

如果没有设置，系统将自动选择最小的可行作用域，例如，在调用只读方法时，它将只请求只读作用域。您可以使用--scope标志直接指定作用域。所有适用的作用域均在各自方法的CLI文档中进行了记录。

首次使用作用域时，会要求用户授权。按照CLI给出的说明进行授权或拒绝。

如果用户认证了某个作用域，相应的信息将以JSON格式存储在配置目录中，例如~/.google-service-cli/vmmigration1-token-<scope-hash>.json。无需手动管理这些令牌。

要撤销授权的认证，请参阅官方文档。

应用程序密钥

为了允许任何应用程序使用Google服务，它需要使用Google开发者控制台进行注册。应用程序可能使用的API将逐个启用。大多数API可以免费使用，并有限额。

为了在不强制用户注册自己的应用程序的情况下更方便地使用CLI，CLI自带了一个默认的应用程序密钥，并根据需要进行配置。这也意味着全球范围内的重用可能会耗尽每日配额。

您可以通过在此位置放置自己的密钥文件来解决这个问题：~/.google-service-cli/vmmigration1-secret.json，假设已经为它启用了所需的vmmigration API。这样的密钥文件可以在Google开发者控制台中在APIs & auth -> Credentials -> Download JSON下下载，并直接使用。

有关如何设置Google项目和启用API的更多信息，请参阅官方文档。

调试

尽管CLI尽可能提供可用的错误消息，但有时了解导致特定问题的确切原因可能很有用。这是通过允许所有客户端-服务器通信以原始形式输出到标准错误。

使用--debug标志，错误将以Debug表示形式打印到标准错误。

您可以考虑将标准错误重定向到文件以方便使用，例如vmmigration1 --debug <resource> <method> [options] 2>debug.txt。