Corporate Info  |  News  |  Solutions  |  Products  |  Partners  |  Services  |  Events  |  Download  |  How To Buy
	e-docs.bea.com   |   Site Map   |   Search   |   PDF Files   |   Contact   |   Glossary
Tuxedo Doc Home   |   Reference   |   Topic List   |   Previous   |   Next   |   Contents

   BEA Tuxedo File Formats and Data Descriptions Reference

TM_MIB - Management Information Base for core BEA Tuxedo system

#include <fml32.h> 
#include <tpadm.h>

The BEA Tuxedo System MIB defines the set of classes through which the fundamental aspects of an application can be configured and managed. This includes management of machines, servers, networking.

TM_MIB(5) should be used in combination with the generic MIB reference page MIB(5) to format administrative requests and interpret administrative replies. Requests formatted as described in MIB(5) using classes and attributes described in this reference page may be used to request an administrative service using any one of a number of existing ATMI interfaces in an active application. Inactive applications may also be administered using the tpadmcall() function interface. TM_MIB(5) consists of the following classes.

TM_MIB Classes

Class Name	Controls . . .
T_BRIDGE	Network connections
T_CLIENT	Clients
T_CONN	Conversations
T_DEVICE	Devices
T_DOMAIN	Global application attributes
T_GROUP	Server groups
T_MACHINE	Machine specific attributes
T_MSG	Message queues
T_NETGROUP	Network groups
T_NETMAP	Machines to Netgroups
T_QUEUE	Server queue
T_ROUTING	Routing criteria
T_SERVER	Servers
T_SERVERCTXT	Server context
T_SERVICE	Services
T_SVCGRP	Service group
T_TLISTEN	BEA Tuxedo system listeners
T_TLOG	Transaction log
T_TRANSACTION	Transaction
T_ULOG	Userlog

Each class description consists of four sections:

• OVERVIEW - High level description of the attributes associated with the class.

• ATTRIBUTE TABLE - The format of the attribute table is summarized below and described in detail in MIB(5).

• ATTRIBUTE SEMANTICS - Defines the interpretation of each attribute that is part of the class.

• LIMITATIONS - Limitations in the access to and interpretation of this class.

Attribute Table Format

Each class that is a part of this MIB is defined in four parts in sections that follow. One of the four parts is the attribute table. The attribute table is a reference guide to the attributes within a class and how they may used by administrators, operators, and general users to interface with an application.

There are five columns for each attribute described in an attribute table: name, type, permissions, values, and default. Each of these components is discussed in MIB(5).

MIB(5) defines the generic TA_FLAGS attribute, which is a long containing both generic and component MIB specific flag values. The following are the TM_MIB(5) specific flag values supported. These flag values should be or'd with any generic MIB flags.

TMIB_ADMONLY

A flag used to indicate that only administrative processes should be activated when changing the state of a T_MACHINE object from INActive to ACTive.

TMIB_APPONLY

A flag used to indicate that only application processes should be considered when activating or deactivating a T_MACHINE object. It may also be used on T_SERVER and T_SERVERCTXT retrievals to restrict the retrieval to application servers only.

TMIB_CONFIG

A flag used to indicate that only configured groups and servers should be considered in satisfying the request.

TMIB_NOTIFY

A flag used when activating or deactivating T_MACHINE, T_GROUP, or T_SERVER objects to cause unsolicited notification messages to be sent to the originating client just prior to and just after the activation or deactivation of each server object selected.

The field table for the attributes described in this reference page is found in the file udataobj/tpadm relative to the root directory of the BEA Tuxedo system software installed on the system. The directory ${TUXDIR}/udataobj should be included by the application in the colon-separated list specified by the FLDTBLDIR environment variable, and the field table name tpadm should be included in the comma-separated list specified by the FIELDTBLS environment variable.

Access to the header files and field tables for this MIB is being provided only on BEA Tuxedo Release 5.0 sites and later, both native and Workstation.

Workstation access to this MIB is limited to runtime only access; the function tpadmcall(3c) is not supported on workstations.

