Fusion Middleware Documentation
Advanced Search


Using Oracle Virtual Assembly Builder
Close Window

Table of Contents

Show All | Collapse

B Oracle Virtual Assembly Builder Introspection Plug-ins

This appendix describes or provides references to other product documentation for plug-ins for appliances that Oracle Virtual Assembly Builder can introspect. For some products being released in Oracle Fusion Middleware 12c, the product documentation for the component contains the plug-in documentation. This appendix describes those component plug-ins that are not documented in other product documentation.

This appendix contains the following sections:

B.1 Plug-ins Documented in Other Product Documentation

For the details of plug-ins for specific Oracle components, see the product documentation for the component. For more information, see:

B.2 Generic Appliance Plug-in

The generic appliance introspection plug-in allows you to create an appliance that gets configured and deployed using scripts supplied during introspection. The generic appliance introspector plug-in reads and collects the properties of an opaque, standalone, and self-contained product or application, and captures the set of files that make up the product as specified by the user. The output of the plug-in is an appliance. Use the introspectGenericProd command to introspect a generic appliance.

A generic appliance does not make use of product-specific plug-in code to capture configuration or product location--instead a simple appliance is created and a set of user-supplied properties, paths, and scripts are added to it in a generic manner. The set of scripts passed in at creation are executed at deployment to perform the necessary operations.

B.2.1 Requirements

The following requirements apply to generic appliances:

B.2.1.1 Specify File Sets

You must specify a list of directories to be captured. All file and directories underneath those directories will be captured. This capability provides the means by which installation binaries, configuration, and data is captured.

B.2.1.2 Scripts Are Launched As Root

All scripts will be launched as the root user. This provides generic appliance scripts the flexibility of performing operations requiring root privileges or switching to another user as desired.

B.2.2 Resulting Artifact Type

A single appliance.

B.2.3 Generic Appliance Plug-in Introspection Parameters

Table B-1 lists the introspection parameters for the generic appliance:

Table B-1 Generic Appliance Plug-in Introspection Parameters

Parameter Description

productRoots

A required list of one or more colon-separated paths of type string. Each path becomes a root of a FileSet within the definition of the Appliance. All files within each specified root are captured during an operation. Each path gets mapped to its own filesystem on the VM at deployment.

propertyFile

Optional. Absolute path of the properties file. Each property in the specified file becomes a user property in the appliance metadata.

If propertyFile is specified, then any properties/ directory is ignored.

scriptRootDir

Optional. Path to the root directory where the scripts are obtained. Scripts are located in subdirectories within this root directory according to operation type.


B.2.4 Property File

If you specify the propertyFile parameter, you must reference a file that exists on the reference system and is readable (otherwise, a failure results and the appliance is not created).

A property file is a text file containing a list of (name, value) pairs. Each property in the property file is added as a user property into the appliance. At deployment the user properties in the appliance are written back out to a file with the absolute path indicated by the $AB_USERPROPS_FILE environment variable.

A property file must consist of zero or more lines where each line is a property declaration, a comment, or a blank line. More formally, a property file must comply with the following syntax:

Example B-1 Property File Syntax

property-file   = *line
line            = prop-decl | comment | blank-line
prop-decl       = name "=" value NL
comment         = *WS "#" *CHAR NL
blank-line      = *WS NL
name            = name-start-char *name-body-char
name-start-char = <any character in "a".."z", "A".."Z", "_">
name-body-char  = <any character in "a".."z", "A".."Z", "0".."9", "_">
value           = *SHCHAR | SQ *SHCHAR SQ | DQ *SHCHAR DQ
NL              = <platform dependent line termination sequence>
WS              = <white space character>
CTL             = <any control character (octets 0 -31) and DEL (127)>
CHAR            = <any character, excluding CTL (and NL), but including WS>
SHCHAR          = <any CHAR, escaped as necessary for shell interpretation>
SQ              = <single quote>
DQ              = <double quote>

