SDH Discovery Cartridge

1 SDH Discovery Cartridge

This chapter provides information on the Oracle Communications Network Integrity SDH Discovery cartridge.

Overview

This chapter provides an overview of the Oracle Communications Network Integrity SDH Discovery cartridge.

This chapter contains the following sections:

About the SDH Discovery Cartridge

The SDH Discovery cartridge supports modeling of SDH connectivities such as Topological Link, Trail, and Tunnel. It supports modeling the service by managing these connectivities.

The SDH Discovery cartridge provides the following:

Read and collect the data from files using FTP.
Modeling and stitching of connectivities detected from the file.
Perform Incremental Discovery on the notifications in database.

This cartridge supports logical discovery of the aforementioned entities. The logical hierarchy has a container (Links, Trails and Tunnels) for the device (connected on one of the ends) under which the connectivities are modeled along with the termination points of the connectivity. For trails and tunnels, the Primary and Secondary (if present) paths are modeled under the Trail/Tunnel. This path upon expansion will display all the links/trails present.

For the SDH Service entity, the modeling begins at the Service level and follows with the Service Configuration ("Main Config Item"). This Configuration is further divided into multiple configurations such as EndPoint_List, Properties_List, and so on.

Description of the illustration scan_result.png

Description of the illustration tl_hierarchy.png

About Cartridge Dependencies

This section provides information on dependencies that the SDH Discovery cartridge has on other entities.

Run-Time Dependencies

This cartridge requires the Address_Handlers cartridge be deployed to Network Integrity.

Design-Time Dependencies

The SDH Discovery cartridge has the following dependencies:

Address_Handlers
NetworkIntegritySDK
ora_uim_model
Optical_Model
SDH_Service_Model
ora_ni_uim_sdh_optical
ora_uim_network_device
ora_ni_uim_device

Opening the Cartridge Files in Design Studio

To review and extend the SDH Discovery cartridge, you must first download the Oracle Communications SDH Discovery cartridge software from the Oracle software delivery web site:https://edelivery.oracle.com.

The software contains the SDH Discovery cartridge ZIP file, which has the following structure:

\UIM_Cartridge_Projects\
\Network_Integrity_Cartridge_Projects\
SDH-Discovery-Cartridge-R7_4_0.b0.iar

See Design Studio Online Help and Oracle Communications Network Integrity Developer's Guide for information about opening files in Design Studio.

Building and Deploying the Cartridge

See Design Studio Help for information about building and deploying cartridges.

About the Cartridge Components

This section provides information about the components of the Oracle Communications Network Integrity SDH Discovery cartridge.

The SDH Discovery cartridge contains the following actions:

Discover SDH Connectivity and Service

Discover SDH Connectivity and Service

The Discover SDH Connectivity and Service action collects the required input files over FTP or SFTP and processes them to model the connectivities and service.. This action creates paths that are covered by the connectivities.

Modeling is performed on various files as follows:

Topological Link - XML file <vendor>-<circle>-NMS-TL.xml comprising of TL information
Trail - Multiple CSV files and <vendor>-<circle>-NMS-TL.xml file
- <vendor>-<circle>-Trail.csv : Contains the device endpoints information, layer rate, protection, and other details of the trail
- <vendor>-<circle>-Trail_LegHasTrail_Relation.csv : Contains mapping between legs and trails
- <vendor>-<circle>-Trail-leg.csv : Contains the leg IDs present in NMS
- <vendor>-<circle>-Trail-ProtectionSegment.csv : Contains the protection segment ID, nature of protection, and endpoint devices information
- <vendor>-<circle>-Trail-ProtectionSegmentHasLegsRelation.csv : Contains the mapping between legs and protection segments
- <vendor>-<circle>-Trail-TrailMultiplexed.csv : Contains the relation between trail and other links and trails
- <vendor>-<circle>-Trail-TrailProtectedByProtectionSegment.csv : Contains the mapping between trail and protection segment
- <vendor>-<circle>-Trail-VC.csv : Contains the VCAT size and channel information for each TL in the trail
Tunnel - Multiple CSV files, <vendor>-<circle>-NMS-TL.xml and <vendor>-<circle>-Trail.csv files
- <vendor>-<circle>-Tunnel.csv : Contains the device endpoints information, layer rate, protection, and other details of the tunnel
- <vendor>-<circle>-Tunnel-Attributes.csv : Contains the characteristics details of the tunnel
- <vendor>-<circle>-Tunnel_LegHasTrail_Relation.csv : Contains mapping between legs and tunnels
- <vendor>-<circle>-Tunnel-legs.csv : Contains the leg IDs present in NMS
- <vendor>-<circle>-Tunnel-ProtectionSegment.csv : Contains the protection segment ID, nature of protection, and the endpoint devices information
- <vendor>-<circle>-Tunnel-ProtectionSegmentHasLegsRelation.csv : Contains the mapping between legs and protection segments
- <vendor>-<circle>-Tunnel-TrailMultiplexed.csv : Contains the relation between tunnel and other trails
- <vendor>-<circle>-Tunnel-TrailProtectedByProtectionSegment.csv : Contains the mapping between tunnel and protection segment
Service - Multiple CSV files
- <vendor>-<circle>-Service.csv : Contains the service related information
- <vendor>-<circle>-ServiceEndpoints.csv : Contains the endpoint related information of the service
- <vendor>-<circle>-ServiceProperties.csv : Contains the properties information of the service
- <vendor>-<circle>-ServiceSupportByTrailRelation.csv : Contains the trails and tunnels information managed by the service

