SSH-Aktivitäten erstellen

Erstellen Sie eine Aktivität, die das SSH-Netzwerkprotokoll verwendet, um Daten von einem Zielhost zu extrahieren.

Vorbereitungen

Erforderliche Rolle: activity_creator oder workflow_admin

Warum und wann dieser Vorgang ausgeführt wird

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

Prozedur

1. Erstellen Sie eine benutzerdefinierte Aktivität.
   Diese Aktion erstellt eine benutzerdefinierte Aktivität mithilfe einer Vorlage.
2. Nach dem Einrichten Allgemeine Eigenschaften Und Eingabevariablen werden erstellt , Konfigurieren Sie den SSH-Ausführungsbefehl.

   Option	Bezeichnung
   Ordnen Sie die Eingabevariablen zu	Verwenden Sie die von Ihnen erstellten Variablen, um den Befehl zu konfigurieren, den Orchestration ausführt.
   Zielhost	Hostname oder IP-Adresse des Zielservers für diese Aktivität
   Befehl	Befehl, mit dem diese Aktivität auf dem Zielhost ausgeführt wird. Sie können ein MID-Server-Skript aus diesem 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
   Anmelde-Tag	Das Orchestration-Anmeldeinformations-Tag, das bei der Ausführung des Befehls verwendet werden soll.
   Erforderliche MID Server-Fähigkeiten	MID-Server mit den entsprechenden Fähigkeiten für die Verbindung mit dem Host. Standardmäßig wählt das System einen MID-Server mit SSH-Fähigkeiten aus.
   Lang laufend	Wenn diese Option aktiviert ist, wird die SSH-Verbindungszeitüberschreitung für Befehle deaktiviert, die möglicherweise länger als die standardmäßigen 60 Sekunden dauern. Orchestration überprüft regelmäßig den laufenden Prozess, um seinen Status zu bestimmen, bis er abgeschlossen ist.
   Sudo erforderlich	Wenn diese Option aktiviert ist, wird die Verwendung von aktiviert Sudo Zum Ausführen von Befehlen.

   Hinweis:

   Sie können Parameterwerte in einem Test-Payload Variablen auf der Registerkarte Ausgaben automatisch zuordnen. Siehe Ausgabevariablen automatisch zuordnen.

Erweiterte SSH-Skriptoptionen

Zum Ausführen von MID-Server Skript 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

• Verwenden Sie die automatische Zuordnung, um Ausgaben und Analyseregeln zu generieren.
• Wenn Sie die automatische Zuordnung nicht verwenden, können Sie Ausgabevariablen und Analyseregeln manuell erstellen.

Ausführungsparameter für SSH-Vorlagen

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

Beschreibungen der Befehlsfelder finden Sie unter SSH-Ausführungsbefehle konfigurieren.

Hinweis:

Sie müssen das Präfix executionParam. mit allen Variablen in dieser Tabelle verwenden.

Tabelle : 1. SSH-Ausführungsparameter

Name	Variable	Typ	Verwendung
Quelle	source	Zeichenfolge	Vorgesehenes Ziel oder vorgesehener Host
Befehl	command	Zeichenfolge	Auf dem Host auszuführender Befehl
Verzeichnis	directory	Zeichenfolge	Verzeichnis auf dem Host, in dem der Befehl ausgeführt werden soll
Anmelde-Tag	credential_tag	Zeichenfolge	Orchestration-Anmeldeinformations-Tag, das bei der Ausführung des Befehls verwendet werden soll.
MidCapabilities	midCapabilities	Zeichenfolge (durch Kommas getrennt)	Liste der erforderlichen MID-Server-Fähigkeiten
ValueCapabilities	valueCapabilities	Hashmap-Array	Fähigkeitswerte, die zum Auswählen des MID-Servers verwendet werden. Weitere Informationen finden Sie unter MID Server-Fähigkeiten. Verwenden Sie dieses Beispiel, um die Auswahl des MID-Servers anzupassen, wenn zusätzliche Fähigkeiten nach Wert zugewiesen werden: var valueCapability = {'NEW_MID_CAPABIILTY':'NEW_MID_CAPABILITY_VALUE'}; executionParam.valueCapabilities.push(valueCapability);
Lang laufend	long_running	Boolean	Gibt an, ob die Befehlsausführung lange Zeit in Anspruch nimmt oder nicht. Der Wert „wahr“ gibt an, dass der Befehl lange ausgeführt wird.
Muss sudo sein	must_sudo	Boolean	Gibt an, ob diese Aktivität Sudo verwenden muss, um Root-Befehle auszuführen. Ein Wert von „wahr“ gibt an, dass an Sudo SSH-Anmeldeinformationen Muss verwendet werden.

