Subscribe

UiPath Orchestrator

The UiPath Orchestrator Guide

Automation Cloud™ robots - VM

UiPath Automation CloudTM robots - VM, or cloud robots - VM for short, make it easy to set up the necessary infrastructure to run automations.
We handle all the work behind the scenes and give you a virtual machine on which to run automations. The only thing you have to do is configure the virtual machine and run jobs.

 

Step 1. Creating the cloud robot pool


You must create a new machine template of the type Cloud Robots - VM.

Machine templates allow you to configure properties that will apply to all Cloud Robots - VM machines created from it. Then, whenever you need machines, we create as many machines as needed that are exactly like the template.

  1. Go to Tenant > Machines.

  2. In the top-right, click Add Machines and select Cloud Robots - VM.

    The Add Cloud Robots - VM page opens:

10031003
  1. Fill in the Name field and, optionally, fill in the Description field for the machine template.
    The Execution slots per machine field is automatically set to 1 and you cannot change it. This means any machine created from this template can run only one job at a time.
  2. Click Next to move to the next step.
    The VM & Runtime details page is displayed:
965965
  1. From the VM size list, choose the type of machine that has the technical specifications you need.
    Each machine created from this template requires the number of Robot Units (RUs) shown on the right. Make sure you have enough Robot Units assigned to your tenant, otherwise you can't create machines.

  2. Under Machine Image, select:

    Then select the machine image from the list.

  3. Under IP Address, select if you want the machine to use a dynamic IP address, or use a static one.
    By default, VMs use a dynamic IP address. If you do not change this setting to Static, the VM acquires a different IP address every time it starts.

  4. Click Next to move to the next step.
    The Pool Configurations page opens.

  5. (Optional) If you want to set a periodic timeframe for installing push updates on VMs that belong to this templat, click Enable maintenance window.
    The Maintenance Window section is displayed. Here, you can set a span of time when all machines that belong to this template go into maintenance mode and can receive push updates, such a Windows security updates. For more information, see the FAQs.
    a. From the Timezone list, select the timezone to use for scheduling the maintenance window.
    b. Under Recurrence, select the frequency for the maintenance window and then fill in the fields for the selected option.
    c. Under Additional options, select how long you want the window to last.
    The window starts as indicated under Recurrence and ends after the amount of time you select here.
    d. If you want to make sure that maintenance is performed as scheduled, select the checkbox Kill running processes when window begins.

  6. (Optional) If you have a VPN gateway already set up for this tenant and you want to allow machines that belong to this template to access company resources that are behind a firewall:
    a. Click Connect VPN Gateway.
    The VPN gateway section is displayed.
    b. In the Address space for VNet field, add the reserved IP addresses you received from your network administrator, in CIDR notation with a mask of /24.

📘

VPN Gateway is currently in private preview and is only available to customers who have signed up from the UiPath Insider Portal.

  1. Click Finish to create the template.

On the Machines page, a success message is displayed along the top and you can see your new template in the list.

 

Step 2. Creating machines


Now that you have configured the cloud robot pool, you can add machines to the pool.

  1. Go to Tenant > Machines.
  2. At the right of the pool row, click and select Manage Cloud Robots - VM:
11581158

The Manage Cloud Robot - VM page opens.

  1. In the top right, click Add Virtual Machine.
    The Add Virtual Machine page opens.

📘

If, at the bottom, the Cost is displayed in red font, this means there are insufficient robot units (RUs) available in the tenant and you cannot create a new machine.
If you are an organization administrator in Automation Cloud, you can click Add more robot units to the tenant balance to go to Admin > Tenants and allocate the needed RUs to this tenant.
Otherwise reach out to your organization administrator to request additional RUs.

  1. (Optional) Fill in the Alias field with a name to help you distinguish the machine.
  2. Fill in the username and password fields with administrator credentials you want to set for the VM.
  3. Click Provision.

Back on the Manage Virtual Machines page, a success message is displayed along the top and the machine appears in the list with a machine status of Provisioning.
It may take a few minutes to complete provisioning. All machine options are unavailable until the machine is provisioned.

After provisioning is complete, the machine status changes to Running.

 

Step 3. Customizing the machine (optional)


