Skip Headers
Oracle® Identity Management User Reference
10g (10.1.4.0.1)

Part Number B15998-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

1 Command-Line Tools Overview

This chapter provides an overview of all of the command-line tools available for Oracle Identity Management. It contains the following topics:

1.1 Configuring Your Environment

Before you begin using the Oracle Identity Management command-line tools, you must configure your environment. This involves setting the appropriate environment variables. Also, if you will be running commands from a Microsoft Windows machine, you will need to install UNIX emulation software. See the following sections for more information:

1.1.1 Setting Environment Variables

The syntax and examples provided in this guide require that you have the following environment variables set:

  • ORACLE_HOME - The location of your Oracle Identity Management installation.

  • ORACLE_SID - The directory database connect string. If you already have a tnsnames.ora file configured, then this is the net service name specified in that file, which is located in $ORACLE_HOME/network/admin.

  • NLS_LANG (APPROPRIATE_LANGUAGE.AL32UTF8) - The default language set at installation is AMERICAN_AMERICA.

  • PATH - The following directory locations should be added to your PATH:

    $ORACLE_HOME/bin

    $ORACLE_HOME/ldap/bin

    $ORACLE_HOME/ldap/admin

    $ORACLE_HOME/opmn/bin

1.1.2 UNIX Emulation Utilities for Windows

To run shell script tools on the Microsoft Windows operating system, you need one of the following UNIX emulation utilities:

1.2 Oracle Identity Management Command-Line Tool Categories

The Oracle Identity Management command-line tools are organized into the following categories:

1.3 Oracle Identity Management Command-Line Tool List

The following table lists all of the Oracle Identity Management command-line tools in alphabetical order and gives a brief description of each tool.

Table 1-1 Oracle Identity Management Command-Line Tool List

Command Tool Name Description

bulkdelete


Bulk Deletion Tool

Used to efficiently delete a subtree from a directory.

bulkload


Bulk Loading Tool

Used to load a large number of entries into a directory server.

bulkmodify


Bulk Modification Tool

Used to modify a large number of existing entries in an efficient way.

catalog


Catalog Management Tool

Used to update the indexed attributes for a directory.

dipassistant


Directory Integration Platform Assistant


Used to administer the Oracle Directory Integration Platform server

hiqpurge.sh


Human Intervention Queue Purge Tool

Used to move a replication change from the human intervention queue to the purge queue.

hiqretry.sh


Human Intervention Queue Retry Tool

Used to move a replication change from the human intervention queue to the retry queue.

ldapadd


LDAP Data Add Tool

Used to add entries, their object classes, attributes, and values to the directory. This command is compliant with IETF (Internet Engineering Task Force) standards.

ldapaddmt


Multithreaded LDAP Data Add Tool

Used to add entries, their object classes, attributes, and values to the directory using multiple threads. This command is compliant with IETF standards.

ldapbind


Authentication Validation Tool

Used to see whether you can authenticate a client to a server. This command is compliant with IETF standards.

ldapcompare


Attribute Comparison Tool

Used to compare an attribute value that you specify on the command line to the attribute value in a directory entry. This command is compliant with IETF standards.

ldapdelete


LDAP Data Deletion Tool

Used to remove entries from the directory. This command is compliant with IETF standards.

ldapmoddn


LDAP DN/RDN Modification Tool

Used to change the RDN of an entry, or to move an entry to a new parent node in the directory tree. This command is compliant with IETF standards.

ldapmodify


LDAP Data Modification Tool

Used to add, delete, or replace attributes for entries by supplying an LDIF file as input. You can also delete or add entries. This command is compliant with IETF standards.

ldapmodifymt


Multithreaded LDAP Data Modification Tool

Used to add, delete, or replace attributes for entries in multi-threaded mode. This command is compliant with IETF standards.

ldapsearch


LDAP Search Tool

Used to search for and retrieve specific entries in the directory. This command is compliant with IETF standards.

ldifmigrator


Data Migration Tool

Used to convert LDIF files output from other directories or application-specific repositories into a format recognized by Oracle Internet Directory.

ldifwrite


Data Export Tool

Used to convert to LDIF all or part of the information residing in an Oracle Internet Directory.

odisrv


Oracle Directory Integration Server Control

Used to start a standalone Oracle Directory Integration Platform server.

odisrvreg


Oracle Directory Integration Platform Server Registration

Used to register an Oracle Directory Integration Platform server with Oracle Internet Directory.

oidca


Oracle Internet Directory Configuration Assistant


Used to create, upgrade, or delete an Oracle Context in Oracle Internet Directory or to configure the ldap.ora file.

oidctl


Oracle Internet Directory Control

Used to start, stop, or restart Oracle Identity Management server instances (Oracle Internet Directory, Oracle Directory Integration Platform, and Oracle Directory Replication).

oiddiag


Oracle Internet Directory Server Diagnostic Tool

Used to collect diagnostic information about Oracle Internet Directory and output it to a file.

oidmon


Oracle Internet Directory Monitor

