Erstellen Sie eine SSH-Aktivität

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 5 Minuten Lesedauer
  • Erstellen Sie eine Aktivität, die Daten aus einem Zielhost extrahiert, der das SSH-Netzwerkprotokoll verwendet.

    Vorbereitungen

    Erforderliche Rolle: Activity_Creator oder Workflow_admin

    Warum und wann dieser Vorgang ausgeführt wird

    Anweisungen zur Verwendung des Aktivitätsvorlagen-Prozess-Flows finden Sie unter Erstellen Sie anwenderdefinierte Aktivitäten .

    Prozedur

    1. Erstellen Sie ein Anwenderdefinierte Aktivität .
      Mit dieser Aktion wird eine anwenderdefinierte Aktivität mithilfe einer Vorlage erstellt.
    2. Nach dem Einrichten Allgemeine Eigenschaften Und Eingabevariablen werden erstellt , Konfigurieren Sie den SSH-Ausführungsbefehl.
      OptionBezeichnung
      Ordnen Sie die Eingabevariablen zu Verwenden Sie die von Ihnen erstellten Variablen, um den Befehl zu konfigurieren, den Orchestration ausführt.
      Ziel-Host Hostname oder IP-Adresse des Zielservers für diese Aktivität.
      Befehl Befehl, der diese Aktivität auf dem Zielhost ausgeführt wird. Sie können ein MID-Serverskript über dieses Feld mit einem beliebigen Skripttyp aufrufen, den die SSH-Befehlszeile unterstützt. Weitere Informationen finden Sie unter Erweiterte SSH-Skriptoptionen Unter der Tabelle.
      Verzeichnis Verzeichnis auf dem Zielhost, auf dem der Befehl ausgeführt wird
      Anmeldeinformations-Tag Das Orchestration-Anmeldeinformations-Tag, das bei der Ausführung des Befehls verwendet werden soll.
      Erforderliche MID-Serverfähigkeiten MID-Server mit den entsprechenden Fähigkeiten zum Herstellen einer Verbindung mit dem Host. Standardmäßig wählt das System einen MID-Server mit SSH-Fähigkeiten aus.
      Lange ausgeführt Wenn diese Option aktiviert ist, wird die SSH-Verbindungszeitüberschreitung für Befehle deaktiviert, deren Ausführung länger als die standardmäßigen 60 Sekunden dauern kann. Orchestration überprüft regelmäßig den laufenden Prozess, um seinen Status zu bestimmen, bis er abgeschlossen ist.
      Muss Sudo Sein Wenn diese Option aktiviert ist, wird die Verwendung von aktiviert Sudo Zum Ausführen von Befehlen.
      Hinweis:
      Sie können Parameterwerte in einer Testnutzlast Variablen in zuordnen Ausgaben Automatisch Registerkarte. Siehe Ausgabevariablen automatisch zuordnen .

    Erweiterte SSH-Skriptoptionen

    Zum Ausführen von MID-ServerSkript auf dem Zielhost, geben Sie den Skripttyp an, und übergeben Sie den Namen des Skripts an ${syncFile()} Parameter. Das System verwendet diesen Parameter, um das benannte Skript in der Tabelle „MID-Serverskriptdatei“ [ecc_agent_script_file] zu suchen und es auf dem Zielhost auszuführen. Ein Bash-Skript kann beispielsweise folgendermaßen ausgedrückt werden:
    bash ${syncFile("<MID script name>")} argument1 argument2 argument3
    Ein Basisskript ( Main_script.bash ) Kann auf ein anderes Skript verweisen ( My_include.bash ) Sowie eine separate Datei ( .Mein_Profil ) Befindet sich auf dem Zielhost. Sowohl Skripts als auch die referenzierte Datei müssen mit synchronisiert werden MID-Server, Mit ${syncFile()} Parameter, zur ordnungsgemäßen Ausführung.
    source ${syncFile(".my_profile")}
    cp ${syncFile("my_include.bash")} /usr/ssmith/my_include.bash
    bash ${syncFile("main_script.bash")} one two three four five six 
    rm /usr/ssmith/my_include.bash
    Ein Python-Beispiel mit Inline-Kommentaren könnte wie folgt aussehen:
    set $LIB_DIR=/usr/bin;. 
    # Sync a file that is referenced inside myF5CreateLBPool.py 
    cp ${syncFile("specialFunctions.py")} ~/specialFunctions.py 
    # set up environment variables 
    source ${syncFile(".python_profile")} 
    # call script that sets up dependencies on the box from remote package repos 
    python ${syncFile("setupPythonDependencies.py")} pycontrol 
    # call a script that requires functions from the package as well as a function from myIncludedFile 
    python ${syncFile("myF5CreateLBPool.py")} snow_pool myActualValue 
    # user is responsible for their own cleanup 
    rm ~/specialFunctions.py 

    Nächste Maßnahme

    SSH-Vorlagenausführungsparameter

    Verwenden Sie Ausführungsparameter, um das Eingabeprozessskript in zu erstellen Vorverarbeitung Formular des Aktivitätendesigners.

    Beschreibungen der Befehlsfelder finden Sie unter Konfigurieren Sie den SSH-Ausführungsbefehl.
    Hinweis:
    Sie müssen verwenden ExecutionParameter. Präfix mit allen Variablen in dieser Tabelle.
    Tabelle : 1. SSH-Ausführungsparameter
    Name Variable Typ Nutzung
    Quelle Quelle Zeichenfolge Beabsichtigtes Ziel oder Host.
    Befehl command Zeichenfolge Kommentar, der auf dem Host ausgeführt werden soll.
    Verzeichnis Verzeichnis Zeichenfolge Verzeichnis auf dem Host, in dem der Befehl ausgeführt werden soll.
    Anmeldeinformations-Tag Credential_Tag Zeichenfolge Orchestration-Anmeldeinformations-Tag, das bei der Ausführung des Befehls verwendet werden soll.
    MidCapabilities MidCapabilities Zeichenfolge (kommagetrennt) Liste der erforderlichen MID-Serverfähigkeiten.
    Wertfähigkeiten Wertfähigkeiten Array von Hashmap Fähigkeitswerte, die zum Auswählen des MID-Servers verwendet werden. Weitere Informationen finden Sie unter MID-Serverfähigkeiten . Wenn zusätzliche Fähigkeiten vorhanden sind, die nach Wert zugewiesen werden, verwenden Sie dieses Beispiel, um die MID-Serverauswahl anzupassen:
    var valueCapability = {'NEW_MID_CAPABIILTY':'NEW_MID_CAPABILITY_VALUE'};
    executionParam.valueCapabilities.push(valueCapability);
    Lange ausgeführt Long_running Boolean Gibt an, ob der Befehl lange ausgeführt wird. Der Wert „wahr“ gibt an, dass der Befehl lange ausgeführt wird.
    Muss sudo Muss_sudo Boolean Gibt an, ob diese Aktivität sudo zum Ausführen von Stammbefehlen verwenden muss. Der Wert „wahr“ gibt das an Sudo SSH-Anmeldeinformationen Muss verwendet werden.

    SSH-Nachverarbeitungsparameter und Nutzlastanalyse

    Verwenden Sie diese Parameter, um ein Nachverarbeitungsskript, eine Nutzlastanalyse und ein Tagging zu erstellen.

    Tabelle : 2. SSH-Nachverarbeitungsparameter
    Name Variable Typ Nutzung
    Ausgabe Ausgabe Zeichenfolge Enthält die vom SSH-Befehl zurückgegebene Ausgabe.
    EccSysID EccSysID Zeichenfolge Enthält die Referenz-ID, die der von der Aktivität zurückgegebenen ECC-Warteschlangeneingabenachricht zugeordnet ist.
    Fehlernachrichten errorMessages Zeichenfolge Enthält die vom SSH-Befehl abgerufenen Fehlermeldungen. Dieser Wert ist Null Wenn keine Fehlermeldungen vorhanden sind.
    Tags tags HashMap der Tag-Werte, die vom SSH-Befehl zurückgegeben werden Enthält die Tags, die zum Extrahieren der Ausgabe mit den SSH-Befehlen verwendet werden. Die Tag-Ausgabe wird durch doppelte Prozentzeichen getrennt, wie in %%tagname%% … %% . Richten Sie den Befehl im folgenden Format ein:
    %%tagname1%%
    output1 line 1
    output1 line 2
    …
    %%
    
    %%tagname2%%
    output2 line 1
    output2 line 2
    …
    %%
    Die zurückgegebenen Tags sind JavaScript-Hashmap-Objekte, in denen jedem Schlüssel ein Präfix vorangestellt ist Tag Mit dem Tagnamen angehängt.
    {"__text__": "", 
    "tagtagname1":"output1 line1\noutput1 line2\n", 
    "tagtagname2":"output2 line1\noutput2 line2\n"}

    Konfigurieren Sie den SSH-Ausführungsbefehl

    Verwenden Sie die von Ihnen erstellten Eingabevariablen, um den Befehl zu konfigurieren, den Orchestration für das Hostziel ausführt.

    Vorbereitungen

    Erstellen Sie die Eingabevariablen, die Sie benötigen, in Eingaben Formular, bevor Sie mit fortfahren Ausführungsbefehl Phase.

    Erforderliche Rolle: Activity_Creator, Administrator

    Hinweis:
    Sie können die SSH-Verbindung zwischen dem MID-Server und dem Ziel testen, ohne die Aktivität in einem Workflow-Kontext ausführen zu müssen. Details finden Sie unter Testvorlagenausgaben.

    Prozedur

    1. Ziehen Sie Variablen aus der Liste der Eingaben, und legen Sie sie in Befehlsfelder ab.
      Das System formatiert die Variable in der richtigen Syntax für den Befehl.
      Abbildung : 1. SSH-Ausführungsbefehl
      SSH-Ausführungsbefehl
    2. Füllen Sie die in der Tabelle angezeigten Felder aus.
      Tabelle : 3. SSH-Aktivitätseingaben
      Feld Beschreibung
      Eingabe Eingabevariablengenerator. Erstellen Sie EingabevariablenZum Zuordnen zu verfügbaren Feldern.
      Ziel-Host Hostname oder IP-Adresse des Zielservers für diese Aktivität.
      Befehl Befehl, der diese Aktivität auf dem Zielhost ausgeführt wird.

      Sie können ein MID-Serverskript über dieses Feld mit einem beliebigen Skripttyp aufrufen, der von der SSH-Befehlszeile unterstützt wird. Weitere Informationen finden Sie unter Erweiterte SSH-Skriptoptionen Unter der Tabelle.

      Verzeichnis Verzeichnis auf dem Zielhost, auf dem der Befehl ausgeführt wird
      Anmeldeinformations-Tag Die Anmeldeinformationsaliasse für Orchestration-Aktivitäten Zur Verwendung beim Ausführen des Befehls.
      Wählen Sie MID-Server nach Fähigkeiten aus MID-Server mit den entsprechenden Fähigkeiten zum Herstellen einer Verbindung mit dem Host. Standardmäßig wählt das System einen MID-Server mit SSH-Fähigkeiten aus
      Lange ausgeführt Kontrollkästchen zum Deaktivieren der SSH-Verbindungszeitüberschreitung für Befehle, deren Ausführung länger als die standardmäßigen 60 Sekunden dauern kann. Orchestration überprüft regelmäßig den laufenden Prozess, um seinen Status zu bestimmen, bis er abgeschlossen ist.
      Muss Sudo Sein Kontrollkästchen, um die Verwendung von zuzulassen SSH-Anmeldeinformationen Zum Ausführen von Befehlen.
    3. Klicken Sie auf Speichern.
    4. Klicken Sie Auf Fahren Sie Fort Um zu weiterzufahren Ausgaben Phase.