SSH@0 – SSH v0-uppgift

Använd den här uppgiften för att köra shell-kommandon eller ett skript på en fjärrdator med hjälp av SSH. Med den här uppgiften kan du ansluta till en fjärrdator med hjälp av SSH och köra kommandon eller ett skript.

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.

Indata

sshEndpoint - SSH-tjänstanslutning
string. Krävs.

Anger namnet på en SSH-tjänstanslutning som innehåller anslutningsinformation för fjärrdatorn. Värdnamnet eller IP-adressen för fjärrdatorn, portnumret och användarnamnet krävs för att skapa en SSH-tjänstanslutning.

• Den privata nyckeln och lösenfrasen måste anges för autentisering.
• Ett lösenord kan användas för att autentisera till fjärranslutna Linux-datorer, men det stöds inte för macOS- eller Windows-system.

runOptions - Köra
string. Krävs. Tillåtna värden: commands, script (skriptfil) inline (infogat skript). Standardvärde: commands.

Kör shell-kommandon eller ett gränssnittsskript på fjärrdatorn.

commands - Kommandon
string. Krävs när runOptions = commands.

Anger vilka gränssnittskommandon som ska köras på fjärrdatorn. Den här parametern är endast tillgänglig när Kommandon har valts för alternativet Kör . Ange varje kommando tillsammans med dess argument på en ny rad i textrutan med flera rader. Om du vill köra flera kommandon tillsammans anger du dem på samma rad avgränsade med semikolon. Exempel: cd /home/user/myFolder;build.

Anteckning

Varje kommando körs i en separat process. Om du vill köra en serie kommandon som är beroende av varandra (till exempel ändra den aktuella mappen innan du kör ett kommando) använder du alternativet Infogat skript i stället.

scriptPath - Shell-skriptsökväg
string. Krävs när runOptions = script.

Anger sökvägen till shell-skriptfilen som ska köras på fjärrdatorn. Den här parametern är endast tillgänglig när Shell-skript har valts för alternativet Kör .

inline - Infogat skript
string. Krävs när runOptions = inline.

Skriver shell-skriptet som ska köras på fjärrdatorn.

interpreterCommand - Tolkkommando
string. Valfritt. Använd när runOptions = inline. Standardvärde: /bin/bash.

Anger sökvägen till den kommandotolk som används för att köra skriptet. Lägger till en shebang-rad i början av skriptet. Endast relevant för UNIX-liknande operativsystem. Använd en tom sträng för Windows-baserade fjärrvärdar. Läs mer om shebang (#!).

args - Argument
string. Valfritt. Använd när runOptions = script.

Anger argumenten som ska skickas till shell-skriptet. Den här parametern är endast tillgänglig när Shell-skript har valts för alternativet Kör .

failOnStdErr - Fel på STDERR
boolean. Standardvärde: true.

Om värdet är truemisslyckas bygget när fjärrkommandona eller skriptet skriver till STDERR.

interactiveSession - Aktivera interaktiv session
boolean. Standardvärde: false.

Startar en interaktiv session. Lösenordsbegäranden fylls i av användarens lösenord. Interaktiva sessioner kan vara användbara för att köra kommandon, till exempel sudo.

readyTimeout - Tidsgräns för SSH-handskakning
string. Krävs. Standardvärde: 20000.

Anger hur länge (i millisekunder) aktiviteten väntar på att SSH-handskakningen ska slutföras.

interactiveKeyboardAuthentication - Använda interaktiv tangentbordsautentisering
boolean. Standardvärde: false.

Aktiverar interaktiv tangentbordsautentisering. Ange till true om SSH-målservern kräver interaktiv tangentbordsautentisering (PasswordAuthentication är inaktiverad på måldatorn/inställd på Nej i sshd_config).

Kontrollalternativ för aktivitet

Alla aktiviteter har kontrollalternativ utöver sina aktivitetsindata. Mer information finns i Kontrollalternativ och vanliga uppgiftsegenskaper.

Utdatavariabler

Inga.

Kommentarer

Använd den här uppgiften för att köra shell-kommandon eller ett skript på en fjärrdator med hjälp av SSH. Med den här uppgiften kan du ansluta till en fjärrdator med hjälp av SSH och köra kommandon eller ett skript.

Förutsättningar

• Uppgiften stöder användning av ett SSH-nyckelpar för att ansluta till fjärrdatorerna.
• Den offentliga nyckeln måste vara förinstallerad eller kopierad till fjärrdatorerna.

Algoritmer som stöds

Nyckelparalgoritmer

• RSA
• DSA

Krypteringsalgoritmer

• aes256-cbc
• aes192-cbc
• aes128-cbc
• blåsfisk-cbc
• 3des-cbc
• arcfour256
• arcfour128
• cast128-cbc
• arcfour

För OpenSSL v1.0.1 och senare (på agent):

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

För OpenSSL v1.0.1 och senare, NodeJS v0.11.12 och senare (på agent):

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

Krav

Krav	Beskrivning
Pipelinetyper	YAML, klassisk version, klassisk version
Körs på	Agent, DeploymentGroup
Krav	Ingen
Funktioner	Den här aktiviteten uppfyller inte några krav för efterföljande uppgifter i jobbet.
Kommandobegränsningar	Valfri
Inställningsbara variabler	Valfri
Agentversion	2.206.1 eller senare
Uppgiftskategori	Distribuera

Se även

• Installera SSH-nyckeluppgift
• Kopiera filer via SSH
• Blogginlägg om SSH-bygguppgift