Any property file that does not comply with the above syntax rules results in an error, and an appliance is not created. Property declarations must be contained on a single line. Ending a line with a slash ("\") does not result in line continuation.

All properties will be marked as "required" in the appliance metadata. Property declarations without any assigned value (nothing after "=") will be set to null in the appliance metadata requiring that the user assign a value to that property prior to deployment.

Whitespace is not permitted anywhere to the left of the equal sign ("=") in a property declaration. Whitespace to the right of the equal sign is assumed to be part of the intended value and is preserved (resulting in a failure if the value is sourced).

Quotes around property values are preserved and are visible to users as part of the value. When editing a property value, it is the responsibility of the user to add, remove, or preserve quotes as necessary according to the rules of shell interpretation.

Comments and blank lines are discarded at dehydration and are not reproduced when the file is regenerated at rehydration.

Typically, a generic appliance script reads the property file into the script environment. A common usage pattern is:

#!/bin/bash
#
# This script reconfigures the example server of the
# example product.
#
. $AB_USERPROPS_FILE
$ORACLE_HOME/bin/oim_reconfig.sh $OIM_INSTANCE

Here is sample content of a valid properties file:

# The following property must have a user supplied value
SHELL=
# This is a variable that should not be changed
PRODUCT_HOME=/my/install/will/not/move
PRODUCT_INSTANCE=/my/instance/will/also/not/move
PRODUCT_PROPERTY="Hello World"
# This is a mispelled variable name
TRUSTROTE=/path/to/file.jks

Given the above property file example (including user edits of some values), the following property file content is generated during reconfiguration:

SHELL=/bin/bash
PRODUCT_HOME=/my/install/will/not/move
PRODUCT_INSTANCE=/my/instance/will/also/not/move
PRODUCT_PROPERTY="Yo, peoples of planet Earth!"
TRUSTROTE=/path/to/file.jks

B.2.4.1 Script Root Directory

The script root directory is the top level directory containing the script subdirectories. If the specified directory does not exist or is not readable then an error will be returned and an appliance will not be created

User supplied reconfiguration scripts must be placed within the root script directory under the following well-known subdirectories: config.d/, start.d/, ping.d/, stop.d/. Scripts under each subdirectory will be captured during dehydration and stored in the appliance. During rehydration the appropriate set of scripts according to the requested operation will be executed in lexicographical order (same order as /bin/ls).

The following is an example of the set of script directories the user might create:

/path/to/script/dirs/
     config.d/
         00config.sh
         01.config.sh
     start.d/
         00start.sh
         01start.sh
     stop.d/
          stop.sh
     ping.d/
          ping.sh

Any file or directory located in the script root directory other than the set of well-known subdirectories will be ignored and will not be captured during dehydration.

The script root directory need not contain all well-known subdirectories. The omission of a well-known subdirectory is ignored during dehydration with the assumption that no script is needed for that particular phase.

A well-known subdirectory may be empty. An empty well-known subdirectory will not be captured.

Well-known subdirectories must only contain scripts that should be launched by the generic appliance plug-in. The presence of a directory within a well-known subdirectory will generate an error during dehydration and an appliance will not be created. Everything else will be captured and the generic appliance will attempt to execute it during rehydration. Files such as data files, configuration files, and videos will likely fail to execute properly resulting in an overall failure of the corresponding operation. Such files are more appropriately captured using the productRoots parameters.

B.2.5 Wiring

You can define one or more input and output endpoints to be able to:

  • Connect from/to other appliances in the assembly

  • Connect to external resources

  • Exchange properties between connected appliances: The GenericProd introspector plug-in allows you to specify at introspection a set of directories to capture, a set of properties to expose to the user, and a set of scripts to run during reconfiguration operations. Currently only the set of properties specified during introspection are made available to the specified reconfiguration scripts.

The metadata associated with these inputs and outputs is exposed to your reconfiguration scripts so that the network connections of the underlying captured product are configured according to the details you supply during assembly editing and the environment into which you deploy the appliance.

B.2.5.1 Appliance Inputs

An appliance input represents the configuration of a host and port on which a component opens a socket, waits for connections to be established, and handles incoming requests.

The metadata associated with an appliance input includes the following:

  • The port on which the component will establish the socket.

  • The host on which the component will establish the socket (determined at deployment).

  • The protocol(s) that the component will handle on the socket.

  • A set of configurable properties with details about how the endpoint should be configured and/or connected to.

  • A set of static properties with details about how the endpoint should be configured and/or connected to.

  • The original host and port used by the component at the time of capture.

During reconfiguration, the introspector plug-ins examine the metadata of their own appliance inputs to modify their own configuration of the sockets that it will open for handling incoming requests. Other components that connect to these sockets also examine this metadata during reconfiguration to appropriately modify client-side connection configuration.

B.2.5.2 Appliance Outputs

An appliance output represents the configuration of a host and port to which a component establishes connections and sends requests. During assembly editing connections between appliance outputs and appliance inputs are configured so that the owner of an appliance output can discover the metadata of the appliance input to which it should connect.

The metadata associated with an appliance output includes the following:

  • The protocol that the component will use on the connection.

  • A set of configurable properties with details about how the component will establish connections.

  • A set of static properties with details about how the component will establish connections.

  • A set of properties needed on any compatible input to which this output will connect to.

  • The original host and port used by the component at the time of capture.

During reconfiguration, the introspector plug-ins examine the metadata of their own appliance outputs and the appliance inputs to which those outputs are connected. This metadata is used to modify the configuration of the sockets that the component will open for sending requests.

B.2.5.3 Endpoint Directory

The optional endpointDir parameter specifies a directory containing one or more files describing appliance inputs and appliance outputs to be added to the appliance as part of introspection. There is one file per endpoint, named as follows:

  • For appliance inputs: <input-name>.input

  • For appliance outputs: <output-name>.output

During reconfiguration of GenericProd appliances, the endpoint files are created for all appliance inputs and appliance outputs of the appliance. In addition, files are created for all appliance inputs of other appliances to which the GenericProd appliance is connected.

The $AB_ENDPOINT_DIR environment variable is passed to all reconfiguration scripts. This variable is set to the temporary directory created to hold the endpoint files.

B.2.5.4 Format of Endpoint Files

The *.input/*.output files are comprised of properties expressed as key/value pairs, one per line, with the form of key=value. Because the keys are not guaranteed to be valid shell variable names, you cannot source endpoint files to create shell variables.

B.2.5.4.1 Properties of *.input files

The following properties can be contained in *.input files:

  • port: required

  • protocols: required, comma separated list with no whitespace

  • host: derived internally, available at reconfiguration

  • userprop.property-name: optional, always type="STRING"

  • sysprop.property-name : optional, always type="STRING"

  • original-port: optional

  • original-host: optional

You must specify required properties in the files supplied at introspection. You should not specify the "host" property, which is derived automatically during reconfiguration. In reconfiguration scripts, use the value of the "host" property to set the listening address when configuring an ApplianceInput and to set the connection address when configuring an ApplianceOutput.

B.2.5.4.2 Properties of *.output files

The following properties can be contained in *.output files:

  • protocol: required

  • connected-input: derived internally, available at reconfiguration

  • userprop.property-name: optional, always type="STRING"

  • sysprop.property-name: optional, always type="STRING"

  • original-port: optional

  • original-host: optional

  • conn-userprop.property-name: optional, for specifying requirements on connected inputs

  • conn-sysprop.property-name: optional, for specifying requirements on connected inputs

You must specify required properties in the files supplied at introspection. You should not specify the "connected-input" property, which is derived automatically during reconfiguration.

B.2.6 Extensions of the Plug-in

None.

B.2.7 Supported Template Types

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

B.3 Oracle Database (SIDB) Plug-in

The single-instance Oracle Database introspection plug-in examines a single-instance Oracle Database appliance and captures its metadata.

B.3.1 Versions Supported

This plug-in supports versions 10gR2, 11gR1, and 11gR2.

B.3.2 Oracle Database Introspection Parameters

Table B-2 lists the introspection parameters for Oracle Database:

Table B-2 Oracle Database Plug-in Introspection Parameters

Parameter Description

asmHome

This parameter is required if ASM is used as the storage type and it is installed in a separate Oracle Home.

dbHome

The ORACLE_HOME of the Oracle RDBMS to be introspected.

oracleSid

The Oracle System ID (SID) of the Oracle RDBMS to be introspected.

shutdownDBOK

This flag needs to be passed to approve the database reboot.

sysDBAUserName

Database account with SYSDBA privileges. This parameter is required only if OS authentication is disabled for the current database.


B.3.3 Oracle Database Introspection Password Parameters

Table B-3 lists the introspection password parameters for Oracle Database. When performing introspection using the abctl tool, a prompt is shown to enter values for these parameters. Oracle Virtual Assembly Builder Studio provides password fields for these parameters.

Table B-3 Oracle Database Plug-in Introspection Parameters (Prompted During Introspection)

Parameter Description

rootPassword

Optional. The rootPassword parameter is required to change the permissions of the ORACLE_HOME files to make capturing of file sets possible.

sysDBAPassword

Optional. Password for sysDBAUserName user. This parameter is required only if OS authentication is disabled for the current database.


B.3.4 Reference System Prerequisites

This introspection plug-in does not support configurations with multiple NICs.

B.3.5 Requirements

The following requirements apply to Oracle Database:

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

B.3.6 Resulting Artifact Type

A single appliance.

B.3.7 Wiring

An input is created on the SIDB appliance with a default Listener and Port. The protocol of an SIDB input is set to 'jdbc'.

B.3.8 Wiring Properties

The input endpoint has two editable properties - port and description, and two non-editable properties - protocol and ORACLE_SID. The protocol indicates what sort of output can be connected to the input.

B.3.9 Oracle Database Appliance Properties

Assemblies with an Oracle Database appliance have user properties (Table B-4) and system properties (Table B-5).

Table B-4 Oracle SIDB Plug-in: User Properties

Name Type Req'd Default Description

asm-password

String

false

none

Password for SYS asm account.

db-account-password

Password

true

none

The password for database accounts SYS, SYSTEM, SYSMAN, and DBSNMP.


Table B-5 Oracle SIDB Plug-in System Properties

Name Type Req'd Default Description

ASM_BASE

String

false

none

ASM ORACLE_BASE path.

ASM_HOME

String

false

none

ASM ORACLE_HOME path.

ASM_OWNER

String

false

none

The OS user who owns the ASM ORACLE_HOME.

DATA_ASM_DISCOVERY_STRING

String

false

none

Path to discover all data asm disks.

DATA_ASM_DISK_GROUP_NAME

String

false

none

Name of the data asm diskgroup.

DATA_ASM_DISK_GROUP_REDUNDANCY

String

false

none

Data asm diskgroup level of redundancy.

DATA_ASM_DISKS

String

false

none

Paths of the disks that belong to the data asm diskgroup.

DATA_STORAGE_TYPE

String

false

none

Storage type for database data.

DB_BASE

String

false

none

The Oracle database base path.

DB_GROUP

String

false

none

The group of the OS user who owns Oracle home.

DB_HOME

String

false

none

The Oracle database home path.

DB_HOME_NAME

String

false

none

The name of the Oracle Home.

DB_LISTENER_NAME

String

false

none

Oracle database listener name.

DB_ORACLE_GROUPS

String

false

none

The OSDBA, OSOPER and OSASM groups.

DB_OWNER

String

false

none

The OS user who owns Oracle home.

DB_USING_ASM

String

false

none

Set to true if either of database or recovery files are stored on ASM as per reference system.

DB_VERSION

String

false

none

Version of Oracle database software on reference system.

ORACLE_SID

String

false

none

The Oracle database SID.

ORIGINAL_GLOBAL_DB_NAME

String

false

none

The database unique name on reference system.

RECOVERY_ASM_DISCOVERY_STRING

String

false

none

Path to discover all recovery asm disks.

RECOVERY_ASM_DISK_GROUP_NAME

String

false

none

Name of the recovery asm diskgroup.

RECOVERY_ASM_DISK_GROUP_REDUNDANCY

String

false

none

Recovery asm diskgroup level of redundancy.

RECOVERY_ASM_DISKS

String

false

none

Paths of the disks that belong to the recovery asm diskgroup.

RECOVERY_STORAGE_TYPE

String

false

none

Storage type for database recovery.


B.3.10 Extensions of the Plug-in

None.

B.3.11 Supported Template Types

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

B.4 Oracle Forms and Reports Extensions

The Oracle Forms and Reports introspection extensions extend the functionality of the Oracle WebLogic Server introspection plug-in. These examine Forms and Reports applications and configuration residing in the Forms WebLogic servers, Reports WebLogic servers and Oracle Instance.

B.4.1 Versions Supported

The extensions support introspecting only in the following scenarios:

  • Oracle Forms and Reports 11g Release 2 (11.1.2.0 or newer).

  • Only Oracle Access Manager 11g Release 1 (11.1.1.5) as the Identity Management/Access Control Server with WebGate as the access client is supported when Forms and Reports applications are to be protected by single sign-on.

  • Oracle Access Manager with mod_osso as the access client or Oracle Single Sign-On Server with mod_osso as the access client is not supported.

B.4.2 Introspection Parameters

There are no additional parameters required beyond those needed by Oracle WebLogic Server.

B.4.3 Reference System Prerequisites

In addition to the reference system prerequisites mentioned for the Oracle WebLogic Server plug-in, create the following empty files on the reference system.

  • $ORACLE_HOME/precomp/public/bnddsc.for

  • $ORACLE_HOME/precomp/public/oraca.for

  • $ORACLE_HOME/precomp/public/seldsc.for

  • $ORACLE_HOME/precomp/public/sqlca.for

Note:

$ORACLE_HOME refers to the Forms and Report Oracle Home.

B.4.3.1 Adding Partner Application Registation Utility (Web Tier on a Separate Node)

If the Web tier is set up on a separate node for the Forms and Reports installation on the reference system, copy the partner app registration utility (rreg-toolkit.jar) from the Forms and Reports installation located in the ORACLE_HOME/oam/server/rreg/client directory to the ORACLE_HOME/oam/server/rreg/client directory on the Web tier before running the introspection on the Web tier node.

B.4.4 Requirements

In addition to the requirements mentioned for Oracle WebLogic Server Plug-in, following requirements must be met:

B.4.4.1 Managed Servers Requirement

Forms and Reports managed servers must be up and running before starting the introspection.

B.4.4.2 Supported Topologies

The Forms and Reports extensions support:

  • Only Forms and Reports managed servers (standalone or part of the cluster) that are on the same machine as the Admin Server will be examined and captured.

  • In case of an Expand Cluster configuration scenario, on the reference system if there are multiple managed servers in the cluster_forms cluster, the configuration from the WLS_FORMS managed server will be replicated to all the Forms managed servers in the virtual deployed environment. Similarly, the configuration from the WLS_REPORTS managed server will be replicated to all the Reports managed servers in the virtual deployed environment.

B.4.4.3 Unsupported Topology

The Forms and Reports extensions do not support:

  • Introspection of remote Forms and Reports managed servers: servers that are created on a different machine than the Admin Server machine.

  • Forms and Reports managed servers created through the Remote Extend Domain configuration scenario: the case where the domain pre-exists and the Forms and/or Reports managed servers are added later through the Extend Domain configuration scenario on a different machine than the Admin Server machine.

B.4.4.4 Requirement to Support Scale Out of Deployed Assembly

After deploying the assembly, you can add new managed servers to Forms and Reports WLS clusters through the "scale" operation. But a cluster can only be scaled out up to the "max" scalability property which is limited to the number of managed servers that were present in the cluster in the reference system at introspection time. To account for future scale out, in the reference system, you should temporarily add additional managed servers to the Forms cluster (cluster_forms) and Reports cluster (cluster_reports) using the WLS Admin Console or WLST before that WLS domain is introspected.

These additional managed servers need not be assigned Machines nor do they need to be up and running in the reference system. Once the assembly is created you can remove these temporary managed servers from the reference system. You can control the actual number of Forms and Reports managed servers that have to be deployed using the "target" scalability property of the cluster_forms WLS appliance. Refer to Table B-19, "Scalability Properties of the Instance Appliance", for details on the scalability properties.

B.4.4.5 Oracle HTTP Server to Reports Cluster Configuration Requirement

In the reference system, if the Reports managed server(s) is part of a WebLogic cluster (cluster_reports) and it's front ended by an Oracle HTTP Server, make sure WebLogicCluster directive is used to for Oracle HTTP Server to Reports managed server(s) routing. By default, it's configured with WebLogicHost and WebLogicPort directives. Modify the following file to add an entry for WebLogicCluster directive and comment out WebLogicHost and WebLogicPort directives:

$ORACLE_INSTANCE/config/OHS/<ohs_name>/moduleconf/reports_ohs.conf

For example:

#mod_weblogic related entry
#<IfModule mod_weblogic.c>
<Location /reports>
SetHandler weblogic-handler

# Add this line:
WebLogicCluster machine1.domain:port1,machine2.domain:port2

# Comment following two entries
# WebLogicHost machine1.domain
# WebLogicPort port1
</Location>
#</IfModule>

B.4.4.6 tnsnames.ora

The tnsnames.ora file on the reference system is included in any assemblies that are created, and any databases (and host machines for them) which are referred to in the file are also referred to in the tnsnames.ora that is deployed as part of the deployed assemblies. Thus, generally the tnsnames.ora file should be empty (or be removed) from the reference system before the assemblies are created, particularly in cases where the assemblies will be shipped to third parties (since those databases and machines will not exist in the new environment). In those cases, users should add their required database entries to the file on the Forms and Reports virtual nodes after deployment.

B.4.5 Resulting Artifact Type

For each Forms and Reports clusters and standalone (non-clustered) managed servers in the introspected WebLogic Server domain, the Forms and Reports extensions create a new appliance within the atomic Oracle WebLogic Server Assembly.

B.4.6 Wiring

The appliances are wired as follows:

B.4.6.1 Oracle HTTP Server Appliance to Forms and Reports WLS Appliances Wiring

If Oracle HTTP Server is configured on the reference system, one or more appliance outputs with the prefix "wls-" are created on the Oracle HTTP Server appliance. Connect the appliance output with the description property "loc=/forms" to the Forms appliance in the atomic WLS assembly and similarly connect the appliance output with the description property "loc=/reports" to the Reports appliance in the atomic WLS assembly.

B.4.6.2 Forms and Reports WLS Appliances to Oracle Internet Directory External Resource Wiring

On the reference system, if the Forms and Reports managed servers are configured with the Oracle Internet Directory server to support running Forms and Reports applications with single sign on protection, appliance outputs named "OIDConnection" are created on the Forms and Reports appliances.

Create an External Resource for this appliance output and enter the properties described in Section B.4.7, "Wiring Properties". If Forms and Reports are part of the same assembly, use the same External Resource to represent the Oracle Internet Directory Server.

Also refer to Oracle HTTP Server - OAM Server wiring as described in "OHS Introspector Plug-in for OVAB" in Administering Oracle HTTP Server.

B.4.6.3 Reports Appliance to Oracle Database Wiring

If a Reports WLS cluster was configured in the reference system, an appliance output named "job_repos_db" is created on the Reports cluster appliance (cluster_reports). This output should be connected to an Oracle Database appliance or an External Resource representing an Oracle Database that contains required Reports job database schemas (see Oracle Reports documentation for details about such schemas) and enter the properties defined in Section B.4.7, "Wiring Properties".

B.4.7 Wiring Properties

The following properties should be set for the External Resource (refer to Section B.4.6.2, "Forms and Reports WLS Appliances to Oracle Internet Directory External Resource Wiring") representing the Oracle Internet Directory server.

Table B-6 Oracle Internet Directory External Resource Properties

Name Type Req'd Default Description

UseOID

Boolean

true

true

This property determines whether or not to configure Forms-OID wiring in the virtual deployment. This property is set to true if the reference system was setup with Forms-OID/Reports-OID configuration. Setting this property to false disables Forms-OID/Reports-OID configuration in the virtual deployments. When this property is set to true, set the rest of the properties listed in this table.

Host

String

true

none

OID Server host name.

Port

Integer

true

none

OID Server port number.

OID_UserDn

Boolean

true

none

OID Server Administrator user name (typically orcladmin).

OID_Password

String

true

none

OID Server Administrator password.

sslConnection

Boolean

true

false

This property indicates whether to establish an SSL connection with the OID Server. When this property is set to true, you should provide the OID Server's SSL port number in the Port property.


Note:

When Single-Sign-On (SSO) protection is to be enabled for the default Forms and Reports applications in the deployed environment, add the values /reports/rwservlet/*,/forms/frmservlet?*oamMode=true* to the webgate.protectedResourcesList user property on the OHS Appliance as described in Table B-15.

Note:

If the UseOID property described in Table B-6 is set to false, that is, you chose not to enable Sign-Sign-On protection on the Forms and Reports applications in the deployed instance, then make sure that the values /reports/rwservlet/*,/forms/frmservlet?*oamMode=true* are removed from to the webgate.protectedResourcesList user property on the OHS Appliance, as described in Table B-15.

Applicable only for a Reports appliance, the following properties should be set for the Oracle Database appliance or an External Resource representing an Oracle Database that contains required Reports job database schemas.

Table B-7 Oracle Database Appliance Properties

Name Type Req'd Default Description

global-db-name

String

true

none

The Oracle System ID (SID) of the Oracle Database. Property defined at input endpoint.

port

Integer

true

none

Oracle Database listener port number. Property defined at input endpoint.


Table B-8 Oracle Database External Resource Properties

Name Type Req'd Default Description

hostname

String

true

none

Oracle Database host name. Property defined at appliance level.

global-db-name

String

true

none

The Oracle System ID (SID) of the Oracle Database. Property defined at input endpoint.

port

String

true

none

Oracle Database listener port number. Property defined at input endpoint.


Table B-9 Reports Appliance Output Properties: job_repos_db

Name Type Req'd Default Description

username

String

true

none

The user needed for the database connection.

password

String

true

<empty>

The password for the user needed for the database connection.

address-name

String

true

none

The database address/service name that goes in the tnsnames.ora file (for example, myProdDb).


B.4.8 Oracle Forms and Reports Appliance Properties

Same as for Oracle WebLogic Server appliances.

(Reports only) If the reference system is enabled for a Reports cluster, specify the following property in your deployment plan:

wlsAssembly -->FileSets -> reportsClusterSharedDir

This is the shared NFS directory to which the VM should mount, and the location of the shared directory for the Oracle Reports shared cache.

B.5 Oracle RAC Database (RACDB) Plug-in

The RACDB introspection plug-in examines Oracle Clusterware and RAC Database components and captures their metadata.

B.5.1 Versions Supported

This plug-in supports version 11gR2.

B.5.2 Oracle RAC Database Introspection Parameters

Table B-10 lists the introspection parameters for the RACDB introspection plug-in:

Table B-10 Oracle RACDB Plug-in Introspection Parameters

Parameter Description

asmHome

This parameter is required if ASM is used as the storage type and it is installed in a separate Oracle Home.

crsHome

The ORACLE_HOME of the Oracle CRS to be introspected.

dbHome

The ORACLE_HOME of the Oracle RDBMS to be introspected.

globalDbName

The global database name of the Oracle RDBMS to be introspected.

shutdownDBOK

This flag needs to be passed to approve the database reboot.

sysDBAUserName

Optional. Database account with SYSDBA privileges. This parameter is required only if OS authentication is disabled for the current database.


B.5.3 Oracle RAC Database Introspection Password Parameters

Table B-11 lists the introspection password parameters for the Oracle RAC Database plug-in. When performing introspection using the abctl tool, a prompt is shown to enter values for these parameters. Oracle Virtual Assembly Builder Studio provides password fields for these parameters.

Table B-11 Oracle RACDB Plug-in Introspection Parameters (Prompted During Introspection)

Parameter Description

rootPassword

Optional. The rootPassword parameter is required to change the permissions of the ORACLE_HOME files to make capturing of file sets possible.

sysDBAPassword

Optional. Password for sysDBAUserName user. This parameter is required only if OS authentication is disabled for the current database.


B.5.4 Reference System Prerequisites

The Clusterware stack must be running during introspection.

B.5.5 Requirements

The following requirements apply to Oracle RAC Database:

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

B.5.6 Resulting Artifact Type

A single appliance.

B.5.7 Wiring

For an 11.2 series RACDB, a single input is created on the RACDB appliance.

For a pre-11.2 series RACDB, inputs are created on the RACDB appliance for each Listener or Port directive found in the configuration.

B.5.8 Wiring Properties

For 11.2 series RACDB, the input endpoint has two editable properties, scan-name and global-db-name, and two non-editable properties, protocol and port, which indicate what sort of output can be connected to the input.

For pre-11.2 series RACDB, the input endpoint has a editable property global-db-name and two non-editable properties, protocol and port.

B.5.9 Oracle Database Appliance Properties

Assemblies with an Oracle Database appliance have user properties (Table B-12) and system properties (Table B-13).

Table B-12 Oracle RAC Database: User Properties

Name Type Req'd Default Description

asm-password

String

false

none

Password for SYS asm account.

cluster-name

String

false

new_cluster

Name for cluster (only for pre-11.2 series Oracle Database).

db-account-password

Password

true

none

The password for database accounts SYS, SYSTEM, SYSMAN, and DBSNMP.


Table B-13 Oracle RAC Database System Properties

Name Type Req'd Default Description

CRS_BASE

String

false

none

The Clusterware base path.

CRS_HOME

String

false

none

The Clusterware home path.

CRS_OWNER

String

false

grid

The name of the OS user who will be the owner of the Clusterware home.

CRS_GROUP

String

false

oinstall

The name of the OS user group of the owner of the Clusterware home.

CRS_ORACLE_GROUPS

String

false

oinstall

The OSDBA, OSOPER and OSASM groups.

VOTING_DISKS_LOCATIONS

String

false

none

Locations of voting disks (only for File System storage type for clusterware files).

VOTING_DISKS_REDUNDANCY

String

false

none

Voting disks redundancy. (only for File System storage type for clusterware files).

OCR_DISKS_LOCATIONS

String

false

none

Locations of ocr disks(only for File System storage type for clusterware files).

OCR_DISKS_REDUNDANCY

String

false

none

OCR disks redundancy. (only for File System storage type for clusterware files)

SCAN_PORT

String

false

1521

Port for SCAN listener.

CRS_STORAGE_TYPE

String

false

none

Storage type for clusterware files as per reference system.

CRS_VERSION

String

false

none

Version of Clusterware software on reference system.

CRS_ASM_DISK_GROUP_NAME

String

false

OVMOCRVD

Name of the clusterware asm diskgroup.

CRS_ASM_DISCOVERY_STRING

String

false

/dev/raw/ovmocrvd*

Path to discover all data asm disks.

CRS_ASM_DISK_GROUP_REDUNDANCY

String

false

NORMAL

Clusterware asm diskgroup level of redundancy.

CRS_ASM_DISKS

String

false

/dev/raw/ovmocrvd0,/dev/raw/ovmocrvd1,/dev/raw/ovmocrvd2

Paths of the disks that belong to clusterware asm diskgroup.

ASM_BASE

String

false

none

ASM ORACLE_BASE path.

ASM_HOME

String

false

none

ASM ORACLE_HOME path.

ASM_OWNER

String

false

grid

The OS user who owns ASM ORACLE_HOME.

DATA_ASM_DISCOVERY_STRING

String

false

/dev/raw/asm*

Path to discover all data asm disks.

DATA_ASM_DISK_GROUP_NAME

String

false

none

Name of the data asm diskgroup.

DATA_ASM_DISK_GROUP_REDUNDANCY

String

false

none

Data asm diskgroup level of redundancy.

DATA_ASM_DISKS

String

false

none

Paths of the disks that belong to data asm diskgroup.

RECOVERY_ASM_DISCOVERY_STRING

String

false

/dev/raw/asm*

Path to discover all recovery asm disks.

RECOVERY_ASM_DISK_GROUP_NAME

String

false

none

Name of the recovery asm diskgroup.

RECOVERY_ASM_DISK_GROUP_REDUNDANCY

String

false

none

Recovery asm diskgroup level of redundancy.

RECOVERY_ASM_DISKS

String

false

none

Paths of the disks that belong to the recovery asm diskgroup.

RECOVERY_STORAGE_TYPE

String

false

none

Storage type for database recovery.

DATA_STORAGE_TYPE

String

false

none

Storage type for database as per reference system.

RECOVERY_STORAGE_TYPE

String

false

none

Storage type for database recovery files as per reference system.

DB_USING_ASM

String

false

none

Set to true if either of database or recovery files are stored on ASM as per reference system.

DB_VERSION

String

false

none

Version of Oracle database software on reference system.


B.5.10 Extensions of the Plug-in

None.

B.5.11 Supported Template Types

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

B.6 Oracle Service Bus Support

Support for Oracle Service is provided via Oracle WebLogic Server plug-in. There is no separate plug-in for it. Oracle WebLogic Server plug-in can be used to introspect a Oracle WebLogic Server domain where Oracle Service Bus is configured.

B.6.1 Versions Supported

This plug-in supports version 11gR1 11.1.1.6.

B.6.2 Oracle Service Bus Introspection Parameters

There are no additional parameters required beyond those needed by Oracle WebLogic Server.

B.6.3 Reference System Prerequisites

There are no additional prerequisites beyond those defined by Oracle WebLogic Server.

B.6.4 Requirements

The following requirements apply to an Oracle WebLogic Server domain containing Oracle Service Bus.

B.6.4.1 Supported Domains

Supported OSB domains are where there is single server, one managed server with Oracle Service Bus and SOA or separate Oracle Service Bus and SOA clusters.

B.6.4.2 Requirement for Configuration Archiving

Turn on configuration archiving since domain security configurations will have to be modified to facilitate the introspection, it is advisable to turn on the configuration backup in WebLogic Server. Refer to the WebLogic Server documentation on configuration backup.

B.6.4.3 Export and Optionally Delete the OSB Artifacts from the Reference Domain

It is recommended that the OSB artifacts be exported before introspection. Optionally they can be deleted.

B.6.4.4 Delete Temporary Files from the Domain Directory

Before introspection and capturing file sets of the domain, all temporary files under the domain directory can be cleaned up. OVAB uses WebLogic pack utility to archive the domain directory from the reference domain. Files containing '\' in their names cannot be processed by the pack utility. They have to be manually removed before introspection.

B.6.4.5 Post Assembly Deployment Requirements

The following are requirements after deployment.

B.6.4.5.1 Import the OSB Artifacts

After the successful deployment of the OSB assembly instance, you can import the OSB artifacts that were exported and optionally deleted before the assembly creation began.

Create a new session for configuration changes and import the OSB artifacts that were saved earlier. After the successful import of the OSB artifacts, the session can be activated.

B.6.4.5.2 Apply Customizations

Some of the endpoint URLs may have to be customized in the deployed VMs as the network configuration is different. You can create a customization file for the assembly instance and after making necessary changes, execute the customizations.

Create a new session for configuration changes and apply the customizations using the OSB console. After execution of the customizations, the change session can be activated.

B.6.5 Resulting Artifact Type

Same as in Oracle WebLogic Server plug-in.

B.6.6 Wiring

Same as in Oracle WebLogic Server plug-in.

B.6.7 Wiring Properties

Same as in Oracle WebLogic Server plug-in.

B.6.8 Oracle Service Bus Appliance Properties

Same as in Oracle WebLogic Server plug-in.

B.6.9 Supported Template Types

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

B.7 Oracle Traffic Director Plug-In

The Oracle Traffic Director plug-in introspects an Oracle Traffic Director configuration on a reference system. In the context of Oracle Traffic Director, a configuration is a collection of configurable elements (metadata) that determine the run-time behavior of an Oracle Traffic Director instance.

For an overview of Oracle Traffic Director, see "Getting Started with Oracle Traffic Director" in the Oracle Traffic Director Administrator's Guide.

B.7.1 Versions Supported

The Oracle Traffic Director plug-in supports Oracle Traffic Director 11.1.1.6.

B.7.2 Oracle Traffic Director Introspection Parameters

Table B-14 lists the introspection parameters for Oracle Traffic Director. All the parameters are mandatory.

Table B-14 Oracle Traffic Director Plug-In Introspection Parameters

Parameter Description

oracleHome

The fully qualified path to the directory in the reference system in which the Oracle Traffic Director binaries are installed.

oracleInstance

The fully qualified path to the directory in the reference system in which the Oracle Traffic Director administration server instance exists.

configName

The name of the Oracle Traffic Director configuration that the plug-in should introspect.


B.7.3 Reference System Prerequisites

For the Oracle Traffic Director plug-in to successfully introspect the Oracle home and the administration server instance, the following prerequisites must be fulfilled on the reference system:

  • Oracle Traffic Director must be installed.

  • The Oracle Traffic Director administration server instance must be configured.

  • At least one configuration must be available.

Note:

The administration server need not be running.

B.7.4 Resulting Artifact Type

The result of the introspection is an atomic assembly that contains the following:

  • An Oracle Traffic Director administration server appliance

  • An Oracle Traffic Director instance appliance

    By default, when the instance appliance is deployed, two virtual machines will be created, regardless of the number of nodes to which the Oracle Traffic Director configuration was deployed on the reference system. The number of virtual machines to be created during the deployment process can be controlled through the scalability properties (see Table B-17, "Scalability Properties of the Administration Server Appliance").

B.7.5 Wiring

The appliances in the Oracle Traffic Director assembly can be wired to external components, and to other appliances and assemblies, through input and output endpoints.

Note:

In this release, you can wire the Oracle Traffic Director assembly to only a WLS assembly.

B.7.5.1 Wiring Endpoints of the Administration Server Appliance

An input endpoint is created for the HTTPS listen port of the Oracle Traffic Director administration server appliance. The input endpoint of the administration server appliance has two editable properties, port and description.

No output endpoint is created for the administration server appliance.

B.7.5.2 Wiring Endpoints of the Instance Appliance

An input endpoint is created for each HTTP listen port in the Oracle Traffic Director configuration. Each input endpoint of the instance appliance has two editable properties, port and description.

An output endpoint is created for each origin-server pool in the configuration. Each output endpoint of the instance appliance has one editable property, description.

Note:

Details of the origin servers in the origin-server pool are not captured during introspection. The origin servers will be defined during the deployment process, based on the appliance to which the output endpoint of the Oracle Traffic Director instance appliance is wired.

B.7.6 Oracle Traffic Director Appliance Properties

This section describes the editable properties of the appliances in an Oracle Traffic Director assembly. The properties are captured during introspection and are used to create the virtual machines when the appliances are deployed.

This section contains the following subsections:

B.7.6.1 Editable Properties of the Administration Server Appliance

Table B-15 General Properties of the Administration Server Appliance

Name Type Req'd Default Description

adminUser

String

true

admin

The user name for logging in to the administration server.

adminPassword

String

true

None

The password for the administration server user name.


Table B-16 Resource Properties of the Administration Server Appliance

Property Name Type Req'd Default Value Description

CPU_MHZ

Integer

true

1000

CPU clock speed.

MEMORY_MB

Integer

true

1024

Memory requirement, in megabytes.

NUMBER_CPUS

Integer

true

1

Number of processors.


Table B-17 Scalability Properties of the Administration Server Appliance

Property Name Type Req'd Default Value Description

Min

Integer

true

1

The minimum number of virtual machines of the appliance that can be deployed.

Max

Integer

true

1

The maximum number of virtual machines of the appliance that can be deployed. This value must be higher than the Absolute-Max value.

Absolute-Max

Integer

false

1

The absolute maximum number of virtual machines of the appliance that can be deployed.

Target

Integer

true

1

The actual number of virtual machines of the appliance to be deployed.


You can change the values of the scalability properties, but Oracle recommends that you leave them at the default values.

B.7.6.2 Editable Properties of the Instance Appliance

Table B-18 Resource Properties of the Instance Appliance

Property Name Type Req'd Default Value Description

CPU_MHZ

Integer

true

1000

CPU clock speed.

MEMORY_MB

Integer

true

1024

Memory requirement, in megabytes.

NUMBER_CPUS

Integer

true

1

Number of processors.


Table B-19 Scalability Properties of the Instance Appliance

Property Name Type Req'd Default Value Description

Min

Integer

true

1

The minimum number of virtual machines of the appliance that can be deployed.

Max

Integer

true

2

The maximum number of virtual machines of the appliance that can be deployed. This value must not be higher than the Absolute-Max value.

Absolute-Max

Integer

false

2

The absolute maximum number of virtual machines of the appliance that can be deployed.

Target

Integer

true

2

The actual number of virtual machines of the appliance to be deployed.


B.7.7 Supported Template Types

Oracle Enterprise Linux.

B.7.8 Post-Deployment Tasks

After deploying the Oracle Traffic Director assembly, you should perform the following tasks:

  • In the reference system, if Oracle Traffic Director is configured as the SSL termination point, then it is assumed that the certificates in the certificate database of the configuration belong to the virtual servers and not to the host name of the reference system. If the certificates belong to the host name of the reference system, then those certificates should be re-installed on the target virtual machines.

  • If SSL is configured between Oracle Traffic Director and the Oracle WebLogic Server managed servers, any new certificates, if required, should be installed after deploying the Oracle Traffic Director assembly.

  • Failover groups configured in the reference system are not captured during introspection. Therefore, high availability should be configured afresh by using the Oracle Traffic Director administration console or the CLI.

    Note:

    High availability is supported only when your base image includes keepalived.

B.8 Oracle Tuxedo Plug-In

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:

  • Oracle TSAM

  • Oracle SALT

  • Oracle Tuxedo Application Runtime for CICS and Batch

  • Oracle Tuxedo Mainframe Adapter SNA

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 Section B.8.6, "Wiring".

B.8.1 Versions Supported

This plug-in supports version 11gR1.

B.8.2 Oracle Tuxedo Introspection Parameters

Table B-20 lists the introspection parameters for the Oracle Tuxedo introspection plug-in:

Table B-20 Oracle Tuxedo Plug-in Introspection Parameters

Parameter Description

TUXDIR

Location where Oracle Tuxedo is installed.

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.


B.8.3 Reference System Prerequisites

None.

B.8.4 Requirements

The following requirements apply to Oracle Tuxedo:

B.8.4.1 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: http://docs.oracle.com/cd/E18050_01/tuxedo/docs11gr1/install/insappd.html).

B.8.4.2 ART CICS/Batch Applications Requiring Microfocus or COBOL IT

For ART CICS/Batch 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 application.

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

B.8.4.3 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.

B.8.5 Resulting Artifact Type

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

B.8.5.1 Single-Machine Oracle Tuxedo Domain

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

B.8.5.2 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:

  • Master: single non-scalable appliance representing the MASTER node in the Tuxedo domain.

  • Backup master (optionally): single non-scalable appliance representing the BACKUP MASTER node in the Tuxedo domain. Must be introspected if present on the reference system.

  • Other: single scalable appliance representing a non-master and non-backup node in the reference Tuxedo domain. There can be one or many such types of appliances depending on the topology of the reference system.

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.

B.8.6 Wiring

This section describes wiring.

B.8.6.1 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.

B.8.6.2 Other Inputs and Outputs

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

  • WSL (Oracle Tuxedo WorkStation protocol)

  • JSL (Oracle Jolt)

  • ISL (Oracle Tuxedo IIOP protocol)

  • Domain (Oracle Tuxedo Domain Gateway)

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

  • Domain (Oracle Tuxedo Domain Gateway)

  • Oracle Single-Instance Database

  • TMA_SNA (Oracle Tuxedo Mainframe Adapter SNA)

  • TSAM (Oracle TSAM)

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.

B.8.7 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 B-21 through Table B-23):

Table B-21 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 B-22 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 B-23 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.


B.8.8 Oracle Tuxedo Appliance Properties

Oracle Tuxedo appliances have user properties (Table B-24) and system properties (Table B-25).

Table B-24 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 B-25 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.


B.8.9 Extensions of the Plug-in

None.

B.8.10 Supported Template Types

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