Use Command Line Utility

Important: The Smart Agent CLI is deprecated and will reach End of Support on February 2, 2026. Until then, only critical security fixes and bug fixes will be provided and a release will be made as needed.

It is recommend to use Smartagentctl instead of Smart Agent Command Line Utility. See Install Smart Agent.

This is syntax of the command that you can use to perform agent operations by using the Smart Agent CLI:

appd { operation } { agent } --{ options }

You can use this syntax for APM Agents and Smart Agents.

APM Agents

To manage the app server agents and Machine Agents, the following are the supported values that you can use in the CLI command from the Smart Agent CLI utility:

It is recommend to use Smartagentctl instead of Smart Agent Command Line Utility.


Parameters	Values	Details
operation	`install` `upgrade` `rollback` `uninstall`	You can perform install, upgrade, rollback, and uninstall operations using the CLI command.
agent	`java` `machine` `node` `python` `php` `db` `apache` `iib` `dotnet_msi`	These are the supported agents on which you can perform the operations using the CLI command.
options	Agent options `--version` `--app-name` `--node-name` `--tier-name` `--backup`	These are the available flag options for the operation on APM agents. The flag options are categorized into the following: Agent options Connection options Install options Configuration options
	Connection options `--inventory` `--remote` `--connection`
	Install options `--install-dir` `--install-agent-from`
	Config options `--config` `--profile`

For example: To install Java Agent 23.9.0, run the following command on the Smart Agent CLI:

appd install java --version 23.9.0

If the controller_url in the Smart Agent CLI config.ini file contains the HTTP or HTTPS protocol, the same protocol is included as the Controller host in the agent controller-info.xml file. If the protocol is not specified, it is excluded from the xml file.

For example, if the controller_url in the config.ini file is http://localhost, then the Machine Agent controller-info.xml file will have the Controller host as http://localhost. However, if the controller_url is localhost, then the Controller host in the Machine Agent controller-info.xml file will also be localhost.

For more examples, see Example Scenarios.

Smart Agents

To manage the Smart Agents, the following are the supported values that you can use in the CLI command from the Smart Agent CLI utility:

It is recommend to use Smartagentctl instead of Smart Agent Command Line Utility. See Install Smart Agent.


Arguments	Values	Details
operation	`install` `upgrade` `configure` `uninstall`	You can perform install, upgrade, rollback, and uninstall operations using the CLI command.
agent	`smartagent`	The Smart Agent on which you can perform the operations using the CLI command.
options	Agent options --version	These are the available flag options for the operation on APM agents. The flag options are categorized into the following: Agent options Download options Connection options Install options Configuration options Smart Agent options
	Download options --smartagent-download-url --install-agent-from
	Connection options `--inventory` `--connection`
	Install options `--install-dir`
	Config options `--config` `--profile`
	Smartagent options `smartagent-download-url` `--auto-start` `--attach-configure-file`

For example:

appd install smartagent --install-agent-from {path_to_local_artifact} --auto-start

CLI Option-Operation Grid

APM Agents


Operation	Install	Upgrade	Uninstall	Rollback
Flags options	version string (latest) ( -v ) profile string (default) ( -p ) config string ( -c ) install-dir string ( -d ) app-name string ( -a ) node-name string ( -n ) tier-name string ( -t ) inventory string ( -i ) connection string ( -q ) hosts string ( -m ) instal-agent-from string ( -l )	version string (latest) ( -v ) profile string (default) ( -p ) config string ( -c ) install-dir string ( -d ) app-name string ( -a ) node-name string ( -n ) tier-name string ( -t ) inventory string ( -i ) connection string ( -q ) hosts string ( -m ) instal-agent-from string ( -l )	backup bool ( -b ) inventory string ( -i ) connection string ( -q ) hosts string ( -m )	inventory string ( -i ) connection string ( -q ) hosts string ( -m )

Smart Agents


Operation	Install	Upgrade	Uninstall	Configure
Flags options	version string (latest) ( -v ) profile string (default) ( -p ) config string ( -c ) inventory string ( -i ) connection string ( -q ) hosts string ( -m ) instal-agent-from string ( -l )	version string (latest) ( -v ) profile string (default) ( -p ) config string ( -c ) inventory string ( -i ) connection string ( -q ) hosts string ( -m ) instal-agent-from string ( -l )	inventory string ( -i ) connection string ( -q ) hosts string ( -m )	inventory string ( -i ) connection string ( -q ) hosts string ( -m ) attach-configure-file string ( -f )