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
1. Access the NGINX instance: Connect using SSH to the VM or server where NGINX Agent is running.
44
+
45
+
`ssh user@your-nginx-instance`
46
+
47
+
1. Open the NGINX Agent configuration file in a text editor.
48
+
49
+
`sudo vim /etc/nginx-agent/nginx-agent.conf`
50
+
51
+
1. Add the features section: Add the following to the end of the configuration file if it doesn't already exist.
52
+
53
+
```nginx
54
+
features:
55
+
- metrics
56
+
- metrics-throttle
57
+
- dataplane-status
58
+
```
59
+
60
+
1. Restart the NGINX Agent service to apply the changes.
61
+
62
+
`sudo systemctl restart nginx-agent`
63
+
64
+
Once the steps have been completed, users will be able to view metrics data being sent but will not have the capability to push NGINX configuration changes.
65
+
66
+
### Enable the publishing of NGINX configurations and disable the collection of metrics
67
+
68
+
1. Access the NGINX instance: Connect using SSH to the VM or server where NGINX Agent is running.
69
+
70
+
`ssh user@your-nginx-instance`
71
+
72
+
1. Open the NGINX Agent configuration file in a text editor.
73
+
74
+
`sudo vim /etc/nginx-agent/nginx-agent.conf`
75
+
76
+
1. Add the fetures section: Add the following to the end of the configuration file if it doesn't already exist.
77
+
78
+
```nginx
79
+
features:
80
+
- nginx-config-async
81
+
- dataplane-status
82
+
- file-watcher
83
+
84
+
1. Restart the NGINX Agent service to apply the changes.
85
+
86
+
`sudo systemctl restart nginx-agent`
87
+
88
+
Once the steps have been completed, users will be able to publish NGINX configurations but metrics data will not be collected by the NGINX Agent.
Copy file name to clipboardExpand all lines: content/includes/nginx-one/how-to/install-nginx-agent.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,13 +8,14 @@ files:
8
8
After entering your data plane key, you'll see a `curl` command to install NGINX Agent, similar to the one below. Copy and run this command on each NGINX instance. Once installed, NGINX Agent typically registers with NGINX One within a few seconds.
9
9
10
10
{{<call-out "important" "Connecting to NGINX One" >}}
11
-
Ensure that any firewall rules you have in place for your NGINX hosts allows network traffic to port `443`for all of the following IPs:
11
+
Make sure your firewall rules for NGINX hosts allow traffic to port `443`from these IP address ranges:
12
12
13
-
-`3.135.72.139`
14
-
-`3.133.232.50`
15
-
-`52.14.85.249`
13
+
-`3.135.72.139/32`
14
+
-`3.133.232.50/32`
15
+
-`52.14.85.249/32`
16
+
-`2600:1f16:19c8:d400::/62`
16
17
17
-
NGINX Agent must be able to establish a connection to NGINX One Console's Agent endpoint (`agent.connect.nginx.com`).
18
+
NGINX Agent must be able to establish a connection to NGINX One Console's Agent endpoint (`agent.connect.nginx.com`).
Copy file name to clipboardExpand all lines: content/nginx-one/changelog.md
+7Lines changed: 7 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,6 +30,13 @@ h2 {
30
30
31
31
Stay up-to-date with what's new and improved in the F5 NGINX One Console.
32
32
33
+
## September 16, 2025
34
+
35
+
### IPv6 endpoints for NGINX Agent and NGINX Plus usage reporting
36
+
37
+
Your instances which run in dual-stack or IPv6-only environments can now communicate with NGINX One Console APIs through IPv6 addresses.
38
+
See the [Getting Started Guide]({{< ref "/nginx-one/getting-started.md#install-nginx-agent" >}}) for the IP address ranges you need to allow in your firewalls.
Copy file name to clipboardExpand all lines: content/nginx-one/getting-started.md
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -126,11 +126,12 @@ Depending on whether this is your first time using NGINX One Console or you've u
126
126
After entering your data plane key, you'll see a `curl` command similar to the one below. Copy and run this command on each NGINX instance to install NGINX Agent. Once installed, NGINX Agent typically registers with NGINX One within a few seconds.
127
127
128
128
{{<call-out "important" "Connecting to NGINX One" >}}
129
-
NGINX Agent must be able to establish a connection to NGINX One Console's Agent endpoint (`agent.connect.nginx.com`). Ensure that any firewall rules you have in place for your NGINX hosts allows network traffic to port `443` for all of the following IPs:
129
+
NGINX Agent must be able to establish a connection to NGINX One Console's Agent endpoint (`agent.connect.nginx.com`). Ensure that any firewall rules you have in place for your NGINX hosts allows network traffic to port `443` for all of the following IP address ranges:
| nginx-plus-module-appprotect | 35+5.498.0-1 | NGINX Plus app protect dynamic module version 5.498.0 |
30
-
| app-protect-module-plus | 35+5.498.0-1 | App-Protect package for Nginx Plus, includes all of the default files and examples. NGINX App Protect provides web application firewall (WAF) security protection for your web applications, including OWASP Top 10 attacks. |
To access available module versions from the data plane API, follow these steps:
37
-
- View Your API Endpoints and Create an API Key
38
-
- Follow the [NGINXaaS data plane API endpoint]({{< ref "/nginxaas-azure/loadbalancer-kubernetes.md#nginxaas-data-plane-api-endpoint" >}}) and [Create an NGINXaaS data plane API key]({{< ref "/nginxaas-azure/loadbalancer-kubernetes.md#create-an-nginxaas-data-plane-api-key" >}}) to locate your dataplane API endpoint and create an API key.
12
+
To view the version of the NGINX Plus modules that are part of your deployment, follow these steps:
13
+
- Retrieve your [data plane API endpoint]({{< ref "/nginxaas-azure/loadbalancer-kubernetes.md#nginxaas-data-plane-api-endpoint" >}}).
39
14
40
-
- Construct the Request URL
41
-
- Add `/packages` to your data plane API endpoint, for example `https://<your-endpoint>/packages`.
15
+
- Create an [API key]({{< ref "/nginxaas-azure/loadbalancer-kubernetes.md#create-an-nginxaas-data-plane-api-key" >}}) if you do not already have one.
42
16
43
-
- Authenticate API requests
44
-
- Encode your API key to Base64 and add the prefix `ApiKey` to the encoded string.
45
-
- Set the `Authorization` HTTP header to:
46
-
`ApiKey <your_hashed_api_key>`
17
+
- Construct the package request URL.
18
+
- Add **/packages** to your data plane API endpoint.
19
+
- For example: `https://my-deployment-b7e43dfb7e26.eastus.nginxaas.net/packages`
47
20
21
+
- Authenticate the API requests using the **Authorization** HTTP header.
22
+
- Encode your API key to **base64** and add the prefix **ApiKey** to the encoded string.
| nginx-plus-module-appprotect | 33+5.264.0-1 | NGINX Plus app protect dynamic module version 5.264.0 |
91
-
| app-protect-module-plus | 33+5.264.0-1 | App-Protect package for Nginx Plus, includes all of the default files and examples. NGINX App Protect provides web application firewall (WAF) security protection for your web applications, including OWASP Top 10 attacks. |
| nginx-plus-module-appprotect | 33+5.264.0-1 | NGINX Plus app protect dynamic module version 5.264.0 |
115
-
| app-protect-module-plus | 33+5.264.0-1 | App-Protect package for Nginx Plus, includes all of the default files and examples. NGINX App Protect provides web application firewall (WAF) security protection for your web applications, including OWASP Top 10 attacks. |
You can monitor the health status of the F5 NGINXaaS service at the [F5 Cloud Status page](https://www.f5cloudstatus.com/history?filter=88pmy2nlbd01). The status page provides information related to service degradation and unscheduled downtime. When appropriate, we provide mitigations to minimize the impact to your deployments.
11
+
12
+
You may also subscribe to receive emails, webhooks, and RSS feeds when an incident related to NGINXaaS is created, updated, or resolved.
0 commit comments