GatherNetworkInventory
The Oracle Communications Unified Assurance Topology Gather Network Inventory application gathers information about the network from devices in the device catalog using SNMP and enters it into inventory tables. This information is also used to create topology layout in the graph database. The following types of information will be discovered by default:
-
ARP entries
-
Bridge ports
-
CDP neighbors
-
Cisco VLANs
-
Interfaces
-
IP addresses
-
LLDP neighbors
-
MAC addresses
-
Ports
-
Routes
-
Trunks
You can run this application as a scheduled job using the Jobs UI.
Gather Network Inventory Setup
-
Discover or create devices in the Device Catalog. You can use auto discovery, manual discovery, or manually enter device information.
See Discovering Devices for information about auto and manual discovery, and Device Auto Discovery and Manual Discovery in Unified Assurance User's Guide for information about the discovery applications.
See Devices in Unified Assurance User's Guide for information about using the Devices UI to manually enter device information.
-
Run the Device SNMP Discovery job so that the Gather Network Inventory job can get data from the devices. See Device SNMP Discovery for more information.
-
Enable the default Gather Network Inventory job, unless you need to set specific configuration options. See Jobs in Unified Assurance User's Guide for information about using the Jobs UI.
Default Scheduled Job
The following table shows the settings for the default job. Actual values are in bold, descriptions of values are in plaintext.
Field | Value |
---|---|
Package | coreCollection-app |
Name | Topology Gather Network Inventory |
Program | bin/core/collection/GatherNetworkInventory |
Arguments | This field is blank. There is no default value. |
Description | Gather network inventory details from routers and switches |
Failover Type | Standalone (Supported: Standalone, Primary, Redundant/Backup) |
Status | Disabled |
Privileged | This option is selected. |
Minutes | 0 |
Hours | 11 |
Days | * |
Months | * |
WeekDays | * |
See Jobs in Unified Assurance User's Guide for general information about the settings for jobs.
See Using Application Primary/Backup Failover for more information about the different failover types.
Default Configuration
The following table shows the default configurations for the application. Actual values are in bold, descriptions of values are in plaintext.
Name | Default Value | Possible Values | Notes |
---|---|---|---|
BaseRules | collection/topology/inventory/base.rules | Text, 1-255 characters | The relative path to the application Base Rules file. |
BranchDir | core/default | Text, 255 characters | The relative path to the rules directory. |
IncludeRules | collection/topology/inventory/base.includes | Text, 1-255 characters | The relative path to the application Include Rules file. |
LoadRules | collection/topology/inventory/base.load | Text, 1-255 characters | The relative path to the application Load Rules file. |
LogFile | logs/TopologyGatherNetworkInventory.log | Text, 255 characters | The relative path to the log file. |
LogLevel | ERROR | OFF, FATAL, ERROR, WARN, INFO, DEBUG | The logging level for the application. |
Threads | 3 | An integer | Number of processing threads created. |
TimeOut | 5 | An integer | The time out for the SNMP connection. |
DBThreads | This field is blank. There is no default value. | An integer | (Optional) Number of database threads to be created. If not specified, defaults to a third (rounded up) of Threads application configuration. |
DeviceGroupID | This field is blank. There is no default value. | The name of any available device group. | (Optional) This entry is used to get a more specific list of devices to be polled for data. If 0, all device groups are gathered. |
DeviceZoneID | This field is blank. There is no default value. | All Zones or the name of any available device zone. | (Optional) This entry is used to get a more specific list of devices to be polled for data. If 0, all device zones are gathered. |
InterfaceType | This field is blank. There is no default value. | Text, 1-255 characters | (Optional) Overrides which value is used when creating the interface vertices. Possible values are IfName, IfDescr, IfAlias, IfIndex. |
Limit | This field is blank. There is no default value. | An integer | (Optional) Limits routes retrieved to this number. Defaults to 200 if no value is provided. |
PreferIPv4 | Disabled | Enabled or Disabled | (Optional) When present and set to true, GatherNetworkInventory will attempt to connect to remote devices using IPv4 if available. |
Skip | This field is blank. There is no default value. | Text, 255 characters. | (Optional) Comma separated list of items not to be retrieved. Possible values are Int, IP, Route, CDP, LLDP, Trunk, ARP, VLAN, MAC. |
DisablePruning | This field is blank. There is no default value. | Enabled or Disabled | (Optional) When enabled, GatherNetworkInventory will no longer prune old data. Note: If your network includes Frequentis devices, set this to Enabled to prevent them from being pruned. You can prune old data using custom rules instead. |
Best Practices
The following list shows you best practices for gathering network inventory.
-
The Topology Gather Network Inventory job is configured to run at 11:00 am every day.
-
Some devices with high interface counts can have trouble returning usable inventory data to the application using the default get-bulk SNMP request method. While the application may fall back to a get-next request, it slows down the discovery as it has to make multiple requests for the same data from the device. The following warning indicates issues with using get-bulk SNMP requests for a device:
[WARN] abc.example.com(xxx) [Interface Names]: "No Values Returned [The message size exceeded the buffer maxMsgSize of xxx]"
To optimize the gather for these high interface count devices, add the following MetaTag to the device to indicate the application should use get-next SNMP requests to obtain the data more reliably:
Type: SNMP, Value: ForceGetNext
Administration Details
The following list shows the technical details you will need for advanced administration of the application:
-
Package: coreCollection-app
-
Package: ./GatherNetworkInventory [OPTIONS]
-
Options
-c, --AppConfigID N Application Config ID (Service, Job, or Request ID) -d, --DeviceID N DeviceID (Optional) -?, -h, --Help Print usage and exit
-
Threaded: Multithreaded