CopyFilesOverSSH@0 - 通过 SSH v0 任务复制文件

通过 SSH 将文件或生成项目复制到远程计算机。

语法

# Copy files over SSH v0
# Copy files or build artifacts to a remote machine over SSH.
- task: CopyFilesOverSSH@0
  inputs:
    sshEndpoint: # string. Required. SSH service connection. 
    #sourceFolder: # string. Source folder. 
    contents: '**' # string. Required. Contents. Default: **.
    #targetFolder: # string. Target folder. 
  # Advanced
    #isWindowsOnTarget: false # boolean. Target machine running Windows. Default: false.
    #cleanTargetFolder: false # boolean. Clean target folder. Default: false.
    #cleanHiddenFilesInTarget: false # boolean. Optional. Use when cleanTargetFolder = true. Remove hidden files in target folder. Default: false.
    readyTimeout: '20000' # string. Required. SSH handshake timeout. Default: 20000.
    #overwrite: true # boolean. Overwrite. Default: true.
    #failOnEmptySource: false # boolean. Fail if no files found to copy. Default: false.
    #flattenFolders: false # boolean. Flatten folders. Default: false.
# Copy files over SSH v0
# Copy files or build artifacts to a remote machine over SSH.
- task: CopyFilesOverSSH@0
  inputs:
    sshEndpoint: # string. Required. SSH service connection. 
    #sourceFolder: # string. Source folder. 
    contents: '**' # string. Required. Contents. Default: **.
    #targetFolder: # string. Target folder. 
  # Advanced
    #isWindowsOnTarget: false # boolean. Target machine running Windows. Default: false.
    #cleanTargetFolder: false # boolean. Clean target folder. Default: false.
    readyTimeout: '20000' # string. Required. SSH handshake timeout. Default: 20000.
    #overwrite: true # boolean. Overwrite. Default: true.
    #failOnEmptySource: false # boolean. Fail if no files found to copy. Default: false.
    #flattenFolders: false # boolean. Flatten folders. Default: false.
# Copy files over SSH v0
# Copy files or build artifacts to a remote machine over SSH.
- task: CopyFilesOverSSH@0
  inputs:
    sshEndpoint: # string. Required. SSH service connection. 
    #sourceFolder: # string. Source folder. 
    contents: '**' # string. Required. Contents. Default: **.
    #targetFolder: # string. Target folder. 
  # Advanced
    #cleanTargetFolder: false # boolean. Clean target folder. Default: false.
    #overwrite: true # boolean. Overwrite. Default: true.
    #failOnEmptySource: false # boolean. Fail if no files found to copy. Default: false.
    #flattenFolders: false # boolean. Flatten folders. Default: false.
# Copy Files Over SSH v0
# Copy files or build artifacts to a remote machine over SSH.
- task: CopyFilesOverSSH@0
  inputs:
    sshEndpoint: # string. Required. SSH service connection. 
    #sourceFolder: # string. Source folder. 
    contents: '**' # string. Required. Contents. Default: **.
    #targetFolder: # string. Target folder. 
  # Advanced
    #cleanTargetFolder: false # boolean. Clean target folder. Default: false.
    #overwrite: true # boolean. Overwrite. Default: true.
    #failOnEmptySource: false # boolean. Fail if no files found to copy. Default: false.
    #flattenFolders: false # boolean. Flatten folders. Default: false.

输入

sshEndpoint - SSH 服务连接
string. 必需。

包含远程计算机的连接详细信息的 SSH 服务连接 的名称。

  • 创建 SSH 服务连接需要使用远程计算机的主机名或 IP 地址、端口号以及用户名。
  • 必须为身份验证指定私钥和通行短语。

sourceFolder - 源文件夹
string.

要复制到远程计算机的文件的源文件夹。 如果为空,则使用存储库的根 (生成) 或项目目录 (发布) ,即 $(System.DefaultWorkingDirectory)。 如果文件不在存储库中,请使用变量。 示例:$(Agent.BuildDirectory)


contents - 内容
string. 必需。 默认值:**

要作为副本的一部分包含的文件路径。 支持多行 minimatch 模式。 默认值 **为 ,其中包括源文件夹下的所有文件 (包括子文件夹) 。

  • 示例: **/*.*(jar|war) 包括所有.jar和 .war 文件, (包括源文件夹下的子文件夹) 。
  • 示例: "** \n !**/*.xml" 包括 (包括源文件夹下) 子文件夹的所有文件,但不包括 xml 文件。

targetFolder - 目标文件夹
string.

远程计算机上的目标文件夹,将在其中复制文件。 示例:/home/user/MySite。 带有波形符 (~) 的开头,用于指定用户的主目录。


isWindowsOnTarget - 运行 Windows 的目标计算机
boolean. 默认值:false

检查目标计算机是否正在运行 Windows。


cleanTargetFolder - 清理目标文件夹
boolean. 默认值:false

在复制之前删除目标文件夹中的所有现有文件和子文件夹。


cleanHiddenFilesInTarget - 删除目标文件夹中的隐藏文件
boolean. 可选。 在 时 cleanTargetFolder = true使用 。 默认值:false

true设置为 时,删除目标文件夹中的隐藏文件。


readyTimeout - SSH 握手超时
string. 必需。 默认值:20000

等待 SSH 握手完成) (时间(以毫秒为单位)。


overwrite - 覆盖
boolean. 默认值:true

替换目标文件夹及其下方的现有文件。


failOnEmptySource - 如果未找到要复制的文件,则失败
boolean. 默认值:false

如果在源文件夹下找不到要复制的匹配文件,则失败。


flattenFolders - 平展文件夹
boolean. 默认值:false

平展文件夹结构并将所有文件复制到远程计算机上的指定目标文件夹中。


任务控制选项

除了任务输入,所有任务都有控制选项。 有关详细信息,请参阅 控制选项和常见任务属性

输出变量

无。

要求

要求 说明
管道类型 YAML,经典内部版本,经典版本
运行平台 Agent、DeploymentGroup
需求
功能 此任务不满足作业中后续任务的任何要求。
命令限制 此任务使用以下命令 限制运行:受限
可设置的变量 此任务有权 设置以下变量:禁用设置变量
代理版本 2.182.1 或更高版本
任务类别 部署
要求 说明
管道类型 YAML,经典内部版本,经典版本
运行平台 Agent、DeploymentGroup
需求
功能 此任务不满足作业中后续任务的任何要求。
命令限制 任意
可设置的变量 任意
代理版本 2.144.0 或更高版本
任务类别 部署
要求 说明
管道类型 YAML,经典内部版本,经典版本
运行平台 Agent、DeploymentGroup
需求
功能 此任务不满足作业中后续任务的任何要求。
命令限制 任意
可设置的变量 任意
代理版本 2.102.0 或更高版本
任务类别 部署