Tuxedo
0

File Formats, Data Descriptions, MIBs, and System Processes Reference

 Previous Next Contents View as PDF  

T_GROUP Class Definition

Overview

The T_GROUP class represents application attributes pertaining to a particular server group. These attribute values represent group identification, location, and DTP information.

Attribute Table

Table 49 TM_MIB(5): T_GROUP Class Definition Attribute Table

Attribute

Type

Permissions

Values

Default

TA_SRVGRP(r)(*)

TA_GRPNO(k)(r)

TA_LMID(k)(r) 1

string

long

string

rU-r--r--

rU-r--r--

rwyr--r--

string[1. .30]

1 <= num < 30,000

"LMID1[,LMID2]"

N/A

N/A

N/A

TA_STATE(k)

string

rwxr-xr--

GET: "{ACT | INA | MIG}"

SET: "{NEW | INV | ACT | RAC |INA | MIG}"

N/A

N/A

TA_CURLMID(k)

string

R--R--R--

LMID

N/A

TA_ENVFILE

string

rwyr--r--

string[0..256] 2

""

TA_OPENINFO

TA_CLOSEINFO

TA_TMSCOUNT

TA_TMSNAME(k)

string

string

long

string

rwyr--r--

rwyr--r--

rw-r--r--

rw-r--r--

string[0..256]

string[0..256]

0 or 2 <= num < 11

string[0..256] 2

""

""

3

""

TA_SEC_PRINCIPAL_NAME

TA_SEC_PRINCIPAL_LOCATION

TA_SEC_PRINCIPAL_PASSVAR

TA_SIGNATURE_REQUIRED

TA_ENCRYPTION_REQUIRED

string

string

string

string

string

rwxr--r--

rwxr--r--

rwxr--r--

rwxr--r--

rwxr--r--

string[0..511]

string[0..511]

string[0..511]

"{Y|N}"

"{Y|N}"

""

""

""

"N"

"N"

(k)—GET key field
(r)—required field for object creation (SET TA_STATE NEW)
(*)—GET/SET key, one or more required for SET operations


  1 TA_LMID must be unique within this class.
2 Maximum string length for this attribute is 78 bytes for BEA Tuxedo 8.0 or earlier.

Attribute Semantics

TA_SRVGRP: string[1..30]

Logical name of the server group. The group name must be unique within all group names in the T_GROUP class and TA_LMID values in the T_MACHINE class. Server group names cannot contain an asterisk (*), comma, or colon.

TA_GRPNO: 1 <= num < 30,000

Group number associated with this server group.

TA_LMID: "LMID1[,LMID2]"

Primary machine logical machine identifier for this server group (LMID1) and optional secondary logical machine identifier (LMID2). The secondary LMID indicates the machine to which the server group can be migrated (if the MIGRATE option is specified in the T_DOMAIN:TA_OPTIONS attribute). A single LMID specified on a GET operation will match either the primary or secondary LMID. Note that the location of an active group is available in the TA_CURLMID attribute. Logical machine identifiers specified with the TA_LMID attribute must be already configured. Limitation: Modifications to this attribute for an active object may only change the backup LMID designation for the group.

TA_STATE:

GET: "{ACTive | INActive | MIGrating}"

A GET operation will retrieve configuration and run-time information for the selected T_GROUP object(s). The following states indicate the meaning of a TA_STATE returned in response to a GET request.


 

SET: "{NEW | INValid | ACTive | ReACtivate | INActive | MIGrating}"

A SET operation will update configuration and run-time information for the selected T_GROUP 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_GROUP 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_GROUP object. This combination is allowed only when in the ACTive or INActive state. Successful return leaves the object state unchanged.

INValid

Delete T_GROUP 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_GROUP object. State change allowed only when in the INActive or MIGrating state. For the purpose of determining permissions for this state transition, the active object permissions are considered (that is, --x--x--x).

If the group is currently in the INActive state, TMS and application servers (subject to restriction by TA_FLAGS settings) are started on the primary logical machine if the primary logical machine is active; otherwise, the TMS and application servers are started on the secondary logical machine if it is active. If neither machine is active, the request fails.

