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

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

T_DM_LOCAL Class Definition

Overview

The T_DM_LOCAL class defines a local domain access point. A local domain access point is used to control access to local services exported to remote domains and to control access to remote services imported from remote domains.

Attribute Table

Table 16 DM_MIB(5): T_DM_LOCAL Class Definition Attribute Table

Attribute	Type	Permissions	Values	Default
TA_DMACCESSPOINT(r)(k)(*)	string	`rw-r--r--`	`string`[1..30]	N/A
TA_DMACCESSPOINTID(r)	string	`rw-r--r--`	`string`[1..30]	N/A
TA_DMSRVGROUP(r)	string	`rw-r--r--`	`string`[1..30]	N/A
TA_DMTYPE	string	`rw-r--r--`	`"`{`TDOMAIN` \| `SNAX` \| `OSITP` \| `OSITPX`}`"`	`"TDOMAIN"`
TA_STATE(r)	string	`rw-r--r--`	`GET`: `"VAL"` `SET`: `"`{`NEW` \| `INV`}`"`	N/A N/A
TA_DMAUDITLOG	string	`rw-r--r--`	`string`[1..256] ^{Note 3}	N/A
TA_DMBLOCKTIME	short	`rw-r--r--`	0 <= `num` <= 32,767	`TA_BLOCKTIME` in `T_DOMAIN` ^{Note 1}
TA_DMTLOGDEV	string	`rw-r--r--`	`string`[1..256] ^{Note 3}	N/A
TA_DMTLOGNAME	string	`rw-r--r--`	`string`[1..30]	`"DMTLOG"`
TA_DMTLOGSIZE	long	`rw-r--r--`	1 <= `num` <= 2048	100
TA_DMMAXRAPTRAN	short	`rw-r--r--`	0 <= `num` <= 32,767	16
TA_DMMAXTRAN	short	`rw-r--r--`	0 <= `num` <= 32,767	`TA_MAXGTT` in `T_DOMAIN` ^{Note 2}
TA_DMSECURITY	string	`rw-r--r--`	`"`{`NONE` \| `APP_PW` \| `DM_PW` \| `DM_USER_PW` \| `CLEAR` \| `SAFE` \| `PRIVATE`}`"`	`"NONE"`
Attributes available when `TA_DMTYPE=TDOMAIN`:
TA_DMCONNECTION_POLICY	string	`rwxr--r--`	`"`{`ON_DEMAND` \| `ON_STARTUP` \| `INCOMING_ONLY`}`"`	`"ON_DEMAND"`
TA_DMMAXRETRY	long	`rwxr--r--`	0 <= `num` <= `MAXLONG`	0
TA_DMRETRY_INTERVAL	long	`rwxr--r--`	0 <= `num` <= `MAXLONG`	60
Attributes available when `TA_DMTYPE=TDOMAIN`:
TA_DMCONNPRINCIPALNAME	string	`rwxr--r--`	`string`[0..511]	`""`
TA_DMMACHINETYPE	string	`rw-r--r--`	`string`[0..15]	`""`
Attributes available when `TA_DMTYPE=SNAX`:
TA_DMBLOB_SHM_SIZE	long	`rw-r--r--`	1 <= `num` <= `MAXLONG`	1000000
(r)—required when a new object is created (k)—a key field for object retrieval (*)—a required key field for all `SET` operations on the class

^{Note 1} Current value of TA_BLOCKTIME in the T_DOMAIN class.
^{Note 2} Current value of TA_MAXGTT in the T_DOMAIN class.
^{Note 3} Maximum string length for this attribute is 78 bytes for BEA Tuxedo 8.0 or earlier.

Attribute Semantics

TA_DMACCESSPOINT: string[1..30]

The name of this T_DM_LOCAL entry—a user-specified local domain access point identifier (logical name) unique within the scope of the T_DM_LOCAL and T_DM_REMOTE access point names in this Domains configuration.

TA_DMACCESSPOINTID: string[1..30]

The identifier of the domain gateway group associated with this local domain access point for purposes of security when setting up connections to remote domains. This identifier is unique across all local and remote domain access points.

TA_DMSRVGROUP: string[1..30]

The group name of the domain gateway group (the name provided in the GROUPS section of the TUXCONFIG file) representing this local domain access point. There is a one-to-one relationship between a local domain access point and a gateway server group.

TA_DMTYPE: "{TDOMAIN | SNAX | OSITP | OSITPX}"

The type of domain for this local domain access point: "TDOMAIN" for a BEA Tuxedo domain, "SNAX" for an SNA domain, "OSITP" for an OSI TP 1.3 domain, or "OSITPX" for an OSI TP 4.0 or later domain. The presence or absence of other attributes depends on the value of this attribute.

