#google #cli #networking #networkmanagement #google-api

app google-networkmanagement1-cli

一个用于与网络管理(协议v1)交互的完整库

7个稳定版本 (3个主要版本)

5.0.4+20240221 2024年3月5日
3.1.0+20220223 2022年4月26日
3.0.0+20220223 2022年3月8日
2.0.4+20210325 2021年4月15日
1.0.14+20200520 2020年7月10日

#2439 in 网络编程

Download history 3/week @ 2024-03-14 37/week @ 2024-03-28 29/week @ 2024-04-04 1/week @ 2024-05-16

每月下载量 126

MIT 许可证

475KB
6K SLoC

networkmanagement1 命令行界面(CLI)允许您在终端中方便地使用Google网络管理服务的大部分功能。

默认情况下,所有输出都会打印到标准输出,但可以通过设置标志将其直接导向文件,而不受shell功能的影响。错误将打印到标准错误,并导致程序的退出代码不为零。

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

有关网络管理API的所有其他信息,请参阅官方文档网站

安装和源代码

使用cargo安装命令行界面

cargo install google-networkmanagement1-cli

github上找到源代码

用法

此文档是从修订版 20240221网络管理 API 生成的。CLI版本为 5.0.4

networkmanagement1 [options]
        projects
                locations-get <name> [-p <v>]... [-o <out>]
                locations-global-connectivity-tests-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-connectivity-tests-delete <name> [-p <v>]... [-o <out>]
                locations-global-connectivity-tests-get <name> [-p <v>]... [-o <out>]
                locations-global-connectivity-tests-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-global-connectivity-tests-list <parent> [-p <v>]... [-o <out>]
                locations-global-connectivity-tests-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-connectivity-tests-rerun <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-connectivity-tests-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-connectivity-tests-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-operations-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-operations-delete <name> [-p <v>]... [-o <out>]
                locations-global-operations-get <name> [-p <v>]... [-o <out>]
                locations-global-operations-list <name> [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
  networkmanagement1 --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 目录中,以 networkmanagement1- 前缀的 JSON 文件中。您可以使用 --config-dir 标志在每次调用中更改用于存储配置的目录。

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

身份验证

大多数API都需要用户对请求进行身份验证。如果是这样,则 作用域 确定了授予的权限集。这些通常不超过 只读完全访问

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

第一次使用作用域时,系统会请求用户授权。根据 CLI 指示授权或拒绝。

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

要撤销授权,请参阅官方文档

应用程序密钥

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

为了让 CLI 更便于使用,无需强制用户注册自己的应用程序,CLI 配置了默认的应用程序密钥。这也意味着全球范围内的重用可能会耗尽每日配额。

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

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

调试

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

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

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

依赖项

~20–32MB
~594K SLoC