Partager via


CopyFilesOverSSH@0 - Copier des fichiers via la tâche SSH v0

Copiez des fichiers ou générez des artefacts sur un ordinateur distant via SSH.

Syntaxe

# 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.
    #concurrentUploads: '10' # string. Number of concurrent uploads when copying files. Default: 10.
    #delayBetweenUploads: '50' # string. Delay between queueing uploads (in milliseconds). Default: 50.
# 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.

Entrées

sshEndpoint - connexion de service SSH
string. Obligatoire.

Nom d’une connexion de service SSH contenant les détails de connexion de l’ordinateur distant.

  • Le nom d’hôte ou l’adresse IP de l’ordinateur distant, le numéro de port et le nom d’utilisateur sont requis pour créer une connexion de service SSH.
  • La clé privée et la phrase secrète doivent être spécifiées pour l’authentification.

sourceFolder - dossier source
string.

Dossier source des fichiers à copier sur l’ordinateur distant. En cas de vide, la racine du référentiel (build) ou du répertoire d’artefacts (mise en production) est utilisée, qui est $(System.DefaultWorkingDirectory). Utilisez variables si les fichiers ne se trouvent pas dans le référentiel. Exemple : $(Agent.BuildDirectory).


contents - contenu
string. Obligatoire. Valeur par défaut : **.

Chemins d’accès aux fichiers à inclure dans le cadre de la copie. Prend en charge plusieurs lignes de modèles de mini-correspondance . La valeur par défaut est **, qui inclut tous les fichiers (y compris les sous-dossiers) sous le dossier source.

  • Exemple : **/*.*(jar|war) inclut tous les fichiers .jar et .war (y compris les sous-dossiers) sous le dossier source.
  • Exemple : "** \n !**/*.xml" inclut tous les fichiers (y compris les sous-dossiers) sous le dossier source, mais exclut les fichiers xml.

targetFolder - dossier cible
string.

Dossier cible sur l’ordinateur distant, où les fichiers seront copiés. Exemple : /home/user/MySite. Préface avec un (~) tilde pour spécifier le répertoire d’accueil de l’utilisateur.


machine cible isWindowsOnTarget - exécutant Windows
boolean. Valeur par défaut : false.

Vérifie si l’ordinateur cible exécute Windows.


cleanTargetFolder - dossier cible Nettoyer
boolean. Valeur par défaut : false.

Supprime tous les fichiers et sous-dossiers existants dans le dossier cible avant la copie.


cleanHiddenFilesInTarget - Supprimer les fichiers masqués dans le dossier cible
boolean. Optionnel. Utilisez quand cleanTargetFolder = true. Valeur par défaut : false.

Lorsque la valeur est définie sur true, supprime les fichiers masqués dans le dossier cible.


readyTimeout - délai d’expiration de l’établissement d’une liaison SSH
string. Obligatoire. Valeur par défaut : 20000.

Durée (en millisecondes) d’attente de la négociation SSH.


overwrite - remplacer
boolean. Valeur par défaut : true.

Remplace les fichiers existants dans et sous le dossier cible.


failOnEmptySource - Échec si aucun fichier n’a été trouvé pour copier
boolean. Valeur par défaut : false.

Échoue si aucun fichier correspondant à copier n’est trouvé sous le dossier source.


flattenFolders - dossiers aplatir
boolean. Valeur par défaut : false.

Aplatit la structure de dossiers et copie tous les fichiers dans le dossier cible spécifié sur l’ordinateur distant.


concurrentUploads - nombre de chargements simultanés lors de la copie de fichiers
string. Valeur par défaut : 10.

Nombre de chargements simultanés lors de la copie de fichiers. La valeur par défaut est 10.


delayBetweenUploads - délai entre les chargements de file d’attente (en millisecondes)
string. Valeur par défaut : 50.

Délai entre les chargements de file d’attente (en millisecondes). La valeur par défaut est 50.


Options de contrôle de la tâche

Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâches. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.

Variables de sortie

Aucun.

Spécifications

Besoin Descriptif
Types de pipelines YAML, Build Classique, Version Classique
Exécutions sur Agent, Groupe de déploiement
demandes Aucun
fonctionnalités de Cette tâche ne répond à aucune demande de tâches ultérieures dans le travail.
restrictions de commande Cette tâche s’exécute à l’aide des restrictions de commande suivantes: restreint
variables settables Cette tâche est autorisée à définir les variables suivantes: la définition des variables est désactivée
Version de l’agent 2.206.1 ou version ultérieure
Catégorie de tâche Déployer
Besoin Descriptif
Types de pipelines YAML, Build Classique, Version Classique
Exécutions sur Agent, Groupe de déploiement
demandes Aucun
fonctionnalités de Cette tâche ne répond à aucune demande de tâches ultérieures dans le travail.
restrictions de commande Cette tâche s’exécute à l’aide des restrictions de commande suivantes: restreint
variables settables Cette tâche est autorisée à définir les variables suivantes: la définition des variables est désactivée
Version de l’agent 2.182.1 ou version ultérieure
Catégorie de tâche Déployer