LUA

LoriotPro scripting documentation
Extensions for LUA language

Table of contents Search function

version française

LoriotPro library (function lp...)

SNMP functions
lp.Get - Perform a SNMP Get
lp.ascii_Getui64 - Perform a SNMP V2 (64 bits) Get
lp.GetBRC - Perform a SNMP Get within a VLAN context
lp_ascii_GetBRCui64 - Perform a SNMP V2 (64 bits) Get within a VLAN context
lp.Set - Perform a SNMP Set
lp_ascii_SetSnmpui64 - Perform a SNMP V2 (64 bits) Set
lp.SetBRC - Perform a SNMP Set within a VLAN context
lp_ascii_SetSnmpBRCui64 - Perform a SNMP V2 (64 bits) Set within a VLAN context
lp.GetNext - Perform a SNMP GetNext
lp.ascii_GetNextui64 - Perform a SNMP V2 (64 bits) GetNext
lp.GetNextBRC - Perform a SNMP GetNext within a VLAN context
lp_ascii_GetNextBRCui64 - Perform a SNMP V2 (64 bits) GetNext within a VLAN context
lp.Gets - Perform a SNMP Get on multiple OID
lp.GetsBRC - Perform a SNMP Get on multiple OID within a VLAN context
lp.GetRows - Perform multiple SNMP GetNext on indexed OID
lp.GetRowsBRC - Perform multiple SNMP GetNext on indexed OID within a VLAN context
lp.GetTableEntryList - Retrieve a full SNMP table object in a LUA table
Debug functions
lp.Trace - Display debug information in the editor system message area
lp.Print - Display information in the editor system message area
lp.Break - Allows you to add break point in a script
lp.Stop - Stop a running LUA script
 
LoriotPro Directory functions
lp.EnableDirectoryObject - Select a directory object that become the current object
lp.GetDirectoryUIDFather - Retreive the UID of the father of a directory object
lp.GetFirstDirectoryUID - Get the UID Unique IDentifier of the first item of the LoriotPro Directory
lp.GetFirstIP - Get the first IP address from the LoriotPro directory
lp.GetNextIP - Get the next IP address after the current selected IP address
lp.GetIPInformation - Get the properties of a host
lp.SetIPOption - Set host properties
lp.SetNetworkOption - Change the parameters of a network object
lp.GetAllHostFromContainer - Retreive all the UID of directory objects that are inside a container
lp.GetFirstNetwork - Get the first network container from the LoriotPro directory
lp.LocateDirectoryUID - Select the default object by UID
lp.GetNextDirectoryUID - Retrieve the next UID of an item of the directory tree
lp.GetNextNetwork - Get the next network container
lp.GetNetworkFromIP - Get the network of an IP address from the LoriotPro directory
lp.GetNetworkHostList - Get a table of host IP adresses pertaining to an IP network
lp.GetNetworkInformation - Get Network properties
lp.GetFirstRouter - Get the first router from the LoriotPro directory
lp.GetNextRouter - Get the next router from the LoriotPro directory
lp.GetRouterInformation - Get the router properties
lp.GetRouterIfList - Retrieve in an array the list of IP adresses attached to a router object
lp.InsertNewContainer - Insert a new container in the LoriotPro directory
lp.InsertNewNetwork - Insert a new network in the LoriotPro directory
lp.InsertNewHost - Insert a new host in the LoriotPro directory
lp.GetUIDInformation - Get information of a directory item with its UID
lp.GetChildUID - Get the child items of a directory item
lp.GetIPFromMAC - Search a host in directory from its MAC address
lp.FindName - Search directory by host name
lp.FindIPFromDynamicDNS - Search directory for IP address of a dynamic host name
lp.SaveDirectoryAs - Save the current directory under a new name
lp.SetDirectoryUID - Change of directory object parameters
lp.UpdateDirectory - Refresh the the LoriotPro directory tree
 
Conversion functions
lp.atoip - Convert an IP address from character string to long interger
lp.iptoa - Convert an IP address from long interger to character string
lp.HexToOID - Convert an Hexa decimal to an OID string
lp.ascii_doubleToui64 - Convert number in character string
lp.ascii_ui64ToHex - Convert an unsigned 64 bits in hexdecimal
lp_atof - Convert a character String in a double
split a character string in an array by using a token
 
File and directory functions
lp.GetFileAttrib - Collect the attributs of a file
lp.GetPath - Return the LoriotPro installation directory
lp.Fclose - Close a file open with the function lp.Fopen.
lp.FindFile - Search for one or multiple files by name in a directory
lp.Fopen - Open a file in text mode
lp.Fprintf - Write texte to a file
lp.MakeDir - Create a new directory in the Windows file system
lp.CopyFile - Copy the file to another file
lp.RemoveDir - Remove a directory from the Windows file system
lp.RemoveFile - Remove a file form the Windows file system
 
Logical and arithmetical functions
lp.AND - Perfom a logical AND between two values
lp.ascii_ui64add - Addition of two 64 bits value
lp.ascii_ui64and - Perform a logical AND between two unsigned 64 bits
lp.ascii_ui64div - Perform a division between two unsigned 64 bits
lp.ascii_ui64multi - Perform a multiplication between two unsigned 64 bits
lp.ascii_ui64or - Perform a logical OR between two unsigned 64 bits
lp_ascii_ui64rest - Get the remainder of a divivion between two unsigned 64 bits
lp_ascii_ui64sub - Perform a substraction between two unsigned 64 bits
lp.ascii_ui64xor - Perform an addition between two unsigned 64 bits
lp.OR - Perform a logical OR between two values
lp.shifttoleft - Perform a binary left shift
lp.shifttoright - Perform a binary right shift
lp.ui64div - Division between two unsigned 64 bits
lp.ui64rest - Remainder of a division between two unsigned 64 bits
lp.XOR - Perform a logical XOR
 
