6 About Design Studio Construction

This chapter provides information on the composition of the Oracle Communications Network Integrity NETCONF Network Discovery Cartridge from the Oracle Communications Service Catalog and Design - Design Studio perspective.

Model Collections

The table below lists the model collection used in the NETCONF Network Discovery and UIM Integration cartridge.

Table 6-1 NETCONF Network Discovery Cartridge Model Collection

Specification Information Model Entity Type Intended Usage/Notes
logicalDeviceSpecification LogicalDevice Represents root object discovered on the network.
deviceInterfaceSpecification DeviceInterface Represents generic interfaces.
400GigE_interface DeviceInterface Represents interfaces with 400GigE rate code.
200GigE_interface DeviceInterface Represents interfaces with 200GigE rate code.
100GigE_interface DeviceInterface Represents interfaces with 100GigE rate code.
50GigE_interface DeviceInterface Represents interfaces with 50GigE rate code.
25GigE_interface DeviceInterface Represents interfaces with 25GigE rate code.
15GigE_interface DeviceInterface Represents interfaces with 15GigE rate code.
10GigE_interface DeviceInterface Represents interfaces with 10GigE rate code.
1GigE_interface DeviceInterface Represents interfaces with 1GigE rate code.
100M_interface DeviceInterface Represents interfaces with 100M rate code.
10M_interface DeviceInterface Represents interfaces with 10M rate code.
subInterfaceSpecification DeviceInterface Represents Sub Interfaces.
Generic_DI_Config_Specification DeviceInterfaceConfigurationItem Represents Generic Media.
physicalDeviceSpecification PhysicalDevice Represents any Physical Device discovered on the network.
holderSpecification EquipmentHolder Represents Board piece of equipment.
shelfSpecification Equipment Represents Shelf piece of equipment.
cardSpecification Equipment Represents Module piece of equipment.
portSpecification PhysicalPort Represents generic physical port.
400GigE_Port PhysicalPort Represents ports associated with 400GigE rate code.
200GigE_Port PhysicalPort Represents ports associated with 200GigE rate code.
100GigE_Port PhysicalPort Represents ports associated with 100GigE rate code.
50GigE_Port PhysicalPort Represents ports associated with 50GigE rate code.
25GigE_Port PhysicalPort Represents ports associated with 25GigE rate code.
15GigE_Port PhysicalPort Represents ports associated with 15GigE rate code.
10GigE_Port PhysicalPort Represents ports associated with 10GigE rate code.
1GigE_Port PhysicalPort Represents ports associated with 1GigE rate code.
100M_Port PhysicalPort Represents ports associated with 100M rate code.
10M_Port PhysicalPort Represents ports associated with 10M rate code.

Specification Lineage

This section shows examples of the logical and physical specification lineages that the NETCONF Network Discovery cartridge generates for the discovered devices in the network.

Logical Specification Lineage for Devices

The example below shows the logical specification lineage for discovered devices. This lineage shows the intended relationship between specifications.

Example Logical Specification Lineage:
logicalDeviceSpecification
     [0..*] deviceInterfaceSpecification
           [0..1] Generic_DI_Config_Specification
                 [0..1] Generic_IPAddresses
                       [0..*] Generic_IPAddress                              

                              GenericIPAddress (characteristic)
                              GenericPrefix (characteristic)
                              GenericIPVersion (characteristic)

Physical Specification Lineage for Devices

The example below shows the physical specification lineage for discovered devices. This lineage shows the intended relationship between specifications.

Example Physical Specification Lineage:
physicalDeviceSpecification
     shelfSpecification
           [0..*] holderSpecification
                   [0..1]  cardSpecification
                           [0..*] holderSpecification
                                    [0..1]  cardSpecification
                                               [0..1]  portSpecification

Discovery Action

The NETCONF Network Discovery Cartridge supports the discovery action Discover Netconf Devices which is used to discovery devices in the network.

Table 6-2 Discover Netconf Devices

Result Category Address Handler Scan Parameters Model Processors
Device IPAddressHandler netconfParameters
  • username
  • password
  • port
  • deviceType
  • netconfVersion
  • connectionTimeout
  • commandTimeout
  • subsystem
  • serverHostKey
 Netconf_Network_Discovery_Cartridge
  • Netconf Connection Intializer
  • Generic Netconf Yang Collector Processor
  • Generic Netconf Data Discovery
  • Vendor Based Netconf Yang Collector Processor
  • Vendor Netconf Data Discovery
  • Netconf Logical Data Modeler
  • Netconf Physical Data Modeler

Discovery Scan Parameter Group

The Discover Netconf Devices action uses the netconfParameter scan parameter group. The below table outlines the Design Studio construction of this scan parameter group.

Table 6-3 netconfParameters Scan Parameter Group Design Studio Construction

