baremetalsolution2 命令行界面（CLI）允许您从终端舒适地使用Google baremetalsolution服务的多数功能。

默认情况下，所有输出都打印到标准输出，但可以设置标志将其直接重定向到文件，而不依赖于shell的功能。错误将打印到标准错误，并导致程序退出代码不为零。

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

baremetalsolution API的其他信息可以在官方文档站点找到。

安装和源代码

使用cargo通过以下命令安装命令行界面：

cargo install google-baremetalsolution2-cli

在github上找到源代码。

用法

此文档是根据baremetalsolution API的修订版20240228生成的。CLI的版本为5.0.4。

baremetalsolution2 [options]
        projects
                locations-get <name> [-p <v>]... [-o <out>]
                locations-instances-detach-lun <instance> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-disable-interactive-serial-console <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-enable-interactive-serial-console <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-get <name> [-p <v>]... [-o <out>]
                locations-instances-list <parent> [-p <v>]... [-o <out>]
                locations-instances-load-auth-info <name> [-p <v>]... [-o <out>]
                locations-instances-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-rename <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-reset <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-start <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-stop <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-networks-get <name> [-p <v>]... [-o <out>]
                locations-networks-list <parent> [-p <v>]... [-o <out>]
                locations-networks-list-network-usage <location> [-p <v>]... [-o <out>]
                locations-networks-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-networks-rename <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-nfs-shares-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-nfs-shares-delete <name> [-p <v>]... [-o <out>]
                locations-nfs-shares-get <name> [-p <v>]... [-o <out>]
                locations-nfs-shares-list <parent> [-p <v>]... [-o <out>]
                locations-nfs-shares-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-nfs-shares-rename <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-os-images-get <name> [-p <v>]... [-o <out>]
                locations-os-images-list <parent> [-p <v>]... [-o <out>]
                locations-provisioning-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-provisioning-configs-get <name> [-p <v>]... [-o <out>]
                locations-provisioning-configs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-provisioning-configs-submit <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-provisioning-quotas-list <parent> [-p <v>]... [-o <out>]
                locations-ssh-keys-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-ssh-keys-delete <name> [-p <v>]... [-o <out>]
                locations-ssh-keys-list <parent> [-p <v>]... [-o <out>]
                locations-volumes-evict <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-volumes-get <name> [-p <v>]... [-o <out>]
                locations-volumes-list <parent> [-p <v>]... [-o <out>]
                locations-volumes-luns-evict <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-volumes-luns-get <name> [-p <v>]... [-o <out>]
                locations-volumes-luns-list <parent> [-p <v>]... [-o <out>]
                locations-volumes-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-volumes-rename <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-volumes-resize <volume> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-volumes-snapshots-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-volumes-snapshots-delete <name> [-p <v>]... [-o <out>]
                locations-volumes-snapshots-get <name> [-p <v>]... [-o <out>]
                locations-volumes-snapshots-list <parent> [-p <v>]... [-o <out>]
                locations-volumes-snapshots-restore-volume-snapshot <volume-snapshot> (-r <kv>)... [-p <v>]... [-o <out>]
  baremetalsolution2 --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文件中，文件名以baremetalsolution2-开头。您可以使用--config-dir标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，会询问用户是否授权。按照CLI的指示授权或拒绝。

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

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

应用程序密钥

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

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

您可以通过将自定义密钥文件放置在此位置来解决这个问题：~/.google-service-cli/baremetalsolution2-secret.json，前提是已为它启用了所需的baremetalsolution API。此类密钥文件可以从Google开发者控制台的APIs & auth -> Credentials -> Download JSON下载并直接使用。

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

调试

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

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

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