background image

Chapter 3 - FTP Commands 

List of Commands 

F T P   A d a p t e r   R e f e r e n c e   G u i d e  

1 6  

Without a firewall the start of a file transfer begins with: 

 

Establish a Socket connection to the remote host. 

 

Issue the 

USER

 command over the connection. 

 

Issue the 

PASS

 command over the connection. 

When a firewall is present (used) more steps are performed in the beginning of 
the transfer of the files. 

These steps are dependent on the 

/method

 specified in the last part of the 

-FIREWALL

 command. 

OPEN 

 

Establish a Socket connection to the firewall host 

 

Issue the following command over the connection in this order: 

OPEN ftp_host 
USER ftp_user 
PASS ftp_pass 

SITE 

 

Establish a Socket connection to the firewall host 

 

Issue the following command over the connection in this order: 

USER fw_user 
PASS fw_pass 
SITE ftp_host 
USER ftp_user 
PASS ftp_pass 

TRANSPARENT 

 

Establish a Socket connection to the remote host 

 

Issue the following command over the connection in this order: 

USER fw_user 
PASS fw_pass 
USER ftp_user 
PASS ftp_pass  

USERFW 

 

Establish a Socket connection to the firewall host 

 

Issue the following command over the connection in this order: 

Summary of Contents for HP NonStop Data Transformation Engine FTP Adapter

Page 1: ... Abstract This manual provides information about using the HP NonStop Data Transformation Engine NonStop DTE FTP adapter on the NonStop server Product Version NonStop Data Transformation Engine 6 7 1 Version Updates RVUs N A Part Number Published 528264 001 June 2004 ...

Page 2: ...F T P A d a p t e r R e f e r e n c e G u i d e 2 Document History Part Number Product Version Published 528264 001 NonStop Data Transformation Engine 6 7 1 June 2004 ...

Page 3: ...Local CPL 13 Code Page Remote CPR 13 Firewall Connection Method URL FW or FIREWALL 14 Adapter Behavior when FIREWALL Command Present 16 URL Syntax 17 FTP URL URL 19 Ignore I or IGNORE 21 Keep Server KS 21 List Option LS 22 Make Directory MKD 23 Passive Mode PV or PASV 23 Port Mode PT or PORT 23 Private Key PKEY 24 Private Key Password KPASS 24 Quantity QTY 24 Site SITE 25 SSL Encryption Strength S...

Page 4: ...Contents F T P A d a p t e r R e f e r e n c e G u i d e 4 Chapter 5 Troubleshooting Adapter Audit Log 34 Adapter Trace File 35 Appendix A Return Codes and Error Messages Messages 37 Index ...

Page 5: ...ironment has used the Mercator Design Studio and understands words such as mapping type trees and other basic Mercator terminology Related References For more information about all products or about topics frequently discussed in this document refer to the Mercator Online Library or the SDK Online Library Related Reference Description Resource Adapters Reference Guide Using resource adapters as ma...

Page 6: ...f the adapter s capabilities the server should conform to RFC 1123 Those servers that are noncompliant may generate errors in the adapter System Requirements The minimum system requirements and operating system requirements for the FTP adapter are detailed in the release notes It is assumed that a Command Server has already been installed on the computer where the adapter is to be installed for ru...

Page 7: ...net target ip 110 to test a POP3 e mail source where target ip is the server IP address If the test is successful you receive a welcome message from the server Shut down the session by typing QUIT and pressing Enter Note You might not be able to see what you are typing on the screen Access to International VANs Access to international VANs is available when using the FTP adapter The FTP adapter ca...

Page 8: ...nds The command syntax is IA alias card_num OA alias card_num In the command syntax IA is the Input Source Override execution command and OA is the Output Target Override execution command alias is the adapter alias and card_num is the number of the map card The FTP adapter alias and corresponding execution commands are listed below Adapter Alias As Input As Output FTP FTP IAFTPcard_num OAFTPcard_...

