Skip Headers
Oracle® Communications Network Integrity Cisco Router and Switch UIM Integration Cartridge Guide
Release 7.1

E23705-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

7 About Cartridge Modeling

This chapter provides information on modeling the Cisco Router and Switch UIM Integration cartridge.

Displaying the Cisco Router and Switch UIM Integration Cartridge UML Representation

Figure 7-1 displays a Unified Modeling Language (UML) diagram depicting the object relationship being rendered.

Figure 7-1 Cisco Router and Switch UIM Integration Cartridge UML Representation

Cisco Router and Switch 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, Frame Relay, or VLAN).

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 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".

The Frame Relay device interface configuration is established and seeded with data sourced from the CISCO-FRAME-RELAY-MIB and RFC1315-MIB. See "About Poll Lists".

The VLAN device interface configuration is established and seeded with data sourced from the VLAN-CISCO-IFTABLE-RELATIONSHIP-MIB. See "About Poll Lists".

Information Model Information

All entities shown in Figure 7-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 Cisco Router and Switch SNMP cartridge supports the following configurations:

  • Generic Media

  • AtmMedia

  • FrameRelayMedia

  • VLAN Membership

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

Field Mapping

The Cisco Router and Switch 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 getter and setters but generically has get and set characteristics method holding a HashSet of entries.

Logical Mapping

The Cisco Router and Switch SNMP cartridge support the following logical mappings:

LogicalDevice

Table 7-1 shows characteristics for the LogicalDevice specification.

Table 7-1 LogicalDevice Characteristics

Characteristics (LogicalDevice) Information Model Support MIB Object Field Type Intended Usage/ 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 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 7-2 shows characteristics for the MediaInterface specification.

Table 7-2 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 specification "interfaceGeneric"

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

Thie 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 7-12.

nativeEmsServiceState

static

ifOperStatus

Enum with the following values:

  • UNKNOWN

  • IN_SERVICE

  • OUT_OF_SERVICE

  • TESTING

  • IN_MAINTENANCE

Mapped, see Table 7-12.

ifType

dynamic

ifType

Text

Mapped from IANA MIB using the properties file "snmpIfTypeMap". 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

Float

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 7-3 shows characteristics for the DeviceInterfaceConfigurationItem (IPv4) specification.

Table 7-3 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 specification "GenericMedia"


DeviceInterfaceConfigurationItem Mapping (IPv6)

Table 7-4 shows characteristics for the DeviceInterfaceConfigurationItem (IPv6) specification.

Table 7-4 DeviceInterfaceConfigurationItem (IPv6) Characteristics

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 off of 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"


DeviceInterfaceConfigurationItem Mapping (Frame Relay)

Table 7-5 shows characteristics for the DeviceInterfaceConfigurationItem Mapping (Frame Relay Media) specification.

Table 7-5 DeviceInterfaceConfigurationItem (Frame Relay Media) Characteristics

Characteristics (FrameRelayMedia) Information Model Support MIB Object Field Type Intended Usage/ Notes

DLCI

dynamic

Table index

Text

Parsed from the table index, which is in the format: <ifindex>.<DLCI>.


Table 7-6 shows characteristics for the DeviceInterfaceConfigurationItem Mapping (FrameRelayData) specification.

Table 7-6 DeviceInterfaceConfigurationItem (FrameRelayData) Characteristics

Characteristics (FrameRelayData) Information Model Support MIB Object Field Type

frCircuitIfIndex

dynamic

frCircuitIfIndex

Text

frCircuitDlci

dynamic

frCircuitDlci

Text

frCircuitState

dynamic

frCircuitState

Text

frCircuitCreationTime

dynamic

frCircuitCreationTime

Text

frCircuitLastTimeChange

dynamic

frCircuitLastTimeChange

Text

frCircuitCommittedBurst

dynamic

frCircuitCommittedBurst

Text

frCircuitExcessBurst

dynamic

frCircuitExcessBurst

Text

frCircuitThroughput

dynamic

frCircuitThroughput

Text


Table 7-7 shows characteristics for the DeviceInterfaceConfigurationItem Mapping (FrameRelayExtendedData) specification.

Table 7-7 DeviceInterfaceConfigurationItem (FrameRelayExtendedData) Characteristics

Characteristics (FrameRelayExtendedData) Information Model Support MIB Object Field Type

cfrCircuitType

dynamic

cfrCircuitType

Text

cfrExtCircuitSubIfIndex

