B Oracle Virtual Assembly Builder Introspection Plug-ins

This appendix describes the plug-ins for appliances that Oracle Virtual Assembly Builder can introspect:

B.1 Oracle WebLogic Server Plug-in

The Oracle WebLogic Server introspection plug-in examines a single Oracle WebLogic Server domain and the Oracle Middleware Home it resides in. The domain specified and its Middleware Home are captured.

B.1.1 Versions Supported

This plug-in supports versions 11gR1 11.1.1.2 and later.

B.1.2 Oracle WebLogic Server Introspection Parameters

Table B-1 lists the introspection parameters for Oracle WebLogic Server:

Table B-1 Oracle WebLogic Server Plug-in Introspection Parameters

Parameter Description

domainRoot

The fully qualified path to the domain you want to introspect. This should be the directory that contains the 'config' directory.

wlsHome

The fully qualified path to the WLS Home server directory. For example, /u01/oracle/middleware/wlserver_10.3.

adminUser

The administrative user for the WLS domain.

adminPassword

The password for the administrative user specified for the adminUser property.


B.1.3 Reference System Prerequisites

The AdminServer for the domain must be running and introspection must target the host where the AdminServer is running.

B.1.4 Requirements

The following requirements apply to Oracle WebLogic Server:

B.1.4.1 Oracle WebLogic Server Domain Requirements

You must ensure that any Oracle WebLogic Server domain being introspected is configured to be editable. This allows edits to be performed successfully during deployment. For more information on configuring your Oracle WebLogic Server, see your product documentation.

B.1.4.1.1 LDAP Provider Requirements

Oracle recommends the use of Oracle Internet Directory as the LDAP provider on the reference system, not file-based LDAP. File-based LDAP cannot work properly in a deployed system due to synchronization issues.

B.1.4.2 Requirement for Remote User Specified for Remote Introspection of Oracle WebLogic Server

The remote user specified for remote introspection of Oracle WebLogic Server must be able to access files created by the user that owns the Oracle WebLogic Server process. When possible it is recommended that the remote user specified be the same as the user who owns the Oracle WebLogic Server process.

B.1.4.3 Requirements for SSL Certificate and Hostname Validation

You must use only a demo certificate, with hostname validation turned off.

B.1.4.4 Requirement to Update Applications Accessing Web Services

For each application that accesses a Web service hosted on the Oracle WebLogic Server reference system, you must update the application to access the Web service WSDL on the new Oracle VM host, and then redeploy the application through Oracle WebLogic Server administration tools, such as Admin Console or wlst, to the Oracle VM Oracle WebLogic Server environment.

B.1.4.5 Requirement Not to Create Templates on Individual Servers

You must not create a template on an individual server in Oracle WebLogic Server. Such templates cannot be deployed because they lack certain deployment artifacts (the domain template jar in content, and data at the assembly level).

B.1.4.6 Requirement to Specify Admin URL When Managed Server Not Running

If you want to perform manual starts from the context of the Guest-OS, you must manually modify the StartManagedServer.sh script to provide the correct Admin Server URL (Admin Server hostname). This is required to provide the default admin URL the correct value (the machine name of the Admin Server is not known at the time of template creation).

You can still start or stop the server through the node manager in Admin Console.

B.1.5 Resulting Artifact Type

An atomic assembly which contains an appliance for the AdminServer and appliances for any clusters found and any stand-alone (non-clustered) managed servers found. One appliance is created for a cluster regardless of the number of managed servers in that cluster. The Oracle WebLogic Server plug-in presumes that every managed server in a cluster is configured identically. The number of servers in the cluster is saved as 'scale out' information in the appliance metadata, as are the names of the servers in the cluster.

Note:

An atomic assembly cannot be edited to add or remove appliances. To wire other appliances to an atomic Oracle WebLogic Server assembly a non-atomic assembly must be created and the Oracle WebLogic Server assembly must be added to the non-atomic assembly.

B.1.6 Wiring

Inputs will be created on the Oracle WebLogic Server assembly for all the channels the servers in the domain are listening on. Typically Oracle HTTP Server outputs would be connected to the Oracle WebLogic Server inputs.

Outputs will be created on the Oracle WebLogic Server assembly for the following types of configuration found:

  • JDBC

  • LDAP

  • JMS Message Bridges

  • Foreign JMS

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.1.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 WebLogic Server endpoints:

Table B-2 describes common Oracle WebLogic Server appliance input system properties:

Table B-2 Common Oracle WebLogic Server Appliance Input System Properties

Name Type Req'd Default Description

originalBindAddresses

String

false

none

The original address of the system that was introspected.

originalDefaultHostname

String

false

none

The original hostname of the system that was introspected. (for example, "example.com").


Table B-3 describes common Oracle WebLogic Server appliance input user properties:

Table B-3 Common Oracle WebLogic Server Appliance Input User Properties

Name Type Req'd Default Description

keepLocalHost

Boolean

false

none

If this input was originally bound to localhost explicitly, this property will exist and be set to true. Connections should not be made to this input if this property exists and its value is not overridden to false.

readymetric-naming-password

String

false

none

The password to use for the connection made to the server when doing the ready metric check.

readymetric-naming-protocol

String

false

none

Optional protocol you can specify for naming connections used for the ready metric check (for example, "iiop").

readymetric-naming-user

String

false

none

The user to use for the connection made to the server when doing the ready metric check (for example, "weblogic").

readymetric-server-protocol

String

false

none

The protocol to use for the connection made to the server when doing the ready metric check (for example, "iiop").


Table B-4 describes Admin Server appliance input system properties:

Table B-4 Admin Server Appliance Input System Properties

Name Type Req'd Default Description

admin-password

String

true

none

The admin user's password.

admin-username

String

true

none

The admin user name for connecting to the Admin server (for example, "weblogic").


Table B-5 through Table B-8 describes Admin Server appliance output user properties for JDBC, foreign JMS, JMS message bridge, and LDAP.

Table B-5 describes Admin Server appliance output user and system properties for JDBC. The password and username properties are user properties, and original-url is a system property.

