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

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

T_DM_TDOMAIN Class Definition

Overview

The T_DM_TDOMAIN class defines the TDomain specific configuration for a local or remote domain access point.

Attribute Table

Table 28 DM_MIB(5): T_DM_TDOMAIN Class Definition Attribute Table

Attribute	Type	Permissions	Values	Default
TA_DMACCESSPOINT(r)(k)(*)	string	`rw-r--r--`	`string`[1..30]	N/A
TA_DMNWADDR(r)(k)(*)	string	`rw-r--r--`	`string`[1..256] ^{Note 1}	N/A
TA_STATE(r)	string	`rw-r--r--`	`GET`: `"VAL"` `SET`: `"`{`NEW` \| `INV`}`"`	N/A N/A
TA_DMNWDEVICE	string	`rw-r--r--`	`string`[1..78]	N/A
TA_DMCMPLIMIT	long	`rw-rw-r--`	0 <= `num` <= `MAXLONG`	`MAXLONG`
TA_DMMINENCRYPTBITS	string	`rw-------`	`"`{`0` \| `40` \| `56` \| `128`}`"` ^{Note 2}	`"0"`
TA_DMMAXENCRYPTBITS	string	`rw-------`	`"`{`0` \| `40` \| `56` \| `128`}`"` ^{Note 2}	`"128"`
TA_DMCONNECTION_POLICY	string	`rwxr--r--`	`"`{`LOCAL` \| `ON_DEMAND` \| `ON_STARTUP` \| `INCOMING_ONLY`}`"`	`"LOCAL"` ^{Note 3} (Also see ^{Note 5})
TA_DMMAXRETRY	long	`rwxr--r--`	0 <= `num` <= `MAXLONG`	0
TA_DMRETRY_INTERVAL	long	`rwxr--r--`	0 <= `num` <= `MAXLONG`	60
TA_DMTCPKEEPALIVE	string	`rwxr--r--`	`"`{`LOCAL` \| `NO` \| `YES`}`"`	`"LOCAL"` ^{Note 3} `"NO"` ^{Note 4}
TA_DMKEEPALIVE	long	`rwxr--r--`	-1 <= `num` <= 2147483647	-1 ^{Note 3} 0 ^{Note 4}
TA_DMKEEPALIVEWAIT	long	`rwxr--r--`	0 <= `num` <= 2147483647	0
TA_DMLACCESSPOINT(r)(k)(*)	string	rw-r--r--	`string`[1..30]	`"*"`
TA_DMFAILOVERSEQ	short	rw-r--r--	-1 <= `num` <= 32767	-1
(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} Maximum string length for this attribute is 78 bytes for BEA Tuxedo 8.0 or earlier.
^{Note 2} Link-level encryption value of 40 bits is provided for backward compatibility.
^{Note 3} Default for remote domain access points.
^{Note 4} Default for local domain access points.
^{Note 5} Default TA_DMCONNECTION_POLICY value for a local domain access point is
the TA_DMCONNECTION_POLICY value specified in the T_DM_LOCAL class.

Attribute Semantics

TA_DMACCESSPOINT: string[1..30]

The local or remote domain access point name for which this entry provides the TDomain-specific configuration data.

When Domains link-level failover is in use, more than one T_DM_TDOMAIN class entry can be defined with the same TA_DMACCESSPOINT attribute value.

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

Specifies the network address associated with the access point. For a local domain access point, this attribute supplies the address to be used for listening for incoming connections. For a remote domain access point, this attribute supplies the destination address to be used when connecting to a remote domain access point. The value of this field must be unique across all T_DM_TDOMAIN entries.

TA_STATE:

GET: "{VALid}"

A GET operation retrieves configuration information for the T_DM_TDOMAIN 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_TDOMAIN 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 state `"INValid"`.
`"INValid"`	The object is deleted. This state change is allowed in the state `"VALid"` and results in the state `"INValid"`.

TA_DMNWDEVICE: string[1..78]

Specifies the network device to be used. For a local domain access point, this attribute specifies the device to be used for listening. For a remote domain access point, this attribute specifies the device to be used when connecting to the remote domain access point.

TA_DMCMPLIMIT: 0 <= num <= MAXLONG

Relevant to remote domain access points only. Threshold message at which compression occurs for traffic to this access point.

TA_DMMINENCRYPTBITS: "{0 | 40 | 56 | 128}"

Relevant to remote domain access points only. When establishing a connection to this access point, this attribute specifies the minimum level of encryption required. "0" means no encryption, while "40", "56", and "128" specify the encryption length (in bits). If this minimum level of encryption is not met, link establishment fails. The default is "0".

The value of 40 bits is provided for backward compatibility.

Note: Modifications to this attribute do not affect established connections.

TA_DMMAXENCRYPTBITS: "{0 | 40 | 56 | 128}"

Relevant to remote domain access points only. When establishing a network link to this access point, this attribute specifies the maximum level of encryption allowed. "0" means no encryption, while "40", "56", and "128" specify the encryption length (in bits). The default is "128".

