Registering a new Gateway server on IBM i with the System Console

After installing an IBM® Sametime® Gateway server on IBM i, register it with the Sametime System Console, which allows you to manage all Sametime servers from a central location.

Before you begin

Before you register the server, verify that you have completed the following tasks:
  • The Sametime System Console must be started.
  • The LDAP server must be connected to the System Console and must be started.
  • The Gateway database must be connected to the System Console and must be started.
  • The Community Server that the Gateway server connects to must already be registered with the Console and must be started.

About this task

Working from the server that you want to connect with the console, follow these steps to update properties files and run the registration utility.

During this task you will edit the following files; click the topic titles to see details on each file. Use Ctrl+Click to open the topic in a new browser tab or window so you can keep it open for reference:

Procedure

  1. Working on the Sametime Gateway server, navigate to the /qibm/userdata/STGateway/ProfileName/console directory.

    The ProfileName is the one you specified when you installed the Gateway.

  2. Make backup copies (using different names) of the console.properties and productConfig.properties files.
  3. Update the console.properties file with the following values, and then save and close the file.
    Table 1. console.properties settings
    Property Value
    SSCHostName Provide the fully qualified host name of the Sametime System Console server.
    SSCHTTPPort Specify the HTTP port used for the Sametime System Console server if SSL is not enabled and the value for SSCSSLEnabled is "false."

    To determine the correct HTTP port, open the AboutThisProfile.txt file for the Sametime System Console Application Server Profile and use the setting specified for the "HTTP transport port." The default profile name is STSCAppProfile.

    On IBM i, look for the AboutThisProfile.txt file in the following location: /QIBM/UserData/Websphere/AppServer/version_number/SametimeWAS/profiles/STSCAppProfile/logs/AboutThisProfile.txt
    SSCUserName Enter the IBM WebSphere Application Server User ID that you created when you installed Sametime System Console. The default is wasadmin.
    SSCPassword Enter the WebSphere Application Server password associated with the SSCUserName.
    SSCSSLEnabled Change this value to "true" to connect to the Sametime System Console using a secure connection.
    Note: If the Sametime System Console was installed using a host name that is different from the system host name, make sure this value is set to "false." Otherwise the registration will fail.
    SSCHTTPSPort Specify the HTTPS port used by the Sametime System Console server if SSCSSLEnabled is set to "true."
  4. Update the productConfig.properties file with the following values, and then save and close the file.

    Only the required values in this file are listed here:

    Table 2. productConfig.properties settings
    Property Value
    InstallType Specify "Cell" as the installation type since this is a non-clustered server.
    DepName Provide a descriptive name for your deployment. It must be a unique deployment name on the Sametime System Console.
    NodeIP Specify the IP address of the server being registered.
    WASAdminPassword Specify the password associated with the WASUserID
    LDAPBindPassword Specify the password associated with the LDAPBindDN.
    DB2AdminPassword Specify the password associated with the database ID.
    CommunityServerHost Specify the fully qualified host name (not the IP address) of the Community Server registered with the Sametime System Console.
    CommunityServerPort Specify the port for the Community Server.
    LDAPHost Specify the fully qualified host name (not the IP address) of the LDAP server that was registered with the Sametime System Console.
    LDAPPort Specify the port of the LDAP server that was registered with the Sametime System Console.
    LDAPBindDN Specify the Bind Distinguished Name of the LDAP server that was registered with the Sametime System Console.
    LDAPBindPwd Specify the password associated with the LDAPBindDN value.
    LDAPBaseDN Specify the search base of the LDAP server that was registered with the Sametime System Console.
    isFederated Set the value to true for a primary or secondary node. The registration utility cannot run without this value.
  5. Run the registration utility:
    1. From an IBM i command line, run the following command to start the QShell Interpreter: QSH
    2. Run the cd shell command, specifying the fully qualified path to the console directory you used in Step 1.
    3. Run the shell script to register the server: registerProduct.sh
    4. When the registration script completes, press F3 to exit QSH.

      The utility registers the cluster, as well as each node, generating a log file called ConsoleUtility.log and storing it in the consoles/logs directory. If the registration is successful, a console.pid will also be generated.

  6. Start Sametime Gateway server, if it is not already running.