Scan Parameter Group

The Discover SDH Connectivity and Service action contains the following scan parameter groups:

SDH File Parameters
SDH Device Parameters
Incremental Discovery Parameters

Table 1-1 SDH File 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 value 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 the value Rename.
Session Timeout (sec)	60	No	The 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. The available values are: Delete, Rename, and 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.

Table 1-2 SDH Device Parameters

Parameter	Default Value	Mandatory	Description
Circle Name	N/A	Yes	The circle name of the OSS.
Vendor Name	N/A	Yes	The vendor name
Topological Link Name	N/A	No	To model and persist only the Topological Links with the names given in this input field.
Topological Link	N/A	No	Select the check box to model and persist Topological Links in this scan.
Trail ID	N/A	No	To model and persist only the Trails with the IDs given in this input field.
Trail	N/A	No	Select this check box to model and persist Trails in this scan.
Tunnel ID	N/A	No	To model and persist only the Tunnels with the IDs given in this input field.
Tunnel	N/A	No	Select this check box to model and persist Tunnels in this scan.
Service ID	N/A	No	To model and persist only the Services with the IDs given in this input field.
Service	N/A	No	Select this check box to model and persist Services in this scan.
Device Name	N/A	No	To model and persist only those connectivities whose both A and Z termination point devices (comma separated) are provided.

Table 1-3 Incremental Discovery Parameters

Parameter	Default Value	Mandatory	Description
Incremental Discovery	N/A	No	Select this check box to perform Incremental Discovery in this scan.
Topological Link	N/A	No	Select this check box to model and persist Topological Links in this scan.
Trail	N/A	No	Select this check box to model and persist Trails in this scan.
Tunnel	N/A	No	Select this check box to model and persist Tunnels in this scan.
Service	N/A	No	Select this check box to model and persist Services in this scan.
NMS Notification Count	N/A	No	The maximum number of NMS notifications to be processed.

Conditions and Processors

The Discover SDH Connectivity and Service action contains the following conditions:

IsTrailDiscoveryEnabled Condition
IsTunnelDiscoveryEnabled Condition
IsServiceDiscoveryEnabled Condition

The Discover SDH Connectivity and Service action contains the following processors run in the following order:

Incremental Discovery Initializer Processor
Notification Name Collector Processor
Topological Link XML File Collector Processor
Topological Link XML Parser Processor
CSV Collector Processor
Trail CSV Parser Processor
Tunnel CSV Parser Processor
Service CSV Parser Processor
Update Notifications for Connectivities and Service Processor

IsTrailDiscoveryEnabled Condition

The condition checks if Trail discovery or incremental discovery is selected in the scan parameters.

IsTunnelDiscoveryEnabled Condition

The condition checks if Tunnel discovery or incremental discovery is selected in the scan parameters.

IsServiceDiscoveryEnabled Condition

The condition checks if Service discovery or incremental discovery is selected in the scan parameters.

Incremental Discovery Initializer Processor

The Incremental Discovery Initializer processor creates the required data structures for incremental discovery: tlNames, trailNames, tunnelNames and serviceNames

Notification Name Collector Processor

The Notification Name Collector processor populates the data structures prepared from the Incremental Discovery Initializer processor. If the incremental discovery option is enabled, the NMS Notification Manager fetches the required notification and populates the requisite data structure.

Topological Link XML File Collector Processor

The Topological Link XML File Collector processor collects the XML files required for Topological Link discovery and places them in the topologicalLinkXMLFileCollectorFileCollection collection.

Topological Link XML Parser Processor

