SUPPORT

Contact Support

OPEN A TICKET

Agents in Netsparker Enterprise On-Premises

An Agent is a Docker, Linux and Windows service application that executes scans and informs the Netsparker Enterprise application.

It is available in both the Netsparker Enterprise On-Premises and On-Demand editions.

  • At least one agent must be configured for each account
  • Users with Administrator permission can configure this setting

Filter the list of agents by clicking on the search icon () next to a column title and entering search criteria, as displayed in the screenshot.

For further information on Agents, Installing and Configuring Netsparker Enterprise On-Premises.

You can install internal agents in Linux and Docker, too. For further information about installing agents in Linux, see Installing a Scan Agent on Linux. For the docker, see Installing a Scan Agent via Dockerization.

Managing Agents

On the Agents page, you can view the details and current state of all Agents. You can also disable them and add new Agents to the list.

Manage Agents Fields

This table lists and explains the fields in the Agents window.

Field

Description

Name

This is the name of the agent.

State

This is whether the agent is online and waiting for a scan assignment.

  • Available
  • Launching
  • Waiting
  • Scanning
  • Terminated
  • NotAvailable

Launch Date

This is the date when the agent was first available.

Last Heartbeat

This is the last time the agent communicated with the web application.

Version

This is the version number of the scan agent.

This table lists the fields displayed when you click Expand for each listed Agent.

Field

Description

Is Up To Date

This is whether the Agent is up-to-date.

Operating System

This is the operating system on which the Agent is installed.

Installed Framework

This is the .NET environment on which the Agent is running.

Operating System Architecture

This is the operating system architecture on which the Agent is installed.

Target URL

This is the target URL of the website, including the path.

Process Architecture

This is the process architecture on which the Agent is installed.

IP Address

This is the IPv4 version of the Agent.

How to Configure an Agent for a Website

  1. From the main menu, select Agents Manage Agents
  2. On the Agents page, select Configure New Agent.

  1. Copy the Agent Token to the appsetting.json file of the other Agent that you manually installed.

How to Disable an Agent

  1. From the main menu, select Agents Manage Agents
  2. On the Agents page, select the Agent you want to disable, and select Disable in their field. The Disable Agent dialog is displayed.

  1. Select Yes, Disable.

How to View Commands for an Agent

  1. From the main menu, select Agents Manage Agents. The Agents window is displayed.
  2. On the Agents page, select the relevant agent.

  1. From the Commands drop-down, select View Agent Commands.

Managing Groups

In the Manage Groups window, you can search for and view the names of the different agent groups. You can also edit or delete their details, and add a new agent group.

How to Add a New Agent Group

  1. From the main menu, select Agents Manage Groups

  1. On the Agent Groups page, select New Agent Group
  2. On the New Agent Group page, complete the Name and Agents fields.
  3. Select Save.

How to Edit Agent Groups

  1. From the main menu, select Agents Manage Groups
  2. On the Agent Groups window, select Edit on the field of the group you want to edit. 
  3. On the New Agent Group page, make your edits.
  4. Select Save.

How to Delete Agent Groups

  1. From the main menu, select Agents Manage Groups

  1. On the Agent Groups page, click Delete. The Delete Agent dialog is displayed.
  2. Select Yes, Delete.

Setting Proxy in Scanner Agents

You can set a proxy for the scanning agent in Netsparker Enterprise. You are required to enter proxy settings manually to the appsettings.json file with your preferred text editor. 

Netsparker supports Basic Authentication but not Digest and NTLM.

  "ProxySettings": {
    "ProxyMode": "SystemProxy",
    "UseDefaultCredentials": true,
    "Username": "",
    "Password": "",
    "Domain": "",
    "Address": "127.0.0.1",
    "Port": "8888",
    "ByPassOnLocal": false,
    "ByPassList": []
  },

This table lists and explains the fields in the Proxy settings.

Field Description
Proxy Mode Enter your proxy settings if you want the Agent to use or not to use the proxy. There are three modes:
NoProxy: The Agent does not use a proxy even if you configure the server's proxy settings.
SystemProxy: The Agent uses the System Proxy that was defined on the server.
CustomProxy: The Agent uses Custom Proxy that you define in the appsettings.json file.
Use Default Credentials Enter true if you authenticate to the proxy via the user that the Agent service is defined.
Use System Default Enter true if you authenticate the agent via operating system credential
Username Enter a username for authentication
Password Enter a password for authentication
Domain Enter a domain name
Address Enter a proxy address. Only IP address or hostname without schema and port is allowed.
Port Enter a port for the proxy
Bypass on Local Enter a value that indicates whether to bypass the proxy server for local addresses.
Bypass List Enter the address(es) that do not use the proxy server.
Any changes in the appsetting.json file, such as setting proxy and changing API Token, require restarting the service so that the changes can take effect.

Accessing Agent Logs

The Netsparker Enterprise Scanning Agent stores application logs in the Logs folder in the installation path.

With the latest version of the Agent, the last three days’ logs can be downloaded from the Manage Agents page. These logs are especially useful for troubleshooting.

How to Request Agent Logs

  1. From the main menu, select Agents Manage Agents.

  1. Next to the relevant Agent, select the Command drop-down, then Request Agent Logs.

  1. Once you confirm, the logs will be requested from the target agent and can be downloaded from the UI.

  1. Alternatively, when target logs are ready, you will receive a notification. Click the bell, then select the relevant notification.

  1. Select Download Logs. The download will start.
Netsparker

Highly accurate, fast & easy-to-use Web Application Security Scanner

Get a demo