Oracle Tuxedo Plug-In for Oracle Virtual Assembly Builder

     Previous  Next    Open TOC in new window    View as PDF - New Window  Get Adobe Reader - New Window
Content starts here

Oracle Tuxedo Plug-In for Oracle Virtual Assembly Builder

The Oracle Tuxedo introspection plug-in examines a single or multiple-machine Oracle Tuxedo domain, and the Oracle Home Directory that it resides on. The Oracle Home Directory where Tuxedo is installed can also include the Tuxedo add-ons listed below, and those will also be examined:

A single machine domain and its Home Directory, including add-on products, are captured. For a multiple-machine Oracle Tuxedo domain, each machine must be introspected separately and wired into an assembly. See Wiring on page 1-5.

 


Versions Supported

Oracle Tuxedo Introspection Parameters

Table 1-1,  Oracle Tuxedo Plug-in Introspection Parameters, on page 1-2 lists the introspection parameters for the Oracle Tuxedo introspection plug-in:

Table 1-1  Oracle Tuxedo Plug-in Introspection Parameters
Parameter
Description
TUXDIR
Location where Oracle Tuxedo is installed.

Note: Before introspecting Tuxedo, exclude the directory, or make sure

    • all file permissions are correct, or
    • no extra files are located in TUXDIR.
TUXCONFIG
Location of the application configuration file, in compiled form. This contains the Tuxedo core configuration as well as a minimal set or values (APPDIR, etc.).
environmentScript
This script will be run before doing introspection to set the environment of the Tuxedo application. The script will be searched relative to the $APPDIR directory. As a result of running the script only known Tuxedo-related environment variables will be captured, so as to prevent things such as DISPLAY, or SHELL from being captured that could interfere on the target environment.
If not set, the plug-in will attempt to run a setenv.sh script (with that exact name) from the $APPDIR directory. This behavior will be exclusive, that is, only one script will be run at most.The plug-in will use the output of the env command, so care should be taken that such environment setting scripts' output may not interfere with the result of calling env.
If an environment script is not used, or is used but non-Tuxedo environment variables also need to be set, a well-known standard Java properties file named ovab-application.properties will be searched for in $APPDIR.
oracleClientDir
Location of Oracle Database client software installation, typically the directory in which the Oracle Instant client software has been unzipped. It is the user's responsibility to ensure that this is accurate, as the Tuxedo plug-in does not have the means to verify that this installation is valid.
tnsNamesLocation
Location of the TNSNAMES.ora client configuration file. This file is parsed and made a template which results in an Appliance Output being created if either the database name specified in the ubbconfig OPENINFO string or environment variable ORACLE_SID (in that order or priority) is found. Multiple OPENINFO/TNSNAMES.ora entries will result in multiple outputs being generated.
scriptWorkingDir
The working directory where the environment script will be run from. This is useful when scripts use the current working directory to determine path values.
artSecurityProfile
Location of security profile used by ART Batch or ART CICS.

 


Reference System Prerequisites

None.

 


Requirements

The following requirements apply to Oracle Tuxedo:

Base Image Requirements

The base system image OS version must match the version of the reference system.

Additionally, you must set IPC kernel parameters on the base system image according to the guidelines listed in Oracle Tuxedo: Installing the Oracle Tuxedo System.

ART CICS/Batch/IMS Applications Requiring Microfocus or COBOL IT

For ART CICS/Batch/IMS applications which require Microfocus or COBOL IT to be installed, you must create a new base image with Microfocus or COBOL IT pre-installed (the installation path is the same as it is on the reference system) based on the original Oracle Virtual Assembly Builder base image, and then use the new base image to create template for the ART CICS/Batch/IMS application.

Only by following this configuration procedure will ART CICS/Batch/IMS applications which require Microfocus/COBOL IT boot successfully on the deployed VM.

Requirements Related to Scaling

For TMA SNA, scaling is not applicable.

For ART Batch, scaling is applicable, except for one limitation: if the TMQUEUE server which monitors JES2QSPACE queue space runs on a slave machine, you should not use the scaling feature for that machine for ART Batch.

For ART CICS, not all servers are applicable for scaling. Refer to the ART CICS reference guide to determine whether scaling is applicable or not for specified servers of ART CICS.

