Presentation Server tssh commands

The TrueSight Presentation Server tssh commands provide the TrueSight Presentation Serverusers the options to set or change advanced settings from the command line interface. The tssh commands are also used as troubleshooting aids.

To run the tssh commands, you must have the required privileges on the computer where the TrueSight Presentation Server is installed. You must run these tssh commands from the installationDirectory\truesightpserver\bin folder. On a Linux environment, only a non-root user has the privileges to run most of the tssh commands. A root user can run only the following three commands:

  • tssh list
  • tssh help
  • tssh service (not available for a non-root user)

The following table describes the tssh commands that are available.

CommandDescriptionUsage
tssh certificate

Create, import, list, delete, and verify the certificates easily and quickly. You enter a few basic details, and the certificates are created and imported with minimal user intervention. 

tssh certificate create

Creates a private key pair and generates the certificate signing request (CSR). Prompts you to submit the CSR to the CA of your organization for signing. 

tssh certificate import <component name>

Imports the specified component's certificates into the Presentation Server keystore or truststore.

Example: tssh certificate import RSSO

tssh certificate list -f { full path of the keystore or truststore file name } -a aliasname

Lists the specified certificate details.

Example

tssh certificate list -f <TrueSight Presentation Server Installation Directory>\truesightpserver\conf\secure\loginvault.ks -a truesightserver

tssh certificate delete -f { full path of the keystore or truststore file name } -a aliasname

Deletes the specified certificate.

Example:

tssh certificate delete -f <TrueSight Presentation Server Installation Directory>\truesightpserver\conf\secure\loginvault.ks -a truesightserver

tssh certificate verify <component name>

Verifies if a secure connection can be established between the Presentation Server (operating as a client) and the specified component. 

tssh certificate verify TSIM


For more information, see Creating and importing certificates in TrueSight Presentation Server.

tssh component

Perform actions on components registered with the TrueSight Presentation Server.

tssh component list | sync <component ID> (SYNC_MOMETA | SYNC_MOS | SYNC_GROUPS | SYNC_DEVICES | SYNC_CITYPES | SYNC_AUTHPROFILES) | initialize <component DNS name>

Examples:

tssh component list - Displays the component ID, component name, and connection status of components registered with the TrueSight Presentation Server.

tssh component sync 1 <option> - Synchronizes the component with component ID 1. Options are:

SYNC_MOMETA - Synchronizes the MO meta information.

SYNC_MOS - Synchronizes the MO information.

SYNC_GROUPS - Synchronizes the groups.

SYNC_DEVICES - Synchronizes the devices from the TrueSight Infrastructure Management server.

SYNC_CITYPES - Synchronizes the CI Types from the TrueSight Infrastructure Management server.

SYNC_AUTHPROFILES - Synchronizes the authorization profiles to the TrueSight Infrastructure Management server.

tssh component initialize xyz.bmc.com - Re-initializes the TrueSight Infrastructure Management server component to obtain the devices, instances, groups and events.

tssh component update <infrastructure management component> <property> <value>- Updates the TrueSight Infrastructure Management server component's (FQDN format) tsimEventPruneInterval property to the specified value. For information on events pruning, see Events Pruning.


tssh component portcheck: Checks the port availability of a component.

For more information, see Checking a component port availability from the Presentation Server

tssh componenttype

Add or update custom components to the TrueSight Presentation Server.

Note: If you have configured the TrueSight Presentation Server for high availability, add or update components on both servers.

tssh componenttype add | update <component zip file path>

Example:

tssh componenttype add c:\compo\abc.zip - Adds a component abc whose zip file is in the specified path.

tssh database

Back up the TrueSight Presentation Server database and configure backup settings.

See Backing up the Presentation Server database.
tssh device

Delete stale devices.

tssh device delete all | <device DNS name>

Example:

tssh device delete all - Deletes all stale devices from the Presentation Server.

tssh dr

Configure the recovery TrueSight Presentation Server in a disaster recovery environment.

See Configuring the Presentation Server in the standalone and disaster recovery mode or Configuring the Presentation Server in the high-availability and disaster recovery mode

tssh dump

Archive a snapshot of the TrueSight Presentation Serverand restore the snapshot.

See Archiving the Presentation Server files.
tssh event

Clean up events in the TrueSight Presentation Server.

tssh event

See  Events are not cleaned up in the Presentation Server


tssh event reinitialize

See Reinitializing events in the Presentation Server

tssh ha

Configure the TrueSight Presentation Server in High Availability (HA) mode.

See TrueSight Presentation Server high availability deployment

tssh list

Lists the tssh commands that are available.


Note: (Linux) Both the root and non-root user can run this command.
tssh list
tssh localeAdd or update, or delete a locale to the Presentation Server.