Table B-5 Admin Server Appliance Output Properties: JDBC

Name Type Req'd Default Description

password

String

false

<empty>

The password for the user needed for the data source connection.

username

String

false

none

The user needed for the data source connection. The value will be the original user for the data source connection.

original-url

String

false

none

The original JDBC URL from the introspected Oracle WebLogic Server domain. (for example, "jdbc:oracle:thin:@adc2100927.example.com:1521:orcl").


Table B-6 describes Admin Server appliance output user properties for foreign JMS:

Table B-6 Admin Server Appliance Output Properties: Foreign JMS

Name Type Req'd Default Description

original-connection-url

String

false

none

The original URL for the foreign JMS server.


Table B-7 describes Admin Server appliance output system properties for JMS message bridge:

Table B-7 Admin Server Appliance Output Properties: JMS Message Bridge

Name Type Req'd Default Description

original-url

String

false

none

The original URL for the JMS messaging bridge server.

original-username

String

false

none

The original username for the JMS messaging bridge server.

original-password

String

false

none

The original password for the JMS messaging bridge server, encrypted.


Table B-8 describes Admin Server appliance output system properties for LDAP:

Table B-8 Admin Server Appliance Output Properties: LDAP

Name Type Req'd Default Description

original-name

String

false

none

The original name for the LDAP security provider.

original-host

String

false

none

The original host for the LDAP security provider.

original-port

String

false

none

The original port for the LDAP security provider.

original-user

String

false

none

The original user for the LDAP security provider.


B.1.8 Oracle WebLogic Server Appliance Properties

This section discusses the following properties for assemblies with an Oracle WebLogic Server appliance. Those properties include assembly-level properties, properties on the inputs and outputs of each application, and properties of the appliances themselves. This section contains the following subsections:

B.1.8.1 Assembly-Level System Properties

Table B-9 describes assembly-level system properties:

Table B-9 Assembly-level System Properties

Name Type Req'd Default Description

admin-username

String

true

none

The admin user for the domain (for example, "weblogic").

admsvr-jmx-input

String

true

none

Indicates what input on the AdminServer appliance should be used when making JMX connections (for example, "Default").

admsvr-jmx-protocol

String

true

none

The protocol to use when making a JMX connection to the Admin Server (for example, "iiop").

domain-name

String

false

none

The domain name of the domain that was introspected (for example, "test_domain").

usesOracleHomes

boolean

true

none

Indicates that this is not a core Oracle Oracle WebLogic Server installation and as such has an OracleHome associated with it. This will be true for SOA and WebCenter domains. Allowable values are true and false.


B.1.8.2 Assembly-Level User Properties

Table B-10 describes assembly-level user properties:

Table B-10 Assembly-level User Properties

Name Type Req'd Default Description

admin-password

String

true

none

The admin user password for the domain.


B.1.8.3 Properties Common to Admin and Managed Server Appliances

The following information describes properties common to admin and managed server appliances.

Table B-11 describes common Oracle WebLogic Server appliance system properties:

Table B-11 Common Oracle WebLogic Server Appliance System Properties

Name Type Req'd Default Description

capture.hostname

String

true

none

The host name where the introspection was performed (for example, “example.com”).

capture.is64bit

boolean

true

none

Indicates if the system where introspection was performed is a 64-bit system.

capture.osarch

String

true

none

The architecture of the system that was introspected (for example, “i386”).

capture.osname

String

true

none

The operating system name of the system that was introspected (for example, “Linux”).

capture.time

String

true

none

The time the introspection was performed (for example, “1269628142430”).

domain-name

String

false

none

The domain name of the system that was introspected.

admin-input-name

String

false

none

The name of the input for administrative traffic on the admin server.

admin-input-protocol

String

false

none

The protocol to use when connecting to the admin server (for example, “iiop”).

isAdminserver

String

false

none

True for the admin server, false otherwise.

NodeManagerType

String

true

none

The type of node manager machine definition to create (for example, "SSL").

server-names

String

false

none

A list of server names for the appliance (for example, “AdminServer”). For a cluster appliance there will most likely be more than one server name in the list.


Table B-12 describes common Oracle WebLogic Server appliance user properties:

Table B-12 Common Oracle WebLogic Server Appliance User Properties

Name Type Req'd Default Description

NodeManagerPort

Integer

true

5556

The port the node manager should listen on (for example, 5556). This will only be present if node manager was found to be configured on the reference system.

readymetric-attribute-compare-type

String

false

EQUALS

The comparison to make between the readymetric-attribute's value and the value specified for the property readymetric-attribute-value.

Valid values are EQUALS, LESSER_THAN, GREATER_THAN, LESSER_THAN_OR_EQUAL, and GREATER_THAN_OR_EQUAL.

readymetric-attribute-name

String

false

State

The MBean attribute to check.

readymetric-attribute-type

String

false

STRING

The type of the MBean attribute.

Valid values (but specific to the attribute being examined) are STRING, INTEGER, SHORT, LONG, DOUBLE, FLOAT, and BOOLEAN.

readymetric-attribute-value

String

false

RUNNING

The value the property readymetric-attribute-name must have for the check to be considered successful.

readymetric-instance-name-0

String

false

com.bea:Name=AdminServer,Type=ServerRuntime

The instance name to use for the JMX ready metric check.

readymetric-max-wait-period

String

false

600

The maximum time in seconds to wait for a successful ready metric check.

readymetric-naming-input

String

false

none

The input to use for the ready metric check (for example, “Default”).

readymetric-polling-period

String

false

none

The time between connection attempts, in seconds, for the ready metric check.

readymetric-server-input

String

false

none

The input to use for the ready metric check (for example, “Default”).

readymetric-trust-store-0

String

false

none

The location of the trust store to use if the ready metric check is using an SSL enabled port.

readymetric-type

String

false

JMX

The type of ready metric to use for the appliance.

readymetric-verify

String

false

true

If this property is set to true the ready metric check will be performed. Otherwise it will be skipped.

useTemplate

