--- title: "UA UI Reference" slug: "ua-ui-reference" description: "Manage all Universal Agents in one place with features like filtering, deployment, and detailed metrics for efficient organization and performance tracking." tags: ["Agent Filters", "Agent Management", "Universal Agents"] status: "new" updated: 2026-10-01T23:12:22Z published: 2026-10-01T23:12:22Z canonical: "kb.kentik.com/ua-ui-reference" --- > ## Documentation Index > Fetch the complete documentation index at: https://kb.kentik.com/llms.txt > Use this file to discover all available pages before exploring further. # UA UI Reference The Universal Agents page provides a centralized view and management interface for all Universal Agents deployed by your organization. You can access this page via **Settings** **»** **Universal Agents** in the navbar. Key UI elements include: - **Auto-refresh/Refresh:** Automatically or manually updates the agent list. - **Deploy Agent (Admin-only)**: Opens the [**Deploy a Universal Agent**](/v1/docs/ua-deployment#deploy-a-universal-agent-through-the-portal) dialog for deploying new agents. - **Show/Hide Filters:** Toggles the **Filters** pane (see [**Universal Agents Filters**](/v1/docs/ua-ui-reference#universal-agents-filters)). - **Search**: Restricts the [**Universal Agents List**](/v1/docs/ua-ui-reference#universal-agents-list) based on keywords you enter and/or filters you select > [!NOTE] > **Note:** For text-based searches, keywords are matched against the **Name** and **Capabilities** columns only. - To clear all entered text, click the **X** in the Search field. - To clear a filter, click the **X** in a lozenge. - **Filters:** Provides controls to narrow the agents list (see [**Universal Agents Filters**](/v1/docs/ua-ui-reference#universal-agents-filters)). - [**Universal Agents List:**](/v1/docs/ua-ui-reference#universal-agents-list) A table displaying your deployed Universal Agents. > [!NOTE] > **Note:** Member-level users can view Universal Agents, but only Admin-level users can add, edit, or remove them (see [**About Users**](/v1/docs/users#about-users)). ## Universal Agents Filters The **Filters** pane on the left of the [**Universal Agents List**](/v1/docs/ua-ui-reference#universal-agents-list) refines the list based on these options: - **Capability**: Filters by installed capabilities (see [**Agent Capabilities**](/v1/docs/universal-agents#agent-capabilities)). - **Status**: Filters by agent status (e.g., “Up”). - **Version**: Allows adding and removing filters for specific agent versions via a drop-down list. - **Site**: Allows adding and removing filters for specific sites (see [**About Sites**](/v1/docs/sites#about-sites)) via a drop-down list. > [!NOTE] > **Notes:** You can add a Version or Site filter by selecting one or more values from the drop-down. To remove a filter, click **X** in the lozenge in the search field. ## Universal Agents List The Universal Agents list shows all the deployed Universal Agents for your organization. To change the sort order of the list, click a column heading, then click the resulting blue up or down arrow to toggle between ascending and descending order. ### **List Columns** The Universal Agents list includes the following columns of information about each deployed Universal Agent: - **Status:** Agent's current operational state. - **Name:** Agent's assigned name. - **CPU:** Percentage of CPU the agent is currently using. - **MEM:** Percentage of memory the agent is currently using. - **Public IP:** Agent's public IP address. - **Private IP:** Agent's private IP address. - **Site:** Associated site name. - **Version:** Agent's software version. - **Capabilities:** Tags indicating agent functionalities. ### List Actions The Universal Agents list includes the following action buttons per row: - **Edit (pencil icon)**: Modify agent properties (see [**Edit Agent Drawer**](/v1/docs/ua-ui-reference#edit-agent-drawer)). - **Remove (trash icon)**: Delete the agent instance (requires confirmation). ## Agent Details Drawer ![Agent details for fedora-temp-66, including status, IP addresses, and capabilities.](https://cdn.us.document360.io/082e25b5-afce-42d4-8f47-70bd3f1d02b7/Images/Documentation/UA-agent-details-drawer.png)Access the Agent Details drawer by clicking an agent's row in the Universal Agents List. ### Agent Details UI The Agent Details drawer includes the following UI elements: - **Close (button):** Closes the drawer. - **Name:** Displays the agent's name. - **Edit (button):** Opens the [**Edit Agent Drawer**](/v1/docs/ua-ui-reference#edit-agent-drawer). - **Properties (fields):** A set of fields with metadata about the agent (see [**Agent Details Fields**](/v1/docs/ua-ui-reference#agent-details-fields)). - **Capabilities (pane):** Lists the agent's capabilities in collapsible sections by [**Capability Categories**](/v1/docs/ua-ui-reference#capability-categories), each with: - **Install (button)**: Installs a capability. - **Details (button):** Opens a detailed view of an installed capability (see [**Capability Drawer**](/v1/docs/ua-ui-reference#capability-drawer)). - **Toggle (switch)****:** Turns a capability ON (blue) or OFF (grey). - **Metrics (pane):** Charts showing the agent's CPU and memory utilization for the last hour (all capabilities combined). - **View in Metrics Explorer (button):** Opens the view in Metrics Explorer. > [!NOTE] > **Note:** When a capability section is collapsed, the total count of capabilities for that section is shown in a blue bubble. ### Capability Categories Capability categories shown in the Agent Details drawer are: - **Installed**: Running or Paused on this Agent - **Available**: Compatible and Supported - **Available**: Compatibility not guaranteed - **Upcoming**: Planned future release ### Agent Details Fields Agent properties are listed in the drawer and include the following: - **Status:** The agent status (e.g., "Up"). - **Host Name:** The name of the host where the agent is deployed. - **Version:** The Kentik-maintained version number for the agent. - **Public IP:** The public IP address of the agent's host machine. - **Private IP:** The private IP address of the agent's host machine. - **Site:** The site to which the agent is associated, if any. - **Description (only if specified):** A description string specified in the agent's settings - **Closest Device:** A field with two states: - If the **Closest Network Device** field is already specified in the [**Edit Agent Drawer**](/v1/docs/ua-ui-reference#edit-agent-drawer), this field shows that value. - If this value is not yet set, this field displays an **Edit** link that opens the [**Edit Agent Drawer**](/v1/docs/ua-ui-reference#edit-agent-drawer), where you can specify the closest device. - **Host OS:** The operating system and CPU type of the agent’s host machine. - **Created on:** The date-time when the agent was created. - **Last seen on:** The date-time when the agent last connected to Kentik. - **Agent ID:** The ID number (integer) of the agent. - **Install ID:** A unique ID (string) generated and stored on the host when the agent was installed. - **Host Machine ID:** The unique ID (string) of the host, collected from the host OS. ## Edit Agent Drawer The Edit Agent drawer lets you view and update details for an installed Universal Agent. You can access it by clicking the **Edit** button in the [**Agent Details Drawer**](/v1/docs/ua-ui-reference#agent-details-drawer). ![](https://cdn.us.document360.io/082e25b5-afce-42d4-8f47-70bd3f1d02b7/Images/Documentation/image(647).png) The Edit Agent drawer includes the following UI elements: - **Cancel (button):** Closes the drawer without saving any changes. - **Save (button):** Saves changes to agent settings and exits the drawer. - **Name:** Your organization's name for the agent (defaults to host name). - **Description:** An optional, user-provided description of the agent. - **Closest Network Device (SNMP/ST only):** A drop-down with which to specify the device in your network that is the fewest hops from the host on which the agent is installed. > [!NOTE] > **Note:** This setting facilitates topology-aware device status reporting in NMS. - **Site:** A field showing the site, if any, to which the agent is currently assigned, which could be a data center or a VPC in a cloud provider (see [**About Sites**](/v1/docs/sites#about-sites)). To set or change the site, click in the field to drop down a filterable list of sites, then click a site in the list to select. - **Create a New Site (button):** If a site hasn't yet been defined for the location where the agent host is located, click the button to create a new site (see [**Configure Site Fields**](/v1/docs/ua-ui-reference#configure-site-fields)). ### Configure Site Fields Clicking the **Create a New Site** button adds the following fields to the **Edit Agent** drawer: - **Site Name:** A name for the new site. - **Street Address:** The physical location of the new site, given as a street address. - **Use an Existing Site:** If you decide not to create a new site, click this button to hide the **Configure Site** fields and instead choose a site from the **Site** drop-down. ## Capability Drawer The **Capability** drawer, which opens by clicking **Details** on an agent capability, has the following UI elements: ![](https://cdn.us.document360.io/082e25b5-afce-42d4-8f47-70bd3f1d02b7/Images/Documentation/image(648).png) - **Back/Cancel (button):** Closes the drawer without saving any changes. - **Save (button):** Saves changes and exits the drawer. - **Status:** The capability status (e.g., "Up"). - **Version:** The version number for the capability, as distinct from the agent version, e.g., "v1.109.0". - **Binary:** The binary name installed for this capability (e.g., "kdns"). - **Run State:** A description of how long the capability has been enabled (e.g., "Running since 2025-05-28 10:00 as pid 762"). If capability is disabled, this will be blank. - **Interface (DNS OTT Tap only):** Indicates which interfaces are included, e.g., "All", "eth0, "lo", "gre0", or "gre101" (see [**Manage a Capability**](/v1/docs/ua-portal-management#manage-a-capability)). - **Promiscuous Mode (DNS OTT Tap only):** "True" if promiscuous mode is enabled, otherwise "False" (see Edit a Capability). - **Metrics chart(s):** Varying by capability as follows: - **SNMP/ST**: Metrics per second - **DNS OTT Tap**: DNS Responses per second, Discards per second - **SNMP Trap Receiver**: Traps per second, Receiver errors per second - **Syslog Server**: Messages per second, Dropped messages per second - **View in Metrics Explorer:** Opens the view in Metrics Explorer - **Devices (SNMP/ST only):** Lists the devices for which a SNMP/ST capability is collecting metrics. Click the device name to open its details page. If no devices are collecting metrics, "No devices found" is displayed. - **Enable/Disable this Capability:** Click to enable/disable the capability. > [!TIP] > **Tip:** In addition to using the button in the **Capability** drawer, you can enable/disable capabilities with the toggle switches in the **Agent Details** drawer (see [**Agent Details UI**](/v1/docs/ua-ui-reference#agent-details-ui)).