====================================================================
NetMgnt README
====================================================================
NetMgnt
Release 1.2.0
March 2001

This README is obsolete.  It is included for historical purposes only.

====================================================================
LICENSE AND COPYRIGHT
====================================================================
The Vovida Software License, Version 1.0

Copyright (c) 2000 Vovida Networks, Inc.  All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in
   the documentation and/or other materials provided with the
   distribution.

3. The names "VOCAL", "Vovida Open Communication Application Library",
   and "Vovida Open Communication Application Library (VOCAL)" must
   not be used to endorse or promote products derived from this
   software without prior written permission. For written
   permission, please contact vocal@vovida.org.

4. Products derived from this software may not be called "VOCAL", nor
   may "VOCAL" appear in their name, without prior written
   permission of Vovida Networks, Inc.

THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND
NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL VOVIDA
NETWORKS, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT DAMAGES
IN EXCESS OF $1,000, NOR FOR ANY INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
DAMAGE.

All third party licenses and copyright notices and other required
legends also need to be complied with as well.

====================================================================
INTRODUCTION
====================================================================    
This directory contains the source for the Network Management (NWM) station and the MIBs that the snmp 
agent is based on.  (agent code is under vocal/snmp).  The NWM queries the HBS's agent 
every 5 minutes for the current system status.  It also registers with the snmp Agent on the
Heartbeat server (HBS) to receive SNMP traps of process up/down for instant up-to-date configuration
information.   This information is displayed to the user via the SNMP GUI.   

The NWM also starts up the MRTG daemon to get periodic statistics from the SIP level snmp daemons.
This information is placed in graphs in the /usr/local/vocal/NetMgnt directory as *.html files.
These files can be viewed by the user.

====================================================================
NEW FEATURES AND FUNCTIONS IN THIS RELEASE
====================================================================  
None

====================================================================
BUG FIXES
====================================================================
Addresses the issues raised in the January 9-15 code review.
The minutes are available through Faq-O-Matic at www.vovida.org:
Vovida Faq-O-Matic: Process: GEM: Code Review Minutes:
Code review minutes from Jan 9-15, 2001

Also fixes the following bugs in Bugzilla at:
http://www.vovida.org/bugzilla                                      

Bug 280 : SNMP GUI doesn't work. Netmgnt aborts.
Bug 324 : SNMP GUI didn't indicate the correct process status for Asiago.
Bug 333 : CDR and PolicyServer can not be killed from SNMP GUI. 
Bug 335 : SNMP GUI doesn't show the whole process running in vvs-nissan.
Bug 343 : Not all fs processes which were running on vvs-fs2-1 and def
Bug  17 : mrtg fails on sip stack. 

====================================================================
KNOWN LIMITATIONS
====================================================================     
None


====================================================================
GETTING STARTED
====================================================================
The NetMgnt is a component of the VOCAL system.
For more information on using this system, please refer to
the Installation Guide at http://www.vovida.org under Documents.  


COMPILE INSTRUCTIONS
--------------------------------------------------------------------
'netMgnt' is the name of the executable .

It can be built as follows:
a) cd ../vocal/
   make netMgnt

The executable 'netMgnt' is produced as:
../vocal/proxies/NetMgnt/bin.<hardwareArchitecture>/netMgnt

USING THE SOFTWARE
--------------------------------------------------------------------
Usage: netMgnt [OPTIONS]...[PSERVER HOST:PORT]
                      [BACKUP PSERVER HOST:PORT]
                      [SIP PORT](can be just xxxx)

Options: -d               do not run in Daemon mode
         -r               turn Retransmission off
         -f < filename >  log to this Filename
         -v < LOG_ALERT | LOG_ERR | LOG_INFO | LOG_DEBUG |
              LOG_DEBUG_STACK | LOG_DEBUG_OPER | LOG_DEBUG_HB >

To execute the netMgnt, you need to supply a host address
and port for the provisioning server, a host address and port for
the redundant/backup provisioning server.
If redundant provisioning servers are not used, the main
provisioning server host and port can be specified as the
redundant provisioning server.

CONTRIBUTORS
====================================================================
This software consists of voluntary contributions made by Vovida
Networks, Inc., Cisco Systems, Inc., and many individuals.


====================================================================
CONTACT INFORMATION AND WEBSITE
====================================================================
We welcome your feedback, suggestions and contributions.
Contact us via email if you have questions, feedback,
code submissions, and bug reports.

For general inquiries - info@vovida.org

We have mailing lists for the VOCAL applications and
proctocol stacks:
VOCAL - vocal@vovida.org
COPS - cops@vovida.org
MGCP - mgcp@vovida.org
RADIUS - radius@vovida.org
RTP - rtp@vovida.org
SIP - sip@vovida.org
TRIP - trip@vovida.org
You can subscribe to the mailing lists on www.vovida.org.

You can submit bug, patches, software contributions, and feature
requests using Bugzilla.  Access Bugzilla from www.vovida.org.

====================================================================
                                                                        
=======
This directory contains the source for the Network Management (NWM) station 
and the MIBs that the snmp agent is based on.  (agent code is under vocal/snmp).
The NWM queries the HBS's agent every 5 minutes for the current system status.
It also registers with the snmp Agent on the Heartbeat server (HBS) to receive 
SNMP traps of process up/down for instant up-to-date configuration information.
This information is displayed to the user via the SNMP GUI.   

The NWM also starts up the MRTG daemon to get periodic statistics from the SIP 
level snmp daemons. This information is placed in graphs in the 
/usr/local/vocal/NetMgnt directory as *.html files. These files can be viewed 
by the user.
======================================================================

Copyright 2000-2003, Cisco Systems, Inc.
THE INFORMATION HEREIN IS PROVIDED ON AN "AS IS" BASIS, WITHOUT ANY
WARRANTIES OR REPRESENTATIONS, EXPRESS, IMPLIED OR STATUTORY, INCLUDING
WITHOUT LIMITATION, WARRANTIES OF NONINFRINGEMENT, MERCHANTABILITY OR
FITNESS FOR A PARTICULAR PURPOSE.

$Id: README,v 1.5.2.2 2003/03/28 05:25:54 bko Exp $