The Topological Link XML Parser processor iterates topologicalLinkXMLFileCollectorFileCollection to read the XML file and model the topological link based on the data. This data is filtered according to the device names, Link names from the scan parameter group, and tlNames (if incremental discovery is selected). The links are grouped according to container Links. This continues only if the Topological Link option is selected in the SDH Device Parameters or Incremental Discovery scan parameter group. The TL information is captured in the nameToTLBeanMap collection.

CSV Collector Processor

The CSV Collector processor collects the CSV files required for Trails, Tunnels, or Services discovery and places it in the csvCollectorFileCollection collection.

Trail CSV Parser Processor

The Trail CSV Parser processor iterates the csvCollectorFileCollection collection to read the required CSV files for modeling trails. This data is filtered according to the device names, Trail IDs from the scan parameter group, and trailNames (if incremental discovery is selected). The trails are grouped according to the container Trails. This continues only if the Trail option is selected in the SDH Device Parameters/Incremental Discovery scan parameter group.

Tunnel CSV Parser Processor

The Tunnel CSV Parser processor iterates the csvCollectorFileCollection collection to read the required CSV files for modeling tunnels. This data is filtered according to the device names, Tunnel IDs from the scan parameter group, and tunnelNames (if incremental discovery is selected). The tunnels are grouped according to the container Tunnels. This continues only if the Tunnel option is selected in the SDH Device Parameters or Incremental Discovery scan parameter group.

Service CSV Parser Processor

The Service CSV Parser processor iterates the csvCollectorFileCollection collection to read the required CSV files for modeling services. This data is filtered according to the Service IDs from the scan parameter group and serviceNames (if incremental discovery is selected). This continues only if the Service option is selected in the SDH Device Parameters or Incremental Discovery scan parameter group.

Update Notifications for Connectivities and Service Processor

The Update Notifications for Connectivities and Service processor updates the NMS notification status to DISCOVERY_SUCCESSFUL for entries in tlNames, trailNames, tunnelNames, and serviceNames. It also creates empty containers for devices that are not attached to any connectivties

Using the Cartridge

This section provides instructions for using the Oracle Communications Network Integrity SDH Discovery cartridge in Network Integrity.

Creating a Discover SDH Connectivity and Service Scan

The Discover SDH Connectivity and Service scan discovers and models connectivities such as Topological Links, Trails, Tunnels, and Services.

To create a Discover SDH Connectivity and Service discovery scan:

Create a new scan.

See Network Integrity Online Help for more information.
On the General tab, do the following:
1. From the Scan Action list, select Discover SDH Connectivity and Service.
  The Scan Type field displays Discovery.
2. In the Scan Action Parameters section, SDH File Parameters is selected by default. Enter the FTP related parameters.
3. Click on the Scan Action Parameters drop down and select SDH Device Parameters. Select the type of entities to model and the required filters such as Name, ID, Device Name, and so on.
4. Enter the Circle Name and Vendor name.
5. If Incremental Discovery is to be performed, select Incremental Discovery from the Scan Action Parameters drop down.
6. Select Incremental Discovery and the type of entities to be modeled and the number of notifications to be processed in this scan.
On the Scope tab, specify path to the file directory.
Save and run the scan.

About Cartridge Modeling

The Oracle Communications Network Integrity SDH Discovery cartridge models collected data according to the Oracle Communications Information Model. The collected data is modeled into the following entities:

Pipe
PipePipeTPRel
PipeTerminationPoint
TrailPath
TrailPipeRel
TrailPipeRelTrailPathRel
Service
ServiceConfigurationItem

See Oracle Communications Information Model Reference for more information about the Information Model.

Specifications

This section lists the specifications included in the Optical_Model and SDH_Service models.

Pipe

Table 1-4 Pipe Specifications

Specification	Cartridge
EthTunnel	Optical_Model
Optical Trail Pipe	Optical_Model
Topological Link	Optical_Model
VC3Circuit	Optical_Model
VC4Circuit	Optical_Model
VC12Circuit	Optical_Model

Pipe Termination Point

Table 1-5 Pipe Termination Point Specifications

Specification	Cartridge
Port Termination Point	Optical_Model

Service

Table 1-6 Service Specifications

Specification	Cartridge
SDH_Service	SDH_Service_Model

Service Configuration

Table 1-7 Service Configuration Specifications

Specification	Cartridge
SDH_Service_Configuration	SDH_Service_Model

About Design Studio Construction

This section provides information on the composition of the Oracle Communications Network Integrity Discovery SDH cartridge from the Oracle Communications Design Studio perspective.

Model Collections

Table 1-8 Discovery SDH Cartridge Model Collection