For ART IMS, all servers are applicable for scaling. There is only one limitation applying to TMQUEUE server, which monitors queue spaces: if TMQUEUE server runs on a slave machine, you should not use the scaling feature for that machine for ART IMS.

 


Installation

Oracle Tuxedo Plug-In for Oracle Virtual Assembly Builder (OVAB) is installed together with Tuxedo in $ORACLE_HOME/tuxedo12.1.3.0.0/plugins/ovab/introspector/Tuxedo.

Note: Because OVAB only supports Linux X64 platforms, Oracle Tuxedo Plug-In for OVAB is only delivered with Tuxedo 12cR2 Linux X64 installer.

 


Resulting Artifact Type

The resulting artifact type depends on whether you introspect a single-machine or multi-machine domain.

Single-Machine Oracle Tuxedo Domain

A single scalable appliance for a single-machine Tuxedo domain.

Multi-Machine Oracle Tuxedo Domain

For multi-machine Tuxedo domains, each machine in the reference system must be introspected separately. The resulting appliances are of the following types:

To deploy the domain, an empty assembly must be created manually, or the appliances must be included in an existing assembly and the wiring performed.

 


Wiring

This section describes wiring.

Multi-Machine Wiring

Inputs will be created on a Master appliance for each machine (except itself) present in the reference system. These are required for non-Master appliances to obtain information on the Master appliance at rehydration time.

Outputs will be created on a Master appliance for each machine (except itself) present in the reference system. These are required for the Master appliance to obtain information on the non-Master appliances at rehydration time. Corresponding inputs and outputs will also be created on non-Master appliances.

These outputs must all be connected to an appliance before deployment. The name of the output and the protocol supported by the output will give hints about the type of appliance to connect the output to.

Other Inputs and Outputs

Inputs will be created on an Oracle Tuxedo appliance for the following types of configuration found:

These outputs must all be connected to either an external resource or to an appliance before deployment. The description on the output and the protocol supported by the output will give hints about the type of appliance to connect the output to.

 


Wiring Properties

All input endpoints have two editable properties - port and description, and one non-editable property - a list of protocols. The protocols indicate what sort of outputs can be connected to the input.

All output endpoints have one editable property - description, and two non-editable properties - protocol and singleton. The protocol indicates what sort of input can be connected to the output. Singleton indicates what sort of appliance the output can be connected to. If singleton is true, the output can only be connected to an input on an appliance that has a scalability absolute max value of 1.

The following properties are specific to Oracle Tuxedo endpoints (Table 1-2 through Table 1-3):

Table 1-2  Oracle Tuxedo: Appliance Output Properties: Domain
Name
Type
Req’d
Default
Description
existing-address
String
false
Address of the remote domain from the reference system.
Specifies the address of the remote domain this domain will connect to. Only used if the output is connected to an external resource.

The output for TMA_SNA and TSAM can only be connected to an external resource.

Table 1-3  Oracle Tuxedo: Appliance Output Properties: TMA_SNA
Name
Type
Req’d
Default
Description
tma-sna-crm-host
String
false
IP address of remote CRM Server from reference system.
Specifies the IP address of the remote CRM Server this machine will connect to. Only used if the output is connected to an external resource.
tma-sna-crm-port
String
false
Port of remote CRM Server from reference system.
Specifies the port of the remote CRM Server this machine will connect to. Only used if the output is connected to an external resource.
tma-sna-crm-address
String
false
Hex format IP Address and port of remote CRM Server from reference system.
Specifies Hex format IP Address and port of remote CRM Server this machine will connect to. Only used if the output is connected to an external resource.

Table 1-4  Oracle Tuxedo: Appliance Output Properties: TSAM
Name
Type
Req’d
Default
Description
tsam-manager-addr
String
false
IP Address of remote TSAM manager from reference system.
Specifies the IP Address of remote TSAM manager this machine will connect to. Only used if the output is connected to an external resource.
tsam-manager-port
String
false
Port of remote TSAM manager from reference system
Specifies the port of remote TSAM manager this machine will connect to. Only used if the output is connected to an external resource.

 


Oracle Tuxedo Appliance Properties

Oracle Tuxedo appliances have user properties (Table 1-5) and system properties (Table 1-6).

