Get Files with SCP

ScpGet32x32

Description

Downloads a set of files from a remote host to the Runtime filesystem, using the secure copy protocol (SCP).

Parameters

Name Mandatory Default Description

Name	Mandatory	Default	Description
SSH Host	Yes		SSH hostname or IP address.
SSH Port	No	22	Connection port.
SSH User	Yes		SSH user.
SSH Password	No		This user’s encrypted password.
SSH Unencrypted Password	No		This user’s password in plain text.
SCP Remote File	No		Remote file to transfer. A wildcard character `*` can be used to get multiple files at once
SCP Local Dir	No		Local directory into which the files are transferred.
SCP Use sFTP	No		Use the sFTP Protocol for transfer.
SCP Preserve File Date	No	False	Select this option to preserve the file timestamp after the transfer.
SSH Trust Hosts	No	true	Accept all the hosts. If set to false, a list of trusted hosts is provided in the SSH Known Hosts File.
SSH Known Hosts File	No		File containing the list of trusted hosts.
SSH Private Key File	No		Private keys used.
SSH Password Phrase	No		Encrypted Password Phrase.
SSH Unencrypted Password Phrase	No		Password Phrase in plain text.
SSH Additional Connection Properties	No		To define additional connection properties in the form of Java Properties. (`key=value` pairs separated by carriage returns)
Proxy Host	No		Hostname for the proxy server.
Proxy Port	No	1080	Port of the proxy server.
Proxy User	No		Proxy server user.
Proxy Password	No		Proxy server user password, encrypted.
Proxy Unencrypted Password	No		Proxy server user password in plain text.
Proxy Protocol	No		Protocol used for the proxy server: HTTP, SOCKS, SOCKS4 or SOCKS5.
SQL Connection	No		SQL connection into which the list of downloaded files is published, similarly to the Get Files with FTP action.
SQL Schema Name	No		SQL schema into which the list of downloaded files is published.
SQL Transaction Name	No		SQL transaction into which the list of downloaded files is published.
SQL Additionnal Connection Properties	No		Additionnal properties set on the connection. These properties are provided as `key=value` pairs separated by a carriage return.

SSH Host

Yes

SSH hostname or IP address.

SSH Port

Connection port.

SSH User

Yes

SSH user.

SSH Password

This user’s encrypted password.

SSH Unencrypted Password

This user’s password in plain text.

SCP Remote File

Remote file to transfer. A wildcard character * can be used to get multiple files at once

SCP Local Dir

Local directory into which the files are transferred.

SCP Use sFTP

Use the sFTP Protocol for transfer.

SCP Preserve File Date

False

Select this option to preserve the file timestamp after the transfer.

SSH Trust Hosts

true

Accept all the hosts. If set to false, a list of trusted hosts is provided in the SSH Known Hosts File.

SSH Known Hosts File

File containing the list of trusted hosts.

SSH Private Key File

Private keys used.

SSH Password Phrase

Encrypted Password Phrase.

SSH Unencrypted Password Phrase

Password Phrase in plain text.

SSH Additional Connection Properties

To define additional connection properties in the form of Java Properties. (key=value pairs separated by carriage returns)

Proxy Host

Hostname for the proxy server.

Proxy Port

1080

Port of the proxy server.

Proxy User

Proxy server user.

Proxy Password

Proxy server user password, encrypted.

Proxy Unencrypted Password

Proxy server user password in plain text.

Proxy Protocol

Protocol used for the proxy server: HTTP, SOCKS, SOCKS4 or SOCKS5.

SQL Connection

SQL connection into which the list of downloaded files is published, similarly to the Get Files with FTP action.

SQL Schema Name

SQL schema into which the list of downloaded files is published.

SQL Transaction Name

SQL transaction into which the list of downloaded files is published.

SQL Additionnal Connection Properties

Additionnal properties set on the connection. These properties are provided as key=value pairs separated by a carriage return.

Passwords are encrypted using the encrypt <password> command on the Runtime engine command-line tool.

This actions supports publishing the processed files to a table as well as using the list of processed file in a bind link, similarly to the Get Files with FTP action.

Published variables

Name

Description

FILE_NB

Number of files downloaded with this action.