How to configure BlackBerry Administration Service High Availability nodes to communicate via TCPPING instead of UDP in BlackBerry Enterprise Server 5.0

Article ID: KB19436

Type: Support Content

Last Modified: 08-15-2014

 

Product(s) Affected:

  • BlackBerry Enterprise Server for Microsoft Exchange
  • BlackBerry Enterprise Server for IBM Domino
CollapseEnvironment
  • BlackBerry Enterprise Server 5.0
  • DT 251193
  • DT 347538
  • DT 449254
CollapseOverview

In BlackBerry Enterprise Server 5.0, several components can be configured for high availability, including the BlackBerry Administration Service.

The BlackBerry Administration Service nodes in a high availability environment need to communicate their existence to each other, in order for the high availability BlackBerry Administration Service cluster to function correctly. BlackBerry Administration Service nodes use User Datagram Protocol (UDP) as the default communication protocol. However, in some situations, UDP traffic is blocked, which prevents the BlackBerry Administration Service nodes from communicating. The following are some examples of situations where the BlackBerry Administration Service nodes will not be able to communicate through UDP:

  • Any one BlackBerry Administration Service node is on a different subnet than the other BlackBerry Administration Service nodes. The remaining BlackBerry Administration Service nodes may not be able to communicate with each other or the singleton, because UDP is typically blocked between subnets.
  • All BlackBerry Administration Service nodes are in the same segment, but UDP multicast is explicitly blocked on that network segment. The BlackBerry Administration Service nodes are not able to communicate with each other.

If either of the situations above is present, log lines similar to these may be seen:

(04/27 09:12:11:630):{http-BAS01.DOMAIN.COM%2F10.0.0.1-443-1} [STDERR] [ERROR] org.apache.tapestry.StaleSessionException: login required but session not logged in, about to throw StaleSessionException context:/com/rim/bes/bas/web/adminconsole/pages/login/Home.page, line 25, column 79]

(04/27 09:12:11:630):{http-BAS01.DOMAIN.COM%2F10.0.0.1-443-1} [STDERR] [ERROR] at com.rim.bes.bas.web.common.BASBasePage.pageValidate(BASBasePage.java:1034)

(04/27 09:12:11:646):{http-BAS01.DOMAIN.COM%2F10.0.0.1-443-1} [com.rim.bes.bas.web.common.CommonExceptionPresenter] [WARN] [BBAS-2007] {unknown} Caught unknown exception


To change the method of communication between BlackBerry Administration Service nodes from UDP Multicast to Transmission Control Protocol (TCP) PING, complete the following tasks:

Task 1 - Backup existing configuration files to a different location

  1. Stop all BlackBerry Administration Service services on all BlackBerry Administration Service nodes in the cluster.
  2. Move the file bas-object-versioning-cache-service.xml from C:\Program Files\Research In Motion\BlackBerry Enterprise Server\BAS\server\default\deploy\ to a different directory (e.g. Desktop).
  3. Move the file cluster-service.xml from C:\Program Files\Research In Motion\BlackBerry Enterprise Server\BAS\jboss\ejb\server\default\deploy\ to a different directory (e.g., Desktop).

    Note: Please do not simply rename the files and leave in their original location. The modifications below will not work unless the files are moved to an outside folder (for example c:\BASFileBackups)

Task 2 - Edit the configuration files

  1. Modify both files (click here), so that the TCPPING initial_hosts match the environment:
    1. Replace BAShost2, BASHost3 etc. with the name of the other BlackBerry Administration Service nodes within the cluster.
    2. The node order must be the same on every BlackBerry Administration Service node in the cluster.

      Note: The simplest way to achieve this is to ensure after the BlackBerry Administration Service hostnames are customized, copy and replace the two customized xml files across all BlackBerry Administration Service nodes. This will ensure the order of the hosts is maintained.

  2. Place the modified bas-object-versioning-cache-service.xml file into the following location on all BlackBerry Administration Service nodes:

    C:\Program Files\Research In Motion\BlackBerry Enterprise Server\BAS\server\default\deploy\bas-object-versioning-cache-service.xml

  3. Place the modified cluster-service.xml file in the following location on all BlackBerry Administration Service nodes:

    C:\Program Files\Research In Motion\BlackBerry Enterprise Server\BAS\jboss\ejb\server\default\deploy\cluster-service.xml

Task 3 - Start all BlackBerry Administration Service nodes

  1. Start the BlackBerry Administration Service services on only one BlackBerry Administration Service node (the first BlackBerry Administration Service node to come online will be considered the singleton and responsible for IT policy reconciliation and other critical singleton specific tasks).
  2. Wait 7 to 10 minutes before starting the BlackBerry Administration Service services on the second BlackBerry Administration Service node.
  3. Continue waiting 7 to 10 minutes before starting each successive BlackBerry Administration Service node.

Task 4 - Verify BlackBerry Administration Service Node Functionality

  1. Attempt to login to each BlackBerry Administration Service node in the cluster using the hostname of the BlackBerry Administration Service node.
    1. Verify that the login page is displayed.
    2. Verify that the Microsoft Active Directory or BlackBerry Administration Service login completes successfully.
  2. Attempt to login to the BlackBerry Administration Service console by accessing the BlackBerry Administration Service pool name (if round robin Domain Name System (DNS) is set up).
    1. Verify that the login page is displayed.
    2. Verify that the Microsoft Active Directory or BlackBerry Administration Service login completes successfully.
CollapseAdditional Information

Trace UDP Multicast streams using Wireshark by the menu item Statistics > Multicast streams while reviewing the network capture from the BlackBerry Administration Service node which does not fully initialize. For more information, refer to http://wiki.wireshark.org/Multicast_streams.

Editing the files (click here) is the preferred process. However, if necessary, complete the following steps to update the bas-object-versioning-cache-service.xml and cluster-service.xml files manually:

  1. Add <!-- between the following lines:

    <!-- * UDP config stack * -->
    <Config>

  2. Add --> between the following lines:

    </Config>
    <!-- * TCP with MPING (multicast ping) config stack * -->

  3. Remove the <!-- * between the following lines:

    <!-- Also comment out the UDP config stack above -->
    <!-- *
    <Config>

  4. Remove * --> between the following lines:

    </Config>
    * -->
    </attribute>

  5. Ensure that the port range specified between start_port and end_port are open between the two BlackBerry Administration Service servers.
  6. Replace the hostx[17600] with the hostname(s) of the other BlackBerry Administration Service nodes.

    <TCPPING initial_hosts="host1[17600],host2[17600],host3[17600]" port_range="10"

    • In order to be sure TCPPING works fine, the initial_hosts parameter should list all the nodes in the cluster, and the two xml files on all BlackBerry Administration Service nodes in the location mentioned above have been replaced.
    • The port number specified for each listed node does not have to be changed.

Note: This article contains information previously documented in KB17902.

Note: This article refers specifically to BlackBerry Enterprise Server 5.0 base version with no service pack. For BlackBerry Enterprise Server 5.0 SP1, see KB19654.

Note: This article refers specifically to BlackBerry Enterprise Server 5.0 base version with no service pack. For BlackBerry Enterprise Server 5.0 SP2, see KB17089.

Disclaimer

By downloading, accessing or otherwise using the Knowledge Base documents you agree:

   (a) that the terms of use for the documents found at www.blackberry.com/legal/knowledgebase apply to your use or reference to these documents; and

   (b) not to copy, distribute, disclose or reproduce, in full or in part any of the documents without the express written consent of RIM.


Visit the BlackBerry Technical Solution Center at www.blackberry.com/btsc.