WebNMS Framework 5,0

WebNMS Framework 5,0 :: Migration Guide

ZOHO Corp. 1

Table Of Contents

11.1 MIGRATION GUIDE .......................................................................................... 2

11.1.1 Migration Guide - Overview ...................................................................................... 2 11.1.2 Migration from 4.7 SP3 to 5 ...................................................................................... 3

11.1.2.1 Server API Changes ..........................................................................................................3 11.1.2.2 Java Client API Changes.................................................................................................39 11.1.2.3 Database Schema Changes............................................................................................43 11.1.2.4 Functional Changes.........................................................................................................48 11.1.2.5 Studio Project Upgrade....................................................................................................52 11.1.2.6 Packaging Changes.........................................................................................................55

11.2 HOW TO MIGRATE......................................................................................... 56

11.2.1 Migration Process................................................................................................... 57


ZOHO Corp. 2

11.1 Migration Guide

11.1.1 Migration Guide - Overview The Migration Guide is designed to aid Developers and Administrators in planning and migrating their application from an earlier version of Web NMS to the latest. Detailed procedural steps are provided to guide the Developers and Administrators during the course of migration. This guide provides a synopsis of the changes in the Database Schema, APIs, and Configuration file changes and explains the steps for a hassle free migration experience. The table below gives a detailed sketch of the contents of the Migration Guide.

Description Where to find instructions

Migration from 4.7 SP3 to 5 Migrating from AdventNet Web NMS 4.7 SP3 to the latest version involves an in-depth knowledge and understanding of the changes over the versions. This section gives a synopsis of all the API and Package changes to ease the migration process at each stage:

Migration from 4.7 SP3 to 5 is documented as given below.

• Server API Changes Topo API Changes, Map API Changes, Performance API Changes, Fault Management API Changes, FE Server API Changes, NMS Utilities API Changes, and Configuration Management API Changes.

• Java Client API Changes Map API Changes, Client Framework API Changes.

• Database Schema Changes

• Functional Changes

• Studio Project Upgrade

• Packaging Changes

How to Migrate A detailed migration process is discussed in this section.

The Process of Migration is covered under the following topics: Introduction, Migration Process -> MO Modeling, Extended Event and Alert. Server API Migration, Configuration File Changes, Internationalization.


ZOHO Corp. 3

11.1.2 Migration from 4.7 SP3 to 5

11.1.2.1 Server API Changes

• Topology API Changes

• Map API Changes

• Performance API Changes

• Fault API Changes

• NMS Utilities API Changes


ZOHO Corp. 4

11.1.2.1.1 Topology API Changes The API changes in the Topology module are listed under their respective classes.

• com.adventnet.nms.topodb o com.adventnet.nms.topodb.ManagedObject o com.adventnet.nms.topodb.TopoAPI o com.adventnet.nms.topodb.SnmpInterface o com.adventnet.nms.topodb.TopoToFaultIfc o com.adventnet.nms.topodb.Network o com.adventnet.nms.topodb.TopoObserver o com.adventnet.nms.topodb.TopoNotificationFilter o com.adventnet.nms.netwatch o com.adventnet.nms.netwatch.UserTester

Package - com.adventnet.nms.topodb API changes in the class : com.adventnet.nms.topodb.ManagedObject

Important Note

• The com.adventnet.nms.topodb.TopoObserver interface has been removed. The alternative with the same functionality is com.adventnet.nms.topodb.TopoActionListener.

• The interfaces available in com.adventnet.nms.topodb.TopoListener and com.adventnet.nms.topodb.TopoExtendedListener are now included in one interface com.adventnet.nms.topodb.TopoBulkListener. Therefore, com.adventnet.nms.topodb.TopoListener and com.adventnet.nms.topodb.TopoExtendedListener are not available.

Deprecated Methods Comments public String getKey()

Deprecated as of WebNMS 5 Users are suggested to use getName(). Since the ownerName will not be used, this method will return object name alone.

public String getOwnerName()

Deprecated as of WebNMS 5 This property was added in webnms for customer segmentation and is never


ZOHO Corp. 5

Deprecated Methods Comments implemented fully. Rather it was set as 'NULL' by default. Hence it is deprecated now.

public void setOwnerName(String owner)

Deprecated as of WebNMS 5 This property was added in webnms for customer segmentation and is never implemented fully. Rather it was set as 'NULL' by default. Hence it is deprecated now.

Removed Methods Comments public Object get(String nam)

Removed as of WebNMS5. Deprecated as of WebNMS2.0. Users are suggested to use the getUserProperty() instead

public void put(String nam, String val)

Removed as of WebNMS5. Deprecated as of WebNMS2.0. Users are suggested to use the setUserProperty() instead .

public Object remove(String nam)

Removed as of WebNMS5. Deprecated as of WebNMS2.0. Users are suggested to use the removeUserProperty() instead.

API changes in com.adventnet.nms.topodb.TopoAPI

Deprecated Methods

Comments

public void deleteObjects(String, Properties, int)

Deprecated as of WebNMS 5 Equivalent Method : deleteObjects(String, Properties) All objects matching the given criteria will be deleted till the last level in the hierarchy.

Removed Methods Comments

public void setManagedAll(Network obj, boolean isManaged)

Removed as of WebNMS5. Equivalent Method : setManaged(ManagedObject) The network sub elements will not be unmanaged.


ZOHO Corp. 11

Added Methods Comments

public int discoverNetwork(String network, String netmask,boolean overRideUnmanaged,boolean overRideDiscoveryDisabled)throws RemoteException,NmsStorageException, UserTransactionException;

New Method added in TopoAPI Triggers discovery for a network which is already present in the database. Inorder to manage and trigger discovery for a unmanaged network, the argument "overRideUnmanaged" should be set to true. This parameter also sets the "discover" property for the network to true.Inorder to trigger discovery for a network which is managed but discover-disabled, the parameter "overRideDiscoveryDisabled" should be set to true. It returns an integer value as follows: 1 = Operation successful. 2 = Network not available in the database. 3 = Invalid NetworkID or Netmask. 4 = Network discovery is in progress. 5 = Network Unmanged. 6 = Network Discovery Disabled. 7 = Error while check out.

public Vector getObjectPropsWithProps(String classname, String[] fetchProperties, Properties p, boolean returnAsProps, boolean performOr) throws RemoteException, NmsStorageException, UserTransactionException;

New Method added in TopoAPI Gets a Vector containing selective properties of objects matching the given criteria. The criteria can be a list of properties taken from properties of ManagedObject or its derived objects. The objects will be selected if they match with any or all the properties given in the match criteria, ie., it uses the both AND or OR operator while querying the tables with the match criteria to obtain the required result. The user properties cannot be used in the match criteria or in the required properties.

public ManagedObject checkOut(String name, int timeOut, boolean dealWithLocks, boolean lazyFetch) throws RemoteException, TimeoutException, NmsStorageException, UserTransactionException;

New Method added in TopoAPI This method is to fetch the object with or without associated Collections. The argument (lazyFetch) will decide whether object will be loaded with collections associated with it. Based on the value of dealWithLocks,the object is fetched from the database using checkOut() or getByName() APIs. If dealWithLocks is set to true ,then this method will call checkOut() method ,else it will call getByname().

public void addTopoBulkListener(TopoBulkListener)

New Method added in TopoAPI To register as a listener to receive notifications from TopoAPI when the bulk-


ZOHO Corp. 12


add/bulk-delete operation is carried out. This is an alternate to addTopoListener(TopoListener) which has been removed.

public Vector getIpAddressesOfNetwork(java.lang.String netName)

New Method added in TopoAPI To get the ipAddresses belonging to the given Network.

API changes in the interface com.adventnet.nms.topodb.SnmpInterface

Removed Methods Comments public int getIndex()

Removed as of WebNMS5. Deprecated as of WebNMS2.0. Users are suggested to use the getIfIndex() instead .

public void setIndex(int index)

Removed as of WebNMS5. Deprecated as of WebNMS2.0. Users are suggested to use the setIfIndex() instead .

API changes in the interface com.adventnet.nms.topodb.TopoToFaultIfc

Modified Methods Comments public void genEvent (String type, ManagedObject obj,int newStatus);

Old implementation: public void genEvent (String type, ManagedObject obj); Reason for modification : To enhance performance. New Method added in TopoToFaultIfc This call is used as a notification for the generation of an Event to indicate the Discovery of a new node/network etc. type - the type of information like whether a node/Network is added to the database or is it due to the change in Property of the node, etc., obj - the object that is associated with the event to be generated. This is the managedObject which represents the node


ZOHO Corp. 13

Modified Methods Comments or Network added.The argument type will be of any of the following: 1. For adding an Object it will be -- " Object Added to Database" . 2. For adding a Network it will be -- "Network Added to Database" . 3. For adding a Node it will be -- "Node Added to Database" . 4. For adding an Interface it will be -- "Interface Added to Database". 5. For the change of IPAddress for DHCP nodes -- "DHCP : Changed IpAddress from oldip to newip". newStatus - the severity value with which the ManagedObject need to be updated.

API changes in the interface com.adventnet.nms.topodb.Network

Removed Methods Comments public Vector getIpaddrs() public com.adventnet.nms.topodb.corba.IpAddress_CI[] getIpaddrs_CT() public void setIpaddrs(Vector ipaddrs) public void setIpaddrs_CT(com.adventnet.nms.topodb.corba.IpAddress_CI[] ipaddrsArray) public Vector getInterfacesList()

Removed as of WebNMS 5 Method removed since loading a collection is heavy for an object. Users are suggested to use following method to get the ip addresses of the Network : TopoAPI.getIpAddressesOfNetwork(String netName)

public Vector getNodes() public com.adventnet.nms.topodb.corba.Node_CI[] getNodes_CT() public void setNodes(Vector nodes) public void setNodes_CT(com.adventnet.nms.topodb.corba.Node_CI[] nodesArray)

