5 About Cartridge Modeling

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

  • DeviceInterfaceConfiguration
  • DeviceInterfaceConfigurationItem
  • Equipment
  • EquipmentHolder
  • EquipmentEquipmentRel
  • EquipmentHolderEquipmentRel
  • LogicalDevice
  • MediaInterface
  • PhysicalDevice
  • PhysicalDeviceEquipmentRel
  • PhysicalPort
See the following topics for more information about modeling cartridges:

Hierarchy Mapping

This section describes the hierarchy mapping for the RESTCONF Network Discovery and UIM Integration cartridge.

Generic Device

The data sourced from the ietf-system.yang file establishes and seeds the logical and physical device objects.

The media interface encapsulates the common information about an interface as a device is discovered. The device interface configuration captures the media type information that decorates the interface with media-specific parameters. These media-specific parameters define the behavior of the interface.

The media interfaces are established and seeded with data sourced from the following YANG files:

  • ietf-interfaces.yang
  • ietf-ip.yang
  • ietf-routing.yang
  • ietf-ospf.yang
  • ietf-rip.yang
  • openconfig-lldp.yang
  • openconfig-bgp.yang
  • ietf-l2vpn-ntw.yang

Equipment, Equipment Holders, and Physical Ports are established and seeded with data sourced from the following YANG file:

  • ietf-hardware.yang

Vendor-Based Device

The data sourced from the Cisco-IOS-XE-native.yang file establishes and seeds the logical and physical device object.

The media interface encapsulates the common information about an interface as a device is discovered. The device interface configuration captures the media type information that decorates the interface with media-specific parameters. These parameters define the behavior of the interface.

The media interfaces are established and seeded with data sourced from the following YANG files:

  • ietf-interfaces.yang
  • openconfig-bgp.yang
  • openconfig-lldp.yang
  • Cisco-IOS-XE-ospf-oper.yang

Equiment, Equiment Holders, and Physical Ports are established and seeded with data sourced from the following YANG file:

  • openconfig-platform.yang

Oracle Communications Information Model Information

All the entities used in RESTCONF Network Discovery and UIM Integration cartridge (for example, physical device, logical device, media interface, and so on) are Oracle Communications Information Model 1.0-compliant for static fields. The dynamic fields (sometimes referred to as characteristics) are application-specific. You can customize application specific data with the device interface configuration mechanism.

This cartridge supports the Generic Media configuration.

Specifications

This section lists the specifications included in the ora_ni_uim_yang_model cartridge for modeling devices.

You must first model inventory (UIM) specifications in an inventory cartridge using Design Studio, define the cartridge dependency such that the Network Integrity cartridge is dependent on the inventory cartridge, and then use the inventory cartridge specifications in the Network Integrity cartridge model.

Specifications shared with UIM are defined in the ora_ni_uim_device cartridge. These cartridges are used to directly deploy specifications to UIM.

Logical Device

Table 5-1 shows the list of logical device specifications.

Table 5-1 Logical Device Specifications

Specification Cartridge Intended Usage
logicalDeviceSpecification ora_ni_uim_yang_model Used to model all types of devices.

Table 5-2 shows the characteristics applied to the logical device specifications.

Table 5-2 Logical Device Characteristics

Characteristics Field Type Field Content
deviceIPAddress String Text
nativeEmsName String Text

Device Interface

Table 5-3 shows the list of device interface specifications.

Table 5-3 Device Interface Specifications