For the purpose of preimage processing (MIB_PREIMAGE flag bit set), local attributes for classes that have global attributes are not considered. Additionally, indexed fields and the indexes that go with them are not considered, for example, T_TLOG class, TA_TLOGCOUNT, TA_TLOGINDEX, TA_GRPNO, TA_TLOGDATA attributes.

The T_BRIDGE class represents run-time attributes pertaining to connectivity between logical machines making up an application. These attribute values represent connection status and statistics.

TM_MIB(5): T_BRIDGE Class Definition Attribute Table

Attribute1	Type	Permissions	Values	Default
TA_LMID(*)2	string	r--r--r--	"LMID1[,LMID2]"	N/A
TA_NETGROUP(k)3	string	R--R--R--	string[1. . 30]	DEFAULTNET
TA_STATE(k)	string	rwxrwxr--	GET: "{ACT | INA | SUS | PEN}" SET: "{ACT | INA | SUS | PEN}"	N/A N/A
TA_CURTIME	long	R--R--R--	0 <= num	N/A
TA_CONTIME	long	R-XR-XR--	0 <= num	N/A
TA_SUSPTIME	long	rwxrwxr--	0 <= num	3004
TA_RCVDBYT	long	R-XR-XR--	0 <= num	N/A
TA_SENTBYT	long	R-XR-XR--	0 <= num	N/A
TA_RCVDNUM	long	R-XR-XR--	0 <= num	N/A
TA_SENTNUM	long	R-XR-XR--	0 <= num	N/A
TA_FLOWCNT	long	R-XR-XR--	0 <= num	N/A
TA_CURENCRYPTBIT	string	R--R-----	{0 | 40 | 56 | 128}5	N/A
(k) - GET key field (*) - GET/SET key, one or more required for SET operations

¹All attributes in Class T_BRIDGE are local attributes.

²The TA_LMID attribute must be fully specified for SET operations, that is, LMID1,LMID2.

³SET operation may only use TA_NETGROUP DEFAULTNET in BEA Tuxedo Release 6.4. GET operation may use any TA_NETGROUP defined for both LMID values.

⁴TA_SUSPTIME may be SET only if the TA_STATE is currently SUSPENDED or is being SET to SUSPENDED.

⁵The link-level encryption value of 40 bits is provided for backward compatibility.

TA_LMID: LMID1[,LMID2]

Source logical machine identifier (LMID1) and destination logical machine identifier (LMID2) for network connection.

TA_NETGROUP: string[1 . .30]

Logical name of the network group.When both source and destination TA_LMID identifiers are in the same TA_NETGROUP, the T_BRIDGE class will present all instances of related fields per TA_NETGROUP. TA_NETGROUP may be used as a key field on GET requests. TA_NETGROUP values other than DEFAULTNET may not be used on SET operations in this BEA Tuxedo release (Release 6.4).

TA_STATE:

GET: "{ACTive | INActive | SUSpended | PENding}"

A GET operation will retrieve run-time information for the selected T_BRIDGE object(s). A TA_LMID attribute value with only one logical machine identifier matches all active connections from LMID1 to other machines in the application. In this case, each retrieved record will contain an expanded TA_LMID attribute value with the destination LMID filled in. The following states indicate the meaning of a TA_STATE returned in response to a GET request.

ACTive	The connection is established and active.
INActive	The connection is inactive. This state is only returned when status is requested on a particular connection, that is, both Lands specified in the TA_LMID attribute and the source logical machine is reachable.
SUSpended	An established connection was terminated due to an error condition, and reconnection has been suspended for at least the amount of time indicated in the TA_SUSPTIME attribute value. This state is ACTive equivalent for the purpose of determining permissions.
PENding	An asynchronous connection has been requested, but has not yet been completed. The final outcome of the connection request has not been determined.

SET: "{ACTive | INActive | SUSpended | PENding}"

A SET operation will update run-time information for the selected T_BRIDGE object. The following states indicate the meaning of a TA_STATE set in a SET request. States not listed may not be set.

