7 Configuring Oracle Internet Directory

This chapter describes Oracle Internet Directory configuration in the OPMN opmn.xml file.

It features the following topics:

Section 7.1, "Oracle Internet Directory Process Module Configuration"
Section 7.2, "Oracle Internet Directory Minimum Configuration"
Section 7.3, "Oracle Internet Directory Complete Configuration"
Section 7.4, "Oracle Internet Directory Attribute Descriptions"

7.1 Oracle Internet Directory Process Module Configuration

The following lines load and identify the Oracle Internet Directory process module. Management of Oracle Internet Directory processes by the process module are identified by the module id.

<module path="$ORACLE_HOME/opmn/lib/libopmnoid.so">
   <module-id id="OID" />
</module>

7.2 Oracle Internet Directory Minimum Configuration

The following lines represent the minimum configuration for Oracle Internet Directory. Default values are assigned to all other configuration elements and attributes for Oracle Internet Directory.

<ias-component id="OID">
   <process-type id="OID" module-id="OID">
      <process-set id="OID" numprocs="1">
         <dependencies>
            <database db-connect-info="IASDB.US.ORACLE.COM"/>
         </dependencies>
            <module-data>
               <category id="oidctl-parameters">
                  <data id="connect" value="IASDB.US.ORACLE.COM"/>
                  <data id="startoidldapd" value="true"/>
               </category>
               <category id="oidmon-parameters">
                  <data id="connect" value="IASDB.US.ORACLE.COM"/>
               </category>
            </module-data>
      </process-set>
   </process-type>
</ias-component>

7.3 Oracle Internet Directory Complete Configuration

The following example represents the complete configuration for Oracle Internet Directory. It contains all possible configuration elements and attributes that can be used with Oracle Internet Directory.

<ias-component id="OID">
   <process-type id="OID" module-id="OID" working-dir="my_working_dir">
      <environment>
         <variable id="TNS_ADMIN" value="/private/user/" />
      </environment>
         <process-set id="OID" numprocs="1">
            <dependencies>
               <database db-connect-info="IASDB.US.ORACLE.COM"/>
            </dependencies>
            <module-data>
               <category id="oidmon-parameters">
                  <data id="connect" value="IASDB.US.ORACLE.COM"/>
                  <data id="host" value="virtual_host_name"/>
                  <data id="sleep" value="20"/>
                  <data id="run-oidctl" value="true"/>
               </category>
               <category id="oidctl-parameters">
                  <data id="connect" value="IASDB.US.ORACLE.COM"/>
                  <data id="instance" value="1"/>
                  <data id="configset" value="1"/>
                  <data id="host" value="12.12.12.12"/>
                  <data id="flags" value="-p 389"/>
                  <data id="startoidldapd" value="true"/>
                  <data id="startoidrepld" value="true"/>
                  <data id="startodisrv" value="true"/>
               </category>
            </module-data>
         </process-set>
   </process-type>
</ias-component>

7.4 Oracle Internet Directory Attribute Descriptions

This section describes the attributes that are specific for Oracle Internet Directory. This section also provides attribute descriptions of the attributes.

The Oracle Internet Directory attributes are described with the following format:

Title: This is the attribute name and value being defined. For example, id="OID".
Required: This field defines whether or not the attribute is required in the component definition.
Default: This defines the default value assigned to the attribute. The default value appears in the installed version of the opmn.xml file or is assigned internally if the attribute is not present.
Valid values: If applicable, this field defines the valid values for the attribute. For example, OID.
Path: This field defines in which elements the attribute can appear. For example, ias-component.

id="OID"

Required: true
Default: none
Valid values: OID
Path: ias-component
Path: ias-component/process-type
Path: ias-component/process-type/process-set

This id name is required and cannot be changed. The name must match the entry targets.xml or Application Server Control Console will not work.

module-id="OID"

Required: true
Default: none
Path: ias-component/process-type

The module-id name defines the type of process and associates this configuration with a process module.

working-dir="my_working_dir"

Required: false
Default: $ORACLE_HOME
Path: ias-component/process-type

The working-dir attribute specifies where the oidmon process will run.

id="TNS_ADMIN"

