Kaseya 2. Benutzerhandbuch. Deutsch. Versión 7.0

Transkript

1 Kaseya 2 Network Monitor API Benutzerhandbuch Versión 7.0 Deutsch September 15, 2014

2 Agreement The purchase and use of all Software and Services is subject to the Agreement as defined in Kaseya s Click-Accept EULATOS as updated from time to time by Kaseya at If Customer does not agree with the Agreement, please do not install, use or purchase any Software and Services from Kaseya as continued use of the Software or Services indicates Customer s acceptance of the Agreement Kaseya. All rights reserved.

3 Inhalt Network Monitor Lua-API 1 Programmiermodell 3 Erweitertes Skript... 4 Einfaches Skript... 6 Bestandskontext... 6 Ergebnis... 6 Globale Funktionen 7 ConvertFromUTF FormatErrorString... 8 GetArgument... 8 GetArgumentCount... 9 GetLastError... 9 GetDeviceAddress... 9 IsIDE... 9 MessageBox print SetExitStatus SetLastError StoreStatisticalData StoreStatisticalData Wait LuaScriptEnumResult 15 Beispiel-Skript: OnEnumerate Add LuaScriptConfigurator 17 Beispiel-Skript: OnConfigure AddArgument SetCharacterLimits SetNumericLimits SetEntryPoint SetAuthor SetDescription SetMinBuildVersion SetScriptVersion TLuaDateTime 23 Add Create CreateSpan i

4 Equal Get GetDate GetTime Greater GreaterOrEqual Less LessOrEqual NotEqual Set Sub TLuaDB 29 Beispiel-Skript: TLuaDB ColCount Connect Connect(2) Execute GetCol GetCol_AsDateTime GetColType GetErrorDescription NextRow ResultAvailable TLuaDNS 35 Beispiel-Skript: TLuaDNS Begin End GetErrorDescription Next Query TLuaDNS_ARecord TLuaDNS_CNAMERecord TLuaDNS_MXRecord TLuaDNS_NSRecord TLuaDNS_PTRRecord TLuaDNS_SOARecord TLuaDNS_TXTRecord TLuaFile 41 Beispiel-Skripte: TLuaFile Close CopyFile CreateDirectory DeleteDirectory DeleteFile DoesFileExist GetDirectoryList GetFileAccessedTime GetFileCreatedTime GetFileList ii

5 GetFileModifiedTime GetFileSize GetFileSizeMB GetFileStatus MoveFile Open Read ReadData RenameFile SeekFromCurrent SeekFromEnd SeekFromStart Write TLuaFTPClient 53 Beispiel-Skript: TLuaFTPClient ChangeDirectory Close CloseFile Connect CreateDirectory DeleteDirectory DeleteFile FindDirectory FindFile GetCurrentDirectory GetFileModifiedTime GetFileSize OpenFile Read RenameFile Write TLuaHTTPClient 61 Beispiel-Skript: TLuaHTTPClient Connect Close Get Post GetContent GetHeadersRaw GetHeaderLocation GetHeaderContentLength GetHeaderContentType GetHeaderContentTransferEncoding GetHeaderCookies GetHeaderCookie GetHeaderCookieCount GetHeaderDate GetHeaderExpires GetHeaderHost iii

6 TLuaICMP 67 Beispiel-Skript: TLuaICMP BeginTrace EndTrace NextTraceResult Ping TLuaICMPPingResult 71 TLuaICMPTraceResult 73 TLuaPowershell 75 Beispiel-Skript: TLuaPowershell Beispiel-Skript: TLuaPowershell (Windows Scripting) Open ExecuteCommand GetStdOut GetStdErr GetErrorDescription GetErrorCode TLuaRegistry 81 Beispiel-Skript: TLuaRegistry BeginEnumValue Close Create DeleteValue EnumValue GetErrorDescription Open ReadValue ReadValue ReadValue SetValue SetValue SetValue SetValueExpandedString TLuaSFTPClient 87 Beispiel-Skript: TLuaSFTPClient Close CloseDir Connect CreateFile ListDir MkDir OpenDir Open_ForRead Open_ForWrite iv

