EntireX Broker provides an API for Command and Information Services (CIS) that include the following: shutting down conversations, servers and services; switching trace on and off; retrieving information on clients; registering servers and services.
Command and Information Services can be accessed from any environment from which EntireX Broker can be accessed. The structures for these services are available for the programming languages Assembler, C, Natural and COBOL.
Before referring to the structure tables below, see section Command-line Utilities.
This document describes the Command and Information Services data structures. It covers the following topics:.
Note:
Version numbers in the tables below refer to the CIS interface version
and not to the Broker version.
The request structure is given in the table below. Note possible combinations under Command Request Parameter Combinations.
The following table shows all valid combinations of parameters:
Object Type | Command | Option | Comment |
---|---|---|---|
BROKER |
APPMON-OFF |
Turn off the Application Monitoring feature in Broker. | |
APPMON-ON |
Turn on the Application Monitoring feature in Broker. | ||
CLEAR-CMDLOG-FILTER |
Remove a command log filter. The command log filter can be
identified using the fields
UID , SERVER-CLASS ,
SERVER and SERVICE .
|
||
DISABLE-ACCOUNTING |
Disable accounting. | ||
DISABLE-CMDLOG |
Disable command logging. | ||
DISABLE-CMDLOG-FILTER |
Disable a command log filter. The command log filter can be
identified using the fields
UID , SERVER-CLASS ,
SERVER and SERVICE .
|
||
DISABLE-DYN-WORKER |
Disable the
DYNAMIC-WORKER-MANAGEMENT .
DYNAMIC-WORKER-MANAGEMENT=YES must be configured
in the attribute file. The current number of active worker tasks will not be
changed until DYNAMIC-WORKER-MANAGEMENT is
enabled again.
|
||
ENABLE-ACCOUNTING |
Enable accounting. | ||
ENABLE-CMDLOG |
Enable command logging. | ||
ENABLE-CMDLOG-FILTER |
Enable a command log filter. The command log filter can be
identified using the fields
UID , SERVER-CLASS ,
SERVER and SERVICE .
|
||
ENABLE-DYN-WORKER |
Enable the
DYNAMIC-WORKER-MANAGEMENT again.
DYNAMIC-WORKER-MANAGEMENT=YES must be configured
in the attribute file. DYNAMIC-WORKER-MANAGEMENT
has been disabled before. Additional worker tasks can be started again, or
stopped if not used.
|
||
PRODUCE-STATISTICS |
Output current statistics to the broker log. | ||
SET-CMDLOG-FILTER |
Add a command log filter. The command log filter can be identified using the fields
UID , SERVER-CLASS ,
SERVER and SERVICE .
|
||
SET-COLLECTOR |
collector broker id |
Set the collector broker ID. | |
SHUTDOWN |
Shutdown Broker immediately. | ||
SWITCH-CMDLOG |
Force a switch of command logging output files. | ||
TRACE-FLUSH |
Flush all trace data kept in internal trace buffers to stderr
(DD:SYSOUT ). The broker-specific attribute
TRMODE=WRAP is required.
|
||
TRACE-OFF |
Set trace off in Broker. | ||
TRACE-ON |
LEVEL |
Set TRACE-LEVEL on in
Broker.
|
|
TRAP-ERROR |
error number |
Modifies the setting of the broker-specific attribute
TRAP-ERROR .
|
|
CONVERSATION |
SHUTDOWN |
convid |
|
SERVER |
SHUTDOWN |
IMMED |
Shutdown server immediately. The server must be uniquely
identified using field P_USER_ID or
SEQNO and will be completely removed from the BROKER
environment. The following steps will be performed: |
QUIESCE |
Shutdown server but allow existing conversations to continue. The termination is signaled to the server by error code 00100051. After this, the next call issued must be a DEREGISTER
for all services (SC=*,SN=*,SV=* if more than one service is active).
|
||
PSF |
ALLOW-NEWUOWMSGS |
New UOW messages are allowed. | |
CONNECT-PSTORE |
Connect the persistent store. | ||
DISCONNECT-PSTORE |
Disconnect the persistent store. | ||
FORBID-NEWUOWMSGS |
New UOW messages are not allowed. | ||
PURGE |
Remove a unit of work from the EntireX Broker persistent store (from version 2). | ||
SET-UOW-STATUS |
ACCEPTED |
Change the status of a UOW that resides in the postpone queue back to status ACCEPTED to make it receivable again.Applies to the specified UOW only. To address all UOWs of a service, use broker command-line utility ETBCMD
(z/OS |
UNIX |
Windows). See also Postponing Units of Work under Using Persistence and Units of Work in the Platform-independent Administration documentation.
|
|
CANCELLED |
Cancel the specified UOW that resides in the postpone queue. It performs SYNCPOINT OPTION=CANCEL of the receiver.Applies to the specified UOW only. To address all UOWs of a service, use broker command-line utility ETBCMD .
|
||
TRACE-OFF |
Set trace off in the persistent store. | ||
TRACE-ON |
LEVEL |
Set TRACE-LEVEL on in the persistent store.
|
|
PARTICIPANT |
SHUTDOWN |
IMMED |
Shutdown participant immediately. The participant must be
identified, using fields P-USER-ID ,
UID or TOKEN and will be
completely removed from the Broker environment. The following steps will be performed: |
QUIESCE |
Shutdown participant but allow existing conversations to continue. The termination is signaled to the participant by error code 00100051. | ||
seqno |
INFO requests return a seqno that can be used here to identify the target. | ||
SECURITY |
RESET-USER |
Clear all cached security information for a user. The user must
be identified using the field UID .
|
|
TRACE-OFF |
Set trace off in EntireX Security. | ||
TRACE-ON |
LEVEL |
Set TRACE-LEVEL on in EntireX
Security.
|
|
SERVICE |
SHUTDOWN |
IMMED |
|
QUIESCE |
|||
class/server/service |
|||
TRANSPORT |
RESUME |
NET | Snn |
Tnn |
Resume NET transport or a specific SSL or TCP communicator instance. |
START |
NET | Snn |
Tnn |
Start NET transport or a specific SSL or TCP communicator instance. | |
STATUS |
NET | Snn |
Tnn |
Show status of NET transport or a specific SSL or TCP communicator instance. | |
STOP |
NET | Snn |
Tnn |
Stop NET transport or a specific SSL or TCP communicator instance. | |
SUSPEND |
NET | Snn |
Tnn |
Suspend NET transport or a specific SSL or TCP communicator instance. | |
TRACE-OFF |
COM | NET | SSL | TCP |
Switch trace off for all communicators (COM) or only NET, SSL or TCP communicators. | |
TRACE-ON
LEVELn |
COM | NET | SSL | TCP |
Set trace level for all communicators (COM) or only NET, SSL or TCP communicators. |
This section describes the header structure (Struct HD_CIS
),
which is used by both the information services and the command service. For
command-specific or information-specific structures, see
Command Request Structure or Information Request Structure.
The header structure is always the first structure in the receive buffer
that comes back from an information or command service request. Even receive
buffers obtained with subsequent RECEIVE
commands
have this structure as the first part of the buffer. The header structure has
the following layout, whereby in the Format column I = 4-byte integer
value:
Field Name | Format | CIS Interface Version |
Comment |
---|---|---|---|
ERROR-CODE |
I4 | 1 | Result of request. Value 0 indicates success. See Broker Command and Information Services Error Codes. |
TOTAL-NUM-OBJECTS |
I4 | 1 | Total number of objects returned in object list. |
CURRENT-NUM-OBJECTS |
I4 | 1 | Number of objects returned within current receive block. |
MAX-SC-LEN |
I4 | 1 | Length of longest SERVER-CLASS value in
total object list. This field is only relevant if the object-specific structure
for the object list contains the SERVER-CLASS
field.
|
MAX-SN-LEN |
I4 | 1 | Length of longest SERVER-NAME value in
total object list. This field is only relevant if the object-specific structure
for the object list contains the SERVER-NAME
field.
|
MAX-SV-LEN |
I4 | 1 | Length of longest SERVICE value in total
object list. This field is only relevant if the object-specific structure for
the object list contains the SERVICE field.
|
MAX-UID-LEN |
I4 | 1 | Length of longest USER-ID value in total
object list. This field is only relevant if the object-specific structure for
the object list contains the USER-ID field.
|
MAX-TK-LEN |
I4 | 1 | Length of longest TOKEN value in total
object list. This field is only relevant if the object-specific structure for
the object list contains the TOKEN field.
|
REQUESTTIME |
I4 | 4 | This is the time that the request was received by the Broker kernel. |
ETB-ERROR-CODE |
A8 | 5 | This is any secondary error code from the broker kernel. See Error Messages and Codes. |
ETB-ERROR-TEXT |
A40 | 5 | This is any secondary error text from the broker kernel. See Error Messages and Codes. |
MAX-PPC-LIB-LEN |
I4 | 6 | Length of longest RPC-LIB value in total
object list. This field is only relevant if the object-specific structure for
the object list contains the RPC-LIB field.
|
MAX-PPC-PGM-LEN |
I4 | 6 | Length of longest RPC-PGM value in total
object list. This field is only relevant if the object-specific structure for
the object list contains the RPC-PGM field.
|
The information services can handle many different information structures. Applications use the information request structure to specify which information structure is required. See also Examples of Selection Criteria.
The layout of the information request structure is shown in the following
table. Fields BLOCK-LENGTH
,
VERSION
, and OBJECT-TYPE
are
mandatory. All other fields are optional. Fields of type I or B are considered
"not specified" if they contain low value. Fields of type A are
considered "not specified" if they contain low value or spaces
(according to the caller's character set).
Field Name | Format | CIS Interface Version |
Opt/ Req |
Comment | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
BLOCK-LENGTH |
I4 | 1 | R | Defines the block length of the data packages returned (without
length of header.) ( RECEIVE-LENGTH field of ACI not used in order
to keep the interfaces independent.)
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VERSION |
I2 | 1 | R | Interface version. This describes the kind and amount of information wanted and enables us to extend the information in further versions of INFO services. Valid versions are 1 and above. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OBJECT-TYPE |
I2 | 1 | R | Specifies the object type for
which the information is required. If an object type is specified without
additional selection criteria, a list of all active objects of that type is
returned in accordance with the information service being addressed (INFO or
USER-INFO ). Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
USER-ID |
A32 | 1 | O | Selection criteria field. This is the user ID of the client or
server as specified in the field USER-ID of the EntireX
Broker ACI. The value of the field is used to restrict information to related
objects of a specific user.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
P-USER-ID |
B28 | 1 | O | Selection criteria field. Specifies the internal unique ID which
is used to distinguish between several users with the same user ID. This field uniquely identifies a client or server process. The value for this field must be obtained by a previous info request. This field is used as a handle, i.e. no translation is performed. Any value different from low value will be treated as selection value. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TOKEN |
A32 | 1 | O | Selection criteria field. Corresponds to the
TOKEN field of the EntireX Broker ACI. The value
restricts the information to objects of users which have specified this
TOKEN value in their Broker calls.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SERVER-CLASS |
A32 | 1 | O | Selection criteria field. Corresponds to field
SERVER-CLASS in the EntireX Broker ACI. The value of
this field is used to restrict information to objects concerning the services
registered with this class.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SERVER-NAME |
A32 | 1 | O | Selection criteria field. Corresponds to field
SERVER-NAME in the EntireX Broker ACI. The value of this
field is used to restrict information to objects concerning the services
registered with this server name.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SERVICE |
A32 | 1 | O | Selection criteria field. Corresponds to field
SERVICE in the EntireX Broker ACI. The value of this
field is used to restrict information to objects concerning the services
registered with this service name.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CONV-ID |
A16 | 1 | O | Selection criteria field. Specifies the conversation ID of a conversation. Using this field uniquely identifies a conversation. The value for this field must be obtained by a previous info request. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RESERVED |
I2 | 1 | Reserved for future use. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UOWID |
A16 | 2 | O | Selection criteria field. Specifies the unit of work ID. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UOWSTATUS |
I1 | 2 | O | Selection criteria field. Specifies the unit of work status search criteria:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
USERSTATUS |
A32 | 2 | O | Selection field. Specifies the user status selection value. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RECVUID |
A32 | 2 | O | Selection field. Specifies the unit-of-work receiver's user ID. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RECVTOKEN |
A32 | 2 | O | Selection field. Specifies the unit-of-work receiver's token ID. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RECVSERVER |
A32 | 2 | O | Selection field. Specifies the unit-of-work receiver's server name. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RECVSERVICE |
A32 | 2 | O | Selection field. Specifies the unit-of-work receiver's service name. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RECVCLASS |
A32 | 2 | O | Selection field. Specifies the unit-of-work receiver's class name. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CONVERSATION-TYPE |
I2 | 5 | O | Selection field. Specifies the conversation type:
|
Abbreviation | Long Form / Description |
---|---|
Y | The field is specified. |
I | The field is ignored. |
N | The field is not specified; information should not be restricted by its value. |
Abbreviation | Long Form / Description |
---|---|
UID |
USER-ID |
RECV-UID |
RECEIVER USER-ID |
PUID |
P-USER-ID |
TK |
TOKEN |
RECV-TK |
RECEIVER TOKEN |
SC |
SERVER-CLASS |
RECV-SC |
RECEIVER SERVER-CLASS |
SN |
SERVER-NAME |
RECV-SN |
RECEIVER SERVER-NAME |
SV |
SERVICE |
RECV-SV |
RECEIVER SERVICE |
CID |
CONV-ID |
UOWID |
UNIT OF WORK ID |
UWSTAT |
UNIT OF WORK STATUS |
USTAT |
USER STATUS |
Selection | PUID | UID | TK | SC | SN | SV | CID |
---|---|---|---|---|---|---|---|
Client (1) | Y | I | I | I | I | I | I |
Client (2) | N | Y | Y | I | I | I | I |
Clients with UID | N | Y | N | I | I | I | I |
Clients with TK | N | N | Y | I | I | I | I |
all clients | N | N | N | I | I | I | I |
Selection | PUID | UID | TK | SC | SN | SV | CID |
---|---|---|---|---|---|---|---|
Server (1) | Y | I | I | I | I | I | I |
Server (2) | N | Y | Y | I | I | I | I |
Servers with UID | N | Y | N | I | I | I | I |
Servers with TK | N | N | Y | I | I | I | I |
Servers offering service | N | N | N | Y | Y | Y | I |
All Servers | N | N | N | N | N | N | I |
Selection | PUID | UID | TK | SC | SN | SV | CID |
---|---|---|---|---|---|---|---|
Services offered by this server (1) | Y | I | I | I | I | I | I |
Services offered by this server (2) | N | Y | Y | I | I | I | I |
Services with this SC/SN/SV | N | N | N | Y | Y | Y | I |
Services with this SC/SN | N | N | N | Y | Y | N | I |
Services with this SC/SV | N | N | N | Y | N | Y | I |
Services with this SC | N | N | N | Y | N | N | I |
Services with this SN/SV | N | N | N | N | Y | Y | I |
Services with this SN | N | N | N | N | Y | N | I |
Services with this SV | N | N | N | N | N | Y | I |
All services | N | N | N | N | N | N | I |
Selection | PUID | UID | TK | SC | SN | SV | CID |
---|---|---|---|---|---|---|---|
Conversations of this client/server (1) | Y | I | I | I | I | I | I |
Conversations of this client/server (2) | N | Y | Y | I | I | I | I |
Conversations of this service | N | N | N | Y | Y | Y | I |
The conversation with CID | N | N | N | N | N | N | Y |
All Conversations | N | N | N | N | N | N | N |
Selection | UOWID | UID | TK | SC | SN | SV | CID |
---|---|---|---|---|---|---|---|
The unit of work | Y | I | I | I | I | I | I |
All units of work for the conversation | N | I | I | I | I | I | Y |
UOWs with client UID | N | Y | N | N | N | N | N |
UOWs with clients having TK | N | N | Y | N | N | N | N |
UOWs with the client SC | N | N | N | Y | N | N | N |
UOWs with the client SN | N | N | N | N | Y | N | N |
UOWs with the client SV | N | N | N | N | N | Y | N |
UOWs with the client SC/SN | N | N | N | Y | Y | N | N |
UOWs with the client SC/SV | N | N | N | Y | N | Y | N |
UOWs with the client SC/SN/SV | N | N | N | Y | Y | Y | N |
UOWs with the client SN/SV | N | N | N | N | Y | Y | N |
All UOWs | N | N | N | N | N | N | N |
UOWs with user status | I | I | I | I | I | N | Y |
UOWs with UOW status | I | I | I | I | I | Y | N |
UOWs with server ID | Y | N | N | N | N | N | N |
UOWs with server having TK | N | N | Y | N | N | N | N |
UOWs with the server SC | N | N | N | Y | N | N | N |
UOWs with the server SN | N | N | N | N | Y | N | N |
UOWs with the server SV | N | N | N | N | N | Y | N |
UOWs with the server SC/SN | N | N | N | Y | Y | N | N |
UOWs with the server SC/SV | N | N | N | Y | N | Y | N |
UOWs with the server SC/SN/SV | N | N | N | Y | Y | Y | N |
UOWs with the server SN/SV | N | N | N | N | Y | Y | N |
All UOWs | N | N | N | N | N | N | N |
(1) | if participant is not using TK (token) for authentication |
(2) | if participant is using TK (token) for authentication |
The information reply structures are defined and described in the delivered source code. The structures are available for programming languages Assembler, C, Natural and COBOL.
Field Name | Format | CIS Interface Version |
Description / Action | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
PLATFORM |
A8 | 1 | Platform dependent. | ||||||||
RUNTIME |
I4 | 1 | Time since Broker started, in seconds. Computed from current time - Broker start time. | ||||||||
NUM-WORKER-ACT |
I4 | 1 | Number of active workers. | ||||||||
NUM-LONG |
I4 | 1 | Number of long buffers defined (see
NUM-LONG-BUFFER ).
|
||||||||
LONG-ACT |
I4 | 1 | Number of long buffers active (in use). | ||||||||
LONG-HIGH |
I4 | 1 | Highest number of long buffers active since Broker started. | ||||||||
NUM-SHORT |
I4 | 1 | Number of short buffers defined (see
NUM-SHORT-BUFFER ).
|
||||||||
SHORT-ACT |
I4 | 1 | Number of short buffers active. | ||||||||
SHORT-HIGH |
I4 | 1 | Highest number of short buffers active since Broker started. | ||||||||
LONG-SIZE |
I4 | 1 | Size of long buffer entry. | ||||||||
SHORT-SIZE |
I4 | 1 | Size of short buffer entry. | ||||||||
NUM-SERVICE |
I4 | 1 | Number of services defined (see
NUM-SERVICE ).
|
||||||||
SERVICE-ACT |
I4 | 1 | Number of services active. | ||||||||
NUM-SERVER |
I4 | 1 | Number of servers defined (see
NUM-SERVER ).
|
||||||||
SERVER-ACT |
I4 | 1 | Number of servers active. This counter also includes the active Attach Server instances. | ||||||||
SERVER-HIGH |
I4 | 1 | Highest number of servers active since Broker started. | ||||||||
NUM-CLIENT |
I4 | 1 | Number of clients defined (see
NUM-CLIENT ).
|
||||||||
CLIENT-ACT |
I4 | 1 | Number of clients active. | ||||||||
CLIENT-HIGH |
I4 | 1 | Highest number of clients active since Broker started. | ||||||||
NUM-CONV |
I4 | 1 | Number of conversations defined (see
NUM-CONVERSATION ).
|
||||||||
CONV-HIGH |
I4 | 1 | Highest number of conversations active since Broker started. | ||||||||
TRACE-LEVEL |
I2 | 1 | Actual Trace Level value. | ||||||||
UNUSED1 |
I2 | 1 | Unused. | ||||||||
LMAXUOWS |
I4 | 2 | Maximum number of active UOWs. | ||||||||
LMAXUOWMSG |
I4 | 2 | Maximum number of messages in a UOW. | ||||||||
LUWTIME |
I4 | 2 | Maximum UOW lifetime | ||||||||
LMAXDELCNT |
I4 | 2 | Currently not in use. (Count is always zero.) | ||||||||
LMAXMSGSIZE |
I4 | 2 | Maximum size of a message | ||||||||
LTOTALUOWS |
I4 | 2 | Number of UOWs. | ||||||||
CSTORE |
I1 | 2 | Store attribute for all UOWs:
|
||||||||
CPSTORE |
I1 | 2 | Startup value for persistent store:
|
||||||||
CUWSTATP |
I1 | 2 | UOW status lifetime multiplier (0-255) | ||||||||
CDEFERRED |
I1 | 2 | Default status attribute for all UOWs:
|
||||||||
CACCOUNTING |
A3 | 3 |
|
||||||||
CAUTHDEFAULT |
I1 | 3 | Authorization Default:
|
||||||||
LSSLPORT |
I4 | 3 | Port number being used for SSL transport (UNIX and Windows only). | ||||||||
NEW-UOW-MESSAGES |
I1 | 3 | New UOW messages:
|
||||||||
UNUSED2 |
I1 | 3 | Unused. | ||||||||
CPLATNAME |
A32 | 3 | Full platform name where Broker is running | ||||||||
CPSTORETYPE |
A8 | 3 | Persistent store type. It will be one of the following values:
|
||||||||
HIGHEST-API-VERSION |
I1 | 4 | For example: 0x06. | ||||||||
HIGHEST-CIS-VERSION |
I1 | 4 | For example: 0x06. | ||||||||
PSTORE-CONNECTED |
I1 | 4 |
|
||||||||
ATTACH-MGRS-ACT |
I4 | 4 | Number of attach servers active. | ||||||||
LUWSTAT-ADD-TIME |
I4 | 4 | Unit of work status additional lifetime. | ||||||||
PRODUCT-VERSION |
A16 | 4 | Version, release, service pack, and patch level, e.g. 8.0.1.00. | ||||||||
LICENSE-EXPIRATION-DATE |
A10 | 5 | License expiration date. | ||||||||
SECURITY-TYPE |
I1 | 5 | Security type:
|
||||||||
ACCOUNTING-ENABLED |
I1 | 5 |
|
||||||||
NUM-FREE-CCB |
I4 | 5 | Number of free CCB entries (conversation control block). | ||||||||
NUM-FREE-PCB |
I4 | 5 | Number of free PCB entries(participant control block). | ||||||||
NUM-FREE-PCBEXT |
I4 | 5 | Number of free PCBEXT entries (PCB extension). | ||||||||
NUM-FREE-SCB |
I4 | 5 | Number of free SCB entries (service control block). | ||||||||
NUM-FREE-SCBEXT |
I4 | 5 | Number of free SCBEXT entries (SCB extension). | ||||||||
NUM-FREE-TCBEXT |
I4 | 5 | Number of free TCBEXT entries (TCP extension). | ||||||||
NUM-FREE-TOQ |
I4 | 5 | Number of free TOQ entries (timeout queue). | ||||||||
NUM-FREE-UWCB |
I4 | 5 | Number of free UWCB entries (UOW control block). | ||||||||
NUM-COM-BUFFER |
I4 | 5 | Number of communication buffers. | ||||||||
NUM-COM-SLOT |
I4 | 5 | Number of communication buffer slots. | ||||||||
NUM-COM-SLOT-FREE |
I4 | 5 | Number of communication buffer slots free. | ||||||||
NUM-CMDLOG-FILTER |
I4 | 5 | Number of CMDLOG filters.
|
||||||||
NUM-CMDLOG-FILTER-ACTIVE |
I4 | 5 | Number of CMDLOG filters
active.
|
||||||||
CMDLOG |
I1 | 5 | Reflects status of Broker attribute
CMDLOG :
|
||||||||
CMDLOG-ENABLED |
I1 | 5 | Reflects result of commands
DISABLE-CMDLOG and
ENABLE-CMDLOG :
|
||||||||
NOTUSED3 |
A2 | 5 | Alignment. | ||||||||
ATTRIBUTE-FILE-NAME |
A256 | 5 | Attribute file name. | ||||||||
LOG-FILE-NAME |
A256 | 5 | Name of trace log file. | ||||||||
LOG-FILE-SIZE |
I4 | 5 | Size of trace log file. | ||||||||
LICENSE-FILE-NAME |
A256 | 5 | License file name. | ||||||||
CMDLOG-FILE-SIZE |
I4 | 5 | Max. size of CMDLOG file.
|
||||||||
OPEN-CMDLOG-FILE-NAME |
A256 | 5 | Name of open CMDLOG file.
|
||||||||
OPEN-CMDLOG-FILE-SIZE |
I4 | 5 | Size of CMDLOG file.
|
||||||||
CLOSED-CMDLOG-FILE-NAME |
A256 | 5 | Name of closed CMDLOG
file.
|
||||||||
CLOSED-CMDLOG-FILE-SIZE |
I4 | 5 | Size of closed CMDLOG
file.
|
||||||||
RESERVED |
I4 | 5 | Reserved for future use. | ||||||||
ACCOUNTING-FILE-NAME |
A256 | 5 | Name of accounting output file. | ||||||||
ACCOUNTING-FILE-SIZE |
I4 | 5 | Size of accounting output file. | ||||||||
CONTROL-INTERVAL |
I4 | 5 | Control interval in seconds. | ||||||||
MAX-TAKEOVER-ATTEMPTS |
I4 | 5 | Max. number of takeover attempts. | ||||||||
RUN-MODE |
A16 | 5 | Broker run mode. | ||||||||
PARTNER-CLUSTER-ADDRESS |
A32 | 5 | Partner Cluster Address. | ||||||||
CMDLOG-SWITCHES-BY-SIZE |
I4 | 5 | Number of CMDLOG switches by
size.
|
||||||||
CMDLOG-SWITCHES-BY-CIS |
I4 | 5 | Number of CMDLOG switches by
CIS.
|
||||||||
CLIENT-NONACT |
I4 | 7 | Client timeout in seconds. See broker attribute
CLIENT-NONACT .
|
||||||||
NUM-WQE |
I4 | 7 | Number of work queue entries. See broker attribute
NUM-WQE .
|
||||||||
TOTAL-STORAGE-ALLOCATED |
I4 | 7 | Size of allocated storage in bytes. | ||||||||
TOTAL-STORAGE-ALLOCATED-HIGH |
I4 | 7 | Highest size of allocated storage in bytes since Broker started. | ||||||||
TOTAL-STORAGE-LIMIT |
I4 | 7 | Maximum of storage that can be allocated. See broker attribute
MAX-MEMORY .
|
||||||||
BROKER-ID |
A32 | 7 | BROKER-ID . See broker attribute
BROKER-ID .
|
||||||||
HOST-NAME |
A256 | 7 | Name of host running broker (on z/OS copied from
CVTSNAME ).
|
||||||||
SYSPLEX-NAME |
A8 | 7 | Name of SYSPLEX (copied from ECVTSPLX ).
|
||||||||
CAUTOLOGON |
I1 | 7 | Auto logon:
AUTOLOGON .
|
||||||||
CDYNAMIC-MEMORY-MANAGEMENT |
I1 | 7 | Dynamic memory management:
DYNAMIC-MEMORY-MANAGEMENT .
|
||||||||
CDYNAMIC-WORKER-MANAGEMENT |
I1 | 7 | Dynamic worker management:
DYNAMIC-WORKER-MANAGEMENT .
|
||||||||
CSERVICE-UPDATES |
I1 | 7 | Service updates:
SERVICE-UPDATES .
|
||||||||
CTRANSPORT-NET |
I1 | 7 | Was TRANSPORT=NET specified?
TRANSPORT=NET .
|
||||||||
CTRANSPORT-SSL |
I1 | 7 | Was TRANSPORT=SSL specified?
TRANSPORT=SSL .
|
||||||||
CTRANSPORT-TCP |
I1 | 7 | Was TRANSPORT=TCP specified?
TRANSPORT=TCP .
|
||||||||
NTRAP-ERROR |
I4 | 7 | Value defined for attribute
TRAP-ERROR .
|
||||||||
CPU-USED-IN-SECONDS |
I4 | 9 | Amount of CPU time in seconds used by Broker process since Broker start. | ||||||||
CPU-USED-REST-IN-MICROSECONDS |
I4 | 9 | Additional CPU time in microseconds used by Broker process since Broker start. (CPU time is provided by two fields because total value including microseconds may exceed one 4-byte integer.) | ||||||||
CPU-USED-PERCENTAGE |
I4 | 9 | CPU time consumed by Broker process in relation to total CPU workload in percent and normalized by the number of CPUs. It never exceeds 100%. | ||||||||
APPLICATION-MONITORING |
I1 | 11 | Application Monitoring.
See broker attribute |
||||||||
COLLECTOR-BROKER-ID |
A64 | 11 | Collector Broker ID. See Application Monitoring attribute COLLECTOR-BROKER-ID .
|
||||||||
UNUSED3 |
A3 | 11 | Alignment. |
Field Name | Format | CIS Interface Version |
Description / Action | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
USER-ID |
A32 | 1 | Corresponds to USER-ID in the ACI. The
maximum length of this field is determined by field
MAX-UID-LEN in the header. See
Common Header Structure for Response Data.
|
||||||||||
P-USER-ID |
B28 | 1 | Specifies the physical internal unique ID which is used to
distinguish between several users with the same user ID. This field is used as
a handle, i.e. no translation is performed. With CIS commands
SHUTDOWN PARTICIPANT and SHUTDOWN
SERVER , field SEQNO is
provided as unique criterion.
|
||||||||||
P-USER-ID-CHAR |
A28 | 1 | No longer used. | ||||||||||
TOKEN |
A32 | 1 | Corresponds to TOKEN in the ACI. The
maximum length of this field is determined by MAX-TK-LEN
in the header. See Common Header Structure for Response Data.
|
||||||||||
CHAR-SET |
I2 | 1 | Character set of user's platform:
|
||||||||||
ENDIAN |
I2 | 1 | Endian type of user's platform:
|
||||||||||
STATUS |
I2 | 1 | Status of user:
|
||||||||||
UNUSED1 |
I2 | 1 | Unused. | ||||||||||
WAIT-CONV-TYPE |
A16 | 1 | Only valid if user is waiting. Indicates what kind of
conversation user is waiting for:
|
||||||||||
WAIT-SERVER-CLASS |
A32 | 1 | When waiting for ANY , NEW or OLD , the class name of the service
to wait for is returned.
|
||||||||||
WAIT-SERVER-NAME |
A32 | 1 | When waiting for ANY , NEW or OLD , the server name of the service
to wait for is returned.
|
||||||||||
WAIT-SERVICE |
A32 | 1 | When waiting for ANY , NEW or OLD , the name of the service to
wait for is returned.
|
||||||||||
CONV-ACT |
I4 | 1 | Number of active conversations of this user. | ||||||||||
SERVICE-ACT |
I4 | 1 | Number of services active (offered) by this server. This information is available for server only. | ||||||||||
LAST-ACTIVE |
I4 | 1 | Elapsed time since the last activity of the user. | ||||||||||
NONACT |
I4 | 1 | Non-activity time-out value. | ||||||||||
WAIT-NEW |
I4 | 1 | Accumulated time a server waited for new conversations. (Receive
with CONVID=NEW or CONVID=ANY ). A
high value indicates that server has capacity.
|
||||||||||
NUM-WAIT-NEW |
I4 | 1 | Number of times a server had to wait for new conversations. | ||||||||||
WAIT-OLD |
I4 | 1 | Accumulated time a server or client waited for messages of
existing conversations. (Receive with CONVID=cid or
CONVID=OLD .) A high value for a server indicates that
server had to wait for the clients. A high value for a client indicates that
the server's response was delayed.
|
||||||||||
NUM-WAIT-OLD |
I4 | 1 | Number of times a server or client had to wait for messages of existing conversations. | ||||||||||
SUM-CONV |
I4 | 1 | Sum of conversations (including non-conversational requests) for the user since start of User. | ||||||||||
LTOTALUOWS |
I4 | 2 | Number of UOWs. | ||||||||||
IP-ADDRESS |
A16 | 4 | IPv4 address of client/server. | ||||||||||
HOST-NAME |
A256 | 4 | Host name of client/server. | ||||||||||
RECV-OPTION |
I1 | 4 | Receive option. | ||||||||||
ATTACH-MGR |
I1 | 4 | Attach manager indicator. | ||||||||||
UNUSED2 |
I2 | 4 | Unused. | ||||||||||
RESERVED_ETBINFO_V73_1 |
A32 | 5 | Reserved for future use. | ||||||||||
APPLICATION-NAME |
A64 | 5 |
The name of the executable that called the broker. If the program that issued the broker call is running on a mainframe system, the eight-byte job name is used as application name. If the job name is shorter than eight bytes, it is padded with underscore characters. If the z/OS program issuing the broker call is running in a TP monitor (except IDMS/DC), a dash sign is set as ninth byte. The following eight bytes from position 10-17 contain monitor-dependent data:
Padding blanks in bytes 10-17 are replaced by underscore characters. |
||||||||||
APPLICATION-TYPE |
A8 | 5 | Application type. This field is used internally. It can be set by other Software AG products, which pass this value to the Broker stub via an unpublished control block. If no value is set, the respective operating system is displayed here. | ||||||||||
RESERVED_ETBINFO_V73_3 |
A32 | 5 | Reserved for future use. | ||||||||||
COUNT-AUTHORIZATION-SUCCEEDED |
I4 | 5 | Counter AUTHORIZ succeeded.
|
||||||||||
COUNT-AUTHORIZATION-FAILED |
I4 | 5 | Counter AUTHORIZ failed.
|
||||||||||
CREATE-TIME |
I4 | 5 | Creation time of the participant. Time as time_t value (number of seconds since the epoch (00:00:00 UTC, January 1, 1970)).
|
||||||||||
RPC-LIBRARY-NAME |
A128 | 6 | Name of the RPC library of the current user request. If the user is inactive at the time of the request and has not issued a request to be processed by the Broker, no RPC information is displayed. | ||||||||||
RPC-PROGRAM-NAME |
A128 | 6 | Name of the RPC program of the current user request. If the user is inactive at the time of the request and has not issued a request to be processed by the Broker, no RPC information is displayed. | ||||||||||
SEQNO |
I4 | 7 | Unique sequence number of client/server. Can be used with CIS
command SHUTDOWN .
|
||||||||||
APPLICATION-VERSION |
A16 | 7 | Application version. This field is used internally. It can be set by other Software AG products, which pass this value to the Broker stub via an unpublished control block. The value is the version of the program that calls the Broker stub. | ||||||||||
IPV6-ADDRESS |
A46 | 8 | IPv6 address corresponding to attribute HOST in DEFAULTS=SSL|TCP section of Broker attribute file.
|
||||||||||
NOTUSED8 |
A2 | 8 | Alignment. | ||||||||||
ARF |
I1 | 10 |
|
||||||||||
SCM |
I1 | 10 | If ARF=1 :
|
||||||||||
PREFETCH |
I1 | 10 | If ARF=1 and SCM=1 :
|
||||||||||
ROAMING |
I1 | 10 |
|
||||||||||
RPC |
A5 | 10 |
|
||||||||||
NOTUSED10 |
A3 | 10 | Alignment. |
Field Name | Format | CIS Interface Version |
Description / Action | ||||
---|---|---|---|---|---|---|---|
UID |
A32 | 5 | User ID. | ||||
SERVER-CLASS |
A32 | 5 | Class. | ||||
SERVER |
A32 | 5 | Server. | ||||
SERVICE |
A32 | 5 | Service. | ||||
SETTER-UID |
A32 | 5 | User ID of filter setter. | ||||
ENABLED |
I1 | 5 |
|
Field Name | Format | CIS Interface Version |
Description / Action | ||||
---|---|---|---|---|---|---|---|
CONV-ID |
A16 | 1 | Unique identification of conversation. | ||||
SERVER-USER-ID |
A32 | 1 | User ID of server - corresponds to
USER-ID in the ACI. The maximum length of this field is
determined by field MAX-UID-LEN in the header. See
Common Header Structure for Response Data.
|
||||
SERVER-P-USER-ID |
B28 | 1 | Specifies the physical internal unique ID which is used to distinguish between several users with the same user ID. This field is used as a handle i.e. no translation is performed. | ||||
SERVER-P-USER-ID-CHAR |
A28 | 1 | No longer used. | ||||
SERVER-TOKEN |
A32 | 1 | Partner's additional identification - corresponds to
TOKEN in the ACI. The maximum length of this field is
determined by MAX-TK-LEN in the header. See
Common Header Structure for Response Data.
|
||||
CLIENT-USER-ID |
A32 | 1 | Owners name. Corresponds to USER-ID in
the ACI.
|
||||
CLIENT-P-USER-ID |
B28 | 1 | Specifies the physical internal unique ID which is used to distinguish between several users with the same user ID. This field is used as a handle i.e. no translation is performed. | ||||
CLIENT-P-USER-ID-CHAR |
A28 | 1 | No longer used. | ||||
CLIENT-TOKEN |
A32 | 1 | Owner's additional identification - corresponds to
TOKEN in the ACI.
|
||||
SERVER-CLASS |
A32 | 1 | Server class of Service of Conversation. | ||||
SERVER-NAME |
A32 | 1 | Server name of Service of Conversation. The maximum length of
SERVER-CLASS , SERVER-NAME and
SERVICE is determined by fields
MAX-SC-LEN , MAX-SN-LEN and
MAX-SV-LEN in the header. See
Common Header Structure for Response Data.
|
||||
SERVICE |
A32 | 1 | Service name of Service of Conversation. | ||||
CONV-TIME-OUT |
I4 | 1 | Conversation timeout (corresponds to
CONV-NONACT of the service in the attribute
file)
|
||||
LAST-ACTIVE |
I4 | 1 | Elapsed time since the last activity for this conversation. | ||||
TYPE |
I2 | 1 | Type of conversation:
|
||||
UNUSED1 |
I2 | 2 | Unused. | ||||
LTOTALUOWS |
I4 | 2 | Number of UOWs. | ||||
CLIENT-RPC-LIBRARY-NAME |
A128 | 6 | Name of the RPC library that was provided by the RPC client at
the start of the conversation, that is, the first SEND that contains both RPC
library and RPC program is stored in the conversation.
|
||||
CLIENT-RPC-PROGRAM-NAME |
A128 | 6 | Name of the RPC program that was provided by the RPC client at
the start of the conversation, that is, the first SEND that contains both RPC
library and RPC program is stored in the conversation.
|
||||
SERVER-RPC-LIBRARY-NAME |
A128 | 6 | Name of the RPC library that was provided by the RPC server with
the first response to clients request, that is, the first SEND that contains
both RPC library and RPC program is stored in the conversation.
|
||||
SERVER-RPC-PROGRAM-NAME |
A128 | 6 | Name of the RPC program that was provided by the RPC server with
the first response to clients request, that is, the first SEND that contains
both RPC library and RPC program is stored in the conversation.
|
||||
ARF |
I1 | 10 |
|
||||
SCM |
I1 | 10 | If ARF=1 :
|
||||
PREFETCH |
I1 | 10 | If ARF=1 and SCM=1 :
|
||||
ROAMING |
I1 | 10 |
|
Field Name | Format | CIS Interface Version |
Description / Action | ||||
---|---|---|---|---|---|---|---|
CLONE-INDEX |
I4 | 5 | Clone index. | ||||
STATUS |
I4 | 5 | Status of communicator. Possible values defined as
ETB_INFO_COM_STATUS_ .
|
||||
DBID |
I2 | 5 | DBID. | ||||
SVC-NUMBER |
I2 | 5 | Adabas SVC number. | ||||
IUBL |
I4 | 5 | Maximum buffer length. | ||||
TIME |
I4 | 5 | MPM-12 timeout. | ||||
NABS |
I4 | 5 | Number of attached buffers. | ||||
CQES |
I4 | 5 | Number of CQEs. | ||||
FORCE |
I1 | 5 | DBID table entry overwrite. | ||||
LOCAL |
I1 | 5 |
|
||||
NOTUSED0 |
A2 | 5 | Alignment. |
Field Name | Format | CIS Interface Version |
Description / Action |
---|---|---|---|
TOTAL-NUM-POOLS |
I4 | 7 | Number of pools currently allocated. |
TOTAL-STORAGE-ALLOCATED |
I4 | 7 | Size of allocated storage in bytes. |
ACCOUNTING-NUM-POOLS |
I4 | 7 | ACCOUNTING : Number of pools.
|
ACCOUNTING-SIZE-ALL-POOLS |
I4 | 7 | ACCOUNTING : Size of all pools in bytes.
|
ACCOUNTING-SIZE-ONE-POOL |
I4 | 7 | ACCOUNTING : Size of one pool in bytes.
|
BLACKLIST-NUM-POOLS |
I4 | 7 | BLACKLIST : Number of pools.
|
BLACKLIST-SIZE-ALL-POOLS |
I4 | 7 | BLACKLIST : Size of all pools in bytes.
|
BLACKLIST-SIZE-ONE-POOL |
I4 | 7 | BLACKLIST : Size of one pool in bytes.
|
BROKER-TO-BROKER-NUM-POOLS |
I4 | 7 | BROKER-TO-BROKER : Number of pools.
|
BROKER-TO-BROKER-SIZE-ALL-POOLS |
I4 | 7 | BROKER-TO-BROKER : Size of all pools in bytes.
|
BROKER-TO-BROKER-SIZE-ONE-POOL |
I4 | 7 | BROKER-TO-BROKER : Size of one pool in bytes.
|
COM-BUFFER-NUM-POOLS |
I4 | 7 | COM-BUFFER : Number of pools.
|
COM-BUFFER-SIZE-ALL-POOLS |
I4 | 7 | COM-BUFFER : Size of all pools in bytes.
|
COM-BUFFER-SIZE-ONE-POOL |
I4 | 7 | COM-BUFFER : Size of one pool in bytes.
|
CMDLOG-NUM-POOLS |
I4 | 7 | CMDLOG : Number of pools.
|
CMDLOG-SIZE-ALL-POOLS |
I4 | 7 | CMDLOG : Size of all pools in bytes.
|
CMDLOG-SIZE-ONE-POOL |
I4 | 7 | CMDLOG : Size of one pool in bytes.
|
CONNECTION-NUM-POOLS |
I4 | 7 | CONNECTION : Number of pools.
|
CONNECTION-SIZE-ALL-POOLS |
I4 | 7 | CONNECTION : Size of all pools in bytes.
|
CONNECTION-SIZE-ONE-POOL |
I4 | 7 | CONNECTION : Size of one pool in bytes.
|
CONVERSATION-NUM-POOLS |
I4 | 7 | CONVERSATION : Number of pools.
|
CONVERSATION-SIZE-ALL-POOLS |
I4 | 7 | CONVERSATION : Size of all pools in bytes.
|
CONVERSATION-SIZE-ONE-POOL |
I4 | 7 | CONVERSATION : Size of one pool in bytes.
|
HEAP-NUM-POOLS |
I4 | 7 | HEAP : Number of pools.
|
HEAP-SIZE-ALL-POOLS |
I4 | 7 | HEAP : Size of all pools in bytes.
|
HEAP-SIZE-ONE-POOL |
I4 | 7 | HEAP : Size of one pool in bytes.
|
MSG-BUFFER-LONG-NUM-POOLS |
I4 | 7 | MSG-BUFFER-LONG : Number of pools.
|
MSG-BUFFER-LONG-SIZE-ALL-POOLS |
I4 | 7 | MSG-BUFFER-LONG : Size of all pools in bytes.
|
MSG-BUFFER-LONG-SIZE-ONE-POOL |
I4 | 7 | MSG-BUFFER-LONG : Size of one pool in bytes.
|
MSG-BUFFER-SHORT-NUM-POOLS |
I4 | 7 | MSG-BUFFER-SHORT : Number of pools.
|
MSG-BUFFER-SHORT-SIZE-ALL-POOLS |
I4 | 7 | MSG-BUFFER-SHORT : Size of all pools in bytes.
|
MSG-BUFFER-SHORT-SIZE-ONE-POOL |
I4 | 7 | MSG-BUFFER-SHORT : Size of one pool in bytes.
|
PARTICIPANT-NUM-POOLS |
I4 | 7 | PARTICIPANT : Number of pools.
|
PARTICIPANT-SIZE-ALL-POOLS |
I4 | 7 | PARTICIPANT : Size of all pools in bytes.
|
PARTICIPANT-SIZE-ONE-POOL |
I4 | 7 | PARTICIPANT : Size of one pool in bytes.
|
PARTICIPANT-EXT-NUM-POOLS |
I4 | 7 | PARTICIPANT-EXT : Number of pools.
|
PARTICIPANT-EXT-SIZE-ALL-POOLS |
I4 | 7 | PARTICIPANT-EXT : Size of all pools in bytes.
|
PARTICIPANT-EXT-SIZE-ONE-POOL |
I4 | 7 | PARTICIPANT-EXT : Size of one pool in bytes.
|
PROXY-QUEUE-NUM-POOLS |
I4 | 7 | PROXY-QUEUE : Number of pools.
|
PROXY-QUEUE-SIZE-ALL-POOLS |
I4 | 7 | PROXY-QUEUE : Size of all pools in bytes.
|
PROXY-QUEUE-SIZE-ONE-POOL |
I4 | 7 | PROXY-QUEUE : Size of one pool in bytes.
|
SERVICE-ATTRIBUTES-NUM-POOLS |
I4 | 7 | SERVICE-ATTRIBUTES : Number of pools.
|
SERVICE-ATTRIBUTES-SIZE-ALL-POOLS |
I4 | 7 | SERVICE-ATTRIBUTES : Size of all pools in bytes.
|
SERVICE-ATTRIBUTES-SIZE-ONE-POOL |
I4 | 7 | SERVICE-ATTRIBUTES : Size of one pool in bytes.
|
SERVICE-NUM-POOLS |
I4 | 7 | SERVICE : Number of pools.
|
SERVICE-SIZE-ALL-POOLS |
I4 | 7 | SERVICE : Size of all pools in bytes.
|
SERVICE-SIZE-ONE-POOL |
I4 | 7 | SERVICE : Size of one pool in bytes.
|
SERVICE-EXT-NUM-POOLS |
I4 | 7 | SERVICE-EXT : Number of pools.
|
SERVICE-EXT-SIZE-ALL-POOLS |
I4 | 7 | SERVICE-EXT : Size of all pools in bytes.
|
SERVICE-EXT-SIZE-ONE-POOL |
I4 | 7 | SERVICE-EXT : Size of one pool in bytes.
|
TIMEOUT-QUEUE-NUM-POOLS |
I4 | 7 | TIMEOUT-QUEUE : Number of pools.
|
TIMEOUT-QUEUE-SIZE-ALL-POOLS |
I4 | 7 | TIMEOUT-QUEUE : Size of all pools in bytes.
|
TIMEOUT-QUEUE-SIZE-ONE-POOL |
I4 | 7 | TIMEOUT-QUEUE : Size of one pool in bytes.
|
TRANSLATION-NUM-POOLS |
I4 | 7 | TRANSLATION : Number of pools.
|
TRANSLATION-SIZE-ALL-POOLS |
I4 | 7 | TRANSLATION : Size of all pools in bytes.
|
TRANSLATION-SIZE-ONE-POOL |
I4 | 7 | TRANSLATION : Size of one pool in bytes.
|
UOW-NUM-POOLS |
I4 | 7 | UOW : Number of pools.
|
UOW-SIZE-ALL-POOLS |
I4 | 7 | UOW : Size of all pools in bytes.
|
UOW-SIZE-ONE-POOL |
I4 | 7 | UOW : Size of one pool in bytes.
|
WORK-QUEUE-NUM-POOLS |
I4 | 7 | WORK-QUEUE : Number of pools.
|
WORK-QUEUE-SIZE-ALL-POOLS |
I4 | 7 | WORK-QUEUE : Size of all pools in bytes.
|
WORK-QUEUE-SIZE-ONE-POOL |
I4 | 7 | WORK-QUEUE : Size of one pool in bytes.
|
Information about individual UOWs, or groups of UOWs, can be obtained through information services.
Field Name | Format | CIS Interface Version |
Description / Action | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
UOWID |
A16 | 2 | Unit of work ID. | ||||||||||||||||
CONVID |
A16 | 2 | Conversation ID. | ||||||||||||||||
SENDERUID |
A32 | 2 | Sender user ID. | ||||||||||||||||
SENDERTOKEN |
A32 | 2 | Sender user token | ||||||||||||||||
SENDERSERVER |
A32 | 2 | Sender server name | ||||||||||||||||
SENDERCLASS |
A32 | 2 | Sender server class | ||||||||||||||||
SENDERSERVICE |
A32 | 2 | Sender service name | ||||||||||||||||
RECVRUID |
A32 | 2 | Receiver user ID. | ||||||||||||||||
RECVRTOKEN |
A32 | 2 | Receiver user token | ||||||||||||||||
RECVRSERVER |
A32 | 2 | Receiver server name | ||||||||||||||||
RECVRCLASS |
A32 | 2 | Receiver server class | ||||||||||||||||
RECVRSERVICE |
A32 | 2 | Receiver service name | ||||||||||||||||
USERSTATUS |
A32 | 2 | User status | ||||||||||||||||
UWSTATUS |
I1 | 2 | UOW status:
|
||||||||||||||||
CEOC |
I1 | 2 | End of conversation state:
|
||||||||||||||||
CSTORE |
I1 | 2 | Persistence flag:
|
||||||||||||||||
CUOWSTATSTORE |
I1 | 2 | Multiplier used to calculate lifetime for the persistent status of a UOW:
|
||||||||||||||||
LEOCREASON |
I4 | 2 | End of conversation reason code. | ||||||||||||||||
LATTEMPTCOUNT |
I4 | 2 | Attempted delivery count. | ||||||||||||||||
LMSQCNT |
I4 | 2 | Number of messages. | ||||||||||||||||
LMSQSIZE |
I4 | 2 | Total message size. | ||||||||||||||||
UWSTATUSLIFETIME |
A32 | 2 | Status lifetime. | ||||||||||||||||
UWCREATETIME |
A32 | 2 | Pseudo time UOW created. Broker downtimes are subtracted. | ||||||||||||||||
UWLIFETIME |
I4 | 2 | UOW lifetime. | ||||||||||||||||
ARF |
I1 | 10 |
|
||||||||||||||||
SCM |
I1 | 10 | If ARF=1 :
|
||||||||||||||||
MAX-POSTPONE-ATTEMPTS |
I4 | 10 | Number of POSTPONE-ATTEMPTS configured for the related service.
|
||||||||||||||||
REMAINING-POSTPONE-ATTEMPTS |
I4 | 10 | Remaining attempts moving the UOW to the postpone queue. | ||||||||||||||||
POSTPONE-DELAY |
I4 | 10 | POSTPONE-DELAY in number of seconds configured for the related service.
|
||||||||||||||||
TIME-BACK-TO-ACCEPTED |
A32 | 10 | Time when UOW will be taken out of the postpone queue for another processing attempt. | ||||||||||||||||
COMMIT-TIME |
A32 | 10 | Time UOW was committed. | ||||||||||||||||
CREATE-TIME |
A32 | 10 | Time UOW was created. |
Note:
Some of the fields listed in this table are represented by blanks or
zeros under Windows. Such fields will not be displayed under Windows because of
this limitation.
Field Name | Format | CIS Interface Version |
Description / Action |
---|---|---|---|
ADA-INFO-VERS |
I4 | 3 | Adabas persistent store information services version. |
ADA-DBID |
I4 | 3 | Adabas database ID (DBID) where the store is located. |
ADA-FNR |
I4 | 3 | Adabas file number of the store (FNR). |
ADA-FNAME |
A16 | 3 | Adabas file name of the store. |
ADA-FORMAT-TOD |
A16 | 3 | TOD of persistent store last format in YYYMMDDHHMMSST. |
ADA-FORMAT-VERS |
I4 | 3 | Persistent store format version. |
ADA-START-CNT |
I4 | 3 | Number of times the persistent store has been opened. |
ADA-START-TOD |
A16 | 3 | TOD of persistent store last open in YYYMMDDHHMMSST. |
ADA-ATTLEN |
I4 | 3 | Length of attribute data. |
ADA-OID-LEN |
I4 | 3 | Length of object identifier. |
ADA-OID-OFF |
I4 | 3 | Offset of object identifier. |
ADA-ATT-CNT |
I4 | 3 | Number of attributes in the store. |
ADA-OID-CNT |
I4 | 3 | Number of object identifiers in the store. |
ADA-UI-EXTS |
I4 | 3 | Number of upper index extents of the Adabas file used by the store. |
ADA-NI-EXTS |
I4 | 3 | Number of normal index extents of the Adabas file used by the store. |
ADA-AC-EXTS |
I4 | 3 | Number of address converter extents of the Adabas file used by the store. |
ADA-DA-EXTS |
I4 | 3 | Number of data extents of the Adabas file used by the store. |
ADA-INDEX-LVLS |
I4 | 3 | Number of index levels in the Adabas file used by the store. |
ADA-UI-PCT |
I4 | 3 | Percentage of upper index that has been used by the store. |
ADA-NI-PCT |
I4 | 3 | Percentage of normal index that has been used by the store. |
ADA-AC-PCT |
I4 | 3 | Percentage of address converter that has been used by the store. |
ADA-DA-PCT |
I4 | 3 | Percentage of data area that has been used by the store. |
TRACE-LEVEL |
I2 | 5 | PSTORE trace level. |
NOTUSED0 |
I2 | 5 | Alignment. |
Field Name | Format | CIS Interface Version |
Description / Action |
---|---|---|---|
FORMAT-VERS |
I4 | 5 | Store version format. |
COLD-START-TIME |
A16 | 5 | YYYYMMDDHHMMSST cold start. |
HOT-STARTS |
I4 | 5 | Hot starts since format. |
MSG-DAT-FILE-NAME |
A256 | 5 | Message data file name. |
MSG-DAT-FILE-SIZE |
I8 | 5 | Message data file size (64-bit). |
MSG-IDX-FILE-NAME |
A256 | 5 | Message index file name. |
MSG-IDX-FILE-SIZE |
I8 | 5 | Message index file size (64-bit). |
STATUS-DAT-FILE-NAME |
A256 | 5 | Status data file name. |
STATUS-DAT-FILE-SIZE |
I8 | 5 | Status data file size (64-bit). |
STATUS-IDX-FILE-SIZE |
A256 | 5 | Status index file name. |
STATUS-IDX-FILE-SIZE |
I8 | 5 | Status index file size (64-bit). |
TRACE-LEVEL |
I2 | 5 | PSTORE trace level. |
NOTUSED0 |
I2 | 5 | Alignment. |
Information services also provide detailed information on the allocation and usage of the various storage pools that implement the z/OS-DIV persistent store. This information can be used to tune the persistent store.
Note:
Persistent store administration was simplified with EntireX version 9.7
and cell pool services are no longer used.
Cell pool information is no longer returned in the PSFDIV-OBJECT
;
all returned fields from DIV-SH-IXMODULUS
to DIV-CX-QUERY-RC
contain zeros only.
Field Name | Format | CIS Interface Version |
Description / Action |
---|---|---|---|
DIV-INFO-VERS |
I4 | 2 | PSD query structure version. |
DIV-SH-NAME |
A8 | 2 | Persistent store name (DATASPACE-NAME in DIV-specific attributes).
|
DIV-SH-FORMAT-TOD |
A16 | 2 | TOD of persistent store cold start at YYYYMMDDHHMMSST. |
DIV-SH-FORMAT-VERS |
I4 | 2 | Persistent store format version (PSTORE-VERSION in Broker-specific attributes).
|
DIV-SH-HWMARK |
B4 | 2 | Highest address in the data space. |
DIV-SH-START-CNT |
I4 | 2 | Number of times the persistent store has been opened. |
DIV-SH-DS-ALET |
B4 | 2 | ALET (Access List Entry Token) for data space. |
DIV-SH-ATT-LEN |
I4 | 2 | Length of attribute data. |
DIV-SH-OID-LEN |
I4 | 2 | Length of object identifier. |
DIV-SH-OID-OFF |
I4 | 2 | Offset of object identifier. |
DIV-SH-IXMODULUS (1) |
I4 | 2 | Size of array/hash modulus. |
DIV-SH-CP-DEF-CNT (1) |
I4 | 2 | Number of cell pool definitions. |
DIV-CP-NAME (1) |
A8 | 2 | Cell pool name. |
DIV-CP-CELL-SIZE (1) |
I4 | 2 | Cell size. |
DIV-CP-CELL-TOTAL (1) |
I4 | 2 | Total number of cells. |
DIV-CP-CELL-AVAIL (1) |
I4 | 2 | Number of cells available. |
DIV-CP-EXTENT-CNT (1) |
I4 | 2 | Number of cell pool extents. |
DIV-CP-QUERY-RC (1) |
I4 | 2 | Return code from cell pool query. |
DIV-CX-STATUS (1) |
I4 | 2 | Cell pool extent status. |
DIV-CX-EXTENT-ADDR (1) |
B4 | 2 | Address of cell pool extent. |
DIV-CX-EXTENT-LEN (1) |
I4 | 2 | Length of cell pool extent. |
DIV-CX-AREA-ADDR (1) |
B4 | 2 | Address of cell area. |
DIV-CX-AREA-LEN (1) |
I4 | 2 | Length of cell area. |
DIV-CX-CELL-TOTAL (1) |
I4 | 2 | Number of cells in extent. |
DIV-CX-CELL-AVAIL (1) |
I4 | 2 | Number of cells available in extent. |
DIV-CX-QUERY-RC (1) |
I4 | 2 | Return code from cell pool extent query. |
TRACE-LEVEL |
I2 | 5 | PSTORE trace level. |
NOTUSED0 |
I2 | 5 | Alignment. |
DIV-CNTLDAT-NUM-POOLS |
I4 | 9 | Number of pools in data space.
|
DIV-CNTLDAT-BYTES-PER-SLOT |
I4 | 9 | Size of one slot in a pool.
|
DIV-CNTLDAT-ALLOC-SLOTS |
I4 | 9 | Number of allocated slots in all CONTROL-DATA pools.
|
DIV-CNTLDAT-FREE-SLOTS |
I4 | 9 | Number of free slots in all CONTROL-DATA pools.
|
DIV-CNTLDAT-USED-SLOTS |
I4 | 9 | Number of used slots in all CONTROL-DATA pools.
|
DIV-LMSGDAT-NUM-POOLS |
I4 | 9 | Number of LONG-MESSAGE-DATA pools in data space.
|
DIV-LMSGDAT-BYTES-PER-SLOT |
I4 | 9 | Size of one slot in a pool.
|
DIV-LMSGDAT-ALLOC-SLOTS |
I4 | 9 | Number of allocated slots in all LONG-MESSAGE-DATA pools.
|
DIV-LMSGDAT-FREE-SLOTS |
I4 | 9 | Number of free slots in all LONG-MESSAGE-DATA pools.
|
DIV-LMSGDAT-USED-SLOTS |
I4 | 9 | Number of used slots in all LONG-MESSAGE-DATA pools.
|
DIV-SMSGDAT-NUM-POOLS |
I4 | 9 | Number of SHORT-MESSAGE-DATA pools in data space.
|
DIV-SMSGDAT-BYTES-PER-SLOT |
I4 | 9 | Size of one slot in a SHORT-MESSAGE-DATA pool.
|
DIV-SMSGDAT-ALLOC-SLOTS |
I4 | 9 | Number of allocated slots in all SHORT-MESSAGE-DATA pools.
|
DIV-SMSGDAT-FREE-SLOTS |
I4 | 9 | Number of free slots in all SHORT-MESSAGE-DATA pools.
|
DIV-SMSGDAT-USED-SLOTS |
I4 | 9 | Number of used slots in all SHORT-MESSAGE-DATA pools.
|
DIV-UOWIDX-NUM-POOLS |
I4 | 9 | Number of UOW index pools in data space. |
DIV-UOWIDX-BYTES-PER-SLOT |
I4 | 9 | Size of one slot in a UOW index pool. |
DIV-UOWIDX-ALLOC-SLOTS |
I4 | 9 | Number of allocated slots in all UOW index pools. |
DIV-UOWIDX-FREE-SLOTS |
I4 | 9 | Number of free slots in all UOW index pools. |
DIV-UOWIDX-USED-SLOTS |
I4 | 9 | Number of used slots in all UOW index pools. |
Notes:
Field Name | Format | CIS Interface Version |
Description / Action |
---|---|---|---|
TOTAL-STORAGE-ALLOCATED |
I4 | 7 | Size of allocated storage in bytes. |
TOTAL-STORAGE-ALLOCATED-HIGH |
I4 | 7 | Highest size of allocated storage in bytes since Broker started. |
TOTAL-STORAGE-LIMIT |
I4 | 7 | Maximum of storage that can be allocated (broker attribute
MAX-MEMORY ).
|
ACCOUNTING-BUFFERS-ALLOCATED |
I4 | 7 | ACCOUNTING : Number of buffers allocated.
|
ACCOUNTING-BUFFERS-FREE |
I4 | 7 | ACCOUNTING : Number of buffers free.
|
ACCOUNTING-BUFFERS-USED |
I4 | 7 | ACCOUNTING : Number of buffers used.
|
BLACKLIST-ENTRIES-ALLOCATED |
I4 | 7 | BLACKLIST : Number of entries allocated.
|
BLACKLIST-ENTRIES-FREE |
I4 | 7 | BLACKLIST : Number of entries free.
|
BLACKLIST-ENTRIES-USED |
I4 | 7 | BLACKLIST : Number of entries used.
|
BROKER-TO-BROKER-ENTRIES-ALLOCATED |
I4 | 7 | BROKER-TO-BROKER : Number of entries allocated.
|
BROKER-TO-BROKER-ENTRIES-FREE |
I4 | 7 | BROKER-TO-BROKER : Number of entries free.
|
BROKER-TO-BROKER-ENTRIES-USED |
I4 | 7 | BROKER-TO-BROKER : Number of entries used.
|
COM-BUFFERS-ALLOCATED |
I4 | 7 | COM-BUFFER : Number of buffers allocated.
|
COM-BUFFERS-FREE |
I4 | 7 | COM-BUFFER : Number of buffers free.
|
COM-BUFFERS-USED |
I4 | 7 | COM-BUFFER : Number of buffers used.
|
CMDLOG-FILTER-ENTRIES-ALLOCATED |
I4 | 7 | CMDLOG-FILTER : Number of entries allocated.
|
CMDLOG-FILTER-ENTRIES-FREE |
I4 | 7 | CMDLOG-FILTER : Number of entries free.
|
CMDLOG-FILTER-ENTRIES-USED |
I4 | 7 | CMDLOG-FILTER : Number of entries used.
|
CONNECTION-ENTRIES-ALLOCATED |
I4 | 7 | CONNECTION : Number of entries allocated.
|
CONNECTION-ENTRIES-FREE |
I4 | 7 | CONNECTION : Number of entries free.
|
CONNECTION-ENTRIES-USED |
I4 | 7 | CONNECTION : Number of entries used.
|
CONVERSATION-ENTRIES-ALLOCATED |
I4 | 7 | CONVERSATION : Number of entries allocated.
|
CONVERSATION-ENTRIES-FREE |
I4 | 7 | CONVERSATION : Number of entries free.
|
CONVERSATION-ENTRIES-USED |
I4 | 7 | CONVERSATION : Number of entries used.
|
HEAP-BYTES-ALLOCATED |
I4 | 7 | HEAP : Number of bytes allocated.
|
HEAP-BYTES-FREE |
I4 | 7 | HEAP : Number of bytes free.
|
HEAP-BYTES-USED |
I4 | 7 | HEAP : Number of bytes used.
|
MSG-BUFFER-LONG-ALLOCATED |
I4 | 7 | MSG-BUFFER-LONG : Number of buffers allocated.
|
MSG-BUFFER-LONG-FREE |
I4 | 7 | MSG-BUFFER-LONG : Number of buffers free.
|
MSG-BUFFER-LONG-USED |
I4 | 7 | MSG-BUFFER-LONG : Number of buffers used.
|
MSG-BUFFER-SHORT-ALLOCATED |
I4 | 7 | MSG-BUFFER-SHORT : Number of buffers allocated.
|
MSG-BUFFER-SHORT-FREE |
I4 | 7 | MSG-BUFFER-SHORT : Number of buffers free.
|
MSG-BUFFER-SHORT-USED |
I4 | 7 | MSG-BUFFER-SHORT : Number of buffers used.
|
PARTICIPANT-ENTRIES-ALLOCATED |
I4 | 7 | PARTICIPANT : Number of entries allocated.
|
PARTICIPANT-ENTRIES-FREE |
I4 | 7 | PARTICIPANT : Number of entries free.
|
PARTICIPANT-ENTRIES-USED |
I4 | 7 | PARTICIPANT : Number of entries used.
|
PARTICIPANT-EXT-ENTRIES-ALLOCATED |
I4 | 7 | PARTICIPANT-EXT : Number of entries allocated.
|
PARTICIPANT-EXT-ENTRIES-FREE |
I4 | 7 | PARTICIPANT-EXT : Number of entries free.
|
PARTICIPANT-EXT-ENTRIES-USED |
I4 | 7 | PARTICIPANT-EXT : Number of entries used.
|
PROXY-QUEUE-ENTRIES-ALLOCATED |
I4 | 7 | PROXY-QUEUE : Number of entries allocated.
|
PROXY-QUEUE-ENTRIES-FREE |
I4 | 7 | PROXY-QUEUE : Number of entries free.
|
PROXY-QUEUE-ENTRIES-USED |
I4 | 7 | PROXY-QUEUE : Number of entries used.
|
SERVICE-ATTRIBUTE-ENTRIES-ALLOCATED |
I4 | 7 | SERVICE-ATTRIBUTE : Number of entries allocated.
|
SERVICE-ATTRIBUTE-ENTRIES-FREE |
I4 | 7 | SERVICE-ATTRIBUTE : Number of entries free.
|
SERVICE-ATTRIBUTE-ENTRIES-USED |
I4 | 7 | SERVICE-ATTRIBUTE : Number of entries used.
|
SERVICE-ENTRIES-ALLOCATED |
I4 | 7 | SERVICE : Number of entries allocated.
|
SERVICE-ENTRIES-FREE |
I4 | 7 | SERVICE : Number of entries free.
|
SERVICE-ENTRIES-USED |
I4 | 7 | SERVICE : Number of entries used.
|
SERVICE-EXT-ENTRIES-ALLOCATED |
I4 | 7 | SERVICE-EXT : Number of entries allocated.
|
SERVICE-EXT-ENTRIES-FREE |
I4 | 7 | SERVICE-EXT : Number of entries free.
|
SERVICE-EXT-ENTRIES-USED |
I4 | 7 | SERVICE-EXT : Number of entries used.
|
TIMEOUT-QUEUE-ENTRIES-ALLOCATED |
I4 | 7 | TIMEOUT-QUEUE : Number of entries allocated.
|
TIMEOUT-QUEUE-ENTRIES-FREE |
I4 | 7 | TIMEOUT-QUEUE : Number of entries free.
|
TIMEOUT-QUEUE-ENTRIES-USED |
I4 | 7 | TIMEOUT-QUEUE : Number of entries used.
|
TRANSLATION-ENTRIES-ALLOCATED |
I4 | 7 | TRANSLATION : Number of entries allocated.
|
TRANSLATION-ENTRIES-FREE |
I4 | 7 | TRANSLATION : Number of entries free.
|
TRANSLATION-ENTRIES-USED |
I4 | 7 | TRANSLATION : Number of entries used.
|
UOW-ENTRIES-ALLOCATED |
I4 | 7 | UOW : Number of entries allocated.
|
UOW-ENTRIES-FREE |
I4 | 7 | UOW : Number of entries free.
|
UOW-ENTRIES-USED |
I4 | 7 | UOW : Number of entries used.
|
WORK-QUEUE-ENTRIES-ALLOCATED |
I4 | 7 | WORK-QUEUE : Number of entries allocated.
|
WORK-QUEUE-ENTRIES-FREE |
I4 | 7 | WORK-QUEUE : Number of entries free.
|
WORK-QUEUE-ENTRIES-USED |
I4 | 7 | WORK-QUEUE : Number of entries used.
|
Field Name | Format | CIS Interface Version |
Description / Action |
---|---|---|---|
COUNT-AUTHENTICATION-SUCCEEDED |
I4 | 5 | Successful authentications. |
COUNT-AUTHENTICATION-FAILED |
I4 | 5 | Failed authentications. |
COUNT-AUTHORIZATION-SUCCEEDED |
I4 | 5 | Successful authorizations. |
COUNT-AUTHORIZATION-FAILED |
I4 | 5 | Failed authorizations. |
SAF-PROFILE-LENGTH |
I4 | 5 | Max profile length (CDT ) m/f.
|
TRACE-LEVEL |
I2 | 5 | Security trace level. |
SECURITY-LEVEL |
I2 | 5 | Security Level m/f. |
AUTHENTICATION-TYPE |
A8 | 5 | Authentication type. |
SAF-CLASS |
A8 | 5 | SAF profile CLASS (8) m/f.
|
SECURITY-NODE |
A8 | 5 | Security node m/f. |
INCLUDE-CLASS |
I1 | 5 | Include CLASS in prof m/f.
|
INCLUDE-NAME |
I1 | 5 | Include NAME in prof m/f.
|
INCLUDE-SERVICE |
I1 | 5 | Include SERVICE in prof m/f.
|
UNIVERSAL |
I1 | 5 | Allow undefined profile m/f. |
CHECK-IP-ADDRESS |
I1 | 5 | Check IP address m/f. |
WARN-MODE |
I1 | 5 | Run in warn mode m/f. |
IGNORE-STOKEN |
I1 | 5 | Ignore ACI STOKEN m/f.
|
TRUSTED-USER |
I1 | 5 | Trusted User ID m/f. |
PROPAGATE-TRUSTED-USER |
I1 | 5 | VerifiedId m/f. |
PASSWORD-TO-UPPER-CASE |
I1 | 5 | Convert password to uppercase m/f. |
NOTUSED0 |
A2 | 5 | Alignment. |
Field Name | Format | CIS Interface Version |
Description / Action | ||||||
---|---|---|---|---|---|---|---|---|---|
SERVER-CLASS |
A32 | 1 | Name of server class. | ||||||
SERVER-NAME |
A32 | 1 | Name of server. | ||||||
SERVICE |
A32 | 1 | Name of service. The header contains the maximum length for the
SERVER-CLASS , SERVER-NAME and SERVICE fields for all retrieved objects. See
Common Header Structure for Response Data.
|
||||||
TRANS |
A8 | 1 | Name of translation routine used. | ||||||
CONV-NONACT |
I4 | 1 | Conversation timeout (corresponds to
CONV-NONACT for the service in the attribute
file).
|
||||||
SERVER-ACT |
I4 | 1 | Number of servers active for service. This counter also includes the active Attach Server instances. You may subtract the
field ATTACH-MGRS-ACT to calculate the number of ordinary server instances.
|
||||||
CONV-ACT |
I4 | 1 | Number of conversations active for service. | ||||||
CONV-HIGH |
I4 | 1 | Highest number of conversations active for service. | ||||||
LONG-ACT |
I4 | 1 | Number of long buffers active (in use) for the service. | ||||||
LONG-HIGH |
I4 | 1 | Highest number of long buffers active (in use) for the service. | ||||||
SHORT-ACT |
I4 | 1 | Number of short buffers active (in use) for the service. | ||||||
SHORT-HIGH |
I4 | 1 | Highest number of short buffers active (in use) for the service. | ||||||
NUM-WAIT-SERVER |
I4 | 1 | Number of times a client had to wait for this service or messages from the server. | ||||||
NUM-SERV-OCC |
I4 | 1 | Number of times a client request (SEND with
CONVID=NEW or NONE ) could not be immediately assigned to
a waiting server, i.e. all servers offering this service are occupied.
|
||||||
NUM-PEND |
I4 | 1 | Number of new conversations which are currently in the queue, but not yet assigned to a server (pending). | ||||||
PEND-HIGH |
I4 | 1 | Highest number of pending conversations. | ||||||
REQ-SUM |
I4 | 1 | Accumulated number of requests (number of SEND commands with
CONVID=NEW or NONE ).
|
||||||
LMAXUOWS |
I4 | 2 | Maximum number of active UOWs | ||||||
LMAXUOWMSG |
I4 | 2 | Maximum number of messages in a UOW | ||||||
LUWTIME |
I4 | 2 | Maximum UOW lifetime | ||||||
LMAXDELCNT |
I4 | 2 | Is currently not in use (count is always zero.) | ||||||
LMAXMSGSIZE |
I4 | 2 | Maximum size of a message | ||||||
LTOTALUOWS |
I4 | 2 | Number of UOWs | ||||||
CSTORE |
I1 | 2 | Store attribute for all UOWs: 0=OFF 1=BROKER |
||||||
CUWSTATP |
I1 | 2 | UOWstatus lifetime multiplier (0-255) | ||||||
CDEFERRED |
I1 | 2 | Default status attribute for all UOWs:
|
||||||
CENCLEVEL |
I1 | 3 | Deprecated. For encrypted transport we strongly recommend using the Secure Sockets Layer/Transport Layer Security protocol. See SSL/TLS and Certificates with EntireX. | ||||||
ATTACH-MGRS-ACT |
I4 | 4 | Number of attach servers active | ||||||
LUWSTAT-ADD-TIME |
I4 | 4 | Unit of work status additional lifetime | ||||||
NUM-CONV |
I4 | 5 | Number of conversations. | ||||||
NUM-SERVER |
I4 | 5 | Number of servers. | ||||||
NUM-LONG-MSG-BUFFER |
I4 | 5 | Number of long message buffers. | ||||||
NUM-SHORT-MSG-BUFFER |
I4 | 5 | Number of short message buffers. | ||||||
CONVERSION |
A8 | 5 | Name of conversion routine. | ||||||
CONVERSION-PARMS |
A255 | 5 | Conversion parameters. | ||||||
NOTUSED1 |
A1 | 5 | Alignment. | ||||||
RESERVED |
I4 | 5 | Reserved for future use. | ||||||
ARF |
I1 | 10 |
|
||||||
SCM |
I1 | 10 | If ARF=1 :
|
||||||
PREFETCH |
I1 | 10 | If ARF=1 and SCM=1 :
|
||||||
RPC |
A5 | 10 |
|
||||||
MAX-POSTPONE-ATTEMPTS |
I4 | 10 | Number of POSTPONE-ATTEMPTS configured for this service.
|
||||||
POSTPONE-DELAY |
I4 | 10 | POSTPONE-DELAY in number of seconds configured for this service.
|
Field Name | Format | CIS Interface Version |
Description / Action |
---|---|---|---|
CLONE-INDEX |
I4 | 5 | Clone index. |
STATUS |
I4 | 5 | Status of communicator. Possible values defined as
ETB_INFO_COM_STATUS_ .
|
OPEN-CONNECTIONS |
I4 | 5 | Number of open connections. |
MAX-CONNECTIONS |
I4 | 5 | Maximum number of connections. |
PORT-NUMBER |
I4 | 5 | Port number. |
IP-ADDRESS |
A16 | 6 | IPv4 address corresponding to attribute
HOST in
DEFAULTS=SSL section of Broker attribute
file.
|
HOST-NAME |
A256 | 6 | Host name specified using attribute
HOST in
DEFAULTS=SSL section of Broker attribute
file.
|
TASK-RUNNING |
I1 | 8 | Transport task running. 0=NO, 1=YES. |
IPV6-ADDRESS |
A46 | 8 | IPV6 address corresponding to attribute HOST in the
DEFAULTS=SSL section of the Broker attribute file.
|
Field Name | Format | CIS Interface Version |
Description / Action |
---|---|---|---|
NUM-SERVICE |
I4 | 7 | Number of services defined (see
NUM-SERVER ).
|
SERVICE-ACT |
I4 | 7 | Number of services active. |
NUM-CLIENT |
I4 | 7 | Number of clients defined (see
NUM-CLIENT ).
|
CLIENT-ACT |
I4 | 7 | Number of clients active. |
CLIENT-HIGH |
I4 | 7 | Highest number of clients active since Broker started. |
NUM-SERVER |
I4 | 7 | Number of servers (see
NUM-SERVER ).
|
SERVER-ACT |
I4 | 7 | Number of servers active. This counter also includes the active Attach Server instances. |
SERVER-HIGH |
I4 | 7 | Highest number of servers active since Broker started. |
NUM-CONV |
I4 | 7 | Number of conversations defined (see
NUM-CONVERSATION ).
|
CONV-ACT |
I4 | 7 | Number of conversations active. |
CONV-HIGH |
I4 | 7 | Highest number of conversations active since Broker started. |
NUM-LONG |
I4 | 7 | Number of long buffers defined (see
NUM-LONG-BUFFER ).
|
LONG-ACT |
I4 | 7 | Number of long buffers active. |
LONG-HIGH |
I4 | 7 | Highest number of long buffers active since Broker started. |
NUM-SHORT |
I4 | 7 | Number of short buffers defined (see
NUM-SHORT-BUFFER ).
|
SHORT-ACT |
I4 | 7 | Number of short buffers active. |
SHORT-HIGH |
I4 | 7 | Highest number of short buffers active since Broker started. |
Field Name | Format | CIS Interface Version |
Description / Action |
---|---|---|---|
CLONE-INDEX |
I4 | 5 | Clone index. |
STATUS |
I4 | 5 | Status of communicator ETB_INFO_COM_STATUS_ .
|
OPEN-CONNECTIONS |
I4 | 5 | Number of open connections. |
MAX-CONNECTIONS |
I4 | 5 | Maximum number of connections. Platform-dependent. See Maximum TCP/IP Connections per Communicator under Broker Resource Allocation. |
PORT-NUMBER |
I4 | 5 | Port number. |
IP-ADDRESS |
A16 | 6 | IPv4 address corresponding to attribute
HOST in
DEFAULTS=TCP section of Broker attribute
file.
|
HOST-NAME |
A256 | 6 | Host name specified using attribute
HOST in
DEFAULTS=TCP section of Broker attribute
file.
|
TASK-RUNNING |
I1 | 8 | Transport task running. 0=NO, 1=YES. |
IPV6-ADDRESS |
A46 | 8 | IPV6 address corresponding to attribute HOST in the
DEFAULTS=TCP section of the Broker attribute file.
|
Field Name | Format | CIS Interface Version | Description / Action |
---|---|---|---|
SERVER-CLASS |
A32 | 9 | Name of server class. |
SERVER-NAME |
A32 | 9 | Name of server. |
SERVICE |
A32 | 9 | Name of service. |
CURRENT-NUMBER-OF-UOWS |
I8 | 9 | Current number of units of work for this service. |
CURRENT-NUMBER-OF-UOW-MESSAGES |
I8 | 9 | Current number of UOW messages for this service. |
CURRENT-NUMBER-OF-BYTES-IN-ALL-UOW-MESSAGES |
I8 | 9 | Current number of bytes in all UOW messages for this service. |
MAX-VALUE-MESSAGES-IN-ONE-UOW |
I4 | 9 | Max value of 'number of messages in one UOW'. |
MAX-VALUE-NUMBER-OF-BYTES-IN-ONE-UOW |
I4 | 9 | Max value of 'number of bytes in one UOW'. |
OLDEST-TIME-OF-UOW-CREATION |
A32 | 9 | Date and time of the oldest UOW for this service. |
NEWEST-TIME-OF-UOW-CREATION |
A32 | 9 | Date and time of the newest UOW for this service. |
NUMBER-OF-UOWS-WITH-STATUS-RECEIVED |
I4 | 11 | Current number of units of work with status RECEIVED. |
NUMBER-OF-UOWS-WITH-STATUS-ACCEPTED |
I4 | 11 | Current number of units of work with status ACCEPTED. |
NUMBER-OF-UOWS-WITH-STATUS-DELIVERED |
I4 | 11 | Current number of units of work with status DELIVERED. |
NUMBER-OF-UOWS-WITH-STATUS-BACKEDOUT |
I4 | 11 | Current number of units of work with status BACKEDOUT. |
NUMBER-OF-UOWS-WITH-STATUS-PROCESSED |
I4 | 11 | Current number of units of work with status PROCESSED. |
NUMBER-OF-UOWS-WITH-STATUS-CANCELLED |
I4 | 11 | Current number of units of work with status CANCELLED. |
NUMBER-OF-UOWS-WITH-STATUS-TIMEOUT |
I4 | 11 | Current number of units of work with status TIMEOUT. |
NUMBER-OF-UOWS-WITH-STATUS-DISCARDED |
I4 | 11 | Current number of units of work with status DISCARDED. |
NUMBER-OF-UOWS-WITH-STATUS-POSTPONED |
I4 | 11 | Current number of units of work with status POSTPONED. |
Field Name | Format | CIS Interface Version |
Description / Action | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
USER-ID |
A32 | 7 | Corresponds to USER-ID in the ACI. The maximum length of this
field is determined by field MAX-UID-LEN in the
header. See Common Header Structure.
|
||||||||||
IS-CLIENT |
I1 | 7 | Is user a client?
|
||||||||||
IS-SERVER |
I1 | 7 | Is user a server?
|
||||||||||
SEQNO |
I4 | 7 | Unique sequence number of user. Can be used with CIS command
SHUTDOWN .
|
||||||||||
ENDIAN |
I2 | 7 | Endian type of user's platform:
|
||||||||||
CHAR-SET |
I2 | 7 | Character set of user's platform:
|
||||||||||
P-USER-ID |
B28 | 7 | Specifies the physical internal unique ID which is used to
distinguish between several users with the same user ID. This field is used as
a handle, i.e. no translation is performed. With CIS commands
SHUTDOWN PARTICIPANT and SHUTDOWN
SERVER , field SEQNO is provided as unique criterion.
|
||||||||||
TOKEN |
A32 | 7 | Corresponds to TOKEN in the ACI. The maximum length of this
field is determined by MAX-TK-LEN in the header. See Common Header Structure for Response Data.
|
||||||||||
LAST-ACTIVE |
I4 | 7 | Elapsed time since the last activity of the user. |
Field Name | Format | CIS Interface Version |
Description / Action | ||||||
---|---|---|---|---|---|---|---|---|---|
WORKER-ID |
I2 | 1 | The worker ID is the table number of this worker's worker queue entry. | ||||||
WORKER-STAT |
I2 | 1 | Status of worker:
|
||||||
CALL-SUM |
I4 | 1 | Sum of calls per worker since Broker started. | ||||||
IDLE-SUM |
I4 | 1 | Sum of idle time per worker since Broker started. |
Field Name | Format | CIS Interface Version |
Description / Action |
---|---|---|---|
WORKER-MAX-ATTRIBUTE |
I4 | 7 | Maximum number of worker tasks the Broker can use. See broker
attribute WORKER-MAX .
|
WORKER-MIN-ATTRIBUTE |
I4 | 7 | Minimum number of worker tasks the Broker can use. See broker
attribute WORKER-MIN .
|
WORKER-NONACT-ATTRIBUTE |
I4 | 7 | Non-activity time in seconds to elapse before a worker tasks is
stopped. See broker attribute
WORKER-NONACT .
|
WORKER-QUEUE-DEPTH |
I4 | 7 | Number of unassigned user requests in the input queue before
another worker task gets started. See broker attribute
WORKER-QUEUE-DEPTH .
|
WORKER-START-DELAY-ATTRIBUTE |
I4 | 7 | Delay after a successful worker task invocation before another
worker task can be started. See broker attribute
WORKER-START-DELAY .
|
LAST-START-TIME |
I4 | 7 | Time of last worker startup. |
LAST-STOP-TIME |
I4 | 7 | Time of last worker stop. |
EFFECTIVE-START-DELAY-SECONDS |
I4 | 7 | Time value representing the seconds of the timeval structure that contains the effective time consumption starting a worker task. |
EFFECTIVE-START-DELAY-MICRO-SECONDS |
I4 | 7 | Time value representing the microseconds of the timeval structure that contains the effective time consumption starting a worker task. |
WORKER-HIGH |
I4 | 7 | Highest number of worker tasks active since Broker started. |
WORKER-LOW |
I4 | 7 | Lowest number of worker tasks active since Broker started. |