Version 9.6	SEARCH   CONTENTS   |   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

• ETBSRV

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 BS2000/OSD environment, run the command-line utility ETBINFO as shown below:

/CALL-PROCEDURE (LIB=EXX960.JOBS,ELE=ETBINFO)

This executes the utility in BS2000/OSD dialog mode.

The ETBINFO parameters are supplied using an SDF variable, for example:

/COMMAND = '-b&(BROKER-ID) -dBROKER'

See the delivered ETBINFO job control in EXX960.JOBS.

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 BS2000/OSD, the profiles used to control the amount of data displayed are contained in EXX960.JOBS and are called PRO-BROKER, PRO-CLIENT etc.

Example

Profile for object SERVICE: PRO-SERVICE.

To use a profile, the profile itself needs to be extracted from LMS library EXX960.JOBS. Uncomment the LMS-section including SDF variable COMMAND in S-procedure ETBINFO and adapt the profile name. For example:

...
/ START-LMS
//  MOD-LMS-DEFAULTS MAX-ERROR-WEIGHT=*RECOVERABLE
//  EXTRACT-ELEMENT                                                 -
//     *LIB(LIB  = &(EXX-JOBS),                                     -
//          ELEM = PRO-SERVICE,                                     -
//          TYPE = S),                                              -
//          TO-FILE    = #PROFILE,                                  -
//          FILE-ATTR  = (ACCESS-METHOD=*SAM),                      -
//          WRITE-MODE = *ANY
//END
/COMMAND = '-b&(BROKER-ID) -dSERVICE -p#PROFILE -lFULL'
...

See also the delivered ETBINFO job control in EXX960.JOBS for more details.

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:

/COMMAND = '-b&(BROKER-ID) -d BROKER -f "%12.12CPLATNAME   %NUM-SERVER      %NUM-CLIENT"'

which produces the following output, for example:

BS2000/OSD W 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:

/COMMAND = '-b&(BROKER-ID) -d SERVER -f "UserID: %5.5USER-ID Token: %5.5TOKEN"'

which produces:

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:

/COMMAND = '-b&(BROKER-ID) -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
...

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 BS2000/OSD environment, run the ETBCMD command-line utility like this:

/CALL-PROCEDURE (LIB=EXX960.JOBS,ELE=ETBCMD)

This executes the utility in BS2000/OSD dialog mode.

The ETBCMD parameters are supplied using an SDF variable. For example:

/COMMAND = '-b&(BROKER-ID) -dBROKER -cTRACE-ON -oLEVEL1'

See also delivered ETBCMD job control in EXX960.JOBS.

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.

Note:
Object type TRANSPORT applies to operating systems z/OS and z/VSE only.

Examples

ETBSRV

The broker command-line utility etbsrv monitors and controls all local brokers; remote brokers can also be monitored.

• Starting a Broker

• Pinging a Broker

• Pinging an RPC Server

• Restarting a Broker

• Stopping a Broker

• Enabling EntireX Security

• Disabling EntireX Security

Starting a Broker

Use command BROKER START to start a specified broker:

ETBSRV BROKER START "ETB001"

Pinging a Broker

Use command BROKER PING to display the status of a specified local or remote broker. Return code 0 means the broker is running; any other value means the broker has stopped. See Component Return Codes in EntireX. Example:

ETBSRV BROKER PING "ETB001"

Enter the command without specifying a broker to display the status of all brokers.

The information is the same as displayed using System Management Hub.

Pinging an RPC Server

Use command BROKER PINGRPC <brokerid> <class/server/service> to display the status of a specified RPC server. Return code 0 means the RPC server is running; any other value means the RPC server has stopped. See Component Return Codes in EntireX. Example:

ETBSRV BROKER PINGRPC "ETB001" "SAG/ETBCIS/RPCCIS"

The information is the same as displayed using System Management Hub.

Restarting a Broker

Use command ETBSRV BROKER RESTART to stop and restart a specified broker. Example:

BROKER RESTART "ETB001"

Stopping a Broker

Use command BROKER STOP to stop a local broker. Example:

ETBSRV BROKER STOP "ETB001"

Enabling EntireX Security

Activate security with command ETBSRV SECURITY ENABLE; once activated, security can only be deactivated with command SECURITY DISABLE.

To enable automatic scripts to execute administration service commands without having to enter a password, set the option TRUSTED-USER=YES when administration service security is activated.

ETBSRV SECURITY ENABLE TRUSTED-USER=YES

Disabling EntireX Security

Disable security with command ETBSRV SECURITY DISABLE.

www.softwareag.com

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

SEARCH   CONTENTS   |   PDF BOOKS   |   HOME   UP   PREV   NEXT