Module Services Startup Options

 

BE Startup Options

 

 

 

 

 

Process

 

com.adventnet.nms.util.RunRmiRegistry

 

Functionality

 

Starts RMI Registry as a Web NMS module

 

Declaration

 

java com.adventnet.nms.util.RunRmiRegistry rmiregistry

 

Arguments - Null.

 

Dependencies

 

Other Process Dependencies

 

All the processes that bind remote API into the RMI registry are dependent on this process. This is a mandatory process and hence should not be disabled.

 

This process starts RMI Registry and hence if this is not available, no process can be bound to the RMI Registry. So, all the processes that bind remote API into RMI registry are dependent on this process.

 


 

Process

 

com.adventnet.nms.util.RunJSPModule

 

Functionality

 

To start WebContainer for serving JSPs and Servlets

 

Declaration

 

java com.adventnet.nms.util.RunJSPModule

 

Arguments - Null

 

Dependencies

 

 

Other Process Dependencies

 

Nil.  However, all servlets and JSPs are executed through this process.  If this process is disabled, clients cannot be connected. This process is mandatory.

 


 

Process

 

com.adventnet.nms.sas.NMSSAServer

 

Functionality

 

To start the SAS which provides communication for applets which are unable to connect directly to managed devices due to security limits

 

Declaration

 

# java com.adventnet.nms.sas.NMSSAServer

[SAS_DEBUG true/false]

[SAS_PORT port]

[APPLET_DIRECTORY applet_directory]

[WEBSERVER_ROOT directory]

[RESTRICT_SOCKETS true/false]

[FILE_OUTPUT true/false]

[SERVER_CLIENT class]

[SESSION_CLIENT class]

[LOG_CLASS class]

[REGISTER_CLIENT class]

Process               com.adventnet.nms.sas.NMSSAServer

 

 

Arguments and Description

 

Arguments

 

Description

SAS_DEBUG

This option enables the debug and prints the packet dumps. Default value : False

 

SAS_PORT

This option allows you to specify the port in which the SAS can start. Writes the port number to the SASPort.html file. Default : 0 (Any free port)

APPLET_DIRECTORY

This option allows you to specify the directory in which the SASPort.html file will be written.  By default it is the current directory. The SASUsers sub-directory, which is used to save data from the applets should be created under the directory specified.  - Default value : Empty string

 

WEBSERVER_ROOT

Specifies the root directory of the Web server. Default value : Empty string  

RESTRICT_SOCKETS

This option allows socket access only to SNMP UDP ports 161 and 162.  Default value : False

 

FILE_OUTPUT

This option enables/disables file output access Default value : False

SERVER_CLIENT

Implementation class for SAServerClient. Default value : null

 

SESSION_CLIENT

Implementation class for SASessionClient.  Default value : null

LOG_CLASS

Implementation class for SASLogInterface interfaces.  Default value : null

 

REGISTER_CLIENT

This option can be used to set the user's implementation of the interface "RegisterClient". This interface can be used by the API users  to receive the traps coming from different agents. Default value : null

 

 

Dependencies

 

Other Processes Dependencies

 

SASServerFE and NMSSAServerFE

 

SASServerFE is a proxy forwarder for SAS in FE. Unless SAServer is started in the BE, there is no need to have its counterpart in FE. Hence, these processes are inter-dependent.

 


 

Process

 

com.adventnet.management.policydb.NmsPolicyMgr

 

Functionality

 

Starts the Policy Module with Web NMS

 

Declaration

 

#java com.adventnet.management.policydb.NmsPolicyMgr

Process           com.adventnet.management.policydb.NmsPolicyMgr

 

Arguments and Description

 

Arguments

 

Description

LOAD_DEFAULT_POLICY

If set as 'true' - default policy will be loaded. If set as 'false' - default policy will not be loaded. Default value is 'true'

 

 

Dependencies

 

Other Processes Dependencies

 

PolicyFE

 

PolicyFE module binds a proxy API for policy module in the FE.

 


 

Process

 

com.adventnet.nms.startnms.NmsMainFE

 

Functionality

 

Starts FE module in the BE/FE server combination

 

Declaration

 

#java com.adventnet.nms.startnms.NmsMainFE

[NMS_FE_PORT WebNMSSocketPort]

[USE_QUOTES_IN_DATABASE_TABLES true/false]

[CLIENT_SERVER TCP/RMI/CORBA]

[BE_FE TCP/RMI/CORBA]

[BE_HOST back_end_host_name]

[BE_PORT back_end_port_num]

[COUNTRY country_code]

[LANGUAGE language_code]

[ROOT_DIR dir]

[ KEEPALIVE_WINDOW_SIZE

milliseconds]

Process               com.adventnet.nms.startnms.NmsMainFE

 

 

Arguments and Description

 