String

false

OEL

Specifies the template type to use by default when creating a template for the appliance.


B.1.8.4 Admin Server Appliance Properties

Table B-13 describes Admin Server appliance system properties:

Table B-13 Admin Server Appliance System Properties

Name Type Req'd Default Description

admin-input-name

String

false

none

The input to use for connecting to the Admin server admin-input-protocol (for example, “Default”).

admin-input-protocol

String

false

none

The protocol to use for connecting to the Admin server (for example, “http”).


Table B-14 describes Admin Server appliance user properties:

Table B-14 Admin Server Appliance User Properties

Name Type Req'd Default Description

<cluster name>-cluster-address

String

false

<empty>

The cluster address for the cluster named by the first part of the property name.

<cluster name>-frontend-host

String

false

<empty>

The front-end host for the cluster named by the first part of the property name.

<cluster name>-frontend-http-port

String

false

<empty>

The non-secure front-end port for the cluster named by the first part of the property name.

<cluster name>-frontend-https-port

String

false

<empty>

The secure front-end port for the cluster named by the first part of the property name.


B.1.10 Supported Template Types

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

B.2 Oracle Coherence*Web Extension

The Oracle Coherence*Web introspection extension extends the functionality of the WLS Introspector. It examines the configuration of Coherence cache clusters and servers configured as part of an Oracle WebLogic Server domain.

B.2.1 Versions Supported

The plug-in extension works with Oracle WebLogic Server 11gR1 version 11.1.1.4.0, which includes Coherence 3.6, and Oracle WebLogic Server 11gR1 version 11.1.1.6.0.

B.2.2 Oracle Coherence*Web Introspection Parameters

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

B.2.3 Reference System Prerequisites

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

B.2.4 Requirements

Oracle Coherence*Web has the following requirements:

B.2.4.1 Deployment Model Requirement

The plug-in extension requires you to use an out-of-process deployment model for Oracle Coherence*Web, in which storage-enabled cache servers are executed as separate processes rather than running within Oracle WebLogic Server.

B.2.4.2 Requirement to Manually Update Custom Cluster Configuration Files

The plug-in extension examines Oracle Coherence*Web configuration defined through the Oracle WebLogic Server console and Oracle WebLogic Server mBeans (including WLST). It does not examine or modify custom cluster configuration files such as tangosol-coherence-override.xml. Custom cluster configuration files are passed through to the deployed environment, but no configuration changes are made to those files to reflect the deployed environment.

After deployment, ensure that you make appropriate manual configuration changes to any custom cluster configuration files.

B.2.5 Resulting Artifact Type

For each Coherence cluster that is defined in an introspected Oracle WebLogic Server domain, the plug-in extension creates a new appliance within the atomic Oracle WebLogic Server assembly.

B.2.6 Wiring

No wiring can be performed for Coherence cluster appliances. Each cluster appliance has a fixed, pre-defined connection to the domain's AdminServer, which is used at rehydration time to modify the cluster's configuration.

B.2.7 Wiring

None.

B.2.8 Oracle Coherence*Web Appliance Properties

Each Oracle Coherence*Web cluster appliances has the following system and user properties:

Table B-15 describes Oracle Coherence*Web cluster appliance system properties:

Table B-15 Oracle Coherence*Web Appliance System Properties

Name Type Req'd Default Description

cache-servers

String

false

none

A list of the cache servers that are part of the cluster.

targets

String

false

none

A list of WLS managed servers that are part of the cluster.

<cacheserver>.node-manager-type

String

false

none

For each cache server in the above list, there is a property indicating the node manager type.

well-known-addresses

String

false

none

A list of well-known-addresses defined for the cluster. If no well-known-address are defined for this cluster (meaning it uses multicast), then this property will not be present.

<wellknownaddress>.server

String

false

none

For each of the well-known-addresses in the above list, there is a property indicating which cache server the well known address maps to (based on matching listen address and port information).


Table B-16 describes Oracle Coherence*Web cluster appliance user properties:

Table B-16 Oracle Coherence*Web Appliance User Properties

Name Type Req'd Default Description

<cacheserver>.node-manager-port

String

false

none

For each of the cache servers in the cluster, the node manager port is listed and may be modified by the user.

<cacheserver>.unicast-listen-port

String

false

none

For each of the cache servers in the cluster, the unicast listen port of that server is listed and may be modified by the user.

multicast-listen-address

String

false

none

The cluster-wide multicast listen address. If one or more well-known-addresses are listed (meaning the cluster uses unicast for cluster discovery), then this multicast property will not be present.

multicast-listen-port

String

false

none

The cluster-wide multicast listen port. If one or more well-known-addresses are listed (meaning the cluster uses unicast for cluster discovery), then this multicast property will not be present.

unicast-listen-port

String

false

none

The default unicast listen port for the cluster. This value is used by any cache servers that do not have a unicast listen port defined, as well as by any WLS managed servers that join the cluster.

<wellknownaddress>.server

String

true

none

If any of the defined well known addresses could not be correlated with a cache server (based on matching listen address and port information), they will be listed here, and the user is responsible for specifying a cache server name to be used as the well known address. This property is mandatory, meaning it must be specified either as an appliance property or via a deployment plan.


B.2.9 Supported Template Types

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

B.3 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.3.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.3.2 Introspection Parameters

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

B.3.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.3.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.3.4 Requirements

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

B.3.4.1 Managed Servers Requirement

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

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

B.3.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.3.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.3.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.3.6 Wiring

B.3.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.3.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.3.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 Section B.6.7.1, "Oracle Access Manager Admin Server".

B.3.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.3.7, "Wiring Properties".

B.3.7 Wiring Properties

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

Table B-17 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-26.

Note:

If the UseOID property described in Table B-17 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-26.

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-18 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-19 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-20 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.3.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.4 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.4.1 Versions Supported

This plug-in supports version 11gR1 11.1.1.6.

B.4.2 Oracle Service Bus Introspection Parameters

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

B.4.3 Reference System Prerequisites

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

B.4.4 Requirements

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

