IBM Cloud Application Performance Management

https://www.ibm.com/docs/en/capm
Admin
IBM Cloud Application Performance Management is a cloud-based monitoring and management solution...
Tokens:581,970
Snippets:4,314
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Example Start Command

Source: https://www.ibm.com/docs/en/capm/index_topic=csm-configuring-agent-by-responding-prompts

An example of the command used to start a Siebel agent instance named 'example-inst01'. This shows the correct syntax for initiating a configured agent.

```shell
/opt/ibm/apm/agent/bin/siebel-agent.sh start example-inst01
```

--------------------------------

### Start JBoss Agent (Shell Script)

Source: https://www.ibm.com/docs/en/capm/index_topic=cjm-configuring-agent-by-responding-prompts

This command starts a configured JBoss agent instance. It requires the installation directory and the instance name as parameters. Ensure the agent is configured before starting.

```shell
#!/bin/bash
install_dir/bin/jboss-agent.sh start instance_name
```

```shell
# Example:
/opt/ibm/apm/agent/bin/jboss-agent.sh start example-inst01
```

--------------------------------

### Start IBM Cloud Agent (Windows)

Source: https://www.ibm.com/docs/en/capm/index_topic=ccm-configuring-agent-by-using-silent-response-file-1

This command starts a configured IBM Cloud agent instance on Windows systems. It requires the agent's installation directory and the name of the agent instance.

```batch
install_dir\bin\ibm_cloud-agent.bat start instance_name
```

--------------------------------

### Start JBoss Agent (Linux)

Source: https://www.ibm.com/docs/en/capm/index_topic=cjm-configuring-agent-by-using-silent-response-file

This command starts the JBoss agent on a Linux system after it has been configured. It requires the agent's installation directory and the instance name.

```bash
/opt/ibm/apm/agent/bin/jboss-agent.sh start example-inst01
```

--------------------------------

### Start IBM Cloud Agent (Linux)

Source: https://www.ibm.com/docs/en/capm/index_topic=ccm-configuring-agent-by-using-silent-response-file-1

This command starts a configured IBM Cloud agent instance on Linux systems. It requires the agent's installation directory and the name of the agent instance.

```shell
install_dir/bin/ibm_cloud-agent.sh start instance_name
```

--------------------------------

### Start Azure Compute Agent Instance

Source: https://www.ibm.com/docs/en/capm/index_topic=cacm-configuring-agent-by-responding-prompts

This command starts a configured Azure Compute agent instance. It requires the installation directory and the previously defined instance name. Ensure the agent is configured before attempting to start it.

```shell
install_dir/bin/azure_compute-agent.sh start instance-name
```

```shell
/opt/ibm/apm/agent/bin/azure_compute-agent.sh start azc-inst3
```

--------------------------------

### Start Amazon ELB Agent

Source: https://www.ibm.com/docs/en/capm/index_topic=caelbm-configuring-agent-by-responding-prompts

Starts the configured Amazon ELB agent instance. Requires the installation directory and the name of the agent instance to be started. This command assumes the agent has already been configured.

```shell
install_dir/bin/amazon_elb-agent.sh start instance-name
```

```shell
/opt/ibm/apm/agent/bin/amazon_elb-agent.sh start elb-inst3
```

--------------------------------

### Run Silent Installation for IBM AgentBuilder

Source: https://www.ibm.com/docs/en/capm/index_topic=builder-silent-installation

This command initiates a silent installation of IBM AgentBuilder. It requires the 'setup' executable, the 'silent' installation mode, and a path to the 'installer.properties' file. The path to the properties file must be fully qualified and cannot contain spaces on Windows.

```Windows Batch
setup.bat -i silent -f path/installer.properties
```

```Unix Shell
./setup.sh -i silent -f path/installer.properties
```

--------------------------------

### Install Cloud APM Agent Scripts

Source: https://www.ibm.com/docs/en/capm/index_topic=netcoolomnibus-installing-configuring-integration-agent

