Manage the Load Generator Agent

The Load Generator Agent manages Load Generator sessions to stress a server. Starting a Load Generator Agent only is useful to make the best of the capacity of a machine dedicated to run Virtual Users.

Load Generator Agents are managed in the NeoLoad Controller. When on the same network, the NeoLoad Controller automatically detects the Load Generator Agents available. When automatic detection is impaired (firewalls, routers, and so on), the Agents must be specified in the Controller. For more information, see Zones and Load Generator hosts.

You need to first install the Agent, either within a Controller or as a standalone installation. For more information, see Install the Controller and Install a Load Generator Agent.

When installed, the NeoLoad Controller includes an embedded Load Generator Agent and a standalone Load Generator Agent. The standalone Agent and the Controller cannot both run at the same time.

Configure the Load Generator Agent

The Load Generator that starts with the Controller is only available from localhost to design the User Paths, and it only allows connection to a trusted Controller. To change these default settings to allow any address and all Controllers, go to the <installationDirectory>/conf/agent.properties file and update the following lines in the [Network] section:

  • Change agent.server.address=127.0.0.1 (localhost only) to agent.server.address=0.0.0.0 (any address)

  • Change agent.accept.only=TRUSTED to ​agent.accept.only=ALL

When you use a new Controller certificate, you also need to update the agent.accept.fingerprints= setting to declare the certificate fingerprint. For detailed instructions, see how to add a new certificate.

Tip: If you need to use different values for these settings, you can use commandline arguments for a one-time override of the configuration file: --agentAcceptOnly and --acceptFingerprints

Start the Load Generator Agent

The Load Generator Agent can be launched:

  • on Windows:

    • with the Start Load Generator Agent shortcut in the Start > Programs menu, or

    • with the NeoLoad 2025.1\bin\LoadGeneratorAgent.exe executable, or

    • as a service in the Windows services control panel for a Load Generator Agent installation only.

  • on Unix:

    • with the command NeoLoad 2025.1/bin/LoadGeneratorAgentService start, or

    • with the command NeoLoad 2025.1/bin/LoadGeneratorAgent, or

    • when installed using the root account, with the service LoadGeneratorAgentService start command using the root account.

To start the Load Generator Agent on Windows

By default, the Load Generator Agent on Windows is started in non-privileged mode (as a normal user, not administrator). In non-privileged mode, the following function is not available: WAN Emulation on the local Load Generator, described in WAN emulation.

  • To start the Load Generator Agent in non-privileged mode:

    • In Start > Programs, click Start Load Generator Agent, or

    • Run NeoLoad 2025.1\bin\LoadGeneratorAgent.exe, or

    • Start the Load Generator Agent service for a Agent-ony installation.

  • To start the Load Generator Agent in administrator mode (once):

    • Right-click LoadGeneratorAgent.exe and select Run as administrator.

  • To always start the Load Generator Agent in administrator mode:

    • Right-click LoadGeneratorAgent.exe and select Properties.

    • On the Compatibility tab, select Run this program as an administrator.

To start the Load Generator Agent on Unix

  • Run NeoLoad 2025.1/bin/LoadGeneratorAgent, or

  • Run NeoLoad 2025.1/bin/LoadGeneratorAgentService start, or

  • Run service LoadGeneratorAgentService start with the root account.

Start additional Load Generator Agents

Additional Load Generator Agents can be started by specifying a port number at launch time.

To add a Load generator Agent, open a command prompt and enter the following line:

  • 2025.1/bin/LoadGeneratorAgent -port <port number> start

To add an additional Load Generator Agent, you can also set the following environment variable:

  • On Unix: export AGENT_PORT_SERVER=<port number>

  • On Windows: set AGENT_PORT_SERVER=<port number>

Start the Load Generator agent in Terminal Services mode

If the NeoLoad Terminal Services feature cannot be used for any reason and a custom script is required, here is the command to start a Load Generator Agent in Terminal Services mode:

  • NeoLoad 2025.1\bin\LoadGeneratorAgent.exe -terminalServices

The Load Generator then uses a unique working folder and picks an available port dynamically. Add the Load Generator to NeoLoad by using the Bind action from the Terminal Services feature. For more information, see Terminal Services.

Stop the Load Generator Agent

According to the installation mode (standalone Agent or Controller), the Load Generator Agent can be stopped:

  • on Windows:

    • with the Shutdown Load Generator Agent shortcut in the Start > Programs menu, or

    • as a service in the Windows service control panel for a Load Generator Agent installation only, or

    • with the command line NeoLoad 2025.1\bin\LoadGeneratorAgent.exe -stop, or

    • with the NeoLoad icon of the system tray.

  • on Unix:

    • with NeoLoad 2025.1/bin/LoadGeneratorAgentService stop when the Agent has been started with NeoLoad 2025.1/bin/LoadGeneratorAgentService start, or

    • with NeoLoad 2025.1/bin/LoadGeneratorAgent -stop, or

    • with service LoadGeneratorAgentService stop when the Agent has been started with service LoadGeneratorAgentService start, or

    • with the NeoLoad icon of the system tray, when available.

To stop the Load Generator Agent on Windows, follow these steps: 

  • In Start > Programs, click Shutdown Load Generator Agent, or

  • For a Agent-only installation, stop the Windows service for the Load Generator Agent, or

  • Run NeoLoad 2025.1\bin\LoadGeneratorAgent.exe -stop, or

  • Exit the Agent from the systray.

To stop the Load Generator Agent on Unix, follow these steps: 

  • Run NeoLoad 2025.1/bin/LoadGeneratorAgentService stop when started with NeoLoad 9.0/bin/LoadGeneratorAgentService start, or

  • Run NeoLoad 2025.1/bin/LoadGeneratorAgent -stop, or

  • Run service LoadGeneratorAgentService stop when started with service LoadGeneratorAgentService start, or

  • Exit the Agent from the systray, when available.