B Properties for Oracle Virtual Assembly Builder Components

The following appendix describes the properties for components that Oracle Virtual Assembly Builder can introspect. It contains the following sections:

• Section B.1, "Common Properties"

• Section B.2, "Oracle Database Properties"

• Section B.3, "Oracle HTTP Server Properties"

• Section B.4, "Oracle Web Cache Properties"

• Section B.5, "Oracle WebLogic Server Properties"

• Section B.6, "External Appliance Template Properties"

B.1 Common Properties

The following OCM-related properties are common to all appliances.

Table B-1 OCM-related Properties

Name	Req'd	Default	Description
ocm.anonymousEmailRegistration.emailId	false	none	Email address to use to register with OCM using an email address that is not associated with a metalink account.
ocm.ccrDirPath.0	true	sample value: /swat/middleware_ps1/utils/ccr	Not to be edited by users.
ocm.metalinkCsiRegistration.CSI	false	none	Register deployments using a Customer Support Identifier.
ocm.metalinkCsiRegistration.countryCode	false	none	Two-letter country code associated with the CSI.
ocm.metalinkCsiRegistration.metalinkId	false	none	Metalink ID associated with the CSI.
ocm.metalinkEmailRegistration.metalinkEmailId	false	none	Register deployments using an email ID associated with a metalink account.
ocm.metalinkEmailRegistration.metalinkPassword	false	none	Password associated with the metalink account.
ocm.proxyHost	false	none	Required when OCM registration must occur through a proxy.
ocm.proxyPassword	false	none	Required when OCM registration must occur through a proxy.
ocm.proxyPort	false	none	Required when OCM registration must occur through a proxy.
ocm.proxyUsername	false	none	Required when OCM registration must occur through a proxy.
ocm.repeaterURI	false	none	For use when registering through a configured OCM hub.
ocm.runConfiguration	false	none	Set to true in order to perform OCM registration.

B.2 Oracle Database Properties

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

Table B-2 Oracle Database: User Properties

Name	Type	Req'd	Default	Description
WALLET_LOCATION	String	false	OEL	The password for a user's SYSTEM, SYS, SYSMAN and DBSNMP.
SYSTEM_PASSWORD	String	false	none	The wallet location of the database listener used for secure connections.

Table B-3 Oracle Database: Server Properties

Name	Type	Req'd	Default	Description
ORACLE_SID	String	false	None	The unique instance name for the Oracle database.
ORACLE_BASE	String	false	none	The home directory for the Oracle database software.
ORACLE_HOME	String	false	none	The path to the Oracle home for a particular Oracle database.

B.3 Oracle HTTP Server Properties

Assemblies with an Oracle HTTP Server component have user properties (Table B-4) and system properties (Table B-5).

Table B-4 Oracle HTTP Server: User Properties

Name	Type	Req'd	Default	Description
useTemplate	String	false	OEL	The template type to use for deployment.
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- server-input	String	false	server-input	Defines the name of the input to use for readymetric verification.
readymetric- verify	String	false	none	Enables or disables readymetric verification.

Table B-5 Oracle HTTP Server: Server 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.4 Oracle Web Cache Properties

Assemblies with an Oracle Web Cache component have user properties (Table B-6), system properties (Table B-7), and output properties (Table B-8).

Table B-6 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.
useTemplate	String	false	OEL	The template type to use for deployment.
readymetric- server-input	String	false	server-input	Defines the name of the input to use for readymetric verification.
readymetric- verify	String	false	true	Enables or disables readymetric verification.
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-7 Oracle Web Cache: Server 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.
JAVA_HOME	String	false	none	The path to the Java home used by this Oracle instance.
originalAdmin Password	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.
original Statistics Password	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.

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

Table B-8 Oracle Web Cache: Output Properties

Name	Type	Req'd	Default	Description
vhm-siteX-related_origin_servers	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.
vhm-siteX-PORT	String	false	none	The value of the port property of the virtual host map.

B.5 Oracle WebLogic Server 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.5.1, "Assembly-Level System Properties"

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

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

B.5.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.5.2 Properties Common to Admin and Managed Server Appliances

Table B-10 through Table A-12 describes properties common to admin and managed server appliances.

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

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

