Using agent commands

The same scripts that you use to install monitoring agents are also used to check the status of an installed agent, stop or start it, or uninstall the agent.

About this task

The agent name and agent codes are provided for your reference.

Use the agent name in the following commands:

name-agent.sh
name-agent.bat

Where name is the name of the agent that is specified in Table 1.

Table 1. Agent names and agent codes
Monitoring agent	`name`	Two letter agent code
Monitoring Agent for Amazon EC2	`amazon_ec2`	`b5`
Monitoring Agent for Azure Compute	`azure_compute`	`ak`
Monitoring Agent for Cassandra	`cassandra`	`zc`
Monitoring Agent for Cisco UCS	`cisco_ucs`	`v6`
Monitoring Agent for Citrix Virtual Desktop Infrastructure	`citrix_vdi`	`vd`
Monitoring Agent for DataPower®	`datapower`	`bn`
Monitoring Agent for Db2®	`db2`	`ud`
Monitoring Agent for Hadoop	`hadoop`	`h8`
Monitoring Agent for HMC Base	`hmc_base`	`ph`
Monitoring Agent for HTTP Server	`http_server`	`hu`
Monitoring Agent for IBM® Cloud	`ibm_cloud`	`fs`
Monitoring Agent for IBM Integration Bus	`iib`	`qi`
Monitoring Agent for MQ Appliance	`ibm_mq_appliances`	`mk`
Monitoring Agent for InfoSphere® DataStage®	`datastage`	`dt`
Monitoring Agent for JBoss	`jboss`	`je`
Monitoring Agent for Linux® KVM	`linux_kvm`	`v1`
Monitoring Agent for Linux OS	`os`	`lz`
Monitoring Agent for MariaDB	`mariadb`	`mj`
Monitoring Agent for Microsoft Active Directory	`msad`	`3z`
Monitoring Agent for Microsoft Cluster Server	`mscs`	`q5`
Monitoring Agent for Microsoft Exchange Server	`msexch`	`ex`
Monitoring Agent for Microsoft Hyper-V Server	`microsoft_hyper-v_server`	`hv`
Monitoring Agent for Microsoft Internet Information Services	`msiis`	`q7`
Monitoring Agent for Skype for Business Server (formerly known as Microsoft Lync Server)	`skype_for_business_server`	`ql`
Monitoring Agent for Microsoft .NET	`dotnet`	`qe`
Monitoring Agent for Microsoft Office 365	`microsoft_office365`	`mo`
Monitoring Agent for Microsoft SharePoint Server	`ms_sharepoint_server`	`qp`
Monitoring Agent for Microsoft SQL Server	`mssql`	`oq`
Monitoring Agent for MongoDB	`mongodb`	`kj`
Monitoring Agent for MySQL	`mysql`	`se`
Monitoring Agent for NetApp Storage	`netapp_storage`	`nu`
Monitoring Agent for Node.js	`nodejs`	`nj`
Monitoring Agent for OpenStack	`openstack`	`sg`
Monitoring Agent for Oracle Database	`oracle_database`	`rz`
Monitoring Agent for PHP	`php`	`pj`
Monitoring Agent for PostgreSQL	`postgresql`	`pn`
Monitoring Agent for Python	`python`	`pg`
Monitoring Agent for RabbitMQ	`rabbitMQ`	`zr`
Monitoring Agent for Ruby	`ruby`	`km`
Monitoring Agent for SAP Applications	`sap`	`sa`
Monitoring Agent for SAP HANA Database	`sap_hana_database`	`s7`
Monitoring Agent for SAP NetWeaver Java™ Stack	`sap_netweaver_java_stack`	`sv`
Monitoring Agent for Siebel	`siebel`	`uy`
Monitoring Agent for Sterling Connect Direct	`sterling_connect_direct-agent`	`FC`
Monitoring Agent for Sterling File Gateway	file_gateway	fg
Monitoring Agent for Sybase Server	sybase	oy
Monitoring Agent for Synthetic Playback	`synthetic_transactions`	`sn`
Monitoring Agent for Tomcat	`tomcat`	`ot`
Monitoring Agent for UNIX OS	`os`	`ux`
Monitoring Agent for VMware VI	`vmware_vi`	`vm`
Monitoring Agent for WebLogic	`oracle_weblogic`	`wb`
Monitoring Agent for WebSphere® Applications	`was`	`yn`
Monitoring Agent for WebSphere Infrastructure Manager	`wim`	`d0`
Monitoring Agent for WebSphere MQ	`mq`	`mq`
Monitoring Agent for Windows OS	`os`	`nt`
Response Time Monitoring Agent	`rt`	`t5`

