Cisco cBR-8 Configuration And Troubleshooting Manual
Cisco cBR Series Converged Broadband Routers Troubleshooting
and Network Management Configuration Guide for Cisco IOS XE Fuji
16.8.x
First Published: 2018-03-07
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
©
2018 Cisco Systems, Inc. All rights reserved.
CONTENTS
CHAPTER 1
Call Home 1
Hardware Compatibility Matrix for the Cisco cBR Series Routers 2
Prerequisites for Call Home 2
Restrictions for Call Home 3
Information About Call Home 3
Benefits of Call Home 4
Obtaining Smart Call Home Services 4
Anonymous Reporting 5
Smart Licensing 5
How to Configure Call Home 5
Configuring Smart Call Home (Single Command) 5
Configuring Call Home 6
Enabling and Disabling Call Home 7
Configuring Contact Information 7
Configuring Destination Profiles 9
Creating a New Destination Profile 10
Copying a Destination Profile 12
Renaming a Destination Profile 13
Setting Profiles to Anonymous Mode 13
Subscribing to Alert Groups 14
Periodic Notification 16
Message Severity Threshold 17
Syslog Pattern Matching 18
Configuring Snapshot Command List 18
Configuring General Email Options 19
Configuring the Mail Server 19
Specifying Rate Limit for Sending Call Home Messages 21
Specifying HTTP Proxy Server 22
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
iii
Contents
Enabling AAA Authorization to Run Cisco IOS Commands for Call Home
Messages 22
Configuring Syslog Throttling 23
Configuring Call Home Data Privacy 24
Sending Call Home Messages Manually 25
Sending a Call Home Test Message Manually 25
Sending Call Home Alert Group Messages Manually 25
Submitting Call Home Analysis and Report Requests 26
Manually Sending Command Output Message for One Command or a Command
List 27
Configuring Diagnostic Signatures 29
Prerequisites for Diagnostic Signatures 29
Information About Diagnostic Signatures 29
Diagnostic Signature Overview 29
Diagnostic Signature Downloading 30
Diagnostic Signature Signing 31
Diagnostic Signature Workflow 31
Diagnostic Signature Events and Actions 31
Diagnostic Signature Event Detection 32
Diagnostic Signature Actions 32
Action Types 33
Diagnostic Signature Variables 33
How to Configure Diagnostic Signatures 34
Configuring the Service Call Home for Diagnostic Signatures 34
Configuring Diagnostic Signatures 36
Verifying the Call Home Configuration 37
Configuration Example for Call Home 41
Example: Call Home Configuration 41
Example: Configuring HTTP Transport for Call Home on the Cisco cBR Series Router 42
Example: Configuring Email Transport for Call Home on the Cisco cBR Series Router 44
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
iv
Default Settings 46
Alert Groups Trigger Events and Commands 47
Message Contents 51
Sample syslog Alert Notification in XML Format 55
Additional References 63
Contents
Feature Information for Call Home 64
CHAPTER 2
SNMP Support over VPNs—Context-Based Access Control 67
Finding Feature Information 67
Hardware Compatibility Matrix for the Cisco cBR Series Routers 68
Restrictions for SNMP Support over VPNs—Context-Based Access Control 68
Information About SNMP Support over VPNs—Context-Based Access Control 69
SNMP Versions and Security 69
SNMPv1 or SNMPv2 Security 69
SNMPv3 Security 69
SNMP Notification Support over VPNs 70
VPN-Aware SNMP 70
VPN Route Distinguishers 71
SNMP Contexts 71
How to Configure SNMP Support over VPNs—Context-Based Access Control 72
Configuring an SNMP Context and Associating the SNMP Context with a VPN 72
Configuring SNMP Support and Associating an SNMP Context 73
Configuration Examples for SNMP Support over VPNs—Context-Based Access Control 76
CHAPTER 3
CHAPTER 4
Example: Configuring Context-Based Access Control 76
Additional References 77
Feature Information for SNMP Support over VPNs—Context-Based Access Control 79
SNMP Engine Enhancement 81
Hardware Compatibility Matrix for the Cisco cBR Series Routers 81
Restrictions for SNMP Cache Engine Enhancement 82
Information About SNMP Cache Engine Enhancement 82
How to Configure SNMP Cache Engine Enhancement 83
Verifying the SNMP Cache Engine Status 84
Additional References 85
Feature Information for SNMP Cache Engine Enhancement 85
Onboard Failure Logging 87
Finding Feature Information 87
Hardware Compatibility Matrix for the Cisco cBR Series Routers 88
Understanding OBFL 88
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
v
Contents
Configuring OBFL 89
Displaying OBFL Logging Information 89
Clearing OBFL Logging 89
Configuration and Verification Examples 90
Feature Information for Onboard Failure Logging 95
CHAPTER 5
Control Point Discovery 97
Hardware Compatibility Matrix for the Cisco cBR Series Routers 97
Prerequisites for Control Point Discovery 98
Restrictions for Control Point Discovery 98
Information About Control Point Discovery 99
Control Points 99
Network Layer Signaling (NLS) 99
NLS for CPD 99
NLS Flags 99
NLS TLVs 100
Control Point Discovery 100
CPD Protocol Hierarchy 100
Control Relationship 101
How to Configure CPD 101
Enabling CPD Functionality 101
Examples for CPD Enable 102
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
vi
Debugging CPD Functionality 102
Configuring Control Relationship Identifier 102
Examples 103
Enabling NLS Functionality 103
Examples 104
Debugging NLS Functionality 104
Configuring Authorization Group Identifier and Authentication Key 104
Examples 105
Configuring NLS Response Timeout 105
Examples 106
Additional References 106
Feature Information for Control Point Discovery 107
Contents
CHAPTER 6
IPDR Streaming Protocol 109
Restrictions for Configuring IPDR Streaming Protocol 110
Information About IPDR Streaming Protocol 110
Data Collection Methodologies 110
How to Configure IPDR Streaming Protocol 111
Configuring the IPDR Session 111
Configuring the IPDR Type 112
Configuring the IPDR Collector 113
Configuring the IPDR Associate 113
Configuring the IPDR Template 114
Configuring the IPDR Exporter 115
Configuration Examples for IPDR Streaming Protocol 116
Example: Configuring the IPDR Session 116
Example: Configuring the IPDR Type 116
Example: Configuring the IPDR Collector 117
Example: Configuring the IPDR Associate 117
CHAPTER 7
Example: Configuring the IPDR Template 117
Example: Configuring the IPDR Exporter 117
Verifying IPDR Streaming Protocol 117
Verifying the IPDR Collector 118
Verifying IPDR exporter 118
Verifying IPDR session 118
Verifying IPDR Session Collector 119
Verifying IPDR Session Template 119
Additional References 119
Feature Information for IPDR Streaming Protocol 120
Usage-Based Billing (SAMIS) 121
Hardware Compatibility Matrix for the Cisco cBR Series Routers 122
Prerequisites for Usage-Based Billing (SAMIS) 122
Restrictions for Usage-based Billing 123
Information About Usage-based Billing 124
Feature Overview 124
Usage-Based Billing and DOCSIS Support on the Cisco CMTS Routers 125
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
vii
Contents
Standards 125
IPDR Service Definition Schemas 125
IPDR CM-STATUS-2008 126
DOCSIS SAMIS Service Definitions 127
Limitation To DOCSIS SAMIS 127
DOCSIS Diagnostic Log Service Definitions 127
DOCSIS Spectrum Measurement Service Definition 128
DOCSIS CMTS CM Registration Status Service Definition 128
DOCSIS CMTS CM Upstream Status Service Definition 128
DOCSIS CMTS Topology Service Definition 129
DOCSIS CPE Service Definition 129
DOCSIS CMTS Utilization Statistics Service Definition 129
Modes of Operation 130
Billing Record Format 130
SNMP Support 134
Benefits 135
How to Configure the Usage-based Billing Feature 135
Enabling Usage-based Billing Feature File Mode Using CLI Commands 135
Enabling Usage-based Billing Feature File Mode Using SNMP Commands 137
Examples for Enabling Usage Billing using SNMP Mode 140
Enabling Usage-based Billing Feature Streaming Mode Using CLI Commands 141
Enabling Usage-based Billing Feature Streaming Mode Using SNMP Commands 142
Examples for SNMP Commands 163
Enabling and Configuring the Secure Copy Protocol (optional) 164
Configuring the Cisco CMTS for SSL Operation 166
Prerequisites for CA 166
Retrieving Records from a Cisco CMTS in File Mode 167
Using SCP 168
Using TFTP 168
Using SNMP 169
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
viii
Using SNMP 174
Examples To Transfer Using SNMP 175
Disabling the Usage-based Billing Feature 176
Configuring Certified SSL Servers for Usage-Based Billing 177
Generating SSL Server Certification 178
Contents
Configuring and Testing the Cisco CMTS for Certified SSL Server Support 178
Monitoring the Usage-based Billing Feature 180
Configuration Examples for Usage-based Billing 181
File Mode Configuration (with Secure Copy) 181
Non-Secure Streaming Mode Configuration 181
Secure Streaming Mode Configuration 182
CHAPTER 8
CHAPTER 9
Frequency Allocation Information for the Cisco CMTS Routers 183
Frequency Allocation for the Cisco CMTS Routers 183
Flap List Troubleshooting 195
Finding Feature Information 195
Hardware Compatibility Matrix for the Cisco cBR Series Routers 196
Prerequisites for Flap List Troubleshooting 196
Restrictions for Flap List Troubleshooting 197
Information About Flap List Troubleshooting 197
Feature Overview 197
Information in the Flap List 197
Cisco Cable Manager and Cisco Broadband Troubleshooter 199
Benefits 199
How to Configure Flap List Troubleshooting 199
Configuring Flap List Operation Using the CLI (optional) 200
Clearing the Flap List and Counters Using the CLI (optional) 201
Enabling or Disabling Power Adjustment Using the CLI (optional) 202
Configuring Flap List Operation Using SNMP (optional) 204
Clearing the Flap List and Counters Using SNMP (optional) 205
How to Monitor and Troubleshoot Using Flap Lists 206
Displaying the Flap List Using the show cable flap-list Command 206
Displaying the Flap List Using the show cable modem flap Command 206
Displaying the Flap List Using SNMP 207
Displaying Flap-List Information for Specific Cable Modems 209
Example 209
Troubleshooting Suggestions 210
Troubleshooting Tips 210
Performing Amplitude Averaging 211
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
ix
Contents
Using Other Related Commands 212
Configuration Examples for Flap List Troubleshooting 213
Additional References 213
Feature Information for Flap List Troubleshooting 214
CHAPTER 10
Maximum CPE and Host Parameters 217
Finding Feature Information 217
Hardware Compatibility Matrix for the Cisco cBR Series Routers 218
Information About the MAX CPE and Host Parameters 218
MAX CPE 219
MAX Host 220
Specifying an Unlimited Value for Max Host 220
MAX CPE IP 221
MAX CPE IPv6 221
Interoperation of the Maximum CPE Parameters 221
Benefits 222
How to Configure the MAX CPE and Host Parameters 222
Configuring the Maximum Number of CPE Devices on the Cisco CMTS 223
Configuration Examples 224
Additional References 225
Feature Information for Maximum CPE and Host Parameters 226
CHAPTER 11
CHAPTER 12
Guide for Cisco IOS XE Fuji 16.8.x
x
SNMP Background Synchronization 227
Information About SNMP Background Synchronization 227
How to Configure SNMP Background Synchronization 228
Enabling SNMP Background Synchronization 228
Setting Data Interval 228
Verifying SNMP Background Synchronization 229
Configuring Example for SNMP Background Synchronization 234
Feature Information for SNMP Background Synchronization 235
Online Offline Diagnostics 237
Overview of Online Offline Diagnostics 237
Benefits of Online Offline Diagnostics 238
Prerequisites for Online Offline Diagnostics 238
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Contents
Restrictions for Online Offline Diagnostics 238
How to Configure Online Offline Diagnostics 239
Configuring Field Diagnostic Test 239
Verifying the Testing Process 239
Removing the Field Diagnostic Image from a Line Card 239
Configuration Example for Online Offline Diagnostics 239
Feature Information for Online Offline Diagnostics 240
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
xi
Contents
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
xii
CHAPTER 1
Call Home
Call Home offers diagnostics and real-time alerts on select Cisco devices, which provide higher network
availability and increased operational efficiency. Smart Call Home is a secure connected service of Cisco
SMARTnet for the Cisco cBR routers.
Finding Feature Information
Your software release may not support all the features that are documented in this module. For the latest
feature information and caveats, see the release notes for your platform and software release. The Feature
Information Table at the end of this document provides information about the documented features and lists
the releases in which each feature is supported.
Use Cisco Feature Navigator to find information about the platform support and Cisco software image
support. To access Cisco Feature Navigator, go to the link http://tools.cisco.com/ITDIT/CFN/. You do not
require a cisco.com login account.
Contents
Hardware Compatibility Matrix for the Cisco cBR Series Routers, page 2
•
Prerequisites for Call Home, page 2
•
Restrictions for Call Home, page 3
•
Information About Call Home, page 3
•
How to Configure Call Home, page 5
•
Configuring Diagnostic Signatures, page 29
•
Verifying the Call Home Configuration, page 37
•
Configuration Example for Call Home, page 41
•
Default Settings, page 46
•
Alert Groups Trigger Events and Commands, page 47
•
Message Contents, page 51
•
Additional References, page 63
•
Feature Information for Call Home, page 64
•
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
1
Call Home
Hardware Compatibility Matrix for the Cisco cBR Series Routers
Hardware Compatibility Matrix for the Cisco cBR Series Routers
Note
The hardware components that are introduced in a given Cisco IOS-XE Release are supported in all
subsequent releases unless otherwise specified.
Table 1: Hardware Compatibility Matrix for the Cisco cBR Series Routers
Interface CardsProcessor EngineCisco CMTS Platform
Cisco cBR-8 Converged
Broadband Router
Cisco IOS-XE Release 16.5.1 and
Later Releases
Cisco cBR-8 Supervisor:
• PID—CBR-SUP-250G
• PID—CBR-CCAP-SUP-160G
• PID—CBR-CCAP-SUP-60G
• PID—CBR-SUP-8X10G-PIC
Cisco IOS-XE Release 16.5.1 and
Later Releases
Cisco cBR-8 CCAP Line Cards:
• PID—CBR-LC-8D30-16U30
• PID—CBR-LC-8D31-16U30
• PID—CBR-RF-PIC
• PID—CBR-RF-PROT-PIC
• PID—CBR-CCAP-LC-40G-R
Cisco cBR-8 Downstream PHY
Modules:
• PID—CBR-D30-DS-MOD
• PID—CBR-D31-DS-MOD
Prerequisites for Call Home
Contact email address (required for full registration with Smart Call Home, optional if Call Home is
•
enabled in anonymous mode), phone number (optional), and street address information (optional) must
be configured so that the receiver can determine the origin of messages received.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
2
Cisco cBR-8 Upstream PHY
Modules:
• PID—CBR-D30-US-MOD
• PID—CBR-D31-US-MOD
Call Home
Restrictions for Call Home
Note
At least one destination profile (predefined or user-defined) must be configured. The destination profiles
•
configured depends on whether the receiving entity is a pager, e-mail, or automated service such as
Cisco Smart Call Home.
The router must have IP connectivity to an email server or the destination HTTP(S) server.
•
To use Cisco Smart Call Home service, you require an active service contract covering the device, which
•
provides full Smart Call Home service.
Note
Contact email address is not required if you enable Smart Call Home by enabling smart
licensing.
If the destination profile uses email message delivery, you must specify a Simple Mail Transfer
◦
Protocol (SMTP) server.
Configuring the trustpool certificate authority (CA) is not required for HTTPS server connection
◦
as the trustpool feature is enabled by default.
An active service contract is only required for full Smart Call Home services like
automatically raising a Cisco Technical Assistance Center (TAC) case.
Restrictions for Call Home
If there is no IP connectivity or if the interface in the VRF to the profile destination is down, Smart Call
•
Home messages cannot be sent.
Smart Call Home operates with any SMTP server.
•
You can configure up to five SMTP servers for Smart Call Home.
•
Information About Call Home
The Call Home feature provides email-based and web-based notification of critical system events. A versatile
range of message formats are available for optimal compatibility with pager services, standard email, or
XML-based automated parsing applications.
Common uses of this feature may include:
Direct paging of a network support engineer
•
Email notification to a network operations center
•
XML delivery to a support website
•
Use of Cisco Smart Call Home services for direct case generation with the Cisco Technical Assistance
•
Center (TAC).
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
3
Benefits of Call Home
The Call Home feature can deliver alert messages containing information on configuration, environmental
conditions, inventory, syslog, snapshot, and crash events.
The Call Home feature can deliver alerts to multiple recipients, which are seen as Call Home destination
profiles, each with configurable message formats and content categories. A predefined destination profile
(CiscoTAC-1) is provided, and you can also define your own destination profiles. The CiscoTAC-1 profile
is used to send alerts to the backend server of the Smart Call Home service. It can be used to create service
requests to Cisco TAC. This service depends on the Smart Call Home service support in place for your device
and the severity of the alert.
Flexible message delivery and format options make it easy to integrate specific support requirements.
Benefits of Call Home
Automatic execution and attachment of the relevant CLI command output.
•
Multiple message-format options such as the following:
•
◦ Short Text—Suitable for pagers or printed reports.
Call Home
◦ Full Text—Fully formatted message information suitable for human reading.
◦ XML—Matching readable format using Extensible Markup Language (XML). The XML format
enables communication with the Cisco TAC.
Multiple concurrent message destinations.
•
Multiple message categories including configuration, crash, diagnostic, environment, inventory, snapshot,
•
and syslog.
Filtering of messages based on the severity and pattern matching.
•
Scheduling of periodic message sending.
•
Obtaining Smart Call Home Services
If you have a service contract directly with Cisco, you can register for the Smart Call Home service. Smart
Call Home analyzes Smart Call Home messages and provides background information and recommendations.
For critical issues, Automatic Service Requests are generated with the Cisco TAC.
Smart Call Home offers the following features:
Continuous device health monitoring and real-time alerts.
•
Analysis of Smart Call Home messages and, if needed, Automatic Service Request generation that is
•
routed to the correct TAC team, including detailed diagnostic information to speed the problem resolution.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
4
Secure message transport directly from your device or through an HTTP proxy server or a downloadable
•
Transport Gateway (TG). You can use a TG aggregation point to support multiple devices or in cases
where security dictates that your devices may not be connected directly to the Internet.
Web-based access to Smart Call Home messages and recommendations, inventory, and configuration
•
information for all Smart Call Home devices provides access to associated field notices, security
advisories, and end-of-life information.
Call Home
You need the following items to register for Smart Call Home:
SMARTnet contract number for your router.
•
Your email address
•
Your Cisco.com username
•
For information about how to configure Call Home to work with the Smart Call Home service, see the Smart
Call Home.
Anonymous Reporting
Smart Call Home is a service capability that is included with many Cisco service contracts and is designed
to assist you help resolve problems quickly. In addition, the information gained from crash messages helps
Cisco understand equipment and issues occurring in the field. If you decide not to use Smart Call Home, you
can still enable Anonymous Reporting to allow Cisco to securely receive minimal error and health information
from the device. If you enable Anonymous Reporting, your customer identity remains anonymous, and no
identifying information is sent.
How to Configure Call Home
Note
When you enable Anonymous Reporting, you acknowledge your consent to transfer the specified data to
Cisco or to vendors operating on behalf of Cisco (including countries outside the United States). Cisco
maintains the privacy of all customers. For information about how Cisco treats personal information, see
the Cisco Privacy Statement at Cisco Online Privacy Statement.
When Call Home is configured in an anonymous way, only crash, inventory, and test messages are sent to
Cisco. No identifying information is sent.
For more information about what is sent in these messages, see the Alert Group Trigger Events and Commands
section.
Smart Licensing
Smart Licensing uses the Smart Call Home service.
The Smart Licensing service is an alternative licensing architecture to Cisco Software Licensing (CSL). Smart
Licensing uses the Cisco Smart Software Manager as a backend tool for managing licenses. Smart Call Home
must be configured before using the Smart Licensing. By default, Smart Licensing and Smart Call Home are
enabled on the Cisco cBR routers.
For more information about Smart Licensing, see the Cisco Smart Licensing on the Cisco cBR Router topic.
How to Configure Call Home
Configuring Smart Call Home (Single Command)
Smart Call Home is enabled by default on the router. The CiscoTAC-1 profile to send data to Cisco is also
enabled by default.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
5
Configuring Call Home
SUMMARY STEPS
DETAILED STEPS
Call Home
The single command is not used to enable Smart Call Home on the router unless you change to anonymous
mode or add HTTP proxy using the single command.
To enable all Call Home basic configurations using a single command, perform the following steps:
configure terminal
1.
call-home reporting {anonymous | contact-email-addr email-address} [http-proxy {ipv4-address |
2.
ipv6-address | name} port port number]
PurposeCommand or Action
Step 1
Step 2
Example:
Device# configure terminal
contact-email-addr email-address}
[http-proxy {ipv4-address |
ipv6-address | name} port port number]
Example:
Device(config)# call-home reporting
contact-email-addr
email@company.com
Enters global configuration mode.configure terminal
Enables all Call Home basic configurations using a single command.call-home reporting {anonymous |
• anonymous—Enables Call-Home TAC profile to only send crash, inventory,
test messages, and send the messages in an anonymous way.
• contact-email-addr—Enables Smart Call Home service full reporting
capability and sends a full inventory message from the Call-Home TAC profile
to the Smart Call Home server to start full registration process.
• http-proxy {ipv4-address | ipv6-address | name—An IPv4 or IPv6 address
or server name. Maximum length is 64.
• port port number—Port number. Range is 1 to 65535.
Note
HTTP proxy option allows you to set your own proxy server to buffer and
secure the internet connections from your devices.
Note
After successfully enabling Call Home either in anonymous or full
registration mode using the call-home reporting command, an inventory
message is sent out. If Call Home is enabled in anonymous mode, an
anonymous inventory message is sent out. If Call Home is enabled in full
registration mode, a Full Inventory message for full registration mode is
sent. For more information about what is sent in these messages, see the
Alert Groups Trigger Events and Commands, on page 47 topic.
Configuring Call Home
For security reasons, we recommend that you use the HTTPS transport options, due to the additional payload
encryption that HTTPS offers. The Transport Gateway software is downloadable from Cisco.com and is
available if you require an aggregation point or a proxy for connection to the Internet.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
6
Call Home
The implementation on the router supports the trustpool feature (embedded CA certificates in Cisco IOS
images). The trustpool feature simplifies configuration to enable Smart Call Home service on configured
devices. It eliminates the requirement of manually configuring the trustpool and provides the automatic update
of the CA certificate, if it changes in the future.
Enabling and Disabling Call Home
To enable or disable the Call Home feature, complete the following steps:
SUMMARY STEPS
configure terminal
1.
service call-home
2.
no service call-home
3.
DETAILED STEPS
Configuring Call Home
Step 1
Example:
Router# configure terminal
Step 2
Example:
Router(config)# service call-home
Step 3
Example:
Router(config)# no service call-home
Configuring Contact Information
Each router must include a contact email address. You can optionally include a phone number, street address,
contract ID, customer ID, and site ID.
To assign the contact information, complete the following steps:
PurposeCommand or Action
Enters global configuration mode.configure terminal
Enables the Call Home feature.service call-home
Disables the Call Home feature.no service call-home
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
7
Configuring Call Home
SUMMARY STEPS
DETAILED STEPS
configure terminal
1.
call-home
2.
contact-email-addr email-address
3.
phone-number +phone-number
4.
street-address street-address
5.
customer-id text
6.
site-id text
7.
contract-id text
8.
Call Home
PurposeCommand or Action
Step 1
Step 2
Step 3
Step 4
Step 5
Example:
Router> configure terminal
Example:
Router(config)# call-home
contact-email-addr email-address
Example:
Router(cfg-call-home)# contact-email-addr
username@example.com
phone-number +phone-number
Example:
Router(cfg-call-home)# phone-number
+1-222-333-4444
street-address street-address
Example:
Router(cfg-call-home)# street-address “1234
Any Street, Any city, Any state, 12345”
Enters global configuration mode.configure terminal
Enters call home configuration mode.call-home
Assigns the customer’s email address. Enter up to 200 characters
in email address format with no spaces.
(Optional) Assigns the customer’s phone number.
Note
The number must begin with a plus (+) prefix, and may
contain only dashes (-) and numbers. Enter up to 16
characters. If you include spaces, you must enclose your
entry within double quotation marks (“ ”).
(Optional) Assigns the customer’s street address where RMA
equipment can be shipped. Enter up to 200 characters. If you include
spaces, you must enclose your entry within double quotation marks
(“ ”).
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
8
Call Home
Configuring Call Home
PurposeCommand or Action
Step 6
customer-id text
Example:
Router(cfg-call-home)# customer-id
Customer1234
Step 7
site-id text
Example:
Router(cfg-call-home)# site-id
Site1ManhattanNY
Step 8
contract-id text
Example:
Router(cfg-call-home)# contract-id
Company1234
Configuring Destination Profiles
A destination profile contains the required delivery information for an alert notification. At least one destination
profile is required. You can configure multiple destination profiles of one or more types.
You can create and define a new destination profile or copy and use the predefined destination profile. If you
define a new destination profile, you must assign a profile name. You can control which profile to be used
for Smart Licensing by enabling or disabling smart-licensing data of that profile. Only one active profile can
have smart-license data enabled.
(Optional) Identifies the customer ID. Enter up to 64 characters. If
you include spaces, you must enclose your entry within double
quotation marks (“ ”).
(Optional) Identifies the customer site ID. Enter up to 200
characters. If you include spaces, you must enclose your entry
within double quotation marks (“ ”).
(Optional) Identifies the customer’s contract ID for the router. Enter
up to 64 characters. If you include spaces, you must enclose your
entry within double quotation marks (“ ”).
If you use the Smart Call Home service, the destination profile must use the XML message format.Note
A destination profile includes the following information:
• Profile name—String that uniquely identifies each user-defined destination profile. The profile name is
limited to 31 characters and is not case-sensitive. You cannot use all as a profile name.
• Transport method—Transport mechanism, either email or HTTP (including HTTPS), for delivery of
alerts.
For user-defined destination profiles, email is the default, and you can enable either or both transport
◦
mechanisms. If you disable both methods, email is enabled.
For the predefined CiscoTAC-1 profile, you can enable either transport mechanism, but not both.
◦
• Destination address—The actual address that is related to the transport method by which the alert is
sent. You can change the destination of the CiscoTAC-1 profile.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
9
Configuring Call Home
Call Home
• Message formatting—The message format that is used for sending the alert. The format options for a
user-defined destination profile are long-text, short-text, or XML. The default is XML. For the predefined
CiscoTAC-1 profile, only XML is allowed.
• Message size—The maximum destination message size. The valid range is 50 to 3,145,728 bytes. The
default is 3,145,728 bytes.
• Reporting method—You can choose which data to report for a profile. You can enable reporting of
Smart Call Home data or Smart Licensing data, or both. Only one active profile is allowed to report
Smart Licensing data at a time.
• Anonymous reporting—You can choose for your customer identity to remain anonymous, and no
identifying information is sent.
• Subscribing to interesting alert-groups—You can choose to subscribe to alert-groups highlighting your
interests.
• Message severity level—The Call Home severity level that the alert must meet before a Call Home
message is generated to all email addresses in the destination profile. An alert is not generated if the
Call Home severity level of the alert is lower than the message severity level set for the destination
profile.
You can also configure a destination profile to allow periodic inventory update messages by using the inventory
alert group.
A predefined destination profile CiscoTAC-1 is supported. It supports the XML message format. This profile
is preconfigured with the Cisco Smart Call Home server HTTPS URL, email address to reach the server,
maximum message size, and message severity level for each alert group.
Important
We recommend that you do not use the message severity level 0. If you use message severity level 0, all
syslogs will trigger Call Home messages, which can cause CPU and memory issues.
This section contains the following:
Creating a New Destination Profile
DETAILED STEPS
Step 1
Example:
Router> enable
Step 2
PurposeCommand or Action
Enables privileged EXEC mode.enable
Enter your password, if prompted.
•
Enters global configuration mode.configure terminal
Example:
Router# configure terminal
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
10
Call Home
Configuring Call Home
PurposeCommand or Action
Step 3
Step 4
Step 5
Step 6
Step 7
Example:
Router(config)# call-home
profile name
Example:
Router(cfg-call-home)# profile profile1
Example:
Router(cfg-call-home-profile)# destination
transport-method email
destination address {email email-address | http
url}
Example:
Router(cfg-call-home-profile)# destination
address email myaddress@example.com
destination preferred-msg-format {long-text |
short-text | xml}
Enters Call Home configuration mode.call-home
Enters the Call Home destination profile configuration mode for
the specified destination profile. If the specified destination profile
does not exist, it is created.
(Optional) Enables the message transport method.destination transport-method {email | http}
• email—Sets the email message transport method.
• http—Sets the HTTP message transport method.
Note
The no option disables the
method.
Configures the destination email address or URL to which Call
Home messages are sent.
Note
When entering a destination URL, include either http://
or https://, depending on whether the server is a secure
server. If the destination is a secure server, you must also
configure a trustpool CA.
(Optional) Configures a preferred message format. The default
is XML.
Step 8
Step 9
Step 10
Example:
Router(cfg-call-home-profile)# destination
preferred-msg-format xml
destination message-size bytes
Example:
Router(cfg-call-home-profile)# destination
message-size 3,145,728
active
Example:
Router(cfg-call-home-profile)# active
smart-licensing-data}
Example:
Router(cfg-call-home-profile)# reporting
smart-call-home-data
• long-text—Configures the long text message format.
• short-text—Configures the short text message format.
• xml—Configures the XML message format.
(Optional) Configures a maximum destination message size for
the destination profile.
Enables the destination profile. By default, the profile is enabled
when it is created.
If you activate a profile which enables smart-licensing data while
smart-licensing data is already being reported in another active
profile, you will receive an error message.
Configures the type of data to report for a profile.reporting {all | smart-call-home-data |
You can select either to report Smart Call Home data or Smart
Licensing data. Selecting the all option reports data for both types
of data.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
11
Configuring Call Home
Call Home
PurposeCommand or Action
Step 11
Example:
Router(cfg-call-home-profile)# end
Step 12
show call-home profile {name | all}
Example:
Router# show call-home profile profile1
Step 13
show call-home smart-licensing
Example:
Router# show call-home smart-licensing
Step 14
Example:
Router# show call-home smart-licensing
statistics
Copying a Destination Profile
Returns to privileged EXEC mode.end
Displays destination profile configuration for the specified profile
or all configured profiles.
Displays the current Call Home Smart Licensing settings for the
configured destination profiles.
Displays the Call Home Smart Licensing statistics.show call-home smart-licensing statistics
You can create a new destination profile by copying an existing profile.
DETAILED STEPS
Step 1
Step 2
Step 3
Step 4
Example:
Router> enable
Example:
Router# configure terminal
Example:
Router(config)# call-home
copy profile source-profile target-profile
Example:
Router(cfg-call-home)# copy profile
profile1 profile2
PurposeCommand or Action
Enables privileged EXEC mode.enable
Enter your password, if prompted.
•
Enters global configuration mode.configure terminal
Enters Call Home configuration mode.call-home
Creates a new destination profile with the same configuration
settings as the existing destination profile.
• source-profile—Name of the source destination profile.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
12
Call Home
Renaming a Destination Profile
DETAILED STEPS
Configuring Call Home
PurposeCommand or Action
• target-profile—Name of the target or new destination
profile.
PurposeCommand or Action
Step 1
Example:
Router> enable
Step 2
Example:
Router# configure terminal
Step 3
Example:
Router(config)# call-home
Step 4
rename profile source-profile target-profile
Example:
Router(cfg-call-home)# rename profile profile1
profile2
Setting Profiles to Anonymous Mode
Enables privileged EXEC mode.enable
Enter your password, if prompted.
•
Enters global configuration mode.configure terminal
Enters Call Home configuration mode.call-home
Renames the existing destination profile.
• source-profile—Name of the source destination profile.
• target-profile—Name of the target destination profile.
DETAILED STEPS
Step 1
Example:
Router> enable
PurposeCommand or Action
Enables privileged EXEC mode.enable
Enter your password, if prompted.
•
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
13
Configuring Call Home
Call Home
PurposeCommand or Action
Step 2
Example:
Router# configure terminal
Step 3
Example:
Router(config)# call-home
Step 4
profile name
Example:
Router(cfg-call-home)# profile profile1
Step 5
Example:
Router(cfg-call-home-profile)#
anonymous-reporting-only
Subscribing to Alert Groups
Enters global configuration mode.configure terminal
Enters Call Home configuration mode.call-home
Enters the Call Home destination profile configuration mode for
the specified destination profile. If the specified destination profile
does not exist, it is created.
Sets the profile to anonymous mode.anonymous-reporting-only
Note
By default, the profile sends a full report of all types of
events that are subscribed in the profile. When
anonymous-reporting-only is set, only crash, inventory,
and test messages are sent.
Note
An alert group is a predefined subset of Call Home alerts that are supported. A destination profile can receive
one or more selected alert groups.
Configuration
•
Crash
•
Diagnostic
•
Environment
•
Inventory
•
Snapshot
•
Syslog
•
The triggering events for each alert group are listed in the Alert Groups Trigger Events and Commands, and
the contents of the alert group messages are listed in the Message Contents.
Call Home alerts are only sent to destination profiles that have subscribed to the alert group containing
that Call Home alert. The alert group must be enabled. The Call Home event severity must be at or above
the message severity set in the destination profile.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
14
Call Home
DETAILED STEPS
Configuring Call Home
PurposeCommand or Action
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Example:
Router> enable
Example:
Router# configure terminal
Example:
Router(config)# call-home
alert-group {all | configuration | crash | diagnostic |
environment | inventory | snapshot | syslog}
Example:
Router(cfg-call-home)# alert-group all
profile name
Example:
Router(cfg-call-home)# profile profile1
subscribe-to-alert-group configuration [periodic
{daily hh:mm | monthly date hh:mm | weekly day
hh:mm}]
Enables privileged EXEC mode.enable
Enter your password, if prompted.
•
Enters global configuration mode.configure terminal
Enters Call Home configuration mode.call-home
Enables the specified alert group. Use the keyword all to enable
all alert groups. By default, all alert groups are enabled.
Enters the Call Home destination profile configuration mode
for the specified destination profile. If the specified destination
profile does not exist, it is created.
Subscribes this destination profile to the Configuration alert
group. The Configuration alert group can be configured for
periodic notification.
Step 7
Step 8
Example:
Router(cfg-call-home-profile)#
subscribe-to-alert-group configuration
periodic daily 12:00
subscribe-to-alert-group crash
Example:
Router(cfg-call-home-profile)#
subscribe-to-alert-group crash
subscribe-to-alert-group diagnostic [severity
{catastrophic | disaster | fatal | critical | major | minor
| warning | notification | normal | debugging}]
Example:
Router(cfg-call-home-profile)#
subscribe-to-alert-group syslog severity major
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
Subscribes to the Crash alert group in the user profile. By
default, Cisco TAC profile subscribes to the Crash alert group
and cannot be unsubscribed.
Subscribes this destination profile to the Diagnostic alert group.
The Diagnostic alert group can be configured to filter messages
based on severity.
for Cisco IOS XE Fuji 16.8.x
15
Configuring Call Home
Call Home
PurposeCommand or Action
Step 9
Step 10
Step 11
Step 12
subscribe-to-alert-group environment [severity
{catastrophic | disaster | fatal | critical | major | minor
| warning | notification | normal | debugging}]
Example:
Router(cfg-call-home-profile)#
subscribe-to-alert-group environment severity
major
subscribe-to-alert-group inventory [periodic {daily
hh:mm | monthly date hh:mm | weekly day hh:mm}]
Example:
Router(cfg-call-home-profile)#
subscribe-to-alert-group inventory
periodic daily 12:00
subscribe-to-alert-group snapshot [periodic {daily
hh:mm | monthly date hh:mm | weekly day hh:mm |
hourly mm | interval mm}]
Example:
Router(cfg-call-home-profile)#
subscribe-to-alert-group snapshot
periodic daily 12:00
subscribe-to-alert-group syslog [severity
{catastrophic | disaster | fatal | critical | major | minor
| warning | notification | normal | debugging}]
[pattern string]
Example:
Router(cfg-call-home-profile)#
subscribe-to-alert-group syslog severity major
Subscribes this destination profile to the Environment alert
group. The Environment alert group can be configured to filter
messages based on severity.
Subscribes this destination profile to the Inventory alert group.
The Inventory alert group can be configured for periodic
notification.
Subscribes this destination profile to the Snapshot alert group.
The Snapshot alert group can be configured for periodic
notification.
By default, the Snapshot alert group has no command to run.
You can add commands into the alert group. The output of
commands that are added in the Snapshot alert group are
included in the snapshot message.
Subscribes this destination profile to the Syslog alert group.
The Syslog alert group can be configured to filter messages
based on the severity. You can specify a pattern to be matched
in the syslog message. If the pattern contains spaces, you must
enclose it in quotes (").
You can specify a text pattern to be matched within each syslog
message. If you configure a pattern, a Syslog alert group
message is sent only if it contains the specified pattern and meets
the severity threshold. If the pattern contains spaces, you must
enclose it in quotes ("). You can specify up to five patterns for
each destination profile.
Step 13
Example:
Router(cfg-call-home-profile)#
subscribe-to-alert-group all
Periodic Notification
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
16
(Optional) Subscribes to all available alert groups.subscribe-to-alert-group all
Important
Entering this command generates many syslog
messages. We recommend that you subscribe to
alert groups individually, using appropriate
severity levels and patterns when possible.
When you subscribe a destination profile to either the Configuration, Inventory, or Snapshot alert group, you
can choose to receive the alert group messages asynchronously or periodically at a specified time. The following
time intervals are available:
Call Home
• Daily—Specify the time of day to send, using an hour:minute format hh:mm, with a 24-hour clock (for
example, 14:30).
• Weekly—Specify the day of the week and time of day in the format day hh:mm, where the day of the
week is spelled out (for example, Monday).
• Monthly—Specify the numeric date, from 1 to 31, and the time of day, in the format date hh:mm.
• Interval—Specifies the interval at which the periodic message is sent, from 1 to 60 minutes.
• Hourly—Specifies the minute of the hour at which the periodic message is sent, from 0 to 59 minutes.
Hourly and by interval periodic notifications are available for the Snapshot alert group only.Note
Message Severity Threshold
Call Home allows you to filter messages based on severity. You can associate each predefined or user-defined
destination profile with a Call Home threshold from 0 (least urgent) to 9 (most urgent). The default is 0 (all
messages are sent).
When you subscribe a destination profile to the Environment or Syslog alert group, you can set a threshold
for relay of alert group messages that are based on the message severity level. Any message with a value lower
than the destination profile threshold is not sent to the destination.
Subscribing to an alert group in a destination profile with a specified severity would also subscribe you to
messages triggered by the events that have same or higher severity in that alert group.
Configuring Call Home
Note
Subscribing to syslog message at low severity level is not recommended. This would trigger too many
syslog messages that would lower the system performance.
Call Home severity levels are not the same as the system message logging severity levels.Note
Table 2: Severity and Syslog Level Mapping
DescriptionSyslog LevelKeywordSmart Call Home
Level
catastrophic9
disaster8
—
—
Network-wide catastrophic failure.
Significant network impact.
System is unusable.Emergency (0)fatal7
Alert (1)critical6
Critical conditions that indicate that
immediate attention is needed.
Major conditions.Critical (2)major5
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
17
Configuring Call Home
Call Home
DescriptionSyslog LevelKeywordSmart Call Home
Level
Minor conditions.Error (3)minor4
Warning conditions.Warning (4)warning3
Syslog Pattern Matching
When you subscribe a destination profile to the Syslog alert group, you can optionally specify a text pattern
to be matched within each syslog message. If you configure a pattern, a Syslog alert group message is sent
only if it contains the specified pattern and meets the severity threshold. If the pattern contains spaces, you
must enclose it in quotes ("") when configuring. You can specify up to five patterns for each destination
profile.
Configuring Snapshot Command List
To configure the snapshot command list, perform the following steps:
DETAILED STEPS
Notice (5)notification2
Basic notification and informational
messages. Possibly independently
insignificant.
Information (6)normal1
Normal event signifying return to normal
state.
Debugging messages.Debug (7)debugging0
Step 1
Step 2
Step 3
18
PurposeCommand or Action
Enters global configuration mode.configure terminal
Example:
Device# configure terminal
Enters Call Home configuration mode.call-home
Example:
Device(config)# call-home
Enters snapshot configuration mode.[no | default ] alert-group-config snapshot
The no or default command removes the snapshot
Example:
Device(cfg-call-home)# alert-group-config snapshot
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
command.
Loading...