B.4.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.4.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.4.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.4.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.4.4.5 Post Assembly Deployment Requirements

The following are requirements after deployment.

B.4.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.4.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.4.5 Resulting Artifact Type

Same as in Oracle WebLogic Server plug-in.

B.4.6 Wiring

Same as in Oracle WebLogic Server plug-in.

B.4.7 Wiring Properties

Same as in Oracle WebLogic Server plug-in.

B.4.8 Oracle Service Bus Appliance Properties

Same as in Oracle WebLogic Server plug-in.

B.4.9 Supported Template Types

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

B.5 Oracle SOA Plug-in

The Oracle SOA introspection plug-in introspects an existing SOA WebLogic Server deployment, capturing all the configuration in the SOA domain as well as the container configuration and deployed composites in MDS.

The SOA plug-in enables running configuration plans for deployed composites in the target environment.

B.5.1 Versions Supported

This plug-in supports version 11gR1 11.1.1.6.

B.5.2 Oracle SOA Service Engine Configuration

The SOA plug-in uses a property mappings files to map configuration elements to bean properties. For each property in a property mappings file, a user property is created on the admin appliance. These mappings files are contained under /config in the soa-plugin.jar. Each mappings file is associated with the corresponding service engine configuration file by a naming convention. Each mappings file adds "-mappings" to the configuration file name just before ".xml". For example, for the service engine configuration file "bpel-config.xml", the associated property mappings file is "bpel-config-mappings.xml".

Each property mappings file has the following structure.

Example B-1 Property Mappings File used by SOA Plug-in

<property-mappings>
  <prefix>soa.bpel</prefix>
  <persistence-bean>oracle.soa.management.config.bpel.BPELConfig</persistence-bean>

  <property name="my-property">
    <bean property="myProperty" type="int"/>
  </property>
  <property name="my-nested-property">
    <bean property="nestedObject.myProperty" type="string"/>
  </property>
  ...
</property-mappings>

Table B-21 describes elements in the property mappings files:

Table B-21 SOA WebLogic Server: Property Mappings File Elements

Parameter Description

prefix

Prefix to add to each property in the file.

persistence-bean

Bean used to set/get property values. The bean can use any mechanism for reading/writing to the service engine configuration file. All persistence beans currently use JAXB for persistence.

property

Contains information about the property.

property.name

The name of the property which will be visible to the end user. This name will be prefixed by the above mentioned prefix.

bean

Contains information about the bean property that this user property is mapped to.

bean.property

The name of the property in the bean. This name is used to determine setter/getter names. For a property with location="myProperty", the getter name is getMyProperty and the setter is setMyProperty.

For boolean types, "isMyProperty" and "hasMyProperty" are also tried. If the property in the bean is on a nested object, that can be specified using the notation location="nestedObject.myProperty". In this case, "getNestedObject()" would be called on the persistence bean and on the result "getMyProperty()" would be called.

bean.type

The type of the property in the bean. Must be one of {string,int,long,float,double,boolean}


B.5.3 Oracle SOA Application Configuration

Application-scoped configuration is configuration scoped to a composite application. The SOA plug-in exposes application configuration as user properties which you can update for the target environment when creating an assembly. Application configuration supports the configuration exposed through SOA configuration plans.

The following types of application configuration are supported:

  • Any composite, service component, reference and binding properties in the SOA composite application file (composite.xml)

  • Attribute values for bindings (for example, the location for binding.ws)

  • schemaLocation attribute of an import in a WSDL file

  • location attribute of an include in a WSDL file

  • schemaLocation attribute of an include, import, and redefine in an XSD file

  • Any properties in JCA adapter files

  • Modify and add policy references for the following:

    • Service component

    • Service and reference binding components

See Oracle SOA Configuration Plan for more information on supported configuration.

During introspection the SOA plug-in checks each composite for a configuration plan. If no configuration plan exists, a default configuration plan is generated for the composite.

The plug-in parses the configuration plan and exposes each element in the configuration plan as a user property in Oracle Virtual Assembly Builder. The configuration plan is an XML document containing hierarchical data.

B.5.3.1 Configuration Plan User Properties

User Property keys are encoded using a "dot" notation where levels of the XML hierarchy are separated by a period ('.') and are referred to as path tokens or tokens. Elements that have an attribute, such as name, that uniquely identify the element are included in the token and are separated from the element type by an underscore ('_').

The portion of the token following the '_' is referred to as the "token id". Each token type (such as composite, or service) may have rules for what constitutes the token id. All configuration plan properties start with soa.cp to make them easily identifiable, as shown in Example B-2.

Example B-2 Configuration Plan used by SOA Plug-in

<composite name="HelloWorldProject">
  <service name="helloworldbpel_client_ep">
    <binding type="ws">
      <attribute name="port">
        <replace>http://xmlns.oracle.com/myPort</replace>
      </attribute>
    </binding>
  </service>
</composite>

The associated user property is:

soa.cp.composite_ HelloWorldProject_1-1.service_ helloworldbpel_client_ep.binding_ws.attribute_port

In this XML code example there is one configuration element, the attribute "port". The composite, service, binding and attribute tokens each have a token id. For the composite token id, it is the name attribute and composite version. For the binding element it is the binding type.

The following are a list of configuration plan elements and their associated path tokens, including the token id rules:

Table B-22 describes elements in the configuration plan:

Table B-22 SOA WebLogic Server: Configuration Plan Elements

Element Path Token

Composite

composite_<composite name>_<composite version with dash ('-') replacing period ('.')>

Service

service_<service name>

Reference

reference_<reference name>

Import

import_<generated id>

Property

property_<property name>

Component

component_<component name>

Attribute

attribute_<attribute name>

Binding

binding_<binding type>

SearchReplace

There is no token for SearchReplace. See Search and Replace tokens.

Search

search_<generated id>

Replace

replace_<generated id>

PolicyReference

PolicyReference_<generated id>

Callback

callback (The configuration plan currently only allows one per element. There is no token id.)

OverrideProperty

