Skip to main content

IP Filtering

IP Filtering controls which remote IP addresses can reach the USP Admin UI (Users) and USP Server Inbound Nodes (Accounts).

By using IP Filters, you can:

  • Restrict access to the USP Admin UI so that only trusted networks can connect.
  • Limit partner access per Inbound Node based on source IP address or network (CIDR range).
  • Define the default posture for unmatched connections (deny or allow).
  • Quickly block known-bad or temporary ranges.
  • Troubleshoot decisions with the built-in Test IP tool.

Before You Begin

Where IP Filters Are Applied

IP Filtering works by creating IP Filters and assigning them to specific configurations:

  • Inbound Nodes: to filter external client connections such as partner systems (Accounts).
  • The Security page: to filter access to the USP Admin UI by Users.

IP Rules

Each IP Filter can have zero, one, or more IP Rules, and each IP Rule specifies:

  • An IP address or canonical CIDR range (IPv4 or IPv6).
  • An action:
    • Allow: permits connections from the specified IPs/ranges.
    • Block: explicitly denies connections from the specified IPs/ranges.

Rule Evaluation and Default Action

IP Filtering evaluates each incoming connection against the rules defined in the assigned IP Filter.

Rules are processed in the following order:

  1. Block rules are evaluated first. If the source IP matches a Block rule, the connection is immediately rejected.
  2. If no Block rule applies, Allow rules are checked. If the source IP matches an Allow rule, the connection is permitted.
  3. If the source IP does not match any rule, the configured Default Action is applied:
    • Block: deny unmatched sources (recommended for security).
    • Allow: permit unmatched sources.

Because of this evaluation order, Block rules always override overlapping Allow rules.

USP High Availability Architecture Diagram

tip

Setting the Default Action to Allow means that any IP address not explicitly covered by a rule will be permitted. This effectively turns the filter into a blocklist, where only the sources in Block rules are denied.

Common Filter Configurations

Intended ResultConfiguration Approach
Allow all connections
  • Add an Allow rule that covers all IPs (0.0.0.0/0 for IPv4 or ::/0 for IPv6), or
  • Alternatively, leave the IP Filter empty (no IP Rules) and set its Default Action to Allow.
warning

Allowing all IPs effectively disables filtering. Use this only in test environments or when no IP restrictions are required.

Deny all connections
  • Add a block IP rule that covers all IPs (0.0.0.0/0 for IPv4 or ::/0 for IPv6).
  • Alternatively, you can leave the IP Filter empty (no IP Rules) and set its Default Action to Block.
info

Empty IP Filters can be assigned to the USP Admin UI under specific conditions:

  • If the Default Action is set to Allow.
  • If the Default Action is Block but the filter contains at least one Allow rule.

This check is enforced only when the filter is assigned. If the filter is edited later, it is still possible to misconfigure it and lock yourself out. See Lockout Recovery (CLI).

Deny a specific IP or range

Add a Block rule for the unwanted IP or range. To permit all other sources, either:

  • Add an Allow rule that covers all addresses (0.0.0.0/0 for IPv4 or ::/0 for IPv6), or
  • Set the Default Action to Allow.
Allow only a specific IP or rangeAdd an allow IP Rule for the desired IP or range, and set Default Action to Block.

IP Filter Administration via USP Admin UI

Adding an IP Filter

To add an IP Filter, follow these steps:

  1. From the Sidebar, click Authentication > IP Filtering.
  2. Click Add IP Filter.
  3. Enter the details for the new IP Filter, using the Field Descriptions table as a guide.
  4. Click Save.
info

When creating an IP Filter, only a name and a Default Action are required. You can refine its behavior later by adding IP Rules.

Field Descriptions

NameDescriptionSpecificationsRequired
NameThe name of the IP Filter.Must be unique.Yes
DescriptionThe description of the IP Filter.No
Default Action

Defines the action applied when a connection's source IP does not match any rule in the IP Filter, or when the filter contains no rules.

Options:

  • Block (recommended for security)
  • Allow
No

Editing an IP Filter

To edit an IP Filter, follow these steps:

  1. From the Sidebar, click Authentication > IP Filtering.
  2. Click the row of the IP Filter you want to edit.
  3. Click the Edit button above the IP Filter details.
  4. Edit the details of the IP Filter, using the Field Descriptions table as a guide.
  5. Click Save.
warning

If you modify an IP Filter 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.

IP Filter Metadata

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

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

Deleting an IP Filter

To delete an IP Filter, follow these steps:

  1. From the Sidebar, click Authentication > IP Filtering.
  2. Click the row of the IP Filter you want to delete.
  3. Click the Delete button above the IP Filter details.
  4. You will be asked to confirm the deletion. Click Delete.
warning

USP Manager prevents deletion of an IP Filter if it is currently referenced by another Configuration Item.

Additionally, if the IP Filter 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 an IP Filter

Besides testing, managing an IP Filter involves three main actions:

Testing an IP Filter

To test a specific IP address and see if it is allowed or blocked by an IP Filter, follow these steps:

  1. From the Sidebar, click Authentication > IP Filtering.
  2. Click the row of the IP Filter you want to test.
  3. Click the Test IP button above the IP Filter details.
  4. Complete the IP Address field with the IP you want to test.
  5. Click Continue.