Oracle® Identity Management User Reference 10g (10.1.4.0.1) Part Number B15998-01 |
|
|
View PDF |
This chapter provides an overview of all of the command-line tools available for Oracle Identity Management. It contains the following topics:
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:
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
To run shell script tools on the Microsoft Windows operating system, you need one of the following UNIX emulation utilities:
Cygwin 1.3.2.2-1 or later. Visit: http://sources.redhat.com
MKS Toolkit 6.1. Visit: http://www.datafocus.com/
The Oracle Identity Management command-line tools are organized into the following categories:
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 |
---|---|---|
|
Bulk Deletion Tool |
Used to efficiently delete a subtree from a directory. |
|
Bulk Loading Tool |
Used to load a large number of entries into a directory server. |
|
Bulk Modification Tool |
Used to modify a large number of existing entries in an efficient way. |
|
Catalog Management Tool |
Used to update the indexed attributes for a directory. |
|
Directory Integration Platform Assistant |
Used to administer the Oracle Directory Integration Platform server |
|
Human Intervention Queue Purge Tool |
Used to move a replication change from the human intervention queue to the purge queue. |
|
Human Intervention Queue Retry Tool |
Used to move a replication change from the human intervention queue to the retry queue. |
|
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. |
|
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. |
|
Authentication Validation Tool |
Used to see whether you can authenticate a client to a server. This command is compliant with IETF standards. |
|
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. |
|
LDAP Data Deletion Tool |
Used to remove entries from the directory. This command is compliant with IETF standards. |
|
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. |
|
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. |
|
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. |
|
LDAP Search Tool |
Used to search for and retrieve specific entries in the directory. This command is compliant with IETF standards. |
|
Data Migration Tool |
Used to convert LDIF files output from other directories or application-specific repositories into a format recognized by Oracle Internet Directory. |
|
Data Export Tool |
Used to convert to LDIF all or part of the information residing in an Oracle Internet Directory. |
|
Oracle Directory Integration Server Control |
Used to start a standalone Oracle Directory Integration Platform server. |
|
Oracle Directory Integration Platform Server Registration |
Used to register an Oracle Directory Integration Platform server with Oracle Internet Directory. |
|
Oracle Internet Directory Configuration Assistant |
Used to create, upgrade, or delete an Oracle Context in Oracle Internet Directory or to configure the |
|
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). |
|
Oracle Internet Directory Server Diagnostic Tool |
Used to collect diagnostic information about Oracle Internet Directory and output it to a file. |
|
Oracle Internet Directory Monitor |
Used to initiate, monitor, and terminate Oracle Internet Directory server processes. |
|
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. |
|
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. |
|
Provisioning Subscription Tool |
Used to create and manage provisioning integration profiles for applications. |
|
Compare and Reconcile Tool |
Used to compare and reconcile one Oracle Internet Directory with another. |
|
Oracle Internet Directory Database Statistics Collection Tool |
Used to analyze the various Oracle Directory Server (ODS) database schema objects to estimate the statistics. |
|
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. |
|
Replication Environment Management Tool |
Used to set up and configure directory replication groups (DRG). |
|
Schema Synchronization Tool |
Used to synchronize the schema between Oracle Internet Directory and a third-party directory. |
|
Oracle Directory Integration Server Stop Command |
Used to stop a standalone Oracle Directory Integration Platform server. |
|
Certificate Upgrade Tool |
Used to update user certificates stored in the directory that were issued before Release 10.1.2. |
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