cc/td/doc/solution/sesm/sesm_313
hometocprevnextglossaryfeedbacksearchhelp
PDF

Table of Contents

Running SESM Components

Running SESM Components

This chapter describes how to start and stop Cisco Subscriber Edge Services Manager (SESM) applications. The chapter contains the following topics:

Starting Applications

This section describes the startup scripts for SESM applications. Topics are:

Starting the SESM Portals

An SESM portal application is a J2EE web application that runs in a J2EE-compliant web server container. The installed startup scripts for the portal applications start the jetty server that is the container for the portal application. The Jetty server is configured (through MBeans in the container's MBean configuration file) to add the portal application to the container.

Startup Script Names

Start the portal applications using the following startup scripts.

Platform Startup Scripts

Solaris and Linux

jetty/bin/startNWSP.sh [-mode mode] jetty/bin/startWAP.sh [-mode mode] jetty/bin/startPDA.sh [-mode mode] jetty/bin/startCAPTIVEPORTAL.sh [-mode mode] jetty/bin/startMESSAGEPORTAL.sh [-mode mode]

Windows NT

jetty\bin\startNWSP.cmd [mode] jetty\bin\startWAP.cmd [mode] jetty\bin\startPDA.cmd [mode] jetty\bin\startCAPTIVEPORTAL.cmd [mode] jetty\bin\startMESSAGEPORTAL.cmd [mode]

Mode Argument

The startup scripts accept an optional command-line argument for specifying the run mode of the portal application. This option provides the capability to switch easily between a fully configured deployment (RADIUS or LDAP mode) and the demonstration deployment (Demo mode).

If the mode argument is included on the command line, it overrides the default mode specified in the SESM MBean in the portal application configuration file. If you switch modes using the command line option, you must make sure that all other configuration attributes are aligned with the mode that you choose.

Valid values for mode are:

Starting RDP

RDP is a Java 2 application that uses the Cisco ConfigAgent and JMX server. RDP does not use the J2EE HTTP server. Therefore, its startup file is not in the Jetty server's bin directory.

Start RDP with the following script:

Platform Script

Solaris and Linux

rdp/bin/runrdp.sh

Windows NT

rdp\bin\runrdp.cmd

Starting CDAT

CDAT is a J2EE application. The startup script for CDAT is in the Jetty server's bin directory. This startup script calls the same generic startup script used by the SESM web applications.

Start CDAT with the following script:

Platform Script

Solaris and Linux

jetty/bin/startCDAT.sh

Windows NT

jetty\bin\startCDAT.cmd

Startup Script Explanation

When you start an SESM portal application or CDAT, you are executing two scripts:

All of the scripts are located in:

    jetty
      bin

You should create an application-specific startup script in this same bin directory for customized SESM web applications.

Application-Specific Startup Scripts

The application-specific startup scripts set the following variables:

The installation program updates the application startup script with the port number that you provide during the installation time. To change the port number after installation, edit the startup script. The default values displayed by the installation program are 8080 for an SESM portal application and 8081 for CDAT.

The port number must be unique on the server machine. If multiple SESM portal applications are running simultaneously on the same server machine, make sure each one listens on a different port. This caveat applies whether you are running two instances of the same application or two different applications.

Generic Startup Script

The generic startup script derives two other port numbers from the application port number:

For example, if you are using the default application port of 8080 for NWSP, the management console port for NWSP is:

    8080 + 100 = 8180
Starting with the default application port value of 8080, the default SSL port is:

    8080 - 80 + 433 = 8443

The generic startup script does the following:

Java System Properties in Startup Scripts

Table 7-1 describes the java system properties that are set by the generic startup script and how the assigned values are derived. The table describes the following lines, which are located at the end of the generic startup script:

$JAVA -Xmx64m -Xmx64m\ -classpath $CLASSPATH \ -Djetty.home=$JETTYDIR \ -Dapplication.home=$APPDIR \ -Dapplication.log=$LOGDIR \ -Dapplication.portno=$PORTNO \ -Dmanagement.portno=$MGMTPORTNO \


Table 7-1: Java System Properties in Startup Scripts
System Property and
Variable Name
Explanation Installed Values in the Start Script

jetty.home=$JETTYDIR

jetty.home is the container's directory name.

The startup script sets $JETTYDIR to the value jetty under the installation directory.

installDir
    jetty

application.home=$APPDIR

application.home is the application's directory name.

The startup script sets $APPDIR to applicationName under the installation directory. The applicationName parameter is passed from another script. (startNWSP.sh, for example).

installDir
    nwsp

or

installDir
    rdp

or

installDir
    cdat

application.log=$LOGDIR

application.log is the location of all log files created for this application.

The startup script sets $LOGDIR differently according to the platform:

  • On Solaris and Linux, $LOGDIR is the logs directory under the application directory in the install directory. For example: installDir/nwsp/logs

  • On Windows NT, $LOGDIR is userTemp\application\logs where userTemp is the administrator's temporary directory. For example: temp\nwsp\logs

application.portno=$PORTNO

application.portno is the port that the web server listens on for HTTP requests from subscribers.

The startup script sets $PORTNO to the portNo parameter passed from another script (startNWSP.sh, for example).

Specified during installation. The default is 8080 for the SESM portal applications and 8081 for CDAT.

management.portno=$MGMTPORTNO

management.portno is the console port that displays the current values for all attributes in all of the MBean configuration files.

The startup script sets $MGMTPORTNO to $PORTNO + 100.

Logging On

To access an SESM portal application, such as the NWSP application, follow these procedures:


Step 1   Start the SESM portal application using its startup script.

Step 2   Start a web browser on a device (such as a desktop computer, a WAP phone, or a PDA) that has network access to the server on which the SESM portal application is running.

Step 3   Go to the URL of the SESM portal application:

    http:// host:port

The URL consists of the host and port number that you specified during the SESM portal application installation, or whatever is currently specified in the portal application's startup script. An example portal application URL is:

    http://server1:80

Default values used during an SESM installation are:

    http://localhost:8080

Step 4   When the SESM portal application's logon page appears, log in using a valid user ID and password. A valid user ID and password is defined in user profiles as follows:


Stopping Applications

This section describes how to stop SESM applications. It includes the following topics:

Stopping SESM Applications on Solaris and Linux

To stop SESM applications on Solaris and Linux, execute the stop scripts listed in Table 7-2. None of the scripts take arguments.


Table 7-2: SESM Stop Scripts on the Solaris and Linux Platforms
Application Stop Script Location and Name on Solaris and Linux Platforms

SESM portals and Jetty

jetty/bin/stopNWSP.sh jetty/bin/stopWAP.sh jetty/bin/stopPDA.sh jetty/bin/stopcaptiveportal.sh jetty/bin/stopmessageportal.sh

CDAT and Jetty

jetty/bin/stopCDAT.sh

RDP

rdp/bin/stoprdp.sh

Stopping SESM Applications on Windows NT

To stop SESM applications and their J2EE containers on Windows NT platforms, you can:

Adding and Removing Services on Windows NT

On a Windows NT platform, you can add your applications to the list of Windows NT services. When the application is a service, it appears in the Services window accessed from Control Panel > Services or Control Panel > Administrative Tools > Services You can start and stop any service from this window. Also, you can optionally configure a service to start automatically when the system reboots.

The SESM installation program provides services scripts with the NWSP, CDAT, and RDP applications. The command syntax is the same for all of the services scripts:

Table 7-3 lists the names and locations of the scripts that add and remove services.


Table 7-3: Scripts for Adding and Removing Services on Windows NT
SESM Application Services Script Location and Name Default Service Name

RDP

rdp\bin\rdpsvc.cmd RDP Application

CDAT

jetty\bin\cdatsvc.cmd CDAT Web Application

SESM portals

jetty\bin\nwspsvc.cmd jetty\bin\wapsvc.cmd jetty\bin\pdasvc.cmd jetty\bin\captiveportalsvc.cmd jetty\bin\messageportalsvc.cmd NWSP Web Application WAP Web Application PDA Web Application Captive Portal Web Application Message Portal Web Application

Memory Requirements and CPU Utilization

This section includes the following topics:

SESM Portal Application Memory Requirements

The total java virtual memory requirements for an SESM portal application depends on several factors:

The most important of these factors is the number of subscribers concurrently logged on. Use the following formula to determine memory requirements for your installation:

requiredJVM = reservedMem + (maxConcurrentUsers * KBPerUser)

Where:

    $JAVA -Xmx64m -Xmx64m
The first -X argument is the initial JVM to reserve. The second -X argument is the maximum JVM. We recommend using the same value for both.

See Table 7-4 for additional guidelines in determining an appropriate kbytePerUser figure.

Symptoms of Insufficient Memory

The installed start script sets the java virtual memory to 64 MB. Consider increasing this default value if you notice these symptoms of insufficient memory:

Verified Memory Requirements

Table 7-4 shows verified memory requirements for the NWSP portal application. We verified these memory requirements using one SESM application instance. It is possible, given more memory, to support larger numbers of users.


Table 7-4: SESM Portal Memory Requirements
SESM Mode JVM Heap Size (MB) Specified in start script1 Maximum Users2 KB per user

RADIUS mode

32

4550

4.73

64

12800

4.18

96

20500

4.17

128

29100

4.04

LDAP mode

64

1800

29.73

96

3000

28.50

128

5000

23.50

256

11000

22.32

1Includes 10.4 MB reserved memory
2In the verification tests, all users were subscribed to three services: one passthrough, one proxy, and one tunnel

SESM Portal Application CPU Utilization

CPU utilization by an SESM portal application increases as the rate of new logons increases. Table 7-5 shows CPU utilization at specified logon rates for the NWSP portal. These rates are verified using consistent login rates, with all users subscribed to three services. The logon rates indicate successful logon and authentication of all users.


Table 7-5: SESM Portal CPU Utilization
SESM Mode Logon Rate Sustained until Maximum Users Reached1 Maximum Users CPU Utilization
on Sun Sparc U5-10
400-MHz server

RADIUS mode

20 logons per second

12,800

20%

40 logons per second

40%

60 logons per second

60%

80 logons per second

80%

100 logons per second

100%

LDAP mode

10 logons per second

11,000

60%

1All users are subscribed to three services: one passthrough, one proxy, and one tunnel.

RDP Memory Requirements

The amount of memory RDP uses is roughly proportional to the number of users that are logged in within a fixed period of time. If you find that RDP is running out of memory, increase the amount of memory allocated to the program by editing the startup script.

As a rough guide, RDP requires 64 MB of memory when 5000 users are logged in within any 20 minute period. If the logon rate is likely to exceed this rate, you should increase the RDP memory allocation.


hometocprevnextglossaryfeedbacksearchhelp
Posted: Mon Aug 26 17:16:53 PDT 2002
All contents are Copyright © 1992--2002 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.