Removed as of WebNMS 5 Method removed since loading a collection is heavy for an object. Users are suggested to use following method to get the nodes of the Network : TopoAPI.getNodesOfNetwork(String netName)


ZOHO Corp. 14

Removed interface com.adventnet.nms.topodb.TopoObserver

Class/Interface Name Comments com.adventnet.nms.topodb.TopoObserver

This interface is removed as of WebNMS5. Reason for Removal: As similar functionality is achieved by com.adventnet.nms.topodb.TopoActionListener.

API changes in the class : com.adventnet.nms.topodb.TopoNotificationFilter

Class/Interface Name Comments TopoNotificationFilter(XMLNode rootnode, TopoObserver topoObserver)

This method is removed as of WebNMS5. Alternative Method: public TopoNotificationFilter(XMLNode rootnode,TopoActionListener topoActionListener) Reason for Removal: Since the TopoObserver is removed as of Web NMS 5.0 , the alternative TopoActionListener is used.

update(java.lang.String type, ManagedObject mobj)

This method is removed as of WebNMS5. Alternative Method: public void update(TopoNotificationEvent evt) Reason for Removal: Since the TopoObserver is removed as of Web NMS 5.0 , the alternative TopoActionListener is used.

Package - com.adventnet.nms.netwatch API changes in the class : com.adventnet.nms.netwatch.UserTester

Modified Methods Comments public int test(ManagedObject obj, TopoAPI api)

Equivalent Method: public int test (String moname, Properties prop, TopoAPI api)

Reason for Modification Earlier during status polling, the full ManagedObject was fetched and provided to the UserTester. Fetching full ManagedObject is costly. Hence now only properties configured by the user would be fetched and provided to UserTester. So instead of passing the full MO to the UserTester only a Property object containing the properties fetched for that MO is passed. Here the list of properties to be fetched for that MO during status polling can be configured in StatusPolling.conf.


ZOHO Corp. 15

11.1.2.1.2 Map API Changes This section gives a complete list of API changes in Map Module.

• com.adventnet.nms.mapdb o com.adventnet.nms.mapdb.MapAPI o com.adventnet.nms.mapdb.MapSymbol o com.adventnet.nms.mapdb.MapContainer

Package - com.adventnet.nms.mapdb The changes in individual classes are listed under each Class name. API Changes in the Interface - MapAPI

Removed Methods Comments public Vector getSymbolNamesAssociatedWithObject(String objName) throws RemoteException, NmsStorageException, UserTransactionException;

Removed as of WebNMS5. Deprecated as of WebNMS2.1. Equivalent: Users are suggested to use getSymbolNamesAssociatedWithObject(String type,String objName)


public boolean addMapWithTabs(String mapname, Properties p,Properties tabProp) throws RemoteException, NmsStorageException, UserTransactionException;

New Method Added for MapAPI: Use this method to add default maps(through map filters) with device view. i.e., This enables users to add panels at the bottom of the map in multiple tabs. This behaves similar to the addMap() method, in addition to which it adds the panels specified as tabs at the bottom of the map. The tabProp is used to specify the panels to be added via panel-keys / module-Ids and also the criteria for the custom view panels. This is a new feature added as of WebNMS5

public boolean addCustomMapWithTabs(String mapname, Properties mapprop, Properties customProps,Properties tabprop) throws RemoteException, NmsStorageException, UserTransactionException;

New Method Added for MapAPI: Use this method to add custom maps(criteria based) with device view. i.e., This enables users to add panels at the bottom of the map in multiple tabs. This behaves similar to the addCustomMap() method, in addition to which it adds the panels specified as tabs at the bottom of the map.The tabProp is used to specify the panels to be added via panel-keys / module-Ids and also the criteria for the custom view panels. This is a new feature added as of WebNMS5


ZOHO Corp. 16

Added Methods Comments public boolean addMapWithTabs(String mapname, Properties p, int index,Properties tabProp) throws RemoteException, NmsStorageException, UserTransactionException;

New Method Added for MapAPI: Use this method to add default maps(through map filters) at the specified index in the tree with device view. i.e., This enables users to add panels at the bottom of the map in multiple tabs. This behaves similar to the addMap() method, in addition to which it adds the panels specified as tabs at the bottom of the map. The index parameter specifies the tree node index for this map. The tabProp is used to specify the panels to be added via panel-keys / module-Ids and also the criteria for the custom view panels. This is a new feature added as of WebNMS5

public boolean addCustomMapWithTabs(String mapname, Properties mapprop,Properties customProps, int index,Properties tabProp) throws RemoteException, NmsStorageException, UserTransactionException; Deprecated Methods

Comments

public String getKey()

Deprecated as of WebNMS 5 Reason for Deprecation: Since the ownerName will not be used, this method will return object name alone. Equivalent: Users are suggested to use getName(). Since the ownerName will not be used, this method will return object name alone.





New Method Added for MapAPI: Use this method to add custom maps(criteria based) at the specified index in the tree with device view. i.e., This enables users to add panels at the bottom of the map in multiple tabs. This behaves similar to the addCustomMap() method, in addition to which it adds the panels specified as tabs at the bottom of the map. The index parameter specifies the tree node index for this map. The tabProp is used to specify the panels to be added via panel-keys / module-Ids and also the criteria for the custom view panels. This is a new feature added as of WebNMS5

API changes in the Class - com.adventnet.nms.mapdb.MapDB


public void setTabPanels (String tpanels)

New API method added in MapDB: Sets the value of the tabpanels property. This takes the module-name(for customviews)/panelkeys(for user-defined panels) of the view seperated by comma eg: "Events,MyPanel" Here 'Events' is a customview module name and MyPanel is a user defined panel-key. This is used only when DEVICE-VIEW is set to true.


ZOHO Corp. 17


public String getTabPanels ()

New API method added in MapDB: Returns the value of the tabpanels property of this map. This property holds the modulename (for customviews) / panelkeys (for user-defined panels) of the tabpanels seperated by comma(,).This returns value only when DEVICE-VIEW is set to true else returns empty string.

public Properties getMapCriteriaProps()

New API method added in MapDB: Returns the criteria for this map. Custom maps have some criteria associated with them. These criteria do not make sense for default maps and hence will be null for default maps.

public void setMapCriteriaProps(Properties prop)

New API method added in MapDB: Sets the criteria for this map. Custom maps have some criteria associated with them. This criteria do not make sense for default maps and hence will be null for default maps.

API changes in the Class - com.adventnet.nms.mapdb.MapSymbol

Deprecated Methods Comments

public static String getStatusColor (int sev)

Removed as of WebNMS5. Deprecated as of Web NMS 2.2. Equivalent Method: SeverityInfo.getInstance().getName(int). Where severity as specified in severityinfo.conf

public static int getStatusInt(String color)

Removed as of WebNMS5. Deprecated as of Web NMS 2.2. Equivalent Method: SeverityInfo.getInstance().getValue(String)


Deprecated as of WebNMS 5 Reason for Deprecation: This property was added in webnms for customer segmentation and is never implemented fully. Rather it was set as 'NULL' by default. Hence it is deprecated now.


Deprecated as of WebNMS 5 Reason for Deprecation:This property was added in webnms for customer segmentation and is never implemented fully. Rather it was set as 'NULL' by default. Hence it is deprecated now.


ZOHO Corp. 18


public int getMapHeight()

New API method added in Mapsymbol: This is used to retrieve the value of the mapHeight attribute of the symbol.This represents the height of the map with respect to which map symbol height is determined.

public int getMapWidth()

New API method added in Mapsymbol: This is used to retrieve the value of the mapWidth attribute of the symbol.This represents the height of the map with respect to which map symbol width is determined.

public void setMapHeight(int height)

New API method added in Mapsymbol: Sets the mapHeight of the symbol to the specified value. Note that this will be effected only if the symbol's anchored property is set to true. Otherwise the map layout class would take care of sizing the symbol.

public void setMapWidth(int width)

New API method added in Mapsymbol: Sets the mapWidth of the symbol to the specified value. Note that this will be effected only if the symbol's anchored property is set to true. Otherwise the map layout class would take care of sizing the symbol.

API changes in the Class - com.adventnet.nms.mapdb.MapContainer


public String getLayout ()

Removed as of WebNMS5. Deprecated As of version WebNMS 2.2. Users are suggested to use an alternate method getCurrentTopology().

public void setLayout (String s)

Removed as of WebNMS5. Deprecated As of version WebNMS 2.2. Users are suggested to use an alternate method getCurrentTopology().


ZOHO Corp. 19

11.1.2.1.3 Performance API Changes This section gives a complete list of API changes in the Performance Module.

• com.adventnet.nms.poll o com.adventnet.nms.poll.PollAPI o com.adventnet.nms.poll.PolledData

Package com.adventnet.nms.poll The API changes in the package poll are listed under their respective classes. API changes in the class : com.adventnet.nms.poll.PollAPI


public void addPoll (PolledData pd,boolean start) throws RemoteException, UserTransactionException,NmsPollException;

Removed as of WebNMS5. Deprecated as of WebNMS2.1. Users are suggested to use addPoll(PolledData) instead.

public Vector getCollectedData (String key,long timeStart) throws UserTransactionException, NmsPollException,RemoteException;

Removed as of WebNMS5. Deprecated as of WebNMS2.2. Users are suggested to use getColletedValues(String,long) instead.

public Vector getCollectedData (String key,long timeStart,long timeEnd)throws UserTransactionException, NmsPollException, RemoteException;

Removed as of WebNMS5. Deprecated as of WebNMS2.2. Users are suggested to use getCollectedValues(String,long,long) instead.

public Vector getCollectedData (String key,String date) throws UserTransactionException, NmsPollException , RemoteException;

Removed as of WebNMS5. Deprecated as of WebNMS2.2. Users are suggested to use getCollectedData(String,Date) instead.

public Vector getList() throws UserTransactionException, NmsPollException, RemoteException;

