模块 ngx_mgmt_module


示例Directives
mgmt
enforce_initial_report
license_token
解析器
ssl_crl
ssl_trusted_certificate
ssl_verify
state_path
usage_report

这ngx_mgmt_module模块启用 NGINX Plus 许可证验证和使用情况报告。 这对每个nginx/1.27.2 (nginx-plus-r33)实例。

名为license.jwt应位于/etc/nginx/对于 Linux 或/usr/local/etc/nginx/对于 FreeBSD 或在 license_token Directives指定的路径上。 许可证文件可从 MyF5 获取。

使用安全连接每小时向 F5 许可终端节点发送一次使用情况报告。 （可选）在网络受限的环境中 报告可以配置为 F5 NGINX 可从中发送报告的 Instance Manager 添加到 F5 许可端点。

默认情况下，如果 F5 许可端点未收到初始使用情况报告，nginx 将停止处理流量。

此模块作为我们商业订阅的一部分提供。

示例配置

mgmt {
    # in case if custom path is required
    license_token custom/file/path/license.jwt;

    # in case of reporting to NGINX Instance Manager
    usage_report endpoint=NIM_FQDN;
}

Directives

语法： mgmt { ... }
默认值： —
上下文： main

提供配置文件上下文，其中 使用情况报告和许可证管理Directives 被指定。

语法： enforce_initial_report on | off;
默认值： 
enforce_initial_report on;
上下文： mgmt

该Directives出现在版本 1.27.2 中。

启用或禁用 180 天宽限期 用于发送初始使用情况报告。

初始使用情况报告将立即发送 安装 NGINX 后首先启动。 默认情况下，如果 F5 许可端点未收到初始报告，则 nginx 会停止处理流量，直到报告成功送达。 将 directive value 设置为off使 180 天的宽限期，在此期间 F5 许可端点必须接收初始使用情况报告。

语法： license_token file;
默认值： 
license_token license.jwt;
上下文： mgmt

该Directives出现在版本 1.27.2 中。

指定 JWT 许可证file. 默认情况下，license.jwtfile 应位于/etc/nginx/对于 Linux 或/usr/local/etc/nginx/对于 FreeBSD。

语法： resolver address ... [valid=time] [ipv4=on|off] [ipv6=on|off] [status_zone=zone];
默认值： —
上下文： mgmt

配置用于解析使用情况报告终端节点名称的名称服务器。 默认情况下，使用系统解析程序。

有关详细信息，请参阅 resolver 。

语法： ssl_crl file;
默认值： —
上下文： mgmt

指定file使用已吊销的证书 （CRL） 采用 PEM 格式，用于验证使用情况报告终端节点的证书。

语法： ssl_trusted_certificate file;
默认值： 
ssl_trusted_certificate system CA bundle;
上下文： mgmt

指定file使用 PEM 格式的受信任 CA 证书 用于验证使用情况报告终端节点的证书。

语法： ssl_verify on | off;
默认值： 
ssl_verify on;
上下文： mgmt

启用或禁用使用情况报告终端节点证书的验证。

在 1.27.2 之前，默认值为off.

语法： state_path path;
默认值： —
上下文： mgmt

该Directives出现在版本 1.27.2 中。

定义用于存储状态文件的目录 (nginx-mgmt-*) 由ngx_mgmt_module模块。 默认目录 对于 Linux 是/var/lib/nginx/state, 对于 FreeBSD 是/var/db/nginx/state.

语法： usage_report [endpoint=address] [interval=time];
默认值： 
usage_report endpoint=product.connect.nginx.com interval=1h;
上下文： mgmt

设置address和port使用情况报告终端节点。 这interval参数设置介于 两个连续的报告。

在 1.27.2 之前，默认值为nginx-mgmt.local和30m.