Setting TA_DMTYPE="OSITPX" is supported only by BEA Tuxedo 8.0 or later software.

TA_STATE:

GET: "{VALid}"

A GET operation retrieves configuration information for the T_DM_LOCAL object. The following state indicates the meaning of a TA_STATE attribute value returned in response to a GET request. States not listed are not returned.

"VALid"

The object exists.

SET: "{NEW | INValid}"

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

`"NEW"`	A new object is created. This state change is allowed in the state `"INValid"` and results in the state `"VALid"`.
`unset`	Modify an existing object. This combination is not allowed in the `"INValid"` state. A successful return leaves the object state unchanged.
`"INValid"`	The object is deleted. This state change is allowed in the state `"VALid"` and results in the state `"INValid"`.

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

The name of the audit log file for this local domain access point.

TA_DMBLOCKTIME: 0 <= num <= 32,767

Specifies the maximum wait time allowed for a blocking call for this local domain access point. The value is a multiplier of the SCANUNIT parameters specified in the T_DOMAIN object. The value SCANUNIT * TA_BLOCKTIME must be greater than or equal to SCANUNIT and less than 32,768 seconds. If this attribute is not specified, the default is set to the value of the TA_BLOCKTIME attribute specified for the T_DOMAIN object. A blocking timeout condition implies that the affected service request has failed.

Be aware that interdomain transactions generate blocking timeout conditions when transaction duration exceeds the value of the TA_DMBLOCKTIME attribute. That is, for an interdomain transaction, if the value of the TA_DMBLOCKTIME attribute is less than (a) the value of the TA_TRANTIME attribute specified for the T_SERVICE object or (b) the timeout value passed in the tpbegin() call to start the transaction, the timeout for the transaction is reduced to the TA_DMBLOCKTIME value. In contrast, for intradomain transactions (that is, transactions handled within a single BEA Tuxedo domain), the value of the TA_BLOCKTIME attribute specified for the T_DOMAIN object has no effect on the timeout value of an intradomain transaction.

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

The device (raw slice) or file containing the Domains transaction log (TLOG) for this local domain access point. The TLOG is stored as a BEA Tuxedo System VTOC table on the device. For reliability, the use of a device (raw slice) is recommended.

If this attribute is not specified, the domain gateway group associated with this local domain access point is not allowed to process requests in transaction mode. Multiple local domain access points for the same machine can share the same BEA Tuxedo filesystem, but each local domain access point must have its own log (a table in the TA_DMTLOGDEV) named as specified by the TA_DMTLOGNAME keyword.

TA_DMTLOGNAME: string[1..30]

The TLOG name for this local domain access point. If more than one TLOG exists on the same device, each TLOG must have a unique name.

TA_DMTLOGSIZE: 1 <= num <= 2048

The size in pages of the TLOG for this local domain access point. This size is constrained by the amount of space available on the device identified in TA_DMTLOGDEV.

TA_DMMAXRAPTRAN: 0 <= num <= 32,767

The maximum number of remote domain access points that can be involved in a single transaction for this local domain access point.

TA_DMMAXTRAN: 0 <= num <= 32,767

The maximum number of simultaneous transactions allowed for this local domain access point. This number must be greater than or equal to the T_DOMAIN:TA_MAXGTT attribute value.

TA_DMSECURITY: "{NONE | APP_PW | DM_PW | DM_USER_PW }"

The type of security enabled for the domain gateway associated with this local domain access point. This attribute must be set to one of the following values:

"NONE"

No security is enabled.

"APP_PW"

Valid only when TA_DMTYPE="TDOMAIN". Application password-based security is enabled.

"DM_PW"

Valid only when TA_DMTYPE="TDOMAIN" or "OSITPX". Domain password-based security is enabled.

"DM_USER_PW"

Valid only when TA_DMTYPE="SNAX". Translation of principal names is enabled.

Attributes available when TA_DMTYPE=TDOMAIN

TA_DMCONNECTION_POLICY:"{ON_DEMAND | ON_STARTUP | INCOMING_ONLY}"

Specifies the conditions under which the domain gateway associated with this local domain access points tries to establish connections to remote domains. Supported values are "ON_DEMAND", "ON_STARTUP", or "INCOMING_ONLY".

"ON_DEMAND"

Means that a connection is attempted only when requested by either a client request to a remote service or a dmadmin(1) connect command. The default setting for TA_DMCONNECTION_POLICY attribute is "ON_DEMAND". The "ON_DEMAND" policy provides the equivalent behavior to previous releases, in which the TA_DMCONNECTION_POLICY attribute was not explicitly available. Connection retry processing is not allowed with this policy.

