A System Administrator's Reference

This appendix contains reference information on directory structures and directory contents, along with details about the start-scripts, JDKs and installer files.

Details for Administration Clients

This section specifies the directory structure, directory contents and start-scripts for administration clients.

Directory Structure and Contents for an Administration Client

All administration clients are installed under the directory:

Linux and Solaris: Oracle_home/ocsb60/admin_console

Oracle_home is the Oracle Home directory you defined when you installed the product.

Table A-1 describes the directory structure and the contents of the directory structure.

Table A-1 Directory Contents and Structure for Administration Clients Relative to Oracle_home/ocsb60

Directory	Description
admin_console	Top-level directory for all administration clients. Contains start-scripts for: Standalone Administration Console Web Administration Console server Scripting Engine Domain Web server Database configuration Also contains files related to log4j: console.log file is the default log file used for the administration clients. log4j.xml defines logging properties used for the administration clients.
admin_console/applications	Created during start-up. Empty directory.
admin_console/extensions	Extensions to the Administration console specific to the features installed.
admin_console/extensions_cef	Extensions to the Administration console specific to the features installed.
admin_console/domain_configuration	Contains these directories: /meta - Contains metadata .xml files that support domain creation. /domain_configuration - Supporting files for domain creation.
admin_console/modules	Contains all OSGi bundles for the administration clients, the Processing Server and the Signaling Server.
admin_console/osgi	Contains OSGi-specific configuration for the Administration Console processes.
admin_console/properties	It contains property files used by the start-scripts for: Standalone Administration Console The SVC and VPN applications. Web Administration Console server Scripting Engine Domain Web server Hosted domains
admin_console/scripts	Contains these scripts used for domain creation: create_domain_bundles.xml create_domain.xml create_hosted_domain.xml define_ocsb_avps.xml define_ocsb_loggers.xml list_bundles.xml Contains the /database directory containing scripts for configuring databases for the Service Broker features that require it.
admin_console/utils	Contains utilities used by the SVC and VPN features.
admin_console/workspace	Contains metadata for administration clients.

Start Scripts

Table A-2 give information about start-scripts for Service Broker.

Table A-2 Start-scripts for the Administration Clients

Script	Description
script.sh	Starts the Scripting Engine. script.sh calls common.sh. See "Using Scripts for Configuration and Management" for details.
start.sh	Starts the Standalone Administration Console. start.sh calls common.sh.
web.sh	Starts the Web Administration Console server. web.sh calls common.sh.
host.sh	Starts the Domain Web server. host.sh calls common.sh. See "Starting and Stopping Processing Servers and Signaling Servers" for information on how to use the script.
common.sh	Starts the Standalone Administration Console, Web Administration Console server, Scripting Engine, and the Domain Web server based on the environment variables set by the script that calls it. Defines the environment variables that send additional arguments to the JVM: AXIA_OPTS - See "Using Wildcard Characters in Scripts" for more information. AXIA_MEM_OPTS - Used to change the Java memory settings in the start script. The syntax for AXIA_MEM_OPTS is: export AXIA_MEM_OPTS=-"-memory_variable new_memory_value" ... Where: memory_variable is the Java memory setting to change. new_memory_value is the amount of memory to reserve. For example, his command sets the Java minimum and maximum heap size settings to 1Gb: export AXIA_MEM_OPTS="-Xms1024m -Xmx1024m" For details on available JVM arguments refer to HotSpot and JRockit documentation: http://www.oracle.com/technetwork/java/javase/gc-tuning-6-140523.html http://docs.oracle.com/cd/E15289_01/doc.40/e15062/toc.htm

Property Files for the Administration Clients

Table A-3 lists property files in

Oracle_home/admin_console/properties and their settings.

Table A-3 Property files used by the Administration Clients

