1. Installation and Configuration Guide
  2. rundssetup Reference

B rundssetup Reference

Before Configuring UCS Products , you must prepare your Directory Server host. This is done by running the directory server setup script (rundssetup) against the directory Server Instance.

This appendix provides information about the rundssetup script.

Convergence release 3.0.3.0.0 is certified using Oracle Unified Directory. DS Setup 6.4.0.30.0 is required for Oracle Unified Directory support.

DS Setup version 6.4.0.30.0 uses rundssetup script which is an enhanced version of comm_dssetup.pl script available in earlier versions of DS Setup. This appendix provides information on rundssetup script usage to prepare Oracle Unified Directory.

Downloading and Installing DS Setup

  1. Download the DS Setup from: https://support.oracle.com

    The rundssetup script is available in the same software package as the Convergence software.

  2. Copy the directory server setup ZIP file to a temporary directory on your directory server hosts and extract the files.

  3. Log on to the directory server host machine as the superuser (root).

  4. Change to the directory where you extracted the DS Setup.

  5. Install the DS Setup using:
    ./commpkg install

  6. Select Comms DSsetup from the list of applications to install and proceed with the installation.

    See "commpkg Reference" for more information about the commpkg command.

About the rundssetup Script

This section provides information you need to understand before running the rundssetup script.

The rundssetup script performs the following steps:

  1. Prompts you for your deployment's Directory Server and schema information.

    For a list of the specific information this step requests, see Information Needed to Run the rundssetup Script

  2. Generates a shell script and LDIF file from the information that you supply that is used to modify the Directory Server LDAP.

  3. Runs the generated shell script and modifies your Directory Server.

At the end of each step, the rundssetup script prompts you to continue. No changes are made to the Directory Server LDAP until the last step.

Executing rundssetup script

Prerequisite: before running DS Setup, make sure the following are installed:

  • Directory Server (Oracle Unified Directory)

  • Python 2.7 and above

To install Oracle Unified Directory, see Install the Oracle Unified Directory Software

For Setting up Directory Server, see Setting Up Oracle Unified Directory as a Directory Server

Make sure a Directory Server instance is already created and is started. rundssetup script can be executed in interactive mode or silent mode

To run the script for preparing OUD, run the command:
python rundssetup --dsType OUD

Answer the command-line prompts.

Note:

You can use either LDAP Schema 2 or Schema 1. Schema 2 is recommended.

To execute rundssetup script in silent mode, see "Running rundssetup in silent mode" below.

If the directory server is already installed at your site, users have already been provisioned. If you have just installed the directory server at your site, then you need to provision users. For information about provisioning users and schema, see Communications Suite Schema Reference.

Directory Server Considerations for the rundssetup Script

When running the rundssetup script, consider the following points.
  • rundssetup configures local Directory Server instances, and thus you must:

    • Install the rundssetup script on every host on which a Directory Server instance resides.

    • Run the rundssetup script on the same host as your Directory Server. The tool runs locally for a specific instance (specified by path of Directory Server or path of instance).

  • You can run the rundssetup script against any Directory Server instance on the local host. If you have multiple Directory Information Trees (DITs) on one host, you can maintain and update one installation of rundssetup, and apply it to every Directory Server instance on the host.

  • rundssetup must configure every Directory Server instance for the same DIT. This assumes that:

    • A Directory Server has already been installed, configured, and is running before you launch the rundssetup script.

    • When adding an additional Directory Server host (such as a replica), at a future date, you must run the rundssetup script against it, too.

  • If you have customized your Directory Server, the following considerations might apply:

    • If you have indexed some attributes, you might have to reindex those attributes after running the rundssetup script.

    • If you have added other LDIF files (schema definitions), they should not be affected, so no action should be necessary. However, back up your custom schema definition files before running the rundssetup script. The rundssetup script backs up old schema files to the /var/tmp/dssetup_timestamp/save directory.

    • For all Directory Server customizations, including the first two just listed, stop the rundssetup script after it generates the script and before it actually updates the LDAP directory. Then inspect the script to evaluate how its proposed actions affect your LDAP directory. Take whatever actions you think necessary to protect your customizations before running the script against your Directory Server.

Information Needed to Run the rundssetup Script

Table B-1 describes the information about your deployment that you need to gather before running the rundssetup script.

Table B-1 rundssetup Information

Information Item Needed Default Value

Directory Server's Instance Path

The instance of Directory Server to be used (if more than one).

