Oracle® Communications
Network Integrity

MIB-II UIM Integration Cartridge Guide

Release 7.3.2

E66043-01

May 2016

Oracle Communications Network Integrity MIB-II UIM Integration Cartridge Guide, Release 7.3.2

E66043-01

Copyright © 2010, 2016, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

Contents

Preface

- Audience

- Documentation Accessibility

- Document Revision History

1 Overview

- About MIB-II UIM Integration Cartridge

- About Cartridge Dependencies

- Run-Time Dependencies

- Design-Time Dependencies

- Opening the Cartridge Files in Design Studio

- Building and Deploying the Cartridge

2 About the Cartridge Components

- Import MIB-II from UIM Action

- Scan Parameter MIB II Initializer

- Detect MIB-II UIM Discrepancies Action

- MIB II UIM Filters Initializer

- Resolve MIB-II in UIM Action

3 Using the Cartridge

- Creating an Import MIB-II from UIM Scan

- Populating UIM with Discovered Data

4 About Cartridge Modeling

- Specification Support in UIM

- Device Generic Characteristics

- Interface Generic Characteristics

5 Design Studio Construction

- Import MIB-II from UIM Action

- Detect MIB-II UIM Discrepancies Action

- Resolve MIB-II in UIM Action

6 Design Studio Extensions

- Updating Property Files

- Extending the Cartridge for Physical Devices

- Import and Discrepancy Resolution Extensions

Preface

This guide describes the functionality and design of the Oracle Communications Network Integrity Management Information Base (MIB) II Unified Inventory Management (UIM) Integration cartridge.

Audience

This guide is intended for network administrators who want to understand the design and functionality of this cartridge and for Network Integrity developers who want either to build or extend similar cartridges.

You should have a good working knowledge of SNMP and SNMP operations, specifications, the use of Oracle Communications Design Studio for Network Integrity, and UIM.

You should be familiar with the following documents, included with this release:

- Network Integrity Concepts

- Network Integrity Developer's Guide

- Network Integrity MIB-II SNMP Cartridge Guide

- Network Integrity UIM Integration Cartridge Guide

- Network Integrity Cisco Router and Switch UIM Integration Cartridge Guide

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

Document Revision History

The following table lists the revision history for this guide:

Version

Date

Description

E66043-01

May 2016

Initial release.

1 Overview

This chapter provides an overview of the Oracle Communications Network Integrity MIB-II UIM Integration cartridge.

About MIB-II UIM Integration Cartridge

The MIB-II UIM Integration cartridge provides discrepancy detection, discrepancy resolution and import functionality for integration with Oracle Communications Unified Inventory Management (UIM). Using the MIB-II UIM Integration cartridge, you can quickly integrate arbitrarily discovered management information bean (MIB) MIB-II data with UIM.

The cartridge imports MIB-II devices from UIM and supports extensibility where custom scan parameters are required for selective import of data. The import action allows logical device trees in UIM to be imported to Network Integrity for comparison of objects with discovered data.

The cartridge detects discrepancies in MIB-II SNMP discovery results in a UIM context. The discrepancy detection action provides the mechanism to allow a filtered comparison of logical trees between data that is discovered and data that is imported from UIM.

The cartridge resolves MIB-II SNMP discrepancies into UIM. The discrepancy resolution action allows the discovered logical device trees to be created and updated in UIM. For more information about discrepancy detection and discrepancy resolution, see Network Integrity Developer's Guide.

About Cartridge Dependencies

This section provides information on dependencies that the MIB-II UIM Integration cartridge has on other cartridges.

Run-Time Dependencies

For the MIB-II UIM Integration cartridge to work at run time:

- The Address_Handlers and MIB-II SNMP cartridges must be deployed to Network Integrity.

- UIM must be installed and be accessible to Network Integrity.

The following components must be installed in UIM:

- ora_ni_uim_ocim

- ora_ni_uim_device

- UIM Integration Web Service

Design-Time Dependencies

The MIB-II UIM Integration cartridge has the following dependencies:

- MIB_II_SNMP_Cartridge

- NetworkIntegritySDK

- ora_uim_device