Property File	Description
common.properties	Defines properties common to the: Standalone Administration Console Web Administration Console server Scripting Engine Domain Web server The properties specified are: axia.production.mode axia.console.log4j.server.port axia.ssl.cipher_suites axia.admin.verify.hostname https.cipherSuites javax.net.ssl.keyStore javax.net.ssl.trustStore log4j.configuration axia.console.password.validation.enabled axia.console.password.validation.min_length axia.console.password.validation.require_lower axia.console.password.validation.require_upper axia.console.password.validation.require_digit See the common.properties file and Table A-9 for details on the property settings. See Table A-10 for information on the security entries.
create_db_table.properties	Defines properties for the SVC and VPN applications. The properties specified are: profile.db.server profile.db.port profile.db.dbname profile.db.user
hosting.properties	Defines properties for the Domain Web server. The properties specified are: axia.platform org.eclipse.equinox.http.jetty.http.enabled org.eclipse.equinox.http.jetty.http.port org.eclipse.equinox.http.jetty.https.enabled org.eclipse.equinox.http.jetty.https.port org.eclipse.equinox.http.jetty.ssl.needclientauth org.eclipse.equinox.http.jetty.ssl.keystore See hosting.properties and Table A-9 for details on the property settings. See Table A-10 for information on the security entries.
script.properties	Defines properties for the Domain Web server. The properties specified are: axia.platform org.eclipse.equinox.http.jetty.http.enabled org.eclipse.equinox.http.jetty.http.port See script.properties file and Table A-9 for details on the property settings. See Table A-10 for information on the security entries.
standalone.properties	Defines properties for the Standalone Administration Console. The properties specified are: axia.platform org.eclipse.equinox.http.jetty.http.enabled org.eclipse.equinox.http.jetty.https.enabled See the standalone.properties file and Table A-9 for details on the property settings. See Table A-10 for information on the security entries.
web.properties	Defines properties for the Web Administration Console server. The properties specified are: axia.platform axia.require.domain axia.basic.auth org.eclipse.equinox.http.jetty.http.enabled org.eclipse.equinox.http.jetty.http.port org.eclipse.equinox.http.jetty.https.enabled org.eclipse.equinox.http.jetty.https.port org.eclipse.equinox.http.jetty.ssl.keystore org.eclipse.equinox.http.jetty.other.info org.eclipse.equinox.http.jetty.customizer.class See the web.properties file and Table A-9 for details on the property settings. See Table A-10 for information on the security entries.

Details for Processing Servers and Signaling Servers

This section specifies the directory structure, directory contents and start-scripts for Processing Servers and Signaling Servers.

Directory Contents and Structure for Processing Servers and a Signaling Servers

Processing Servers and a Signaling Servers are installed under the directory:

Oracle_home/ocsb60/managed_server

Oracle_home is the Oracle Home directory you defined when you installed the product.

Table A-4 describes the directory structure and the contents of the directory structure.

Table A-4 Directory Contents and Structure for Processing Servers and Signaling Servers relative to Oracle_home/ocsb60

Directory	Description
managed_server	Top-level directory for a Processing Server and a Signaling Server. Contains start-scripts for the Processing Server and the Signaling Server. Contains the property file server.properties. Also contains files related to log4j: server.log is the default log file used for the servers. log4j.xml defines logging properties used for the servers. These files are relevant up the point in the platform life cycle when the bundle for the log4j service is started. After this point, this configuration is overridden by the configuration in the log4j service itself.
managed_server/config	Contains configuration data.
managed_server/modules	Contains all necessary bundles to start the OSGi framework and bundles for: Platform logging service log4j Provisioning service The bundles in this directory are the minimal set necessary to initiate the server and load the contents of the domain configuration directory.
managed_server/osgi	A working directory for the Managed Server process.
managed_server/ss7	Contains binaries for the SS7 stacks for TDM and Sigtran.

Start Scripts for Processing Servers and Signaling Servers

Table A-5 gives information about start-scripts for Processing Servers and Signaling Servers.

Table A-5 Start-scripts for Processing Servers and Signaling Servers

