IACBOX.COM
Batch Access Version 1.1.0 Deutsch 11.07.2016 In diesem HOWTO wird beschrieben, wie bestimmte Daten auf der IACBOX via HTTP POST abgefragt werden können.
Batch Access
TITEL
IACBOX.COM
Inhaltsverzeichnis Inhaltsverzeichnis................................................................................................................................ 1 1. Hinweise............................................................................................................................................... 2 2. Beschreibung.................................................................................................................................... 3 3. Vorbereitungen................................................................................................................................ 3 4. Verfügbare Befehle......................................................................................................................... 4 4.1. Daten exportieren................................................................................................................. 4 4.2. Backup exportieren............................................................................................................... 7 4.3. Ticket Befehle............................................................................................................................ 7 4.4. System Befehle........................................................................................................................ 7
Batch Access
s1|8
IACBOX.COM
1. Hinweise Bitte beachten Sie folgende Hinweise • Batch Access ist verfügbar ab IAC-BOX Version 5.0.7615 (p7742) oder neuer • Der anfragende Client muss Zugriff auf das WebAdmin Interface der IAC-BOX haben
Batch Access
s2|8
IACBOX.COM
2. Beschreibung Dieses HOWTO bescheibt wie das Batch Access Modul verwendet werden kann um bestimmte Daten auf einer IAC-BOX abzufragen oder Befehle auszuführen. Die Kommunikation wird über HTTP Post Requests durchgeführt. Automatisierte Sicherungen von spezifischen Daten sind hiermit möglich – in diesem HOWTO wird dies exemplarisch mit cURL und wget dargestellt.
3. Vorbereitungen Windows Systeme Das Batch Access Modul kann auf Windows Systemen mit dem Kommandozeilentool cURL getestet werden. Nach dem Download müssen die Dateien in das system32 Verzeichnis kopiert werden. CURL (x64 SSL version) kann von hier bezogen werden: http://www.paehl.com/open_source/?CURL_7.41.0 Linux Systeme Linux basierende Systeme können das Modul Batch Access mit wget verwenden.
Batch Access
s3|8
IACBOX.COM
4. Verfügbare Befehle Es gilt zu beachten, dass folgenden Befehle für cURL problemlos auf wget übertragen werden können. Die folgenden Befehle können in einer Windows Kommandozeile ausgeführt werden (cmd.exe).
4.1. Daten exportieren Statistiken: tickets oder revenue, csv oder xls Format, from_date und to_date. Optionale Felder: - export_id: Liefert die Ticket IDs als ersten Spaltenwert. Mit der Ticket ID können weitere Ticket Befehle gesendet werden (siehe 4.3 Ticket Befehle). - search_text: Suche nach bestimmten Ticket Namen oder die Ticket Beschreibung. Alternativ werden ab IAC-BOX Version 8 auch MAC-Adressen (AA:BB:CC:11:22:33 & aabbcc112233) erkannt und auf die Suche angewandt. - issuer: Suche nach bestimmtem Benutzer/Dienst welcher die Tickets erstellt hat (z.B. „sysop“). - revoked: Zeigt entweder nur Tickets die storniert (1) oder eben nicht storniert (0) wurden. curl insecure o tickets.csv data "lang=de_DE&username=sysop&password=sysop&action=statistics&downlo ad=tickets&dataformat=csv&from_date=2015.01.01 00:00:00&to_date=2015.01.31 23:59:59&export_id=1&search_text=AA:BB:CC:11:22:33&issuer=sysop&re voked=1" https://192.168.1.1/batch.php
Rückverfolgung: proxy oder conntrack, csv oder raw Format, from_date und to_date. Optional Fields: - search_text: Suche nach aufgerufenen Webseiten, Verbindungen, IPAdressen, MAC-Adressen etc. curl insecure o proxy_log.csv data "lang=de_DE&username=sysop&password=sysop&action=connection_tracki ng&download=proxy&dataformat=csv&from_date=2015.01.01 00:00:00&to_date=2015.01.31 23:59:59&search_text=bild.de" https://192.168.1.1/batch.php
Batch Access
s4|8
IACBOX.COM Anwendungs-Log: csv oder xls Format, from_date und to_date. curl insecure o application_log.csv data "lang=de_DE&username=sysop&password=sysop&action=application_log&d ownload=logdata&dataformat=csv&from_date=2015.01.01 00:00:00&to_date=2015.01.31 23:59:59" https://192.168.1.1/batch.php
Anwendungs-Log Tickets: Nur Ticket relevante Daten aus dem Anwendungs-Log. Als csv oder xls Format, from_date und to_date. Optionale Felder: - hide_msg: Beim Wert 0 wird die Log-Nachricht selbst nicht ausgeliefert. Dieser Text ist nur eine Beschreibung des numerischen state Feldes, somit kann man mit dieser Option die Datenmenge erheblich reduzieren. curl insecure o application_log.csv data "lang=de_DE&username=sysop&password=sysop&action=application_log&d ownload=deviceinfo&dataformat=csv&from_date=2015.01.01 00:00:00&to_date=2015.01.31 23:59:59&hide_msg=1" https://192.168.1.1/batch.php
System Log: system oder mail, generation 0 = heute, 1 = gestern, ... curl insecure o system_log.gz data "username=sysop&password=sysop&action=system_log&download=system&g eneration=0" https://192.168.1.1/batch.php
Hinweis: Es wird eine komprimierte gzip Datei ausgegeben.
Messaging Daten: csv oder xls Format, from_date und to_date, download = Datentyp. Folgende Datentypen sind möglich: - email: Tickets die mit dem Email Modul erstellt wurden. - sms: Tickets die mit dem SMS Modul erstellt wurden. - social: Tickets die mit dem Social Modul (z.B. Facebook) erstellt wurden. - tkrq: Tickets die mit dem Email Ticket Request Modul erstellt wurden. - dtc: Tickets die mit Hilfe des Data Collectors weitere Benutzerdaten enthalten.
Batch Access
s5|8
IACBOX.COM curl insecure o messaging_data.csv data "lang=de_DE&username=sysop&password=sysop&action=messaging&downloa d=tkrq&dataformat=csv&from_date=2015.01.01 00:00:00&to_date=2015.01.31 23:59:59" https://192.168.1.1/batch.php
Benutzerinformationen: Benutzer online, maximale gleichzeitige Benutzer etc. in json Format. curl insecure o userinfo.jsn data "username=sysop&password=sysop&action=json&want=userinfo" https://192.168.1.1/batch.php
Lizenzinformationen: Lizenzdaten, lizenzierte Module etc. in json Format. curl insecure o licenseinfo.jsn data "username=sysop&password=sysop&action=json&want=licenseinfo" https://192.168.1.1/batch.php
Systeminformationen: CPU Last, RAM, HDD etc. in json Format. curl insecure o systeminfo.jsn data "username=sysop&password=sysop&action=json&want=systeminfo" https://192.168.1.1/batch.php
Version: Software Version, Release, Release Datum etc. curl insecure o version.jsn data "username=sysop&password=sysop&action=json&want=version" https://192.168.1.1/batch.php
Batch Access
s6|8
IACBOX.COM 4.2. Backup exportieren Mit folgendem Befehl können Sie ein Backup erstellen und exportieren. curl insecure o backup.bkp data "username=sysop&password=sysop&backup=1" https://192.168.1.1/download_backup.php
4.3. Ticket Befehle Tickets abmelden: logout von bestimmten Tickets anhand ihrer ids (= Ticket IDs). curl insecure data "username=sysop&password=sysop&action=manage_ticket&subaction=logo ut&ids=12,22,540,299" https://192.168.1.1/batch.php
Tickets stornieren: revoke von bestimmten Tickets anhand ihrer ids (= Ticket IDs). curl insecure data "username=sysop&password=sysop&action=manage_ticket&subaction=revo ke&ids=12,22,540,299" https://192.168.1.1/batch.php
Hinweis: Es können mehrere Ticket IDs zum Abmelden oder Stornieren gleichzeitig angegeben werden. Die Ticket IDs können zum Beispiel mit der Statistik Abfrage der Batch Access API abgefragt werden (siehe 4.1 Daten exportieren – Statistiken).
4.4. System Befehle Online Update: Startet das Online Update auf dem ausgewählten System. curl –insecure o update.tmp data "username=sysop&password=sysop&action=online_update&subaction=doup date" https://192.168.1.1/batch.php
Update Log Auflistung: Zeigt eine Auflistung aller verfügbarer Online Update Logs. curl –insecure o logfiles.tmp data "username=sysop&password=sysop&action=online_update&subaction=list _log_files" https://192.168.1.1/batch.php
Batch Access
s7|8
IACBOX.COM Export Update Log: Exportiert bestimmte Update Logs. curl –insecure o logfiles.tmp data "username=sysop&password=sysop&action=online_update&subaction=fetc h_log_files&logfiles=onlupdate_20160621132007.log;onlupdate_201606 21043642.log" https://192.168.1.1/batch.php
Hinweis: Es können mehrere Update Logs gleichzeitig exportiert werden. Die genaue Bezeichnung der einzelnen Logs lässt sich mit der Update Log Auflistung ermitteln (siehe #UpdateLogAuflistung).
Batch Access
s8|8
