Backing up a gateway configuration

 

Overview

The Back up options write out, to a single file, the deployment details for all the Web services and associated resources (channels, filters, UDDI references and so on) that are currently deployed to the gateway.

There are two situations in which you might want to back up a gateway configuration:

When you install a gateway upgrade, any previously configured gateway is replaced with an upgraded but empty gateway. Use the Save Gateway Configuration > Private option to preserve an existing gateway configuration before you complete the installation of an upgraded gateway. This saved configuration contains deployment details (for example URIs) that are specific to a given instance of the gateway, so only use it to save a configuration that you intend to re-apply to the same gateway instance.

When you want to scale the gateway, use the Save Gateway Configuration > Shared option to save a shareable version of your gateway configuration. This saved configuration does not include machine-specific values, and therefore can be shared by all the gateways in your scaled gateway deployment group.

To back up your gateway configuration, complete the following steps:

  1. Display the Web services gateway administrative user interface.

  2. (Optional)   If you are backing up to preserve your gateway configuration before you install a gateway upgrade, and any of your deployed Web services are also published by the gateway to UDDI registries, use the Listing and managing gateway-deployed Web services option to un-publish them from UDDI. Make a note of the UDDI deployment details so that you can re-publish them to UDDI after you restore the gateway configuration (the reasons why this manual step is necessary are explained in Backing up and restoring UDDI publication links).

  3. In the gateway administrative user interface navigation pane, click the following link:

    Gateway

    • Back Up

    The Save Gateway Configuration window opens.

  4. In the Location field, type the path to your configuration file.The path to your configuration file must point to a local drive on the machine on which the gateway is currently running. The file name for the configuration file can be any valid Java file name.

  5. If you are backing up to preserve the configuration of a gateway before you install a gateway upgrade, select Private. If you are backing up to create a scaled gateway deployment, select Shared.

  6. Click OK.

 

Results

Your gateway configuration is saved to the location specified.

 

What to do next

If you exported a gateway that is running on a version of IBM WebSphere Application Server that is earlier than V5.1.0.4., and the exported gateway includes JMS channels among its deployed resources, then you need to modify the exported configuration file before you can import the saved configuration into a later version of the gateway. For more information, see Troubleshooting the Web services gateway.


Related tasks
Backing up and restoring a gateway configuration