Skip to end of metadata
Go to start of metadata

Telnet Commands Related to the SAP JMS Provider

Applies to:
SAP NetWeaver Composition Environment 7.1 SP3 and higher

The SAP JMS Provider service provides Telnet commands for administering and monitoring the JMS resources in a server.
To use these commands, enable the JMS commands group with ADD JMS.
To show the help information about the available commands in the JMS group, you can type one of the following in the command line:

  • JMS -h
  • JMS -?
  • MAN JMS

jms_list
Shows information about the JMS runtime objects - connections, sessions, producers, consumers, etc.
The generic command is jms_list [JSTSG:command] <destinationName> <virtualProviderName>
where:
<destinationName> specifies the JMS destination
<virtualProviderName> specifies the JMS Virtual Provider

jms_list destinations <virtualProviderName>
Displays the currently active destinations for the specified Virtual Provider. Note that this command provides runtime
information - only destinations with currently registered producers and/or consumers are listed.
If you do not specify a Virtual Provider, the active destinations for all Virtual Providers are displayed.

jms_list config_destinations <virtualProviderName>
Displays all destinations for the specified Virtual Provider. This command provides a snapshot of all the configured destinations, including the ones that currently do not have any registered producers and/or consumers.
If you do not specify a Virtual Provider, all destinations for all Virtual Providers are displayed. 

jms_list config_factories <virtualProviderName>
Displays the currently active connections created by connection factories belonging to the specified Virtual Provider.
If you do not specify a Virtual Provider, all currently active connections created from connection factories belonging to
any Virtual Provider are displayed. 

jms_list sessions <virtualProviderName> 
Displays the currently active sessions created from connection of the specified Virtual Provider. 
If you do not specify a Virtual Provider, all currently active sessions for all Virtual Providers are displayed. 

jms_list producers <virtualProviderName
Displays the currently active producers registered to destinations belonging to the specified Virtual Provider.
If you do not specify a Virtual Provider, all currently active producers registered to destinations belonging to any
Virtual Provider are displayed. 

jms_list consumers <virtualProviderName> 
Displays the currently active consumers registered to destinations belonging to the specified Virtual Provider.
If you do not specify a Virtual Provider, all currently active consumers registered to destinations belonging to any
Virtual Provider are displayed. 

jms_list browsers <virtualProviderName>
Displays the currently active browsers registered to Queues belonging to the specified Virtual Provider.
If you do not specify a Virtual Provider, all currently active browsers registered to queues belonging to any Virtual Provider are displayed. 

jms_list vps
Displays information about all Virtual Providers. 

jms_list subscriptions <virtualProviderName>
Displays the durable subscriptions registered to topics belonging to the specified Virtual Provider.
If you do not specify a Virtual Provider, all registered durable subscriptions registered to Topics belonging to any Virtual Provider are displayed. 

jms_list msg <destinationName> <virtualProviderName>
Lists the messages present in the database for the particular destination. You must specify both destination name and
Virtual Provider name. For example, jms_list msg sapDemoQueue default

list_temp_destinations
Displays details about the currently existing temporary JMS destinations.
The generic command is list_temp_destinations <virtualProviderName>,
where the <virtualProviderName> specifies the JMS Virtual Provider, for which the temporary destinations will be
listed.
Note: It is obligatory to specify the <virtualProviderName>.
Example: list_temp_destinations default

Monitoring the JMS Provider using the jms_monitor command

Applies to:
SAP NetWeaver Composition Environment 7.1 EHP1 and higher

The common syntax of the command is jms_monitor <commandOption> vp=<virtualProviderName> <additionalParameter>,
where the name of the JMS Virtual Provider vp=<virtualProviderName> is optional and the additional parameter is the name of a destination or the name of an application.

Using commands, you can access the following runtime information of the JMS Provider:

  • messages that are sent but not acknowledged yet
  • the time of the last message for a particular destination delivered to a consumer
  • if a particular destination has dead (undeliverable) messages
  • browse the messages in a particular Queue
  • configuration and current status of a JMS Store-and-Forward Agent for a particular application

Currently, the following monitors are available via the jms_monitor command in the JMS group.

jms_monitor -p vp=<virtualProviderName> dest=<destinationName>
or
jms_monitor -pending vp=<virtualProviderName> dest=<destinationName>
Pending messages are such messages, which are sent but not acknowledged yet. This monitor lists all pending messages for a given destination. If you specify only the name of a Virtual Provider, you get all pending messages for all destinations that belong to that particular Virtual Provider. For example, jms_monitor -p vp=default dest=sapDemoTopic
If you do not specify any Virtual Provider or destination, you get all pending messages for all destinations and their corresponding Virtual Providers. For example, jms_monitor -p

jms_monitor -lastDeliveryTime vp=<virtualProviderName> <dest=destinationName>
Displays the last time the message was delivered to a consumer registered to the specified destination.
For example, jms_monitor -lastDeliveryTime vp=default dest=sapDemoQueue

jms_monitor -deadMsgAlert vp=<virtualProviderName> <dest=destinationName>
Shows if there are any dead messages for the specified destination. If there are dead messages, the deadMessagesAlert flag is set to true.
For example, jms_monitor -deadMsgAlert vp=default dest=sapDemoQueue

jms_monitor -resetDead vp=<virtualProviderName> <dest=destinationName>
This command resets the deadMessagesAlert flag.
For example, jms_monitor -resetDead vp=default sapDemoQueue

jms_monitor -browseQueue vp=<virtualProviderName> <dest=destinationName>
Creates a QueueBrowser to view the messages of the specified Queue.
Note: This monitor is available only for queues.
For example, jms_monitor -browseQueue vp=default dest=sapDemoQueue

jms_monitor -safAgentStatus vp=<virtualProviderName> <app=applicationName>
Shows the status of the Store-and-Forward (SAF) Agent of the specified application and general information about its local and remote resources. The status of the SAF Agent can be: RUNNING, STOPPED, NOT_AVAILABLE.
For example, jms_monitor -safAgentStatus vp=default app=sap.com/mySAFApplication

jms_monitor -cacheSize vp=<virtualProviderName>
Shows the size of the currently used server-side message cache in bytes.
For example, jms_monitor -cacheSize vp=default

jms_monitor -cacheCount vp=<virtualProviderName>
Shows the number of messages currently cached on the server.
For example, jms_monitor -cacheCount vp=default