SFTP

Description

The com.dovetail.ant.ssh.Sftp task is a new task similar to the Ant Scp task. It includes the following enhancements:

• Support for common SFTP commands: put, get, chmod, mkdir, rm, rmdir, rename, cd, pwd, lcd, lpwd, list
• Support for using an ssh-auth or PuTTY pagent key agent.
• Support for multiple known_hosts files, and PuTTY known host registry entries on Windows
• Allows for password prompts, which are masked if supported by the Ant runtime environment.
• Several SFTP commands may be nested in a single SSH Session task

Implements the SSH SFTP protocol for transferring files and managing remote files.

Note: This task is used as an antlib with external libraries that are distributed with the Dovetail ant-ssh distribution.

See also the ssh exec task, the ssh session task, and the ssh scp task

Parameters

Parameters specified as nested elements

fileset or resource collections

FileSets or Resource Collections are used to select groups of files to copy. To use a fileset or a resource collection, the todir attribute must be set.

Examples

This task is packaged in an Antlib. To run, you must point to the Dovetail ant-ssh library jars:

   ant -lib /path/to/ant-ssh/lib

Various SFTP commands on a single SSH session.

<?xml version="1.0" encoding="ISO-8859-1" ?>
<project name="ant-ssh test" default="ssh.example"  
  xmlns:ssh="antlib:com.dovetail.ant.ssh">
  <!-- To run this script, you must have ant-ssh lib/*.jars in your Ant classpath.
       See the ant-ssh README for more information.
  -->
  
    <target name="init" >
      <property name="server" value="localhost"/>
      <property name="serverdir" value="/tmp/anttest"/>
      <property name="userid" value="kirk"/>
      <property name="localdir" value="${java.io.tmpdir}" />
      <tempfile property="dummypath" destdir="${localdir}" deleteonexit="yes" createfile="yes" 
        prefix="anttest." suffix=".txt" />
      <basename property="dummyfile" file="${dummypath}"/>
      <echoproperties destfile="${dummypath}" />  
  </target>
        
  <target name="ssh.example" depends="init" >
    <ssh:session username="${userid}" host="${server}" trust="yes">
      <ssh:sftp action="pwd" />
      <ssh:sftp action="list" file="/etc/fstab" />  <
      <ssh:sftp action="mkdir" dir="${serverdir}" ignoreError="yes" />
      <ssh:sftp action="put" todir="${serverdir}">  
        <fileset dir="${localdir}" casesensitive="yes" >
            <include name="anttest.*"/>
          </fileset>
      </ssh:sftp>
      <ssh:sftp action="chmod" file="${serverdir}/${dummyfile}" filemode="644" />
      <ssh:sftp action="get" dir="/etc/*crontab*" todir="${localdir}" />
      <ssh:sftp action="cd" dir="${serverdir}" />
      <ssh:sftp action="list" file="*.txt" />
      <ssh:sftp action="rm" file="notthere" failOnError="no" />
      <ssh:sftp action="rename" file="${dummyfile}" tofile="${dummyfile}.bak" />        
      <ssh:sftp action="rm"    file="${dummyfile}.bak" />        
      <ssh:sftp action="rmdir" dir="foonotthere" failOnError="no" />
      <ssh:sftp action="mkdir" dir="foo" failOnError="no" />
      <ssh:sftp action="symlink" file="foosym" todir="foo" />
      <ssh:sftp action="rm" file="foosym" />
      <ssh:sftp action="rmdir" dir="foo" />
      <ssh:sftp action="list" /> 
      <ssh:exec command="uname -a" />
    </ssh:session> 
  </target>

</project>

Example connecting to an IBM z/OS system running Co:Z SFTP.

<?xml version="1.0" encoding="ISO-8859-1" ?>
<project name="ant-ssh test1" default="upload_zos" 
    xmlns:ssh="antlib:com.dovetail.ant.ssh">
  
    <target name="init" >
      <property name="server" value="zos.coztoolkit.com"/>
      <property name="serverDir" value="/tmp/src"/>
      <property name="sampJclPds" value="KIRK.COZ.SAMPJCL" />
      <property name="userid" value="kirk"/>
  </target>
        
  <target name="upload_zos" depends="init" >
    <echo message="Uploading source to ${server}:${serverDir}" />
    <ssh:session username="${userid}" host="${server}">
      <ssh:sftp action="mkdir" dir="${serverDir}" ignoreError="yes" />
      <ssh:sftp action="list" file="/+mode=text" />
      <ssh:sftp action="put" todir="${serverDir}" >
        <fileset dir="src" casesensitive="yes" >
          <include name="**"/>
          <modified/>
        </fileset>
      </ssh:sftp>
      <ssh:sftp action="list" file="/+mode=binary" />
      <ssh:sftp action="put" todir="${serverDir}" >
        <fileset dir="bin" casesensitive="yes" >
          <include name="**"/>
          <modified/>
        </fileset>
      </ssh:sftp>
      <ssh:sftp action="list" file="/+mode=text" />
      <!-- Jsch SFTP requires that z/OS datasets use the prefix "/-/" -->
      <ssh:sftp action="cd" todir="/-/${sampJclPds}"/>
      <ssh:sftp action="put" todir=".">
        <fileset dir="jcl" >
          <include name="*" />
          <modified/>
        </fileset>
      </ssh:sftp>
      <ssh:exec command="cd ${serverDir}; make" />
    </ssh:session>
  </target>
  
</project>