OverrideProperty_<override property name>

WsdlAndSchema

wsdlAndSchema_<wsdlAndSchema name>


B.5.3.2 External References

Composite configurations may contain references to external resources. Examples of this are Web service reference bindings where a location is specified, and imports. You can update these external references for the target environment. Only “search” properties are parsed for external references. For search properties that contain an external reference, the replace value will be the search value with the protocol://host:port portion of the URL re-placed with a token in the form of <#Output::output-name#>. This correlates that user property with the appropriate assembly output.

When composites are deployed using a configuration plan, the configuration artifacts in the composite are modified based on the configuration plan. Because of this, if a configuration plan is used to deploy a composite to a staging environment and then later the staging environment is introspected, any external references in the configuration plan will have already been replaced in the composite. As a result, none of the external references in the configuration plan will be replaced during reconfiguration because the search value no longer exists in the composite configuration. To handle this case, each output has a user property called soa.reference.aliases. This alias property allows for aliases to be specified for the output. By default, the location portion of the replace value is set as an alias. Additional aliases may be added manually using a ',' or ' ' separator between aliases. In addition to the original search value, each of the aliases will also be replaced during reconfiguration.

Example B-3 External Reference in a Configuration Plan used by SOA Plug-in

<composite name="compositeA">  <reference name="reference1">    <binding type="ws">      <attribute name="location">        <searchReplace>          <search>http://my.host.com:8080/some/path/info</search>          <replace>https://my.new-host.com:8081/some/path/info</replace>        </searchReplace>    </attribute>     </binding>  </reference></composite

The associated user properties are:

  • Search Property:

    • name=soa.cp.composite_compositeA_1-0.reference_reference1.binding_ws.attribute_location.search

    • value=http://my.host.com:8080/some/path/info

  • Replace Property:

    • name=soa.cp.composite_compositeA_1-0.reference_reference1.binding_ws.attribute_location.replace

    • value=<#Output::my_host_com:8080#>/some/path/info

In the example, the original replace value is not used. Instead, the original search value is used with the protocol, host, and port being replaced with a token that correlates this search/replace with an external reference output. At reconfiguraiton, this token is replaced with the protocol, host, and port obtained from the external resource that is connected to the external reference output of the name "my_host_com:8080". The replacement token should not be modified, but the path information following the replacement token can be updated if needed.

If another external reference that matches "http://my.host.com:8080" is contained in a configuration plan of any composite deployed to the domain, the same output is used.

In the following configuration plan, no new output is added to the assembly:

Example B-4 Configuration Plan Where No New Output is Added to the Assembly

<composite name="compositeB">
  <import>
    <searchReplace>
      <search>http://my.host.com:8080</search>
      <replace/>
    </searchReplace>
  </import>
</composite>

The associated user properties are:

  • Search Property:

    • name=soa.cp.composite_compositeB_1-0.import.search

    • value=http://my.host.com:8080

  • Replace Property:

    • name=soa.cp.composite_compositeB_1-0.import.replace

    • value=<#Output::my_host_com:8080#>

B.5.4 Reference System Prerequisites

The SOA plug-in has runtime dependencies on product jars in the SOA/WebLogic Server distribution. These dependencies are not part of the plug-in's initial classpath. You must load these product dependencies dynamically from the product distribution.

These dependencies fall into two functional categories:

  • Fabric dependencies include the capturing of file sets of composites and the deployment of composites, and are contained in dynlib/soa-plugin-fabric.jar.

  • MDS dependencies include all interactions with MDS, and are contained in dynlib/soa-plugin-mds.jar.

B.5.5 Resulting Artifact Type

The introspection produces a SOA assembly consisting at minimum of an admin server and a managed server, but most likely consisting of an admin server, and a cluster of managed SOA servers. Each of these servers, or cluster, is represented by an appliance.

B.5.6 Wiring

Composite configurations may contain references to external resources. Examples of this are Web service reference bindings where a location is specified, and imports. These external references are exposed so that they can be updated for the target environment.

For each distinct external reference an output is added to the associated assembly. You must wire each output to an input of an external resource using Oracle Virtual Assembly Builder Studio. A reference is distinct from another reference if it differs in protocol, host/IP address or port.

B.5.7 Wiring Properties

See Section B.5.3.2, "External References".

B.5.8 Oracle SOA Appliance Properties

Oracle SOA appliances have the following properties:

Table B-23 Oracle SOA: System Properties

Name Type Req'd Default Description

SOA_MW_HOME

String

false

none

The Middleware Home directory.

SOA_HOME

String

false

none

The SOA Oracle Home (for example, "AS11gR1SOA").

SOA_JDK_HOME

String

false

none

The JDK Home.

IS_SOA_SERVER

String

false

none

Identifies SOA Managed Servers.


B.5.9 Extensions of the Plug-in

None.

B.5.10 Supported Template Types

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

B.6 Oracle HTTP Server Introspector Plug-in

The Oracle HTTP Server introspection plug-in examines a single Oracle HTTP Server appliance from an Oracle Web Tier instance. Oracle HTTP Server and the Oracle Process Manager and Notification Server that manages it are captured, as well as the Oracle Access Manager 11g admin server and any server instances.

B.6.1 Versions Supported

This plug-in supports versions 11gR1 11.1.1.5 and 11gR1 11.1.1.6.

B.6.2 Oracle HTTP Server Introspection Parameters

Table B-24 lists the introspection parameters for Oracle HTTP Server:

Table B-24 Oracle HTTP Server Plug-in Introspection Parameters

Parameter Description

oracleInstance

The fully qualified path to the Oracle Instance that contains the Oracle HTTP Server appliance to be introspected.

componentName

The name of the Oracle HTTP Server appliance within the Oracle Instance specified. For example, 'ohs1'.


B.6.3 Reference System Prerequisites

