Starting with version 1.0.17, you can install multiple CIC Agents on a single machine and have them run concurrently. Agent instances are differentiated by subdomain and can service different environments or tenants.
Sub-commands to install, activate, update, and uninstall an agent instance require the
-s) command-line flag.
Installed subdomain instances are not required to use the same version. For example, one instance can run the 1.0.16 version and another instance can run the 1.0.17 version.
Each subdomain instance is updated independently of other installed instances.
Note: Cloning or copying an Agent installation is not supported. Each Agent must be installed individually. For information about configuring multiple Agents for high availability (HA), see High Availability CIC Agents.
Installing Agent Instances
To install an Agent instance, use either the
For example, to install a new agent instance for subdomain "stage-apname" to the default location, run the following command:
cleo-agent-downloader install -v latest -s stage-apname
This command installs the agent to the following location:
--agent-dir flag can be used to override the base installation location:
cleo-agent-downloader install -v latest -s stage-apname --agent-dir /thirdparty/apps
results in the agent being installed to:
Linux Install Note
When installing a new subdomain instance on a Linux machine that has a previously installed agent running version 1.0.16 or earlier, the following error message displays:
Previously installed agent is required to be updated before installing another subdomain instance. You may initiate the update locally by running: sudo -u cleo ./cleo-agent-downloader update -v latest -s _legacy_ -i
You can update the previously installed agent through the Cockpit or using the command line. After the agent is updated, you can install the new subdomain instance.
Each subdomain is installed as a separate service and the service name includes the subdomain name.
For a subdomain named "stage-apname", the service name would be:
On Windows, the agent will appear in the service control panel as:
Cleo Agent (stage-apname)
To start the service from the command line:
net start cleo-agent-stage-apname
- Linux SystemD
sudo systemctl start cleo-agent-stage-apname
- Linux SysVInit
sudo service cleo-agent-stage-apname start
To stop the service from the command line:
net stop cleo-agent-stage-apname
- Linux SystemD
sudo systemctl stop cleo-agent-stage-apname
- Linux SysVInit
sudo service cleo-agent-stage-apname stop
status sub-command displays a list of currently installed agent instances.
status sub-command requires administrative privileges.
cleo-agent status 2 agent(s) installed - Cleo Agent (legacy installer) sub-domain: _legacy_ version: pr-1144 install date: last updated: 2021-11-16T10:41:21-10:00 home: C:\Program Files\Cleo\Agent\ rest port: 17081 service: CleoAgent (running) activated: true aversion: PR-1144::46 asub-domain: _legacy_ agent id: 9e073c56-cc87-402c-a890-f2ff91d0ff0f - Cleo Agent (stage-apname) sub-domain: stage-apname version: PR-1144::46 install date: 2021-11-16T10:39:52-10:00 last updated: home: C:\Program Files\Cleo\agent-stage-apname rest port: 17082 service: cleo-agent-stage-apname (running) activated: true aversion: PR-1144::46 asub-domain: stage-apname agent id: e258cc10-bab1-4ee8-9e58-a1bf7798221a
Updating an Agent Instance
You can update an Agent instance through the Cockpit when a newer version becomes available. Alternatively, you can initiate an update from the command line using the cleo-agent
cleo-agent update -v latest -s stage-apname -i
sudo -u cleo cleo-agent update -v latest -s stage-apname -i
This command will initiate an update for the agent instance identified by the subdomain, "stage-apname".
The update process stores a backup of the current agent instance to an instance-specific location in an OS-specific common program data location:
An update to an instance with a subdomain of stage-apname would have a backup stored at:
Uninstalling CIC Agent
You can uninstall the CIC Agent from the command line. On a Windows system, you can uninstall using "Add Remove Programs" (App & features). If uninstalling from the command line, the
--sub-domain command-line flag is required:
cleo-agent uninstall -s stage-apname
sudo cleo-agent uninstall -s stage-apname
This command uninstalls the instance for the "stage-apname" sub-domain. Note that the uninstall must be run with administrative privileges. To uninstall Agent version 1.0.16 or earlier (legacy install), you must use their corresponding package uninstallers.
- Windows - Add/Remove Programs
- Linux - Debian or RPM
Please sign in to leave a comment.