DeviceSNMPDiscovery
The Oracle Communications Unified Assurance Core Device SNMP Discovery application utilizes SNMP and SNMP Access Profiles to obtain additional information about devices marked as Verified in the Device Catalog. The application will also periodically re-test SNMP Access Profiles for devices that had been previously discovered. Unified Assurance uses this information to apply a Device Type to the device in the Device Catalog. Rules files can also be utilized with this application to further customize the Device Catalog record for the device based upon the returned data. If discovery was successfully completed via this application, the device State appears as Discovered in the Device Catalog.
Device SNMP Discovery Setup
-
Add an SNMP Access Profile(s) or modify existing SNMP Access Profiles:
-
Enable the default Job, unless a specific configuration option is needed.
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 | Device SNMP Discovery |
| Program | bin/core/collection/DeviceSNMPDiscovery |
| Arguments | This field is blank. There is no default value. |
| Description | Runs SNMP Discovery Profiles for Device Catalog |
| Failover Type | Standalone (Supported: Standalone, Primary, Redundant/Backup) |
| Status | Disabled |
| Privileged | This option is selected. |
| Minutes | 59 |
| Hours | 23 |
| Days | * |
| Months | * |
| WeekDays | 6 |
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/discovery/snmp/base.rules | Text, 255 characters | The relative path to the application Base Rules file. |
| BranchDir | core/default | Text, 255 characters | The relative path to the rules directory. |
| ExpireTime | 1209600 | An integer | How long to wait (in seconds) before rediscovery of a device is tried. |
| IncludeRules | collection/discovery/snmp/base.includes | Text, 255 characters | The relative path to the application Include Rules file. |
| LoadRules | collection/discovery/snmp/base.load | Text, 255 characters | The relative path to the application Load Rules file. |
| LogFile | logs/DeviceSNMPDiscovery.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. |
| PreferIPv4 | Enabled | Enabled or Disabled | Controls whether or not to prefer IPv4 transport to communicate with Devices. This option is only considered if both IPv4 and IPv6 are available for a device. If this configuration is missing, IPv6 will be preferred. |
| Threads | 3 | An integer | The number of process threads created. |
| TimeOut | 5 | An integer | The time out for the SNMP connection. |
| DeviceZoneID | Default First Zone | All Zones or the name of any available device zone. | (Optional) If specified, only the devices in the given zone are discovered. If not specified or set to '[All Zones]', discovers devices in all zones. |
Best Practice
- The default job configuration runs at 11:59 pm every Saturday.
Rules
This application uses the Unified Assurance standard rules architecture in Perl syntax. For information about creating rules, see the following in Unified Assurance Developer's Guide:
-
Core for information about core rules functions.
Tokens
The application exposes the following tokens for rules processing.
| Token | Description |
|---|---|
| $DeviceID | Device's internal DeviceID. |
| $DNS | DNS Address of Device. |
| $IPv4 | IPv4 Address of Device. |
| $IPv6 | IPv6 Address of the Device. |
| $SysOID | Device System Object Identifier (preferred method, same as using $SNMPInfo->{'SysObjectID'}). |
| $SNMPInfo->{'Version'} | SNMP version used. |
| $SNMPInfo->{'AccessProfileID'} | SNMP Access profile ID used for this device in Unified Assurance. |
| $SNMPInfo->{'AccessProfileName'} | SNMP Access profile name used for this device in Unified Assurance. |
| $SNMPInfo->{'SysObjectID'} | System Object ID (same as using $SysOID). |
| $SNMPInfo->{'SysName'} | System Name. |
| $SNMPInfo->{'SysContact'} | System Contact. |
| $SNMPInfo->{'SysLocation'} | System Location. |
| $SNMPInfo->{'SysServices'} | System Services. |
| $SNMPInfo->{'SysDescr'} | System Description. |
| $SNMPInfo->{'Serial'} | Serial. |
| $SNMPInfo->{'IPForward'} | IP Forward. |
| $AppConfig | Hash reference to the application configuration name-value pairs that were configured. (i.e. use $AppConfig->{'Host'} to retrieve the set value for 'Host'.) |
| $Session | Net::SNMP session object connected to the device. For advanced discovery of device information only. |
Administration Details
The following list shows the technical details you will need for advanced administration of the application:
-
Package: coreCollection-app
-
Package:
./DeviceSNMPDiscovery [OPTIONS] -
Options:
-c, --AppConfigID N Application Config ID (Service, Job, or Request ID) -d, --Device S Comma separated list of devices to manually discover -?, -h, --Help Print usage and exit -
Threaded: Multithreaded