Removed as of WebNMS5. Deprecated as of WebNMS2.0. Users are suggested to use com.adventnet.nms.util.CommonAPI#getCompleteList() instead.

public boolean getPolledDataConsistent(String groupname,String key)throws java.rmi.RemoteException,UserTransactionException,NmsPollException;

Removed as of WebNMS5. Deprecated as of WebNMS2.3 SP7.

public Vector getPolledDataForGroup(String group)throws UserTransactionException,java.rmi.RemoteException,NmsPollException;


public Vector getPolledDataForNode(String ipaddr) throws UserTransactionException, NmsPollException,java.rmi.RemoteException;



ZOHO Corp. 20


public Vector getPolledDataForNodes(String startip,String endip,String netmask) throws java.rmi.RemoteException,NmsPollException,UserTransactionException;


public Vector getPolledDataForNodes(String ipaddrlist[]) throws UserTransactionException,NmsPollException, java.rmi.RemoteException;


public void modifyPoll(PolledData pd) throws RemoteException,NmsPollException, UserTransactionException;

Removed as of WebNMS5. Deprecated as of WebNMS2.3 Users are suggested to use modifyPoll(PolledData,boolean) instead.

public boolean removePoll(String key) throws NmsPollException, UserTransactionException,RemoteException;

Removed as of WebNMS5. Deprecated as of WebNMS2.3 Users are suggested to use removePoll(PolledData,boolean) instead.

public boolean removePolledDataForGroup(String groupname,String key) throws java.rmi.RemoteException, NmsPollException,UserTransactionException;


public boolean removePolledDataForNode(String ipaddr,String key) throws UserTransactionException, NmsPollException,java.rmi.RemoteException;


public boolean removePolledDataForNodes(String startip,String endip,String netmask,String key) throws java.rmi.RemoteException,NmsPollException,UserTransactionException;


public boolean removePolledDataForNodes(String[] ipaddr,String key) throws java.rmi.RemoteException, NmsPollException,UserTransactionException;


public void savePollState() throws java.rmi.RemoteException;

Removed as of WebNMS5. Deprecated as of WebNMS2.3 SP7. Reason for removal: Saves the state of the polling engine. It is not required to call this method as saving the state is done automatically whenever any changes are made.

public boolean setAutoCommit(boolean b) throws java.rmi.RemoteException,java.sql.SQLException;

Removed as of WebNMS5. Deprecated as of WebNMS2.2.1

public boolean setPolledDataForGroup(String group,PolledData pd)throws java.rmi.RemoteException,NmsPollException,UserTransactionException;


public boolean setPolledDataForNode(String ipaddr,PolledData pd)throws java.rmi.RemoteException,NmsPollException,UserTransactionException;


public boolean setPolledDataForNodes(String startip,String endip,Stringnetmask,PolledData pd) throws java.rmi.RemoteException,NmsPollException,UserTransactionException;


public boolean setPolledDataForNodes(String ipaddrlist[],PolledData pd) throws UserTransactionException, NmsPollException, java.rmi.RemoteException;



ZOHO Corp. 21


public Hashtable registerRemotePoller (RemotePoller rp,String name) throws java.rmi.RemoteException;

New Method added in Polled Data. Description: Registers the RemotePoller with the Poll Engine if the Poller is not already registered.

public void deregisterPoller (String pollerName) throws java.rmi.RemoteException;

New Method added in Polled Data. Description: Deregisters the RemotePoller from the Poll Engine.

public Hashtable getDynamicTablesAndSchemas () throws java.rmi.RemoteException;

New Method added in Polled Data. Description: Returns a Hashtable containing a Vetcor dynamic tables names and a hashtable containing its Schema mapping.

public Vector<ArrayList<String>> obtainPollerSpecificPolldata (String name) throws java.rmi.RemoteException;

Obtains the polled data values for a specific remote poller that can be directly dumped into the database.

API changes in the class : com.adventnet.nms.poll.PolledData






public boolean logAllData (String logFile,String date)

Deprecated as of WebNMS 2.2 Users are suggested ot use logAllData(String logFile,Date date) instead.


public int getNumeric ()

Removed as of WebNMS5. Deprecated as of WebNMS2.0 Users are suggested to use getNumericType() instead.


ZOHO Corp. 22


public void setNumeric (int numeric)

Removed as of WebNMS5. Deprecated as of WebNMS2.0 Users are suggested to use setNumericType(int numeric) instead.

public String getGroup ()

Removed as of WebNMS5. Deprecated as of WebNMS2.0 Users are suggested to use getGroupName() instead.

public void setGroup (String group)

Removed as of WebNMS5. Deprecated as of WebNMS2.0 Users are suggested to use setGroupName(String name) instead.

public String getFilename()

Removed as of WebNMS 5. Deprecated as of WebNMS 2.3 Users are suggested to use the getLogFile() instead.

public void setFilename(String filename)

Removed as of WebNMS 5. Deprecated as of WebNMS 2.3 Users are suggested to use the setLogFile(String filename) instead.


public String getThresholdList ()

New Method added in Polled Data. Description: This method returns the value of thresholdList.

public void setThresholdList (String thresholdList)

New Method added in Polled Data. Description: This method sets the value of thresholdList.

Modified Methods Comments


Description: The ownerName is deprecated as of WebNMS5. Hence his method will not return the owner name in the key and this will always return only the name + agent + oid as the key.

public void setPollerName(java.lang.String pollerName)

Description: This method has been modified to be used for internal purpose.


ZOHO Corp. 23

11.1.2.1.4 Fault API Changes This section gives a complete list of API changes in the Fault Management Module.

• com.adventnet.nms.alertdb o com.adventnet.nms.alertdb.Alert o com.adventnet.nms.alertdb.AlertAPI o com.adventnet.nms.eventdb o com.adventnet.nms.eventdb.Event o com.adventnet.nms.eventdb.EventAPI

Package : com.adventnet.nms.alertdb API changes in the class : com.adventnet.nms.alertdb.Alert

Deprecated Methods

Comments


Deprecated as of WebNMS 5 Users are suggested to use getName(). Since the ownerName will not be used, this method will return object name alone.





Removed Method

Comments

public int getStage()

Removed as of WebNMS5. Deprecated as of WebNMS2.0. A property that defines where the Alert is in it's cycle. This is removed as of WebNms 2.0.


ZOHO Corp. 24

Removed Method

Comments

public void setStage(int stage)

Removed as of WebNMS5. Deprecated as of WebNMS2.0. A property that defines where the Alert is in it's cycle. This is removed as of WebNms 2.0.

public String getGroup()

Removed as of WebNMS5. Deprecated as of WebNMS2.0. Users are suggested to use Use getGroupName() instead.

public void setGroup(String group)

Removed as of WebNMS5. Deprecated as of WebNMS2.0. Users are suggested to use Use setGroupName() instead

API changes in the class : com.adventnet.nms.alertdb.AlertAPI


public Vector getAlerts(Alert alert) throws java.rmi.RemoteException,FaultException;

Removed as of WebNMS5. Deprecated as of WebNMS2.0. Equivalent Method Use getAlerts(Alert alert1,Alert alert2) throws java.rmi.RemoteException,FaultException

public String getAnnotationNotes(String entity) throws java.rmi.RemoteException;

Removed as of WebNMS5. Deprecated as of WebNMS2.2. Users are suggested to use getAnnotation(String entity)} and getHistory(String entity) which will return Vector of AlertAnnotation and AlertHistory objects respectively.

public void deleteAlert(Alert alert) throws java.rmi.RemoteException;

Removed as of WebNMS5. Deprecated as of WebNMS2.2. Users are suggested to use checkOutIfAvailable(String entity) to get the Alert object and after getting Alert object use deleteAlert(Alert alert,boolean dealWithLock) to delete that Alert.

public void deleteAlert(String entity) throws java.rmi.RemoteException;

Removed as of WebNMS5. Deprecated as of WebNMS2.3. Because complete Alert object is needed to lock that object during this operation. Users are


ZOHO Corp. 25

Removed Methods Comments suggested to use checkOutIfAvailable(String entity)to get the Alert object and after getting Alert object use deleteAlert(Alert entity,boolean dealWithLock) to delete that Alert.

public int getCriticalAlertsCount() throws java.rmi.RemoteException;

Removed as of WebNMS5. Deprecated as of WebNMS2.1. Use getAlertsCount(int severity) method to get the count of alerts of any given severity. The method has been deprecated to support configurable number of severities.

public int getMajorAlertsCount() throws java.rmi.RemoteException;


public int getMinorAlertsCount() throws java.rmi.RemoteException;


public int getWarningAlertsCount() throws java.rmi.RemoteException;


public int getClearAlertsCount() throws java.rmi.RemoteException;


public void saveAlertState() throws java.rmi.RemoteException;

Removed as of WebNMS5. Obsolete Method Deprecated as of WebNMS2.3. AdventNet Web NMS supports stateless server.

public boolean setAutoCommit(boolean b) throws java.rmi.RemoteException, java.sql.SQLException;

Removed as of WebNMS5. Deprecated as of WebNMS2.3. Since there is not separate database connection for Fault module.


ZOHO Corp. 26


public boolean isDatabaseMode() throws java.rmi.RemoteException;

Removed as of WebNMS5. Obsolete Method Deprecated as of WebNMS2.3. AdventNet Web NMS supports Database mode only.

Added Method Comments public Vector getObjectPropsWithProps(String classname, String[] fetchProperties, Properties p, boolean returnAsProps) throws java.rmi.RemoteException,FaultException;

New Method added in AlertAPI This method gets a vector containing selective properties of objects matching the given criteria.

Deprecated interface as of WebNMS5:

Class/Interface Name Comments com.adventnet.nms.alertdb.PropagationFilter This interface is deprecated as of

WebNMS5. Reason for Deprecation: As similar functionality is achieved by status propagation functionality.

