Copy Files Over SSH task
Azure Pipelines | Azure DevOps Server 2019 | TFS 2018 | TFS 2017
Use this task in a build or release pipeline to copy files from a source folder to a target folder on a remote machine over SSH.
This task allows you to connect to a remote machine using SSH and copy files matching a set of minimatch patterns from specified source folder to target folder on the remote machine. Supported protocols for file transfer are SFTP and SCP via SFTP. In addition to Linux, macOS is partially supported (see Q&A).
In Microsoft Team Foundation Server (TFS) 2018 and previous versions, run and release pipelines are called definitions, runs are called builds, service connections are called service endpoints, stages are called environments, and jobs are called phases.
- The task supports use of an SSH key pair to connect to the remote machine(s).
- The public key must be pre-installed or copied to the remote machine(s).
# Copy files over SSH # Copy files or build artifacts to a remote machine over SSH - task: CopyFilesOverSSH@0 inputs: sshEndpoint: #sourceFolder: # Optional #contents: '**' #targetFolder: # Optional #cleanTargetFolder: false # Optional #overwrite: true # Optional #failOnEmptySource: false # Optional #flattenFolders: false # Optional
|SSH endpoint||The name of an SSH service connection containing connection details for the remote machine.
- The hostname or IP address of the remote machine, the port number, and the user name are required to create an SSH service connection.
- The private key and the passphrase must be specified for authentication.
|Source folder||The source folder for the files to copy to the remote machine. If omitted, the root of the repository is used. Names containing wildcards such as
|Contents||File paths to include as part of the copy. Supports multiple lines of minimatch patterns. Default is
|Target folder||Target folder on the remote machine to where files will be copied. Example:
|Advanced - Clean target folder||If this option is selected, all existing files in the target folder will be deleted before copying.|
|Advanced - Overwrite||If this option is selected (the default), existing files in the target folder will be replaced.|
|Advanced - Flatten folders||If this option is selected, the folder structure is not preserved and all the files will be copied into the specified target folder on the remote machine.|
|Control options||See Control options|
This task is open source on GitHub. Feedback and contributions are welcome.
Q & A
What key formats are supported for the SSH tasks?
The Azure Pipelines SSH tasks use the Node.js
ssh2 package for SSH connections. Ensure that you are using the latest version of the SSH tasks. Older versions may not support the OpenSSH key format.
If you run into an "Unsupported key format" error, then you may need to add the
-m PEM flag to your
ssh-keygen command so that the key is in a supported format.
Do I need an agent?
You need at least one agent to run your build or release. Get an agent for Linux, macOS, or Windows.
I'm having problems. How can I troubleshoot them?
I can't select a default agent pool and I can't queue my build or release. How do I fix this?
See Agent pools.
Is this task supported for target machines running operating systems other than Linux?
This task is intended for target machines running Linux.
- For copying files to a macOS machine, this task may be used, but authenticating with a password is not supported.
- For copying files to a Windows machine, consider using Windows Machine File Copy.