tssh locale list add update <language-name> <language-code> <resourceFileName> | delete <language-name>  

Examples:

tssh locale list - Displays the list of current locales.

tssh locale add - Adds a new locale with the specified resource file name.

tssh locale update - Updates the specified locale if json file name has changed.

tssh locale delete - Deletes the locale.

For more information, see Creating and applying a custom language pack.

tssh logger

Enable debug logging for some or all loggers in the TrueSight Presentation Server.

See Enabling logging of the Presentation Server.
tssh process

Start, stop, and view the status of the TrueSight Presentation Server processes.

tssh process start | stop | status (database | indexserver | CSR)

Example:

tssh process status database - Displays the status of the Presentation Server database.

tssh properties

Set, view, and reload the TrueSight Presentation Server properties.

tssh properties list: Displays the list of properties with the current values.

Syntax: tssh properties list

Example: tssh properties list


tssh properties reload: Reloads the properties. Use this command after you update the values of properties.

Syntax: tssh properties reload

Example: tssh properties reload


tssh properties set: Sets a particular tssh property.

Syntax: tssh properties set <property name> <property value> [reload]

Note: Reload is an optional parameter and enables you to immediately reload a property after its value is set.


Examples:

  • tssh properties set cmdb_user_name cmdbuser reload: This command sets the cmdb_user_name property value to cmdbuser and reloads the property.
  • tssh properties set include.citypes.as.service <CI Types list seperated by comma>: This command includes any additional CI Types (predefined and user-defined) those are not listed on the Services page of the TrueSight console, when you click Configure CI Types option. For more information, see To configure additional CI Types as a services.
  • tssh properties set askCredentialsForAQT <true/false>: This command helps you enable (value, true) or disable (value, false) authentication for running a query on the PATROL Agent.

  • tssh properties set forceNotesForEventOps true reload: This command forces users to insert notes before applying event operations such as acknowledging and unacknowledging an event, assigning an event, taking or declining ownership, closing an event, and setting the event priority.
  • tssh properties set monitoring.group.tree.default.expanded false reload: This command allows users to display a collapsed view of nodes (only parent nodes) in the monitoring group name. By default, the value is set to true and displays an expanded view of nodes.

  • tssh properties set excludeNativeMonitors <value>: This command is used to include or exclude native monitors while creating notification rules and attribute sets. You can set one of the following values:

    • true: Native monitors are excluded and will not be listed. You cannot select a native monitor while creating a notification rule or an attribute set.

    • false: Native monitors are included and they will be listed. You can select a native monitor while creating a notification rule or an attribute set.

    By default, excludeNativeMonitors is set to true.

For enabling the base user group, set these properties to true or false:

      • tsps.usergroup.base.enabled
      • tsps.usergroup.base.name
    • tssh properties set manageDashboardInSharingMode true reload: This command is used to allow users to edit dashboards shared with them even though they do not own them.


tssh server

Start and stop the TrueSight Presentation Server.

List the version and status of the TrueSight Presentation Server.

Check the TrueSight Presentation Server ports for availability.

tssh server start | stop | version | status | portcheck

Examples:

tssh server start - Starts all the TrueSight Presentation Server services. Note that you cannot start this service if the computer hosting the Presentation Server does not meet the system requirements.

tssh server start force - Forces all the TrueSight Presentation Server services to start irrespective of whether the computer hosting the Presentation Server meets the System requirements for Presentation Server.

tssh server stop - Stops all the TrueSight Presentation Server services.

tssh server version - Lists the TrueSight Presentation Server version and build number.

tssh server status - Lists the status of the database, index server, and core server processes of the TrueSight Presentation Server.

tssh server portcheck - Checks the TrueSight Presentation Server ports for availability and displays the status - busy or available. For more information, see Troubleshooting startup problems due to port conflicts.

tssh service

(Linux only) Register the TrueSight Presentation Server for non-root users.

Note: (Linux) Only a root user can run this command.

tssh service register <non-root User> - Registers the BMCTSPSSvc.service service under the /etc/systemd/system folder.

tssh service deregister <non-root User> - Deregisters and removes the BMCTSPSSvc.service service from the /etc/systemd/system folder.

For more information, see Register the BMCTSPSSvc service on Linux

tssh servicelogon

Configure the TrueSight Presentation Server to run as a Network Service user.

This command is no longer supported. However, you can configure the TrueSight Infrastructure Management and TrueSight Presentation Server to run as Network Service user. For more information, see Configuring TrueSight Operations Management components to run as a Network Service user.

Related topics

Configuring and managing the Presentation Server

Troubleshooting


Was this page helpful? Yes No Submitting... Thank you

Comments