SSH-Nachverarbeitungsparameter und Analyse des Payload

Verwenden Sie diese Parameter, um ein Nachverarbeitungsskript und eine Payload-Analyse zu erstellen sowie ein Tagging vorzunehmen.

Tabelle : 2. SSH-Nachverarbeitungsparameter

Name	Variable	Typ	Verwendung
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 Eingabenachricht der ECC-Warteschlange zugeordnet ist
ErrorMessages	errorMessages	Zeichenfolge	Enthält die vom SSH-Befehl abgerufenen Fehlermeldungen. Dieser Wert ist null, wenn keine Fehlermeldungen vorhanden sind.
Tags	tags	Hashmap der vom SSH-Befehl zurückgegebenen Tag-Werte.	Enthält die Tags, die zum Extrahieren der Ausgabe mithilfe der SSH-Befehle verwendet werden. Die Tag-Ausgabe wird durch doppelte Prozentzeichen begrenzt, wie z. B. %%tagname%% … %%. Geben Sie den Befehl in folgendem Format an: %%tagname1%% output1 line 1 output1 line 2 … %% %%tagname2%% output2 line 1 output2 line 2 … %% Die zurückgegebenen Tags sind JavaScript-Hashmap-Objekte, wobei jeder Key mit dem Präfix tag beginnt und mit dem Tag-Namen endet. {"__text__": "", "tagtagname1":"output1 line1\noutput1 line2\n", "tagtagname2":"output2 line1\noutput2 line2\n"}

SSH-Ausführungsbefehle konfigurieren

Verwenden Sie die von Ihnen erstellten Eingabevariablen, um den Befehl zu konfigurieren, den Orchestration auf dem Hostziel ausführt.

Vorbereitungen

Erstellen Sie im Formular Eingaben die benötigten Eingabevariablen, bevor Sie mit der Stufe Ausführungsbefehl fortfahren.

Erforderliche Rolle: activity_creator, admin

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 dazu finden Sie unter „Vorlagenausgaben testen“.

Prozedur

1. Ziehen Sie Variablen aus der Liste der Eingaben, und legen Sie sie in den Befehlsfeldern ab.
   Das System formatiert die Variablen in der richtigen Syntax für den Befehl.

   Abbildung : 1. SSH-Ausführungsbefehl

   

2. Füllen Sie die in der Tabelle angegebenen Felder aus.

   Tabelle : 3. Eingaben für die SSH-Aktivität

   Feld	Beschreibung
   Eingabe	Generator für Eingabevariablen. Eingabevariablen erstellen, um sie verfügbaren Feldern zuzuordnen.
   Zielhost	Hostname oder IP-Adresse des Zielservers für diese Aktivität
   Befehl	Befehl, mit dem diese Aktivität auf dem Zielhost ausgeführt wird. Sie können ein MID-Server-Skript aus diesem 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
   Anmelde-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 für die Verbindung mit dem Host. Standardmäßig wählt das System einen MID-Server mit SSH-Fähigkeiten aus
   Lang laufend	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.
   Sudo erforderlich	Kontrollkästchen, um die Verwendung von zuzulassen SSH-Anmeldeinformationen Zum Ausführen von Befehlen.

3. Klicken Sie auf Speichern.
4. Klicken Sie auf Fortsetzen, um mit der Stufe Ausgaben fortzufahren.