Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

These are used by all Opmantek products (exception: NMIS does not use the addresses property). Only the first two, name and hostname host,are absolutely necessary properties. 

The properties shown in italic are not directly interpreted by the applications and are completely optional.

Property NameDescription
name

The internal name of the node. This is used for identifying and displaying the node, not for communication with the node!

host

The DNS name, unqualified host name or main IP address for this  node. Using a fully qualified DNS host name is recommended.

addresses

A list containing any secondary IP addresses that should also be associated with this node.
This list is often empty. NMIS does not use this property.

group

The (single) group that this node belongs to, which is used to control what nodes a user is allowed to see.

notes

Free-form notes for a node, which are shown on the relevant context pages. (optional)

commentsA list of originator- and time-tagged comments for this node. (optional, supported in opEvents 2.0 and newer)
locationThe location of the node. (optional)
businessServiceThe service the node provides. (optional)

...

Status
colourYellow
titleopConfig 4
  This properties are accessible in the configuration hash. As an example, platform should be accessed as configuration.os_info.platform

opEvents Properties

The current version of opEvents , 1.2.6, does not make use of does have a product-specific propertiesnode property: activated.opEvents

NMIS Properties

NMIS uses further properties to control its operations, mostly things like SNMP-related identities, node active and collect flags, etc. The table below describes the most important properties that NMIS interprets or understands.

Whenever a node in opConfig or opEvents is refreshed/imported from NMIS, all of NMIS' node properties are also transferred. These properties are currently not used by opConfig or opEvents, but will show up when you export a node using opnode_admin. Your opEvents and opConfig policies can make use of these properties, you can edit them with opnode_admin (and, to some extent, via the GUI if you modify the configuration variables opevents_gui_node_summary_list and/or opconfig_gui_node_summary_list).


authkey

privkey
Property NameDescription
activewhether the node is active and handled by NMIS or should be ignored
collectwhether SNMP data should be collected from this node
pingwhether reachability statistics should be collected for this node
model

what type of device this is (default: "automatic")

versionsnmpv1, snmpv2c or snmpv3; relevant only if collect is true
communityread-only community string for access using snmpv1 or snmpv2c
netTypewan or lan
roleTypecore, access or distribution - the three layers of the Cisco three-layer hierarchical network model

username
authprotocol
authpassword

privprotocol
privpassword

authentication and privacy parameters for SNMP Version 3

authkey

privkey

Alternative password parameters for SNMP Version 3. Optionally, theauthkey and privkey can be used so that a plain text password does not have to be specified (see Net::SNMP). 
The 
snmpkey utility can be used to create the hexadecimal key string with the authoritativeEngineID (MAC address) for the destination device (see snmpkey).
portwhich port to use for SNMP access (default: 161)
timezonewhich timezone this system is in, numeric offset
webserverwhether the node runs a webserver.
if true, a link to the node is presented in the NMIS GUI
thresholdwhether thresholds are to be processed for this node
cbqoswhether Quality of Service data should be collected for this node
(if the device and model support QoS)

Status
colourYellow
titleNMIS 9
  This properties are accessible in the configuration hash. As an example, collect should be query as configuration.collect