Compartilhar via


CopyFilesOverSSH@0 – Copiar arquivos pela tarefa SSH v0

Copie arquivos ou compile artefatos para um computador remoto por SSH.

Syntax

# 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.

Entradas

sshEndpoint - Conexão de serviço SSH
string. Obrigatórios.

O nome de uma conexão de serviço SSH que contém detalhes de conexão para o computador remoto.

  • O nome do host ou endereço IP do computador remoto, o número da porta e o nome de usuário são necessários para criar uma conexão de serviço de SSH.
  • A chave privada e a frase secreta devem ser especificadas para autenticação.

sourceFolder - Pasta de origem
string.

A pasta de origem dos arquivos a serem copiados para o computador remoto. Quando vazia, a raiz do repositório (build) ou do diretório de artefatos (versão) é usada, que é $(System.DefaultWorkingDirectory). Use variáveis se os arquivos não estiverem no repositório. Exemplo: $(Agent.BuildDirectory).


contents - Conteúdo
string. Obrigatórios. Valor padrão: **.

Os caminhos de arquivo a serem incluídos como parte da cópia. Dá suporte a várias linhas de padrões de minimatch. O valor padrão é **, que inclui todos os arquivos (incluindo subpastas) na pasta de origem.

  • Exemplo: **/*.*(jar|war) inclui todos os arquivos .jar e .war (incluindo subpastas) na pasta de origem.
  • Exemplo: "** \n !**/*.xml" inclui todos os arquivos (incluindo subpastas) na pasta de origem, mas exclui arquivos xml.

targetFolder - Pasta de destino
string.

A pasta de destino no computador remoto, em que os arquivos serão copiados. Exemplo: /home/user/MySite. Preceda com um bloco (~) para especificar o diretório base do usuário.


isWindowsOnTarget - Computador de destino executando o Windows
boolean. Valor padrão: false.

Verifica se o computador de destino está executando o Windows.


cleanTargetFolder - Limpar pasta de destino
boolean. Valor padrão: false.

Exclui todos os arquivos e subpastas existentes na pasta de destino antes de copiar.


cleanHiddenFilesInTarget - Remover arquivos ocultos na pasta de destino
boolean. Opcional. Use quando cleanTargetFolder = true. Valor padrão: false.

Quando definido truecomo , remove arquivos ocultos na pasta de destino.


readyTimeout - Tempo limite do handshake SSH
string. Obrigatórios. Valor padrão: 20000.

Quanto tempo (em milissegundos) aguardar a conclusão do handshake SSH.


overwrite - Substituir
boolean. Valor padrão: true.

Substitui os arquivos existentes dentro e abaixo da pasta de destino.


failOnEmptySource - Falha se nenhum arquivo encontrado para copiar
boolean. Valor padrão: false.

Falhará se nenhum arquivo correspondente a ser copiado for encontrado na pasta de origem.


flattenFolders - Nivelar pastas
boolean. Valor padrão: false.

Nivela a estrutura de pastas e copia todos os arquivos para a pasta de destino especificada no computador remoto.


Opções de controle da tarefa

Todas as tarefas têm opções de controle além de suas entradas de tarefa. Para obter mais informações, consulte Opções de controle e propriedades comuns da tarefa.

Variáveis de saída

Nenhum.

Requisitos

Requisito Descrição
Tipos de pipeline YAML, build clássico, versão clássica
Executa em Agent, DeploymentGroup
Demandas Nenhum
Funcionalidades Essa tarefa não atende a nenhuma demanda para tarefas subsequentes no trabalho.
Restrições de comando Essa tarefa é executada usando as seguintes restrições de comando: restrito
Variáveis configuráveis Essa tarefa tem permissão para definir as seguintes variáveis: A configuração de variáveis está desabilitada
Versão do agente 2.206.1 ou superior
Categoria da tarefa Implantar
Requisito Descrição
Tipos de pipeline YAML, build clássico, versão clássica
Executa em Agent, DeploymentGroup
Demandas Nenhum
Funcionalidades Essa tarefa não atende a nenhuma demanda para tarefas subsequentes no trabalho.
Restrições de comando Essa tarefa é executada usando as seguintes restrições de comando: restrito
Variáveis configuráveis Essa tarefa tem permissão para definir as seguintes variáveis: A configuração de variáveis está desabilitada
Versão do agente 2.182.1 ou superior
Categoria da tarefa Implantar
Requisito Descrição
Tipos de pipeline YAML, build clássico, versão clássica
Executa em Agent, DeploymentGroup
Demandas Nenhum
Funcionalidades Essa tarefa não atende a nenhuma demanda por tarefas subsequentes no trabalho.
Restrições de comando Qualquer
Variáveis configuráveis Qualquer
Versão do agente 2.144.0 ou superior
Categoria da tarefa Implantar
Requisito Descrição
Tipos de pipeline YAML, build clássico, versão clássica
É executado em Agent, DeploymentGroup
Demandas Nenhum
Funcionalidades Essa tarefa não atende a nenhuma demanda por tarefas subsequentes no trabalho.
Restrições de comando Qualquer
Variáveis configuráveis Qualquer
Versão do agente 2.102.0 ou superior
Categoria da tarefa Implantar