com.adventnet.nms.alertdb.MiniAlert This class is deprecated as of WebNMS5. Reason for Deprecation: PropagationFilter is deprecated, hence this is of no use anymore.

Event API Changes Package : com.adventnet.nms.eventdb API changes in the class : com.adventnet.nms.eventdb.Event

Method Comments public String getKey() Deprecated as of WebNMS 5

Users are suggested to use getName(). Since the ownerName will not be used, this method will return object name alone.

public String getOwnerName() Deprecated as of WebNMS 5 This property was added in webnms for customer segmentation and is never implemented fully. Rather it was set as 'NULL' by default. Hence it is deprecated now.




ZOHO Corp. 27

API changes in the class : com.adventnet.nms.eventdb.EventAPI


public void addEvent(InputEvent event) throws java.rmi.RemoteException,NmsStorageException, FaultException;

Deprecated as of AdventNet Web NMS5 Equivalent Method Use public void addEvent(Event event) throws java.rmi.RemoteException,NmsStorageException,FaultException;

public void pickUpAlert(Alert alert,String who) throws java.rmi.RemoteException;

Removed as of WebNMS5. Deprecated as of AdventNet Web NMS 2.0 Equivalent Method Use AlertAPI 's public void pickUpAlert (Alert alert,String who,boolean dealWithLock) throws java.rmi.RemoteException,AccessDeniedException, UserTransactionException,FaultException;

public Alert getAlert(String entity) throws java.rmi.RemoteException;

Removed as of WebNMS5. Deprecated as of AdventNet Web NMS 2.0. Equivalent Method Use checkOutIfAvailable(String entity) to get locked Alert object with the specified entity. Use unlock(Alert alt) to unlock the checked out object.

public Vector getAlerts(Alert alert) throws java.rmi.RemoteException;

Removed as of WebNMS5. Deprecated as of AdventNet Web NMS 2.0. Equivalent Method Use AlertAPI 's public Vector getAlerts(Alert alert1,Alert alert2) throws java.rmi.RemoteException,FaultException;

public Vector getAlerts(Alert alert1,Alert alert2) throws java.rmi.RemoteException;

Removed as of WebNMS5. Deprecated as of AdventNet Web NMS 2.0 Equivalent Method Use AlertAPI 's public Vector getAlerts(Alert alert1,Alert alert2) throws java.rmi.RemoteException,FaultException;

public void deleteAlert(Alert alert) throws java.rmi.RemoteException;

Removed as of WebNMS5. Deprecated as of AdventNet Web NMS 2.0 Equivalent Method Use AlertAPI 's public Alert checkOutIfAvailable(String entity) throws java.rmi.RemoteException , TimeoutException,FaultException; public void deleteAlert(Alert alert,boolean dealWithLock) throws java.rmi.RemoteException,AccessDeniedException, UserTransactionException, FaultException;

public void clearAlert(Alert alert) throws java.rmi.RemoteException;

Removed as of WebNMS5. Deprecated as of AdventNet Web NMS 2.0 Equivalent Method Use AlertAPI 's public Alert checkOutIfAvailable(String entity) throws java.rmi.RemoteException ,TimeoutException,FaultException; public void clearAlert(Alert alert,boolean dealWithLock) throws java.rmi.RemoteException, AccessDeniedException,UserTransactionException, FaultException;


ZOHO Corp. 28


public void updateNotes(Alert alert,String notes) throws java.rmi.RemoteException;

Removed as of WebNMS5. Deprecated as of AdventNet Web NMS 2.0 Equivalent Method Use AlertAPI 's public Alert checkOutIfAvailable(String entity) throws java.rmi.RemoteException ,TimeoutException,FaultException; public void updateNotes(Alert alert,String userName,String notes,boolean dealWithLock) throws java.rmi.RemoteException, AccessDeniedException,UserTransactionException, FaultException;

public int getMaxSeverityofAlerts() throws java.rmi.RemoteException;

Removed as of WebNMS5. Deprecated as of AdventNet Web NMS 2.0 Equivalent Method Use AlertAPI 's public int getMaxSeverityofAlerts() throws java.rmi.RemoteException;

public int getCriticalAlertsCount() throws java.rmi.RemoteException;

Removed as of WebNMS5. Deprecated as of AdventNet Web NMS 2.0 Equivalent Method Use AlertAPI 's public int getAlertsCount(int severity) throws java.rmi.RemoteException;

public int getMajorAlertsCount() throws java.rmi.RemoteException;


public int getMinorAlertsCount() throws java.rmi.RemoteException;


public int getWarningAlertsCount() throws java.rmi.RemoteException;


public int getClearAlertsCount() throws java.rmi.RemoteException;


public void saveEventState() throws java.rmi.RemoteException;

Removed as of WebNMS5. Obsolete method. Since WebNms2.3 NMS supports stateless server. Invocation of this method does nothing.

public void saveAlertState() throws java.rmi.RemoteException;

Removed as of WebNMS5. Obsolete Method Since WebNms2.3 NMS supports stateless server. Invocation of this method does nothing.


ZOHO Corp. 29

Method Added Comments public Vector getObjectPropsWithProps(String classname, String[] fetchProperties, Properties p, boolean returnAsProps) throws java.rmi.RemoteException,FaultException;

New Method added in EventAPI This method gets a vector containing selective properties of objects matching the given criteria.


ZOHO Corp. 30

11.1.2.1.5 NMS Utilities API Changes This section gives a complete list of API changes in NMS Utilities.

• com.adventnet.nms.hbn.util • com.adventnet.nms.util o com.adventnet.nms.util.NmsUtil o com.adventnet.nms.util.DBParamsParser o com.adventnet.nms.util.GenericBEAPI o com.adventnet.nms.util.PureServerUtils o com.adventnet.nms.smtp o com.adventnet.nms.smtp.SmtpMailer o com.adventnet.nms.management o com.adventnet.nms.management.NmsManagementAPI o com.adventnet.management.transaction o com.adventnet.management.transaction.TransactionAPI o com.adventnet.management.transaction.ConnectionPool o com.adventnet.management.transaction.ConnectionBreakHandler

Package : com.adventnet.nms.hbn.util

Important Note New Class HibernateUtil added in the com.adventnet.nms.hbn.util package. The methods in this class can be used to access the Hibernate APIs.

Methods Comments

public static Configuration getConfiguration() Description: Gets the Hibernate Configuration instance.

public static String getHbnProperty(String key)

Description: Gets the value configured for the parameter key from hibernate.cfg.xml. Apart from the parameters specific to hibernate, any new or user defined parameters can also be read from the configuration file.


ZOHO Corp. 31

Package : com.adventnet.nms.util API changes in the Class : com.adventnet.nms.util.NmsUtil

Methods Deprecated Comments

public static void setConfirmAuth(ConfirmAuth permission)

Deprecated as of WebNMS5.0 Deprecated without any replacement as LDAP support has been removed from Web NMS 5.0

public static ConfirmAuth getConfirmAuth()

Deprecated as of WebNMS5.0 Deprecated without any replacement as LDAP support has been removed from Web NMS 5.0

Methods Added Comments

public static String getBannerMessage()

Since WebNMS5.0 It provides the banner message as available in the memory. The message is parsed from BannerMessage.xml file or would have set via from BannerConfiguration UI

public static void setBannerMessage(String message) throws Exception

Since WebNMS5.0 To configure the given banner message into BannerMessage.xml. The method will also update the message as available in the memory

API changes in the Class : com.adventnet.nms.util.DBParamsParser


public static DBParamsParser getInstance(java.io.File file) throws java.io.IOException

Description: Returns the instance of this class after parsing the DataBase Parameters based on the File name passed as argument.

Methods Removed Comments

public Hashtable getURLTable()

Reason for Removal: Not in use Alternative Method: public java.lang.String getURL()

public Hashtable getDriverNameTable()

Reason for Removal: Not in use Alternative Method: public java.lang.String getDriverName()


ZOHO Corp. 32

Methods Removed Comments

public Hashtable getUserNameTable()

Reason for Removal: Not in use Alternative Method: public java.lang.String getUserName()

public Hashtable getPasswordTable()

Reason for Removal: Not in use Alternative Method: public java.lang.String getPassword()

API changes in the Class : com.adventnet.nms.util.GenericBEAPI


public String registerForStandByServer(Properties standbyProps)throws RemoteException

Since WebNMS 5.0 This method is used to get notification about the stand by server startup or shutdown operation

public void unregisterForStandByServer(String standById)throws RemoteException

Since WebNMS 5.0 This method is used to unregister from receiving the notification on standby server startup or shutdown operation

public boolean registerClientConnectionObserver(ClientConnectionObserver co) throws java.rmi.RemoteException;

Since WebNMS5.0 This method is used for registering with the Web NMS server to get the notification on client login/logout/login failures.

public boolean deregisterClientConnectionObserver(ClientConnectionObserver co) throws java.rmi.RemoteException

Since WebNMS 5.0 This method is used for deregistering from the Web NMS server to get the notification on client login/logout/login failures


ZOHO Corp. 33

API changes in the Class : com.adventnet.nms.util.PureServerUtils


public static java.util.Hashtable driverNameTable

Deprecated as of WebNMS5.0 Reason: No more driverName per module. Instead use driverName.

public static java.util.Hashtable passwordTable

Deprecated as of WebNMS5.0 Reason: No more password per module. Instead use password.

public static java.util.Hashtable urlTable

Deprecated as of WebNMS5.0 Reason:No more url per module. Instead use url.

public static java.util.Hashtable userNameTable

Deprecated as of WebNMS5.0 Reason:No more userName per module. Instead use userName.

Package - com.adventnet.nms.smtp API changes in the Class : com.adventnet.nms.smtp.SmtpMailer

Method Added Comments SmtpMailer(String server, String from, String[] to, String sub, String fileAttach,String usr, String pwd, boolean ssl)throws IOException

