4 About Cartridge Modeling

This chapter provides information on modeling the Oracle Communications Network Integrity MIB-II SNMP cartridge.

MIB-II SNMP Cartridge UML Representation

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

Figure 4-1 MIB-II SNMP Cartridge UML Representation

Displays a UML representation of the MIB-II SNMP cartridge

Hierarchy Mapping

The logical device object is established and seeded with data sourced by RFC1213-MIB.mgmt.mib-2.system tables.

As a device is discovered, the media interface encapsulates common information about that interface. The device interface configuration captures the media type information that decorates the interface with media-specific parameters that define its behavior (that is; Generic, ATM, Frame Relay or VLAN). This cartridge supports only Generic.

Interfaces are established and seeded with data sourced by:

  • 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

The interface hierarchy is established by:

  • F-MIB.mgmt.mib-2.ifMIB.ifMIBObjects.ifStackTable.ifStackEntry.ifStackStatus

Device interface configuration is established and seeded with data sourced by:

  • RFC1213-MIB.mgmt.mib-2.ip.ipAddrTable.ipAddrEntry

  • IP-MIB.mgmt.mib-2.ip.ipAddressTable.ipAddressEntry

About Oracle Communications Information Model

The logical device and media interface objects are Oracle Communications Information Model 1.0 compliant for static fields. The dynamic fields (sometimes referred to as characteristics) are considered application-specific.

The device interface configuration is considered a mechanism to customize the media interface to show application specific data. See Figure 4-1, "MIB-II SNMP Cartridge UML Representation".

This cartridge supports only generic media. Other cartridges support other configurations:

  • AtmMedia

  • FrameRelayMedia

  • VLAN Membership

For a listing of the Information Model fields, see "Field Mappings".

Specifications

This section lists the specifications included in the Network Integrity MIB-II SNMP cartridge.

Logical Device: deviceGeneric

This specification models a generic Logical Device entity.

This specification is used to model a logical device discovered by Network Integrity.

Table 4-1 shows the characteristics applied to the generic device specification.

Table 4-1 Characteristics Applied to the deviceGeneric Specification

Characteristics Field Type Field Content Intended Usage/ Notes

mgmtIpAddress

String

Text

Management IP address of discovered device

nativeEmsAdminServiceState

Drop Down box

Enum with the following values:

  • UNKNOWN

  • IN_SERVICE

  • OUT_OF_SERVICE

  • TESTING

  • IN_MAINTENANCE

Device administered state

nativeEmsServiceState

Drop Down box

Enum with the following values:

  • UNKNOWN

  • IN_SERVICE

  • OUT_OF_SERVICE

  • TESTING

  • IN_MAINTENANCE

Device actual state

nativeEmsName

String

Text

Device actual name

sysObjectId

String

Text

The vendor's authoritative identification of the network management subsystem contained in the entity.

Device Interface: interfaceGeneric

This specification models a generic interface entity.

This specification is used to model an interface discovered by Network Integrity.

Table 4-2 shows the characteristics applied to the interfaceGeneric specification.

Table 4-2 Characteristics Applied to the interfaceGeneric Specification

Characteristics Field Type Field Content Intended Usage/ Notes

nativeEmsName

String

Text

Alternate name this interface could be known by

nativeEmsAdminServiceState

String

Enum with the following values:

  • UNKNOWN

  • IN_SERVICE

  • OUT_OF_SERVICE

  • TESTING

  • IN_MAINTENANCE

Interface administered state

nativeEmsServiceState

Drop Down box

Enum with the following values:

  • UNKNOWN

  • IN_SERVICE

  • OUT_OF_SERVICE

  • TESTING

  • IN_MAINTENANCE

Interface actual state

ifType

Drop Down box

Text

IANA iftype

mtuSupported

String

Text (numeric)

Max allowed MTU

mtuCurrent

String

Text (numeric)

Current Value of MTU

physicalAddress

String

Text

Interface's address at its protocol sub-layer

physicalLocation

String

Text

Location of interface

minSpeed

String

Text (numeric)

Minimum speed of interface

maxSpeed

String

Text (numeric)

Max speed of interface

nominalSpeed

String

Text (numeric)

Nominal speed of interface

ifAlias

String

Text

Alternate name this interface could be known by

ifName

String

Text

Alternate name this interface could be known by

Other Characteristics

This MIB-II SNMP Cartridge additionally models the following characteristics. These characteristics are used by the Network Integrity Cisco Router and Switch SNMP cartridge which extends the sample technology pack.

Table 4-3 shows the characteristics used by Network Integrity Cisco Router and Switch SNMP cartridge.

Table 4-3 Characteristics used by ora_ni_uim_cisco_device

Characteristics Field Type Field Content Intended Usage/ Notes

discoveredModelNumber

String

Text

All Physical Equipment

discoveredPartNumber

String

Text

All Physical Equipment

discoveredVendorName

String

Text

All Physical Equipment

hardwareRev

String

Text

All Physical Equipment

softwareRev

String

Text

All Physical Equipment

