Configuring CMTS Option Sets

CMTS User Interface Pages

Selecting CMTS Option Sets to Configure

Listing CMTS Option Sets

Managing CMTS Option Sets

Adding CMTS Option Sets

Cloning CMTS Option Sets

Modifying CMTS Option Sets

Deleting CMTS Option Sets

Listing CMTS Options

Managing CMTS Options

Tips for Using the Edit CMTS Options Page

Adding CMTS Options

Cloning CMTS Options

Modifying CMTS Options

Deleting CMTS Options

Configuring CMTS Option Sets

You can use the Modem Registrar user interface to define and configure Cable Modem Termination System (CMTS) option sets as described in this chapter. The CMTS option set contains DOCSIS options that apply to a specific CMTS. Modem Registrar requires that you create CMTS options sets; however, you are not required to define DOCSIS options for the sets.

You can choose to associate the CMTS option set with a CMTS group option set that contains the applicable DOCSIS options. For more information, see the "Option Set Scopings" section.

CMTS User Interface Pages

Figure 8-1 shows the hierarchy of the user interface pages used to configure the CMTS option set.

Figure 8-1: Hierarchy of CMTS Option Set Pages

Selecting CMTS Option Sets to Configure

You can use the Configure Option Sets page (see Figure 8-2) to select the option set(s) you want to configure.

Figure 8-2: Configure Option Sets Page

To configure and list the CMTS option sets, click CMTS. The CMTS Option Set List page appears.

Listing CMTS Option Sets

You can use the CMTS Option Set List page (see Figure 8-3) to list all of the CMTS option sets currently defined.

Figure 8-3: CMTS Option Set List Page

To list the CMTS option sets currently defined, do the following:

Step 1 Log in to Modem Registrar.

Step 2 On the Main Menu page, click Option Sets.

Step 3 On the Configure Option Sets page, click CMTS. The CMTS Option Set List page appears, listing all of the CMTS option sets currently defined.

Managing CMTS Option Sets

You can use the CMTS Option Set List page (see Figure 8-3) to access the user interface pages used to do the following:

Add a new CMTS option set
Copy an existing CMTS option set and add the cloned option set
Modify a CMTS option set
Remove a CMTS option set

Adding CMTS Option Sets

You can use the Add CMTS Option Set page (see Figure 8-4) to define a new CMTS option set.

Figure 8-4: Add CMTS Option Set Page

To add a CMTS option set, do the following:

Step 1 Log in to Modem Registrar.

Step 2 On the Main Menu page, click Option Sets.

Step 3 On the Configure Option Sets page, click CMTS.

Step 4 On the CMTS Option Set List page, click Add Option Set.

Step 5 On the Add CMTS Option Set page, enter the name of the new CMTS option set in the CMTS Option Set Name field. This name must be unique.

For example: abacus.cisco.com

Step 6 Select the CMTS group from the CMTS Group pull-down list with which you want to associate the new CMTS option set. This field is optional.

If you do not want to associate the new CMTS option set with a CMTS group, select <none> in the CMTS Group pull-down list.

Step 7 Set the DOCSIS version by doing one of the following. You must specify the DOCSIS version either in this CMTS option set or in the CMTS group option set with which it is associated.

To set the DOCSIS version in the CMTS option set, select the DOCSIS version you are using from the CMTS DOCSIS Version pull-down list. The default is DOCSIS version 1.0.
To use the DOCSIS version set in the CMTS group option set with which this CMTS option set is associated, select Use Group DOCSIS Version in the CMTS DOCSIS Version pull-down list. You must have selected a CMTS group in the CMTS Group field and the CMTS group option set must have a DOCSIS version specified.

: If you selected <none> in the CMTS Group field, or you did not specify a DOCSIS version in the CMTS group option set, an error message appears indicating that group settings cannot be used when a group is not specified.

Note A built-in scoping of option sets defines the options that must be included or excluded from a generated configuration file for a specific DOCSIS version. The mandatory options set in more specific option sets may override mandatory

options in the built-in option set. However, the mandatory options cannot be suppressed. The TFTP server assembles only those options appropriate for the particular cable modem.

Step 8 Set a shared secret by doing one of the following. You must specify a shared secret either in this CMTS option set or in the CMTS group option set with which it is associated. The CMTS uses the shared secret to verify that the file was not tampered with and that a trusted TFTP server sent it.

To use the shared secret set in the CMTS group option set with which this CMTS option set is associated, select the Use Group Secret radio button.

