lh Command Syntax

Use the following syntax to invoke the Identity Manager command-line interface and execute Identity Manager commands:

lh { $class | $command } [ $arg [$arg... ] ]

where:

• class must be a fully qualified class name, such as com.waveset.session.WavesetConsole.

• command must be one of the following commands:

  • assessment can be used during upgrades. Supports subcommands that report on all modified objects and report on all installed version of Identity Manager. See the Sun Identity Manager 8.1 Upgrade guide for details.

  • config starts the Business Process Editor.

  • console starts the Identity Manager console.

  • genReports generates a set of random data that can be used to demonstrate Identity Manager report functionality.

  • import imports an Identity Manager object. Specify the -s option for strict mode. When strict mode is enabled, reference checking during import is less forgiving.

  • js invokes a JavaScript program.

  • javascript also invokes a JavaScript program.

  • msgtool generates a custom message catalog based off of WPMessages.properties. This catalog can be manipulated to make custom changes to text or languages.

  • script executes JavaScript or BeanShell.

  • setRepo sets the Identity Manager index repository.

  • setup starts the Identity Manager setup process, which allows you to set the license key, define the Identity Manager index repository, and import configuration files.

  • spml launches the SPML browser.

  • syslog [options] extracts records from the system log. See syslog Command for details.

  • waveset an alias for the console command. See console, above.

  • xmlparse validates XML for Identity Manager objects.

  • xpress [options] Filename evaluates an expression. Valid option is -trace (enables trace output).

Usage Notes

When working with lh commands, you must be aware of the following notes:

• To view the command usage help, type lh without any arguments.

• When setting the path environment variables for the lh command,

  • Set JAVA_HOME location to the JRE directory that contains a bin directory with the Java executable. This location differs depending on your installation.

    If you have a standard JRE from Sun (without the JDK), a typical directory location is C:\Program Files\Java\jre1.5.0_14 (or similar). This directory contains the bin directory with the Java executable. In this case, set JAVA_HOME to C:\Program Files\Java\jre1.5.0_14.

    A full JDK installation has more than one Java executable. In this case, set JAVA_HOME to the embedded jre directory, which contains the correct bin/java.exe file. For a typical installation, set JAVA_HOME to C:\java\jdk1.5.0_14\jre.

  • Set the WSHOME variable to the Identity Manager installation directory, as follows:

    set WSHOME=<path_to_identity_manager_directory>

    For example, to set the variable to the default installation directory, type:

    set WSHOME=C:\Program Files\tomcat\webapps\idm

    ---

    Note –

    The WSHOME variable value must not contain the following characters:

    • Quotation marks (“ “)

      Do not use quotation marks, even if the path to the application deployment directory contains spaces.

    • A backslash at the end of the path (\)

    ---

    On UNIX systems, you must also export the path variables by typing:

    export WSHOME
    export JAVA_HOME

• To run the command in 64-bit mode, uncomment the FLAGS="$FLAGS -d64" line in the lh script.

• To start the Identity Manager command-line interface

  • On Windows, type the following at a command line:

    %WSHOME%\bin\lh

  • On UNIX, type the following at a command line:

    $WSHOME/bin/lh