EntireX	Version 9.7	SEARCH   CONTENTS   |   PDF PAGE   PDF BOOKS   |   HOME   UP   PREV   NEXT

EntireX Broker provides the following internal services: Command Service and Information Service, which can be used to administer and monitor brokers. Because these services are implemented internally, nothing has to be started or configured. You can use these services immediately after starting EntireX Broker. This document covers the following topics:

• ETBINFO

• ETBCMD

ETBINFO

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.

• Running the Command-line Utility

• Command-line Parameters

• Profile

• Format String

Running the Command-line Utility

In a z/VSE environment, run the command-line utility ETBINFO as shown below:

* $$ JOB JNM=RUNINFO,CLASS=0,DISP=D                                             
* $$ LST CLASS=A,DISP=H                                                         
// JOB RUNINFO                                                                  
*                                                                               
* INFORMATION SERVICES SAMPLE JCL                                               
*                                                                               
// LIBDEF *,SEARCH=(SAGLIB.EXX960,SAGLIB.WAL826)                                
/*                                                                              
/* / EXEC ETBINFO,PARM='ENVAR("LOGNAME=ENTIRE")/-d BROKER -c PING -bip:+      
/*               port:TCP'                                                    
// EXEC ETBINFO,PARM='ENVAR("LOGNAME=ENTIRE")/-d BROKER -c PING -bETBn+        
               nnnn:SVCmmm:NET'                                              
/*                                                                              
// EXEC LISTLOG                                                                 
/&                                                                              
* $$ EOJ

Command-line Parameters

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.

Profile

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.

Location of Profiles

On z/VSE, the profiles used to control the format of the data displayed are members of the EXX960 sublibrary and are named SERVER.PRO, CLIENT.PRO etc.

Example for using a profile:

// EXEC ETBINFO,PARM='ENVAR("LOGNAME=ENTIRE")/-b LOCALHOST:1971:TCP    +
               -d SERVICE -p DD:SAGLIB.EXX960(SERVICE.PRO)'

Format String

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:

// EXEC ETBINFO,PARM='ENVAR("LOGNAME=ENTIRE")/-b LOCALHOST:1971:TCP    +
-d SERVICE',                                            +
PARM=' -f "CLASS: %24SERVER-CLASS   SERVER: %24SERVER-NA+
ME   SERVICE: %24SERVICE"'

which produces:

CLASS:                      SAG   SERVER:                   ETBCIS   SERVICE:                     INFO
CLASS:                      SAG   SERVER:                   ETBCIS   SERVICE:                USER-INFO
CLASS:                      SAG   SERVER:                   ETBCIS   SERVICE:                      CMD
CLASS:                      SAG   SERVER:                   ETBCIS   SERVICE:     PARTICIPANT-SHUTDOWN
CLASS:                      SAG   SERVER:                   ETBCIS   SERVICE:             SECURITY-CMD

Example:

// EXEC ETBINFO,PARM='ENVAR("LOGNAME=ENTIRE")/-b DAVLCSI:9084:TCP      +
               -d BROKER',                                             +
               PARM=' -f "%12.12CPLATNAME   %NUM-SERVER   %NUM-CLIENT"'

which produces:

z/VSE 5.1.2   12   200

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. Please note that due to the PARM string syntax in the z/VSE EXEC command, \n becomes \\n. For example:

// EXEC ETBINFO,PARM='ENVAR("LOGNAME=ENTIRE")/-b LOCALHOST:1971:TCP    +
               -d SERVICE',                                            +
               PARM=' -f "CLASS: %SERVER-CLASS   \\n\\tSERVER: %SERVER-+
               NAME   \\n\\tSERVICE: %SERVICE"'

which produces:

CLASS: SAG
      SERVER: ETBCIS
      SERVICE: INFO
CLASS: SAG
      SERVER: ETBCIS
      SERVICE: USER-INFO
CLASS: SAG
      SERVER: ETBCIS
      SERVICE: CMD
CLASS: SAG
      SERVER: ETBCIS
      SERVICE: PARTICIPANT-SHUTDOWN
CLASS: SAG
      SERVER: ETBCIS
      SERVICE: SECURITY-CMD

ETBCMD

Allows the user to take actions - for example purge a unit of work, stop a server, shut down a Broker - against EntireX Broker.

• Running the Command-line Utility

• Command-line Parameters

• List of Commands and Objects

• Examples

Running the Command-line Utility

In a z/VSE environment, run the ETBCMD command-line utility like this:

* $$ JOB JNM=RUNCMD,CLASS=0,DISP=D                                              
* $$ LST CLASS=A,DISP=H                                                         
// JOB RUNCMD                                                                   
*                                                                               
* COMMAND SERVICES SAMPLE JCL                                                   
*                                                                               
// LIBDEF *,SEARCH=(SAGLIB.EXX960,SAGLIB.WAL826)                                
/*                                                                              
/* / EXEC ETBCMD,PARM='ENVAR("LOGNAME=ENTIRE")/-d BROKER -c PING -bip:+      
/*               port:TCP'                                                     
// EXEC ETBCMD,PARM='ENVAR("LOGNAME=ENTIRE")/-d BROKER -c PING -bETBnn+        
               nnn:SVCmmm:NET'                                               
/*                                                                              
// EXEC LISTLOG                                                                 
/amp;                                                                              
* $$ EOJ

Command-line Parameters

The table below explains the command-line parameters. All entries in the Option column are case-sensitive.

Transport ID Values

This table explains the possible values for parameter transportid:

List of Commands and Objects

This table lists the available commands and the objects to which they can be applied.

Examples

www.softwareag.com

Copyright © 1997-2014 Software AG, Darmstadt, Germany.

SEARCH   CONTENTS   |   PDF PAGE   PDF BOOKS   |   HOME   UP   PREV   NEXT