| Table of Contents |
|---|
NMIS code plugins are meant to augment and extend the update and collect functionality, if and when classic modelling doesn't suffice to handle a
particular scenario.
Each plugin must be valid perl, be named X.pm, must have a 'package X;' line, and its package name must not clash with the other NMIS components. the plugin MUST NOT use Exporter to export anything from its namespace.
It's recommended that the plugin have a version declaration right after the package line, i.e. 'our $VERSION = "1.2.3";'
The plugin may load extra perl modules with use or require, but it must not use any package-level global variables. all its variables and any objects that it might create must have local scope.
A plugin can offer one or more of the functions update_plugin(), collect_plugin() after_update_plugin() or after_collect_plugin().
...
- (0 or undef,rest ignored) means no changes were made, or that the plugin declined to run altogether (for example, because the environment doesn't match the plugin's needs
- (1,rest ignored) means changes were made to the sys object, and nmis should save the nodeinfo and view components.
- (2,list of error messages) means the plugin failed to work and NMIS should please log the error messages. no nodeinfo/view saving will be performed.
How to access the information in NMIS9
The following all assumes the following function initialization
| Code Block |
|---|
my (%args) = @_;
my ($node, $S, $C, $NG) = @args{qw(node sys config nmisng)}; |
Nodes
We can access the node object using the object sys:
| Code Block |
|---|
my $node_obj = $S->nmisng_node |
Collected Data - As Interfaces
We All the collected data is saved in a new structure called inventory. We can use as many filters that we need:
| Code Block |
|---|
my $host_ids = $node_obj->get_inventory_ids(
concept => "Host_Storage",
filter => { historic => 0 }); |
Log
We can log any message by using the NMISNG object:
| Code Block |
|---|
$NG->log->info("Working on $node Host Memory Calculations"); |
Installation
Just place the plugin into /usr/local/nmis9/conf/plugins and make sure it has the right permissions.
To fix permissions you can just run:
| Code Block |
|---|
/usr/local/nmis9/bin/nmis-cli act=fixperms |
You can test the plugin by running an update/collect for a node and check the log files (/usr/local/nmis9/logs/nmis.log).
You will see an info message like this:
| Code Block |
|---|
[Mon May 24 16:12:09 2020] [info] Host_Resources[8027] Running Host Resources plugin for node::test |
Example
You can see a complete example of a collect plugin in the Host_Resources plugin (Released in 9.1.2). There are many more plugins added to the NMIS9 project.
Porting Plugins from NMIS8 to NMIS9
Existing plugins in NMIS8 were ported to NMIS9, so there are many good examples on the changes to the API calls required. You can find all the ported and any new plugins in GitHub here: https://github.com/Opmantek/nmis9/tree/nmis9_dev/conf-default/plugins
Review the NMIS8 Host_Resources and NMIS9 Host_Resources plugin as a way to see how to easily port one.
If you have a support contract and need some assistance to port your plugin, you can open a support case: FirstWave Support