Assure1 Topology File Stitcher¶
Overview¶
The Assure1 Topology File Stitcher can be used to create device relationships in the Orient Database. It takes a flat file of device information and makes it available to rules for special processing and entry into the Orient Database.
The "Topology NMAP Stitcher" is a default job that utilizes the File Stitcher to create Orient Database relationships after doing an NMAP scan of the network.
File Stitcher Setup¶
Default Scheduled Job¶
| Field | Value |
|---|---|
| Package Name | coreCollection-app |
| Job Name | Topology NMAP Stitcher |
| Job Program | bin/core/collection/GenericFileStitcher |
| Job Arguments | |
| Job Description | Create and update Hierarchy from network inventory for Layer4 via NMAP |
| Failover Type | Standalone (Supported: Standalone, Primary/Backup) |
| Status | Disabled |
| Privileged | (Checked) |
| Minutes | 0 |
| Hours | 20 |
| Days | * |
| Months | * |
| WeekDays | * |
Default Configuration¶
| Name | Value | Possible Values | Notes |
|---|---|---|---|
| BaseRules | collection/topology/file/base.rules | Text, 255 characters | Relative path to Base Rules |
| BranchDir | core/default | Text, 255 characters | relative path to Rules dir |
| 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 | Relative path to Include Rules |
| LoadRules | collection/topology/file/base.load | Text, 255 characters | Relative path to Load Rules |
| LogFile | logs/TopologyNMAPStitcher.log | Text, 255 characters | Relative path to Log File. |
| LogLevel | ERROR | OFF, FATAL, ERROR, WARN, INFO, DEBUG | Logging level used by 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 Assure1 standard rules architecture, which are 100% Perl syntax. Refer to the following articles to assist in rules creation:
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. |
Example Integration¶
NOTE: this section will be coming soon as some needed core functionality is not available yet. (Get examples out of v4 "Writing_Flat_File_Stitcher_Rules" and "Using_the_Flat_File_Stitcher" guides.)
Administration Details¶
The following list shows the technical details needed for advanced administration of the application:
-
Package - coreCollection-app
-
Synopsis -
./GenericFileStitcher [OPTIONS] -
Options:
-c, --AppConfigID N Application Config ID (Service, Job, or Request ID) -?, -h, --Help Print usage and exit -
Threaded - Single Threaded