Name	Type	Req'd	Default	Description
originalBind Addresses	String	false	none	The original address of the system that was introspected.
originalDefault Hostname	String	false	none	The original hostname of the system that was introspected. (for example, "example.com").

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

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

Name	Type	Req'd	Default	Description
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-12 describes common Oracle WebLogic Server appliance system properties:

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

Table B-13 Common Oracle WebLogic Server Appliance User Properties

Name	Type	Req'd	Default	Description
adfconfig-max-wait-period	String	false	600	The maximum time in seconds that ADF introspection will wait to connect to the server.
NodeManagerPort	String	true	none	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.5.3 Admin Server Appliance Properties

Table B-14 describes Admin Server appliance input user properties:

Table B-14 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-15 through Table B-18 describes Admin Server appliance output user properties for JDBC, foreign JMS, JMS message bridge, and LDAP.

Table B-15 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-15 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-16 describes Admin Server appliance output user properties for foreign JMS:

Table B-16 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-17 describes Admin Server appliance output user properties for JMS message bridge:

Table B-17 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-18 describes Admin Server appliance output user properties for LDAP:

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

Table B-19 describes Admin Server appliance system properties:

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

Table B-20 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.6 External Appliance Template Properties

External appliances represent services to which an Oracle WebLogic Server domain connects.

B.6.1 Common Properties

All external appliance templates have the properties described in Table B-21 (hostname is a user property and external-appliance is a system property)

Table B-21 External Appliance Template Properties: Common Properties

Name	Type	Req'd	Default	Description
hostname	String	true	none	The hostname where the service the external appliance is representing resides. By default this value is unset in the external appliance templates. You must provide a value before deployment
external- appliance	String	true	true	Indicates this appliance as an external appliance.

B.6.2 foreignJMS Properties

Table B-22 describes properties for external appliances to connect a foreign JMS output on an Oracle WebLogic Server Admin server.

Table B-22 foreignJms Properties

Name	Type	Req'd	Default	Description
url	String	false	none	The URL used to connect to the foreign JMS server. If not specified in the template then the value from the reference system is retained when the Oracle WebLogic Server domain is deployed.
Password	String	false	none	The password used to connect to the foreign JMS server. If not specified in the template then the value from the reference system will be retained when the Oracle WebLogic Server domain is deployed.

B.6.3 jmsBridgeDestination Properties

Table B-23 describes properties for external appliances to connect a JMS message bridge output on an Oracle WebLogic Server Admin server.

Table B-23 jmsBridgeDestination Properties

Name	Type	Req'd	Default	Description
url	String	false	none	The URL used to connect to the JMS bridge destination server. If not specified in the template then the value from the reference system is retained when the Oracle WebLogic Server domain is deployed.
Username	String	false	none	The username used to connect to the JMS bridge destination server. If not specified in the template then the value from the reference system is retained when the Oracle WebLogic Server domain is deployed.
Password	String	false	none	The password used to connect to the JMS bridge destination server. If not specified in the template then the value from the reference system is retained when the Oracle WebLogic Server domain is deployed.

B.6.4 LDAP Properties

Table B-24 describes properties for external appliances to connect an LDAPoutput on an Oracle WebLogic Server Admin server.

Table B-24 LDAP Properties

Name	Type	Req'd	Default	Description
Username	String	false	none	The username used to connect to the LDAP server. If not specified in the template then the value from the reference system is retained when the Oracle WebLogic Server domain is deployed.
Password	String	false	none	The password used to connect to the LDAP server. If not specified in the template then the value from the reference system is retained when the Oracle WebLogic Server domain is deployed.

B.6.5 Non-Oracle JDBC Properties

Table B-25 describes properties for external appliances to connect a non-Oracle JDBC output on an Oracle WebLogic Server Admin server.

Table B-25 Non-Oracle JDBC Properties

Name	Type	Req'd	Default	Description
url	String	false	none	The URL used to connect to the non-Oracle database. If not specified in the template then the value from the reference system is retained when the Oracle WebLogic Server domain is deployed.

B.6.6 JDBC Properties

Table B-26 describes properties for external appliances to connect an Oracle JDBC output on an Oracle WebLogic Server Admin server.

Table B-26 Oracle JDBC Properties

Name	Type	Req'd	Default	Description
ORACLE_SID	String	true	orcl	The ORACLE_SID needed to connect to the Oracle database. If not specified in the template then the deployment will fail.