Specification Cartridge Intended Usage
deviceInterfaceSpecification ora_ni_uim_yang_model Used to model device interfaces with undefined rate code.
400GigE_interface ora_ni_uim_yang_model Used to model device interfaces with 400GigE rate code.
200GigE_interface ora_ni_uim_yang_model Used to model device interfaces with 200GigE rate code.
100GigE_interface ora_ni_uim_yang_model Used to model device interfaces with 100GigE rate code.
50GigE_interface ora_ni_uim_yang_model Used to model device interfaces with 50GigE rate code.
25GigE_interface ora_ni_uim_yang_model Used to model device interfaces with 25GigE rate code.
15GigE_interface ora_ni_uim_yang_model Used to model device interfaces with 15GigE rate code.
10GigE_interface ora_ni_uim_yang_model Used to model device interfaces with 10GigE rate code.
5GigE_interface ora_ni_uim_yang_model Used to model device interfaces with 5GigE rate code.
1GigE_interface ora_ni_uim_yang_model Used to model device interfaces with 1GigE rate code.
100M_interface ora_ni_uim_yang_model Used to model device interfaces with 100M rate code.
10M_interface ora_ni_uim_yang_model Used to model device interfaces with 10M rate code.
subInterfaceSpecification ora_ni_uim_yang_model Used to model all sub interfaces.

Table 5-3 shows the characteristics applied to deviceInterfaceSpecification specification and all device interface specifications that have rate code.

Table 5-4 Device Interface Item Characteristics fordeviceInterfaceSpecification Specification

Characteristics Field Type Field Content Description
highSpeed String Text High Speed supported on device
ifSpeed String Text Speed
nativeEMSAdminServiceState String Text Admin Service State
nativeEMSServiceState String Text Service State
nativeEmsName String Text unique identifier such as name
bgpPeerAdminStatus String Text Administrative state of the BGP peer
bgpPeerLastError String Text Last error recorded with the BGP peer
bgpPeerLocalAddr String Text Local IP address used in the BGP session
bgpPeerRemoteAddr String Text Remote IP address of the BGP peer
ipCidrRouteDest String Text Destination address for a route
ipCidrRouteMask String Text Subnet mask associated with a route
ipCidrRouteNextHop String Text Next-hop IP address for a route
AEndDeviceName String Text Name of device on the A end
AEndInterfaceIPAddress String Text A-end interface IP Address
AEndInterfaceName String Text Name of interface on the A end
ZEndDeviceName String Text Name of device on the Z end
ZEndInterfaceIPAddress String Text Z-end interface IP Address
ZEndInterfaceName String Text Name of interface on the Z end
mplsVpnVrfDescription String Text Description of the VPN Routing and Forwarding (VRF)
mplsVpnVrfRouteDistinguisher String Text Route distinguisher for identifying unique VPNs
rtBothValue String Text Route targets for both import and export
rtExportValue String Text Route target(s) used for route export
rtImportValue String Text Route target(s) used for route import
ospfIfAdminState String Text Administrative state of the OSPF interface
ospfIfAreaId String Text OSPF area identifier for the interface
ospfIfIpAddress String Text IP address associated with the OSPF interface
ospfIfLsaCount String Text Count of LSAs seen or generated on interface
ospfIfState String Text Operational state of OSPF (for example, Down, DR, BDR)
ospfIfType String Text Interface type (for example, broadcast, point-to-point)
ospfNbrIpAddr String Text IP address of the adjacent OSPF neighbor
rtBothValue String Text Route targets for both import and export
rtExportValue String Text Route target(s) used for route export
rtImportValue String Text Route target(s) used for route import
ospfIfAdminState String Text Administrative state of the OSPF interface
ospfIfAreaId String Text OSPF area identifier for the interface
ospfIfIpAddress String Text IP address associated with the OSPF interface
ospfIfLsaCount String Text Count of LSAs seen or generated on interface
ospfIfState String Text Operational state of OSPF (for example, Down, DR, BDR)
ospfIfType String Text Interface type (for example, broadcast, point-to-point)
ospfNbrIpAddr String Text IP address of the adjacent OSPF neighbor

Device Interface Configuration Item

Table 5-5 shows the list of Device Interface specifications.

Table 5-5 Device Interface Configuration Item Specifications

Specification Cartridge Intended Usage
Generic_DI_Config_Specification NetworkIntegritySDK Used to model Device Interface IPAdress Details.

Table 5-6 shows the characteristics applied to Generic_IPAddress Device Interface Configuration Item

Table 5-6 Device Interface Configuration Item Characteristics for Generic_DI_Config_Specification