Required: false
Default: $ORACLE_HOME/network/admin
Path: ias-component/process-type/environment

Oracle Internet Directory requires the connection to the database by specifying a connect string. The string taken by Oracle Internet Directory is an alias. At runtime, the string is resolved using the tnsnames.ora file in the $TNS_ADMIN directory. By default, $TNS_ADMIN points to $ORACLE_HOME/network/admin. If tnsnames.ora exists under a different directory, the environment must be set to the different directory.

numprocs="1"

Required: true
Default: none
Valid values: 1
Path: ias-component/process-type/process-set

This attribute gives the number of oidmon instances started for this process-set. There should be at most one instance running in one Oracle Application Server instance.

db-connect-info="IASDB.US.ORACLE.COM"

Required: true
Default: none
Valid values: The database connect string
Path: ias-component/process-type/process-set

Oracle Internet Directory depends on the backend database. If the backend database is not running, oidmon and other Oracle Internet Directory server processes cannot start.

id="oidmon-parameters"

Required: false
Default: none
Path: ias-component/process-type/process-set/module-data/ category

The id category specifies the startup parameters for oidmon.

id="connect"

Required: true
Default: none
Valid values: The database connect string alias
Path: ias-component/process-type/process-set/module-data/
category/data

The id data must be configured to start oidmon. The following command starts oidmon:

prompt> $ORACLE_HOME/bin/oidmon connect=<value> -opmnuid <uid> start

id="host"

Required: false
Default: none
Valid values: The virtual host name
Path: ias-component/process-type/process-set/module-data/
category/data

The host data is configured by default at installation time. The following command starts oidmon:

prompt> $ORACLE_HOME/bin/oidmon connect=<value> host=<value> -opmnuid <uid> start

id="sleep"

Required: false
Default: 10 seconds
Valid values: The time interval in seconds at which oidmon monitors Oracle Internet Directory servers
Path: ias-component/process-type/process-set/module-data/
category/data

If the sleep data is configured, the following command starts oidmon:

prompt> $ORACLE_HOME/bin/oidmon connect=<connect_value> sleep=<sleep_value>
-opmnuid <uid> start

id="run-oidctl"

Required: false
Default: true
Valid values: true or false
Path: ias-component/process-type/process-set/module-data/
category/data

OPMN manages oidmon. However, when starting and stopping oidmon, OPMN also attempts to start oidldapd through oidctl by default.

If you do not want to start any process associated with oidctl, set this value to false.

id="instance"

Required: false
Default: 1
Valid values: The numerical value of the instance (>0 and <= 1000) to be started and stopped.
Path: ias-component/process-type/process-set/module-data/
category/data

The instance value is required for using oidctl. If this id is not configured, the default value is 1. You can overwrite this default option by specifying a value.

id="configset"

Required: false
Default: 0
Valid values: The numerical value of the configuration set (>=0 and <= 1000)
Path: ias-component/process-type/process-set/module-data/
category/data

The configset id is only needed to start oidldapd. If you want to start oidrepld or oidsrv, the assigned data is ignored. If configset is not configured, the default value is 0.

id="flags"

Required: false
Default: none
Path: ias-component/process-type/process-set/module-data/
category/data

If flags is configured, it will overwrite the settings in the configset at runtime.

id="startoidldapd"

Required: false
Default: true
Valid values: true or false
Path: ias-component/process-type/process-set/module-data/
category/data

If the id data is configured, the default start command for the server is:

prompt> $ORACLE_HOME/bin/oidctl connect=<connect_value> server=oidldapd instance=1
configset=0 start

id="startoidrepld"

Required: false
Default: false
Valid values: true or false
Path: ias-component/process-type/process-set/module-data/
category/data

If the id data is configured, the default start command for the server is:

prompt> $ORACLE_HOME/bin/oidctl connect=<connect_value> server=oidrepld instance=1
configset=0 start

Note:

This server must be configured before it can be brought up manually or by OPMN after installation.

id="startodisrv"

Required: false
Default: false
Valid values: true or false
Path: ias-component/process-type/process-set/module-data/
category/data

If the id data is configured, the default start command for the server is:

prompt> $ORACLE_HOME/bin/oidctl connect=<connect_value> server=odisrv instance=1
configset=0 start