Welcome to the Ranorex Support Portal

Set up an Azure Pipelines agent

To execute an Azure DevOps pipeline, you need an Azure Pipelines agent. This is a standalone program that’s similar to a Ranorex Agent. You install it on a physical or virtual machine, connect it to Azure DevOps, and can then pass pipelines to the agent for execution.

On this page, you’ll find out how to set up and start an agent. We’ll only cover what’s relevant for executing a Ranorex Studio solution through an Azure DevOps pipeline. For all other topics, please refer to the official Azure DevOps documentation.

In this chapter

Download an agent

To download an agent:

  1. In the bottom left of your Azure DevOps project, click Project settings.

  2. Click Agent pools.

  3. Select an available agent pool. You can select from a hosted pool or from a local pool (default).

Note Icon


The following instructions assume a default local pool.

  1. In the agent view that appears, click New agent.

  2. Select Windows as OS, your OS’s architecture (x64 or x86), and click Download.

  3. Unpack the downloaded .zip file to a folder of your choice.

The unpacked agent files.

Configure the agent

To configure the downloaded agent:

  1. Double-click the file config.cmd.

  2. Configure the agent as follows:

This is a basic userguide text with all paddings and margins set correctly. Just use all text styles H2, H3 etc… as you want. If you need to define Key strokes like CTRL do it like this here.

  1. Paste the Azure-DevOps project URL from your browser’s address bar.

  2. Press Enter to use PAT as authentication type.

  3. In the Security menu of your Azure DevOps account, create a full-access PAT and paste it here.

Note Icon


The generated PAT is visible only once and can’t be recreated. Copy and paste it immediately after generating it.

  1. Press Enter to select the default local pool.

  2. Press Enter to confirm the agent’s name or change it.

  3. Press Y if you have previously had an agent installed on this machine; press Enter if not.

  4. Press Enter to confirm the work folder or change it.

  5. Press N. The agent must not be run as a service.

  6. Press Y.

Start the agent

To start the agent:

  1. In the folder to which you unpacked the agent files, double-click run.cmd.

The agent starts, connects to the server, and idles until it receives a pipeline to execute.



Get the latest test automation information right in your mailbox.


© 2024 Ranorex GmbH. All Rights Reserved