: You must have selected a CMTS group in the CMTS Group field and the CMTS group option set must have a shared secret specified. If you selected <none> in the CMTS Group field, or you did not specify a shared secret in the CMTS group option set, an error message appears indicating that group settings cannot be used when a group is not specified.

To use the null string as the shared secret, select the Secret is Null String radio button.
To set a shared secret in
this CMTS option set, do the following:
- Select the Secret Specified Below radio button.
- Enter the shared secret in the Type and Retype fields.

: You must enter the shared secret identically in the Type and Retype fields. If you do not, an error message appears indicating that the shared secret must be entered the same way twice.

Step 9 Click OK to add the new option set.

If the CMTS option set name is unique and all of the other fields are valid, the new option set is added. The CMTS Option Set List page appears.

If any information in the fields is invalid, a message appears asking you to correct the invalid information.

Step 10 If you want to assign options to the new CMTS option set, see the "Adding CMTS Options" section.

Cloning CMTS Option Sets

You can use the Clone CMTS Option Set page (see Figure 8-5) to create a new CMTS option set using the settings of an existing CMTS option set.

Figure 8-5: Clone CMTS Option Set Page

To clone a CMTS option set, do the following:

Step 1 Log in to Modem Registrar.

Step 2 On the Main Menu page, click Option Sets.

Step 3 On the Configure Option Sets page, click CMTS.

Step 4 On the CMTS Option Set List page, click Clone Option Set.

Step 5 On the Clone CMTS Option Set page, select the CMTS option set that you want to copy from the Clone from Option Set pull-down list. This list contains the names of all of the CMTS option sets currently defined.

Step 6 Enter the name of the CMTS option set you are creating in the Clone to Option Set field. This name must be unique.

Step 7 Enter the description for the new CMTS option set in the Description field to further identify it. This field is optional. You can choose to leave this field blank.

Step 8 Click OK to add the new option set.

If the CMTS option set name you entered and all of the information in the other fields are valid, the new CMTS option set is added and the CMTS Option Set List page appears.

If any of the information is invalid, a message appears asking you to correct the invalid information.

Step 9 To modify the cloned option set, see the "Modifying CMTS Option Sets" section.

Note

Modifying CMTS Option Sets

You can use the Edit CMTS Option Set page (see Figure 8-6) to do the following:

Change the CMTS group with which the CMTS option set is associated
Change the DOCSIS version applied to the option set
Change the shared secret that the CMTS uses
Modify the description of the CMTS option set
Modify the default neighborhood
Access the user interface page used to modify CMTS options

Note A neighborhood provides a means of grouping computers, and contains shared settings that affect the provisioning of subscribers. A neighborhood may also administer to one or more shared cable modems. You can use the User Registrar application to create neighborhood objects. For more information, see the User Registrar User's Guide.

Figure 8-6: Edit CMTS Option Set Page

To modify the CMTS option set, do the following:

Step 1 Log in to Modem Registrar.

Step 2 On the Main Menu page, click Option Sets.

Step 3 On the Configure Option Sets page, click CMTS.

Step 4 On the CMTS Option Set List page, locate the CMTS option set you want to modify in the list of option sets and click its hypertext link.

Step 5 On the Edit CMTS Option Set page, modify the option set as desired by doing the following:

To change the CMTS group option set with which this CMTS option set is associated, select a CMTS group from the Edit CMTS Group pull-down list. The pull-down list displays the CMTS group option sets currently configured. You can select <none>.

To change the DOCSIS version the option set uses, select the DOCSIS version from the Edit CMTS DOCSIS Version pull-down list. The default is DOCSIS version 1.0.

: To use the DOCSIS version set in the CTMS group option set with which this CMTS option set is associated, select Use Group DOCSIS Version in the pull-down list. You must have selected a CMTS group in the CMTS Group field and the CMTS group option set must have a DOCSIS version specified. If you selected <none> in the CMTS Group field, or you did not specify a DOCSIS version in the CMTS group option set, an error message appears indicating that the group settings cannot be used when a group is not specified.
: You must specify a DOCSIS version either in the CMTS group option set or in the CMTS option set.

Note A built-in scoping of option sets defines the options that must be included or excluded from a generated configuration file for a specific DOCSIS version. Settings for

mandatory options

in less specific option set scopings can override the mandatory options in the built-in option set. However, the mandatory options cannot be suppressed. The TFTP server assembles only those options appropriate for the particular cable modem.