The value of 40 bits is provided for backward compatibility.

Note: Modifications to this attribute do not affect established connections.

TA_DMCONNECTION_POLICY = "{LOCAL | ON_DEMAND | ON_STARTUP | INCOMING_ONLY}"

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

The TA_DMCONNECTION_POLICY attribute is available in the T_DM_TDOMAIN class when running BEA Tuxedo 8.1 or later software. Its value in the T_DM_TDOMAIN class for a particular local or remote domain access point takes precedence over its global value in the T_DM_LOCAL class. The ability to override the global connection policy enables you to configure connection policy on a per remote domain basis.

Specifying no connection policy for a local domain access point defaults to the global connection policy specified in the T_DM_LOCAL class. If you choose to specify a global connection policy in the T_DM_TDOMAIN class, do not specify a global connection policy in the T_DM_LOCAL class.

"LOCAL"

A connection policy of "LOCAL" means that a remote domain access point accepts the global connection policy specified in the T_DM_LOCAL class. "LOCAL" is the default connection policy for remote domain access points. Excluding "LOCAL", the connection policy value for a remote domain access point takes precedence over the connection policy value for a local domain access point.

"ON_DEMAND"

A connection policy of "ON_DEMAND" means that the TDomain gateway attempts a connection only when requested by either a client request to a remote service or a dmadmin(1) connect command. Connection retry processing is not allowed when the connection policy is "ON_DEMAND".

"ON_STARTUP"

A connection policy of "ON_STARTUP" means that the TDomain gateway attempts to establish a connection at gateway server initialization time. For "ON_STARTUP", the remote services for a particular remote domain (that is, services advertised by the TDomain gateway) are advertised only if a connection is successfully established to the remote domain. Thus, if there is no active connection to the remote domain, the remote services are suspended. By default, this connection policy retries failed connections every 60 seconds, but you can specify a different value for this interval using the TA_DMRETRY_INTERVAL attribute in the T_DM_TDOMAIN class. Also, see the TA_DMMAXRETRY attribute in this class.

"INCOMING_ONLY"

A connection policy of "INCOMING_ONLY" means that the TDomain gateway does not attempt an initial connection upon startup and that remote services are initially suspended. The TDomain gateway is available for incoming connections from a remote domain, and remote services are advertised when the 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_DMFAILOVERSEQ = -1 <= num <= 32767

Specifies or requests failover sequences and primary records for a TDomain session record in the BDMCONFIG file. If a DM_MIB SET request does not specify a TA_DMFAILOVERSEQ value or a DM_MIB SET TA_DMFAILOVERSEQ request is from Tuxedo releases prior to 9.0, the output TDomain session record in the BDMCOMFIG file uses the default FAILOVERSEQ = -1.

The record with the lowest FAILOVERSEQ value is the primary record for that TDomain session. There is only one primary record for a TDomain session, all remaining records for the same TDomain session are called secondary/backup records. With the exceptions of NWADDR, NWDEVICE, and FAILOVERSEQ, the primary record is the source for all TDomain session configuration parameters and attributes. All other parameters and attributes listed in secondary/backup records are ignored.

Based on the CONNECTION_POLICY attribute you select, the local domain will try to connect to a TDomain session's primary record. If the primary record has a failover, it will then try to connect to the next sequential secondary/backup record. If all secondary record connections fail, it will retry the primary record information at a later time as determined by RETRY_INTERVAL until MAXRETRY is exhausted.

TA_DMLACCESSPOINT: string[1..30]

Specifies or requests a local domain access point found in the DM_LOCAL section for a TDomain session record in the BDMCONFIG file. The TA_DMLACCESSPOINT parameter is used exclusively to define TDomain session gateways and can contain only one local domain accesspoint as its value.

If a DM_MIB SET request does not specify a TA_DMLACCESSPOINT value or a DM_MIB SET TA_DMLACCESSPOINT request is from Tuxedo releases prior to 9.0, the output TDomain session record in the BDMCOMFIG file uses the default LACCESPOINT ="*".

Note: DM_MIB does not allow regular expression use with TA_DMLACCESSPOINT.

TA_DMMAXRETRY: 0 <= num <= MAXLONG; TA_DMRETRY_INTERVAL: 0 <= num <= MAXLONG; TA_DMTCPKEEPALIVE = "{LOCAL | NO | YES}"; TA_DMKEEPALIVE = -1 <= num <= 2147483647; TA_DMKEEPALIVEWAIT = 0 <= num <= 2147483647

Limitations

Deleting an instance of this class or updating the TA_DMNWDEVICE attribute of an instance of this class is not permitted in the following scenarios:

If the instance of the class corresponds to a local domain access point and the Domain gateway administration (GWADM) server for the local access point is active.
The instance of the class corresponds to a remote domain access point and any TDomain Domain gateway administration (GWADM) server is active.