Running the TIBCO EMS monitoring extension

This extension monitors and reports activity from TIBCO EMS servers. The information is then passed to the MVMM Extensible Agent. This section includes:

For information on installing this extension on the various supported platforms, see Installing-the-TIBCO-EMS-monitoring-extension.

Some TIBCO EMS monitoring extension features are:

  • monitoring of TIBCO EMS Server and associated static or dynamic objects
  • parallel monitoring of multiple servers through a single TIBCO EMS monitoring extension
  • monitoring of SSL-secured servers
  • command prompt interface for administering the monitoring extension and retrieving EMS servers
  • validation of monitored server information upon registration

If you have not already distributed your 

MVMM

 Extensible Agent and monitoring extension files, then do so now.

Related topics

Running-performance-and-availability-monitoring-extensions

Controlling the TIBCO EMS monitoring extension on Windows or UNIX

This monitoring extension is distributed as a zip file. It must be extracted before you can use it. After you have extracted the files from the archive into a directory (it must be a directory different than the MVMM Extensible Agent directory), BMC recommends installing it as a subdirectory of the MVMM Extensible Agent), use the --help command parameter to list available command parameters.

  1. Open a command prompt and change to the directory containing the distributed files.
  2. Enter the monitoring extension command qptibems (Windows) qptibems.sh (UNIX) followed by the required command parameter.

    To list all available command parameters, enter:
    For Windows: qptibems --help
    For UNIX: ./qptibems.sh --help

    For example, in Windows qptibems --start starts the monitoring extension; in UNIX ./qptibems.sh --start starts the monitoring extension. The table below lists the available command parameters to support information available with the --help parameter.

    (UNIX only) TIBCO EMS monitoring extension (qptibems) runs as a Java process. If you want to work directly with the process, use the ps command to find the active Java process.

Note

Although nearly any shell can be used with 

MainView Middleware Monitor

, many of the script files are written for the Korn shell.

Note

Some commands can use wildcards as described in the table below. Wildcards available are * or >. If used, place > in quotes. Use wildcards with the -validate switch. Otherwise the command does not resolve to the objects on the server.

Command parameters

Use to...

--install

Install the monitoring extension as a Windows Service.

--start

Start the monitoring extension in the background.

--stop

Stop the monitoring extension.

--console

Run the monitoring extension in the foreground, displaying log messages as they are generated. It is useful when trying to locate or troubleshoot problems.

--help

List the available command prompt options (this list) and short descriptions.

--status

Display the current status (running or stopped) of the monitoring extension.

--version

Display version information for the monitoring extension.

--remove

Remove the monitoring extension from the Windows registry.

Ctrl+c

Stop the monitoring extension. This is used in console mode. The command both stops the monitoring extension and exits console mode.

--config

 

 

Set the host and port of the MVMM Topic Service so that the monitoring extension can pass its information to it.

-host:name

Host name or IP address of the MVMM Topic Service. Optional.

-port:number

Port used by the MVMM Topic Service. Optional.

--register

 

 

 

 

 

 

Registers an EMS server and its objects for monitoring.

-srv:name

Name of the TIBCO EMS server. Required. Wildcards cannot be used when defining the server.

-queue:name

Name of the static queue. Wildcards are accepted. Dynamic or temporary queues cannot be registered for monitoring, but are registered as transient topics. You can only register static queues for monitoring with this command. Optional.

-topic:name

Name of the static topic. Wildcards are accepted. Dynamic or temporary topics cannot be registered for monitoring, but are registered as transient topics. You can only register static topics for monitoring with this command. Optional.

-route:name

Name of the route. No wildcards are supported. Optional.

-durable:name

Name of the static durable subscriber. No wildcards are supported. Dynamic durables cannot be registered for monitoring, but are registered as transient topics. You can only register static durables for monitoring with this command. Optional.

-validate

Validate the server, queues, etc. Required if you used wildcards when defining any queues, topics, and so on. Any object that cannot be validated against the EMS server is ignored.

--unregister

 

 

 

 

 

Unregisters an EMS server and its objects from monitoring.

-srv:name

Name of the TIBCO EMS server. Required.

-queue:name

Name of the static queue. Optional.

-topic:name

Name of the static topic. Optional.

-route:name

Name of the route. Optional.

-durable:name

Name of the static durable subscriber. Optional.

--addPref

 

 

 

 

 

 

 

 

Adds an EMS server profile as a preference.

-srv:name

Name of the TIBCO EMS server. Required.

