|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Links the TM_MQI, TM_MQO, and TMQUEUE_MQM servers
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Each command respectively links the TM_MQI, TM_MQO, and TMQUEUE_MQM servers
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Parses a DMCONFIG file and loads a binary BDMCONFIG configuration file
|
|
|
Unloads a BDMCONFIG file (a binary Domains configuration file)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Parses a UBBCONFIG file (a text-format configuration file) and loads a TUXCONFIG file (a binary configuration file)
|
|
|
|
|
|
TMS_rac_refresh sends the Transaction Manager Servers (TMS), which are specified by groupname(s) or group ID(s) and listed in the groupname parameter, a command to re-execute the xa_recover() operation.
|
|
|
|
|
|
Unloads a TUXCONFIG file (a binary configuration file)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Encrypts the LDAP bind password for the XAUTHSVR/ LAUTHSVR/ GAUTHSVR configuration file
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The Oracle Tuxedo Command Reference describes, in alphabetic order, shell-level commands delivered with the Oracle Tuxedo software.
name [ -
option . . . ] [
cmdarg . . . ]
where name is the name of an executable file and
option is a string of one of the following two types:
noargletter . . . or
argletter optarg [, . . .]
Surrounding an option or
cmdarg, mean that the option or argument is not required.
Surrounding cmdargs that are separated by an
or sign, mean that one of the choices must be selected if the associated option is used.
bldc_dce—Builds an Oracle Tuxedo ATMI client that can be called via
OSF/DCE.
bldc_dce [-o output_file] [-i
idl_options] [-f
firstfiles]
[-l
lastfiles] [
idl_file . . .]
bldc_dce parses any input IDL and related ACF source files and combines them with C source and object files and the
OSF/DCE libraries to generate an Oracle Tuxedo ATMI client that can be called via
DCE RPC (it is a
DCE RPC client).
blds_dce—Builds an Oracle Tuxedo ATMI server that calls
OSF/DCE.
blds_dce [-o output_file] [-i
idl_options] [-f
firstfiles]
[-l
lastfiles] [-s
service] [
idl_file . . .]
blds_dce parses any input IDL and related ACF source files and combines them with C source and object files and the
OSF/DCE libraries to generate an Oracle Tuxedo ATMI server that can make
DCE RPC calls. The primary use of this command is to make an Oracle Tuxedo system-to-
OSF/DCE gateway process.
-s service[,service . . .]
buildclient—Constructs an Oracle Tuxedo ATMI client module.
buildclient [ -C ] [ -v ] [ {-r rmname | -w } ] [ -o
name]
[ -f
firstfiles] [ -l
lastfiles] [ -k ]
buildclient is used to construct an Oracle Tuxedo ATMI client module. The command combines the files supplied by the
-f and
-l options with the standard Oracle Tuxedo ATMI libraries to form a load module. The load module is built by
buildclient using the default C language compilation command defined for the operating system in use. The default C language compilation command for the UNIX system is the
cc(1) command described in UNIX system reference manuals.
Specifies that buildclient should work in verbose mode. In particular, it writes the compilation command to its standard output.
(See buildtms(1) for further details.) Using the
rmname value, the entry in
$TUXDIR/udataobj/RM is used to include the associated libraries for the resource manager automatically and to set up the interface between the transaction manager and resource manager properly. Other values can be specified as they are added to the resource manager table. If the
-r option is not specified, the default is that the client is not associated with a resource manager. Refer to the
UBBCONFIG(5) reference page.
Specifies one or more user files to be included in the compilation and link edit phases of buildclient first, before the Oracle Tuxedo ATMI libraries. If more than one file is specified, filenames must be separated by white space and the entire list must be enclosed in quotation marks. This option may be specified multiple times. The
CFLAGS and
ALTCFLAGS environment variables, described below, should be used to include any compiler options and their arguments.
If -C option is specified and the environment variable
COB is set to “
AcuCobol”, this option only accepts COBOL source files. Other user files, such as library files, C source files, etc, should be specified with environment variable “
TM_COB_CC_FILES”. See below “Environment Variable” section.
Keeps the COBOL client stub. buildclient generates a stub with data structures such as the function table invoked in COBOL program. This is normally compiled and then removed when the client is built. This option indicates that the source file should be kept (to see what the source filename is, use the -v option). This option is valid only when
-C option is specified and the environment variable
COB is set to “
AcuCobol”.
buildclient uses the environment variable
TUXDIR to find the Oracle Tuxedo ATMI libraries and
include files to use during compilation of the client process.
buildclient normally uses the default C language compilation command to produce the client executable. The default C language compilation command is defined for each supported operating system platform and is defined as
cc(1) for UNIX system. In order to allow for the specification of an alternate compiler,
buildclient checks for the existence of an environment variable named
CC. If
CC does not exist in
buildclient’s environment, or if it is the string
"",
buildclient will use the default C language compiler. If
CC does exist in the environment, its value is taken to be the name of the compiler to be executed.
The environment variable CFLAGS is taken to contain a set of arguments to be passed as part of the compiler command line. This is in addition to the command line option “
-I${TUXDIR}/include” passed automatically by
buildclient. If
CFLAGS does not exist in
buildclient’s environment, or if it is the string
"", no compiler command line arguments are added by
buildclient.
When the -C option is specified for COBOL compilation,
buildclient normally uses the Oracle Tuxedo shell
cobcc which in turn calls
cob to produce the client executable. In order to allow for the specification of an alternate compiler,
buildclient checks for the existence of an environment variable named
ALTCC. If
ALTCC does not exist in
buildclient’s environment, or if it is the string
"",
buildclient uses
cobcc. If
ALTCC does exist in the environment, its value is taken to be the name of the compiler command to be executed.
|
Note:
|
On a Windows system, the ALTCC and ALTCFLAGS environment variables are not applicable and setting them will produce unexpected results. You must compile your application first using a COBOL compiler and then pass the resulting object file to the buildclient(1) command.
|
The environment variable ALTCFLAGS is taken to contain a set of additional arguments to be passed as part of the COBOL compiler command line when the
-C option is specified. This is in addition to the command line option:
This option is passed automatically by buildclient. When the
-C option is used, putting compiler options and their arguments in the
buildclient -f option generates errors; they must be put in
ALTCFLAGS. If not set, the value is set to the same value used for
CFLAGS, as specified above.
|
Note:
|
1. ALTCFLAGS only works for the MicroFocus COBOL compiler. For other supported COBOL compilers (i.e., IBMCOBOL or AccuCOBOL), CFLAGS is supported and is sufficient. 2. See the note under the description of the ALTCC environment variable.
|
The environment variable COBOPT is taken to contain a set of additional arguments to be used by the COBOL compiler, when the
-C option is specified.
The environment variable COBCPY indicates which directories contain a set of COBOL copy files to be used by the COBOL compiler, when the
-C option is specified.
The environment variable TM_COB_STATIC indicates whether shared version or static version
libcobatmi library to be linked by
buildclient. The environment variable value may be “
Yes” or “
No”. If “
Yes” is set, static version
libcobatmi library is used; otherwise shared version is used. If the environment variable is not specified, the shared version
libcobatmi library is used by default.
If “AcuCobol” is specified, the ACUCOBOL compiler is used. If “
IBMCobol” is specified, the IBMCOBOL compiler is used.
The environment variable TM_COB_VERSION indicates the ACUCOBOL compiler version. This environment variable takes effect only when
-C option is specified and the environment variable
COB is set to “
AcuCobol”. The value format of the environment variable is “
[0-9]+\.[0-9]”.
|
•
|
If TM_COB_VERSION value is less than 7.0, buildclient generates old style ACUCOBOL stub code; otherwise buildclient generates new style ACUCOBOL stub code.
|
|
•
|
If TM_COB_VERSION is not set, buildclient generates new style ACUCOBOL stub code by default.
|
When ACUCOBOL compiler is used, only COBOL source files can be specified with -f option. If there are other user files to be passed to
cc(1) in the compilation and link edit phases of
buildclient first, before the Oracle Tuxedo ATMI libraries, these files must be specified with the environment variable
TM_COB_CC_FILES. If more than one file is specified, filenames must be separated by white space and the entire list must be enclosed in quotation marks. The environment variable takes effect only when
-C option is specified and the environment variable
COB is set to “
AcuCobol”.
|
Note:
|
File direct.c is used by ACUCOBOL to access C external variables and functions in COBOL programs. If the programmer modified direct.c to support third party software, the modified direct.c must be stored under directory $ACUCOBOL/lib.
|
The environment variable LD_LIBRARY_PATH indicates which directories contain shared objects to be used by the COBOL compiler, in addition to the Oracle Tuxedo system shared objects. Some UNIX systems require different environment variables: for HP-UX systems, use the
SHLIB_PATH environment variable; for AIX, use
LIBPATH.
The buildclient compilation tool is supported on the following platforms:
Listing 1 shows a general COBOL compiler example.
CC=ncc CFLAGS="-I /APPDIR/include"; export CC CFLAGS
buildclient -o empclient -f emp.c -f "userlib1.a userlib2.a" COBCPY=$TUXDIR/cobinclude
COBOPT="-C ANS85 -C ALIGN=8 -C NOIBMCOMP -C TRUNC=ANSI -C OSEXT=cbl"
COBDIR=/usr/lib/cobol LD_LIBRARY_PATH=$COBDIR/coblib:$TUXDIR/lib
export COBOPT COBCPY COBDIR LD_LIBRARY_PATH
buildclient -C -o empclient -f name.cbl -f "userlib1.a userlib2.a"
Listing 2 shows an ACUCOBOL compiler example.
Listing 3 shows an IBMCOBOL compiler example.
buildmqadapter builds the TM_MQI,
TM_MQO, and
TMQUEUE_MQM servers and installs them in
$TUXDIR/bin/TM_MQI, $TUXDIR/bin/TM_MQO, and
$TUXDIR/bin/TMQUEUE_MQM.
The servers built by buildmqadapter are used by the Tuxedo MQ Adapter to interact with IBM WebSphere MQ as described in the Oracle MQ Adapter for Tuxedo 11gR1 Users Guide.
buildmqadapter invokes the buildserver command to build each of the MQ Adapter servers.
buildmqadapter does not build the TMS server for the MQ resource manager, and the Tuxedo administrator will need to execute buildtms at some time in order to build the WebSphere MQ TMS server.
Specifies that buildmqadapter should work in verbose mode. In particular, it writes the buildserver command to its standard output and specifies the -v option to buildserver.
buildmqadapter uses the buildserver command to produce the output files. buildserver uses the CC and CFLAGS environment variables, if set, for the compiler and compiler flags, respectively. See
buildserver(1) for further details.
buildnetclient—Constructs an Oracle Tuxedo .NET Workstation Client module.
buildnetclient is a utility used to construct a Tuxedo .NET Workstation Client application. This command combines the files specified by the
.cs source file arguments,
.dll assembly files, and .
netmodule module files with the Tuxedo .NET Workstation Client wrapper libraries to form a client application. The client application is then built using the C# compiler (
csc.exe) provided by Microsoft’s .NET Framework environment.
Specifies that the buildnetclient command should work in verbose mode. In particular, it writes the compile command to its standard output.
buildnetclient analyzes the arguments passed to it via command line and constructs another valid command line to invoke the C# compiler to build the application executable.
For example, [buildnetclient -o t1.exe, t1.cs] is translated by
buildnetclient to
csc /out:t1.exe /t:exe /r:%TUXDIR%\bin\libwscdnet.dll t1.cs on Windows system.
buildobjclient [-v][-o name] [-f
firstfile-syntax]
[-l
lastfile-syntax] -P
Use the buildobjclient command to construct a CORBA client application. The command combines the files specified in the
-f and
-l options with the standard CORBA libraries to form a client application. The client application is built using the default C++ language compile command defined for the operating system in use.
All specified .c and
.cpp files are compiled in one invocation of the compilation system for the operating system in use. Users may specify the compiler to invoke by setting the
CC environment variable to the name of the compiler. If the
CC environment variable is not defined when
buildobjclient is invoked, the default C++ language compile command for the operating system in use will be invoked to compile all
.c and
.cpp files.
Specifies that the buildobjclient command should work in verbose mode. In particular, it writes the compile command to its standard output.
|
Note:
|
The -f option may be specified multiple times.
|
|
Note:
|
The -l option may be specified multiple times.
|
This is in addition to the command line option "-I$(TUXDIR)/include" for UNIX systems or the
command line option
/I%TUXDIR%\include for Windows systems, which is passed automatically by the
buildobjclient command. If
CPPFLAGS does not exist in the
buildobjclient command environment, no compiler commands are added.
The buildobjclient command is not supported on client-only CORBA systems.
buildobjserver [-v] [-o name] [-f firstfile-syntax]
[-l lastfile-syntax] [-r rmname][-t]
Use the buildobjserver command to construct a CORBA server application. The command combines the files specified with the
-f and
-l options with the main routine and the standard CORBA libraries to form a server application. The server application is built using the default C++ compiler provided for the platform.
All specified .c and
.cpp files are compiled in one invocation of the compilation system for the operating system in use. Users may specify the compiler to be invoked by setting the
CC environment variable to the name of the compiler. If the
CC environment variable is not defined when
buildobjserver is invoked, the default C++ language compile command for the operating system in use is invoked to compile all
.c and
.cpp files.
Specifies that the buildobjserver command should work in verbose mode, and it writes the compile command to standard output.
Using the rmname value, the entry in
$TUXDIR/udataobj/RM or
%TUXDIR%\udataobj\RM automatically includes the associated libraries for the resource manager and sets up the interface between the transaction manager and the resource manager. The value
TUXEDO/SQL includes the libraries for the Oracle Tuxedo System/SQL resource manager. Other values can be specified as they are added to the resource manager table. If the
-r option is not specified, the null resource manager is used by default.
The buildobjserver command is not supported on client-only CORBA systems.
The following example shows how to use the CC and
CFLAGS environment variables with the
buildobjserver command. The example also shows how to link in the math library, using the
-f and
-lm options, in a Bourne or Korn shell (on a UNIX system):
buildserver—Constructs an Oracle Tuxedo ATMI server load module.
buildserver is used to construct an Oracle Tuxedo ATMI server load module. The command combines the files supplied by the
-f and
-l options with the standard server main routine and the standard Oracle Tuxedo ATMI libraries to form a load module. The load module is built by the
cc(1) command, which
buildserver invokes. (See
cc(1) in any UNIX system reference manual.) The options to
buildserver have the following meaning:
Specifies that buildserver should work in verbose mode. In particular, it writes the compilation command to its standard output.
Specifies one or more user files to be included in the compilation and link edit phases of buildserver first, before the Oracle Tuxedo ATMI libraries. If more than one file is specified, filenames must be separated by white space and the entire list must be enclosed in quotation marks. This option may be specified multiple times. The
CFLAGS and
ALTCFLAGS environment variables, described below, should be used to include any compiler options and their arguments.
If -C option is specified and the environment variable
COB is set to “
AcuCobol”, this option only accepts COBOL source files. Other user files, such as library files, C source files, etc, should be specified with environment variable “
TM_COB_CC_FILES”. See below “Environment Variable” section.
(See buildtms(1) for further details.) Using the
rmname value, the entry in
$TUXDIR/udataobj/RM is used to include the associated libraries for the resource manager automatically and to set up the interface between the transaction manager and resource manager properly. Other values can be specified as they are added to the resource manager table. If the
-r option is not specified, the default is to use the null resource manager. Refer to the
UBBCONFIG(5) reference page.
If -M is specified,
buildserver allows at most 32 types of resource managers. If more than 32 resource managers are specified with the
-r option, the previous resource manager is replaced and a warning message is printed.
buildserver ignores duplicate library by comparing the
library_names configured in RM file and prints a warning message.
-s { @
filename |
service[,
service...][:
func] | :
func } ]
A filename can be specified with the -s option by prefacing the filename with the ‘@’ character. Each line of this file is treated as an argument to the
-s option. You may put comments in this file. All comments must start with the ‘#’ character. This file can be used to specify all the functions in the server that may have services mapped to them.
The -s option may appear several times. Note that services beginning with the ‘.’ character are reserved for system use, and
buildserver will fail if the
-s option is used to include such a service in the server.
buildserver normally uses the
cc command to produce the
a.out. In order to allow for the specification of an alternate compiler,
buildserver checks for the existence of a shell variable named
CC. If
CC does not exist in
buildservercs environment, or if it is the string
"",
buildserver will use
cc as the compiler. If
CC does exist in the environment, its value is taken to be the name of the compiler to be executed. Likewise, the shell variable
CFLAGS is taken to contain a set of parameters to be passed to the compiler.
Keeps the server main stub.
buildserver generates a
main stub with data structures such as the service table and a
main() function. This is normally compiled and then removed when the server is built. This option indicates that the source file should be kept (to see what the source filename is, use the
-v option).
Specifies the __stdcall calling convention for the XA switch interfaces.
buildserver uses the environment variable
TUXDIR to find the Oracle Tuxedo ATMI libraries and include files to use during compilation of the server process.
buildserver normally uses the default C language compilation command to produce the server executable. The default C language compilation command is defined for each supported operating system platform and is defined as
cc(1) for the UNIX system. In order to allow for the specification of an alternate compiler,
buildserver checks for the existence of an environment variable named
CC. If
CC does not exist in the
buildserver environment, or if it is the string
"",
buildserver will use the default C language compiler. If
CC does exist in the environment, its value is taken to be the name of the compiler to be used.
The environment variable CFLAGS is taken to contain a set of arguments to be passed as part of the compiler command line. This is in addition to the command line option "
-I${TUXDIR}/include" passed automatically by
buildserver. If
CFLAGS does not exist in
buildserver’s environment, or if it is the string
"", no compiler command line arguments are added by
buildserver.
When the -C option is specified for COBOL compilation,
buildserver normally uses the Oracle Tuxedo shell
cobcc(1) which in turn calls
cob to produce the server executable. In order to allow for the specification of an alternate compiler,
buildserver checks for the existence of an environment variable named
ALTCC. If
ALTCC does not exist in
buildserver’s environment, or if it is the string
"",
buildserver will use
cobcc. If
ALTCC does exist in the environment, its value is taken to be the name of the compiler command to be executed.
|
Note:
|
On a Windows system, the ALTCC and ALTCFLAGS environment variables are not applicable and setting them will produce unexpected results. You must compile your application first using a COBOL compiler and then pass the resulting object file to the buildserver(1) command.
|
The environment variable ALTCFLAGS is taken to contain a set of additional arguments to be passed as part of the COBOL compiler command line when the
-C option is specified. This is in addition to the command line option "
-I${TUXDIR}/include" passed automatically by
buildserver. When the
-C option is used, putting compiler options and their arguments in the
buildserver -f option will generate errors; they must be put in
ALTCFLAGS. If not set, the value is set to the same value used for
CFLAGS, as specified above.
|
Note:
|
1. ALTCFLAGS only works for the MicroFocus COBOL compiler. For other supported COBOL compilers (i.e., IBMCOBOL or AccuCOBOL), CFLAGS is supported and is sufficient. 2. See the note under the description of the ALTCC environment variable.
|
The environment variable COBOPT is taken to contain a set of additional arguments to be used by the COBOL compiler, when the
-C option is specified.
The environment variable COBCPY indicates which directories contain a set of COBOL copy files to be used by the COBOL compiler, when the
-C option is specified.
The environment variable TM_COB_STATIC indicates whether shared version or static version
libcobatmi library to be linked by
buildserver. The environment variable value may be “
Yes” or “
No”. If “
Yes” is set, static version
libcobatmi library is used; otherwise shared version is used. If the environment variable is not specified, the shared version
libcobatmi library is used by default.
If “AcuCobol” is specified, the ACUCOBOL compiler is used. If “
IBMCobol” is specified, the IBMCOBOL compiler is used.
The environment variable TM_COB_VERSION indicates the ACUCOBOL compiler version. This environment variable takes effect only when
-C option is specified and the environment variable
COB is set to “
AcuCobol”. The value format of the environment variable is “
[0-9]+\.[0-9]”.
|
•
|
If TM_COB_VERSION value is less than 7.0, buildserver generates old style ACUCOBOL stub code; otherwise buildserver generates new style ACUCOBOL stub code.
|
|
•
|
If TM_COB_VERSION is not set, buildserver generates new style ACUCOBOL stub code by default.
|
When ACUCOBOL compiler is used, only COBOL source files can be specified with -f option. If there are other user files to be passed to
cc(1) in the compilation and link edit phases of
buildserver first, before the Oracle Tuxedo ATMI libraries, these files must be specified with the environment variable
TM_COB_CC_FILES. If more than one file is specified, filenames must be separated by white space and the entire list must be enclosed in quotation marks. The environment variable takes effect only when
-C option is specified and the environment variable
COB is set to “
AcuCobol”.
|
Note:
|
File direct.c is used by ACUCOBOL to access C external variables and functions in COBOL programs. If the programmer modified direct.c to support third party software, the modified direct.c must be stored under directory $ACUCOBOL/lib.
|
TM_COBOLIT_VERSION is taken to judge the COBOL compiler version. Set this environment variable when using COBOL-IT compiler 3.5 or higher; otherwise, the build will fail. Once you set it, Tuxedo will automatically specify
COBITOPT=-fno-main to compile COBOL main function.
The environment variable LD_LIBRARY_PATH indicates which directories contain shared objects to be used by the COBOL compiler, in addition to the Oracle Tuxedo shared objects. Some UNIX systems require different environment variables: for HP-UX systems, use the
SHLIB_PATH environment variable; for AIX, use
LIBPATH.
In earlier releases, the -g option was allowed to specify a
genoption of
sql or
database. For upward compatibility, this option is a synonym for the
-r option.
The buildserver compilation tool is supported on any platform on which the Oracle Tuxedo ATMI server environment is supported. RM XA libraries are not supported on the Windows platform.
Some compilation systems may require some code to be executed within the main(). For example, this could be used to initialize constructors in C++ or initialize the library for COBOL. A general mechanism is available for including application code in the server
main() immediately after any variable declarations and before any executable statements. This will allow for the application to declare variables and execute statements in one block of code. The application exit is defined as follows:
#ifdef TMMAINEXIT #include "mainexit.h" #endif. To use this feature, the application should include
"-DTMMAINEXIT" in the
ALTCFLAGS (for COBOL) or
CFLAGS (for C) environment variables and provide a
mainexit.h in the current directory (or use the
-I include option to include it from another directory).
The following example shows how buildserver can be supplied
CC and
CFLAGS variables and how
-f can be used to supply a
-lm option to the
CC line to link in the math library:
Listing 4 shows a general COBOL compiler example.
Listing 5 shows an ACUCOBOL compiler example.
Listing 6 shows an IBMCOBOL compiler example.
These commands build one of three TM_MQI,
TM_MQO, or
TMQUEUE_MQM servers. The default output location is
$TUXDIR/bin/TM_MQI,
$TUXDIR/bin/TM_MQO, or
$TUXDIR/bin/TMQUEUE_MQM. This may be changed using the
-o option.
Specifies the resource manager name associated with the MQ Adapter servers. The value rm_name must appear in the resource manager table located at
$TUXDIR/udataobj/RM. The entry associated with the
rm_name value is used to include the correct libraries for the resource manager automatically and properly to set up the interface between the transaction manager and resource manager (using the
xa_switch_t structure). The default value for this parameter is
MQSeries_XA_RMI.
buildtms—Constructs a transaction manager server load module.
buildtms [ -v ] -o name -r rm_name [-z]
buildtms is used to construct a transaction manager server load module.
rm_name:rm_structure_name:library_names
where rm_name is the resource manager name,
rm_structure_name is the name of the
xa_switch_t structure, and
library_names is the list of object files for the resource manager. White space (tabs and/or spaces) is allowed before and after each of the values and may be embedded within the
library_names. The colon (
:) character may not be embedded within any of the values. Lines beginning with a pound sign (
#) are treated as comments and are ignored.
Specifies that buildtms should work in verbose mode. In particular, it writes the
buildserver command to its standard output and specifies the
-v option to
buildserver.
Specifies the resource manager associated with this server. The value rm_name must appear in the resource manager table located in
$TUXDIR/udataobj/RM. The entry associated with the
rm_name value is used to include the correct libraries for the resource manager automatically and properly to set up the interface between the transaction manager and resource manager (using the
xa_switch_t structure).
Specifies the __stdcall calling convention for the XA switch interfaces.
buildtms uses the
buildserver command to produce the
a.out.
buildserver uses the
CC and
CFLAGS environment variables, if set, for the compiler and compiler flags, respectively. See
buildserver(1) for further details.
buildtms is supported as an Oracle Tuxedo system-supplied compilation tool on any platform on which the Oracle Tuxedo ATMI or CORBA server environment is supported. RM XA libraries are not supported on the Windows platform.
buildwsh—Builds customized workstation handler process.
buildwsh [
-v ] [
-o name] [
-f files]
buildwsh is used to construct a customized Oracle Tuxedo ATMI workstation handler module. The files included by the caller should include only the application buffer type switch and any required supporting routines. The command combines the files supplied by the
-f option with the standard Oracle Tuxedo ATMI libraries necessary to form a workstation handler load module. The load module is built by the
cc(1) command described in UNIX system reference manuals, which
buildwsh invokes. The options to
buildwsh have the following meaning:
Specifies that buildwsh should work in verbose mode. In particular, it writes the
cc command to its standard output.
Specifies one or more user files to be included in the compilation and/or link edit phases of buildwsh. Source files are compiled using the either the
cc command or the compilation command specified through the
CC environment variable. Object files resulting from compilation of source files and object files specified directly as arguments to the
-f option are included after all object files necessary to build a base workstation handler process and before the Oracle Tuxedo ATMI libraries. If more than one file is specified, filenames must be separated by white space and the entire list must be enclosed in quotation marks. This option can be specified multiple times.
buildwsh normally uses the
cc command to produce the
a.out. In order to allow for the specification of an alternate compiler,
buildwsh checks for the existence of a shell variable named
CC. If
CC does not exist in
buildwsh’s environment, or if it is the string "",
buildwsh will use
cc as the compiler. If
CC does exist in the environment, its value is taken to be the name of the compiler to be executed. Likewise, the shell variable
CFLAGS is taken to contain a set of parameters to be passed to the compiler.
The buildwsh compilation tool is supported on any platform on which the Oracle Tuxedo ATMI server environment is supported.
cc(1), ld(1) in a UNIX system reference manual
cobcc—COBOL compilation interface.
cobcc [
option . . . ]
filename . . .
cobcc is used as an interface shell to the COBOL compiler. It is invoked, by default, when
buildclient(1) or
buildserver(1) is executed with the
-C (COBOL) option. This can be overridden by specifying the
ALTCC environment variable.
The following list indicates the options recognized by cobcc. To use these options, set the environment variable
ALTCFLAGS to the string of options to be recognized by
cobcc when running
buildclient or
buildserver. Consult your documentation for the COBOL and C compilers to see what effect the various options have.
|
Note:
|
On a Windows system, the ALTCC and ALTCFLAGS environment variables are not applicable and setting them will produce unexpected results. You must compile your application first using a COBOL compiler and then pass the resulting object file to the buildclient(1) or buildserver(1) command.
|
Note that for cobcc, unlike
cc and
cob, all options must come before any filenames.
The argument may consist of up to three comma-separated fields. If the first part of the argument is -
p or -
0, it is passed to the C compiler. If it starts with -
a, it is passed to the assembler. If it starts with -
l, it is passed to the loader. If it starts with -
C, it is passed to the COBOL compiler. Otherwise, it is passed through to the C compiler.
cc(1) in a UNIX system reference manual
cpy2record—Generates Oracle Tuxedo RECORD description file from copybook file.
With -i option, if
#vname is not specified in copybook file,
rname is not converted to lowcase as the default
vname; without
-i option,
rname is converted to lowercase.
Before using cpy2record, add
TUXDIR/bin and Java command
java to system environment
PATH.
dmadmin—Oracle Tuxedo Domains Administration Command Interpreter.
dmadmin [
-c ] [-2] [-s] [-e]
dmadmin is an interactive command interpreter used for the administration of domain gateway groups defined for a particular Oracle Tuxedo application involved in a Domains configuration. This page describes the use of
dmadmin for TDomain gateways, SNA Gateways (SNAX), and OSI TP gateways of the Oracle Tuxedo Domains component. For a description of the Oracle Tuxedo Domains component, see
Using the Oracle Tuxedo Domains Component.
dmadmin can operate in two modes: administration mode and configuration mode.
dmadmin enters
administration mode when called with no parameters. Administration mode is the default mode. In this mode,
dmadmin can be run on any active node (excluding workstations) within an active application. Application administrators can use this mode to obtain or change parameters on any active domain gateway group. Application administrators may also use this mode to create, destroy, or re-initialize the Domains transaction log for a particular local domain access point. In this case, the domain gateway group associated with that local domain access point must not be active, and
dmadmin must be run on the machine assigned to the corresponding gateway group.
dmadmin requires the use of the Domains administrative server (
DMADM) for the administration of the
BDMCONFIG file, and the gateway administrative server (
GWADM) for the reconfiguration of active domain gateway groups. There is one
DMADM process running for each Oracle Tuxedo application involved in a Domains configuration, and there is one
GWADM process running for each domain gateway group.
dmadmin enters
configuration mode when it is invoked with the
-c option or when the
config subcommand is invoked. Application administrators can use this mode to update or add new configuration information to the binary version of the Domains configuration file (
BDMCONFIG).
Once dmadmin has been invoked, commands may be entered at the prompt (“>”) according to the following syntax:
Output from dmadmin commands is paginated according to the pagination command in use (see the
paginate subcommand in the discussion that follows).
Allows all configured events (-all) or a specified event (named
event) to be sent out to remote domains. These events are configured with
LACCESSPOINT=
local_domain_name in “
*DM_EVT_OUT” section.
Activates (on) or deactivates (
off) the audit trace for the named local domain access point. If no option is set, the current setting is toggled between the values
on and
off, and the new setting is printed. The initial setting is
off.
connect (co) -d local_domain_access_point_name
[
-R remote_domain_access_point_name]
|
Note:
|
When DMCONFIG(5) DMTLOGDEV is set to export tlog info to Oracle database, DMTLOG is no longer automatically created.
|
Prints help messages. If command is specified, the abbreviation, arguments, and description for that command are printed. Omitting all arguments causes the syntax of all commands to be displayed.
passwd (passwd) [
-r ]
local_domain_access_point_name
remote_domain_access_point_name [
LDOM RDOM |
-2 |
–s <start-time> -e <end-time>]
Adds password pair 1 (or password pair 2 if -2 is included) for the TDOMAIN session
<LDOM, RDOM>. The password becomes valid at
<start-time>, and expires at
<end-time>. If an old password pair 1 exists, this command fails.
Activates (on), deactivates (
off), or resets (
reset) statistics gathering for the named local domain access point. If no option is given, the current setting is toggled between the values
on and
off, and the new setting is printed. The initial setting is
off.
Forbids all configured events (-all) or a specified event (named
event) to be sent out to remote domains. These events are configured with
LACCESSPOINT=local_domain_name in “
*DM_EVT_OUT” section.
The dmadmin command enters configuration mode when executed with the
-c option or when the
config subcommand is used. In this mode,
dmadmin allows run-time updates to the
BDMCONFIG file.
dmadmin manages a buffer that contains input field values to be added or retrieved, and displays output field values and status after each operation completes. The user can update the input buffer using any available text editor.
dmadmin first prompts for the desired section followed by a prompt for the desired operation.
20) EVENTS_IN 21) EVENTS_OUT
q) QUIT
Enter Section [1]:
dmadmin then prompts for the desired operation.
|
1.
|
FIRST—retrieves the first record from the specified section. No key fields are needed (they are ignored if in the input buffer).
|
|
2.
|
NEXT—retrieves the next record from the specified section, based on the key fields in the input buffer.
|
|
3.
|
RETRIEVE—retrieves the indicated record from the specified section by key field(s) (see fields description below).
|
|
4.
|
ADD—adds the indicated record in the specified section. Any fields not specified (unless required) take their defaults as specified in DMCONFIG(5). The current value for all fields is returned in the output buffer. This operation can only be done by the Oracle Tuxedo administrator.
|
|
5.
|
UPDATE—updates the record specified in the input buffer in the selected section. Any fields not specified in the input buffer remain unchanged. The current value for all fields is returned in the input buffer. This operation can only be done by the Oracle Tuxedo administrator.
|
|
6.
|
DELETE—deletes the record specified in the input buffer from the selected section. This operation can only be done by the Oracle Tuxedo system administrator.
|
|
7.
|
NEW SECTION—clears the input buffer (all fields are deleted). After this operation, dmadmin immediately prompts for the section again.
|
|
8.
|
QUIT—exits the program gracefully ( dmadmin is terminated). A value of q for any prompt also exits the program.
|
dmadmin then prompts you to indicate whether you want to edit the input buffer:
Entering a value of y puts the input buffer into a temporary file and executes the text editor. The environment variable
EDITOR is used to determine which editor is to be used; the default is
ed, a UNIX text editor. The input format is a set of field name/field value pairs and is described in the
Configuration Input Format. The field names associated with each
DMCONFIG section are listed in tables in the subsections that follow. The semantics of the fields and associated ranges, defaults, restrictions, and so on are described in
DMCONFIG(5), and
DM_MIB(5). In many cases, the field name is the same as the
KEYWORD in the
DMCONFIG file, prefixed with "
TA_". When the user completes editing the input buffer,
dmadmin reads it. If more than one line is included for a particular field name, the first line is used and other lines are ignored. If any errors occur, a syntax error is printed and
dmadmin prompts you to indicate whether you want to edit the file to correct the problem:
Finally, dmadmin asks whether the operation should be executed:
When the operation completes, dmadmin prints the return value as in
Return value TAOK followed by the output buffer fields. The process then begins again with a prompt for the section. All output buffer fields are available in the input buffer unless the buffer is cleared.
When "QUIT" is selected,
dmadmin prompts for authorization to create a backup text version of the configuration file:
On success, dmadmin indicates that a backup was created; otherwise, an error is printed.
The following sections describe, for each DMCONFIG section, the field identifiers associated with each
DMCONFIG field, the field type of each identifier, and when each field can be updated. All applicable field values are returned with the retrieval operations. Fields that are allowed and/or required for adding a record are described in
DMCONFIG(5), and
DM_MIB(5). Fields indicated below as
key are key fields that are used to uniquely identify a record within section. These key fields are required to be in the input buffer when updates are done and are not allowed to be updated dynamically. The
Update column indicates when a field can be updated. The possible values are:
|
•
|
Yes—can be updated at any time.
|
|
•
|
NoGW—cannot be updated dynamically while the domain gateway group associated with the local domain access point is running.
|
|
•
|
No—cannot be updated dynamically while at least one domain gateway group is running.
|
Table 4 lists the fields in the
DM_LOCAL section (also known as the
DM_LOCAL_DOMAINS section). At the
dmadmin operation prompt, enter
2 (
LOCAL_DOMAINS) to access this section.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Format: {TDOMAIN | SNAX | OSITP | OSITPX}
|
|
|
|
|
With the improved DMCONFIG terminology, DOMAINID is known as ACCESSPOINTID.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Format: {ON_DEMAND | ON_STARTUP | INCOMING_ONLY}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
With the improved DMCONFIG terminology, MAXRDTRAN is known as MAXRAPTRAN.
|
|
|
|
|
|
|
|
|
|
Applicable to OSITP only; with the improved DMCONFIG terminology, MAXRDOM is known as MAXACCESSPOINT.
|
|
|
|
|
TDOMAIN (TDomain) format: { NONE | APP_PW | DM_PW}
SNAX (SNA) format: { NONE|DM_USER_PW}
OSITPX (OSI TP 4. x) format: { NONE|DM_PW}
|
Table 5 lists the fields in the
DM_REMOTE section (also known as the
DM_REMOTE_DOMAINS section). At the
dmadmin operation prompt, enter
3 (
REMOTE_DOMAINS) to access this section.
The DM_TDOMAIN section contains the network addressing parameters required by
TDOMAIN type domains.
Table 6 lists the fields in this section.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Can also be used together with TA_RDOM ( only when TA_RDOM is used to establish the remote domain access point name) as an option to establish a TDomain session.
|
|
|
|
|
Format: -1 <= num <= 32767
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Format: {LOCAL | ON_DEMAND | ON_STARTUP | INCOMING_ONLY}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* Available in Oracle Tuxedo release 8.1 or later.
** Takes precedence over same parameter in DM_LOCAL section.
*** Available in Oracle Tuxedo release 9.0 or later.
|
The DM_OSITP section contains the network addressing parameters for OSI TP 1.3 required by
OSITP type domains.
Table 7 lists the fields in this section.
The DM_OSITPX section contains the network addressing parameters for OSI TP 4.0 or later required by
OSITPX type domains.
Table 8 lists the fields in this section.
Table 9 lists the fields in the
DM_EXPORT section (also known as the
DM_LOCAL_SERVICES section). At the
dmadmin operation prompt, enter
4 (
LOCAL_SERVICES) to access this section.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Applicable to TDOMAIN, SNAX, OSITP, and OSITPX
|
|
|
|
|
Applicable to SNAX, OSITP, and OSITPX
|
|
|
|
|
Applicable to SNAX, OSITP, and OSITPX; “S” in BUFSTYPE stands for “subtype”
|
|
|
|
|
Applicable to SNAX, OSITP, and OSITPX
|
|
|
|
|
Applicable to SNAX, OSITP, and OSITPX; “S” in OBUFSTYPE stands for “subtype”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Applicable to OSITPX only; “S” in INRECSTYPE stands for “subtype”
|
|
|
|
|
|
|
|
|
|
Applicable to OSITPX only; “S” in OUTRECSTYPE stands for “subtype”
|
Table 10 lists the fields in the
DM_IMPORT section (also known as the
DM_REMOTE_SERVICES section). At the
dmadmin operation prompt, enter
5 (
REMOTE_SERVICES) to access this section.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Applicable to TDOMAIN, SNAX, OSITP, and OSITPX
|
|
|
|
|
|
|
|
|
|
Applicable to SNAX, OSITP, and OSITPX
|
|
|
|
|
Applicable to SNAX, OSITP, and OSITPX; “S” in BUFSTYPE stands for “subtype”
|
|
|
|
|
Applicable to SNAX, OSITP, and OSITPX
|
|
|
|
|
Applicable to SNAX, OSITP, and OSITPX; “S” in OBUFSTYPE stands for “subtype”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Applicable to OSITPX only; “S” in INRECSTYPE stands for “subtype”
|
|
|
|
|
|
|
|
|
|
Applicable to OSITPX only; “S” in OUTRECSTYPE stands for “subtype”
|
|
|
|
|
|
|
|
|
|
|
Table 11 lists the fields in the
DM_EVT_IN section.
Table 12 lists the fields in the
DM_EVT_OUT Section.
Table 13 lists the fields in the
DM_ROUTING section.
Table 14 lists the fields in the
DM_ACCESS_CONTROL section.
Table 15 lists the fields in the
DM_PASSWORDS section. This section only applies to TDomain gateways.
The TA_LPWD and
TA_RPWD show the existence of a defined password for the local and/or the remote domain access point. Passwords are not displayed. If an
UPDATE operation is selected, the value of the corresponding field must be set to
U. The program will then prompt with echo turned off for the corresponding passwords.
dmadmin fails if it cannot allocate an FML typed buffer, if it cannot determine the
/etc/passwd entry for the user, or if it cannot reset the environment variables
FIELDTBLS or
FLDTBLDIR.
The return value printed by dmadmin after each operation completes indicates the status of the requested operation. There are three classes of return values.
The calling process specified an ADD,
UPDATE, or
DELETE operation but it is not running as the Oracle Tuxedo administrator. Update operations must be run by the administrator (that is, the user specified in the
UID attribute of the
RESOURCES section of the
TUXCONFIG file).
When using dmunloadcf to print entries in the configuration, optional field values are not printed if they are not set (for strings) or 0 (for integers). These fields will always appear in the output buffer when using
dmadmin. In this way, it makes it easier for the administrator to retrieve an entry and update a field that previously was not set. The entry will have the field name followed by a tab but no field value.
In the following example, dmadmin is used to add a new remote domain access point. For illustration purposes,
ed(1) is used for the editor.
The dmadmin program ends.
If dmadmin is run using the
UID of the application administrator, it is assumed that the user is a trusted user and security is bypassed. If
dmadmin is run with another user ID, and the security option is enabled in the
TUXCONFIG file, the corresponding application password is required to start the
dmadmin program. If standard input is a terminal,
dmadmin will prompt the user for the password with echo turned off. If standard input is not a terminal, the password is retrieved from the environment variable,
APP_PW. If this environment variable is not specified and an application password is required,
dmadmin will fail to start.
dmadmin resets the
FIELDTBLS and
FLDTBLDIR environment variables to pick up the
${TUXDIR}/udataobj/dmadmin field table. Hence, the
TUXDIR environment variable should be set correctly.
The TUXCONFIG environment variable should be set to the pathname of the Oracle Tuxedo configuration file.
If the dmadmin command is entered before the system has been booted, the following message is displayed:
dmadmin then prompts for the corresponding commands.
dmadmin must be installed on Oracle Tuxedo release 5.0 or later. Other nodes in the same domain with a release 5.0 gateway may be Oracle Tuxedo release 4.1 or later.
The dmadmin administrative tool is supported on any platform on which the Oracle Tuxedo server environment is supported.
dmloadcf—Parses a
DMCONFIG file and loads a binary
BDMCONFIG configuration file.
dmloadcf [-c] [-n] [-y] [-b blocks] {DMCONFIG_file | - }
dmloadcf reads a file or standard input that is in
DMCONFIG syntax, checks the syntax, and optionally loads a binary
BDMCONFIG configuration file. The
BDMCONFIG environment variable points to the pathname of the
BDMCONFIG file where the information should be stored.
dmloadcf prints an error message if it finds any required section of the
DMCONFIG file missing. If a syntax error is found while the input file is being parsed,
dmloadcf exits without performing any updates to the
BDMCONFIG file.
dmloadcf requires the existence of the
$TUXDIR/udataobj/DMTYPE file. This file defines valid domain types. If this file does not exist,
dmloadcf exits without performing any updates to the
BDMCONFIG file.
The -c option to
dmloadcf causes the program to print the minimum amount of IPC resources needed for each local domain (gateway group) in this configuration. The
BDMCONFIG file is not updated.
The -n option to
dmloadcf causes the program to do only syntax checking of the text
DMCONFIG file without updating the
BDMCONFIG file.
After syntax checking, dmloadcf checks whether the file referenced by the
BDMCONFIG environment variable exists, is a valid Oracle Tuxedo file, and contains
BDMCONFIG tables. If these conditions are not true,
dmloadcf gives the user a chance to create and initialize the file by displaying the following prompt:
Initialize BDMCONFIG file:
path [y, q]?
Here path is the complete filename of the
BDMCONFIG file. Prompting is suppressed if the standard input and output are not directed to a terminal, or if the
-y option is specified on the command line. Any response other than “
y” or “
Y” causes
dmloadcf to exit without creating a binary configuration file.
If the BDMCONFIG file is not properly initialized, and the user has entered
y after the
Initialize BDMCONFIG file prompt,
dmloadcf creates the Oracle Tuxedo filesystem and creates the
BDMCONFIG tables. If the
-b option is specified on the command line, its argument defines the number of blocks for the device when the Oracle Tuxedo filesystem is created. If the value of the
-b option is large enough to hold the new
BDMCONFIG tables,
dmloadcf uses the specified value to create the new filesystem; otherwise,
dmloadcf prints an error message and exits. If the
-b option is not specified,
dmloadcf creates a new filesystem large enough to hold the
BDMCONFIG tables. The
-b option is ignored if the filesystem already exists. The
-b option is highly recommended if
BDMCONFIG is a raw device (that is, a device that has not been initialized). In this case,
-b should be used to set the number of blocks on the raw device. The
-b option is not recommended if
BDMCONFIG is a regular UNIX file.
If the BDMCONFIG file has been initialized already,
dmloadcf ensures that the local domain described by that
BDMCONFIG file is not running. If a local domain is running,
dmloadcf prints an error message and exits. Otherwise,
dmloadcf, to confirm that the file should be overwritten, prompts the user with:
“Really overwrite BDMCONFIG file [y, q]?”
If the SECURITY parameter is specified in the
RESOURCES section of the
TUXCONFIG file,
dmloadcf flushes the standard input, turns off terminal echo, and prompts the user for an application password as follows:
Enter Application Password? The password is limited to 30 characters. The option to load the text
DMCONFIG file via the standard input (rather than a file) cannot be used when this
SECURITY parameter is turned on. If the standard input is not a terminal, that is, if the user cannot be prompted for a password (as with a
here file, for example), the environment variable
APP_PW is accessed to set the application password. If the environment variable
APP_PW is not set with the standard input not a terminal,
dmloadcf will print an error message, generate a log message and fail to load the
BDMCONFIG file.
For backwards compatibility, aliases are provided between the DMCONFIG terminology used prior to Oracle Tuxedo 7.1 and the improved Domains MIB terminology. In Oracle Tuxedo 7.1 or later,
dmloadcf accepts both versions of the
DMCONFIG terminology. By default,
dmunloadcf generates a
DMCONFIG file that uses the improved domains terminology. Use the
-c option of
dmunloadcf to generate a
DMCONFIG file that uses the previous domains terminology.
The dmloadcf administrative tool is supported on any platform on which the Oracle Tuxedo server environment is supported.
The BDMCONFIG environment variable should point to the
BDMCONFIG file.
If dmloadcf is run on an active node, the following error message is displayed:
If dmloadcf is run by a person whose effective user identifier does not match the
UID specified in the
TUXCONFIG file, the following error message is displayed:
Upon successful completion, dmloadcf exits with exit code 0. If the
BDMCONFIG file is updated, a
userlog message is generated to record this event.
dmunloadcf—Unloads the binary
BDMCONFIG Domains configuration file.
dmunloadcf translates the
BDMCONFIG configuration file from the binary representation into text. This translation is useful for transporting the file in a compact way between machines with different byte orderings, and for making a backup copy of the file in a compact form for reliability. The text format is the same as that described in
DMCONFIG(5).
dmunloadcf reads values from the
BDMCONFIG file referenced by the
BDMCONFIG environment variable and writes them to standard output.
For Oracle Tuxedo release 7.1 or later, dmunloadcf, by default, generates a
DMCONFIG file that uses the improved domains terminology. For details, see the following section, “Domains Terminology Improvements.” Use the
-c option to generate a
DMCONFIG file that uses the previous domains terminology.
For backward compatibility, aliases are provided between the DMCONFIG terminology used prior to Oracle Tuxedo 7.1 and the improved Domains MIB terminology. In Oracle Tuxedo 7.1 or later,
dmloadcf accepts both versions of the
DMCONFIG terminology. By default,
dmunloadcf, generates a
DMCONFIG file that uses the improved domains terminology. Use the
-c option of
dmunloadcf to generate a
DMCONFIG file that uses the previous domains terminology.
The dmunloadcf command is supported on any platform on which the Oracle Tuxedo server environment is supported.
dmunloadcf checks that the file referenced by the
BDMCONFIG environment variable exists, is a valid Oracle Tuxedo filesystem, and contains
BDMCONFIG tables. If any of these conditions is not met,
dmunloadcf prints an error message and exits with error code 1. Upon successful completion,
dmunloadcf exits with exit code 0.
gencat—Generates a formatted message catalog.
gencat [-m] catfile msgfile . . .
The gencat utility merges the message text source file(s)
msgfile into a formatted message database
catfile. The database
catfile is created if it does not already exist. If
catfile does exist its messages are included in the new
catfile. If set and message numbers collide, the new message text defined in
msgfile replaces the old message text currently contained in
catfile. The message text source file (or set of files) input to
gencat can contain either set and message numbers or simply message numbers, in which case the set
NL_SETD (see
nl_types(5)) is assumed.
Where n specifies the set identifier of the following messages until the next
$set,
$delset, or end-of-file appears.
n must be a number in the range (
1-{NL_SETMAX}). Set identifiers within a single source file need not be contiguous. Any string following the set identifier is treated as a comment. If no
$set directive is specified in a message text source file, all messages are located in the default message set.
NL_SETD.
Deletes message set n from an existing message catalog. Any string following the set number is treated as a comment. (Note: if
n is not a valid set it is ignored.)
The m denotes the message identifier, which is a number in the range (
1-{NL_MSGMAX}). (Do not confuse this message text syntax with the
-m command line option described under
NOTES.) The message text is stored in the message catalog with the set identifier specified by the last
$set directive, and with message identifier
m. If the message text is empty, and an ASCII space or tab field separator is present, an empty string is stored in the message catalog. If a message source line has a message number, but neither a field separator nor message text, the existing message with that number (if any) is deleted from the catalog. Message identifiers need not be contiguous. The length of message text must be in the range (
0-{NL_TEXTMAX}).
This line specifies an optional quote character c, which can be used to surround message text so that trailing spaces or null (empty) messages are visible in a message source line. By default, or if an empty
$quote directive is supplied, no quoting of message text is recognized. Empty lines in a message text source file are ignored. Text strings can contain the special characters and escape sequences defined in the following table.
The escape sequence \ddd consists of a backslash followed by 1, 2, or 3 octal digits, which are taken to specify the value of the desired character. If the character following a backslash is not one of those specified, the backslash is ignored.
gencat is supported on any platform on which the Oracle Tuxedo server environment is supported.
This version of gencat produces a catalog that at run time is read into
malloc’ed space. Shared catalogs available with some versions of
gencat are not available. On some systems, generation of
malloc’ed catalogs requires that the
-m option be specified. This option can be specified on the command line, but has no effect.
malloc’ed catalogs are the default; the
-m option is supported for compatibility only.
genicf—Generates an Implementation Configuration File (ICF).
genicf [options] idl-filename...
Given the idl-filename(s), generates an ICF file that provides the code generation process with additional information about policies on implementations and the relationship between implementations and the interface they implement. If an ICF file is provided as input to the
idl command, the
idl command generates server code for only the implementation/interface pairs specified in the ICF file.
-D identifier=[definition]
Performs the same function as the #define C++ preprocessor directive; that is, the
-D option defines a token string or a macro to be substituted for every occurrence of a given identifier in the definition file. If a definition is not specified, the identifier is defined as 1. Multiple
-D options can be specified. White space between the
-D option and the identifier is optional.
There are two types of #include OMG IDL preprocessor directives: system (for example,
<a.idl>) and user (for example,
"a.idl"). On UNIX systems, the path for system
#include directories is
/usr/include and any directories specified with the
-I option; the path for user
#include directives is the location of the file containing the
#include directive, followed by the path specified for the system
#include directive. On Windows 2003 systems, no distinction is made between the system
#include directories and the user
#include directives.
idl—Compiles the Object Management Group (OMG) Interface Definition Language (IDL) file and generates the files required for the interface.
idl [-i] [-D identifier[=value]] [-I pathname][-h] [-P] [-T]
idl-filename... [ icf-filename...]
Given the provided idl-filename() file(s) and optional
icf-filename() file(s), the
idl command generates the following files:
The IDL compiler overwrites the generated client stub files (filename_c.cpp and
filename_c.h), and the generated server skeleton files (
filename_s.cpp and
filename_s.h). Any previous versions are destroyed.
When using the -i option, the IDL compiler overwrites the sample implementation class definition file (
filename_i.h). Previous versions are destroyed. The sample implementation file (
filename_i.cpp) is overwritten, however, any code contained within the code preservation blocks is preserved and restored in the newly generated file. To avoid the loss of data, it is recommended that you copy the sample implementation files (
filename_i.h and
filename_i.cpp) to a safe location before regenerating these files.
-D identifier[=definition]
Performs the same function as the #define C++ preprocessor directive; that is, the
-D option defines a token string or a macro to be substituted for every occurrence of a given identifier in the definition file. If a definition is not specified, the identifier is defined as 1. Multiple
-D options can be specified. White space between the
-D option and the name is optional.
There are two types of #include OMG IDL preprocessor directives:
system (for example,
<a.idl>) and
user (for example,
"a.idl"). The path for system
#include directories is the system include directory and any directories specified with the
-I option. The path for user
#include directives is the location of the file containing the
#include directive, followed by the path specified for the system
#include directive.
Results in idl-filename_i.cpp files being generated. These files contain example templates for the implementations that implement the interfaces specified in the OMG IDL file.
|
Note:
|
When using the idl command -i option to update your implementation files, proceed as follows to update your implementation files:
|
|
5.
|
If you previously made modifications to the implementation definition file (*_i.h), edit the newly generated definition file and add your modifications back in. Be sure to put your modifications inside the code preservation blocks so subsequent updates will automatically retain them. Pay particular attention to the implementation constructor and destructor functions; the function signatures changed in Oracle Tuxedo release 7.1.
|
Not having the Tobj_ServantBase class in the inheritance tree for a servant means that the servant does not have
activate_object and
deactivate_object methods. In CORBA servers these methods are called by the TP Framework to dynamically initialize and save a servant's state before invoking a method on the servant. For CORBA joint client/servers, user-written code must explicitly create a servant and initialize a servant's state; therefore, the
Tobj_ServantBase operations are not needed. When using the
-P option, ICF files are not used because the TP Framework is not available.
idl2ir—Creates the Interface Repository and loads interface definitions into it.
idl2ir [options] definition-filename-list
[-f repository-name] [-c]
[-D identifier[=definition]]
[-I pathname [-I pathname] [...]] [-N{i|e}]
-D identifier[=definition]
Performs the same function as the #define preprocessor directive; that is, the
-D option defines a token string or a macro to be substituted for every occurrence of a given identifier in the definition file. If a definition is not specified, the identifier is defined as 1.You can specify multiple
-D options.
There are two types of #include OMG IDL preprocessor directives: system (for example,
<a.idl>) and user (for example,
"a.idl"). The path for system
#include directives is
/usr/include for UNIX systems, and any directories specified with the
-I option. The path for system
#include directives is the local directory for Windows NT systems, and any directories specified with the
-I option.
The path for user #include directives is the current directory and any directories specified with the
-I option. Multiple
-I options can be specified.
[-f repository-name] [-n]
[-t interface-type] [-o filename]
irdel [-f repository-name] [-i id] object-name
The repository id for the specified object. The
id is used as a secondary level of lookup. If the
id does not match the
id of the named object, the object is not deleted.
mkfldcs,
mkfldcs32—Creates C# header files from field tables
mkfldcs is similar to
mkfldhdr except its output file is used to generate C# source files which contain public classes including the definitions for every FML field ID provided in the input files.
mkfldhdr,
mkfldhdr32—Creates header files from field tables.
mkfldhdr [
-d outdir] [
field_table... ]
mkfldhdr32 [
-d outdir] [
field_table... ]
mkfldhdr translates each field table file to a corresponding header file suitable for inclusion in C programs. The resulting header files provide
#define macros for converting from field names to field IDs. Header filenames are formed by concatenating a
.h to the simple filename for each file to be converted.
If the field table names are not given on the command line, the program uses the FIELDTBLS environment variable as the list of field tables to be converted, and
FLDTBLDIR environment variable as a list of directories to be searched for the files.
FIELDTBLS specifies a comma-separated list of field table filenames. If
FIELDTBLS has no value,
fld.tbl is used as the name of the (only) field table file (in this case, the resulting header file will be (
fld.tbl.h).
The FLDTBLDIR environment variable is a colon-separated list of directories in which to look for each field table whose name is not an absolute pathname; the search for field tables is very similar to the search for executable commands using the UNIX system
PATH variable. If
FLDTBLDIR is not defined, only the current directory is searched. Thus, if no field table names are specified on the command line and
FIELDTBLS and
FLDTBLDIR are not set,
mkfldhdr will convert the field table
fld.tbl in the current directory into the header file
fld.tbl.h.
mkfldhdr32 is used for 32-bit FML. It uses the
FIELDTBLS32 and
FLDTBLDIR32 environment variables.
mkfldhdr produces the
#include files
maskftbl.h,
DBftbl.h, and
miscftbl.h in the current directory by processing the files
maskftbl,
DBftbl, and
miscftbl in directory
/project/fldtbls.
The command mkfldhdr myfieldsprocesses the input file
myfields and produces
myfields.h in the current directory.
mklanginfo—Compiles language information constants for a locale.
mklanginfo reads input lines, ignoring lines that begin with white space or ‘#’. Value input lines must be of the form:
The characters between the token and the double-quoted
value can be anything but a double quote as long as white space appears after the token. If
value is the null string, the line is ignored. Otherwise,
token must be either an integer between 1 and 48, inclusive, or a string, as follows:
Integer String Value 1
DAY_1 Day 1 of the week, for example, Sunday 2
DAY_2 Day 2 of the week, for example, Monday 3
DAY_3 Day 3 of the week, for example, Tuesday 4
DAY_4 Day 4 of the week, for example, Wednesday 5
DAY_5 Day 5 of the week, for example, Thursday 6
DAY_6 Day 6 of the week, for example, Friday 7
DAY_7 Day 7 of the week, for example, Saturday 8
ABDAY_1 Abbreviated day 1 of the week, for example, Sun 9
ABDAY_2 Abbreviated day 2 of the week, for example, Mon 10
ABDAY_3 Abbreviated day 3 of the week, for example, Tue 11
ABDAY_4 Abbreviated day 4 of the week, for example, Wed 12
ABDAY_5 Abbreviated day 5 of the week, for example, Thu 13
ABDAY_6 Abbreviated day 6 of the week, for example, Fri 14
ABDAY_7 Abbreviated day 7 of the week, for example, Sat 15
MON_1 Month 1 of the year, for example, January 16
MON_2 Month 2 of the year, for example, February 17
MON_3 Month 3 of the year, for example, March 18
MON_4 Month 4 of the year, for example, April 19
MON_5 Month 5 of the year, for example, May 20
MON_6 Month 6 of the year, for example, June 21
MON_7 Month 7 of the year, for example, July 22
MON_8 Month 8 of the year, for example, August 23
MON_9 Month 9 of the year, for example, September 24
MON_10 Month 10 of the year, for example, October 25
MON_11 Month 11 of the year, for example, November 26
MON_12 Month 12 of the year, for example, December 27
ABMON_1 Abbreviated month 1 of the year, for example, Jan 28
ABMON_2 Abbreviated month 2 of the year, for example, Feb 29
ABMON_3 Abbreviated month 3 of the year, for example, Mar 30
ABMON_4 Abbreviated month 4 of the year, for example, Apr 31
ABMON_5 Abbreviated month 5 of the year, for example, May 32
ABMON_6 Abbreviated month 6 of the year, for example, Jun 33
ABMON_7 Abbreviated month 7 of the year, for example, Jul 34
ABMON_8 Abbreviated month 8 of the year, for example, Aug 35
ABMON_9 Abbreviated month 9 of the year, for example, Sep 36
ABMON_10 Abbreviated month 10 of the year, for example, Oct 37
ABMON_11 Abbreviated month 11 of the year, for example, Nov 38
ABMON_12 Abbreviated month 12 of the year, for example, Dec 39
RADIXCHAR Radix character, for example, '.' 40
THOUSEP Separator for thousands 41
YESSTR Affirmative response string, for example, yes 42
NOSTR Negative response string, for example, no 43
CRNCYSTR Currency symbol 44
D_T_FMT string for formatting date and time, for example, “%a%b%d%H:%M:0Y” 45
D_FMT string for formatting date, for example, “%m/%d/%y” 46
T_FMT string for formatting time, for example, “H:%M:%S” 47
AM_FMT Ante Meridian affix, for example, AM 48
PM_FMT Post Meridian affix, for example, PM
After processing the file, mklanginfo prints the string name and string value for each language information constant shown in the previous code listing to the standard error in the order specified in the listing. The null string is used as a value for any language information constant not specified;
nl_langinfo uses the default value for the C locale (U.S. English values) for these unset constants.
If a filename is specified on the command name, mklanginfo writes the
compiled output to
fname.
out; otherwise, the output is written to the standard output. The format is a list of all of the null-terminated string values (without newlines).
$TUXDIR/locale/C/lang.text—the default values for the C locale
$TUXDIR/locale/C/LANGINFO—the “compiled” file for the C locale
$TUXDIR/locale/xx/LANGINFO—the “compiled” file for the
xx locale
The mklanginfo command and the resulting
LANGINFO file are needed only if the Oracle Tuxedo system compatibility functions for
setlocale(),
strftime(), or
nl_langinfo() are used. The functions provided with the UNIX system use a different set and format of files.
qmadmin—Queue manager administration program.
[QMCONFIG=
<device>]
qmadmin [
<device>]
With the commands listed in this entry, qmadmin supports the creation, inspection, and modification of message queues. The universal device list (UDL) maps the physical storage space on a machine on which the Oracle Tuxedo ATMI system is run. An entry in the UDL points to the disk space in which the queues and messages of a queue space are stored. The name of the device (file) on which the UDL resides (or will reside) for the queue space may be specified either as a command line argument or via the environment variable
QMCONFIG. If both are specified, the command option is used.
As a system-provided command, qmadmin does not undergo normal initialization, so it does not pick up the value of
ULOGPFX from the
UBBCONFIG file. As a result, any log entries generated by
qmadmin commands are written to the current working directory. This is corrected by setting and exporting the
ULOGPFX environment variable to the pathname of the directory in which the userlog is located.
qmadmin uses the greater than sign (
>) as a prompt. Arguments are entered separated by white space (tabs and/or spaces). Arguments that contain white space may be enclosed within double quotes; if an argument enclosed within double quotes contains a double quote, the internal double quote must be preceded with a backslash. Commands prompt for required information if it is not given on the command line. A warning message is displayed and the prompt shown again, if a required argument is not entered. Commands do not prompt for information on optional parameters.
A user can exit the program by entering q or <
CTRL-d> when prompted for a command. Output from a command may be terminated by pressing BREAK; the program then prompts for the next command. Hitting return when prompted for a command repeats the previously executed command, except after a break.
Output from qmadmin commands is paginated according to the pagination command in use (see the
paginate subcommand below).
When qmadmin is initially entered, no queue space is opened. To create a queue space, run
qspacecreate; to open it, run
qopen. The
qaborttrans,
qclose,
qchangeprio,
qchangequeue,
qchangetime,
qchangeexptime,
qcommittrans,
qchange,
qcreate,
qdeletemsg,
qinfo,
qlist,
qprinttrans and
qset commands can be executed only when a queue space is open.
chdl [
dlindex [
newdevice]]
crdl [
device [
offset [
size]]]
Destroys an entry found in the universal device list. The dlindex argument is the index on the universal device list of the device that is to be removed from the device list. If it is not provided on the command line, the program prompts for it. Entry 0 cannot be removed until all
VTOC files and other device list entries are destroyed. (Because entry 0 contains the device that holds the device list and table of contents, destroying it also destroys these two tables.)
VTOC files can be removed only by removing the associated entities (for example, by destroying a queue space that resides on the device). The program prompts for confirmation unless
-y is specified.
Prints help messages. If a command is specified, the abbreviation, arguments, and description for that command are printed. The
all argument causes a description of all commands to be displayed.
ipcrm [
-f] [
-y] [
queue_space_name]
Prints information for all VTOC table entries. The information printed for each entry includes the name of the
VTOC table, the device on which it is found, the offset of the
VTOC table from the beginning of the device and the number of pages allocated for that table. There are a maximum of 100 entries in the
VTOC.
qchange [
-d persist|
nonpersist] [
-n nhigh,nlow,ncmd]
[
-e default_relative_expiration_time]
[
queue_name [
out-of-order [
retries [
delay [
high [
low [
cmd]]]]]]]
The threshold values are used to allow for automatic execution of a command when a threshold is reached for persistent messages. The high limit specifies when the command is executed. The low limit must be reached before the command is executed again when the high limit is reached. For example, if the limits are 100 and 50 messages, the command is executed when 100 messages are on the queue, and it is not executed again until the queue is drained down to 50 messages and is filled again to 100 messages. The queue capacity can be specified in bytes or blocks used by the queue (number followed by a b or
B suffix), percentage of the queue space used by the queue (
number followed by a
%), or total number of messages on the queue (
number followed by an
m). The threshold type for the high and low threshold values must be the same. It is optional whether or not the type is specified on the low value, but if specified, it must match the high value type. The message (
m) suffix spans both persistent and non-persistent messages. The other threshold suffixes apply only to persistent messages. Use the
-n option to specify threshold values for non-persistent messages. When specified on the command line, the threshold command should be enclosed in double quotation marks if it contains white space. The retry count indicates how many times a message can be dequeued and the transaction rolled back, causing the message to be put back on the queue. A delay between retries can also be specified. When the retry count is reached, the message is moved to the error queue defined for the queue space. If no error queue has been defined, the message is dropped. The queue ordering values for the queue cannot be changed. Low-priority messages are dequeued after every ten messages, even if the queue still contains high-priority messages.
The -d option specifies the default delivery policy for the queue. The valid values for the
-d option are
persist and
nonpersist. When the default delivery policy is
persist, enqueued messages with no explicitly specified delivery mode are delivered using the persistent (disk-based) delivery method. When the policy is
nonpersist, enqueued messages with no explicitly specified delivery mode are delivered using the non-persistent (in memory) delivery method. If the
-d option is not specified, the system does not prompt for information and the default delivery policy is unchanged. When the default delivery policy is modified, the delivery quality of service is not changed for messages already in the queue. If the queue being modified is the reply queue named for any messages currently in the queue space, the reply quality of service is not changed for those messages as a result of changing the default delivery policy of the queue.
If the amount of memory reserved for non-persistent messages in a queue space is zero (0), no space is reserved for non-persistent messages. (See
qspacecreate and
qspacechange for information on specifying the non-persistent message memory area.) In this case, attempts to enqueue a non-persistent message fail. This includes messages with no specified delivery quality of service for which the target queue has a default delivery policy of
nonpersist.
The -n option specifies the threshold values used for automatic execution of a command when a non-persistent storage area threshold is reached. The
nhigh limit specifies when the command
ncmd is executed. The
nlow limit must be reached before the command will be executed again when the
nhigh limit is reached. If the
-n option is specified, the
nhigh,
nlow, and
ncmd values must all be supplied, or the command fails. The
ncmd value may be specified as an empty string.
If the
-n option is not specified, the program does not prompt for information.
The m suffix of the [ . . . [
high[
low[
cmd]]] . . . ] thresholds applies to all messages in a queue, including both persistent and non-persistent messages, and therefore is not available with
nhigh and
nlow. The [ . . . [
high[
low[
cmd]]] . . . ] thresholds specified without the
-m suffix apply to persistent (disk-based) messages only.
The -e default_relative_expiration_time option sets an expiration time for all messages enqueued to the queue that do not have an explicitly specified expiration time. The expiration time may be either a relative expiration time or
none. When the expiration time is reached and the message has not been dequeued or administratively deleted, the message is removed from the queue, all resources associated with the message are reclaimed by the system, and statistics are updated. If the expiration time is before the message availability time, the message is not available for dequeuing unless either the availability or expiration time is changed so that the availability time is before the expiration time. In addition, these messages are removed from the queue at expiration time even if they were never available for dequeuing. If a message expires during a transaction, the expiration does not cause the transaction to fail. Messages that expire while being enqueued or dequeued within a transaction are removed from the queue when the transaction ends. There is no notification when a message has expired.
If the -e option is not specified, the default expiration time of the queue is not changed. When the queue’s expiration time is modified using
qchange, the expiration times for messages already in the queues are not modified. If the
-e option is not specified, the program does not prompt for it.
The format of a relative default_relative_expiration_time is
+seconds where
seconds is the number of seconds from the time that the queue manager successfully completes the operation to the time that the message expires. A value of zero (
0) indicates immediate expiration.The value of
default_relative_expiration_time may also be set to the string
none. The
none string indicates that messages that are enqueued with no explicit expiration time will not expire unless an expiration time is explicitly assigned to them.
The queue for which an expiration time is set is selected using the qset command. Selection criteria for limiting the messages to be updated are set with the
qscan command. If no selection criterion is set, all messages on the queue are changed. By default, a confirmation is requested before the expiration time is set. The
-y option specifies no prompt for confirmation. The
newtime value can be relative to either the current time, an absolute value, or
none. If the
newtime value is not provided on the command line, the program prompts for it.
A relative expiration time is relative to when the request arrives at the queue manager process. The format of a relative newtime is
+seconds where
seconds is the number of seconds from the time that the queue manager successfully completes the operation to the time that the message expires. If
seconds is set to zero (
0), messages expire immediately. An absolute expiration time is determined by the clock on the machine where the queue manager process resides. The format of an absolute
newtime is
YY[
MM[
DD[
HH[
MM[
SS]]]]] as described in
qscan. The value of
newtime may also be set to the string
none, which indicates that affected messages never expire.
Moves messages to a different queue within the same queue space. The queue from which messages are moved is set using the qset command and the selection criteria for limiting the messages to be moved are set using the
qscan command. If no selection criteria are set, all messages on the queue are moved: confirmation is requested before this is done unless the
-y option is specified. It is recommended that the
qlist command be executed to see what messages will be moved (this reduces typographical errors). The
newqueue value specifies the name of the queue to which messages will be moved. If
newqueue is not specified on the command line, the program prompts for it. The delivery quality of service of a message is not changed to match the default delivery policy of
newqueue.
If no selection criteria are set, all messages on the queue are changed: confirmation is requested before this is done unless the -y option is specified. It is recommended that the
qlist command be executed to see what messages will be modified (this reduces typographical errors). The
newtime value can be either relative to the current time or an absolute value. If not provided on the command line, the program will prompt for it. The format of a relative
onetime is
+seconds where
seconds is the number of seconds from now that the message is to be executed (0 implies immediately). The format of an absolute
newtime is
YY[
MM[
DD[
HH[
MM[
SS]]]]], as described in
qscan.
qcreate (
qcr) [
-d persist|
nonpersist] [
-n nhigh,nlow,ncmd]
[
-e default_relative_expiration_time]
[
queue_name [
qorder [
out-of-order [
retries [
delay
[
high [
low [
cmd]]]]]]]]
The queue ordering values are fifo,
lifo,
priority,
expiration, and
time. When specifying the queue ordering, the most significant sort value must be specified first, followed by the next most significant sort value, and so on;
fifo or
lifo can be specified only as the least significant (or only) sort value. If neither
fifo or
lifo is specified, the default is
fifo within whatever other sort criteria are specified. If
expiration is specified, messages with no expiration time are dequeued after all messages with an expiration time. Multiple sort values may be specified separated by commas. The out-of-order values are
none,
top, or
msgid. Both
top and
msgid may be specified, separated by a comma.
The queue capacity can be specified in bytes or blocks used by the queue (number followed by a b or
B suffix), percentage of the queue space used by the queue (
number followed by a
%), or total number of messages on the queue (
number followed by an
m). The threshold type for the high and low threshold values must be the same. The message (
m) suffix spans both persistent and non-persistent messages. The other threshold suffixes apply only to persistent messages. Use the
-n option to specify threshold values for non-persistent messages. It is optional whether or not the type is specified on the low value, but if specified, it must match the high value type. When specified on the command line, the threshold command should be enclosed in double quotation marks if it contains white space.
The -d option specifies the default delivery policy for the queue. The valid values for the
-d option are
persist and
nonpersist. When the default delivery policy is
persist, enqueued messages with no explicitly specified delivery mode are delivered using the persistent (disk-based) delivery method. When the policy is
nonpersist, enqueued messages with no explicitly specified delivery mode are delivered using the non-persistent (in memory) delivery method. If the
-d option is not specified, the system does not prompt for information and the default delivery policy for the queue is
persist. When the default delivery policy is modified, the delivery quality of service is not changed for messages already in the queue.
If the amount of memory reserved for non-persistent messages in a queue space is zero (0), no space is reserved for non-persistent messages. (See
qspacecreate and
qspacechange for information on specifying the non-persistent message memory area.) In this case, attempts to enqueue a non-persistent message fail. This includes messages with no specified delivery quality of service for which the target queue has a default delivery policy of
nonpersist.
The -n option specifies the threshold values used for automatic execution of a command when a non-persistent storage area threshold is reached. The
nhigh limit specifies when the command
ncmd is executed. The
nlow limit must be reached before the command will be executed again when the
nhigh limit is reached. If the
-n option is specified, the
nhigh,
nlow, and
ncmd values must all be supplied, or the command fails. The
ncmd value may be specified as an empty string.
If the
-n option is not specified, the program does not prompt for information.
The m suffix of the [ . . . [
high[
low[
cmd]]] . . . ] thresholds applies to all messages in a queue, including both persistent and non-persistent messages, and therefore is not available with
nhigh and
nlow. The [ . . . [
high[
low[
cmd]]] . . . ] thresholds specified without the
-m suffix apply to persistent (disk-based) messages only.
The -e default_relative_expiration_time option sets an expiration time for all messages enqueued to the queue that do not have an explicitly specified expiration time. The expiration time may be either a relative expiration time or
none. When the expiration time is reached and the message has not been dequeued or administratively deleted, the message is removed from the queue, all resources associated with the message are reclaimed by the system, and statistics are updated. If the expiration time is before the message availability time, the message is not available for dequeuing unless either the availability or expiration time is changed so that the availability time is before the expiration time. In addition, these messages are removed from the queue at expiration time even if they were never available for dequeuing. If a message expires during a transaction, the expiration does not cause the transaction to fail. Messages that expire while being enqueued or dequeued within a transaction are removed from the queue when the transaction ends. There is no notification when a message has expired.
If the -e option is not specified, the default expiration time of the queue is set to
none. When the queue’s expiration time is modified using
qchange, the expiration times for messages already in the queues are not modified. If the
-e option is not specified, the program does not prompt for it.
The format of a relative default_relative_expiration_time is
+seconds where
seconds is the number of seconds from the time that the queue manager successfully completes the operation to the time that the message expires. A value of zero (
0) indicates immediate expiration.The value of
default_relative_expiration_time may also be set to the string
none. The
none string indicates that messages that are enqueued with no explicit expiration time will not expire unless an expiration time is explicitly assigned to them.
Deletes messages from a queue. The queue is specified using the qset command. The selection criteria for limiting the messages to be deleted are set using the
qscan command. If no selection criteria are set, all messages on the queue are deleted: confirmation is requested before this is done. It is recommended that the
qlist command be executed to see what messages will be deleted (this reduces typographical errors). This command prompts for confirmation unless the
-y option is specified.
qdestroy (
qds) [{
-p | -f }] [
-y] [
queue_name]
qscan [{ [
-t time1[
-time2]] [
-p priority1[
-priority2]] [
-m msgid]
[
-i corrid][
-d delivery_mode] [
-e time1[
-time2]] |
none }]
Sets the selection criteria used for the qchangeprio,
qchangequeue,
qchangetime,
qdeletemsg, and
qlist commands. An argument of
none indicates no selection criteria; all messages on the queue will be affected. Executing this command with no argument prints the current selection criteria values. When command line options give a value range (for example,
-t,
-e, or
-p) the value range may not contain white space. The
-t option can be used to indicate a time value or a time range. The format of
time1 and
time2 is:
YY[
MM[
DD[
HH[
MM[
SS]]]]] specifying the year, month, day, hour, minute, and second. Units omitted from the date-time value default to their minimum possible values. For example, “7502” is equivalent to “750201000000.” The years 00-37 are treated as 2000-2037, years 70-99 are treated as 1970-1999, and 38-69 are invalid. The
-p option can be used to indicate a priority value or a priority range. Priority values are in the range 1 to 100, inclusive. The
-m option can be used to indicate a message identifier value, assigned to a message by the system when it is enqueued. The message identifier is unique within a queue and its value may be up to 32 characters in length. Values that are shorter than 32 characters are padded on the right with nulls (0x0). Backslash and non-printable characters (including white space characters such as space, newline, and tab) must be entered with a backslash followed by a two-character hexadecimal value for the character (for example, space is \20, as in “
hello\20world”). The
-i option can be used to indicate an correlation identifier value associated with a message. The identifier value is assigned by the application, stored with the enqueued message, and passed on to be stored with any reply or error message response such that the application can identify responses to particular requests. The value may be up to 32 characters in length. Values that are shorter than 32 characters are padded on the right with nulls (0x0). Backslash and non-printable characters (including white space characters such as space, newline, and tab) must be entered with a backslash followed by a two-character hexadecimal value for the character (for example, space is \20, as in
my\20ID\20value).
The valid values for the -d delivery_mode option are
persist and
nonpersist. This option specifies the delivery mode of messages selected by
qscan so that an operator can take action based on the delivery method.
The -e option can be used to indicate an expiration time or an expiration time range. The format of
time1 and
time2 is the same as
time1 and
time2 for the
-t option.
qsize [
‑A actions] [
‑H handles] [
‑C cursors] [
‑O owners] [
‑Q tmp_queues]
[
‑f filter_memory] [
-n nonpersistent_msg_memory[
b,B]] [
‑o overflow_memory][
pages [
queues [
transactions [
processes [
messages]]]]]
qspacechange (
qspch)
[
‑A actions] [
‑H handles] [
‑C cursors] [
‑O owners]
[
‑Q tmp_queues] [
‑f filter_memory] [
-n nonpersistent_msg_memory[
b,B]]
[
‑o overflow_memory][
queue_space_name [
ipckey [
trans [
procs [
messages [
errorq [
inityn [
blocking]]]]]]]]
qspacecreate (
qspc) [
‑A actions] [
-n nonpersistent_msg_memory[
b,B]]
[
‑o overflow_memory][
queue_space_name [
ipckey [
pages [
queues [
trans
[
procs [
messages [
errorq [
inityn [
blocking]]]]]]]]]]
The number of physical pages requested is rounded down to the nearest multiple of four pages. For example, a request of 50 pages results in a memory allocation of 48 pages, and a request of 52 pages results in a memory allocation of 52 pages. The error queue is used to hold messages that have reached the maximum number of retries (they are moved from their original queue to the error queue). The administrator is responsible for ensuring that this queue is drained.
The –A actions option specifies the number of additional actions that the Queuing Services component can handle concurrently. When a blocking operation is encountered and additional actions are available, the blocking operation is set aside until it can be satisfied. After setting aside the blocking operation, another operation request can be handled. When the blocking operation completes, the action associated with the operation is made available for a subsequent operation. An operation fails if a blocking operation is requested and cannot be immediately satisfied and there are no actions available. The system reserves actions equivalent to the number of processes that can attach to a queue space so that each queue manager process may have at least one blocking action. Beyond the system-reserved number of blocking actions, the administrator may configure the system to be able to accommodate additional blocking actions beyond the reserve. If the
–A actions option is not specified, the default is zero. If the
–A option is not specified, the program does not prompt for it.
The -n nonpersistent_msg_memory option specifies the size of the area to reserve in shared memory for non-persistent messages for all queues in the queue space. The size may be specified in bytes (
b) or blocks (
B), where the block size is equivalent to the disk block size. The [
bB] suffix is optional and, if not specified, the default is blocks. If the
-n option is not specified, the memory size defaults to zero (
0). Also, if the
-n option is not specified, the program does not prompt for it.
If the value is specified in bytes (b) for
nonpersistent_msg_memory, the system divides the specified value by the number of bytes per page (page size is equivalent to the disk page size), rounds down the result to the nearest integer, and allocates that number of pages of memory. For example, assuming a page size of 1024 bytes (1KB), a requested value of 2000b results in a memory allocation of 1 page (1024 bytes), and a requested value of 2048b results in a memory allocation of 2 pages (2048 bytes). Requesting a value less than the number of bytes per page results in an allocation of 0 pages (0 bytes).
If the value is specified in blocks (B) for
nonpersistent_msg_memory and assuming that one block of memory is equivalent to one page of memory, the system allocates the same value of pages. For example, a requested value of 50B results in a memory allocation of 50 pages.
If the nonpersistent_msg_memory for a queue space is zero (
0), no space is reserved for non-persistent messages. In this case, attempts to enqueue a non-persistent message fail. Persistent and non-persistent storage are not interchangeable. If a non-persistent message cannot be enqueued due to an exhausted or fragmented memory area, the enqueuing operation fails, even if there is sufficient persistent storage for the message. If a persistent message cannot be enqueued due to an exhausted or fragmented disk, the enqueuing operation fails, even if there is sufficient non-persistent storage for the message.
The –o overflow_memory option specifies the size of the memory area to reserve in shared memory to accommodate peek load situations where some or all of the allocated shared memory resources are exhausted. The memory size is specified in bytes. Additional objects will be allocated from this additional memory on a first-come-first-served basis. When an object created in the additional memory is closed or destroyed, the memory is released for subsequent overflow situations. If the
–o overflow_memory option is not specified, the default is zero. If the
–o option is not specified, the program does not prompt for it. This additional memory space may yield more objects than the configured number, but there is no guarantee that additional memory is available for any particular object at any given point in time. Currently, only actions, handles, cursors, owners, temporary queues, timers, and filters use the overflow memory.
qspacedestroy (
qspds) [
-f] [
-y] [
queue_space_name]
Destroys the named queue space. If not provided on the command line, the program will prompt for it. If the specified queue space is open in qmadmin, it will be closed. By default, an error is returned if processes are attached to the queue space or if requests exist on any queues in the queue space. See the
qdestroy command for destroying queues that contain requests. The
-f option can be specified to “force” deletion of all queues, even if they may have messages or processes are attached to the queue space. This command prompts for confirmation before proceeding unless the
-y option is specified. All non-persistent messages in the specified queue space are lost when this command completes successfully.
(qspl) [
queue_space_name]
$ QMCONFIG=/dev/rawfs qmadmin
qmadmin - Copyright (c) 1987 ATT; 1991 USL. All rights reserved.
QMCONFIG=/dev/rawfs
# create the list of devices on which the queue space
# can exist; specify two devices, 80000 and 600
# blocks, respectively
# NOTE: the first one will actually contain the device list
#
# create first device on a raw slice
#
> crdl /dev/rawfs 0 80000
Created device /dev/rawfs, offset 0, size 80000 on /dev/rawfs
#
# create another device on a UNIX file
#
> crdl /home/queues/FS 0 600
Created device /home/queues/FS, offset 0, size 600 on /dev/rawfs
#
# if you want a list of the device list
#
> v Verbose mode is now on
> lidl
universal device index. 0:
name: /dev/rawfs
start: 0
size: 20000
free space map(1 entry used 47 available):
size[1]: 79974 addr[1]: 26
universal device index. 1:
name: /home/queues/FS
start: 0
size: 600
free space map(1 entry used 47 available):
size[1]: 600 addr[1]: 0
#
# create a queue space
#
> qspacecreate
Queue space name: myqueuespace
IPC Key for queue space: 42000
Size of queue space in disk pages: 50000
Number of queues in queue space: 30
Number of concurrent transactions in queue space: 20
Number of concurrent processes in queue space: 30
Number of messages in queue space: 20000
Error queue name: ERRORQ
Initialize extents (y, n [default=n]): y
Blocking factor [default=16]: 16
....................
#
# open queue space
#
> qopen myqueuespace
#
# use queue space defaults for queue
> qcreate
Queue name: service1
queue order (priority, time, fifo, lifo): fifo
out-of-ordering enqueuing (top, msgid, [default=none]): top,msgid
retries [default=0]: 1
retry delay in seconds [default=0]: 30
High limit for queue capacity warning (b for bytes used, B for blocks used,
% for percent used, m for messages [default=100%]): 100m
Reset (low) limit for queue capacity warning [default=0m]: 50
queue capacity command: /usr/app/bin/mailadmin myqueuespace service1
#
# get out of the program
#
> q
qmadmin is supported on any platform on which the Oracle Tuxedo ATMI server environment is supported.
In order to carry out a command that you have configured within a qmadmin() session, such as the
qchange ... Queue capacity command, the Windows
CreateProcess() function spawns a child process as a
DETACHED PROCESS. This type of process does
not have an associated console for standard input/output. Therefore, for instance, if you use standard command line syntax to set the
qchange ... Queue capacity command to run a built-in command (such as
dir or
date) and then pipe or redirect the standard output to a file, the file will be empty when the command completes.
qmadmin
> qopen yourQspace
> qchange
yourQname
>
go through all the setups... the threshold queue capacity warning,
and so on
> "Queue capacity command: " cmd /c date /t > x.out
qmadmin
> qopen yourQspace
> qchange
yourQname
>
go through all the setups... the threshold queue capacity warning,
and so on
> "Queue capacity command: "
yourFile.cmd
rex—Offline regular expression compiler and tester.
rex pattern [
file . . . ]
When invoked without arguments, rex reads regular expressions from the standard input and writes initialized character arrays to the standard output. Normally, the output is included in a C program. This saves on both execution time and program size. The command
rex compiles the regular expressions on the standard input (normally redirected from an input file) and writes the output to the standard output (normally redirected to an output file).
name string [
string . . .]
Here name is the C name to be used for the output array and
string is the regular expression enclosed with double quotes. Where more than one
string follows a
name they are concatenated into one
string. (Multiple
strings are strictly a formatting convenience.) If double quotes occur in the pattern they need to be preceded by a backslash.
/* pattern: “[a-aA-Z_][a-zA-Z0-9_]*" */
char cname[] = {
040,0,0206,012,0,0210,0141,0172,0210,0101,0132,0137,
... };
/* pattern: "\\\\(([0-9]{3})$0\\\\)([0-9]{3})$1-([0-9]{4})$2" */
char tn[] = {
063,0,050,0202,0225,013,0,03,0206,06,0,0210,060,071,
... };
rex can be used to try patterns against test data by invoking it with one or more arguments. The first argument is taken as a pattern (regular expression) to be applied to each line of the files whose names are mentioned in the remaining arguments. If no filename arguments are given the standard input is used. The special filename,
-, may be used as an argument to refer to the standard input.
tlisten [-d device] -l nlsaddr [-u {uid-# | uid-name}][-s][-n sec_principal_name][-c sec_principal_location][-p sec_principal_passvar] [-z bits] [-Z bits ][-j jmxaddr][-m jvm_min_mem][-M jvm_max_mem][-S][-C keyStore][-P keyStorePassword]
tlisten is a network-independent listener process that runs as a
daemon process on Oracle Tuxedo ATMI application processors and provides remote service connections for other Oracle Tuxedo ATMI processes, for example,
tmboot(1). The following command line options are used by
tlisten.
tlisten finds an address for
hostname using the local name resolution facilities (usually DNS).
hostname must be the local machine, and the local name resolution facilities must unambiguously resolve
hostname to the address of the local machine.
For IPv4, the string #.#.#.# is in dotted decimal format. In dotted decimal format, each
# should be a number from
0 to
255. This dotted decimal number represents the IP address of the local machine. In both of the above formats,
port_number is the TCP port number at which the
tlisten process listens for incoming requests. The value of
port_number can be either a name or a number between
0 and
65535.
If port_number is a name, it must be found in the network services database on your local machine. The address can also be specified in hexadecimal format when preceded by the characters “
0x”. Each character after the initial “
0x” is a number between
0 and
9 or a letter between
A and
F (case insensitive). The hexadecimal format is useful for arbitrary binary network addresses such as IPX/SPX or TCP/IP. The address can also be specified as an arbitrary string. The value should be the same as that specified for the
NLSADDR parameter in the
NETWORK section of the configuration file.
|
Note:
|
If the UBBCONFiG *Resources Section and tlisten SSL settings are not in sync, the application will not boot.
|
When using an Oracle wallet, this specifies the location of a directory that contains a subdirectory wallet.sec_principal_name where the Oracle Wallet for the principal name specified by the
-n option is located. When using the legacy Tuxedo security credential format, this specifies the location of the file or device where the decryption (private) key for the principal specified in
sec_principal_name resides. If the wallet or the private key is in a directory under
APPDIR, you can also use a relative path to specify this location.
The sec_principal_location parameter may contain a maximum of 1023 characters (excluding the terminating NULL character).
tlisten will run as the indicated user. This option supports the start up of
tlisten as part of system initialization by
root. This option is required if the user running
tlisten is
root. The
tlisten process can therefore be started by
root, and run as
root or
non-root. Non-
root users of the
tlisten command do not need to use the
-u option. Non-
root users can set the
-u option, but it can only be set to their own user ID and is effectively a no-op. Each instantiation of a
tlisten process on a processor is capable of supporting all Oracle Tuxedo ATMI applications that use the same application administrator user ID.
-z [
0 |
40 |
56 |
128|256]
-Z [
0 |
40 |
56 |
128|256]
jmxaddr specifies the address of RMI connector of embedded JMX agent. If the address has been occupied by another process, an error message is printed into ULOG and JMX agent fails to start up.
The tlisten process authenticates most service requests.
tlisten reads a file with a list of passwords, and any process requesting a service must present at least one of the passwords found in the file. If the
APPDIR environment variable is set, passwords is obtained from a file named
APPDIR/.adm/tlisten.pw.
If this file is not found, the system will look for TUXDIR/udataobj/tlisten.pw, which is created when the Oracle Tuxedo ATMI system is installed. A zero-length or missing password file disables password checking. When running in this insecure mode, the
tlisten and any process connecting to
tlisten will generate a userlog warning message.
Processes that request services from tlisten, such as
tmboot, find the passwords to be used during authentication in files on their own machines. They use the same methods as
tlisten to find their password files.
|
•
|
APPDIR is set to provide the location of the tlisten password file.
|
|
•
|
LD_LIBRARY_PATH must be set for SVR4 applications that use shared objects. It must be set to TUXDIR/lib prior to starting the tlisten process. Some UNIX systems require different environment variables: for HP-UX systems, use the SHLIB_PATH environment variable; for AIX, use LIBPATH.
|
|
•
|
TMUSEIPV6 is used to switch the IP version; n|N is the default IPv4 value, y|Y sets the IPv6 value. In MP mode, you must set TMUSEIPV6 to y|Y before executing tlisten on a slave machine.
|
|
•
|
TUXDIR must be set and exported before executing tlisten.
|
|
•
|
ULOGPFX can be used to direct the file in which log messages are placed.
|
One alternative method for starting the tlisten process is to start it manually. The
-u option can be omitted if the
tlisten process is started by the application administrator. Duplicate
tlisten command invocations using the same network address will terminate automatically and gracefully log an appropriate message.
Suppose the local machine on which the tlisten is being run is using TCP/IP addressing and is named
backus.company.com, with address
155.2.193.18. Further suppose that the port number at which the
tlisten should accept requests is
2334. Assume that port number
2334 has been added to the network services database under the name
bankapp-nlsaddr. The address specified by the
-l option can be represented as follows:
For a STARLAN network, a recommended address of
uname.
tlisten usually yields a unique name.
tlistpwd(1)—Used to add or change password(s) to the system-encrypted
tlisten.pw file.
Once a password is input, the tlisten.pw file is encrypted. If you want to add a new password, you must use
tlistpwd(1). It appends the new password to the end of
$TUXDIR/udataobj/tlisten.pw. To remove an existing password, you must delete the corresponding line in
tlisten.pw.
tlistpwd(1) is available on any platform where the Oracle Tuxedo ATMI server environment is supported
|
•
|
The $TUXDIR environment variable must be defined before invoking this command.
|
tmadmin—Oracle Tuxedo bulletin board command interpreter.
With the commands listed in this entry, tmadmin provides for the inspection and modification of bulletin boards and associated entities in a uniprocessor, multiprocessor, or networked environment. The
TUXCONFIG and
TUXOFFSET environment variables are used to determine the location and offset at which the Oracle Tuxedo configuration file is loaded.
tmadmin supports the following options:
If tmadmin is invoked with the
-c option, it enters configuration mode. The only valid commands are
default,
echo,
help,
quit,
verbose,
livtoc,
crdl,
lidl,
dsdl,
indl, and
dumptlog.
tmadmin may be invoked in this mode on any node, including inactive nodes. A node is considered active if
tmadmin can join the application as an administrative process or client (via a running
BBL).
The -r option instructs
tmadmin to enter the bulletin board as a client instead of as the administrator; in other words, it requests read-only access. This option is useful if you want to leave the administrator slot unoccupied.
Only one tmadmin process can be the administrator at a time. When the
-r option is specified by a user other than the Oracle Tuxedo administrator and security is turned on, the user is prompted for a password.
The -v option causes
tmadmin to display the Oracle Tuxedo version number and license number. After printing out the information,
tmadmin exits. If the
-v option is entered with either of the other two options, the others are ignored; only the information requested by the
-v option is displayed.
Normally, tmadmin may be run on any active node within an active application. If it is run on an active node that is partitioned or if there is no NLS available for the master node, commands are limited to read-only access to the local bulletin board. These command include
bbls,
bbparms,
bbstat,
default,
dump,
dumptlog,
echo,
help,
interfaceparms, printactiveobject, printclient,
printinterface, printfactory, printnet,
printqueue,
printroute, printserver,
printservice,
printtrans,
printgroup,
reconnect,
quit,
serverparms,
serviceparms, and
verbose, in addition to the configuration commands. If the partitioned node is the backup node for the
MASTER (specified as the second entry on the
MASTER parameter in the
RESOURCES section of the configuration file), the
master command is also available to make this node the
MASTER for this part of the partitioned application.
If the application is inactive, tmadmin can be run only on the
MASTER processor. In this mode, all of the configuration mode commands are available plus the
TLOG commands (
crlog,
dslog, and
inlog) and
boot.
Once tmadmin has been invoked, commands may be entered at the prompt (
>) according to the following syntax:
If machine is not set via the
default command, the
DBBL is addressed (the local BBL is used in a SHM configuration).
The machine value for a command can generally be obtained from the
default setting (
printserver is an example). A caution is required here, however, because some commands (the
TLOG commands, for example) act on devices found through
TUXCONFIG; a
default setting of
DBBL or
all results in an error. For some commands, such as
logstart, you must specify the value of
machine on the command line; the value does not appear as an argument to the
-m option.
Output from tmadmin commands is paginated according to the pagination command in use (see the description of the
paginate subcommand later in this entry).
There are some commands that have either verbose or terse output. The verbose command can be used to set the default output level. However, each command (except
boot,
shutdown, and
config) takes a
-v or
-t option to turn on verbose or terse output for that command only. When output is printed in terse mode, some information (for example,
LMID or
GROUP name, service name, or server name) may be truncated. This type of truncation is indicated by a plus sign, +, at the end of the value. The entire value may be seen by reentering the command in verbose mode.
aborttrans (
abort)
[ -yes ] [-g groupname[-R rmid]] tranindex
If groupname is specified (on the command line or by default), aborts the transaction associated with the specified transaction index
tranindex at the specified server group. Otherwise, notifies the coordinator of the transaction to abort the global transaction. If the transaction is known to be decided and the decision was to commit,
aborttrans will fail. The index is taken from the previous execution of the
printtrans command. To completely get rid of a transaction,
printtrans and
aborttrans must be executed for all groups that are participants in the transaction.
The -R rmid option is used to specify a resource manager when current group is a multiple resource manager group. The
-R option must be used with the
-g option, and
rmid must between
1 and
31 inclusive.
advertise (
adv)
{-q qaddress [ -g groupname ]
[-i srvid] | -g groupname -i srvid} [-f SINGLETON|SECONDARYRQ] service[:func]
Creates an entry in the service table for the indicated service. service may be mapped onto a function
func. If
qaddress is not specified, both
groupname and
srvid are required to uniquely identify a server. If this
service is to be added to an MSSQ set, all servers in the set will advertise the service. If all servers in an MSSQ set cannot advertise the service, the advertisement is disallowed. Services beginning with the character ‘.’ are reserved for use by system servers and will fail to be advertised for application servers.
If SINGLETON is specified, that indicates the service is the unique service in the domain. If
SECONDARYRQ is specified, that indicates the service can only be advertised on the secondary request queue.
Checks the integrity of all accessers of the bulletin board residing on machine machine, and the
DBBL as well.
bbclean gracefully removes dead servers and restarts them if they are marked as restartable. It also removes those resources no longer associated with any processes. As its last step,
bbclean causes the
DBBL to check the status of each
BBL. If any
BBL does not respond within
SCANUNIT seconds, it is marked as partitioned. To clean only the Distinguished bulletin board,
machine should be specified as
DBBL. In SHM mode,
bbclean restarts the
BBL, if it has failed; the
machine parameter is optional.
broadcast (
bcst)
[-m machine] [-u usrname] [-c cltname] [text]
changeload (
chl) [
-m machine] {
-q qaddress [
-g groupname]
[
-i srvid]
-s service |
-g groupname -i srvid -s service |
-I interface [
-g groupname]}
newload
Changes the load associated with the specified service or interface to newload. If
qaddress is not specified, both
groupname and
srvid must be specified. For CORBA environments,
interface may be specified. If
machine is set to
all or is not set, the change is made on all machines; otherwise, a local change is made on the specified
machine. Local changes are overridden by any subsequent global (or local) changes.
changemonitor (
chmo)
[-m machine] [-g groupname] [-i serverid] newspec
changepriority (
chp)
[-m machine] {-q qaddress [-g groupname]
[-i srvid] -s service | -g groupname -i srvid -s service | -I interface [-g groupname]} newpri
Changes the dequeuing priority associated with the specified service or interface to newpri. If
qaddress is not specified, both
groupname and
srvid must be specified. For CORBA environments,
interface may be specified. If
machine is set to
all or is not set, the change is made on all machines; otherwise, a local change is made on the specified
machine. Local changes are overridden by any subsequent global (or local) changes.
The -R rmid option is used to specify a resource manager when current group is a multiple resource manager group. The
-R option must be used with the
-g option, and
rmid must between
1 and
31 inclusive.
changetrantime (
chtt)
[-m machine] {-q qaddress [-g groupname] -
[-i srvid] -s service | -g groupname -i srvid -s service | -I interface [-g groupname]} newtlim
Commits the transaction associated with the specified transaction index tranindex at the specified server group.
committrans will fail if the transaction has not been precommitted at the specified server group or if the transaction is known to be abort-only. The index is taken from the previous execution of the
printtrans command. This command prompts for confirmation before proceeding unless the
-yes option is used.
The -R rmid option is used to specify a resource manager when current group is a multiple resource manager group. The
-R option must be used with the
-g option, and
rmid must between
1 and
31 inclusive.
crdl -b blocks -z config -o configoffset [
-O newdefoffset ] [
newdevice ]
Creates an entry in the universal device list. blocks specifies the number of physical blocks to be allocated on the device. The default
blocks value is initialized to 1000 blocks.
configoffset specifies the block number at which space may begin to be allocated. If the
-o option is not given and a default has not been set, the value of the environment variable
FSOFFSET is used. If
FSOFFSET is not set, the default is 0.
config points to the first device (which contains the device list); it must be an absolute pathname (starting with /). If the
-z option is not given and a default has not been set, the path named by the
FSCONFIG environment variable is used. The
newdevice argument to the
crdl command, if specified, points to the device being created; it must be an absolute pathname (starting with /). If this parameter is not given, the
newdevice defaults to the config device.
newdefoffset specified an offset to the beginning of
newdevice. If not specified with the
-O (capital O) option of default, the default is 0 (zero).
Creates the DTP transaction log for the named or default machine (it cannot be “DBBL” or “all”). An error is returned if a
TLOG is not defined for the machine on the configuration. This command references the
TUXCONFIG file to determine the Oracle Tuxedo file system containing the
TLOG, the name of the
TLOG in that file system, the offset, and the size (see
UBBCONFIG(5)).
default (
d)
[-g groupname] [-i srvid] [-m machine] [-u usrname] [-c cltname]
[-q qaddress] [-s service] [-b blocks] [-o offset] [-z config] [-a { 0 | 1 | 2}] [-I interface] [-B objectid] [-r routingname]
Sets the corresponding argument to be the default group name, server ID, machine, user name, client name, queue address, service name, device blocks, device offset, or UDL configuration device path (it must be an absolute pathname starting with /). See printservice for information on the
-a option. For CORBA environments, you can also set corresponding arguments to be the default object interface name, object ID, or factory-based routing name. When the objectID parameter is specified (with
-B), the machine argument (
-m) must also be specified. All defaults may be unset by specifying
* as an argument. If
machine has been set to a machine identifier, and later retrievals are to be done from the Distinguished bulletin board,
machine should be set to
DBBL. Unsetting the
machine (
-m *) is equivalent to setting it to
DBBL. If the
default command is entered with no arguments, the current defaults are printed.
dsdl [
-yes ]
-z config [
-o offset ]
dlindex
Destroys an entry found in the universal device list. The dlindex argument is the index on the universal device list of the device that is to be removed from the device list. Entry 0 cannot be removed until all
VTOC files and other device list entries are destroyed first (because entry 0 contains the device which holds the device list and table of contents, destroying it also destroys these two tables.)
config points to the device containing the universal device list; it must be an absolute pathname (starting with /). If the
-z option is not given and a default has not been set, the path named by the
FSCONFIG environment variable is used.
offset specifies an offset into
config. If the
-o option is not given and a default has not been set, the value of the environment variable
FSOFFSET is used. If
FSOFFSET is not set, the default is 0. This command prompts for confirmation before proceeding unless the
-yes option is used.
dslog (
dslg) [
-yes ]
-m machine
Destroys the DTP transaction log for the named or default machine (it cannot be “DBBL” or “all”). An error is returned if a
TLOG is not defined for the machine, if the application is not inactive, or if outstanding transaction records exist on the log. The term outstanding transactions means that a global transaction has been committed but an end-of-transaction has not yet been written. This command references the
TUXCONFIG file to determine the Oracle Tuxedo file system containing the
TLOG and name of the
TLOG in that filesystem. This command prompts for confirmation before proceeding unless the
-yes option is specified.
dumptlog (
dl)
-z config [ -o offset ] [ -n name ] [-g groupname[-R rmid]]
filename
Dumps a text version of the TLOG into the specified
filename. The
TLOG is located on the specified
config and
offset, and has the specified
name. If the
-n option is not given and a default has not been set, the name “TLOG” is used.
config points to the device containing the universal device list; it must be an absolute pathname (starting with /). If the
-z option is not given and a default has not been set, the path named by the
FSCONFIG environment variable is used.
The -o offset option can be used to specify an offset into
config. If the
-o option is not given and a default has not been set, the value of the environment variable
FSOFFSET is used. If
FSOFFSET is not set, the default is 0. If
groupname is specified, only log records for transactions where that group is the coordinator are dumped.
The -R rmid option is used to specify a resource manager when current group is a multiple resource manager group. The
-R option must be used with the
-g option, and
rmid must between
1 and
31 inclusive.
help (
h) [{
command |
all}]
Prints help messages. If command is specified, the abbreviation, arguments, and description for that command are printed.
all causes a description of all commands to be displayed. Omitting all arguments causes the syntax of all commands to be displayed.
initdl (
indl) [
-yes ]
-z config [
-o offset ]
dlindex
Re-initializes a device on the device list. The argument dlindex is the index of the device on the universal device list of the device that is to be reinitialized. All space on the specified device is freed; this means that any files, etc., stored on the device may be overwritten in the future so this command must be used cautiously. This command prompts for confirmation before proceeding unless the
-yes option is used.
config points to the device containing the universal device list; it must be an absolute pathname (starting with /). If the
-z option is not given and a default has not been set, the path named by the
FSCONFIG environment variable is used. The
-o offset option can be used to specify an offset into
config. If the
-o option is not given and a default has not been set, the value of the environment variable
FSOFFSET is used. If
FSOFFSET is not set, the default is 0.
inlog [
-yes ]
-m machine
Re-initializes the DTP transaction log for the named or default machine (it cannot be “DBBL” or “all”). An error is returned if a
TLOG is not defined for the machine or if the application is not inactive. If outstanding transactions exist on the
TLOG, data may be inconsistent across resource managers acting as participants in these transactions since the resource managers may abort the local transaction instead of correctly committing the transaction. This command references the
TUXCONFIG file to determine the Oracle Tuxedo filesystem containing the
TLOG and name of the
TLOG in that filesystem. This command prompts for confirmation before proceeding unless the
-yes option is specified.
lidl -z config [
-o offset ] [
dlindex ]
Prints information for all VTOC table entries. The information printed for each entry includes the name of the
VTOC table, the device on which it is found, the offset of the
VTOC table from the beginning of the device and the number of pages allocated for that table.
config points to the device containing the universal device list; it must be an absolute pathname (starting with /). If the
-z option is not given and a default has not been set, the path named by the
FSCONFIG environment variable is used. The
-o offset option can be used to specify an offset into
config. If the
-o option is not specified, the value of the environment variable
FSOFFSET is used. If
FSOFFSET is not set, the default is 0.
Reads the text version of a TLOG from the specified
filename (produced by
dumptlog) into the existing
TLOG for the named or
default machine (it cannot be “DBBL” or “all”).
Forces a warm start for the TLOG information on the specified
machine. This should normally be done following a
loadtlog and after disk relocation during server group migration.
If master is run on the backup node when partitioned, the backup node takes over as the acting master node and a DBBL is booted to take over administrative processing. If
master is run on the master node when the backup node is acting as the master, the DBBL is migrated to the master node, and the backup node is no longer the acting master node. This command prompts for confirmation before proceeding unless the
-yes option is specified.
The migrategroup command takes the name of a server group. If the configuration file specifies the
MIGRATE option and an alternate location for the group, all servers in
group_name are migrated to the alternate location. Servers must be shut down for migration with the following command:
The -R option retains server names in the bulletin board so that migration can be done. The migration can be canceled after the
shutdown -R by the following command:
The -cancel option deletes the server names from the bulletin board.
When the migratemachine command is used, all server groups located on
machine must have the same alternate location (otherwise
migrategroup must be used). Migration of an
LMID (that is, machine) that contains Domains gateway servers implies the migration of these gateway servers to the alternate
LMID. Specifying the
-cancel option causes a migration that is already in progress to be cancelled. In other words, the servers have been shut down—with the
tmshutdown -R command—but have not yet been migrated.
pclean first forces a
bbclean on the specified
machine to restart or clean up any servers that may require it. If
machine is partitioned, entries for processes and services identified as running on
machine are removed from all non-partitioned bulletin boards. If
machine is not partitioned, any processes or services that cannot be restarted or cleaned up are removed.
printclient (
pclt) [
-m machine] [
-u usrname]
[-c cltname][
-v]
pclt-v adds the heading “Network Address” and IP address number for remote client information output.
Print information about objects that are active in the domain. The information includes the object ID, interface name, service name, program name, group ID, process ID, and reference count. The command accepts an object ID and a machine ID as optional parameters. If no object ID is specified, information for all active objects is printed. If no machine ID is specified, information is provided for all active objects on the machine where the command is issued. Any object ID that contains over 128 characters is displayed as a 40-character, alphanumeric, hash value.
Print information about specified object interfaces, including the interface name, queue name, group ID, machine ID, routing name, and the number of requests done by the interface. The command accepts a machine name, group name, and interface name as optional parameters. If a machine name is specified, the number of active objects for the interface is printed. Otherwise, a hyphen (-) indicates that the information about active objects is unavailable. This command is only used in CORBA environments.
Prints network connection information. The default is to print information for all machines. The printnet command optionally takes a comma-separated list of machines (
LMIDs) as arguments. If such a list is provided, information is restricted to network connections involving the specified machines. For each machine, the information indicates whether the machine is partitioned. If a machine is not partitioned, information is printed indicating the other machines to which it is connected and counts of messages in and out.
Print information about factory-based routing definitions, including routing name, type, field, and ranges. If routingname is not specified, all existing routes are displayed. This commands prints routes for both Oracle TUXEDO data dependent routing and CORBA factory-based routing. The type field in the output displays
FACTORY for factory-based routing entries and
SERVER for data-dependent routing entries. When information for data-dependent routing entries has been requested in verbose mode, the output includes buffer type and field type. This command is only used in CORBA environments.
printserver (
psr)
[-m machine] [-g groupname[-R rmid]] [-i srvid] [-q
qaddress]
The -R rmid option is used to specify a resource manager when current group is a multiple resource manager group. The
-R option must be used with the
-g option, and
rmid must between
1 and
31 inclusive.
printservice (
psc)
[-m machine] [-g groupname[-R rmid]] [-i srvid]
The -R rmid option is used to specify a resource manager when current group is a multiple resource manager group. The
-R option must be used with the
-g option, and rmid must between
1 and
31 inclusive.
The -a option allows you to select the class of service:
-a0 limits the display to application services,
-a1 selects application services plus system services that can be called by an application,
-a2 selects both of those, plus system services that can be called by the Oracle Tuxedo system.
|
•
|
Group Name: Remote domain sequence number:Remote Group Number
|
printtrans (
pt)
[-g groupname[-R rmid]] [-m machine]
The -R rmid option is used to specify a resource manager when current group is a multiple resource manager group. The
-R option must be used with the
-g option, and
rmid must between
1 and
31 inclusive.
reconnect (
rco)
non-partitioned_machine1 partitioned_machine2
Initiates a new connection from the non-partitioned machine to the partitioned machine. reconnect forces a new connection from the non-partitioned machine to the partitioned machine. If a connection is already active, it is closed before the reconnect. This may cause in-transit messages to be lost, resulting in transaction timeouts. It is possible for a machine or network connection to be down, but the network interface driver will continue to accept and buffer requests without any error indication to the
BRIDGE. In this case,
reconnect will fail, forcing the
BRIDGE to recognize that the remote machine cannot be reached. Note that in most cases, after network problems are resolved, the
BRIDGE reconnects automatically, making manual intervention (with
reconnect) unnecessary.
resume (
res) {
-q qaddress |
-g groupname |
-i srvid |
-s service |
-I interface} . . .
Resumes (unsuspend) services. The -q,
-g,
-s,
-I, and
-i options can be used to restrict the resumed services to any combination of queue, group, service, interface (CORBA environments only), and server. (At least one of these options must be specified or have a default.) Thus the following command line provides a shortcut method of unsuspending all services advertised on the queue with the address
servq8:
The -R rmid option is used to specify a resource manager when current group is a multiple resource manager group. The
-R option must be used with the
-g option, and rmid must between
1 and
31 inclusive.
If MODEL SHM is specified in the configuration file,
shmstats can be used to assure more accurate statistics. When entered with no argument,
shmstats returns the present setting of the
TMACCSTATS flag of the
bbparms.options member of the bulletin board structure. This tells you whether statistics presently being gathered are exact or approximate. If the command is entered with
ex specified,
shmstats turns on the
TMACCSTATS flag, locks the bulletin board, and zeroes out the counters for server table, queue table, and service table entries.
suspend (
susp) {
-q qaddress |
-g groupname |
-i srvid |
-s service |
-I interface} . . .
Suspends services. The -q,
-g,
-s,
-I, and
-i options can be used to restrict the suspended services to any combination of queue, group, service, interface (CORBA environments only), and server (At least one of these options must be specified or have a default.) Thus the following command provides a shortcut method of suspending all services advertised on the queue with the address
servq8:
unadvertise (
unadv) {
-q qaddress [
-g groupname] [
-i srvid] |
-g groupname -i srvid}
service
Removes an entry in the service table for the indicated service. If
qaddress is not specified, both
groupname and
srvid are required to uniquely identify a server. Specifying either a queue or a particular server on that queue achieve the same results. If this
service is to be removed from a multiple server, single queue (MSSQ) set, the advertisement for
service is removed from all servers reading from t
