The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This chapter provides the instructions to configure the IPDR Login Event Generator (LEG).
To start the IPDR LEG, you must configure the following three files in the directory sm-inst-dir/sm/server/root/config directory, where sm-inst-dir refers to the SM installation directory:
The ipdr.cfg file is loaded only upon Service Control Management Suite (SCMS) Subscriber Manager (SM) IPDR LEG startup.
The configuration files consist of sections headed by a bracketed section title; for example, [IPDR LEG] for the IPDR LEG configuration section. Each section consists of several parameters and they are given in a specific format, for example, port=4737. The pound symbol (#) at the beginning of a line signifies that it is a comment.
The [IPDR LEG] section in the configuration file defines the behavior of the IPDR LEG and contains the following parameters:
Defines whether to start the LEG at SM startup.
Possible values for this parameter are yes and no.
Defines whether a subscriber has to be logged in with IPv6 address.
Possible values are true and false.
Defines whether the LEG will log the messages that are issued for failed queries.
Possible values for this parameter are yes and no.
Defines whether the LEG will log all the messages.
Possible values for this parameter are yes and no.
Note This parameter should only be set to yes when troubleshooting.
Enable this parameter to log the IPDR messages that are received.
Possible value for this parameter is either true or false.
Enable this parameter to log the mapping table information.
Possible value for this parameter is either true or false.
Enable this parameter to log the subscribers, who are partially logged in.
Possible value for this parameter is either true or false.
Possible values for this parameter are yes and no.
If the value is set to yes, the IP address of the cable modem is assigned to the subscribers. If set to no, the IP address of the CPE is assigned to the subscribers.
Defines the mode in which the collector starts.
Possible values for this parameter are ipdr and ipdr_snmp.
If the value is set to ipdr, the collector runs in pure IPDR stack. If set to ipdr_snmp, the collector runs in both the SNMP mode and the IPDR mode.
Defines whether to query the CMTS for bonding group information after the CM registration template is received.
Possible values for this parameter are true and false.
Defines whether to send bulk SNMP queries to CMTS for the cable modem bonding group association query.
Note Changing the value of this parameter may impact the CMTS CPU performance.
Possible values for this parameter are true and false.
Defines the number of cable modem MAC addresses to be processed in a single bulk query.
Note Changing the value of this parameter may impact the CMTS CPU performance.
The maximum number of queries that can be processed each second is 100. Depending on the number of cable modems, the number of queries varies. To calculate the number of queries, multiply the number of cable modems with the number of object IDs.
Defines the interval, in milliseconds, between two SNMP bulk queries.
Note Changing the value of this parameter may impact the CMTS CPU performance.
The default value is 1000 milliseconds.
This parameter is applicable only if the collector_mode is configured as ipdr_snmp.
Defines the time interval, in seconds, at which the CMTS is periodically queried for bonding group information pertaining to the aggregated cable modem’s MAC address.
The default value is 60 seconds.
The possible value range for this parameter is from 15 to 900 seconds.
This parameter is applicable only if the collector_mode is configured as ipdr_snmp. If the bonding group information for the aggregated cable modem’s MAC address is not retrieved during the primary query, the IPDR LEG retries to retrieve the information during the retry queries. Based on the configured time interval, all the cable modems will be queried. The default value is 60 seconds.
The possible value range for this parameter is 15 seconds to 900 seconds.
This parameter is applicable only if the snmp_mode_for_BG parameter is enabled. If the bonding group information for the aggregated cable modem’s MAC address is not retrieved during the primary query, the IPDR LEG retries to retrieve the information during retry queries. If a cable modem needs to be processed for retrying, the time interval should be passed in milliseconds after login time.The default value is 900000 milliseconds(15 minutes).
The possible value range for this parameter can be from 0 to 900000 milliseconds.
Defines the template types. CPE information is processed as a subscriber ID only if the CPE information is retrieved from one of the IPDR templates.
– CMTS-CM-REG-STATUS-TYPE_3.5.1-A.1
– DOCSIS-CMTS-TOPOLOGY-TYPE_3.5.1-A.2
Defines whether to ignore the Subscriber IP mapping when the subscriber logs in through the IPDR LEG.
Possible values are true and false. The default value is false.
Defines whether to add the CM MAC address to the primary queue for each CPE login regardless of whether the corresponding subscriber has a VLink ID.
Possible values are true and false. The default value is true.
A delimiter used to separate the ip addresses from the CPE type messages’ cpeIpv4AddrList field. Default value is a single space
The [IPDR.Exporter.<Exporter Name>] section in the configuration file contains the following parameters:
Defines whether to receive the IPDR exporter messages.
Defines the connection type of the exporter.
Defines the connection time out period in minutes.
The default value is 100 minutes.
Defines the time in minutes, for which the session has to be kept alive.
The default value is 15 minutes.
Defines the port to be used for the session.
A numeric value that defines the session ID.
Defines whether to ignore the Subscriber IP mapping when the subscriber logs in through the IPDR LEG. Possible values are true and false. The default value is false.
A device specific delimiter used to separate the IP addresses from the CPE type messages.
Default value is a single space
Configure the exporter IP in the vlink.cfg as Device.<Exporter Name>.
Reconnecting the Collector to the Exporter
If you modify the IPDR Exporter section of an IPDR configuration, or the exporter configuration in CMTS, you must complete these steps to reconnect the Collector to the Exporter:
Step 1 Change the start parameter to no.
Step 2 Load the p3sm configuration, using the p3sm load config command.
Step 3 Change the start parameter to yes.
Step 4 Load the p3sm configuration, using the p3sm load config command.
The [IPDR.Subscriber ID] section in the configuration file contains the following parameters:
Defines the IPDR protocol field name.
Do not start or end the field name with a space bar. Do not include the “=” character in the name.
Note It is mandatory to create an [IPDR.Field.<field name>] section for each field defined in this parameter.
Defines the field definition. Copy and uncomment this section for each field defined in fields parameter. The fields property can be defined in the Subscriber ID section.
Defines the ipdr_key parameter with the IPDR template key name. See the “IPDR Templates” section for the various key names.
Defines the type of the IPDR key type. Possible values for this parameter are integers or strings.
Note In a cable environment, we recommend that you configure the subscriber ID as CmMacAddr irrespective of whether the IPDR is in the CM mode or the CPE mode.
The [IPDR.Policy.packageID] section of the configuration file contains the following parameters:
Defines the IPDR fields from which the subscriber package ID is retrieved. For multiple fields, use commas between the field name.
The following restrictions apply to field names:
– Field name shall not start or end with space bar.
– Field name shall not contain “=” character.
It is mandatory to create an [IPDR.Field.<field name>] section for each field defined in this parameter.
There is no default value for this parameter.
Defines the separator value to use when concatenating options.
Defines the ways to manipulate the IPDR field values. You can define field manipulation rule for each field_name.
To define manipulation operations, use the following format:
field_manipulation.<field name>=<regular expression>, where:
<field name> is one of the fields defined in fields parameter.
<regular expression> is the reduction regular expression for the <field name>.
.* means no reduction is required. This the default rule if field manipulation is not configured.
Defines a conversion table for the result of the attribute value manipulation, the matching rule, and the property value.
The <Property-value> is an integer in case of a match. You can define <.*> to the default value if there is no match.
There is no default value for this parameter.
Defines a list of policy IDs separated by commas. During login, if the policy ID matches one of the values defined in this parameter, a login operation occurs without changing the policy value.
This parameter is valid only if allow_login_with_no_policy parameter is true.
There is not default value for this parameter.
Defines whether a login can be performed when no policy is found for assigning.
Possible values for this parameter are true and false.
Defines the policy property key to use for policy assignment.
Possible values for this parameter are downVlinkId or upVlinkId.
The default value is packageId.
Note The policy_property_name parameter is case sensitive and must be written exactly as defined in the Cisco SCA BB Console, for example, packageId, upVlinkId, or downVlinkId.
Determines whether to use a default policy when no policy information can be extracted from the IPDR data.
Possible values for this parameter are true or false. The default value is false.
Defines the default policy ID to use if no policy information is extracted from the IPDR data. This parameter is relevant only if the use_default parameter is set to true.
Possible values for this parameter are any integer number. This parameter has no default value.
The [IPDR.Policy.VirtualLinkDownstream] section of the configuration file contains the following parameters:
Defines the IPDR fields from which the subscriber downVlinkId is retrieved. For multiple fields, use commas between the field names.
The following restrictions apply to field names:
– The field name shall not start or end with a space bar.
– The field name shall not contain the “=” character.
It is mandatory to create an [IPDR.Field.<field name>] section for each field defined in this parameter.
There is no default value for this parameter.
Defines the separator value to use when concatenating options.
Defines the package property key to use for policy assignment.
The default value is downVlinkId.
The [IPDR.Policy.VirtualLinkUpstream] section of the configuration file contains the following parameters:
Defines the IPDR fields from which the subscriber VirtualLinkUpstream is retrieved. For multiple fields, use commas between the field names.
The following restrictions apply to field names:
– The field name shall not start or end with a space bar.
– The field name shall not contain the “=” character.
It is mandatory to create an [IPDR.Field.<field name>] section for each field defined here.
There is no default value for this parameter.
Defines the separator value to use when concatenating options.
Defines the package property key to use for policy assignment.
The default value is upVlinkId.
The following is an example of an IPDR LEG configuration file:
Note The message DOCSIS-CPE_3.5.1-A.0.xsd is not supported. The IP address is denoted by hexadecimal representation in the template DOCSIS-CPE_3.5.1-A.0.xsd. It is expected that the collector will always send the normal IP format for the cpeIpv4AddrList information. And the cpeIpv4AddrList information currently has only one field.Only the first mappings are used to login for "CpeIpv4AddrList, CpeIpv6AddrList" from parsing IPDRDOCSIS-CPE-TYPE_3.5.1-A.2.xsd template.
The following is an overview of the steps you need to perform to configure the IPDR LEG:
Step 1 Configure each exporter or CMTS to send messages to the Collector. See the “Configuring Exporter or CMTS to Send IPDR Messages to the Collector” section or the “Configuring the IPDR Collector and Templates On an Arris CMTS” section.
Step 2 Configure the IP address of the SCE and the Collection Manager in p3sm.cfg. See the “Configuring the IP Address of the SCE in p3sm.cfg” section.
Step 3 (Optional) Add a host entry in the Subscriber Manager server. See the “Adding Host Entry in the Subscriber Manager Server” section.
Step 4 Configure IPDR LEG to collect IPDR Messages from the Exporter and send it to the IPDR LEG. See the “Configuring IPDR LEG to Collect IPDR Messages from the Exporter and to Send it to VLM” section.
Step 5 Configure VLM. See the “Configuring VLM” section.
Note This section is applicable only to Cisco CMTS.
To configure each exporter or CMTS to send the IPDR messages to the collector (Subscriber Manager), perform the following steps:
Step 1 Configure CMTS with session ID for Collector.
Step 2 Configure time-based or event-based IPDR Session Type.
Step 3 Associate the template to a session.
Step 5 Associate the collector to a session.
Step 6 (Only for SAMIS-TYPE template) Enable metering.
Step 7 Start the IPDR Exporter.
Note Repeat Step 1, Step 2, Step 3, and Step 5 for each session.
Note If you modify the IPDR Exporter section of an IPDR configuration or the exporter configuration in the CMTS, you must complete the steps provided in the “Reconnecting the Collector to the Exporter” section to reconnect the Collector to the Exporter.
Tip Use different templates for different sessions.
The following is an example of configuring the CMTS to send IPDR messages to the Collector:
To configure each Exporter or CMTS to send the IPDR messages to the collector or to the Subscriber Manager, complete these steps:
Step 1 Enable the DOCSIS compatibility mode.
Step 2 Set a time for sending keep-alive-interval to the Collector.
Step 3 Add the Collector to the IPDR Exporter.
Step 4 Add a session, a template and the mode of collection to the exporter.
Step 5 Configure the periodic intervals for sending SAMIS messages.
Step 6 Enable the IPDR Exporter.
Note Repeat Step 4 for SAMIS-1 service with method as time, and for CPE service with method as event.
The following is an example of configuring the IPDR Collector and Templates in an Arris CMTS:
Configure the IP address of the SCE and the port in the <pcube>/sm/server/root/config/p3sm.cfg file:
Configure the IP address of the Collection Manager in the <pcube>/sm/server/root/config/p3sm.cfg file:
To add a host entry in the Subscriber Manager server perform the following steps:
Step 1 Login to the Subscriber Manager as the root user.
Step 2 Open the /etc/hosts file in a text editor, such as vi editor.
Step 3 If Subscriber Manager server host name information is missing in this file, add the following as the last line in the given format:
<SM Server IP Address> <SM Server hostname>
Step 4 Save the file and quit the editor.
Step 5 Restart the network server by using the #/etc/rc.d/init.d/network restart command.
Note This command terminates all the existing SSH and Telnet connections to the Subscriber Manager.
To configuring the IPDR LEG to collect IPDR messages from the exporter and to send it to VLM complete these steps:
Step 1 Configure the <pcube>/sm/server/root/config/ipdr.cfg file.
The CM Mac Address will be the default Subscriber ID. The CMTS name should be mapped to the CMTS Name configured in vlink.cfg file.
The following is an example of the configuration:
Step 2 If the host entry is not added in the Subscriber Manager, then add the IPDR Collector IP address to the ipdr.cfg file.
The following is an example of the configuration:
Configure the VLM configuration file, <pcube>/sm/server/root/config/vlink.cfg.
The following an example of the VLM configuration file:
Note Use a label device_type only for non-Cisco CMTS.
Note This feature is applicable only for Cisco CMTS.
The Adhoc IPDR sessions retrieve the IPDR records that were not communicated due to lack of connection between CMTS and Subscriber Manager. After the connection is reestablished, the CMTS forwards all the IPDR records to the Subscriber Manager. Connection is reestablished because of various reasons including restarting of SM, CMTS, IPDR LEG, or the Exporter in CMTS.
To configure the IPDR LEG to use Adhoc IPDR sessions, perform the following steps:
Step 2 Map the session IDs in the IPDR configuration file (ipdr.cfg).
Step 3 Restart the Cisco SCMS Subscriber Manager.
Note The Adhoc-based IPDR sessions supports only the CMTS-CM-REG-STATUS-TYPE and DOCSIS-CPE-TYPE templates.
The following is an example of configuration for Adhoc IPDR sessions:
Configuration in Subscriber Manager
Note You must configure an additional 60 MB of memory for each CMTS in the Subscriber Manager process memory. This is to accomodate the SNMP queue.
To configure the IPDR LEG to learn cable modem and associated bonding groups through SNMP query, complete the following steps:
Step 1 Open the IPDR configuration file.
Step 2 Change the value of collector_mode parameter to ipdr_snmp.
Step 3 Change the value of enable_bulk_query parameter to true.
Step 4 If the IPDR LEG must query the CMTS immediately after the cable modem registration template message is received, change the value of snmp_mode_for_BG parameter to true.
Step 5 Configure these parameters:
Step 6 Save the IPDR configuration file.