7 Open_ForAppend Read Remove Rename RmDir Write TLuaSFTPClientAttributes 95 AccessedTime CreatedTime Group ModifiedTime Owner PermissionBits Size SizeMB TLuaSFTPClientDirectoryHandle 99 Next TLuaSFTPClientFile 101 TLuaSNMP 103 Beispiel-Skript: TLuaSNMP BeginWalk Close Get Open Set Walk TLuaSNMPResult TLuaSSH2Client 109 Beispiel-Skript: TLuaSSH2Client ExecuteCommand GetErrorDescription GetStdErr GetStdOut Open TLuaSocket 113 Beispiel-Skript: TLuaSocket Close OpenTCP OpenUDP Read Write v

8 TLuaSocketSecure 117 Beispiel-Skript: TLuaSocketSecure Open Close Read Write GetCertificateExpiryDate TLuaStorage 121 CreateItem UpdateItem DeleteItem FindItem TLuaStorageItem TLuaTimer 125 Beispiel-Skript: TLuaTimer Start Stop TLuaWinperf 127 Beispiel-Skript: TLuaWinperf GetErrorDescription GetResult Query TLuaWMIQuery 129 TLuaWMIQuery Execute GetErrorDescription GetProperty NextInstance SetNamespace TLuaXMLNode 133 FindAttribute FindChildNode GetData GetTag GetParentNode IsValid TLuaXMLReader 137 FindChildNode FindNode FromXML GetRootNode vi

9 Inhaltsverzeichnis 141 vii

10

