Using Modem Registrar

The Modem Registrar user interface provides a flexible method for customizing DOCSIS configuration files. This chapter discusses the user interface, and explains how to start using Modem Registrar.

Modem Registrar User Interface

Modem Registrar provides a Web-based user interface that consists of a collection of pages, designed to enable you to perform a specific management or configuration task. Using these pages, you can do the following:

Manage services, including adding and deleting service types, levels, classes, and packages
Manage the default option set
Manage other option sets, including listing, adding, modifying, cloning, and deleting CMTS group, CMTS, subnet, and vendor option sets
Search for cable modems, list options that will be applied to them, and create option sets for specific cable modems (see the online Help information for the cable modem pages)
Set and control TFTP settings, and set log and trace settings
Create and manage administrators

Note For more information, see the Modem Registrar Administrator's Guide.

Online Help pages provide information about the fields and buttons on a user interface page. To open a Help page, click Help in the page's Modem Registrar Toolbar, shown in Figure 2-1.

Table 2-1 lists the menu pages available in the Modem Registrar user interface. For more information about the user interface pages, see the Modem Registrar Administrator's Guide.

User Interface Page	Description
Login	Starts a session with Modem Registrar.
Main Menu	Selects the functional area that you want to manage.
Manage Services	Selects the services that you want to manage.
Configure Option Sets	Selects the option sets that you want to manage.
Configure TFTP Server	Selects the TFTP functional area you want to control or manage.
Manage Administrators	Lists and deletes the administrators currently defined, and accesses the pages used to add and modify administrators.

Table 2-1:

User Interface Page Description

Login

Starts a session with Modem Registrar.

Main Menu

Selects the functional area that you want to manage.

Manage Services

Selects the services that you want to manage.

Configure Option Sets

Selects the option sets that you want to manage.

Configure TFTP Server

Selects the TFTP functional area you want to control or manage.

Manage Administrators

Lists and deletes the administrators currently defined, and accesses the pages used to add and modify administrators.

Menu Pages

Modem Registrar Toolbar

The Modem Registrar Toolbar (see Figure 2-1) appears on each of the user interface pages in the upper right-hand corner. The toolbar consists of the following buttons , although not all buttons are available for each page as indicated in the descriptions below:

Help ---Opens the online Help page, providing information about the fields and buttons on the current page.
Logout ---Terminates the current Modem Registrar session. The Logout button is not available on the Login page. You must save any configuration changes you make before you click Logout.
Back ---Redisplays the previous page. The Back button appears on a limited number of interface pages after clicking View on a page.

Figure 2-1: Modem Registrar Toolbar

Navigation Bar

The Modem Registrar Navigation Bar (see Figure 2-2) enables you to quickly navigate from one user interface page to another. The Navigation Bar appears just below the page title on each of the interface pages, except the Login and Main Menu pages.

Figure 2-2: Navigation Bar

The Navigation Bar consists of one or two rows of buttons, depending on the page. The top row of buttons provides the same selections available on the Main Menu page and corresponds to the four functional areas you may manage or configure. The buttons in this row are:

Services
Option Sets
TFTP Server
Administrators

The bottom row of buttons provides access to the pages available from the selections in the top row. Selections displayed in red indicate the choices you are currently accessing. Selections displayed in green indicate the choices you can access.

For example, Figure 2-2 displays the option sets Navigation Bar. The buttons in the bottom row provide access to the pages available from the Option Sets button.

Additional User Interfaces for TFTP Server Management

In addition to managing the TFTP server using the Web user interface (see the "Managing the TFTP Server" section), you can also use the command line interface (CLI) to manage the TFTP server. For more information, see the Cisco Network Registrar CLI Reference Guide.

Reloading the TFTP Server's Memory

The TFTP server assembles DOCSIS options for a cable modem's DOCSIS configuration file based on the configuration information stored in the server's memory. When you make changes to the configuration information, the changes are written to the directory database, but they are not stored in the TFTP server's memory. You must reload the server's memory to update it with the most current LDAP configuration information.

To reload the TFTP server's memory, do the following:

Step 1 On the Main Menu page, click Configure TFTP Server.

Step 2 On the Configure TFTP Server page, click Control.

Step 3 On the Control TFTP Server page, click Reload.

The TFTP server stops and then immediately restarts with the changed LDAP configuration installed in the server's memory.

You are not notified if the server's memory was successfully updated. However, a message does appear if the reload operation failed.

