UiPath Robot Guide

Regutil Command Descriptions

Regutil.exe is a small command line tool that enables you to activate your machine online or offline, deactivate it and/or export license information to a file. The Regutil tool can be found in the C:\Program Files (x86)\UiPath\Studio\UiPath folder by default.

All the examples displayed here are constructed from the assumption that you first navigated to the location of the Regutil tool, by using the cd command (cd C:\Program Files (x86)\UiPath\Studio\UiPath).

Command
Description

help

Displays the help information required to get you going with Regutil.exe.
Example:
regutil.exe help /help

activate

Helps you activate your Robot offline or online.
Online activation:
A valid email address and activation code are required. These can be specified using the /code and /email arguments. If no activation code is provided, the trial mode is used.
Example:
regutil.exe activate /email=documentation@uipath.com - only for trial activation
regutil.exe activate /email=documentation@uipath.com /code=1234567890

Offline activation:
The following are required:

  • a valid email address
  • a valid activation code
  • access to a computer with internet access or with access to our validation portal

The following arguments have to be used: get-activation-cert, /email, /code, /out_file, /offline, and /response_file.
To activate your Robot offline, do the following:

  1. Generate an activation certificate from the command line, by writing something like:
    regutil.exe get-activation-cert /email=documentation@uipath.com /code=1234567890 /out_file=E:\certificate.txt.
  2. On a machine with a connection to the internet, navigate to this URL: http://support.uipath.com/activation. The activation portal is displayed.
  3. In the Activation Code field, paste the information in the certificate generated at step 1.
  4. Click Activate. An activation response code is generated.
  5. Save the generated response to a .txt file.
  6. On the machine used at step 1, activate the license offline, as follows: regutil.exe activate /offline /code=1234567890 /response_file=D:\response.txt.

deactivate

Deactivates your license online, using the locally stored code.
Example:
regutil deactivate

get-deactivation-cert

Helps you deactivate your license on a machine without internet connection. Please note that you still need access to a computer with internet access to perform the deactivation. Additionally, you have to use the /out_file argument.

  1. Export the deactivation certificate to a .txt file using the following command: regutil get-deactivation-cert /out_file=D:\certificate.txt. Once this command is executed, the local license becomes invalid.
  2. Move the certificate to a machine with internet access.
  3. Navigate to this URL:
    http://support.uipath.com/deactivation. The deactivation portal is generated.
  4. In the Deactivation Certificate field, paste the information from the file generated at step 1.
  5. Click Deactivate. A Deactivation Successful message is displayed.

get-info

Displays license information in the command line, as follows:

  • License code
  • License status - displays an error code that explains the status of your licensing. Information regarding the possible codes can be found in the official Nalpeiron documentation here, as well as here and here.
  • Device Id
  • License expire date - The next time the license is going to be checked by the licensing server. By default, this is checked every 30 days.
  • Subscription expire date - the license expiry date, as communicated by our teams
  • Maintenance expire date - no longer used
  • Attended - the total number of available licenses for Attended Robots.
  • Unattended - the total number of available licenses for Unattended Robots.
  • Free - the total number of available licenses for NonProduction Robots.
  • Development - the total number of available licenses for Development Robots.
  • Concurrent - it is always set to false and not currently used.
    Example:
    Regutil get-info

export-info

Displays a string that contains the local licensing information.
Example:
regutil.exe export-info

It can be used with the /out_file argument to export the license to a custom file. The output file can be in any format. This license file can be uploaded to Orchestrator, in the License tab of the Settings page.
Example:
regutil.exe export-info /out_file=E:\license.txt
regutil.exe export-info /out_file=E:\orchestrator.license

/offline

Helps you activate your license offline. If the /response_file argument is not provided, the certificate is read from the standard input. The /code argument must be used with it.
Example:
regutil.exe activate /offline /code=1234567890 /response_file=D:\response.txt

/verbose

Displays additional information to standard output.

/code

Helps you specify the activation code. Can be used with both online and offline activation. If omitted when activating your license, the trial is used.
Example:
regutil.exe activate /email=documentation@uipath.com /code=1234567890

/email

Specifies the email to be used with the activation. It has to be used with both offline and online activations.
Example:
regutil.exe get-activation-cert /email=documentation@uipath.com /code=1234567890 /out_file=E:\certificate.txt
regutil.exe activate /email=documentation@uipath.com

/response

Specifies the response certification file, when activating your license offline. All types of files are supported (.txt, .docx, .license, etc.).
If you do not provide the full path of the file, it is downloaded to the UiPath Platform folder (C:\Program Files (x86)\UiPath\Studio\UiPath).
Example:
regutil.exe activate /offline /code=1234567890 /response_file=D:\response.txt

/out_file

Specifies the output file for licensing information. The resulted file can be uploaded to Orchestrator to help you license your Robots, as explained here. All types of files are supported (.txt, .docx, .license, etc.).
If you do not provide the full path of the file, it is generated in the installation directory of the UiPath Platform, C:\Program Files (x86)\UiPath\Studio\UiPath.
Example:
regutil.exe export-info /out_file=E:\orchestrator.license

/config_file

Specify a custom configuration file for licensing library.


Regutil Command Descriptions