Post on 11-May-2018
transcript
Eventscripts- was passiert wann? -
OS4X - Eventscripts• Events (Ereignisse) werden zu vielen
Situationen aus OS4X gerufen
• Konfigurierbar (wird beim Start der Daemons eingelesen sowie bei Signalverarbeitung
• Jegliches Executable nutzbar (Shell-Script, Binaries, PHP, Java, ...)
• Prüfung der Daemons auf Ausführbarkeit. Wenn nicht existent oder nicht ausführbar wird die Konfiguration verworfen
• Events verfügbar für:
• Start Session, Ende Session
• Start Senden, Ende Senden
• Start Empfangen, Ende Empfangen
• xERP
• Send-Queue-Eintrag blockiert
• Debug-Daemon-Dump
• License High Water Mark
• Softwareupdate
• Zertifikat-Import
• Enqueue-Post-Script
OS4X - Eventscripts
• Dokumentation aller Parameter im Wiki (bequem erreichbar über "i"-Link der Config)
• Vereinbarung: es werden niemals Parameter entfernt oder vertauscht, nur weitere hinzugefügt
• Parameter mit Leerzeichen beachten! (virt. Filename, SFIDs, Partnerkurzname etc.)
• Errorcodes beachten! Errorcode 0 bedeutet "erfolgreich"
• Alle Scripte (bis auf Start-Receive) werden im Hintergrund ausgeführt! Schnelles Forking beachten (z.b. beim Blocked-Script).
• SWAN ab 2010.1 benötigt keine Event-Scripts mehr (tiefe Integration mittels OS4X in SWAN-Datenbank).
OS4X - Eventscripts
• sämtliche OS4X-Umgebungsvariablen sind in Event-Scripts verfügbar. Diese sind im Wiki dokumentiert und werden ggf. erweitert.
• OS4X_CFGFILE: OS4X Configfile
• OS4X_IN_DIR: Eingangsverzeichnis
• OS4X_OUT_DIR: Ausgangsverzeichnis
• OS4X_TMP_DIR: temporäres Datenverzeichnis
• OS4X_BIN_DIR: Installationsverzeichnis der Binaries
• OS4X_SCRIPT_DIR: Script-Installationsverzeichnis
• OS4X_BACKUP_DIR: Backup-Verzeichnis
• RAND_FILE: konfigurierte Entropie-Datei
• OPENSSL_BIN: konfiguriertes openSSL-Binary
• RRDTOOL_BIN: konfiguriertes RRD-Tool
• RRDB_DATAPATH: Pfad zu RRD-Daten
• OS4X_WEBGUI_DIR: Installationsverzeichnis der Admin-Web-GUI
• CA_PATH: Pfad zum Trusted certificate-Verzeichnis
OS4X - Eventscripts
• Start-Session-Script:!
• $1: Partner-Kurzname
• $2: Partner Datenbank-Index
• Ende-Session-Script:!
• $1: Partner-Kurzname
• $2: Partner Datenbank-Index
OS4X - Eventscripts
Wird quasi nie genutzt, interessant für Analysezwecke.
• Start-Senden-Script:!
• $1: Partner-Kurzname
• $2: virt. Filename
• $3: realer abs. Filename
• $4: Send-Queue-Kommentar (enthält oft einen Auftrags-bezogenen Wert)
• $5: Partner Datenbank-Index
OS4X - Eventscripts
Selten genutzt, OS4X Enterprise und SWAN könnten hier informiert werden (werden es aber nicht).
• Ende-Senden-Script:!
• $1: Partner-Kurzname
• $2: virt. Filename
• $3: realer abs. Filename
• $4: Send-Queue-Kommentar (enthält oft einen Auftrags-bezogenen Wert)
• $5: Errorcode ( 0 = fehlerfrei übertragen)
• $6: Partner Datenbank-Index
• $7: durchschnittliche Datenübertragungsrate in kB/s
OS4X - Eventscripts
OS4X Enterprise & SWAN basieren auf Informationsweitergabe über dieses Eventscript. Errorcode beachten!
• Start-Empfangen-Script:!
• $1: Partner-Kurzname
• $2: virt. Filename
• $3: realer abs. Filename (nach Transferende)
• $4: absoluter temporärer Filename während Transfer
• $5: vom Absender angegebene Dateigröße in kB (muss nicht unbedingt stimmen!)
!
• $6: Partner Datenbank-Index
• $7: Ziel-("Destination")-SFID
• $8: Absender-("Originator")-SFID
• $9: optional: OFTP2-Dateikommentar (sonst leer)
• $10: OFTP-Datestamp (wichtig für EERP/NERP)
• $11: OFTP-Timestamp (wichtig für EERP/NERP)
OS4X - Eventscripts
Einziges synchrones Eventscript, in dem auf Returncode des Eventscripts geprüft wird. Returncode wird in OFTP-Fehler umgesetzt. Protokolldefinition siehe Wiki (mit Erklärung) und RFCs.
• Ende-Empfangen-Script:!
• $1: Partner-Kurzname
• $2: virt. Filename
• $3: realer abs. Filename (nach Transferende)
• $4: Errorcode (0 = erfolgreich übertragen)
• $5: Partner Datenbank-Index
• $6: Ziel-("Destination")-SFID
• $7: Absender-("Originator")-SFID
!
• $8: optional: OFTP2-Dateikommentar (sonst leer)
• $9: durchschnittliche Datenübertragungsrate in kB/s
• $10: OFTP-Datestamp (wichtig für EERP/NERP)
• $11: OFTP-Timestamp (wichtig für EERP/NERP)
• $12: genutzte Ciphersuite (numerischer Wert, 0 bei OFTP 1.x)
• $13: Anfrage nach signierter EERP (0 oder 1)
OS4X - Eventscripts
OS4X Enterprise und SWAN erhalten über dieses Script ihre Infos.
• xERP-Script:!
• $1: Partner-Kurzname
• $2: virt. Filename
• $3: realer abs. Filename (falls ein passender Send-Queue-Eintrag gefunden wurde)
• $4: Kommentar des Send-Queue-Eintrags
• $5: Errorcode (0: EERP, ungleich 0: NERP Fehlercode)
• $6: Partner Datenbank-Index
• $7: OFTP-Datestamp (wichtig für EERP/NERP)
• $8: OFTP-Timestamp (wichtig für EERP/NERP)
• $9: Absender-("Originator")-SFID
• $10: Ziel-("Destination")-SFID
OS4X - Eventscripts
OS4X Enterprise erhält über dieses Script seine Infos. Dateien gelten erst als versendet, wenn die Empangsbestätigung einging.
• Blocked-Script:!
• $1: Partner-Kurzname
• $2: virt. Filename
• $3: realer abs. Filename
• $4: Kommentar des Send-Queue-Eintrags
• $5: Partner-Index
OS4X - Eventscripts
Wird derzeit nirgends verwendet, OS4X Enterprise und SWAN könnten hierüber Aufträge abbrechen, analysieren etc.
• Debug-Daemon-Dump-Script:!
• $1: absoluter Filename der Dump-File
OS4X - Eventscripts
Administrativ zu erzeugendes Script (z.B. für Komprimierung der File, Mailing, automatisches Aufräumen, Archivierung, ...)
• License high water mark Script!
• $1: konfiguriertes High Water Mark (in Prozent)
• $2: Anzahl der konfigurierten Partner
• $3: lizensierte Anzahl der konfigurierten Partner
OS4X - Eventscripts
Administrativ zu erzeugendes Script (Reaktion auf Erreichung eines konfigurierbaren Lizenz-Limits).
• Software-Update-Script!
• Parameterübergabe ist im Vergleich zu anderen Events verändert:
Ausführung wird mit „-f <absoluter Filename>“ durchgeführt.
OS4X - Eventscripts
OS4X Auto Update wird über dieses Event-Script ausgeführt.
• Zertifikat-Import-Script!
• $1: Partner-Kurzname
• $2: Partner Datenbank-Index
OS4X - Eventscripts
Event-Script dient lediglich der Information dass der angegebene Partner ein neues Zertifikat gesendet hat, das in OS4X importiert wurde.
• Enqueue-Post-Script (#1):!
• $1: Partner Datenbank-Index-Wert
• $2: realer abs. Filename
• $3: virt. Filename
• $4: Kommentar des Send-Queue-Eintrags
• $5: alternative SSID des Absenders
!
• $6: alternative SSID des Empfängers
• $7: Absender-("Originator")-SFID
• $8: Ziel-("Destination")-SFID
• $9: Priorität des Send-Queue-Eintrags
• $10: Größe der Datei (in Bytes)
OS4X - Eventscripts
Nach dem erfolgreichen Enqueueing wird dieses Script gerufen (hilfreich um Post-Enqueue-Processing umzusetzen).
• Enqueue-Post-Script (#2):!
• $11: Original-Größe der Datei (vor dem Vorbereiten zum Versand, z.b. bei OFTP2 durch Kompression)
• $12: alternatives OFTP-Passwort des Absenders
• $13: alternatives OFTP-Passwort des Empfängers
• $14: OFTP Release Level (entspricht indirekt der OFTP-Version, Dokumentation siehe Wiki)
• $15: OFTP2-Feld zur Darstellung des Dateizustands (Dokumentation siehe Wiki)
• $16: OFTP2 Cipher Suite
• $17: OFTP2-Kompression
• $18: OS4X Server ID
• $19: Send-Queue Index-Wert des Eintrags
OS4X - Eventscripts
Nach dem erfolgreichen Enqueueing wird dieses Script gerufen (hilfreich um Post-Enqueue-Processing umzusetzen).
OS4X - EventscriptsLogging der Events möglich:
OS4X - EventscriptsLogging der Events möglich:
OS4X - EventscriptsÜber Logeinträge möglich: • Darstellung des Scripts, Parameter, Ausgabe und
Returncode • Filtern nach Script-Typ, Datum, Scriptname und Parametern • Einfaches Restarten eines Events mit dem aktuell
konfigurierten Script für dieses Event (falls sich die Konfiguration unterscheidet)
• Massen-Ausführung mehrerer selektierter Events
Fragen?
OS4X - Eventscripts