Backing Up and Restoring your CIC Agent

If you want to restore your CIC Agent, the following procedures will allow you to back up and restore the Agent while keeping its associated Endpoints, Access Points, and Data Flows intact.

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 subsystem name>.

Restoring the CIC Agent

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

1. Find 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. You will use this value as an argument when you run the cleo-agent-downloader below.

2. In the CIC Cockpit, create an Access Point (this is temporary) and copy the Agent installation script/commands.
3. Navigate to the directory where you want to put the cleo-agent-downloader file to be downloaded by the script.
4. In the Agent installation script you copied, add the -v option and 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:

   DO NOT COPY AND PASTE THIS EXAMPLE 
   ./cleo-agent-downloader activate -t "aHR0cHM6Ly9h
   cGkuY2xlb2ludGVncmF0aW9uLmNsb3VkL3Byb2QvYXBpL2IxN2i5MTUzLTZiMTctNGVhNrthNTQ3LTIyN2R
   hYzZjYzE1Mi9hY3RpdmF0aW9uL3Rva2VuL2Y0NzdkNzAzLTI2MWQtNDEzNC05NDZjLWU3NTvlZWQ1ZD
   d8MA==" -s ap-node-name -v 1.0.3

   Notes regarding the example above:

   • Replace ap-node-name with your Access Point node name.
   • The token in quotes will be different for your installation.
   • This command must be run in the same path as the cleo-agent-downloader executable.
   • This command might require the proper privileges to execute, so be certain to have these before attempting this process.
5. Go to the computer with the new Access Point and run the Agent installation instructions as modified above. This installs the Agent version needed for the backup and starts up the service the Agent runs under.
6. Go back to the CIC Cockpit and delete the temporary Access Point, but do not remove the new Agent. Normally, you would remove the Agent when you remove the Access Point, but not in the case of restoring from a backup.
7. Go back to the new computer (where you just installed the Agent) and stop the CIC Agent service.
8. Replace the contents of the Agent installation directory with your backup. 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 that was backed up. The new Agent is linked to the old Agent’s Access Point, Endpoints, and Data Flows this way.

9. Restart the CIC Agent service.