About the Cartridge Components

2 About the Cartridge Components

This chapter provides information about the components of the Oracle Communications Network Integrity RAN and Microwave Discovery cartridge.

This cartridge contains the following actions:

RAN and Microwave File Collector

The RAN and Microwave File Collector action is an abstract action that collects the required input files over FTP/SFTP and processes them to model the logical and physical device hierarchies.

All the modeling is done over different files as discussed below:

RAN Files:
- ran_device.csv: Contains the network element information. It is used for modeling logical device and physical device.
- ran_equipment.csv: Contains the equipment level information. It is used for modeling racks, shelves, and cards.
- ran_port.csv: Contains the port level information. It is used for modeling device interfaces and physical ports.
Microwave Files:
- microwave_ne_inventory.csv: Contains the network element information.
- microwave_hw_module_inventory.csv: Contains equipment information and their positioning.
- microwave_sw_module_inventory.csv: Contains software information of the equipment.
- microwave_eth_config_data.csv: Contains ethernet related configuration data of the network elements.
- microwave_ospf_config_data.csv: Contains the OSPF related configuration data of the network elements.
- microwave_generic_config_data.csv: Contains other generic configuration data of the network elements.
- microwave_license.csv: Contains license information of the network elements.

Scan Parameter Group

The RAN and Microwave File Collector action contains the following scan parameter groups:

RAN and Microwave Discovery Parameters

Table 2-1 RAN and Microwave Discovery Parameters

Parameter	Default Value	Mandatory	Description
Password	N/A	No	The password to connect to the remote location.
Port	N/A	No	The port used to connect to the remote server. The default is 21 for FTP and 22 for SFTP.
Rename Suffix	processed	No	The suffix to add to the source file if the source file management characteristic has a value of Rename.
Session Timeout (sec)	60	No	The amount of time in seconds before an idle connection is timed out. The valid range is from 1 to 3600.
Source File Management	Rename	No	Select the action to take on source files when the file transfer is complete. Options are: Delete, Rename, Nothing.
Transfer Type	SFTP	No	Select how files should be transferred: FTP, SFTP, Local.
User Name	N/A	No	The user name to connect to the remote location.
Network Element Name Qualifier	EQUALS	No	List: EQUALS, EQUALS_IGNORE_CASE, CONTAINS, CONTAINS_IGNORE_CASE, STARTS_WITH, STARTS_WITH_IGNORE_CASE, ENDS_WITH, ENDS_WITH_IGNORE_CASE This parameter works in combination with network element name to filter the collected NEs by name and qualifier.
Network Element Name	N/A	No	Name of network element. This parameter works in combination with Network Element Name Qualifier. It helps to filter the scan.
Network Element Type Qualifier	EQUALS	No	List: EQUALS, EQUALS_IGNORE_CASE, CONTAINS, CONTAINS_IGNORE_CASE, STARTS_WITH, STARTS_WITH_IGNORE_CASE, ENDS_WITH, ENDS_WITH_IGNORE_CASE This parameter works in combination with Network Element Type to filter the collected NEs by name and qualifier.
Network Element Type	N/A	No	Type of Network Element. This parameter works in combination with Network Element Type Qualifier. This parameter helps to filter the scan.

RAN and Microwave File Collector Processor

The RAN and Microwave File Collector Processor collects the CSV files required for discovery and places them in the ranAndMicrowaveFileCollectorFileCollection collection.

Discover RAN Devices

The Discover RAN Devices action reads the RAN files and processes them to model the logical and physical device hierarchies.

Scan Parameter Group

The Discover RAN Devices action contains the following scan parameter groups:

RAN and Microwave Discovery Parameters

Table 2-2 Discover RAN Devices action RAN and Microwave Discovery Parameters scan parameter group

Parameter	Default Value	Mandatory	Description
Password	N/A	No	The password to connect to the remote location.
Port	N/A	No	The port used to connect to the remote server. The default is 21 for FTP and 22 for SFTP.
Rename Suffix	processed	No	The suffix to add to the source file if the source file management characteristic has a value of Rename.
Session Timeout (sec)	60	No	The amount of time in seconds before an idle connection is timed out. The valid range is from 1 to 3600.
Source File Management	Rename	No	Select the action to take on source files when the file transfer is complete. Options are: Delete, Rename, Nothing.
Transfer Type	SFTP	No	Select how files should be transferred: FTP, SFTP, Local.
User Name	N/A	No	The user name to connect to the remote location.
Network Element Name Qualifier	EQUALS	No	List: EQUALS, EQUALS_IGNORE_CASE, CONTAINS, CONTAINS_IGNORE_CASE, STARTS_WITH, STARTS_WITH_IGNORE_CASE, ENDS_WITH, ENDS_WITH_IGNORE_CASE This parameter works in combination with Network Element Name to filter the collected NEs by name and qualifier.
Network Element Name	N/A	No	Name of Network Element. This parameter works in combination with Network Element Name Qualifier. This parameter helps to filter the scan.
Network Element Type Qualifier	EQUALS	No	List: EQUALS, EQUALS_IGNORE_CASE, CONTAINS, CONTAINS_IGNORE_CASE, STARTS_WITH, STARTS_WITH_IGNORE_CASE, ENDS_WITH, ENDS_WITH_IGNORE_CASE This parameter works in combination with Network Element Type to filter the collected NEs by name and qualifier.
Network Element Type	N/A	No	Type of Network Element. This parameter works in combination with Network Element Type Qualifier. This parameter helps to filter the scan.