New API introduced to send EMails in SSL Mode

Package - com.adventnet.nms.management

Note: A new API, NmsManagementAPI is introduced in com.adventnet.nms.management from Web NMS 5.0 release to monitor the various parameters of Web NMS such as Trap rate, Data Collection rate, Status Polling rate, etc.,


ZOHO Corp. 34

APIs added in the Class : com.adventnet.nms.management.NmsManagementAPI

Method Comments

public void monitorDataCollectionRate(boolean enable) throws RemoteException;

This API can be used to enable/disable the Data Collection Rate Calculation. The initial value for this parameter is taken from <NMS_HOME>/conf/HealthMonitor.xml.

public boolean getMonitorDataCollectionRate() throws RemoteException;

This API is used to check if the calculation of Data Collection Rate is enabled or disabled.

public long getDataCollectionRate() throws RemoteException;

This API is used to get the Data Collection Rate value of the NMS server. The latest computed rate will be returned from the Database.

public ArrayList getDataCollectionRate(long stime, long etime) throws RemoteException;

This API can be used to get the Data Collection Rate value of the NMS server for a time period. The time from and to which the rate values are required are to be provided as long values. Note that the start time should be greater than the end time.

public void setDCRateInterval(int interval) throws RemoteException;

This API can be used to set the time interval at which the Data Collection Rate is to be calculated for monitoring the Data Collection in NMS server. The time interval is in seconds and it should be a positive integer greater than zero. The initial value for this parameter is taken from <NMS_HOME>/conf/HealthMonitor.xml.

public int getDCRateInterval() throws RemoteException;

This API is used to get the Data Collection Rate interval. The interval is in seconds and it has a default value of 300 seconds.

public void monitorStatusPollingRate(boolean enable) throws RemoteException;

This API can be used to enable/disable the Status Polling Rate Calculation. The initial value for this parameter is taken from <NMS_HOME>/conf/HealthMonitor.xml.

public boolean getMonitorStatusPollingRate() throws RemoteException;

This API is used to check if the calculation of Status Polling Rate is enabled or disabled.

public long getStatusPollingRate() throws RemoteException;

This API is used to get the Status Polling Rate value of the NMS server. The latest computed rate will be returned from the Database.


ZOHO Corp. 35

Method Comments

public ArrayList getStatusPollingRate(long stime, long etime) throws RemoteException;

This API can be used to get the Status Polling Rate value of the NMS server for a time period. The time from and to which the rate values are required are to be provided as long values. Note that the start time should be greater than the end time.

public void setSPRateInterval(int interval) throws RemoteException;

This API can be used to set the time interval at which the Status Polling Rate is to be calculated for monitoring the Status Polling in NMS server. The time interval is in seconds and it should be a positive integer greater than zero. The initial value for this parameter is taken from <NMS_HOME>/conf/HealthMonitor.xml.

public int getSPRateInterval() throws RemoteException;

This API is used to get the Status Polling Rate interval. The interval is in seconds and it has a default value of 300 seconds.

public void monitorTrapRate(boolean enable) throws RemoteException;

This API can be used to enable/disable the Trap Rate Calculation. The initial value for this parameter is taken from <NMS_HOME>/conf/HealthMonitor.xml.

public boolean getMonitorTrapRate() throws RemoteException;

This API is used to check if the calculation of Trap Rate is enabled or disabled.

public long getTrapRate() throws RemoteException;

This API is used to get the Trap Rate value of the NMS server. The latest computed rate will be returned from the Database.

public ArrayList getTrapRate(long stime, long etime) throws RemoteException;

This API can be used to get the Trap Rate value of the NMS server for a time period. The time from and to which the rate values are required are to be provided as long values. Note that the start time should be greater than the end time.

public void setTrapRateInterval(int interval) throws RemoteException;

This API can be used to set the time interval at which the Trap Rate is to be calculated for monitoring the Trap in NMS server. The time interval is in seconds and it should be a positive integer greater than zero. The initial value for this parameter is taken from <NMS_HOME>/conf/HealthMonitor.xml.


ZOHO Corp. 36

Method Comments

public int getTrapRateInterval() throws RemoteException;

This API is used to get the Trap Rate interval. The interval is in seconds and it has a default value of 300 seconds.

public void monitorEventRate(boolean enable) throws RemoteException;

This API can be used to enable/disable the Event Rate Calculation. The initial value for this parameter is taken from <NMS_HOME>/conf/HealthMonitor.xml.

public boolean getMonitorEventRate() throws RemoteException;

This API is used to check if the calculation of Event Rate is enabled or disabled.

public long getEventRate() throws RemoteException;

This API is used to get the Event Rate value of the NMS server. The latest computed rate will be returned from the Database.

public ArrayList getEventRate(long stime, long etime) throws RemoteException;

This API can be used to get the Event Rate value of the NMS server for a time period. The time from and to which the rate values are required are to be provided as long values. Note that the start time should be greater than the end time.

public void setEventRateInterval(int interval) throws RemoteException;

This API can be used to set the time interval at which the Event Rate is to be calculated for monitoring the Event in NMS server. The time interval is in seconds and it should be a positive integer greater than zero. The initial value for this parameter is taken from <NMS_HOME>/conf/HealthMonitor.xml.

public int getEventRateInterval() throws RemoteException;

This API is used to get the Event Rate interval. The interval is in seconds and it has a default value of 300 seconds.

public void monitorAlertRate(boolean enable) throws RemoteException;

This API can be used to enable/disable the Alert Rate Calculation. The initial value for this parameter is taken from <NMS_HOME>/conf/HealthMonitor.xml.

public boolean getMonitorAlertRate() throws RemoteException;

This API is used to check if the calculation of Alert Rate is enabled or disabled.

public long getAlertRate() throws RemoteException;

This API is used to get the Alert Rate value of the NMS server. The latest computed rate will be returned from the Database.


ZOHO Corp. 37

Method Comments

public ArrayList getAlertRate(long stime, long etime) throws RemoteException;

This API can be used to get the Alert Rate value of the NMS server for a time period. The time from and to which the rate values are required are to be provided as long values. Note that the start time should be greater than the end time.

public void setAlertRateInterval(int interval) throws RemoteException;

This API can be used to set the time interval at which the Alert Rate is to be calculated for monitoring the Alert in NMS server. The time interval is in seconds and it should be a positive integer greater than zero. The initial value for this parameter is taken from <NMS_HOME>/conf/HealthMonitor.xml.

public int getAlertRateInterval() throws RemoteException;

This API is used to get the Alert Rate interval. The interval is in seconds and it has a default value of 300 seconds.

Package - com.adventnet.management.transaction API changes in the Class : com.adventnet.management.transaction.TransactionAPI

Methods Added Comments public static org.hibernate.Session getSession() throws UserTransactionException

Gets a Session associated with current thread from Hibernate.

API changes in the Class : com.adventnet.management.transaction.ConnectionPool

Methods Deprecated Comments public void commitAllNonTransactionConnections() throws NmsStorageException

Deprecated as of WebNMS 5 Reason: All the connections will be created by hibernate. So this method will have no effect.

public void createConnection(int num_trans, int num_nontrans) throws NmsStorageException


public void freeConnectionForTransaction()



ZOHO Corp. 38


public java.lang.Integer getConnectionId(java.sql.Connection con)

Deprecated as of WebNMS 5 Reason: As the connections are cached by ConnectionProviders.

public java.lang.Integer getIdForThread(java.lang.Thread obj)

Deprecated as of WebNMS 5 Reason: As the connections are cached by ConnectionProviders.

public boolean lockConnectionForTransaction(int timeout)

Deprecated as of WebNMS 5 Reason: All the connections will be created by hibernate. So this method will have no effect. Gets a dedicated connection for the transaction and locks it.

public void startConnectionMaintainer(java.lang.String queryStr)

Deprecated as of WebNMS 5 Reason: This method executes a query 'select id from Events' for every connection created in WebNMS. This can be done from hibernate itself.

public ConnectionPool(java.lang.String urlstr, java.lang.String usrname, java.lang.String pwd, java.lang.String drivername,int num_trans, int num_nontrans, java.lang.String conAuth)

Deprecated as of WebNMS 5 Reason: The number of connections is created by hibernate and therefore this method is not required.

API changes in the Class : com.adventnet.management.transaction.ConnectionBreakHandler


void handleConnectionFail(java.sql.Connection con, java.lang.Exception e)

Description: The exception that resulted in notifying the ConnectionBreakHandler and the corresponding database Connection is passed to the handler. Based on the exception and connection, reconnection can be attempted.


ZOHO Corp. 39

11.1.2.2 Java Client API Changes

• Map API Changes

• Client Framework API Changes


ZOHO Corp. 40

11.1.2.2.1 Java Client - Map Client Related API Changes The API changes in the Map module are listed under their respective classes. Package - com.adventnet.nms.mapui API changes in the class : com.adventnet.nms.mapui.MapClientAPI

Removed / Deprecated Methods Comments public EditableMap getMapContainer(String mapName, boolean includeToolBar)

Removed as of WebNMS5. Deprecated as of WebNMS2.3 Users are suggested to use getMapCanvas(String) instead.


ZOHO Corp. 41

11.1.2.2.2 Java Client - Client Framework API Changes The API changes in the Client module are listed under their respective classes. Package - com.adventnet.nms.nmsutil API changes in the class : com.adventnet.nms.nmsutil.NmsClientUtil

Removed / Deprecated FIELDS Comments USER_NAME

Removed as of WebNMS5. Deprecated as of WebNMS2.3 Users are suggested to use getUserName() instead.

Removed / Deprecated methods Comments public static String getUserRealm ()

Removed as of WebNMS5. Deprecated as of WebNMS 2.3. Users are suggested to use getAllGroupOfUser(), which will return a vector in which each element indicates each group to which the user belongs.

Added methods Comments public static int getMinPasswordLength()