11 Network Monitor Lua-API Network Monitor Lua-API Diese Dokumentation behandelt die Network Monitor Lua-API. Network Monitorverwendet Lua 5.0. Lua Lua ist eine leistungsfähige, schlanke Programmiersprache, die zur Erweiterung von Anwendungen entwickelt wurde. Lua wird außerdem häufig als eigenständige Mehrzwecksprache verwendet. Lua ist eine frei erhältliche Software. Lua verbindet einfache prozedurale Syntax mit leistungsfähigen Datenbeschreibungskonstrukten, die auf assoziative Arrays und erweiterbare Semantik basieren. Lua ist dynamisch typisiert, wird von Bytecode übersetzt und verfügt über automatische Speicherverwaltung mit automatischer Speicherbereinigung, wodurch sie ideal für Konfiguration, Skripting und Rapid Prototyping ist. Hinweis: Diese Dokumentation behandelt nicht die Programmiersprache Lua. Weitere Informationen zur Programmiersprache Lua finden Sie unter ( Network Monitor und Lua Kunden können mit der Skriptsprache Lua benutzerdefinierte Monitore erstellen, um Systeme und Arbeitsgeräte zu testen, die von der aktuell verwendeten Überwachungslösung nicht unterstützt werden. Neue Monitore, Aktionen und Ereignisse können in der von Kaseya zur Verfügung gestellten Entwicklungsumgebung erstellt und getestet werden, bevor sie in Kaseya Network Monitor exportiert und verwendet werden. Den Entwicklern steht eine umfassende Bibliothek vordefinierter Klassen, wie z. B. SFTP-Client, HTTP-Client und Dateiverwaltung zur Verfügung. 1

12 Network Monitor Lua-API Die Entwicklungsumgebung beinhaltet Debugger, Hervorhebung von Schlüsselwörtern, eine integrierte Hilfe und andere Funktionen, die in modernen Entwicklungstools verfügbar sind. Die Entwicklungsumgebung kann von unserer Homepage heruntergeladen werden: ( Lua IDE v3 2

13 K a p i t e l 1 Programmiermodell Wenn ein benutzerdefiniertes Lua-Skript zur Verwendung in Kaseya Network Monitor erstellt wird, gibt es mehrere Anforderungen, die das Skript erfüllen muss, um erfolgreich von Kaseya Network Monitor ausgeführt werden zu können. In diesem Kapitel Erweitertes Skript... 4 Einfaches Skript... 6 Bestandskontext... 6 Ergebnis

14 Programmiermodell Erweitertes Skript Das erweiterte Skriptmodell stellt dem Skriptautor neue leistungsstarke Tools für die Steuerung von n zur Verfügung, die als Argumente im Skript eingefügt werden. Dadurch können Lua-Skripte mit demselben Aussehen und Verhalten wie systemeigene Monitortypen erstellt werden. Reservierte Funktionsnamen Es gibt zwei reservierte Funktionsnamen, die von Network Monitor verwendet werden, um Informationen abzufragen. Diese Funktionsnamen dürfen für keinen anderen Zweck verwendet werden. OnConfigure Diese Funktion wird von Network Monitor aufgerufen, damit das Skript eine LuaScriptConfigurator-Klasseninstanz auffüllt. Diese Daten werden dann dafür verwendet, um eine Benutzeroberfläche für das Skript zu erstellen. Der Instanzname muss ''Config'' (Schreibweise beachten) lauten, sodass Network Monitor diese im Lua-Stapel finden kann, wenn die Funktion zurückgegeben wird. OnEnumerate Es kann jedes Feld in der Benutzeroberfläche aufgezählt werden, Network Monitor ruft die OnEnumerate-Funktion auf, damit das Skript mit einer Datenstruktur, LuaScriptEnumResult, aufgefüllt wird und zwar mit Werten, die der Benutzer auswählen kann. Die Funktion ''OnEnumerate'' hat einen, sfieldtoenum, der vom Skript verwendet wird, um zu bestimmen, für welches Feld/Argument Aufzählungsergebnisse geliefert werden sollen. Die zurückgegebene Instanz muss ''Enum'' genannt werden (Schreibweise beachten). Der Einstiegspunkt Das erweiterte Skriptmodell fordert von der Funktion ''OnConfigure'', dass diese den Namen der Einstiegspunktfunktion festlegt. Diese Funktion wird von Network Monitor aufgerufen, damit diese die Ausführung des Skripts startet. Der Einstiegspunktname ist standardmäßig ''main'', kann jedoch vom Programmierer beliebig geändert werden; die reservierten Funktionsnamen sind davon ausgenommen. 4

15 Programmiermodell Beispiel --This function is called by KNM when enumerating a field function OnEnumerate(sFieldToEnum) --The variable returned must be called "Config" so KNM can find it. Enum = LuaScriptEnumResult() --Second argument if sfieldtoenum == "Argument 2" then Enum:Add("First value") Enum:Add("Second value") Enum:Add("Third value") end return Enum end --This function is called by KNM to retrieve a script configuration function OnConfigure() --The variable returned must be called "Config" so KNM can find it. Config = LuaScriptConfigurator() --Author. Config:SetAuthor("My name") --Description. Config:SetDescription("Description of the script, including usage, parameters etc") --Minimum build version of KNM, set to zero for if no specificbuild version is required. Config:SetMinBuildVersion(0) --Script version (major/minor) Config:SetScriptVersion(1,0) --A parameter configuration, add them in the order the script isextracting them. Config:AddArgument("Argument 1","This is the description of thefirst argument",luascriptconfigurator.check_not_empty) --Add another parameter, a select box with 3 values. Config:AddArgument("Argument 2","This is the description of thesecond argument",luascriptconfigurator.check_not_empty+luascriptconfigurator.enum _AVAIL) --Set the entry point, this is the function called by KNM Config:SetEntryPoint("main") --Done with configuration, return the asset return Config end --This is the entry point 5

16 Programmiermodell function main() end sfirstargument = GetArgument(0) ssecondargument = GetArgument(1) SetExitStatus("OK",true) Einfaches Skript Das einfache Skriptmodell wurde in Network Monitor von der ersten Version an verwendet, und gilt nun als veraltet. Es wird aus Kompatibilitätsgründen mit älteren Skripten beibehalten. Bestandskontext Funktionen sind relativ zum Bestandskontext. Beispiel Alle Aufrufe bei denen auf Ressourcen zugegriffen wird, sind relativ zum übergeordneten Bestand. Zum Beispiel, wenn das Skript einen Pfad öffnet, muss der bereitgestellte Pfad zur Öffnungsfunktion relativ zum Bestand sein. Richten Sie den Host als Adresse für den ''Domainserver'' des Windows-Computer ein. TLuaFile:Open("C:\\test.txt"); Durch Aufrufen der Funktion öffnet das Skript die Datei test.txt, die sich auf der C-Festplatte des ''Domainserver''-Computers befindet. Aus diesem Grund nehmen alle der Kommunikation zugehörige Klassen wie z. B. TLuaFTPClient, TLuaHTTPClient und TLUASocket nur ein Port-Nummernargument auf, die IP-Adresse ist über Framework mit dem aktuellen Bestand hartcodiert. Ergebnis Wenn ein Skript beendet wird, muss es Network Monitor melden, ob der Test erfolgreich war oder nicht. Eine globale Funktion steht für diesen Zweck bereit: SetExitStatus. SetExitStatus ist obligatorisch und muss aufgerufen werden, bevor das Skript beendet wird. 6

17 K a p i t e l 2 Globale Funktionen Globale Funktionen sind Funktionen, die nicht mit einem Bestand verknüpft sind. Es gibt mehrere globale Funktionen in der Network Monitor Lua-API. Ein paar müssen aufrufen, wenn ein Skript beendet wird. In diesem Kapitel ConvertFromUTF FormatErrorString... 8 GetArgument... 8 GetArgumentCount... 9 GetLastError... 9 GetDeviceAddress... 9 IsIDE... 9 MessageBox print SetExitStatus SetLastError StoreStatisticalData StoreStatisticalData Wait

18 Globale Funktionen ConvertFromUTF16 string ConvertFromUTF16(local UTF16data,int isize) Eine 8-Bit-Zeichenfolge, die von einem UTF16-Zeichenfolge umgewandelt wurde. UTF16data UTF16-Zeichenfolge (Doppelbyte) gelesen von TLuaFile::ReadData. isize Größe der Zeichenfolge. Diese Funktion akzeptiert nur Daten, die von der Funktion TLuaFile::ReadData erstellt wurden. FormatErrorString string FormatErrorString(int ierror) Eine Zeichenfolge, die den Fehlercode ''ierror'' beschreibt. ierror Ein Windows-Fehlercode, der bereits durch den Aufruf der Funktion GetLastError erhalten wird. Diese Funktion kann sinnvoll sein, um dem Benutzer aussagekräftigem Text statt eines Fehlercodes zu senden. GetArgument string GetArgument(int inumber) Ein Argument, dass durch den Aufruf der Anwendung übergeben wird. inumber Ein nullbasierter Index des abzurufenden Arguments. Die Höchstzahl der Argumente kann durch den Aufruf von GetArgumentCount festgelegt werden. Eine aufrufende Anwendung kann eine Anzahl an Argumente an ein Lua-Skript übergeben, um dessen Verhalten anzupassen. Mit dieser Funktion und dem verwandten GetArgumentCount kann der Programmierer die Argumente extrahieren. 8

19 Globale Funktionen GetArgumentCount int GetArgumentCount() Die Anzahl der Argumente, die von einer aufrufenden Anwendung an ein Programm übergeben werden. Eine aufrufende Anwendung kann eine Anzahl an Argumente an ein Lua-Skript übergeben, um dessen Verhalten anzupassen. Mit dieser Funktion kann der Programmierer bestimmen, wie viele Argumente extrahiert werden sollen. GetLastError int GetLastError() Der letzte Fehlercode, der durch den Aufruf einer Bibliothek-Funktion erzeugt wurde. Der Fehlercode ist ein standardmäßiger Windows-Fehlercode. Mit SetLastError kann der aktuelle Windows-Fehlercode gelöscht werden, bevor function.sds aufgerufen wird GetDeviceAddress string GetDeviceAddress() Die in das Adressenfeld des Geräts eingegebene Adresse. Die Zeichenfolge kann als eindeutiger Bezeichner verwendet werden, wenn Daten in TLuaStorage gespeichert werden. IsIDE bool IsIDE() Der boolesche Wert muss ''Wahr'' sein, wenn das Skript von IDE ausgeführt wird, und ''Falsch'', wenn das Skript von Network Monitor ausgeführt wird. Diese Funktionen können verwendet werden, wenn das Skript von Network Monitor oder IDE ausgeführt wird. 9

20 Globale Funktionen MessageBox MessageBox(string stext) stext Der im Nachrichtenfeld erscheinende Text. Diese Funktionen rufen ein standardmäßiges Nachrichtenfeld des Betriebssystems auf, um eine Zeichenfolge anzuzeigen. Diese Funktion ist nur in IDE verfügbar. Beachten Sie, dass die Ausführung des Skripts gestoppt wird, solange das Nachrichtenfeld geöffnet ist. print print(string stext) stext Text, der im Ausgabefenster erscheint Diese Funktion kann verwendet werden, um Text im Ausgabefenster für Debug-Zwecke auszugeben. Wenn das Skript von Network Monitor ausgeführt wird, hat der mit dieser Funktion ausgegebene Text keinen Zweck. SetExitStatus SetExitStatus(string sstring,bool bsuccess) sstring Eine Zeichenfolge, die das Ergebnis des Skripts beschreibt. bsuccess Das Skript gilt bei ungleich null (boolescher Wert ist ''Wahr'') als erfolgreich vom Framework ausgeführt. Wenn dieser Wert auf null (boolescher Wert ist ''Falsch'') steht, muss die Funktion SetErrorString ebenfalls mit einer Zeichenfolge aufgerufen werden, die den Fehlerstatus beschreibt. Diese Funktion muss beim Beenden eines Skripts aufgerufen werden. Die Funktion teilt Network Monitor mit, ob das Skript erfolgreich war oder nicht. Der Text, der mit der Funktion bereitgestellt wird, wird von Network Monitor verwendet, um in der Benutzeroberfläche den letzten Statustext einzusetzen, wenn das Skript im Kontext eines Agents ausgeführt wird. SetLastError SetLastError(int ierrorcode) ierrorcode Eine ganzzahlige Entsprechung für einen Windows-spezifischen Fehlercode. 10

21 Globale Funktionen Die Funktion richtet den letzten Fehlercode ein, der später über GetLastError abgerufen werden kann. StoreStatisticalData bool StoreStatisticalData(int irecordset,float fdata,float fthreshold,string Unit) Wahr: Daten konnten erfolgreich in der statistischen Datenbank gespeichert werden. Falsch: Ein fehler ist vorgefallen. irecordsetindex Ein nullbasierter Index des statistischen Kanals, in dem die Daten gespeichert werden. Gültige Konstanten finden Sie unter. fdata Gleitkommadaten, die vom Skript aufgezeichnet werden. fthreshold Optionaler Schwellenwert für die Probedaten. Dieser Wert muss in allen Aufrufen konstant sein. Unit Optionale Zeichenfolge, die die Dateneinheit beschreibt. Dieser Wert muss in allen Aufrufen konstant sein. Diese Zeichenfolge darf höchstens 16 Zeichen lang sein, sonst schlägt der Aufruf fehl. Diese Funktion gibt dem Skript die Fähigkeit, statistische Daten zu speichern. Aktuell gibt es 8 Kanäle, die für diesen Zweck verwendet werden können. Der Indexparameter der Datensatzmenge kann eine der folgenden Konstanten sein. LUA_RECORDSET_1 LUA_RECORDSET_2 LUA_RECORDSET_3 LUA_RECORDSET_4 LUA_RECORDSET_5 LUA_RECORDSET_6 LUA_RECORDSET_7 LUA_RECORDSET_8 StoreStatisticalData bool StoreStatisticalData(int irecordset,float fdata,float fthreshold,int ivirtualtype,int ivirtualunit,string Unit) Wahr: Daten konnten erfolgreich in der statistischen Datenbank gespeichert werden. Falsch: Ein fehler ist vorgefallen. irecordsetindex Ein nullbasierter Index des statistischen Kanals, in dem die Daten gespeichert werden. Gültige Konstanten finden Sie unter. fdata Gleitkommadaten, die vom Skript aufgezeichnet werden. fthreshold Optionaler Schwellenwert für die Probedaten. Dieser Wert muss in allen Aufrufen konstant sein. ivirtualtype Datentyp der gespeicherten Daten. 11

22 Globale Funktionen ivirtualunit Ausgewählte Einheit des gespeicherten Typs. Gültige Kombinationen von Typen und Einheiten finden Sie unter. Unit Optionale Zeichenfolge, die die Dateneinheit beschreibt. Dieser Wert muss in allen Aufrufen konstant sein. Diese Zeichenfolge darf höchstens 16 Zeichen lang sein, sonst schlägt der Aufruf fehl. Diese Funktion ist nur für erweiterte Skripte verfügbar. Der Unterschied zwischen dieser Funktion und der alten Funktion mit demselben Namen ist die Fähigkeit Typinformationen mit den Daten zu speichern. ivirtualtype und ivirtualunit kann in den folgenden Kombinationen verwendet werden: 12

23 Globale Funktionen VT_SWAP_UTILIZATION VT_MEMORY_UTILIZATION VT_DISK_UTILIZATION VT_CPU_UTILIZATION UNIT_TYPE_PERCENT VT_FREE_DISKSPACE UNIT_TYPE_MEGABYTE UNIT_TYPE_GIGABYTE UNIT_TYPE_TERABYTE VT_SQL_QUERY UNIT_TYPE_NONE VT_TEMPERATURE: UNIT_TYPE_FAHRENHEIT UNIT_TYPE_CELSIUS UNIT_TYPE_KELVIN VT_HUMIDITY UNIT_TYPE_PERCENT VT_WETNESS UNIT_TYPE_NONE VT_VOLTAGE UNIT_TYPE_VOLT VT_BANDWIDTH_UTILIZATION UNIT_TYPE_PERCENT VT_BANDWIDTH_USAGE UNIT_TYPE_KBPS UNIT_TYPE_MBPS UNIT_TYPE_GBPS VT_DIRECTORY_SIZE: UNIT_TYPE_MEGABYTE UNIT_TYPE_GIGABYTE UNIT_TYPE_TERABYTE VT_DIRECTORY_COUNT UNIT_TYPE_NONE VT_PING_ROUNDTRIP UNIT_TYPE_MILLISECONDS UNIT_TYPE_SECONDS VT_PING_PACKETLOSS UNIT_TYPE_PERCENT VT_MAIL_ROUNDTRIP: UNIT_TYPE_MILLISECONDS UNIT_TYPE_SECONDS 13

24 Globale Funktionen VT_MEMORY_USAGE UNIT_TYPE_MEGABYTE UNIT_TYPE_GIGABYTE VT_TRANSFER_SPEED UNIT_TYPE_NONE VT_HTTP_FETCHTIME UNIT_TYPE_MILLISECONDS UNIT_TYPE_SECONDS VT_WMI_GENERIC_VALUE VT_LUA_GENERIC_VALUE VT_WINPERF_GENERIC_VALUE VT_SSH2SCRIPT_GENERIC_VALUE VT_SNMP_GENERIC_VALUE UNIT_TYPE_NONE VT_CURRENT UNIT_TYPE_AMPERE VT_FANSPEED UNIT_TYPE_RPM VT_LUMINOSITY UNIT_TYPE_LUX Der Indexparameter der Datensatzmenge kann eine der folgenden Konstanten sein. LUA_RECORDSET_1 LUA_RECORDSET_2 LUA_RECORDSET_3 LUA_RECORDSET_4 LUA_RECORDSET_5 LUA_RECORDSET_6 LUA_RECORDSET_7 LUA_RECORDSET_8 Wait Wait(int ims) ims Die Anzahl der Millisekunden, die die Skriptausführung warten soll. Diese Funktion ruft die Betriebssystem-Funktion ''Sleep'' dazu auf, die Ausführung des Thread abzubrechen, der das Skript ausführt. 14

25 K a p i t e l 3 LuaScriptEnumResult Die Klasse bietet eine Benutzeroberfläche, um Aufzählungsergebnisse in der OnEnumeration-Rückruffunktion einzugeben. In diesem Kapitel Beispiel-Skript: OnEnumerate Add

26 LuaScriptEnumResult Beispiel-Skript: OnEnumerate function OnEnumerate(sFieldToEnum) --The variable returned must be called "Config" so KNM can find it. Enum = LuaScriptEnumResult() --Second argument if sfieldtoenum == "Argument 2" then Enum:Add("First value") Enum:Add("Second value") Enum:Add("Third value") end return Enum end Add Add(const string &sdisplayvalue,const string &susagevalue=''') sdisplayvalue Anzeigewert als auswählbare Option. susagevalue (Optional) Ein Wert der statt dem Anzeigewert verwendet wird. Der optionale susagevalue kann verwendet werden, wenn Sie sehr komplexe und lange Werte haben und einen einfacheren Weg suchen, die Optionen anzuzeigen. Wenn Sie dies verwenden, wird sdisplayvalue dem Benutzer als Wert angezeigt, Network Monitor verwendet jedoch den Wert susagevalue. 16

27 K a p i t e l 4 LuaScriptConfigurator Diese Klasse bietet eine Benutzeroberfläche, um Konfigurationsinformationen zu erstellen, die Network Monitor verwendet, um für das Skript eine Benutzeroberfläche zu präsentieren. In diesem Kapitel Beispiel-Skript: OnConfigure AddArgument SetCharacterLimits SetNumericLimits SetEntryPoint SetAuthor SetDescription SetMinBuildVersion SetScriptVersion

28 LuaScriptConfigurator Beispiel-Skript: OnConfigure function OnConfigure() --The variable returned must be called "Config" so KNM can find it. Config = LuaScriptConfigurator() --Author. Config:SetAuthor("My name") --Description. Config:SetDescription("Description of the script, including usage, parameters etc") --Minimum build version of KNM, set to zero for if no specificbuild version is required. Config:SetMinBuildVersion(0) --Script version (major/minor) Config:SetScriptVersion(1,0) --A parameter configuration, add them in the order the script is extracting them. Config:AddArgument("Argument 1","This is the description of thefirst argument",luascriptconfigurator.check_not_empty) --Add another parameter, a select box with 3 values. Config:AddArgument("Argument 2","This is the description of thesecond argument",luascriptconfigurator.check_not_empty+luascriptconfigurator.enum _AVIL) --Set the entry point, this is the function called by KNM Config:SetEntryPoint("main") --Done with configuration, return the asset return Config end AddArgument int AddArgument(string sname,string sdescription,int iflags); Ein Handle, das verwendet werden kann, um auf dieses Argument in nachfolgenden Aufrufen zu verweisen. sname Name des Argumentfelds sdesc Beschreibung des Felds für die Validierung von Markierungssteuerungen ''iflags''. Markierungen finden Sie unter. 18

29 LuaScriptConfigurator Es handelt sich um gültige Markierungen. Manche können kombiniert werden. CHECK_NOTHING CHECK_NOT_EMPTY CHECK_RANGE_LOW CHECK_RANGE_HIGH CHECK_NUMERIC ENUM_AVAIL Standardwert, jedes Zeichen, einschließlich kein Text wird akzeptiert. Überprüfen, ob das Argument leer ist. Kann nicht mit CHECK_NOTHING kombiniert werden. Muss zusammen mit CHECK_NUMERIC verwendet werden. Überprüft, dass der numerische Wert im Bereich liegt (unterer Bereich) Muss zusammen mit CHECK_NUMERIC verwendet werden. Überprüft, dass der numerische Wert im Bereich liegt (oberer Bereich) Überprüft, dass der Wert numerisch ist (reelle oder ganze Zahl) Zeigt an, dass es eine Aufzählungsrückruffunktion mit vordefinierten Werten gibt, die für dieses Feld verfügbar ist. SetCharacterLimits SetCharacterLimits(int iargindex,int imaxcharacters,int imaxvisiblecharacters) iargindex Handle wird von AddArgument zurückgegeben. imaxcharacters Max. Eingabezeichen für Argument. imaxvisiblecharacters Max. sichtbare Zeichen, muss kleiner oder gleiche imaxcharacters sein. Diese Funktion legt die Höchstlänge eines Arguments fest und wie viele dieser Zeichen in der Benutzeroberfläche sichtbar sind (Länge des Eingabefelds). SetNumericLimits SetNumericLimits(int iargindex,float flow,float fhigh) iargindex Handle wird von AddArgument zurückgegeben. (siehe 18) Niedrig Unterer Bereich Hoch Oberer Bereich Diese Funktion legt den gültigen Bereich für reelle und Ganzzahl-Werte fest, die in das Feld eingetragen werden dürfen. Für das Argument müssen die Markierungen CHECK_RANGE_LOW und CHECK_RANGE_HIGH gesetzt sein. SetEntryPoint SetEntryPoint(string sname) sname Name der Einstiegspunktfunktion. 19

30 LuaScriptConfigurator Die Funktion registriert den Namen der Einstiegspunktfunktion. Diese Funktion ruft Network Monitor als Einstiegspunkt der Ausführung auf. Der Standardwert lautet ''main''. SetAuthor SetAuthor(string sname) sname Name des Skriptautors. Diese Funktion wird vom Autor des Skripts festgelegt. Es wird für Beschreibungszwecke verwendet, wenn ein Benutzer ein Drittanbieterskript lädt, um zu informieren, wer das Skript geschrieben hat. SetDescription SetDescription(string sdescription) sdescription Eine Beschreibung der Funktion des Skripts. Die Beschreibung eines Skripts muss dem Benutzer in wenigen Zeilen die Funktion des Skripts mitteilen, und ob Einschränkungen bekannt sind. Es gibt keine Längenbeschränkung für den Text, aber er sollte kurz gehalten werden. SetMinBuildVersion SetMinBuildVersion(int iminbuildnumber) iminbuildnumber Die minimale Buildnummer von Network Monitor, die das Skript anfordert. Die minimale Buildnummer ist ein sehr wichtiges Feld, das eingestellt werden muss. Es teilt Network Monitor mit, ob das Skript mit der aktuelle Version von Network Monitor verwendet werden kann. Standardmäßig muss diese Nummer auf die Buildnummer eingestellt werden, die der Autor zur Skriptprüfung verwendet hat. SetScriptVersion SetScriptVersion(int imajor,int iminor) imajor Die Hauptversionsnummer des Skripts. iminor Die Nebenversionsnummer des Skripts. 20

31 LuaScriptConfigurator Der Skriptautor muss eine Versionsnummer des Skripts festlegen. Eine Hauptversion 0 zeigt an, dass das Skript in einer ''Betaphase'' ist und nur für die Weiterentwicklung von anderen Benutzern verwendet werden darf. Mit jeder Skriptänderung muss die Versionsnummer erhöht werden. Eine Änderung der Hauptversionsnummer muss eine deutliche Verbesserung oder neu Schreibung des Skripts deutlich machen, die Nebenversionsnummer zeigt eine unbedeutendere Veränderung an. 21

32

33 K a p i t e l 5 TLuaDateTime TLuaDateTime stellt Datum- und Zeitfunktionen zur Verfügung. Bei der Zeit handelt es sich um die Ortszeit in Sekunden vom 1. Januar 1970 an. In diesem Kapitel Add Create CreateSpan Equal Get GetDate GetTime Greater GreaterOrEqual Less LessOrEqual NotEqual Set Sub

34 TLuaDateTime Add Add(TLuaDateTime DateTime) DateTime TLuaDateTime-Instanz wird von anderen Klassenfunktionen erhalten oder konstruiert. Die Funktion fügt die Zeit, die im DateTime enthalten ist, dem Bestand hinzu. Create Create(int iyear,int imonth,int iday,int ihour,int iminute,int isecond) iyear Jahr, z. B imonth Monat, z. B. 10 iday Tag, z. B. 2 ihour Festgelegte Stunde, der Wert kann null sein iminute Festgelegte Minute, der Wert kann null sein isecond Festgelegte Sekunde, der Wert kann null sein Die Funktion erstellt TLuaDateTime mit einer absoluten Zeit. CreateSpan CreateSpan(int ihour,int iminute,int isecond) ihour Festgelegte Stunden, der Wert kann null sein iminute Festgelegte Minuten, der Wert kann null sein isecond Festgelegte Sekunden, der Wert kann null sein Die Funktion erstellt TLuaDateTime nicht mit einer absoluten Zeit, sondern mit einer Zeitspanne, die zum Hinzufügen oder Abziehen von einem anderen TLuaDateTime-Bestand verwendet werden kann. Equal bool Equal(TLuaDateTime DateTime) Wahr, wenn DateTime gleich ist, andernfalls Falsch. 24

35 TLuaDateTime DateTime TLuaDateTime-Instanz wird von anderen Klassenfunktionen erhalten oder konstruiert. Get int Get() Anzahl der Sekunden, die in dieser Instanz enthalten sind. Die Funktion kann verwendet werden, um die Anzahl der Sekunden, die in dieser Instanz enthalten sind, in absoluter Zeit abzurufen. GetDate string GetDate(string sformat=null) Gibt eine Zeichenfolge mit der aktuellen Zeit zurück, der im Standardformat oder wie im sformat angegeben formatiert ist. sformat Optionale Zeichenfolge mit einem alternativen Format der zurückgegebenen Zeit. Das Standardformat lautet JJ MM TT. Die verfügbaren Markierungen finden Sie im Abschnitt ''''. Gibt eine Zeichenfolge mit der in der Instanz enthaltenen Zeit zurück. Das Standardformat lautet JJ MM TT. Mit Ihrem eigenen Formatcode können Sie die Art ändern, in der die Zeit zurückgegeben wird. Markierungen formatieren %a Abgekürzter Wochentagsname %A Vollständiger Wochentagsname %b Abgekürzter Monatsname %B Vollständiger Monatsname %c Angemessene Anzeige von Datum und Zeit für das Gebietsschema %d Monatstag als Dezimalzahl (01 31) %H Stunde im 24-Stundenformat (00 23) %I Stunde im 12-Stundenformat (01 12) %j Tag im Jahr als Dezimalzahl ( ) %m Monat als Dezimalzahl (01 12) %M Minute als Dezimalzahl (00 59) %p Für das Gebietsschema aktuelle Anzeige der Indikatoren ''A.M./P.M.'' für Uhren im 12-Stundenformat %S Sekunden als Dezimalzahl (00 59) %U Kalenderwoche als Dezimalzahl, wobei Sonntag der erste Tag der Woche ist (00 53) 25