- UIM_Integration_Cartridge

See Network Integrity UIM Integration Cartridge Guide for information about the operation of the web service and its dependencies.

Opening the Cartridge Files in Design Studio

To review and extend the MIB-II UIM Integration cartridge, you must first download the Oracle Communications MIB-II UIM Integration cartridge software from the Oracle software delivery website:

https://edelivery.oracle.com

The software contains the MIB-II UIM Integration cartridge ZIP file, which has the following structure:

- \UIM_Cartridge_Projects\

- \Network_Integrity_Cartridge_Projects\

The UIM_Cartridge_Projects and Network_Integrity_Cartridge_Projects folders contain the extensible Design Studio files.

Note:
When importing MIB files into Design Studio, ensure that the MIB files do not have any filename extension. For example, rename the FileMIB1.txt file to FileMIB1 before importing it into Design Studio.

See the Design Studio Help and Network Integrity Developer's Guide for information about opening files in Design Studio.

Building and Deploying the Cartridge

See Design Studio Help for information about building and deploying cartridges.

2 About the Cartridge Components

This chapter describes the components of Oracle Communications Network Integrity MIB-II UIM Integration cartridge.

The MIB-II UIM Integration cartridge contains the following actions:

- Import MIB-II from UIM Action

- Detect MIB-II UIM Discrepancies Action

- Resolve MIB-II in UIM Action

Import MIB-II from UIM Action

The Import MIB-II from UIM action imports MIB-II logical 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 MIB-II from UIM action contains the following processors run in the following order:

1. Import UIM Initializer (inherited)

2. Scan Parameter MIB II Initializer

3. Logical Device UIM Finder (inherited)

4. Physical Device UIM Finder (inherited)

5. Logical Device UIM Importer (inherited)

6. LInked Physical Device UIM Importer (inherited)

7. Logical Device UIM Persister (inherited)

8. Physical Device UIM Importer (inherited)

9. Physical Device UIM Persister (inherited)

Figure 2-1 illustrates the processor workflow of the Import MIB-II from UIM action.

Figure 2-1 Import MIB-II from UIM Action Processor Workflow

Scan Parameter MIB II Initializer

This processor initializes the scan parameters configured on the Create Scan page in Network Integrity.

Table 2-1 describes the import scan parameters used to configure import filters.

Table 2-1 Import Scan Parameters in the UI

Filter

Pattern

Example

Name

Supports comma separated list for multiple values and wildcards

rot3640-11

Management IP Address

Supports comma separated list for multiple values and wildcards

10.10.10.10

Inventory State

- INSTALLED

- UNAVAILABLE

N/A

Network Location /Entity Code

Supports comma separated list for multiple values and wildcards

NYHQ1.D3

The import functionality is implemented to:

- Retrieve all the Logical Device Ids that match the filter criteria and have the deviceGeneric specification.

- Iterate over each Id:

- Retrieve the Logical tree from UIM.

- Persist the Logical Device and child interfaces.

This import action provides scan parameters that allow the user to set filters when creating an import scan. The filters determine the set of entities included in the import scan.

Table 2-2 shows scan filter values used when configuring the filters in the base class.

Table 2-2 Import Scan Parameters (not set by the user)

Filter

Value

Query Physical Devices

False

Import Related Physical or Logical Device

False

Logical Device Specification

deviceGeneric

Detect MIB-II UIM Discrepancies Action

The Detect MIB-II UIM Discrepancies action enables discrepancy detection between discovered MIB-II SNMP results and 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 in this action, see Network Integrity UIM Integration Cartridge Guide.

The Detect MIB-II UIM Discrepancies Action contains the following processors run in the following order:

1. UIM Discrepancies Filter Intializer (inherited)

2. MIB II UIM Filters Initializer

3. Discrepancy Detector (inherited)

Figure 2-2 illustrates the processor workflow of the Detect MIB-II UIM Discrepancies action.

Figure 2-2 Detect MIB-II UIM Discrepancies Action Processor Workflow

MIB II UIM Filters Initializer