If the group is currently in the MIGrating state, the active secondary logical machine (identified as the alternate to TA_CURLMID in the TA_LMID list) is used to start TMS and application servers if it is active. Otherwise, the request fails. The TMIB_NOTIFY TA_FLAG value should be used when activating a server group if status on individual servers is required.

Successful return leaves the object in the ACTive state.

ReACtivate

Identical to a transition to the ACTive state except that this state change is also allowed in the ACTive state in addition to being allowed in the INActive and MIGrating states.

The TMIB_NOTIFY TA_FLAG value should be used when reactivating a server group if status on individual servers is required.

INActive

Deactivate the T_GROUP object. TMS and application servers (subject to restriction by TA_FLAGS settings) are deactivated. State change allowed only when in the ACTive or MIGrating state. Successful return leaves the object in the INActive state.

The TMIB_NOTIFY TA_FLAG value should be used when deactivating a server group if status on individual servers is required.

MIGrating

Deactivate the T_GROUP object on its active primary logical machine (TA_CURLMID) and prepare the group to be migrated to the secondary logical machine. State change allowed only when in the ACTive state. Successful return leaves the object in the MIGrating state.

UnAVailable

Suspend all application services in the group. (Note: Individual services can be suspended through the T_SVCGROUP class.) A SET operation to this state is allowed only when the group is in the ACTive state. The operation leaves the group in the ACTive state, but with all its application services in a suspended state. Limitation: Operation will fail in a mixed-release application where any pre-release 6.4 machine is active.

AVaiLable

Unsuspend all application services in the group marked as suspended. A SET operation to this state value is allowed only when the group is in the ACTive state. The operation leaves the group in the ACTive state.


 

Limitation: Operation will fail in a mixed-release application where any pre-release 6.4 machine is active.

TA_CURLMID: LMID

Current logical machine on which the server group is running. This attribute will not be returned for server groups that are not active.

TA_ENVFILE: string[0..256] (up to 78 bytes for BEA Tuxedo 8.0 or earlier)

Environment file for servers running in this group. If the value specifies an invalid filename, no values are added to the environment. the value of string is placed in the environment.

When booted, local servers inherit the environment of tmboot(1) and remote servers (not on the MASTER) inherit the environment of tlisten(1). TUXCONFIG, TUXDIR, and APPDIR are also put in the environment when a server is booted based on the information in the associated T_GROUP object.

PATH is set in the environment to:

APPDIR:TUXDIR/bin:/bin:/usr/bin:path

where path is the value of the first PATH= line in the machine environment file, if one exists (subsequent PATH= lines is ignored). This PATH is used as a search path for servers that are specified with a simple or relative pathname (that is, one that does not begin with slash).

LD_LIBRARY_PATH is set in the environment to:

APPDIR:TUXDIR/lib:/lib:/usr/lib:lib

where lib is the value of the first LD_LIBRARY_PATH= line appearing in the machine environment file, if one exists (subsequent LD_LIBRARY_PATH= lines are ignored).

As part of server initialization (before tpsvrinit(3c) is called), a server reads and exports variables from both the machine and server ENVFILE files. If a variable is set in both the machine and server ENVFILE, the value in the server ENVFILE will override the value in the machine ENVFILE with the exception of PATH which is appended. A client processes only the machine ENVFILE file. When the machine and server ENVFILE files are processed, lines that are not of the form ident= is ignored, where ident contains only underscore or alphanumeric characters.

If a PATH= line is encountered, PATH is set to:

APPDIR:TUXDIR/bin:/bin:/usr/bin:path

where path is the value of the first PATH= line appearing in the environment file (subsequent PATH= lines are ignored). If PATH appears in both the machine and server files, path is defined as path1:path2, where path1 is from the machine ENVFILE, and path2 is from the server ENVFILE. If a LD_LIBRARY_PATH= line is encountered, LD_LIBRARY_PATH is set to:

APPDIR:TUXDIR/lib:/lib:/usr/lib:lib