Specification	Information Model Entity Type	Description
Topological Link	Pipe	Represents Topological Link connectivity
Optical Trail Pipe	Pipe	Represents Optical Trail Pipe which forms the segments of an optical path
VC12Circuit	Pipe	Represents VC12 type of trail connectivity
VC3Circuit	Pipe	Represents VC3 type of trail connectivity
VC4Circuit	Pipe	Represents VC4 type of trail connectivity
EthTunnel	Pipe	Represents EthTunnel type of tunnel connectivity
Port Termination Point	Pipe Termination Point	Represents Port Termination Point which acts as a device end
SDH_Service	Service	Represents SDH_Service that manages the network
SDH_Service_Configuration	Service Configuration	Represents SDH_Service_Configuration

Discovery Action

The SDH Discovery cartridge supports the Discover SDH Connectivity and Service action.

The following table shows the discovery action in the SDH Discovery cartridge.

Table 1-9 Discover SDH Connectivity and Service

Result Category	Address Handler	Scan Parameters	Model	Processors
Device Link Trail Tunnel Service	FileTransferAddressHandler	SDH File Parameters SDH Device Parameters Incremental Discovery Parameters Note: You must add these scan parameters to the Create Scan web service request even if the values are left empty.	SDH_Discovery_Cartridge	Incremental Discovery Initializer Notification Name Collector Topological Link XML File Collector Topological Link XML Parser CSV Collector Trail CSV Parser Tunnel CSV Parser Service CSV Parser Update Notifications for Connectivities and Service

Result Category

Address Handler

Scan Parameters

Model

Processors

Device
Link
Trail
Tunnel
Service

FileTransferAddressHandler

SDH File Parameters
SDH Device Parameters
Incremental Discovery Parameters

Note: You must add these scan parameters to the Create Scan web service request even if the values are left empty.

SDH_Discovery_Cartridge

Incremental Discovery Initializer
Notification Name Collector
Topological Link XML File Collector
Topological Link XML Parser
CSV Collector
Trail CSV Parser
Tunnel CSV Parser
Service CSV Parser
Update Notifications for Connectivities and Service

Discovery Processors

The following table shows the discovery processors in the SDH Discovery cartridge.

Table 1-10 Discover SDH Connectivity and Service Action Processors

Processor Name	Variable
Incremental Discovery Initializer	Input: N/A Output: tlNames trailNames tunnelNames serviceNames Collections of IDs and names on which the incremental discovery is performed. discoveryDeviceList Collection of device names over which discovery is performed.
Notification Name Collector	Input: tlNames trailNames tunnelNames serviceNames Collections of IDs and names on which the incremental discovery is performed. Output: N/A
Topological Link XML File Collector	Input: N/A Output: topologicalLinkXMLFileCollectorFileCollection Collection of files read from the scope provided.
Topological Link XML Parser	Input: topologicalLinkXMLFileCollectorFileCollection Collection of files read from the scope provided. tlNames Collection of TL names on which the incremental discovery is performed. discoveryDeviceList Collection of device names that are obtained from the input files. Output: nameToTLBeanMap Map with TL Name and TL Bean object to be used for processing trails and tunnels. tlDiscoveredDevices Collection of device names which are attached to the discovered topological Links.
CSV Collector	Input: N/A Output: csvCollectorFileCollection Collection of files read from the scope provided.
Trail CSV Parser	Input: csvCollectorFileCollection Collection of files read from the scope provided. nameToTLBeanMap Map with TL Name and TL Bean object to be used for processing trails and tunnels. trailNames Collection of trail IDs on which the incremental discovery is performed. discoveryDeviceList Collection of device names that are obtained from the input files. Output: trailDiscoveredDevices Collection of device names which are attached to the discovered trails.
Tunnel CSV Parser	Input: csvCollectorFileCollection Collection of files read from the scope provided. nameToTLBeanMap Map with TL Name and TL Bean object to be used for processing trails and tunnels. tunnelNames Collection of tunnel IDs on which the incremental discovery is performed. Output: tunnelDiscoveredDevices Collection of device names which are attached to the discovered trails.
Service CSV Parser	Input: csvCollectorFileCollection Collection of files read from the scope provided. serviceNames Collection of service IDs on which the incremental discovery is performed. Output: N/A
Update Notifications for Connectivities and Service	Input: tlNames trailNames tunnelNames serviceNames Collections of IDs and names on which the incremental discovery is performed. discoveryDeviceList Collection of device names that are obtained from the input files. tlDiscoveredDevices Collection of device names which are attached to the discovered topological Links. trailDiscoveredDevices Collection of device names which are attached to the discovered Trails. tunnelDiscoveredDevices Collection of device names which are attached to the discovered tunnels. Output: N/A