This processor adds the following filters to ignore association discrepancies between logical and physical devices. Discrepancy detection between logical and physical devices is required only when a different import action is used to import both logical and physical devices.

- Disregard Association+ and Association- discrepancies on Logical Device

- Disregard Association+ and Association- discrepancies on Device Interface

Resolve MIB-II in UIM Action

The Resolve MIB-II in UIM action resolves discrepancies between discovered MIB-II SNMP data and the data imported from UIM.

This discrepancy resolution action extends the Abstract Resolve in 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 Resolve MIB-II in UIM 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

Figure 2-3 illustrates the processor workflow of the Resolve MIB-II in UIM action.

Figure 2-3 Resolve MIB-II in UIM Action Processor Workflow

3 Using the Cartridge

This chapter provides instructions for using the Oracle Communications Network Integrity MIB-II UIM Integration cartridge in Network Integrity.

Creating an Import MIB-II from UIM Scan

The Import MIB-II from UIM scan imports simple network management protocol (SNMP) logical devices from Oracle Communications Unified Inventory Management (UIM).

To create an Import MIB-II from UIM scan:

1. Create a new scan.
See the Network Integrity online Help for more information.

2. On the General tab of the Create Scan page, do the following:

- From the Scan Action list, select Import MIB-II From UIM.
The Scan Type field displays Import.

- In the Scan Action Parameters area, leave all the fields with their default values.

3. Make any other required configurations.

4. Save and run the scan.
The logical device model is created for each device and used the deviceGeneric and interfaceGeneric specifications.

Populating UIM with Discovered Data

This procedure describes steps to populate UIM with network data.

To populate UIM with discovered network data:

1. Create a new scan.
See the Network Integrity online Help for more information.

2. On the General tab of the Create Scan page, do the following:

- From the Scan Action list, select Discover MIB-II SNMP.
The Scan Type field displays Discover.

- Select Detect Discrepancies.

- In the Scan Action Parameters area, leave all the fields with their default values.

3. Run the discovery scan.
The scan generates one entity+ discrepancies for each device.

4. Right-click on the discrepancies you want to populate into UIM and select Correct in UIM.

5. Click Submit.

6. Verify that UIM is populated with the discovered data.

You can now create an import scan to import the MIB-II data from UIM. You can run a new discovery scan with discrepancy detection which should not detect any discrepancies that you populated in UIM.

4 About Cartridge Modeling

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

For information about the following, see Network Integrity MIB-II SNMP Cartridge Guide:

- MIB-II UIM Integration Cartridge UML Representation

- Hierarchy Mapping

- Oracle Communications Information Model Information

- Specifications

- Field Mappings

Specification Support in UIM

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. This cartridge is used to directly deploy specifications to UIM.

Oracle Communications Design Studio features are used to tag certain characteristics as specific to UIM. These characteristics appear on specifications deployed to UIM, but they do not appear on specifications deployed to Network Integrity.

Network Integrity specifications such as GenericMedia are defined in the MIB-II SNMP cartridge. This cartridge references ora_ni_uim_device for the shared deviceGeneric and interfaceGeneric specifications.

The following tables identify which characteristics on the shared specifications are specific to UIM.

Device Generic Characteristics

Table 4-1 shows Device Generic characteristics.

Table 4-1 Device Generic Characteristics

Characteristic Name

Specific to UIM

mgmtIpAddress

No

sysObjectId

No

nativeEmsAdminServiceState

Yes

nativeEmsServiceState

Yes

nativeEmsName

Yes

Interface Generic Characteristics

Table 4-2 shows Interface Generic characteristics.

Table 4-2 Interface Generic Characteristics

Characteristic Name

Specific to UIM

ifAlias

No

ifName

No

ifPromiscuousMode

No

ifType

Yes

minSpeed

Yes

maxSpeed

Yes

nominalSpeed

Yes

physicalAddress

Yes

physicalLocation

Yes

nativeEmsConnectorPresent

Yes

mtuCurrent

Yes

mtuSupported

Yes

nativeEmsAdminServiceState

Yes

nativeEmsServiceState

Yes

nativeEmsName

Yes

5 Design Studio Construction

