Known issues
This document lists and describes the known issues and possible workarounds in F5 NGINX Instance Manager. We also list the issues resolved in the latest releases.
Tip: We recommend you upgrade to the latest version of NGINX Instance Manager to take advantage of new features, improvements, and bug fixes.
February 06, 2025
| Issue ID | Status |
|---|---|
| 45845 | Fixed in Instance Manager 2.19.1 |
In NGINX Instance Manager v2.19.0, publishing an NGINX App Protect WAF policy from the UI fails if the latest NGINX App Protect WAF compiler v5.264.0 (for NGINX App Protect WAF v4.13.0 or v5.5.0) is manually installed without adding the NGINX repository certificate and key.
-
Download the NGINX repository certificate and key:
- Log in to MyF5.
- Go to My Products and Plans > Subscriptions.
- Download the SSL certificate (nginx-repo.crt) and private key (nginx-repo.key) for your NGINX App Protect subscription.
-
Upload the certificate and key using the NGINX Instance Manager web interface:
- Go to Settings > NGINX Repo Connect.
- Select Add Certificate.
- Choose Select PEM files or Manual entry.
- If using manual entry, copy and paste your certificate and key details.
For detailed steps, see Upload NGINX App Protect WAF certificate and key.
-
Restart the
nms-integrationsservice:sudo systemctl restart nms-integrations
November 08, 2024
| Issue ID | Status |
|---|---|
| 45846 | Fixed in Instance Manager 2.19.1 |
On Ubuntu 24.04, NGINX Instance Manager v2.18.0 and v2.19.0 fail to automatically download NGINX App Protect WAF compiler v5.210.0 (for NGINX App Protect WAF v4.12.0) and v5.264.0 (for NGINX App Protect WAF v4.13.0) from the NGINX repository.
Manually install the missing compiler by following the instructions in Install the WAF compiler.
| Issue ID | Status |
|---|---|
| 45573 | Fixed in Instance Manager 2.19.0 |
Saving templates as “staged configs” causes syntax errors due to Augment templates being multiple directories down the tree.
| Issue ID | Status |
|---|---|
| 45570 | Fixed in Instance Manager 2.19.0 |
If there is an NGINX configuration error when pushing a template configuration, the text overlaps outside the error window.
| Issue ID | Status |
|---|---|
| 45301 | Fixed in Instance Manager 2.19.0 |
.tgz files are not accepted in templates while .tar.gz files are.
| Issue ID | Status |
|---|---|
| 45024 | Fixed in Instance Manager 2.19.0 |
There is an issue that causes previous error messages to persist in the web interface, even after fixing the error causing the message.
September 13, 2024
| Issue ID | Status |
|---|---|
| 45565 | Fixed in Instance Manager 2.19.0 |
The Certificate Management screen can only show up to 100 certificates.
July 10, 2024
| Issue ID | Status |
|---|---|
| 45512 | Fixed in Instance Manager 2.18.0 |
The months in the custom date range were not displayed correctly because NGINX Instance Manager assumed the data format was in the US timezone.
| Issue ID | Status |
|---|---|
| 45153 | Fixed in nginxagent-2.36.0 |
In NGINX Instance Manager 2.17.0, an “invalid number of arguments” error appears in the web interface when using specific configuration parameters in NGINX Agent 2.36.0.
Install NGINX Agent 2.35.1 if you’re using NGINX Instance Manager 2.17.0. This version is included with NGINX Instance Manager 2.17.0 by default.
If you’re installing NGINX Agent from package files, follow the steps in the Installing NGINX Agent guide.
| Issue ID | Status |
|---|---|
| 45131 | Open |
When using NGINX Instance Manager, you configure OIDC by manually editing the /etc/nginx/conf.d/nms-http.conf and /etc/nms/nms.conf files.
During the upgrade to 2.17.0, the user is asked if they would like to keep their own nms-http.conf, or replace it with the new default. As Web Analytics are enabled via the /etc/nginx/conf.d/nms-http.conf file, if a user decides to keep their own config when prompted during upgrade, these will not get enabled.
To keep the existing nms-http.conf file while maintaining the web analytics functionality, add the following to “/etc/nginx/conf.d/nms-http.conf” , inside the /ui location block:
add_header Content-Security-Policy "default-src 'none'; block-all-mixed-content; frame-ancestors 'self'; object-src 'none'; manifest-src 'self'; script-src 'self' https://*.walkme.com 'unsafe-inline' 'unsafe-eval'; style-src 'self' https://*.walkme.com fonts.googleapis.com 'unsafe-inline'; img-src 'self' https://*.walkme.com s3.walkmeusercontent.com d3sbxpiag177w8.cloudfront.net data:; font-src 'self' https://*.walkme.com data: https://fonts.gstatic.com; connect-src 'self' https://*.walkme.com; frame-src 'self' https://*.walkme.com blob:; worker-src 'self' blob: https://*.walkme.com;";| Issue ID | Status |
|---|---|
| 45113 | Open |
If NGINX Agent is configured to monitor NGINX App Protect before App Protect is installed, NGINX Agent will send an empty App Protect metadata structure to NGINX Instance Manager. This causes Instance Manager to fail to register the NGINX instance properly.
Edit the “/etc/nginx-agent/nginx-agent.conf” file and configure “precompiled_publication” as “false”. Then restart the nginx-agent process running sudo systemctl restart nginx-agent.
| Issue ID | Status |
|---|---|
| 44975 | Fixed in Instance Manager 2.18.0 |
When publishing a configuration template fails, the system only displays “Accepted” without providing the final result, such as “Success” or “Failure.”
| Issue ID | Status |
|---|---|
| 44971 | Fixed in Instance Manager 2.17.0 |
When editing a template submission, you can now choose between using a snapshot of the template from when it was first deployed or the latest version of the template. Important: Note that if you use the latest version, changes to the templates might make an augment template incompatible with a base template, causing the publication to the data plane to fail.
December 12, 2023
| Issue ID | Status |
|---|---|
| 44698 | Open |
After adding a license, some NGINX Management Suite features might be disabled, even if they are included in the license.
Restart NGINX Management Suite to make all the features available for use. To restart NGINX Management Suite, open a terminal on the host and run the command:
sudo systemctl restart nms| Issue ID | Status |
|---|---|
| 44685 | Open |
With the introduction of Instance Manager 2.15, we are expanding the features available for some licenses, such as those with only NGINX Plus entitlement. If such a license was applied before upgrading to 2.15, the expanded set of features will not be available as intended.
Terminate the license applied previously. Re-apply the license.
October 16, 2023
| Issue ID | Status |
|---|---|
| 44554 | Open |
When using the Scan feature, the CVE column may provide a value of ‘–’ for instances running specific versions of NGINX App Protect, including App Protect 4.4 and potentially others.
| Issue ID | Status |
|---|---|
| 44547 | Open |
Under certain conditions, instances that are not reporting request totals may not show in the Network Utilization panel or drawer when data is sorted by Request count. This typically happens when NGINX is not configured to stream metrics data to NGINX Agent.
Configure NGINX Plus or NGINX Stub Status APIs to send correctly the NGINX metrics using NGINX Agent. See the Metrics documentation to learn more.
| Issue ID | Status |
|---|---|
| 44520 | Open |
Users might not have permission to access the built-in policies (NginxDefaultPolicy and NginxStrictPolicy) while using NGINX Management Suite.
Use RBAC to assign the following permissions to the user:
- (At minimum) READ access to any other custom security policy or
- READ access to the security policy feature:
/api/platform/v1/security/policies
August 28, 2023
| Issue ID | Status |
|---|---|
| 44267 | Open |
In Instance Manager 2.13, a new configuration is published before the compile stage of a WAF policy is complete. This happens only when the policy is first referenced. This leads to a deployment failure, and the configuration rolls back. Typically, by the time you try to submit the configuration again, the policy has finished compiling, and the request goes through.
The initial failure message looks like this:
Config push failed - err: failure from multiple instances. Affected placements: instance/70328a2c-699d-3a90-8548-b8fcec15dabd (instance-group: ig1) - err: failed building config payload: config: aux payload /etc/nms/NginxDefaultPolicy.tgz for instance:70328a2c-699d-3a90-8548-b8fcec15dabd not ready aux payload not ready, instance/2e637e08-64b3-36f9-8f47-b64517805e98 (instance-group: ig1) - err: failed building config payload: config: aux payload /etc/nms/NginxDefaultPolicy.tgz for instance:2e637e08-64b3-36f9-8f47-b64517805e98 not ready aux payload not readyRetry pushing the new configuration. The deployment should work the second time around.
| Issue ID | Status |
|---|---|
| 43950 | Open |
If precompiled_publication is set to true, NGINX Management Suite may incorrectly report the version of Attack Signatures (AS) and Threat Campaigns (TC) that you previously installed on the NAP WAF instance.
June 12, 2023
| Issue ID | Status |
|---|---|
| 42838 | Open |
When updating Attack Signatures or Threat Campaign packages on multiple instances simultaneously, only one instance may be successfully updated. An error similar to the following is logged: security policy bundle object with given ID was not found.
Update the Attack Signatures or Threat Campaigns package one instance at a time.
April 26, 2023
| Issue ID | Status |
|---|---|
| 42217 | Open |
The list of Threat Campaigns will disappear when scrolling down, preventing the selection of the oldest versions.
Threat Campaign versions can be published with the API using the route: api/platform/v1/security/publish
| Issue ID | Status |
|---|---|
| 42133 | Won’t be resolved |
When upgrading to 2.10 you may see a warning like the below message for the NGINX Management Suite Ingestion service. It can be safely ignored.
[WARN] #011/usr/bin/nms-ingestion #011start/start.go:497 #011error checking migrations Mismatched migration version for ClickHouse, expected 39 migrations to be applied, currently have only 44 migrations applied.| Issue ID | Status |
|---|---|
| 42119 | Won’t be resolved |
After upgrading to Instance Manager 2.10, the API does not return lastDeploymentDetails for existing configuration blocks. This is then reflected as “Invalid Date” in the UI (See #42108).
Republish the configuration for the affected configuration blocks.
November 17, 2022
| Issue ID | Status |
|---|---|
| 38782 | Won’t be resolved |
When installing NGINX Instance Manager on Kubernetes via Helm Chart, the App Protect page shows an error banner, and no default policies are displayed.
| Issue ID | Status |
|---|---|
| 38596 | Won’t be resolved |
Deploying NGINX config with references to remote cert that resides in allowed directories could fail, with the following error:
BIO_new_file() failed (SSL: error:02001002:system library:fopen:No such file or directory.
This can also be diagnosed with log entries in /var/log/nginx-agent/agent.log, noting the removal of the referenced certificate.
- Add the referenced cert to NMS as managed certificate and publish the config again.
- Move the referenced remote certificate to a directory that’s not in the allowed directory list.
| Issue ID | Status |
|---|---|
| 38488 | Won’t be resolved |
When using NGINX Instance Manager with App Protect policies, previously referenced policies in the NGINX configuration may not be removed after they are no longer referenced in the NGINX config.
Unreferenced policy files may be removed manually from /etc/nms.
| Issue ID | Status |
|---|---|
| 38041 | Won’t be resolved |
The values currently populated for http.version_schema are incorrect. The response is “4” for HTTP traffic and “6” for HTTPS traffic.
| Issue ID | Status |
|---|---|
| 36265 | Open |
References to external files in a policy are not supported.
For example, in the NGINX App Protect WAF JSON declarative policy, these references are not supported:
- User-defined signatures - " not supporting for a while" @dan
- Security controls in external references
- Referenced OpenAPI Spec files
October 04, 2022
| Issue ID | Status |
|---|---|
| 37498 | Won’t be resolved |
Updating a config with an aux data file exceeding 3145728 characters fails with a validation error similar to the following example:
Request body has an error: doesn’t match the schema: Error at “/auxFiles/files/3/contents”: maximum string length is 3145728
| Issue ID | Status |
|---|---|
| 37437 | Won’t be resolved |
Occasionally, when publishing an NGINX config to a NATS server, the system returns a Deployment Not Found error, and the nms.log file includes the error http failure with code '131043': <nil>.
Remove the existing NATs working directory and restart the NMS Data Plane Manager (nms-dpm) service as root.
Caution Restarting thenms-dpmservice is disruptive and may result in the loss of event data. You should schedule a maintenance window for restarting the service.
rm -rf /var/lib/nms/streaming
systemctl restart nms-dpmJune 30, 2022
| Issue ID | Status |
|---|---|
| 34255 | Open |
NGINX Instance Manager reports metrics at a per-minute interval and includes dimensions for describing the metric data’s characteristics.
An issue has been identified in which metric data is aggregated across all dimensions, not just for existing metrics data. When querying the Metrics API with aggregations like SUM(metric-name), the aggregated data causes the API to over count the metric. This overcounting skews some of the metrics dashboards.
When querying the Metrics API, you can exclude the data for an aggregated dimension by specifying the dimension name in the filterBy query parameter.
filterBy=<dimension-name>!= ''May 25, 2022
| Issue ID | Status |
|---|---|
| 34185 | Won’t be resolved |
When adding certificates, an internal error (error code: 134018) is returned if the name given for the certificate exceeds 255 characters.
Use a name that is 255 or fewer characters.
April 05, 2022
| Issue ID | Status |
|---|---|
| 33307 | Won’t be resolved |
After upgrading to NGINX Instance Manager 2.1.0, and updating nginx-agent from platform packaging, duplicate instances may appear on the Instance overview page. This issue is caused by a change in how the NGINX Agent generates the system_uid.
You can safely delete the older entries or wait for them to expire.
| Issue ID | Status |
|---|---|
| 33160 | Won’t be resolved |
When publishing a configuration, you might encounter an error similar to the following example:
config action failed: Config apply failed (write): no such processThis error can occur when there is a desyncronization between the NGINX Agent and NGINX PID, often after manually restarting NGINX when the Agent is running.
Restart the NGINX Agent:
sudo systemctl restart nginx-agentDecember 21, 2021
| Issue ID | Status |
|---|---|
| 32718 | Won’t be resolved |
NGINX Instance Manager does not currently support managing NGINX App Protect WAF instances. NGINX App Protect WAF may block attempts to publish configurations to NGINX App Protect WAF instances.
| Issue ID | Status |
|---|---|
| 31081 | Open |
In the web interface, when uploading a config file that’s larger than 50 MB (max size), the system incorrectly reports the state as Analyzing (Status code 403), although the upload failed.
Keep config files under 50 MB.
| Issue ID | Status |
|---|---|
| 28758 | Won’t be resolved |
When installing on CentOS 7, RHEL 7, and Amazon Linux 2, the package manager doesn’t prevent installing NGINX Instance Manager with unsupported versions of NGINX or NGINX Plus. As a consequence, it is possible that nms-instance-manager is installed without an NGINX gateway. Resulting in a less than optimal experience.
Install a supported version of NGINX (v1.18 or later) or NGINX Plus (R22 or later). See the Technical Specifications guide for details.
| Issue ID | Status |
|---|---|
| 28683 | Won’t be resolved |
When starting NGINX Instance Manager, you may see errors similar to the following in /etc/nginx/conf.d/nms-http.conf:227:
nginx[1234]: nginx: [emerg] unknown directive "grpc_socket_keepalive"Make sure your version of NGINX is v1.18 or later.