(Absolute path of the Directory Server instance where it is running).

The script displays an example of instance path of Directory Server, depending on the Directory Server type selected. The rundssetup script does attempt to heuristically determine the default.

By default, the dstype is ODSEE.

Example for Directory Server instance path when dstype is OUD: /opt/oracle/Oracle/Middleware/asinst_1

User and group root suffix

The default depends on what is detected. The rundssetup script does attempt to heuristically determine the value.

For example, o=usergroup
Schema version? (pick one of the following):

  • 1 - Schema 1

  • 1.5 - Schema 2 Compatibility Mode

  • 2 - Schema 2 Native Mode

For more information on how to choose a schema, see "About the rundssetup Script Schema Choices".

For new deployments , Schema 2 is preferred.

2

Do you want to update the schema files

Yes

Do you want to configure new indexes

Yes

Do you want to Reindex the new indexes now

Yes

DC Tree base suffix

(This option is not prompted when schema type is chosen as 2).

If you choose Schema 1 or 1.5, you need a DC tree. If the DC tree does not yet exist, the rundssetup script creates only the root suffix node, its does not create the rest of the DC tree. You must create the rest of your DC tree yourself.

o=internet

However, if you run rundssetup again, it defaults to the value that you chose the previous time.

About the rundssetup Script Schema Choices

Attribute Indexes Created by the rundssetup Script

Attribute indexes improve the performance of search algorithms. The rundssetup script offers you the choice to index attributes.

Table B-2 lists all the attributes the rundssetup script indexes, grouped by suffix category. It also lists the type of indexes created for each attribute. For more information about Directory Server indexing, see the Directory Server documentation at: https://docs.oracle.com/cd/E52734_01/oud/OUDAG/indexing.htm#OUDAG00048

Attribute indexes improve the performance of search algorithms. The rundssetup script offers you the choice to index attributes.

Table B-2 Attributes Indexed by rundssetup

Suffix Attributes Indexed Types of Indexes Added

User/Group (schema 1 & 2)

mail

'presence','equality','approximate','substring'

N/A

mailAlternateAddress

'presence','equality','approximate','substring'

N/A

mailEquivalentAddress

'presence','equality','approximate','substring'

N/A

mailUserStatus

'presence','equality'

N/A

member

'equality'

N/A

ou

'presence'

N/A

groupid

'presence','equality','substring'

N/A

uniquemember

'equality'

N/A

memberOf

'substring','equality'

N/A

cn

'equality'

N/A

mgrpUniqueId

'equality'

N/A

deleted

'presence','equality'

N/A

davuniqueid

'presence','equality'

N/A

inetCos

'equality'

User/Group (schema 2)

inetDomainBaseDN

'presence','equality'

N/A

sunPreferredDomain

'presence','equality'

N/A

associatedDomain

'presence','equality'

N/A

o

'presence','equality'

N/A

mailDomainStatus

'presence','equality'

N/A

sunOrganizationAlias

'presence','equality'

DC Tree (Schema 1)

inetDomainBaseDN

'presence','equality'

(o=internet)

mailDomainStatus

'presence','equality'

N/A

inetCanonicalDomainName

'presence','equality'

New PAB (o=PiServerDb)

displayname

'presence','equality','substring'

N/A

memberOfPIBook

'equality'

N/A

memberOfPIGroup

'equality'

o=mlusers

mail

'equality'

N/A

mlsubListIdentifier

'equality'

N/A

mlsubMail

'equality'

DS Setup command line options

Table B-3 describles rundssetup command line options. All options are not mandatory. The options not specified are picked from default values. But if options are provided, they override the default ones.

Table B-3 DS Setup Command Line Options

Option and Argument Description

-h, --help

Shows the help message and exits

--version

Show program's version number and exit

--debug

Turns on debugging output

--verbose

Verbose output

-D BINDDN, --bindDN BINDDN

DS bind DN credential, e.g. "cn=Directory Manager"

-j PASSWDFILE, --bindPasswordFile PASSWDFILE

file containing DS bind DN password, e.g. "mypasswdfile"

-i {yes,no}, --addIndex {yes,no}

add new indexes yes/no, e.g. "yes"

-R {yes,no}, --reIndex {yes,no}

execute reindexing

-d INSTLOC, --instanceLocation INSTLOC

location of DS instance, e.g. "/oracle/Oracle/Middleware/asinst_1"

-r DCTREE, --dctree DCTREE

DC tree suffix, e.g. "o=internet"