unset	Modify an existing T_BRIDGE object. This combination is allowed only when in the ACTive or SUSpended state. Successful return leaves the object state unchanged.
ACTive	Activate the T_BRIDGE object by establishing a connection between the indicated logical machines. This operation will fail if only one logical machine is specified, if either of the two machines is not active, or if the source logical machine is not reachable. While the T_BRIDGE object is establishing the asynchronous connection, the BRIDGE will do other work. Using the state change to PENding is recommended. State change allowed in the INActive and SUSpended states. For the purpose of determining permissions for this state transition, the active object permissions are considered (that is, --x--x--x). Successful return leaves the object in the PENding state.
INActive	Deactivate the T_BRIDGE object by closing the connection between the indicated logical machines. This operation will fail if only one logical machine is specified or if the two machines are not connected. State change allowed only when in the ACTive state. Successful return leaves the object in the INActive state.
SUSpended	Suspend the T_BRIDGE object by closing the connection between the indicated logical machines and by setting the TA_SUSPTIME parameter as indicated. State change allowed only when in the ACTive state. Successful return leaves the object in the SUSpended state. Limitation: Note that since the statistics reported are from the viewpoint of the source logical machine, resetting those statistics will cause them to be out of sync with the statistics reported by the destination logical machine for the same connection.
PENding	Activate the T_BRIDGE object by establishing an asynchronous connection between the indicated logical machines. This operation will fail if only one logical machine is specified, if either of the two machines is not active, or if the source machine is not reachable. When in the PENding state, the success or failure of the connection request has not yet been determined. However, the BRIDGE may continue to process other events and data while the connection is outstanding. State change allowed in the INActive and SUSpended states. For the purpose of determining permissions for this state transition, the active object permissions are considered (that is, --x--x--x). Successful return leaves the object in the PENding state.

TA_CURTIME: 0 <= num

Current time, in seconds, since 00:00:00 UTC, January 1, 1970, as returned by the time(2) system call on T_BRIDGE:TA_LMID. This attribute can be used to compute elapsed time from the following attribute value.

TA_CONTIME: 0 <= num

Time, in seconds, since 00:00:00 UTC, January 1, 1970, as returned by the time(2) system call on T_BRIDGE:TA_LMID, when this connection was first established. Elapsed open time in seconds can be computed using TA_CURTIME - TA_CONTIME.

TA_SUSPTIME: 0 <= num

Time, in seconds, remaining in the suspension of this connection. After this amount of time, the connection will automatically change to a TA_STATE of INACTIVE and may be activated by normal application traffic.

TA_RCVDBYT: 0 <= num

Number of bytes sent from the destination logical machine to the source logical machine.

TA_SENTBYT: 0 <= num

Number of bytes sent from the source logical machine to the destination logical machine.

TA_RCVDNUM: 0 <= num

Number of messages sent from the destination logical machine to the source logical machine.

TA_SENTNUM: 0 <= num

Number of messages sent from the source logical machine to the destination logical machine.

TA_FLOWCNT: 0 <= num

Number of times flow control has been encountered over this connection.

TA_CURENCRYPTBITS: {0 | 40 | 56 | 128}

The current encryption level for this link. The level is negotiated between machines when the link is established.

Note: The link-level encryption value of 40 bits is provided for backward compatibility.

None.

The T_CLIENT class represents run-time attributes of active clients within an application. These attribute values identify and track the activity of clients within a running application.

TM_MIB(5): T_CLIENT Class Definition Attribute Table

