FTPLOGON        Logon an FTP site

Top  Previous  Next

Syntax:

FTPLOGON

[ site ] [ /options ]

Arguments:

[ site ]

Variable or string defining the site name, URL, or IP address (e.g., ftp.acme-widget.com  or 20.188.128.17) of an FTP site; if [ site ] is omitted, the default site name is used; site names are not case-sensitive.

Options:

/acct=xx

Define account to use when logging on to an FTP site.

 

/allowerrors

Allow for listing errors when logging into an FTP site.

 

/clientcert

Specify this option if you are connecting to an SSL server and you wish to provide a client certificate to the site used and this site wasn’t preconfigured to use client certificates. This is optional if the SSL server automatically requests that Robo-FTP send its certificate. If you know that a particular site requires a client certificate, it is a good idea to specify this option because it is possible that the server will not request the certificate which will result in the connection to fail.

 

/dynamicdirs

Specify this option when connecting an FTP site that presents different (dynamic) directory listings to a client depending on which directory is active. This option may always be present if you are in doubt - there may be a minor decrease in performance since Robo-FTP may request directory listings more often.

 

/ibm

Enable IBM Host Features mode.

 

/keyauth

Specify this option if you are connecting to an SSH server and you wish to enable key authentication. This is optional if the SSH server only requires password authentication. This option requires a private key to be previously defined using the Robo-FTP configurator.

 

/listtype=x

Specify this option to instruct Robo-FTP to issue alternate forms of the LIST command. See below.

 

/pasv

Use FTP passive mode for data transfers.

 

/pasvport=xx

Outgoing data connection port to use when connecting using passive mode.

 

/port=nn

FTP port to connect to.

 

/proxy=xx

Define the name or IP address of a proxy server (/gw= is also accepted).

 

/proxyport=nn

Proxy server port to connect to (/gwport= is also accepted).

 

/proxypw=xx

Define password to use when logging on to a proxy server (/gwpw= is also accepted).

 

/proxyuser=xx

Define user name to use when logging on to a proxy server (/gwuser= is also accepted).

 

/pw=xx

Define password to use when logging on to an FTP site.

 

/restrictipaddr

In AltFTP and SSL mode, specify this option to restrict the data onnection to the same IP address used for the control connection (as opposed to allowing a connection to whatever IP address is returned in reply to PASV command from the Server). This option only applies to passive mode data transfers.

 

/timeout=nn

Time-out in seconds to wait for logon to complete.

 

/trust=xx

Action to take when an untrusted certificate is received from an SSL secured server or when an unknown SSH server identifies itself during key authentication. The default action if this option is not specified is DENY.

 

/servertype=xx

Select the FTP site type (normal FTP or a supported secure protocol: FTPS or SFTP).

 

/user=xx

Define user name to use when logging on to an FTP site.

 

 

This script command logs on to an FTP site. Predefined sites are created using the Robo-FTP Configurator. Robo-FTP searches its internal predefine site list for a match of [ site ] and uses the user name, password, and other parameters found associated with that server. [ site ] names are not case-sensitve.

 

The /user, /pw, /port, and /acct options may be used to override the predefined user name and/or password associated with an existing site, or may be used with a site that has not been previously defined. Not all sites utilize the /acct option.

 

The /servertype option (/type also recognized for backward compatibility with pre-v2.0 versions) may be used to override the predefined site type, or may be used with a site that has not been previously defined. The possible choices are:

 

FTP

Normal FTP (the default)

SFTP

FTP + SSH

FTPS

FTP + SSL (control channel encrypted only)

FTPSDATA

FTP + SSL (control and data channels both encrypted)

FTPSCCC

FTP + SSL (data channel encrypted only)

FTPSIMP

FTP + SSL (implicit mode)

ALTFTP

An alternate normal FTP mode (use only under direction of Robo-FTP technical support)

HTTP

HTTP

HTTPS

HTTP + SSL

 

The /trust option may be used to control server-side certificates received when connecting to an SSL secured site or to control Robo-FTP’s action when an identified SSH server is detected during key authentication. The possible choices are:

 

DENY

The untrusted SSL certificate/unknown SSH server is denied. This is the default action.

ALLOW

The untrusted SSL certificate/unknown SSH server is allowed for this connection only.

ALL

The untrusted certificate/unknown SSH server is allowed for this connection and is added to the SSL trusted certificate/SSH known servers database to be automatically accepted on all future connections.

 

The /clientcert option may be used to force an SSL connection to send a client certificate when it may not have been preconfigured to do so. The /keyauth option may be used to enable SSH private key authentication when connecting to this site.

 

When access to an FTP site is controlled by a proxy server, the /proxy, /proxyuser, /proxyport, and /proxypw options may be used to define or override a predefined proxy (gateway) server name, user name, port, and/or password.

 

Some servers require an alternate form of the LIST command to return directory contents. The /listtype=1 option forces Robo-FTP to issue alternate “LIST .” (vs. simply “LIST”) when requesting directory listings from an FTP site. The /listtype=2 option forces Robo-FTP to issue alternate “NLST” (vs. simply “LIST”) when requesting directory listings from an FTP site. In this later case, the server does not return any information about its files (e.g., file size, date/time) so some features of Robo-FTP (such as requesting the most recent file on the server) are not supported when /listtype=2 is used.

 

Important

The /listtype option cannot be directly configured for the FTP client applet or preconfigured as a default option for a particular site. However, a manual setting value does exist for this option. Access the Robo-FTP online knowledge base at http://www.robo-ftp.com/ftp-knowledge-base.php and search on “listtype” for more information.)

 

The /ibm option enables IBM Host Features for the FTP session if the logon is successful. IBM Host Features mode permits EBCDIC transfer mode and JES queue options to be selected. Using this option overrides the settings for a given FTP site that may have been set when the FTP site was configured with the Robo-FTP Configurator.

 

The /pasv option enables passive mode operation for the FTP session if the logon is successful. Passive mode operation may be required to list directories, and send and receive files with certain FTP sites. Using this option overrides the settings for a given site that may have been set when it was configured with the Robo-FTP Configurator.

 

In AltFTP and SSL modes with passive mode operation, the /restrictipaddr option forces the data connection to be on the same IP address as the control connection. This option may be required to connect to some servers.

 

Any logon, either with this script command or with the Logon button within the Robo-FTP client applet, serves as a general logon for either or both script and applet operation within Robo-FTP.

 

Consider the following example where Robo-FTP attempts to connect with a predefined FTP site name. The user name and password are obtained from the internal site list.

 

FTPLOGON "The Robo-FTP Site"

 

The logon can also be by way of an URL or IP address depending on how the site was defined.

 

FTPLOGON "ftp.acme-widget.com"

-or-

FTPLOGON "20.178.128.17"

 

Consider the following example where Robo-FTP attempts to connect with an SSL server and accepts the FTP site’s possibly untrusted certificate.

 

FTPLOGON "ftp.secure.com" /servertype= FTPSDATA /trust=ALLOW

 

Consider the following example where Robo-FTP attempts to connect with a previously undefined FTP site.

 

FTPLOGON "ftp.new.com" /user=anonymous /pw=itchy

 

Finally, consider the following example where Robo-FTP attempts to connect with the default server and uses a different password than one saved when the FTP site was defined.

 

FTPLOGON /pw=adv50095

 

Related Commands: FTPLOGOFF

See also: Using Variables in Command Options, Using the Robo-FTP Client Applet