About Cartridge Modeling

5 About Cartridge Modeling

This chapter provides information on modeling the Network Integrity Generic SNMP cartridge.

Generic SNMP Cartridge UML Representation

Figure 5-1 displays a unified modeling language (UML) diagram depicting the object relationship being rendered.

Figure 5-1 Generic SNMP Cartridge UML Representation

Description of "Figure 5-1 Generic SNMP Cartridge UML Representation"

Hierarchy Mapping

The data sourced from RFC1213-MIB.mgmt.mib-2.system tables establishes and seeds the logical 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 media-specific parameters define the behavior of the interface (Generic, ATM).

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

RFC1213-MIB.mgmt.mib-2.system
RFC1213-MIB.mgmt.mib-2.interfaces.ifTable
IF-MIB.mgmt.mib-2.ifMIB.ifMIBObjects.ifXTable.ifXEntry
IP-MIB.mgmt.mib-2.ip.ipAddressTable.ipAddressEntry
IF-MIB.mgmt.mib-2.ifMIB.ifMIBObjects.ifStackTable.ifStackEntry.ifStackStatus

IF-MIB.mgmt.mib-2.ifMIB.ifMIBObjects.ifStackTable.ifStackEntry.ifStackStatus establishes the interface hierarchy.

The generic media device interface configuration is established and seeded with data sourced from the following:

RFC1213-MIB.mgmt.mib-2.ip.ipAddrTable.ipAddrEntry
IP-MIB.mgmt.mib-2.ip.ipAddressTable.ipAddressEntry

The ATM media device interface configuration is established and seeded with data sourced from the ATM-MIB. See "About Poll Lists".

Oracle Communications Information Model Information

