Limitations

None

T_NETMAP CLASS DEFINITION

Overview

The T_NETMAP class associates TA_LMIDs from the T_MACHINE class in the TM_MIB to a TA_NETGROUP object from the T_NETGROUP class. This class identifies which logical machines belong to which network group. A TA_LMID may be in many TA_NETGROUP groups. When one LMID connects to another LMID, the BRIDGE process determines the subset of network groups to which the two LMIDs belong. When the pair of LMIDs are in several common groups, they are sorted in descending TA_NETPRIO order (TA_NETGRPNO is the secondary key). The TA_NADDRs of the highest TA_NETPRIO network group(s) are the primary network addresses. Network groups with the same TA_NETPRIO will flow network data in parallel. Should a networking error prevent data from flowing entirely through the highest priority group(s), then the next lower priority network group(s) are used. This is called "Failover." When a failover condition exists, the higher priority groups are periodically retried. When a higher priority connection is established, no further data is scheduled for the lower priority one. Once the lower priority connection is drained, it is disconnected in an orderly fashion. This is call "Failback."

Attribute Table

TM_MIB(5): T_NETMAP Class Definition Attribute Table
Attribute	Type	Permissions	Values	Default
TA_NETGROUP( r )( * )	string	ru-------	string[1...30]	N/A
TA_LMID( r )( * )	string	ru-------	string[1...30]	N/A
TA_STATE	string	rw-------	GET:"{VAL}"	N/A
			SET:"{NEW|INV}"	N/A
TA_NADDR	string	rw-r--r--	string[1...78]	""
TA_MINENCRYPTBIT	string	rwxrwx---	{0|40|128}	0
TA_MAXENCRYPTBIT	string	rwxrwx---	{0|40|128}	128

( r ) - Required field for object creation (SET TA_STATE NEW)

( * ) - GET/SET key, one or more required for SET operations

Attribute Semantics

TA_NETGROUP: string

This attribute is the name of the associated network group found in the T_NETGROUP class.

TA_LMID: string

The logical machine name from the T_MACHINE class (in TM_MIB) for this network mapping.

TA_STATE:

GET: {VALid}

A GET operation will retrieve configuration information for the selected T_NETMAP object(s). The following states indicate the meaning of a TA_STATE returned in response to a GET request. States not listed will not be returned.

ACTive

T_NETMAP object is defined. Note that this is the only valid state for this class. Network mappings are never active.

SET: {NEW|INValid}

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

NEW

Create T_NETMAP object for application. State change allowed only when in the INValid state. Successful return leaves the object in the VALid state.

unset

Modify an existing T_NETMAP object. Successful return leaves the object state unchanged.

INValid

Deletes the given network mapping. If any network links were active as a result of the mapping, they will be disconnected. This disconnection may cause a state change in T_BRIDGE objects (in TM_MIB) associated with the network links.

TA_NADDR: string

Specifies the complete network address to be used by the BRIDGE oricess okaced ib tge kigical machine as its listening address. The listening address for a BRIDGE is the means by which it is contacted by other BRIDGE processes participating in the application. This attribute must be set if the logical machine is to participate in a networked application, that is, if the LAN option is set in the T_DOMAIN:TA_OPTIONS (in TM_MIB?) attribute value. If string has the form "0xhex-digits," is must contain an even number of valid hex digits. These forms are translated internally into a character array containing the Hexadecimal representations of the string specified. For TCP/IP addresses either the

"//hostname:port"
or
"//#.#.#.#:port"

format is used.

TA_MINENCRYPTBIT: {0|40|128}

When establishing a network link to this machine, require at least this minimum level of encryption. "0" means no encryption, while "40' and "128" specify the encryption key length (in bits). If this minimum level of encryption cannot be met, link establishment will fail. The default value is "0". Limitation: Modifications to this attribute will not effect established network links.

TA_MAXENCRYPTBIT: {0|40|128}

When establishing a network link, negotiate encryption up to this level. "0" means no encryption, while "40" and "128" specify the encryption length (in bits). Limitation: Modifications to this attribute will not effect established network links.

Limitations

None

T_QUEUE CLASS DEFINITION

Overview

The T_QUEUE class represents runtime attributes of queues in an application. These attribute values identify and characterize allocated TUXEDO System/T request queues associated with servers in a running application. They also track statistics related to application workloads associated with each queue object.