To change the shared secret, do one of the following:
- To use the shared secret set in the CMTS group option set with which this CMTS option set is associated, select the Use Group Secret radio button. You must have selected a CMTS group in the CMTS Group field and the CMTS group option set must have a shared secret specified. If you selected <none> in the CMTS Group field, or you did not specify a shared secret in the CMTS group option set, an error message appears indicating that group settings cannot be used when a group is not specified.
- To use the null string as the shared secret, select the Secret is Null String radio button.
To modify the description of the CMTS option set, edit the description in the Edit Description field.
To modify the default neighborhood, select a neighborhood object from the Edit Default Neighborhood pull-down list. Setting a default neighborhood is optional, and the selection defaults to <none>.

Step 6 Click OK to save the changes you made to the fields on this page. The CMTS Option Set List page appears.

Step 7 To modify the options assigned to this CMTS option set, see the "Modifying CMTS Options" section.

Deleting CMTS Option Sets

You can use the Edit CMTS Option Set page (see Figure 8-6) to remove a CMTS option set.

To remove a CMTS option set, do the following:

Step 1 Log in to Modem Registrar.

Step 2 On the Main Menu page, click Option Sets.

Step 3 On the Configure Option Sets page, click CMTS.

Step 4 On the CMTS Option Set List page, locate the CMTS option set you want to remove in the list of option sets and click its hypertext link.

Step 5 On the Edit CMTS Option Set page, check the name of the CMTS option set displayed just below the Navigation Bar and verify that you selected the correct CMTS option set.

Step 6 Click Delete Option Set to remove the option set. A confirmation message appears asking you if you want to remove the option set. Click Yes or No as appropriate.

Listing CMTS Options

You can use the List CMTS Options page (see Figure 8-7) to list all of the options currently defined in a CMTS option set for all service types and levels.

Figure 8-7: List CMTS Options Page

To list all of the CMTS options in an option set, do the following:

Step 1 Log in to Modem Registrar.

Step 2 On the Main Menu page, click Option Sets.

Step 3 On the Configure Option Sets page, click CMTS.

Step 4 On the CMTS Option Set List page, locate the option set containing the options you want to list and click its hypertext link.

Step 5 On the Edit CMTS Option Set page, click List All Options. The List CMTS Options page appears, listing all of the CMTS options defined for this option set.

Note For information about the fields and buttons on this page, see the online Help page or the

"Tips for Using the Edit CMTS Options Page" section

Step 6 After you are finished viewing the CMTS options, click OK. The Edit CMTS Option Set page appears.

Managing CMTS Options

You can use the Edit CMTS Options page (see Figure 8-8) to do the following:

Add new options to the CMTS option set
Copy an existing option and add the cloned copy to the CMTS option set
Modify the DOCSIS options currently defined in the CMTS option set
Remove options from the CMTS option set

Figure 8-8: Edit CMTS Options Page

Tips for Using the Edit CMTS Options Page

Refer to the following information when using the Edit CMTS Options page. For more information, see the online Help page.

To view the DOCSIS specification for an option, click for that option.
To hide the suboption values of compound options, click Shrink.

: When you click Shrink, the Edit CMTS Options page redisplays and the suboption values are not visible. The Shrink button then changes to Expand.

To display the suboption values of compound options, click Expand.

: When you click Expand, the Edit CMTS Options page redisplays and the suboption values are visible. The Expand button then changes to Shrink.

Adding CMTS Options

You can use the Edit CMTS Options page (see Figure 8-8) to define options for a CMTS option set.

To add a CMTS option, do the following:

Step 1 Log in to Modem Registrar.

Step 2 On the Main Menu page, click Option Sets.

Step 3 On the Configure Option Sets page, click CMTS.

Step 4 On the CMTS Option Set List page, locate the CMTS option set to which you want to add an option and click its hypertext link.

Step 5 On the Edit CMTS Option Set page, do one of the following:

If the CMTS option you are adding applies to all service types and levels, click Common Options .
If the CMTS option you are adding applies to a specific service type and level, select a service type from the Service Type pull-down list and click Type/Level Options .

Note

Type/Level Options

Step 6 On the Edit CMTS Options page, select a discrete option number from the Add Option pull-down list and click Add Option. The Edit CMTS Options page redisplays with the new option listed.

Note

Step 7 In the Value field for the new option, enter the value you want to assign to the option. You must specify a value for simple options. For compound options, you must specify a value for at least one of the suboptions, but you can choose to leave some of them blank.