"ON_STARTUP"

Means that a domain gateway attempts to establish a connection with its remote domains at gateway server initialization time. Remote services for a particular remote domain (that is, services advertised by the domain gateway) are advertised only if a connection is successfully established to the remote domain. Therefore, if there is no active connection to a remote domain, the remote services are suspended. By default, this connection policy retries failed connections every 60 seconds; however, you can specify a different value for this interval using the TA_DMRETRY_INTERVAL attribute. Also, see the TA_DMMAXRETRY attribute.

"INCOMING_ONLY"

Means that a domain gateway does not attempt an initial connection to remote domains upon startup and that remote services are initially suspended. The domain gateway is available for incoming connections from remote domains, and remote services are advertised when the domain gateway receives an incoming connection or an administrative connection (using the dmadmin(1) connect command) is made. Connection retry processing is not allowed when the connection policy is "INCOMING_ONLY".

TA_DMMAXRETRY: 0 <= num <= MAXLONG

The number of times that the domain gateway associated with this local domain access point tries to establish connections to remote domains. The minimum value is 0 and the maximum is MAXLONG (2147483647). MAXLONG indicates that retry processing is repeated indefinitely, or until a connection is established. For a connection policy of "ON_STARTUP", the default setting for TA_DMMAXRETRY is MAXLONG. Setting this attribute to 0 turns off the automatic retry mechanism. For other connection policies, automatic retries are disabled.

The TA_DMMAXRETRY attribute is valid only when the connection policy is "ON_STARTUP".

TA_DMRETRY_INTERVAL: 0 <= num <= MAXLONG

The number of seconds that the domain gateway associated with this local domain access point waits between automatic attempts to establish a connection to remote domains. The minimum value is 0 and the maximum value is MAXLONG (2147483647). The default is 60. If TA_DMMAXRETRY is set to 0, setting TA_DMRETRY_INTERVAL is not allowed.

This attribute is valid only when the TA_DMCONNECTION_POLICY attribute is set to "ON_STARTUP". For other connection policies, automatic retries are disabled.

Attributes available when TA_DMTYPE=TDOMAIN

TA_DMCONNPRINCIPALNAME: string[0..511]

The connection principal name identifier, which is the principal name used for verifying the identity of the domain gateway associated with this local domain access point when establishing a connection to a remote domain. This attribute applies only to domain gateways of type TDOMAIN running BEA Tuxedo 7.1 or later software.

The TA_DMCONNPRINCIPALNAME attribute may contain a maximum of 511 characters (excluding the terminating NULL character). If this attribute is not specified, the connection principal name defaults to the TA_DMACCESSPOINTID string for this local domain access point.

For default authentication plug-ins, if a value is assigned to the TA_DMCONNPRINCIPALNAME attribute for this local domain access point, it must be the same as the value assigned to the TA_DMACCESSPOINTID attribute for this local domain access point. If these values do not match, the local domain gateway process will not boot, and the system will generate the following userlog(3c) message: ERROR: Unable to acquire credentials.

TA_DMMACHINETYPE: string[0..15]

Used for grouping domains so that encoding/decoding of messages can be bypassed between the machine associated with this local domain access point and the machines associated with the remote domain access points. This attribute applies only to domain gateways of type TDOMAIN.

If TA_DMMACHINETYPE is not specified, the default is to turn encoding/decoding on. If the value set for the TA_DMMACHINETYPE attribute is the same in both the T_DM_LOCAL and T_DM_REMOTE classes for a connection, data encoding/decoding is bypassed. The value set for TA_DMMACHINETYPE can be any string value up to 15 characters in length. It is used only for comparison.

Attributes available when TA_DMTYPE=SNAX

TA_DMBLOB_SHM_SIZE: 1 <= num <= MAXLONG

Specifies the shared memory allocated to storing binary large object log information specific to this SNAX local domain access point. This attribute applies only to local domain access points and domain gateways of type SNAX.

Limitations

When the Domain gateway administration (GWADM) server supporting the local domain access point specified in the TA_DMLACCESSPOINT attribute is active, you cannot SET the TA_STATE to INValid or update the following attributes: TA_DMACCESSPOINTID, TA_DMSRVGROUP, TA_DMTYPE, TA_DMTLOGDEV, TA_DMTLOGNAME, TA_DMTLOGSIZE, TA_DMMAXRAPTRAN, TA_DMMAXTRAN, or TA_DMMACHINETYPE.