< Back to Top

Backing Up and Restoring your CIC Agent

In the event that the computer on which you have installed the CIC Agent goes down, you can restore your Agent to a new computer, allowing you to retain Endpoints, Access Points, and Data Flows that reference that Agent.

Note: Cleo recommends you back up your CIC Agent frequently to ensure the most up-to-date configuration is available if you need to restore your Agent. 

Backing Up the CIC Agent

To back up your CIC Agent, make a copy of the directory where the Agent was installed.

  • On a Windows system, copy the contents of C:\Program Files\Cleo.
  • On all other systems, copy the contents of /opt/cleo/agent.

Restoring the CIC Agent

To restore your CIC Agent, you create a temporary Access Point, install the CIC Agent on a new computer to get the Agent service up and running, and then replace the content of CIC Agent Install directory structure with your backup copy.

  1. In the CIC Cockpit, create an Access Point (this is temporary) and copy the Agent installation script/commands.
  2. Determine the version of the Agent at the time of backup. Go to the conf directory of the backup, open the file, version.properties, and find the property, agent.version. The value of this property is the version of the Agent installed at backup time.
  3. In the Agent installation script you copied, specify the version of the CIC Agent to be installed.

    Add the -v option with the value you got from the agent.version property to the end of the cleo-agent-downloader command.

    For example, if the value of the agent.version property was 1.0.3, add the -v option with the 1.0.3 argument to end of the command like this:

    cleo-agent-downloader activate ... -v 1.0.3
  4. Go to the new computer (which replaces the one that crashed) and run the Agent installation instructions. This installs the Agent and starts up the service the Agent runs under.
  5. Go back to the CIC Cockpit and delete the temporary Access Point, but do not remove the Agent from the new computer you just installed it on. (Normally, you would remove the Agent when you remove the Access Point, but not in the case of restoring from a backup.)
  6. Go back to the new computer (where you just installed the Agent) and stop the CIC Agent service.
  7. Replace the content of the Agent installation directory with your back up. On Linux, make sure the backup copy is replaced as the "cleo" user.
    Applying the backup in this way causes the Agent to assume the "identity" of the Agent whose server crashed. And the new Agent is linked to the existing Access Point, Endpoints, and Data Flows the old Agent was linked to.
  8. Restart the CIC Agent service.

Related articles