Updating a Relay Server farm configuration

A Relay Server farm configuration is defined by the contents of the Relay Server configuration file. Each Relay Server in a Relay Server farm shares the same Relay Server configuration file, so when you update a Relay Server farm configuration you must update the Relay Server configuration file at each Relay Server in the farm. Updates include any of the following:

  • Adding a new Relay Server to the Relay Server farm.

  • Creating a new backend server farm and allowing it access to the Relay Server farm.

  • Adding a new backend server to an existing backend server farm.

  • Changing the properties of a Relay Server, backend server farm, or a backend server.

  • Changing options.

One way to update a Relay Server configuration is to shutdown all Relay Servers, replace the Relay Server configuration file with the updated version, and restart all the Relay Servers. However, shutting down and restarting the Relay Servers means that users of the Relay Server may incur a service interruption.

The preferred method of updating a Relay Server configuration is to use the Relay Server State Manager to update the configuration while a Relay Server farm is running without interrupting service.

Updating a Relay Server configuration is done by launching a new instance of the Relay Server State Manager using the following command line format:

rshost -u -f <filename>

The -u option instructs the Relay Server State Manager to perform an update operation. The -f option specifies the name of the configuration file containing the updated configuration. See Relay Server State Manager.

Below is an overview of the steps required to update a Relay Server farm configuration:

  1. Make your changes to the master copy of the Relay Server configuration file.

  2. On each computer running an instance of a Relay Server that belongs to the Relay Server farm being updated, do the following:

    1. Replace the old configuration file with the updated configuration file.

    2. Run the Relay Server State Manager with the updated configuration file.


Updating a Relay Server configuration for Microsoft IIS on Windows
Updating a Relay Server configuration for Apache on Linux