Partager via

SSH@0 - Tâche SSH v0

  • Article

Utilisez cette tâche pour exécuter des commandes ou un script d'interpréteur de commandes sur une machine distante via 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.

Syntax

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

# 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. 
    #args: # string. Optional. Use when runOptions = script. Arguments. 
  # Advanced
    #failOnStdErr: true # boolean. Fail on STDERR. Default: true.
    readyTimeout: '20000' # string. Required. SSH handshake timeout. Default: 20000.

# 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. 
    #args: # string. Optional. Use when runOptions = script. Arguments. 
  # Advanced
    #failOnStdErr: true # boolean. Fail on STDERR. Default: true.

Entrées

sshEndpoint - Connexion au 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 de machines Linux distantes, mais cela n’est pas pris en charge pour les systèmes macOS ou Windows.

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

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


commands - Commandes
string. Nécessaire lorsque runOptions = commands.

Spécifie les commandes de l’interpréteur de commandes à exécuter sur l’ordinateur distant. Ce paramètre est disponible uniquement lorsque les Commandes sont sélectionnées 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.

Notes

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


scriptPath - Chemin du script shell
string. Nécessaire lorsque runOptions = script.

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


inline - Inline Script
string. Nécessaire lorsque runOptions = inline.

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


interpreterCommand - Commande interpréteur
string. facultatif. 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. facultatif. Utilisez quand runOptions = script.

Spécifie les arguments à passer au script shell. Ce paramètre est disponible uniquement lorsque le Script d’interpréteur de commandes est sélectionné pour l’option Exécuter.


failOnStdErr - Échec 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 la 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 par clavier interactif
boolean. Valeur par défaut : false.

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


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.

Notes

Utilisez cette tâche pour exécuter des commandes ou un script d'interpréteur de commandes sur une machine distante via 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.

Prérequis

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

Algorithmes pris en charge

Algorithmes de paire de clés

  • RSA
  • DSA

Algorithmes de chiffrement

  • aes256-cbc
  • aes192-cbc
  • aes128-cbc
  • blowfish-cbc
  • 3des-cbc
  • arcfour256
  • arcfour128
  • cast128-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

Configuration requise

Condition requise Description
Types de pipelines YAML, build classique, version classique
S’exécute sur Agent, DeploymentGroup
Demandes None
Capabilities Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail.
Restrictions de commande Quelconque
Variables paramétrables Quelconque
Version de l’agent 2.206.1 ou version ultérieure
Catégorie de la tâche Déployer
Condition requise Description
Types de pipelines YAML, build classique, version classique
S’exécute sur Agent, DeploymentGroup
Demandes None
Capabilities Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail.
Restrictions de commande Quelconque
Variables paramétrables Quelconque
Version de l’agent 2.144.0 ou version ultérieure
Catégorie de la tâche Déployer
Condition requise Description
Types de pipelines YAML, build classique, version classique
S’exécute sur Agent, DeploymentGroup
Demandes None
Capabilities Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail.
Restrictions de commande Quelconque
Variables paramétrables Quelconque
Version de l’agent 2.102.0 ou version ultérieure
Catégorie de la tâche Déployer

Voir aussi