Skip to main content

Proxy Clients

A Proxy Client represents an instance of a USP Client that connects to a USP Server through a specific Tunnel. It defines the authentication parameters required for establishing a secure connection between the client and the server. For a Proxy Client to function correctly:

  • Its Name field must match the USP Client configuration file's name value.
  • Its Public Key must correspond to those configured on the USP Client.
info

Before adding a Proxy Client, you must first add the Public Key used for USP Client and Tunnel Authentication..

Before You Begin​

USP Client and Tunnel Authentication​

Connections between a USP Client and a USP Server’s Tunnel use SSH public key authentication, which requires two complete key pairs, one for each side of the connection:

  • A key pair for the USP Client
  • A key pair for the USP Server (set within its Tunnel)
ComponentPrivate KeyPublic Key
USP ClientReferenced in the USP Client’s .hcl config (key parameter).Uploaded in the USP Admin UI and USP REST API, and linked via the Proxy Client’s Public Key.
USP ServerUploaded in the USP Admin UI and USP REST API, and linked via the Tunnel’s Private Key.Referenced in the USP Client’s .hcl configuration file (tunnel.host_key parameter).
warning

Additionally, the Name field of the Proxy Client must match the USP Client’s name value (in its .hcl configuration file).

info

For more information on authentication between USP Clients and Tunnels, refer to Authentication Between USP Clients and Tunnels.

Adding a Proxy Client​

To add a Proxy Client, follow these steps:

  1. From the Sidebar, click Configuration > Proxy Servers.
  2. Click the Name of the Proxy Server associated with the Proxy Client.
  3. Go to the Tunnels tab.
  4. Click the Name of the Tunnel where the Proxy Client is to be added.
  5. Go to the Proxy Clients tab.
  6. Click the Add Proxy Client button.
  7. Complete the details for the new Proxy Client using the Field Descriptions table as a guide.
  8. Click Save.

Field Descriptions​

NameDescriptionSpecificationsRequired
NameThe name of the Proxy Client.

Must match exactly the name value argument in the USP Client configuration file.

Yes
DescriptionThe description of the Proxy Client.No
Public KeyThe Public key that is used to authenticate the Proxy Client to the USP Server's tunnel.Must reference an already-created Public Key.Yes

Editing a Proxy Client​

To edit a Proxy Client, follow these steps:

  1. From the Sidebar, click Configuration > Proxy Servers.
  2. Click the Name of the Proxy Server associated with the Proxy Client.
  3. Go to the Tunnels tab.
  4. Click the Name of the Tunnel where the Proxy Client is.
  5. Go to the Proxy Clients tab.
  6. Click the Edit button.
  7. Complete the details for the Proxy Client using the Field Descriptions table as a guide.+Draft#Field-Descriptions) table as a guide.
  8. Click Save.
warning

If you modify a Proxy Client 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.

Proxy Client Metadata​

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

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

Deleting a Proxy Client​

To delete a Proxy Client, follow these steps:

  1. From the Sidebar, click Configuration > Proxy Servers.
  2. Click the Name of the Proxy Server associated with the Proxy Client.
  3. Go to the Tunnels tab.
  4. Click the Name of the Tunnel where the Proxy Client is.
  5. Go to the Proxy Clients tab.
  6. Click the Name of the Proxy Client you want to delete.
  7. Click the Delete button above the Proxy Client details.
  8. You will be asked to confirm the deletion. Click Delete.
warning

USP Manager prevents deletion of a Proxy Client if it is currently referenced by a Tunnel.

Additionally, if the Proxy Client 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.