Internal
lp.GetIPAddress - Perform a DNS resolution
lp.GetVersion -
lp.GetLoriotProID - Retrieve the ID of the LoriotPro license
lp.GetTCPPoll - Perform a tcp polling
 
Plugin functions
lp_CliPlugin_FR.htm - Perform bidirectionnal communication with a Directory plugin
lp_CliServicePlugin - Perform bidirectionnal communication with a Service plugin
lp.FoundADVAuditUID - Retrieve the Unique IDentifier UID of a directory Audit plugin
lp.FoundADVTCPUID - Retrieve the Unique IDentifier UID of a directory TCP Polling plugin
lp.GetADVInformation - Retreive in a table all the settings of an Audit or a TCP plugin
lp.GetServicePluginInformation -
lp_GetServicePluginList -
lp.GraphADVAuditToJpeg - Create a jpeg image file of the graph attached to an audit process
lp.GraphADVPollingToJpeg - Create a jpeg image file of the graph of the polling response time attached to an audit process
lp.GraphIPPollingToJpeg - Create a jpeg image file of the IP or SNMP polling response time of a host.
lp.GraphVuMeterToJpeg - Create a jpeg image file of a gauge or counter (a vumeter) for one value
lp.HidePlugin - Hide a plugin windows that is currently visible
lp.InsertADVAuditPolling - Attach a new LUA Audit plugin to a host in the directory
lp.InsertADVTCPPolling - Attach a new TCP Audit plugin to a host in the directory
lp.SetADVAuditPollingUID - Modify the properties of an Audit plugin
lp.SetADVTCPPollingUID - Modify the properties of an TCP Audit plugin
lp.ShowPlugin - Displays the window of a directory plugin
lp.UpdateADVAuditPolling - Update the settings of an Audit plugin
lp.UpdateADVAuditPollingUID - Update the settings of an Audit plugin
lp.UpdateADVTCPPolling - Updates the parameters of a TCP Audit plugin
lp.UpdateADVTCPPollingUID - Update the parameters of a TCP Audit plugin
lpsms.GetSMSRecipientList - Retrieve a list of the recipient lists
lpsms.SendSMS - Send a SMS message to the recipient list
 
Event functions
lp.SendEvent - Send an event message locally
lp.SendExternEvent - Send an event message to a LoriotPro manager
lp_AckEvent - Acknowledge events
lp.AckEventFilterAction - Acknowledge an event filter
lp.GetEventActionList - List of all referenced actions associated to an event
lp.GetEvenList - List of all referenced LoriotPro event type
lp.GetEventFilterActionInformation - Provide the setup information of an event filter action
lp_ClearIPEventCounter - Reset the counter of events received by a host
lp.SetEventFilterActionDisable - Enable/disable the action of an event filter
lp.SetEventFilterDisable - Enable or disable all the filter/actions of an event filter
lp.SetEventFilterGlobalStatus - Enable or disable globally the event filter function
 
SNMP Trap functions
lp_AckTrapFilter - Acknowledge SNMP Traps by type
lp_AckEventFilterAction - Acknowledge a SNMP Trap filter counter
lp.ClearIPTrapCounter - Perform a reset of the counter of SNMP TRAPs received by a host
lp.GetEventFilterGlobalStatus - Retreives the enabled status of a LoriotPro event filter
lp.GetEventInformation - Retrieve statistics information of an event and its filter
lp.GetTrapFilterActionList - Retrieve the list of filters attached to a TRAP
GetTrapFilterActionInformation - Retrieves the information of a Trap filter.
lp.GetTrapFilterGlobalStatus - Retrieve the global enable/disable status of a Trap filters
lp.GetTrapFilterInformation - Retrieve the information attached to a a Trap filter
lp.GetTrapFilterList - Retrieve a list of trap that have known filter statistics
lp.SendTrapV1 - Send a SNMP Trap in V1 format to a Trap receiver
lp.SendTrapV2 - Sends a SNMP Trap in V2C format
lp.SetTrapFilterActionDisable - Enable/disable the action of a TRAP filter
lp.SetTrapFilterDisable - Enable/disable all the actions of a TRAP filter
lp.SetTrapFilterGlobalStatus - Enable or disable all the TRAP filters
 
SYSLOG functions
lp.SendSyslog - Send a Syslog Message to a syslog server
 
 
MIB functions
lp.GetSNMPObjectDescription - Retrieve the description field of a MIB object
lp.GetSnmpObjectInformations - Retrieve information about a SNMP MIB object
lp.IsLoadedMIBRef - Check if a MIB file is loaded and accessible
lp.IsRegisteredMIBRef - Provide the MIB file name where is declared a MIB object
lp.FindSNMPObject - Check if a snmp object is available in the MIB tree
 
LUA library functions
lp.LoadLibrary - Load a new LUA library
lp.FreeLibrary - Unload a LUA library
lp.InitLuaPath - Initializes the necessary path to the lua for windows librairies
 
SLA function
lpsla.Compute - Compute the statistical data of a service level agreement
lpsla.GetLoriotProIDList - retrieves a list of SLA directories
lpsla.GetSLAList - Retrieve a list of the SLA directories
 
 
 
 
 

 


www.loriotpro.com