Previous Topic: How to Register the Report Server

Next Topic: Gather Registration Information

Create a Client Name and Passphrase

You run the XPSRegClient utility to create a client name and passphrase. A client name and passphrase are:

To run the registration tool

  1. Open a command–line window from the Policy Server host system.
  2. Navigate to siteminder_home/bin.
    siteminder_home

    Specifies the Policy Server installation path.

  3. Run the following command:
    XPSRegClient client_name[:passphrase] -report -t timeout -r retries
    -c comment -cp -l log_path -e error_path -vT -vI -vW -vE -vF
    
    client_name

    Identifies the name of Report Server you are registering.

    Limit: The value must be unique. For example, if you have previously used reportserver1, enter reportserver2.

    Note: Record this value. This value is required to complete registration process from the Report Server host system.

    passphrase

    Specifies the password required to complete the Report Server registration.

    Limits: The passphrase

    • Must contain at least six (6) characters.
    • The passphrase cannot include an ampersand (&) or an asterisk (*).
    • If the passphrase contains a space, it must be enclosed in quotation marks.

    If you do not specify the passphrase in this step, XPSRegClient prompts you to enter and confirm it.

    Note: Record this value. This value is required to complete registration process from the Report Server host system.

    -report

    Specifies that a Report Server is being registered.

    -t timeout

    (Optional) Specifies how long you have to complete the registration process from the Report Server host system. The Policy Server denies the registration request when the timeout value is reached.

    Unit of measurement: minutes

    Default: 240 (4 hours)

    Minimum Limit: 1

    Maximum Limit: 1440 (one day)

    -r retries

    (Optional) Specifies how many failed attempts are allowed when you complete the registration process from the Report Server host system. A failed attempt can result from submitting an incorrect passphrase to the Policy Server during the registration.

    Default: 1

    Maximum Limit: 5

    -c comment

    (Optional) Inserts the specified comments into the registration log file for informational purposes.

    Note: Surround comments with quotes.

    -cp

    (Optional) Specifies that registration log file can contain multiple lines of comments. The registration tool prompts for multiple lines of comments and inserts the specified comments into the registration log file for informational purposes.

    Note: Surround comment with quotes.

    -l log path

    (Optional) Specifies where the registration log file must be exported.

    Default: siteminder_home\log, where siteminder_home is where the Policy Server is installed.

    -e error path

    (Optional) Sends exceptions to the specified path.

    Default: stderr

    -vT

    (Optional) Sets the verbosity level to TRACE.

    -vI

    (Optional) Sets the verbosity level to INFO.

    -vW

    (Optional) Sets the verbosity level to WARNING.

    -vE

    (Optional) Sets the verbosity level to ERROR.

    -vF

    (Optional) Sets the verbosity level to FATAL.

    The utility lists the name of the registration log file. If you did not provide a passphrase, the utility prompts for one.

  4. Press Enter.

    The registration tool creates the client name and passphrase.

You can now register the Report Server with the Policy Server. You complete the registration process from the Report Server host system.