SSH@0 — zadanie SSH v0

Artykuł
06/11/2024

To zadanie służy do uruchamiania poleceń powłoki lub skryptu na maszynie zdalnej przy użyciu protokołu SSH. To zadanie umożliwia nawiązywanie połączenia z maszyną zdalną przy użyciu protokołu SSH i uruchamiania poleceń lub skryptu.

Składnia

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

Dane wejściowe

sshEndpoint - Połączenie z usługą SSH
string. Wymagane.

Określa nazwę połączenia usługi SSH zawierającego szczegóły połączenia dla maszyny zdalnej. Nazwa hosta lub adres IP maszyny zdalnej, numer portu i nazwa użytkownika są wymagane do utworzenia połączenia usługi SSH.

Do uwierzytelniania należy określić klucz prywatny i hasło.
Hasło może służyć do uwierzytelniania na zdalnych maszynach z systemem Linux, ale nie jest to obsługiwane w systemach macOS lub Windows.

runOptions - Uruchomić
string. Wymagane. Dozwolone wartości: commands, script (Plik skryptu), inline (Wbudowany skrypt). Wartość domyślna: commands.

Uruchamia polecenia powłoki lub skrypt powłoki na maszynie zdalnej.

commands - Polecenia
string. Wymagane, gdy runOptions = commands.

Określa polecenia powłoki do uruchomienia na maszynie zdalnej. Ten parametr jest dostępny tylko wtedy, gdy dla opcji Uruchom wybrano opcję Uruchom polecenia. Wprowadź każde polecenie wraz z jego argumentami w nowym wierszu pola tekstowego wielowierszowego. Aby uruchomić wiele poleceń razem, wprowadź je w tym samym wierszu oddzielonym średnikami. Przykład: cd /home/user/myFolder;build.

Uwaga

Każde polecenie jest uruchamiane w osobnym procesie. Jeśli chcesz uruchomić serię poleceń, które są współzależne (na przykład zmiana bieżącego folderu przed wykonaniem polecenia), użyj opcji Skrypt wbudowany .

scriptPath - Ścieżka skryptu powłoki
string. Wymagane, gdy runOptions = script.

Określa ścieżkę do pliku skryptu powłoki do uruchomienia na maszynie zdalnej. Ten parametr jest dostępny tylko wtedy, gdy dla opcji Uruchom wybrano skrypt powłoki.

inline - Wbudowany skrypt
string. Wymagane, gdy runOptions = inline.

Zapisuje skrypt powłoki do uruchomienia na maszynie zdalnej.

interpreterCommand - Interpreter , polecenie
string. Opcjonalny. Użyj polecenia , gdy runOptions = inline. Wartość domyślna: /bin/bash.

Określa ścieżkę do interpretera poleceń używanego do wykonywania skryptu. Dodaje wiersz shebang na początku skryptu. Dotyczy tylko systemów operacyjnych przypominających system UNIX. Użyj pustego ciągu dla hostów zdalnych opartych na systemie Windows. Dowiedz się więcej o shebang (#!).

args - Argumenty
string. Opcjonalny. Użyj polecenia , gdy runOptions = script.

Określa argumenty, które mają być przekazywane do skryptu powłoki. Ten parametr jest dostępny tylko wtedy, gdy dla opcji Uruchom wybrano skrypt powłoki.

failOnStdErr - Niepowodzenie w usłudze STDERR
boolean. Wartość domyślna: true.

Jeśli wartość to true, kompilacja kończy się niepowodzeniem, gdy polecenia zdalne lub skrypt zapisują w pliku STDERR.

interactiveSession - Włączanie sesji interakcyjnej
boolean. Wartość domyślna: false.

Rozpoczyna sesję interaktywną. Żądania haseł są wypełniane hasłem użytkownika. Sesje interaktywne mogą być przydatne w przypadku uruchamiania poleceń, takich jak sudo.

readyTimeout - Limit czasu uzgadniania SSH
string. Wymagane. Wartość domyślna: 20000.

Określa, jak długo (w milisekundach) zadanie czeka na ukończenie uzgadniania SSH.

interactiveKeyboardAuthentication - Korzystanie z uwierzytelniania za pomocą klawiatury interakcyjnej
boolean. Wartość domyślna: false.

Włącza uwierzytelnianie interakcyjne za pomocą klawiatury. Ustaw wartość true , jeśli docelowy serwer SSH wymaga uwierzytelniania za pomocą klawiatury interakcyjnej (PasswordAuthentication jest wyłączony na maszynie docelowej/ustawić wartość Nie w sshd_config).

Opcje sterowania zadania

Wszystkie zadania mają opcje sterowania oprócz danych wejściowych zadań. Aby uzyskać więcej informacji, zobacz Opcje sterowania i typowe właściwości zadań.

Zmienne wyjściowe

Brak.

Uwagi

Wymagania wstępne

Zadanie obsługuje używanie pary kluczy SSH do nawiązywania połączenia z maszynami zdalnymi.
Klucz publiczny musi być wstępnie zainstalowany lub skopiowany do maszyn zdalnych.

Obsługiwane algorytmy

Algorytmy par kluczy

Algorytmy szyfrowania

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

W przypadku programu OpenSSL w wersji 1.0.1 lub nowszej (na agencie):

aes256-ctr
aes192-ctr
aes128-ctr

W przypadku programu OpenSSL w wersji 1.0.1 lub nowszej węzeł NodeJS w wersji 0.11.12 lub nowszej (na agencie):

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

Wymagania

Wymaganie	Opis
Typy potoków	YAML, kompilacja klasyczna, wersja klasyczna
Działa na	Agent, DeploymentGroup
Wymagania	Brak
Możliwości	To zadanie nie spełnia żadnych wymagań dotyczących kolejnych zadań w zadaniu.
Ograniczenia poleceń	Dowolne
Zmienne w formie tabeli settable	Dowolne
Wersja agenta	2.206.1 lub nowsza
Kategoria zadania	Wdróż

Wymaganie	Opis
Typy potoków	YAML, kompilacja klasyczna, wersja klasyczna
Działa na	Agent, DeploymentGroup
Wymagania	Brak
Możliwości	To zadanie nie spełnia żadnych wymagań dotyczących kolejnych zadań w zadaniu.
Ograniczenia poleceń	Dowolne
Zmienne w formie tabeli settable	Dowolne
Wersja agenta	2.144.0 lub nowsza
Kategoria zadania	Wdróż

Wymaganie	Opis
Typy potoków	YAML, kompilacja klasyczna, wersja klasyczna
Działa na	Agent, DeploymentGroup
Wymagania	Brak
Możliwości	To zadanie nie spełnia żadnych wymagań dotyczących kolejnych zadań w zadaniu.
Ograniczenia poleceń	Dowolne
Zmienne w formie tabeli settable	Dowolne
Wersja agenta	2.102.0 lub nowsza
Kategoria zadania	Wdróż

Udostępnij za pośrednictwem