Attribute1	Type	Permissions	Values	Default
TA_STATE(k)	string	R-XR-XR--	GET: "{ACT | SUS | DEA}" SET: "{ACT | SUS | DEA}"	N/A N/A
TA_CLIENTID(*)	string	R--R--R--	string[1 . .78]	N/A
TA_CLTNAME(k)	string	R--R--R--	string[0 . .30]	N/A
TA_IDLETIME(k)	long	R--R--R--	0 <= num	N/A
TA_LMID(k)	string	R--R--R--	LMID	N/A
TA_PID(k)	long	R--R--R--	1 <= num	N/A
TA_CONTEXTID	long	R--R--R--	-2 <= num < 30,000	N/A
TA_SRVGRP(k)	string	R--R--R--	string[0 . .30]	N/A
TA_USRNAME(k)	string	R--R--R--	string[0 . .30]	N/A
TA_WSC(k)	string	R--R--R--	"{Y | N}"	N/A
TA_WSH(k)	string	R--R--R--	"{Y | N}"	N/A
TA_WSHCLIENTID(k)	string	R--R--R--	string[1 . .78]	N/A
TA_RELEASE	long	R--R--R--	0 <= num	N/A
TA_WSPROTO	long	R--R--R--	0 <= num	N/A
TA_NUMCONV	long	R-XR-XR--	0 <= num	N/A
TA_NUMDEQUEUE	long	R-XR-XR--	0 <= num	N/A
TA_NUMENQUEUE	long	R-XR-XR--	0 <= num	N/A
TA_NUMPOST	long	R-XR-XR--	0 <= num	N/A
TA_NUMREQ	long	R-XR-XR--	0 <= num	N/A
TA_NUMSUBSCRIBE	long	R-XR-XR--	0 <= num	N/A
TA_NUMTRAN	long	R-XR-XR--	0 <= num	N/A
TA_NUMTRANABT	long	R-XR-XR--	0 <= num	N/A
TA_NUMTRANCMT	long	R-XR-XR--	0 <= num	N/A
TA_CMTRET	string	R--R--R--	"{COMPLETE | LOGGED}"	N/A
TA_CURCONV	long	R--R--R--	0 <= num	N/A
TA_CURENCRYPTBIT	string	R--R-----	{0 | 40 | 56 | 128}2	N/A
TA_CURREQ	long	R--R--R--	0 <= num	N/A
TA_CURTIME	long	R--R--R--	1 <= num	N/A
TA_LASTGRP	long	R--R--R--	1 <= num <30,000	N/A
TA_NADDR	string	R--R--R--	string[1 . .78]	N/A
TA_NOTIFY	string	R--R--R--	"{DIPIN | SIGNAL | THREAD | IGNORE}"	N/A
TA_NUMUNSOL	long	R--R--R--	0 <= num	N/A
TA_RPID	long	R--R--R--	1 <= num	N/A
TA_TIMELEFT	long	R--R--R--	0 <= num	N/A
TA_TIMESTART	long	R--R--R--	1 <= num	N/A
TA_TRANLEV	long	R--R--R--	0 <= num	N/A
(k) - GET key field (*) - GET/SET key, one or more required for SET operations

¹All attributes in Class T_CLIENT are local attributes.
²The link-level encryption value of 40 bits is provided for backward compatibility.

TA_STATE:

GET: "{ACTive | SUSpended | DEAd}"

A GET operation will retrieve run-time information for the selected T_CLIENT object(s). Note that client information is kept in local bulletin board tables only. Therefore, for maximum performance, inquiries on client status should be restricted using key fields as much as possible. The following states indicate the meaning of a TA_STATE returned in response to a GET request.

ACTive	T_CLIENT object active. This is not an indication of whether the client is idle or busy. A non 0 value retrieved for either the TA_CURCONV attribute or the TA_CURREQ attribute indicates a busy client.
SUSpended	T_CLIENT object active and suspended from making further service requests (tpcall() or tpacall()) and from initiating further conversations (tpconnect()). See SET SUSpended below for details. This state is ACTive equivalent for the purpose of determining permissions.
DEAd	T_CLIENT object identified as active in the bulletin board but currently not running due to an abnormal death. This state will exist only until the BBL local to the client notices the death and takes action to clean up the client's bulletin board resources. This state is ACTive equivalent for the purpose of determining permissions.

SET: "{ACTive | SUSpended | DEAd}"

A SET operation will update run-time information for the selected T_CLIENT object. The following states indicate the meaning of a TA_STATE set in a SET request. States not listed may not be set.