modelName

String

Text

All Physical Equipment

Specification Lineage

        deviceGeneric
                    [0.100000] interfaceGeneric
                         [0.100000] interfaceGeneric

Sample Logical Device Hierarchy

Figure 4-2 shows a logical device hierarchy.

Figure 4-2 Sample Logical Device Hierarchy

Displays scan result for discovered logical device

Field Mappings

This section provide information about field mappings used in the cartridge:

  • Text: Implies Text [255].

  • static: The Information Model 1.0 defines this field to be static on the entity specification. The specification provides getters/setters for this field.

  • dynamic: This is a dynamic field where the entity specification treats the field as a name/value pair. The specification does not provide getter/setters but generically has a get/setCharacteristics method holding a HashSet of entries.

The following tables describe field mappings used in the cartridge:

Logical Device Mapping

Table 4-4 shows the logical device mapping for the MIB-II SNMP cartridge.

Table 4-4 Logical Device Mapping

LogicalDevice Information Model Support MIB Object Field Type Notes

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 specification ”deviceGeneric”

nativeEmsAdminServiceState

static

N/A

Enum:

  • UNKNOWN

  • OUT_OF_SERVICE

  • TESTING

  • IN_SERVICE

  • IN_MAINTENANCE

No source

nativeEmsServiceState

static

N/A

Enum:

  • UNKNOWN

  • OUT_OF_SERVICE

  • TESTING

  • IN_SERVICE

  • IN_MAINTENANCE

No source

nativeEmsName

static

sysName

Text

N/A

mgmtIpAddress

dynamic

N/A

Text

discoveryAddress

sysObjectId

dynamic

sysObjectId

Text

Support legacy systems

Media Interface Mapping

Table 4-5 shows the media interface mapping for the MIB-II SNMP cartridge.

Table 4-5 Media Interface Mapping

Media Interface Information Model Support MIB Object Field Type Notes

Id

static

N/A

Text

Programmatically generated asMgmtIPAddress:: sysName::ifDesc::"MediaInterface"

Name

static

ifDescr

Text

N/A

Description

static

ifDescr

Text

N/A

Specification

static

N/A

N/A

Programmatically applies specification "interfaceGeneric"

interfaceNumber

static

N/A

Text

No source

customerInterfaceNumber

static

N/A

Text

No source

vendorInterfaceNumber

static

ifName

Text

N/A

nativeEmsName

static

ifDesc

Text

Field must be unique. ifDescr guarantees uniqueness in device.

nativeEmsAdminServiceState

static

ifAdminStatus

Enum:

  • UNKNOWN

  • OUT_OF_SERVICE

  • TESTING

  • IN_SERVICE

  • IN_MAINTENANCE

Mapped.

See "Mapping Table" for more information.

nativeEmsServiceState

static

ifOperStatus

Enum:

  • UNKNOWN

  • OUT_OF_SERVICE

  • TESTING

  • IN_SERVICE

  • IN_MAINTENANCE

Mapped.

See "Mapping Table" for more information.

ifType

dynamic

ifType

Text

Mapped from IANA MIB using properties file "snmpIfTypeMap".

Look up returning null results in value of "n"

mtuSupported

static

N/A

Float

No source. 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

No source. Defaults to 0.0

maxSpeed

static

N/A

Float

No source. Defaults 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

Device Interface Configuration Mapping (IPv4)

Table 4-6 shows the device interface configuration mapping for Internet Protocol, Version 4, for the MIB-II SNMP cartridge.

Table 4-6 Device Interface Configuration Mapping (IPv4)

Generic Media Information Model Support MIB Object Field Type 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 specification "GenericMedia"

Device Interface Configuration (IPv6)

Table 4-7 shows the device interface configuration for the Internet Protocol, Version 6 for the MIB-II SNMP cartridge.

Table 4-7 Device Interface Configuration Mapping (IPv6)

Generic Media Information Model Support MIB Object Field Type Notes

ipAddress

dynamic

ipAddressIfIndex

Text

For IP v6 addresses, the actual IP is derived from the index since ipAddressAddr is not accessible.

prefix

dynamic

ipAddressPrefix

Text

N/A

ipVersion

dynamic

ipAddressType

Enum {IPV4 | IPV6}

Programmatically set to IPV6

Specification

static

N/A

N/A

Programmatically applies specification "GenericMedia"

Mapping Table

Table 4-8 shows the mapping of ifOperStatus/ifAdminStatus to nativeEms(Admin)ServiceState.

Table 4-8 Mapping Table

ifOperStatus ifAdminStatus nativeEmsServiceStatenativeEmsAdminState

1: up

1: up

IN_SERVICE

2: down

2: down

OUT_OF_SERVICE

3: testing

3: testing

TESTING

4: unknown

N/A

UNKNOWN

5: dormant

2: down

OUT_OF_SERVICE

6: notPresent

N/A

UNKNOWN

7: lowerLayerDown

2: down

OUT_OF_SERVICE

N/A

N/A

IN_MAINTENANCE