SAP Agent Upgrade on Windows and non-Windows platforms: Creating backup of configuration file

About this task

User must create backup of the agent configuration file before upgrading SAP agent on Windows and non-Windows platforms.

Procedure on Windows Platform

Perform the following steps to save the agent configuration file KSAENV and preserve the configuration after agent upgrade:

  1. Stop the Transaction Tracking consumer utility. Refer to Starting and stopping SAP Transaction Tracking consumer utility.
  2. Locate the agent configuration file install_dir\tmaitm6_x64\KSAENV, where install_dir is the agent installation directory such as C:\IBM\APM on Windows platform.
  3. Create a backup copy of the KSAENV file and store it locally in another folder. The KSAENV file contains the agent configuration changes.
  4. Perform the agent upgrade.
  5. The KSAENV file is overwritten after agent is upgraded to a new version, however the instance specific configuration file KSAENV_instance_name remains intact after upgrade, where instance_name is the agent instance name.
  6. Update the agent configuration parameters in the new KSAENV file by referring to the backup copy of KSAENV. Then, save and close the file.
  7. For all the existing agent instances, re-configure the agent instances and restart the agent instances to reflect the changes.
  8. If new agent instances are configured, start the agent instances.
  9. Start the Transaction Tracking consumer utility. Refer to Starting and stopping SAP Transaction Tracking consumer utility.

Results on Windows Platform

The updates in the configuration file KSAENV are applied to all agent instances after agent upgrade.

Procedure on non-Windows Platform

Perform the following steps to save the agent configuration file .sa.environment and preserve the configuration after agent upgrade:

  1. Stop the Transaction Tracking consumer utility. Refer to Starting and stopping SAP Transaction Tracking consumer utility.
  2. Locate the agent configuration file install_dir/config/.sa.environment, where install_dir is the agent installation directory such as /opt/IBM/APM on non-Windows platform.
  3. Create a backup copy of the .sa.environment file and store it locally in another folder. The .sa.environment file contains the agent configuration changes.
  4. Perform the agent upgrade.
  5. The .sa.environment file is overwritten after agent is upgraded to a new version, however the instance specific configuration file sa_instance_name.environment file remains intact after upgrade, where instance_name is the agent instance name.
  6. Update the agent configuration parameters in the new .sa.environment file by referring to the backup copy of .sa.environment. Then, save and close the file.
  7. For all the existing agent instances, re-configure the agent instances and restart the agent instances to reflect the changes.
  8. If new agent instances are configured, start the agent instances.
  9. Start the Transaction Tracking consumer utility. Refer to Starting and stopping SAP Transaction Tracking consumer utility.

Results on non-Windows Platform

The updates in the configuration file .sa.environment are applied to all agent instances after agent upgrade.