7 Administering Oracle Managed File Transfer Embedded Servers

Learn how to administer the FTP and sFTP (SSH-FTP) servers embedded by Oracle Managed File Transfer.

This chapter includes the following sections:

For information about administering the Oracle WebLogic Server managed server dedicated to Oracle Managed File Transfer, see Administering Oracle Managed File Transfer.

7.1 About Embedded FTP and sFTP Servers

Oracle Managed File Transfer includes built-in FTP and sFTP servers, which handle many of the types of file transfers performed. Uploading a file into one of the embedded server directories is necessary to transfer a file using one of the embedded servers.

These embedded servers have their own file system directories for sending and receiving files. The default root directory location for both the FTP and sFTP servers is WLS_Home/user_projects/domains/base_domain/mft/ftp_root. To change this location, see Other Embedded Server Settings.

The payloads directory under the root is for files accessed by external systems such as SOA.

The FTP embedded server is enabled by default, but its security features are disabled. The sFTP server is disabled by default.

Oracle Managed File Transfer supports the use of any compliant FTP or sFTP client.

Note:

Files present in an embedded FTP or sFTP source directory before the source is deployed or enabled are ignored. Only files uploaded to the directory after deployment or enabling are picked and transferred.

7.1.1 Security

Oracle Managed File Transfer embedded servers can restrict user access to the server file systems. For more information, see Embedded Server Security and Embedded Server User Access.

7.1.2 Archiving and Purging Transfers and Files

To clear space in the embedded server file systems, you can use WLST commands to archive and purge transfer instances and their associated files. For more information, see MFT Archive and Restore Commands and MFT Purge Commands in WLST Command Reference for SOA Suite.

Single Source Instance can be purged from the user interface using the Purge option in the Source Instance of the Monitoring page. For more information, see Interpreting Artifact Instance Messages.

Files uploaded to embedded server directories for which no sources are configured cannot be purged or archived. Only files associated with a transfer instance can be purged or archived.

7.2 Embedded Server Configuration

You can set the Embedded server configuration settings in the Embedded Servers, Embedded Server Ports, and Embedded Server User Access tabs from the Administration page.

For information about these settings, see the following sections:

7.2.1 Re-configuring the Port

You can reconfigure the ports of the Oracle Managed File Transfer embedded servers.

Embedded servers are not the same thing as Oracle WebLogic Server managed servers. The MFT embedded FTP and sFTP servers are services that run on the Oracle WebLogic Server managed server(s) dedicated to Oracle Managed File Transfer.

The steps for this process are:

  1. On the left pane of the Administration page, click the arrow to the left of Embedded Servers.

    The Ports and User Access items appear.

  2. Click Ports.

    The Embedded Server Ports tab opens.

  3. Change the Configured Port value for each Server Instance and Service (FTP or sFTP) combination you want to reconfigure.
  4. Click Save.
  5. Click Restart, Start, or Stop.
  6. Click the Refresh icon to update the table. Verify that the new Server Status for all servers is RUNNING and that the new Running Port values are the values you configured.

7.2.2 Path Separators for Remote FTP and sFTP Servers

If the path separator on a remote FTP server is not the conventional forward slash (/), you must specify the FTP Path Separator when you configure FTP Remote or sFTP Remote sources and targets.

For more information about other settings you can edit after you create an FTP Remote or sFTP Remote source or target, see the Oracle Fusion Middleware MFT Composer Help Online Help.

7.2.3 Other Embedded Server Settings

Table 7-1 lists the FTP embedded server settings not related to security. These settings are on the Administration page, Embedded Servers tab, and FTP subtab.

Table 7-1 FTP Embedded Server Settings

Setting Description

Root Directory

Specifies the root directory of the FTP server. The default is WLS_Home/user_projects/domains/base_domain/mft/ftp_root. You must set it to a shared location if multiple Oracle WebLogic Server instances run in a cluster.

To change the root directory:

  1. Stop the Oracle WebLogic Server managed server(s) dedicated to Oracle Managed File Transfer.

  2. Change the Root Directory setting.

  3. Move the directories and files under the root directory.

  4. Restart the managed server(s).

See Re-configuring the Port for how to stop and start the managed server(s).

Enabled

Enables the sFTP server if checked. The default is enabled (checked).

Maximum Logins

Specifies the maximum number of concurrent users. The default is 10.

Maximum Login Failures

Specifies the maximum number of login failures after which a connection is closed. The default is 3.

Maximum Concurrent Requests

Specifies the maximum number of concurrent requests the sFTP server can accept. The default is 10.

Idle Timeout

Specifies the time in seconds that the server can be idle before the connection ends and the user must log in again. The default is 600, equivalent to 10 minutes.

Active Connection: Port Range Start, Port Range End

