Remote FTP Server

A Remote FTP(S) Server is a type of Endpoint that represents your partner's FTP(S) Server (external).

This Endpoint type stores connection details such as hostname, port, and encryption mode, and is used to initiate outbound FTP(S) transfers.

Within a UDMG as Client Pipeline, a Remote FTP Endpoint can function as either a Source Endpoint (to pull files) or a Destination Endpoint (to push files), enabling secure and automated file exchanges with your partner's FTP(S) servers.

info

File transfers when UDMG is acting as the client are only initiated via the Transfer API (not via the UI).

A Pipeline with a Remote FTP Server Endpoint cannot be associated with an Account or Account Group. The Credentials needed to connect and authenticate with your partner's FTP(S) server are added on the Pipeline.

Before You Begin

IP Address and Port

The Host IP Address and Port define the connection to your partner's FTP(S) Server. Obtain these values directly from your partner.

After configuring the Endpoint, click Validate to confirm that UDMG can successfully connect to the partner's FTP(S) Server using the specified IP and port. For detailed steps, see Validating the Configuration.

Encryption Mode

The Encryption Mode specifies how the Remote FTP Server handles encryption. The available options are:

• None (FTP): Allows clients to connect insecurely (plain text FTP). This mode is not recommended.
• Explicit (FTPES): Allows clients to request the server to create a secured session using SSL/TLS.
• Implicit (FTPS): Allows clients to connect to an implicit port where SSL/TLS encryption is automatically enforced from the initial connection. UDMG does not support forced explicit as an Encryption Mode.

Adding an Endpoint

To add an Endpoint, follow these steps:

1. From the Sidebar, select Configuration > Endpoints.
2. Click the Add Endpoint button.
3. Select Remote FTP Server as the Endpoint Type.
4. Complete the Name and Description details for the new Endpoint.
5. Enter the Host IP Address and Port you obtained earlier.
6. Select the Encryption Mode, specifying how the Remote FTP Server will handle encryption.
7. Choose whether the Endpoint should be enabled effective immediately.
   • Note: The Endpoint must be added to a Pipeline for the Endpoint to be serviceable.
8. Click Add.
9. Validate the connection (connection only, no authentication). See Validating the Configuration.

Field Descriptions

The following table describes the fields that are configured for the Endpoint:

Name	Description	Specifications	Required
Endpoint Type	The type of Endpoint indicates the type of file transfer. Select: Remote FTP Server.	Cannot be modified after creation.	Yes
Name	The name of the Endpoint.	Must be unique. Must follow the Standard Naming Pattern.	Yes
Description	The description of the Endpoint.		No
Host IP Address	The IP Address of your partner's FTP(S) Server.	Must be in IPv4 format.	Yes
Port	The port number of your partner's FTP(S) Server.	Must be within 1 and 65535.	Yes
Encryption Mode	Select whether to connect using encrypted or plaintext FTP. Options: None (FTP) Implicit (FTPS) Explicit (FTPES)		Yes
Disable TLS 1.3	When enabled, TLS 1.3 is disabled. tip Disable TLS 1.3 only if required for compatibility with legacy FTP servers.	Default value: Disabled.	Yes
Verify Uploads	When enabled, extra verification steps are performed after the upload to confirm that the file exists and has the expected size and time. It can be disabled if the remote server is write-only and does not allow to read file information.	Default is Enabled.	Yes
Auto-Start Endpoint	Endpoint's auto-start status. See Auto-Starting Endpoints.	Default is Enabled.	Yes

Editing an Endpoint

Endpoint configuration changes are pushed to all Pipelines referencing the Endpoint with immediate effect.

To edit an Endpoint, follow these steps:

1. From the Sidebar, select Configuration > Endpoint. 2.Click the Name field of the Endpoint you want to edit.
2. Click the Edit button above the Endpoint details.
3. Edit details for the Endpoint, using the Field Descriptions table as a guide.
4. Click Update.

Managing an Endpoint

Viewing Endpoint Details

To view the details of an Endpoint, follow these steps:

1. From the Sidebar, click Configuration > Endpoints.
2. Click the Name of the Endpoint you want to view.
3. Additionally, click the Pipelines tab to see all the Pipelines the Endpoint is associated with.

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

Endpoint Metadata

Name	Description
UUID	Universally Unique Identifier of this Endpoint.
Version	Version number of the configuration. Every change increases the number.
Enabled	Endpoint's Enabled status. If enabled, field is set to True.
Created	Date and time this Endpoint was created.
Updated	Date and time this Endpoint was last updated.
Test Status	Status of the Validate Endpoint configuration test. Options: Test not executed Test passed Test error

Validating the Configuration

The Endpoint configuration can be validated to confirm if an unauthenticated connection with the external FTP(S) server can be made. After clicking the Validate button, one of the following messages appears:

• Error/Fail: 'Endpoint test has failed. The dial tcp 0.0.0.4:2235: i/o timeout.'
  • If validation fails, then the system was not able to make a successful connection with the external FTP(S) server. Check the Endpoint's configuration, network path, firewall rules, and try again.
• Pass: 'Endpoint has passed the test.'
  • If validation passes, then the system was able to make a successful connection with the external FTP(S) server.

Enabling and Disabling Endpoints

Remote FTP(S) Server Endpoints can be Enabled or Disabled to control their active status and ability to participate in file transfers.

• Enabled (default): The Endpoint is active and can participate in file transfers.
• Disabled: The Endpoint is inactive and cannot participate in file transfers.

The status is set during initial creation and changed following these steps:

1. From the Sidebar, select Configuration > Endpoints.
2. Click the Name of the Endpoint you want to enable or disable.
3. Click Edit.
4. Move the Enable Endpoint toggle.
5. Click Update.

info

Changes to the Endpoint's Enabled status are not active until the Account reconnects.

Deleting an Endpoint

To delete an Endpoint, follow these steps:

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

warning

UDMG prevents the deletion of a Configuration Item if it is currently referenced by another Configuration Item (i.e., Pipeline). The Configuration Item must be edited or the reference removed before you can delete the Endpoint. Deletion cannot be undone.