Procedure

On the system where you want to send a command to the monitoring agent, change to the install_dir/bin directory. Enter any of the commands in Table 2 where name is the agent name that is specified in Table 1.

Table 2. Commands for UNIX and Linux systems
Command	Description
`./name-agent.sh status`	Checks the agent status. Status can be either running or not running. When the agent is running, the connection status between the agent and the Cloud APM server is also checked. Possible negative connection statuses are: Connection failed, Error detected, Disconnected-error. The positive status is Connected, this is the expected status. The transitional status is Connecting. A status of Unknown means that the agent status cannot be recognized, possible due to errors in the file system or in the agent log file.
`./name-agent.sh start`	Starts the monitoring agent. If the agent has instances, enter an instance name after the command.
`./name-agent.sh stop`	Stops the agent. If the agent has instances, enter an instance name after the command.
`./name-agent.sh prereqcheck`	Runs a prerequisite scan. This command option is available for most agents.
`./name-agent.sh install`	Installs the monitoring agent. For more information, see Installing agents on UNIX systems and Installing agents on Linux systems.
`./name-agent.sh config instance_name path_to_silent_config_file`	Configures the monitoring agent. Run the command from the `install_dir`/bin directory and add the response file path if required. If the agent has instances, enter an instance name. For more information about which agents are multiple instance agents, see the Table 1 . The `silent_config_file` is optional. If you do not specify a file for silent configuration, you can configure the monitoring agent interactively by following the prompts.
`./name-agent.sh uninstall`	Uninstalls the monitoring agent. For more information, see Uninstalling your agents.
`./smai-agent.sh uninstall_all`	Uninstalls all the monitoring agents on the managed system.
`./name-agent.sh remove instance_name`	Removes an instance of a multiple instance agent.
`./name-agent.sh`	View a description of the functions that are available with the script.

On the system where you want to send a command to the monitoring agent, change to the install_dir\BIN directory at the command prompt, for example: C:\IBM\APM\bin. Enter any of the commands in Table 3 where name is the agent name that is specified in Table 1.

Table 3. Commands for Windows systems
Command	Description
`name-agent.bat status`	Checks the agent status. Checks the connection status between the agent and the Cloud APM server. Possible negative connection statuses are: Connection failed, Error detected, Disconnected-error. The positive status is Connected, this is the expected status. The transitional status is Connecting. A status of Unknown means that the agent status cannot be recognized, possible due to errors in the file system or in the agent log file.
`name-agent.bat start`	Starts the monitoring agent. If the agent has instances, enter an instance name after the command.
`name-agent.bat stop`	Stops the agent. If the agent has instances, enter an instance name after the command.
`name-agent.bat prereqcheck`	Runs a prerequisite scan. This command option is available for most agents.
`name-agent.bat install`	Installs the monitoring agent. For more information, see Installing agents.
`name-agent.bat config instance_name path_to_silent_config_file`	Configures the monitoring agent. Run the command from `install_dir`\bin directory and add the response file path if required. If the agent has instances, enter an instance name. For more information about which agents are multiple instance agents, see the Table 1 . The `silent_config_file` is optional. If you do not specify a file for silent configuration, you can configure the monitoring agent interactively by following the prompts.
`name-agent.bat uninstall`	Uninstalls the monitoring agent. For more information, see Uninstalling your agents.
`smai-agent.bat uninstall_all`	Uninstalls all monitoring agents on the managed system.
`name-agent.bat remove instance_name`	Removes an instance of a multiple instance agent.
`name-agent.bat`	View a description of the functions that are available with the script.

Agent version command

To see the version of an agent in your environment, run the following commands:
- ```
install_dir/bin/cinfo 
```
  Enter 1 to show the versions.
- ```
install_dir/InstallITM/kincinfo
```