LUALoriotPro WEB site

LoriotPro scripting documentation
Extensions for LUA language

Table of contents Search function

Print the current page Mail this  link UTUBE Channel version française

LoriotPro LUA 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
lp.GetV1  LoriotPro V7 feature - Perform a SNMP GET in version 1 (community different from directory)
lp.GetV1_p  LoriotPro V7 feature  - Perform a SNMP GET in version 1 (community and port different from directory)
lp.GetV2c  LoriotPro V7 feature - Perform a SNMP GET in version 2c (community different from directory)
lp.GetV2c p LoriotPro V7 feature - Perform a SNMP GET in version 2c (community and port different from directory)
 
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.FindName - Search directory by host name
lp.FindIPFromDynamicDNS - Search directory for IP address of a dynamic host name
lp.GetAllHostFromContainer - Retreive all the UID of directory objects that are inside a container
lp.GetChildUID - Get the child items of a directory item
lp.GetDirectoryUIDFather - Retreive the UID of the father of a directory object
lp.GetFastNextDirectoryUID  LoriotPro V7 feature
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.GetFirstNetwork - Get the first network container from the LoriotPro directory
lp.GetFirstRouter - Get the first router from the LoriotPro directory
lp.GetGlobalInformation  LoriotPro V7 feature  - Retrieve information about LoriotPro, Directory statistics, MIB database statistics and Time information
lp.GetIPDoubles  LoriotPro V7 feature - Retrieve a table of 100 variables (type double) attached to a directory host object
lp.GetIPValues  LoriotPro V7 feature - Retrieve a table of variables (string type) attached to a directory host object
lp.GetNextIP - Get the next IP address after the current selected IP address
lp.GetIPInformation - Get the properties of a host
lp.GetIPFromMAC - Search a host in directory from its MAC address
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.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.GetUIDInformation - Get information of a directory item with its UID
lp.InsertNewContainer - Insert a new container in the LoriotPro directory
lp.InsertNewHost - Insert a new host in the LoriotPro directory
lp.InsertNewNetwork - Insert a new network in the LoriotPro directory
lp.LocateDirectoryUID - Select the default object by UID
lp.SetDirectoryStructureChanged  LoriotPro V7 feature
lp.SetIPDouble  LoriotPro V7 feature - Store in a LUA table attached to a directory host a variable of type "double"
lp.SetIPOption - Set host properties
lp.SetNetworkOption - Change the parameters of a network object
lp.SaveDirectoryAs - Save the current directory under a new name
lp.SetDirectoryUID - Change of directory object parameters
lp.SetIconForUID  LoriotPro V7 feature - Change the current icon of an object of the directory
lp.UpdateDirectory - Refresh the the LoriotPro directory tree
 
Conversion and parse 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
lp.Parse - split a character string in an array by using a token  LoriotPro V7 feature
lp.XSLT - Convert a XML XSL associated text/file to an HTML text/file LoriotPro V7 feature
 
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
lp.CompFile  LoriotPro V7 feature - Compare two files
 
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
 
Global Object
lp.ClearGObjectFlagCheck  LoriotPro V7 feature - Clear the check flag
lp.CountAssignedGObject  LoriotPro V7 feature - Give the number of assigned Global Object
lp.CountFreeGObject  LoriotPro V7 feature - Give the number of Global Object that are available for creation
lp.CountLockedGObject  LoriotPro V7 feature - Give the number of Global Object with a locked status
lp.DeleteAllGObjectNotFlagChecked  LoriotPro V7 feature - Delete all Global Object with the check flag not set
lp.DeleteGObject  LoriotPro V7 feature - Delete a Global Object
lp.GenerateAllModifedGObject  LoriotPro V7 feature - Generate a file with a list of Global Object
lp.GenerateSynchroGObjectList  LoriotPro V7 feature
lp.GetLocalIP LoriotPro V7 feature - Get the IP V4 internal reference for Global object management.
lp.SetGObjectAutoLoad  LoriotPro V7 feature - Initialized with the saved value at Loriotpro startup.
lp.GetGObjectDouble  LoriotPro V7 feature - Retrieve the current double type value of a Global Object
lp.GetGObjectFlagCheck  LoriotPro V7 feature - Set the check flag
lp.GetGObjectLock  LoriotPro V7 feature - Allows to know if a Global Object is in a locked status
lp.GetGObjectParam1  LoriotPro V7 feature - Retrieve the content of the Param1
lp.GetGObjectParam2  LoriotPro V7 feature - Retrieve the content of the Param2
lp.GetGObjectStatus  LoriotPro V7 feature - Retrieve the current status
lp.GetGObjectString  LoriotPro V7 feature - Retrieve the current string
lp.GetGObjectStamp  LoriotPro V7 feature - Retrieve the timestamp fo the last execution of the LUA function
lp.isGObject  LoriotPro V7 feature - Check if a GObject exist
lp.ListAllGObject  LoriotPro V7 feature - List all existing Globla Object
lp.ListAllGObjectForGroup  LoriotPro V7 feature - List all the GLOBAL OBJECTS that pertain to a group
lp.ListAllLocatedGObject  LoriotPro V7 feature - List of GLOBAL OBJECTS located on the specified LoriotPro server (ip)
lp.SaveGObject  LoriotPro V7 feature - Save the Global Object
lp.SaveGObjectAutoLoadList  LoriotPro V7 feature - Save all the Global Object that are in autoload mode
lp.SetGObjectDouble  LoriotPro V7 feature - Set the current double type value of a Global Object
lp.SetGObjectFlagCheck  LoriotPro V7 feature - Set the check flag
lp.SetGObjectFunctionName  LoriotPro V7 feature - Define the name of the LUA function attached to this Global Object.
lp.SetGObjectFunctionTime  LoriotPro V7 feature
lp.SetGObjectGroupName  LoriotPro V7 feature - Assign a Global Object to a Group
lp.SetGObjectInterval  LoriotPro V7 feature - Set the time interval at which the Global Object LUA function must be executed
lp.SetGObjectIntervalType  LoriotPro V7 feature - Define the unit of the time interval in second or milliseconds or user defined
lp.SetGObjectIPRef  LoriotPro V7 feature - Set the IP address of the conditional function execution of the pre-scheduling option
lp.SetGObjectIPRefMaster  LoriotPro V7 feature - Set the IP address of the LoriotPro managing this Object (Master)
lp.SetGObjectLock  LoriotPro V7 feature - Set unset the locked status
lp.SetGObjectParam1  LoriotPro V7 feature - Set the content of the Param1
lp.SetGObjectParam2  LoriotPro V7 feature - Set the content of the Param2
lp.SetGObjectSchedule  LoriotPro V7 feature - Set the schedule status of a Global Object
lp.SetGObjectStamp  LoriotPro V7 feature - Set the timestamp to the current timestamp
lp.SetGObjectStatus  LoriotPro V7 feature - Set the status flag of a Global Object
lp.SetGObjectStatusCheck  LoriotPro V7 feature - Change the value of the Check Type option of a Global Object
lp.SetGObjectStatusRef  LoriotPro V7 feature - Set the ref value of a check
lp.SetGObjectString  LoriotPro V7 feature - Set the String variable of Global Object
lp.SetGObjectUIDRef  LoriotPro V7 feature - Set the UID of the conditional function execution
lp.SetGObjectVersion  LoriotPro V7 feature - Define the version which is a time stamp of a Global Object
lp.SetLocalIP LoriotPro V7 feature - Set the IP V4 internal reference for Global object management.
lp.StatusOfGObject  LoriotPro V7 feature - Retrieve in a LUA table the current values of the Global Object
lp.TriggerGObjectLock  LoriotPro V7 feature - Set a Global Object in locked state
lp.triggerGObjectLock_Ext  LoriotPro V7 feature - Set a Global Object in locked state
 