Page 9: ...urce Target Account ACCT account_id Audit AUDIT S full_path Certificate Authority CA filename Note Only available if Security Option is installed Client Certificate CERT filename Note Only available if Security Option is installed Client Certificate Password CPASS password Note Only available if Security Option is installed Code Page Local OS 390 z OS only CPL code_page_name Code Page Remote OS 39...

Page 10: ...y available if Security Option is installed Private Key Password KPASS password Note Only available if Security Option is installed Quantity QTY number Site SITE command_text SSL Encryption Strength STR WEAK STRONG ANY Note Only available if Security Option is installed SSL Protocol SPROTO SSLv2 SSLv3 SSLv23 TLSv1 Note Only available if Security Option is installed Stage STAGE file_name System SYS...

Page 11: ...dapter command A or AUDIT to produce a log file in the map directory where the adapter is installed with the default name m4ftp log The log file records audit information detailing files sent or received from each host elapsed time file size and retry count for each file AUDIT S full_path Option Description Append audit information to the existing log file If a log file does not exist one is creat...

Page 12: ...e trusted CA certificates Client Certificate CERT Use the Client Certificate adapter command CERT to specify the file containing the client certificate if used CERT filename Option Description filename Specify the file containing the client certificate Client Certificate Password CPASS Use the Client Certificate Password adapter command CPASS to specify the password for the client certificate if p...

Page 13: ...ode page name of the data on the local system See IBM publication OS 390 C C Run Time Library Reference SC28 1663 function __atoe_l or go to http publibz boulder ibm com cgi bin bookmgr_OS390 BOOKS EDCLB130 3 50 SHELF CBCBS130 DT 200206201 75922 for more information Code Page Remote CPR Use the Code Page Remote adapter command CPR to specify the code page of the data on the remote system to which ...

Page 14: ...xy server Unless you are also specifying a password this parameter must be followed by if you specify fw_host fw_pass Specify the password that authenticates the user name This parameter must be followed by if you are also specifying fw_host fw_host The name or address of the proxy server to which to connect fw_port The name or number of the port to use for connection method Required value The met...

Page 15: ...er PASS ftp_pass Note TRANSPARENT is the only method that directly connects to the FTP server all other methods connect to the firewall See the FTP URL URL adapter command for more information on the FTP variables shown in the Connection Information column Example The following command uses the USERLOGON or USER method to connect to the proxy server fire no port specified with a user name of jbond...

Page 16: ...he FIREWALL command OPEN Establish a Socket connection to the firewall host Issue the following command over the connection in this order OPEN ftp_host USER ftp_user PASS ftp_pass SITE Establish a Socket connection to the firewall host Issue the following command over the connection in this order USER fw_user PASS fw_pass SITE ftp_host USER ftp_user PASS ftp_pass TRANSPARENT Establish a Socket con...

Page 17: ...pass USER USERLOGONFW or USERFW Establish a Socket connection to the firewall host Issue the following command over the connection in this order USER fw_user ftp_host PASS fw_pass USER ftp_user PASS ftp_pass URL Syntax Because the syntax for the rest of the URL varies depending on the scheme selected URL schemes that involve the direct use of an IP based protocol for a specified host on the Intern...

Page 18: ... user and password field any or characters must be encoded The URL does not need to be completely URL encoded You only need to use escape characters for tokens specifically used in an FTP URL as shown in the following table Any FTP URL that contains spaces must be enclosed in quotes for example FIREWALL FTP Home Machine FTP Files Tokens Replaced with percent 25 at 40 forward slash 2F colon 3A semi...

Page 19: ...fy the password that authenticates the user name This parameter must be followed by if you are also specifying ftp_host ftp_host Specify the FTP server name or address to which to connect If not specified the default of localhost is assumed ftp_port The port name or number to use for connection dir Specify the directory path for the file The ellipsis indicates this field can repeat depending on yo...

