Broadband Access Center for Cable Support Tools and Advanced Concepts

Transcription

1 CHAPTER 12 Broadband Access Center for Cable Support Tools and Advanced Concepts This chapter contains information on, and explains the use of, tools that help you maintain Broadband Access Center for Cable (BACC) as well as speed and improve the installation, deployment, and use of this product. This chapter discusses these topics: Developing Template Files, page 12-1 Using the Configuration File Utility, page The RDU Log Level Tool, page Using the PKCert.sh Tool to Manage KDC Certificates, page Using the changenrproperties.sh Tool, page Using the Keygen Tool, page Using the snmpagentcfgutil.sh Command, page Using the disk_monitor.sh Tool to Monitor Available Disk Space, page Troubleshooting Devices by MAC Address, page Note This section contains many examples of tool use. In many cases, the tool filenames include a path specified as <BACC_HOME>. This indicates the default directory location. Developing Template Files BACC uses templates to help administrators deploy dynamic PacketCable, DOCSIS, and CableHome files. Using templates, you can create a template file in an easily readable format, and edit it quickly and simply. A template is an ASCII text file that represents the PacketCable, DOCSIS, or CableHome options and values used for generating a valid PacketCable, DOCSIS, or CableHome file. BACC uses the.tmpl file extension to identify template files. You must add template files to the RDU as an external file using either the administrator s user interface or the API, before any class of service can reference it. When installing the BACC RDU component, several sample template files are copied to the <BACC_HOME>/rdu/samples directory. 12-1

2 Developing Template Files Chapter 12 Although all that you need to create or edit a template is a simple text editor, before attempting to create your own template file, you should thoroughly familiarize yourself with this information: BACC provisioning flows DOCSIS 1.0, 1.1, and 2.0 RFI specifications PacketCable 1.0 and 1.1 specifications MTA device provisioning specification CableHome 1.0 specification SNMP MIBs for cable devices (for example, DOCS-CABLE-DEVICE-MIB) Template Grammar A template is comprised of four different types of statements: Comments, page 12-3 Includes, page 12-3 Options, page 12-3 Instance Modifier, page 12-5 Comments allow you to document your templates. Includes allow you to create building block templates to be used in other templates. Options allow you to specify the PacketCable, DOCSIS, or CableHome type length value (TLV) in a descriptive manner. Table 12-1 describes the available template grammar options. Table 12-1 Template Grammar Option <comment> <include> <option-description> <option-num> <option-value> <well-defined-value> <custom-value> <ascii-value> <hex-value> <ip-value> <instance-num> <template> <template-statement> <snmp-value> Description ::= #[ascii-string] ::= include <filename.tmpl> ::= option <option-num> [instance <instance-num>] <option-value> ::= <unsigned-byte>[.<unsigned-byte>]* ::= <well-defined-value> <custom-value> ::= <option-value-string>[,<option-value-string>]* ::= <ascii-value> <hex-value> <ip-value> <snmp-value> ::= ascii <ascii-string> ::= hex <hex-string> ::= ip <ip-string> ::= <unsigned integer> ::= <template-statement>* ::= <comment> <include> <option-description> ::= snmp <snmpvar-oid>,<snmpvar-type>,<snmpvar-value> 12-2