ACTive	Activate a SUSpended T_CLIENT object. State change allowed only when in the SUSpended state. Successful return leaves the object in the ACTive state.
unset	Modify an existing T_CLIENT object. This combination is allowed only when in the ACTive or SUSpended state. Successful return leaves the object state unchanged.
SUSpended	Suspend the T_CLIENT object from making service requests (tpcall() or tpacall()), initiating conversations (tpconnect()), beginning transactions (tpbegin()), and enqueuing new requests (tpenqueue()). Clients within a transaction will be permitted to make these calls until they abort or commit the current transaction, at which time they will become suspended. Invocations of these routines will result in a TPESYSTEM error return and a system log message being generated indicating the situation. State change allowed only when in the ACTive state. Successful return leaves the object in the SUSpended state.
DEAd	Abortively deactivate the T_CLIENT object. State change allowed only when in the ACTive or SUSpended state. The recommended method for deactivating clients is to first broadcast a warning message (tpbroadcast)), then to suspend them (see SET SUSpended above), and finally to abortively deactivate them by setting the state to DEAd. Successful return leaves the object in the DEAd state. Limitation: Workstation handlers (T_CLIENT:TA_WSH == Y) may not be set to a state of DEAd. The system may not be able to kill the client due to platform or signaling restrictions. In this case, a native client will be abortively terminated at its next access to ATMI, and a Workstation client's connection to a WSH will be preemptively torn down.

TA_CLIENTID: string[1..78]

Client identifier. The data in this field should not be interpreted directly by the end user except for equality comparison.

TA_CLTNAME: string[0..30]

Client name associated with client at tpinit() time via the cltname element of the TPINIT structure.

TA_IDLETIME: 0 <= num

Approximate amount of time, in seconds, since this client last interacted with the system via an ATMI call. This value is accurate to within TA_SCANUNIT (see the T_DOMAIN class) seconds. When specified as a key field, a positive value indicates that all clients with idle times of at least the indicated value match, a negative value indicates that all clients with no more than the indicated value match, and a 0 value matches all clients.

TA_LMID: LMID

Logical machine where client is running (native clients) or where client is connected (Workstation clients).

TA_PID: 1 <= num

Process identifier of client. Note that for Workstation clients, this identifier indicates the workstation handler through which the Workstation client is connected. A negative number may be specified on a GET operation for the purpose of retrieving client information for the calling process. If the calling process is not a client, then an error will be returned.

TA_CONTEXTID: -2 <= num < 30,000

Identifier for this particular application association.

TA_SRVGRP: string[0..30]

Server group with which the client is associated. This information is set via the grpname element of the TPINIT structure at tpinit() time.

TA_USRNAME: string[0..30]

User name associated with client at tpinit() time via the usrname element of the TPINIT structure.

TA_WSC: "{Y | N}"

Workstation client. If this attribute is set to "Y", then the indicated client is logged in to the application from a remote workstation.

TA_WSH: "{Y | N}"

Workstation handler. If this attribute is set to "Y", then the indicated client is a workstation handler process.

TA_WSHCLIENTID: string[1..78]

Client identifier for the associated workstation handler (WSH) if this client is a Workstation client (TA_WSH == Y); otherwise, this attribute will be returned as a 0-length string.

TA_RELEASE: 0 <= num

The BEA Tuxedo system major protocol release number for the machine where the client is running. This may be different from the TA_SWRELEASE for the same machine. Note that for Workstation clients (TA_WSC == Y), this value may be different than the major release associated with the application administered machine through which the Workstation client accesses the application.

TA_WSPROTO: 0 <= num

The BEA Tuxedo system Workstation protocol version number for a Workstation client. This value is changed with each update to the Workstation protocol. A value of 0 is returned for this attribute when associated with non-Workstation clients (TA_WSC == N).

TA_NUMCONV: 0 <= num

Number of conversations initiated by this client via tpconnect().

TA_NUMDEQUEUE: 0 <= num

Number of dequeue operations initiated by this client via tpdequeue().

TA_NUMENQUEUE: 0 <= num

Number of enqueue operations initiated by this client via tpenqueue().

TA_NUMPOST: 0 <= num

Number of postings initiated by this client via tppost().

TA_NUMREQ: 0 <= num

Number of requests made by this client via tpcall() or tpacall().

TA_NUMSUBSCRIBE: 0 <= num

Number of subscriptions made by this client via tpsubscribe().

TA_NUMTRAN: 0 <= num

Number of transactions begun by this client.

TA_NUMTRANABT: 0 <= num

Number of transactions aborted by this client.

TA_NUMTRANCMT: 0 <= num

Number of transactions committed by this client.

TA_CMTRET: "{COMPLETE | LOGGED}"