Page 20: ...d in Internet draft draft bernstein eplf 02 txt D4 Directory machine readable list format as defined in Internet draft draft ietf ftpext m1st 02 txt Append the transferred data to the existing file Note An additional forward slash is required to separate the user and host parameters from file and transfer type if specified Example The following is an example of the input card command in the Map De...

Page 21: ...rors of type 550 file not available and returns a zero length file to the map A list of error codes appears in RFC 959 beginning on page 37 of the document at http www ietf org rfc rfc0959 txt Keep Server KS Use the Keep Server adapter command KS to specify in a map rule that when retrieving a file from an FTP server it should not be deleted after transfer This option should be used if this behavi...

Page 22: ... and lists the files in the specified order FTP server ignores the option and lists the files in the default order FTP server rejects the option and the adapter returns an error For example URL ftp testftp test host mydir ls tr The LS command is issued by the adapter before any file transfer so that its results are used to control the order of the file transfer In the example above all files from ...

Page 23: ...d A new file called data txt will be added to this new directory Passive Mode PV or PASV The Passive Mode adapter command PV or PASV specifies that you only try passive mode for the FTP data connection Passive mode is primarily useful for firewalls and is a preferred connection method for security reasons By default the adapter attempts to connect using passive mode If unsuccessful the adapter use...

Page 24: ...tion Description filename Specify the file containing the client private key Private Key Password KPASS Use the Private Key Password adapter command KPASS to specify the password for the client private key if password protected KPASS password Option Description password Specify the password for the client private key Quantity QTY Use the Quantity command QTY to capture the number of files to be re...

Page 25: ...r command SITE to send an FTP server specific site command to the FTP server software SITE command_text Option Description command_text Specify the FTP server specific site command enclosed in single quotes to send to the FTP server software For example SITE namefmt 1 sends the NAMEFMT command to an AS 400 FTP server before files are transferred To see what commands are accepted by the server use ...

Page 26: ...lable encryption SSL Protocol SPROTO Use the SSL Protocol adapter command SPROTO to set the Secure Socket Layer SSL protocol level SSL enables the adapter to process FTPS URLs If SPROTO is not specified the SSL Protocol defaults to SSLv23 SPROTO SSLv2 SSLv3 SSLv23 TLSv1 Option Description SSLv2 Specify SSL protocol version 2 SSLv3 Specify SSL protocol version 3 SSLv23 Specify SSL protocol version ...

Page 27: ...cify a unique file name for the temporary file This option is especially useful if a server does not supply unique file names System SYS Use the System adapter command SYS to specify the system type when the adapter cannot accurately determine the system type of the FTP server Note The FTP server system type is not necessarily the same as the operating system of the machine it is running on Some W...

Page 28: ...th Option Description Append trace information to the existing log file S Summary mode Record only minimal information only in the log file This is the default value V Verbose mode Record in the log file all activity occurring while the adapter is retrieving data If not specified summary mode assumed full_path Create trace file with the specified name in the specified directory By default the dire...

Page 29: ... URL FTP ftp_user ftp_pass ftp_host ftp_port dir dir filename type xfer_type ACCT account_id AUDIT S full_path CERT filename CPASS password CPL code_page_name CPR code_page_name FIREWALL FTP fw_user fw_pass fw_host fw_port method IGNORE error_code error_code KPASS password KS LS sort_type MKD PASV PKEY filename PORT QTY number SITE command_text SPROTO SSLv2 SSLv3 SSLv23 TLSv1 STR WEAK STRONG ANY S...

Page 30: ...t ftp_port dir dir filename type xfer_type ACCT account_id AUDIT S full_path CA filename CERT filename CPASS password CPL code_page_name CPR code_page_name FIREWALL FTP fw_user fw_pass fw_host fw_port method IGNORE error_code error_code KPASS password KS LS sort_type MKD PASV PKEY filename PORT SITE command_text SPROTO SSLv2 SSLv3 SSLv23 TLSv1 STAGE file_name STR WEAK STRONG ANY SYS WIN32 UNIX UNK...

