|
|
A full installation of CSRC requires the following software packages to operate properly:
This chapter provides installation-specific information you will need to install CNR and the CSRC software packages.
For information about installing the directory server, see "Netscape Directory Server."
In addition to a copy of the "CSRC Installation Worksheet" (see Figure 2-1), Table 3-1 lists the software packages you need to complete a full installation of CSRC.
| Software Package | What You Need |
|---|---|
Cisco Network Registrar (CNR) | CNR installation kit, included on the CSRC distribution media. Getting Started with Network Registrar for CNR installation instructions. |
LDAP directory server | LDAP directory server software. Note For more information, see "Netscape Directory Server." |
CSRC | CSRC software packages on the CSRC distribution media. For more information, see the "CSRC Installation" section. CSRC license key, located in the CSRC installation kit. |
Step 1 of the CSRC installation process is to install Cisco Network Registrar (CNR). The following sections describe the installation requirements for CNR and how to configure CNR for CSRC. Cisco recommends that you review these sections before you install CNR as described in the "Cisco Network Registrar Installation Procedure" section.
All of the CSRC software packages require CNR version 3.0(1)T or higher version, except the CSCOcsrcd package. This package does not require CNR.
As you install CNR, be sure you do the following:
As you install CNR, be sure to indicate the following information on the "CSRC Installation Worksheet" (see Figure 2-1):
If you already have CNR installed, check the version number of the installed graphical user interface (GUI) and the CNR servers to ensure that they meet the CSRC requirement. To check the GUI version number, do the following:
Step 1 Open the CNR graphical user interface (GUI) using the following command:
/opt/nwreg2/usrbin/ntwkreg
Step 2 In the Help menu, select the About Network Registrar option. The CNR version displays in the window that appears.
To check the CNR servers version number, do the following:
Step 1 Enter the following command to change directories:
# cd /opt/nwreg2/bin
Step 2 If you are using the C shell, enter the following command to display the version number:
# setenv LD_LIBRARY_PATH /opt/nwreg2/lib; ./dns -v
If you are using the Bourne shell, enter the following command to display the version number:
# LD_LIBRARY_PATH=/opt/nwreg2/lib dns -v
The information that displays is similar to the following:
Copyright (C) 1994-1999 by Cisco Systems, Inc. product: 3.0(2)T nightly build #140287 . . .
The following procedure describes how to install Cisco Network Registrar (CNR). You must install the user interface component (GUI component) of CNR on the same host(s) as the CSCOcsrcw and CSCOcsrcu packages. You must install the servers component of CNR on the same host as the CSCOcsrcn package.
To install CNR, do the following:
Step 1 Enter the following command line to start the CNR installer:
# pkgadd -d /cdrom/nr_3_0_2_t/solaris/see_readme_before_using nwreg2
where cdrom specifies the directory on which the CD-ROM is mounted. For example, replace /cdrom/nr_3_0_1_t with the directory on which the CD-ROM is mounted. This directory varies, depending on how your Solaris volume daemon is configured and on which version of CNR you are installing.
Step 2 Follow the installer until installation completes. Be sure you do the following:
Step 3 Configure a cluster and set the CNR license key for that cluster. For more information, see the "What to Do After You Install CNR" section.
After you install the proper version of CNR, you must configure at least one cluster and set the CNR license key for that cluster. If you do not do this before you begin installing the CSRC software packages, CSRC will not install successfully.
The license key is located on the back of the CNR distribution media. You must enter your license the first time you configure a cluster.
To configure one cluster and set the license key, do the following:
Step 1 Enter the following command to start the CNR graphical user interface (GUI):
/opt/nwreg2/usrbin/ntwkreg
Step 2 From the Admin menu, select Clusters.
Step 3 In the Cluster dialog box, click Add Cluster.
Step 4 In the Add Cluster dialog box, enter the cluster name. The cluster name must be the name of the host on which the database runs. This is usually the name of the DNS server.
Step 5 Select the Connect to this cluster checkbox. You must connect to the cluster to set the license key.
Step 6 Click OK.
Step 7 In the Login for Cluster dialog box for that cluster, enter the username and password.
Step 8 Click OK.
Step 9 From the License dialog box, click New Key.
Step 10 From the Cluster Properties dialog box, select Edit License Key.
Step 11 Enter the 16-character license.
Step 12 Click OK.
For more information, see Getting Started with Network Registrar.
Step 2 of the CSRC installation process is to install an LDAP version 3 compliant server, such as the Netscape Directory Server (NDS). For information about installing NDS, see "Netscape Directory Server" and the NDS documentation.
Step 3 of the CSRC installation process is to install the CSRC software packages. Table 3-2 lists the CSRC packages included on the CSRC distribution media. You can install each of these packages separately or all at once. You can choose to install the packages on the same host or on different hosts (see the "Installation Worksheet" section). Regardless of how many hosts you install the CSRC packages on, you must always install the CSCOcsrcd package first. If you install the remaining packages on the same host, you must install them in the same order as they are listed in Table 3-2.
The following sections discuss the installation of the CSRC software packages.
You can install the CSRC packages on multiple hosts with different operating systems, based on the CSRC data center you design. The order in which you install the CSRC packages is important if you install the packages on the same host. You must install the CSRC packages in the following order:
You can specify one or more packages on the pkgadd command line; however, when specifying multiple packages you must enter the packages on the command line in the order specified above.
As you install the CSRC software packages, do the following:
If you install multiple CSRC packages on the same host, you only need to install the required software for each package once on that host. For example, the CSCOcsrcw and CSCOcsrcu packages each require that you install the CNR user interface on the host on which the package is installed. If you install CSCOcsrcw and CSCOcsrcu on the same host, you only need to install the CNR user interface once on that host.
The CSRC installer requires you to enter values that pertain to the installation of a previously installed required component (for example, the LDAP administrator password entered during the directory server installation). To ensure that you enter consistent values, refer to the appropriate boxes on the "CSRC Installation Worksheet" (see Figure 2-1) as you answer the CSRC installer's questions.
As you install CSRC, be sure to indicate the root distinguished name for CSRC data on the "CSRC Installation Worksheet" (box 11). This is the path in the directory server's hierarchy where CSRC data will be stored. The default is o=NetscapeRoot.
You can install CSRC from the CSRC distribution CD-ROM. To do this, use the following command line syntax:
pkgadd -d /cdrom/csrc_1_0_2/CSRC/Solaris [-r response-file] [packages]
where:
cdrom specifies the CD-ROM directory containing the CSRC installer.
-r response-file indicates to use the required parameter values contained in the file identified in response-file instead of prompting the user for the information. For more information, see "The Response File" section.
packages is the name(s) of the CSRC software package(s) you want to install. For more information, see Table 3-2.
You can also install CSRC from the CSRC electronic distribution image. To do this, you must unpack the distribution image into a directory and then specify that directory in the command line. For example, to unpack the distribution image into the /opt/CSRCdist directory, use the following command line syntax:
pkgadd -d /opt/CSRCdist/csrc_1_0_2/CSRC/Solaris [packages]
Before you begin installing the CSRC software packages, you must confirm that the directory server is running. The directory server must be running for the CSCOcsrcd software package to install correctly. To confirm that the Netscape Directory Server (NDS) is running, see the NDS documentation.
You must install the CSRC software packages as root. The following procedure describes how to install the first CSRC package on a host. The steps in the procedure indicate the number of the box on the "CSRC Installation Worksheet" that contains the information requested. In this procedure, the first package installed on the host is CSCOcsrcd. If the first package you install is another CSRC package, substitute the other package name on the command line. All other steps remain the same.
To install the first CSRC package on a host, do the following:
Step 1 Log in to your Solaris system as superuser or switch to superuser if you are logged in as a normal user.
Step 2 To start the installer from the CD-ROM, enter the following command line:
# pkgadd -d /cdrom/csrc_1_0_2/CSRC/Solaris CSCOcsrcd
where cdrom specifies the CD-ROM directory containing the CSRC installer and 1_0_2 is the version number of CSRC.
The installer displays a message, indicating that you will now be prompted for the information required to install CSRC.
Step 3 Enter yes to indicate that you want the installer to prompt you for all CSRC installation parameters. This allows you to create a response file that you can use later to install additional CSRC packages.
Prompt for all CSRC installation parameters now? [no]: yes
Step 4 Enter your CSRC license key at the following prompt. If you do not specify a license key, the installer installs a thirty-day evaluation key. If you enter an invalid key, the installer displays an error message and prompts you again.
Enter CSRC license key:
Step 5 Enter the full path of the directory in which you installed the LDAP directory server (box 5). For Netscape Directory Server, the default is /usr/netscape/server4, if it exists. Otherwise, the default is none.
Enter the LDAP server installation root directory:
If you enter a directory that does not exist while installing the CSCOcsrcd package, the installer displays the prompt again. If the directory does not exist while installing other CSRC packages, a warning message appears indicating that the installation is continuing with the assumption that the NDS is installed on another host on which the directory does exist.
Step 6 Enter the name of the host on which the LDAP server is installed (box 6). The default is the output of the hostname command.
Enter the LDAP server host name:
Step 7 Enter the unique identifier for the LDAP server (box 7). The default is the LDAP server host name with its domain removed, if the corresponding server directory LDAP-server-root/slapd-host-name exists. Otherwise, there is no default.
Enter directory server identifier:
If you specify a directory server identifier and the corresponding server directory does not exist while installing CSCOcsrcd, the installer displays the prompt again.
Step 8 Enter the port number on which the LDAP server listens for queries (box 8). The default is the value of the Port parameter in the slapd.conf file, if it exists. Otherwise, there is no default.
Enter the LDAP port number:
If you enter a non-integer, the installer displays the prompt again. The slapd.conf file is in the LDAP-server-root/slapd-identifier/config directory.
Step 9 Enter the root distinguished name (DN) for CSRC data (box 11). The root DN you specify must already exist. If it does not, you must create it before you install CSRC. For Netscape Directory Server, the default is o=NetscapeRoot. You can use the default.
Enter the root distinguished name for CSRC data [o=NetscapeRoot]:
To prevent CSRC data from conflicting with the data of other applications, a specific location is allocated in the directory server's hierarchy for CSRC data. The root DN for CSRC data is the path to this location. If you specify a DN that does not contain the substring o=, the installer displays the prompt again.
For example, you can enter a DN, such as o=yourcompany.com, or you can enter a more detailed DN, such as ou=csrc,o=yourcompany.com.
The installer prepends csrcprogramname=csrc, (including the trailing comma) to the DN you enter.
Step 10 Enter the administrator ID for the LDAP directory server (box 9). The default is admin.
Enter the directory server administrator ID [admin]:
Step 11 Enter the password (box 10) for the directory server administrator ID you specified in the previous step. You must enter the password twice identically.
Enter the directory server administrator password: Enter the directory server administrator password (again):
If you do not enter the password identically both times, the installer displays the prompt again.
Step 12 Enter the name of the host on which the Cisco Network Registrar servers are installed (box 1). This is the host on which the TFTP server is running. The default is the name of the current host (the host on which you are running the installation).
Enter Cisco Network Registrar host name:
Step 13 Enter the username for the Cisco Network Registrar administrator who has access to the Cisco Network Registrar database (box 2). The default is admin.
Enter Cisco Network Registrar user name:
Step 14 Enter the password for the CNR administrator you specified in the previous step (box 3), and then enter the password again to confirm it.
Enter password for Cisco Network Registrar "username" user: Again:
If you do not enter the password identically both times, the installer displays the prompt again.
Step 15 Review the information the installer displays to confirm the values you entered. The installer does not display the actual value you entered for a password. Instead, it displays <not displayed>. The installer stores the passwords you entered in encoded form in both the Solaris package database and the csrc.cfg file.
If the values displayed are correct, press Enter to accept the prompt's default answer and continue installing CSRC, or enter no or quit to terminate the installation.
Proceed with the installation of Cisco Subscriber Registration Center version [Y]?
At this point, the installer saves the parameter values you entered, if you previously indicated that you wanted to create a response file when the installer prompted you. The installer saves the parameter values in the /tmp/csrc_install_defaults file and displays a message indicating how to invoke the pkgadd utility to use the response file when installing additional CSRC packages.
pkgadd -d /cdrom/csrc_1_0_2/CSRC/Solaris CSCOcsrcn CSCOcsrcw CSCOcsrcu
where cdrom specifies the CD-ROM directory containing the CSRC installer and 1_0_2 is the version number of CSRC.
If you want the installer to use the parameter values in a response file, enter the following command:
pkgadd -d /cdrom/csrc_1_0_2/CSRC/Solaris -r /tmp/csrc_install_defaults package
where package is the name of the package you are installing.
The installer prompts you for the CSRC license key and uses the information in the response file to gather the remaining needed information. Enter your CSRC license key at the following prompt. This prompt does not appear if you are installing the CSCOcsrcd package.
Enter CSRC license key:
If you enter an invalid key, an error message appears and the prompt displays again.
If you do not specify a license key, the installer installs a thirty-day evaluation key.
If you want to install CSRC packages on a different host using the response file, copy the response file to that host and invoke pkgadd as described in the above example.
As the installation of CSRC continues, the installer does the following:
Step 5 of the installation process is to start the CSRC servers (JRUN and Apache Web server) and the TFTP server. The CSRC installer automatically installs the JRUN and Apache servers during CSRC installation. You must manually start them.
To start the JRUN and Apache servers, enter the following command:
# /opt/csrc/bin/csrc_start
To start the TFTP server from the nrcmd command line interface and to enable the server to start up automatically when the server is restarted, enter the following commands:
nrcmd> tftp start nrcmd> tftp enable start-on-reboot
For more information about the nrcmd command line interface, see the Network Registrar CLI Reference Guide.
To verify the User Registrar Administrator application, do the following:
Step 1 Start your browser and enter the following URL to open the CSRC Welcome page:
http://hostname/csrc/admin.html
where hostname is the actual name of the host on which the admin.html file is stored.
Step 2 On the CSRC Welcome page, click the following hypertext link to open the Administrator Login to User Registrar page (see Figure 3-1):
Log in to User Registrar Administrator
Step 3 Enter the following default administrator username and password in the Username and Password fields.
Username admin Password changeme
Step 4 Click Login. The User Registrar Home page (see Figure 3-2) appears.
Step 5 On the Home Page, click Administrators. The Manage Administrators page (see Figure 3-3) appears.
Step 6 On the Manage Administrators page, click Add Administrator. The Add Administrator page (see Figure 3-4) appears.
Step 7 On the Add Administrator page, enter the following username in the Administrator username field:
Administrator username: testuser
Step 8 Enter a description in the Description field to further identify the administrator.
Step 9 Enter the following password in the Administrator password and Confirm password fields:
Administrator password: 1234 Confirm password: 1234
Step 10 Select all of the Administrator privileges checkboxes.
Step 11 Click Add Administrator. The Confirm Addition of Administrator page (see Figure 3-5) appears.
Step 12 On the Confirm Addition of Administrator page, click Add Administrator to add the new administrator. The Manage Administrators page (see Figure 3-3) appears.
Step 13 On the Manage Administrators page, enter the testuser username in the Username field and click Search to display the new administrator.
Step 14 Click Logout. The Administrator Logout from User Registrar page (see Figure 3-6) appears.
Step 15 On the Administrator Logout from User Registrar page, click Logout again to exit from the User Registrar Administrator application. The Administrator Login to User Registrar page (see Figure 3-1) appears.
Proceed to the "Verifying Modem Registrar" section to continue verifying the CSRC installation.
To verify the Modem Registrar application, do the following:
Step 1 Enter the following URL in your browser to open the CSRC Welcome page:
http://hostname/csrc/admin.html
where hostname is the actual name of the host on which the admin.html file is stored.
Step 2 On the CSRC Welcome page, click the following hypertext link to open the Modem Registrar Login (see Figure 3-7) page:
Log in to Modem Registrar
Step 3 On the Login page, enter the following username and password in the Username and Password fields to log in as the default administrator:
Username: admin Password: changeme
Step 4 Click Login. The Main Menu page (see Figure 3-8) appears.
Step 5 On the Main Menu page, click Administrators. The Manage Administrators page (see Figure 3-9) appears.
Step 6 On the Manage Administrators page, enter the testuser username in the Username field and click Search to list the administrator you previously added using User Registrar.
Step 7 Locate the testuser username in the list of currently defined administrators and click Delete for that administrator. The Confirm Deletion of Administrator page (see Figure 3-10) appears.
Step 8 On the Confirm Deletion of Administrator page, click Delete again to remove the testuser administrator.
Step 9 On the Manage Administrators page (see Figure 3-9), click Logout to exit the Modem Registrar application.
Step 6 of the CSRC installation process is to configure your cable network for CSRC before you begin using the software. The following sections discuss example configurations for setting up Cisco Network Registrar and the uBR IOS, and describe how to change the encoded passwords in the csrc.cfg file.
The CSRC distribution media contains a Perl script and companion files that you can use to set up Cisco Network Registrar (CNR) for operation with CSRC. The /opt/csrc/conf directory on the CSRC distribution media contains the following components:
For more information, see the following guides:
Before you run the cnrConfig.pl script, you must set the CNR license key, using the following command syntax in the nrcmd program. For more information about the nrcmd program, see the Network Registrar CLI Reference Guide.
license set key=value
The CNR license key is located on the back of the CNR CD-ROM. If you downloaded CNR, an evaluation key is located on the CNR software download site.
To set the license key you must run the nrcmd program in interactive mode. For example, to set the license key to 1234 abcd 5678 efgh, enter the following:
nrcmd -C cluster1 -N admin -P aicuser nrcmd> license set key=1234-abcd-5678-efgh 100 Ok
The cnrConfig.pl script is used to configure CSRC for CNR and has the following syntax:
# perl cnrConfig.pl [-dxk] [-f cnrCfgTemplate] [-O qryOutput] [-I qryInput]
where:
-d indicates to run in debug mode and to write program trace information to stdout.
-x creates the nrcmd batch file, but does not execute it. This option indicates on stdout what the batch command line would have been had it been executed.
-k saves the generated cnrConfig.cmd file. By default, this file is deleted after the nrcmd command executes since it contains plain text password information.
-f cnrCfgTemplate indicates the path to the cnrConfig.tmpl template file. By default, the cnrConfig.pl script assumes the cnrConfig.tmpl file resides in the current directory.
-O qryOutput indicates to write the CNR configuration information you specify interactively to the file specified in qryOutput.
-I qryInput indicates to read needed information from the file specified in qryInput instead of querying you interactively for the information.
For more information about the cnrConfig.pl script options, see the following sections.
The -f cnrCfgTemplate option indicates the path to the CNR configuration data template file. The cnrCfgTemplate argument must specify the path. The default is the cnrConfig.tmpl file in the current directory.
The generated and updated template file resides in the specified directory portion of the pathname or in the default directory location if this option is not specified. In all cases, the name of the generated CNR batch file is cnrConfig.cmd.
The -O qryOutput option writes the CNR configuration information you entered to the file specified in qryOutput. This allows you to subsequently execute the cnrConfig.pl script without requiring your input. It also provides a record of the nrcmd transaction. Cisco recommends that you execute the cnrConfig.pl script with the -O option specified if you intend to interactively provide answers to the script's questions.
You can choose to simply create a file manually instead of using the -O qryOutput option. If you do, you must provide the answers in the order in which the script asks the questions. For more information, see "The cnrConfig.pl Script Operation" section.
 | Caution The file you specify in qryOutput will contain plain text passwords. Be sure to protect the file after it is created. |
