User Tools
Table of Contents
Config Sync Scripts
Author: Eoin Joy
These scripts operate in a similar way to Alarm Sync Scripts and Performance Discovery Scripts in that they perform the same kind of two-step process, with the first step being the data retrieval.
In this case the second step is creating a list of configuration settings that were discovered from the controller and its children.
Additional Configuration
configGetType
OutboundTaskType – Used to determine what strategy will be used to retrieve the information, such as HTTP_GET or SNMP_SUBTREE.
configMib
Should the configGetType be SNMP_TABLE, then the Mib object containing the table needs to be set.
Retrieve Path
Used for all types to determine either what URLs to retrieve, or what SNMP OIDs to poll.
Return Value
List< Map< String, String > > – A list of String to String maps containing a path and optional identifier value.
Inserted Variables
networkElement – NetworkElement – The controller that we wish to perform the sync on.
Parameter Populate
Used for HTTP_POST type syncs to determine what data should be inserted into the postData such as some JSON requests. Executed for every path in the pathMapList generated by the Retrieve Path script.
Return Value
Map< String, String > – The postData required for the given path.
Inserted Variables
jobType – JobType – Used to determine in the script which postData should be returned, eg. ALARM_SYNC or ALARM_SEVERITY_SYNC.
httpSession – GroovyHttpSessionManager – Holds the current session connected to the given controller.
path – String – The path to calculate the postData for.
url – String – The full URL (protocol + ipAddress + port + path) to calculate the postData for.
pathMap – Map< String, String > – The map containing the path and identifier data for this entry as calculated in the Retrieve Path script.
Config Value Parse
This script takes the retrieved information regardless of strategy and parses it into the configuration values that will be compared against what is currently in the database.
Return Value
NetworkElementConfigBase – Part of a structure where a Base has many NetworkElementConfigKey objects which themselves have several NetworkElementConfigValue objects. The mapping between these allows for easy retrieval per controller or per NetworkElement.
Inserted Variables
networkElement – NetworkElement – The controller the sync is being performed on.
pathResultMap – Map< String, String > – The combined results of the retrieved data from the paths generated in the Retrieve Path script.
voList – List< SnmpDataVO > – The list of results received from the SNMP type gets as SnmpDataVO objects.