-url:url

URL used to connect to the TIBCO EMS server. Required. The syntax for URLs is: protocol://host:port

For further details, see the EMS documentation.

-usr:user_name

User name to connect to the TIBCO EMS server. Required.

-pwd:password

Password to connect to the TIBCO EMS server. Required.

-ssl_identity:file_name

Name of the SSL certificate or identity file.

-ssl_identity_encoding:encoding

Encoding used for the SSL certificate. It can be one of the following:

  • AUTO (default)
  • ENTRUST
  • PKCS7
  • PKCS8
  • DER
  • KEYSTORE
  • PEM
  • PKCS12
-ssl_private_key:file_name

File containing the SSL private key.

-ssl_private_key_encoding:encoding

Encoding used for the SSL private key. It can be one of the following:

  • AUTO (default)
  • ENTRUST
  • PKCS7
  • PKCS8
  • DER
  • KEYSTORE
  • PEM
  • PKCS12
-ssl_password:password

Password used for encrypting the certificate or key.

-validate

Validate the server, queues, etc. Required if you used wildcards when defining any queues, topics, and so on. Any object that cannot be validated against the EMS server is ignored.

--listPref

List the EMS server profiles that are stored as preferences.

--removePref

 

Removes an EMS server profile from the preferences.

-srv:name

Name of the TIBCO EMS server. Required.

--changePref

 

 

 

 

 

 

 

 

 

Alters an EMS server profile stored as a preference.

-srvold:name

Name of the server profile to be altered. Required.

-srv:name

New name of the TIBCO EMS server. Optional.

-url:url

URL used to connect to the TIBCO EMS server. Optional. The syntax for URLs is: protocol://host:port

For further details, see the EMS documentation.

-usr:user_name

User name to connect to the TIBCO EMS server. Optional.

-pwd:password

Password to connect to the TIBCO EMS server. Optional.

-ssl_identity:file_name

Name of the SSL certificate or identity file.

-ssl_identity_encoding:encoding

Encoding used for the SSL certificate. It can be one of the following:

  • AUTO (default)
  • ENTRUST
  • PKCS7
  • PKCS8
  • DER
  • KEYSTORE
  • PEM
  • PKCS12
-ssl_private_key:file_name

File containing the SSL private key.

-ssl_private_key_encoding:encoding

Encoding used for the SSL private key. It can be one of the following:

  • AUTO (default)
  • ENTRUST
  • PKCS7
  • PKCS8
  • DER
  • KEYSTORE
  • PEM
  • PKCS12
-ssl_password:password

Password used for encrypting the certificate or key.

-validate

Validate the server, queues, etc.

--showServer (stored EMS server version)

 

 

 

 

 

Retrieve the EMS server status and objects available. There are different options available depending on whether you are using a server profile stored as a preference to connect to the TIBCO EMS server. This section describes the options available if the TIBCO EMS server is stored as a preference. If the EMS server is not stored as a preference, see the --showServer section directly below.

-srv:name

Name of the TIBCO EMS server. Required.

-queue:name

Name of the queue. Optional.

-topic:name

Name of the topic. Optional.

-route:name

Name of the route. Optional.

-durable:name

Name of the durable subscriber. Optional.

--showServer (not stored EMS server version)

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Retrieve the EMS server status and objects available. There are different options available depending on whether you are using a server profile stored as a preference to connect to the TIBCO EMS server. This section describes the options available if the TIBCO EMS server is not stored as a preference. If the EMS server is stored as a preference, see the --showServer section directly above.

URL used to connect to the TIBCO EMS server. Optional. The syntax for URLs is: protocol://host:port

For further details, see the EMS documentation.

User name to connect to the TIBCO EMS server. Optional.

Password to connect to the TIBCO EMS server. Optional.

Name of the SSL certificate or identity file.

Encoding used for the SSL certificate. It can be one of the following:

  • AUTO (default)
  • ENTRUST
  • PKCS7
  • PKCS8
  • DER
  • KEYSTORE
  • PEM
  • PKCS12

 

 

File containing the SSL private key.

Encoding used for the SSL private key. It can be one of the following:

  • AUTO (default)
  • ENTRUST
  • PKCS7
  • PKCS8
  • DER
  • KEYSTORE
  • PEM
  • PKCS12

Password used for encrypting the certificate or key.

Name of the queue. Optional.

Name of the topic. Optional.

Name of the route. Optional.

Name of the durable subscriber. Optional.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*