Configuring the RA FTP Agent

You can specify FTP proxy server settings and SOCKS proxy server settings for RA FTP Agent Connection objects. You can also enabling remote command executions for FTP Jobs.

FTP Proxy Server Settings

To use an FTP proxy server, fill in the following fields.

  • Type of FTP Proxy

    • The FTP proxy type. Options include:

    • None: No FTP proxy server settings are used.
    • USER@HOST: The FTP proxy server settings are used and the editable Commands for FTP Proxy field is pre-populated with the following.

      • USER __proxyUser__

      PASS __proxyPassword__

      USER __user__@__targetHost__

      PASS __password__

    • SITE: The FTP proxy server settings are used and the editable Commands for FTP Proxy field is pre-populated with the following.

      • USER __proxyUser__

      PASS __proxyPassword__

      SITE __targetHost__

      USER __user__

      PASS __password__

    • OPEN: The FTP proxy server settings are used and the editable Commands for FTP Proxy field is pre-populated with the following.

      • USER __proxyUser__

      PASS __proxyPassword__

      OPEN __targetHost__

      USER __user__

      PASS __password__

    • Custom: The FTP proxy server settings are used and the editable Commands for FTP Proxy field starts empty.

    If you select USER@HOST, SITE, or OPEN, you should not need to edit anything in the Commands for FTP Proxy field. However, if you need to, you can edit these commands and their values (where you can use hard-coded values instead of substitution variables).

  • IP Address

    • The FTP proxy IP address

  • Port

    • The FTP proxy port

    Commands for FTP Proxy

    The commands for the FTP proxy. The commands and values can be hard-coded or you can use the substitution variables shown below. Each substitution variable includes two underscores at the beginning and end of their name.

    If you select USER@HOST, SITE, or OPEN, you should not need to edit anything in the text box. However, if you need to, you can edit these commands and their values (where you can use hard-coded values instead of substitution variables) or you can start with nothing in the text box by selecting Custom.

    __user__

    Target host username

    __password__

    Target host password

    __targetHost__

    Target host name

    __proxyUser__

    Proxy username

    __proxyPassword__

    Proxy password

  • Username

    • The username (if required)

  • Password

    • The password (if required)

For each Connection object of protocol type FTP where you wish to use the settings in the Agent's FTP proxy server settings sub-tab, check the Creating RA FTP Agent Connection Objects for Each FTP Server box.

SOCKS Proxy Server Settings

To use a SOCKS proxy server, fill in the following fields.

  • Type of Socks Proxy

    • The SOCKS proxy type. Options include:

    • None: No FTP proxy server settings are used.
    • SOCKS4/SOCKS5: The SOCKS proxy server settings are used.
  • IP Address

    • The SOCKS proxy IP address

  • Port

    • The SOCKS proxy port

  • Username

    • The username (if required)

  • Password

    • The password (if required)

For each Connection object of protocol type FTP where you wish to use the settings in the Agent's FTP proxy server settings sub-tab, check the Socks proxy, use server settings box.

When using a SOCKS proxy server for FTP, FTPS and FTPES protocols, you should also check the Force active mode box in your Connection objects. If you use the default passive mode, the FTP Agent will not be able to connect to the FTP server causing your Jobs to fail.

The following documentation comes from Oracle and is included for reference. For updates or more information, see Oracle's web site/documentation.

SOCKS Protocol Support Settings

The SOCKS user name and password are acquired in the following way. First, if the application has registered a java.net.Authenticator default instance, then this will be queried with the protocol set to the string "SOCKS5", and the PromptSet to the string "SOCKS authentication". If the authenticator does not return a username/password or if no authenticator is registered then the system checks for the user preferences "java.net.socks.username" and "java.net.socks.password". If these preferences do not exist, then the system property "user.name" is checked for a username. In this case, no password is supplied.

socksProxyHost

socksProxyPort (default: 1080)

Indicates the name of the SOCKS proxy server and the port number that will be used by the SOCKS protocol layer. If socksProxyHost is specified then all TCP sockets will use the SOCKS proxy server to establish a connection or accept one. The SOCKS proxy server can either be a SOCKS v4 or v5 server and it has to allow for unauthenticated connections.

Enabling Remote Command Execution

Users with the necessary security credentials can enable Remote Command commands for FTP Jobs by checking the Enable remote execution box. When this box is checked, you can run commands on the remote system. This is only supported for SSH to UNIX systems with a Connection object with SFTP selected as the protocol. You cannot use this for Windows and Telnet.

For security reasons, the Enable remote execution box is unchecked by default. When the Enable remote execution box is unchecked, users can add Remote Command commands to FTP Jobs, but they will fail when the Job is executed. When the Enable remote execution box is checked, FTP Jobs with Remote Command will run normally. For more information on Remote Command commands, see topic Remote Command Settings.