Table 1-5  Oracle Tuxedo: User Properties
Name
Type
Req’d
Default
Description
ALOGPFX
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
ALOGRTNSIZE
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
ALTCC
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
ALTCCFLAGS
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
applicationEnvVars
String
false
none
Applications can use this property to specify non-Tuxedo variables using comma-separated keyword/value pairs. For example:
CURRENCY=dollar,GROUPNAME=stdev,JDK=/my/jdk/path.
This property is populated by the ovab-application.properties file, if it exists in the $APPDIR directory.
applicationPassword
String
false
none
If the Tuxedo application uses security (that is, *RESOURCES is set to APP_PW, USER_AUTH, ACL or MANDATORY_ACL) then this user property must be set to capture the new password to be used at reconfiguration time.
COBCPY
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
COBDIR
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
COBOPT
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
dbPassword
String
false
none
Replacement value for database username when Tuxedo application has an OPENINFO set for Oracle databases (RM type of Oracle_XA in OPENINFO.)
For example:
For the following OPENINFO value:"Oracle_XA: Oracle_XA+Acc=P/Scott/*****+SesTm=30+SqlNet=instance1", the dbPassword property may be set in which case it is used to regenerate a new encrypted password.
dbUsername
String
false
none
Replacement value for database username when Tuxedo application has an OPENINFO set for Oracle databases (RM type of Oracle_XA in OPENINFO.)
For example:
For the following OPENINFO value:"Oracle_XA: Oracle_XA+Acc=P/Scott/*****+SesTm=30+SqlNet=instance1"the dbUsername property may be set to change "Scott" into a different value for the target machine.
FIELDTBLS
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
FIELDTBLS32
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
FLDTBLDIR
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
FLDTBLDIR32
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
FSCONFIG
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
FSMAXCOMMIT
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
FSMAXUPDATE
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
FSMSGREP
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
FSOFFSET
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
ISSANE
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
QMCONFIG
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
runtimeLoadLibraryPath
String
false
none
Populated with the contents of LD_LIBRARY_PATH after setting the environment. The format of this string is be the same as the actual LD_LIBRARY_PATH to be used on the target system.
shutdownScript
String
false
none
The name of a shutdown script that will be used in place of the tmshutdown -y command used on the target machine when it is stopped (after undeployment, or as a result of an Oracle Virtual Assembly Builder stop command).
startupScript
String
false
none
The name of a startup script that will be used in place of the tmboot -y command used on the target machine when it is started (after deployment or as a result of an Oracle Virtual Assembly Builder start command).
TAGENTLOG
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TM_CBL_IGNORE_CONTEXT
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TM_CPAU
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TM_ENGINE_TMSHMSEGSZ
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TM_GWT_OLDSECCHECK
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TM_ICU_COMPATIBILITY
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TM_LOG_ESYS
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TM_ORB_CLTMAXRTY
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TMCMPLIMIT
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TMCMPPRFM
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TMNETLOAD
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TMNOTHREADS
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TMSICACHEENTRIESMAX
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TMUSEIPV6
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TPMBACONV
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TPMBENC
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TUX_BLOCKLICIW
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TUX_SSL_ENFORCECONSTRAINTSUINMEDSIGS
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
URLENTITYCACHEDIR
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
URLENTITYCATCHING
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
VIEWDIR
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
VIEWDIR32
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
VIEWFILES
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
VIEWFILES32
String
false
none
Tuxedo environment variable. See "tuxenv(5)" in Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
KIX_TS_DIR
String
false
none
Tuxedo ART CICS environment variable. See "CICS Runtime Environment Variables" in Oracle Tuxedo Application Runtime for CICS Reference Guide.
KIX_TD_DIR
String
false
none
Tuxedo ART CICS environment variable. See "CICS Runtime Environment Variables" in Oracle Tuxedo Application Runtime for CICS Reference Guide.
KIX_TD_QSPACE_DEVICE
String
false
none
Tuxedo ART CICS environment variable. See "CICS Runtime Environment Variables" in Oracle Tuxedo Application Runtime for CICS Reference Guide.
KIX_TD_QSPACE_NAME
String
false
none
Tuxedo ART CICS environment variable. See "CICS Runtime Environment Variables" in Oracle Tuxedo Application Runtime for CICS Reference Guide.
KIX_TD_QSPACE_IPCKEY
String
false
none
Tuxedo ART CICS environment variable. See "CICS Runtime Environment Variables" in Oracle Tuxedo Application Runtime for CICS Reference Guide.
KIX_TECH_DIR
String
false
none
Tuxedo ART CICS environment variable. See "CICS Runtime Environment Variables" in Oracle Tuxedo Application Runtime for CICS Reference Guide.
KIX_CWA_SIZE
String
false
none
Tuxedo ART CICS environment variable. See "CICS Runtime Environment Variables" in Oracle Tuxedo Application Runtime for CICS Reference Guide.
KIX_CWA_IPCKEY
String
false
none
Tuxedo ART CICS environment variable. See "CICS Runtime Environment Variables" in Oracle Tuxedo Application Runtime for CICS Reference Guide.
KIX_QSPACE_IPCKEY
String
false
none
Tuxedo ART CICS environment variable. See "CICS Runtime Environment Variables" in Oracle Tuxedo Application Runtime for CICS Reference Guide.
KIX_TRACE_LEVEL
String
false
none
Tuxedo ART CICS environment variable. See "CICS Runtime Environment Variables" in Oracle Tuxedo Application Runtime for CICS Reference Guide.
KIX_MAP_PATH
String
false
none
Tuxedo ART CICS environment variable. See "CICS Runtime Environment Variables" in Oracle Tuxedo Application Runtime for CICS Reference Guide.
DATA
String
false
none
Tuxedo ART CICS environment variable. See "CICS Runtime Environment Variables" in Oracle Tuxedo Application Runtime for CICS Reference Guide.
SPOOL
String
false
none
Tuxedo ART CICS environment variable. See "CICS Runtime Environment Variables" in Oracle Tuxedo Application Runtime for CICS Reference Guide.
TMP
String
false
none
Tuxedo ART CICS environment variable. See "CICS Runtime Environment Variables" in Oracle Tuxedo Application Runtime for CICS Reference Guide.
PROCLIB
String
false
none
Tuxedo ART CICS environment variable. See "CICS Runtime Environment Variables" in Oracle Tuxedo Application Runtime for CICS Reference Guide.
MT_ACC_FILEPATH
String
false
none
Tuxedo ART CICS environment variable. See "CICS Runtime Environment Variables" in Oracle Tuxedo Application Runtime for CICS Reference Guide.
MT_DB_LOGIN
String
false
none
Tuxedo ART CICS environment variable. See "CICS Runtime Environment Variables" in Oracle Tuxedo Application Runtime for CICS Reference Guide.
MT_LOG
String
false
none
Tuxedo ART CICS environment variable. See "CICS Runtime Environment Variables" in Oracle Tuxedo Application Runtime for CICS Reference Guide.
MT_TMP
String
false
none
Tuxedo ART CICS environment variable. See "CICS Runtime Environment Variables" in Oracle Tuxedo Application Runtime for CICS Reference Guide.
MT_KSH
String
false
none
Tuxedo ART CICS environment variable. See "CICS Runtime Environment Variables" in Oracle Tuxedo Application Runtime for CICS Reference Guide.