Arguments

Description

 

CLIENT_SERVER

Specifies the type of communication to be used between the Client and the FE Server. By Default : TCP.

 

BE_FE

Specifies the type of communication to be used between the BE Server and the FE Server.  The default value is TCP.

BE_HOST

Specifies the machine name in which the BE Server is running. The default value is localhost.

 

BE_PORT

Specifies the port number in which the BE Server is listening.  The default value is 2000.

 

COUNTRY

The name of the country, in whose native language all the log messages have to be stored in the FE Server. Default : US

LANGUAGE

The language in which all the log messages have to be stored in the FE Server. Default : en

 

ROOT_DIR

The root directory where WebNMS is installed

KEEPALIVE_WINDOW_SIZE

The Java Client sends the "Keep-Alive" signal to the FE Server in the specified interval of time. The FE Server knows that the client is still connected to it only by this signal. If the client's signal is not received for 10 continuous time intervals, the FE Server assumes that the client is no more connected and closes the communication socket. The default value is 300.

 

 

Dependencies

 

Other Processes Dependencies

 

All FE Processes defined in NmsProcessFE.conf in BE-FE combination

 

NmsMainFE reads the NmsProcessesFE.conf file and starts all the FE processes  one by one. Hence, all the FE Processes defined in NmsProcessFE.conf are dependent on this process.

 


 

Process

 

com.adventnet.nms.startnms.WebNMSBackUp

 

Functionality

 

To take backup of the data in the Web NMS Server

 

Declaration

 

java com.adventnet.nms.startnms.WebNMSBackUp

 

Arguments - Null

 

Dependencies

 

None

 


 

Process

 

com.adventnet.nms.tester.ProcessTest

 

Functionality

 

An implementation provided as an example to explain the implementation of the com.adventnet.nms.util.RunProcessInterface.

 

Declaration

 

java com.adventnet.nms.tester.ProcessTest

 

Arguments - Null

 

Dependencies

 

Other Processes Dependencies

 

ExampleFE

 

ExampleFE provides FE transportation layer for this example

 


 

Process

 

com.adventnet.nms.store.DBUserStorageServer

 

Functionality

 

For adding, deleting, updating and getting UserObjects to or from database

 

Declaration

 

java com.adventnet.nms.store.DBUserStorageServer

 

Arguments - Null

 

Dependencies

 

Other Processes Dependencies

 

UserStorageFE & JMX Agent

 

JMX agent uses UserStorage APIs for adding objects into database and UserStorageFE is the FE counterpart . So, both depend on this process.

 


 

Process

 

java com.adventnet.nms.kpi.KPICollector

 

Functionality

 

Process for performing KPI data collection and calculation.

 

Declaration

 

# java com.adventnet.nms.kpi.KPICollector

ARGS KPI_STATS_TABLE_NAME KPI_STATSDATA% LOCK_CLASS com.adventnet.nms.util.DefaultLockableObject OPTIMIZE_FETCHING false

 

Process   com.adventnet.nms.kpi.KPICollector

 

Arguments and Description

 

Arguments

 

Description

KPI_STATS_TABLE_NAME


Table to store the KPI data. eg. KPI_STATSDATA%

 

LOCK_CLASS

The Lock class to use for application level locking, LockableObject implementation class com.adventnet.nms.util.DefaultLockableObject

OPTIMIZE_FETCHING

If set as 'true'- fetching of data will be in bulk and optimized in a single query. If set as 'false' - queries will be executed to fetch the values. Default value is 'false'

 

Dependencies

 

Other Processes Dependencies

 

PolicyFE

 

PolicyFE module binds a proxy API for policy module in the FE.

 


 

 

General Guidelines

 

Otherwise, you may disable these processes.

 

Otherwise, you may disable this process.

 

 

Otherwise, you may disable the above process.

 

 

Framework Services

 

 

 

 

Process

 

com.adventnet.nms.util.RunRmiRegistry

 

Functionality

 

Starts RMI Registry as a Web NMS module.

 

Declaration

 

java com.adventnet.nms.util.RunRmiRegistry rmiregistry

 

Arguments - Null.

 

Dependencies

 

In BE/FE combination,  if RunRmiRegistry is running in BE, this process will not run in FE.

 

Other Process Dependencies

 

All the processes that bind remote API into the RMI registry.

 

This is a mandatory process and hence should not be commented out. If this process is running in BE, it won't start in FE. This process starts RMI Registry and hence if this is not available, no process can be bound to the RMI Registry. So, all the processes that bind remote API into RMI registry are dependent on this process.                                                   

 


                                                                                

Process

 

com.adventnet.nms.util.RunJSPModule

 

Functionality

 

To start the Tomcat Web container in the FE Server.

 

Declaration

 

java com.adventnet.nms.util.RunJSPModule

 

