Page Comparison

Introduction

In NMIS and opCharts we can add custom validations for custom fields in the nodes table.

This is a list of the steps the customer needs to follow :-

In this example we are using "device_ci" as the name of our custom field and "Device CI" as the label to be displayed in the screens.

NOTE: Telmex uses just "ci" so the info below has been changed to just use "ci"

1) The steps below are how to accomplish the validation and integration.

Add the custom field to

...

NMIS 

This is done by adding a code block similar to the below in /usr/local/nmis9/conf-default/Table-Nodes.nmis.

NOTE: If this configuration file does not currently exist in the /usr/local/nmis9/conf/ directory, it will need to be copied from /usr/local/nmis9/conf-default.

{ ci => { header => 'CI', display => 'header,text',value => [""] }}, 

2) Modify the node_summary_field_list list attribute

To include the new custom field (ci), this is done by updating 'node_summary_field_list' in /usr/local/nmis9/conf/Config.nmis to the below.

'node_summary_field_list' => 'host,uuid,customer,ci,businessService,serviceStatus,snmpdown,wmidown',

Image Removed

3) Add a Adding custom index in Config.nmis

In /usr/local/nmis9/conf/Config.nmis ::database:: add the following code block under the 'database' section of the configuration.

'custom_indices' => {
      'nodes' => [
          [ {'configuration.ci' => 1}, { unique => 1, partialFilterExpression => { "configuration.ci" => { '$exists' => true } }  }] 
        ]
}

Image Removed

Then verify by running the following commandThe end result will look similar to the below.Image Added

Once the above has been completed, then save the file. You can also verify that the code is valid by executing the below command.

perl -c /usr/local/nmis9/conf/Config.nmis

Image Removed4) If it returns something other than /usr/local/nmis9/conf/Config.nmis syntax OK, you will need to verify that the configurations have been added correctly.

After the addition of custom indices, please run ensure indexes to add custom index. you will also need to run the below command.

/usr/local/nmis9/bin/nmis-cli act=ensure_indexes debug=9

...

...

Add the Device CI to

...

opCharts and Node Admin Schemas

Node Admin:
Copy /usr/local/omk/lib/json/admin/table_schemas/admin_node-ip.json to /usr/local/omk/conf/table_schemas/ and add in the below:

{
   "name": "nodes.configuration.ci",
   "label": "CI",
   "cell": "String",
   "editable": false,
   "search": "iregex"
}

6) Add the Device CI to the opCharts node table schema

opCharts:
Copy /usr/local/omk/lib/json/opCharts/table_schemas/opCharts_node-list.json to /usr/local/omk/conf/table_schemas and add in the below:

{
   "name": "nodes.configuration.ci",
   "label": "CI",
   "cell": "String",
   "editable": false,
   "search": "iregex"
}

7) Add the Device CI to the admin edit node fields. (admin_nodes.json file will need to be created in the "/usr/local/omk/conf/form_schemas/" directory )

vi Node Admin Edit Node Fields:

Create /usr/local/omk/conf/form_schemas/admin_nodes.json and add in the below:

{"label": "Device Ci",
 "description": "Edit in conf/form_schemas/admin_nodes.json",
 "component": ["node_admin"],
 "tags": ["node"],
 "schema": {
         "configuration.ci": {
                 "title": "CI",
                 "type": "Text"}
 }}
}

8) Add the Device CI to omk/opCharts/nodes so it shows in the node info tablevi opCharts Node Summary Table:

Copy /usr/local/omk/lib/json/opCharts/table_schemas/opCharts_node-summary-table.json to /usr/local/omk/conf/table_schemas/ and add the device_ci as shown below:

// VERSION=1.518.0
[  
  "group",
  "host",
  "host_addr",
  "location",
  "nodeVendor",
  "nodeModel",
  { "name" : "ci", "label": "CI", "cell": "String"},
  { "name" : "sysDescr", "label": "sysDescr", "cell": "Tooltip", "formatter": "ShortenedString", "maxLength" : 48},
  { "name" : "lastUpdateSec", "label" : "Last Updated", "cell" : "String", "formatter" : "UnixTime"},
  { "name" : "sysUpTimeSec", "label" : "Uptime", "cell" : "String", "formatter" : "UpTime"},
  { "name" : "remote", "label" : "Managed by"}
]

Final Steps

9) Create a directory called named plugins_available @ in /usr/local/nmis9/conf-default/:

cd /usr/local/nmis9/conf-default/
mkdir plugins_available

Copy the NodeValidation.pm from /usr/local/nmis9/conf-default/validation_plugins/NodeValidation.pm into the plugins_available directory.

Then cd change directory into the /usr/local/nmis9/conf-default/plugins/

cd /usr/local/nmis9/conf-default/
mkdir plugins_available
cp /usr/local/nmis9/conf-default/validation_plugins/NodeValidation.pm  /usr/local/nmis9/conf-default/plugins_available/
cd plugins

 
10) Create a soft link of that file in plugins:

ln -s /usr/local/nmis9/conf-default/plugins_available/NodeValidations.pm NodeValidations.pm

11) Finally restart services

...

Once the above has been completed, then restart nmis9d and omkd services.

sudo service nmis9d restart
sudo service omkd restart

...