Used to initiate, monitor, and terminate Oracle Internet Directory server processes.

oidpasswd


Oracle Internet Directory Database Password Utility

Used to change the password, create a wallet, or unlock the super user account for the Oracle Internet Directory database.

oidpasswd


Oracle Internet Directory Database Password Utility

Used to change the password for the Oracle Internet Directory database, or to create a wallet for the database password and replication server password.

oidprovtool


Provisioning Subscription Tool

Used to create and manage provisioning integration profiles for applications.

oidcmprec


Compare and Reconcile Tool

Used to compare and reconcile one Oracle Internet Directory with another.

oidstats.sql


Oracle Internet Directory Database Statistics Collection Tool

Used to analyze the various Oracle Directory Server (ODS) database schema objects to estimate the statistics.

opmnctl


Oracle Process Manager and Notification Server Control

Used to manage Oracle Application Server components in an integrated way. This tool can be used to start the Oracle Internet Directory server, Monitor process, and database.

remtool


Replication Environment Management Tool

Used to set up and configure directory replication groups (DRG).

schemasync


Schema Synchronization Tool

Used to synchronize the schema between Oracle Internet Directory and a third-party directory.

stopodiserver.sh


Oracle Directory Integration Server Stop Command

Used to stop a standalone Oracle Directory Integration Platform server.

upgradecert.pl


Certificate Upgrade Tool

Used to update user certificates stored in the directory that were issued before Release 10.1.2.


1.4 Oracle Identity Management Command-Line Tool Common Tasks

The following table lists the common tasks that you can perform with the Oracle Identity Management command-line tools and the associated tool name.

Table 1-2 Task List for Oracle Identity Management Command-Line Tools

Task Tool Name

Adding a New Node to an Oracle Database Advanced Replication-based DRG


remtool


Adding a Partial Replica to a DRG


remtool


Adding a Read-Only Replica to a DRG


remtool


Adding Concurrent Entries to the Directory Using an LDIF File


ldapaddmt


Adding Data to the Directory Using a DSML File


ldapadd


Adding Data to the Directory Using an LDIF File


ldapadd


Adding the Metadata of a Pilot Replica to a Master Replica


remtool


Backing Up the Metadata of a Pilot Replica to an LDIF File


remtool


Beginning Pilot Mode for a Replica


remtool


Bootstrapping a Directory Using a Configuration File


dipassistant


Bootstrapping a Directory Using a Synchronization Profile


dipassistant


Changing the Password for the Oracle Directory Integration Platform Administrator


dipassistant


Changing the Password to the Oracle Internet Directory Database


oidpasswd


Changing the Password to the Oracle Internet Directory Database


oidpasswd


Changing the RDN of an Entry


ldapmoddn


Changing the Replication Administrator Password for an Advanced Replication-based DRG


remtool


Changing the Replication DN Password in the Oracle Internet Directory Wallet


remtool


Changing the Replication DN Password Used for LDAP-Based Replication


remtool


Cleaning Up an Incomplete or Flawed LDAP-based DRG Setup


remtool


Cleaning Up an Oracle Database Advanced Replication-based DRG Setup


remtool


Collecting All Diagnostic Information


oiddiag


Collecting Selected Diagnostic Information


oiddiag


Comparing Attribute Values for an Entry


ldapcompare


Comparing and Reconciling Entire Directories


oidcmprec


Comparing and Reconciling Individual Entries in Two Directories


oidcmprec


Comparing and Reconciling Subtrees in Two Directories


oidcmprec


Configuring the ldap.ora File


oidca


Converting a Partial Naming Context to an LDIF File


ldifwrite


Converting All Entries under a Naming Context to an LDIF File


ldifwrite


Converting an Oracle Context to an Oracle Identity Management Realm


oidca


Creating a New Synchronization Profile


dipassistant


Creating a New Synchronization Profile Using an Existing Profile as a Template


dipassistant


Creating a Provisioning Profile


oidprovtool


Creating an Oracle Context


oidca


Creating an Oracle Database Advanced Replication-based DRG


remtool


Creating Wallets for Oracle Internet Directory Database and Oracle Directory Replication Server Passwords


oidpasswd


Creating Wallets for Oracle Internet Directory Database and Oracle Directory Replication Server Passwords


oidpasswd


Completely Deleting All Entries in a Naming Context


bulkdelete


Deleting a Provisioning Profile


oidprovtool


Deleting a Read-Only Replica from a DRG


remtool


Deleting a Single Entry


ldapdelete


Deleting a Synchronization Profile


dipassistant


Deleting an Oracle Context


oidca


Deleting Multiple Entries Using an LDIF File


ldapdelete


Detecting and Correcting Errors in an Oracle Database Advanced Replication DRG Setup


remtool


Detecting Errors in an Oracle Database Advanced Replication DRG Setup


remtool


Disabling a Provisioning Profile


oidprovtool


Discarding a Range of HIQ Change Logs


hiqpurge.sh


Discarding a HIQ Change Log


hiqpurge.sh


