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

Global Object properties

The Global Object properties can be defined with the Graphical interface or with LUA functions.

Before creating and configuring a new Global Object, the behind concepts should be well understood.

A Global Object, use the concept of object and has properties (sometime called Attribute) and functions (sometimes called Method).

As properties for example, a Global Object has a Name and a Group Name.

Each Global Object can have a LUA function attached which is used to perform data collection and correlation.

As an example, a very basic function can collect a single SNMP object on a host but a more complex function can be used to make the correlation of other GLOBAL OBJECTS.

This function is called by an external process (Audit process) at regular interval.

The function may update during its execution three properties of the Global Object, respectively called: String,Double,Status.

These properties can be use elsewhere in LoriotPro, in an Active View for example in the expression of a graphical object.

Here under a simple schema of the concept.

GlobalObjectConcept.png

One Audit is responsible for the execution of the Global Object LUA functions that are attached to a single group. As an Audit is a process declare in a Windows Thread, the distribution of the Load can be done between multiple Audit working on the same Group.

Creation of a Global Object

To create a Global Object you can either us the Graphical interface Global Object Monitor or use the dedicated LUA function.

To open the Global Object Monitor use the Configure option of the LoriotPro Main menu and select Global Object

Select the button New to start the creation of a new Global Object

The minimum setting require for having a Global Object is to assign a Name and Save/Quit.

If this GLOBAL OBJECTS must be processed by an Audit (Scheduled) then a Group assignment is required.

AT this point there is two case

  1. The Group exist then you can select it with the List Box attached to the Group Name label
  2. If the Group doesn't exist enter the name in the empty filed near the Group Name lable. Next time that you create another object in this group you will see it in the list of Group. After click the Edit Group Scheduler button.

If you try to save the new Object without Editing the attached Scheduler funtion then a Popup appears.

WHen you click on the Edit Group Scheduler button the LoriotPro LUA script editor appears. By default the function is written and just need to be saved.

EditGroupSheduler

Do a File->Quit only and you get a new Scheduler function for your server Group.

Next step consist of filling the Param 1 and Param 2 option.

This variables are use to provide to the Global Object LUA function some arguments.

Now you have to decided if

  1. this Global Object is simply use to store static data
  2. or if thse Global Object is used to perform data collection (SNMP for example)or data correlation.

In the second case the Global Object LUA Function must execute at regular interval (Sheduled). The Schedule value should be set to 1.

The next value Locked should stay by default at 0. It can be reset when the Global Object become locked.

The function name field specified the LUA function that is to be processed by the Audit process(es). The function define which type of collect or correlation to perform when updating this Global Object. The functione is empty by default and must be written.

Click on the Edit ScheduleObject Function to start the edition.

See here how to create GlobalObject LUA function creation.

Select after the IP reference. The IP reference define the LoriotPro master for this Global Object. If you don't have redondancy implemented enter the loopback address or select the LoriotPro object in the Directory.

Enter the Interval of time at which the LUA function should be executed by an Audit. Beware that the interval must be higher that the Audit process interval time.

Properties of a Global Object

Here under a table of the parameters of a Global Object

Name

A unique name that identify this Global Object

Group Name

Define the group name in which this Global Object belongs.

List box Group Scheduler function

Allows the selection of the function run by the Audit for that group.

Edit Group Scheduler function

Open the LUA editor and the Group Scheduler function

Param 1

The first argument provided to the attached LUA function

Param 2

The second argument provided to the attached LUA function

   

Scheduled

Run the associated LUA function at every audit interval. Yes or No.

If Yes the LUA function will be executed each time that an Audit managing this group of Global Object look at it and if the interval is timeout and if the Global Object is not locked by another Audit.

 

Scheduling Parameters

Locked

The access to this Global Object has conflicts.

Function Name

The name of the Global Object LUA function called by the Audit that update this Global Object

IP reference

An IP Reference provide as an argument to the LUA function. An IP Reference is a LoriotPro system, it must exist in all the Directories of all LoriotPro of the redundancey infrstructure and it must respond to SNMP requests.

check box Not Locally Backup

If checked the Global Object will not be monitored by this LoriotPro if the LoriotPro master of this Global Object failed (heartbeat lost).

Interval

The minimum interval of time between two execution of the Global Object LUA function

Interval Type

Allow to defined if the Interval value is in seconds or milliseconds

 

Pre-Scheduling Options

Check Type

Activate the check of the availability of a reference for a specified IP or UID before running the Global Object LUA function.

Check if IP status

Specify the IP of the host (must be defined in the LoriotPro Directory

Check if UID status

Specify the UID of the host (must be defined in the LoriotPro Directory

 

Current Global Object values

 

String

A string value for this object (example :  “this is a string”)

Double

A type double value for this object (example: 245.4501 )

Status

An integer value defining the current status (example: 2)

 

Autoload this object at startup with default values

The Current Global Object values will be initialized with the default values

Apply, Save and Quit Apply the change, save the change for the next startup of LoriotPro
Apply and Quit Apply the change and quit, the changes will not be restored at the next startup of LoriotPro

 

 

 



www.loriotpro.com