Partager via


SSH@0 - Tâche SSH v0

Utilisez cette tâche pour exécuter des commandes shell ou un script sur un ordinateur distant à l’aide de SSH. Cette tâche vous permet de vous connecter à un ordinateur distant à l’aide de SSH et d’exécuter des commandes ou un script.

Syntaxe

# SSH v0
# Run shell commands or a script on a remote machine using SSH.
- task: SSH@0
  inputs:
    sshEndpoint: # string. Required. SSH service connection. 
    runOptions: 'commands' # 'commands' | 'script' | 'inline'. Required. Run. Default: commands.
    commands: # string. Required when runOptions = commands. Commands. 
    #scriptPath: # string. Required when runOptions = script. Shell script path. 
    #inline: # string. Required when runOptions = inline. Inline Script. 
    #interpreterCommand: '/bin/bash' # string. Optional. Use when runOptions = inline. Interpreter command. Default: /bin/bash.
    #args: # string. Optional. Use when runOptions = script. Arguments. 
  # Advanced
    #failOnStdErr: true # boolean. Fail on STDERR. Default: true.
    #interactiveSession: false # boolean. Enable interactive session. Default: false.
    readyTimeout: '20000' # string. Required. SSH handshake timeout. Default: 20000.
    #interactiveKeyboardAuthentication: false # boolean. Use interactive-keyboard authentication. Default: false.
# SSH v0
# Run shell commands or a script on a remote machine using SSH.
- task: SSH@0
  inputs:
    sshEndpoint: # string. Required. SSH service connection. 
    runOptions: 'commands' # 'commands' | 'script' | 'inline'. Required. Run. Default: commands.
    commands: # string. Required when runOptions = commands. Commands. 
    #scriptPath: # string. Required when runOptions = script. Shell script path. 
    #inline: # string. Required when runOptions = inline. Inline Script. 
    #interpreterCommand: '/bin/bash' # string. Optional. Use when runOptions = inline. Interpreter command. Default: /bin/bash.
    #args: # string. Optional. Use when runOptions = script. Arguments. 
  # Advanced
    #failOnStdErr: true # boolean. Fail on STDERR. Default: true.
    #interactiveSession: false # boolean. Enable interactive session. Default: false.
    readyTimeout: '20000' # string. Required. SSH handshake timeout. Default: 20000.

Entrées

sshEndpoint - connexion de service SSH
string. Obligatoire.

Spécifie le 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.
  • Un mot de passe peut être utilisé pour s’authentifier auprès d’ordinateurs Linux distants, mais cela n’est pas pris en charge pour les systèmes macOS ou Windows.

runOptions - Exécuter
string. Obligatoire. Valeurs autorisées : commands, script (fichier de script), inline (script inline). Valeur par défaut : commands.

Exécute des commandes d’interpréteur de commandes ou un script shell sur l’ordinateur distant.


Commandes commands -
string. Obligatoire lorsque runOptions = commands.

Spécifie les commandes shell à exécuter sur l’ordinateur distant. Ce paramètre est disponible uniquement lorsque Commandes est sélectionnée pour l’option Exécuter. Entrez chaque commande avec ses arguments sur une nouvelle ligne de la zone de texte multiligne. Pour exécuter plusieurs commandes ensemble, entrez-les sur la même ligne séparée par des points-virgules. Exemple : cd /home/user/myFolder;build.

Remarque

Chaque commande s’exécute dans un processus distinct. Si vous souhaitez exécuter une série de commandes qui sont interdépendantes (par exemple, en modifiant le dossier actif avant d’exécuter une commande), utilisez l’option Script inline à la place.


chemin de script scriptPath - Shell
string. Obligatoire lorsque runOptions = script.

Spécifie le chemin d’accès au fichier de script shell à exécuter sur l’ordinateur distant. Ce paramètre est disponible uniquement lorsque script Shell est sélectionné pour l’option Exécuter.


inline - script inline
string. Obligatoire lorsque runOptions = inline.

Écrit le script shell à exécuter sur l’ordinateur distant.


interpreterCommand - commande Interpréteur
string. Optionnel. Utilisez quand runOptions = inline. Valeur par défaut : /bin/bash.

Spécifie le chemin d’accès à l’interpréteur de commandes utilisé pour exécuter le script. Ajoute une ligne de shebang au début du script. Pertinent uniquement pour les systèmes d’exploitation de type UNIX. Utilisez une chaîne vide pour les hôtes distants Windows. En savoir plus sur shebang (# !).


args - arguments
string. Optionnel. Utilisez quand runOptions = script.

Spécifie les arguments à passer au script shell. Ce paramètre est disponible uniquement lorsque script Shell est sélectionné pour l’option Exécuter.


échec de failOnStdErr - sur stDERR
boolean. Valeur par défaut : true.

Si la valeur est true, la build échoue lorsque les commandes distantes ou le script écrivent dans STDERR.


interactiveSession - Activer le de session interactive
boolean. Valeur par défaut : false.

Démarre une session interactive. Les demandes de mot de passe sont remplies par le mot de passe de l’utilisateur. Les sessions interactives peuvent être utiles pour exécuter des commandes, telles que sudo.


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

Spécifie la durée (en millisecondes) pendant laquelle la tâche attend la fin de l’établissement d’une liaison SSH.


interactiveKeyboardAuthentication - Utiliser l’authentification interactive au clavier
boolean. Valeur par défaut : false.

Active l’authentification interactive au clavier. Défini sur true si votre serveur SSH de destination nécessite l’authentification clavier interactive (PasswordAuthentication est désactivé sur l’ordinateur cible/défini sur Non dans sshd_config).


Options de contrôle de tâche

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

Variables de sortie

Aucun.

Remarques

Utilisez cette tâche pour exécuter des commandes shell ou un script sur un ordinateur distant à l’aide de SSH. Cette tâche vous permet de vous connecter à un ordinateur distant à l’aide de SSH et d’exécuter des commandes ou un script.

Conditions préalables

  • La tâche prend en charge l’utilisation d’une paire de clés SSH pour se connecter à la ou les machines distantes.
  • La clé publique doit être préinstallée ou copiée sur la ou les machines distantes.

Algorithmes pris en charge

Algorithmes de paire de clés

  • RSA
  • DSA

Algorithmes de chiffrement

  • AES256-CBC
  • AES192-CBC
  • AES128-CBC
  • Poisson-globe-CBC
  • 3des-CBC
  • Arcfour256
  • Arcfour128
  • DISTRIBUTION128-CBC
  • Arcfour

Pour OpenSSL v1.0.1 et versions ultérieures (sur l’agent) :

  • aes256-ctr
  • aes192-ctr
  • aes128-ctr

Pour OpenSSL v1.0.1 et versions ultérieures, NodeJS v0.11.12 et versions ultérieures (sur l’agent) :

  • AES128-GCM
  • aes128-gcm@openssh.com
  • AES256-GCM
  • aes256-gcm@openssh.com

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 N'importe quel
variables settables N'importe quel
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 N'importe quel
variables settables N'importe quel
Version de l’agent 2.144.0 ou version ultérieure
Catégorie de tâche Déployer

Voir aussi