Table Of Contents

Introduction

What is Contained in this Guide

Navigating through this Guide

Components and Processes of the NMOS

Databases of MWFM NMOS

Languages of MWFM NMOS

Quick Reference

Who is this Guide for?

Styles used in this Guide

Commands, file names and directories

Command lines, example scripts and code

Keywords in Language Syntax

Common Definitions and Abbreviations

What's Next?

Introduction

---

This chapter provides an outline of the contents of the Cisco Mobile Wireless Fault
Mediator 2.0.1 - Topology and Platform Modeling Reference Guide. An Overview of each chapter is provided along with additional information on MWFM nomenclature.

What is Contained in this Guide

In this guide you are provided with detailed information about the components (and their constituent databases) that make up MWFM NMOS. The following descriptions briefly summarize the contents of each chapter:

Table 1-1 Chapters of the Reference Guide and a summary of their Contents 

Chapter	Chapter title	Description
1	Introduction	Illustrates the styles and conventions used in the Cisco Mobile Wireless Fault Mediator 2.0.1 - Topology and Platform Modeling Reference Guide.
2	MWFM NMOS database schemata	Introduces the schema and naming convention adopted for the databases used in MWFM NMOS.
3	MWFM NMOS Overview	Gives a general overview of MWFM NMOS and how it forms the foundation of the Network Management Operating System solution.
4	Active Objects	Describes the containment data model used by MWFM NMOS and introduces the concepts of class hierarchies, inheritance, Active Objects, and Active Object Classes.
5	The CLASS Component	Describes the MWFM NMOS Active Object Class manager and distributor, riv_class, and how to run it.
6	The DISCO Component	Provides an introduction to the operation of the auto-discovery process manager, DISCO. It also details how to run DISCO.
7	The Discovery Process	Provides an overview of the default discovery process and introduces the concept of a configurable discovery data flow. This chapter also introduces Containment Model and the advanced discovery features.
8	Discovering Devices: Configuring the Finders	Describes the processes that are responsible for discovering device existence in the network.
9	The Discovery Agents	Describes the processes that are responsible for the retrieval of connectivity information from the network, i.e., the Details Agent and the Discovery Agents.
10	Inter-process Communication	Describes the communication between DISCO and the Helper Server.
11	The Helper System	Introduces the methodology of the system used to retrieve connectivity information from the network during the discovery process and its advantages.
12	The Helpers	Describes the various Helpers that compose the Helper system and explains how to configure their operation.
13	The Stitchers	Describes the powerful processes that knit connectivity information together to form a network topology.
14	The MODEL component	Describes the network topology repository and distributor, MODEL, and how to run it.
15	The MONITOR Component	Describes the polling process controller used to monitor device status in the network, MONITOR, and how to run it.
16	The Polling Agent databases	Describes the entities responsible for monitoring the status of network devices, i.e. the Polling Agents.
17	The AUTH Component	Describes the MWFM NMOS authentication engine, AUTH, which is responsible for user profiles and security privileges.
18	The CTRL Component	Describes the MWFM NMOS process controller, CTRL.
19	The STORE component	Describes the functionality and configuration of MWFM NMOS' persistent storage engine STORE.
20	The DIST Component	Describes the process responsible for enabling the distribution of MWFM NMOS to multiple NMOS domains.
21	External Data Types	Provides a list of all the externally defined data types that you will encounter in some of the MWFM NMOS databases.
22	The Databases of CLASS	Describes the databases used by the Active Object Class manager, CLASS.
23	DIST Configuration Databases	Gives a detailed description of the databases that determine the overall behavior of DISCO.
24	DISCO Databases	Gives a detailed description of the databases that can be interrogated to retrieve the current discovery data flow, monitor the status of discovery processes, and track the progress of the discovery process.
25	DISCO Configuration Databases	Provides a detailed description of the databases used by the individual processes responsible for discovering existence and connectivity of devices on the network.
26	MODEL Databases	Describes the databases used by MODEL for the storage and distribution of the network topology.
27	Monitor Database	Describes the databases used by MONITOR for the management and monitoring of the Polling Agents.
28	The Polling Agent databases	Describes the databases used by CTRL to manage the overall processes of MWFM NMOS.
29	The Database of CTRL	Gives a description of the databases used to configure the persistent data store, STORE, and provides example configurations.
30	The Databases of STORE	Gives a description of the databases used to configure the NMOS component DIST, the interface between the NMOS and third party legacy applications.
31	DIST Configuration Databases	Provides you with some concepts that are common to all NMOS languages, with which you are advised to familiarize yourself before reading the syntax definition of the languages that follows.
32	Language Prerequisites	Introduces the OQL service provider riv_oql, including its detailed syntax definition and a tutorial for the language used by all MWFM NMOS processes to talk to their databases, the Object Query Language (OQL).
33	The OQL Language	Provides a syntax definition of the language used to write text-defined Stitchers.
Appendix A	Appendix A, "Quick Reference"	Provides a quick reference for MWFM NMOS components, executable names, command lines, and database structures.

Navigating through this Guide

The chapters in the Cisco Mobile Wireless Fault Mediator 2.0.1 - Topology and Platform Modeling Reference Guide are organized into broad groups, which should assist you in finding information as quickly as possible. The groups are listed below.

•An introduction to the various functional components and processes that make up MWFM NMOS.

•A detailed description of all the databases used by each of the components and processes.

