Path Route Set Management

Learn to use path route sets to apply a set of path routes to a Load Balancer resource.

To apply path route rules to a listener, you first create a path route set that contains the rules. The path route set becomes a part of the load balancer's configuration. You then specify the path route set to use when you create or update a listener for the load balancer. To remove a path route set from a listener, edit the listener and choose None as the Path Route Set option.

Note

Path route rules will be retired on: Thursday, 24 March 2022. Instead, use routing policies. See Routing Policy Management for more information.

Creating Path Route Sets

Create a path route set for a Load Balancer resource.

Use one of the following methods to create a path route set for a selected load balancer.

To create a path route set using the Console

Use the OCI Console to create a path route set for a Load Balancer resource.

  1. Open the navigation menu, click Networking, and then click Load Balancers.

  2. Select the Compartment from the list.

    All load balancers and network load balancers in that compartment are listed in tabular form.

  3. (optional) Select a State from the list to limit the load balancers displayed to that state.

  4. (optional) Uncheck Load Balancer under Type to only display load balancers.

  5. Select the load balancer for which you want to create a path route set.

    The Load Balancer Details dialog box appears.

  6. Click Path Route Sets under Resources.

    The Path Route Sets list appears. All routing policies are listed in tabular form.

  7. Click Create Path Route Set.

    The Create Path Route Set dialog box appears.

  8. Enter the following:

    • Name: Required. Specify a friendly name for the path route set. The name must be unique, and cannot be changed.

      The path route set name cannot begin with a period and cannot contain the characters ;, ?, #, %, /, \, [, or ].

      Avoid entering confidential information.

    • Path Route Rules

      • Order: Optional. If you have multiple path route rules, you can click the up or down arrows to move the corresponding rule.

        Note

        The order of the rules within the path route set usually does not matter. However, if matching cascades down to prefix or suffix matching, the system chooses the first prefix or suffix rule that matches the incoming URI path.

      • Match Style: Required. The type of matching to apply to incoming URIs. See Request Routing Management for more information.

      • URL String: Required. The path string to match against the incoming URI path, for example /admin/.

      • Backend Set Name: Required. The name of the target backend set for requests where the incoming URI matches the specified path.

      • Click + Additional Rule to create another path route rule. You can have up to 20 path route rules in a set.

      • Click X to delete an existing rule.

  9. Click Create.

After you create a path route set, the set becomes available for use with the associated load balance. Create or update a listener to apply the path route set.

To create a path route set using the CLI

Use the command line interface (CLI) to create a path route set for a Load Balancer resource.

Enter the following command:

oci lb path-route-set create --name name --load-balancer-id load_balancer_id --path-routes path_routes [OPTIONS]

See the CLI online help for a list of options:

oci lb path-route-set create --help

See oci lb path-route-set create for a complete description of the command.

To create a path route set using the API

Use the API to create a path route set for a Load Balancer resource.

Run the CreatePathRouteSet method to create a path route set for a load balancer. See CreatePathRouteSet for a complete description.

Listing Path Route Sets

List the path route sets for a Load Balancer resource.

Use one of the following methods to display a list of path route sets for a selected load balancer.

To list the path route sets using the Console

Use the OCI Console to list the path route sets for a Load Balancer resource.

  1. Open the navigation menu, click Networking, and then click Load Balancers.

  2. Select the Compartment from the list.

    All load balancers and network load balancers in that compartment are listed in tabular form.

  3. (optional) Select a State from the list to limit the load balancers displayed to that state.

  4. (optional) Uncheck Load Balancer under Type to only display load balancers.

  5. Select the load balancer for which you want to create a path route set.

    The Load Balancer Details dialog box appears.

  6. Click Path Route Sets under Resources.

    The Path Route Sets list appears. All path route sets are listed in tabular form.

To list the path route sets using the CLI

Use the command line interface (CLI) to list the path route sets for a Load Balancer resource.

Enter the following command:

oci lb path-route-set list --load-balancer-id load_balancer_id [OPTIONS]

See the CLI online help for a list of options:

oci lb path-route-set list --help

See oci lb path-route-set list for a complete description of the command.

To list the path route sets using the API

Use the API to list the path route sets for a Load Balancer resource.

Run the ListPathRouteSets method to display a list of path route sets for a load balancer. See ListPathRouteSets for a complete description.

Getting Path Route Set Details

Get the details of a path route set for a Load Balancer resource.

Use one of the following methods to display the details of a path route set for a selected load balancer.

To get the details of a path route set using the Console

Use the OCI Console to get the details of a path route set for a Load Balancer resource.

  1. Open the navigation menu, click Networking, and then click Load Balancers.

  2. Select the Compartment from the list.

    All load balancers and network load balancers in that compartment are listed in tabular form.

  3. (optional) Select a State from the list to limit the load balancers displayed to that state.

  4. (optional) Uncheck Load Balancer under Type to only display load balancers.

  5. Select the load balancer whose path route set details you want to get.

    The Load Balancer Details dialog box appears.

  6. Click Path Route Sets under Resources.

    The Path Route Sets list appears. All path route sets are listed in tabular form.

  7. Click the path route set whose details you want to get.

    The Path Route Set Details page appears.

