3.4.8 Shutting Down Web NMS Server

The Web NMS ShutDown process shuts down all the sub-processes and properly releases all the system resources. It is necessary that the shutdown process be properly executed to make sure that the system does not leave any operation incomplete in addition to leaving the database information in a consistent state. The NMS server can be shutdown only by authenticated users and it is recommended that the NMS server be shutdown using one of the standard ways.

The following is the sequence of operations which take place during the NMS Server shutdown process,

1. Stop all the schedulers

2. Notify the registered shutdown observers

3. Unbind all RMI registry objects

4. Shutdown all the sub processes (sub-modules), which will execute specific tasks

5. Shut down the rmiregistry process (if started by Web NMS)

6. Disconnect all database connections

7. Stop mysql (if started by Web NMS)

8. Shutdown the webserver (if started by Web NMS)

9. Exit (the main process)

The Web NMS BE Server can be shut down by any of the following ways,

• Sending a ShutDown request to the BE server through the TCP socket on which it is listening for connections from FE (the BE_PORT parameter). This is usually the preferred way of shutting down the BE server.

• Executing the ShutDown servlet in the webserver corresponding to the BE Server. This servlet invokes the ShutDown process in the BE server. This ShutDown process can not be invoked if the web server is not running in the BE server host.

• Executing the corresponding ShutDownAPI method from remote (using RMI). The ShutDownAPI will be bound in the RMI registry of the BE Server host. The ShutDown process can not be invoked if the RMI rmi registry process is not running in the BE Server host.

The shutdown process checks for the authenticity and the permissions of the user invoking the shutdown operation and allows only if the user has proper permissions.

A standalone application is provided, which uses the above mentioned methods to ShutDown the Web NMS server. First it tries through the TCP mode. If it fails, it uses the servlet mode. If the servlet mode also fails, it uses the RMI mode. The user name, password, host name and the ports (TCP, Web Server, RMI) are configurable in the application.

The Web NMS Server can be shut down

• By invoking the standalone application "Shutdown NMS Server" from the Web NMS Launcher

• By invoking the script shutdown.bat/sh from <Web NMS Home>/bin

• From the HTML Client

• Through Command Line mode

• Running the scripts from remote machine

• Automatically when the database connection is lost

Shutting down Web NMS Server through the Web NMS Launcher

Run WebNMSLauncher.bat/sh file from<Web NMS Home>. Choose the application "Shutdown NMS Server". Right click on the icon and choose the "Run"option. A dialog box "Shut Down NMS Server" comes up for you to type in your password. Click on the OK button for the Web NMS Server to shut down.

By invoking the script shutdown.bat/sh from <Web NMS Home>/bin

In Windows

Run the ShutDown.bat from <Web NMS Home>/bin. This invokes a UI which prompts the user to enter the password. On clicking "Settings", you can view your port where the Web NMS is running, the RMI Registry Port and TCP Port. Click "OK" to successfully shut down.

In Linux and Solaris

Invoke : sh ShutDown.sh. This invokes a UI which prompts the user to enter the password. On clicking "Settings", you can view your port where the Web NMS is running, the RMI Registry Port and TCP Port. Click "OK" to successfully shut down

Shutting down Web NMS Server from HTML UI

To shutdown Web NMS Server from HTML UI, choose the System Administration panel or choose "File -> System Admin" from the tools menus. Choose the "Shut Down Server" option from the HTML page displayed. This opens up a new HTML page with the message "Are you sure you want to ShutDown the server". On clicking "Yes", the Web NMS server will be shutdown.

Shutting down Web NMS Server through Command Line mode

Web NMS Server can be shutdown through command line

In Windows

Invoke :ShutDown.bat [User Name] [Password]

In Linux and Solaris

Invoke : sh ShutDown.sh [User Name] [Password]

You have to edit the script to meet specific requirements. The script that executes the Java program StandAloneShutDown has the following arguments.

• Host: Host can be the DNS name of the machine where the Web NMS server is running or its IP address.

• Port: The port on which Web NMS is running.

• UserName: This is the user name registered with Web NMS, who is authorized to shut down the Web NMS server. The default username is 'root'.

• Password: The password for the above mentioned user. The default password is 'public'.

Running the scripts from remote machine

The script can also be run from a remote machine to shut down the Web NMS server. In order to do that, the following steps has to be followed.

1. Create a temporary directory say WebNMSShutDown/ on the remote machine.

2. Copy the ShutDown.bat/sh script to this directory.

3. Copy the <Web NMS Home>/classes/StandAloneShutDown.class to this directory.

4. Edit the classpath to point to the current working directory.

5. Edit the script to pass the correct arguments to the StandAloneShutDown class.

Internationalization Support

To Internationalize Shutting down Web NMS UI, edit the ShutDownNmsServerResources.properties file present in <Web NMS Home>/HTML directory. The values for the keys should be substituted by new values.

Shutdown Automatically When the Database Connection is Lost

Please refer to Automated Shutdown for detailed description.