6 About Design Studio Construction

This chapter provides information on the composition of the Oracle Communications Network Integrity RESTCONF Network Discovery and UIM Integration cartridge from the Oracle Communications Service Catalog and Design - Design Studio perspective.

Model Collections

Table 6-1 lists the model collection used in the RESTCONF Network Discovery and UIM Integration cartridge.

Table 6-1 RESTCONF Network Discovery Cartridge Model Collection

Specification Information Model Entity Type Intended Usage/Notes
logicalDeviceSpecification LogicalDevice Represents the 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 RESTCONF 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 RESTCONF Network Discovery Cartridge supports the discovery action Discover Restconf Devices which is used to discover devices in the network.

Table 6-2 Discover Restconf Devices

Result Category Address Handler Scan Parameters Model Processors
Device IPAddressHandler RestconfParameters
  • username
  • password
  • port
  • deviceType
  • authentication
  • connectTimeout
  • ssl
  • readTimeout
  • fieldFiltering
  • contextRoot
 Restconf_Discovery
  • Restconf Property Initializer
  • Generic Rest Yang Collector Processor
  • Generic Restconf Data Discovery
  • Vendor Based Rest Yang Collector Processor
  • Vendor Restconf Data Discovery
  • Restconf Logical Data Modeler
  • Restconf Physical Data Modeler

Scan Parameter Group

The scan parameter groups used in this cartridge are listed in Scan Parameter Group.

Table 6-3 Scan Parameter Group

Scan Parameter Group Name Parameters
RestconfParameters
  • username
  • password
  • port
  • deviceType
  • authentication
  • connectTimeout
  • ssl
  • readTimeout
  • fieldFiltering
  • contextRoot

Discovery Processors

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

Table 6-4 List of Discovery Processors

Processor Name Variable
Restconf Property Intializer

Input: N/A

Output: deviceType
Generic Rest Yang Collector Processor

Input: The directory path to YANG files

Output: genericRestYangCollectorProcessorProcessorResponseType

The collection of attributes to be discovered from the device
Generic Restconf Data Discovery

Input: genericRestYangCollectorProcessorProcessorResponseType

Output: genericbindings

Map of response Java objects
Vendor Based Rest Yang Collector Processor

Input: The directory path to YANG files

Output: vendorbasedRestYangcollectorProcessorProcessorResponseType

The collection of attributes to be discovered from the device
Vendor Restconf Data Discovery

Input: vendorbasedRestYangcollectorProcessorProcessorResponseType

Output: vendorBindings

Map of response Java objects
Restconf Logical Data Modeler

Input:

  • genericbindings
  • vendorBindings

Output:

  • logicalDevice
Restconf Physical Data Modeler

Input:

  • genericbindings
  • vendorBindings

Output: physicalDevice

Import Action

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

Table 6-5 Import Restconf Device from UIM

Result Category Scan Parameters Model Processors
Device UIMImportParameters Restconf_Network_Discovery_Cartridge

ProcessRestconfImportScanInput

This action extends the Abstract Import from UIM action. For more information about the processors in this action, see Network Integrity UIM Integration Cartridge Guide.

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 Checkbox Use this box to indicate whether to import logical devices. By default, this box is checked in the UI. Import Logical Devices
importPhysicalDevices Checkbox 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 in case multiple specifications 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 in case multiple specifications given. Physical Device Specification

Discrepancy Detection Action

The Detect Restconf Device Discrepancies action is used to perform Discrepancy detection.

Table 6-7 Detect Restconf Device Discrepancies

Result Category Result Source Scan Parameters Model Processors
All Discover Restconf Devices N/A Restconf_Discovery

Restconf Discrepancy Filters Initializer

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

Discrepancy Resolution Action

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

Table 6-8 Reconcile Restconf Device Discrepancies

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