All entities shown in Figure 5-1 (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.

The Generic SNMP cartridge supports the following configurations:

Generic Media
AtmMedia

For a listing of the Information Model fields, see "Logical Mapping" and "Physical Mapping".

Specifications

This section lists the specifications included in the ora_ni_uim_device cartridge for modeling Generic vendor 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 Oracle Communications Unified Inventory Management (UIM) are defined in the ora_ni_uim_device cartridge. These cartridges are used to directly deploy specifications to UIM.

PhysicalDevice

This specification models a physical device entity.

Table 5-1 shows the specifications for physical device.

Table 5-1 Physical Device Specifications

Specification	Cartridge	Intended Usage
GenericPhysicalDeviceSpecification	ora_ni_uim_device	Used to model all types of generic devices.

GenericPhysicalDeviceSpecification is available in ora_ni_uim_device and used to model all type of generic devices.

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

Table 5-2 Physical Device Characteristics

Characteristics	Field Type	Field Content
mgmtIpAddress	String	Text
modelName	String	Text
discoveredModelNumber	String	Text
discoveredPartNumber	String	Text
discoveredVendorName	String	Text
serialNumber	String	Text
physicalLocation	String	Text
hardwareRev	String	Text
softwareRev	String	Text
nativeEmsName	String	Text

Equipment

Table 5-3 Equipment Specifications

Specification	Cartridge	Intended Usage
GenericEquipmentShelfSpecification	ora_ni_uim_device	Used to model shelf for all generic devices.
GenericEquipmentSpecification	ora_ni_uim_device	Used to model card for all generic devices.

GenericEquipmentShelfSpecification and GenericEquipmentSpecification are available in ora_ni_uim_device and used to model generic devices.

Table 5-4 GenericEquipmentShelfSpecification Characteristics

Characteristics	Field Type	Field Content
discoveredModelNumber	String	Text
discoveredPartNumber	String	Text
discoveredVendorName	String	Text
hardwareRev	String	Text
softwareRev	String	Text
modelName	String	Text
nativeEmsName	String	Text
owner	String	Text
userLabel	String	Text

Table 5-5 GenericEquipmentSpecification Characteristics

Characteristics	Field Type	Field Content
discoveredModelNumber	String	Text
discoveredPartNumber	String	Text
discoveredVendorName	String	Text
hardwareRev	String	Text
softwareRev	String	Text
modelName	String	Text
nativeEmsName	String	Text
owner	String	Text
userLabel	String	Text

Equipment Holder

Table 5-7 shows the characteristics applied to the EquipmentHolder specifications.

Table 5-6 Equipment Holder Specifications

Specification	Cartridge	Intended Usage
GenericEquipmentHolderSpecification	ora_ni_uim_device	Used to model all types of Generic Vendor devices.

GenericEquipmentHolderSpecification is available in ora_ni_uim_device and used to model Generic Vendor devices.

Table 5-7 EquipmentHolder Characteristics

Characteristics	Field Type	Field Content
modelName	String	Text
nativeEmsName	String	Text
discoveredModelNumber	String	Text
discoveredPartNumber	String	Text
discoveredVendorName	String	Text
hardwareRev	String	Text
softwareRev	String	Text
owner	String	Text
userLabel	String	Text

Physical Port

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

Table 5-8 Physical Port Characteristics

Characteristics	Field Type	Field Content
modelName	String	Text
discoveredModelNumber	String	Text
discoveredPartNumber	String	Text
discoveredVendorName	String	Text
serialNumber	String	Text
physicalLocation	String	Text
hardwareRev	String	Text
softwareRev	String	Text
nativeEmsName	String	Text
physicalAddress	String	Text

Table 5-9 Physical Port Characteristics

Characteristics	Field Type	Field Content
direction	String	Text
discoveredVendorName	String	Text
discoveredPartNumber	String	Text
discoveredVendorName	String	Text
hardwareRev	String	Text
softwareRev	String	Text
edgePoint	String	Text
nativeEmsName	String	Text
tpProtectionAssociation	String	Text
portLevel	String	Text
portType	String	Text

Logical Device

For logical device and device interface specification details, see Network Integrity MIB-II SNMP Cartridge Guide.

Specification Cardinality

The cardinality of all specification parent-child relationships is included in the software code so that 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.

Field Mapping

The Generic SNMP 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 getters and setters but generically has get and set characteristics method holding a HashSet of entries.

Logical Mapping

The Generic SNMP cartridge supports the following logical mappings:

LogicalDevice

Table 5-10 shows characteristics for the LogicalDevice specification.

Table 5-10 LogicalDevice Characteristics

Characteristics (LogicalDevice)	Information Model Support	MIB Object	Field Type	Intended Usage
Id	static	N/A	Text	Programmatically generated as MgmtIPAddress::sysName::"LogicalDevice"
Name	static	sysName	Text	N/A
Description	static	sysDescr	Text	N/A
Specification	static	N/A	N/A	Programmatically applies deviceGeneric specification
nativeEmsAdminServiceState	static	N/A	Enum with the following values: UNKNOWN IN_SERVICE OUT_OF_SERVICE TESTING IN_MAINTENANCE	Nothing available to source the field
nativeEmsName	static	sysName	Text	N/A
nativeEmsServiceState	static	N/A	Enum with the following values: UNKNOWN IN_SERVICE OUT_OF_SERVICE TESTING IN_MAINTENANCE	Nothing available to source the field
mgmtIpAddress	dynamic	N/A	Text	discoveryAddress
sysObjectId	dynamic	sysObjectId	Text	Support legacy systems

MediaInterface

Table 5-11 shows characteristics for the MediaInterface specification.

Table 5-11 MediaInterface Characteristics

Characteristics (MediaInterface)	Information Model Support	MIB Object	Field Type	Intended Usage/ Notes
Id	static	N/A	Text	Programmatically generated as MgmtIPAddress::sysName::ifDescr::"MediaInterface"
Name	static	ifDescr	Text	N/A
Description	static	ifDescr	Text	N/A
Specification	static	N/A	N/A	Programmatically applies interfaceGeneric specification
interfaceNumber	static	N/A	Text	Nothing available to source the field.
customerInterfaceNumber	static	N/A	Text	Nothing available to source the field.
vendorInterfaceNumber	static	ifName	Text	N/A
nativeEmsName	static	ifDescr	Text	The field must be unique. ifDescr guarantees the uniqueness of a device.
nativeEmsAdminServiceState	static	ifAdminStatus	Enum with the following values: UNKNOWN IN_SERVICE OUT_OF_SERVICE TESTING IN_MAINTENANCE	Mapped, see Table 5-17.
nativeEmsServiceState	static	ifOperStatus	Enum with the following values: UNKNOWN IN_SERVICE OUT_OF_SERVICE TESTING IN_MAINTENANCE	Mapped, see Table 5-17.
ifType	dynamic	ifType	Text	Mapped from IANA MIB using the snmpIfTypeMap properties file. Look up returning null results in a value of "n".
mtuSupported	static	N/A	Float	Nothing available to source the field. Defaults to 0.0
mtuCurrent	static	ifMtu	Float	N/A
physicalAddress	static	ifPhysAddress	Text	N/A
physicalLocation	static	sysLocation	Text	N/A
minSpeed	static	N/A	Float	Nothing available to source the field. Defaults to 0.0
maxSpeed	static	N/A	Float	Nothing available to source the field. Default to 0.0
nominalSpeed	static	ifSpeed \| ifHighSpeed	Float	ifHighSpeed overrides ifSpeed when ifHighSpeed is available
ifAlias	dynamic	ifAlias	Text	N/A
ifName	dynamic	ifName	Text	Support legacy systems

DeviceInterfaceConfigurationItem Mapping (IPv4)

Table 5-12 shows characteristics for the DeviceInterfaceConfigurationItem (IPv4) specification.

Table 5-12 DeviceInterfaceConfigurationItem (IPv4) Characteristics

Characteristics (Generic Media)	Information Model Support	MIB Object	Field Type	Intended Usage/ Notes
ipAddress	dynamic	ipAdEntAddr	Text	N/A
prefix	dynamic	ipAdEntNetMask	Text	N/A
ipVersion	dynamic	ipAddressType	Enum IPV4 IPV6	Programmatically set to IPV4.
Specification	static	N/A	N/A	Programmatically applies GenericMedia specification

DeviceInterfaceConfigurationItem Mapping (IPv6)

Table 5-13 shows characteristics for the DeviceInterfaceConfigurationItem (IPv6) specification.

Table 5-13 Characteristics for the DeviceInterfaceConfigurationItem (IPv6) Specification

Characteristics (Generic Media)	Information Model Support	MIB Object	Field Type	Intended Usage/ Notes
ipAddress	dynamic	ipAddressIfIndex	Text	For IPv6 addresses the actual IP is derived from the index since ipAddressAddr is not acceptable.
prefix	dynamic	ipAddressPrefix	Text	N/A
ipVersion	dynamic	ipAddressType	Enum IPV4 IPV6	Programmatically set to IPV6.
Specification	static	N/A	N/A	Programmatically applies GenericMedia specification

DeviceInterfaceConfigurationItem Mapping (ATM Media)

Table 5-14 shows characteristics for the DeviceInterfaceConfigurationItem mapping (ATM media) specification.

Table 5-14 Characteristics for the DeviceInterfaceConfigurationItem (ATM media) Specification

Characteristics (ATM Media)	Information Model Support	MIB Object	Field Type	Intended Usage/ Notes
VPI	dynamic	Table index	Text	Parsed from the table index, which is in the format: <ifIndex>.<VPI>.<VCI>
VCI	dynamic	Table index	Text	Parsed from the table index, which is in the format: <ifIndex>.<VPI>.<VCI>

Table 5-15 shows characteristics for the DeviceInterfaceConfigurationItem Mapping (VirtualChannelLinkData) specification.

Table 5-15 Characteristics for the DeviceInterfaceConfigurationItem (VirtualChannelLinkData) Specification

Characteristics (VirtualChannelLinkData)	Information Model Support	MIB Object	Field Type
atmVccAal5EncapsType	dynamic	atmVccAal5EncapsType	Text
atmVccAalType	dynamic	atmVccAalType	Text
atmVclLastChange	dynamic	atmVclLastChange	Text
atmVclAdminStatus	dynamic	atmVclAdminStatus	Text
atmVclOperStatus	dynamic	atmVclOperStatus	Text

Table 5-16 shows characteristics for the DeviceInterfaceConfigurationItem Mapping (AtmInterfaceConfigurationData) specification.

Table 5-16 Characteristics for the DeviceInterfaceConfigurationItem (AtmInterfaceConfigurationData) Specification

Characteristics (AtmInterfaceConfigurationData)	Information Model Support	MIB Object	Field Type
atmInterfaceMaxVpcs	dynamic	atmInterfaceMaxVpcs	Text
atmInterfaceMaxVccs	dynamic	atmInterfaceMaxVccs	Text
atmInterfaceMaxActiveVpiBits	dynamic	atmInterfaceMaxActiveVpiBits	Text
atmInterfaceMaxActiveVciBits	dynamic	atmInterfaceMaxActiveVciBits	Text
atmInterfaceIlmiVpi	dynamic	atmInterfaceIlmiVpi	Text
atmInterfaceIlmiVci	dynamic	atmInterfaceIlmiVci	Text
atmInterfaceAddressType	dynamic	atmInterfaceAddressType	Text
atmInterfaceAdminAddress	dynamic	atmInterfaceAdminAddress	Text

Mapping Table

Table 5-17 shows a mapping table.

Table 5-17 Mapping Table

ifOperStatus	ifAdminStatus	nativeEmsServiceState nativeEmsAdminState
4: unknown, 6: notPresent	N/A	UNKNOWN
1: up	1: up	IN_SERVICE
2: down, 5: dormant, 7: lowerLayerDown	2: down	Programmatically set to OUT_OF_SERVICE.
3: testing	3: testing	TESTING
N/A	N/A	IN_MAINTENANCE

Physical Mapping

This cartridge support the following physical mappings:

Information Model Nomenclature Mapping

Information Model mapping helps in classification of physical components. For example, if an equipment is classified as "Power Supply," this cartridge maps the SNMP data into the Information Model entity type Equipment. Table 5-18 lists the various physical classes and the Information Model entity type they are mapped to.

Table 5-18 Information Model Nomenclature Mapping

entPhysicalClass	Information Model
root	Physical Device
Other (1)	Unsupported
Unknown (2)	Unsupported
Chassis (3)	Equipment-Shelf
Backplane (4)	Equipment-Shelf
Container (5)	Equipment-Holder
Power supply (6)	Equipment
Fan (7)	Equipment
Sensor (8)	Equipment
Module (9)	Equipment-Card
Port (10)	Physical Port
Stack (11)	Unsupported

PhysicalDevice

Table 5-19 shows the characteristics for the PhysicalDevice specification.

Table 5-19 PhysicalDevice Characteristics

Characteristics (Physical Device)	Information Model Support	MIB Object	Field Type	Intended Usage/ Notes
Id	static	N/A	Text	Programmatically generated as MgmtIPAddress::sysName::0::"PhysicalDevice".
Name	static	sysName	Text	N/A
Description	static	sysDescr	Text	N/A
Specification	static	N/A	Text	Programmatically applies GenericPhysicalDeviceSpecification specification.
discoveredModelNumber	dynamic	sysObjectId	Text	N/A
discoveredVendorName	dynamic	N/A	Text	Set to "Network Vendor".
serialNumber	static	N/A	Text	N/A
physicalLocation	N/A	location	Text	N/A
discoveredPartNumber	dynamic	N/A	Text	N/A
hardwareRev	dynamic	N/A	Text	N/A
softwareRev	dynamic	N/A	Text	N/A
ModelName	dynamic	N/A	Text	Set to "Network Equipment Type".
mgmtIpAddress	dynamic	N/A	Text	discoveryAddress
nativeEmsName	static	sysName	Text	N/A

Equipment

Table 5-20 shows characteristics for the Equipment specification.

Table 5-20 Equipment Characteristics

Characteristics (Equipment)	Information Model Support	MIB Object	Field Type	Intended Usage/ Notes
Id	static	N/A	Text	Programmatically set to MgmtIPAddress::sysName:: [absRelativePosition]::"Equipment.Rack\|Shelf\|Card". See "About the absRelativePosition Value".
Name	static	entPhysicalDescr	Text	N/A
Description	static	entPhysicalDescr	Text	N/A
Specification	static	N/A	Text	Programmatically applies GenericEquipmentShelfSpecification or GenericEquipmentSpecification based on device type (shelf/card).
discoveredModelNumber	dynamic	entPhysicalVendorType	Text	N/A
discoveredVendorName	dynamic	entPhysicalMfgName	Text	N/A
serialNumber	static	entPhysicalSerialNum	Text	N/A
physicalLocation	static	location	Text	N/A
discoveredPartNumber	dynamic	entPhysicalModelName	Text	N/A
hardwareRev	dynamic	entPhysicalHardwareRev	Text	N/A
softwareRev	dynamic	entPhysicalSoftwareRev	Text	N/A
ModelName	dynamic	N/A	Text	Programmatically applies based on entPhysicalDescr or entPhysicalModelName.
nativeEmsName	static	entPhysicalDescr and absRelativePosition	Text	N/A

EquipmentHolder

Table 5-21 shows characteristics for the EquipmentHolder specification.

Table 5-21 EquipmentHolder Characteristics

Characteristics (EquipmentHolder)	Information Model Support	MIB Object	Field Type	Intended Usage/ Notes
Id	static	N/A	Text	Programmatically generated as MgmtIPAddress::sysName::[absRelativePosition]::"EquipmentHolder". See "About the absRelativePosition Value".
Name	static	entPhysicalDescr and entPhysicalParentRelPos	Text	Programmatically generated as entPhysicalDescr::entPhysi calParentRelPos.
Description	static	entPhysicalDescr	Text	N/A
Specification	static	N/A	Text	Programmatically applies GenericEquipmentHolderSpecification.
discoveredModelNumber	dynamic	entPhysicalVendorType	Text	N/A
discoveredVendorName	dynamic	entPhysicalMfgName	Text	N/A
serialNumber	static	entPhysicalSerialNum	Text	N/A
physicalLocation	static	location	Text	N/A
discoveredPartNumber	dynamic	entPhysicalModelName	Text	N/A
hardwareRev	dynamic	entPhysicalHardwareRev	Text	N/A
softwareRev	dynamic	entPhysicalSoftwareRev	Text	N/A
ModelName	dynamic	entPhysicalDescr or entPhysicalModelName	Text	Programmatically applies based on entPhysicalDescr or entPhysicalModelName
nativeEmsName	static	entPhysicalParentRelPos	Text	N/A

PhysicalPort

Table 5-22 shows characteristics for the PhysicalPort specification.

Table 5-22 PhysicalPort Characteristics

Characteristics (PhysicalPort)	Information Model Support	MIB Object	Field Type	Intended Usage/ Notes
Id	static	N/A	Text	Programmatically generated as MgmtIPAddress::sysName::[absRelativePosition]::"PhysicalPort". See "About the absRelativePosition Value".
Name	static	entPhysicalDescr and entPhysicalParentRelPos	Text	Programmatically generated as entPhysicalDescr::entPhysicalParentRelPos.
Description	static	entPhysicalName	Text	N/A
Specification	static	N/A	Text	Programmatically applies GenericPhysicalPortSpecification.
discoveredModelNumber	dynamic	entPhysicalVendorType	Text	N/A
portNumber	static	entPhysicalParentRelPos	Int	N/A
customerPortName	static	entPhysicalParentRelPos	Text	N/A
vendorPortName	static	N/A	Text	N/A
discoveredVendorName	dynamic	entPhysicalMfgName	Text	N/A
serialNumber	static	entPhysicalSerialNum	Text	N/A
physicalLocation	static	location	Text	N/A
discoveredPartNumber	dynamic	entPhysicalModelName	Text	N/A
hardwareRev	dynamic	entPhysicalHardwareRev	Text	N/A
softwareRev	dynamic	entPhysicalSoftwareRev	Text	N/A
ModelName	dynamic	entPhysicalDescr or entPhysicalModelName	Text	Programmatically applies based on entPhysicalDescr or entPhysicalModelName
nativeEmsName	static	entPhysicalParentRelPos	Text	N/A