This article provides a summary of the cleo-agent command and its subcommands.

cleo-agent Command

Usage

cleo-agent [subcommand]

Subcommands

Activate	Install and activate a Cleo Agent service instance.
Connect	Test connectivity to the Cleo Agent installer repository.
Downgrade	Revert installed Agent to the previously backed up version.
Dump	Run a Cleo Agent thread dump or heap dump.
Install	Install a Cleo Agent service instance.
Patch	Patch a Cleo Agent legacy installation.
Shutdown	Shutdown a Cleo Agent service instance.
Status	Display the status of installed Cleo Agent(s).
Template	Create a 'proxy.json' template file.
Uninstall	Uninstall a Cleo Agent service instance.
Update	Update a Cleo Agent service instance.

Global Flags

The following flags can be used with any subcommand.

-d, --debug	Enable debug messages.
-h, --help	Display help text.
-s, --subdomain string	Subdomain on which the Access Point resides. Used to uniquely identify a particular Agent if you have multiple installed on the same machine.

Activate subcommand

Install and activate a Cleo Agent service instance.

Usage

cleo-agent activate -s=<SUBDOMAIN> -t=<TOKEN> [-v=<VERSION>] [flags]

Flags

-a, --agent-dir string	Optional. Specify custom agent directory.
-c, --proxy-cert string	Optional. Path to proxy certificate file (PEM/DER/PKCS#7).
--download-only	Optional. Download the installer, but do not install or activate it.
-h, --help	Display help for activate.
-p, --proxy-json string	Optional. Path to 'proxy.json' file.
-s, --sub-domain string	Required. Subdomain on which the Access Point resides.
-t, --token string	Access Point activation token.
-v, --version string	Specify the version of Agent. Valid values are  "latest" and <x.y.z>. Default value is "latest".

Connect subcommand

 Test connectivity to the Cleo Agent installer repository.

Usage

 cleo-agent connect [flags]

Flags

-h, --help	Display help for connect.
-p, --proxy-json string	Path to 'proxy.json' file.
-r, --repo	Check repository connectivity.
-u, --update	Test update url.
-v, --version string	Specify the version of Agent. Valid values are  "latest" and <x.y.z>. Default value is "latest".

Downgrade subcommand

Revert a CIC Agent to the version that was in use prior to the most recent update.

Usage

 cleo-agent downgrade [-s=<SUBDOMAIN>] [flags]

Flags

-h, --help

Display help for downgrade.

Dump subcommand

Generate a thread and heap dump for CIC Agent.

Usage

 cleo-agent dump --thread --heap [-s=<SUBDOMAIN>] 

Flags

--heap	Generate a heap dump for Agent.
-h, --help	Display help for dump.
--thread	Generate a thread dump for Agent.

Install subcommand

Install a Cleo Agent service instance.

Usage

 cleo-agent install -s=<SUBDOMAIN> [-v=<VERSION>] [flags]

Flags

-a, --agent-dir	Specify custom agent directory.
--download-only	Only download the installer (don't install/activate).
-h, --help	Display help for install.
-v, --version string	Specify the version of Agent. Valid values are  "latest" and <x.y.z>. Default value is "latest".

Patch subcommand

Patch a Cleo Agent legacy installation.

Note: This subcommand is a Linux-only option.

Usage

 cleo-agent patch -s=<SUBDOMAIN> -t=<TOKEN> [-v=<VERSION>] [flags]

Flags

-a, --agent-dir string	Specify custom agent directory.
--download-only	Download the patch, but do not install or activate it.
-h, --help	Display help for patch.
-v, --version string	Specify the version of Agent. Valid values are  "latest" and <x.y.z>. Default value is "latest".
-t, --token string	Access Point activation token.

Shutdown subcommand

Shutdown a Cleo Agent service instance.

Usage

 cleo-agent shutdown [-s=<SUBDOMAIN>] [-f] [flags]

Flags

-f, --force	Force the shutdown request, ignoring any in-progress jobs.
-h, --help	Display help for shutdown.
-w, --wait	Wait for service to shutdown.

Status subcommand

Display the status of installed Cleo Agent(s).

Usage

 cleo-agent status [flags]

Flags

-h, --help	Display help for status.
-q, --query string	Rest query parameters.
-v, --version	Show the latest available version of the Agent, not the installed version.

Template subcommand

Create a 'proxy.json' template file that can be used for connecting through a proxy.

Usage

 cleo-agent template [flags]

Flags

-h, --help

Display help for template.

Uninstall subcommand

 Uninstall a Cleo Agent service instance.

Usage

 cleo-agent uninstall [-s=<SUBDOMAIN>] [flags]

Flags

-h, --help	Display help for uninstall.
--no-prompt	Skip the uninstall prompt.

Update subcommand

Update a Cleo Agent service instance.

On a Linux system, run this command:

• as user, cleo, for example, sudo -u cleo ./cleo-agent update 
• from /opt/cleo/agent-[subdomain]/bin

On a Windows system, run this command from c:\program files\cleo\agent-[subdomain]\bin

Usage

 cleo-agent update [-s=<SUBDOMAIN>] [-v=<VERSION>] [flags]

Flags

-h, --help	Display help for the update.
-i, --initiate	Initiate the update request. This flag is required.
-v, --version	Specify the version of Agent. Valid values are  "latest" and <x.y.z>. Default value is "latest".
--download-only	Download the update, but do not install it.