Zum Hauptinhalt springen

Ausführen Python-Skript

Aktuelle Konfiguration des Tasks `Run Script Python` im Workflow Designer

Die Aufgabe Python-Skript ausführen ermöglicht es, Python-Skripte auszuführen, indem konfiguriert wird, ob die Ausführung lokal oder auf einem Remote-System erfolgt, und dabei die Verbindungseinstellungen sowie das zu auszuführende Skript definiert werden.

Konfiguration​

Der Tab Konfiguration ist das Herzstück der Aufgabe und gliedert sich in zwei Untertabs: Verbindung und Skript.

Untertab „Verbindung”​

Dieser Abschnitt ermöglicht die Definition, wie die Aufgabe mit dem System verbunden wird, auf dem das Python-Skript ausgeführt werden soll. Die Konfiguration variiert je nach ausgewogener „Verbindungstyp“.

Verbindungstyp​

Dieses Menü ermöglicht die Auswahl zwischen verschiedenen Verbindungsmethoden:

Standard:​

  • Beschreibung: Verwendet eine vordefinierte Verbindungskonfiguration auf System- oder Projektebene. Es sind keine spezifischen Konfigurationsfelder sichtbar, da die Einstellungen vererbt werden.
Manuell:​
  • Beschreibung: Ermöglicht die manuelle Definition aller Verbindungsparameter für die Skriptausführung.
  • Spezifische Felder:
  • IP-Adresse: Die IP-Adresse des Remote-Servers, auf dem das Skript ausgeführt wird.
  • Hostname: Der Hostname des Remote-Servers. Kann alternativ zur IP-Adresse verwendet werden.
  • Benutzer: Der Benutzername für den Zugriff auf den Remote-Server.
  • SSH-Schlüssel: Eine Checkbox zur Aktivierung der Authentifizierung mittels SSH-Schlüssel. Bei Auswahl wird in der Regel ein Feld zur Schlüsselwahl aktiviert.
  • Passwort: Ein Button „Passwort festlegen“, der ein sicheres Dialogfeld öffnet, um das Benutzerpasswort einzugeben.
  • Port: Der Port für die SSH-Verbindung.
  • Python-Executable: Der Name des Python-Executables auf dem Zielsystem (z. B. python3).
  • Virtuelle Umgebung: Eine Checkbox, die bei Auswahl die Nutzung einer Python-virtuellen Umgebung aktiviert.
Umgebung:​
  • Beschreibung: Ermöglicht die Auswahl einer zuvor als „Umgebung“ gespeicherten Verbindungskonfiguration. Dies ist nützlich, um Satz von Verbindungsparametern wiederzuverwenden.
  • Spezifische Felder:
  • Umgebungsverbindung: Ein Menü zur Auswahl aus gespeicherten Umgebungskonfigurationen (z. B. „SSH Test“).
  • Hinweis: Sobald eine Umgebung ausgewählt wurde, werden die darunter liegenden Felder (IP-Adresse, Hostname, Benutzer usw.) mit den Werten der gewählten Umgebung vorausgefüllt.

Untertab „Skript”​

Dieser Abschnitt ist für die Eingabe und Verwaltung des zu ausführenden Python-Codes vorgesehen.

Python-Editor​

  • Beschreibung: Ein integrierter Texteditor, in dem der zu ausführende Python-Code direkt geschrieben oder eingefügt werden kann.
  • Verwendung: Der hier eingegebene Code wird auf dem in der Untertab „Verbindung“ angegebenen System ausgeführt, unter Verwendung des konfigurierten Python-Executables.

Die Konfigurationsfelder der Aufgabe können manuell oder über Workflow-Parameter und -Variablen. befüllt werden.

Ausgabeparameter​

Nach Abschluss der Ausführung stellt die Aufgabe die folgenden Ausgabeparameter bereit, die als Eingabe in nachfolgende Workflow-Aufgaben verwendet werden können.

  • result: Enthält eine Textnachricht, die das Ergebnis des Skripts oder eine Fehlermeldung beschreibt (z. B. „Missing server address“).
  • resultJson: Stellt das Ergebnis der Aufgaben-Ausführung im JSON-Format dar und enthält allgemeine Informationen, Konfigurationen und Details zur Ausführung.
  • content: gibt den in das Feld Skript geschriebenen Python-Code zurück.