To get the details of a path route set using the CLI

Use the command line interface (CLI) to get the details of a path route set for a Load Balancer resource.

Enter the following command:

oci lb path-route-set get --path-route-set-name path_route_set_name --load-balancer-id load_balancer_id [OPTIONS]

See the CLI online help for a list of options:

oci lb path-route-set get --help

See oci lb path-route-set get for a complete description of the command.

To get the details of a path route set using the API

Use the API to get the details of a path route set for a Load Balancer resource.

Run the GetPathRouteSet method to display the details of a path route set for a load balancer. See GetPathRouteSet for a complete description.

Editing Path Route Sets

Update a path route set for a Load Balancer resource.

Use one of the following methods to edit and update a path route set for a selected load balancer.

To edit a path route rule using the Console

Use the OCI Console to update a path route set for a Load Balancer resource.

  1. Open the navigation menu, click Networking, and then click Load Balancers.

  2. Select the Compartment from the list.

    All load balancers and network load balancers in that compartment are listed in tabular form.

  3. (optional) Select a State from the list to limit the load balancers displayed to that state.

  4. (optional) Uncheck Load Balancer under Type to only display load balancers.

  5. Select the load balancer for whose path route set you want to update.

    The Load Balancer Details dialog box appears.

  6. Click Path Route Sets under Resources.

    The Path Route Sets list appears. All path route sets are listed in tabular form.

  7. Click the path route set whose settings you want to edit.

    The Path Route Set Details page appears.

  8. Click Edit.

    Alternatively, click the Actions icon (Actions icon) associated with the path route set you want to edit and click Edit.

    The Edit Path Route Set dialog box appears.

  9. Edit the following as needed for each rule you want to change:

    • Order: Optional. If you have multiple path route rules, you can click the up or down arrows to move the corresponding rule.

      Note

      The order of the rules within the path route set usually does not matter. However, if matching cascades down to prefix or suffix matching, the system chooses the first prefix or suffix rule that matches the incoming URI path.

    • Match Style: Required. The type of matching to apply to incoming URIs. See Request Routing Management for more information.

    • URL String: Required. The path string to match against the incoming URI path, for example /admin/.

    • Backend Set Name: Required. The name of the target backend set for requests where the incoming URI matches the specified path.

    • Click + Additional Rule to create another path route rule. You can have up to 20 path route rules in a set.

    • Click X to delete an existing rule.

  10. Click Save Changes.

To edit a path route set using the CLI

Use the command line interface (CLI) to update a path route set for a Load Balancer resource.

Enter the following command:

oci lb path-route-set update --path-route-set-name path_route_set_name --load-balancer-id load_balancer_id --path-routes path_routes [OPTIONS]

See the CLI online help for a list of options:

oci lb path-route-set update --help

See oci lb path-route-set update for a complete description of the command.

To edit a path route set using the API

Use the API to update a path route set for a Load Balancer resource.

Run the UpdatePathRouteSet method to edit a path route set for a load balancer. See UpdatePathRouteSet for a complete description.

Deleting Path Route Sets

Delete a path route set from a Load Balancer resource.

Use one of the following methods to delete a path route set from a selected load balancer.

To delete a path route set using the Console

Use the OCI Console to delete a path route set from a Load Balancer resource.

  1. Open the navigation menu, click Networking, and then click Load Balancers.

  2. Select the Compartment from the list.

    All load balancers and network load balancers in that compartment are listed in tabular form.

  3. (optional) Select a State from the list to limit the load balancers displayed to that state.

  4. (optional) Uncheck Load Balancer under Type to only display load balancers.

  5. Select the load balancer for whose path route set you want to update.

    The Load Balancer Details dialog box appears.

  6. Click Path Route Sets under Resources.

    The Path Route Sets list appears. All path route sets are listed in tabular form.

  7. Click the path route set whose settings you want to delete.

    The Path Route Set Details page appears.

  8. Click Delete.

    Alternatively, click the Actions icon (Actions icon) associated with the path route set you want to delete and click Delete.

  9. Confirm the deletion when prompted.

To delete a path route set using the CLI

Use the command line interface (CLI) to delete a path route set from a Load Balancer resource.

Enter the following command:

oci lb path-route-set delete --path-route-set-name path_route_set_name --load-balancer-id load_balancer_id --path-routes path_routes [OPTIONS]

See the CLI online help for a list of options:

oci lb path-route-set delete --help

See oci lb path-route-set delete for a complete description of the command.

To delete a path route set using the API

Use the API to delete a path route set from a Load Balancer resource.

Run the DeletePathRouteSet method to delete a path route set for a load balancer. See DeletePathRouteSet for a complete description.