NOTE: This documentation is only relevant to Opmantek Products with NMIS8, when using NMIS9 node_admin.pl performs all necessary node administration functions for NMIS, opConfig and opEvents.
For NMIS9 and op Modules
Table of Contents
Table of Contents |
---|
opConfig and opEvents provide a number of different methods for managing nodes, both GUI-based and commandline-oriented. This document describes the commandline tool opnode_admin.pl
.
...
Run the tool with no options or -? or -h and it'll display a simple help page:
Code Block |
---|
./bin/usr/local/nmis9/admin/opnode_admin.pl Usage: opnode_admin.pl act=[action to take] [extras...] opnode_admin.pl act=list opnode_admin.pl act={create|export|update} node=nodeX opnode_admin.pl act=delete node=nodeX [deletedata=0/1] opnode_admin.pl act=show node=nodeX opnode_admin.pl act=set node=nodeX entry.propname=value... opnode_admin.pl act=mktemplate [placeholder=1/0] opnode_admin.pl act=rename old=nodeX new=nodeY mktemplate: prints blank template for node creation, optionally with __REPLACE_XX__ placeholder create: requires file=NewNodeDef.json export: exports to file=someFile.json (or STDOUT if no file given) update: updates existing node from file=someFile.json (or STDIN) delete: only deletes if confirm=yes (in uppercase) is given node events and config information are deleted only if deletedata is 1 or true. show: prints the nodes properties in the same format as set set: adjust one or more node properties |
...
Code Block |
---|
./bin/opnode_admin.pl act=show node=mel-router1 entry.active=true entry.activated.opConfig=1 entry.activated.opEvents=1 entry.customer=Sales entry.group=Melbourne entry.host=mel-router1 entry.nodeModel=CiscoRouter entry.nodeType=router entry.nodeVendor=Cisco Systems entry.nodedown=false entry.processorRam=99.61 Mb entry.softwareImage=C1841-ADVENTERPRISEK9-M entry.softwareVersion=12.4(25f) entry.sysContact=default ... |
...
Exporting all of a node's configuration (in JSON format) works like this, if you don't specify an output file to save the data in:
...
Code Block |
---|
./bin/opnode_admin.pl act=mktemplate placeholder=true // Please see https://docs.community.opmantekfirstwave.com/wiki/display/opCommon/Common+Node+Properties for detailed descriptions of the properties! ...lots more hopefully helpful comments { "activated" : { "opAddress" : "__REPLACE_opAddress_ACTIVATION__", ... |
...
This removes only the node configuration information but not existing opEvents or opConfig data for the node.To delete these as well, you can add the option deletedata=1
to the command, and all data related to this node will be removed permanently.