Internal and generic
lp.GetGlobalInformation  LoriotPro V7 feature  Retrieve information about LoriotPro, Directory statistics, MIB database statistics and Time information
lp.GetLoriotProID - Retrieve the ID of the LoriotPro license
lp.GetVersion - Retrieve the version of LoriotPro
lp.GetTmpName  LoriotPro V7 feature - Retrieve a unique name
lp.ShowLoriotPro  LoriotPro V7 feature - Display LoriotPro
lp.GenerateModalJPG  LoriotPro V7 feature - Generate an image file (JPEG format) from an Active View template.
lp.CreateProcess  LoriotPro V7 feature - Start an external executable application
lp.Sleep  LoriotPro V7 feature - Wait a delay
lp.ImgToImg  LoriotPro V7 feature - Generate an image file (JPEG format) from an Active View template
 
Network functions
lp.ReStartSnmpSocket LoriotPro V7 feature -  Reinitialize the SNMP socket
lp.GetIPAddress - Perform a DNS resolution
lp.GetIPRTTData  LoriotPro V7 feature - Retrieves in a LUA table the last 100 Round Trip Time values in millisecondes of the PING/SNMP polling
lp.GetIPRTTValues  LoriotPro V7 feature - Same as previous
lp.GetServiceInformation  LoriotPro V7 feature - Retrieve information from the file /config/port-numbers.txt about IP application port number.
lp.GetTCPPoll - Perform a tcp polling
lp.GetIPDNSName  LoriotPro V7 feature - Perform a reverse DNS resolution. Resilve form IP address to Name
 
Plugin functions
lp.CliPlugin - 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.GetADVGraphValues  LoriotPro V7 feature - Retrieve in a LUA table the last 100 values returned by an Audit Plugin
lp.GetADVInformation - Retreive in a table all the settings of an Audit or a TCP plugin
lp.GetADVRTTValues  LoriotPro V7 feature - Retrieve in a LUA table the Round Trip Time values of the last 100 PING/SNMP polling performed by the LoriotPro Poller
lp.GetServicePluginInformation  LoriotPro V7 feature - Retrieves information about a LoriotPro Service Plugin.
lp.GetServicePluginList  LoriotPro V7 feature - List of the UID of the LoriotPro Service Plugin
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
lp.GetEventCacheInformation  LoriotPro V7 feature - Get technical information on the Event receiver cache system
 
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
lp.GetTrapCacheInformation  LoriotPro V7 feature - Get technical information on the Trap receiver cache system
 
SYSLOG functions
lp.SendSyslog - Send a Syslog Message to a syslog server
lp.GetSyslogCacheInformation  LoriotPro V7 feature - Get technical information on the Syslog receiver cache system
 
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
 
WEB & User Rights
lp.GetUserInformation LoriotPro V7 feature - Provide the rights associated to WEB user
lp.HTTPUserResetSessions LoriotPro V7 feature - Reset all the current connexion used for LoriotPro WEB access.
lp.isUserRight LoriotPro V7 feature

 


www.loriotpro.com