2 About the Cartridge Components

This chapter provides information about the components of the Oracle Communications Network Integrity RESTCONF Network Discovery and UIM Integration cartridge.

This cartridge contains the following actions:

Abstract Discover Restconf Devices

This is an abstract action that can be extended in Oracle Communications Service Catalog and Design - Design Studio to discover specified network objects.

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

Restconf Property Initializer

The Restconf Property Initializer processor sets the properties needed to select and run the appropriate processors, using the parameters from the RestconfParameters scan parameter group.

Generic Restconf Yang Collector Processor

The Generic Restconf Yang Collector Processor collects variables from a device for discovery. It uses attributes from generic YANG models needed to retrieve device details. This processor runs when the deviceType parameter is set to Generic. See About Poll Lists, for more information.

Generic Restconf Data Discovery

The Generic Restconf Data Discovery Processor sends RESTCONF requests to retrieve attribute values from a device, collects the response, and generates Java binding objects. It runs when the deviceType parameter is set to Generic.

Vendor-Based Restconf Yang Collector Processor

The Vendor-based Restconf Yang Collector Processor collects variables from a device for discovery. It uses attributes from vendor-specific YANG models required to retrieve device details. This processor runs when the deviceType parameter is set to Cisco IOS XE 1691. For more information, see About Poll Lists.

Vendor Restconf Data Discovery

The Vendor RESTCONF Data Discovery Processor sends RESTCONF requests to retrieve attribute values from a device, collects the response, and generates Java binding objects. It runs when the deviceType parameter is set to Cisco IOS XE 1691.

Restconf Logical Data Modeler

The Restconf Logical Data Modeler Processor builds the logical data model from data collected by the YANG collector processor. It creates a hierarchical structure of the logical devices and its child interfaces.

Restconf Physical Data Modeler

The Restconf Physical Data Modeler Processor builds the physical data model from data collected by the Yang collector processor. It creates a hierarchy of the physical device, equipment, equipment holders, and physical ports.

Discover Restconf Devices

The Discover Restconf Devices action scans devices and builds physical and logical hierarchies based on the discovery. It also models associations between the physical and logical layers.

This action extends the Abstract Restconf Discovery action. It contains the following processors run in the following order:

  • Restconf Property Initializer (inherited)
  • Generic Rest Yang Collector Processor (inherited)
  • Generic Restconf Data Discovery (inherited)
  • Vendor based Restconf Yang Collector Processor (inherited)
  • Vendor Restconf Data Discovery (inherited)
  • Restconf Logical Data Modeler (inherited)
  • Restconf Physical Data Modeler (inherited)

Import Restconf Device from UIM

The Import Restconf Device from UIM action imports logical device and physical device trees from Oracle Communications Unified Inventory Management (UIM). Import scan parameters are available on the Create Scan page in Network Integrity to configure import filters.

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

The Import Restconf Device from UIM action contains the following processors run in the following order:

  1. Import UIM Initializer (inherited)
  2. ProcessRestconfImportScanInput
  3. Logical Device UIM Finder (inherited)
  4. Physical Device UIM Finder (inherited)
  5. Logical Device UIM MultiTheard Importer (inherited)
  6. Physical Device UIM MultiTheard Importer (inherited)
  7. Logical Device UIM Importer (inherited)
  8. Linked Physical Device UIM Importer (inherited)
  9. Logical Device UIM Persister (inherited)
  10. Physical Device UIM Importer (inherited)
  11. Linked Logical Device UIM Importer (inherited)
  12. Physical Device UIM Persister (inherited)

ProcessRestconfImportScanInput

This processor uses filters as input parameters and sets filter values based on the scan parameters. For more information about the scan parameter groups associated with this action, see Scan Parameter Group.

Detect Restconf Device Discrepancies

The Detect Restconf Device Discrepancies action detects discrepancies between discovery scan results of the Discover Restconf Devices action and the 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 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. Restconf Discrepancy Filters Initializer
  3. Discrepancy Detector (inherited)

Restconf Discrepancy Filters Initializer

This processor adds the following filters to ignore association discrepancies between logical and physical devices:

  • Disregard Association+ and Association- discrepancies on Logical Device
  • Disregard Association+ and Association- discrepancies on Device Interface

Note:

Discrepancy detection between logical and physical devices is required only when a different import action is used to import both logical and physical devices.

Reconcile Restconf Device Discrepancies

The Resolve Restconf Device Discrepancies action resolves discrepancies on logical and physical hierarchies and associations between logical and physical entities in UIM.

This 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 Restconf Device Discrepancies action contains the following processors run in the following order:

  1. UIM Resolution Framework Initializer (inherited)
  2. UIM Resolution Initializer (inherited)
  3. UIM Resolution Framework Dispatcher (inherited)