Characteristic name Parameter Type Description UI Label
username String Username to establish connection username
password String Password to establish connection password
port String Port to establish connection port
connectionTimeout String Maximum time limit in milliseconds to establish connection. connectionTimeout
commandTimeout String Maximum time limit in milliseconds for command execution. commandTimeout
deviceType Dropdown Type of device to be discovered deviceType
netconfVersion Dropdown NETCONF version supported on device Netconf Version
subsystem String Specifies the SSH subsystem to use. Subsystem
serverHostKey String Specifies the expected host key algorithm for the SSH server Server Host Key
hostKeysFileName String Path to SSH client's Known Hosts file hostKeysFileName
keyBasedAuthentication CheckBox Enable key-based authentication keyBasedAuthentication
pemKeyFile String Path to SSH client's Private Key pemKeyFile
strictHostKeyChecking CheckBox Enable verification of SSH server's host key. strictHostKeyChecking

Discovery Processors

The below table describes the discovery processors of the Discover Netconf Devices action.

Table 6-4 List of Discovery Processors

Processor Name Variable
Netconf Connection Intializer

Input: N/A

Output:

  • deviceType
  • netconfConnection
Generic Netconf Yang Collector Processor

Input: directory path to YANG files.

Output:

  • genericYangProcessorProcessorResponseType

    A collection of attributes to be discovered from device
Generic Netconf Data Discovery

Input:

  • genericYangProcessorProcessorResponseType
  • netconfConnection

Output:

  • genericbindings

    Map of response Java objects

Vendor Based Netconf Yang Collector Processor

Input: directory path to YANG files.

Output:

  • vendorbasednetconfyangcollectorProcessorResponseType

    A collection of attributes to be discovered from device
Vendor Netconf Data Discovery

Input:

  • vendorbasednetconfyangcollectorProcessorResponseType
  • netconfConnection

Output:

  • vendorBindings

    Map of response Java objects

Netconf Logical Data Modeler

Input:

  • genericbindings
  • vendorBindings

Output:

  • logicalDevice
Netconf Physical Data Modeler

Input:

  • genericbindings
  • vendorBindings

Output:

  • physicalDevice

Import Action

The Import Netconf Device from UIM action is used to import devices from UIM.

Table 6-5 Import Netconf Device from UIM

Result Category Scan Parameters Model Processors
Device UIMImportParameters Netconf_Network_Discovery_Cartridge

Import Scan Parameter Group

The Import from UIM action uses the UIMImportParameters scan parameter group. The below table outlines the Design Studio construction of this scan parameter group.

Table 6-6 UIMImportParameters Scan Parameter Group Design Studio Construction

Characteristic Name Parameter Type Description UI Label
adminState Dropdown The status of the device in the inventory system. Inventory State
importLogicalDevices Check box Use this box to indicate whether to import logical devices. By default, this box is checked in the UI. Import Logical Devices
importPhysicalDevices Check box Use this box to indicate whether to import physical devices. By default, this box is checked in the UI. Import Physical Devices
logicalDeviceSpecification String The specification name(s) for logical devices. This field supports wildcard characters. Values are comma-separated if multiple specifications are given. Logical Device Specification
name String Use to filter imported devices by device name. This field supports wildcard characters. Name
networkLocationEntityCode String The network or entity location code. This field supports wildcard characters. Network/Entity Location
physicalDeviceSpecification String The specification name(s) for physical devices. This field supports wildcard characters. Values are comma-separated if multiple specifications are given. Physical Device Specification

Discrepancy Detection Action

The Detect Netconf Device Discrepancies action is used to perform discrepancy detection.

Table 6-7 Detect Netconf Device Discrepancies

Result Category Result Source Scan Parameters Model Processors
All Discover Netconf Devices N/A Netconf_Network_Discovery_Cartridge

Netconf Discrepancy Filters Initializer

This action extends the Abstract Detect UIM Discrepancies action included in the UIM Integration cartridge. For more information, see Network Integrity UIM Integration Cartridge Guide.

Detect Netconf Device Discrepancies

The Detect Netconf Device Discrepancies action detects discrepancies between discovery scan results of the Discover Netconf Devices action and the data imported from UIM.

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

This action contains the following processors run in the following order:

  1. UIM Discrepancies Filter Initializer (inherited)
  2. Netconf Discrepancy Filters Initializer
  3. Discrepancy Detector (inherited)

Discrepancy Resolution Action

The Reconcile Netconf Device Discrepancies action is used to perform discrepancy resolution.

Table 6-8 Reconcile Netconf Device Discrepancies

Result Category Result Source Processors
All Discover Netconf Devices This action extends the Abstract Resolve in UIM action included in the Network Integrity UIM Integration cartridge. For more information, see Network Integrity UIM Integration Cartridge Guide.