dynamic

cfrExtCircuitSubifIndex

Text

cfrSvcThroughputIn

dynamic

cfrSvcThroughputIn

Text

cfrSvcCommitBurstIn

dynamic

cfrSvcCommitBurstIn

Text

cfrSvcExcessBurstIn

dynamic

cfrSvcExcessBurstIn

Text


DeviceInterfaceConfigurationItem Mapping (ATM Media)

Table 7-8 shows characteristics for the DeviceInterfaceConfigurationItem mapping (ATM media) specification.

Table 7-8 DeviceInterfaceConfigurationItem (ATM media) Characteristics

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 7-9 shows characteristics for the DeviceInterfaceConfigurationItem Mapping (VirtualChannelLinkData) specification.

Table 7-9 DeviceInterfaceConfigurationItem (VirtualChannelLinkData) Characteristics

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 7-10 shows characteristics for the DeviceInterfaceConfigurationItem Mapping (AtmInterfaceConfigurationData) specification.

Table 7-10 DeviceInterfaceConfigurationItem (AtmInterfaceConfigurationData) Characteristics

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


DeviceInterfaceConfigurationItem Mapping (VLAN)

Table 7-11 shows characteristics for the DeviceInterfaceConfigurationItem mapping (VLAN) specification.

Table 7-11 DeviceInterfaceConfigurationItem (VLAN) Characteristics

Characteristics (VLAN ID) Information Model Support MIB Object Field Type

cviRoutedVlanIfIndex

dynamic

cviRoutedVlanIfIndex

Text


Mapping Table

Table 7-12 shows a mapping table.

Table 7-12 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

The Cisco Router and Switch UIM Integration cartridge supports the following physical mappings:

Mapping from Cisco to Information Model Nomenclature

Table 7-13 provides the mapping from Cisco to Information Model classification of physical components. For example, if a piece of discovered equipment is classified as “Power Supply,” this cartridge maps the SNMP data into the Information Model entity type Equipment.

Table 7-13 Cisco to Information Model Physical Nomenclature Mappings

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 7-14 shows the characteristics for the PhysicalDevice specification.

Table 7-14 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

N/A

Programmatically applies specification "physicalDeviceGeneric"

discoveredModelNumber

dynamic

sysObjectId

Text

N/A

discoveredVendorName

dynamic

N/A

Text

Mapped using the snmpVendorNameMap which is created by the MIB II Properties Initializer. See "Determining the Value of the discoveredVendorName Field"

serialNumber

static

N/A

Text

N/A

physicalLocation

static

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

Mapped using the ciscoProductsMap, which is created by the Cisco SNMP Properties Initializer. See "Determining the Value of the modelName Field"

mgmtIpAddress

dynamic

N/A

Text

discoveryAddress

nativeEmsName

static

sysName

Text

N/A


Equipment

Table 7-15 shows characteristics for the Equipment specification.

Table 7-15 Equipment Characteristics

Characteristics (Equipment) Information Model Support MIB Object Field Type Intended Usage/ Notes

Id

static

N/A

Text

Programmatically generated as 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

N/A

Programmatically applies specification "equipmentGeneric"

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

Mapped using the ciscoVendorTypesMap, which is created by the Cisco SNMP Properties Initializer. "Determining the Value of the modelName Field"

nativeEmsName

static

entPhysicalDescr and absRelativePosition

Text

N/A


Equipment Holder

Table 7-16 shows characteristics for the EquipmentHolder specification.

Table 7-16 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

N/A

Programmatically applies specification "equipmentHolderGeneric"

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

Mapped using the ciscoVendorTypesMap, which is created by the Cisco SNMP Properties Initializer. See "Determining the Value of the modelName Field"

nativeEmsName

static

entPhysicalParentRelPos

Text

N/A


PhysicalPort

Table 7-17 shows characteristics for the PhysicalPort specification.

Table 7-17 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::entPhysi calParentRelPos.

Description

static

entPhysicalName

Text

N/A

Specification

static

N/A

N/A

Programmatically applies specification "equipmentGeneric"

discoveredModelNumber

dynamic

entPhysicalVendorType

Text

N/A

portNumber

static

entPhysicalParentRelPos

Integer

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

N/A

Text

Mapped using the ciscoVendorTypesMap, which is created by the Cisco SNMP Properties Initializer. See "About the absRelativePosition Value"

nativeEmsName

static

entPhysicalParentRelPos

Text

N/A