Newly added API method in WebNMS5 The method returns Maximum Length of Password that can be configured. The parameter is read from 'PASSWD_MAX_LENGTH' attribute as configured in clientparameters.conf file.

public static int getMinPasswordLength() Newly added API method in WebNMS5 The method returns Minimum Length of Password that can be configured. The parameter is read from 'PASSWD_MIN_LENGTH' attribute as configured in clientparameters.conf file.

public static boolean isDeviceView()

Newly added API method in WebNMS5 This method returns whether the DEVICE_VIEW is enabled or disabled.


ZOHO Corp. 42

Added methods Comments public static int getViewSplitLocation()

Newly added API method in WebNMS5 This method returns the divider location for the Device view pane when the device view is enabled.

public static void setViewSplitLocation(int value)

Newly added API method in WebNMS5 This method sets the divider location for the Device view pane when the device view is enabled.

public static ValidateCredentials getValidator()

Newly added API method in WebNMS5 The method provides the implementation instance of the interface 'ValidateCredentials'. The instance can be used to do your custom validation. The ValidateCredentials implementation instance is configured under 'Validator' attribute in clientparameters.conf file.

public static String changeTheGivenPassword(Properties passProp)

Newly added API method in WebNMS5 This method changes the given password for a given user and returns the String "success" if the password is successfully modified OR error string as returned from the server. The properties requires values for following keys:

port - Web Server Port host - Web NMS Server Host Name jsessionid - WebServer SessionID - NmsClientUtil.applet.getParameter("jsessionid"); userName - User Name password - New password curpassword - Current Password age - Password Age


ZOHO Corp. 43

11.1.2.3 Database Schema Changes

Overview The Web NMS database table structure is exposed in the file DatabaseSchema.conf file in the <Web NMS Home>/conf directory. The table entries for the objects mapped using Hibernate are removed from the DatabaseSchema.conf file and a separate object mapping file is introduced to define the table structure. The object mapping is available for Map, Fault, Topology, and Performance management modules, and the corresponding object mapping file xxx.hbm.xml is located in <Web NMS Home>\classes\hbnlib\ folder in the respective package structure.

• Discovery and Topology

• Map

• Fault

• Performance

• Client Tree

• Security Audit

Note: For all modules, OWNERNAME is no more a part of primary key. The column is by default commented in the object mapping file <Web NMS Home>\classes\hbnlib\com\adventnet\nms\ in the Topo, Map, Fault, and Performance modules.

Discovery and Topology

• The internal table TopoDBSpecialkey, DBInterfaces table has been removed.

• OWNERNAME is no more a part of primary key. The column is by default commented in the object mapping file <Web NMS Home>\classes\hbnlib\com\adventnet\nms\topodb\ManagedObject.hbm.xml.

• NAME is present only in the ManagedObject table.

• MOID is the newly added surrogate key.

• The DISCRIMINATOR key has been added to the ManagedObject table. This field contains the marker values that tell the persistence layer what subclass to instantiate.

• The TOPOUSERPROPS table is commented by default in the object mapping file .


ZOHO Corp. 44

Following are the fields added and deleted in the tables related to Discovery and Topology module.

Added Fields Deleted Fields Table

Column Name Column Type Default Value Column Name

ManagedObject MOID DISCRIMINATOR PARENTID

BIGINT(20) VARCHAR(30) BIGINT(20)

OWNERNAME

TopoObject MOID BIGINT(20) NAME, OWNERNAME

Network MOID BIGINT(20) NAME, OWNERNAME

Node MOID BIGINT(20) NAME, OWNERNAME

IpAddress MOID BIGINT(20) NAME, OWNERNAME

SnmpNode MOID BIGINT(20) NAME, OWNERNAME

SnmpInterface MOID BIGINT(20) NAME, OWNERNAME

TL1Node MOID BIGINT(20) NAME, OWNERNAME

TL1Interface MOID BIGINT(20) NAME, OWNERNAME

GroupTable MOID BIGINT(20) OWNERNAME, MEMBEROWNERNAME

ManagedGroupObject MOID BIGINT(20) NAME

CorbaNode MOID BIGINT(20) NAME, OWNERNAME Following are the DataType changes for the tables related to Discovery and Topology module.

Table Column Name Previous DataType

Current DataType

ManagedObject MANAGED STATUSCHANGETIME STATUSUPDATETIME STATUSPOLLENABLED ISCONTAINER ISGROUP

varchar(10) varchar(25) varchar(25) varchar(10) varchar(10) varchar(10)

BIT(1)* BIGINT(20) BIGINT(20) BIT(1) BIT(1) BIT(1)

TopoObject ISDHCP ISSNMP ISNODE ISNETWORK ISINTERFACE

varchar(10) varchar(10) varchar(10) varchar(10) varchar(10)

BIT(1) BIT(1) BIT(1) BIT(1) BIT(1)

Network DISCOVER

varchar(10) BIT(1)

Node ISROUTER

varchar(10) BIT(1)

* BIT refers to boolean datatype.


ZOHO Corp. 45

Map • DBMap, CUSTOMMAPS, DEFAULTMAPS has been removed.

• The DISCRIMINATOR key has been added to the MapSymbol table. This field contains the marker values that tell the persistence layer what subclass to instantiate.

• OWNERNAME is no more a part of primary key. The column is by default commented in the object mapping files in map module.

• CRITERIAPROPERTIES, MAPPEDPROPERTIES table has been included. This will replace the CUSTOMPROPS and MAPUSERPROPS table respectively.

• MapContainer, MapGroup, and MapLink tables have MapSymbol as the base table. Following are the fields added and deleted in the tables related to Map module.

Added Fileds Table

Column Name Column Type Default Value Deleted Fields

MapSymbol DISCRIMINATOR MAPWIDTH MAPHEIGHT

VARCHAR(30) INT(11) INT(11)

OWNERNAME

MapLink OWNERNAME

MapContianer OWNERNAME

MapGroup OWNERNAME

MapDB OWNERNAME

Following are the DataType changes in the tables related to Map module.

Table Column Name Previous DataType Current DataType MapSymbol ANCHORED

HEIGHT WIDTH X Y

varchar(10) varchar(25) varchar(25) varchar(25) varchar(25)

BIT(1)* INT(11) INT(11) INT(11) INT(11)

MapLink NX NY STATUS

varchar(25) varchar(25) varchar(25)

INT(11) INT(11) INT(11)

MapContainer CONTAINMENT varchar(10)

BIT(1)

* BIT refers to boolean datatype. Fault Management

• The tables EVENTALERTFILTER, GENERICFAULTTABLE, ALERTLOGGER, EVENTLOGGER, TRAPFILTER, and TRAPEVENTPARSER have been removed.

• The tables DBEVENT and DBALERT have been removed.

• The DISCRIMINATOR key has been added to the EVENT, ALERT, and ANNOTATION tables. This field contains the marker values that tell the persistence layer what subclass to instantiate.

• OWNERNAME is no more a part of primary key. The column is by default commented in the object mapping files in fault module.


ZOHO Corp. 46

• AAID it the surrogate key in the Annotation table.

• The EVENTUSERPROPS and ALERTUSEPROPS table is commented by default in the respective object mapping file .

Following are the fields added and deleted in the tables related to Fault Management module.

Added Fileds Table

Column Name Column Type Default Value

Deleted Fields

Alert DISCRIMINATOR VARCHAR(30)

MAPNAME, STAGE, OWNERNAME, PRIORITY

Annotation AAID DISCRIMINATOR

BIGINT(20) VARCHAR(30) OWNERNAME

ALERTUSERPROPS ENTITY VARCHAR(100) NAME, OWNERNAME

Event DISCRIMINATOR VARCHAR(30) OWNERNAME, DDOMAIN, HELPURL

EVENTUSERPROPS ID INT(11) NAME, OWNERNAME

Performance

• DBPoll and POLLFILTER table has been removed.

• The DISCRIMINATOR key has been added to the PolledData table. This field contains the marker values that tell the persistence layer what subclass to instantiate.

Following are the fields added and deleted in the tables related to Performance module.

Added Fileds Table

Column Name Column Type Default Value

Deleted Fields

PolledData DISCRIMINATOR SAVEDATA POLLERNAME

VARCHAR(30) BIT(1) VARCHAR(200)

SSAVE

PollingAttributes POLLCONDITION VARCHAR(50) CONDITION

ObjectSchedularRunnable MOID CLASSNAME

BIGINT(20) VARCHAR(150) VALUESTRING

Following are the DataType changes in the tables related to Performance module.

Table Column Name Previous DataType

Current DataType

PolledData ACTIVE LOGDIRECTLY THRESHOLD ISMULTIPLEPOLLEDDATA SAVEABSOLUTES TIMEAVG SAVEONTHRESHOLD

varchar(10) varchar(10) varchar(10) varchar(10) varchar(10) varchar(10) varchar(10)

BIT(1) BIT(1) BIT(1) BIT(1) BIT(1) BIT(1) BIT(1)

*BIT refers to boolean datatype.


ZOHO Corp. 47

Client Tree

• PanelProps table has been removed.

• The properties that were stored in PanelProps table are now stored in the JSON string notation in the PanelTree table.

Added Fileds

Table Column Name Column Type Default Value

Deleted Fields

PanelTree PANELPROPS

VARCHAR(1000)

The PANELPROPS column will store the corresponding Tree properties. The following is the list of properties that is stored inside PANELPROPS. TREE-POPUP-MENU TABLE-POPUP-MENU TARGET PANEL-KEY PANEL-NAME URL ICON-FILE MENU-FILE-NAME DEFAULT-CLOSE-OPERATION INIT-ON-STARTUP CLIENT TREE-NAME IMAGE-NAME OPERATION HTML-TABLE Security Audit

• AuthAudit table has been removed.

• AuthAuditExt table which stored the Audit details has been removed to AuthAudit.


ZOHO Corp. 48

