itnmMetaDiscoAudit.pl

Use the itnmMetaDiscoAudit.pl script to generate a report that contains audit information on device classification, and missing device metadata. The output also includes templates of SQL inserts that you can use to rectify missing metadata issues.

Generate a report

To run the script to generate a report, use a command similar to the following example:

$NCHOME/precision/bin/ncp_perl $NCHOME/precision/scripts/perl/scripts/
itnmMetaDiscoAudit.pl –domain NCOMS –report > my_report.txt

Generate a report for specific devices

To run the script to generate a report for specific devices use a command similar to the following example
Note: The -entity command-line option can be used multiple times, In this example it is used twice, once with an entity identifier, and the second time with an IP address.
: 
$NCHOME/precision/bin/ncp_perl $NCHOME/precision/scripts/perl/scripts/
itnmMetaDiscoAudit.pl –domain NCOMS –report –entity 500 –entity 10.10.10.1 
> my_report.txt

Generate a report to exclude specific device classes (AOCs)

To run the script to generate a report that excludes specific device classes, use a command similar to the following example:
$NCHOME/precision/bin/ncp_perl $NCHOME/precision/scripts/perl/scripts/
itnmMetaDiscoAudit.pl –domain NCOMS –report –exclude AIX –exclude Sun

View device membership for specified device classes (AOCs)

To run the script to view device membership for specified device classes, use a command similar to the following example:

$NCHOME/precision/bin/ncp_perl $NCHOME/precision/scripts/perl/scripts/
itnmMetaDiscoAudit.pl –domain NCOMS –showClassCisco –showClassIBM

Command line options

The following table describes the command line options for the script.

Table 1. itnmMetaDiscoAudit.pl command line options
Command line option Description
-domain DomainName Mandatory; the name of the domain where you want to start, stop, or display status of a discovery.
-report Optional; instructs the script to generate the output in a report.
-showclass Optional; instructs the script to produce output that shows device membership for specified device classes.
Note: The -showclass option cannot be used with the -report option.
-version Prints the version and exits.
-entity entity ID | entity name |IP address Optional; instructs the script to produce output for specific entities only. Entities can be specified by NCIM topology database entity identifier, by IP address, or by entity name.
Note: This option can be used multiple times.
-exclude parameter Optional; instructs the script to produce output that excludes specified parameters from the output tables; for example, entityId, className, or sysObjectId.
Note: This option can be used multiple times.
-maxTableRows number Limits the output table sizes to the specified number of rows. The default is 250 rows.
-timeLimit seconds Limits the tool runtime to the specified number of seconds. The default is 300 seconds (5 minutes).
-help Displays help.
-debug Runs the script in debug mode.
-v Optional; provides more information on the screen.

Script output

The script generates output in the following distinct sections:
AOC Class Hierarchy and Device Membership
Visualizes the AOC device class tree and indicates how many devices are in each class. The marker ### is used to bring specific AOC classes to your attention. For example, consider the following output snippet:
           1 Core 
           5 |--- NetworkDevice 3 device(s) ###
         127 | |--- Redback (Router)  
          71 | |--- Dasan (Switch)  
         118 | |--- Nortel (NetworkDevice)  
         119 | | |--- BayWellfleet (Router)  
         120 | | |--- Centillion (Switch)  
         121 | | |--- NortelEthernetRoutingSwitch (Router)  
         123 | |  `-- NortelPassport (Switch)  
         124 | |   |--- NortelPassport15000 (Switch)  
         171 | |   |--- NortelPassport8xxx (Switch)  
         125 | |    `-- NortelPassport7000 (Switch)  
         358 | |--- Moxa (NetworkDevice)  
         359 | |  `-- MoxaNPortExpress (NetworkDevice)  
         220 | |--- RANBaseStation (Transmitter)  
          11 | |--- Adtran (Router)  
          12 | | |--- AdtranMX2800 (Router)  
          13 | |  `-- AdtranNetVanta (Router)
The second line reads as follows:
           5 |--- NetworkDevice 3 device(s) ###

This line contains the following elements:

Device class identifier
In this line of output, the device class identifier is 5, corresponding to the NetworkDevice class.
Device class name
In this line of output, the device class name is NetworkDevice.
Number of devices in this class
This line of output reads 3 device(s). This statement means that the NetworkDevice class contains 3 devices.
Note: If there is no text after the class name, then there are no devices in the class. For example, in the preceding output snippet the only class that contains devices is the NetworkDevice class.
Suggestion to reclassify (###)
The presence of the ### marker means that you should consider reclassifying the devices in the current device class into a more specific class. For example, in this line of output there are 3 devices in the NetworkDevice class. The NetworkDevice class is a container class and ideally would not directly contain devices: Container classes should contain other device classes rather than devices. If, for example, the three devices under NetworkDevice were a new type of Cisco device then these devices should be reclassified into a more specific class, such as Cisco, or, even better, into a subclass of Cisco.
Device Discovery Audit
Lists the devices with missing MIB data, and highlights the MIB data fields that are missing for each device listed. For each device, the following identifying information is provided:
  • Entity identifier (entityId)
  • Entity name
  • IP address
  • Device class
  • MIB system object ID
For each device, the output lists MIB data fields and highlights missing fields with the marker ###.
Metadata Audit
Lists the devices with missing metadata, and highlights the metadata fields that are missing for each device listed. For each device, the following identifying information is provided:
  • Entity identifier (entityId)
  • Entity name
  • IP address
  • Device class
  • MIB system object ID
For each device, the output lists metadata fields and highlights missing fields with the marker ###.
Recommended SQL Inserts
Lists recommended SQL insert templates. Use these templates to add the missing metadata to the database. The templates highlight the information that you need to add to get a working insert. For example, in the output that follows, you must provide values to replace the following dummy entries:
  • __deviceModel__
  • __deviceFunction__
INSERT INTO deviceFunction VALUES ('Avocent', '1.3.6.1.4.1.10418', 
'1.3.6.1.4.1.10418.7.1.3', '__deviceModel__', '__deviceFunction__');
INSERT INTO deviceFunction VALUES ('Cisco', '1.3.6.1.4.1.9', 
'1.3.6.1.4.1.9.1.1642', '__deviceModel__', '__deviceFunction__');
INSERT INTO deviceFunction VALUES ('Extreme Networks', '1.3.6.1.4.1.1916', 
'1.3.6.1.4.1.1916.2.93', '__deviceModel__', '__deviceFunction__');