where lib is the value of the first LD_LIBRARY_PATH= line appearing in the environment file (subsequent LD_LIBRARY_PATH= lines are ignored). Attempts to reset TUXDIR, APPDIR, or TUXCONFIG are ignored and a warning is displayed if the value does not match the corresponding T_GROUP attribute value. Limitation: Modifications to this attribute for an active object DO not affect running servers or clients.

TA_OPENINFO: string[0..256]

The resource manager instance-dependent information needed when opening the resource manager for this group. The value must be enclosed in double quotes and must be less than or equal to 256 characters in length.

If a non NULL string other than TMS is specified for the TA_TMSNAME attribute, the TA_OPENINFO attribute value provides the resource manager dependent information needed when initiating access to the resource manager. Otherwise, the TA_OPENINFO attribute value is ignored.

A NULL string value for the TA_OPENINFO attribute means that the resource manager for this group (if specified) does not require any application specific information to open access to the resource.

The format of the TA_OPENINFO string is dependent on the requirements of the vendor providing the underlying resource manager. The information required by the vendor must be prefixed with the published name of the vendor's transaction (XA) interface followed immediately by a colon (:).

For BEA Tuxedo /Q databases, the format is:

# On UNIX #
OPENINFO = "TUXEDO/QM:qmconfig:qspace"

# On Windows #
OPENINFO = "TUXEDO/QM:qmconfig;qspace"

# In AS/400 environment #
OPENINFO = "TUXEDO/QM:qmconfig;qspace"

# In OpenVMS environment #
OPENINFO = "TUXEDO/QM,[a.b.c]qmconfig,qspace"

where TUXEDO/QM is the published name of the BEA Tuxedo /Q XA interface, qmconfig is replaced with the name of the QMCONFIG (see qmadmin(1)) on which the queue space resides, and qspace is replaced with the name of the queue space. For Windows and AS/400, the separator after qmconfig must be a semicolon (;). For OpenVMS, the separator after TUXEDO/QM and after qmconfig must be a comma (,).

For other vendors' databases, the format of the TA_OPENINFO string is specific to the particular vendor providing the underlying resource manager.

Limitation: Run-time modifications to this attribute will not affect active servers in the group.

TA_CLOSEINFO: string[0..256]

The resource manager instance-dependent information needed when closing the resource manager for this group. The value must be enclosed in double quotes and must be less than or equal to 256 characters in length. Note that a TA_CLOSEINFO string is not used for BEA Tuxedo /Q databases.

If a non NULL string other than TMS is specified for the TA_TMSNAME attribute, the TA_CLOSEINFO attribute value provides the resource manager-dependent information needed when terminating access to the resource manager. Otherwise, the TA_CLOSEINFO attribute value is ignored.

A NULL string value for the TA_CLOSEINFO attribute means that the resource manager for this group (if specified) does not require any application specific information to close access to the resource.

The format of the TA_CLOSEINFO string is dependent on the requirements of the vendor providing the underlying resource manager. The information required by the vendor must be prefixed with the published name of the vendor's transaction (XA) interface followed immediately by a colon (:).

Limitation: Run-time modifications to this attribute will not affect active servers in the group.

TA_TMSCOUNT: 0 or 2 <= num < 11

If a non NULL string is specified for the TA_TMSNAME attribute, the TA_TMSCOUNT attribute value indicates the number of transaction manager servers to start for the associated group. Otherwise, this attribute value is ignored.

TA_TMSNAME: string[0..256] (up to 78 bytes for BEA Tuxedo 8.0 or earlier)

Transaction manager server a.out associated with this group. This attribute must be specified for any group entry whose servers will participate in distributed transactions (transactions across multiple resource managers and possibly machines that are started with tpbegin(), and ended with tpcommit()/tpabort()).

The value TMS is reserved to indicate use of the NULL XA interface. If a non-empty value other than TMS is specified, a TLOGDEVICE must be specified for the machine(s) associated with the primary and secondary logical machines for this object.

A unique server identifier is selected automatically for each TM server, and the servers will be restartable an unlimited number of times.

