Sun Identity Manager 8.1 System Administrator's Guide

From the Command Line

Enabling trace from the command line is useful if you want a wider range of options.

ProcedureTo Enable Tracing:

  1. Open a command window.

  2. Start the Gateway, specifying the necessary trace command arguments.

    The following table describes the Gateway tracing command line arguments.

    Argument 

    Description 

    -f 

    Specify the path to the trace file 

    -l 

    Specify the level of tracing: 

    • Level 0. Disables tracing. (Default)

    • Level 1. Traces the flow of control between components and generally defines a low-detail trace point that includes entry and exit from high-level functional methods.

    • Level 2. Generally defines a medium-detail trace point that includes entry and exit from every method, and information and data trace points for high-level functional methods. Level 2 adds the flow of control within each component, major decision points, and items of information.

    • Level 3. Generally defines a high-detail trace point that includes entry and exit from every method, information and data trace points for high-level functional methods, and significant subroutines. Level 3 adds lower-level decision points and items of information.

    • Level 4. Generally defines a hyper-detail trace point that includes everything traced in the other trace levels. Level 4 traces at a very low level and provides a level of detail that is seldom needed but might be useful in characterizing complex behaviors of some components. NOTE: Not all components support level 4.

      Trivial methods, such as getters and setters, generally do not have entry or exit trace points because they add overhead.

    -m 

    Specify the maximum trace file size in kilobytes 

    When the trace file reaches -m Kbytes, Identity Manager closes the current trace file, deletes any existing back-up files, renames the current trace file to the name specified by the -f argument with .bk appended, and opens a new trace file with the -f argument name.

    For example, if you specified -f beeble.trc on the command line, the following two files result after -m Kbytes are recorded:

    beeble.trc.bk

    beeble.trc

    Where beeble.trc contains the most recent traces.

    Usage: gateway -f name -l -m

    For example:


    cd %WSHOME%\bin\winnt
    gateway -d -p 11319 -f %CD%\gateway.trc -l 2 -m 500

    The preceding invocation starts the Gateway with the following characteristics:

    • -d – Use regular application (not a service)

    • -p 11319 – Use port 11319

      You must configure this port for Gateway resources from the Identity Manager resource configuration. For example, for an Active Directory resource

    • -f %CD%\gateway.trc – Directory to which the trace output is written. Identity Manager writes the trace output to a text file in this directory.

    • -l 2 – Output level 2 of Gateway tracing.

    • -m – Maximum size in Kilobytes of trace log file.


    Note –

    If specified, Identity Manager saves -f, -l, and -m values in the registry, so the next time you run Gateway from the command line or as a service, the same values are used.

    Identity Manager sends the Gateway trace output to the console and to a trace file.