While the machine is running, you can connect to it through Windows Remote Desktop and customize its configuration.

  1. Go to Tenant > Machines.
  2. At the right of the pool row, click and select Manage Virtual Machines.
  3. On the Manage Virtual Machines page, check that the Machine Status column shows Running for the machine.
    If the machine is stopped, at the right of the row, click and select Start Virtual Machine. Wait a few minutes until the status changes to Running.
  4. (Optional) If the Accept Jobs column shows Enabled for the machine, click and select Disable Accept Jobs. Wait a few moments for the status to change to Disabled.
    We recommend doing this to prevent our auto-scaling engine from shutting down the machine while you are connected to it. This can happen if the machine becomes idle, even if your are connected to it.
  5. Check that the Remote Desktop column shows Enabled for the machine.
    If disabled, at the right of the row, click and select Enable Remote Desktop. Wait until the Remote Desktop value changes to Enabled.
  6. In the Remote Desktop column, click the info icon to see the IP address for the machine and copy it.
  7. Connect to the machine using Windows Remote Desktop as follows:
    • use the machine's IP address
    • use the admin credentials you defined for the machine; if you do not remember the credentials, you can reset them.
  8. Now you can customize the machine as needed, by installing or updating software, or by changing its configuration.

📘

The machines we provide have UiPath Robot software and the supported web browsers preinstalled.

Do not modify UiPath software on the machine because these changes may cause problems.

  1. (Optional) When you finish the configuration, log out of the machine and then disable remote desktop for the machine from Orchestrator.
    Remote desktop is automatically disabled on the machine after 24 hours.
  2. If you disabled Accept Jobs for the machine earlier, on the Manage Virtual Machines page, click and select Enable Accept Jobs to re-enable it.

If you want to use this customized machine for a machine template, you can create a customized image. You can then use the customized image when creating new cloud robot pools, instead of a standard machine image.

 

Step 4. Preparing cloud robots for use


To be able to run automations with your new cloud robots, some setup is required in Orchestrator:

Step 4a. Accept jobs on the machine

A newly-provisioned machine is not set to accept jobs by default. After any configuration you want to perform is complete and the machine is ready for use, you must manually set it to accept jobs.

To allow a machine to be used for running jobs:

  1. Go to Tenant > Machines.
  2. At the right of the pool row, click and select Manage Virtual Machines.
  3. On the Manage Virtual Machines page, at the right of the machine row, click and select Enable Accept Jobs.

A success message is displayed along the top and the Accept Jobs column shows Enabling.
After a few moments, when the status changes to Enabled, the machine can be used to run jobs in the folders where the pool is assigned.

👍

Auto-scaling

After a machine is set to accept jobs, our auto-scaling engine takes control and has the ability to shut down and start machines automatically.

Step 4b. Add the pool to folders

Add the Cloud Robots - VM machine template to folders which contain unattended automations that you want to run using cloud robots.

Step 4c. Use cloud robots to run jobs

Now you and your users can start to run unattended automations using cloud robots.

To run a job using cloud robots: Start a job as you normally would, but for the Runtime license select Cloud Robot - VM.

  • Some fields which do not apply when the runtime is Cloud Robot - VM are not available or cannot be edited. Configure job execution using the available options.
  • In the case of cloud robots, selecting the Keep Account/Machine allocation on job resumption checkbox means the job resumes on a machine that was created from the same template, not necessarily the exact same machine.

The job will run on one of the available machines in the machine template that is allocated to the folder.

 

Reusing customized machine images


If you have a machine that you have customized according to your automation needs and you want to reuse it, you can create an image of the customized machine. This creates a disk capture that is available to use in a new Clooud Robots - VM template as a customized machine.

To create an image of a customized machine:

  1. Go to Tenant > Machines.
  2. At the right of the pool row, click and select Manage Cloud Robot - VM.
  3. On the Manage Virtual Machines page, check that the Machine Status column shows Stopped for the machine.
    If the machine is running, at the right of the row, click and select Stop Virtual Machine. Wait until the status changes to Stopped.
  4. Check that the Accept Jobs column shows Disabled for the machine.
    If enabled, at the right of the row, click and select Disable Accept Jobs. Wait until the status changes to Disabled.
  5. At the right of the machine row, click and select Capture Image.
    You can create up to 20 custom images. If you cannot create a new one, consider deleting custom images to allow for creating new ones.
    The Capture machine as base image dialog opens:
500500
  1. Fill in the Image Name field and, optionally, also fill in the Description field.
  2. Optionally fill in the Implicit Username field with the user name you want VMs to use by default.
    If you leave the Implicit Username field blank, the username uirobot is used.
  3. Click Create.
  4. Restart the machine ( > Start Machine) and then re-enable accept jobs for the machine if you want it to be available for running jobs.

