EntireX Broker provides internal Information Services, which can be used to monitor the EntireX Broker. Because these services are implemented internally, nothing has to be started or configured. You can use these services immediately after starting EntireX Broker.
Queries the Broker for different types of information, generating an
output text string with basic formatting. This text output can be further
processed by script languages. etbinfo uses data descriptions called profiles
to control the type of data that is returned for a request. etbinfo is useful
for monitoring and administering EntireX Broker efficiently, for example how
many users can run concurrently and whether the number of specified message
containers is large enough.
Although basic formatting of the output is available, it is usually formatted by script languages or other means external to the Broker.
In a Windows environment, run the command-line utility with
etbinfo. If the environment variable
LOGNAME is not set, you must use the -x option
(see below) to provide a user ID if the Broker is running with
EntireX Security. .
The table below explains the command-line parameters. The format string and profile parameters are described in detail following the table. All entries in the Option column are case-sensitive.
| Option | Command-line Parameter | Req/ Opt |
Explanation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
-b |
brokerid |
R | Broker identifier, for example
localhost:1971:TCP.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
-c |
class |
O | Class as selection criterion. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
-C |
csvoutput |
O | Comma-separated variable output, suitable for input into a spreadsheet or other analysis tool. Any format string specified by means of format string or profile command-line parameters is ignored. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
-d |
object |
R | Possible values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
-e |
recv class |
O | Receiver's class name. This selection criterion
is valid only for object PSF.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
-f |
Format String | O | Format string how you expect the output. See Profile. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
-g |
recv service |
O | Receiver's service name. This selection criterion
is valid only for object PSF.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
-h |
help |
O | Prints help information. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
-i |
convid |
O | Conversation ID as selection criterion. Only
valid for object CONVERSATION.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
-I |
conv type |
O | Conversation's type. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
-j |
recv server |
O | Receiver's server name. This selection criterion
is valid only for object PSF.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
-k |
recv token |
O | Receiver's token. This selection criterion is
valid only for object PSF.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
-l |
level |
O | The amount of information displayed:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
-m |
recv userid |
O | Receiver's user ID. This selection criterion is
valid only for object PSF.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
-n |
server name |
O | Server name. This selection criterion is valid
only for the objects SERVER,
SERVICE or
CONVERSATION.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
-p |
file | O | Here you can specify a file that defines the layout of the output. There are
default files you can modify or you can use your own. The default files are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
-q |
puserid |
O | Physical user ID. This selection criterion is
valid only for objects CLIENT,
SERVER,
CONVERSATION,
SUBSCRIBER,
PUBLISHER or
PUBLICATION.
Note: |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
-P |
publication id |
O | Publication ID. This selection criterion is valid
only for object PUBLICATION.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
-r |
sec |
O | Refresh information after seconds. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
-s |
service |
O | Service. This selection criterion is valid only
for objects SERVER,
SERVICE or
CONVERSATION.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
-S |
"sslparms" |
O | When using SSL transport. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
-t |
token |
O | This selection criterion is valid only for
objects CLIENT,
SERVER, SERVICE,
CONVERSATION,
SUBSCRIBER,
PUBLISHER,
PUBLICATION or
TOPIC.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
-T |
topic |
O | Topic name. This selection criterion is valid
only for objects PUBLICATION,
SUBSCRIBER,
PUBLISHER, or
TOPIC.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
-u |
userid |
O | User ID. This selection criterion is only valid
for the display types CLIENT,
SERVER, SERVICE,
CONVERSATION,
SUBSCRIBER,
PUBLISHER,
PUBLICATION or
TOPIC.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
-U |
subscr type |
O | Subscriber's subscription type. This selection
criterion is valid only for object
SUBSCRIBER.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
-v |
UOW status |
O | Unit of work status. This selection criterion is
valid only for object PSF.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
-w |
UOW ID |
O | Unit of work ID. This selection criterion is
valid only for object PSF.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
-x |
userid |
O | User ID. For security purposes. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
-y |
password |
O | Password. For security purposes. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
-z |
token |
O | Used with userid
to uniquely identify a caller to Command and Information Services.
|
etbinfo supports an alternative method of passing command-line
parameters.
If the environment variable INF_ATTR is set, the content is interpreted
as a file name. If no command-line parameters are given, the command
etbinfo evaluates the content of the file.
Example:
-blocalhost:3930:TCP -dBROKER
If you do not use the profile option or a format string, your output will be an unformatted list with all columns of that display type. To display specific columns, specify a profile that includes only those columns.
The following default sample profiles include all the columns defined for each display type:
|
|
|
You can either delete the columns not required or copy the default profile and modify the order of the columns. Ensure that the column names have a leading "%". Column names can be written in one line or on separate lines. The output is always written side by side.
On Windows, the profiles are contained in directory <drive>:\SoftwareAG\EntireX\etc and are named broker.pro, client.pro etc.
Profile for object SERVICE: SERVICE.
etbinfo -b ETB001 -d SERVICE -p service.pro -l FULL
The following list is displayed:
SAG ETBCIS INFO 1 0 16 86400 0 31647 0 00 00 00 00 0 0 SAG ETBCIS USER-INFO 2 0 16 86400 0 31647 0 00 00 00 00 0 0 SAG ETBCIS CMD 6 0 16 86400 0 31647 0 00 00 00 00 0 0
Your own profile: MYPROF
etbinfo -b ETB001 -d SERVICE -p my_service.pro
Note:
In this case, my_service.pro
contains:%4.4SERVERCLASS %SERVERNAME
The following list is displayed:
ACLA ASERVER BCLA BSERVER CCLA CSERVER
You can find the sample profiles for etbinfo in your
<drive>:\SoftwareAG\EntireX\EntireX\config
directory.
The format string, if specified, will override the use of a profile. The
format string is built like a printf() in C language.
The string must be enclosed in quotation marks. You can specify the columns by
using a "%" and the column name. The column name must contain
letters only. Numeric characters are not allowed. You can specify the length of
column output by using a format precision, as in the ANSI-C
printf() function. The column name must be followed by
a blank. For example:
etbinfo -b ETB001 - BROKER -f "%12.12CPLATNAME %NUM-SERVER %NUM-CLIENT"
which gives, for example:
MVS/SP 7.04 30 100
You can also use an arbitrary column separator, which can be any
character other than "%". You can use \n for a new
line in the output and \t for a tabulator in the format string or
profile. For example:
etbinfo -b ETB001 -d SERVER -f "UserID: %5.5USER-ID Token: %5.5TOKEN"
which gives:
UserID: HUGO Token: MYTOK UserID: EGON Token: UserID: HELMU Token: Helmu
If you want to structure your output a little more, you can operate with
the \n or \t character. For example:
etbinfo -b ETB001 -d SERVICE -f "Class:%5.5SERVER-CLASS \n\tName:%5.5SERVER-NAME \n\tService:%5.5SERVICE"
which produces:
Class:DATAB
Name:DB10
Service:Admin
Class:PRINT
Name:LPT1
Service:PRINT
...