Note Be sure to exercise caution when choosing to reload the TFTP server as this can have a disruptive effect on subscribers currently using the system. You might choose to make reloading the TFTP server part of a regularly scheduled activity that occurs in off-peak hours.

Suggestions for Using Modem Registrar

The Modem Registrar user interface provides a flexible method for doing the following:

Creating and managing administrators
Configuring the Cisco TFTP server
Customizing DOCSIS configuration files

To simplify the configuration process, Cisco recommends that you define options for the general to the more specific option set scopings. First define options for the default option set (the most general option set) and then define option sets for more specific option sets, such as the CMTS and vendor option sets.

At a minimum, you must assign options to the default option set and create option sets for the CMTS and subnet option scopings.

Default option set---The default option set contains options that apply to all cable modems in your installation and is typically more densely populated with DOCSIS options.
CMTS option set---The CMTS option set identifies the servicing CMTS for the cable modems.
Subnet option set---The subnet option set serves identifies the CMTS with which the cable modem actually communicates.

You can choose to define the following optional option sets:

CMTS group option set---You can assign a CMTS option set to a CMTS group option set and manage CMTS devices at the group level.
Vendor option set---You can define option sets for specific vendor cable modems.
Cable modem option set ---Under special circumstances you can choose to assign options to an individual cable modem .

Using Modem Registrar for the First Time

When using Modem Registrar for the first time, Cisco recommends that you follow these steps:

Step 1 Disable all existing TFTP services on the host on which you installed Cisco Network Registrar (CNR ) version 3.0 (1)T or higher Technology (T) version.

Note

Step 2 Create administrators (see "Creating and Managing Administrators" section).

Step 3 Configure the Cisco TFTP server using the Modem Registrar user interface (see the "Managing the TFTP Server" section).

Step 4 Define services.

Step 5 Assign options to the default option set .

Step 6 Define the optional CMTS group option set , if desired, and the required CMTS and subnet option sets .

Step 7 Define the optional vendor and cable modem option sets , if desired.

Typically, the optional option sets are sparsely populated since they pertain to very specific cases within the installation.

As you define option sets, you must determine whether to actually assign option values to those sets. You may choose not to define options for some option sets. For example, you can create subnet option sets that model your physical installation, but that do not have any options assigned to them.

For more information, see the Modem Registrar Administrator's Guide.

Disabling Existing TFTP Services

The Cisco TFTP server provides standard TFTP services and dynamically creates customized configuration files for each DOCSIS cable modem. This server replaces all existing TFTP services running on your Solaris or Windows NT system. To prevent overlapping of services, you must disable all existing TFTP services.

Logging In to Modem Registrar

You can use the Login page (see Figure 2-3) to establish a session with Modem Registrar. This page provides fields for you to enter your username and password. If you are logging in to Modem Registrar for the first time, you can use the default username and password shown below. Subsequently, however, Cisco recommends that administrators log in using the username and password you create.

Username    admin
Password    changeme

Tips After you log in to Modem Registrar the first time, create administrators that you want to manage and define configuration parameters. For more information, see the "Creating and Managing Administrators" section.

Figure 2-3: Login Page

To log in to Modem Registrar , do the following:

Step 1 Enter the following URL in your browser to open the CSRC Welcome page:

http://<hostname>[:<port-number>]/csrc/admin.html

where:

hostname is the name of your Web browser.

port-number is the number of the port on which the Web browser is communicating. The default is port 80. You only need to specify the port number if a port other than 80 is being used.

For example, if your Web browser is called webhost and is communicating on port 80, you enter the following URL:

http://webhost/csrc/admin.html

If port 1002 is being used instead of port 80, you enter the following URL:

http://webhost:1002/csrc/admin.html

Step 2 On the CSRC Welcome page, click the following hypertext link to open the Modem Registrar Login (see Figure 2-3) page:

Log in to Modem Registrar

Step 3 On the Login page, enter your administrator username and password in the Username and Password fields.

Note

admin

changeme

Step 4 Click Login. The Main Menu page appears.

Logging Out of Modem Registrar

You can use the Logout button in the Modem Registrar Toolbar (see Figure 2-1) to end a session with Modem Registrar. The Toolbar appears in the upper right-hand corner of each user interface page; however, the Logout button is not available on the Login page.

To log out of Modem Registrar , do the following:

Step 1 Save any configuration changes you made.

Step 2 Click Logout in the Modem Registrar Toolbar.

Step 3 On the Logout from Modem Registrar page (see Figure 2-4), click Logout to exit Modem Registrar or click Cancel to return to the previous page.