Characteristics Field Type Field Content
GenericIPAddress String Text
GenericPrefix String Text
GenericIpVersion String Text

Note: The allowed values are "IPV4" and "IPV6".

Physical Device

Table 5-7 shows the list of physical device specifications.

Table 5-7 Physical Device Specifications

Specification Cartridge Intended Usage
physicalDeviceSpecification ora_ni_uim_yang_model Used to model all types of devices.

The physicalDeviceSpecification is available in ora_ni_uim_yang_model.

Table 5-8 shows the characteristics applied to the physical device specifications.

Table 5-8 Physical Device Characteristics

Characteristics Field Type Field Content
deviceIPAddress String Text
nativeEmsName String Text

Equipment

Table 5-9 shows the list of Equipment specifications.

Table 5-9 Equipment Specifications

Specification Cartridge Intended Usage
shelfSpecification ora_ni_uim_yang_model Used to model all types of devices.
cardSpecification ora_ni_uim_yang_model Used to model all types of devices.

Table 5-10 shows the characteristics applied to the equipment specifications.

Table 5-10 Equipment Characteristics

Characteristics Field Type Field Content
hardwareRevision String Text
softwareRevision String Text
modelName String Text
nativeEmsName String Text
vendorName String Text

Equipment Holder

Table 5-12 shows the list of equipment holder specifications.

Table 5-11 Equipment Holder Specifications

Specification Cartridge Intended Usage
holderSpecification ora_ni_uim_yang_model Used to model all types of devices.

Table 5-12 shows the characteristics applied to the equipment holder specifications.

Table 5-12 Equipment Holder Characteristics

Characteristics Field Type Field Content
nativeEmsName String Text

Physical Port

Table 5-13 shows the list of Physical Port specifications.

Table 5-13 Physical Port Specifications

Specification Cartridge Intended Usage
portSpecification ora_ni_uim_yang_model Used to model physical ports with no device interface associated or mapped with generic device interface.
400GigE_Port ora_ni_uim_yang_model Used to model physical ports mapped with 400GigE device interfaces.
200GigE_Port ora_ni_uim_yang_model Used to model physical ports mapped with 200GigE device interfaces.
100GigE_Port ora_ni_uim_yang_model Used to model physical ports mapped with 100GigE device interfaces.
50GigE_Port ora_ni_uim_yang_model Used to model physical ports mapped with 50GigE device interfaces.
25GigE_Port ora_ni_uim_yang_model Used to model physical ports mapped with 25GigE device interfaces.
15GigE_Port ora_ni_uim_yang_model Used to model physical ports mapped with 15GigE device interfaces.
10GigE_Port ora_ni_uim_yang_model Used to model physical ports mapped with 10GigE device interfaces.
5GigE_Port ora_ni_uim_yang_model Used to model physical ports mapped with 5GigE device interfaces.
1GigE_Port ora_ni_uim_yang_model Used to model physical ports mapped with 1GigE device interfaces.
100M_Port ora_ni_uim_yang_model Used to model physical ports mapped with 100M device interfaces.
10M_Port ora_ni_uim_yang_model Used to model physical ports mapped with 10M device interfaces.

Table 5-14 shows the characteristics applied to the physical port specifications.

Table 5-14 Physical Port Characteristics

Characteristics Field Type Field Content
nativeEmsName String Text

Specification Cardinality

The cardinality of all specification parent-child relationships is min=0 and max=n. This approach allows Network Integrity to programmatically instantiate all objects on demand as they are discovered using the web service.

Equipment Visual Specifications

The visual facility on the Equipment specifications is not used. It is left to the customer to decide if they want to enrich the technology pack to provide visual effects to the UIM GUI for a given Equipment entity.

Field Mapping

The RESTCONF Network Discovery Cartridge supports the following field mappings:

  • Text: Implies Text [255]
  • static: Information Model 1.0 defines this field to be static on the entity specification. The specification provides getters and setters for this field.
  • dynamic: This is a dynamic field where the entity specification treats the field as a name and value pair. The specification does not provide getter and setters but generically has get and set characteristics method holding a HashSet of entries.