These commands initiate the installation process for the Cloud APM Integration Agent. One script is for Linux-based systems (.sh) and the other for Windows-based systems (.bat). The installation includes a prerequisite scan and automatically starts the agent upon successful completion.

```shell
installAPMAgents.sh
```

```batch
installAPMAgents.bat 
```

--------------------------------

### Node Manager Configuration Output Example (Windows)

Source: https://www.ibm.com/docs/en/capm/index_topic=monitoring-configuring-transaction-tracking-weblogic-agent

This snippet displays the output when 'WebLogic Node Manager' is selected as the startup method. It highlights key information messages, including the location of the weblogic_nodemanager_dc_opts file containing JVM start options and a confirmation of skipped start script configuration.

```text
INFO: [2000] Automatic configuration of agent environment file succeeded.
INFO: [3010] Automatic configuration of WebLogic start script skipped.
INFO: [3011] Please review C:\IBM\APM\TMAITM6_x64\wbdchome\8.1.4.0.0\runtime\ttdd_win\win_Server1\staging\weblogic_nodemanager_dc_opts.win for required WebLogic JVM start options.
INFO: [9000] Restart the WebLogic agent and WebLogic server for configuration to take effect.

```

--------------------------------

### Start PostgreSQL Agent on Linux

Source: https://www.ibm.com/docs/en/capm/index_topic=cpm-configuring-agent-linux-systems

This command is used to start the configured PostgreSQL agent on a Linux system. It requires the installation directory and the instance name that was used during the configuration. This ensures the agent begins collecting data.

```bash
install_dir/bin/postgresql-agent.sh start instance_name
```

--------------------------------

### Configure Startup Scripts with `kcirunas.cfg` (XML)

Source: https://www.ibm.com/docs/en/capm/index_topic=agents-starting-as-non-root-user

This XML configuration file is used to activate product code sections for monitoring agents and specify instance details. It supports agents with and without instance values. For agents requiring an instance, specify product code, instance name, and user.

```xml
<productCode>ud</productCode>
<instance>
<name>db2inst1</name>
<user>db2inst1</user>
</instance>
<instance>
<name>db2inst2</name>
<user>root</user>
</instance>

```

--------------------------------

### Example simpleConfig Script Execution and Prompts (Shell)

Source: https://www.ibm.com/docs/en/capm/index_topic=monitoring-configuring-transaction-tracking-weblogic-agent

This example shows an interactive session of running the simpleConfig.sh script. It illustrates the prompts for selecting an agent instance, WebLogic startup method, domain search path, and specific WebLogic server. The output indicates successful configuration of the agent environment and start script.

```bash
./simpleconfig.sh

The following agents and subnodes are not yet configured for transaction tracking:

1) wlinst1 Server1
2) wlinst1 Server2

Type the number that corresponds to the agent instance and subnode that you want to configure.

Type your selection here (For example: 1): 1

The following WebLogic startup methods are supported:

1) WebLogic startup script
2) WebLogic Node Manager

Type your selection here (default is 1): 1

The path to begin looking for WebLogic domains.
WebLogic domain search root (default is: ): /home/wlsadmin

The found WebLogic domain paths are:

1) /home/wlsadmin/oracle/user_projects/domains/ttdd

Type the number that corresponds to the WebLogic domain containing the WebLogic server that 
you want to configure.

Type your selection here (For examble: 1): 1

The following WebLogic servers are available for configuration:

1) AdminServer
2) Server1

Select a WebLogic server name (default is: 2): 2
INFO: [2000] Automatic configuration of agent environment file succeeded.
INFO: [3000] Automatic configuration of WebLogic start script succeeded.
INFO: [9000] Restart the WebLogic agent and WebLogic server for configuration to take effect.

```

--------------------------------

### Start Siebel Agent (Shell Script)

Source: https://www.ibm.com/docs/en/capm/index_topic=csm-configuring-agent-by-responding-prompts

This command starts the Siebel agent instance after it has been configured. It requires the installation directory and the instance name as arguments. Ensure the agent is configured before attempting to start it.

```shell
install_dir/bin/siebel-agent.sh start instance_name
```

--------------------------------