11.1.2.4 Functional Changes

Overview All important functional changes of AdventNet Web NMS 5 GA are discussed in this topic to help users to start working with the current version on completing the Migration process. The modules/functionalities covered in this section are

• Framework Services

• Java Client Framework

• Discovery & Topology

• WebNMS Eclipse Plugin

Framework Services

• The StorageAPI interface replaces the already available UserStorageAPI. This is the interface for adding, deleting, updating and getting user objects to/from database. When NMS server is started, the StorageAPI can be accessed remotely via RMI or from the same JVM.

• As of the J2SE 5.0 release stub class is no longer needed to access the remote objects and so the codebase entry is no longer needed in startnms.bat/sh file.

• Web NMS has integrated Log4j as default logging service framework. The Web NMS logging framework will use the Log4j mode of logging and the log files will be available in the <Web NMS Home>/logs directory. Log4j logging is configured using the LOG_HANDLER_IMPL and CUSTOMLOG_CONF_FILE entries available in the serverparameters.conf file present under <Web NMS Home>/conf folder. configurations with respect to Log4j must be made in the log4j.xml file present in the <Web NMS Home>/conf. Modify the relevant files to make any additions to log files or any modifications in the log levels. It is not possible to configure the parameters dynamically.

• Incase if the tables has to be restored, then it is necessary to specify all the tables in the TablesToRestore.conf file present under <WebNMS Home>/bin/backup related to that module.

• In WebNMS 5 GA, NMS Server application can be monitored using JConsole with the following command jconsole service:jmx:rmi://<host where server is running>:<port1>/jndi/rmi://<host where server is running>:<port2>/jmxrmi where port1 is the JMX_RMI_CONNECTOR_PORT and port 2 is the JMX_RMI_SERVER_PORT

• In the previous release DB_RECONNECTION_TIMEOUT parameter have configured to enable database re-connection. In WebNMS 5 GA,By default, the database reconnection timeout period is set as 20000 mills, i.e, the database reconnection is tried after an interval of 20000 mills. To configure, it is necessary to specify the desired value for hibernate.c3p0.acquireRetryAttempts and hibernate.c3p0.acquireRetryDelay in milliseconds. Refer Accessing Connections section for more details.

• In WebNMS 5 GA, the module specific user properties tables like TOPOUSERPROPS, EVENTUSERPROPS, ALERTUSERPROPS, MAPUSERPROPS, and POLLUSERPROPS are commented. For example, ALERTUSERPROPS can be used to store the additional properties of the Alert object. EVENTUSERPROPS can be used to store the additional properties of the Event object. Each additional property will be stored in a separate row in the


ZOHO Corp. 49

table. All these tables will not be created, by default. where as in the previous release, By default, one user property table exists per module.

public void setUserProperty(String nam, Object val) Description: This method sets the user property as a specified object type instead of a default string value. One of the argument type in the setUserProperty() method is changed from string to Object. Till beta we supported only string data type when adding additional property using Dynamic Schema Extension. To support all the data types,we changed the data type. public Object getUserProperty(String nam) Description: This method will return corresponding object of the property. You can convert object to corresponding property type. We have changed return type of getUserProperty() method from string to Object. Till beta we supported only string data type when adding additional property using Dynamic Schema Extension. To support all the data types ,we changed the data type.

Dynamic Schema Extension Dynamic Schema Extension allows you to extend the Schema and add your own columns. Here, the additonal properties will be stored in the Base table itself. Only one query will be sent to the database to insert the additional property.

To add properties in the ManagedObject table, include the following property tags in the hibernate mapping file ManagedObject.hbm.xml present under the <Web NMS Home>/classes/hbnlib in the package structure com/adventnet/nms/topodb.

<property name="MOPROP1" type="string" column="MOPROP1" length="100" access="com.adventnet.nms.store.relational.hbn.DynamicPropertyAccessor"/> <property name="MOPROP2" type="string" column="MOPROP2" length="100" access="com.adventnet.nms.store.relational.hbn.DynamicPropertyAccessor"/> <property name="MOPROP3" type="integer" column="MOPROP3" length="11" access="com.adventnet.nms.store.relational.hbn.IntegerDynamicPropertyAccessor"/>

Refer to Dynamic Schema Extension section in Developer Guide for more details.

• For the previous release, fillCustomProperties method contains argument as DBInterface dbObj, ResultSet rs, int id but the argument have been changed for this method for WebNMS 5 GA. It is described below.

fillCustomProperties(Object obj, java.sql.ResultSet rs, java.sql.PreparedStatement stmt) - This method is called for every PreparedStatement returned from the getCustomStatements() method. The ResultSet got by executing the PreparedStatement will be passed as the parameter to this method. Subclasses should implement this method. This method should manipulate the ResultSet passed and fill up the obj with the appropriate properties. fillCustomProperties(Object obj, ResultSet rs, String str) - This method is called for every SQL string returned from the getCustomStatement() method. Subclasses should implement this method. The ResultSet got by executing the SQL will be passed as the


ZOHO Corp. 50

parameter to this method. Subclasses should implement this method. This method should manipulate the ResultSet passed and fill up the obj with the appropriate properties.

Refer to Modeling Managed Resources section in Developer Guide for more details.

Java Client Framework

• In Client tree, PanelProps table has been removed. The properties that were stored in PanelProps table are now stored in the JSON string notation in the PanelTree table.

• In WebNMS 5 GA , The Manage/Unmanage option, if invoked for any Network object will not manage/ unmanage its node and interface respectively. In Map and List View, the Manage/Unmanage option will be disabled for multiple selection of different types of Managed Object.

• RMI ClientAPI examples were removed for this release.

Discovery & Topology • In WebNMS 5 GA, the test() method in UserTester interface has been changed such that it

accepts a property object instead of the while ManagedObject. This property object will contain the list of ManagedObject properties specified in the StatusPolling.conf.

• TopoListener and ExtendedTopoListener were used to get notification on operations on a large number of Managed Objects. In WebNMS 5 GA, TopoListener and ExtendedTopoListener were removed and this functionality is achieved by using the TopoBulkListener.

In order to receive notifications during both Add and Delete operations to multiple Managed Objects, you have to implement the interface TopoBulkListener. This interface has deleteObject(XMLNode) method which would be called when any of the following operations takes place :

• Deleting a Container Managed Object using the method TopoAPI.deleteObjectAndSubElements()

• Deleting Managed Objects based on criteria using the method TopoAPI.deleteObjects(String,Properties)

• Deleting related Managed Objects based on levels (Cascade Delete) using the method TopoAPI.deleteObjectAndSubElements(String,int )

• TopoObserver , AlertObserver , TopoSubscriber were removed. TopoObserver is used to get notification on operations on individual Managed Object. In WebNMS 5 GA, TopoObserver has been removed and this functionality is achieved by using TopoActionListener.

• In WebNMS 5 GA, AlertObserver has been removed and instead of AlertObserver, AlertListener is used.

• In the previous release deleteObjectAndSubElements(String key) method will delete all its first level children from the database. In WebNMS 5 GA if the object to be deleted is a container, this method will delete all its children till the last level in the containment hierarchy.

• In the Network object, the attributes nodes and interfaceList are removed. Henceforth, to get the list of nodes and interfaces for a network, TopoAPI.getInterfacesOfNetwork and getNodesOfNetwork are used.

• In WebNMS 5 GA , few properties such as ManagedObject, isContainer, isGroup, enableStatusPolling, TopoObject were declared as boolean which were declared as string in the previous release.


ZOHO Corp. 51

WebNMS Eclipse Plugin • As of WebNMS 4.7, Studio is used for customizing the various services offered by Web NMS.

WebNMS provides a plug-in for Eclipse version 3.3.x, which has Web NMS Studio tools and features integrated. Modeling the Managed Object in Studio is different from that of in Eclipse. In WebNMS 5, Managed Objects modeled in Studio, must be modeled again in the Eclipse plugin by using the wizard. The key feature of the wizard is the MIB support provided to simplify the task of defining unique properties for the Managed Resource. The hibernate mapping file is the final output of this wizard.

Refer to the Creating Managed Resource section of the Eclipse document for more details on Modeling the Managed Resource.

• Eclipse doesnot support the Security configurations directly. So Security Administration features for Eclipse project have to be configured using Security Administrator Tool bundled in WebNMS installation. After deploying the application NAR file in the WebNMS installation, Start the server using WebNMS > Launch > Start WebNMS Server menu. and Start the client using WebNMS > Launch > Start WebNMS Client menu. In the Client Screen , Click Tools->Security Administration. Security Administration Dialog Box is opened.It helps to create a new users, groups and a opertions.

• Rebranding cannot be done with respect to Eclipse Project. It has to be done directly in the Web NMS Installation. To do Rebranding, invoke <Web NMS Home>\bin\developertools>startRebrandingTool.bat Refer to Rebranding section in Eclipse document for more details.


ZOHO Corp. 52

11.1.2.5 Studio Project Upgrade

Overview In certain scenarios, there may be requirement to reuse the existing Studio project created in Web NMS 4.7 (with any service pack) with minor modifications. As Web NMS 5 does not bundle Studio, it is not possible to directly upgrade and use the project. Eclipse replaces Studio to aid development of your management application in Web NMS 5. Most of the customizations in the Studio project can be imported and used in Eclipse. The modules customizations that cannot be imported need to be created new in Eclipse IDE. The packaging and installation can be achieved in Eclipse also. Main sections in Studio Project The main sections of the Studio projects and the procedures for upgrading is provided below.

Module Upgrade Procedure Remarks Modeled MO Must be redone With the eclipse plugin for Web

NMS, the objects can be modelled with ease using the Model Managed Object Wizard.

Extended Event and Alert

Must be redone Extended Alerts/Events created for incorporating additional properties must be created again in the eclipse plugin in Web NMS 5.

Client Nars Must be imported Must be imported Client NARS can be imported for customization of client, using the Client Application Import Wizard in the EclipsePlugin.

