C Common Properties for Oracle Virtual Assembly Builder Components

The following appendix describes common properties for components that Oracle Virtual Assembly Builder can introspect, and other properties that can be specified for deployment. It contains the following sections:

Section C.1, "Common Properties"
Section C.2, "System Properties"
Section C.3, "External Resource Properties"
Section C.4, "Deployer Properties"

C.1 Common Properties

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

Table C-1 OCM-related Common 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.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	false	Set to true in order to perform OCM registration.

C.2 System Properties

The following OCM-related system properties are common to all appliances. They cannot be modified by users.

Table C-2 OCM-related System Properties

Name	Req'd	Default	Description
ocm.ccrDirPath.0	true	sample value: /swat/middleware_ps1/utils/ccr	Not to be edited by users.

C.3 External Resource Properties

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

C.3.1 Common Properties

All external resource appliances have the properties described in Table C-3 (hostname is a user property and external-appliance is a system property)

Table C-3 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

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

C.3.2 foreignJMS Properties

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

Table C-4 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.

C.3.3 jmsBridgeDestination Properties

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

Table C-5 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.

C.3.4 LDAP Properties

Table C-6 describes properties for external resources to connect an LDAP output on an Oracle WebLogic Server Admin server.

Table C-6 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.

C.3.5 Non-Oracle JDBC Properties

Table C-7 describes properties for external resources to connect a non-Oracle JDBC output on an Oracle WebLogic Server Admin server.

Table C-7 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.

C.3.6 JDBC Properties

Table C-8 describes properties for external resources to connect an Oracle JDBC output on an Oracle WebLogic Server Admin server.

Table C-8 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 external resource user properties, then the deployment will fail.

C.4 Deployer Properties

The Oracle Virtual Assembly Builder allows you to configure the deployer properties described in Table C-9 through the deployer.properties file. This file must reside in the $AB_INSTANCE/config/deployer directory.

Table C-9 Deployer Properties Configurable in deployer.properties

Name	Type	Req'd	Default	Description
ovmPort	String	false	0	The HTTP port used for template upload. This property is only used when `uploadTemplatesOverHttp` is also used. The default value of 0 means that a random port will be used.
phoneHomePort	String	false	9678	The HTTPS port on which phone home HTTPS requests are made from the VM instance and templates are uploaded when using HTTPS.
useHostInURL	String	false	none	This overrides the host in the URL, to make the deployer reachable to the VM instance. If unspecified, uses the Oracle Virtual Assembly Builder machine's hostname (the hostname resolved by the machine).
phoneHomeTimeout	String	false	900	Configures the phone home request timeout, in seconds.
uploadTemplatesOverHttp	Boolean	false	false	This property is used to disable the use of SSL when uploading templates.