Share via

SSH@0 - SSH v0-taak

  • Artikel

Gebruik deze taak om shell-opdrachten of een script op een externe computer uit te voeren met behulp van SSH. Met deze taak kunt u verbinding maken met een externe computer met behulp van SSH en opdrachten of een script uitvoeren.

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.

Invoerwaarden

sshEndpoint - SSH-serviceverbinding
string. Vereist.

Hiermee geeft u de naam van een SSH-serviceverbinding met verbindingsgegevens voor de externe computer. De hostnaam of het IP-adres van de externe computer, het poortnummer en de gebruikersnaam zijn vereist om een SSH-serviceverbinding te maken.

  • De persoonlijke sleutel en de wachtwoordzin moeten worden opgegeven voor verificatie.
  • Een wachtwoord kan worden gebruikt voor verificatie bij externe Linux-machines, maar dit wordt niet ondersteund voor macOS- of Windows-systemen.

runOptions - Uitvoeren
string. Vereist. Toegestane waarden: commands, script (scriptbestand), inline (inlinescript). Standaardwaarde: commands.

Voert shell-opdrachten of een shellscript uit op de externe computer.


commands - Opdrachten
string. Vereist wanneer runOptions = commands.

Hiermee geeft u de shell-opdrachten die moeten worden uitgevoerd op de externe computer. Deze parameter is alleen beschikbaar wanneer Opdrachten is geselecteerd voor de optie Uitvoeren . Voer elke opdracht samen met de bijbehorende argumenten in op een nieuwe regel van het tekstvak met meerdere regels. Als u meerdere opdrachten tegelijk wilt uitvoeren, voert u deze in op dezelfde regel, gescheiden door puntkomma's. Bijvoorbeeld: cd /home/user/myFolder;build.

Notitie

Elke opdracht wordt in een afzonderlijk proces uitgevoerd. Als u een reeks opdrachten wilt uitvoeren die onderling afhankelijk zijn (bijvoorbeeld door de huidige map te wijzigen voordat u een opdracht uitvoert), gebruikt u in plaats daarvan de optie Inline Script .


scriptPath - Shell-scriptpad
string. Vereist wanneer runOptions = script.

Hiermee geeft u het pad naar het shellscriptbestand dat moet worden uitgevoerd op de externe computer. Deze parameter is alleen beschikbaar wanneer Shell-script is geselecteerd voor de optie Uitvoeren .


inline - Inlinescript
string. Vereist wanneer runOptions = inline.

Hiermee schrijft u het shellscript dat moet worden uitgevoerd op de externe computer.


interpreterCommand - Opdracht Interpreter
string. Optioneel. Gebruik wanneer runOptions = inline. Standaardwaarde: /bin/bash.

Hiermee geeft u het pad naar de opdrachtinterpreter die wordt gebruikt om het script uit te voeren. Hiermee voegt u een shebang-regel toe aan het begin van het script. Alleen relevant voor UNIX-achtige besturingssystemen. Gebruik een lege tekenreeks voor externe Windows-hosts. Meer informatie over shebang (#!).


args - Argumenten
string. Optioneel. Gebruik wanneer runOptions = script.

Hiermee geeft u de argumenten die moeten worden doorgegeven aan het shellscript. Deze parameter is alleen beschikbaar wanneer Shell-script is geselecteerd voor de optie Uitvoeren .


failOnStdErr - Fout op STDERR
boolean. Standaardwaarde: true.

Als de waarde is true, mislukt de build wanneer de externe opdrachten of het script naar STDERRschrijven.


interactiveSession - Interactieve sessie inschakelen
boolean. Standaardwaarde: false.

Start een interactieve sessie. Wachtwoordaanvragen worden ingevuld door het wachtwoord van de gebruiker. Interactieve sessies kunnen handig zijn voor het uitvoeren van opdrachten, zoals sudo.


readyTimeout - Time-out voor SSH-handshake
string. Vereist. Standaardwaarde: 20000.

Hiermee geeft u op hoe lang (in milliseconden) de taak wacht totdat de SSH-handshake is voltooid.


interactiveKeyboardAuthentication - Verificatie via interactief toetsenbord gebruiken
boolean. Standaardwaarde: false.

Hiermee schakelt u verificatie via interactief toetsenbord in. Stel in op true als uw doel-SSH-server interactieve toetsenbordverificatie vereist (PasswordAuthentication is uitgeschakeld op de doelcomputer/ingesteld op Nee in sshd_config).


Opties voor taakbeheer

Alle taken hebben besturingsopties naast hun taakinvoer. Zie Besturingsopties en algemene taakeigenschappen voor meer informatie.

Uitvoervariabelen

Geen.

Opmerkingen

Gebruik deze taak om shell-opdrachten of een script op een externe computer uit te voeren met behulp van SSH. Met deze taak kunt u verbinding maken met een externe computer met behulp van SSH en opdrachten of een script uitvoeren.

Vereisten

  • De taak ondersteunt het gebruik van een SSH-sleutelpaar om verbinding te maken met de externe machine(s).
  • De openbare sleutel moet vooraf zijn geïnstalleerd of gekopieerd naar de externe computer(s).

Ondersteunde algoritmen

Sleutelpaaralgoritmen

  • RSA
  • DSA

Versleutelingsalgoritmen

  • aes256-cbc
  • aes192-cbc
  • aes128-cbc
  • blowfish-cbc
  • 3des-cbc
  • arcfour256
  • arcfour128
  • cast128-cbc
  • arcfour

Voor OpenSSL v1.0.1 en hoger (op agent):

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

Voor OpenSSL v1.0.1 en hoger, NodeJS v0.11.12 en hoger (op agent):

  • aes128-gcm
  • aes128-gcm@openssh.com
  • aes256-gcm
  • aes256-gcm@openssh.com

Vereisten

Vereiste Beschrijving
Pijplijntypen YAML, klassieke build, klassieke release
Wordt uitgevoerd op Agent, DeploymentGroup
Eisen Geen
Functies Deze taak voldoet niet aan eventuele vereisten voor volgende taken in de taak.
Opdrachtbeperkingen Alle
Instelbare variabelen Alle
Agentversie 2.206.1 of hoger
Taakcategorie Implementeren
Vereiste Beschrijving
Pijplijntypen YAML, klassieke build, klassieke release
Wordt uitgevoerd op Agent, DeploymentGroup
Eisen Geen
Functies Deze taak voldoet niet aan eventuele vereisten voor volgende taken in de taak.
Opdrachtbeperkingen Alle
Instelbare variabelen Alle
Agentversie 2.144.0 of hoger
Taakcategorie Implementeren
Vereiste Beschrijving
Pijplijntypen YAML, klassieke build, klassieke release
Wordt uitgevoerd op Agent, DeploymentGroup
Eisen Geen
Functies Deze taak voldoet niet aan eventuele vereisten voor volgende taken in de taak.
Opdrachtbeperkingen Alle
Instelbare variabelen Alle
Agentversie 2.102.0 of hoger
Taakcategorie Implementeren

Zie ook