The Oracle HTTP Server plug-in supports Oracle Access Manager 11g WebGate for single-sign on if you meet the following requirements:

  • You install WebGate 11g in the same MW_HOME as Oracle HTTP Server, with the ORACLE_INSTANCE of WebGate 11g the same as the ORACLE_INSTANCE of Oracle HTTP Server.

  • You configure Oracle HTTP Server with Oracle Access Manager 11g Webgate and register the Webgate 11g agent with the Oracle Access Manager server.

  • The RREG toolkit, rreg-toolkit.jar, is available on the reference system under OHS_MW_HOME/Oracle_FRHome1/oam/server/rreg/client.

    The RREG toolkit is located in the oam directory inside the Oracle home after Oracle Forms and Reports is installed, and is used to register the partner application with Oracle Access Manager 11g during reconfiguration. The version of the RREG toolkit must match the version of Oracle Access Manager 11g. If the RREG toolkit of the correct version is not available under this location, then the introspection fails.

    If the Web tier is set up on a separate node for the Forms and Reports installation on the reference system, ensure that you meet the requirements described in Section B.3.3.1, "Adding Partner Application Registation Utility (Web Tier on a Separate Node)" prior to introspection.

    For more information on the RREG toolkit, see "Configuring Oracle Forms and Reports with Oracle Access Manager in Secure Mode" in Oracle® Fusion Middleware Installation Guide for Oracle Forms and Reports.

B.6.4 Resulting Artifact Type

A single scalable appliance.

B.6.5 Requirements

Make sure Oracle Access Manager admin server and the instances are up and running.

B.6.6 Wiring

Inputs are created on the Oracle HTTP Server appliance for each Listen or Port directive found in the configuration. The protocol of an Oracle HTTP Server input is set to http unless the Listen directive is found inside a VirtualHost directive and has SSLEngine on directive set, then it has the protocol set to https. Typically Web Cache outputs are connected to Oracle HTTP Server inputs.

Outputs on the Oracle HTTP Server appliance are created based on various directives related to Oracle WebLogic Server in the Oracle HTTP Server configuration. The outputs indicate which inputs on an Oracle WebLogic Server assembly to connect to through the output 'description'.

One output endpoint is created on the Oracle HTTP Server appliance to represent the Oracle Access Manager admin server connection.

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

B.6.7.1 Oracle Access Manager Admin Server

One output endpoint is created on the Oracle HTTP Server appliance to represent the Oracle Access Manager admin server connection. The output exposes the following non-editable properties:

Table B-25 Output for Oracle Access Manager Admin Server Connection

Name Type Default Description

name

String

OAMRegistration

Name of the Oracle Access Manager admin server.

protocols

String

Discovered at introspection.

The security protocol. Can be simple, open, or cert.


An External Resource should be created to represent the Oracle Access Manager admin server. The external resource exposes the admin-username, admin-password, port and protocols as input endpoint properties.

B.6.8 Oracle HTTP Server Appliance Properties

Oracle HTTP Server appliances have user properties (Table B-26) and system properties (Table B-27). Properties with the webgate prefix are required for partner application registration during reconfiguration.

Note:

There are a number of other properties that you can use in partner application registration during reconfiguration. For example, maxConnections, maxSessionTime, failOverThreshold, etc. None of these properties are exposed by the Oracle HTTP Server plug-in as appliance properties.

You can change these properties after reconfiguration. For a list of supported properties, see Registering Partners (Agents and Applications) Remotely in Oracle® Fusion Middleware Administrator's Guide for Oracle Access Manager with Oracle Security Token Service .

Table B-26 Oracle HTTP Server: User Properties

Name Type Req'd Default Description

userDirective

String

false

none

Indicates whether the user directive exists in the configuration files.

groupDirective

String

false

none

Indicates whether the group directive exists in the configuration files.

readymetric.timeout

Integer

false

300

Sets the timeout duration, in seconds.

readymetric.pollingPeriod

Integer

false

5

Sets the polling period, in seconds.

webgate.security

String

true

Discovered at introspection.

Indicates the level of communication transport security between the Agent and the Oracle Access Manager Server (this must match the level specified for the Oracle Access Manager Server).

Possible values: simple, open or cert.

If the value of webgate.security user property specified is cert, you must install the required certificates on the deployed VM and establish the trust channel between WebGate and Oracle Access Manager server manually after reconfiguration.

You do not need to install the certificates if the same (reference system) Oracle Access Manager server is used for partner application registration during reconfiguration, because the certificates required for the communication between WebGate and Oracle Access Manager server are, by default, copied from the reference system to the deployed VM.

webgate.agentPassword

String

false

N/A

An optional, unique password for this Webgate, which can be assigned during this registration process.

webgate.agentKeyPassword

String

false

N/A

Required by the Oracle Access Manager Server to generate password.xml.

Required only when the webgate.security value is "cert".

webgate.protectedResourcesList

String

true

