# Agent Web Interface

> Use the agent's own web interface to read measurements, change its configuration, and queue applications.

Source: https://docs.capaone.com/performanceguard/technical-reference/agents/agent-web-interface/  
Product: PerformanceGuard — a separate CapaSystems product; do not apply this page to any other.

The agent can be configured to offer its own web (HTTP)-based interface. The interface allows users to retrieve measurements and other information from the agent, and it also lets users change agent configurations, queue application ping requests, etc.

# **Enable Agent Web Server**

The agent web server can be enabled either through the configuration distributed by PerformanceGuard or by adding registry values on individual computers that run the agent.

:::caution
In the default configuration, the agent web server is enabled on port 4007 for access from the same computer, eveen if the agent GuiMode parameter is set to NoWindow. You should make sure to change the web server setup in the agent configuration (as explained in the following) if you want to change this.
:::

# **Access Agent Web Interface**

The agent web interface can be reached on the '/' resource on the configured port, which will redirect you to the '/cmd/cmd ' resource.

By default you'll see the **View > Status** page.  
![](/attachments/performanceguard/9ef73357-f05d-4829-a809-2eb6feca0008.png)  
The agent web interface's yellow menu bar provides access to a wide range of configuration information as well as data collected by the agent.

:::note[Important]
**Example:** Select **View > IP Data** to view IP-traffic data measured by the agent. This is the same as typing view ip data in the agent's Telnet interface.
:::

:::note[Important]
**Example:** Select **View > DNS** to view all entries in the agent's reverse DNS cache. This is the same as typing view dns in the agent's Telnet interface.
:::

# **Agent 'Get' Interface**

There is an additional web-based interface URL, which is normally used to relay information to the system tray icon. This interface is reached on, for example, [http://localhost:4007/get/get?version=0](http://localhost:4007/get/get?version=0).  
One or more parameters may be queried in a single request:

| **Parameter**         | **Value**                                                                     |
|:----------------------|:------------------------------------------------------------------------------|
| **version**           | Build label                                                                   |
| **isservice**         | true if the agent runs as a windows service                                   |
| **build\_time**       | Date and time of compilation                                                  |
| **window\_title**     | Window title to use for Agent                                                 |
| **agent\_name**       | Name of agent distinguishes OEM agents                                        |
| **agent\_dir**        | Catalog where agent is installed                                              |
| **agent\_id**         | ID assigned by PerformanceGuard backend server for the agent                  |
| **configuration\_id** | ID of the configuration currently used by the agent                           |
| **protocolversion**   | Version of the protocol used to communicate with the PerformanceGuard backend |
| **GUImode**           | Configuration values that control how the agent should be presented           |
| **configuration**     | Agent configuration string                                                    |

The following command will query all variables:

**Text**

```text
http://localhost:4007/get/get?version=0&isservice=0&build_time=0&window_title=0&agent_name
```

Result:

**Text**

```text
version=Internal Jun 27 2007 09:44:48
isservice=no
build_time=-
window_title=PremiTech PerformanceGuard Agent
agent_name=GuardAgentD
agent_dir=C:\Dev\bugfix-pg-5-1\premitech\bin\win32
agent_id=5
configuration_id=1
protocolversion=510
GUImode=Icon Window NoExit AutoHide SendReport
configuration="Promiscuous=false
FrameType=Ethernet
DiscoverServerPorts=true
TCPReport=true
UDPReport=true
UDPLocalPortBlackList=1-1024
CitrixReport=true
CitrixStatInterval=10
ProcessStatInterval=10
DiskIOReport=true
CPUUsageLimit=1
CPUTop=0
MemTop=0
GUIMode=Icon Window NoExit AutoHide SendReport
SocketReadTimeOut=6000
keepalivefilter=Server=0.0.0.0/0 Port=0-65535 Type=TCPKeepAlive\tServer=0.0.0.0/0 Port=139
Type=NetBiosKeepAlive
TelnetClientList=127.0.0.1/8
ReportInterval=60
HistogramIntervals=10,20,50,100,200,500,1000,2000,5000"
```