Script	Description
start.sh	Starts the Standalone Administration Console. Defines the AXIA_OPTS and AXIA_MEM_OPTS environment variables.

Properties File for Managed Servers

Table A-6 gives information property files in:

Oracle_home/managed_server/properties

Table A-6 Property Files Used by Processing Servers and Signaling Servers

Property File	Description
server.properties	Defines properties common for Processing Servers and Signaling Servers. The properties specified are: axia.platform log4j.configuration javax.net.ssl.keyStore javax.net.ssl.trustStore axia.admin.verify.hostname See the server.properties file and Table A-9 for details on the property settings.

Details for Domains

This section specifies the directory structure and directory contents for domains.

Directory Contents and Structure for Domains

Domain directories are created, one for each domain, under the domains home directory, by the domain creation script.

Domains_home/Domain_dir

Domains_home is the directory where you store all domain directories, also know as domain configuration directories. For example: /home/oracle/domains/

Domain_dir is where the domain configuration is stored

Domain directories are defined in the domain_path parameter when you run the domain creation script. Normally, all domain directories are created under the same Domains Home directory.

Table A-7 describes the directory structure and contents of the directory structure.

Table A-7 Directory Contents and Structure for Domains relative to Domains_home

Directory	Description
Domain_dir	Top-lever directory for a domain. Contains the domain configuration file initial.zip. Contains the properties file domain.properties (for Oracle internal use only). This directory is passed to the server start script and this is where a server takes its configuration from.
Domain_dir/modules	Contains all necessary bundles to start the domain functions: processing tier modules, signaling tier modules, or both.
Domain_dir/protected	Contains the domain credential file and the master passwords file protecting the credential file. Both files are encrypted.
Domain_dir/workspace	Contains domain configuration while it is being edited either through the Administration Console or configuration mbeans.

Environment Variables

Table A-8 gives information about the environment variables used.

Table A-8 Environment variables

Variable	Description
AXIA_OPTS	Defines any additional Java options to use.
AXIA_MEM_OPTS	Overrides the default memory settings for the JVM, such as heap size.

System Properties

Table A-9 describes the general system properties defined for Oracle Communications Service Broker. The security-related property entries are listed in Table A-10.

Table A-9 Description of System Properties

System Property	Description
axia.console.log4j.server.port	The port to use for static log4j XML logging service traffic. Set in common.properties
axia.platform	Defines the start mode. These default settings must not be changed: server in server.properties. standalone in standalone.properties. web in web.properties. script in script.properties. hosting in hosting.properties.
diameter.watchdog.for.dynamic.peers	Boolean. Defines whether the Diameter SSU should send Device-Watchdog-Request (DWR) commands to dynamic Diameter peers. true - Directs Diameter SSU to send DWR commands to dynamic peers. false - Stops Diameter SSU from sending DWR commands. This is the default setting. Use AXIA_OPTS to change this setting before starting the Signaling Servers server. This example sets this setting to true: export AXIA_OPTS="-Ddiameter.watchdog.for.dynamic.peers=true" The Diameter SSU applies this property only when dynamic peers are allowed.
diameter.tcp.keepalive.for.client.peers	Boolean. Defines whether the TCP socket option SO_KEEPALIVE for Diameter dynamic peers is enabled. true - Enables SO_KEEPALIVE. false - Disables SO_KEEPALIVE. This is the default setting. Use AXIA_OPTS to change this setting before starting the Signaling Servers server. This example sets this setting to true: export AXIA_OPTS="-Ddiameter.tcp.keepalive.for.client.peers=true" The Diameter SSU applies this property only when dynamic peers are allowed.
log4j.configuration	The name of the static log4j XML configuration file. Set in common.properties for the administration tools. Set in server.properties for the Processing Server and the Signaling Server.
org.eclipse.equinox.http.jetty.http.port	Specifies the HTTP port number the Jetty listens for HTTP traffic on if org.eclipse.equinox.http.jetty.http.enabled is set to true. Default value is 9000. Set in: web.properties hosting.properties The setting in web.properties defines the port for the Web Administration Console server. The setting in hosting.properties defines the port for the Domain Web server. This setting must correspond to the port defined when the domain configuration was created.
org.eclipse.equinox.http.jetty.http.enabled	Boolean. Specifies whether HTTP is used by the Jetty server. Set this property to: true to use HTTP. false to not use HTTP. Set in: hosting.properties script.properties standalone.properties web.properties Must always be set to false in script.properties, standalone.properties, and web.properties.
org.eclipse.equinox.http.jetty.https.enabled	Boolean. Specifies if HTTPS is used by the Jetty server. Set this property to: true to use HTTPS. false to not use HTTPS. Set in: script.properties standalone.properties web.properties Must always be set to false in script.properties, standalone.properties, and web.properties.
org.eclipse.equinox.http.jetty.https.port	Specifies the HTTP port number to use for HTTP communication if org.eclipse.equinox.http.jetty.https.enabled is set to true. The default value is 9000. Set in web.properties and hosting.properties.
org.eclipse.equinox.http.jetty.other.info	Specifies which help-system to use for the Administration Console. Ignored, for future use. Set in web.properties.
profile.db.dbname	Specifies the name of the profile database server used by the SVC and VPN features. The default value is orcl. Set in the create_db_table.properties file.
profile.db.port	Specifies the port of the profile database server used by the SVC and VPN features. The default value is 1521. Set in the create_db_table.properties file.
profile.db.server	Specifies the IP address of the profile database server used by the SVC and VPN features. There is no default value. Set in the create_db_table.properties file.
profile.db.user	Specifies the database user used by the profile database server. Used by the SVC and VPN features. The default value is ocsb. Set in the create_db_table.properties file.

