B Oracle Virtual Assembly Builder Introspection Plug-ins

The following appendix describes the plug-ins for components that Oracle Virtual Assembly Builder can introspect:

• Section B.1, "Oracle WebLogic Server Plug-in"

• Section B.2, "Oracle Coherence*Web Extension"

• Section B.3, "Oracle HTTP Server Introspector Plug-in"

• Section B.4, "Oracle Web Cache Plug-in"

• Section B.5, "Oracle Database Plug-in"

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 v11.1.1.2+.

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 component. 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:

• Section B.1.8.1, "Assembly-Level System Properties"

• Section B.1.8.2, "Properties Common to Admin and Managed Server Appliances"

• Section B.1.8.3, "Admin Server Appliance Properties"

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-password	String	true	none	The admin user password for the domain.
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 Properties Common to Admin and Managed Server Appliances

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

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

Table B-10 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-11 describes common Oracle WebLogic Server appliance user properties:

Table B-11 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.3 Admin Server Appliance Properties

Table B-12 describes Admin Server appliance system properties:

Table B-12 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-13 describes Admin Server appliance user properties:

Table B-13 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.9 Extensions of the Plugin

See Section B.2, "Oracle Coherence*Web Extension".

B.1.10 Supported Template Types

The supported template types are Oracle Enterprise Linux (OEL) and Oracle JRockit Virtual Edition (JRVE).

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.

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-14 describes Oracle Coherence*Web cluster appliance system properties:

Table B-14 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-15 describes Oracle Coherence*Web cluster appliance user properties:

Table B-15 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). Oracle JRockit Virtual Edition (JRVE) is not supported.

B.3 Oracle HTTP Server Introspector Plug-in

The Oracle HTTP Server introspection plug-in examines a single Oracle HTTP Server component from an Oracle webtier instance. Both Oracle HTTP Server and the Oracle Process Manager and Notification Server that manages it are captured.

B.3.1 Oracle HTTP Server Introspection Parameters

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

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

Parameter	Description
oracleInstance	The fully qualified path to the Oracle Instance that contains the Oracle HTTP Server component to be introspected.
componentName	The name of the Oracle HTTP Server component within the Oracle Instance specified. For example, 'ohs1'.

B.3.2 Resulting Artifact Type

A single scalable appliance.

B.3.3 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 will be set to http unless the Listen directive is found inside a VirtualHost directive and has SSLEngine on directive set, then it will have the protocol set to https. Typically Web Cache outputs would be 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 via the output 'description'.

B.3.4 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.3.5 Oracle HTTP Server Appliance Properties

Oracle HTTP Server appliances have user properties (Table B-17) and system properties (Table B-18).

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

Table B-18 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 component being introspected.
COMPONENT_NAME	String	false	none	The name of the component 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.3.6 Extensions of the Plug-in

None.

B.3.7 Supported Template Types

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

B.4 Oracle Web Cache Plug-in

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

B.4.1 Versions Supported

This plug-in supports versions 11gR1 v11.1.1.2+.

B.4.2 Oracle Web Cache Introspection Parameters

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

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

Parameter	Description
oracleInstance	The fully qualified path to the Oracle Instance that contains the Oracle HTTP Server component to be introspected.
componentName	The name of the Oracle HTTP Server component within the Oracle Instance specified. For example, 'ohs1'.

B.4.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.4.4 Requirements

The following requirements apply to Oracle Web Cache:

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

A single scalable appliance.

B.4.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.4.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-20:

Table B-20 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.4.8 Oracle Web Cache Appliance Properties

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

Table B-21 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-22 describes Oracle Web Cache appliance system properties.

Table B-22 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 component being introspected.
componentName	String	false	none	The name of the component 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.4.9 Extensions of the Plug-in

None.

B.4.10 Supported Template Types

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

B.5 Oracle Database Plug-in

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

B.5.1 Versions Supported

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

B.5.2 Oracle Database Introspection Parameters

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

Table B-23 Oracle Database Plug-in Introspection Parameters

Parameter	Description
dataFileDir	Optional. The full path of the database files. This parameter is required if your database file directory is different from the default. Default value: DB 10.2 release: <Parent directory of $ORACLE_HOME>/oradata DB 11.1 and 11.2 release: $ORACLE_BASE/oradata
dbHome	The ORACLE_HOME of the Oracle RDBMS to be introspected.
dbUniqueName	Optional. The global database unique name. This parameter is required if your datbase unique name is different from the SID. The default value is the value specified for -oracleSid.
flashRecoveryDir	Optional. The full path of the database flash recovery files. This parameter is required if your recovery area is different from the default. If you do not have a recovery area, you can ignore this parameter. DB 10.2 release: <Parent directory of $ORACLE_HOME>/flash_recovery_area DB 11.1 release: $ORACLE_BASE/flash_recovery_area DB 11.2 release: $ORACLE_BASE/recovery_area
oracleSid	The Oracle System ID (SID) of the Oracle RDBMS to be introspected.

B.5.3 Reference System Prerequisites

This introspection plugin does not support configurations with multiple NICs.

The database must be shut down during packaging.

B.5.4 Requirements

The following requirements apply to Oracle Database:

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

B.5.4.1 Database Configuration Support

The database introspector expects the listeners (the listener.ora configuration) to be configured as follows:

(ADDRESS = (PROTOCOL = TCP)(HOST = example.cm)(PORT = 5521))

Note:

The protocol, host, and port are all required, and must appear in the order above.

B.5.5 Resulting Artifact Type

A single appliance.

B.5.6 Wiring

Inputs are created on the SIDB appliance for each Listener or Port directive found in the configuration. The protocol of an SIDB input is set to 'jdbc'.

B.5.7 Wiring Properties

All input endpoints have 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.5.8 Oracle Database Appliance Properties

Assemblies with an Oracle Database component have user properties (Table B-17) and system properties (Table B-25).

Table B-24 Oracle Database: User Properties

Name	Type	Req'd	Default	Description
input-listener-1-port	Integer	false	none	Database listener port.
useTemplate	String	false	OEL	The template type to use for deployment.
DB_ACCOUNT_PASSWORD	Password	false	none	The password for database accounts SYS, SYSTEM, SYSMAN, and DBSNMP.

Table B-25 Oracle Database System Properties

Name	Type	Req'd	Default	Description
DB_HOME_NAME	String	false	None	The name of the Oracle home.
DB_LISTENER_ORA_PATH	String	false	DB_LISTENER_ORA_PATH	The path to database listener's listener.ora file.
DB_OWNER	String	false	oracle	The Oracle home owner.
DB_TNSNAMES_ORA_PATH	String	false	$ORACLE_HOME/network/admin/tnsnames.ora	The path to database listener's tnsnames.ora file.
GLOBAL_DB_NAME	String	false	none	The global database name.
ORACLE_GROUPS	String	false	none	The OSDBA and OSOPER groups.
oraInstLocDir	String	false	/etc	The directory where OUI's oraInst.loc file locates.
ORACLE_SID	String	false	none	The unique name for the Oracle database.
DB_BASE	String	false	none	The Oracle base path.
DB_HOME	String	false	none	The Oracle home path.

B.5.9 Extensions of the Plug-in

None.

B.5.10 Supported Template Types

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