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
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 argument3Ein 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.bashEin 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.| 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: |
| 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.
| 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:Die zurückgegebenen Tags sind JavaScript-Hashmap-Objekte, wobei jeder Key mit dem Präfix tag beginnt und mit dem Tag-Namen endet. |
SSH-Ausführungsbefehle konfigurieren
Verwenden Sie die von Ihnen erstellten Eingabevariablen, um den Befehl zu konfigurieren, den Orchestration auf dem Hostziel ausführt.
Vorbereitungen
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“.