Skip to main content Skip to complementary content

Pairing Remote Engines with the configuration file

Pair a Remote Engine by configuring the Remote Engine settings on your local machine.

If you have installed the Remote Engine using the installer and already defined the Remote Engine key during the installation process, this configuration file is already set up. You can ignore this section.

Before you begin

  • You have installed the Remote Engine.
  • You have created a Remote Engine logical entity in Talend Management Console.


  1. Open Talend Management Console.
  2. Open the Processing page then click the Engines tab.
  3. Select the environment of the engine from the Environment drop-down-list.
    You can also use the search box and the filter options to filter the list.
  4. On the engine list, click the remote engine for which you want to reset the pairing.
  5. In the Engine details blade that is displayed, click the Manage tab.
  6. Copy the pairing key.
    The Manage tab displays different information depending on the pairing status of the engine.
    • If the engine is unpaired, copy the key from the Remote Engine key field.
      Screenshot of Remote Engine key in Engine details window.
    • If the engine has been paired, but you need to reset the key to pair the engine again for a re-installation or repairing connection issues, do the following:
      1. In the Reset the connection section, click Reset the key to open the corresponding wizard.
        Screenshot of resetting Remote Engine pairing key.
      2. On the first window of the wizard, click Reset key.

        This window provides information about how your tasks and plans are affected by resetting the key.

        Screenshot of the information window about resetting a Remote Engine pairing key.
      3. In the second window, copy the new pairing key.

        This pairing key, also referred to as preauthorized key, pre-authorized or pre-authorization key, is used in your Remote Engine configuration to set up the connection to that engine.

  7. If started, stop the Remote Engine by executing the stop file in the <RemoteEngineInstallationDirectory>/bin folder.
  8. Open <RemoteEngineInstallationDirectory>/etc/preauthorized.key.cfg.
  9. Edit the parameters.
    Paste the preauthorized key. This pre-authorization key is the remote engine paring key.
    Enter the name of the Remote Engine.
    Enter the description of the Remote Engine.
  10. Save the file.
  11. Launch the Talend Remote Engine console on your machine (trun ).
  12. Type list then press Enter .
    All bundles are in Active status.


Your remote engine has been paired with your account and the status moved to Paired on Talend Management Console.

To run tasks with the Remote Engine as the execution runtime, ensure that you have the Execute right on the workspace where the engine is located.

If you need to know the Java version used by the engine, click the Configuration tab in the Engine details blade. There you can see the version Talend Remote Engine is using for start and also the Java version it uses to run tasks and plans. Note that by default, Talend Remote Engine uses the Java it starts with to run tasks and plans.

If you encounter the error message below in your engine's Karaf logs, it means that engine pairing has failed:
Error setting property: PropertyDescriptor <name: cleanInterval, getter: null, setter: [class org.talend.ipaas.rt.deployment.agent.impl.KarafDataMavenCleaner.setCleanInterval(long)]
This error is caused by trailing spaces at the end of the local.maven.clean.interval.days parameter line in the <RemoteEngineInstallationDirectory>/etc/org.talend.ipaas.rt.deployment.agent.cfg file.
  • The local.maven.clean.interval.days parameter controls automatic cleanup of unused artifacts in your engine. For further information about your Remote Engine's resilience settings, see Automatic artifact cleanup.

To resolve the issue, remove the trailing spaces from the local.maven.clean.interval.days parameter line.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!