Lua API

The ntopng core provides a LuaAPI to interact with it. The API is internally used by periodic scripts and GUI scripts to extract information or to apply configuration changes.

Custom checks can use the API, for example, to provide new data visualizations or extract the data to send it to an external program.

Since some API functions can return very complex objects, which will not be covered here, the suggestion is to use the utility function tprint to print out the result a the function to figure out its format.

The Lua C API consists of two main objects:

• the ntop object is used to access global ntopng functions, which are not bound to a specific network interface.
• the interface object is used to access a specific network interface functions.

For example, the flows information is a network interface specific information, so it’s available through the interface object API via interface.getFlowsInfo().

• 1. ntop Lua Object
  • 1.1. Cache API
  • 1.2. Prefs API
  • 1.3. Filesystem API
  • 1.4. Network API
  • 1.5. Users API
  • 1.6. Misc API
• 2. interface Lua Object
  • 2.1. Hosts API
  • 2.2. Flows API
  • 2.3. Misc API
  • 2.4. MACs API
  • 2.5. nDPI API
  • 2.6. Dump API
• 3. Host Checks
  • 3.1. Operational Mode
  • 3.2. Script Example
  • 3.3. Host Object Methods
• 4. Flow Checks
  • 4.1. Operational Mode
  • 4.2. Script Example
  • 4.3. Flow Object Methods
• 5. Interface Checks
• 6. Network Checks