OOBC default configuration file
The oobc.properties.xml file is the default configuration file for the
OOBC software.
All configuration parameters are set in this file except for LOG4J property settings, which are in the log4j2.xml file.
Note: In versions of Netcool Configuration
Manager
prior to Fix Pack 16, the LOG4J property settings file was called
log4j.xml.
The XML schema for the oobc.properties.xml configuration file can be
found in the installation directory of the OOBC software.
Sample
The following is an example oobc.properties.xml file with sample
values. The remainder of this section will dissect each portion of the XML file and
explain its purpose.
<?xml version="1.0"?>
<out-of-band-change xmlns="http://intelliden.com/oobc/properties"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="
http://intelliden.com/oobc/properties
..\OutOfBandProperties.xsd">
<!-- Properties to configure what and how we monitor -->
<monitor>
<logFile>/opt/OutOfBandChange/run1/local7.log</logFile>
<markerFile>/opt/OutOfBandChange/run1/log.marker</markerFile>
<syslogMessageSaverFile>/opt/OutOfBandChange/run1/log.syslog-messages</
syslogMessageSaverFile>
<recoveryFile>/opt/OutOfBandChange/run1/log.recovery</recoveryFile>
<pollFrequencySeconds>5</pollFrequencySeconds>
<rollupAlgorithm>IdleTimeout</rollupAlgorithm>
<rollupFrequencySeconds>1800</rollupFrequencySeconds>
<fatalRestartSeconds>15</fatalRestartSeconds>
<notifyOnUnmanaged>true</notifyOnUnmanaged>
</monitor>
<!-- ITNCM API access settings -->
<intelliden-server>
<host>10.0.0.2</host>
<port>16310</port>
<user>OOBCUser</user>
<password>ce6f3ea926ad712172f8f9d7a67ccc07</password>
<protocol>iiop</protocol>
<initialContextFactory>com.ibm.websphere.naming.WsnInitialContext-
Factory</initialContextFactory>
</intelliden-server>
<!-- List of ITNCM and other third party system users -->
<!-- List of ITNCM worker servers -->
<worker-servers>
<server>intelliden</server>
</worker-servers>
<syslog-users>
<!-- ITNCM system users do work on behalf of ITNCM.
Syslog entries that contain these user ID's are skipped. -->
<intelliden-users>
<user>intelliden</user>
</intelliden-users>
<!-- Third party system users do work that needs synchronizationinto ITNCM but
nobody needs to be notified. -->
<authorized-users>
<user>3rdPartyUser</user>
</authorized-users>
</syslog-users>
<syslog-match>
<!-- this pattern matches the most common log messages like
Apr 17 06:46:24 test_2-1 12980: Apr 17 02:46:23.318 EDT: %SYS-
5-CONFIG_I: Configured from console by unknown on vty0 (10.0.0.1)
-->
<log-pattern actionName="ConfigSyncIn" uowPriority="LOW" notifyName="
FileNotifier">
<pattern>([A-S][a-u][by]\
s+\d{1,2}\s+\d{2}:\d{2}:\d{2})\s+\[?([\.A-Za-z0-9_-
]+)\]?[\.\S+]*\s+.*?SYS-5-CONFIG_I:\s(Configured\
sfrom.*by\s(.*)\s+on\s(.*$))</pattern>
<timeStampIndex>1</timeStampIndex>
<dnsNameIndex>2</dnsNameIndex>
<userIdIndex>4</userIdIndex>
<descriptionIndex>3</descriptionIndex>
<sourceHostIndex>5</sourceHostIndex>
</log-pattern>
<!-- this pattern matches the most common log messages like
Apr 17 11:53:24 test_3-2 12984: Apr 17 07:52:23.318
%SYS-5-CONFIG_I: Configured from console by cisco on console
-->
<log-pattern actionName="ConfigSyncIn" uowPriority="LOW" notifyName="
FileNotifier">
<pattern>([A-S][a-u][by]\
s+\d{1,2}\s+\d{2}:\d{2}:\d{2})\s+\[?([\.A-Za-z0-9_-
]+)\]?[\.\S+]*\s+.*?SYS-5-CONFIG_I:\s(Configured\
sfrom.*by\s(.*)\s+on\s(.*$))</pattern>
<timeStampIndex>1</timeStampIndex>
<dnsNameIndex>2</dnsNameIndex>
<userIdIndex>4</userIdIndex>
<descriptionIndex>3</descriptionIndex>
<sourceHostIndex>5</sourceHostIndex>
</log-pattern>
<!-- this pattern matches the most common log messages like
Apr 17 11:53:24 test_3-2 12984: Apr 17 07:52:23.318
%SYS-5-CONFIG_I: Configured from console by vty0 (10.0.0.1)
-->
<log-pattern actionName="ConfigSyncIn" uowPriority="LOW" notifyName="
FileNotifier">
<pattern>([A-S][a-u][by]\
s+\d{1,2}\s+\d{2}:\d{2}:\d{2})\s+\[?([\.A-Za-z0-9_-
]+)\]?[\.\S+]*\s+.*?SYS-5-CONFIG_I:\s(Configured\
sfrom.*by\s(.*)\s+on\s(.*$))</pattern>
<timeStampIndex>1</timeStampIndex>
<dnsNameIndex>2</dnsNameIndex>
<userIdIndex>4</userIdIndex>
<descriptionIndex>3</descriptionIndex>
<sourceHostIndex>5</sourceHostIndex>
</log-pattern>
<log-pattern actionName="Import" uowPriority="HIGH" notifyName="FileNotifier">
<pattern>([A-S][a-u][by]\
s+\d{1,2}\s+\d{2}:\d{2}:\d{2})\s+\[?([\.A-Za-z0-9_-
]+)\]?[\.\S+]*\s+.*?SYS-5-SUMTHIN_ELSE:\s(Configured\
sfrom.*by\s(.*)\s+on\s(.*$))</pattern>
<timeStampIndex>1</timeStampIndex>
<dnsNameIndex>2</dnsNameIndex>
<userIdIndex>4</userIdIndex>
<descriptionIndex>3</descriptionIndex>
<sourceHostIndex>5</sourceHostIndex>
</log-pattern>
<log-pattern actionName="Reload" uowPriority="MEDIUM" notifyName="
FileNotifier">
<pattern>([A-S][a-u][by]\
s+\d{1,2}\s+\d{2}:\d{2}:\d{2})\s+\[?([\.A-Za-z0-9_-
]+)\]?[\.\S+]*\s+.*?SYS-5-RELOAD:\s(Reload\srequested\
sby\s(.*)\s+on\s(.*$))</pattern>
<timeStampIndex>1</timeStampIndex>
<dnsNameIndex>2</dnsNameIndex>
<userIdIndex>4</userIdIndex>
<descriptionIndex>3</descriptionIndex>
<sourceHostIndex>5</sourceHostIndex>
</log-pattern>
</syslog-match>
<!--
All current implementations of the OutOfBandAction interface.
These actions are referenced by name from a log-pattern match.
An instance of the OutOfBandAction class is invoked whenever a syslog
match is found. It is the responsibility of the action object
to take whatever steps are necessary to synchronize the out-of-band
changes to the network device with ITNCM or vice versa.
-->
<actions>
<action name="Import" priority="2">
<className>com.intelliden.oobc.impl.ImportFromDevice</className>
<properties>
<property name="overrideConflicts" value="true"/>
</properties>
</action>
<action name="ConfigSyncIn" priority="3">
<className>com.intelliden.oobc.impl.SynchronizeFromDevice</
className>
<properties>
<property name="overrideConflicts" value="true"/>
</properties>
</action>
<action name="Reload" priority="1">
<className>com.intelliden.oobc.impl.ReloadAction</className>
<properties>
<property name="overrideConflicts" value="true"/>
<property name="secondsBetweenUOWs" value="30"/>
<property name="realmPath" value="ITNCM/commandSets"/>
<property name="commandSetName" value="testCommandSet"/>
</properties>
</action>
</actions>
<!--
The default implementation of the OutOfBandNotifier interface.
The OutOfBandNotifier is notified of non-ITNCM and un-Authorized
user access to an ITNCM managed network resources.
The following implementation is a file notifier which writes formatted
messages to the output file.
-->
<notifiers>
<notify name="FileNotifier" priority="1">
<className>com.intelliden.oobc.impl.FileSerializer</className>
<pollFrequency>5000</pollFrequency>
<properties>
<property name="outFile" value="/opt/OutOfBandChange/run2/
notification.log"/>
<property name="format"
value="{0,date,yyyyMMddHHmmss'Z'}|{1}|ITNCMAlarm|{2}|{3} of
{4} syslog events. {5}"/>
<property name="formatDNF"
value="{0,date,yyyyMMddHHmmss'Z'}|{1}|ITNCMNot-
Found|{2}|Device {1} not currently managed by ITNCM. {3} of {4} syslog
events. {5}"/>
</properties>
</notify>
</notifiers>
</out-of-band-change>