Note that when a GET operation with the MIB_LOCAL flag is performed in a multi-machine application, multiple objects will be returned for each active queue\(emone object for each logical machine where local attribute values are collected.

Attribute Table

TM_MIB(5): T_QUEUE Class Definition Attribute Table
Attribute	Type	Permissions	Values	Default
TA_RQADDR( * )	string	R--R--R--	string[1...30]	N/A
TA_SERVERNAME( k )	string	R--R--R--	string[1...78]	N/A
TA_STATE( k )	string	R--R--R--	GET:"{ACT|MIG|SUS|PAR}"	N/A
			SET:N/A	N/A
TA_GRACE	long	R--R--R--	0 <= num	N/A
TA_MAXGEN	long	R--R--R--	1 <= num < 256	N/A
TA_RCMD	string	R--R--R--	string[0...78]	N/A
TA_RESTART	string	R--R--R--	"{Y|N}"	N/A
TA_CONV	string	R--R--R--	"{Y|N}"	N/A
TA_LMID( k )	string	R--R--R--	LMID	N/A
TA_RQID	long	R--R--R--	1 <= num	N/A
TA_SERVERCNT	long	R--R--R--	1 <= num < 8K	N/A
T_QUEUE Class:LOCAL Attributes
TA_TOTNQUEUED	long	R-XR-XR--	0 <= num	N/A
TA_TOTWKQUEUED	long	R-XR-XR--	0 <= num	N/A
TA_SOURCE( k )	string	R--R--R--	LMID	N/A
TA_NQUEUED	long	R--R--R--	0 <= num	N/A
TA_WKQUEUED	long	R--R--R--	0 <= num	N/A

( k ) - GET key field

( * ) - GET/SET key, one or more required for SET operations

Attribute Semantics

TA_RQADDR: string[1...30]

Symbolic address of the request queue. Servers with the same T_SERVER:TA_RQADDR attribute value are grouped into a Multiple Server Single Queue (MSSQ) set. Attribute values returned with a T_QUEUE object apply to all active servers associated with this symbolic queue address.

TA_SERVERNAME: string[1...78]

Full pathname of the server executable file. The server identified by TA_SERVERNAME is running on the machine identified by the T_QUEUE:TA_LMID attribute. When specified as a key field on a GET operation, this attribute may specify a relative pathname; all appropriate full pathnames will be matched.

TA_STATE:

GET: {ACTive|MIGrating|SUSpended|PARtitioned}

A GET operation will retrieve runtime information for the selected T_QUEUE object(s). The T_QUEUE class does not address configuration information directly. Configuration related attributes discussed here must be set as part of the related T_SERVER objects. The following states indicate the meaning of a TA_STATE returned in response to a GET request. States not listed will not be returned.

ACTive

At least one server associated with this T_QUEUE object is active.

MIGrating

The server(s) associated with this T_QUEUE object is currently in the MIGrating state. See the T_SERVER class for more details on this state. This state is ACTive equivalent for the purpose of determining permissions.

SUSpended

The server(s) associated with this T_QUEUE object is currently in the SUSpended state. See the T_SERVER class for more details on this state. This state is ACTive equivalent for the purpose of determining permissions.

PARtitioned

The server(s) associated with this T_QUEUE object is currently in the PARtitioned state. See the T_SERVER class for more details on this state. This state is ACTive equivalent for the purpose of determining permissions.

SET:

A SET operation will update runtime information for the selected T_QUEUE object. State changes are not allowed when updating T_QUEUE object information. Modification of an existing T_QUEUE object is allowed only when the object is in the ACTive state.

TA_GRACE: 0 <= num

The period of time, in seconds, over which the T_QUEUE:TA_MAXGEN limit applies. This attribute is meaningful only for restartable servers, that is, if the T_QUEUE:TA_RESTART attribute is set to "Y". A value of 0 for this attribute indicates that a server should always be restarted.

TA_MAXGEN: 1 <= num < 256

Number of generations allowed for restartable servers (T_QUEUE:TA_RESTART == "Y") associated with this queue over the specified grace period (T_QUEUE:TA_GRACE). The initial activation of each server counts as one generation and each restart also counts as one.

TA_RCMD: string[0...78]

Application specified command to be executed in parallel with the system restart of application servers associated with this queue.

TA_RESTART: {Y|N}

Servers associated with this queue are restartable ("Y") or non-restartable ("N").

TA_CONV: {Y|N}

Servers associated with this queue are conversational-based ("Y") or request/response-based ("N").

TA_LMID: LMID

Logical machine on which servers associated with this queue are active.

TA_RQID: 1 <= num

UNIX System message queue identifier.

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_SERVERCNT: 1 <= num < 8K

Number of active servers associated with this queue.

TA_TOTNQUEUED: 0 <= num

The sum of the queue lengths of this queue while it has been active. This sum includes requests enqueued to and processed by servers that are no longer active on the queue. Each time a new request is assigned to the queue, the sum is incremented by the length of the queue immediately before the new request is enqueued.

Limitation: If the T_DOMAIN:TA_LDBAL attribute is "N" or the T_DOMAIN:TA_MODEL attribute is "MP", then TA_TOTNQUEUED is not returned. In the same configuration, updates to this attribute are ignored. Consequently, when this attribute is returned TA_LMID and TA_SOURCE have the same value.

TA_TOTWKQUEUED: 0 <= num

The sum of the workloads enqueued to this queue while it has been active. This sum includes requests enqueued to and processed by servers that are no longer active on the queue. Each time a new request is assigned to the queue, the sum is incremented by the workload on the queue immediately before the new request is enqueued.

Limitation: If the T_DOMAIN:TA_LDBAL attribute is "N" or the T_DOMAIN:TA_MODEL attribute is "MP", then TA_TOTWKQUEUED is not returned. In the same configuration, updates to this attribute are ignored. Consequently, when this attribute is returned TA_LMID and TA_SOURCE have the same value.

TA_SOURCE: LMID

Logical machine from which local attribute values are retrieved.

TA_NQUEUED: 0 <= num

Number of requests currently enqueued to this queue from the TA_SOURCE logical machine. This value is incremented at enqueue time and decremented when the server dequeues the request.

Limitation: If the T_DOMAIN:TA_LDBAL attribute is "N" or the T_DOMAIN:TA_MODEL attribute is "MP", then TA_NQUEUED is not returned. Consequently, when this attribute is returned TA_LMID and TA_SOURCE have the same value.

TA_WKQUEUED: 0 <= num

Workload currently enqueued to this queue from the TA_SOURCE logical machine. If the T_DOMAIN:TA_MODEL attribute is set to SHM and the T_DOMAIN:TA_LDBAL attribute is set to "Y" then this attribute reflects the application-wide workload enqueued to this queue. However, if TA_MODEL is set to MP and TA_LDBAL is set to "Y", this attribute reflects the workload enqueued to this queue from the TA_SOURCE logical machine during a recent timespan. This attribute is used for load balancing purposes. So as to not discriminate against newly started servers, this attribute value is zeroed out on each machine periodically by the BBL.

Limitations

None.

T_ROUTING CLASS DEFINITION

Overview

The T_ROUTING class represents configuration attributes of routing specifications for an application. These attribute values identify and characterize application data dependent routing criteria with respect to field names, buffer types, and routing definitions.

Attribute Table

TM_MIB(5): T_ROUTING Class Definition Attribute Table
Attribute	Type	Permissions	Values	Default
TA_ROUTINGNAME ( r )( * )	string	ru-r--r--	string[1...15]	N/A
TA_BUFTYPE( r )( * )	string	ru-r--r--	string[1...256]	N/A
TA_FIELD( r )( k )	string	rw-r--r--	string[1...30]	N/A
TA_RANGES( r )	carray	rw-r--r--	carray[1...2048]	N/A
TA_STATE( k )	string	rw-r--r--	GET:"{VAL}" SET:"{NEW|INV}"	N/A N/A

( k ) - GET key field

( r ) - Required field for object creation (SET TA_STATE NEW)

( * ) - GET/SET key, one or more required for SET operations

Attribute Semantics

TA_ROUTINGNAME: string[1...15]

Routing criteria name.

TA_BUFTYPE: type1[:subtype1[,subtype2 . . . ]][;type2[:subtype3[, . . . ]]] . . .

List of types and subtypes of data buffers for which this routing entry is valid. A maximum of 32 type/subtype combinations are allowed. The types are restricted to be one of FML, VIEW, X_C_TYPE, or X_COMMON. No subtype can be specified for type FML, and subtypes are required for types VIEW, X_C_TYPE, and X_COMMON (``*'' is not allowed). Note that subtype names should not contain semicolon, colon, comma, or asterisk characters. Duplicate type/subtype pairs can not be specified for the same routing criterion name; more than one routing entry can have the same criterion name as long as the type/subtype pairs are unique. If multiple buffer types are specified for a single routing entry, the data types of the routing field for each buffer type must be the same.

TA_FIELD: string[1...30]

Routing field name. This field is assumed to be an FML buffer or view field name that is identified in an FML field table (using the FLDTBLDIR and FIELDTBLS environment variables) or an FML view table (using the VIEWDIR and VIEWFILES environment variables), respectively. This information is used to get the associated field value for data dependent routing during the sending of a message.

TA_RANGES: carray[1...2048]

The ranges and associated server groups for the routing field. The format of string is a comma-separated, ordered list of range/group name pairs. A range/group name pair has the following format:

lower[-upper]:group

lower and upper are signed numeric values or character strings in single quotes. lower must be less than or equal to upper. To embed a single quote in a character string value, it must be preceded by two backslashes (for example, 'O\\'Brien'). The value MIN can be used to indicate the minimum value for the data type of the associated field on the machine. The value MAX can be used to indicate the maximum value for the data type of the associated field on the machine. Thus, ``MIN--5'' is all numbers less than or equal to -5, and ``6-MAX'' is all numbers greater than or equal to 6.

The meta-character ``*'' (wild-card) in the position of a range indicates any values not covered by the other ranges previously seen in the entry; only one wild-card range is allowed per entry and it should be last (ranges following it will be ignored).

The routing field can be of any data type supported in FML. A numeric routing field must have numeric range values, and a string routing field must have string range values.

String range values for string, carray, and character field types must be placed inside a pair of single quotes and can not be preceded by a sign. Short and long integer values are a string of digits, optionally preceded by a plus or minus sign. Floating point numbers are of the form accepted by the C compiler or atof(3): an optional sign, then a string of digits optionally containing a decimal point, then an optional e or E followed by an optional sign or space, followed by an integer.

The group name indicates the associated group to which the request is routed if the field matches the range. A group name of ``*'' indicates that the request can go to any group where a server offers the desired service.

Limitation: Attribute values greater than 256 bytes in length will disable interoperability with TUXEDO System/T Release 4.2.2 and earlier.

TA_STATE:

GET: {VALid}

A GET operation will retrieve configuration information for the selected T_ROUTING object(s). The following states indicate the meaning of a TA_STATE returned in response to a GET request. States not listed will not be returned.

VALid

T_ROUTING object is defined. Note that this is the only valid state for this class. Routing criteria are never active; rather, they are associated through the configuration with service names and are acted upon at runtime to provide data dependent routing. This state is INActive equivalent for the purpose of permissions checking.

SET: {NEW|INValid}

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

NEW

Create T_ROUTING object for application. State change allowed only when in the INValid state. Successful return leaves the object in the VALid state.

unset

Modify an existing T_ROUTING object. This combination is not allowed in the INValid state. Successful return leaves the object state unchanged.

INValid

Delete T_ROUTING object for application. State change allowed only when in the VALid state. Successful return leaves the object in the INValid state.

Limitations

None.

T_SERVER CLASS DEFINITION

Overview

The T_SERVER class represents configuration and runtime attributes of servers within an application. These attribute values identify and characterize configured servers as well as provide runtime tracking of statistics and resources associated with each server object.

Attribute Table

TM_MIB(5): T_SERVER Class Definition Attribute Table
Attribute	Type	Permissions	Values	Default
TA_SRVGRP( r )( * )	string	ru-r--r--	string[1...30]	N/A
TA_SRVID( r )( * )	long	ru-r--r--	1 <= num < 30,001	N/A
TA_SERVERNAME( k )( r )	string	rw-r--r--	string[1...78]	N/A
TA_GRPNO( k )	long	r--r--r--	1 <= num < 30,000	N/A
TA_STATE( k )	string	rwxr-xr--	GET:"{ACT|INA|MIG|CLE|RES| SUS|PAR|DEA}"	N/A
			SET:"{NEW|INV |ACT|INA|DEA}"	N/A
TA_BASESRVID	long	r--r--r--	1 <= num < 30,001	N/A
TA_CLOPT	string	rwyr--r--	string[0...256]	"-A"
TA_ENVFILE	string	rwyr--r--	string[0...78]	""
TA_GRACE	long	rwyr--r--	0 <= num	86,400
TA_MAXGEN	long	rwyr--r--	1 <= num < 256	1
TA_MAX	long	rwxr--r--	1 <= num < 1,001	1
TA_MIN	long	rwyr--r--	1 <= num < 1,001	1
TA_RCMD	string	rwyr--r--	string[0...78]	""
TA_RESTART	string	rwyr--r--	"{Y|N}"	N
TA_SEQUENCE( k )	long	rwxr--r--	1 <= num < 10,000	>= 10,000
TA_SYSTEM_ACCESS	string	rwyr--r--	"{FASTPATH|PROTECTED}"	(Note 1)
TA_CONV( k )	string	rw-r--r--	"{Y|N}"	N
TA_REPLYQ	string	rw-r--r--	"{Y|N}"	N
TA_RPPERM	long	rw-r--r--	0001 <= num <= 0777	(Note 1)
TA_RQADDR( k )	string	rw-r--r--	string[0...30]	"GRPNO.SRVID"
TA_RQPERM	long	rw-r--r--	0001 <= num <= 0777	(Note 1)
TA_LMID( k )	string	R--R--R--	LMID	N/A
TA_GENERATION	long	R--R--R--	1 <= num < 32K	N/A
TA_PID( k )	long	R--R--R--	1 <= num	N/A
TA_RPID	long	R--R--R--	1 <= num	N/A
TA_RQID	long	R--R--R--	1 <= num	N/A
TA_TIMERESTART	long	R--R--R--	1 <= num	N/A
TA_TIMESTART	long	R--R--R--	1 <= num	N/A
T_SERVER Class: LOCAL Attributes
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

TM_MIB(5): T_SERVER Class Definition Attribute Table
Attribute	Type	Permissions	Values	Default
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_TOTREQC	long	R-XR-XR--	0 <= num	N/A
TA_TOTWORKL	long	R-XR-XR--	0 <= num	N/A
TA_CLTLMID	string	R--R--R--	LMID	N/A
TA_CLTPID	long	R--R--R--	1 <= num	N/A
TA_CLTREPLY	string	R--R--R--	"{Y|N}"	N/A
TA_CMTRET	string	R--R--R--	"{COMPLETE|LOGGED}"	N/A
TA_CURCONV	long	R--R--R--	0 <= num	N/A
TA_CURREQ	long	R--R--R--	0 <= num	N/A
TA_CURRSERVICE	string	R--R--R--	string[0...15]	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_SVCTIMEOUT	long	R--R--R--	0 <= num	N/A
TA_TIMELEFT	long	R--R--R--	0 <= num	N/A
TA_TRANLEV	long	R--R--R--	0 <= num	N/A

( k ) - GET key field

( r ) - Required field for object creation (SET TA_STATE NEW)

( * ) - GET/SET key, one or more required for SET operations

Note 1.

Defaults to value set for this attribute in Class T_DOMAIN

Attribute Semantics

TA_SRVGRP: string[1...30]

Logical name of the server group. Server group names cannot contain an asterisk (*), comma, or colon.

TA_SRVID: 1 <= num < 30,001

Unique (within the server group) server identification number.

TA_SERVERNAME: string[1...78]

Name of the server executable file. The server identified by TA_SERVERNAME will run on the machine(s) identified by the T_GROUP:TA_LMID attribute for this server's server group. If a relative pathname is given, then the search for the executable file is done first in TA_APPDIR, then in TA_TUXDIR/bin, then in /bin and /usr/bin, and then in &ltpath>, where &ltpath> is the value of the first PATH= line appearing in the machine environment file, if one exists. Note that the attribute value returned for an active server will always be a full pathname. The values for TA_APPDIR and TA_TUXDIR are taken from the appropriate T_MACHINE object. See discussion of the T_MACHINE:TA_ENVFILE attribute for a more detailed discussion of how environment variables are handled.

TA_GRPNO: 1 <= num < 30,000

Group number associated with this server's group.

TA_STATE:

GET: {ACTive|INActive|MIGrating|CLEaning|REStarting|SUSpended|PARtitioned|DEAd}

A GET operation will retrieve configuration and runtime information for the selected T_SERVER object(s). The following states indicate the meaning of a TA_STATE returned in response to a GET request. States not listed will not be returned.

ACTive

T_SERVER object defined and active. This is not an indication of whether the server is idle or busy. An active server with a non 0-length TA_CURRSERVICE attribute should be interpreted as a busy server, that is, one that is processing a service request.

INActive

T_SERVER object defined and inactive.

MIGrating

T_SERVER object defined and currently in a state of migration to the server group's secondary logical machine. The secondary logical machine is the one listed in T_GROUP:TA_LMID attribute that does not match the T_GROUP:TA_CURLMID attribute. This state is ACTive equivalent for the purpose of determining permissions.

CLEaning

T_SERVER object defined and currently being cleaned up after by the system due to an abnormal death. Note that restartable servers may enter this state if they exceed TA_MAXGEN starts/restarts within their TA_GRACE period. This state is ACTive equivalent for the purpose of determining permissions.

REStarting

T_SERVER object defined and currently being restarted by the system due to an abnormal death. This state is ACTive equivalent for the purpose of determining permissions.

SUSpended

T_SERVER object defined and currently suspended pending shutdown. This state is ACTive equivalent for the purpose of determining permissions.

PARtitioned

T_SERVER object defined and active; however, the machine where the server is running is currently partitioned from the T_DOMAIN:TA_MASTER site. This state is ACTive equivalent for the purpose of determining permissions.

DEAd

T_SERVER object defined, 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 server notices the death and takes action (REStarting|CLEaning). Note that this state will only be returned if the MIB_LOCAL TA_FLAGS value is specified and the machine where the server was running is reachable. This state is ACTive equivalent for the purpose of determining permissions.

SET: {NEW|INValid|ACTive|INActive|DEAd}

A SET operation will update configuration and runtime information for the selected T_SERVER object. The following states indicate the meaning of a TA_STATE set in a SET request. States not listed may not be set.

NEW

Create T_SERVER object for application. State change allowed only when in the INValid state. Successful return leaves the object in the INActive state.

unset

Modify an existing T_SERVER object. This combination is allowed only when in the ACTive or INActive state. Successful return leaves the object state unchanged.

INValid

Delete T_SERVER object for application. State change allowed only when in the INActive state. Successful return leaves the object in the INValid state.

ACTive

Activate the T_SERVER object. State change allowed only when in the INActive state. (Servers in the MIGrating state must be restarted by setting the T_GROUP:TA_STATE to ACTive.) 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 ACTive state. The TMIB_NOTIFY TA_FLAG value should be used when activating a server if status on the individual server is required.

INActive

Deactivate the T_SERVER object. State change allowed only when in the ACTive state. Successful return leaves the object in the INActive state. The TMIB_NOTIFY TA_FLAG value should be used when deactivating a server if status on the individual server is required.

DEAd

Deactivate the T_SERVER object by sending the server a SIGTERM signal followed by a SIGKILL signal if the server is still running after the appropriate timeout interval (see TA_MIBTIMEOUT in MIB(5)). Note that by default, a SIGTERM signal will cause the server to initiate orderly shutdown and the server will become inactive even if it is restartable. If a server is processing a long running service or has chosen to disable the SIGTERM signal, then SIGKILL may be used and will be treated by the system as an abnormal termination. State change allowed only when in the ACTive or SUSpended state. Successful return leaves the object in the INActive, CLEaning or REStarting state.

TA_BASESRVID: 1 <= num < 30,001

Base server identifier. For servers with a TA_MAX attribute value of 1, this attribute will always be the same as TA_SRVID. However, for servers with a TA_MAX value of greater than 1, this attribute indicates the base server identifier for the set of servers configured identically.

TA_CLOPT: string[0...256]

Command line options to be passed to server when it is activated. See the servopts(5) manual page for details.

Limitation: Runtime modifications to this attribute will not affect a running server.

TA_ENVFILE: string[0...78]

Server specific environment file. See T_MACHINE:TA_ENVFILE for a complete discussion of how this file is used to modify the environment.

Limitation: Runtime modifications to this attribute will not affect a running server.

TA_GRACE: 0 <= num

The period of time, in seconds, over which the T_SERVER:TA_MAXGEN limit applies. This attribute is meaningful only for restartable servers, that is, if the T_SERVER:TA_RESTART attribute is set to "Y". When a restarting server would exceed the TA_MAXGEN limit but the TA_GRACE period has expired, the system resets the current generation (T_SERVER:TA_GENERATION) to 1 and resets the initial boot time (T_SERVER:TA_TIMESTART) to the current time. A value of 0 for this attribute indicates that a server should always be restarted. Note that servers sharing a request queue (that is, equal values for T_SERVER:TA_RQADDR) should have equal values for this attribute. If they do not, then the first server activated will establish the runtime value associated with all servers on the queue.

Limitation: Runtime modifications to this attribute will affect a running server and all other active servers with which it is sharing a request queue. However, only the selected server's configuration parameter is modified. Thus, the behavior of the application depends on the order of boot in subsequent activations unless the administrator ensures that all servers sharing a queue have the same value for this attribute.

TA_MAXGEN: 1 <= num 256

Number of generations allowed for a restartable server (T_SERVER:TA_RESTART == "Y") over the specified grace period (T_SERVER:TA_GRACE). The initial activation of the server counts as one generation and each restart also counts as one. Processing after the maximum generations is exceeded is discussed above with respect to TA_GRACE. Note that servers sharing a request queue (that is, equal values for T_SERVER:TA_RQADDR) should have equal values for this attribute. If they do not, then the first server activated will establish the runtime value associated with all servers on the queue.

Limitation: Runtime modifications to this attribute will affect a running server and all other active servers with which it is sharing a request queue. However, only the selected server's configuration parameter is modified. Thus, the behavior of the application depends on the order of boot in subsequent activations unless the administrator ensures that all servers sharing a queue have the same value for this attribute.

TA_MAX: 1 <= num < 1,001

Maximum number of occurrences of the server to be booted. Initially, tmboot(1) boots T_SERVER:TA_MIN objects of the server, and additional objects may be started individually (by starting a particular server id) or through automatic spawning (conversational servers only). Runtime modifications to this attribute will affect all running servers in the set of identically configured servers (see TA_BASESRVID above) as well as the configuration definition of the server.

TA_MIN: 1 <= num < 1,001

Minimum number of occurrences of the server to be booted by tmboot(1). If a T_SERVER:TA_RQADDR is specified and TA_MIN is greater than 1, then the servers will form an MSSQ set. The server identifiers for the servers will be T_SERVER:TA_SRVID up to TA_SRVID + T_SERVER:TA_MAX - 1. All occurrences of the server will have the same sequence number, as well as any other server parameters.

Limitation: Runtime modifications to this attribute will not affect a running server.

TA_RCMD: string[0...78]

Application specified command to be executed in parallel with the system restart of an application server. This command must be an executable UNIX System file. Note that servers sharing a request queue (that is, equal values for T_SERVER:TA_RQADDR) should have equal values for this attribute. If they do not, then the first server activated will establish the runtime value associated with all servers on the queue.

Limitation: Runtime modifications to this attribute will affect a running server and all other active servers with which it is sharing a request queue. However, only the selected server's configuration parameter is modified. Thus, the behavior of the application depends on the order of boot in subsequent activations unless the administrator ensures that all servers sharing a queue have the same value for this attribute.

TA_RESTART: {Y|N}

Restartable ("Y") or non-restartable ("N") server. If server migration is specified for this server group (T_DOMAIN:TA_OPTIONS/MIGRATE and T_GROUP:TA_LMID with alternate site), then this attribute must be set to "Y". Note that servers sharing a request queue (that is, equal values for T_SERVER:TA_RQADDR) should have equal values for this attribute. If they do not, then the first server activated will establish the runtime value associated with all servers on the queue.

Limitation: Runtime modifications to this attribute will affect a running server and all other active servers with which it is sharing a request queue. However, only the selected server's configuration parameter is modified. Thus, the behavior of the application depends on the order of boot in subsequent activations unless the administrator ensures that all servers sharing a queue have the same value for this attribute.

TA_SEQUENCE: 1 <= num < 10,000

Specifies when this server should be booted ( tmboot(1)) or shutdown ( tmshutdown(1)) relative to other servers. If two servers are given the same sequence number, it is possible for tmboot(1) to boot them in parallel and for tmshutdown(1) to shut them down in parallel. T_SERVER objects added without a TA_SEQUENCE attribute specified or with an invalid value will have one generated for them that is 10,000 or more and is higher than any other automatically selected default value. Servers are booted by tmboot(1) in increasing order of sequence number and shutdown by tmshutdown(1) in decreasing order. Runtime modifications to this attribute affect only tmboot(1) and tmshutdown(1) and will affect the order in which running servers may be shutdown by a subsequent invocation of tmshutdown(1).

TA_SYSTEM_ACCESS: {FASTPATH|PROTECTED}

Mode used by System/T libraries within this server process to gain access to System/T's internal tables. See T_DOMAIN:TA_SYSTEM_ACCESS for a complete discussion of this attribute.

Limitation: Runtime modifications to this attribute will not affect a running server.

TA_CONV: {Y|N}

Conversational server ("Y") or request/response server ("N").

TA_REPLYQ: {Y|N}

Allocate a separate reply queue for the server (TA_REPLYQ == "Y"). MSSQ servers that expect to receive replies should set this attribute to "Y".

TA_RPPERM: 0001 <= num <= 0777

UNIX System permissions for the server's reply queue. If a separate reply queue is not allocated (T_SERVER:TA_REPLYQ == "N"), then this attribute is ignored.

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_RQADDR: string[0...30]

Symbolic address of the request queue for the server. Specifying the same TA_RQADDR attribute value for more than one server is the way multiple server, single queue (MSSQ) sets are defined. Servers with the same TA_RQADDR attribute value must be in the same server group.

TA_RQPERM: 0001 <= num <= 0777

UNIX System permissions for the server's request 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_LMID: LMID

Current logical machine on which the server is running.

TA_GENERATION: 1 <= num < 32K

Generation of the server. When a server is initially booted via tmboot(1) or activated through the TM_MIB(5), its generation is set to 1. Each time the server dies abnormally and is restarted, its generation is incremented. Note that when T_SERVER:TA_MAXGEN is exceeded and T_SERVER:TA_GRACE has expired, the server will be restarted with the generation reset to 1.

TA_PID: 1 <= num

UNIX System process identifier for the server. Note that this may not be a unique attribute since servers may be located on different machines allowing for duplication of process identifiers.

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_RPID: 1 <= num

UNIX System message queue identifier for the server's reply queue. If a separate reply queue is not allocated (T_SERVER:TA_REPLYQ == "N"), then this attribute value will be the same as T_SERVER:TA_RQID.

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_RQID: 1 <= num

UNIX System message queue identifier for the server's request queue. If a separate reply queue is not allocated (T_SERVER:TA_REPLYQ == "N"), then this attribute value will be the same as T_SERVER:TA_RPID.

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_TIMERESTART: 1 <= num

Time, in seconds, since 00:00:00 UTC, January 1, 1970, as returned by the time(2) system call on T_SERVER:TA_LMID, when the server was last started or restarted.

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_SERVER:TA_LMID, when the server was first started. Restarts of the server do not reset this value; however, if T_SERVER:TA_MAXGEN is exceeded and T_SERVER:TA_GRACE is expired, this attribute will be reset to the time of the restart.

TA_NUMCONV: 0 <= num

Number of conversations initiated by this server via tpconnect(3c).

TA_NUMDEQUEUE: 0 <= num

Number of dequeue operations initiated by this server via tpdequeue(3c).

TA_NUMENQUEUE: 0 <= num

Number of enqueue operations initiated by this server via tpenqueue(3c).

TA_NUMPOST: 0 <= num

Number of postings initiated by this server via tppost(3c).

TA_NUMREQ: 0 <= num

Number of requests made by this server via tpcall(3c) or tpacall(3c).

TA_NUMSUBSCRIBE: 0 <= num

Number of subscriptions made by this server via tpsubscribe(3c).

TA_NUMTRAN: 0 <= num

Number of transactions begun by this server since its last (re)start.

TA_NUMTRANABT: 0 <= num

Number of transactions aborted by this server since its last (re)start.

TA_NUMTRANCMT: 0 <= num

Number of transactions committed by this server since its last (re)start.

TA_TOTREQC: 0 <= num

Total number of requests completed by this server. For conversational servers (T_SERVER:TA_CONV == "Y"), this attribute value indicates the number of completed incoming conversations. This is a runtime attribute that is kept across server restart but is lost at server shutdown.

TA_TOTWORKL: 0 <= num

Total workload completed by this server. For conversational servers (T_SERVER:TA_CONV == "Y"), this attribute value indicates the workload of completed incoming conversations. This is a runtime attribute that is kept across server restart but is lost at server shutdown.

TA_CLTLMID: LMID

Logical machine for the initiating client or server. The initiating client or server is the process that made the service request that the server is currently working on.

TA_CLTPID: 1 <= num

UNIX System process identifier for the initiating client or server.

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_CLTREPLY: {Y|N}

The initiating client or server is expecting a reply ("Y") or is not expecting a reply ("N").

TA_CMTRET: {COMPLETE|LOGGED}

Setting of the TP_COMMIT_CONTROL characteristic for this server. See the description of the System/T ATMI function tpscmt(3) for details on this characteristic.

TA_CURCONV: 0 <= num

Number of conversations initiated by this server via tpconnect(3c) that are still active.

TA_CURREQ: 0 <= num

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

TA_CURRSERVICE: string[0...15]

Service name that the server is currently working on, if any.

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_SERVER:TA_LMID. This attribute can be used to compute elapsed time from the T_SERVER:TA_TIMESTART and T_SERVER:TA_TIMERESTART attribute values.

TA_LASTGRP: 1 <= num < 30,000

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

TA_SVCTIMEOUT: 0 <= num

Time left, in seconds, for this server to process the current service request, if any. A value of 0 for an active service indicates that no timeout processing is being done. See T_SERVICE:TA_SVCTIMEOUT for more information.

TA_TIMELEFT: 0 <= num

Time left, in seconds, for this server 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_TRANLEV: 0 <= num

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

Limitations

None.

T_SERVICE CLASS DEFINITION

Overview

The T_SERVICE class represents configuration attributes of services within an application. These attribute values identify and characterize configured services. A T_SERVICE object provides activation time configuration attributes for services not specifically configured as part of the T_SVCGRP class. Runtime information about services active in the application is provided solely through the T_SVCGRP class. Runtime updates to the T_SERVICE class are usually not reflected in active T_SVCGRP objects (TA_ROUTINGNAME is the exception). Both the T_SERVICE class and the T_SVCGRP class define activation time attribute settings for service names within the application. When a new service is activated (advertised), either due to initial activation of a server or due to a call to tpadvertise(3c), the following hierarchy exists for determining the attribute values to be used at service startup time.

1.

If a matching configured T_SVCGRP object exists (matching service name and server group), then the attributes defined in that object are used to initially configure the advertised service.

2.

Otherwise, if a matching configured T_SERVICE object exists (matching service name), then the attributes defined in that object are used to initially configure the advertised service.

3.

Otherwise, if any configured T_SVCGRP objects are found with matching TA_SERVICENAME attribute values, then the first one found is used to initially configure the advertised service.

4.

If none of the preceding cases is used, then the system defaults for service attributes are used to initially configure the advertised service.

The specification of configuration attributes for application services is completely optional, that is, services advertised by servers as they are activated will take on the established default service attribute values if configured values are not available (see above for description of how attribute values are identified at service activation time). Service names to be offered by a server are built in at runtime (see buildserver(1)) and may be overridden by the command line options specified for a server object (see T_SERVER:TA_CLOPT and servopts(5)).

Attribute Table

TM_MIB(5): T_SERVICE Class Definition Attribute Table
Attribute	Type	Permissions	Values	Default
TA_SERVICENAME ( r )( * )	string	ru-r--r--	string[1...15]	N/A
TA_STATE( k )	string	rw-r--r--	GET:"{ACT|INA}"	N/A
			SET:"{NEW|INV}"	N/A
TA_AUTOTRAN	string	rwyr--r--	"{Y|N}"	"N"
TA_LOAD	long	rwyr--r--	1 <= num < 32K	50
TA_PRIO	long	rwyr--r--	1 <= num < 101	50
TA_SVCTIMEOUT	long	rwyr--r--	0 <= num	0
TA_TRANTIME	long	rwyr--r--	0 <= num	30
TA_BUFTYPE	string	rw-r--r--	string[1...256]	"ALL"
TA_ROUTINGNAME	string	rwxr--r--	string[0...15]	""

( k ) - GET key field

( r ) - Required field for object creation (SET TA_STATE NEW)

( * ) - GET/SET key, one or more required for SET operations

Attribute Semantics

TA_SERVICENAME: string[1...15]

Service name.

TA_STATE:

GET: {ACTive|INActive}

A GET operation will retrieve configuration information for the selected T_SERVICE object(s). The following states indicate the meaning of a TA_STATE returned in response to a GET request. States not listed will not be returned.

ACTive

T_SERVICE object is defined and at least one T_SVCGRP object with a matching TA_SERVICENAME value is active.

INActive

T_SERVICE object is defined and no T_SVCGRP object with a matching TA_SERVICENAME value is active.

SET: {NEW|INValid}

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

NEW

Create T_SERVICE object for application. State change allowed only when in the INValid state. Successful return leaves the object in the INActive state.

Limitation: Unconfigured services may still be active by virtue of a server advertising them. In this case, the creation of a new T_SERVICE object is not allowed.

unset

Modify an existing T_SERVICE object. This combination is not allowed in the INValid state. Successful return leaves the object state unchanged.

INValid

Delete T_SERVICE object for application. State change allowed only when in the INActive state. Successful return leaves the object in the INValid state.

TA_AUTOTRAN: {Y|N}

Automatically begin a transaction ("Y") when a service request message is received for this service if the request is not already in transaction mode.

Limitation: Runtime updates to this attribute are not reflected in active T_SVCGRP objects.

TA_LOAD: 1 <= num < 32K

This T_SERVICE object imposes the indicated load on the system. Service loads are used for load balancing purposes, that is, queues with higher enqueued workloads are less likely to be chosen for a new request. Service loads have meaning only if the T_DOMAIN:TA_LDBAL is set to "Y".

Limitation: Runtime updates to this attribute are not reflected in active T_SVCGRP objects.

TA_PRIO: 1 <= num < 101

This T_SERVICE object has the indicated dequeuing priority. If multiple service requests are waiting on a queue for servicing, the higher priority requests will be serviced first.

Limitation: Runtime updates to this attribute are not reflected in active T_SVCGRP objects.

TA_SVCTIMEOUT: 0 <= num

Time limit (in seconds) for processing requests for this service name. Servers processing service requests for this service will be abortively terminated (kill -9) if they exceed the specified time limit in processing the request. A value of 0 for this attribute indicates that the service should not be abortively terminated.

Limitation: Runtime updates to this attribute are not reflected in active T_SVCGRP objects.

Limitation: This attribute value is not enforced on TUXEDO System/T Release 4.2.2 sites or earlier.

TA_TRANTIME: 0 <= num

Transaction timeout value in seconds for transactions automatically started for this T_SERVICE object. Transactions are started automatically when a request not in transaction mode is received and the T_SERVICE:TA_AUTOTRAN attribute value for the service is "Y".

Limitation: Runtime updates to this attribute are not reflected in active T_SVCGRP objects.

TA_BUFTYPE: type1[:subtype1[,subtype2 . . . ]][;type2[:subtype3[, . . . ]]] . . .

List of types and subtypes of data buffers accepted by this service. A maximum of 32 type/subtype combinations are allowed. Types of data buffers provided with TUXEDO System/T are FML (for FML buffers), VIEW, X_C_TYPE, or X_COMMON (for FMLviews), STRING (for NULL terminated character arrays), and CARRAY or X_OCTET (for a character array that is neither encoded nor decoded during transmission). Of these types, only VIEW, X_C_TYPE, and X_COMMON have subtypes. A VIEW subtype gives the name of the particular VIEW expected by the service. Application types and subtypes can also be added (see tuxtypes(5)). For a buffer type that has subtypes, ``*'' can be specified for the subtype to indicate that the service accepts all subtypes for the associated buffer type.

A single service can only interpret a fixed number of buffer types, namely those found in its buffer type switch (see tuxtypes(5)). If the TA_BUFTYPE attribute value is set to ALL, that service will accept all buffer types found in its buffer type switch.

A type name can be 8 characters or less in length and a subtype name can be 16 characters or less in length. Note that type and subtype names should not contain semicolon, colon, comma, or asterisk characters.

Limitation: This attribute value represents the buffer types that must be supported by each and every instance of an application service with this service name. Since this attribute value is processed at service activation time, updates to this attribute are allowed only when there are no active T_SVCGRP objects with matching service names.

TA_ROUTINGNAME: string[0...15]

This T_SERVICE object has the indicated routing criteria name. Active updates to this attribute will be reflected in all associated T_SVCGRP objects.

Limitations

None.

T_SVCGRP CLASS DEFINITION

Overview

The T_SVCGRP class represents configuration and runtime attributes of services/groups within an application. These attribute values identify and characterize configured services/groups as well as provide runtime tracking of statistics and resources associated with each object. Both the T_SERVICE class and the T_SVCGRP class define activation time attribute settings for service names within the application. When a new service is activated (advertised), either due to initial activation of a server or due to a call to tpadvertise(3c), the following hierarchy exists for determining the attribute values to be used at service startup time.

1.

If a matching configured T_SVCGRP object exists (matching service name and server group), then the attributes defined in that object are used to initially configure the advertised service.

2.

Otherwise, if a matching configured T_SERVICE object exists (matching service name), then the attributes defined in that object are used to initially configure the advertised service.

3.

Otherwise, if any configured T_SVCGRP objects are found with matching TA_SERVICENAME attribute values, then the first one found is used to initially configure the advertised service.

4.

If none of the preceding cases is used, then the system defaults for service attributes are used to initially configure the advertised service.

The specification of configuration attributes for application services is completely optional, that is, services advertised by servers as they are activated will take on the established default service attribute values if configured values are not available (see above for description of how attribute values are identified at service activation time). Service names to be offered by a server are built in at runtime (see buildserver(1)) and may be overridden by the command line options specified for a server object (see T_SERVER:TA_CLOPT and servopts(5)). Once a T_SVCGRP object is active, it is represented solely by the T_SVCGRP class. A particular service name/group name combination may have more than one associated T_SVCGRP class at runtime if there are multiple servers within the group offering the service.

Attribute Table

TM_MIB(5): T_SVCGRP Class Definition Attribute Table
Attribute	Type	Permissions	Values	Default
TA_SERVICENAME ( r )( * )	string	ru-r--r--	string[1...15]	N/A
TA_SRVGRP( r )( * )	string	ru-r--r--	string[1...30]	N/A
TA_GRPNO( k )	long	r--r--r--	1 <= num < 30,000	N/A
TA_STATE( k )	string	rwxr-xr--	GET:"{ACT|INA |SUS|PAR}"	N/A
			SET:"{NEW|INV |ACT|INA|SUS}"	N/A
TA_AUTOTRAN	string	rwxr-xr--	"{Y|N}"	"N"
TA_LOAD	long	rwxr-xr--	1 <= num < 32K	50
TA_PRIO	long	rwxr-xr--	1 <= num < 101	50
TA_SVCTIMEOUT	long	rwyr-yr--	0 <= num	0
TA_TRANTIME	long	rwxr-xr--	0 <= num	30
TA_LMID( k )	string	R--R--R--	LMID	N/A
TA_RQADDR( * )	string	R--R--R--	string[1...30]	N/A
TA_SRVID( * )	long	R--R--R--	1 <= num < 30,001	N/A
TA_SVCRNAM	string	R-XR-XR--	string[1...15]	(Note 2)
TA_BUFTYPE	string	r--r--r--	string[1...256]	N/A
TA_ROUTINGNAME	string	r--r--r--	string[0...15]	N/A
TA_SVCTYPE( k )	string	r--r--r--	"{APP|CALLABLE|SYSTEM}"	"APP"
T_SVCGRP Class: LOCAL Attributes
TA_NCOMPLETED	long	R-XR-XR--	0 <= num	N/A
TA_NQUEUED	long	R--R--R--	0 <= num < 32K	N/A

( k ) - GET key field

( r ) - Required field for object creation (SET TA_STATE NEW)

( * ) - GET/SET key, one or more required for SET operations (see Note 1)

Note 1.

SET operations on this class must specify sufficient key fields to uniquely identify the object being addressed. If the object is active, then it may be necessary to augment the TA_SERVICENAME and TA_SRVGRP key fields with either TA_RQADDR or TA_SRVID. Modifications to an active object will affect that object and the related configuration record but not other active objects that may have derived their runtime attributes from the same configuration record.

Note 2.

If nothing is specified for this attribute, it defaults to TA_SERVICENAME.

Attribute Semantics

TA_SERVICENAME: string[1...15]

Service name.

TA_SRVGRP: string[1...30]

Server group name. Server group names cannot contain an asterisk (*), comma, or colon. The hierarchy of the search for service attributes to be used at service activation time is described above in the T_SVCGRP Overview section.

TA_GRPNO: 1 <= num < 30,000

Server group number.

TA_STATE:

GET: {ACTive|INActive|SUSpended|PARtitioned}

A GET operation will retrieve configuration and runtime information for the selected T_SVCGRP object(s). The following states indicate the meaning of a TA_STATE returned in response to a GET request. States not listed will not be returned.

ACTive

T_SVCGRP object is active within the server identified by the returned values for the TA_SRVGRP and TA_SRVID attributes. Attribute values returned indicate the current runtime instance of the service and may not be reflected in the configuration instance if temporary updates have been performed.

INActive

T_SVCGRP object is defined and inactive.

SUSpended

T_SVCGRP object defined, active, and currently suspended. This service is not available for access by the application in this state. This state is ACTive equivalent for the purpose of determining permissions.

PARtitioned

T_SVCGRP object defined, active, and currently partitioned from the master site of the application. This service is not available for access by the application in this state. This state is ACTive equivalent for the purpose of determining permissions.

SET: {NEW|INValid|ACTive|INActive|SUSpended}

A SET operation will update configuration and runtime information for the selected T_SVCGRP object. Note that runtime modifications to a service object may affect more than one active server. The following states indicate the meaning of a TA_STATE set in a SET request. States not listed may not be set.

NEW

Create T_SVCGRP object for application. State change allowed only when in the INValid state. Successful return leaves the object in the INActive state.

Limitation: Unconfigured services may still be active by virtue of a server advertising them. In this case, the service class state is ACTive and cannot be updated.

unset

Modify an existing T_SVCGRP object. This combination is not allowed in the INValid state. Successful return leaves the object state unchanged.

INValid

Delete T_SVCGRP object for application. State change allowed only when in the INActive state. Successful return leaves the object in the INValid state.

ACTive

Activate (advertise) the T_SVCGRP object. State change allowed only when in the INActive, SUSpended or INValid states. Either TA_SRVID or TA_RQADDR must be specified with this state change. 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 ACTive state.

Limitation: State change not permitted for service names (TA_SERVICENAME) beginning with the reserved string ".".

INActive

Deactivate the T_SVCGRP object. State change allowed only when in the SUSpended state. Successful return leaves the object in either the INActive (configured entries) or INValid (unconfigured entries) state.

Limitation: State change not permitted for service names (TA_SERVICENAME) beginning with the reserved string "_".

SUSpended

Suspend the T_SVCGRP object. State change allowed only when in the ACTive state. Successful return leaves the object in the SUSpended state.

Limitation: State change not permitted for service names (TA_SERVICENAME) beginning with the reserved string "_".

TA_AUTOTRAN: {Y|N}

Automatically begin a transaction ("Y") when a service request message is received for this service if the request is not already in transaction mode.

TA_LOAD: 1 <= num < 32K

This T_SVCGRP object imposes the indicated load on the system. Service loads are used for load balancing purposes, that is, queues with higher enqueued workloads are less likely to be chosen for a new request.

TA_PRIO: 1 <= num < 101

This T_SVCGRP object has the indicated dequeuing priority. If multiple service requests are waiting on a queue for servicing, the higher priority requests will be serviced first.

TA_SVCTIMEOUT: 0 <= num

Time limit (in seconds) for processing requests for this service name. Servers processing service requests for this service will be abortively terminated (kill -9) if they exceed the specified time limit in processing the request. A value of 0 for this attribute indicates that the service should not be abortively terminated.

Limitation: This attribute value is not enforced on TUXEDO System/T Release 4.2.2 sites or earlier.

TA_TRANTIME: 0 <= num

Transaction timeout value in seconds for transactions automatically started for this T_SVCGRP object. Transactions are started automatically when a request not in transaction mode is received and the T_SVCGRP:TA_AUTOTRAN attribute value for the service is "Y".

TA_LMID: LMID

Current logical machine on which an active server offering this service is running.

TA_RQADDR: string[1...30]

Symbolic address of the request queue for an active server offering this service. See T_SERVER:TA_RQADDR for more information on this attribute.

TA_SRVID: 1 <= num < 30,001

Unique (within the server group) server identification number for an active server offering this service. See T_SERVER:TA_SRVID for more information on this attribute.

TA_SVCRNAM: string[1...15]

Function name within the associated server assigned to process requests for this service. On a SET request, the server must be able to map the function name to a function using its symbol table to successfully advertise the service. In some situations (for example, direct calls to tpadvertise(3c) by the server), the function name for an ACTive service object will not be known and the string "?" will be returned as the attribute value.

Limitation: This attribute may only be set along with a state change from INActive to ACTive.

TA_BUFTYPE: string[1...256]

Configured buffer types accepted by this service.

Limitation: This attribute is settable only via the corresponding T_SERVICE class object.

TA_ROUTINGNAME: string[0...15]

Routing criteria name.

Limitation: This attribute is settable only via the corresponding T_SERVICE class object.

Number of service requests completed with respect to the retrieved ACTive or SUSpended object since it was activated (advertised).

Limitation: This attribute is returned only when the T_DOMAIN:TA_LDBAL attribute is set to "Y".

TA_SVCTYPE: {APP|CALLABLE|SYSTEM}

Type of service. APP indicates an application defined service name. CALLABLE indicates a system provided callable service. SYSTEM indicates a system provided and system callable service. SYSTEM services are not available to application clients and servers for direct access. Note that when used as a GET key field, a delimited list ('|' delimiter) may be used to retrieve multiple types of service group entries on one request. By default, only APP services are retrieved.

Number of requests currently enqueued to this service. This attribute is incremented at enqueue time and decremented when the server dequeues the request.

Limitation: This attribute is returned only when the T_DOMAIN:TA_MODEL attribute is set to SHM and the T_DOMAIN:TA_LDBAL attribute is set to "Y".

TA_NCOMPLETED: 0 <= num

Number of service requests completed with respect to the retrieved ACTive or SUSpended object since it was activated (advertised).

Limitation: This attribute is returned only when the T_DOMAIN:TA_LDBAL attribute is set to "Y".

TA_NQUEUED: 0 <= num < 32K

Number of requests currently enqueued to this service. This attribute is incremented at enqueue time and decremented when the server dequeues the request.

Limitation: This attribute is returned only when the T_DOMAIN:TA_MODEL attribute is set to SHM and the T_DOMAIN:TA_LDBAL attribute is set to "Y".

Limitations

None.

T_TLISTEN Class Definition

Overview

The T_TLISTEN class represents runtime attributes of /T listener processes for a distributed application.

Attribute Table

TM_MIB(5): T_TLISTEN Class Definition Attribute Table
Attribute	Type	Permissions	Values	Default
TA_LMID( k )	string	R--R--R--	LMID	N/A
TA_STATE( k )	string	R--R--R--	GET:"{ACT|INA}"	N/A
			SET:N/A	N/A

( k ) - GET key field

Attribute Semantics

TA_LMID: LMID

Logical machine identifier.

TA_STATE:

GET: {INActive|ACTive}

A GET operation will retrieve runtime information for the selected T_TLISTEN object(s). The following states indicate the meaning of a TA_STATE returned in response to a GET request. States not listed will not be returned.

INActive

T_TLISTEN object not active.

ACTive

T_TLISTEN object active.

SET:

SET operations are not permitted on this class. This attribute is settable only via the corresponding T_SERVICE class object.

Limitations

This class is not available through the tpadmcall(3c) interface.

T_TLOG CLASS DEFINITION

Overview

The T_TLOG class represents configuration and runtime attributes of transaction logs. This class allows the user to manipulate logs within an application, that is, create, destroy, migrate, etc.

Attribute Table

TM_MIB(5): T_TLOG Class Definition Attribute Table
Attribute (Note 1)	Type	Permissions	Values	Default
TA_LMID( * )	string	r--r--r--	LMID	N/A
TA_STATE( k )	string	r-xr-xr--	GET:"{ACT|INA|WAR}"	N/A
			SET:"{WAR}"	N/A
TA_TLOGCOUNT	long	r-xr-xr--	1 <= num	N/A
TA_TLOGINDEX	long	r-xr-xr--	0 <= num	N/A
TA_GRPNO( k )	long	r--r--r--	1 <= num < 30,000	Note 2
TA_TLOGDATA	string	r-xr-xr--	string[1...256]	Note 2

( k ) - GET key field

( * ) - GET/SET key, one or more required for SET operations

Note 1.

All attributes in Class T_TLOG are local attributes

One or more TA_GRPNO and TA_TLOGDATA attribute values may be returned with each object of the T_TLOG class. The attribute values for each of these attributes belonging to the particular object are the TA_TLOGCOUNT number of occurrences beginning with the TA_TLOGINDEX.

Attribute Semantics

TA_LMID: LMID

Transaction log logical machine identifier.

TA_STATE:

GET: {ACTive|INActive|WARmstart}

A GET operation will retrieve log configuration and runtime information for the selected T_TLOG object(s). The following states indicate the meaning of a TA_STATE returned in response to a GET request. States not listed will not be returned.

ACTive

The transaction log exists and is actively logging commit records for transactions coordinated on the site. This corresponds to the associated T_MACHINE object being active.

INActive

The transaction log exists but is currently inactive. This state corresponds to the associated T_MACHINE object being inactive and can only be returned if the site has a tlisten(1) process running; otherwise, the site is unreachable and a object will not be returned.

WARmstart

The transaction log exists, is currently active, and is marked for warmstart processing. Warmstart processing will occur when the next server group is started on the site. This state is ACTive equivalent for the purposes of determining permissions.

SET: {WARmstart}

A SET operation will update log configuration and runtime information for the selected T_TLOG 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 T_TLOG object. Allowed only when in the ACTive state. Successful return leaves the object state unchanged. The only object modifications permitted on this class are additions to the transaction log. In this case, TA_TLOGINDEX and TA_TLOGCOUNT indicate the objects of TA_TLOGDATA to be added.

WARmstart

Initiate warmstart for the T_TLOG object. State change allowed only when in the ACTive state. Successful return leaves the object in the WARmstart state.

TA_TLOGCOUNT: 1 <= num

Number of transaction log data records (TA_TLOGDATA) counted, retrieved, or to be added. This attribute is ignored for SET operations with a state change indicated. For valid SET operations with no state change, this attribute indicates the number of log records to be added to an active transaction log. A GET operation with neither TA_GRPNO nor TA_TLOGDATA specified returns a count of in use log records. A GET operation with only TA_GRPNO set will return a count of in use log records with a coordinator group matching the indicated group. A GET operation with only TA_TLOGDATA set ("") will return a count of in use log records and populate arrays of TA_TLOGDATA and TA_GRPNO attribute values corresponding to the in use log records. A GET operation with both TA_GRPNO and TA_TLOGDATA set ("") will return a count of in use log records with a coordinator group matching the indicated group and populate arrays of TA_TLOGDATA and TA_GRPNO attribute values corresponding to the in use log records.

TA_TLOGINDEX: 0 <= num

Index of the first object specific attribute values (TA_GRPNO and TA_TLOGDATA) corresponding to this object.

TA_GRPNO: 1 <= num < 30,000

Transaction coordinator's group number.

TA_TLOGDATA: string[1...256]

Formatted transaction log entry. This attribute value should not be interpreted directly. Rather, it should be used solely as a means of migrating log records as part of server group migration.

Limitations

Retrieval and update of information from/to INActive objects is not supported in TUXEDO System/T Release 5.0.

T_TRANSACTION CLASS DEFINITION

Overview

The T_TRANSACTION class represents runtime attributes of active transactions within the application.

Attribute Table

TM_MIB(5): T_TRANSACTION Class Definition Attribute Table
Attribute (Note 1)	Type	Permissions	Values	Default
TA_COORDLMID( k )	string	R--R--R--	LMID	N/A
TA_LMID( k )	string	R--R--R--	LMID	N/A
TA_TPTRANID( * )	string	R--R--R--	string[1...78]	N/A
TA_XID( * )	string	R--R--R--	string[1...78]	N/A
TA_STATE( k )	string	R-XR-XR--	GET:"{ACT|ABY|ABD|COM| REA|DEC|SUS}"	N/A
			SET:"{ABD}"	N/A
TA_TIMEOUT	long	R--R--R--	1 <= num	N/A
TA_GRPCOUNT	long	R--R--R--	1 <= num	N/A
TA_GRPINDEX	long	R--R--R--	0 <= num	N/A
TA_GRPNO	long	R--R--R--	1 <= num < 30,000	(Note 2)
TA_GSTATE	string	R-XR-XR--	GET:"{ACT|ABD|RDO|REA| HCO|HAB|DON}"	(Note 2)
			SET:"{HCO|HAB}"	N/A

( k ) - GET key field

( * ) - GET/SET key, one or more required for SET operations

Note 1.

All attributes in Class T_TRANSACTION are local attributes.

Note 2.

One or more TA_GRPNO and TA_GSTATE attribute values may be returned with each object of the T_TRANSACTION class. The attribute values for each of these attributes belonging to the particular object are the TA_GRPCOUNT number of occurrences beginning with the TA_GRPINDEX.

Attribute Semantics

TA_COORDLMID: LMID

Logical machine identifier of the server group responsible for coordinating the transaction.

TA_LMID: LMID

Retrieval machine logical machine identifier. Note that transaction attributes are primarily kept local to a site and coordinated via common transaction identifiers by transaction management servers (TMSs).

TA_TPTRANID: string[1...78]

Transaction identifier as returned from tpsuspend(3c) mapped to a string representation. The data in this field should not be interpreted directly by the user except for equality comparison.

TA_XID: string[1...78]

Transaction identifier as returned from tx_info(3c) mapped to a string representation. The data in this field should not be interpreted directly by the user except for equality comparison.

TA_STATE:

GET: {ACTive|ABortonlY|ABorteD|COMcalled|REAdy|DECided|SUSpended}

A GET operation will retrieve runtime information for the selected T_TRANSACTION object(s). The following states indicate the meaning of a TA_STATE returned in response to a GET request. States not listed will not be returned. Note that distinct objects pertaining to the same global transaction (equivalent transaction identifiers) may indicate differing states. In general, the state indicated on the coordinator's site (TA_COORDLMID) indicates the true state of the transaction. The exception is when a non-coordinator site notices a condition that transitions the transaction state to ABortonlY. This transition will eventually be propagated to the coordinator site and result in the rollback of the transaction, but this change may not be immediately reflected on the coordinator site. All states are ACTive equivalent for the purpose of determining permissions.

ACTive

The transaction is active.

ABortonlY

The transaction has been identified for rollback on the retrieval site.

ABorteD

The transaction has been identified for rollback and rollback has been initiated on the retrieval site.

COMcalled

The initiator of the transaction has called tpcommit(3c) and the first phase of two-phase commit has begun on the retrieval site.

REAdy

All of the participating groups on the retrieval site have successfully completed the first phase of two-phase commit and are ready to be committed.

DECided

The second phase of the two-phase commit has begun on the retrieval site.

SUSpended

The initiator of the transaction has suspended processing on the transaction. Note that this state will be returned from the initiator's site only.

SET: {ABorteD}

A SET operation will update runtime information for the selected T_TRANSACTION 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_TRANSACTION object. This combination is allowed only when in the REAdy state and only for the purpose of updating an individual group's state (see TA_GSTATE below). Successful return leaves the object state unchanged.

ABorteD

Abort the T_TRANSACTION object for the application. State change allowed only when in the ACTive, ABortonlY, or COMcalled states. May not be accompanied by a change to TA_GSTATE. Successful return leaves the object in the ABorteD state.

TA_TIMEOUT: 1 <= num

Time left, in seconds, before the transaction will timeout on the retrieval site. Note that this attribute value is returned only when the transaction state (TA_STATE) is ACTive.

TA_GRPCOUNT: 1 <= num

Number of groups identified as participants in the transaction by the information returned from the retrieval site.

TA_GRPINDEX: 1 <= num

Index of the first group specific attribute values (TA_GRPNO and TA_GSTATE) corresponding to this object.

TA_GRPNO: 1 <= num < 30,000

Group number of the participating group.

TA_GSTATE:

GET: {ACTive|ABorteD|ReaDOnly|REAdy|HCOmmit|HABort|DONe}

A GET operation will retrieve runtime information for the selected T_TRANSACTION object(s) pertaining to the indicated group. The following states indicate the meaning of a TA_GSTATE returned in response to a GET request. States not listed will not be returned. Note that distinct objects pertaining to the same global transaction (equivalent transaction identifiers) may indicate differing states for individual groups. In general, the state indicated on the group's site indicates the true state of the group's participation in the transaction. The exception is when the coordinator site determines that the transaction should abort and sets each participant group state to ABorteD. This transition will be propagated to the group's site and result in the rollback of the group's work in the transaction but may not be reflected immediately.

ACTive

The transaction is active in the indicated group.

ABorteD

The transaction has been identified for rollback and rollback has been initiated for the indicated group.

ReaDOnly

The group has successfully completed the first phase of two-phase commit and has performed only read operations on the resource manager, thus making it unnecessary to perform the second phase of commit for this group.

REAdy

The group has successfully completed the first phase of two-phase commit and is ready to be committed.

HCOmmit

The group has been heuristically committed. This may or may not agree with the final resolution of the transaction.

HABort

The group has been heuristically rolled back. This may or may not agree with the final resolution of the transaction.

DONe

This group has completed the second phase of the two-phase commit.

SET: {HCOmmit|HABort}

A SET operation will update runtime information for the first group in the originating request within the selected T_TRANSACTION object. The following states indicate the meaning of a TA_GSTATE set in a SET request. States not listed may not be set. State transitions are allowed only when performed within the object representing the group's site (TA_LMID).

HCOmmit

Heuristically commit the group's work as part of the indicated transaction. State change allowed only when TA_GSTATE is REAdy, TA_STATE is REAdy, and the indicated group is not on the coordinator's site. Successful return leaves the object in the HCOmmit state.

HABort

Heuristically rollback the group's work as part of the indicated transaction. State change allowed only when TA_GSTATE is ACTive or REAdy, TA_STATE is REAdy, and the indicated group is not on the coordinator's site. Successful return leaves the object in the HABort state.

Limitations

None.

T_ULOG CLASS DEFINITION

Overview

The T_ULOG class represents runtime attributes of userlog(3c) files within an application.

Attribute Table

TM_MIB(5): T_ULOG Class Definition Attribute Table
Attribute (Note 1)	Type	Permissions	Values	Default
TA_LMID( k )	string	R--R--R--	LMID	(Note 2)
TA_PMID( x )	string	R--R--R--	string[1...30]	(Note 2)
TA_MMDDYY( k )	long	R--R--R--	mmddyy	Current date
TA_STATE	string	R--R--R--	GET:"{ACT}"	N/A
			SET:N/A	N/A
TA_ULOGTIME( k )	long	R--R--R--	hhmmss	000000
TA_ENDTIME( k )	long	K--K--K--	hhmmss	235959
TA_ULOGLINE( k )	long	R--R--R--	1 <= num	1
TA_ULOGMSG( x )	string	R--R--R--	string[1...256]	N/A
TA_TPTRANID( k )	string	R--R--R--	string[1...78]	N/A
TA_XID( k )	string	R--R--R--	string[1...78]	N/A
TA_PID( k )	long	R--R--R--	1 <= num	N/A
TA_SEVERITY( x )	string	R--R--R--	string[1...30]	N/A
TA_ULOGCAT( x )	string	R--R--R--	string[1...30]	N/A
TA_ULOGMSGNUM( k )	long	R--R--R--	1 <= num	N/A
TA_ULOGPROCNM( x )	string	R--R--R--	string[1...30]	N/A

( k ) - GET key field

( x ) - Regular expression GET key field

Note 1.

All attributes in Class T_ULOG are local attributes.

Note 2.

TA_LMID is a required field used by the system to determine which application log file should be accessed. It is not used to restrict returned records to only those generated from processes running on the indicated machine. In cases where multiple machines share a log file via a networked file system, multiple TA_LMID values may be returned even though a specific value has been provided as a key field. For the same reasons, TA_PMID is not considered in directing the request to a particular machine, but is used in determining which records should be returned. In this capacity, it may be useful to leverage TA_PMID as a regular expression key field.

Attribute Semantics

TA_LMID: LMID

Retrieval machine logical machine identifier.

TA_PMID: string[1...30]

Physical machine identifier.

TA_MMDDYY: mmddyy

Date of userlog file found or to be accessed.

TA_STATE:

GET: {ACTive}

A GET operation will retrieve runtime information for the selected T_ULOG object(s). The following states indicate the meaning of a TA_STATE returned in response to a GET request. States not listed will not be returned.

ACTive

The object returned reflects an existing userlog file on the indicated logical machine.

SET:

SET operations are not permitted on this class.

TA_ULOGTIME: hhmmss

The time of the userlog message represented by this object. The value of this attribute is formed by multiplying the hour by 10,000, adding to that the minute multipled by 100, and finally adding in the seconds. When used as a key field, this attribute represents the start of the time range to be accessed for messages.

TA_ENDTIME: hhmmss

The latest time to be considered in a GET operation when accessing this userlog file.

TA_ULOGLINE: 1 <= num

The line number of the userlog message returned/requested within the userlog file. When used as a key field for retrieval, this value indicates the starting line within the log file.

TA_ULOGMSG: string[1...256]

The entire text of the userlog message as it appears in the userlog file.

TA_TPTRANID: string[1...78]

Transaction identifier as returned from tpsuspend(3c). The data in this field should not be interpreted directly by the user except for equality comparison. Messages not associated with transactions will retrieve a 0-length string as the value for this attribute.

TA_XID: string[1...78]

Transaction identifier as returned from tx_info(3c). The data in this field should not be interpreted directly by the user except for equality comparison. Messages not associated with transactions will retrieve a 0-length string as the value for this attribute.

TA_PID: 1 <= num

Process identifier of the client or server that generated the userlog message.

TA_SEVERITY: string[1...30]

Severity of message, if any.

TA_ULOGCAT: string[1...30]

Catalog name from which the message was derived, if any.

TA_ULOGMSGNUM: 1 <= num

Catalog message number, if the message was derived from a catalog.

TA_ULOGPROCNM: string[1...30]

Process name of the client or server that generated the userlog message.

Limitations

Retrievals may be done only if the associated T_MACHINE object is also ACTive. Retrievals for this class must be directed, that is, the TA_LMID attribute must be specified. Retrievals of log records written by workstation clients are available only if the log file used by the client is shared with one of the machines defined in the T_MACHINE class for the application. Otherwise, these log records are unavailable through this class. Retrievals on this class which cannot be completely satisfied will always return a TA_MORE value of 1 indicating only that more information may be available for the originating request.

DIAGNOSTICS

There are two general types of errors that may be returned to the user when interfacing with TM_MIB(5). First, any of the three ATMI verbs ( tpcall(3c), tpgetrply(3c), and tpdequeue(3c)) used to retrieve responses to administrative requests may return any error defined for them. These errors should be interpreted as described on the appropriate manual pages.

If, however, the request is successfully routed to a system service capable of satisfying the request and that service determines that there is a problem handling the request, then failure may be returned in the form of an application level service failure. In these cases, tpcall(3c) and tpgetrply(3c) will return an error with tperrno set to TPESVCFAIL and return a reply message containing the original request along with TA_ERROR, TA_STATUS, and TA_BADFLD fields further qualifying the error as described below. When a service failure occurs for a request forwarded to the system through the TMQFORWARD(5) server, the failure reply message will be enqueued to the failure queue identified on the original request (assuming the -d option was specified for TMQFORWARD).

When a service failure occurs during processing of an administrative request, the FML32 field TA_STATUS is set to a textual description of the failure, and the FML32 field TA_ERROR is set to indicate the cause of the failure as indicated below. All error codes specified below are guaranteed to be negative.

[other]

Other error return codes generic to any component MIB are specified in the MIB(5) manual page. These error codes are guaranteed to be mutually exclusive with any TM_MIB(5) specific error codes defined here.

The following diagnostic codes are returned in TA_ERROR to indicate successful completion of an administrative request. These codes are guaranteed to be non-negative.

[other]

Other return codes generic to any component MIB are specified in the MIB(5) manual page. These return codes are guaranteed to be mutually exclusive with any TM_MIB(5) specific return codes defined here.

INTEROPERABILITY

The header files and field tables defined in this manual page are available on TUXEDO System/T Release 5.0 and later. Fields defined in these headers and tables will not be changed from release to release. New fields may be added which are not defined on the older release site. Access to the /AdminAPI is available from any site with the header files and field tables necessary to build a request. If sites of differing releases, both greater than or equal to Release 5.0, are interoperating, then information on the older site is available for access and update as defined in the MIB manual page for that release and may be a subset of the information available in the later release.

PORTABILITY

The existing FML32 and ATMI functions necessary to support administrative interaction with TUXEDO System MIBs, as well as the header file and field table defined in this manual page, are available on all supported native and workstation platforms.

EXAMPLE

Following is a sequence of code fragments that configure, activate, query, and deactivate a two node application using both tpadmcall(3c) and tpcall(3c). Variable names are used in places where reasonable values for a local environment are required, for example, tuxconfig is a two element array of character pointers with each element identifying the full path name of the TUXCONFIG file on that machine.

Field Tables

The field table tpadm must be available in the environment to have access to attribute field identifiers. This can be done at the shell level as follows:

$ FIELDTBLS=tpadm
$ FLDTBLDIR=${TUXDIR}/udataobj
$ export FIELDTBLS FLDTBLDIR

#include &ltatmi.h>
#include &ltfml32.h>
#include &lttpadm.h>

/* Allocate and initialize the buffer */
ibuf = (FBFR32 *)tpalloc("FML32", NULL, 4000);
obuf = (FBFR32 *)tpalloc("FML32", NULL, 4000);
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_DOMAIN", 0);
Fchg32(ibuf, TA_STATE, 0, "NEW", 0);
/* Set TM_MIB(5) attributes to be set in T_DOMAIN class object */
Fchg32(ibuf, TA_OPTIONS, 0, "LAN,MIGRATE", 0);
Fchg32(ibuf, TA_IPCKEY, 0, (char *)&ampipckey, 0);
Fchg32(ibuf, TA_MASTER, 0, "LMID1", 0);
Fchg32(ibuf, TA_MODEL, 0, "MP", 0);
/* Set TM_MIB(5) attributes for TA_MASTER T_MACHINE class object */
Fchg32(ibuf, TA_LMID, 0, "LMID1", 0);
Fchg32(ibuf, TA_PMID, 0, pmid[0], 0);
Fchg32(ibuf, TA_TUXCONFIG, 0, tuxconfig[0], 0);
Fchg32(ibuf, TA_TUXDIR, 0, tuxdir[0], 0);
Fchg32(ibuf, TA_APPDIR, 0, appdir[0], 0);
Fchg32(ibuf, TA_ENVFILE, 0, envfile[0], 0);
Fchg32(ibuf, TA_ULOGPFX, 0, ulogpfx[0], 0);
Fchg32(ibuf, TA_BRIDGE, 0, "/dev/tcp", 0);
Fchg32(ibuf, TA_NADDR, 0, naddr[0], 0);
Fchg32(ibuf, TA_NLSADDR, 0, nlsaddr[0], 0);
/* Perform the action via tpadmcall() */
if (tpadmcall(ibuf, &ampobuf, 0) < 0) {
    fprintf(stderr, "tpadmcall failed: %s\n", tpstrerror(tperrno));
    /* Additional error case processing */
}

/* Clear the request buffer */
Finit32(ibuf, Fsizeof32(ibuf));
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_MACHINE", 0);
Fchg32(ibuf, TA_STATE, 0, "NEW", 0);
/* Set TM_MIB(5) attributes to be set in T_MACHINE class object */
Fchg32(ibuf, TA_LMID, 0, "LMID2", 0);
Fchg32(ibuf, TA_PMID, 0, pmid[1], 0);
Fchg32(ibuf, TA_TUXCONFIG, 0, tuxconfig[1], 0);
Fchg32(ibuf, TA_TUXDIR, 0, tuxdir[1], 0);
Fchg32(ibuf, TA_APPDIR, 0, appdir[1], 0);
Fchg32(ibuf, TA_ENVFILE, 0, envfile[1], 0);
Fchg32(ibuf, TA_ULOGPFX, 0, ulogpfx[1], 0);
Fchg32(ibuf, TA_BRIDGE, 0, "/dev/tcp", 0);
Fchg32(ibuf, TA_NADDR, 0, naddr[1], 0);
Fchg32(ibuf, TA_NLSADDR, 0, nlsaddr[1], 0);
tpadmcall(....); /* See earlier example for detailed error processing  */

/* Clear the request buffer */
Finit32(ibuf, Fsizeof32(ibuf));
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_DOMAIN", 0);
/* Set TM_MIB(5) T_DOMAIN attributes changing */
Fchg32(ibuf, TA_MASTER, 0, "LMID1,LMID2", 0);
tpadmcall(....); /* See earlier example for detailed error processing  */

/* Clear the request buffer */
Finit32(ibuf, Fsizeof32(ibuf));
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_GROUP", 0);
Fchg32(ibuf, TA_STATE, 0, "NEW", 0);
/* Set TM_MIB(5) attributes defining first group */
Fchg32(ibuf, TA_SRVGRP, 0, "GRP1", 0);
Fchg32(ibuf, TA_GRPNO, 0, (char *)&ampgrpno[0], 0);
Fchg32(ibuf, TA_LMID, 0, "LMID1,LMID2", 0);
tpadmcall(....); /* See earlier example for detailed error processing  */
/* Set TM_MIB(5) attributes defining second group */
Fchg32(ibuf, TA_SRVGRP, 0, "GRP2", 0);
Fchg32(ibuf, TA_GRPNO, 0, (char *)grpno[1], 0);
Fchg32(ibuf, TA_LMID, 0, "LMID2,LMID1", 0);
tpadmcall(....); /* See earlier example for detailed error processing  */

/* Clear the request buffer */
Finit32(ibuf, Fsizeof32(ibuf));
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_SERVER", 0);
Fchg32(ibuf, TA_STATE, 0, "NEW", 0);
/* Set TM_MIB(5) attributes defining first server */
Fchg32(ibuf, TA_SRVGRP, 0, "GRP1", 0);
Fchg32(ibuf, TA_SRVID, 0, (char *)&ampsrvid[0], 0);
Fchg32(ibuf, TA_SERVERNAME, 0, "ECHO", 0);
tpadmcall(....); /* See earlier example for detailed error processing  */
/* Set TM_MIB(5) attributes defining second server */
Fchg32(ibuf, TA_SRVGRP, 0, "GRP2", 0);
Fchg32(ibuf, TA_SRVID, 0, (char *)&ampsrvid[1], 0);
tpadmcall(....); /* See earlier example for detailed error processing  */

/* Clear the request buffer */
Finit32(ibuf, Fsizeof32(ibuf));
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_ROUTING", 0);
Fchg32(ibuf, TA_STATE, 0, "NEW", 0);
/* Set TM_MIB(5) attributes defining routing criteria */
Fchg32(ibuf, TA_ROUTINGNAME, 0, "ECHOROUTE", 0);
Fchg32(ibuf, TA_BUFTYPE, 0, "FML", 0);
Fchg32(ibuf, TA_FIELD, 0, "LONG_DATA", 0);
Fchg32(ibuf, TA_RANGES, 0, "MIN-100:GRP1,100-MAX:GRP2", 26);
tpadmcall(....); /* See earlier example for detailed error processing  */

/* Clear the request buffer */
Finit32(ibuf, Fsizeof32(ibuf));
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_SERVICE", 0);
Fchg32(ibuf, TA_STATE, 0, "NEW", 0);
/* Set TM_MIB(5) attributes defining service entry */
Fchg32(ibuf, TA_SERVICENAME, 0, "ECHO", 0);
Fchg32(ibuf, TA_ROUTINGNAME, 0, "ECHOROUTE", 0);
tpadmcall(....); /* See earlier example for detailed error processing  */

/* Clear the request buffer */
Finit32(ibuf, Fsizeof32(ibuf));
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_DOMAIN", 0);
Fchg32(ibuf, TA_STATE, 0, "ACT", 0);
tpadmcall(....); /* See earlier example for detailed error processing  */

/* Now that the system is active, join it as the administrator */
tpinfo = (TPINIT *)tpalloc("TPINIT", NULL, TPINITNEED(0));
sprintf(tpinfo->usrname, "appadmin");
sprintf(tpinfo->cltname, "tpsysadm");
if (tpinit(tpinfo) < 0) {
    fprintf(stderr, "tpinit() failed: %s\n", tpstrerror(tperrno));
    /* Additional error case processing */
}
/* Reinitialize buffers as typed buffers */
Finit32(ibuf, Fsizeof32(ibuf));
Finit32(obuf, Fsizeof32(obuf));

/* Clear the request buffer */
Finit32(ibuf, Fsizeof32(ibuf));
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_MACHINE", 0);
Fchg32(ibuf, TA_STATE, 0, "RAC", 0);
/* Set TM_MIB(5) attributes identifying machine */
Fchg32(ibuf, TA_LMID, 0, "LMID1", 0);
/* Invoke the /AdminAPI and interpret results */
if (tpcall(".TMIB", (char *)ibuf, 0, (char **)&ampobuf, &ampolen, 0) < 0) {
    fprintf(stderr, "tpcall failed: %s\n", tpstrerror(tperrno));
    if (tperrno == TPESVCFAIL) {
        Fget32(obuf,TA_ERROR,0,(char *)&ampta_error,NULL);
        ta_status = Ffind32(obuf, TA_STATUS, 0, NULL);
        fprintf(stderr, "Failure: %ld, %s\n",
            ta_error, ta_status);
    }
    /* Additional error case processing */
}

/* Clear the request buffer */
Finit32(ibuf, Fsizeof32(ibuf));
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "GET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_SERVER", 0);
flags = MIB_LOCAL;
Fchg32(ibuf, TA_FLAGS, 0, (char *)&ampflags, 0);
/* Set TM_MIB(5) attributes identifying machine */
Fchg32(ibuf, TA_SRVGRP, 0, "GRP1", 0);
Fchg32(ibuf, TA_SRVID, 0, (char *)&ampsrvid[0], 0);
tpcall(....); /* See earlier example for detailed error processing  */

/* Clear the request buffer */
Finit32(ibuf, Fsizeof32(ibuf));
/* Shutdown Remote Machine First */
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_MACHINE", 0);
Fchg32(ibuf, TA_LMID, 0, "LMID2", 0);
Fchg32(ibuf, TA_STATE, 0, "INA", 0);
tpcall(....); /* See earlier example for detailed error processing  */
/* And now application servers on master machine */
flags = TMIB_APPONLY;
Fchg32(ibuf, TA_FLAGS, 0, (char *)&ampflags, 0);
Fchg32(ibuf, TA_LMID, 0, "LMID1", 0);
tpcall(....); /* See earlier example for detailed error processing  */
/* Terminate active application access */
tpterm();
/* Finally, shutdown the master admin processes */
Finit32(ibuf, Fsizeof32(ibuf));
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_DOMAIN", 0);
Fchg32(ibuf, TA_STATE, 0, "INA", 0);
tpadmcall(....); /* See earlier example for detailed error processing  */

${TUXDIR}/include/tpadm.h, ${TUXDIR}/udataobj/tpadm