Discarding all HIQ Change Logs from a Supplier


hiqpurge.sh


Displaying Errors for an Advanced Replication-based DRG


remtool


Displaying Queue Statistics for an Advanced Replication-Based DRG


remtool


Ending Pilot Mode for a Replica


remtool


Generating Change Logs


oidcmprec


Including and Excluding Attributes


oidcmprec


Indexing a Single Attribute


catalog


Indexing Multiple Attributes


catalog


Loading and Reconciling Data Using the Data Migration Tool


ldifmigrator


Loading Data for Multiple Nodes in a Replicated Environment


bulkload


Loading Data in Bulk Mode


bulkload


Loading Data for Multiple Nodes in a Replicated Environment


bulkload


Loading Data in Incremental Mode


bulkload


Managing Super User Access Control Points


oidpasswd


Managing Super User Access Control Points


oidpasswd


Merging Two Directories


oidcmprec


Modifying a Provisioning Profile


oidprovtool


Modifying a Synchronization Profile


dipassistant


Modifying an Entry


ldapmodify


Modifying Multiple Entries Concurrently


ldapmodifymt


Modifying the Directory Schema


ldapmodify


Moving an Entry


ldapmoddn


Moving an Integration Profile to a Different Identity Management Node


dipassistant


Overriding Data Migration Values in Lookup Mode


ldifmigrator


Overriding Default Conflict Resolution Rules


oidcmprec


Performing a Base Object Search


ldapsearch


Performing a One-Level Search


ldapsearch


Performing a Subtree Search


ldapsearch


Performing an Express Configuration for Microsoft Active Directory


dipassistant


Performing Directory Schema Operations


oidcmprec


Performing User-Defined Compare and Reconcile Operations


oidcmprec


Previewing an Add Operation


ldapadd


Provisioning Users in Bulk


dipassistant


Recovering Data After a Load Error


bulkload


Recreating Indexes


bulkload


Registering the Oracle Directory Integration Platform Server With Oracle Internet Directory


odisrvreg


Removing a RMS Node from an Oracle Database Advanced Replication-based DRG


remtool


Removing an Attribute from the List of Indexed Attributes


catalog


Resetting the Replication DN Password for a Single Directory


remtool


Resetting the Super User Password


oidpasswd


Resetting the Super User Password


oidpasswd


Restarting an Oracle Internet Directory Server Instance


oidctl


Resuming Replication Activity for an Advanced Replication-based DRG


remtool


Retrying a Range of HIQ Change Logs


hiqretry.sh


Retrying a HIQ Change Log


hiqretry.sh


Retrying all HIQ Change Logs from a Supplier


hiqretry.sh


Running the Oracle Internet Directory Database Statistics Collection Tool


oidstats.sql


Running the Oracle Internet Directory Database Statistics Collection Tool


oidstats.sql


Searching for All User Attributes and Specified Operational Attributes


ldapsearch


Searching for Attribute Values of Entries


ldapsearch


Searching for Entries (More Examples)


ldapsearch


Searching for Entries with Attribute Options


ldapsearch


Setting the Wallet Password for the Oracle Directory Integration Platform Server


dipassistant


Showing a List of All Synchronization Profiles in Oracle Internet Directory


dipassistant


Starting a Directory Replication Server Instance


oidctl


Starting a Standalone Oracle Directory Integration Platform Server


odisrv


Starting All Oracle Internet Directory Server Instances Using opmnctl


opmnctl


Starting an Oracle Directory Integration Platform Server Instance


oidctl


Starting an Oracle Internet Directory Server Instance


oidctl


Starting and Stopping a Server Instance on a Virtual Host or Cluster Node


oidctl


Starting Oracle Internet Directory Monitor


oidmon


Starting Oracle Internet Directory Monitor on a Virtual Host or Cluster Node


oidmon


Stopping a Directory Replication Server Instance


oidctl


Stopping a Standalone Oracle Directory Integration Platform Server


stopodiserver.sh


Stopping All Oracle Internet Directory Server Instances Using opmnctl


opmnctl


Stopping an Oracle Directory Integration Platform Server Instance


oidctl


Stopping an Oracle Internet Directory Server Instance


oidctl


Stopping Oracle Internet Directory Monitor


oidmon


Suspending Replication Activity for an Advanced Replication-based DRG


remtool


Synchronizing the Schema between Oracle Internet Directory and a Third-Party Directory


schemasync


Unlocking the Super User Account


oidpasswd


Unlocking the Super User Account


oidpasswd


Updating an Attribute for Multiple Entries at Once


bulkmodify


Upgrading an Oracle Context


oidca


Upgrading User Certificates Stored in the Directory from Releases Prior to 10.1.2


upgradecert.pl


Using a Parameter File


oidcmprec


Using the Data Migration Tool by Supplying Your Own Values


ldifmigrator


Using the Data Migration Tool in Lookup Mode


ldifmigrator


Validating Authentication Credentials


ldapbind


Viewing the Details of a Specific Synchronization Profile


dipassistant