Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion content/includes/nginx-one-console/how-to/add-instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,8 @@ Connect to the host where your NGINX instance is running. Run the provided comma
curl https://agent.connect.nginx.com/nginx-agent/install | DATA_PLANE_KEY="<data_plane_key>" sh -s -- -y
```

Once the process is complete, you can configure that instance in your NGINX One Console.
Once the process is complete, you can configure that instance in your NGINX One Console.

{{< call-out class="note" >}}
To assign a display name that's easier to recognize than the hostname, set the `display-name` NGINX Agent label. For details, see [Assign a display name to an instance]({{< ref "/nginx-one-console/agent/configure-instances/configure-instance-display-name.md" >}}).
{{< /call-out >}}
Original file line number Diff line number Diff line change
Expand Up @@ -85,3 +85,13 @@ sudo docker run \
| NGINX_AGENT_COLLECTOR_EXTENSIONS_TLS_KEY | --collector-extensions-health-tls-key | File path for TLS key used when connecting with OTel health server. | N/A |
| NGINX_AGENT_COLLECTOR_PROCESSORS_BATCH_SEND_BATCH_TIMEOUT | --collector-processors-batch-send-batch-timeout | Maximum time duration for sending batch data metrics regardless of size. | 200ms
{{</table >}}

## Reserved labels

NGINX One Console uses the following label keys for specific purposes:

{{<table>}}
| **Label** | **Description** |
|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
| display-name | Sets a display name for the instance in NGINX One Console. For details, see [Assign a display name to an instance]({{< ref "/nginx-one-console/agent/configure-instances/configure-instance-display-name.md" >}}). |
{{</table >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
title: Assign a display name to an instance
description: "Set a custom display name for an NGINX instance in NGINX One Console using the NGINX Agent display-name
label."
toc: true
weight: 500
f5-content-type: how-to
f5-product: NGINX Agent
f5-keywords: "display name, instance name, nginx agent label, nginx one console"
f5-summary: >
Assign a custom display name to an NGINX instance by setting the reserved
display-name label in NGINX Agent. Use it to identify and filter instances
in NGINX One Console instead of relying on hostname alone.
f5-audience: operator
---

## Overview

By default, NGINX One Console identifies each NGINX instance by its hostname. To assign a display name to an instance, set the reserved `display-name` NGINX Agent label. After NGINX Agent reports the label, NGINX One Console shows the display name alongside the hostname. You can then use the display name to filter and sort instances.

## Before you begin

Before you start, make sure that you have:

- [NGINX Agent installed]({{< ref "/nginx-one-console/agent/install-upgrade/" >}}) and connected to NGINX One Console.
- Access to the NGINX Agent configuration file, CLI, or container environment.

## Set a display name

Set the `display-name` label using any of the [NGINX Agent label]({{< ref "/nginx-one-console/agent/configure-instances/configuration-overview.md" >}}) configuration sources.

### Configuration file

Add the label to the `labels` section of `/etc/nginx-agent/nginx-agent.conf`:

```yaml
labels:
display-name: prod-usw2-edge-03
```

### CLI parameters

```shell
nginx-agent --labels=display-name=prod-usw2-edge-03
```

### Environment variables

```shell
export NGINX_AGENT_LABELS="display-name=prod-usw2-edge-03"
```

After you save your changes, restart NGINX Agent to apply them:

```shell
sudo systemctl restart nginx-agent
```

{{< call-out class="important" >}}
Display names must be 256 characters or fewer. If a value exceeds this limit, the instance registers without a display name.

Display names cannot include Unicode characters like emoji or other multi-byte characters.
{{< /call-out >}}

## Where the display name appears

Once NGINX Agent reports the `display-name` label, NGINX One Console uses it in the following places:

- The **Instances** list and **Instance details** page, alongside the hostname.
- Instance filters and sort options, so you can find instances by display name.
- Data Plane Key details, Config Sync Group instance lists, and Staged Config publish flows.
- Instance metrics dashboards and F5 WAF for NGINX security events, where available.

If an instance doesn't have a display name set, NGINX One Console continues to show its hostname.
6 changes: 6 additions & 0 deletions content/nginx-one-console/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ nollms: true

Stay up-to-date with what's new and improved in the F5 NGINX One Console.

## August 19, 2026

### Instances: Custom display names

You can now assign a display name to an NGINX instance by setting the `display-name` NGINX Agent label. When set, the display name appears alongside the hostname throughout NGINX One Console, and you can filter and sort your instances by display name. For more information, see [Assign a display name to an instance]({{< ref "/nginx-one-console/agent/configure-instances/configure-instance-display-name.md" >}}).

## July 16, 2026

### Observability: Zone Filter
Expand Down
2 changes: 2 additions & 0 deletions content/nginx-one-console/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,8 @@ The `install` script writes an `nginx-agent.conf` file to the `/etc/nginx-agent/

{{<call-out class="note" title="Note: NGINX Agent poll interval" >}} We recommend keeping `dataplane.status.poll_interval` between `30s` and `60s` in the NGINX Agent config (`/etc/nginx-agent/nginx-agent.conf`). If the interval is set above `60s`, NGINX One Console may report incorrect instance statuses.{{</call-out>}}

{{<call-out class="note" title="Note: Instance display names" >}} To assign a display name that's easier to recognize than the hostname, set the `display-name` NGINX Agent label. For details, see [Assign a display name to an instance]({{< ref "/nginx-one-console/agent/configure-instances/configure-instance-display-name.md" >}}).{{</call-out>}}

<br>

---
Expand Down
Loading
Loading