This chapter provides information on using Oracle Communications Design Studio to construct for the Oracle Communications Network Integrity MIB-II UIM Integration cartridge.

Import MIB-II from UIM Action

Table 5-1 shows the import action of the MIB-II UIM Integration cartridge.

Table 5-1 Import MIB-II from UIM Action

Result Category

Scan Parameters

Model

Processors

Device

- name

- mgmtIPAddress

- adminState

- networkLocationEntityCode

MIB-II UIM Model

- Scan Parameter MIB-II UIM Initializer

- This action extends the Abstract Import from UIM action. See Network Integrity UIM Integration Cartridge Guide for information about the processors in this action.

Detect MIB-II UIM Discrepancies Action

Table 5-2 shows the discrepancy detection action of the MIB-II UIM Integration cartridge.

Table 5-2 Detect MIB-II UIM Discrepancies Action

Model

Results Source

Notes

Processors

MIB-II UIM Model

Discover MIB-II SNMP

Discrepancy detection compares the discovered tree from Discover MIB-II SNMP.

- MIB-II UIM Filters Initializer

- This action extends the Abstract Detect UIM Discrepancies action. See Network Integrity UIM Integration Cartridge Guide for information about the processors in this action.

Resolve MIB-II in UIM Action

Table 5-3 shows the discrepancy resolution action of the MIB-II UIM Integration cartridge.

Table 5-3 Resolve MIB-II in UIM Action

Model

Results Source

Result Category

Processors

MIB-II UIM Model

Discover MIB-II SNMP

All

This action extends the Abstract Resolve in UIM action. See Network Integrity UIM Integration Cartridge Guide for information about the processors in this action.

6 Design Studio Extensions

This chapter provides examples of extending certain aspects of the Oracle Communications Network Integrity MIB-II UIM Integration cartridge.

Updating Property Files

To update the property files (in the event that new interface types or new vendors are introduced), see Network Integrity MIB-II SNMP Cartridge Guide.

Extending the Cartridge for Physical Devices

If you want to extend the cartridge project to discover, resolve, and import physical device trees, see Network Integrity Cisco Router and Switch UIM Integration Cartridge Guide. This cartridge serves as a fully implemented example.

Import and Discrepancy Resolution Extensions

The import action and source code are extensible to work with physical device trees. An example of this can be seen in the Cisco Router and Switch UIM Integration cartridge that extends both the source code and Oracle Communications Design Studio construction of the import action.

The discrepancy resolution action and source code are extensible to work with physical device trees. An example of this can be seen in the Cisco Router and Switch UIM Integration cartridge that extends both the source code and Design Studio construction of the discrepancy resolution action.

Oracle Legal Notices

Copyright Notice

Copyright © 1994-2016, Oracle and/or its affiliates. All rights reserved.

License Restrictions Warranty/Consequential Damages Disclaimer

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

Warranty Disclaimer

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

Restricted Rights Notice

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

Hazardous Applications Notice

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Trademark Notice

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

Third-Party Content, Products, and Services Disclaimer

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

Alpha and Beta Draft Documentation Notice

If this document is in preproduction status:

This documentation is in preproduction status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.

Private Alpha and Beta Draft Documentation Notice

If this document is in private preproduction status:

The information contained in this document is for informational sharing purposes only and should be considered in your capacity as a customer advisory board member or pursuant to your beta trial agreement only. It is not a commitment to deliver any material, code, or functionality, and should not be relied upon in making purchasing decisions. The development, release, and timing of any features or functionality described in this document remains at the sole discretion of Oracle.

This document in any form, software or printed matter, contains proprietary information that is the exclusive property of Oracle. Your access to and use of this confidential material is subject to the terms and conditions of your Oracle Master Agreement, Oracle License and Services Agreement, Oracle PartnerNetwork Agreement, Oracle distribution agreement, or other license agreement which has been executed by you and Oracle and with which you agree to comply. This document and information contained herein may not be disclosed, copied, reproduced, or distributed to anyone outside Oracle without prior written consent of Oracle. This document is not part of your license agreement nor can it be incorporated into any contractual agreement with Oracle or its subsidiaries or affiliates.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.