In active mode, the client establishes the command channel. The server establishes the data channel between a server port in the range from Port Range Start to Port Range End and a client port that the client specifies using the PORT command.

Enable

Enables the FTP server if checked. The MFT server does not start a disabled FTP server during initialization. The default is disabled (unchecked).

IP Check

Finds out whether the IP address for the data connection is the same as for the control socket if checked. FTP uses two channels between client and server, which are separate TCP connections. The command channel is for commands and responses. The data channel is for transferring files. The default is disabled (unchecked).

Passive Connection: Port Range Start, Port Range End

In passive mode, the client establishes both the command and data channels. The server tells the client which port in the range from Port Range Start to Port Range End to use for the data channel.

Table 7-2 lists the sFTP embedded server settings not related to security. These settings are on the Administration page, Embedded Servers tab, and sFTP subtab.

Table 7-2 sFTP Embedded Server Settings

Setting Description

Root Directory

Specifies the root directory of the sFTP server. The default is WLS_Home/user_projects/domains/base_domain/mft/ftp_root. You must set it to a shared location if multiple Oracle WebLogic Server instances run in a cluster.

To change the root directory:

  1. Stop the Oracle WebLogic Server managed server(s) dedicated to Oracle Managed File Transfer.

  2. Change the Root Directory setting.

  3. Move the directories and files under the root directory.

  4. Restart the managed server(s).

See Re-configuring the Port for how to stop and start the managed server(s).

Enabled

Enables the sFTP server if checked. The default is enabled (checked).

Maximum Concurrent Requests

Specifies the maximum number of concurrent requests the sFTP server can accept. The default is 10.

Maximum Login Failures

Specifies the maximum number of login failures after which a connection is closed. The default is 3.

Idle Timeout

Specifies the time in seconds that the server can be idle before the connection ends and the user must log in again. The default is 600, equivalent to 10 minutes.

For information about the embedded server settings related to security, see Embedded Server Security.

7.3 Starting and Stopping Embedded Servers

You can start or stop the Oracle Managed File Transfer embedded servers from the Administration page.

The steps for this process are:

  1. Open the Embedded Servers tab on the Administration page.
  2. Select the FTP or sFTP subtab.
  3. Look at the Start and Stop buttons. If Start is grayed out, the server is running and you can Stop or Restart it. If Stop is grayed out, the server is not running and you can Start it.
  4. Click Start, Stop, or Restart.

To restart all embedded servers, click Restart All.

To start, restart, or stop the Oracle WebLogic Server managed server(s) dedicated to Oracle Managed File Transfer, see Oracle WebLogic Server Startup and Shutdown.

7.4 Managing Embedded Servers and High Availability

When you set up high availability for Oracle Managed File Transfer, the embedded servers participate in the load balancing, failover, and other features.

For more information, see Managing Multiple Weblogic Servers and High Availability.

7.5 Supported FTP and sFTP Commands

Oracle Managed File Transfer supports FTP and sFTP commands.

Supported FTP commands are:

  • APPE: Appends data to the end of a file on the remote host.

  • AUTH: Establishes SSL encrypted session. Only the SSL type is supported.

  • CDUP: Changes to the parent directory.

  • CWD: Changes the working directory. If the directory name is not specified, the root directory (/) is assumed.

  • LIST: Lists files. Must be preceded by a PORT or PASV command.

  • MKD: Creates a directory.

  • MLSD: Similar to LIST.

  • NOOP: No operation.

  • PASS: Specifies the password. Must be immediately preceded by USER.

  • PASV: Listens on a data port.

  • PORT: Specifies the data port.

  • PROT: Specifies the data channel protection level.

  • PWD: Returns the name of the current working directory.

  • REST: Specifies the marker position from which the file transfer is to be restarted.

  • RETR: Transfers a copy of the file specified as the argument.

  • SIZE: Returns the size of the file in bytes.

  • STOR: Accepts and stores the data received as a file.

  • TYPE: Specifies the file type, ascii (the default) or binary.

  • USER: Specifies the user name.

  • QUIT: Logs out.

  • DELE: Deletes the file specified by the provided path.

  • RMD: Removes a directory.

  • RNFR: Renames from the specified name.

  • RNTO: Renames to the specified name.

  • STOU: Stores a unique file to this directory.

Supported sFTP commands are:

  • cd: Changes the remote working directory.

  • get: Downloads a file from a remote directory to a local directory.

  • ls: Lists the contents of a remote directory.

  • mkdir: Creates a remote directory.

  • mv: Moves or renames a remote file.

  • put: Uploads a file from a local directory to a remote directory.

  • pwd: Prints a remote working directory.

  • rm: Removes a remote file.

  • rmdir: Removes a remote directory.

  • quit, bye: Ends and disconnects a client or user session.

Oracle Managed File Transfer does not support shell command execution.