Installation and Upgrade Guides › Policy Server Installation Guide › Installing the Administrative UI › How to Configure Additional Policy Server Connections › Run the Registration Tool

Run the Registration Tool

You run the Administrative UI registration tool to create a client name and passphrase. A client name and passphrase pairing are values that the Policy Server uses to identify the Administrative UI you are registering. You submit the client and passphrase values from the Administrative UI to complete the registration process.

To run the registration tool

1. Open a command prompt from the Policy Server host system.
2. Run the following command:

   XPSRegClient client_name[:passphrase] -adminui -t timeout -r retries -c comment -cp -l log_path -e error_path
   -vT -vI -vW -vE -vF
   

   Note: Inserting a space between client_name and [:passphrase] results in an error.

   • client_name

     Identifies the Administrative UI being registered.

     Limit: This value must be unique. For example, if you have previously used smui1 to register an Administrative UI, enter smui2.

     Note: Record this value. This value is to complete the registration process from the Administrative UI.

   • passphrase

     Specifies the password required to complete the registration of the Administrative UI.

     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 are registering the Administrative UI as part of an upgrade, you can reuse a previous passphrase.

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

     Important! Record the passphrase, so that you can refer to it later.

   • -adminui

     Specifies that an Administrative UI is being registered.

   • -t timeout

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

     Unit of measurement: minutes

     Default: 240 (four 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 Administrative UI. A failed attempt can result from an incorrect client name or passphrase submitted to the Policy Server during the registration process.

     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 comments with quotes.

   • -l log_path

     (Optional) Specifies where to export the registration log file.

     Default: siteminder_home\log

     siteminder_home

     Specifies the Policy Server installation path.

   • -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 registration tool lists the name of the registration log file and prompts for a passphrase.

3. Press Enter.

   The registration tool creates the client name and passphrase pairing.

You can now register the Administrative UI with a Policy Server. You complete the registration process from the Administrative UI.