Install an OPLG - Windows

Use on-premises load generators to run load tests on applications that cannot be accessed over your firewall.

In this topic:

Prerequisites

To help ensure the successful installation of an on-premises load generator, enable Windows Script Host on the load generator machine.

Back to top

System requirements

Memory, CPU, and free disk space requirements vary per protocol, system under test, and script characteristics.

We recommend that you always use the most current version of the on-premises load generator:

On-premises load generator version	24.1 - Using LoadRunner load generator 24.1
Supported operating systems	Microsoft Windows 10 64-bit versions Enterprise LTSC 2019, 21H2, 22H2 Microsoft Windows 11 64-bit versions 21H2, 22H2, 23H2 Microsoft Windows Server 2016 Microsoft Windows Server 2019 (Recommended) Microsoft Windows Server 2022
Processor	8 core CPU
Memory	16 GB
Free disk space	100 GB; SSD drive Note: During installation, the installer checks for space on the drive on which the temp directory is located (as configured in the user’s local environment variables).
Bandwidth	A bandwidth of at least 1 GB is recommended for communicating with the OpenText Core Performance Engineering servers.

Back to top

Notes and limitations

The following notes and limitations apply to on-premises load generators:

Limitation/Note	Solution
.NET 3.5	If your scripts require .NET 3.5, you must manually install or activate them on the on-premises load generator machine.
WSE	If your scripts depend on Web Services Enhancements (WSE), you must manually install WSE 2.0 SP3 and WSE 3.0 for Microsoft .NET. Note: Both WSE installations require .NET 3.5.
Axis	If your Web Services scripts depend on the obsolete Axis toolkit, you must manually copy the Axis files to %LG_PATH%bin\java\Axis. You can download the Axis files from the OpenText Support Portal.
Date and time	Ensure that the date and time on the load generator machine are correct. Tip: Synchronize your computer clock with an Internet time server.
Connection between LGs and OpenText Core Performance Engineering	The load generator machine needs to be able to access the OpenText Core Performance Engineering servers in SaaS and the cloud machines. (Only outbound HTTPS connection on port 443 needs to be enabled.) If there is no connection between OpenText Core Performance Engineering servers and the Load Generator (on-premises load generator Status=Not Connected), an error message is reported when you try to run your test. If you receive a system error -1030, check the network connectivity between your on-premises load generator and the cloud (AWS). Also ensure that outbound communication over port 443 is enabled. If your company's security or firewall requires static IP addresses for allowed lists, submit a service request to request the IP addresses. For details, see Dedicated IP addresses.
One test per load generator	The load generator can run only one test at a time. If the required load generator is already in use by another test, an error message is reported when you try to run your test.
Vusers	Vusers in your on-premises load test cannot exceed the maximum number of Vusers in your license.
Security	Ensure that the OS, as well as any protocol prerequisites (for example, JDK and .NET), have the latest security updates.
Multiple IP addresses	If you have requested multiple IP addresses for a load test, ensure you have assigned all the valid IP addresses to the load generator machine so that OpenText Core Performance Engineering can use them during the test. For details on working with multiple IP addresses, see Enable multiple IPs for cloud and on-premises load generators.

Back to top

Set up an on-premises load generator

This section describes how to set up and install an on-premises load generator.

The installer package, OneLG, is a combined load generator installer for all of the LoadRunner family products: LoadRunner Professional, LoadRunner Enterprise, and OpenText Core Performance Engineering. During the installation, you select the relevant product to allow the installation to make the appropriate configurations. After the load generator installation is complete, you can reconfigure the load generator to work with a different tool from the LoadRunner family.