/,/.../*

Specifies the resource URLs that you want the Oracle Access Manager Agent to protect with some authentication scheme. The resource URLs must be relative paths to the agentBaseUrl.

Specify as a comma-separated list.

For example, in an environment where Oracle HTTP Server is a front-end to Oracle Forms and Reports: /reports/rwservlet/*,/forms/frmservlet?*oamMode=true

webgate.publicResourcesList

String

false

/public/index.html

Specifies the resource URLs that you want to keep public (not protected by the Oracle Access Manager Agent). The resource URLs must be relative paths to the agentBaseUrl. For instance, you may want to specify the Home page or the Welcome page of your application.

Specify as a comma-separated list.

webgate.excludedResourcesList

String

false

/excluded/index.html

Specifies the HTTP type resource URLs that you want to keep public (not protected by the Oracle Access Manager Agent). The resource URLs must be relative paths to the agentBaseUrl. For instance, you may want to specify the Home page or the Welcome page of your application.

Only HTTP resource types can be excluded. Typically security insensitive files like Images (*.jpg, *.png) that do not require Authentication, Authorization, Response processing, Session management, and Auditing. Excluded resources cannot be added to any user-defined policy in the console.

Specify as a comma-separated list.


Note:

The agentBaseURL is generated automatically during reconfiguration based on the deployed VM hostname and Oracle HTTP Server instance port.

Table B-27 Oracle HTTP Server: System Properties

Name Type Req'd Default Description

ORACLE_INSTANCE

String

false

none

The path the user specified as the Oracle instance.

COMPONENT_TYPE

String

false

none

The type of the appliance being introspected.

COMPONENT_NAME

String

false

none

The name of the appliance being introspected.

ORACLE_HOME

String

false

none

The path to the Oracle home related to this Oracle instance.

FMW_HOME

String

false

none

The path to the Fusion Middleware home related to this Oracle instance.

JAVA_HOME

String

false

none

The path to the Java home used by this Oracle instance.

oraInstLocDir

String

false

none

The directory used by Oracle Universal Installer for installation files.


B.6.9 Extensions of the Plug-in

None.

B.6.10 Supported Template Types

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

B.7 Oracle Web Cache Plug-in

The Oracle Web Cache introspection plug-in examines a single Oracle Web Cache appliance from an Oracle Web tier instance. Both Oracle Web Cache and the Oracle Process Manager and Notification Server that manages it are captured.

B.7.1 Versions Supported

This plug-in supports versions 11gR1 11.1.1.5 and 11gR1 11.1.1.6.

B.7.2 Oracle Web Cache Introspection Parameters

Table B-28 lists the introspection parameters for Oracle Web Cache Server:

Table B-28 Oracle Web Cache Plug-in Introspection Parameters

Parameter Description

oracleInstance

The fully qualified path to the Oracle Instance that contains the Oracle HTTP Server appliance to be introspected.

componentName

The name of the Oracle HTTP Server component within the Oracle Instance specified. For example, 'ohs1'.


B.7.3 Reference System Prerequisites

The Oracle Web Cache introspection plug-in does not support configurations with multiple network interface cards (NICs). If the Web Cache configuration binds to more than one NIC, introspection will fail. To avoid this failure, before introspection set all IP addresses in the <LISTEN> elements to "ANY".

B.7.4 Requirements

The following requirements apply to Oracle Web Cache:

B.7.4.1 Requirement to Update Virtual Host Map Properties

Whenever you make a port change, you must update your virtual host map (VHM) ports by manually updating the properties associated with the VHMs.

B.7.5 Resulting Artifact Type

A single scalable appliance.

B.7.6 Wiring

Inputs will be created on the Web Cache appliance for each <LISTEN> element found in webcache.xml.

Outputs on the Oracle Web Cache appliance indicate how they should be connected to an Oracle HTTP Server appliance via the output 'description'. The outputs are created based on various directives in the Oracle Web Cache configuration and the description can be used to determine which input on the Oracle HTTP Server appliance to connect the Oracle Web Cache output to.

B.7.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 Web Cache endpoints:

A single output is created for each virtual host mapping. Each output contains the properties described in Table B-29:

Table B-29 Oracle Web Cache: Output Properties

Name Type Req'd Default Description

relatedOriginServers

String

false

OEL

A comma separated list of all of the host definition names for the given virtual host map.

For example, 'host1,host2,host3'

vhm-siteX-HOST

String

false

none

The value of the host property of the virtual host map.

PORT

String

false

none

The value of the port property of the virtual host map.


B.7.8 Oracle Web Cache Appliance Properties

Table B-30 describes Oracle Web Cache appliance user properties.

Table B-30 Oracle Web Cache: User Properties

Name Type Req'd Default Description

adminPassword

String

false

none

The password to use for the MONITORING password. If not specified, the system property originalAdminPassword will be used.

statisticsPassword

String

false

none

The password to use for the INVALIDATION password. If not specified, the system property originalStatisticsPassword will be used.

readymetric.timeout

Integer

false

300

Sets the timeout duration, in seconds.

readymetric.pollingPeriod

Integer

false

5

Sets the polling period, in seconds.

siteX-HOST

String

false

<read from file>

The host name for the site definition.

siteX-PORT

String

false

<read from file>

The port value for the site definition.


Table B-31 describes Oracle Web Cache appliance system properties.

Table B-31 Oracle Web Cache: System Properties

Name Type Req'd Default Description

oracleInstance

String

false

none

The path the user specified as the Oracle instance.

componentType

String

false

none

The type of the appliance being introspected.

componentName

String

false

none

The name of the appliance being introspected.

oracleHome

String

false

none

The path to the Oracle home related to this Oracle instance.

javaHome

String

false

none

The path to the Java home used by this Oracle instance.

originalAdminPassword

String

false

See the description column.

This is the password hash as it exists for this Oracle Web Cache instance. The deployed system uses this value unless you specifically set the value of the 'adminPassword' user property.

The default value is the hashed password from the existing Oracle Web Cache configuration for the 'MONITORING' password hash.

originalStatisticsPassword

String

false

A hashed value.

This is the value of the password hash from the existing Oracle Web Cache configuration for the 'INVALIDATION' password hash.

oraInstLocDir

String

false

none

The directory used by Oracle Universal Installer for installation files.


B.7.9 Extensions of the Plug-in

None.

B.7.10 Supported Template Types

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

B.8 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.8.1 Versions Supported

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

B.8.2 Oracle Database Introspection Parameters

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

Table B-32 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.8.3 Oracle Database Introspection Password Parameters

Table B-33 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-33 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.8.4 Reference System Prerequisites

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

B.8.5 Requirements

The following requirements apply to Oracle Database:

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

B.8.6 Resulting Artifact Type

A single appliance.

B.8.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.8.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.8.9 Oracle Database Appliance Properties

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

Table B-34 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-35 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.8.10 Extensions of the Plug-in

None.

B.8.11 Supported Template Types

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

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

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

B.9.1 Versions Supported

This plug-in supports version 11gR2.

B.9.2 Oracle RAC Database Introspection Parameters

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

Table B-36 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.9.3 Oracle RAC Database Introspection Password Parameters

Table B-37 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-37 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.9.4 Reference System Prerequisites

The Clusterware stack must be running during introspection.

B.9.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.9.6 Resulting Artifact Type

A single appliance.

B.9.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.9.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.9.9 Oracle Database Appliance Properties

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

Table B-38 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-39 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.9.10 Extensions of the Plug-in

None.

B.9.11 Supported Template Types

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

B.10 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.10.6, "Wiring".

B.10.1 Versions Supported

This plug-in supports version 11gR1.

B.10.2 Oracle Tuxedo Introspection Parameters

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

Table B-40 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.10.3 Reference System Prerequisites

None.

B.10.4 Requirements

The following requirements apply to Oracle Tuxedo:

B.10.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.10.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.10.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.10.5 Resulting Artifact Type

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

B.10.5.1 Single-Machine Oracle Tuxedo Domain

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

B.10.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.10.6 Wiring

This section describes wiring.

B.10.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.10.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.10.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-41 through Table B-43):

Table B-41 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-42 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-43 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.10.8 Oracle Tuxedo Appliance Properties

Oracle Tuxedo appliances have user properties (Table B-44) and system properties (Table B-45).

Table B-44 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-45 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.10.9 Extensions of the Plug-in

None.

B.10.10 Supported Template Types

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

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

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.11.1 Requirements

The following requirements apply to generic appliances:

B.11.1.1 Specify File Sets

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

B.11.1.2 Scripts Are Launched As Root

All scripts will be launced 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.11.2 Resulting Artifact Type

A single appliance.

B.11.3 Generic Appliance Plug-in Introspection Parameters

Table B-46 lists the introspection parameters for a generic appliance:

Table B-46 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 eDefinition of the Appliance. All files within each specified root are captured during a e 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.

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.11.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-5 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.11.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.11.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.11.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.11.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.11.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. Each endpoint is described in a separate file with the following naming strategy:

  • 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.11.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.11.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.11.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.

All 'userprop.*' properties are endpoint user properties. All 'sysprop.*' properties are endpoint system properties. All 'pwprop.*' properties are endpoint user properties of type PASSWORD and must be supplied in encrypted form and will be returned in encrypted form. See Encryption Support for instructions on how to obtain the encrypted form of a value.

The properties with the 'conn-' prefix are connection properties and they are for specifying requirements on connected inputs. An input is only compatible with a given output if it supports the protocol of the output and has the user and system properties that the output names in its connection properties. This requirement is enforced when creating connections in appliance metadata. Omitting this information may permit the output to be associated with an incompatible input.

The original-host and original-port properties are useful in determining which inputs were connected to which outputs in the case where the inputs/outputs of appliances captured separately were originally connected to each other and need to be reconnected in appliance metadata.

Do not specify the 'connected-input' property, which is derived automatically during reconfiguration. Use the value of the 'connected-input' property in reconfiguration scripts to derive the name of the *. input file by appending '.input' to the name. The filename indicated by the connected-input property will take the form of <assembly-path>.<input-name>.

This input file is just like any other *.input file but it is for another appliance and therefore prefixed with the assembly-path to avoid input name collision. For example, consider an appliance at path 'mySite/otherAppliance' which has input 'otherInput' which is connected to an output named 'output1' on a target GenericProd appliance. The connected output file, 'output1. output' would contain the following property:

connected-input=mySite.otherAppliance.otherInput

The *.input file representing 'otherInput' would be located at the following full path (alongside all other *.input/*.output files):

$AB_ENDPOINT_DIR/mySite.otherAppliance.otherInput.input

B.11.5.5 Encryption Support

To prevent the storage of cleartext passwords on disk, you must supply all password properties in encrypted form. During reconfiguration the password properties (which may have been modified during assembly editing or by deployment plan) are written back out to the property files also in encrypted form. OVAB provides an encryption utility for use during property file creation and a decryption utility for scripts to invoke during reconfiguration operations.

You can use the 'encryptProperties' command of the abctl utility to encrypt password values during property file creation:

abctl encryptProperties -propertyNames String ... [-outputFile String]

Example execution with three properties, applied to a pre-existing file with replacement of the myprop3 property:

% abctl encryptProperties -propertyNames myprop1 myprop2 myprop3 -outputFile
allmysecrets.pwprops
Enter value for property 'myprop1':
Confirm entered value for property 'myprop1':
Enter value for property 'myprop2':
Confirm entered value for property 'myprop2':
Enter value for property 'myprop3':
Confirm entered value for property 'myprop3':
Changes applied to pre-existing file 'allmysecrets.pwprops'.
Added property 'myprop1'.
Added property 'myprop2'.
Replaced property 'myprop3'.
%

During script execution you can use the 'decryptProperty' command of the utility indicated by the $AB_CLI environment variable to decrypt property values:

$AB_CLI decryptProperty -encryptedValue String

Example execution from a script:

# Encrypted value already obtained from property file.
# Execute decryption utility and store value in variable.
THE_PASSWORD=$($AB_CLI -encryptedValue $THE_PASSWORD_ENCRYPTED)
# Now ready to use $THE_PASSWORD to reconfigure a product.

The standard help facility, "abctl help <command>" in the source environment and "$AB_CLI help <command>" on the vServer may be used to find more detail about these commands.

B.11.5.6 Additional Property Support

Other components may create properties in the appliance that need to be fetched during script execution. Since these values were not originally supplied from a property file they are not present in any of the property files during reconfiguration. You can fetch these properties directly from the appliance metadata. You can use the 'getProperty' command of the $AB_CLI utility by scripts during reconfiguration operations:

$AB_CLI getProperty -propertyName String [-parentAssembly] [-systemProperty] [-instanceId String]

The Deployer delivers to the VM certain configuration parameters that influence the behavior of reconfiguration operations. These parameters are separate from the appliance metadata but may be useful in rare cases to scripts. You can use the 'getConfigParam' command of the $AB_CLI utility by scripts during reconfiguration operations:

$AB_CLI getConfigParam -paramName String [-instanceId String]

The standard help facility, "abctl help <command>" in the source environment and "$AB_CLI help <command>" on the vServer may be used to find more detail about these commands.

B.11.6 Extensions of the Plug-in

None.

B.11.7 Supported Template Types

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