Section 5 - File Formats, Data Descriptions, MIBs, and System Processes Reference

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

T_WSL Class Definition

Overview

The T_WSL class represents configuration and run-time attributes of WSL server processes configured to manage Workstation groups. These attribute values identify and characterize Workstation specific configuration attributes for WSL T_SERVER objects within the application. This class is linked to the T_WSH class by the common key fields, TA_SRVGRP and TA_SRVID.

Attribute Table

Table 67 WS_MIB(5): T_WSL 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_GRPNO`(k)	long	`r--r--r--`	1 <= `num` < 30,001	N/A
`TA_STATE`(k)	string	`rwxr-xr--`	See `T_SERVER` Class in `TM_MIB`(5)
`TA_LMID`(k)	string	`R--R--R--`	`LMID`	N/A
`TA_PID`(k)	long	`R--R--R--`	1 <= `num`	N/A
`TA_DEVICE`	string	`rw-r--r--`	`string`[0..78]	N/A
`TA_NADDR`(r)	string	`rw-r--r--`	`string`[1..256] ³	N/A
`TA_EXT_NADDR`	string	`rw-r--r--`	`string`[0..78]	`""`
`TA_WSHNAME`	string	`rw-r--r--`	`string`[1..78]	`"WSH"`
`TA_MINHANDLERS`	long	`rwxr-xr--`	0 <= `num` < 256	0
`TA_MAXHANDLERS`	long	`rw-r--r--`	0 <= `num` < 32,767	See note ¹
`TA_MULTIPLEX`	long	`rw-r--r--`	1 <= `num` < 32,767	10
`TA_MINENCRYPTBITS`	string	`rwxrwx---`	`"`{`0` \| `40` \| `56` \| `128`}`"` ²	`"0"`
`TA_MAXENCRYPTBITS`	string	`rwxrwx---`	`"`{`0` \| `40` \| `56` \| `128`}`"` ²	`"128"`
`TA_MINWSHPORT`	long	`rwxr-xr--`	0 <= `num` < 65,535	2048
`TA_MAXWSHPORT`	long	`rw-r--r--`	0 <= `num` < 65,535	65,535
`TA_MAXIDLETIME`	long	`rwxr-xr--`	0 <=`num` < 35,204,650	35,204,649
`TA_MAXINITTIME`	long	`rwxr-xr--`	1 <= `num` < 32,767	60
`TA_CMPLIMIT`	string	`rwxr-xr--`	`threshold`	`MAXLONG`
`TA_CLOPT`	string	`rwxr--r--`	`string`[0..128]	`"-A"`
`TA_ENVFILE`	string	`rwxr--r--`	`string`[0..256] ³	`""`
`TA_GRACE`	long	`rwxr--r--`	0 <= `num`	0
`TA_KEEPALIVE`	string	`rwxr-xr--`	`"`{`client` \| `handler` \| `both` \| `none`}`"`	`"none"`
`TA_MAXGEN`	long	`rwxr--r--`	0 <= `num` < 256	`1`
`TA_NETTIMEOUT`	long	`rwxr-xr--`	0 <= `num` <= `MAXLONG`	0
`TA_RCMD`	string	`rwxr--r--`	`string`[0..256] ³	`""`
`TA_RESTART`	string	`rwxr--r--`	`"`{`Y` \| `N`}`"`	`"Y"`
`TA_SEQUENCE`(k)	long	`rwxr--r--`	1 <= `num` < 10,000	>= 10,000
T_WSL Class: Local Attributes
`TA_CURHANDLERS`	long	`R--R--R--`	0 <= `num`	N/A
`TA_HWHANDLERS`	long	`R--R--R--`	0 <= `num`	N/A
`TA_WSPROTO`	long	`R--R--R--`	0 <= `num`	N/A
`TA_SUSPENDED`	string	`R-XR-XR--`	`"`{`NEW` \| `ALL` \| `NONE`}`"`	N/A
`TA_VIEWREFRESH`	string	`--X--X---`	`"Y"`	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

¹ If a value for this attribute is not specified at the time the object is created, a value of 0 will be assigned. A value of 0 for this attribute indicates that the effective value is determined at activation time from the current setting for TA_MAXHANDLERS and the T_MACHINE class setting for TA_MAXWSCLIENTS. Note that a GET operation with the MIB_LOCAL flag set will get the effective value for objects with an activation time default setting.
² Link-level encryption value of 40 bits is provided for backward compatibility.
³ 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. 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_GRPNO: 1 <= num < 30,001

Group number associated with this servers group.

TA_STATE:

State for the WSL server within the application. Any state defined for the T_SERVER class in TM_MIB(5) may be returned or set as indicated on that reference page.

TA_LMID: LMID

Current logical machine on which the server is running.

TA_PID: 1 = num

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

TA_DEVICE: string[0..78]

Device name to be used by the WSL process to access the network. This attribute is optional.

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

Specifies the complete network address to be used by the WSL process as its listening address. The listening address for a WSL is the means by which it is contacted by Workstation client processes participating in the application. If string has the form "0xhex-digits" or "\\xhex-digits", it must contain an even number of valid hex digits. These forms are translated internally into a character array containing TCP/IP addresses. The value of string may also be represented in either of the following forms:

//hostname:port_number

//#.#.#.#:port_number

In the first of these formats, hostname is resolved to a TCP/IP host address at the time the address is bound using the locally configured name resolution facilities accessed via gethostbyname(3c). The string #.#.#.# is the dotted decimal format in which each # represents a decimal number in the range 0 to 255. Port_number is a decimal number in the range 0 to 65535.

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

TA_EXT_NADDR: string[0..78]

Specifies the complete network address to be used as a well known address template of the WSH process. The address is combined with a WSH network address to generate a well known network address used by the Workstation client to connect to a WSH process. It has the same format as the TA_NADDR except that it substitutes the port number with same length of character M to indicate the position of the combined network address will be copied from the WSH network address. For example when Address template is 0x0002MMMMdddddddd and WSH network address is 0x00021111ffffffff then the well known network address will be 0x00021111dddddddd. When address template starts with "//" network address type assumes to be IP based and the TCP/IP port number of WSH network address will be copied into the address template to form the combined network address. This feature is useful when Workstation client needs to connect to a WSH through a router which performs Network Address Translation. Empty TA_EXT_NADDR string in a SET operation on an existing T_WSL object will eliminate the -H entry from the TA_CLOPT attribute.

TA_WSHNAME: string[1..78]

The name of the executable providing workstation handler services for this workstation listener. The default for this is WSH which corresponds to the system provided workstation handler. Workstation handlers may be customized using the command buildwsh(). See the Customization section and the buildwsh(1) reference page for more details.

TA_MINHANDLERS: 0 <= num < 256

The minimum number of handlers that should be available in conjunction with this WSL at any given time. The WSL will start this many WSHs immediately upon being activated and will not deplete the supply of WSHs below this number until the administrator issues a shutdown to the WSL. Modifications to this attribute for a running WSL may cause additional handlers to be activated.

TA_MAXHANDLERS: 0 <= num < 32,767

The maximum number of handlers that should be available in conjunction with this WSL at any given time. Handlers are started as necessary to meet the demand of Workstation clients attempting to access the system. This attribute must be greater than or equal to the setting for the minimum number of handlers.

TA_MULTIPLEX: 1 <= num < 32,767

Maximum number of clients that are to be supported by any one handler process concurrently.

TA_MINENCRYPTBITS: {0 | 40 | 56 | 128}

Specifies the minimum level of encryption required when connecting to the BEA Tuxedo system. 0 means no encryption, while 40, 56, and 128 specify the encryption key length (in bits). If this minimum level of encryption cannot be met, link establishment fails. The default is 0.

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

TA_MAXENCRYPTBITS: {0 | 40 | 56 | 128}

Specifies the maximum level of encryption that can be negotiated when connecting to the BEA Tuxedo system. 0 means no encryption, while 40, 56, and 128 specify the encryption length (in bits). The default is 128.

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

TA_MINWSHPORT: 0 <= num < 65,535

The lower end of the range of available port numbers that may be allocated to WSH processes by this listener.

TA_MAXWSHPORT: 0 <= num < 65,535

The upper end of the range of available port numbers that may be allocated to WSH processes by this listener.

TA_MAXIDLETIME: 0 <= num < 35,204,650

Maximum amount of time, in minutes, that a Workstation client is permitted to be idle before it will be abortively disconnected from the application by the handler. A value of 35,204,650 allows clients to be idle as long as they wish without being timed out. A value of 0 indicates clients may be terminated after any period of inactivity greater than 1 second.

TA_MAXINITTIME: 1 <= num < 32,767

The minimum number of seconds that should be allowed for a Workstation client to complete initialization processing through the WSH before being timed out by the WSL.

TA_CMPLIMIT: threshold

Threshold message size at which compression will occur for traffic to and from Workstation clients. The threshold value may be either non-negative numeric values or the string MAXLONG, which is dynamically translated to the maximum long setting for the machine. Limitation: This attribute value is not used for Workstation clients running BEA Tuxedo Workstation release 6.1 or earlier.

TA_CLOPT: string[0..128]

Command line options to be passed to WSL server when it is activated. See the servopts(5) reference page for details. Limitations: Run-time modifications to this attribute will not affect a running WSL server. Server specific options (that is, those after a double-dash "--") may not be set and will not be returned.

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

WSL server specific environment file. See T_MACHINE:TA_ENVFILE for a complete discussion of how this file is used to modify the environment. Limitation: Run-time modifications to this attribute will not affect a running WSL server.

TA_GRACE: 0 <= num

The period of time, in seconds, over which the T_WSL:TA_MAXGEN limit applies. This attribute is meaningful only for restartable WSL servers, that is, if the T_WSL: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 the WSL server should always be restarted.

TA_KEEPALIVE: "{client | handler | both | none}"

Here you can turn on the network keep-alive operation for the client, the handler, or both. You may also turn off this operation for both the client and handler by specifying "none".

Changes to the value of this attribute affect only new connections.

TA_MAXGEN: 1 <= num < 256

Number of generations allowed for a restartable WSL server (T_WSL:TA_RESTART == "Y") over the specified grace period (T_WSL:TA_GRACE). The initial activation of the WSL 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.

TA_NETTIMEOUT: 0 <= num <= MAXLONG

The value of TA_NETTIMEOUT is the minimum number of seconds that a Workstation client is allowed to wait to receive a response from the WSL/WSH. A value of 0 indicates no network timeout.

Changes to the value of this attribute affect only new connections.

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

Application specified command to be executed in parallel with the system restart of an application server. This command must be an executable file in the native operating system.

TA_RESTART: "{Y | N}"

Restartable ("Y") or non-restartable ("N") WSL server. If server migration is specified for this server group (T_RESOURCE:TA_OPTIONS/MIGRATE T_GROUP:TA_LMID w/ alternate site), this attribute must be set to "Y".

TA_SEQUENCE: 1 <= num < 10,000

Specifies when this server should be booted (tmboot(1)) or shut down (tmshutdown(1)) relative to other servers. T_WSL 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. Servers are booted by tmboot() in increasing order of sequence number and shutdown by tmshutdown() in decreasing order. Run-time modifications to this attribute affect only tmboot() and tmshutdown() and will affect the order in which running servers may be shutdown by a subsequent invocation of tmshutdown().

TA_CURHANDLERS: 0 <= num

Number of currently active handlers associated with this WSL.

TA_HWHANDLERS: 0 <= num

Maximum number of currently active handlers associated with this WSL at any one time.

TA_WSPROTO: 0 <= num

The BEA Tuxedo Workstation protocol version number for this Workstation group. Note that Workstation clients connecting to this group may themselves have a different protocol version number associated with them.

TA_SUSPENDED: "{NEW | ALL | NONE}"

A value of "NEW" indicates that new incoming clients may not connect through this WSL object. A value of "ALL" indicates that Workstation clients already connected to the application through this WSL have been suspended (see TM_MIB(5)) in addition to disallowing new incoming connections. A value of "NONE" indicates that no suspension characteristics are in effect.

TA_VIEWREFRESH: Y

Setting a value of Y will cause all active WSHs in the Workstation group to refresh their VIEW buffer type cache.

Limitations

This class represents a specialization of the T_SERVER class and as such represents certain attributes that are duplicated in the corresponding T_SERVER objects. Attributes not listed that are included in the T_SERVER class must be accessed via that class and are not available through the T_WSL class.