Table 1-6  Oracle Tuxedo System Properties
Name
Type
Req’d
Default
Description
appdir
String
false
none
Application Directory, location of the Tuxedo application executables and files.
masterTuxconfig
String
false
none
Location of the TUXCONFIG file for the Master machine in a multi-machine domain. This is necessary to perform scale-out operations.
masterTuxdir
String
false
none
Location of TUXDIR file the Master machine in a multi-machine domain. This is necessary to perform scale-out operations.
model
String
false
none
Indicates whether this appliance is a single-machine appliance (SHM) or multi-machine appliance (MP).
pmid
String
false
none
Oracle Tuxedo Machine identifier for this appliance.
role
String
false
none
Along with model, is used to qualify the type of appliance when it is part of a multi-machine domain. The role can be 'MASTER', 'BACKUP' or 'SLAVE'. It is always 'SLAVE' for a single-machine domain.
tuxconfig
String
false
none
Used to save the value of TUXCONFIG as introspected.
tuxdir
String
false
none
Used to save the value of TUXDIR as introspected.
kixdir
String
false
none
Used to save the value of KIXDIR as introspected.
kixconfig
String
false
none
Used to save the value of KIXCONFIG as introspected.
jesdir
String
false
none
Used to save the value of JESDIR as introspected.

 


Extensions of the Plug-in

None.

 


Supported Template Types

The supported template type is Oracle Enterprise Linux (OEL).

 


Supported VM Server


  Back to Top       Previous  Next