Arguments - Null

 

Dependencies

 

This process can be started independently.

 

Other Process Dependencies

 

All servlets and JSPs are executed through this process. If this process is commented out, clients cannot be connected. If this process is running in BE, it won't start in FE.                                      

 


                                                                                

Process

 

com.adventnet.nms.fe.sas.SAServerFE

 

Functionality

 

This process is the FE SAServer proxy forwarder. It accepts all SAS Client requests and forwards them to the SAServer running in either FE or BE. If the SAServer is started in FE, then it forwards the requests to FE, otherwise it forwards them to BE

 

Declaration

 

java com.adventnet.nms.fe.sas.SAServerFE

 

Arguments - Null.

 

Dependencies

 

Other Process Dependencies

 

NmsSAServerBE or NmsSAServerFE.

 

SASServerFE is a proxy forwarder for SAS in FE. Unless SAServer is started in the BE, there is no need to have its counter part in FE. Hence, these processes are inter-dependent.   

 


                                                                    

Process

 

com.adventnet.nms.fe.policy.PolicyFE

 

Functionality

 

Binds the proxy API for the NmsPolicyAPI.

 

Declaration

 

java com.adventnet.nms.fe.policy.PolicyFE

 

Arguments - Null.

 

Dependencies

 

This process depends on NmsPolicyMgr in the BE

 


 

Process

 

com.adventnet.nms.example.befe.ExampleFE

 

Functionality

 

It is an implementation in the FE Server side provided as an example for client server communication.

 

Declaration

 

java com.adventnet.nms.example.befe.ExampleFE

 

Arguments - Null.

 

Dependencies

 

None                                                                    

 


 

Process

 

com.adventnet.nms.fe.telnet.telnetwindow.StartTelnetClientFE

 

Functionality

 

Binds the proxy API for the Telnet API.

 

Declaration

 

java com.adventnet.nms.fe.telnet.telnetwindow.StartTelnetClientFE

 

Arguments - Null.

 

Dependencies

 

This process depends on StartTelnetBE.

 

Other Process Dependencies

 

Telnet functionality in client  

 


                                                                                

Process

 

com.adventnet.nms.fe.store.UserStorageFE

 

Functionality

 

Binds the proxy for the UserStorageAPI.

 

Declaration

 

java com.adventnet.nms.fe.store.UserStorageFE

 

Arguments - Null.

 

Dependencies

 

This process depends on UserStorageBE.

                                                                        


 

Process

 

com.adventnet.nms.fe.sas.NmsSAServerFE

 

Functionality

 

To start the SAServer in FE , in case the SAServer is not already running in a BE/FE server combination.

 

Declaration

 

 java com.adventnet.nms.fe.sas.NmsSAServerFE

[SAS_DEBUG true/false]

[SAS_PORT port]

[APPLET_DIRECTORY applet_directory]

[WEBSERVER_ROOT directory]

[RESTRICT_SOCKETS true/false]

[FILE_OUTPUT true/false]

[SERVER_CLIENT class]

[SESSION_CLIENT class]

[LOG_CLASS class]

Process   :           com.adventnet.nms.fe.sas.NmsSAServerFE

ARGS                  APPLET_DIRECTORY html SERVER_CLIENT test.TestSvrClient LOG_CLASS

         com.adventnet.nms.util.LogMessage

 

Arguments and Description

 

Arguments

 

Description

SAS_DEBUG

This option enables the debug and prints the packet dumps. Default value : False

 

SAS_PORT

This option allows you to specify the port in which the SAS can start. Writes the port number to the SASPort.html file. Default : 0 (Any free port)

APPLET_DIRECTORY

This option allows you to specify the directory in which the SASPort.html file will be written.  By default it is the current directory. The SASUsers sub-directory, which is used to save data from the applets should be created under the directory specified.  - Default value : Empty string

 

WEBSERVER_ROOT

Specifies the root directory of the Web server. Default value : Empty string  

RESTRICT_SOCKETS

This option allows socket access only to SNMP UDP ports 161 and 162.  Default value : False

 

FILE_OUTPUT

This option enables/disables file output access Default value : False

SERVER_CLIENT

Implementation class for SAServerClient. Default value : null

 

SESSION_CLIENT

Implementation class for SASessionClient.  Default value : null

LOG_CLASS

Implementation class for SASLogInterface interfaces.  Default value : null

 

REGISTER_CLIENT

This option can be used to set the user's implementation of the interface "RegisterClient". This interface can be used by the API users  to receive the traps coming from different agents. Default value : null

 

 

Dependencies

 

None

 

General Guidelines

 

Otherwise, you may disable the above process.

 

Otherwise, you may disable this process.

 

 

 

 

 

 


Copyright © 2013, ZOHO Corp. All Rights Reserved.