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. You can use this procedure to create a nonsecure or a secure environment.

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.
  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/Registrar. Use 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 for the Conference Manager by completing the following steps:
    1. Click New.
    2. Define the first routing rule for the Conference Manager with the following settings.
      Table 2. First Conference Manager routing rule. Use the descriptions in this table to determine the correct settings for the first Conference Manager routing rule.
      Field Description
      Method Select INVITE.
      Source Address Do not select this option
      Request-URI Do not select this option
      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:
        • Stand-alone server deployment
          The conference_manager_address is the value of the com.ibm.ws.sip.sent.by.host SIP Container custom property, which is set to the fully qualified domain name by default. To find the value:
          1. Log in to the WebSphere Application Server Integrated Solutions Console on the Conference Manager server as the WebSphere administrator.
          2. Click Servers > Server types > WebSphere application servers > Conference Manager server name > SIP container > Custom properties .
          3. Note the value of the com.ibm.ws.sip.sent.by.host SIP Container custom property.
        • 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
      • Name: Content-Length
      • Value: 0
    3. Select Using fields and define Destination settings using the following table.
      Table 3. Destination settings for the first Conference Manager routing rule. Use the descriptions in this table to determine the Destination settings for the first Conference Manager routing rule.
      Field Description
      Scheme Required. Use SIP for this setting. When configuring a secure environment, use SIP in this field with TLS as the setting in the Transport Protocol field.
      IP/FQDN Required. Type the IP address or the fully qualified host name of the Bandwidth Manager server.
      Port Required. Type the port number on the Bandwidth Manager server through which SIP requests are routed.
      Transport Protocol Specify the network transport mechanism to use for sending SIP messages, either TLS or TCP. If you are configuring a secure environment, this field is required and the setting must be TLS. If you do not provide a value, the server supplies a transport protocol. (UDP is not supported.)
    4. Click OK.
  6. Create the second routing rule for the Conference Manager by completing the following steps:
    1. Click New.
    2. Define the second routing rule for the Conference Manager with the following settings.
      Note: Only the value for User defined header is different from the first routing rule.
      Table 4. Second Conference Manager routing rule. Use the descriptions in this table to determine the correct settings for the second Conference Manager routing rule.
      Field Description
      Method Select INVITE.
      Source Address Do not select this option.
      Request-URI Do not select this option.
      Contact Header 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.
      • Name: Content-Type
      • Value: ^((?!text/xml).)*$
    3. Select Using fields and define the same Destination settings that you used for the first Conference Manager routing rule.
      Table 5. Destination settings for the second Conference Manager routing rule. The settings in this table are the same settings used in Table 3 for the first Conference Manager routing rule.
      Field Description
      Scheme Required. Use SIP for this setting. When configuring a secure environment, use SIP in this field with TLS as the setting in the Transport Protocol field.
      IP/FQDN Required. Type the IP address or the fully qualified host name of the Bandwidth Manager server.
      Port Required. Type the port number on the Bandwidth Manager server through which SIP requests are routed.
      Transport Protocol Specify the network transport mechanism to use for sending SIP messages, either TLS or TCP. If you are configuring a secure environment, this field is required and the setting must be TLS. If you do not provide a value, the server supplies a transport protocol. (UDP is not supported.)
    4. Click OK.
  7. Create the first routing rule for the Video Manager by completing the following steps:
    1. Click New.
    2. Define the first routing rule for the Video Manager with the following settings.
      Table 6. First Video Manager routing rule. Use the descriptions in this table to determine the correct settings for the first Video Manager routing rule.
      Field Description
      Method Select INVITE.
      Source Address Do not select this option
      Request-URI Do not select this option
      Contact Header Select this option, and then add a regular expression that represents the address of the Video Manager in the format:
      .*video_manager_IP_address:port_number.*
      where
      • video_manager_IP_address is the IP address of the Video Manager.

        This address must be an IP address. If you have clustered Video Managers, create the routing rule for each node with its own IP address.

      • port_number is the SIP port number of the Video Manager’s WebSphere Application Server. The default secured port is 5060; the default unsecured port is 5061.
      User defined header
      • Name: Content-Length
      • Value: 0
    3. Select Using fields and define Destination settings using the following table.
      Table 7. Destination settings for the first Video Manager routing rule. Use the descriptions in this table to determine the Destination settings for the first Video Manager routing rule.
      Field Description
      Scheme Required. Use SIP for this setting. When configuring a secure environment, use SIP in this field with TLS as the setting in the Transport Protocol field.
      IP/FQDN Required. Type the IP address or the fully qualified host name of the Bandwidth Manager server.
      Port Required. Type the port number on the Bandwidth Manager server through which SIP requests are routed.
      Transport Protocol Specify the network transport mechanism to use for sending SIP messages, either TLS or TCP. If you are configuring a secure environment, this field is required and the setting must be TLS. If you do not provide a value, the server supplies a transport protocol. (UDP is not supported.)
    4. Click OK.
  8. Create the second routing rule for the Video Manager by completing the following steps:
    1. Click New.
    2. Define the second routing rule for the Video Manager with the following settings.
      Note: Only the value for User defined header is different from the first routing rule for the Video Manager.
      Table 8. Second Video Manager routing rule. Use the descriptions in this table to determine the correct settings for the second Video Manager routing rule.
      Field Description
      Method Select INVITE.
      Source Address Do not select this option.
      Request-URI Do not select this option.
      Contact Header Select this option and add the same regular expression that represents the address of the Video Manager that you provided in the first routing rule for the Video Manager (see the Contact Header description in Table 6).
      User defined header
      Note: This value is different from the User defined header in the first Video Manager routing rule.
      • Name: Content-Type
      • Value: ^((?!text/xml).)*$
    3. Select Using fields and define the same Destination settings that you used for the first Video Manager routing rule.
      Table 9. Destination settings for the second Video Manager routing rule. The settings in this table are the same settings used in Table 7 for the first Video Manager routing rule.
      Field Description
      Scheme Required. Use SIP for this setting. When configuring a secure environment, use SIP in this field with TLS as the setting in the Transport Protocol field.
      IP/FQDN Required. Type the IP address or the fully qualified host name of the Bandwidth Manager server.
      Port Required. Type the port number on the Bandwidth Manager server through which SIP requests are routed.
      Transport Protocol Specify the network transport mechanism to use for sending SIP messages, either TLS or TCP. If you are configuring a secure environment, this field is required and the setting must be TLS. If you do not provide a value, the server supplies a transport protocol. (UDP is not supported.)
    4. Click OK.
  9. Restart the Sametime SIP Proxy/Registrar.