The -I qryInput option reads needed information from the file specified in qryInput instead of prompting you for it. You can create this file using the -O qryOutput option when you interactively execute the cnrConfig.pl script, or you can create the file manually.
If you create the qryInput file manually, you must provide the answers to the script's questions in the following format:
The following are examples of valid tokens:
validToken | # valid data and comment |
"Good Value" | # quoted valid white space |
"C:\A Good\Value Combo\" | # quoted valid white space |
1.2.3.4.5.6.7.8 | # valid multi-valued data |
The following are examples of invalid tokens:
Bad Value | # must quote tokens with valid white space |
"C:\A Bad Value" | # invalid white space |
C:\"Also Bad" | # must quote the entire token |
The cnrConfig.pl script first prompts for the following information about your CSRC installation in the order specified:
You can choose to specify this information interactively or non-interactively using an input file. In interactive mode, you enter the needed information when the cnrConfig.pl script prompts you for it. You can enter ? to display a brief description of the desired information before you enter a value. After you finish entering the needed information, the cnrConfig.pl script displays all of the values you entered for your verification. You can then accept the values or abort the program, leaving CNR configuration unchanged.
In non-interactive mode, the cnrConfig.pl script reads the values for needed information from an input file. In this case, the cnrConfig.pl script does not allow you to verify the values or abort any changes to the CNR configuration. For more information, see the "-O qryOutput" section and the "-I qryInput" section.
After the cnrConfig.pl script gathers the needed information, it does the following:
1. Parses the associated cnrConfig.tmpl template file (see the "The cnrConfig.tmpl Template File" section), replacing template tokens found in the cnrConfig.tmpl file with the associated values provided during the query phase.
2. Generates a CNR batch file called cnrConfig.cmd. This file resides in the directory specified by the -f option. If the -f option is not specified, the file resides in the current directory. The cnrConfig.cmd file is deleted by default. Use the -k option to save it.
3. Invokes the nrcmd command to run the CNR commands specified in the cnrConfig.cmd file.
4. Redirects stdout to store the results of the batch nrcmd session in a file called cnrConfigResults.out. This file resides in the same directory as the cnrConfig.cmd file, specified by the -f option.
The cnrConfig.pl script has the following limitations:
The cnrConfig.tmpl template file is a companion file on which the cnrConfig.pl script operates. The cnrconfig.tmpl file is actually a collection of CNR (nrcmd) commands. The file contains template tokens with the following format:
<<keyword>>
where <<keyword>> is an exact match for the name field of one of the cnrData hash elements defined at the beginning of the cnrConfig.pl script. A template token must match the value of one of the hash entries in the script file. If not, the script displays an error message, indicating the template token in error and its line number in the cnrConfig.tmpl file. The cnrConfig.pl script then aborts.
You can modify the default cnrconfig.tmpl file as desired. However, if you modify, add, or delete token templates, then you must also make the associated modifications to the cnrData associative array in the cnrConfig.pl script and to the ordering of these hash nodes in the sortedData array, if necessary. For information about making these modifications, see the cnrConfig.pl script.
The cnrConfig.tmpl file has the following limitations:
The CSRC distribution media contains an example configuration for the CableLabs uBR. This example configuration is available in the ubr-config.txt file in the distribution media's /opt/csrc/conf directory.
The passwords stored in the csrc.cfg file are encoded. If you change the LDAP or Cisco Network Registrar (CNR) password for the account that CSRC uses, you must update the password in the csrc.cfg file on each CSRC server host on which the file is present. To do this, you must first encode the password, using the csrcencode utility in the /opt/csrc/bin directory.
To encode a password, enter the following command:
# <csrc_install_dir>/bin/csrcencode password encoded password
where password is the password you want to encode and encoded password is the encoded password string that results from the command's execution.
After you encode the new password, you can copy the encoded password string and insert it into the csrc.cfg file in place of the previous password string.
Posted: Mon Sep 25 12:35:22 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.