GenericFileStitcher
The Oracle Communications Unified Assurance Topology File Stitcher can be used to create device relationships in the graph database. It takes a flat file of device information and makes it available to rules for special processing and entry into the graph database.
The Topology NMAP Stitcher is a default job that utilizes the File Stitcher to create graph database relationships after doing an NMAP scan of the network.
You can run this application as a scheduled job 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 NMAP Stitcher |
Program | bin/core/collection/GenericFileStitcher |
Arguments | This field is blank. There is no default value. |
Description | Create and update Hierarchy from network inventory for Layer4 via NMAP |
Failover Type | Standalone (Supported: Standalone, Primary, Redundant/Backup) |
Status | Disabled |
Privileged | This option is selected. |
Minutes | 0 |
Hours | 20 |
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/file/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. |
File | /var/log/nmap | Text, 255 characters | Full path to the file that will be read and processed. |
IncludeRules | collection/topology/file/base.includes | Text, 255 characters | The relative path to the application Include Rules file. |
LoadRules | collection/topology/file/base.load | Text, 255 characters | The relative path to the application Load Rules file. |
LogFile | logs/TopologyNMAPStitcher.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. |
Best Practices
- The default job is configured to run at 8:00 pm every day, but the default perspective stitcher is configured to run at 9:00 pm every day.
Rules
This stitcher uses the Unified Assurance standard rules architecture in Perl syntax. For information about creating rules, see the following in Unified Assurance Developer's Guide:
Tokens
The stitcher exposes the following tokens for use in rules processing.
Token | Description |
---|---|
$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'.) |
$line | Current line of the input file. |
$Count | Line number for current line of the input file. |
Administration Details
The following list shows the technical details you will need for advanced administration of the application:
-
Package: coreCollection-app
-
Package:
./GenericFileStitcher [OPTIONS]
-
Options:
-c, --AppConfigID N Application Config ID (Service, Job, or Request ID) -?, -h, --Help Print usage and exit
-
Threaded: Single Threaded