Step 8 Click OK to save the new option.

If the information in all of the fields is valid, the Edit CMTS Options page redisplays with the new option added.

If any of the information is invalid, a message appears asking you to correct the invalid information.

Cloning CMTS Options

You can use the Edit CMTS Options page (see Figure 8-8) to clone a multi-instance compound option. Cloning an option copies and adds an exact copy of a compound option and all of its suboptions to the CMTS option set. You can clone only multi-instance compound options. For more information, see the "Single-Instance and Multi-Instance Options" section.

To clone a multi-instance compound option, do the following:

Step 1 Log in to Modem Registrar.

Step 2 On the Main Menu page, click Option Sets.

Step 3 On the Configure Option Sets page, click CMTS.

Step 4 On the CMTS Option Set List page, locate the CMTS option set to which you want to clone an option and click its hypertext link.

Step 5 On the Edit CMTS Option Set page, do one of the following:

To clone a compound option that applies to all service types and levels, click Common Options.
To clone a compound option that applies to a specific service type and level, select a service type from the Service Type pull-down list and click Type/Level Options.

Note

Type/Level Options

Step 6 On the Edit CMTS Options page, locate the compound option you want to clone and click Clone for that option.

Note

Step 7 Click OK to save the cloned option and its suboptions.

If the information in all of the fields is valid, the Edit CMTS Option Set page appears.

If any of the information is invalid, a message appears asking you to correct the invalid information.

Step 8 Modify the cloned option as desired. For more information, see the "Modifying CMTS Options" section.

Note

Modifying CMTS Options

You can use the Edit CMTS Options page (see Figure 8-8) to modify an option in a CMTS option set.

To modify a CMTS option, do the following:

Step 1 Log in to Modem Registrar.

Step 2 On the Main Menu page, click Option Sets.

Step 3 On the Configure Option Sets page, click CMTS.

Step 4 On the CMTS Option Set List page, locate the name of the CMTS option set containing the option you want to modify and click its hypertext link.

Step 5 On the Edit CMTS Option Set page, do one of the following:

To modify an option that applies to all service types and levels, click Common Options.
To modify an option that applies to a specific service type and level, select a service type from the Service Type pull-down list and click Type/Level Options.

Note

Type/Level Options

Step 6 On the Edit CMTS Options page, locate the option number you want to modify and do the following:

To change the value assigned to the option, edit the value in the Value field. You must specify a value for simple options. For compound options, you must specify a value for at least one of the suboptions, but you can choose to leave some of them blank.

To change the rule to be used in applying the option, select a rule from the Rule pull-down list. The rules listed in the Rule pull-down list apply only to multi-instance options and apply to all instances of the option.

Select Replace to discard the previous option and replace it with the option associated with the rule.

Select Append to retain the previous option and add to it the option associated with the rule.

Note

To add the suppress rule to a multi-instance option, select the discrete option number from the Suppress pull-down list and click Suppress Option. The page redisplays, showing the new suppress rule.

Note The suppress

rule prevents option values of more specific scopings (such as vendor option sets) from being used. This rule applies only to multi-instance options. The Suppress Option pull-down list displays the options for the option set. The list does not contain options for which a suppress rule is already specified.

Step 7 Click OK to save the changes you made to the fields on this page.

If the information in all of the fields is valid, the Edit CMTS Options page redisplays with the changes visible.

If any of the information is invalid, a message appears asking you to correct the invalid information.

Deleting CMTS Options

You can use the Edit CMTS Options page (see Figure 8-8) to remove an option from a CMTS option set.

To remove a CMTS option, do the following:

Step 1 Log in to Modem Registrar.

Step 2 On the Main Menu page, click Option Sets.

Step 3 On the Configure Option Sets page, click CMTS.

Step 4 On the CMTS Option Sets List page, locate the name of the CMTS option set containing the CMTS option you want to remove and click its hypertext link.

Step 5 On the Edit CMTS Option Set page, do one of the following:

To remove an option that applies to all service types and levels, click Common Options.
To remove an option that applies to a specific service type and level, select a service type from the Service Type pull-down list and click Type/Level Options.

Note

Type/Level Options

Step 6 On the Edit CMTS Options page, locate the option you want to remove and click Delete for that option. A confirmation message appears asking you if you want to remove the option. Click Yes or No as appropriate.

Click Yes to remove the option. If it is a compound option, all of its suboptions are also removed.

Click No to leave the option unchanged.

Table of Contents

Configuring CMTS Option Sets