Installation Guides › Policy Server Installation Guide › Installing the Administrative UI › How to Register the Administrative UI › 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.
• (Optional) Create the initial Super User account.

To run the registration tool

1. Open a command prompt from the machine that is hosting the Policy Server.
2. Run the following command:

   XPSRegClient client_name[:passphrase] -adminui -su -t timeout -r retries
   

   -c comment -cp -l log_path -e error_path -vT -vI -vW -vE -vF
   

   • client_name

     Specifies the name that identifies the Administrative UI that is to be 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 is a required value 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 8 characters.
     • It must contain at least one uppercase and one lowercase character.
     • At least one character must be a digit.
     • If the passphrase contains a space, it must be enclosed in quotation marks.
     • If you are re-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 it.

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

• -adminui

  Specifies that an Administrative UI is being registered.

• -su

  Specifies that the user that logs into the Administrative UI to complete the registration process becomes the default Super User.

  Note: If the Administrative UI that you are registering uses an administrative user store that contains a Super User account established by a previous Administrative UI registration, you do not have to supply this flag. You can use the same Super User account credentials to log into the Administrative UI you are registering to complete the process.

• -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 (4 hours)

  Minimum Limit: 1

  Maximum Limit: 1440 (1 day)

• -r retries

  (Optional) Specifies how may failed attempts are allowed when you complete the registration process from the Administrative UI. A failed attempt is one where you submit an incorrect passphrase 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: Comments must be surrounded by quotes.

• -cp

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

  Note: Comments must be surrounded by quotes.

• -l log path

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

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

• -e error path

  (Optional) Outputs 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.

1. Press Enter.

   The registration tool creates the client name and passphrase pairing.

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