Action	Task
Define your load generator in OpenText Core Performance Engineering and note the key:	In OpenText Core Performance Engineering, select Assets > Load Generators. Select the load generator from the list, or click Create to add one. Give the load generator a meaningful name and description. Select the relevant operating system. Set the maximum number of Vusers for each supported protocol. Default values are displayed. Click Save. A key is generated for the load generator and is displayed in the details. Copy the Key value for later use.
Download the load generator installation package	On each machine on which you want to install a load generator, download the installation .zip file from LoadRunner Cloud banner > Tools and Integrations > Agents > OPLG, and extract the contents. Note: To help ensure the successful installation of an on-premises load generator, enable Windows Script Host on the load generator machine.
Install the load generator components	If the machine on which you want to install the load generator already contains an on-premises load generator, refer to Update an OPLG. Manual installation Unzip the downloaded load generator installation package, SetupOneLG.zip. Run the extracted file SetupOneLG.exe as an administrator. Extract the installation packages into a temporary folder. Install the required prerequisite programs when you are prompted to do so. Accept the license agreement and select the installation location. By default, the location is C:\Program Files (x86)\Micro Focus\LoadRunner OneLG. We recommend that you use the location: C:\LoadRunnerCloudLG. In the LoadRunner OneLG Configuration step, select LoadRunner Cloud and click Install to start the installation of the load generator and the other required applications. When the installation is complete, the setup program creates the LoadRunner Cloud - Configure Load Generator and LoadRunner Cloud – Start Load Generator shortcuts on the Desktop, and opens the load generator configuration tool. To skip the configuration at this point, close the tool. You can configure it later. Note: The load generator and the OpenText Core Performance Engineering server can communicate only after the load generator is configured properly. If you receive an error during the installation indicating that there is not enough disk space, refer to Troubleshooting for possible solutions. To run JMeter, Gatling, and/or Silk Performer scripts on on-premises load generators, make sure to select the Install JMeter/Gatling/Silk Performer Agent after installation option during setup.
Configure the load generator	On the General tab, enter: The load generator key that you noted earlier Your credentials: the OpenText Core Performance Engineering username/password or client ID/secret key. Tenants created before version 24.3 can authenticate using the username/password or OAuth authentication methods. However, tenants created for version 24.3 and higher may only authenticate with the OAuth method with a client ID and secret key. The preferred and more secure method is to always authenticate with a client ID and secret key, even for earlier versions. For details, see API access keys. Your Tenant ID On the Misc tab: To use a different proxy other than the one shown, enter your proxy URL. If your proxy requires authentication, select the Advanced tab to enter your credentials. Note: This is necessary only if the Load Generator machine cannot directly access the Internet. Select a Log level. Click Save & Test to save your settings and test your connection to the OpenText Core Performance Engineering server. Tip: If you get an error, check that the configuration details that you provided are correct. For more information on configuring the load generator, see OPLG configuration tool.
Launch the load generator	Go to Start > Micro Focus > LoadRunner Cloud - Start Load Generator. Tip: For best results, run the load generator as an administrator.

Back to top

OPLG configuration tool

If you skipped the load generator configuration when you installed or updated the on-premises load generator, or if you need to update the configuration settings:

Go to Start > ...> - Configure Load Generator.

Back to top

Run the load generator as a service

To run an on-premises load generator as a service:

1. Open the built-in Windows Task Scheduler (Control Panel > Administrative Tools > Schedule tasks).

2. Schedule a task which automatically starts the LoadRunner Cloud - Load Generator Agent at system startup.

   • The executable file of the agent is
     %LG_PATH%LRC\testexec.server\stormagent\bin\start_stormagent.cmd.
   • You can also find the file location through the Desktop shortcut.

Back to top

Multiple IP addresses

You can configure a load test to use multiple IP addresses on an on-premises load generator.

Action	Task
Enable multiple IP addresses	Contact your account manager or sales representative.
Enable multiple IP addresses for a load test	From LoadRunner Cloud > Load tests > Test settings, select the Enable multiple IP addresses checkbox.
Allocate sufficient IP addresses	You must ensure that you have allocated the required number of valid IP addresses on the relevant on-premises load generator.

For more information, see Enable multiple IPs for cloud and on-premises load generators.

Back to top

Run tests on OPLGs

This section describes how to run a test using an on-premises load generator.

To set up an on-premises test run:

1. Go to the Load tests tab and select a load test.
2. Go to the Load profile pane and select a script . Expand the Location dropdown and select On-premises. If there are no scripts listed, click the Add from Assets button to select one or more scripts from the repository.
3. Go to the Load distribution pane and click the On-premises tab. Click the + Add from Assets button to select the on-premises load generators to use for your test.
4. To customize the number of allowed Vusers per protocol, select one of the on-premises servers, and click the Edit button. Customize the number of Vusers for the desired protocols.

For more information, see Tests.

Back to top

Update an OPLG

This section describes how to update an OPLG (on-premises load generator) to the latest version.

Back to top

Perform a silent OPLG installation

A silent installation, also known as unattended install, has multiple benefits. If you installed the OPLG (on-premises load generator) with the latest OneLG installation, you can imbed a silent installation into the software installation process.

This capability allows you to automate installation and updates on multiple remote machines, instead of having to log in to each machine separately and manually installing the OPLG.

Prerequisites

The following are the prerequisites for performing a silent installation:

• .NET 4.8. If .NET 4.8 is not installed on the OPLG machine, install it before running the silent installation. Otherwise the machine requires a restart and you need to run the silent command again.

• Termination of existing processes. Make sure the existing OpenText Core Performance Engineering load generator agent on the machine has been closed, and all OpenText Core Performance Engineering load generator agent processes have been terminated. Agent processes that are still running may prevent the installation from updating the agent during the silent installation.

Silent installation

Perform the following steps to run a silent installation on an OPLG:

1. Open a Windows command line as an administrator.

2. Enter the command for your installation type:

   • Silent installation

     For a basic silent installation only, enter the command:

     Copy code

     SetupOneLG.exe -s -sp"/s INSTALLDIR=C:\LoadRunnerCloudOneLG IS_RUNAS_SERVICE=2 NVINSTALL=N"

   • Silent installation to a location path that includes a space

     To perform a silent installation in a location where the path name includes a space, enclose the path name with double quotes. For example:

     Copy code

     SetupOneLG.exe -s -sp"/s INSTALLDIR=""C:\Program Files (x86)\LoadRunnerCloudOneLG"" IS_RUNAS_SERVICE=2 NVINSTALL=N"

   • Silent installation and configuration

     To configure a load generator as part of the silent installation, you can set the LRC_PARAMS parameter to the full path of a YAML file that contains the configuration options. For example:

     Copy code

     SetupOneLG.exe -s -sp"/s INSTALLDIR=C:\LoadRunnerCloudOneLG IS_RUNAS_SERVICE=2 NVINSTALL=N LRC_PARAMS=C:\Temp\config.yml"

     The following configuration options are defined in the YAML file:

     Field	Description	Example	Mandatory/Optional
     tenant	Tenant Id	‘123456789’	Mandatory
     key	Load generator key	‘2fc1f0632fa263f9bd49’	Mandatory
     username	Username or client Id	‘<username>’	Mandatory
     password	Password or secret key	‘<password>’	Mandatory
     proxy	Proxy server address and port	‘http://<your proxy server>:<port>’	Optional
     logLevel	Log level (info, error, debug, warn)	‘info’	Optional
     options	Additional options	option1: true option2: true	Optional

     You can copy the following code into your YAML file and then change the values for your load generator:

     Copy code

     tenant: '123456789'
     key: '2fc1f0632fa263f9bd49'
     username: '<username>'
     password: '<password>'
     proxy: 'http://<your proxy server>:<port>'
     logLevel: 'info'
     options:
       option1: true
       option2: true

     Note: Tenants created before version 24.3 can authenticate using the username/password or OAuth authentication methods. However, tenants created for version 24.3 and higher may only authenticate with the OAuth method with a client ID and secret key. The preferred and more secure method is to always authenticate with a client ID and secret key, even for earlier versions.

   • Enable JMeter or Gatling

     To run JMeter or Gatling scripts on the load generator, you can install JMeter or Gatling as part of the installation by adding INSTALL_JMETER=1 or INSTALL_GATLING=1 to the installation command. For example:

     Copy code

     SetupOneLG.exe -s -sp"/s INSTALLDIR=C:\LoadRunnerCloudOneLG IS_RUNAS_SERVICE=2 INSTALL_JMETER=1 INSTALL_GATLING=1 NVINSTALL=N"

3. (Optional) Automatically configure a load generator machine after the silent installation:

   • If the machine did not have an OPLG installed prior to the silent installation, copy the sample_conf.json you previously saved to the %LG_PATH%LRC\testexec.server\stormagent\ folder. If you copy the configuration file from an existing machine with a configured load generator, modify the "key" field accordingly, because the same key cannot be used by multiple OPLGs.

   • If the machine had an OPLG installed prior to the silent installation, no action is required. The installer automatically upgrades the existing OPLG and backs up the %LG_PATH%LRC\testexec.server\stormagent\sample_conf.json file. At the completion of the silent installation, the OPLG configurations are automatically stored.

Back to top

Uninstall an OPLG

Depending on the version of on-premises load generator you want to uninstall, locate the program in the Windows Programs and Feature list, and uninstall it:

• Micro Focus LoadRunner OneLG for version 2020.07 and later.

• LoadRunner Cloud - Load Generator for version 2020.05 or earlier.

Back to top

See also:

• OPLG requirements
• OPLG configuration tool
• Troubleshooting OPLGs
• Deploy an OPLG on Linux
• Performance Engineering on Marketplace