TA_SEC_PRINCIPAL_NAME: string[0..511]

Security principal name identification string to be used for authentication purposes by an application running BEA Tuxedo 7.1 or later software. This attribute may contain a maximum of 511 characters (excluding the terminating NULL character). The principal name specified for this attribute becomes the identity of one or more system processes running in this group.

TA_SEC_PRINCIPAL_NAME can be specified at any of the following four levels in the configuration hierarchy: T_DOMAIN class, T_MACHINE class, T_GROUP class, and T_SERVER class. A principal name at a particular configuration level can be overridden at a lower level. If TA_SEC_PRINCIPAL_NAME is not specified at any of these levels, the principal name for the application defaults to the TA_DOMAINID string for this domain.

Note that TA_SEC_PRINCIPAL_NAME is one of a trio of attributes, the other two being TA_SEC_PRINCIPAL_LOCATION and TA_SEC_PRINCIPAL_PASSVAR. The latter two attributes pertain to opening decryption keys during application booting for the system processes running in a BEA Tuxedo 7.1 or later application. When only TA_SEC_PRINCIPAL_NAME is specified at a particular level, the system sets each of the other two attributes to a NULL (zero length) string.

TA_SEC_PRINCIPAL_LOCATION: string[0..511]

Location of the file or device where the decryption (private) key for the principal specified in TA_SEC_PRINCIPAL_NAME resides. This attribute may contain a maximum of 511 characters (excluding the terminating NULL character).

TA_SEC_PRINCIPAL_LOCATION can be specified at any of the following four levels in the configuration hierarchy: T_DOMAIN class, T_MACHINE class, T_GROUP class, and T_SERVER class. When specified at any of these levels, this attribute must be paired with the TA_SEC_PRINCIPAL_NAME attribute; otherwise, its value is ignored. (TA_SEC_PRINCIPAL_PASSVAR is optional; if not specified, the system sets it to a NULL—zero length—string.)

TA_SEC_PRINCIPAL_PASSVAR: string[0..511]

Variable in which the password for the principal specified in TA_SEC_PRINCIPAL_NAME is stored. This attribute may contain a maximum of 511 characters (excluding the terminating NULL character).

TA_SEC_PRINCIPAL_PASSVAR can be specified at any of the following four levels in the configuration hierarchy: T_DOMAIN class, T_MACHINE class, T_GROUP class, and T_SERVER class. When specified at any of these levels, this attribute must be paired with the TA_SEC_PRINCIPAL_NAME attribute; otherwise, its value is ignored. (TA_SEC_PRINCIPAL_LOCATION is optional; if not specified, the system sets it to a NULL—zero length—string.)

During initialization, the administrator must provide the password for each of the decryption keys configured with TA_SEC_PRINCIPAL_PASSVAR. The system automatically encrypts the password entered by the administrator and assigns each encrypted password to the associated password variable.

TA_SIGNATURE_REQUIRED: "{Y | N}"

If set to "Y", every process running in this group requires a digital signature on its input message buffer. If not specified, the default is "N". This attribute applies only to applications running BEA Tuxedo 7.1 or later software.

TA_SIGNATURE_REQUIRED can be specified at any of the following four levels in the configuration hierarchy: T_DOMAIN class, T_MACHINE class, T_GROUP class, and T_SERVICE class. Setting SIGNATURE_REQUIRED to "Y" at a particular level means that signatures are required for all processes running at that level or below.

TA_ENCRYPTION_REQUIRED: "{Y | N}"

If set to "Y", every process running in this group requires an encrypted input message buffer. If not specified, the default is "N". This attribute applies only to applications running BEA Tuxedo 7.1 or later software.

TA_ENCRYPTION_REQUIRED can be specified at any of the following four levels in the configuration hierarchy: T_DOMAIN class, T_MACHINE class, T_GROUP class, and T_SERVICE class. Setting TA_ENCRYPTION_REQUIRED to "Y" at a particular level means that encryption is required for all processes running at that level or below.

Limitations

None.

 

Back to Top Previous Next
Contact e-docsContact BEAwebmasterprivacy