Table A-10 lists the security-related property file entries. See Table A-9 for the other system property file entries.

Table A-10 System Security Properties

System Security Property	Description
axia.admin.verify.hostname	Boolean. Determines whether hostname verification is required for each administrator certificate connection. Default value is true. Set in common.properties.
axia.basic.auth	Boolean. Specifies if HTTP basic authentication is used when the Web Administration Console connects to the Web Administration Console server. Set this property to: true to use HTTP basic authentication. false to not use HTTP basic authentication. Set in web.properties.
axia.console.password.validation.enabled	Boolean. Enables/disables password strength validation. If true, the restrictions in axia.console.password.validation.min_length, axia.console.password.validation.min_length, axia.console.password.validation.require_lower, axia.console.password.validation.require_upper, and axia.console.password.validation.require_digit are enforced. Default value is true. Set in common.properties.
axia.console.password.validation.min_length	Defines the minimum password length. Enforced if axia.console.password.validation.enabled is set to true. Default value is 6 characters. Set in common.properties.
axia.console.password.validation.require_lower	Boolean. Enables/disables requirement that passwords include at least one lower-case character. Enforced if axia.console.password.validation.enabled is set to true. Default is true. Set in common.properties.
axia.console.password.validation.require_upper	Boolean. Enables/disables requirement that passwords include at least one upper-case character. Enforced if axia.console.password.validation.enabled is set to true. Default value is true. Set in common.properties.
axia.console.password.validation.require_digit	Boolean. Enables/disables requirement that passwords include at least one digit. Enforced if axia.console.password.validation.enabled is set to true. Default value is true Set in common.properties.
axia.ssl	Boolean. There are two of these settings and the default value for both is true. One is in the common.properties file that controls whether the Administration Console is requried to use SSL security in all traffic. The other is the master SSL switch for the managed server. If false, no traffic with the managed server is required to use SSL security. If true, SSL security is required.
axia.ssl.cipher_suites	Specifies the combinations of ciphers that Service Broker supports for SSL communication between the Administration Console and its clients. The choices are: TLS_RSA_WITH_AES_128_CBC_SHA TLS_DHE_RSA_WITH_AES_128_CBC_SHA TLS_DHE_DSS_WITH_AES_128_CBC_SHA
https.cipherSuites	Specifies the combinations of ciphers that Service Broker supports for HTTPS communication between the Administration Console and its clients. The choices are: TLS_RSA_WITH_AES_128_CBC_SHA TLS_DHE_RSA_WITH_AES_128_CBC_SHA TLS_DHE_DSS_WITH_AES_128_CBC_SHA
javax.net.ssl.keyStore	The file name of the keystore to use for Processing Servers, Signaling Servers and administration tools. The keystore is a file that contains public and private keys used to establish SSL connections. Set in common.properties for the administration tools. Set in server.properties for the Processing Server and the Signaling Server.
javax.net.ssl.trustStore	The file name of the truststore to use for Processing Servers, Signaling Servers and administration tools. The truststore is a file that contains public certificates used to establish SSL connections. Set in common.properties for the administration tools. Set in server.properties for the Processing Server and the Signaling Server.
org.eclipse.equinox.http.jetty.ssl.keystore	Specifies the keystore to use for the Jetty HTTPS connection between the Web Administration Console and the Web Administration Console server. This entry is commented-out by default. If not specified, the same keystore as defined in the property javax.net.ssl.keyStore is used. Set in web.properties. and hosting.properties.