Page 31: ...name or password specified enter the following command URL FTP host c forms mine txt The command example would retrieve the entire contents of the forms directory because the file name is omitted from the host computer URL FTP host c forms URL Syntax The syntax for the rest of the URL varies depending on the scheme selected URL schemes that involve the direct use of an IP based protocol for a spec...

Page 32: ...it from the prefix containing user password host and port The url_path is interpreted as a series of FTP commands as follows Each cwd element is to be sequentially supplied as the argument to a CWD change working directory command If the typecode is d perform a NLST name list command with name as the argument and interpret the results as a file directory listing Otherwise perform a TYPE command wi...

Page 33: ...cters for tokens specifically used in an FTP URL as shown in the following table Any FTP URL that contains spaces must be enclosed in quotes for example URL FTP Home Machine FTP Files Tokens Replaced with percent 25 at 40 forward slash 2F colon 3A semicolon 3B ampersand Escape not needed use as is pound Escape not needed use as is 8 bit or control characters Escape not needed use as is ...

Page 34: ... log log adapter trace file mtr Adapter Audit Log The adapter audit log is a text file created during the adapter execution that records information about the events that occurred during the adapter activity To produce an adapter audit log use the adapter command AUDIT The default log name is m4ftp log and is located in the map directory See the Trace T adapter command for more information The ada...

Page 35: ... Retry Interval is 0 Rollback is OFF Fetch Unit is 0 Burst Mode is OFF Run Started at 08 49 38 911 on 03 28 00 220 S 220 This is a demo version of the Vermillion FTP Daemon licensed only for S 220 a 30 day evaluation period For continued use you must purchase a S 220 license For more information or to download the latest version please S 220 visit Arcane Software on the web at http www arcanesoft ...

Page 36: ... c e G u i d e 3 6 187714 bytes received Socket Closed Connection closed 226 Transfer Complete S QUIT 221 Goodbye S Socket Closed Connection closed Winsock Client ID 1 disabled Read 187714 bytes from d rollback gif Data in E 167 tmp kept Run Completed at 08 49 39 742 on 03 28 00 ...

Page 37: ...ote Adapter return codes with positive numbers are warning codes that indicate a successful operation Adapter return codes with negative numbers are error codes that indicate a failed operation Return Code Message 0 OK 1 Insufficient memory to continue 1 Library Initialization Failed 2 Invalid Entry Point AIX adapters only 3FTP Could not load adapter 3 Error Sending Data 4 Error Receiving Data 5 F...

Page 38: ... 104 Code page values invalid for this system 105 Unable to initialize code page descripton 106 Specify both CPR and CPL or neither 107 Code page translation results in unequal character counts 108 Iconv failed to convert all characters 600 Internal Error Resource Manager Error where Is an error code returned from the server made negative and where is a server supplied error message ...

Page 39: ...e Directory MKD 23 Passive Mode P or PASV 23 Port Mode PORT 24 Private Key PKEY 24 Private Key Password KPASS 24 Quantity QTY 24 Site SITE 25 SSL Encryption Strength STR 26 SSL Protocol SPROTO 26 Stage STG or STAGE 26 syntax summary 29 System SYS 27 Trace T or TRACE 28 D debugging trace file 35 E error codes 21 error messages 37 examples audit log 34 Firewall Connection Method URL 15 FTP adapter c...

Page 40: ... Socket information 7 SSL Encryption Strength STR adapter command 26 SSL Protocol SPROTO adapter command 26 Stage STG or STAGE adapter command 26 syntax summary 29 System SYS adapter command 27 system requirements 6 T Trace T adapter command 28 trace file 35 troubleshooting 34 trace file 35 ...

Reviews: