You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/includes/licensing-and-reporting/configure-nginx-plus-report-to-nim.md
+9-6Lines changed: 9 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,20 +2,23 @@
2
2
docs:
3
3
---
4
4
5
-
1.Open port `443` for NGINX Instance Manager.
5
+
1.Allow NGINX Plus instances to connect to NGINX Instance Manager over HTTPS (TCP `443`).
6
6
7
-
2. On each NGINX Plus instance, update the [`usage_report`](https://nginx.org/en/docs/ngx_mgmt_module.html#usage_report) directive in the [`mgmt`](https://nginx.org/en/docs/ngx_mgmt_module.html) block of the NGINX configuration (`/etc/nginx/nginx.conf`) to point to your NGINX Instance Manager host:
7
+
1. On each NGINX Plus instance, set the [`usage_report`](https://nginx.org/en/docs/ngx_mgmt_module.html#usage_report) directive in the [`mgmt`](https://nginx.org/en/docs/ngx_mgmt_module.html) block of `/etc/nginx/nginx.conf` to point to your NGINX Instance Manager host:
{{<call-out "note" "Extra steps for self-signed certificates">}}If you use self-signed certificates in your NGINX Instance Manager environment, follow the steps in [Configure SSL verification for usage reporting with self-signed certificates]({{< ref "nim/system-configuration/secure-traffic.md#configure-ssl-verify" >}}).{{</call-out>}}
16
-
17
-
3. Reload NGINX:
15
+
1. Reload NGINX:
18
16
19
17
``` bash
20
18
systemctl reload nginx
21
19
```
20
+
21
+
**Extra steps for self-signed certificates:**
22
+
23
+
- If you use self-signed certificates with NGINX Instance Manager, follow
24
+
[Configure SSL verification for usage reporting with self-signed certificates]({{< ref "nim/system-configuration/secure-traffic.md#configure-ssl-verify" >}}).
In connected environments, NGINX Plus sends usage reports directly to the F5 licensing endpoint.
158
+
159
+
<br>
160
+
161
+
Allow the necessary outbound traffic so reports can reach F5.
145
162
146
-
### For internet-connected environments
163
+
1. Allow NGINX Plus instances to connect to the F5 licensing endpoint (`product.connect.nginx.com`) over HTTPS (TCP `443`). Make sure the following IP addresses are allowed:
147
164
148
-
1. Allow outbound HTTPS traffic on TCP port `443` to communicate with F5's licensing endpoint (`product.connect.nginx.com`). Ensure that the following IP addresses are allowed:
165
+
-`3.135.72.139`
166
+
-`3.133.232.50`
167
+
-`52.14.85.249`
149
168
150
-
-`3.135.72.139`
151
-
-`3.133.232.50`
152
-
-`52.14.85.249`
169
+
1.*(R34 and later)* If your company restricts outbound traffic, configure NGINX Plus instances to connect through an outbound proxy. Update the [`proxy`](https://nginx.org/en/docs/ngx_mgmt_module.html#proxy) directive in the [`mgmt`](https://nginx.org/en/docs/ngx_mgmt_module.html) block of (`/etc/nginx/nginx.conf`) to point to your proxy server:
153
170
154
-
2. (Optional, R34 and later) If your company enforces a strict outbound traffic policy, you can use an outbound proxy for establishing an end-to-end tunnel to the F5 licensing endpoint. On each NGINX Plus instance, update the [`proxy`](https://nginx.org/en/docs/ngx_mgmt_module.html#proxy) directive in the [`mgmt`](https://nginx.org/en/docs/ngx_mgmt_module.html) block of the NGINX configuration (`/etc/nginx/nginx.conf`) to point to the company's outbound proxy server:
171
+
```nginx
172
+
mgmt {
173
+
proxy PROXY_ADDR:PORT; # can be http or https
174
+
proxy_username USER; # optional
175
+
proxy_password PASS; # optional
176
+
}
177
+
```
155
178
179
+
</details>
180
+
181
+
<details>
182
+
<summary>Configure reporting in network-restricted environments</summary>
In environments where NGINX Plus instances cannot access the internet, you'll need NGINX Instance Manager to handle usage reporting.
188
+
In environments without internet access, NGINX Plus sends usage reports to NGINX Instance Manager. NGINX Instance Manager collects the reports and later forwards them to F5. For details on forwarding usage reports from NGINX Instance Manager to F5, see [Submit usage reports to F5 from NGINX Instance Manager](#submit-usage-reports-from-nim).
168
189
169
-
#### Configure NGINX Plus to report usage to NGINX Instance Manager
190
+
<br>
170
191
171
-
To configure NGINX Plus R33 or later to report usage data to NGINX Instance Manager:
192
+
To configure NGINX Plus to send usage reports to NGINX Instance Manager:
172
193
173
-
{{< include "licensing-and-reporting/configure-nginx-plus-report-to-nim.md" >}}
194
+
{{< include "/licensing-and-reporting/configure-nginx-plus-report-to-nim.md" >}}
174
195
175
-
To send NGINX Plus usage reports to F5, follow the instructions in [Submit usage reports to F5 from NGINX Instance Manager](#submit-usage-reports-from-nim).
You can delay reporting by setting [`enforce_initial_report`](https://nginx.org/en/docs/ngx_mgmt_module.html#enforce_initial_report) to `off`. This starts a 180-day grace period where NGINX Plus keeps running while it continues trying to report.
200
+
By default, NGINX Plus requires a successful initial usage report before it continues processing traffic.
201
+
202
+
If you need to delay this requirement, you can set [`enforce_initial_report`](https://nginx.org/en/docs/ngx_mgmt_module.html#enforce_initial_report) to `off`. This starts a 180-day grace period where NGINX Plus keeps running while it continues trying to report.
180
203
181
204
```nginx
182
205
# Modify this directive to start the 180-day grace period for initial reporting.
@@ -185,7 +208,10 @@ mgmt {
185
208
}
186
209
```
187
210
188
-
{{< call-out "important" >}}After 180 days, if usage reporting still hasn’t been established, NGINX Plus will stop processing traffic.{{< /call-out >}}
211
+
{{< call-out "important" "Important" >}}
212
+
Use this option only when necessary. After 180 days, if usage reporting still hasn’t been established,
0 commit comments