Directory Contents and Structure for a Domain Configuration

Table A-11 gives information about the directory structure and contents of a domain configuration.

Table A-11 Directory Structure for a Domain Configuration

Directory	Description
Domain_home	Top-level directory for a domain configuration. This directory contains: initial.zip Contains references to all modules for Processing Servers and Signaling Servers. modules A directory with OSGi bundles deployed on the Processing Servers and Signaling Servers in the domain. admin_lock.dat Lock file used to ensure exclusive write-access to the domain configuration.
Domain_home/modules	Contains binaries and configuration data for Processing Servers and Signaling Servers in the domain.

Directory Structure and Contents for JDKs

A bundled JDK can be installed when an administration client, a Processing Server, and a Signaling Server are installed.

These files are located in under the directory:

Linux and Solaris: Oracle_home/ocsb60

Oracle_home is the Oracle Home directory you defined when you installed the product.

Table A-12 describes the directory structure and the contents of the directory structure.

Table A-12 Directory Structure for JDKs Relative to Oracle_home/ocsb60

Directory	Description
jdkversion	Contains Sun HotSpot JDK. version correlates to the version of the JDK, for example 1.6.0_14 This directory is created only if you specified to install Sun HotSpot JDK during the installation.
jrrt-version	Contains Oracle JRockit JDK. version correlates to the version of the JDK, for example 3.1.0-1.6.0 This directory is created only if you specified to install Oracle JRockit JDK during the installation.

Directory Structure and Contents for Oracle Universal Installer

A set of files and directories are created by Oracle Universal Installer.

These files are located under the directory:

Oracle_home/ocsb60

Oracle_home is the Oracle Home directory you defined when you installed the product.

Table A-13 describes the directory structure and the contents of the directory structure.

Table A-13 Directory Structure for Oracle Universal Installer Relative to Oracle_home/ocsb60

Directory	Description
cfgtoollogs	Contains log-files related to Oracle Universal Installer.
inventory	Contains inventory files maintained by Oracle Universal Installer.

Safe Services

Safe services is a set of services that are installed and running when the platform is in state SAFE MODE. They are the bare minimum of services that needs to be running in order to fetch server services, applications, and protocol adapters for the domain configuration and start them. Table A-14 lists these services.

See "Life Cycle of Processing Servers and Signaling Servers" for details on SAFE MODE.

Table A-14 Safe Services

Service	OSGi Bundles
Provisioning service	oracle.axia.platform.provisioningservice
Logging-related	com.bea.core.apache.log4j oracle.axia.platform.loggingservice
Services related to Equinox OSGi Framework	org.eclipse.osgi.services org.eclipse.osgi.services org.eclipse.equinox.ds org.eclipse.equinox.util