Setting of the TP_COMMIT_CONTROL characteristic for this client. See the description of the BEA Tuxedo System ATMI function tpscmt() for details on this characteristic.

TA_CURCONV: 0 <= num

Number of conversations initiated by this client via tpconnect() that are still active.

TA_CURENCRYPTBITS: {0 | 40 | 56 | 128}

The current encryption level for this client. The level is negotiated when the link is established.

Note: The link-level encryption value of 40 bits is provided for backward compatibility.

TA_CURREQ: 0 <= num

Number of requests initiated by this client via tpcall() or tpacall() that are still active.

TA_CURTIME: 1 <= num

Current time, in seconds, since 00:00:00 UTC, January 1, 1970, as returned by the time(2) system call on T_CLIENT:TA_LMID. This attribute can be used to compute elapsed time from the T_CLIENT:TA_TIMESTART attribute value.

TA_LASTGRP: 1 <= num < 30,000

Server group number (T_GROUP:TA_GRPNO) of the last service request made or conversation initiated from this client.

TA_NADDR: string[1 . . 78]

For Workstation clients, this attribute indicates the network address of the client. Network addresses with unprintable characters are converted to one of the following formats.

• "0xhex-digits"

• "\\xhex-digits"
  A string in either format must contain an even number of valid hex digits. Such a string is translated internally into a character array containing the hexadecimal representations of the string specified.

  For TCP/IP addresses one of the following formats is used.

  "//hostname:port"

  "//#.#.#.#:port_number"

  Each # (pound) sign represents a decimal number in the range of 0 to 255. The value of port_number is a decimal number in the range of 0 to 65535.

  Note: Some port numbers may be reserved for the underlying transport protocols (such as TCP/IP) used by your system. Check the documentation for your transport protocols to find out which numbers, if any, are reserved on your system.

  Non-Workstation clients have a 0-length string associated with them for this attribute value.

  Limitation: The ability of the system to provide this information is determined by the transport provider in use. In some cases, Workstation clients may not have addresses associated with them if the provider does not make this information available.

TA_NOTIFY: "{DIPIN | SIGNAL | THREAD | IGNORE}"

Setting of the notification characteristic for this client. See the T_DOMAIN class description of this attribute for more details.

TA_NUMUNSOL: 0 <= num

Number of unsolicited messages queued for this client awaiting processing.

TA_RPID: 1 <= num

UNIX System message queue identifier for the client's reply queue. Limitation: This is a UNIX System specific attribute that may not be returned if the platform on which the application is being run is not UNIX-based.

TA_TIMELEFT: 0 <= num

Time left, in seconds, for this client to receive the reply for which it is currently waiting before it will timeout. This timeout may be a transactional timeout or a blocking timeout.

TA_TIMESTART: 1 <= num

Time, in seconds, since 00:00:00 UTC, January 1, 1970, as returned by the time(2) system call on T_CLIENT:TA_LMID, since the client joined the application.

TA_TRANLEV: 0 <= num

Current transaction level for this client. 0 indicates that the client is not currently involved in a transaction.

None.

The T_CONN class represents run-time attributes of active conversations within an application.

TM_MIB(5): T_CONN Class Definition Attribute Table

Attribute1	Type	Permissions	Values	Default
TA_LMID(k)	string	R--R--R--	LMID	N/A
TA_STATE(k)	string	R--R--R--	GET: "ACT" SET: N/A	N/A N/A
TA_SERVICENAME	string	R--R--R--	string[1..15]	N/A
TA_CLIENTID(k) TA_CONNOGRPNO TA_CONNOLMID TA_CONNOPID TA_CONNOSNDCNT TA_CONNOSRVID	string long string long long long	R--R--R-- R--R--R-- R--R--R-- R--R--R-- R--R--R-- R--R--R--	string[1..78] 1 <= num < 30,001 LMID 1 <= num 0 <= num 1 <= num < 30,001	N/A N/A N/A N/A N/A N/A
TA_CONNSGRPNO TA_CONNSLMID TA_CONNSPID TA_CONNSSNDCNT TA_CONNSSRVID	long string long long long	R--R--R-- R--R--R-- R--R--R-- R--R--R-- R--R--R--	1 <= num < 30,001 LMID 1 <= num