API

nv unset 命令会移除您使用等效的 nv set 命令设置的配置。本指南仅在 nv unset 命令与 nv set 命令不同时描述 nv unset 命令。


nv set system api certificate <certificate-string>

配置要用于 API 端点的 X.509 证书。

命令语法

语法描述
certificate-string证书字符串。

版本历史

在 Cumulus Linux 5.8.0 中引入

示例

cumulus@switch:~$ nv set system api certificate <string>

nv set system api listening-address <listening-address-id>

配置 NVUE REST API 监听地址;您可以指定 IPv4 地址或 localhost。如果您未指定监听地址,NGINX 将监听目标端口的所有地址。

命令语法

语法描述
listening-address-idAPI 监听地址的 IP 地址,或 localhost。

版本历史

在 Cumulus Linux 5.6.0 中引入

示例

cumulus@switch:~$ nv set system api listening-address localhost

nv set system api mtls ca-certificate <certificate-string>

配置在相互 TLS (mTLS) 身份验证期间用于客户端验证的证书。

命令语法

语法描述
certificate-string证书字符串。

版本历史

在 Cumulus Linux 5.8.0 中引入

示例

cumulus@switch:~$ nv set system api mtls ca-certificate <string>

nv set system api port

配置 NVUE REST API 端口。您可以设置介于 1 和 65535 之间的值。如果您未设置端口,Cumulus Linux 将使用默认端口 8765。

版本历史

在 Cumulus Linux 5.6.0 中引入

示例

cumulus@switch:~$ nv set system api port 8888

nv set system api state

启用或禁用 NVUE REST API。默认设置为 enabled

要在 Cumulus Linux 5.6 中使用 NVUE REST API,您必须更改 cumulus 用户的密码;否则,当您运行命令时,您会看到 403 响应。

版本历史

在 Cumulus Linux 5.6.0 中引入

示例

cumulus@switch:~$ nv set system api state enabled