Filters and Observers

Must be imported The Filters and Observers written in the previous version can be retained in Web NMS 5.

User Administration Must be done after installing the NAR

It is not available in EclipsePlugin. It is achieved using Security Administration tool bundled in the Web NMS.

Rebranding

Must be done after installing the NAR

Rebranding cannot be done with respect to Eclipse project. It has to be done directly in the Web NMS Installation.

Packaging the Project as NAR

Almost same procedure The Package Project Wizard in the Eclipse packages all the resources of a Project (any customized, generated or edited files) into a .nar file.

Installing the NAR in Web NMS

Same procedure It can be performed using the Nar Installer present in the Deployment Wizard. T


ZOHO Corp. 53

Modeled MO Managed Objects modeled in Studio, must be modeled again in the eclipse plugin in Web NMS 5. With Eclipse, the objects can be modelled with ease using the Model Managed Object Wizard. This wizard will guide you through the steps of defining the ManagedObject properties. The hibernate mapping file is the final output of this wizard . This file can in turn be used to generate the bean class using the Generate Java Source menu. The key feature of the wizard is the MIB support provided to simplify the task of defining unique properties for the Managed Resource. Refer to the "4.3.1.1 Creating Managed Resource" section of the Eclipse document for more details on Modeling the Managed Resource. Extended Alert and Event Extended Alerts created for incorporating additional properties must be created again in the eclipse plugin in Web NMS 5. The Procedure to Extend Alert Object is similar to the steps followed in Modelling a Managed Object except that in the Component MO Table Details screen, select alert for the Select Module option instead of topo and select com.adventnet.nms.alertdb.Alert from the drop down list for the Parent MO/Extended Object Name option. Please refer to the "4.3.4.2 Extending Alerts" section of the Eclipse document for more details on Extending Alerts. Similarly, events can also be extended to have additional properties. Refer to the "4.3.4.1 Extending Events" section of the Eclipse document for more details on Extending Events. Client Nars Client NARs created using Studio Client Builder tools can be imported using the Client Application Import Wizard in the EclipsePlugin. Importing Client NAR using studio in Web NMS 4.7 SP3 will be available for Eclipse Plugin in Web NMS 5. The Procedure to import a client nar in Eclipseplugin in Web NMS 5 is similar to the steps followed in studio. Please refer to the "4.4.1 Importing Client Nar" section of the Eclipse document for more details on Importing Client Nar. Filters and Observers The Filters and Observers created in the studio can be imported to the Eclipse project. Import the required conf file from <Web NMS Home>/conf directory into the Eclipse Project. Open the file and make the required modifications then click Save to save the changes. Read the section Working with Files for more details. User Administration This option is not available in EclipsePlugin. The user creation must be done after installing the project NAR in Web NMS. Security configuration is achieved using Security Administration tool bundled in the AdventNet Web NMS. Do refer to the documentation on security adminstration for more details. Rebranding Web NMS In Web NMS 5, Rebranding cannot be done with respect to Eclipse Project. It has to be done directly in the Web NMS Installation after installing the project NAR. To do Rebranding, invoke <Web NMS Home>\bin\developertools>startRebrandingTool.bat


ZOHO Corp. 54

Please refer to the "Rebranding Web NMS" section of the Eclipse document for more details on Rebranding. Packaging the Project With the eclipse plugin for Web NMS, the projects can be packaged with ease using the wizard by providing the NAR file name and its version and the output directory. Please refer to the "4.4.2 Packaging the Project" section of the Eclipse document for more details on Packaging the Project. Installing the NAR in Web NMS The NAR should be installed over Web NMS. This task can be performed using the Nar Installer present in the Deployment Wizard. The Installer wizard with an easy- to- use interface helps you walk through the process of installing the nar. Refer to the section Installing Eclipse Project in Web NMS for more details.


ZOHO Corp. 55

11.1.2.6 Packaging Changes The major Packaging changes in AdventNet Web NMS 5 are:

1. All individual classes (.class files) present under the <Web NMS Home>/classes folder have been packaged inside the NmsServerClasses.jar file.

2. SSL can be configured by just modifying the script files as stated in the SSL Communication document. There is no requirement for the Apache Add-On as Apache Web Server is not used in Web NMS.

3. In the previous versions of Web NMS, Apache was used as web server and Tomcat was used as web container involving two applications for two services. Apart from using Tomcat as web container, Web NMS 5 uses Tomcat also as web server instead of Apache.

4. Web NMS Studio enhanced with support for Eclipse IDE. Web NMS provides a plugin for Eclipse version 3.3.0, which has all the Web NMS Studio tools and features integrated.

5. JimiProClasses.zip is now modified as JimiProClasses.jar. 6. JRE version 1.6 is bundled with Web NMS 5 GA release. 7. The hibernate.cfg.xml file , present under <Web NMS Home>/classes/hbnlib/ directory is

used to configure the database parameter, such as database location, driver name, etc. by simply editing the file.

8. Web NMS adopts Java Service Wrapper for installing Web NMS as Service. The parameters in the wrapper.conf file are configured for installing and running Web NMS as NT service. The Wrapper correctly handles user log outs under Windows, service dependencies, and the ability to run services which interact with the desktop. Using Wrapper, Web NMS can be started with multiple dependent services.

9. Examples for Distributed poller , JBoss and JVM Monitoring has been provided in <Web NMS Home>/examples directory.


ZOHO Corp. 56

11.2 How To Migrate The migration process to be followed on upgrading the project in earlier versions to Web NMS 5 GA is displayed in the flow diagram given below. The process involves automatic and manual updations.

Please refer to the next section for more details on the Migration Process.


ZOHO Corp. 57

11.2.1 Migration Process Migration process provides step-by-step instructions to migrate the customizations done over Web NMS 4.7 framework in the application to the latest version Web NMS 5. Migration involves manual and automatic procedures to migrate the Managed Object, Filter / Observer, and configuration details to the current version. With the new installation of the Web NMS 5 product, the older project customizations can be migrated by following the steps given below.

• MO Modeling

• Extended Event and Alert

• Server API Migration

• Configuration File Changes

• Internationalization

MO Modeling Managed Objects modeled in the previous version cannot be used in Web NMS 5. Therefore they must be modelled again in the current version. With the eclipse plugin for Web NMS, the objects can be modelled with ease using the wizard by providing the additional properties and database table details as input. The .hbm.xml file for the MO properties is generated in the eclipse tool. The .java file for the MO can also be generated from eclipse by using the .hbm.xml generated in the previous step as the input. Please refer to the "4.3.1.1 Creating Managed Resource" section of the Eclipse document for more details on Modeling the Managed Resource. Extended Event and Alert Extended Alerts created for incorporating additional properties must be created again in Web NMS 5. The easy-to-use Extended Alerts / Events wizard available in eclipse similar to the Managed Resource modeling wizard can be used to create the the Extended Alerts. Server API Migration

Filters and Observers The Filters and Observers written in the previous version can be retained in Web NMS 5. But the API changes must be noted and corresponding change must be done in the equivalent section of your Topology, Map, and Fault code. Please refer tot he API changes Deprecated / Removed methods and use the equivalent methods provided to achieve your requirement. Also some new methods have been added to enhance product performance. Status Polling The test() method in UserTester interface has been changed such that it accepts a property object instead of the while ManagedObject. This property object will contain the list of ManagedObject properties specified in the StatusPolling.conf. Please refer to the "Topology API Changes" of the document for more details and incorporate the changes in your code. The list of ManagedObject properties that has to be fetched during StatusPolling has to be configured in StatusPolling.conf.


ZOHO Corp. 58

Policy and Configuration Changes that require migration have not gone into the Policy and Configuration modules. They follow the relational object concept, and therefore the implementations used in the previous version can be used in Web NMS 5 also.

Configuration File Changes

Database Configuration With the introduction of persistence support, the database connection information is stored in the hibernate.cfg.xml file. After installing the fresh version of Web NMS 5, the database related parameters must be updated in the hibernate.cfg.xml file available in the <Web NMS Home>/classes/hbnlib folder. All database connection definitions are provided in this file. The datatypes of few properties have been changed in the database tables. The "Database Schema" section of the document lists the current fields and database types. Please refer to the file and apply the appropriate changes in your code.

Note: As there is Database Schema changes in Web NMS 5, there is no out-of-the-box provision to migrate Web NMS 4.7 data to Web NMS 5. However, if there is requirement to migrate 4.7 data, please contact [email protected].

Status Polling A new file named StatusPolling.conf is introduced. In this file, the list of ManagedObject properties to be fetched during status polling can be configured. The fetched properties will be provided to the test method of UserTester interface if user defined status polling is enabled for that ManagedObject. Status Propagation The ENABLE_SP_FOR_MO_RELATIONS parameter has been changed to STATUS_PROPAGATION. As the name implies, you can use this parameter to enable or disable the status propagation of Managed Objects in a containment relationship. In <Web NMS Home>/confNmsProcessesBE.conf file, for the java com.adventnet.nms.topodb.DBServer process, the ENABLE_SP_FOR_MO_RELATIONS parameter must be changed to STATUS_PROPAGATION, and the value set to "true" to enable status propagation.

Logging Service Web NMS has now adopted the industry-standard Apache's Log4j logging framework as the default Web NMS logging framework. Log4j logging is configured using the LOG_HANDLER_IMPL and CUSTOMLOG_CONF_FILE entries available in the serverparameters.conf file present under <Web NMS Home>/conf folder. configurations with respect to Log4j must be made in the log4j.xml file present in the <Web NMS Home>/conf. Modify the relevant files to make any additions to log files or any modifications in the log levels.

Internationalization Client UI has changed considerably in Web NMS 5. And therefore it is suggested to use the new version of the .properties files which has additional / modified key words.

WebNMS Framework 5,0

Documents

Transcript of WebNMS Framework 5,0