2 About the Cartridge Components
This chapter provides information about the components of the Oracle Communications Network Integrity IP Assimilation Cartridge.
The IP Assimilation Cartridge contains the following actions:
Assimilate IP Links
Assimilate IP Links action reads the results of discovery scans and creates links between the discovered devices.
Assimilation is based on the characteristics of discovered devices, as given below:
-
Device Interface Configuration Item: IP Address, IP Version and Subnet Mask values are considered to create links between device interfaces. Device interfaces are identified using the following characteristics: ipAddress, ipVersion (with value IPv4) and prefix (with subnet mask values 255.255.255.252 or 255.255.255.254).
Note:
Assimilation is only supposerted for device interfaces with ipVersion value as IPv4.
-
Device Interface Characteristics: Device Interface characteristics name, nativeEMSName, specification name, mgmtIPAddress, description, ifSpeed and highSpeed are considered in modeling pipes and pipe termination points.
If a link is discovered on a media interface, then a flow interface is created and assigned to the media interface upon reconciliation and the connectivity is closed on the flow interface. If a link is discovered on an interface with ifType "l2vlan", then a flow interface is created and assigned to parent interface of l2vlan, and connectivity is closed on the flow interface.
The format of a topological link name is A side Logical Device-A side device interface!Z side Logical Device-Z side device interface. This name is used as a connectivity identifier and is stored as a characteristic (tlName) in UIM.
The format of a Port Termination Point name is Parent Device Interface:Device Interface, and it is used to identify interfaces on UIM.
Pipes and Pipe Termination Points are created based on the collected characteristics from device interfaces.
This action contains the following processors run in the following order:
IP Links Collector Processor
The IP Links Collector collects characteristics required to model Pipes and Pipe Termination Points. Device interfaces with defined device interface configuration items are analyzed to collect required parameters.
IPDeviceInterface entity is used to store required parameters to create links. The output of this processor is a Map with the IP Address value as key and IPDeviceInterface entity as value.
IP Links Pipe Modeler Processor
The IP Links Pipe Modeler models Pipes and Pipe Termination Points. This processor calculates the IP Address of a ‘Z’ device interface based on the IP address of the ‘A’ device interface. If a device interface with the calculated IP address exists, then a link (pipes and pipe termination points) is created between the two device interfaces.
An Inventory Group entity is created for the device and all the links discovered on the device are assigned as members to it. All the created Inventory Groups are then added to the result category IPLinks.
Import IP Links from UIM
The Import IP Links from UIM action imports a connectivity from UIM and transforms it to a Network Integrity connectivity. This action contains the following processors run in the following order:
Import IP Links Initializer Processor
The Import IP Links Initializer processor provides the following variables as output:
-
filters: Items of type DeviceFilter with default values populated.
-
uimImportContext: Items of type UIMImportContext which contains a context used by multiple processors.
IP Logical Device Finder Processor
The IP Logical Device Finder processor uses the filters and uimImportContext variables as input parameters to perform one or more logical device find operations through the UIM web service API. This processor provides the following variables as output:
-
logicalDeviceIdNameMap: Items of type Map with device ID as key and device name as value.
-
uimImportContext: Items of type UIMImportContext which contains a context used by multiple processors.
-
uimLogicalDeviceIDs: Items of type Set.
IP Multithread Links Importer Processor
The IP Multithread Links Imported Processor uses the logicalDeviceIdNameMap, uimImportContext and uimLogicalDeviceIDs. It collects the connectivities of the logical devices and transforms UIM connectivities to Network Integrity connectivities. Inventory groups for devices are created and added to the IPLinks result category, and links are added as members.
Scan Parameter Group
The Import IP Links from UIM action contains the scan parameter group IP Links Import parameters.
Table 2-1 lists the scan parameters that are available during scan creation:
Table 2-1 IP Links Import parameters
| Parameter | Default Value | Mandatory | Description |
|---|---|---|---|
| deviceName | N/A | No | Import Devices with the names provided in this input field. |
| deviceNameFile | N/A | No | Import Devices with the names in the file path provided in this input field. |
| logicalDeviceSpecification | N/A | No | Import Devices with the specification provided in this input field. |
Detect IP Links Discrepancies
The Detect IP Links Discrepancies action is used to detect discrepancies between IP Links discovered and IP Links imported from UIM.
The Detect IP Links Discrepancies action contains two processors:
-
Discrepancy Detection (inherited)
IPLinksDDFiltersInitializer Processor
This processor implements the following filters:
-
Ignores case sensitivity for entity relationship for port termination point.
-
On a pipe, ignores the ID, physical location, description, partial, nativeEMSName and layerRate attributes.
-
On a pipe termination point, ignores highSpeed, ifSpeed, ipAddress, description and rate attributes.
-
Ignores partial containers.
-
Ignores the attributes connectivityType, description, aDeviceSpecName and zDeviceSpecName on a pipe termination point of type ethTopologicalLink.
Resolve IP Links Discrepancies
Resolve IP Links Discrepancies is a Discrepancy Resolution Action, used to resolve discrepancies between IP links discovered and imported links from UIM.
This discrepancy resolution action extends the Abstract Resolve in UIM action (from the UIM Integration cartridge) and inherits all its processors. For information about the inherited processors, see Network Integrity Developer's Guide.
The Resolve IP Links Discrepancies into UIM action contains the following processors run in the following order:
-
UIM Resolution Framework Initializer (inherited)
-
UIM Resolution Initializer (inherited)
-
UIM Resolution Framework Dispatcher (inherited)
IP Links Resolution Initializer
This processor registers the following handlers required for Connectivities and Service resolution:
-
PipeHandler
-
PipeTerminationPointHandler
Supported Creation Scenarios in UIM
This section describes the creation of a link (for INNI connectivity specifications) which is supported in UIM.
Note:
If devices are not already created in UIM, the Entity+ discrepancies would be in Ignored state since they are created for a container. Once the devices are created in UIM and imported into Network Integrity, the discovery scan should be run again so that Entity+ discrepancies can be resolved.
Creation of a Link
When a link (of type INNI connectivity specification) is discovered, and it does not exist in UIM, Network Integrity displays an Entity+ discrepancy for the topological link. Discrepancy resolution creates the INNI connectivity, and the link is associated with the device.
When a link exists in UIM but is not discovered, Network Integrity displays an Entity- discrepancy. If the link has only one design version and is in In Progress state, the link is deleted during the resolution of the Entity- discrepancy.
Note:
If multiple resolution requests sharing a common logical device are sent to UIM at the same time, it is possible that UIM may fail some of the requests with the OptimisiticLockException error. This can resolved by adding the uim.inverserel.update.disable=true property inside the system-config.properties file in UIM. For more information about this file, see "Setting System Properties" in UIM System Administrator's Guide.