Adding a local Community Server to Sametime Gateway

Connect a local Sametime® Community Server or Sametime community cluster to Sametime Gateway Server to enable Sametime users to have instant messaging with external users.

Before you begin

Before you can add a local Sametime server to Sametime Gateway Server, make sure you've completed the preceding steps:
  • Opened port 1516 on the internal firewall to the local Sametime community server. If the Sametime community is clustered, you opened port 1516 to each of the Sametime community servers, allowing both inbound and outbound traffic between Sametime Gateway Server and each community server.
  • Configured the Sametime server to trust the IP addresses of Sametime Gateway Server servers.
  • Disabled the legacy Sametime SIP Gateway on the Sametime community server.
  • Allowed local Sametime clients to add external users to Contact Lists.
Important: You can only connect one gateway to a community; otherwise the awareness and chat features may not work properly. Likewise, you can connect only one local Sametime community to Sametime Gateway Server. You must add the local community to Sametime Gateway Server before you add external communities.

About this task

Expected state:
  • Single server: the Sametime Gateway Server is started.
  • Cluster: the deployment manager is started, and the node agent and Sametime Gateway Servers are started on at least one node.

Procedure

  1. In the Integrated Solutions Console, click Sametime Gateway > Communities.
  2. In the table that lists communities, click New.
  3. In the Name field, type a logical name for the local community such as Sametime Users.
  4. In the Community Type field, select Local.
  5. In the Domains field, type the domain names in which users are found in the local community.

    Notes

    • You can use a wildcard character (*) in this field as a prefix, but it must always be followed by a period and at least two components of the fully qualified domain name. For example, a value of *.example.com includes example.com, us.example.com and test.prod2.example.com.

      In keeping with this example, you can use *.example.com and *.prod2.example.com, but you cannot use *example.com because the wildcard is not followed by a period; however example.com is already included in *.example.com.

    • Do not use wildcards in the domain name if you plan to connect to XMPP communities.
    • Each domain name must access the same user directory. For example: example.com, us.example.com, fr.example.com, and uk.example.com must all be linked by a common user directory to be in the community. Obtain this information from the system administrator of the local Sametime community.
  6. In the Translation Protocol field, select VP.
  7. Provide the Host name that Gateway connects to when it reads the overall configuration of the Community Servers. Depending on the size of your deployment, Sametime Gateway connects to either a single Sametime Community Server or a virtual IP address if you have one configured one for routing to multiple Community Servers.
    Type the appropriate host name.
    • One Sametime Community Server

      Enter the server's host name.

    • Multiple Community Servers (in a distributed or clustered environment)

      Enter the host name of a Virtual IP (VIP) configured to route to an available Community Server at all times. This is a bootstrapping phase, in which the Gateway connects to the Community Server the VIP is currently pointing to so it can read the cluster configuration information. This information contains the list of Community Server host names. The Gateway then closes the connection to the VIP and begins connecting to each of the Community Servers directly instead.

      Note: Use the VIP or fully qualified domain name of the load balancer fronting the Community Server that load balances port 1516, for server communications, and not the VIP or fully qualified domain name that load balances port 1533 for client connections. However, if the same VIP or fully qualified domain name balances both ports, you can use it.
      Note: Do not enter the host name of a MUX or IP sprayer that Sametime clients connect to.
  8. Set the Port to 1516. Select a transport protocol option.
    • TCP (Transmission Control Protocol)
    • TLS (Transport Layer Security)
    • Dynamic

      When you select the Dynamic option, Sametime Gateway first uses TCP, and will upgrade the connection to TLS automatically if possible.

  9. Click OK.
    Note: The local community cannot be renamed or deleted after it is created. You can make other changes to the local community after it is created and the new settings go into effect after you restart the Gateway server.
  10. Restart the Sametime Gateway Server server, or, if you have a cluster of Sametime Gateway Server servers, restart the cluster.