•A detailed description of the syntax of all the languages available when using MWFM NMOS.

A brief description of these groups is given below.

Components and Processes of the NMOS

"MWFM NMOS Overview" through "The DIST Component," focus on the individual components and processes that constitute MWFM. Within each chapter there is a description of how each component or process works and how they interact with other processes or components.

You are then introduced to the configuration files that are responsible for each component's behavior. Finally, each chapter provides you with the necessary command line options needed to start each process or component, together with a list of recommended prerequisites that must be in place prior to starting the component.

This group of chapters shall henceforth be referred to (when it is referenced by external documents) as the components and processes section of the NMOS Reference Guide.

Databases of MWFM NMOS

"External Data Types," focuses on the databases that are defined within the scope of each of the components' configuration files. A full description of each database, the constituent tables of each database, and a full description of each field within each table is provided. The location of each configuration file is indicated as well as a full description of the implications of altering the contents of some of the databases. In some cases, examples demonstrate how to configure some of the components and processes using their databases.

This group of chapters shall henceforth be referred to (when it is referenced by external documents) as the databases section of the NMOS Reference Guide.

Languages of MWFM NMOS

"Language Prerequisites," focuses on the languages that are available for use in MWFM NMOS. Initially, information is given that will assist you in understanding the concepts behind the languages; you are strongly advised to avail yourself of the information contained within this introductory chapter.

The next few chapters introduce you to the Object Query Language (OQL), whose syntax is fully described in terms of operations performed on a clearly defined database; the Stitcher language, which is used in collaboration with OQL to write text Stitchers, and finally the full functionality of a powerful feature that is common to both languages, the eval statement, is described.

This group of chapters shall henceforth be referred to (when it is referenced by external documents) as the languages section of the NMOS Reference Guide.

Quick Reference

"Quick Reference," recognizes the fact that information is often needed at a glance and gives you quick access to the following information:

•A list of command line options needed to start the MWFM NMOS components.

•Pictorial representations of the databases and their constituent tables for each component of the MWFM NMOS.

•OQL interface command line options for components' databases.

•A list of service names for use with the OQL service provider command line.

•A list of all processes and their executable names.

•A list of the locations of each configuration file for each NMOS component.

Who is this Guide for?

This guide is aimed at network administrators who need to set up MWFM NMOS and tailor its features to suit their particular network.

It is assumed that the reader will already have a reasonable knowledge of networks and how they are configured and managed.

Styles used in this Guide

Certain styles are used to highlight specific items throughout the Cisco Mobile Wireless Fault
Mediator 2.0.1 - Topology and Platform Modeling Reference Guide. These styles are detailed in the sections below.

Commands, file names and directories

When a command, file name or directory appears in the body text, it is highlighted using bold weighting. The following paragraph references the command `cd', the path and directory `Solaris2/etc.', and the file name `DiscoSchema.cfg':

"The file DiscoSchema.cfg can be found in the directory Solaris2/etc. You can change to this directory using the cd command."

Command lines, example scripts and code

There are instances when command line examples, examples of code, or output generated as a result of inputted code are shown. These sections are recognizable by their grey background. The keys that you press in order to execute the commands (if applicable) are shown in <> and in italics. The following example line shows that the ls command is executed by pressing the <enter> key:

ls <enter>

Keywords in Language Syntax

In sections of the Reference Guide where the complete syntax of a language, such as the Stitcher or OQL language, is discussed, all keywords applicable to the language are shown in bold regardless of whether they are embedded in text or code examples. This is to makes the keywords easily distinguishable from other characters in the syntax.

SELECT Name, Sex FROM engineering.docu WHERE (Sex<>"M" AND Sex<>"Male");

Common Definitions and Abbreviations

You may come across the basic abbreviations listed in the table below whilst reading about the key databases used by MWFM NMOS.

---

Note These abbreviations are utilized for descriptive purposes only; in practice, you must enter the full name of the database at all times.

---

For example, a practical reference to a database called allSwtich.entityByName, by calling it allSwitch.EBN, for example, is invalid.

Table 1-2 Common abbreviations Used in the Cisco Mobile Wireless Fault
Mediator 2.0.1 - Topology and Platform Modeling Reference Guide

Abbreviation	Definition
EBN	This is used to abbreviate EntityByName tables of some databases. Thus, the database table names allSwitch.EBN and allSwitch.entityByName both refer to the same database table within the allSwitch database.
EBNR	This is used to abbreviate the EntityByNeighbor table of some databases. Thus, the database table names allSwitch.EBNR and allSwitch.entityByNeighbor both refer to the same database table within the allSwitch database.

The environment variable $RIV_HOME is used to refer to the home directory of MWFM NMOS within your system throughout the Reference Guide. Always substitute the actual home directory of MWFM NMOS on your system in place of the word $RIV_HOME when copying a code listing.

What's Next?

The next two chapters are designed as an introduction to the principles used by MWFM NMOS. "MWFM NMOS Database Schemata" introduces the concept of database schemata and the naming convention adopted for NMOS database tables; "MWFM NMOS Overview" discusses the FCAPS model and how MWFM NMOS serves as a platform for integrating other network management applications.

"Active Objects" introduces the concepts of object modelling, Active Object Classes and containment, and their application to network management. Readers familiar with these concepts should proceed to "The CLASS Component," which details the CLASS component of MWFM NMOS.