Setting up routing from the SIP Proxy/Registrar to the Bandwidth Manager

To ensure that the IBM® Sametime® SIP Proxy/Registrar correctly routes communications to the Sametime Bandwidth Manager, create routing rules.

About this task

Routing rules define how SIP messages are routed through the SIP Proxy/Registrar. The routing rules display in a table with the highest priority granted to the first rule in the table. You will create two routing rules for data coming from the Sametime Conference Manager, and two routing rules for data coming from the Sametime Video Manager. Add the new rules at the top of the table to ensure they receive the highest priority.

For details on best practices for deploying the Sametime Bandwidth Manager, see the following Community article in the Sametime wiki: Bandwidth Manager Deployment - Best Practices.

Procedure

  1. On the server hosting the Sametime SIP Proxy/Registrar, log in to the WebSphere® Integrated Solutions Console as the WebSphere administrator.
  2. Click Sametime System Console > Sametime Servers > SIP Proxies and Registrars.
  3. Click the Deployment Name of the SIP Proxy/Registrar cluster.
  4. In the SIP Proxy/Registrar configuration page, click Proxy Administration and use the following table to set basic routing properties.
    Table 1. Routing properties for the SIP Proxy/RegistrarUse the descriptions in this table to determine the correct settings for the routing properties.
    Field Description
    Record route mode Select this option. When this option is enabled, the optional Record-Route header is inserted by the server that wants to remain in the signalling path for the duration of the session.
    Parallel search mode Do not select this option.
    Add public IP to outgoing request Select this option. When this option is enabled, the server adds an IBM-Destination-Public-IP header field to outgoing initial requests. This header contains the public IP of the endpoint.
    Specify Handled Domains Do not change this setting; these are domains that are managed by the SIP Proxy/Registrar.
  5. Create the first routing rule by completing the following steps:
    1. Click New.
    2. Specify the settings in the table to define the first routing rule.
      Table 2. Settings for the first routing rule
      Field Description
      Name BWM initial request
      Method Select INVITE.
      Contact Header Select this option, and then add a regular expression that represents the address of the Sametime Conference Manager in the format: 
      .*conference_manager_address:port_number.*
      where
      • conference_manager_address is determined using one of the following methods:
        • Clustered deployment using a load balancer or IP sprayer:

          The conference_manager_address is the cluster address, which is either a virtual IP address or a fully qualified domain name for the cluster, depending on how the cluster is configured on the load balancer.

        • Clustered deployment fronted only by a WebSphere SIP proxy server:

          Extract the conference_manager_address from Workload Management.

      • port_number is the SIP port number of the Conference Manager's WebSphere Application Server. The default secured port is 5060; the default unsecured port is 5061.
      User defined header Select this option
      Header name Content-Length
      Header value 0
      Construct a SIP URI section: IP/FQDN Enter the IP address of the load balancer in front of the Bandwidth Manger cluster. For example, enter 10.10.10.1
      Port

      Use port 5060 for SIP, or port 5061 for secure SIP

      For example, enter 5060
      Transport

      Choose TCP for SIP or TLS for secure SIP

      For example, select TCP
    3. Click OK.
    4. Click New and then specify the settings in the table.
      Table 3. Settings for the second routing rule
      Field Description
      Name Enter a name that describes this rule. For example, BWM Second
      Method Select INVITE
      Contact Header Select this option. Enter the Conference Manager's host name. If a load balancer is in front of the Conference Manager cluster, enter the load balancer host name.
      Note: This value starts with a period (.).
      User defined header Select this option.
      Header name Enter Content-Type
      Header value Enter ^((?!text/xml).)*$
      Construct a SIP URI section: IP/FQDN Enter the IP address of the load balancer in front of the BWM cluster.
      Port

      Enter port 5060 for SIP or 5061 for secure SIP

      For example, enter port 5060
      Transport

      Choose TCP for SIP or TLS for secure SIP

      For example, select TCP
    5. Click OK.
  6. Create the routing rule for the first Video Manager by completing the following steps:
    1. Click New.
    2. Define the first Video Manager routing rule using the following settings.
      Note: Only the value for User defined header is different from the first routing rule.
      Table 4. Settings for the first Video Manager routing rule
      Field Description
      Name Specify a descriptive name for the rule. For example, enter VMGR1
      Method Select INVITE.
      Contact Header .*<host> *506. *

      Select this option and add the same regular expression that represents the address of the Conference Manager that you provided in the first routing rule for the Conference Manager (see the Contact Header description in Table 2).
      User defined header
      Note: This value is different from the User defined header in the first Conference Manager routing rule.
      Header Name Content-Type
      Header Value ^((?!text/xml).)*$
      Construct a SIP URI section: IP/FQDN Enter the IP address of the load balancer in front of the BWM cluster. For example, enter 10.10.10.1
      Port

      Enter port 5060 for SIP or 5061 for secure SIP.

      For example, enter port 5060
      Transport

      Choose TCP for SIP or TLS for secure SIP

      For example, select TCP
    3. Click OK.
    4. Click New and define the settings for the second Video Manger routing rule.
      Table 5. Settings for the second Video Manager routing rule
      Field Description
      Name Enter a unique value for the second video manager rule, for example, enter VMGR2
      Method Select INVITE.
      Contact Header Select this option.

      Use this format: .*<host> *506. *

      The host is the IP address of the load balancer in front of the Sametime Video Manager cluster.

      For example, enter .*10.10.10.1:506.*
      User defined header Select this option.
      Header name Enter Context-Type
      Header value Enter ^((?!text/xml).)*$
      Construct a SIP URI section: IP/FQDN Required. Type the IP address of the load balancer in front of the Bandwidth Manger cluster.
      Port

      Enter port 5060 or SIP or 5061 for secure SIP

      For example, enter 5060
      Transport Specify the network transport mechanism to use for sending SIP messages:

      Choose TCP for SIP or choose TSL for secure SIP. UDP is not supported.

      For example, select TCP
    5. Click OK.
  7. Repeat steps 6.a. through 6.c for any additional Video Manager instances.
  8. Review the rules and then click Apply and OK.
  9. Save the rules to the master configuration by clicking the Save link in the "Messages" box at the beginning of the page.