Remote Download Command

Purpose

This command transfers files from a target host to the host where the command is being executed. This is typically used to download files from a DataStage Engine to a MettleCI Agent Host as part of a MettleCI-enabled build pipeline. This command…

• uses the SFTP protocol,

• authenticates using either a username/password or SSH Private Key, and

• uses ANT File Patterns

Note that all directories matched by transfer patterns are created in the -destination folder.

Note that the -privateKey parameter is the name of a private key file accessible your mettleci remote execute command. If used as part of a CI/CD pipeline then the build agent process running the command will need access to the specified private key file.

Syntax

Syntax : remote download [options]

Description

• -source

  Directory to be transferred from

  Required

• -destination

  Directory to be transferred to

• -transferPattern

  Pattern of files to include

  Required

• -username

  Username when connecting to remote server

  Required

• -password

  Password when connecting to remote server, required when -privateKey is not used

• -privateKey

  Private SSH key, required when -password is not used

• -passphrase

  SSH key pass phrase

• -host

  URL of the server

  Required

• -port

  SSH Port

Examples

$> mettleci remote download \
    -host my-engine.my-org.com \
    -username mci-user \ 
    -privateKey ~/.ssh/MyPrivateKey.pem \
    -source /source-dir \
    -destination /target-dir \ 
    -transferPattern DSParams

MettleCI Command Line (build 128)
(C) 2018-2022 Data Migrators Pty Ltd
Connecting to my-engine.my-org.com on port 22
Downloading 'DSParams' from remote directory '/source-dir' to local directory '/target-dir':
  DSParams - SUCCESS
Done. 1 file transferred.

See Also