### Start JBoss Agent (Windows)

Source: https://www.ibm.com/docs/en/capm/index_topic=cjm-configuring-agent-by-using-silent-response-file

This command starts the JBoss agent on a Windows system after it has been configured. It requires the agent's installation directory and the instance name.

```bat
C:\IBM\APM\bin\jboss-agent.bat start example-inst01
```

--------------------------------

### Example Configuration Command

Source: https://www.ibm.com/docs/en/capm/index_topic=csm-configuring-agent-by-responding-prompts

An example of the command used to configure a Siebel agent instance named 'example-inst01'. This demonstrates the expected format, including the path to the script and the instance name.

```shell
/opt/ibm/apm/agent/bin/siebel-agent.sh config example-inst01
```

--------------------------------

### Run Hybrid Gateway Installation Script

Source: https://www.ibm.com/docs/en/capm/index_topic=gateway-installing-hybrid

Navigates to the extracted Hybrid Gateway installation directory and executes the installation script with root privileges. This initiates the installation process, including a prerequisite scan.

```shell
cd APM_Hybrid_Gateway_Install_version
./install.sh
```

--------------------------------

### Start WebSphere MQ Agent Instance (Unix/Linux)

Source: https://www.ibm.com/docs/en/capm/index_topic=monitoring-configuring-websphere-mq-agent

Command to start a previously configured WebSphere MQ agent instance on Unix or Linux systems. This command requires the installation directory and the specific instance name to be started. Ensure the agent is configured before attempting to start it.

```shell
install_dir/bin/mq-agent.sh start instance_name
```

--------------------------------

### Run IBM Key Management (iKeyman) Command

Source: https://www.ibm.com/docs/en/capm/index_topic=transactions-setting-up-keystore

This command initiates the IBM Key Management utility, which is essential for managing keystores and certificates. Ensure the `JAVA_HOME` environment variable is correctly set before execution.

```shell
c:\IBM\APM\java\java80_x64\jre\bin\ikeyman
```

--------------------------------

### Start Amazon EC2 Agent

Source: https://www.ibm.com/docs/en/capm/index_topic=monitoring-configuring-agent-by-responding-prompts

This command starts the configured Amazon EC2 agent instance. It requires the installation directory path and the previously defined instance name. This action assumes the agent has already been configured.

```shell
install_dir/bin/amazonec2-agent.sh start instance_name
/opt/ibm/apm/agent/bin/amazonec2-agent.sh start ec2-inst3
```

--------------------------------

### Start Citrix VDI Agent Script

Source: https://www.ibm.com/docs/en/capm/index_topic=ccvdim-configuring-agent-by-responding-prompts

This script initiates the operation of a configured Citrix VDI agent instance. It requires the installation directory and the instance name that was previously configured. The script's output is the running agent process.

```shell
install_dir/bin/citrixvdi-agent.sh start instance_name
/opt/ibm/apm/agent/bin/citrixvdi-agent.sh start vdi_inst01
```

--------------------------------

### Starting the Unconfiguration Utility

Source: https://www.ibm.com/docs/en/capm/index_topic=collector-unconfiguring-data-interactively

Commands to launch the unconfiguration utility. Use the appropriate script based on your operating system (Linux/Unix or Windows).

```bash
./unconfig.sh
```

```batch
unconfig.bat
```

--------------------------------

### SOAP Profile Example Configuration

Source: https://www.ibm.com/docs/en/capm/index_topic=monitors-soap-monitor

Provides a concrete example of a SOAP profile element configuration, specifying values for WSDL, operation, location, polling, retries, and input/output parameters for monitoring a calculator service.

```text
wsdl: c:\%ISMHOME%\etc\SOAP.wsdl
operation: add
operationnamespace: `http://localhost/SOAP/Calculator`
location: http://serverA/SOAP/Calculator
description: basic Calculator SOAP monitor
Active: Selected
timeout: 30
poll: 300
failureretests: 2
retestinterval: 5
inputs: [in0=1,in1=2]
outputs: [addReturn=3]
```
Tokens:
Raw