The Discover RAN Devices action contains the following processors run in the following order:

RAN and Microwave File Collector (inherited)
RanDiscoveryInitializer
Device CSV Parser
Equipment CSV Parser
Port CSV Parser
RanDeviceModelPersister

RANDiscoveryInitializer Processor

The RanDiscoveryInitializer processor iterates over the ranAndMicrowaveFileCollectorFileCollection collection to arrange the files into 3 categories: deviceFiles, equipmentFiles and portFiles. This processor outputs these as collections of files along with the logical device and physical device object maps i.e., logicalDeviceObjectMap and physicalDeviceObjectMap.

Device CSV Processor

The Device CSV Parser processor iterates over the deviceFiles collection, parses the files and models the Logical and Physical Device Objects to place them in logicalDeviceObjectMap and physicalDeviceObjectMap respectively. This processor also filters the network element devices based on name-matching and type-matching criteria provided through scan parameters. Only those devices that are matched by specified criteria are considered for further processing.

Equipment CSV Parser Processor

The Equipment CSV Parser processor iterates over the equipmentFiles collection, parses the files, and models the Rack Equipment Objects, Shelf Equipment Objects and Card Equipment Objects and associates them with the corresponding Physical Device Objects present in physicalDeviceObjectMap.

Port CSV Parser Processor

The Port CSV Parser processor iterates over the portFiles collection, parses the files, and models the Physical Port Object and associates them with the Card Equipment Object with the help of physicalDeviceObjectMap.

RanDeviceModelPersister Processor

The RanDeviceModelPersister processor iterates over the logicalDeviceObjectMap and physicalDeviceObjectMap collections and models the logical and physical hierarchies.

Discover Microwave Devices

The Discover Microwave Devices action reads the Microwave files and processes them to model the logical and physical device hierarchies.

Scan Parameter Group

The Discover Microwave Devices action contains the following scan parameter groups:

RAN and Microwave Discovery Parameters

Table 2-3 Discover Microwave Devices action RAN and Microwave Discovery Parameters scan parameter group

Parameter	Default Value	Mandatory	Description
Password	N/A	No	The password to connect to the remote location.
Port	N/A	No	The port used to connect to the remote server. The default is 21 for FTP and 22 for SFTP.
Rename Suffix	processed	No	The suffix to add to the source file if the source file management characteristic has a value of Rename.
Session Timeout (sec)	60	No	The amount of time in seconds before an idle connection is timed out. The valid range is from 1 to 3600.
Source File Management	Rename	No	Select the action to take on source files when the file transfer is complete. Options are: Delete, Rename, Nothing.
Transfer Type	SFTP	No	Select how files should be transferred: FTP, SFTP, Local.
User Name	N/A	No	The user name to connect to the remote location.
Network Element Name Qualifier	EQUALS	No	List: EQUALS, EQUALS_IGNORE_CASE, CONTAINS, CONTAINS_IGNORE_CASE, STARTS_WITH, STARTS_WITH_IGNORE_CASE, ENDS_WITH, ENDS_WITH_IGNORE_CASE This parameter works in combination with Network Element Name to filter the collected NEs by name and qualifier.
Network Element Name	N/A	No	Name of Network Element. This parameter works in combination with Network Element Name Qualifier. This parameter helps to filter the scan.
Network Element Type Qualifier	EQUALS	No	List: EQUALS, EQUALS_IGNORE_CASE, CONTAINS, CONTAINS_IGNORE_CASE, STARTS_WITH, STARTS_WITH_IGNORE_CASE, ENDS_WITH, ENDS_WITH_IGNORE_CASE This parameter works in combination with Network Element Type to filter the collected NEs by name and qualifier.
Network Element Type	N/A	No	Type of Network Element. This parameter works in combination with Network Element Type Qualifier. This parameter helps to filter the scan.

The Discover RAN Devices action contains the following processors run in the following order:

RAN and Microwave File Collector (inherited)
Microwave Files Parser
MicrowaveDeviceModelPersister

Microwave Files Parser Processor

The Microwave Files Parser processor iterates over the ranAndMicrowaveFileCollectorFileCollection collection, parses the files, and models the network element Objects and places them in the neObjects collection. The processor also filters the network element devices based on name-matching and type-matching criteria provided through scan parameters. Only those devices that are matched by specified criteria are considered for further processing.

MicrowaveDeviceModelPersister Processor

The MicrowaveDeviceModelPersister processor iterates over the neObjects collection and models the logical and physical hierarchies.

Detect Discrepancies for RAN and Microwave Devices

The Detect Discrepancies for RAN and Microwave Devices action detects discrepancies between discovery scan results of Discover RAN Devices action or Discover Microwave Devices and data imported from UIM.

This discrepancy detection action extends the Abstract Detect UIM Discrepancies action (from the UIM Integration cartridge) and inherits all its processors. For more information about the inherited processors, see Network Integrity UIM Integration Cartridge Guide.

The Detect Discrepancies for RAN and Microwave Devices action contains the following processors run in the following order:

UIM Discrepancies Filter Initializer (inherited)
Discrepancy Detector (inherited)

Resolve RAN and Microwave Devices in UIM

The Resolve RAN and Microwave Devices in UIM action resolves discrepancies on logical and physical hierarchies and associations between logical and physical entities in UIM.

The 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 UIM Integration Cartridge Guide.

The Resolve RAN and Microwave Devices in 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)