FTP Log On Action
<AMFTPLOGIN SERVER="text" USERNAME="text" PASSWORD="text" PORT="number" LOGFILE="text" PASSIVEMODE="yes/no" PROXYTYPE="text [options]" PROXYSERVER="text" PROXYPORT="text" PROXYUSERNAME="text" PROXYPASSWORD="text" SESSION="text">
Starts a transaction with a File Transfer Protocol (FTP) server and creates a session for the current connection. Other FTP related actions can follow this step. This action allows simultaneous FTP connections using the same username/password and
NOTE: Be sure to end FTP sessions with an "FTP Log Off" step.
Used to establish a connection with an FTP server. Other actions such as 'FTP Download' or 'FTP Upload' can then be used in subsequent steps.
Specifies the FTP server to connect to. This can be an IP address (e.g. xxx.xxx.xxx.xxx) or a server and domain name (e.g. server.domain.com).
Specifies the username that should be used when logging on to the FTP Server. The Username should be preconfigured at the server level.
Specifies the password that should be used when logging on to the FTP Server. The Username should be preconfigured at the server level. When the step is created using the Task Builder it is written to the task encrypted.
Specifies that the FTP server should be logged onto as an "Anonymous" user. The server must be configured to accept Anonymous connections. If set to YES, the User name/Password parameters are ignored.
Specifies the session name to identify this login request in subsequent FTP steps. This allows several connections to be active simultaneously.
If enabled, functionality reverts to AutoMate's legacy FTP engine (used in AutoMate 6 and older versions). This option is available mainly for AutoMate 6 or older users.
NOTE: Certificate stores are not available in compatibility mode.
Specifies the type of FTP connection that should be used. If unsure which connection to use, check with the administrator of the FTP Server.
The available options are:
FTP (Standard FTP): Connect using standard FTP .
FTP with SSL (Implicit): Connect using FTPS (also known as FTP Secure or FTP-SSL). This connection type adds support for the Secure Sockets Layer (SSL) and Transport Layer Security (TLS) cryptographic protocols. In Implicit mode, a client immediately sends the FTPS server a TLS/SSL "ClientHello" message. If such a message is not received by the FTPS server, the connection is dropped.
FTP with SSL (Explicit): Connect using FTPS (also known as FTP Secure or FTP-SSL). This connection type adds support for the Secure Sockets Layer (SSL) and Transport Layer Security (TLS) cryptographic protocols. In Explicit mode, a client must "explicitly request" security from a FTPS server and then use a mutually agreed encryption method.
SFTP (Password): Connect using SFTP (also known as Secure FTP). SFTP uses SSH (Secure Shell) protocol to transfer files. Unlike standard FTP, it encrypts both commands and data, preventing sensitive information from being transmitted in the clear over the network. In Password mode, a password is used to authenticate the SFTP connection.
SFTP (Public Key File): Connect using SFTP (also known as Secure FTP). SFTP uses SSH (Secure Shell) protocol to transfer files. Unlike standard FTP, it encrypts both commands and data, preventing sensitive information from being transmitted in the clear over the network. In Public Key File mode, connection is validated via a specified public key.
Specifies the port that should be used to connect to the FTP server. Most standard FTP servers operate on port 21 (the default port specified) however, this parameter can be customized in case the FTP server operates on other ports.
NOTE: Other default ports may be assigned depending on the server connection type selected.
Specifies the location of the detailed FTP log file. This log file contains the exact text of the FTP session which can be useful in diagnosing particular errors or elusive problems.
If enabled, specifies that the log file should be overwritten if the same file already exists.
Specifies a connection timeout to customize how long AutoMate will wait before aborting a connection attempt. If connection is not established within the timeout value specified, it is automatically aborted. (Default = 60 seconds).
Determines how an FTP data connection is made. If this option is enabled, AutoMate issues the PASV command and the server tells AutoMate where to establish the data connection. AutoMate initiates both connections to the server, solving the problem of firewalls filtering the incoming data port connection to the client from the server. If this option is disabled, the PORT method is used. AutoMate listens for a data connection which is established by the server and the PORT command tells the server where to connect to. AutoMate then connects to the server where the server indicated. This method is sometimes used with some proxy configurations. However, some proxy configurations require PORT transfers and some FTP servers do not support PASV transfers. The Passive Mode option is available only if the FTP (Standard FTP), FTP with SSL (Implicit) or FTP with SSL (Explicit) option is selected from the Server Connection Type parameter.
If enabled, specifies that all data channel communication between the FTPS client and server are to be encrypted. It may NOT be advantageous to use data channel encryption when performing transfers under the following scenarios:
Files being transferred are of a non-sensitive nature, making encryption unnecessary.
Files being transferred are already encrypted at the file level, making encryption redundant.
The Encrypt data channel option is available only if the FTP with SSL (Implicit) or FTP with SSL (Explicit) option is selected from the Server Connection Type parameter.
If enabled, specifies that this action will ignore invalid certificates when connecting to an FTP server using SSL. This option is available only if the FTP with SSL (Implicit) or FTP with SSL (Explicit) option is selected from the Server Connection Type parameter.
If enabled, allows compatibility with Tumbleweed Secure Content Delivery
FTP over SSL allows sessions to be encrypted between an FTP client and server. The Certificates tab is used to enter certificate information when an FTP over SSL connection is chosen. A certificate is a digitally-signed statement that binds the value of a public key to the identity of the person, device, or service that holds the corresponding private key. One of the main benefits of certificates is that hosts no longer have to maintain a set of passwords for individual subjects who need to be authenticated as a prerequisite to access. Instead, the host merely establishes trust in a certificate issuer.
When enabled, allows selection of a certificate using the Window's trusted certificate store for certificate approval. Clicking the Choose Certificate button opens the Windows Certificates snap-in, the primary tool for users and administrators to view and manage certificates for a user, computer, or service. The Certificates snap-in allows the user to request, renew, find, view, move, copy, and delete certificates.
NOTE: This option is available only if the FTP with SSL (Implicit) or FTP with SSL (Explicit) option is selected from the Server Connection Type parameter located in the Advanced tab.
Specifies information regarding the certification authority that issued the certificate (available only when From certificate store option is selected).
Specifies the unique serial number that the issuing certification authority assigns to the certificate. The serial number is unique for all certificates issued by a given certification authority (available only when From certificate store option is selected).
When enabled, allows selection of a certificate file.
Specifies the path and filename of the certificate file.
Specifies the path and filename of the Private key file. This option is available only when the SFTP (Public Key File) option is selected from the Server Connection Type parameter located in the Advanced tab.
In public/private key encryption, different keys are used to encrypt and decrypt information. The first key is a private key (a key that is known only to its owner), while the second key (called the public key) can be made known and available to other entities on the network.
The two keys are different but complementary in function. For example, a user’s public key can be published in a certificate in a directory so that it is accessible to other people in the organization. The sender of a message can retrieve the user’s certificate from Active Directory, obtain the public key from the certificate, and then encrypt the message by using the recipient's public key. Information that is encrypted with the public key can be decrypted only by using the corresponding private key of the set, which remains with its owner, the recipient of the message.
Specifies the passphrase used to authenticate connection. A passphrase is a password that comprises a whole phrase.
Specifies proxy protocol that should be used. If you are unsure of the value to use in this parameter, contact your network administrator.
The available options are:
System Default (default, recommended): The settings specified in the Task Administrator preferences are used.
None: Explicitly instructs the action not to use a proxy server regardless of the system default
Socks 4: Instructs the action to go through a Socks 4 compliant server
Socks 4a: Instructs the action to go through a Socks 4a compliant server
Socks 5: Instructs the action to go through a Socks 5 compliant server
Note: To create the most portable tasks it is best to specify "system default" and specify proxy settings in the Preferences of the Task Administrator (Proxy Tab). By proceeding this way, tasks created in one environment that may have a proxy server will be portable to others that do not - and vice-versa.
Specifies the port that should be used to connect to the proxy server. Most proxy servers operate on port 1028 (the default) however the proxy server can be customized to operate on other ports
Specifies the hostname (server.domain.com) or IP address (xxx.xxx.xxx.xxx) of the proxy server.
Specifies the username that should be used to authenticate when connecting through the proxy server. This option is only valid when Socks 5 is specified in the Proxy type as it is the only version that supports authentication.
Specifies the password that should be used to authenticate when connecting through the proxy server. When the step is created using the Task Builder it is written to the task encrypted. This option is only valid when Socks 5 is specified in the Proxy type as it is the only version that supports authentication.
This action includes the Description tab for entering a custom step description.
More on setting custom step description
This action also includes the standard Error Causes and On Error failure handling options/tabs.
More on Error Handling Options
All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.
More on variables
More on expressions
More on the expression builder
NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.
<AMFTPLOGIN SERVER="ftp.networkautomation.com" ANONYMOUSLOGIN="YES" LOGFILE="C:\errorlog.log" OVERWRITELOG="NO" />