After the custom image is created, you can use it as the base image for a Cloud Robot - VM machine template by selecting Customized for the Machine Image while creating the new template.

Managing custom images

You can have up to 20 custom images of cloud robot machines.
If you can no longer create new ones, consider deleting some of your unused images as described below.

To view and manage your customized machine images for Cloud Robot - VM:

  1. Go to Tenant > Settings and select the Cloud Robot Images tab:
977977

All your existing images are listed on the page.

  1. At the right of the image row, click and select:
    • Edit Image to change the name or description of the image.
    • Delete Image if you want to remove the image so that it is no longer available for use.

 

Resetting credentials for a machine


If you forgot the administrator credentials for one of your machines, you can set a new username and password.

  1. Go to Tenant > Machines.
  2. At the right of the pool row, click and select Manage Virtual Machines.
  3. On the Manage Virtual Machines page, at the right of the machine row, click and select Reset Admin Account.
  4. On the Reset Admin Account page, define a new username and password for the administrator account of the machine.
    The old credentials will no longer work after the reset.
  5. Click Update.

 

Monitoring


You can monitor your cloud robots to check for errors on the following pages:

  • You can see pending jobs that are waiting for an available machine on the Jobs page.
  • You can see the created virtual machines in Orchestrator, on the Monitoring page of the modern folder. When a machine becomes available, it is already connected to Orchestrator, so it runs the next pending job.
    If virtual machines are not being created, check the configuration of your cloud robot pool in Orchestrator.
  • On the Alerts page in Orchestrator, you can set the State filter to All to see details about the Cloud Robots component and see as new robots are created or any errors. To see alerts, you need to have the Alerts - View and Machines - View permissions from a role that is directly assigned to your account (not inherited from groups), and to be added to the folders where cloud robots are used.
  • You can view logs for a particular VM, as described below.

Viewing logs for a machine

Logs are valuable reports used by administrators for diagnosing and troubleshooting machines. They provide detailed reports on important events happening on a machine such as machine events, job events, or Azure issues.

Logs are kept for 30 days. The oldest log entry is the first one deleted at the end of the retention period.

To view logs for your machine:

  1. Go to Tenant > Machines.
  2. At the right of the pool row, click More Actions and select Manage Cloud Robot - VM.
  3. On the Manage Cloud Robot - VM page, at the right of the machine row, click More Actions and select View Logs.
13341334
  1. On the Machine Event Logs page, you can see logs generated for that machine, most recent logs displayed first.
  2. For details about one of the logs, click Show details at the right of the log row. The Log details window shows a detailed report about that specific event.
13361336

 

Frequently asked questions


About machines

What does a standard machine include?

All standard machines that we provide are Microsoft Azure virtual machines of the type Standard_E2s_v4, which have sufficient computing power for basic automations.

In addition, all standard VMs come with:

  • the UiPath Robot software preinstalled (details below)
  • the supported web browsers you might need for running automations.

If you need additional software or to set up the VM in a certain way, you can further customize it.

When are UiPath Robot updates applied?

We take care to update your VMs to use the latest version of UiPath Robot within approximately 2 weeks of a new version becoming available.
The update happens:

  • when a machine needing an update first starts
  • before a machine that was running jobs shuts down
  • for machines that are in constant use and are not able to receive the update for 2 weeks since the update was available, we schedule a short maintenance window on the machine to apply the update.

Where are virtual machines created?

All virtual machines are created and hosted in our Microsoft Azure subscription.

In which region are virtual machines hosted?

All virtual machines are created and hosted in the tenant region.
Organization administrators can see what the region is for a tenant in Tenant Settings (Admin > Tenants).

About the maintenance window

Will the machine images that I created be automatically updated with the latest Windows version and updates?

No. If you want to install the latest Windows version and updates, you can:

  • connect to the machine using RDP to manually update Windows.
    Then, if you want, you can also create an image of the customized machine and use it in other machine templates.
  • configure a maintenance window for the template when you can push updates to all machines.

Does the maintenance window apply for all machines?

Only machines that belong to the machine template where the maintenance window was configured and for which Accept Jobs is Enabled enter the maintenance window.
Machines that are not running are automatically started for the maintenance window.

Are robot units consumed during the maintenance window?

The required robot units are consumed once per month, when the machine first starts. After that, it can run indefinitely for the whole month without consuming additional robot units.

Updated 8 days ago


Automation Cloud™ robots - VM


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.