Note Be sure to click OK to save your configuration changes before you click Logout. Any unsaved changes are lost when you log out.

Figure 2-4: Logout from Modem Registrar Page

Selecting the Item You Want to Manage

You can use the Main Menu page (see Figure 2-5) to access the user interface pages used to manage and configure the following:

Service types, levels, classes, and packages
Default, CMTS group, CMTS, subnet, vendor, and cable modem option sets
TFTP controls and settings, and log and trace settings
Administrators

Figure 2-5: Main Menu Page

Creating and Managing Administrators

You can use the Manage Administrators page (see Figure 2-6) to do the following:

List the existing administrators
Access the user interface page used to add new administrators
Access the user interface page used to modify administrator information and administrator privileges
Remove administrators that you no longer want to manage configuration parameters

Figure 2-6: Manage Administrators Page

The following sections describe how to add and modify administrators. For more information about managing administrators, see the Modem Registrar Administrator's Guide.

Adding Administrators

You can use the Add Administrators page (see Figure 2-7) to do the following:

Create new administrators
Set the administrator privileges for the new administrator

Figure 2-7: Add Administrator Page

To add administrators, do the following:

Step 1 Log in to Modem Registrar.

Step 2 On the Main Menu page, click Administrators.

Step 3 On the Manage Administrators page, click Add Administrator.

Step 4 On the Add Administrator page, enter the new administrator's username in the Administrator Username field.

Step 5 Enter descriptive information in the Description field to further identify the administrator.

Step 6 Enter a password for the new administrator in the Administrator Password field. The password appears as a series of asterisks.

Step 7 Enter the password again in the Confirm Password field. You must enter the password exactly as you entered it the first time. If you do not, an error message appears asking you to re-enter the new password. The password appears as a series of asterisks.

Step 8 Set the desired administrator privileges for the new administrator.

Select User Registrar Administrator checkbox if you want the new administrator to manage subscribers, modems, and computers using the User Registrar Administrator application.
Select the Modem Registrar Administrator checkbox if you want the new administrator to manage services, configure cable modem option sets, or configure the TFTP server using the Modem Registrar application.
Select the Configuration Administrator checkbox if you want the new administrator to create new services, modify existing services, or manage CSRC defaults using the User Registrar Administrator application.
Select the Administrator Administrator checkbox if you want the new administrator to add, modify, and delete administrators using the User Registrar Administrator application and/or the Modem Registrar application.

Note

Step 9 Click Add Administrator.

Step 10 On the Confirm Addition of Administrator page (see Figure 2-8), review the new administrator information and do one of the following:

Click Add Administrator to save the new administrator information in the database.
Click Cancel to return to the Add Administrator page without adding the new administrator.

Figure 2-8: Confirm Addition of Administrator Page

Modifying Administrators

You can use the Edit Administrator page (see Figure 2-9) to do the following:

Change an administrator's description and password
Modify administrator privileges

Figure 2-9: Edit Administrator Page

To modify the an administrator, do the following:

Step 1 Log in to Modem Registrar.

Step 2 On the Main Menu page, click Administrators.

Step 3 On the Manage Administrators page, list the administrator you want to modify by doing one of the following:

To list a specific administrator, enter the administrator's username or description in the Username or Description field and click Search.
To list all existing administrators, enter * in the Username field and click Search.

Step 4 In the list of administrators, locate the username of the administrator you want to modify and click Edit for that administrator.

Step 5 On the Edit Administrator page , modify the administrator's information as desired.

To modify the description of the administrator, edit the description in the Description field.
To modify the administrator's password, edit the password in the Administrator Password field. Enter the new password again in the Confirm Password field.

Note

To allow the administrator to manage subscribers, modems, and computers using the User Registrar Administrator application, select the User Registrar Administrator checkbox.
To allow the administrator to manage services, configure cable modem option sets, or configure the TFTP server using the Modem Registrar application, select the Modem Registrar Administrator checkbox.
To allow the administrator to create new services, modify existing services, or manage CSRC defaults using the User Registrar Administrator application, select the Configuration Administrator checkbox.
To allow the administrator to add, modify, or delete other administrators, select the Administrator Administrator checkbox.

Note

To temporarily prevent an administrator from logging in to the application for which the administrator has administrator privileges, select the Disabled checkbox.

: For example, if you select the Modem Registrar Administrator checkbox, you can select the Disabled checkbox to temporarily prevent the administrator from accessing the Modem Registrar pages.

Step 6 Click OK to save the changes you indicated.

Step 7 On the Confirm Changes to Administrator page (see Figure 2-10), review the administrator information and do one of the following:

Click OK to save the changes in the database. The Manage Administrators page appears.
Click Cancel to return to the Edit Administrator page without saving the changes you made.

Figure 2-10: Confirm Changes to Administrator Page

Managing the TFTP Server

You can use the Configure TFTP Server page (see Figure 2-11) to control TFTP server activities and to configure TFTP server settings. Typically, you only need to define these policies once, although you can choose to modify them at a later time.

Figure 2-11: Configure TFTP Server Page

You can manage the following TFTP activities and settings:

TFTP server start, stop, and reload activities
LDAP bootstrap settings
Standard TFTP server settings
Log and trace settings

Controlling TFTP Server Activity

You can use the Control TFTP Server page (see Figure 2-12) to control the following TFTP server activities:

Starting and stopping the TFTP server

Reloading the TFTP server's memory with updated information stored on the LDAP Server

Making TFTP services available when the TFTP server reboots

Displaying information about the health of the TFTP server
Displaying statistical information about the TFTP server

Figure 2-12: Control TFTP Server Page

To control TFTP server activity , do the following:

Step 1 Log in to Modem Registrar (see the "Logging In to Modem Registrar" section).

Step 2 On the Main Menu page, click TFTP Server.

Step 3 On the Configure TFTP Server page, click Control.

Step 4 On the Control TFTP Server page, click the button for the activity you want to control.

To start the TFTP server, click Start. If the server is already started, the server is not restarted.
To stop the TFTP server, click Stop. A message appears asking you if you want to stop the server. Click Yes or No as appropriate.
To reload the TFTP server's memory, click Reload. The TFTP server stops and then immediately restarts, and updated LDAP configuration information is loaded into the TFTP server's memory.

: If the TFTP server is already stopped when you click Reload, the server starts again and the updated configuration loads into the TFTP server's memory.

Note The TFTP server uses the LDAP configuration information stored in the server's memory to generate DOCSIS configuration files. The

changes you make to the current configuration are written to the directory server's database, but are not stored in the TFTP server's memory until you click Reload.

To make the TFTP server services available when you reboot the server, click Enable. The TFTP server must be enabled and started in order for the server to generate DOCSIS configuration files.
To make the TFTP server services unavailable when you reboot the server, click Disable. A message appears asking you if you want to disable the server. Click Yes or No as appropriate.

: If the server is already disabled when you click Disable, the server remains disabled.

To display TFTP server health information, click Health. A message appears with a number to indicate the health of the server. For example:

: 1 = poor health or the server is stopped
: 10 = excellent health
: Click OK to dismiss the message. The Control TFTP Server page appears.

To display TFTP server statistics, click Statistics. Two columns of information appear. The statistic title appears in the first column and the corresponding statistic appears in the second column.

Setting Up the LDAP External Interface

You can use the Configure Bootstrap Settings page (see Figure 2-13) to set parameters for the external interface to the LDAP Server. The bootstrap settings you specify enable the TFTP server to communicate with the appropriate LDAP Server.

Figure 2-13: Configure Bootstrap Settings Page

To configure bootstrap settings, do the following:

Step 1 Log in to Modem Registrar.

Step 2 On the Main Menu page, click TFTP Server.

Step 3 On the Configure TFTP Server page, click Bootstrap.

Step 4 On the Configure Bootstrap Settings page, enter the LDAP server's DNS name or IP address in the LDAP Hostname or IP Address field.

Step 5 In the LDAP Port field, enter the port number reserved for the LDAP Server. The default is 389.

Step 6 In the LDAP Username and LDAP Password fields, enter the administrator username and password you use to log in to the LDAP server.

Step 7 In the LDAP Root DN field, enter the root distinguished name (DN) for the CSRC configuration.

Step 8 Select the LDAP Use SSL checkbox if you want the TFTP server to use the Secure Sockets Layer (SSL) security when communicating with the LDAP server.

Step 9 In the LDAP Initial Communication Timeout field, enter the number of seconds you want to allow the TFTP server to initially attempt to communicate with the LDAP Server.

Note

Step 10 In the LDAP Maximum Communication Timeout field, enter the maximum number of seconds you want to allow the TFTP server to re-attempt (re-try) to communicate with the LDAP server.

Note

Step 11 Click OK to save the information. The Configure TFTP Server page appears.

Controlling Standard TFTP File Services

You can use the Configure TFTP Settings page (see Figure 2-14) to control standard TFTP file services, such as file access and communication timeouts.

Figure 2-14: Configure TFTP Settings Page