networkconnectivity1 命令行界面（CLI）允许您从终端舒适地使用Google networkconnectivity服务的几乎所有功能。

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

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

有关networkconnectivity API的所有其他信息，请参阅官方文档网站。

安装和源代码

使用cargo安装命令行界面：

cargo install google-networkconnectivity1-cli

在github上找到源代码。

用法

本文档是从networkconnectivity API（修订版本20240221）生成的。CLI版本为5.0.4。

networkconnectivity1 [options]
        projects
                locations-get <name> [-p <v>]... [-o <out>]
                locations-global-hubs-accept-spoke <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-hubs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-hubs-delete <name> [-p <v>]... [-o <out>]
                locations-global-hubs-get <name> [-p <v>]... [-o <out>]
                locations-global-hubs-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-global-hubs-groups-get <name> [-p <v>]... [-o <out>]
                locations-global-hubs-groups-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-global-hubs-groups-list <parent> [-p <v>]... [-o <out>]
                locations-global-hubs-groups-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-hubs-groups-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-hubs-list <parent> [-p <v>]... [-o <out>]
                locations-global-hubs-list-spokes <name> [-p <v>]... [-o <out>]
                locations-global-hubs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-hubs-reject-spoke <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-hubs-route-tables-get <name> [-p <v>]... [-o <out>]
                locations-global-hubs-route-tables-list <parent> [-p <v>]... [-o <out>]
                locations-global-hubs-route-tables-routes-get <name> [-p <v>]... [-o <out>]
                locations-global-hubs-route-tables-routes-list <parent> [-p <v>]... [-o <out>]
                locations-global-hubs-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-hubs-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-policy-based-routes-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-policy-based-routes-delete <name> [-p <v>]... [-o <out>]
                locations-global-policy-based-routes-get <name> [-p <v>]... [-o <out>]
                locations-global-policy-based-routes-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-global-policy-based-routes-list <parent> [-p <v>]... [-o <out>]
                locations-global-policy-based-routes-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-policy-based-routes-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-internal-ranges-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-internal-ranges-delete <name> [-p <v>]... [-o <out>]
                locations-internal-ranges-get <name> [-p <v>]... [-o <out>]
                locations-internal-ranges-list <parent> [-p <v>]... [-o <out>]
                locations-internal-ranges-patch <name> (-r <kv>)... [-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-service-classes-delete <name> [-p <v>]... [-o <out>]
                locations-service-classes-get <name> [-p <v>]... [-o <out>]
                locations-service-classes-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-service-classes-list <parent> [-p <v>]... [-o <out>]
                locations-service-classes-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-service-classes-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-service-classes-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-service-connection-maps-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-service-connection-maps-delete <name> [-p <v>]... [-o <out>]
                locations-service-connection-maps-get <name> [-p <v>]... [-o <out>]
                locations-service-connection-maps-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-service-connection-maps-list <parent> [-p <v>]... [-o <out>]
                locations-service-connection-maps-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-service-connection-maps-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-service-connection-maps-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-service-connection-policies-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-service-connection-policies-delete <name> [-p <v>]... [-o <out>]
                locations-service-connection-policies-get <name> [-p <v>]... [-o <out>]
                locations-service-connection-policies-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-service-connection-policies-list <parent> [-p <v>]... [-o <out>]
                locations-service-connection-policies-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-service-connection-policies-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-service-connection-policies-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-service-connection-tokens-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-service-connection-tokens-delete <name> [-p <v>]... [-o <out>]
                locations-service-connection-tokens-get <name> [-p <v>]... [-o <out>]
                locations-service-connection-tokens-list <parent> [-p <v>]... [-o <out>]
                locations-spokes-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-spokes-delete <name> [-p <v>]... [-o <out>]
                locations-spokes-get <name> [-p <v>]... [-o <out>]
                locations-spokes-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-spokes-list <parent> [-p <v>]... [-o <out>]
                locations-spokes-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-spokes-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-spokes-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
  networkconnectivity1 --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文件中存储所有持久数据，文件以networkconnectivity1-为前缀。您可以使用--config-dir标志根据每次调用更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时，用户将被要求授权。遵循CLI提供的说明授予权限或拒绝。

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

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

应用程序密钥

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

为了使CLI更加方便使用，无需强制任何人为自己的应用程序注册，CLI自带了一个默认的应用程序密钥，并相应地进行配置。这也意味着全球范围内的重用可能会耗尽每日配额。

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

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

调试

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

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

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