SSH@0 - SSH v0-taak

Gebruik deze taak om shellopdrachten of een script uit te voeren op een externe computer 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.

Syntaxis

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

Invoer

sshEndpoint - SSH-serviceverbinding
string. Verplicht.

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. Verplicht. 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 op de externe computer moeten worden uitgevoerd. Deze parameter is alleen beschikbaar wanneer Opdrachten is geselecteerd voor de optie uitvoeren. Voer elke opdracht samen met de 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. Voorbeeld: cd /home/user/myFolder;build.

Notitie

Elke opdracht wordt uitgevoerd in een afzonderlijk proces. Als u een reeks opdrachten wilt uitvoeren die afhankelijk zijn van elkaar (bijvoorbeeld het wijzigen van de huidige map voordat u een opdracht uitvoert), gebruikt u in plaats daarvan de optie inlinescript.

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 shell-script dat moet worden uitgevoerd op de externe computer.

opdrachtinterpreterCommand - interpreter
string. Facultatief. Gebruiken wanneer runOptions = inline. Standaardwaarde: /bin/bash.

Hiermee geeft u het pad naar de opdracht-interpreter 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 Hosts op basis van Windows. Meer informatie over shebang (#!).

args - argumenten
string. Facultatief. Gebruiken wanneer runOptions = script.

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

failOnStdErr - mislukt op STDERR-
boolean. Standaardwaarde: true.

Als de waarde trueis, mislukt de build wanneer de externe opdrachten of het schrijven van scripts naar STDERR.

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. Verplicht. Standaardwaarde: 20000.

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

interactiveKeyboardAuthentication - Interactieve toetsenbordverificatie gebruiken
boolean. Standaardwaarde: false.

Hiermee schakelt u interactieve toetsenbordverificatie in. Ingesteld op true als voor de doel-SSH-server interactieve toetsenbordverificatie is vereist (PasswordAuthentication is uitgeschakeld op de doelcomputer/is ingesteld op Nee in sshd_config).

Opties voor taakbeheer

Alle taken hebben besturingsopties naast hun taakinvoer. Zie Opties en algemene taakeigenschappenvoor meer informatie.

Uitvoervariabelen

Geen.

Opmerkingen

Gebruik deze taak om shellopdrachten of een script uit te voeren op een externe computer 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.

Benodigdheden

• De taak ondersteunt het gebruik van een SSH-sleutelpaar om verbinding te maken met de externe computer(s).
• De openbare sleutel moet vooraf worden 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

Voorwaarde	Beschrijving
Pijplijntypen	YAML, klassieke build, klassieke release
Wordt uitgevoerd op	Agent, DeploymentGroup
eisen	Geen
mogelijkheden	Deze taak voldoet niet aan de vereisten voor volgende taken in de taak.
opdrachtbeperkingen	Welk dan ook
variabelen instellen	Welk dan ook
Agentversie	2.206.1 of hoger
Taakcategorie	Implementeren

Zie ook

• SSH-sleuteltaak installeren
• Bestanden kopiëren via SSH-
• Blogbericht SSH-buildtaak