Install the TSPS Component

Issue with TrueSight Presentation Server 11.3.03 Upgrade

Upgrading TrueSight Presentation Server to version 11.3.03 while the Hardware Sentry KM TSPS Component is already installed and configured in your environment can prevent it from loading properly in TrueSight. As a result:

• The TrueSight interface no longer displays links to Hardware Sentry KM
• The Component page no longer lists Hardware Sentry KM

This problem occurs because the upgrade script modifies the /opt/bmc/TrueSightPServer/truesightpserver/conf/custom/csr.conf configuration file, overriding the Hardware Sentry KM TSPS Component's default entries in /opt/bmc/TrueSightPServer/truesightpserver/conf/services/csr.conf.

To fix the problem:

1. Edit the /opt/bmc/TrueSightPServer/truesightpserver/conf/services/csr.conf and locate the following line:

   vm.args.classpath.282="${truesight.home}/lib/hardware-sentry-tsps-rest-api.jar"
   

   Note: The numbers may vary depending on your environment.

2. Replace the entry number (282 in the above example) with a number that is not listed in either this files (./conf/services/csr.conf) and ./conf/custom/csr.conf. In a typical setup, replacing 282 with 287 will work:

   vm.args.classpath.287="${truesight.home}/lib/hardware-sentry-rest-gateway.jar"
   

3. Then restart TrueSight Presentation Server with the below commands:

   $ ./tssh server stop
   $ ./tssh server start
   

Everything should work as expected after the restart and a refresh of the TrueSight interface in your browser.

Handling backslashes in object IDs

Some KMs, such as BMC's Windows KM and Microsoft SQL Server KM, use backslashes (\) in object IDs for certain classes. When accessing these objects in Hardware Sentry KM via a web browser or the REST API, the URL includes the object path, which may contain backslashes.

By default, Apache Tomcat—the Web server and Application Server behind TrueSight Presentation Server—blocks backslashes in URLs. As a result, attempting to access a monitored object with a backslash in Hardware Sentry KM through TSPS will result in an (HTTP/400 Bad Request).

To solve this problem, you need to modify Apache Tomcat’s configuration to permit backslashes in URLs:

1. Edit the ./conf/custom/csr.conf file in your TSPS installation directory

2. Add the following lines:

   # Allow backslashes
   vm.args.system.501=-Dorg.apache.catalina.connector.CoyoteAdapter.ALLOW_BACKSLASH=true
   vm.args.system.502=-Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true
   

   Note: If there is already a vm.args.system.501 or vm.args.system.502 entry, use the next numbers in sequence.

3. Run the below command to restart TrueSight Presentation Server:

   $ ./tssh server stop
   $ ./tssh server start
   

HA Installation

In a clustered environment, the installation of the Hardware Sentry KM TSPS Component must be performed on each TrueSight Presentation Server (TSPS) node. The configuration however needs to be done only on the active node.

The below procedure is therefore recommended:

1. Install the Component on the standby node (B), following the above installation procedure.

2. Wait for this TSPS node (B) to restart and be back in standby status. Do not proceed with the next step until TSPS is ready on the standby node (B).

3. Install the Component on the active node (A), with the same procedure.

   This will trigger a restart of TSPS, and potentially a failover of the cluster (where node B takes over and becomes the active node).

4. Wait for the cluster to be back online. This may take several minutes. Be patient.

5. Connect to the TSPS interface, using the cluster address, and configure the Component, following the regular procedure.

6. Optionally, trigger a failover of the cluster by running a tssh server start on the active node.

   Once the cluster is back online, verify that the Hardware Sentry TSPS Component is still properly listed as Connected in Administration > Components.

   This optional step simply verifies that the failover mechanism will work safely for Hardware Sentry KM.

To determine the exact hostnames and the status of each node in your clustered TSPS, you can run the below command on either node:

[tsps@dev-tsps-ha-1 bin]$ ./tssh ha status

+--------------------------------------------------------------------------------------------+
|   BMC TrueSight Presentation Server - Command Line Interface 2020 version 11.3.04          |
|   Copyright 2014-2020. BMC Software, Inc. as an unpublished work.  All rights reserved.    |
+--------------------------------------------------------------------------------------------+


Real-time Stats details
==============================
Node State :> Active
Active since :> Dec 7, 2020 6:15:00 PM



Primary node details
------------------------------
TSPS FQDN :> dev-tsps-ha-1.internal.sentrysoftware.net
Cache replication port :> 7800
Control port :> 8800



Secondary node details
------------------------------
TSPS FQDN :> dev-tsps-ha-2.internal.sentrysoftware.net
Cache replication port :> 7800
Control port :> 8800



Load Balancer
------------------------------
FQDN :> dev-tsps-ha.internal.sentrysoftware.net

HA Upgrade

Similarly, the upgrade of the Hardware Sentry KM TSPS Component must be performed on each node:

1. Upgrade on the standby node with tssh componenttype update.

2. Wait for TSPS to restart and be back in standby status. Do not proceed with the next step until TSPS is ready on the standby node.

3. Upgrade on the active node with the same procedure.

   Note: This will trigger a restart of TSPS, and potentially a failover of the cluster. This may take several minutes. Be patient.

Upgrades do not require to re-configure the TSPS Component.

HA Removal

The removal of the Hardware Sentry KM TSPS Component in a clustered environment is a bit trickier. Follow the below procedure carefully:

1. Delete the Hardware Sentry Component through Administration > Components in the TrueSight interface.

   • If the component is immediately deleted, you can skip to the 4th step.
   • If the component remains in the Deleting state, proceed with the next step.

2. Restart the active node with tssh server start.

   This will trigger a failover of the cluster and will synchronize the TSPS configuration from the active node to the standby node.

3. Wait for the cluster to be back online. This may take several minutes. Again, be patient.

4. Refresh your browser, and verify in the Administration > Components interface that the Hardware Sentry TSPS Component is no longer listed.

During the removal procedure, you may experience a blank screen issue when you refresh your browser (the TrueSight interface doesn't load). This is caused by the intermediary state of the cluster. The restart of the active node should solve the issue.