-u UGSUFFIX, --ugtree UGSUFFIX

User/Group tree suffix, e.g. "o=usergroup"

-s {yes,no}, --updateSchema {yes,no}

whether to update schema (yes/no), e.g. "yes"

-t {1,1.5,2}, --schemaType {1,1.5,2}

the schema type (1, 1.5, or 2), e.g. "2"

-m {yes,no}, --modifyDS {yes,no}

whether to modify the Directory Server (yes/no), e.g."yes"

-f {yes,no}, --force {yes,no}

force the application of this version of dssetup, even if the same version or later has been applied before

--silent SILENTFILE

run silently, taking the input from SILENTFILE and the command line. Command line arguments override entries in SILENTFILE. Specify NONE for the SILENTFILE if you want silent mode but with no silent file

--dsType {OUD,DSEE}

The Directory Server type, e.g. "OUD"

--createSuffixes {yes,no}

Power User switch - whether to create suffixes (yes/no), e.g. "yes", default is yes

--createSuffixDN {yes,no}

Power user switch (OUD only) - whether to create the DN associated with the suffix (yes/no). If --createSuffixes is no, then this switch is ignored (i.e. will be "no"), e.g. "yes", default is yes

--createMLusersSuffix {yes,no}

Power user switch - whether to create the o=mlusers suffix (yes/no), e.g. "yes", default is yes

--createPiServerDbSuffix {yes,no}

Power user switch - whether to create the o=mlusers suffix (yes/no), e.g. "yes", default is yes

Running the rundssetup Script in Silent Mode

To run the rundssetup script in silent mode:

  1. On the host where Directory Server is installed, log in as or become the superuser(root).

  2. Start Directory Server, if necessary.

  3. Change to the directory where you installed or copied the Directory Server Setup rundssetup script.

  4. Run the script followed by the silent mode options.

    For more information, see "Silent Mode Options".

    rundssetup [-h] [--version] [--debug] [--verbose] [-D BINDDN]

[-j PASSWDFILE] [-i {yes,no}] [-R {yes,no}] [-d INSTLOC]

[-r DCTREE] [-u UGSUFFIX] [-s {yes,no}] [-t {1,1.5,2}]

[-m {yes,no}] [-f {yes,no}] [--silent SILENTFILE]

[--dsType {OUD,DSEE}] [--createSuffixes {yes,no}]

[--createSuffixDN {yes,no}] [--createMLusersSuffix {yes,no}]

[--createPiServerDbSuffix {yes,no}]
    The script creates the following LDIF file and shell script to update the LDAPindexes and schema:

    • /var/tmp/dssetup_timestamp/dssetup.ldif

    • /var/tmp/dssetup_timestamp/dssetup.sh

  5. If you answered no to the -R and -m options, you need to manually run the dssetup.sh script that was created. If you answered yes to the -R and -m options, the dssetup.sh script is runautomatically.

    For example:

    schema 2:
    rundssetup -D "cn=Directory Manager" -j /tmp/ds_pass -i yes -R yes -d /oracle/Oracle/Middleware/asinst_1 -u o=usergroup -s yes -t 2 -m yes -f yes --silent=NONE --dsType=OUD --createSuffixes yes --createSuffixDN no --createMLusersSuffix yes --createPiServerDbSuffix yes
    schema 1:
    rundssetup -D "cn=Directory Manager" -j /tmp/ds_pass -i yes -R yes -d /oracle/Oracle/Middleware/asinst_1 -r "o=internet" -u "o=usergroup" -s yes -t 1 -m yes -f yes --silent=NONE --dsType=OUD --createSuffixes yes --createSuffixDN no --createMLusersSuffix yes --createPiServerDbSuffix yes

Silent Mode Options

Following are the options supported for running in silent mode:
rundssetup [-h] [--version] [--debug] [--verbose] [-D BINDDN]

[-j PASSWDFILE] [-i {yes,no}] [-R {yes,no}] [-d INSTLOC]

[-r DCTREE] [-u UGSUFFIX] [-s {yes,no}] [-t {1,1.5,2}]

[-m {yes,no}] [-f {yes,no}] [--silent SILENTFILE]

[--dsType {OUD,DSEE}] [--createSuffixes {yes,no}]

[--createSuffixDN {yes,no}] [--createMLusersSuffix {yes,no}]

[--createPiServerDbSuffix {yes,no}]
Explanation of the above options can be seen by running:
./rundssetup --help