3 Chapter 12 Developing Template Files Comments Comments provide information only and are always located between the pound (#) symbol and the end of a line. Example 12-1 shows example comment usage. Example 12-1 Example Comment Usage # # Template for gold service # option 3 1 # enabling network access Includes Include files let you build a hierarchy of similar, but slightly different, templates. This is very useful for defining options that are common across many service classes without having to duplicate the options in several templates. You can use multiple include statements in a single template although the location of the include statement in the template is significant; the contents of the include file are included wherever the include statement is found in the template. The included template must be added as an external file to the RDU before it can be used. The included file must not contain any location modifiers such as../.. because the templates are stored without path information in the RDU database. Examples 12-2 and 12-3 illustrate both correct and incorrect usage of the include option. Example 12-2 Correct Include Statement Usage # Valid, including common options include "common_options.tmpl" Example 12-3 Incorrect Include Statement Usage # Invalid, using location modifier include "../common_options.tmpl" # Invalid, using incorrect file suffix include "common_options.common" # Invalid, not using double quotes include common_options.tmpl Options PacketCable, DOCSIS, and CableHome configuration files consist of properly encoded option id-value pairs. Two forms of options are supported: defined and custom. Well-defined options require the option number and value. The value is encoded based on the encoding type of the option number. Custom options require the option number, explicit value encoding type, and the value. When using compound options, for example, option 43, you can use the instance modifier to specify the TLV groupings. See the Instance Modifier section on page 12-5 for additional information. 12-3

4 Developing Template Files Chapter 12 When specifying one of these well-defined options in a template, it is not necessary to specify a value encoding for the value. See the Encoding Types for Defined Options section on page 12-8 and the DOCSIS Option Support section on page for additional information on these defined encoding types. When specifying custom options (e.g. option 43), you must specify the encoding type for the option. The available encoding types are: ASCII ASCII type encodes any given value as an ASCII string without a NULL terminator. If the value contains spaces, they must be double quoted. hex The value must be valid hexadecimal and there must be exactly 2 characters for each octet. If 01 is specified as the value, then exactly one octet is used in the encoding. If 0001 is specified as the value, then exactly two octets are used in the encoding process. IP address IP address type encodes any given value as 4 octets. For example, the IP address is encoded as 0A0A0A01. Use a comma to separate multi-valued options on a given line. Each value is treated as such, so you might have to double quote one of the values, but not the others. A good example of a multi-valued option is Option 11 (SNMP Varbind). See the SNMP Varbind section on page 12-5 for additional information. When specifying compound options, there is no need to specify the top level option (for example option 4 when specifying option 4.1). Examples 12-4 and 12-5 illustrate both correct and incorrect usage of the option statement. Example 12-4 Correct Option Statement Usage # Valid, specifying the number for well known option 3 option 3 1 # Valid, specifying the number for option 4 sub-option 1 option # Valid, specifying a vendor option as hex option hex 00000C # Valid, specifying a vendor option as ascii option ascii "enable log" # Valid, specifying a vendor option as IP option ip Example 12-5 Incorrect Option Statement Usage # Invalid, using hex with incorrect hex separator option hex C # Invalid, not using double quotes when needed option ascii enable log # Invalid, not specifying IP address correctly option ip # Invalid, specifying the description for option "Network Access Control" option "Network Access Control" 1 # Invalid, specifying top level option option

5 Chapter 12 Developing Template Files Instance Modifier The instance modifier is used to group compound options into specific individual Tag-Length-Values (TLVs). Examples 12-6 and 12-7 illustrate both correct and incorrect methods of creating separate TLVs. These are required to enable the IOS DOCSIS modem to interpret the IOS commands as two separate commands. Example 12-6 Correct IOS Command Line Entries # Valid, each IOS command gets its own TLV option 43.8 instance C option instance 1 ascii "login" option 43.8 instance C option instance 2 ascii "password cable" Example 12-7 Incorrect IOS Command Line Entries # Invalid, IOS commands are grouped into one TLV option C option ascii "login" option ascii "password cable" # Invalid, using instance on non-compound options option 3 instance 1 1 Note The encoding type for option 43.8 is an organizationally unique identifier (OUI). Unlike that shown in Example 12-4, this only accepts an C format. SNMP Varbind DOCSIS MIBs You must use an object identifier (OID), when specifying DOCSIS option 11, PacketCable option 64, or CableHome option 28. The MIB that contains the OID must be in one of the following MIBs loaded by the RDU. You must specify as much of the OID as needed to uniquely identify it. You can use the name or the number of the OID. The RDU automatically loads these MIBs: SNMPv2-SMI SNMPv2-TC CISCO-SMI CISCO-TC SNMPv2-MIB RFC1213-MIB IANAifType-MIB IF-MIB These DOCSIS MIBs are loaded into the RDU: DOCS-IF-MIB DOCS-BPI-MIB 12-5

6 Developing Template Files Chapter 12 CISCO-CABLE-SPECTRUM-MIB CISCO-DOCS-EXT-MIB SNMP-FRAMEWORK-MIB DOCS-CABLE-DEVICE-MIB DOCS-CABLE-DEVICE-MIB-OBSOLETE CISCO-CABLE-MODEM-MIB Two versions of the DOCS-CABLE-DEVICE MIB are loaded into the RDU: DOCS-CABLE-DEVICE-MIB-OBSOLETE (experimental branch) DOCS-CABLE-DEVICE-MIB (mib2 branch) A fully-qualified MIB OID (.experimental...) always uniquely identifies a MIB OID. If you use a non-fully qualified MIB OID from DOCS-CABLE-DEVICE-MIB, it will always default to DOCS-CABLE-DEVICE-MIB and not DOCS-CABLE-DEVICE-MIB-OBSOLETE. Examples 12-8 and 12-9 illustrate using a fully-qualified MIB OID and a non-fully qualified MIB OID. Example 12-8 Fully Qualified MIB OID # Valid, uniquely identifying an OID option 11.experimental.docsDev.docsDevMIBObjects.docsDevNmAccessTable.docsDevNmAccess Entry.docsDevNmAccessStatus.1, Integer, 4 Example 12-9 Non-Fully Qualified MIB OID (Defaults to DOCS-CABLE-DEVICE-MIB) # Valid, Non-Fully Qualified MIB OID. option 11.docsDevNmAccessStatus.1, Integer, 4 If no DOCSIS CMs in a deployment require DOCS-CABLE-DEVICE-MIB-OBSOLETE, you can always use the shorter form of the MIB OID. PacketCable MIBs CableHome MIBs These PacketCable (North American) MIBs are loaded into the RDU: CLAB-DEF-MIB PKTC-MTA-MIB PKTC-SIG-MIB PKTC-EVENT-MIB These CableHome MIBs are loaded into the RDU: CABH-CAP-MIB CABH-CDP-MIB CABH-CTP-MIB CABH-PS-DEV-MIB 12-6

7 Chapter 12 Developing Template Files CABH-QOS-MIB CABH-SEC-MIB These additional MIBs are needed but are not part of the BACC product: CABH-CTP-MIB needs RMON2-MIB, TOKEN-RING-RMON-MIB CABH-SEC-MIB needs DOCS-BPI2-MIB. Macro Variables Macro variables are specified as values in templates that let you specify device-specific option values. When a macro variable is encountered in the template, the properties hierarchy is searched for the macro variable name and the value of the variable is then substituted. The variable name is a custom property, which is predefined in the RDU. It must not contain any spaces. Note When you use custom properties for macro variables, you must use DataType.STRING. After the custom property is defined, it can be used in this property hierarchy: System defaults Technology defaults, such as PacketCable, DOCSIS, or CableHome DHCP criteria properties Class of service properties Device properties The template parser works bottom up when locating properties in the hierarchy (device first, then the class of service, and so on) and converts the template option syntax. The following syntax is supported for macro variables: ${var-name} This syntax is a straight substitution. If the variable is not found, the parser will generate an error. ${var-name, ignore} This syntax lets the template parser ignore this option if the variable value is not found in the properties hierarchy. ${var-name, default-value} This syntax provides a default value if the variable is not found in the properties hierarchy. Examples and illustrate both correct and incorrect usage of option 11. Example Correct Macro Variables Usage # Valid, using macro variable for max CPE's, straight substitution option 18 ${MAX_CPES} # Valid, using macro variable for max CPE's, ignore option if variable not found # option 18 will not be defined in the DOCSIS configuration file if MAX_CPES # is not found in the properties hierarchy option 18 ${MAX_CPES, ignore} # Valid, using macro variable for max CPE's with a default value option 18 ${MAX_CPES, 1} 12-7

8 Developing Template Files Chapter 12 # Valid, using macro variable for vendor option option hex ${MACRO_VAR_HEX} # Valid, using macro variable for vendor option option ascii ${MACRO_VAR_ASCII} # Valid, using macro variable for vendor option option ip ${MACRO_VAR_IP} # Valid, using macro variable in double quotes option 18 "${MAX_CPES}" # Valid, using macro variable within a value option ascii "hostname ${HOSTNAME}" # Valid, using macro variables in multi-valued options option 11 ${ACCESS_CONTROL_MIB,.mib-2.docsDev.docsDevMIBObjects.docsDevNmAccessTable.docsDevNmAccessEntry.docsDevNmAccess Control.1}, Integer, ${ACCESS_CONTROL_VAL, 3} # Valid, using macro variable in an include statement include "${EXTRA_TEMPLATE}" # Valid, using macro variable in an include statement with a default value include "${EXTRA_TEMPLATE, modem_reset.tmpl}" # Valid, using macro variable in an include statement with a default value include "${EXTRA_TEMPLATE, modem_reset}.tmpl" # Valid, using macro variable in an include statement with an ignore clause include "${MY_TEMPLATE, ignore}" Example Incorrect Macro Variables Usage # Invalid, using macro variable as the option number option ${MAX_CPES} 1 # Invalid, using macro variable with space in name option 18 ${MAX CPES} Encoding Types for Defined Options Table 12-2 identifies the options with defined encoding types. Table 12-2 Defined Option Encoding Types Encoding Input Example Boolean 0 for false and 1 for true. 0 Bytes A series of hexadecimal octets. Each octet must be exactly 2 characters in length. IP Address Four unsigned integer 8, dot (.) separated Multiple IP Addresses Comma separated list of IP addresses , MAC Address Six hexadecimal octets colon (:) or dash (-) separated. Each octet must be exactly 2 characters in length. Colons and dashes must not be mixed. 00:01:02:03:04:05 or

9 Chapter 12 Developing Template Files Table 12-2 Defined Option Encoding Types (continued) Encoding Input Example MAC Address And Mask Twelve octets colon (:) or dash (-) separated. Each octet must be exactly 2 characters in length. Colons and dashes must not be mixed. The first six octets represent 00:01:02:03:04:05:06:07:08:09:0A:0B or A-0B the MAC address; the last six represent the mask for the MAC address. NVTASCII An ASCII string. The encoded string will not be NULL terminated. This is an ASCII string OID An SNMP OID string. sysinfo.0 OIDCF OUI SNMPVarBind Sub Type An SNMP OID string and an unsigned integer (0 or 1) comma separated. Three hexadecimal octets colon (:) or dash (-) separated. Each octet must be exactly 2 characters in length. An SNMP OID string, type, and value. Each of these is comma separated. Valid types are: BITS Counter Counter Counter64 Gauge Gauge INTEGER Integer IpAddress OCTETSTRING OBJECTIDENTIFIER Opaque TimeTicks Unsigned Note The OCTETSTRING can be either a string that will be converted to hexadecimal notation without a trailing NULL, octet string for example, or hexadecimal notation contained in single quotes, 'aa:bb:cc' for example. One or two comma separated unsigned integer 8. sysinfo.0, C.experimental.docsDev.docsDevMIBObjects. docsdevnmaccesstable.docsdevnmaccessent ry.docsdevnmaccessstatus.1, INTEGER, 4 12 or 12,

10 Developing Template Files Chapter 12 Table 12-2 Defined Option Encoding Types (continued) Encoding Input Example 8 0 to to to and unsigned integer BITS Value Syntax One unsigned integer 8 and one unsigned integer, comma separated. 3,124 8 pair Two unsigned integer 8, comma separated. 1,3 8 triplet Three unsigned integer 8, comma separated. 1,2,3 ZTASCII An ASCII string. The encoded string will be NULL terminated. This is an ASCII string When using the BITS type, you must specify either the labels ( interval1 interval2 interval3 ) or numeric bit location ( ). Note that label values are 1-based and bit values are 0-based. This is the syntax that uses the bit numbers: option 11.pktcSigDevR0Cadence.0,STRING," " This is the syntax for the customer octet string (FFFE ) that uses the labels: option 11.pktcSigDevR0Cadence.0,STRING,"interval1 interval2 interval3 interval4 interval5 interval6 interval7 interval8 interval9 interval10 interval11 interval12 interval13 interval14 interval15" OCTETSTRING Syntax The OCTETSTRING can be either a string that is converted to hexadecimal notation without a trailing NULL (for example, octet string), or hexadecimal notation contained within single quotes, (for example, 'aa:bb:cc' ). Adding SNMP TLVs Without a MIB You can add SNMP TLVs in dynamic configuration files (DOCSIS, PacketCable, CableHome) without requiring the MIB be loaded by the RDU. From within RDU configuration extensions, the functionality can be accessed with the DOCSISOptionFactory interface, using the following method: public OptionValue createoptionvalue(optionsyntax syntax, String optionnumstr, String[] optionvaluelist) The public OptionSyntax.SNMP enumerated value can be used in the above method, in conjunction with the optionvaluelist containing the tuple: OID, Type, Value. From RDU dynamic configuration templates, the following syntax is used to specify SNMP TLVs that are not validated against the RDU MIBs: option <option-number> snmp <OID>, <Type>, <Value> 12-10

11 Chapter 12 Developing Template Files Examples: # DOCS-CABLE-DEVICE-MIB: option 11 snmp.docsdevnmaccessip.1,ipaddress, # Arris vendor specific SNMP TLV (OID numbers only, mix names/numbers) option 11 snmp , INTEGER, 6 option 11 snmp.enterprises , INTEGER, 6 # NOTE: trailing colon required for single octet option 11 snmp , STRING, 'c0:' The allowed SNMP variable type names are: IETF standard SMI Data Type SNMP API name Integer INTEGER Integer (Enumerated) INTEGER Unsigned UNSIGNED Gauge GAUGE Counter COUNTER Counter64 COUNTER64 Timeticks TIMETICKS OCTET STRING STRING OBJECT IDENTIFIER OBJID IpAddress IPADDRESS BITS STRING For example, to specify a SMI Integer type, the following types are accepted (regardless of case sensitivity): Integer, INTEGER. For OCTET STRING type, all of the following types are accepted: OCTET STRING, OCTETSTRING, or STRING. The custom SNMP TLV template option can be used to specify any SNMP TLV, including those that are present in the RDU MIBs. The custom SNMP TLV error checking is less stringent, and will not detect incorrect scalar/columnar references (for example,.0 vs..n in OID names)

12 Developing Template Files Chapter 12 DOCSIS Option Support Table 12-3 describes DOCSIS options and identifies the specific version support for each option. Table 12-3 DOCSIS Options and Version Support Option Number Description Encoding Validation 0 PAD No length and no value 1 Downstream Frequency Multivalued DOCSIS Version N/A True Multiples of False 2 Upstream Channel ID 8 3 Network Access Control Boolean 4 Class of Service Compound 4.1 Class ID 8 Between 1- inclusive 4.2 Maximum Downstream Rate 4.3 Maximum Upstream Rate False 4.4 Upstream Channel Priority 8 Less than 8 False 4.5 Guaranteed Minimum Upstream Channel Data Rate 4.6 Maximum Upstream Channel Transmit Burst 4.7 Class-of-Service Privacy Enable 6 CM MIC Configuration Setting 7 CMTS MIC Configuration Setting 9 Software Upgrade Filename 10 SNMP Write-Access Control Boolean Byte Byte NVTASCII None True OIDCF None True 11 SNMP MIB Object SNMPVarBind None True 14 CPE Ethernet MAC Address MAC Address None True 15 Telephony Settings Option NVTASCII 15.2 Service Provider Name NVTASCII 12-12

13 Chapter 12 Developing Template Files Table 12-3 DOCSIS Options and Version Support (continued) Option Number Description Encoding Validation 15.3 Telephone Number (1) NVTASCII 15.4 Telephone Number (2) NVTASCII 15.5 Telephone Number (3) NVTASCII 15.6 Connection Threshold Login Username NVTASCII 15.8 Login Password NVTASCII 15.9 DHCP Authentication Boolean DHCP Server IP Address RADIUS realm NVTASCII PPPAuthentication Demand Dial Inactivity Timer Threshold SNMP IP Address (No Longer Used) 17 Baseline Privacy Configuration Setting 17.1 Authorize Wait Timeout 17.2 Reauthorize Wait Timeout 17.3 Authorization Grace Time 17.3 Authorization Grace Time 17.4 Operational Wait Timeout 17.5 Rekey Wait Timeout 17.6 TEK Grace Time 17.6 TEK Grace Time 17.7 Authorize Reject Wait Timeout 8 IP Address Compound Between 1 and 30 inclusive Between 1 and 30 inclusive Between 1 and 1800 inclusive Between 1 and inclusive Between 1 and 10 inclusive Between 1 and 10 inclusive Between 1 and 1800 inclusive Between 1 and inclusive Between 1 and 600 inclusive Multivalued False False False False False False False DOCSIS Version False False 12-13

14 Developing Template Files Chapter 12 Table 12-3 DOCSIS Options and Version Support (continued) Option Number Description Encoding Validation 17.8 SA Map Wait Timeout 17.9 Maximum Clock Drift 18 Maximum Number of CPEs 19 TFTP Server Timestamp 20 TFTP Server Provisioned Modem Address 21 Software Upgrade TFTP Server 22 Upstream Packet Classification Encoding Between 1 and inclusive Between 1 and 10 inclusive False False Greater than 0 False IP Address IP Address N Compound None True 22.1 Classifier Reference 8 Between 1 and 255 inclusive 22.2 Classifier Identifier 22.3 Service Flow Reference 22.4 Service Flow Identifier Between 1 and inclusive Between 1 and inclusive False False False Greater than 0 False 22.5 Rule Priority Classifier Activation State Boolean 22.7 Dynamic Service Change Action Multivalued DOCSIS Version Less than 3 False 22.8 Classifier Error Encodings Compound Error Parameter Sub Type Error Code 8 Less than 26 False Error Message ZTAASCII 22.9 IP Packet Classification Encodings IP Type of Service Range and Mask Compound 8 triplet 12-14

15 Chapter 12 Developing Template Files Table 12-3 DOCSIS Options and Version Support (continued) Option Number Description Encoding Validation IP Protocol Less than 258 False IP Source Address IP Address IP Source Mask IP Address IP Destination Address IP Address IP Destination Mask IP Address TCP/UDP Source Port Start TCP/UDP Source Port End TCP/UDP Destination Port Start TCP/UDP Destination Port End Ethernet LLC Packet Classification Encodings Destination MAC Address MAC Address and Mask Compound Source MAC Address MAC Address Ethertype/DSAP/MacType 8 and unsigned integer IEEE 802.1P/Q Packet Classification Encodings IEEE 802.1P User_Priority 8 pair IEEE 802.1Q VLAN_ID Vendor Specific Classifier Parameters Compound Less than 8 False Compound Vendor ID OUI 23 Downstream Packet Classification Encoding Compound None True 23.1 Classifier Reference 8 Between 1 and 255 inclusive 23.2 Classifier Identifier Multivalued DOCSIS Version False False 12-15

16 Developing Template Files Chapter 12 Table 12-3 DOCSIS Options and Version Support (continued) Option Number Description Encoding Validation 23.3 Service Flow Reference 23.4 Service Flow Identifier Between 1 and Between 1 and False False 23.5 Rule Priority 8 Greater than 0 False 23.6 Classifier Activation Boolean 23.7 Dynamic Service Change Action 8 Less than 3 False 23.8 Classifier Error Encodings Compound Error Parameter Sub Type Error Code 8 Less than Error Message ZTASCII 23.9 IP Classification Encodings IP Type of Service Range and Mask IP Protocol Compound 8 Less than 258 False IP Source Address IP Address IP Source Mask IP Address IP Destination Address IP Address IP Destination Mask IP Address TCP/UDP Source Port Start TCP/UDP Source Port End TCP/UDP Destination Port Start TCP/UDP Destination Port End Ethernet LLC Packet Classification Encodings Compound Destination MAC Address MAC Address and Mask\ Multivalued DOCSIS Version Source MAC Address MAC Address 12-

17 Chapter 12 Developing Template Files Table 12-3 DOCSIS Options and Version Support (continued) Option Number Description Encoding Validation Ethertype/DSAP/MacType 8 and unsigned integer IEEE 802.1P/Q Packet Classification Encodings IEEE 802.1P User_Priority 8 pair IEEE 802.1Q VLAN_ID Vendor Specific Classifier Parameters Compound Less than 8 False Compound Vendor ID OUI 24 Upstream Service Flow Scheduling 24.1 Service Flow Reference 24.3 Service Identifier Compound None True Greater than 0 False 24.4 Service Class Name ZTASCII 24.5 Service Flow Error Encodings Compound None True Errored Parameter Error Code 8 Less than 26 False Error Message ZTASCII 24.6 Quality of Service Parameter Set Type Multivalued DOCSIS Version Less than 8 False 24.7 Traffic Priority 8 Less than 8 False 24.8 Upstream Maximum Sustained Traffic Rate 24.9 Maximum Traffic Burst Minimum Reserved Traffic Rate Assumed Minimum Reserved Rate Packet Size Timeout for active QoS Parameters 12-17

18 Developing Template Files Chapter 12 Table 12-3 DOCSIS Options and Version Support (continued) Option Number Description Encoding Validation Timeout for Admitted QoS Parameters Maximum Concatenated Burst Service Flow Scheduling Type 24. Request/Transmission Policy 8 Between 1-6 inclusive Nominal Polling Interval Tolerated Poll Jitter Unsolicited Grant Size Nominal Grant Interval Tolerated Grant Jitter False Less than 512 False Grants per Interval 8 Less than 128 False IP Type of Service Overwrite Unsolicited Grant Time Reference Vendor Specific PHS Parameters 8 pair Compound Vendor ID OUI 25 Downstream Service Flow Scheduling 25.1 Service Flow Reference 25.3 Service Identifier Compound None True Greater than 0 False 25.4 Service Class Name ZTASCII 25.5 Service Flow Error Encodings Multivalued DOCSIS Version Compound None True Errored Parameter Error Code 8 Less than 26 False Error Message ZTASCII 12-18

19 Chapter 12 Developing Template Files Table 12-3 DOCSIS Options and Version Support (continued) Option Number Description Encoding Validation 25.6 Quality of Service Parameter Set Type 8 Less than 8 False 25.7 Traffic Priority 8 Less than 8 False 25.8 Downstream Maximum Sustained Traffic Rate 25.9 Maximum Traffic Burst Minimum Reserved Traffic Rate Assumed Minimum Reserved Rate Packet Size Timeout for active QoS Parameters Timeout for Admitted QoS Parameters Maximum Downstream Latency Vendor Specific PHS Parameters Compound Vendor ID OUI 26 Payload Header Suppression Compound None True 26.1 Classifier Reference 8 Greater than 0 False 26.2 Classifier Identifier 26.3 Service Flow Reference 26.4 Service Flow Identifier 26.5 Dynamic Service Change Action 26.6 Payload Header Suppression Error Encodings Multivalued DOCSIS Version Greater than 0 False Greater than 0 False Greater than 0 False 8 Less than 4 False Compound Errored Parameter Error Code 8 Less than 26 False Error Message ZTASCII 12-19

20 Developing Template Files Chapter 12 Table 12-3 DOCSIS Options and Version Support (continued) Option Number Description Encoding Validation 26.7 Payload Header Suppression Field (PHSF) 26.8 Payload Header Suppression Index (PHSI) 26.9 Payload Header Suppression Mask (PHSM) Payload Header Suppression Size (PHSS) Payload Header Suppression Verification (PHSV) Vendor Specific PHS Parameters Bytes 8 Greater than 0 False Bytes 8 Boolean Compound Vendor ID OUI 28 Maximum Number of Classifiers Multivalued DOCSIS Version Privacy Enable Boolean Manufacturer CVC Bytes 33 Co-signer CVC Bytes 34 SnmpV3 Kickstart Value Compound 34.1 SnmpV3 Kickstart Security Name 34.2 SnmpV3 Kickstart Manager Public Number 35 Subscriber Management Control 36 Subscriber Management CPE IP Table 37 Subscriber Management Filter Groups 38 Configuration File Element - docsisv3 Notification Receiver 38.1 IP Address of Trap Receiver 38.2 UDP Port Number of Trap Receiver NVTASCII Bytes Bytes Multiple IP Addresses Bytes Compound IP address unsigned integer 12-20

21 Chapter 12 Developing Template Files Table 12-3 DOCSIS Options and Version Support (continued) Option Number Description Encoding Validation 38.3 Type of Trap Sent by the PS unsigned integer Timeout unsigned integer 38.5 Number of Retries When Sending an Inform After Sending the Inform First 38.6 Notification Filtering Parameters 38.7 Security Name to Use When Sending SNMP V3 Notification unsigned integer 8 OID NVTASCII 39 Enable 2.0 Mode Enable/Disable None False 40 Enable Test Mode SubOptions None True 41 Downstream Channel List SubOptions None True 41.1 Single Downstream Channel Single Downstream Channel Timeout Single Downstream Channel Frequency 41.2 Downstream Frequency Range Downstream Frequency Range Timeout Downstream Frequency Range Start Downstream Frequency Range End Downstream Frequency Range Step Size SubOptions None True unsigned integer None False unsigned integer None False SubOptions True unsigned integer None False unsigned integer unsigned integer Multiples of Multiples of False False unsigned integer None False 41.3 Default Scanning unsigned integer None True 42 Multicast MAC Address MAC Address None True 43 Vendor-Specific Information 43.1 Static Downstream Frequency Compound None True 43.2 Sync Loss Timeout Multivalued DOCSIS Version

22 Developing Template Files Chapter 12 Table 12-3 DOCSIS Options and Version Support (continued) Option Number Description Encoding Validation 43.3 Update Boot Monitor Image 43.4 Power Backoff NVTASCII 43.8 Vendor ID OUI Boolean 43.9 Update Factory System Image Phone Lines IP Precedence Settings Compound None True IP Precedence Value Rate Limit IOS Configuration Filename IOS Config File Without Console Disable NVTASCII NVTASCII IOS CLI Command NVTASCII None True Plus Flow Encodings Compound Plus Flow ID Class ID Unsolicited Grant Size Nominal Grant Interval Between inclusive Between inclusive Grants Per Interval 8 Between inclusive Embedded Voice Calls 8 Between inclusive Hold Queue Length Between inclusive False False False False False Fair Queue Compound False Congestive Discard Threshold Between inclusive Multivalued DOCSIS Version

23 Chapter 12 Developing Template Files Table 12-3 DOCSIS Options and Version Support (continued) Option Number Description Encoding Validation Number of Dynamic Conversation Queues Number of Reservable Conversation Queues Between inclusive Between inclusive Custom Queue List Length 8 Between 1- inclusive False False False Random Detection Boolean False Priority Group 8 Between 1- inclusive Service Policy File NVTASCII False Inactivity Timer Between inclusive COS Tag NVTASCII False Downstream Sub Channel ID 8 Between 0-15 inclusive SU Tag NVTASCII N/A False 255 End-of-Data Marker No length and no value DOCSIS Version PacketCable Option Support Table 12-4 identifies the PacketCable 1.0 MTA options supported by BACC. Table 12-4 PacketCable MTA 1.0 Options Number Description Encoding Validation 11 SNMP MIB Object SNMPVarBind with 1 byte length 38 SNMPv3 Notification Receiver 38.1 SNMPv3 Notification Receiver IP Address 38.2 SNMPv3 Notification Receiver UDP Port Number Multivalued Multivalued PacketCable Version None True SubOptions None True IPAddress 12-23

24 Developing Template Files Chapter 12 Table 12-4 PacketCable MTA 1.0 Options (continued) Number Description Encoding Validation 38.3 SNMPv3 Notification Receiver Trap Type 38.4 SNMPv3 Notification Receiver Timeout 38.5 SNMPv3 Notification Receiver Retries 38.6 Notification Receiver Filtering Parameters 38.7 Notification Receiver Security Name SNMPTrapType From 1 to 5 False From 0 to 255 False OID NVTASCII 43 Vendor-Specific Information SubOptions None True 43.8 Vendor ID OUI None True 64 SNMP MIB Object SNMPVarBind with 2 byte length 254 Telephony Config File Start/End 8 Must be 1 or 255 PacketCable Version False Non-Secure CableHome Option Support Table 12-5 identifies the non-secure CableHome options supported by BACC. Table 12-5 Non-secure CableHome Options and Version Support Option Number Description Encoding Validation 0 PAD No length and no value Multivalued Multivalued 1.0 None True 9 Software Upgrade Filename NVTASCII None False 10 SNMP Write-Access Control OIDCF None True 12 Modem IP Address IP Address None False 14 CPE Ethernet MAC Address MACAddress None True 21 Software Upgrade TFTP Server IPAddress None False 28 SNMP MIB Object SNMPVarBind None True Manufacturer CVC Bytes None False 33 Co-signer CVC Bytes None True 34 SnmpV3 Kickstart Value SubOptions None False CableHome Version 12-24

25 Chapter 12 Using the Configuration File Utility Table 12-5 Non-secure CableHome Options and Version Support (continued) Option Number Description Encoding Validation 34.1 SnmpV3 Kickstart Security Name 38 SNMPv3 Notification Receiver SubOptions None True 38.1 SNMPv3 Notification Receiver IPAddress None False IP Address 38.2 SNMPv3 Notification Receiver UDP Port Number None False 38.3 SNMPv3 Notification Receiver Trap Type 38.4 SNMPv3 Notification Receiver Timeout 38.5 SNMPv3 Notification Receiver Retries 38.6 Notification Receiver Filtering Parameters 38.7 Notification Receiver Security Name Multivalued 1.0 NVTASCII None False SNMPTrapType From 1 to5 False None False None False OID None False NVTASCII None False 43 Vendor-Specific Information SubOptions None True 43.1 Vendor ID OUI None False 53 PS MIC. A 20 octet SHA-1 hash Bytes None False of PS config file 255 End-of-Data Marker No length and no value None False CableHome Version Using the Configuration File Utility You use the configuration file utility to test, validate, and view PacketCable 1.0, DOCSIS 1.0/1.1/2.0, and CableHome template and configuration files. These activities are critical to successful deployment of individualized configuration files. See the Developing Template Files section on page 12-1 for more information on templates. The configuration file utility is available only when the RDU is installed and the utility is installed in the <BACC_HOME>/rdu/bin directory. Both the template file being encoded and the binary file being decoded must reside in the directory from which the configuration file utility is invoked. All examples found in this section assume that the RDU is operating and that these conditions apply: The BACC application is installed in the home directory (/opt/cscobpr). The RDU login name is admin. The RDU login password is changeme

26 Using the Configuration File Utility Chapter 12 Note Some of the examples provided in this section have been truncated whenever the omitted formation is of no consequence to the example of its outcome. Instances where this occurs are identified by a series of periods (...) that are located just prior to the example summary. This section discusses these topics: Parsing a Local Template File, page Parsing an External Template File, page Specifying Macro Variables at the Command Line, page 12- Specifying a Device for Macro Variables, page Specifying Output to a Binary File, page Viewing a Local Binary File, page Viewing an External Binary File, page Running the Configuration File Utility In subsequent procedures and examples, the phrase run the configuration file utility means to enter the runcfgutil.sh command from the directory specified. To run the configuration file utility, run this command from the home directory: runcfgutil.sh (options) Where the available (options) include: -c <secret> Specifies the CMTS shared secret when parsing a DOCSIS template file. To specify the default shared secret, enter -c cisco. -cablehome Identifies the input file as a CableHome portal service configuration file. Do not use this with either the -docsis or -pkt options. -d Decodes the binary input file. Do not use this with the -e option. -docsis Specifies the input file is a DOCSIS configuration file. Do not use this default with the -pkt option. -e Encodes the template input file. Do not use this default with the -d option. -g Generates a template file from either a docsis, packetcable or cablehome binary file. -h<host:port> Specifies the host and port number. The default port number id i <device id> Specifies the device to use when parsing macro variables. For example, if your device is ID is 1,6,00:00:00:00:00:01, enter -i 1,6,00:00:00:00:00:01. When using this option, you must also use the -u and -p options, respectively, to specify the username and password. Do not use this with the -m option. -l <filename> Identifies the input file as being on the local file system. For example, if your input file is called any_file, enter -l any_file. Do not use this with the -r option. -loc Specifies the PacketCable locale, na (North America) or euro (Europe). The default is na. If the MTA is euro-mta, then the locale should be set to euro. -m <macros> Specifies key value pairs for macro variables. The format is key=value. If you require multiple macro variables, use a double comma separator between the key value pairs, for example, key_1=value_1,,key_2=value_2. Do not use this with the -i option

27 Chapter 12 Using the Configuration File Utility -p <password> Specifies the password to use when connecting to the RDU. For example, if your password is , enter -p o <filename> Saves parsed template file as a binary file. For example, if you want the output to be found in a file call op_file, enter -o op_file. -pkt Identifies the input file as a PacketCable MTA configuration file. Do not use this with the -docsis option. -r <filename> Identifies the input file as an external file that has been added to the RDU. For example, if your file is called file25 enter -r file25. When using this option you must also use the -u and -p options, respectively, to specify the username and password. Do not use this with the -l option. -s Displays the parsed template or the contents of the binary file in a human readable format. -t Specifies the PacketCable encoding type, secure or basic (default is secure). -u <username> Specifies the username to use when connecting to the RDU. For example, if your username is admin, enter -u admin. -v <version> Specifies the DOCSIS version being used. For example, if you are using DOCSIS 1.1, enter -v 1.1. If you do not specify the version number, the command defaults to use DOCSIS 2.0. Note The configuration file utility does not include option 19 (TFTP server timestamp) and option 20 (TFTP server provisioned modem address) in the template file, however the BACC TFTP mixing does. Also, options 6 (CM MIC) and 7 (CMTS MIC) are both automatically inserted into the encoded template file. Therefore, you do not have to specify these message integrity checks (MIC). Using the Configuration File Utility To use the configuration file utility to test BACC templates: Step 1 Develop the template as described in the Developing Template Files section on page Step 2 Step 3 Step 4 Step 5 Run the configuration file utility on the local file system. If the template contains macro variables, perform these operations in the order specified: a. Test with command line substitution. b. Test with a device that has been added to your RDU. Add the template (and any included templates that are used) to the RDU. Run the configuration file utility as an external file. If the template contains macro variables, perform these operations in the order specified: a. Test with command line substitution. b. Test with a device that has been added to your RDU. Configure a class of service to use the template

28 Using the Configuration File Utility Chapter 12 Converting a Binary File Into a Template File Usage Guidelines Use the runcfgutil.sh command to convert binary configuration memory files into template files. BACC dynamic configuration generation is based on templates that are created. Automatically converting existing, tested, binary files to template files speeds the process and reduces the possibility of introducing errors. Syntax Description You must use this syntax when using the runcfgutil.sh command to convert an existing binary file into a template file. runcfgutil.sh g l <binary_file> o <template_file> -g specifies that a template file needs to be generated from an input binary file -l <binary_file> specifies the local input file, including the path name. In all cases, the input binary file name will have a *.cm file extension; bronze.cm for example. -o <template_file> specifies the output template file, including the path name. In all cases, the input binary file name will have a *.tmpl file extension; test.tmpl for example. Parsing a Local Template File Usage Guidelines Use the runcfgutil.sh command to parse external template files. Syntax Description You must use this syntax when using the runcfgutil.sh command to parse a local template file: runcfgutil.sh -pkt -l <file> -pkt identifies the input file as a packetcable MTA file -l specifies the input file is on the local file system <file> identifies the input template file being parsed Parsing the File To parse a template file that is on the local file system: Step 1 Step 2 Change directory to /opt/cscobpr/rdu/samples/packet_cable. Select a template file to use. Note This example uses an existing template file called unprov_packet_cable.tmpl. The -pkt option is used because this is a PacketCable MTA template. Step 3 Run the configuration file utility using this command: 12-28

29 Chapter 12 Using the Configuration File Utility runcfgutil.sh -pkt -l unprov_packet_cable.tmpl -pkt identifies the input file as a packetcable MTA file -l specifies the input file is on the local file system unprov_packet_cable.tmpl identifies the input template file being parsed After running the utility, results similar to these should appear: Off File Bytes Option Description Value 0 FE Telephony Config File Start/End 1 3 0B E 2B A30B SNMP MIB Object.iso.org.dod.internet. private.enterprises.ca blelabs.clabproject.cl abprojpacketcable.pktc MtaMib.pktcMtaMibObjec ts.pktcmtadevbase. pktcmtadevenable d.0,integer,false(2) 0 error(s), 0 warning(s) detected. Parsing of unprov_packet_cable.tmpl was successful. The file unprov_packet_cable.tmpl was parsed successfully in 434 ms. The parser initialization time was 92 ms. The parser parse time was 342 ms. Parsing an External Template File Usage Guidelines Use the runcfgutil.sh command to parse external template files. Syntax Description You must use this syntax when using the runcfgutil.sh command to parse an external template file: runcfgutil.sh -r <file> -u <username> -p <password> -r <file> identifies the input file as an external file that has been added to the RDU -u <username> specifies the username to use when connecting to the RDU -p <password> specifies the password to use when connecting to the RDU Parsing the File To parse a template file that has been added to the RDU: Step 1 Step 2 Change directory to /opt/cscobpr/rdu/samples/docsis. Select a template file to use

30 Using the Configuration File Utility Chapter 12 Note Step 3 This example uses an existing template file called unprov.tmpl. The -docsis option is used because a DOCSIS template is being used. Run the configuration file utility using this command: runcfgutil.sh -r <unprov.tmpl> -u <admin> -p <changeme> -docsis unprov.tmpl identifies the input file admin identifies the user name changeme identifies the password -docsis identifies the file as a DOCSIS template After running the utility, results similar to these should appear: Note The results shown here are for illustration only and have been truncated for brevity. Off File Bytes Option Description Value Network Access Control On 3 041F 4 Class of Service Class ID FA Maximum Downstream Rate bits/sec FA Maximum Upstream Rate bits/sec Upstream Channel Priority F C9152B44DB EF6FE B675B 70B7BD3E09AC 210F794A1E8F 6 CM MIC Configuration Setting FC9152B44 DB EF6FE 7 CMTS MIC Configuration Setting 644B675B70B7BD3E 09AC210F794A1E8F 288 FF 255 End-of-Data Marker PAD PAD PAD 0 error(s), 0 warning(s) detected. Parsing of unprov.tmpl was successful. The file unprov.tmpl was parsed successfully in 375 ms. The parser initialization time was 63 ms. The parser parse time was 312 ms

31 Chapter 12 Using the Configuration File Utility Parsing a Template File and Adding a User-Specified Shared Secret Usage Guidelines Use the runcfgutil.sh command to parse a template file and add a shared secret that you specify. Syntax Description You must use this syntax when using the runcfgutil.sh command to parse a template file and add a shared secret: runcfgutil.sh -e -docsis -l <file> -c <secret> -e identifies the encode option. -docsis Identifies the input file as a DOCSIS template file. -l Specifies the input file is on the local file system. <file> Identifies the input template file being parsed. -c <secret> Specifies the CMTS shared secret when parsing a DOCSIS template file. The default shared secret is -c cisco. Parsing the File To parse a locally saved template file, and set a user specified shared secret: Step 1 Step 2 Change directory to /opt/cscobpr/rdu/samples/docsis. Select a template file to parse. Note Step 3 This example uses an existing template file called unprov.tmpl. The -docsis option is used because this is a DOCSIS template. Run the configuration file utility using this command: runcfgutil.sh -e -docsis -l unprov.tmpl -c shared -e identifies the encode option. -docsis Identifies the input file as a DOCSIS template file. -l Specifies the input file is on the local file system. The locally saved file used in this example is unprov.tmp. -c Indicates that a shared secret is being set and shared identifies that new shared secret. After running the utility, results similar to these should appear: Off File Bytes Option Description Value Network Access Control Off 3 041F 4 Class of Service Class ID

32 Using the Configuration File Utility Chapter F Maximum Downstream Rate bits/sec FA Maximum Upstream Rate bits/sec Upstream Channel Priority F C9152B44DB EF6FE B675B 70B7BD3E09AC 210F794A1E8F 6 CM MIC Configuration Setting FC9152B44 DB EF6FE 7 CMTS MIC Configuration Setting 644B675B70B7BD3E 09AC210F794A1E8F 288 FF 255 End-of-Data Marker PAD PAD PAD 0 error(s), 0 warning(s) detected. Parsing of unprov.tmpl was successful. The file unprov.tmpl was parsed successfully in 375 ms. The parser initialization time was 63 ms. The parser parse time was 312 ms. Specifying Macro Variables at the Command Line Usage Guidelines Use the runcfgutil.sh command to specify macro variables. Syntax Description You must use this syntax when using the runcfgutil.sh command when specifying macro variables at the command line: runcfgutil.sh -e -l <file> -m < macros > -e identifies the encode option. -l Specifies the input file is on the local file system. <file> Identifies the input template file being parsed. -m Specifies the macro variables to be substituted when parsing a template. < macros > Identifies the desired macros. When multiple macro variables are required, insert a double comma separator between each macro. 12-

33 Chapter 12 Using the Configuration File Utility To specify values for macro variables at the command line: Step 1 Step 2 Change directory to /opt/cscobpr/rdu/samples/templates. Select a template file to use. Step 3 Identify the macro variables in the template. In this example, the macro variables are macro1 (option 3) and macro11 (option 4.2). Step 4 Step 5 Identify the values for the macro variables. The value for macro1 will be set to 1, and the value for macro11 to Run the configuration file utility using this command: runcfgutil.sh -e -l macro.tmpl -m "macro1=1,,macro11=64000" -e identifies the encode option. -unprov.tmpl Identifies the input file. macro1=1,,macro11=64000 Identifies the key value pairs for macro variables. Since multiple macro variables are necessary, a double comma separator is inserted between the key value pairs. After running the utility, results similar to these should appear: Off File Bytes Option Description Value Network Access Control On 3 041F 4 Class of Service Class ID FA Maximum Downstream Rate bits/sec FA Maximum Upstream Rate bits/sec Upstream Channel Priority error(s), 0 warning(s) detected. Parsing of macro.tmpl was successful. The file macro.tmpl was parsed successfully in 854 ms. The parser initialization time was 76 ms. The parser parse time was 778 ms. Specifying a Device for Macro Variables Usage Guidelines Use the runcfgutil.sh command to specify a device for macro variables. Syntax Description You must use this syntax when using the runcfgutil.sh command when specifying a device for macro variables: runcfgutil.sh -e -l <file> -i <MAC> -u <username> -p <password> 12-33