Skip to main content

Routes

A Route groups one or more Inbound Nodes, which represent the entry points where external incoming connections initiate sessions, and one or more Outbound Nodes, which specify the possible internal destinations for forwarded traffic.

Each Route is governed by an associated Rule, which defines the authentication posture and credential handling applied to inbound and outbound connections.

info

Routes are a prerequisite for setting up Listeners, which bind the Route to a specific port on a USP Server instance and determine the Outbound Node used to forward traffic to the internal target.

Before You Begin​

Traffic Routing​

Traffic behavior within a Route is determined by the combined configuration of its Inbound Nodes, Outbound Nodes, and the Listener's default outbound node. The connection handling process follows this sequence:

  1. External incoming connections are evaluated against the Route's Inbound Nodes, using their Priority and Address Filter to determine the appropriate match.
  2. Once matched to an Inbound Node, the connection is forwarded to the Outbound Node defined as the Listener's Default Outbound Node.
info

For more information on how these Configuration Items relate to each other, refer to Configuration.

Route Administration via USP Admin UI​

Adding a Route​

To add a Route, follow these steps:

  1. From the Sidebar, click Configuration > Routes.
  2. Click Add Route.
  3. Enter the details for the new Route, using the Field Descriptions table as a guide.
  4. Click Save.
info

Adding a Route initially requires only a name. However, its functionality is defined in the subsequent steps, where Inbound Nodes, Outbound Nodes, and Listeners are added and configured.

Field Descriptions​

NameDescriptionSpecificationsRequired
NameThe name of the Route.Must be unique.Yes
DescriptionThe description of the Route.No

Editing a Route​

To edit a Route, follow these steps:

  1. From the Sidebar, click Configuration > Routes.
  2. Click the Name of the Route you want to edit.
  3. Click the Edit button above the Route details.
  4. Edit the details of the Route, using the Field Descriptions table as a guide.
  5. Click Save.
warning

If you modify a Route that is currently in use by a USP Server instance, the changes will not take effect until you manually apply the updated configuration by pushing it to the server. To apply the changes:

  1. Navigate to Monitoring > Status.
  2. Click the Name of the associated USP Server instance.
  3. Go to the Configuration tab.
  4. Review the pending changes in the Updated Configuration column.
  5. If the changes are correct, click Push Configuration.

Route details include all parameters given in the Field Descriptions table above, plus the following read-only metadata:

Route Metadata​

NameDescription
IDUniversally Unique Identifier of this Route.
Created AtDate and time this Route was created.
Updated AtDate and time this Route was last updated.

Deleting a Route​

To delete a Route, follow these steps:

  1. From the Sidebar, click Configuration > Routes.
  2. Click the Name of the Route you want to delete.
  3. Click the Delete button above the Route details.
  4. You will be asked to confirm the deletion. Click Delete.
warning

USP Manager prevents deletion of a Route if it is currently referenced by another Configuration Item.

Additionally, if the Route is used by a USP Server instance, the updated configuration must be manually applied. To apply the changes:

  1. Navigate to Monitoring > Status.
  2. Click the Name of the associated USP Server instance.
  3. Go to the Configuration tab.
  4. Review the pending changes in the Candidate Configuration - Preview section.
  5. If the changes are correct, click Push Configuration.

The changes do not take effect on the server until this step is completed.

Managing a Route​

Managing a Route involves three main actions: