Port NULL 🛈¶
Stimulation¶
Dieser Port besitzt keine Stimulus-Fähigkeiten.
Eigenschaften 🛈¶
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
SSH-Host |
uri |
Adresse des SSH-Hosts |
|||
SSH-Port |
22 |
int |
Port, über den SSH am Host erreichbar ist |
||
SSH-Benutzername |
string |
Benutzername, mit dem per SSH das Kommando ausgeführt werden soll. |
|||
Authentisierungsmethode |
Keyfile |
[None, Password, Keyfile] Anzeigewerte:
|
string |
Methode, mit welcher sich beim Remote-System angemeldet wird. |
|
SSH-Schlüsselpfad |
Authentisierungsmethode: ‚Keyfile‘ |
string |
Pfad zum privaten SSH-Schlüssel für Public-Key-Authentifizierung. Kann absolut oder relativ zum Toolhost-Basispfad angegeben werden. Wurde kein Toolhost-Basispfad festgelegt, kann der Pfad relativ zum Workspace sein. Unterstützte Schlüsselformate: RSA, DSA, ECDSA und ED25519 |
||
SSH-Passwort |
Authentisierungsmethode: ‚Password‘ |
string |
Passwort des angegebenen Benutzers. Achtung, das Passwort wird unverschlüsselt in der TBC gespeichert! |
||
Verbindungsmodus |
Auto |
[Auto, Manual] Anzeigewerte:
|
string |
Legt fest, ob die SSH-Verbindung automatisch oder manuell per Portjob hergestellt wird. |
|
Dateiübertragungsprotokoll |
SFTP |
[SFTP, SCP] |
string |
Legt das Protokoll fest, welches bei der Übertragung von Dateien verwendet wird. Wenn möglich, sollte SFTP bevorzugt verwendet werden, da es sich um das stabilere und sicherere Protokoll handelt. |
Jobs 🛈¶
Connect¶
Stellt die SSH-Verbindung her. Falls die Verbindung bereits hergestellt ist wird nichts unternommen.
Disconnect¶
Trennt die SSH-Verbindung. Falls die Verbindung bereits getrennt ist wird nichts unternommen.
DownloadFileOrFolder¶
Kopiert eine Datei oder einen Ordner vom Remote-PC auf den lokalen Rechner.
Vorhandene Dateien werden dabei überschrieben.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
localPath |
string |
Lokaler Pfad in den die Remote-Dateien kopiert werden. Wird bei Bedarf angelegt. |
|||
remotePath |
string |
Datei oder Ordner auf dem Remote-PC, der kopiert wird. |
ExecuteInteractively¶
Hinweis: Wird nur für SSH-Hosts mit einer Linux-Distribution unterstützt.
Führt den angegebenen Ausdruck in einer interaktiven Session aus, wartet auf die davon erzeugte Ausgabe und gibt sie zurück. Im Unterschied zum Job „ExecuteSshCommand“ agieren damit alle Aufrufe dieses Jobs in der gleichen Shell; der Kontext (z.B. gesetzte Umgebungsvariablen, aktuelles Arbeitsverzeichnis) bleibt über alle Aufrufe erhalten. Zum Testfallende wird die Shell geschlossen.
Dieser Job arbeitet blockierend und kehrt in diesen Fällen zurück:
Der Befehl wurde vollständig (erfolgreich oder fehlerbehaftet) ausgeführt.
In der SSH-Ausgabe taucht ein konfigurierbarer String auf (z.B. „Passwort“ bei „sudo pwd“).
Der gesamte Aufruf dauert länger als ein einstellbarer Timeout. In diesem Fall wird ein Fehler geworfen.
In den ersten beiden Fällen werden die bisher erzeugten Ausgabezeilen der SSH-Shell wieder zurück gegeben.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
command |
string |
Kommando, welches auf dem Remote-PC ausgeführt werden soll. |
|||
returnAtText |
string |
Abbruchkriterium für Fall 2). Wenn nicht leer, wird die SSH-Ausgabe nach diesem String durchsucht und falls vorhanden wird der Job-Aufruf beendet. |
|||
timeout |
30 |
int |
Abbruchkriterium für Fall 3). Wirft einen Fehler, wenn der Aufruf nach der angegebenen Zeit in Sekunden noch nicht beendet ist. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
object |
Liste mit allen Zeilen des SSH-Shell-Outputs, die von der jeweiligen Eingabe hervorgerufen wurden. |
ExecuteSshCommand¶
Führt ein Kommando per SSH auf dem Remote-PC aus.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
command |
string |
Kommando, welches auf dem Remote-PC ausgeführt werden soll. Das Kommando wird in einer eigenen Session ausgeführt, welche nach dem Aufruf wieder geschlossen wird. Mehrfache Aufrufe des Jobs sind daher unabhängig voneinander. Das Kommando wird in einer Umgebung ausgeführt, die weder interaktiv noch eine Login-Shell ist. Daher werden keine Shell-Umgebungsvariablen geladen. |
|||
nonBlocking |
False |
[False, True] |
bool |
Wenn True, kehrt der Job-Aufruf sofort zurück und gibt für stdout und stderr nur leere Listen zurück. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
object |
Tupel, aus den beiden Standarddatenströmen stdout und stderr. Für jeden der Datenströme enthält das Tupel eine Liste aller zugehöriger Zeilen. |
IsConnected¶
Gibt an, ob die SSH-Verbindung hergestellt ist.
Parametrierung
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
[False, True] |
bool |
UploadFileOrFolder¶
Kopiert eine Datei oder einen Ordner vom lokalen Rechner auf den Remote-PC.
Vorhandene Dateien werden dabei überschrieben.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
localPath |
string |
Datei oder Ordner auf dem lokalen PC, der kopiert wird. |
|||
remotePath |
string |
Remote-Pfad in den die lokalen Dateien kopiert werden. Wird bei Bedarf angelegt. |