Cloning an Agent

You can clone an existing Agent to create a copy of an existing Agent that includes:

  • The configuration to the specified event broker service.

  • The configuration of the external system.

Prerequisites

Before you start cloning an Agent, ensure that you have:

  • An existing Agent. To ensure you have the valid configuration, Solace recommends that the Agent you clone is in the Running state.

  • The connection details and credentials for your external system and event broker service if they are different from the Agent you are cloning. For more information about retrieving the information for an event broker service, see Detailed Event Broker Service Information.

  • Your user account must have the Mission Control Manager assigned to it.

Considerations for Cloning Agents

Consider the following information when you are cloning Agents:

  • You may find it useful to clone an existing Agent to save time and reduce errors during the configuration process for new Agents. For example, you can copy the configuration for the same external system, but modify the queue and the event broker service details.

  • When you create a clone of an Agent, it can be in any state, such as Running, Not deployed, or even down Down. Regardless of the state of the Agent that you are copying, the cloned Agent starts in the Not Deployed state. No validation checks are performed on the configuration if you are only cloning it. This may be useful in situations where you don't have all the details and want to temporarily use placeholder values in the configuration.

    Alternatively you can choose to clone and deploy the Agent in a single click. This option triggers validation checks of the configuration prior to creating and deploying the clone. In this case, the Agent starts in the Deploying state and moves to the Running state after it successfully deploys.

  • If you are using environments, you cannot clone an Agent from one environment to another environment. In the situations where you have migrated the event broker service, you must manually re-create the Agent. For more information about environments, see Creating and Managing Environments.

Clone an Agent

To clone (or copy) an existing Agent, perform these steps: 

  1. Log in to the PubSub+ Cloud Console if you have not done so yet. The URL to access the Cloud Console differs based on your authentication scheme. For more information, see Logging In to the PubSub+ Cloud Console.

  2. On the navigation bar, select Agents .

  3. If your organization uses multiple environments, on the Agents page, select the environment where you want to create the Agent.

  4. Click Create Agent.

  5. On the top-right corner, click the ellipsis () and select Clone.

  6. On the <Agent type:name of the Agent> page, a copy of the Agent you are cloning is created. You can optionally:

    • Modify the Name field. By default, the name is the same as the Agent your are cloning with - Clone appended to the end.

    • Modify the Description.

    • Click the Source Connection, Target Header Mapping, or Target Connection tabs to modify the fields for the source connection, header mappings, or target connection fields. For example, you can change the event broker service or even remove the event broker service if you are not ready to deploy the Agent.

  7. Click one of the following to clone the Agent:

    • Clone to only create a copy of the Agent. No validation checks are performed. You can later modify the details and deploy Agent.

    • Clone and Deploy to clone and deploy the Agent. Validation checks are made on the configuration prior to cloning and deploying. If validation checks are not successful, the clone will not be created.