Bamboo SFTP Download Task

You can use the SFTP Download task to transfer files and directories from a remote SFTP server to the local working directory

Using the SFTP Download Task user interface

Navigate to the Tasks configuration tab for the job (this will be the default job if creating a new plan).
Click the name of an existing SFTP Download task or click Add Task and then search 'SFTP' to easily locate the SFTP Download task type, in order to create a new task.
Complete the following settings:

Task Description	A description of the task, which is displayed in Bamboo.
Disable this task	Check, or clear, to selectively run this task.
Host	The hostname or IP address of the remote server to which the files will be copied.
Authentication Type	Username and Password - Enter username and password to use when connecting to remote host.
Authentication Type	SSH Private Key - Browse to the SSH private key with which to authenticate with the remote host. A passphrase for the key can be supplied if required.
Remote Directory	The path to the download source directory on the remote server
Include Pattern	A comma separated list of files to be downloaded relative to the remote directory path. You can use Ant-style pattern matching to include multiple files, such as `*/target/.jar`.
Local Directory	The path to the download destination directory (relative to the Bamboo working directory).
Verify remote host fingerprint on connect	Enter the host fingerprint to be verified. See below for more details.
Port	The port number of the remote host that is used for the SSH connection. The default value is 22.

Click Save

Host fingerprint

You can determine the fingerprint for a host by running:

ssh-keygen -l -F <HOSTNAME>

The fingerprint is the part of the response shown in the screenshot below:

Use the SFTP Download Task in a YAML pipeline

- mci-sftp-download:
    destination-dir: test-reports
    source-dir: /opt/dm/mci/reports
    transfer-pattern: ${bamboo.ProjectName}/**/*.xml
    port: '22'
    host: ${bamboo.ServerName}
    username: ${bamboo.ServerUsername}
    shared-credentials: *ssh_credentials     #SSH shared credential variable substitution
    description: Retrieve unit test results