Page 1
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
Page 2
©
2018 Cisco Systems, Inc. All rights reserved.
Page 3
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
Page 4
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
Page 5
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
Page 6
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
Page 7
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
Page 8
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
Page 9
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
Page 10
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
Page 11
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
Page 12
Contents
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
xii
Page 13
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
Page 14
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
Page 15
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
Page 16
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.
Page 17
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
Page 18
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
Page 19
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
Page 20
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
Page 21
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
Page 22
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
Page 23
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
Page 24
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
Page 25
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
Page 26
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
Page 27
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
Page 28
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:
Page 29
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
Page 30
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.
Page 31
Call Home
Configuring Call Home
PurposeCommand or Action
Step 4
[no | default ] add-command command string
Example:
Device(cfg-call-home-snapshot)# add-command
"show version"
Step 5
Example:
Device(cfg-call-home-snapshot)# exit
Configuring General Email Options
Configuring the Mail Server
To use the email message transport, you must configure at least one Simple Mail Transfer Protocol (SMTP)
email server address. You can specify up to four backup email servers, for a maximum of five total mail-server
definitions.
Consider the following guidelines when configuring the mail server:
Adds the command to the Snapshot alert group. The no or
default command removes the corresponding command.
• command string—Cisco IOS command. Maximum
length is 128.
Exits and saves the configuration.end
SUMMARY STEPS
Backup email servers can be defined by repeating the mail-server command using different priority
•
numbers.
The mail-server priority number parameter can be configured from 1 to 100. The server with the highest
•
priority (lowest priority number) is tried first.
To configure general email options, perform the following steps:
configure terminal
1.
call-home
2.
mail-server {ipv4-address | name} priority number
3.
sender from email-address
4.
sender reply-to email-address
5.
source-interface interface-name
6.
source-ip-address ipv4/ipv6 address
7.
vrfvrf-name
8.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
19
Page 32
Configuring Call Home
DETAILED STEPS
Call Home
PurposeCommand or Action
Step 1
Step 2
Step 3
Step 4
Example:
Device# configure terminal
Example:
Device(config)# call-home
mail-server {ipv4-address | name} priority
number
Example:
Device(cfg-call-home)# mail-server
stmp.example.com priority 1
sender from email-address
Example:
Enters global configuration mode.configure terminal
Enters call home configuration mode.call-home
Assigns an email server address and its relative priority among
configured email servers.
Provide either of the following:
• The email server’s IP address or
• The email server’s fully qualified domain name (FQDN) of 64
characters or less.
Assign a priority number between 1 (highest priority) and 100 (lowest
priority).
(Optional) Assigns the email address that appears in the from field in
Call Home email messages. If no address is specified, the contact email
address is used.
Step 5
Step 6
Step 7
Device(cfg-call-home)# sender from
username@example.com
sender reply-to email-address
Example:
Device(cfg-call-home)# sender reply-to
username@example.com
source-interface interface-name
Example:
Device(cfg-call-home)# source-interface
loopback1
source-ip-address ipv4/ipv6 address
(Optional) Assigns the email address that appears in the reply-to field
in Call Home email messages.
Assigns the source interface name to send call-home messages.
interface-name—Source interface name. Maximum length is 64.
Note
For HTTP messages, use the ip http client source-interface
interface-name command in global configuration mode to
configure the source interface name. This command allows all
HTTP clients on the device to use the same source interface.
Assigns source IP address to send call-home messages.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
20
Page 33
Call Home
Example:
Device(cfg-call-home)# ip-address
209.165.200.226
Configuring Call Home
PurposeCommand or Action
• ipv4/ipv6 address—Source IP (IPv4 or IPv6) address. Maximum
length is 64.
Step 8
vrfvrf-name
Example:
Device(cfg-call-home)# vrf vpn1
Specifying Rate Limit for Sending Call Home Messages
To specify the rate limit for sending Call Home messages, perform the following steps:
SUMMARY STEPS
configure terminal
1.
call-home
2.
rate-limit number
3.
DETAILED STEPS
(Optional) Specifies the VRF instance to send call-home email messages.
If no vrf is specified, the global routing table is used.
Note
For HTTP messages, if the source interface is associated with
a VRF, use the ip http client source-interface interface-name
command in global configuration mode. This command would
specify the VRF instance that is used for all HTTP clients on
the device.
Step 1
Step 2
Step 3
Example:
Device# configure terminal
Example:
Device(config)# call-home
rate-limit number
Example:
Device(cfg-call-home)# rate-limit 40
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
PurposeCommand or Action
Enters global configuration mode.configure terminal
Enters call home configuration mode.call-home
Specifies a limit on the number of messages that are sent
per minute.
• number—Range 1 to 60. The default is 20.
for Cisco IOS XE Fuji 16.8.x
21
Page 34
Configuring Call Home
Specifying HTTP Proxy Server
To specify an HTTP proxy server for sending Call Home HTTP(S) messages to a destination, perform the
following steps:
SUMMARY STEPS
1.
2.
3.
DETAILED STEPS
Call Home
configure terminal
call-home
http-proxy {ipv4-address | ipv6-address name} name
PurposeCommand or Action
Step 1
Example:
Device# configure terminal
Step 2
Example:
Device(config)# call-home
Step 3
http-proxy {ipv4-address | ipv6-address name} name
Example:
Device(config)# http-proxy 1.1.1.1 port 1
Enabling AAA Authorization to Run Cisco IOS Commands for Call Home Messages
To enable AAA authorization to run Cisco IOS commands that enable the collection of output for a Call Home
message, perform the following steps:
SUMMARY STEPS
Enters global configuration mode.configure terminal
Enters call home configuration mode.call-home
Specifies the proxy server for the HTTP request.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
22
configure terminal
1.
call-home
2.
aaa-authorization
3.
aaa-authorization [username username]
4.
Page 35
Call Home
DETAILED STEPS
Configuring Call Home
PurposeCommand or Action
Step 1
Step 2
Step 3
Step 4
Example:
Device# configure terminal
Example:
Device(config)# call-home
Example:
Device(cfg-call-home)# aaa-authorization
aaa-authorization [username username]
Example:
Device(cfg-call-home)# aaa-authorization username
username
Enters global configuration mode.configure terminal
Enters call home configuration mode.call-home
Enables AAA authorization.aaa-authorization
Note
By default, AAA authorization is disabled for
Call Home.
Specifies the username for authorization.
• username user—Default username is callhome.
Maximum length is 64.
Configuring Syslog Throttling
SUMMARY STEPS
DETAILED STEPS
Step 1
Example:
Device# configure terminal
To enable or disable Call Home syslog message throttling and avoid sending repetitive Call Home syslog
messages, perform the following steps:
configure terminal
1.
call-home
2.
[no] syslog-throttling
3.
PurposeCommand or Action
Enters global configuration mode.configure terminal
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
23
Page 36
Configuring Call Home
Call Home
PurposeCommand or Action
Step 2
Example:
Device(config)# call-home
Step 3
[no] syslog-throttling
Example:
Device(cfg-call-home)# syslog-throttling
Configuring Call Home Data Privacy
The data-privacy command scrubs data, such as passwords and IP addresses, from running configuration
files to protect the privacy of customers. Enabling the data-privacy command can affect CPU utilization
when scrubbing a large amount of data. Currently, show command output is not being scrubbed except for
configuration messages in the show running-config all and show startup-config data.
SUMMARY STEPS
configure terminal
1.
call-home
2.
data-privacy {level {normal | high} | hostname}
3.
Enters call home configuration mode.call-home
Enables or disables Call Home syslog message throttling and
avoids sending repetitive Call Home syslog messages. By
default, syslog message throttling is enabled.
DETAILED STEPS
Step 1
Example:
Device# configure terminal
Step 2
Example:
Device(config)# call-home
Step 3
data-privacy {level {normal | high} |
hostname}
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
24
PurposeCommand or Action
Enters global configuration mode.configure terminal
Enters call home configuration mode.call-home
Scrubs data from running configuration file to protect the privacy of the
user. The default data-privacy level is normal.
Page 37
Call Home
Example:
Device(cfg-call-home)# data-privacy
level high
Configuring Call Home
PurposeCommand or Action
Note
Enabling the data-privacy command can affect CPU utilization
when scrubbing a large amount of data.
• normal—Scrubs sensitive data such as passwords.
• high—Scrubs all normal-level commands plus the IP domain name
and IP address commands.
• hostname—Scrubs all high-level commands plus the hostname
command.
Sending Call Home Messages Manually
Sending a Call Home Test Message Manually
You can use the call-home test command to send a user-defined Call Home test message.
SUMMARY STEPS
1.
call-home test [“test-message”] profile name
DETAILED STEPS
Step 1
call-home test [“test-message”] profile name
Example:
Router# call-home test profile profile1
Note
Scrubbing the hostname from configuration messages can cause
Smart Call Home processing failure on some platforms.
PurposeCommand or Action
Sends a test message to the specified destination profile. The
user-defined test message text is optional, but must be enclosed in quotes
(“ ”) if it contains spaces. If no user-defined message is configured, a
default message is sent.
Sending Call Home Alert Group Messages Manually
Before You Begin
Only the snapshot, crash, configuration, and inventory alert groups can be sent manually. Syslog alert
•
groups cannot be sent manually.
When you manually trigger a snapshot, configuration, or inventory alert group message and you specify
•
a destination profile name, a message is sent to the destination profile regardless of the profile's active
status, subscription status, or severity setting.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
25
Page 38
Configuring Call Home
DETAILED STEPS
Call Home
When you manually trigger a snapshot, configuration, or inventory alert group message and do not
•
specify a destination profile name, a message is sent to all active profiles that have either a normal or
periodic subscription to the specified alert group.
PurposeCommand or Action
Step 1
Step 2
Step 3
Step 4
Step 5
Example:
Router> enable
call-home send alert-group snapshot [profile name ]
Example:
Router# call-home send alert-group snapshot
profile profile1
call-home send alert-group crash [profile name ]
Example:
Router# call-home send alert-group configuration
profile profile1
call-home send alert-group configuration [profile name
]
Example:
Router# call-home send alert-group configuration
profile profile1
call-home send alert-group inventory [profile name ]
Example:
Router# call-home send alert-group inventory
Enables privileged EXEC mode.enable
Enter your password, if prompted.
•
Sends a snapshot alert group message to one destination
profile if specified, or to all subscribed destination profiles.
Sends a crash alert group message to one destination profile
if specified, or to all subscribed destination profiles.
Sends a configuration alert group message to one destination
profile if specified, or to all subscribed destination profiles.
Sends an inventory alert group message to one destination
profile if specified, or to all subscribed destination profiles.
Submitting Call Home Analysis and Report Requests
You can use the call-home request command to submit information about your system to Cisco Systems to
receive helpful analysis and report information specific to your system. You can request various reports,
including security alerts, known bugs, best practices, and command references.
Note the following guidelines when manually sending Call Home analysis and report requests:
If a profile name is specified, the request is sent to the profile. If no profile is specified, the request is
•
sent to the Cisco TAC profile. The recipient profile need not be enabled for the call-home request. The
profile specifies the email address where the transport gateway is configured so that the request message
can be forwarded to the Cisco TAC and you can receive the reply from the Smart Call Home service.
The ccoid user-id is the registered identifier of the Smart Call Home user. If the user-id is specified, the
•
response is sent to the email address of the registered user. If no user-id is specified, the response is sent
to the contact email address of the device.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
26
Page 39
Call Home
SUMMARY STEPS
Configuring Call Home
Based on the keyword specifying the type of report that is requested, the following information is
•
returned:
◦ config-sanity—Information on best practices as related to the current running configuration.
◦ bugs-list—Known bugs in the running version and in the currently applied features.
◦ command-reference—Reference links to all commands in the running configuration.
◦ product-advisory—Product Security Incident Response Team (PSIRT) notices, End of Life (EOL)
or End of Sales (EOS) notices, or field notices (FN) that may affect devices in your network.
To submit a request for analysis and report information from the Cisco Output Interpreter tool, complete the
following steps:
1.
call-home request output-analysis “show-command”
call-home request {config-sanity | bugs-list | command-reference | product-advisory}
2.
DETAILED STEPS
Step 1
call-home request output-analysis “show-command”
Example:
[profile name] [ccoid user-id]
Example:
Device# call-home request output-analysis “show
diag” profile TG
Step 2
call-home request {config-sanity | bugs-list |
command-reference | product-advisory}
Example:
[profile name] [ccoid user-id]
Example:
Device# call-home request config-sanity profile TG
PurposeCommand or Action
Sends the output of the specified show command for analysis.
The show command must be contained in quotes (").
Sends the output of a predetermined set of commands, such as
the show running-config all and show version commands, for
analysis. In addition, the call home request product-advisory
subcommand includes all inventory alert group commands. The
keyword that is specified after the call-home request command
specifies the type of report requested.
Manually Sending Command Output Message for One Command or a Command List
You can use the call-home send command to execute a CLI command and email the command output to
Cisco or to an email address that you specify.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
27
Page 40
Configuring Call Home
Note the following guidelines when sending the output of a command:
To execute a command and send the command output, complete the following step:
Call Home
The specified Cisco IOS command or list of Cisco IOS commands can be any run command, including
•
commands for all modules. The command must be contained in quotes (“”).
• If the email option is selected using the “email” keyword and an email address is specified, the command
output is sent to that address. If neither email nor HTTP option is specified, the output is sent in long-text
format with the specified service request number to the Cisco TAC (attach@cisco.com).
• If neither the “email” nor the “http” keyword is specified, the service request number is required for both
long-text and XML message formats and is provided in the subject line of the email.
If the HTTP option is specified without a profile name or destination URL, the CiscoTac-1 profile
•
destination HTTP or HTTPS URL is used as the destination. The destination email address can be
specified so that Smart Call Home can forward the message to the email address. You must specify
either the destination email address or an SR number but you can also specify both.
If a profile is specified and the profile has callhome@cisco.com as one of its email destinations, you
•
must use XML as the message format. If you use long-text format, an error message is displayed.
DETAILED STEPS
Step 1
call-home send {cli command | cli
•
list} [email [profile profile-name |
email] [msg-format {long-text |
xml}]] [tac-sevice-request SR#]
call-home send {cli command | cli
•
list} [http [profile profile-name |
URL-dest]
[destination-email-address email]]
[tac-sevice-request SR#]
Example:
Router# call-home send “show
version;show running-config show
inventory” email
support@example.com msg-format xml
PurposeCommand or Action
Executes the CLI or CLI list and sends output via email or HTTP.Use one of the following commands:
• {cli command | cli list}—Specifies the Cisco IOS command or list of Cisco
IOS commands (separated by ‘;’). It can be any run command, including
commands for all modules. The commands must be contained in quotes (“”).
• email [profile profile-name | email] [msg-format {long-text | xml}]—If the
email option is selected and a profile name is specified, the command output
is sent to the email address configured in the profile. If an email address is
specified, the command output is sent to the specified email address. The
message is in long-text or XML format with the service request number in the
subject. The profile name or email address, the service request number, or
both must be specified. The service request number is required if the profile
name or email address is not specified (default is attach@cisco.com for
long-text format and callhome@cisco.com for XML format).
http [profile profile-name | URL-dest] [destination-email-address email]
•
—If the http option is selected without a profile name or destination URL, the
command output is sent to the Smart Call Home backend server (URL specified
in TAC profile) in XML format. If a profile name or destination URL is
specified, the command output is sent to the destination URLs configured in
the profile (profile-name case) or the destination URL specified in the
command.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
28
destination-email-address email can be specified so that the backend server
can forward the message to the email address. The email address, the service
request number, or both must be specified.
Page 41
Call Home
PurposeCommand or Action
• tac-service-request SR#—Specifies the service request number. The service
request number is required if the email address is not specified.
Configuring Diagnostic Signatures
The Diagnostic Signatures feature downloads digitally signed signatures to devices. Diagnostic Signatures
(DS) files are formatted files that collate knowledge of diagnostic events. DS files provide methods to
troubleshoot them without a need to upgrade the Cisco software. The aim of DS is to deliver flexible intelligence
that can detect and collect troubleshooting information. This information can be used to resolve known
problems in customer networks.
Configuring Diagnostic Signatures
Prerequisites for Diagnostic Signatures
Before you download and configure diagnostic signatures (DSes) on a device, you must ensure that the
following conditions are met:
• Ensure that you assign a diagnostic signature to the device. Refer to the “Diagnostic Signature
Downloading” section for more information about how to assign DSes to devices.
HTTP/Secure HTTP (HTTPS) transport is required for downloading DS files. Install the certification
•
authority (CA) certificate to enable the authentication of the destination HTTPS server.
If you configure the trustpool feature, the CA certificate is not required.Note
Information About Diagnostic Signatures
Diagnostic Signature Overview
Diagnostic signatures (DS) for the Call Home system provides a flexible framework that allows the defining
of new events and corresponding CLIs that can analyze these events without upgrading the Cisco software.
DSs enable you to define more types of events and trigger types than the standard Call Home feature supports.
The DS subsystem downloads and processes files on a device and also handles callbacks for diagnostic
signature events.
The Diagnostic Signature feature downloads digitally signed signatures that are in the form of files to devices.
DS files are formatted files that collate the knowledge of diagnostic events and provide methods to troubleshoot
these events.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
29
Page 42
Information About Diagnostic Signatures
DS files contain XML data to specify the event description, and these files include CLI commands or scripts
to perform required actions. These files are digitally signed by Cisco or a third party to certify their integrity,
reliability, and security.
The structure of a DS file can be one of the following formats.
Metadata-based simple signature. This format specifies the event type and contains other information
•
that can be used to match the event and perform actions such as collecting information by using the CLI.
The signature can also change configurations on the device as a workaround for certain bugs.
Embedded Event Manager (EEM) Tool Command Language (Tcl) script-based signature. This format
•
specifies new events in the event register line and additional action in the Tcl script.
Combination of both the preceding formats.
•
The following basic information is contained in a DS file:
• ID (unique number)—unique key that represents a DS file that can be used to search a DS.
• Name (ShortDescription)—unique description of the DS file that can be used in lists for selection.
• Description—long description about the signature.
Call Home
• Revision—version number, which increments when the DS content is updated.
• Event & Action—defines the event to be detected and the action to be performed after the event happens.
Diagnostic Signature Downloading
To download the diagnostic signature (DS) file, you require the secure HTTP (HTTPS) protocol. If you have
already configured an email transport method to download files on your device, change your assigned profile
transport method to HTTPS to download and use DS.
Cisco software uses a PKI Trustpool Management feature. The PKI Trustpool Management is enabled by
default on devices to create a scheme to provision, store, and manage a pool of certificates from known
certification authorities (CAs). The trustpool feature installs the CA certificate automatically. The CA certificate
is required for the authentication of the destination HTTPS servers.
There are two types of DS update requests to download DS files: regular and forced-download.
Regular download requests DS files that were recently updated. You can trigger a regular download request
either by using a periodic configuration or by initiating an on-demand CLI. The regular download update
happens only when the version of the requested DS is different from the version of the DS on the device.
Periodic download is only started after there is any DS assigned to the device from DS web portal. After the
assignment happens, the response to the periodic inventory message from the same device will include a field
to notify device to start its periodic DS download or an update. In a DS update request message, the status
and revision number of the DS is included such that only a DS with the latest revision number is downloaded.
Forced-download downloads a specific DS or a set of DSes. You can trigger the forced-download update
request only by initiating an on-demand CLI. In a force-download update request, the latest version of the DS
file is downloaded irrespective of the current DS file version on the device.
The DS file is digitally signed, and signature verification is performed on every downloaded DS file to make
sure it is from a trusted source.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
30
Page 43
Call Home
Diagnostic Signature Signing
The diagnostic signature (DS) files are digitally signed before they are made available for downloading. The
following methods are used for digitally signing DS files:
Signing algorithm (Rivest Shamir and Adleman [RSA] 2048 bits).
•
Request keypairs to Abraxas system, which is the digital signing client.
•
DS signed through the secure socket layer (SSL) through a code signing client, where the signature is
•
embedded using XML tags.
Public keys are embedded in the DS subsystem (Cisco signed, partner-signed, third-party signed) in the
•
Cisco software. The digitally signed DS file contains the product name such as Diagnostic_Signatures
(Cisco signed), Diagnostic_Signatures_Partner, Diagnostic_Signatures_3rd_Party. The product names
are only used to sign the DS files.
The digital signing client can be found at the https://abraxas.cisco.com/SignEngine/submit.jsp link.
These conditions that must be met to verify the digital signature in a DS file:
Information About Diagnostic Signatures
Code sign component support must be available in Cisco software.
•
Various public keys that verify the different kinds of diagnostic signatures must be included in platforms
•
where DS is supported.
After parsing and retrieving the DS, the DS must execute the verification application program interface
•
(API) to verify that the DS is valid.
Diagnostic Signature Workflow
The diagnostic signature feature is enabled by default in Cisco software. The following is the workflow for
creating diagnostic signatures:
1
Find the DSs you want to download and assign them to the device. This step is mandatory for a regular
periodic download, but not required for a forced download.
2
The device downloads every assigned DS or a specific DS by regular periodic download or by on-demand
forced download.
3
The device verifies the digital signature of every DS. After verification, the device stores the DS file into
a nonremovable disk. This nonremovable disk can be a bootflash or hard disk, where that DS files can be
read after the device is reloaded. On the routers, the DS file is stored in the bootflash:/call home directory.
4
The device continues sending periodic regular DS download requests to get the latest revision of DS and
replace the older one in the device.
5
The device monitors the event and executes the actions that are defined in the DS when the event happens.
Diagnostic Signature Events and Actions
The events and actions sections are the key areas that are used in diagnostic signatures. The event section
defines all event attributes that are used for the event detection. The action section lists all the steps to be
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
31
Page 44
Information About Diagnostic Signatures
completed after the event. The actions include collecting show command outputs and sending them to Smart
Call Home to parse.
Diagnostic Signature Event Detection
Event detection in a DS is defined in two ways: single event detection and multiple event detection.
Single Event Detection
In single event detection, only one event detector is defined within a DS. The event specification format is
one of the following two types:
DS event specification type: syslog, periodic, configuration, Online Insertion Removal (OIR) immediate,
•
and callhome are the supported event types, where “immediate” indicates that this type of DS does not
detect any events, its actions are performed once it is downloaded, and the call-home type modifies the
current CLI commands defined for existing alert-group.
The Embedded Event Manager (EEM) specification type: supports any new EEM event detector without
•
having to modify the Cisco software.
Other than using EEM to detect events, a DS is triggered when a Tool Command Language (Tcl) script
is used to specify event detection types.
Call Home
Multiple Event Detection
Multiple event detection involves defining two or more event detectors, two ore more corresponding tracked
object states, and a time period for the events to occur. The specification format for multiple event detection
can include complex event correlation for tracked event detectors. For example, three event detectors (syslog,
OIR, and IPSLA) are defined during the creation of a DS file. The correlation that is specified for these event
detectors is that the DS will execute its action if both syslog and OIR events are triggered simultaneously, or
if IPSLA is triggered alone.
Diagnostic Signature Actions
The diagnostic signature (DS) file consists of various actions that must be initiated when an evnt occurs. The
action type indicates the kind of action that will be initiated in response to a certain event.
Variables are elements within a DS file that are used to customize the files.
DS actions are categorized into the following five types:
call-home
•
command
•
emailto
•
script
•
message
•
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
32
DS action types call-home and emailto collect event data and send a message to call-home servers or to the
defined email addresses. The message uses "diagnostic-signature" as its message type and DS ID as the
message sub-type.
Page 45
Call Home
Action Types
Information About Diagnostic Signatures
The commands defined for the DS action type initiate CLI commands that can change configuration of the
device, collect show command outputs, or run any EXEC command on the device. The DS action type script
executes Tcl scripts.
DS action type message defines action to generate message to notify or remind user certain important
information. The message could be broadcasted to all TTY lines or generated as a syslog entry.
DS actions are categorized into the following four types:
Call-home
•
Command
•
Emailto
•
Script
•
DS action types call-home and emailto collect event data and send a message to call-home servers or to the
defined email addresses. The message includes the following elements:
• Message type—diagnostic-signature
• Message subtype—ds-id
• Message description—event-id : ds name
The commands defined for the DS action type initiates CLI commands that can change configuration of the
device. The DS action type script executes Tcl scripts.
Diagnostic Signature Variables
Variables are referenced within a DS and are used to customize the DS file. All DS variable names have the
prefix ds_ to separate them from other variables. The following are the supported DS variable types:
System variable: variables assigned automatically by the device without any configuration changes. The
•
Diagnostic Signatures feature supports two system variables: ds_hostname and ds_signature_id.
Environment variable: values assigned manually by using the environmentvariable-name variable-value
•
command in call-home diagnostic-signature configuration mode. Use the show call-home
diagnostic-signature command to display the name and value of all DS environment variables. If the
DS file contains unresolved environment variables, this DS will stay in pending status until the variable
gets resolved.
Prompt variable: values assigned manually by using the call-home diagnostic-signature install ds-id
•
command in privileged EXEC mode. If you do not set this value, the status of the DS indicates pending.
Regular expression variable: values assigned from a regular expression pattern match with predefined
•
CLI command outputs. The value is assigned during the DS run.
Syslog event variable: values assigned during a syslog event detection in the DS file. This variable is
•
valid only for syslog event detection.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
33
Page 46
How to Configure Diagnostic Signatures
How to Configure Diagnostic Signatures
Configuring the Service Call Home for Diagnostic Signatures
Configure the Service Call Home feature to set attributes such as the contact email address where notifications
related with diagnostic signatures (DS) are sent and destination HTTP/secure HTTP (HTTPS) URL to download
the DS files from.
You can also create a new user profile, configure correct attributes, and assign it as the DS profile. For periodic
downloads, the request is sent out just following full inventory message. By changing the inventory periodic
configuration, the DS periodic download also gets rescheduled.
Call Home
Note
DETAILED STEPS
Step 1
Example:
Router> enable
Step 2
The predefined CiscoTAC-1 profile is enabled as a DS profile by default and Cisco recommends using
it. Ensure that you change the destination transport-method to the http setting, when you use the predefined
CiscoTAC-1 profile.
Before You Begin
Before you download and configure diagnostic signatures (DSs) on a device, you must ensure that the following
conditions are met:
Assign one or more DSs to the device.
•
HTTP/Secure HTTP (HTTPS) transport is required for downloading DS files. Install the certification
•
authority (CA) certificate to enable the authentication of the destination HTTPS server.
If you configure the trustpool feature, the CA certificate is not required.Note
PurposeCommand or Action
Enables privileged EXEC mode.enable
Enter your password, if prompted.
•
Enters global configuration mode.configure terminal
Step 3
34
Example:
Router# configure terminal
Enables Call Home service on a device.service call-home
Example:
Router(config)# service call-home
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
Page 47
Call Home
How to Configure Diagnostic Signatures
PurposeCommand or Action
Step 4
Step 5
Step 6
Step 7
Step 8
Example:
Router(config)# call-home
contact-email-addr email-address
Example:
Router(cfg-call-home)# contact-email-addr
username@example.com
mail-server {ipv4-address | name} priority number
Example:
Router(cfg-call-home)# mail-server 10.1.1.1
priority 4
profile name
Example:
Router(cfg-call-home)# profile profile1
Example:
Router(cfg-call-home-profile)# destination
transport-method email
Enters Call Home configuration mode.call-home
Assigns customer's email address. You can enter a maximum
of 200 characters in email address format with no spaces.
Note
You can use any valid email address. You cannot use
spaces.
(Optional) Configures a Simple Mail Transfer Protocol (SMTP)
email server address for Call Home. This command is only used
when sending email is part of the actions that are defined in any
DS.
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.
Step 9
Step 10
destination address {email email-address | http url}
Example:
Router(cfg-call-home-profile)# destination
address http https://tools.cisco.com/its/
service/oddce/services/DDCEService
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
What to Do Next
Set the configured profile from the previous procedure as the DS profile and configure other DS parameters.
Note
To configure diagnostic signatures, you must use the
http option.
Configures the destination email address or URL to which Call
Home messages are sent.
Note
To configure diagnostic signatures, you must use the
http option.
Subscribes this destination profile to the Inventory alert group.
The Inventory alert group can be configured for periodic
notification.
Note
This command is used only for the periodic
downloading of DS files.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
35
Page 48
How to Configure Diagnostic Signatures
Configuring Diagnostic Signatures
Before You Begin
Configure the Service Call Home feature to set attributes for the Call Home profile. You can either use the
default CiscoTAC-1 profile or use the newly created user profile.
DETAILED STEPS
Call Home
PurposeCommand or Action
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Step 7
Step 8
Example:
Router> enable
Example:
Router# configure terminal
Example:
Router(config)# call-home
Example:
Router(cfg-call-home)# diagnostic-signature
profile ds-profile-name
Example:
Router(cfg-call-home-diag-sign)# profile user1
environment ds_env-var-name ds-env-var-value
Example:
Router(cfg-call-home-diag-sign)# environment ds_env1
envarval
end
Example:
Router(cfg-call-home-diag-sign)# end
call-home diagnostic-signature {{deinstall | download}
{ds-id | all} | install ds-id}
Enables privileged EXEC mode.enable
Enter your password, if prompted.
•
Enters global configuration mode.configure terminal
Enters Call Home configuration mode.call-home
Enters call-home diagnostic signature mode.diagnostic-signature
Specifies the destination profile on a device that DS
uses.
Sets the environment variable value for DS on a
device.
Exits call-home diagnostic signature mode and
returns to privileged EXEC mode.
Downloads, installs, and uninstalls diagnostic
signature files on a device.
Example:
Router# call-home diagnostic-signature download 6030
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
36
Page 49
Call Home
Verifying the Call Home Configuration
PurposeCommand or Action
Step 9
show call-home diagnostic-signature [ds-id [actions | events
| prerequisite | prompt | variables] | failure | statistics
[download]]
Example:
Router# show call-home diagnostic-signature actions
Verifying the Call Home Configuration
• show call-home —Displays the Call Home configuration summary.
Following is a sample output of the command:
Router# show call-home
Current call home settings:
call home feature : enable
call home message's from address: Not yet set up
call home message's reply-to address: Not yet set up
vrf for call-home messages: Not yet set up
contact person's email address: sch-smart-licensing@cisco.com (default)
contact person's phone number: Not yet set up
street address: Not yet set up
customer ID: Not yet set up
contract ID: Not yet set up
site ID: Not yet set up
source ip address: Not yet set up
source interface: TenGigabitEthernet4/1/1
Mail-server[1]: Address: 173.36.13.143 Priority: 60
http proxy: Not yet set up
Diagnostic signature: enabled
Profile: CiscoTAC-1 (status: ACTIVE)
Smart licensing messages: enabled
Profile: CiscoTAC-1 (status: ACTIVE)
aaa-authorization: disable
aaa-authorization username: callhome (default)
data-privacy: normal
syslog throttling: enable
Rate-limit: 20 message(s) per minute
Snapshot command[0]: show cable modem summary totalb
Snapshot command[1]: show cable modem summary total
Available alert groups:
Keyword State Description
------------------------ ------- ------------------------------configuration Enable configuration info
crash Enable crash and traceback info
diagnostic Enable diagnostic info
environment Enable environmental info
inventory Enable inventory info
snapshot Enable snapshot info
Displays the call-home diagnostic signature
information.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
37
Page 50
Verifying the Call Home Configuration
syslog Enable syslog info
Profiles:
Profile Name: CiscoTAC-1
Profile Name: test
• show call-home detail—Displays the Call Home configuration in detail.
Following is a sample output of the command:
Router# show call-home detail
Current call home settings:
call home feature : enable
call home message's from address: Not yet set up
call home message's reply-to address: Not yet set up
vrf for call-home messages: Not yet set up
contact person's email address: sch-smart-licensing@cisco.com (default)
contact person's phone number: Not yet set up
street address: Not yet set up
customer ID: Not yet set up
contract ID: Not yet set up
site ID: Not yet set up
source ip address: Not yet set up
source interface: TenGigabitEthernet4/1/1
Mail-server[1]: Address: 173.36.13.143 Priority: 60
http proxy: Not yet set up
Diagnostic signature: enabled
Profile: CiscoTAC-1 (status: ACTIVE)
Smart licensing messages: enabled
Profile: CiscoTAC-1 (status: ACTIVE)
aaa-authorization: disable
aaa-authorization username: callhome (default)
data-privacy: normal
syslog throttling: enable
Rate-limit: 20 message(s) per minute
Snapshot command[0]: show cable modem summary totalb
Snapshot command[1]: show cable modem summary total
Available alert groups:
Keyword State Description
------------------------ ------- ------------------------------configuration Enable configuration info
crash Enable crash and traceback info
diagnostic Enable diagnostic info
environment Enable environmental info
inventory Enable inventory info
snapshot Enable snapshot info
syslog Enable syslog info
Profiles:
Profile Name: CiscoTAC-1
Profile status: ACTIVE
Profile mode: Anonymous Reporting Only
Reporting Data: Smart Call Home, Smart Licensing
Preferred Message Format: xml
Message Size Limit: 3145728 Bytes
Transport Method: http
Email address(es): callhome@cisco.com
HTTP address(es): https://tools.cisco.com/its/service/oddce/services/DDCEService
Periodic configuration info message is scheduled every 17 day of the month at 09:39
Call Home
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
38
Page 51
Call Home
Verifying the Call Home Configuration
Periodic inventory info message is scheduled every 17 day of the month at 09:24
Alert-group Severity
------------------------ -----------crash debug
diagnostic minor
environment minor
inventory normal
Syslog-Pattern Severity
------------------------ -----------.* major
• show call-home alert-group —Displays the available alert groups and their status.
Following is a sample output of the command:
Router# show call-home alert-group
Available alert groups:
Keyword State Description
------------------------ ------- ------------------------------configuration Enable configuration info
crash Enable crash and traceback info
diagnostic Enable diagnostic info
environment Enable environmental info
inventory Enable inventory info
snapshot Enable snapshot info
syslog Enable syslog info
• show call-home mail-server status—Checks and displays the availability of the configured email
servers.
Following is a sample output of the command:
Router# show call-home mail-server status
Mail-server[1]: Address: 173.36.13.143 Priority: 60
• show call-home profile {all | name} —Displays the configuration of the specified destination profile.
Use the keyword all to display the configuration of all destination profiles.
Following is a sample output of the command:
Router# show call-home profile CiscoTac-1
Profile Name: CiscoTAC-1
Profile status: ACTIVE
Profile mode: Full Reporting
Reporting Data: Smart Call Home, Smart Licensing
Preferred Message Format: xml
Message Size Limit: 3145728 Bytes
Transport Method: email
Email address(es): callhome@cisco.com
HTTP address(es): http://10.22.183.117:8080/ddce/services/DDCEService
Periodic configuration info message is scheduled every 17 day of the month at 09:39
Periodic inventory info message is scheduled every 17 day of the month at 09:24
Alert-group Severity
------------------------ -----------crash debug
diagnostic minor
environment minor
inventory normal
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
39
Page 52
Verifying the Call Home Configuration
Syslog-Pattern Severity
------------------------ -----------.* major
• show call-home statistics [detail | profile profile-name]—Displays the statistics of Call Home events.
Following is a sample output of the command:
Router# show call-home statistics
Message Types Total Email HTTP
------------- -------------------- -------------------- -----------------Total Success 4 3 1
Config 1 1 0
Crash 0 0 0
Diagnostic 0 0 0
Environment 0 0 0
Inventory 1 0 1
Snapshot 0 0 0
SysLog 2 2 0
Test 0 0 0
Request 0 0 0
Send-CLI 0 0 0
SCH 0 0 0
Total In-Queue 0 0 0
Config 0 0 0
Crash 0 0 0
Diagnostic 0 0 0
Environment 0 0 0
Inventory 0 0 0
Snapshot 0 0 0
SysLog 0 0 0
Test 0 0 0
Request 0 0 0
Send-CLI 0 0 0
SCH 0 0 0
Total Failed 0 0 0
Config 0 0 0
Crash 0 0 0
Diagnostic 0 0 0
Environment 0 0 0
Inventory 0 0 0
Snapshot 0 0 0
SysLog 0 0 0
Test 0 0 0
Request 0 0 0
Send-CLI 0 0 0
SCH 0 0 0
Total Ratelimit
Config 0 0 0
Crash 0 0 0
Diagnostic 0 0 0
Environment 0 0 0
Inventory 0 0 0
Snapshot 0 0 0
SysLog 0 0 0
Test 0 0 0
Request 0 0 0
Send-CLI 0 0 0
SCH 0 0 0
Last call-home message sent time: 2015-03-06 18:21:49 GMT+00:00
Call Home
-dropped 0 0 0
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
40
• show call-home diagnostic-signature—Displays the configuration of diagnostic signature information.
Page 53
Call Home
Configuration Example for Call Home
Following is a sample output of the command:
Router# show call-home diagnostic-signature
Current diagnostic-signature settings:
Diagnostic-signature: enabled
Profile: CiscoTAC-1 (status: ACTIVE)
Environment variable:
Not yet set up
Downloaded DSes:
Last Update
DS ID DS Name Revision Status (GMT-05:00)
-------- ------------------------------- -------- ---------- -------------------
• show call-home version—Displays the Call Home version information.
Following is a sample output of the command:
Router# show call-home version
Call-Home Version 3.0
Component Version:
call-home: (rel4)1.0.15
eem-call-home: (rel2)1.0.5
Configuration Example for Call Home
Example: Call Home Configuration
Following is a configuration example for configuring the HTTPS transport:
ip host tools.cisco.com 72.163.4.38
vrf definition smart-vrf
!
address-family ipv4
exit-address-family
!
address-family ipv6
exit-address-family
!
interface TenGigabitEthernet4/1/1
vrf forwarding smart-vrf
ip address 172.22.11.25 255.255.255.128
no ip proxy-arp
!
ip route vrf smart-vrf 72.163.4.38 255.255.255.255 172.22.11.1
!
ip http client source-interface TenGigabitEthernet4/1/1
!
Following is a configuration example for configuring email options:
call-home
mail-server 173.36.13.143 priority 60
source-interface TenGigabitEthernet4/1/1
vrf smart-vrf
alert-group-config snapshot
add-command "show cable modem summary total"
profile "test"
active
destination transport-method email
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
41
Page 54
Call Home
Example: Configuring HTTP Transport for Call Home on the Cisco cBR Series Router
destination address email call-home@cisco.com
subscribe-to-alert-group configuration
subscribe-to-alert-group crash
subscribe-to-alert-group diagnostic severity debug
subscribe-to-alert-group environment severity debug
subscribe-to-alert-group inventory
subscribe-to-alert-group syslog severity major pattern .*
subscribe-to-alert-group syslog severity notification pattern "^.+UPDOWN.+changed state
to (down|up)$"
subscribe-to-alert-group snapshot periodic daily 12:00
!
ip route vrf smart-vrf 173.36.13.143 255.255.255.255 172.22.11.1
!
Example: Configuring HTTP Transport for Call Home on the Cisco cBR Series
Router
Step 1
Step 2
Step 3
Step 4
Back up the current running configuration file.
Verify the built-in router certificates.
Example:
Router# show crypto pki trustpool | include Class 3 Public
ou=Class 3 Public Primary Certification Authority
ou=Class 3 Public Primary Certification Authority
(Optional) Configure VRF.
Example:
Router(config)# vrf def smart-vrf
Router(config-vrf)# address-family ipv4
Router(config-vrf-af)# exit-address-family
Router(config-vrf)# address-family ipv6
Router(config-vrf-af)# exit-address-family
Set up the network interface.
Example:
Router(config)# interface TenGigabitEthernet4/1/1
Router(config)# vrf forward smart-vrf
Router(config-if)# ip address 172.22.11.25 255.255.255.128
Router(config-if)# no ip proxy-arp
Router(config-if)# no shut
If IPv6 is enabled, you must configure the IPv6 address.Note
Step 5
Step 6
42
Set up the Cisco portal.
Example:
Router(config)# ip host tools.cisco.com 72.163.4.38
Router(config)# ip route vrf smart-vrf 72.163.4.38 255.255.255.255 172.22.11.1
Verify the data path.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
Page 55
Call Home
Example: Configuring HTTP Transport for Call Home on the Cisco cBR Series Router
Example:
!Verify the connectivity to TenGigabitEthernet4/1/1 interface
Router# ping vrf smart-vrf 172.22.11.25
!Verify the connectivity to TenGigabitEthernet4//1/1 gateway
Router# ping vrf smart-vrf 172.22.11.1
!Verify the connectivity to tools.cisco.com
Router# ping vrf smart-vrf 72.163.4.38
Step 7
Step 8
Step 9
Configure the HTTP client interface.
Example:
Router(config)# ip http client source-interface TenGigabitEthernet4/1/1
Send the Call Home alert group message manually and verify the configuration.
Example:
Router# call-home send alert inventory profile CiscoTAC-1
Sending inventory info call-home message ...
Please wait. This may take some time ...
Router# show call-home statistics | include Total
Message Types Total Email HTTP
Total Success 0 0 0
Total In-Queue 1 0 1
Total Failed 0 0 0
Total Ratelimit
Router# show call-home statistics | include Total
Message Types Total Email HTTP
Total Success 1 0 1
Total In-Queue 0 0 0
Total Failed 0 0 0
Total Ratelimit
Display the Call Home configuration.
Example:
Router# show call-home profile CiscoTAC-1
Profile Name: CiscoTAC-1
Profile status: ACTIVE
Profile mode: Full Reporting
Reporting Data: Smart Call Home, Smart Licensing
Preferred Message Format: xml
Message Size Limit: 3145728 Bytes
Transport Method: http
Email address(es): callhome@cisco.com
HTTP address(es): https://tools.cisco.com/its/service/oddce/services/DDCEService
Periodic configuration info message is scheduled every 15 day of the month at 15:37
Periodic inventory info message is scheduled every 15 day of the month at 15:22
Alert-group Severity
------------------------ -----------crash debug
diagnostic minor
environment minor
inventory normal
Syslog-Pattern Severity
------------------------ ------------
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
43
Page 56
Call Home
Example: Configuring Email Transport for Call Home on the Cisco cBR Series Router
.* major
Example: Configuring Email Transport for Call Home on the Cisco cBR Series
Router
Step 1
Step 2
Step 3
Step 4
Back up the current running configuration file.
(Optional) Configure VRF.
Example:
Router(config)# vrf def smart-vrf
Router(config-vrf)# address-family ipv4
Router(config-vrf-af)# exit-address-family
Router(config-vrf)# address-family ipv6
Router(config-vrf-af)# exit-address-family
Set up the network interface.
Example:
Router(config)# interface TenGigabitEthernet4/1/1
Router(config)# vrf forward smart-vrf
Router(config-if)# ip address 172.22.11.25 255.255.255.128
Router(config-if)# no ip proxy-arp
Router(config-if)# no shut
If IPv6 is enabled, you must configure the IPv6 address.Note
Verify the data path.
Example:
!Verify the connectivity to TenGigabitEthernet4/1/1 interface
Router# ping vrf smart-vrf 172.22.11.25
!Verify the connectivity to TenGigabitEthernet4//1/1 gateway
Router# ping vrf smart-vrf 172.22.11.1
Step 5
Step 6
44
!Verify the connectivity to tools.cisco.com
Router# ping vrf smart-vrf 72.163.4.38
(Optional) Configure Call Home.
Example:
Router(config)# call-home
!Configure the TenGigabitEthernet 4/1/1
Router(cfg-call-home)# source-ip-address 172.22.11.25
Configure the mail server and verify the configuration.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
Page 57
Call Home
Example: Configuring Email Transport for Call Home on the Cisco cBR Series Router
Example:
Router(config)# call-home
Router(cfg-call-home)# mail-server 173.36.13.143 priority 60
Router(cfg-call-home)# vrf smart-vrf
Router(cfg-call-home)# exit
Router(config)# ip route vrf smart-vrf 173.36.13.143 255.255.255.255 172.22.11.1
Router(config)# end
Router# ping vrf smart-vrf 173.36.13.143
…
Router# show call-home mail status
Please wait. Checking for mail server status ...
Mail-server[1]: Address: 173.36.13.143 Priority: 60 [Available]
Step 7
Step 8
Note
The VRF configuration is
optional.
Create a new destination profile and subscribe to alert the group.
Example:
Router(config)# call-home
Router(cfg-call-home)# alert-group-config snapshot
Router(cfg-call-home-snapshot)# add-command "show cable modem summary total”
Router(cfg-call-home-snapshot)# exit
Router(cfg-call-home)# profile test
Router(cfg-call-home-profile)# active
Router(cfg-call-home-profile)# destination transport-method email
Router(cfg-call-home-profile)# destination address email xyz@company.com
Router(cfg-call-home-profile)# subscribe syslog severity notification pattern "^.+UPDOWN.+changed
state to (down|up)$”
Router(cfg-call-home-profile)# subscribe-to-alert-group snapshot periodic daily 12:00
Router(cfg-call-home-profile)# end
Send the Call Home alert group message manually and verify the configuration.
Example:
Router# call-home send alert-group inventory profile test
Sending inventory info call-home message ...
Please wait. This may take some time ...
Router# show call-home statistics | include Total
Message Types Total Email HTTP
Total Success 1 0 1
Total In-Queue 2 2 0
Total Failed 0 0 0
Total Ratelimit
Step 9
Router# show call-home statistics | include Total
Message Types Total Email HTTP
Total Success 3 2 1
Total In-Queue 0 0 0
Total Failed 0 0 0
Total Ratelimit
Display the Call Home configuration.
Example:
Router# show call-home profile test
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
45
Page 58
Default Settings
Profile Name: test
Profile status: ACTIVE
Profile mode: Full Reporting
Reporting Data: Smart Call Home
Preferred Message Format: xml
Message Size Limit: 3145728 Bytes
Transport Method: email
Email address(es): abcd@company.com
HTTP address(es): Not yet set up
Periodic snapshot info message is scheduled daily at 12:00
Alert-group Severity
------------------------ -----------configuration normal
crash debug
diagnostic debug
environment debug
inventory normal
Syslog-Pattern Severity
------------------------ -----------^.+UPDOWN.+changed state
to (down|up)$ notification
Call Home
Default Settings
Table 3: Default Call Home Parameters
DefaultParameters
EnabledCall Home feature status
ActiveUser-defined profile status
ActivePredefined CiscoTAC-1 profile status
HTTPTransport method
XMLMessage-format type
EnabledAlert group status
DebugCall Home message severity threshold
20Message rate limit for messages per minute
DisabledAAA authorization
EnabledCall Home syslog message throttling
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
46
NormalData privacy level
Page 59
Call Home
Alert Groups Trigger Events and Commands
Alert Groups Trigger Events and Commands
The following table lists the supported alert groups and the default command output that is included in Call
Home messages that are generated for the alert group.
Table 4: Call Home Alert Groups, Events, and Actions
Configuration
SeveritySyslog EventCall Home Trigger EventAlert Group
——
normal
periodic
Description and Executed
Commands
Periodic events that are related
to configuration sent monthly.
Commands executed:
show platform
•
show version
•
show inventory
•
show running-config all
•
show startup-config
•
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
47
Page 60
Alert Groups Trigger Events and Commands
Call Home
Crash
SeveritySyslog EventCall Home Trigger EventAlert Group
Description and Executed
Commands
——
debug
Events that are generated by a
crash on the router, such as
Supervisor or line card crash.
Commands executed:
Crash traceback
show version
•
show logging
•
show region
•
show stack
•
Crash system
show version
•
show inventory
•
show logging
•
show region
•
show stack
•
more crashinfo-file
•
Crash module
show version
•
show inventory
•
show platform
•
show logging
•
show region
•
show stack
•
more crashinfo-file
•
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
48
Page 61
Call Home
Alert Groups Trigger Events and Commands
Diagnostic
FAN_FAILUREEnvironmental
TEMPERATURE_ALARM
——
CBR_PEM-3FANFAIL
ENVIRONMENTAL
-1-ALERT
SeveritySyslog EventCall Home Trigger EventAlert Group
minor
minorCBR_PEM-6-FANOK
Description and Executed
Commands
Events that are generated by
diagnostics.
Commands executed:
show platform
•
show version
•
show diagnostic event
•
slot detail
show inventory
•
show buffers
•
show logging
•
show diagnostic events
•
slot all
Events that are related to
power, fan, and environment
sensing elements, such as
temperature alarms.
Commands executed:
show platform
•
POWER_SUPPLY_FAILURE
CBR_PEM-6-PEMOK
CBR_PEM-3PEMFAIL
show environment
•
show inventory
•
show logging
•
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
49
Page 62
Alert Groups Trigger Events and Commands
Call Home
Inventory
OIR_REMOVE
OIR_INSERTION
—
SeveritySyslog EventCall Home Trigger EventAlert Group
normal
Description and Executed
Commands
Inventory status that is
provided whenever a unit is
cold booted, or when FRUs
are inserted or removed. This
alert is considered as a
noncritical event, and the
information is used for status
and entitlement.
Command executed:
show platform
•
show version
•
show inventory oid
•
show diag all eeprom
•
detail
show interfaces
•
show file systems
•
show bootflash: all
•
Snapshot
Syslog
show data-corruption
•
show memory statistics
•
show process memory
•
show process cpu
•
show process cpu
•
history
show license udi
•
show license detail
•
show buffers
•
show platform software
•
proc slot monitor cycle
——
normal
User-generated CLI
commands.
——
major
Events that are generated by
Syslog messages.
Commands executed:
show inventory
•
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
50
show logging
•
Page 63
Call Home
Message Contents
Test
Message Contents
Smart Call Home supports the following message formats:
Short Text Message Format
•
Common Fields for Full Text and XML Messages
•
Fields Specific to Alert Group Messages for Full Text and XML Messages
•
Inserted Fields for a Reactive and Proactive Event Message
•
SeveritySyslog EventCall Home Trigger EventAlert Group
——
normal
Description and Executed
Commands
User-generated test message
sent to the destination profile.
Commands executed:
show inventory
•
show platform
•
show version
•
Inserted Fields for an Inventory Event Message
•
Inserted Fields for a User-Generated Test Message
•
The following table describes the short text formatting option for all the message types.
Table 5: Short Text Message Format
DescriptionData Item
Configured device name.Device identification
Time stamp of the triggering event.Date and time stamp
Plain English description of triggering the event.Error isolation message
Error level such as that applied to the system message.Alarm urgency level
The following table describes the first set of common event message fields for full text or XML messages.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
51
Page 64
Message Contents
Call Home
Table 6: Common Fields for Full Text and XML Messages
Call-Home Message Tag (XML Only)Description (Plain Text and XML)Data Item
(Plain Text and
XML)
Time stamp
Message type
Message
subtype
Message group
Source ID
Device ID
CallHome/EventTimeDate and time stamp of the event in the
ISO time notation:
YYYY-MM-DD HH:MM:SS GMT +
HH:MM.
For short text message onlyName of message.Message name
CallHome/Event/TypeName of the message type, specifically
"Call Home."
CallHome/Event/SubTypeSpecific type of message: full, delta,
test.
For long-text message onlyName of the alert group, specifically
"reactive." Optional, because the default
is "reactive".
Body/Block/SeveritySeverity level of messageSeverity level
For long-text message onlyProduct type for routing through the
workflow engine. The Source ID is
typically the product family name.
CallHome/CustomerData/ContractData/DeviceIdUnique device identifier (UDI) for the
end device that generated the message.
Ensure that the field is empty if the
message is nonspecific to a device. The
format is type@Sid@serial.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
52
Customer ID
Contract ID
• type is the product model number
from the backplane IDPROM.
• @ is a separator character.
• Sid is C, identifying the serial ID
as a chassis serial number.
• serial is the number that is
identified by the Sid field.
An example is
WS-C6509@C@12345678
CallHome/CustomerData/ContractData/CustomerIdOptional user-configurable field that is
used for contract information or other
ID by any support service.
CallHome/CustomerData/ContractData/ContractIdOptional user-configurable field that is
used for contract information or other
ID by any support service.
Page 65
Call Home
Message Contents
Call-Home Message Tag (XML Only)Description (Plain Text and XML)Data Item
(Plain Text and
XML)
Site ID
Server ID
description
Device name
CallHome/CustomerData/ContractData/SiteIdOptional user-configurable field that is
used for Cisco-supplied site ID or other
data meaningful to alternate support
service.
For long text message onlyIf the message is generated from the
device, this is the unique device
identifier (UDI) of the device. The
format is type@Sid@serial.
• type is the product model number
from the backplane IDPROM.
• @ is a separator character.
• Sid is C, identifying the serial ID
as a chassis serial number.
• serial is the number that is
identified by the Sid field.
An example is
WS-C6509@C@12345678.
CallHome/MessageDescriptionShort text that describes the error.Message
CallHome/CustomerData/SystemInfo/NameNameNode that experienced the event
(hostname of the device).
Contact name
Contact email
Contact phone
number
Street address
Model name
number
CallHome/CustomerData/SystemInfo/ContactName of the contact person for issues
that are associated with the node that
experienced the event.
CallHome/CustomerData/SystemInfo/ContactEmailEmail address of the contact person for
this unit.
CallHome/CustomerData/SystemInfo/ContactPhoneNumberPhone number of the contact person for
this unit.
CallHome/CustomerData/SystemInfo/StreetAddressOptional field that contains the street
address for RMA part shipments that
are associated with this unit.
CallHome/Device/Cisco_Chassis/ModelModel name of the device (the specific
model as part of a product family
name).
CallHome/Device/Cisco_Chassis/SerialNumberChassis serial number of the unit.Serial number
/aml/body/chassis/partNoTop assembly number of the chassis.Chassis part
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
53
Page 66
Message Contents
Call Home
Call-Home Message Tag (XML Only)Description (Plain Text and XML)Data Item
(Plain Text and
XML)
System object
ID
System
description
System Object ID that uniquely
identifies the system.
System description for the managed
element.
CallHome/Device/Cisco_Chassis/
AdditionalInformation/AD@name=“sysObjectID”
CallHome/Device/Cisco_Chassis/
AdditionalInformation/AD@name=“sysDescr”
The following table describes the fields specific to alert group messages for full text and XML. These fields
may be repeated if multiple commands are executed for an alert group.
Table 7: Fields Specific to Alert Group Messages for Full Text and XML Messages
XML Tag (XML Only)Description (Plain Text and XML)Data Item (Plain Text and XML)
Command output name
/aml/attachments/attachment/nameExact name of the issued
command.
/aml/attachments/attachment/typeSpecific command output.Attachment type
/aml/attachments/attachment/mimeEither plain text or encoding type.MIME type
Command output text
/mml/attachments/attachment/atdataOutput of the command that is
automatically executed.
The following table describes the reactive and proactive event message format for full text or XML messages.
Table 8: Inserted Fields for a Reactive and Proactive Event Message
version
Affected FRU name
generating the event message.
FRU slot
generating the event message.
FRU hardware version
FRU.
FRU software version
the affected FRU.
XML Tag (XML Only)Description (Plain Text and XML)Data Item (Plain Text and XML)
/aml/body/chassis/hwVersionHardware version of chassis.Chassis hardware version
/aml/body/chassis/swVersionTop-level software version.Supervisor module software
/aml/body/fru/nameName of the affected FRU that is
/aml/body/fru/serialNoSerial number of the affected FRU.Affected FRU serial number
/aml/body/fru/partNoPart number of the affected FRU.Affected FRU part number
/aml/body/fru/slotSlot number of the FRU that is
/aml/body/fru/hwVersionHardware version of the affected
/aml/body/fru/swVersionSoftware version that is running on
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
54
Page 67
Call Home
Sample syslog Alert Notification in XML Format
The following table describes the inventory event message format for full text or XML messages.
Table 9: Inserted Fields for an Inventory Event Message
XML Tag (XML Only)Description (Plain Text and XML)Data Item (Plain Text and XML)
/aml/body/chassis/hwVersionHardware version of the chassis.Chassis hardware version
/aml/body/chassis/swVersionTop-level software version.Supervisor module software
version
FRU name
/aml/body/fru/nameName of the affected FRU that is
generating the event message.
/aml/body/fru/serialNoSerial number of the FRU.FRU s/n
/aml/body/fru/partNoPart number of the FRU.FRU part number
/aml/body/fru/slotSlot number of the FRU.FRU slot
/aml/body/fru/hwVersionHardware version of the FRU.FRU hardware version
FRU software version
/aml/body/fru/swVersionSoftware version that is running on
the FRU.
The following table describes the user-generated test message format for full text or XML.
Table 10: Inserted Fields for a User-Generated Test Message
XML Tag (XML Only)Description (Plain Text and XML)Data Item (Plain Text and XML)
/aml/body/process/idUnique process ID.Process ID
Process state
/aml/body/process/processStateState of process (for example,
running or halted).
/aml/body/process/exceptionException or reason code.Process exception
Sample syslog Alert Notification in XML Format
<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope
xmlns:soap-env="http://www.w3.org/2003/05/soap-envelope">
<soap-env:Header>
<aml-session:Session
xmlns:aml-session="http://www.cisco.com/2004/01/aml-session"
soap-env:mustUnderstand="true"
soap-env:role="http://www.w3.org/2003/05/soap-envelope/role/next">
<aml-session:To>http://tools.cisco.com/neddce/services/DDCEService</aml
-session:To>
<aml-session:Path>
<aml-session:Via>http://www.cisco.com/appliance/uri</aml-session:Via>
</aml-session:Path>
<aml-session:From>http://www.cisco.com/appliance/uri</aml-session:From>
<aml-session:MessageId>MA:FXS1739Q0NR:548F4417</aml-session:MessageId>
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
55
Page 68
Sample syslog Alert Notification in XML Format
</aml-session:Session>
</soap-env:Header>
<soap-env:Body>
<aml-block:Block
xmlns:aml-block="http://www.cisco.com/2004/01/aml-block">
<aml-block:Header>
<aml-block:Type>http://www.cisco.com/2005/05/callhome/syslog</aml-block
:Type>
<aml-block:CreationDate>2014-12-16 04:27:03
GMT+08:00</aml-block:CreationDate>
<aml-block:Builder>
<aml-block:Name>CBR8</aml-block:Name>
<aml-block:Version>2.0</aml-block:Version>
</aml-block:Builder>
<aml-block:BlockGroup>
<aml-block:GroupId>GB:FXS1739Q0NR:548F4417</aml-block:GroupId>
<aml-block:Number>0</aml-block:Number>
<aml-block:IsLast>true</aml-block:IsLast>
<aml-block:IsPrimary>true</aml-block:IsPrimary>
<aml-block:WaitForPrimary>false</aml-block:WaitForPrimary>
</aml-block:BlockGroup>
<aml-block:Severity>6</aml-block:Severity>
</aml-block:Header>
<aml-block:Content>
<ch:CallHome xmlns:ch="http://www.cisco.com/2005/05/callhome"
version="1.0">
<ch:EventTime>2014-12-16 04:26:59 GMT+08:00</ch:EventTime>
<ch:MessageDescription>Dec 16 04:26:59.885 CST: %ENVIRONMENTAL-1-ALERT:
Temp: INLET, Location: 6, State: Critical, Reading: 53
Celsius</ch:MessageDescription> <ch:Event> <ch:Type>syslog</ch:Type>
<ch:SubType></ch:SubType> <ch:Brand>Cisco Systems</ch:Brand>
<ch:Series>CBR8 Series Routers</ch:Series> </ch:Event>
<ch:CustomerData> <ch:UserData> <ch:Email>xxxx@company.com</ch:Email>
</ch:UserData>
<ch:ContractData>
<ch:CustomerId></ch:CustomerId>
<ch:SiteId></ch:SiteId>
<ch:ContractId></ch:ContractId>
<ch:DeviceId>CBR-8-CCAP-CHASS@C@FXS1739Q0NR</ch:DeviceId>
</ch:ContractData>
<ch:SystemInfo>
<ch:Name>sig-cbr</ch:Name>
<ch:Contact></ch:Contact>
<ch:ContactEmail>xxxx@company.com</ch:ContactEmail>
<ch:ContactPhoneNumber></ch:ContactPhoneNumber>
<ch:StreetAddress></ch:StreetAddress>
</ch:SystemInfo>
<ch:CCOID></ch:CCOID>
</ch:CustomerData>
<ch:Device>
<rme:Chassis xmlns:rme="http://www.cisco.com/rme/4.0">
<rme:Model>CBR-8-CCAP-CHASS</rme:Model>
<rme:HardwareVersion>0.1</rme:HardwareVersion>
<rme:SerialNumber>FXS1739Q0NR</rme:SerialNumber>
<rme:AdditionalInformation>
<rme:AD name="PartNumber" value="000-00000-00" /> <rme:AD
name="SoftwareVersion" value="15.5(20141214:005145) " /> <rme:AD
name="SystemObjectId" value="1.3.6.1.4.1.9.1.2141" /> <rme:AD
name="SystemDescription" value="Cisco IOS Software, IOS-XE Software
(X86_64_LINUX_IOSD-ADVENTERPRISEK9-M), Experimental Version
15.5(20141214:005145) [ece5_throttle_ios-ram-ece5-bk 105] Copyright (c)
1986-2014 by Cisco Systems, Inc.
Compiled Sun 14-Dec-14 00:20 by ram" /> <rme:AD name="ServiceNumber"
value="" /> <rme:AD name="ForwardAddress" value="" />
</rme:AdditionalInformation> </rme:Chassis> </ch:Device> </ch:CallHome>
</aml-block:Content> <aml-block:Attachments> <aml-block:Attachment
type="inline"> <aml-block:Name>show inventory</aml-block:Name>
<aml-block:Data encoding="plain"> <
Call Home
Sample syslog Alert Notification in XML Format
NAME: "sup 0", DESCR: "Cisco cBR CCAP Supervisor Card"
PID: CBR-CCAP-SUP-160G , VID: V01, SN: CAT1736E05L
NAME: "harddisk 4/1", DESCR: "Hard Disk"
PID: UGB88RTB100HE3-BCU-DID, VID: , SN: 11000072780
NAME: "sup-pic 4/1", DESCR: "Cisco cBR CCAP Supervisor Card PIC"
PID: CBR-SUPPIC-8X10G , VID: V01, SN: CAT1735E004
NAME: "SFP+ module 4/1/0", DESCR: "iNSI xcvr"
PID: SFP+ 10GBASE-SR , VID: A , SN: FNS1727294V
NAME: "SFP+ module 4/1/1", DESCR: "iNSI xcvr"
PID: SFP+ 10GBASE-SR , VID: A , SN: FNS172727WZ
NAME: "SFP+ module 4/1/4", DESCR: "iNSI xcvr"
PID: 10GE ZR , VID: , SN: AGM120525EW
NAME: "sup 1", DESCR: "Cisco cBR CCAP Supervisor Card"
PID: CBR-CCAP-SUP-160G , VID: V01, SN: CAT1736E05L
NAME: "clc 6", DESCR: "Cisco cBR CCAP Line Card"
PID: CBR-CCAP-LC-40G , VID: V01, SN: CAT1736E0EN
NAME: "Cable PHY Module", DESCR: "CLC Downstream PHY Module 6/0"
PID: cBR-8-GEMINI , VID: V01 , SN: CSJ13152101
NAME: "Cable PHY Module", DESCR: "CLC Upstream PHY Module 6/2"
PID: cBR-8-LEOBEN , VID: V01 , SN: TST98765432
NAME: "Power Supply Module 0", DESCR: "Cisco cBR CCAP AC Power Supply"
PID: PWR-3KW-AC-V2 , VID: V02, SN: DTM173702KQ
NAME: "Power Supply Module 2", DESCR: "Cisco cBR CCAP AC Power Supply"
PID: PWR-3KW-AC-V2 , VID: V02, SN: DTM173702GD
sig-cbr#]]></aml-block:Data>
</aml-block:Attachment>
<aml-block:Attachment type="inline">
<aml-block:Name>show logging</aml-block:Name> <aml-block:Data
encoding="plain"> <![CDATA[show logging Load for five secs: 2%/0%; one
minute: 2%; five minutes: 2% Time source is NTP, 04:27:02.886 CST Tue
Dec 16 2014
Syslog logging: enabled (0 messages dropped, 51 messages rate-limited,
0 flushes, 0 overruns, xml disabled, filtering disabled)
No Active Message Discriminator.
No Inactive Message Discriminator.
Console logging: level debugging, 213 messages logged, xml disabled,
Monitor logging: level debugging, 0 messages logged, xml disabled,
Buffer logging: level debugging, 262 messages logged, xml disabled,
Exception Logging: size (4096 bytes)
Count and timestamp logging messages: disabled
Persistent logging: disabled
No active filter modules.
Trap logging: level informational, 209 message lines logged
Logging Source-Interface: VRF Name:
Log Buffer (1000000 bytes):
*Dec 15 20:20:16.188: Rommon debug: debugFlagsStr[7], flags[0x7] *Dec
filtering disabled
filtering disabled
filtering disabled
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
57
Page 70
Sample syslog Alert Notification in XML Format
15 20:20:16.188: TRACE - Debug flag set 0x7 *Dec 15 20:20:16.188: TRACE
- Register NV N:systemInitByEvent V:True with no CallBack *Dec 15
20:20:16.188: TRACE - Register NV N:routingReadyByEvent V:True with no
CallBack *Dec 15 20:20:16.188: TRACE - Smart agent init started.
Version=1.2.0_dev/22
*Dec 15 20:20:16.188: ERROR - PD init failed: The requested operation
is not supported *Dec 15 20:20:16.188: ERROR - Pre Role Init Failed:
The requested operation is not supported *Dec 15 20:20:16.188: TRACE Smart agent init Done. status 10, state 4294967295, init 0 enable 0
Current Role Invalid *Dec 15 20:20:16.188: TRACE - Shutdown Started
*Dec 15 20:20:16.188: DEBUG - Scheduler shutdown start *Dec 15
20:20:16.188: ERROR - Failed to set shutdown watched boolean (code
Invalid argument (22)). Going the hard way!!!
*Dec 15 20:20:16.188: DEBUG - Destroying XOS stuff to exit dispatch
loop *Dec 15 20:20:16.188: DEBUG - XDM dispatch loop about to exit *Dec
15 20:20:16.188: DEBUG - Scheduler shutdown end *Dec 15 20:20:16.188:
ERROR - SmartAgent not initialized.
*Dec 15 20:20:16.188: ERROR - Smart Agent not a RF client *Dec 15
20:20:16.188: ERROR - Smart Agent not a CF client *Dec 15 20:20:16.188:
TRACE - Setting Ha Mgmt Init FALSE *Dec 15 20:20:16.188: TRACE Shutting down Any Role *Dec 15 20:20:17.432: (DBMS RPHA) Client
initialization; status=success *Dec 15 20:20:17.432: CABLE Parser
Trace: cable_parser_init:82 *Dec 15 20:20:17.774: ****
mcprp_ubr_punt_init: Initialized*****
-->RF_STATUS_SEND_RF_STATE received-->RF_PROG_INITIALIZATION received
*Dec 15 20:20:20.790: CWAN OIR debugging enabled (ROMMON variable
DEBUG_CWAN_OIR set)-->RF_PROG_ACTIVE_FAST
received-->RF_PROG_ACTIVE_DRAIN
received-->RF_PROG_ACTIVE_PRECONFIG
received-->received-->RF_PROG_ACTIVE_POSTCONFIG
received-->RF_PROG_ACTIVE received
*Dec 15 20:20:20.841: **** IPC port 0x1000E created!
*Dec 15 20:20:20.841: **** CIPC RP Server created UBRCCE_CIPC_14/0 !
*Dec 15 20:20:28.294: %SPANTREE-5-EXTENDED_SYSID: Extended SysId
enabled for type vlan *Dec 15 20:20:31.944: %VOICE_HA-7-STATUS: CUBE
HA-supported platform detected.
*Dec 15 20:20:33.391: instant_msg_handle_proc_sup started!!
*Dec 15 20:20:33.391: queue_msg_handle_proc_sup started!!
*Dec 15 20:20:35.603: %IOSXE_MGMTVRF-6-CREATE_SUCCESS_INFO: Management
vrf Mgmt-intf created with ID 1, ipv4 table-id 0x1, ipv6 table-id
0x1E000001
*Dec 15 20:20:34.513: %IOSXE-6-PLATFORM: CLC4: cpp_cp: Process
CPP_PFILTER_EA_EVENT__API_CALL__REGISTER
*Dec 15 20:20:03.806: %HW_PFU-3-PFU_IDPROM_CORRUPT: R0/0: cmand: The
PEM/FM idprom could be read, but is corrupt in slot P11 The system will
run without environmental monitoring for this component *Dec 15
20:20:09.012: %SYSTEM-3-SYSTEM_SHELL_LOG: R0/0: 2014/12/15
20:20:08 : <anon>
*Dec 15 20:20:13.919: %IOSXE-4-PLATFORM: R0/0: kernel: astro: FD open
*Dec 15 20:20:13.919: %IOSXE-4-PLATFORM: R0/0: kernel: astro: astro:
mmio_start=d0000000 mmio_len=2000000
*Dec 15 20:20:13.919: %IOSXE-4-PLATFORM: R0/0: kernel: astro: Done
astro Memory map base_ptr ffffc90016600000, astro_reg_ptr ffffc90016600000...
*Dec 15 20:20:16.259: %IOSXE-4-PLATFORM: R0/0: kernel: astro: FD open
*Dec 15 20:20:16.553: %CPPHA-7-START: F0: cpp_ha: CPP 0 preparing
ucode *Dec 15 20:20:17.220: %CPPHA-7-START: F0: cpp_ha: CPP 0 startup
init *Dec 15 20:20:18.549: %PMAN-3-PROC_EMPTY_EXEC_FILE: F0: pvp.sh:
Empty executable used for process iosdb *Dec 15 20:20:20.003:
%PMAN-3-PROC_EMPTY_EXEC_FILE: CLC4: pvp.sh: Empty executable used for
process iosdb *Dec 15 20:20:20.783: %PMAN-3-PROC_EMPTY_EXEC_FILE: CLC4:
pvp.sh: Empty executable used for process iosdb *Dec 15 20:20:24.061:
%HW_PFU-3-PFU_IDPROM_CORRUPT: R0/0: cmand: The PEM/FM idprom could be
read, but is corrupt in slot P11 The system will run without
environmental monitoring for this component *Dec 15 20:20:31.722:
%CPPHA-7-START: F0: cpp_ha: CPP 0 running init *Dec 15 20:20:32.070:
%CPPHA-7-READY: F0: cpp_ha: CPP 0 loading and initialization complete
*Dec 15 20:20:36.528 UTC: TRACE - Platform EventCB invoked. EventType:
8 *Dec 15 20:20:36.528 UTC: DEBUG - Hostname changed. Old:sig-cbr
New:sig-cbr *Dec 15 20:20:36.528 UTC: %CNS IQ:0.1 ID:0
Changed:[sig-cbr] *Dec 15 20:20:36.528 UTC: %CNS IQ:0.2 ID:1
Changed:[sig-cbr] *Dec 15 20:20:36.528 UTC: %CNS IQ:0.3 ID:2
Changed:[sig-cbr] *Dec 15 20:20:36.594 UTC: %SYS-5-LOG_CONFIG_CHANGE:
Buffer logging: level debugging, xml disabled, filtering disabled, size
Call Home
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
58
Page 71
Call Home
Sample syslog Alert Notification in XML Format
(1000000) *Dec 16 04:20:36.597 CST: %SYS-6-CLOCKUPDATE: System clock
has been updated from 20:20:36 UTC Mon Dec 15 2014 to 04:20:36 CST Tue
Dec 16 2014, configured from console by console.
*Dec 16 04:20:36.607 CST: spa_type 2946 ports 8 *Dec 16 04:20:36.622
CST: spa_type 2946 ports 8 *Dec 16 04:20:37.350 CST:
cmts_set_int_us_qos_flags: move US-QOS flags 0 to CDMAN *Dec 16
04:20:37.350 CST: cmts_set_int_us_default_weights: move US-QOS weights
to CDMAN *Dec 16 04:20:36.625 CST: %IOSXE-4-PLATFORM: R0/0: kernel:
astro: FD open *Dec 16 04:20:43.221 CST: %LINEPROTO-5-UPDOWN: Line
protocol on Interface Video6/0/0, changed state to up *Dec 16
04:20:43.223 CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
Video6/0/1, changed state to up *Dec 16 04:20:43.502 CST: % Redundancy
mode change to SSO
*Dec 16 04:20:43.502 CST: %VOICE_HA-7-STATUS: NONE->SSO; SSO mode will
not take effect until after a platform
reload.-->RF_STATUS_REDUNDANCY_MODE_CHANGE received *Dec 16
04:20:44.220 CST: %SYS-5-CONFIG_I: Configured from memory by console
*Dec 16 04:20:44.228 CST: %IOSXE_OIR-6-INSCARD: Card (rp) inserted in
slot R1 *Dec 16 04:20:44.229 CST: %IOSXE_OIR-6-INSCARD: Card (fp)
inserted in slot F0 *Dec 16 04:20:44.229 CST: %IOSXE_OIR-6-ONLINECARD:
Card (fp) online in slot F0 *Dec 16 04:20:44.263 CST:
%IOSXE_OIR-6-INSCARD: Card (fp) inserted in slot F1 *Dec 16
04:20:44.263 CST: %IOSXE_OIR-6-INSCARD: Card (cc) inserted in slot 4
*Dec 16 04:20:44.263 CST: %IOSXE_OIR-6-ONLINECARD: Card (cc) online in
slot 4 *Dec 16 04:20:44.264 CST: %IOSXE_OIR-6-INSCARD: Card (cc)
inserted in slot 5 *Dec 16 04:20:44.264 CST: %IOSXE_OIR-6-INSCARD: Card
(cc) inserted in slot 6 *Dec 16 04:20:44.330 CST: %IOSXE_OIR-6-INSSPA:
SPA inserted in subslot 4/1 *Dec 16 04:20:44.751 CST: %SYS-5-RESTART:
System restarted -- Cisco IOS Software, IOS-XE Software
(X86_64_LINUX_IOSD-ADVENTERPRISEK9-M), Experimental Version
15.5(20141214:005145) [ece5_throttle_ios-ram-ece5-bk 105] Copyright (c)
1986-2014 by Cisco Systems, Inc.
Compiled Sun 14-Dec-14 00:20 by ram
*Dec 16 04:20:44.775 CST: %XML-SRVC: Security Enforcement XML
Service(111) OK. PID=574
*Dec 16 04:20:44.775 CST: %SSH-5-ENABLED: SSH 1.99 has been enabled
*Dec 16 04:20:45.453 CST: %LINK-3-UPDOWN: Interface GigabitEthernet0,
changed state to up *Dec 16 04:20:45.543 CST: %LINK-5-CHANGED:
Interface TenGigabitEthernet4/1/2, changed state to administratively
down *Dec 16 04:20:45.546 CST: %LINK-5-CHANGED: Interface
TenGigabitEthernet4/1/3, changed state to administratively down *Dec 16
04:20:45.548 CST: %LINK-5-CHANGED: Interface TenGigabitEthernet4/1/4,
changed state to administratively down *Dec 16 04:20:45.551 CST:
%LINK-5-CHANGED: Interface TenGigabitEthernet4/1/5, changed state to
administratively down *Dec 16 04:20:45.571 CST: %LINK-5-CHANGED:
Interface TenGigabitEthernet4/1/6, changed state to administratively
down *Dec 16 04:20:45.574 CST: %LINK-5-CHANGED: Interface
TenGigabitEthernet4/1/7, changed state to administratively down *Dec 16
04:20:45.576 CST: %LINK-5-CHANGED: Interface TenGigabitEthernet5/1/0,
changed state to administratively down *Dec 16 04:20:45.578 CST:
%LINK-5-CHANGED: Interface TenGigabitEthernet5/1/1, changed state to
administratively down *Dec 16 04:20:45.580 CST: %LINK-5-CHANGED:
Interface TenGigabitEthernet5/1/2, changed state to administratively
down *Dec 16 04:20:45.582 CST: %LINK-5-CHANGED: Interface
TenGigabitEthernet5/1/3, changed state to administratively down *Dec 16
04:20:45.584 CST: %LINK-5-CHANGED: Interface TenGigabitEthernet5/1/4,
changed state to administratively down *Dec 16 04:20:45.586 CST:
%LINK-5-CHANGED: Interface TenGigabitEthernet5/1/5, changed state to
administratively down *Dec 16 04:20:45.588 CST: %LINK-5-CHANGED:
Interface TenGigabitEthernet5/1/6, changed state to administratively
down *Dec 16 04:20:45.590 CST: %LINK-5-CHANGED: Interface
TenGigabitEthernet5/1/7, changed state to administratively down *Dec 16
04:20:45.596 CST: %LINK-3-UPDOWN: Interface Integrated-Cable6/0/0:0,
changed state to down *Dec 16 04:20:45.602 CST: %LINK-3-UPDOWN:
Interface Integrated-Cable6/0/0:1, changed state to down *Dec 16
04:20:45.603 CST: %LINK-3-UPDOWN: Interface Integrated-Cable6/0/0:2,
changed state to down *Dec 16 04:20:45.604 CST: %LINK-3-UPDOWN:
Interface Integrated-Cable6/0/0:3, changed state to down *Dec 16
04:20:45.606 CST: %LINK-3-UPDOWN: Interface Integrated-Cable6/0/0:4,
changed state to down *Dec 16 04:20:45.607 CST: %LINK-3-UPDOWN:
Interface Integrated-Cable6/0/0:5, changed state to down *Dec 16
04:20:45.608 CST: %LINK-3-UPDOWN: Interface Integrated-Cable6/0/0:6,
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
59
Page 72
Sample syslog Alert Notification in XML Format
changed state to down *Dec 16 04:20:45.610 CST: %LINK-3-UPDOWN:
Interface Integrated-Cable6/0/0:7, changed state to down *Dec 16
04:20:45.648 CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
Bundle1, changed state to up *Dec 16 04:20:45.649 CST: %LINK-3-UPDOWN:
Interface Bundle1, changed state to up *Dec 16 04:20:45.649 CST:
%LINK-3-UPDOWN: Interface Cable6/0/0, changed state to down *Dec 16
04:20:45.649 CST: %SNMP-5-LINK_DOWN: LinkDown:Interface
Cable6/0/0 changed state to down
*Dec 16 04:20:45.666 CST: %LINK-3-UPDOWN: Interface
Wideband-Cable6/0/0:0, changed state to down *Dec 16 04:20:45.666 CST:
%LINK-3-UPDOWN: Interface Wideband-Cable6/0/0:1, changed state to down
*Dec 16 04:20:45.681 CST: %LINK-3-UPDOWN: Interface
Wideband-Cable6/0/0:2, changed state to down *Dec 16 04:20:45.681 CST:
%LINK-3-UPDOWN: Interface Wideband-Cable6/0/0:3, changed state to down
*Dec 16 04:20:45.681 CST: %LINK-3-UPDOWN: Interface
Wideband-Cable6/0/0:4, changed state to down *Dec 16 04:20:45.681 CST:
%LINK-3-UPDOWN: Interface Wideband-Cable6/0/0:5, changed state to down
*Dec 16 04:20:45.682 CST: %LINK-3-UPDOWN: Interface
Wideband-Cable6/0/0:6, changed state to down *Dec 16 04:20:45.682 CST:
%LINK-3-UPDOWN: Interface Wideband-Cable6/0/0:7, changed state to down
*Dec 16 04:20:45.685 CST: %LINK-3-UPDOWN: Interface
Integrated-Cable6/0/1:0, changed state to down *Dec 16 04:20:45.694
CST: %LINK-3-UPDOWN: Interface Integrated-Cable6/0/1:1, changed state
to down *Dec 16 04:20:45.694 CST: %LINK-3-UPDOWN: Interface Cable6/0/1,
changed state to down *Dec 16 04:20:45.694 CST: %SNMP-5-LINK_DOWN:
LinkDown:Interface
Cable6/0/1 changed state to down
*Dec 16 04:20:45.699 CST: %LINK-3-UPDOWN: Interface
Wideband-Cable6/0/1:0, changed state to down *Dec 16 04:20:45.703 CST:
%LINK-3-UPDOWN: Interface Wideband-Cable6/0/1:1, changed state to down
*Dec 16 04:20:45.706 CST: %LINK-3-UPDOWN: Interface
Integrated-Cable6/0/1:2, changed state to down *Dec 16 04:20:45.707
CST: %LINK-3-UPDOWN: Interface Integrated-Cable6/0/1:3, changed state
to down *Dec 16 04:20:45.709 CST: %LINK-3-UPDOWN: Interface
Wideband-Cable6/0/2:0, changed state to down *Dec 16 04:20:46.469 CST:
%SNMP-5-COLDSTART: SNMP agent on host sig-cbr is undergoing a cold
start *Dec 16 04:20:46.472 CST: %LINEPROTO-5-UPDOWN: Line protocol on
Interface GigabitEthernet0, changed state to up *Dec 16 04:20:46.543
CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
TenGigabitEthernet4/1/2, changed state to down *Dec 16 04:20:46.546
CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
TenGigabitEthernet4/1/3, changed state to down *Dec 16 04:20:46.548
CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
TenGigabitEthernet4/1/4, changed state to down *Dec 16 04:20:46.551
CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
TenGigabitEthernet4/1/5, changed state to down *Dec 16 04:20:46.571
CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
TenGigabitEthernet4/1/6, changed state to down *Dec 16 04:20:46.574
CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
TenGigabitEthernet4/1/7, changed state to down *Dec 16 04:20:46.576
CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
TenGigabitEthernet5/1/0, changed state to down *Dec 16 04:20:46.578
CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
TenGigabitEthernet5/1/1, changed state to down *Dec 16 04:20:46.580
CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
TenGigabitEthernet5/1/2, changed state to down *Dec 16 04:20:46.582
CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
TenGigabitEthernet5/1/3, changed state to down *Dec 16 04:20:46.584
CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
TenGigabitEthernet5/1/4, changed state to down *Dec 16 04:20:46.586
CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
TenGigabitEthernet5/1/5, changed state to down *Dec 16 04:20:46.588
CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
TenGigabitEthernet5/1/6, changed state to down *Dec 16 04:20:46.590
CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
TenGigabitEthernet5/1/7, changed state to down *Dec 16 04:20:46.641
CST: %SYS-6-BOOTTIME: Time taken to reboot after reload = 374 seconds
*Dec 16 04:20:53.697 CST: %IOSXE-1-PLATFORM: R0/0: kernel: Raptor MAC
image download wrote 55917152 bytes *Dec 16 04:21:23.432 CST:
%TRANSCEIVER-6-INSERTED: CLC4: iomd:
transceiver module inserted in TenGigabitEthernet4/1/0 *Dec 16
04:21:23.435 CST: %TRANSCEIVER-6-INSERTED: CLC4: iomd:
transceiver module inserted in TenGigabitEthernet4/1/1 *Dec 16
Call Home
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
60
Page 73
Call Home
Sample syslog Alert Notification in XML Format
04:21:23.440 CST: %TRANSCEIVER-6-INSERTED: CLC4: iomd:
transceiver module inserted in TenGigabitEthernet4/1/4 *Dec 16
04:21:29.430 CST: %CBRDTI-5-DTISLOT: DTI slot 4/1: card role changed to
Active
*Dec 16 04:21:29.454 CST: %SPA_OIR-6-ONLINECARD: SPA (CBR-SUPPIC-8X10G)
online in subslot 4/1 *Dec 16 04:21:31.403 CST: %LINK-3-UPDOWN:
Interface TenGigabitEthernet4/1/0, changed state to up *Dec 16
04:21:31.405 CST: %CBR_SPA-7-RAPTOR_ESI_EGRESS_HDR_LO_INTERRUPT:
CLC4: iomd: LOCAL RAPTOR, DP 0, channel_not_found_err *Dec 16
04:21:31.412 CST: %LINK-3-UPDOWN: Interface TenGigabitEthernet4/1/1,
changed state to up *Dec 16 04:21:32.403 CST: %LINEPROTO-5-UPDOWN: Line
protocol on Interface TenGigabitEthernet4/1/0, changed state to up *Dec
16 04:21:32.412 CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
TenGigabitEthernet4/1/1, changed state to up *Dec 16 04:21:41.171 CST:
%IOSXE-3-PLATFORM: R0/0: kernel: i801_smbus
0000:00:1f.3: Transaction timeout
*Dec 16 04:21:41.174 CST: %IOSXE-3-PLATFORM: R0/0: kernel:
/nobackup/ram/ece5-bk/binos/os/linux/drivers/binos/i2c/max3674/max3674_
mai n.c:show_reg_pll (line 88): show_reg_pll failed *Dec 16
04:21:58.237 CST: %IOSXE-5-PLATFORM: CLC6: cdman: Basestar FPGA rev_id
0x00000002, fpga_rev_id 0x00000032 *Dec 16 04:21:59.074 CST:
%CMRP-3-BAD_ID_HW: R0/0: cmand: Failed Identification Test in CBR
linecard. The module linecard slot 6 in this router may not be a
genuine Cisco product. Cisco warranties and support programs only apply
to genuine Cisco products. If Cisco determines that your insertion of
non-Cisco memory, WIC cards, AIM cards, Network Modules, SPA cards,
GBICs or other modules into a Cisco product is the cause of a support
issue, Cisco may deny support under your warranty or under a Cisco
support pro *Dec 16 04:21:59.075 CST: %IOSXE_OIR-6-ONLINECARD: Card
(cc) online in slot 6 *Dec 16 04:22:08.825 CST:
%ASR1000_INFRA-3-EOBC_SOCK: CLC6:
ubrclc-k9lc-ms: Socket event for EO6/0/1, fd 11, failed to bind;
Address already in use success *Dec 16 04:22:09.605 CST: SNMP IPC
session up(RP <-> slot 6)!
*Dec 16 04:22:09.605 CST: CMTS IPC session up!
*Dec 16 04:22:14.564 CST: %SNMP-5-LINK_UP: LinkUp:Interface
Cable6/0/0-upstream0 changed state to up *Dec 16 04:22:14.565 CST:
%SNMP-5-LINK_UP: LinkUp:Interface
Cable6/0/0-upstream1 changed state to up *Dec 16 04:22:14.566 CST:
%SNMP-5-LINK_UP: LinkUp:Interface
Cable6/0/2-upstream0 changed state to up *Dec 16 04:22:14.566 CST:
%SNMP-5-LINK_UP: LinkUp:Interface
Cable6/0/2-upstream1 changed state to up *Dec 16 04:22:15.051 CST:
%SNMP-5-LINK_UP: LinkUp:Interface Cable6/0/0 changed state to up *Dec
16 04:22:15.258 CST: %SNMP-5-LINK_UP: LinkUp:Interface Cable6/0/1
changed state to up *Dec 16 04:22:15.258 CST: %SNMP-5-LINK_UP:
LinkUp:Interface Cable6/0/2 changed state to up *Dec 16 04:22:15.259
CST: %SNMP-5-LINK_UP: LinkUp:Interface Cable6/0/3 changed state to up
*Dec 16 04:22:15.259 CST: %SNMP-5-LINK_UP: LinkUp:Interface Cable6/0/4
changed state to up *Dec 16 04:22:15.411 CST: %SNMP-5-LINK_UP:
LinkUp:Interface Cable6/0/5 changed state to up *Dec 16 04:22:15.411
CST: %SNMP-5-LINK_UP: LinkUp:Interface Cable6/0/6 changed state to up
*Dec 16 04:22:15.411 CST: %SNMP-5-LINK_UP: LinkUp:Interface Cable6/0/7
changed state to up *Dec 16 04:22:15.411 CST: %SNMP-5-LINK_UP:
LinkUp:Interface Cable6/0/8 changed state to up *Dec 16 04:22:15.432
CST: %SNMP-5-LINK_UP: LinkUp:Interface Cable6/0/9 changed state to up
*Dec 16 04:22:15.432 CST: %SNMP-5-LINK_UP: LinkUp:Interface Cable6/0/10
changed state to up *Dec 16 04:22:15.433 CST: %SNMP-5-LINK_UP:
LinkUp:Interface Cable6/0/11 changed state to up *Dec 16 04:22:15.433
CST: %SNMP-5-LINK_UP: LinkUp:Interface Cable6/0/12 changed state to up
*Dec 16 04:22:15.433 CST: %SNMP-5-LINK_UP: LinkUp:Interface Cable6/0/13
changed state to up *Dec 16 04:22:15.433 CST: %SNMP-5-LINK_UP:
LinkUp:Interface Cable6/0/14 changed state to up *Dec 16 04:22:15.433
CST: %SNMP-5-LINK_UP: LinkUp:Interface Cable6/0/15 changed state to up
*Dec 16 04:22:15.677 CST: %LINEPROTO-5-UPDOWN: Line protocol on
Interface Cable6/0/8, changed state to up *Dec 16 04:22:15.678 CST:
%LINEPROTO-5-UPDOWN: Line protocol on Interface Cable6/0/9, changed
state to up *Dec 16 04:22:15.901 CST: %LINEPROTO-5-UPDOWN: Line
protocol on Interface Cable6/0/10, changed state to up *Dec 16
04:22:15.902 CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
Cable6/0/11, changed state to up *Dec 16 04:22:15.902 CST:
%LINEPROTO-5-UPDOWN: Line protocol on Interface Cable6/0/12, changed
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
61
Page 74
Sample syslog Alert Notification in XML Format
state to up *Dec 16 04:22:15.903 CST: %LINEPROTO-5-UPDOWN: Line
protocol on Interface Cable6/0/13, changed state to up *Dec 16
04:22:15.903 CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
Cable6/0/14, changed state to up *Dec 16 04:22:15.904 CST:
%LINEPROTO-5-UPDOWN: Line protocol on Interface Cable6/0/15, changed
state to up *Dec 16 04:22:17.046 CST: %LINEPROTO-5-UPDOWN: Line
protocol on Interface Cable6/0/0, changed state to up *Dec 16
04:22:17.047 CST: %LINK-3-UPDOWN: Interface Cable6/0/0, changed state
to up *Dec 16 04:22:17.256 CST: %LINEPROTO-5-UPDOWN: Line protocol on
Interface Cable6/0/1, changed state to up *Dec 16 04:22:17.257 CST:
%LINK-3-UPDOWN: Interface Cable6/0/1, changed state to up *Dec 16
04:22:17.259 CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
Cable6/0/2, changed state to up *Dec 16 04:22:17.260 CST:
%LINK-3-UPDOWN: Interface Cable6/0/2, changed state to up *Dec 16
04:22:17.260 CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
Cable6/0/3, changed state to up *Dec 16 04:22:17.260 CST:
%LINK-3-UPDOWN: Interface Cable6/0/3, changed state to up *Dec 16
04:22:17.260 CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
Cable6/0/4, changed state to up *Dec 16 04:22:17.260 CST:
%LINK-3-UPDOWN: Interface Cable6/0/4, changed state to up *Dec 16
04:22:17.411 CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
Cable6/0/5, changed state to up *Dec 16 04:22:17.411 CST:
%LINK-3-UPDOWN: Interface Cable6/0/5, changed state to up *Dec 16
04:22:17.411 CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
Cable6/0/6, changed state to up *Dec 16 04:22:17.411 CST:
%LINK-3-UPDOWN: Interface Cable6/0/6, changed state to up *Dec 16
04:22:17.411 CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
Cable6/0/7, changed state to up *Dec 16 04:22:17.412 CST:
%LINK-3-UPDOWN: Interface Cable6/0/7, changed state to up *Dec 16
04:22:16.714 CST: %IOSXE-5-PLATFORM: CLC6: cdman: DS-JIB:ILK Interrupts
Enabled. (Init:20539, Check:9566 1stPKO:8942) *Dec 16 04:22:17.809 CST:
%CMRP-3-IDPROM_SENSOR: R0/0: cmand: One or more sensor fields from the
idprom failed to parse properly because Invalid argument.
Dec 16 04:22:57.161 CST: %SNMP-5-LINK_DOWN: LinkDown:Interface
Integrated-Cable6/0/0-downstream0 changed state to down Dec 16
04:22:57.161 CST: %SNMP-5-LINK_DOWN: LinkDown:Interface
Integrated-Cable6/0/0-downstream1 changed state to down Dec 16
04:22:57.161 CST: %SNMP-5-LINK_DOWN: LinkDown:Interface
Integrated-Cable6/0/0-downstream2 changed state to down Dec 16
04:22:57.162 CST: %SNMP-5-LINK_DOWN: LinkDown:Interface
Integrated-Cable6/0/0-downstream3 changed state to down Dec 16
04:22:57.162 CST: %SNMP-5-LINK_DOWN: LinkDown:Interface
Integrated-Cable6/0/0-downstream4 changed state to down Dec 16
04:22:57.162 CST: %SNMP-5-LINK_DOWN: LinkDown:Interface
Integrated-Cable6/0/0-downstream5 changed state to down Dec 16
04:22:57.162 CST: %SNMP-5-LINK_DOWN: LinkDown:Interface
Integrated-Cable6/0/0-downstream6 changed state to down Dec 16
04:22:57.162 CST: %SNMP-5-LINK_DOWN: LinkDown:Interface
Integrated-Cable6/0/0-downstream7 changed state to down Dec 16
04:22:57.163 CST: %SNMP-5-LINK_DOWN: LinkDown:Interface
Integrated-Cable6/0/0-downstream8 changed state to down Dec 16
04:22:57.163 CST: %SNMP-5-LINK_DOWN: LinkDown:Interface
Integrated-Cable6/0/0-downstream9 changed state to down Dec 16
04:22:57.163 CST: %SNMP-5-LINK_DOWN: LinkDown:Interface
Integrated-Cable6/0/0-downstream10 changed state to down Dec 16
04:22:57.163 CST: %SNMP-5-LINK_DOWN: LinkDown:Interface
Integrated-Cable6/0/1-downstream0 changed state to down Dec 16
04:22:57.164 CST: %SNMP-5-LINK_DOWN: LinkDown:Interface
Integrated-Cable6/0/1-downstream1 changed state to down Dec 16
04:22:57.164 CST: %SNMP-5-LINK_DOWN: LinkDown:Interface
Integrated-Cable6/0/1-downstream2 changed state to down Dec 16
04:22:57.164 CST: %SNMP-5-LINK_DOWN: LinkDown:Interface
Integrated-Cable6/0/1-downstream3 changed state to down Dec 16
04:22:57.164 CST: %SNMP-5-LINK_DOWN: LinkDown:Interface
Integrated-Cable6/0/1-downstream4 changed state to down Dec 16
04:22:57.164 CST: %SNMP-5-LINK_DOWN: LinkDown:Interface
Integrated-Cable6/0/1-downstream5 changed state to down Dec 16
04:22:57.183 CST: %SNMP-5-LINK_UP: LinkUp:Interface
Integrated-Cable6/0/0-downstream0 changed state to up Dec 16
04:22:57.184 CST: %SNMP-5-LINK_UP: LinkUp:Interface
Integrated-Cable6/0/0-downstream1 changed state to up Dec 16
04:22:57.189 CST: %SNMP-5-LINK_UP: LinkUp:Interface
Integrated-Cable6/0/0-downstream2 changed state to up Dec 16
Call Home
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
62
Page 75
Call Home
Additional References
04:22:57.211 CST: %SNMP-5-LINK_UP: LinkUp:Interface
Integrated-Cable6/0/0-downstream3 changed state to up Dec 16
04:22:57.212 CST: %SNMP-5-LINK_UP: LinkUp:Interface
Integrated-Cable6/0/0-downstream4 changed state to up Dec 16
04:22:57.212 CST: %SNMP-5-LINK_UP: LinkUp:Interface
Integrated-Cable6/0/0-downstream6 changed state to up Dec 16
04:22:57.213 CST: %SNMP-5-LINK_UP: LinkUp:Interface
Integrated-Cable6/0/0-downstream7 changed state to up Dec 16
04:22:57.213 CST: %SNMP-5-LINK_UP: LinkUp:Interface
Integrated-Cable6/0/0-downstream8 changed state to up Dec 16
04:22:57.213 CST: %SNMP-5-LINK_UP: LinkUp:Interface
Integrated-Cable6/0/0-downstream9 changed state to up Dec 16
04:22:57.213 CST: %SNMP-5-LINK_UP: LinkUp:Interface
Integrated-Cable6/0/0-downstream10 changed state to up Dec 16
04:22:57.214 CST: %SNMP-5-LINK_UP: LinkUp:Interface
Integrated-Cable6/0/1-downstream0 changed state to up Dec 16
04:22:57.424 CST: %SNMP-5-LINK_UP: LinkUp:Interface
Integrated-Cable6/0/1-downstream1 changed state to up Dec 16
04:22:57.426 CST: %SNMP-5-LINK_UP: LinkUp:Interface
Integrated-Cable6/0/1-downstream2 changed state to up Dec 16
04:22:57.435 CST: %SNMP-5-LINK_UP: LinkUp:Interface
Integrated-Cable6/0/1-downstream3 changed state to up Dec 16
04:22:57.437 CST: %SNMP-5-LINK_UP: LinkUp:Interface
Integrated-Cable6/0/1-downstream4 changed state to up Dec 16
04:22:57.449 CST: %SNMP-5-LINK_UP: LinkUp:Interface
Integrated-Cable6/0/1-downstream5 changed state to up Dec 16
04:22:59.219 CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface
Integrated-Cable6/0/1:0, changed state to up Dec 16 04:22:59.219 CST:
%LINK-3-UPDOWN: Interface Integrated-Cable6/0/1:0, changed state to up
Dec 16 04:22:59.427 CST: %LINEPROTO-5-UPDOWN: Line protocol on
Interface Integrated-Cable6/0/1:1, changed state to up Dec 16
04:22:59.427 CST: %LINK-3-UPDOWN: Interface Integrated-Cable6/0/1:1,
changed state to up Dec 16 04:22:59.449 CST: %LINEPROTO-5-UPDOWN: Line
protocol on Interface Wideband-Cable6/0/0:0, changed state to up Dec 16
04:22:59.450 CST: %LINK-3-UPDOWN: Interface Wideband-Cable6/0/0:0,
changed state to up Dec 16 04:22:59.450 CST: %LINK-3-UPDOWN: Interface
Wideband-Cable6/0/0:1, changed state to up Dec 16 04:22:59.450 CST:
%LINK-3-UPDOWN: Interface Wideband-Cable6/0/0:2, changed state to up
Dec 16 04:22:59.450 CST: %LINK-3-UPDOWN: Interface
Wideband-Cable6/0/0:3, changed state to up Dec 16 04:22:59.450 CST:
%LINK-3-UPDOWN: Interface Wideband-Cable6/0/0:4, changed state to up
Dec 16 04:22:59.450 CST: %LINK-3-UPDOWN: Interface
Wideband-Cable6/0/0:5, changed state to up Dec 16 04:22:59.451 CST:
%LINK-3-UPDOWN: Interface Wideband-Cable6/0/0:6, changed state to up
Dec 16 04:22:59.451 CST: %LINK-3-UPDOWN: Interface
Wideband-Cable6/0/0:7, changed state to up Dec 16 04:22:59.451 CST:
%LINEPROTO-5-UPDOWN: Line protocol on Interface Wideband-Cable6/0/1:0,
changed state to up Dec 16 04:22:59.451 CST: %LINK-3-UPDOWN: Interface
Wideband-Cable6/0/1:0, changed state to up Dec 16 04:22:59.451 CST:
%LINEPROTO-5-UPDOWN: Line protocol on Interface Wideband-Cable6/0/1:1,
changed state to up Dec 16 04:22:59.452 CST: %LINK-3-UPDOWN: Interface
Wideband-Cable6/0/1:1, changed state to up Dec 16 04:22:59.452 CST:
%LINK-3-UPDOWN: Interface Wideband-Cable6/0/2:0, changed state to up
Dec 16 04:23:27.352 CST: %IOSXE-5-PLATFORM: CLC6: cdman: DSPHY Gemini
module 1 was not present Dec 16 04:26:59.885 CST:
%ENVIRONMENTAL-1-ALERT: Temp: INLET, Location:
6, State: Critical, Reading: 53 Celsius sig-cbr#]]></aml-block:Data>
</aml-block:Attachment> </aml-block:Attachments> </aml-block:Block>
</soap-env:Body> </soap-env:Envelope>
Additional References
Related Documents
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
Document TitleRelated Topic
Cisco IOS Master Commands List, All ReleasesCisco IOS XE commands
for Cisco IOS XE Fuji 16.8.x
63
Page 76
Feature Information for Call Home
to all related product information.
web-based access to important information on select
Cisco devices and offers higher network availability,
and increased operational efficiency by providing
real-time alerts.
Call Home
Document TitleRelated Topic
Cisco Smart Call Home siteSmart Call Home site page on Cisco.com for access
Smart Call Home User GuideExplains how the Smart Call Home service offers
Call Home Quick Start Guide
MIBs
CISCO-CALLHOME-MIB
Technical Assistance
The Cisco Support website provides extensive online
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter,
and Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Smart Call Home Quick Start Configuration Guide
for Cisco cBR Series Routers
MIBs LinkMIB
To locate and download MIBs for selected platforms,
Cisco IOS releases, and feature sets, use Cisco MIB
Locator found at the following URL:
http://www.cisco.com/go/mibs
LinkDescription
http://www.cisco.com/support
Feature Information for Call Home
Use Cisco Feature Navigator to find information about the platform support and software image support.
Cisco Feature Navigator enables you to determine which software images support a specific software release,
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
64
Page 77
Call Home
Feature Information for Call Home
feature set, or platform. To access Cisco Feature Navigator, go to the http://www.cisco.com/go/cfn link. An
account on the Cisco.com page is not required.
Note
The following table lists only the software release that introduced support for a given feature in a given
software release train. Unless noted otherwise, subsequent releases of that software release train also
support that feature.
Table 11: Feature Information for Call Home
Feature InformationReleasesFeature Name
Cisco IOS XE Everest 16.6.1Smart Call Home
This feature was integrated into the
Cisco IOS XE Everest 16.6.1 on
the Cisco cBR Series Converged
Broadband Routers.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
65
Page 78
Feature Information for Call Home
Call Home
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
66
Page 79
CHAPTER 2
SNMP Support over VPNs—Context-Based Access Control
The SNMP Support over VPNs--Context-Based Access Control feature provides the infrastructure for
multiple Simple Network Management Protocol (SNMP) context support in Cisco software and VPN-aware
MIB infrastructure using the multiple SNMP context support infrastructure.
Finding Feature Information, page 67
•
Hardware Compatibility Matrix for the Cisco cBR Series Routers, page 68
•
• Restrictions for SNMP Support over VPNs—Context-Based Access Control, page 68
• Information About SNMP Support over VPNs—Context-Based Access Control, page 69
• How to Configure SNMP Support over VPNs—Context-Based Access Control, page 72
• Configuration Examples for SNMP Support over VPNs—Context-Based Access Control, page 76
Additional References, page 77
•
• Feature Information for SNMP Support over VPNs—Context-Based Access Control, page 79
Finding Feature Information
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.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
67
Page 80
SNMP Support over VPNs—Context-Based Access Control
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 12: 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
Cisco cBR-8 Upstream PHY
Modules:
• PID—CBR-D30-US-MOD
• PID—CBR-D31-US-MOD
Restrictions for SNMP Support over VPNs—Context-Based Access Control
If you delete an SNMP context using the no snmp-server context command, all SNMP instances in
•
that context are deleted.
Not all MIBs are VPN-aware.
•
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
68
Page 81
SNMP Support over VPNs—Context-Based Access Control
Information About SNMP Support over VPNs—Context-Based Access Control
Information About SNMP Support over VPNs—Context-Based
Access Control
SNMP Versions and Security
Cisco software supports the following versions of SNMP:
• SNMPv1—Simple Network Management Protocol: a full Internet standard, defined in RFC 1157. (RFC
1157 replaces the earlier versions that were published as RFC 1067 and RFC 1098.) Security is based
on community strings.
• SNMPv2c—The community string-based Administrative Framework for SNMPv2. SNMPv2c (the "c"
is for "community") is an experimental Internet protocol defined in RFC 1901, RFC 1905, and RFC
1906. SNMPv2c is an update of the protocol operations and data types of SNMPv2p (SNMPv2 Classic)
and uses the community-based security model of SNMPv1.
For more information about SNMP Versions, see the “ Configuring SNMP Support ” module in the Cisco
Network Management Configuration Guide.
SNMPv1 or SNMPv2 Security
Cisco IOS software supports the following versions of SNMP:
• SNMPv1—Simple Network Management Protocol: a full Internet standard, defined in RFC 1157. (RFC
1157 replaces the earlier versions that were published as RFC 1067 and RFC 1098.) Security is based
on community strings.
• SNMPv2c—The community string-based Administrative Framework for SNMPv2. SNMPv2c (the "c"
is for "community") is an experimental Internet protocol defined in RFC 1901, RFC 1905, and RFC
1906. SNMPv2c is an update of the protocol operations and data types of SNMPv2p (SNMPv2 Classic)
and uses the community-based security model of SNMPv1.
SNMPv1 and SNMPv2 are not as secure as SNMPv3. SNMP version 1 and 2 use plain text communities and
do not perform the authentication or security checks that SNMP version 3 performs. To configure the SNMP
Support over VPNs—Context-Based Access Control feature when using SNMP version 1 or SNMP version
2, you need to associate a community name with a VPN. This association causes SNMP to process requests
coming in for a particular community string only if it comes in from the configured VRF. If the community
string contained in the incoming packet does not have an associated VRF, it is processed only if it came in
through a non-VRF interface. This process prevents users outside the VPN from snooping a clear text
community string to query the VPN’s data. These methods of source address validation are not as secure as
using SNMPv3.
SNMPv3 Security
If you are using SNMPv3, the security name should always be associated with authentication or privileged
passwords. Source address validation is not performed on SNMPv3 users. To ensure that a VPN’s user has
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
69
Page 82
SNMP Notification Support over VPNs
access only to context associated to the VPN and cannot see the MIB data of other VPNs, you must configure
a minimum security level of AuthNoPriv.
On a provider edge (PE) router, a community can be associated with a VRF to provide source address validation.
However, on a customer edge (CE) router, if source address validation is to be provided, you must associate
a source address with the community list by using an access control list.
If you are using SNMPv3, the security name or security password of the users of a VPN should be unknown
to users of other VPNs. Cisco recommends not to use SNMPv3 nonauthorized users if you need security of
management information.
SNMP Notification Support over VPNs
The SNMP Notification Support over VPNs feature allows the sending and receiving of SNMP notifications
(traps and informs) using VPN routing and forwarding (VRF) instance tables. In particular, this feature adds
support to Cisco software for the sending and receiving of SNMP notifications (traps and informs) specific
to individual VPNs.
SNMP is an application-layer protocol that provides a message format for communication between SNMP
managers and agents.
A VPN is a network that provides high-connectivity transfers on a shared system with the same usage guidelines
as a private network. A VPN can be built on the Internet over IP, Frame Relay, or ATM networks.
A VRF stores per-VPN routing data. It defines the VPN membership of a customer site attached to the network
access server (NAS). A VRF consists of an IP routing table, a derived Cisco Express Forwarding (formerly
known as CEF) table, and guidelines and routing protocol parameters that control the information that is
included in the routing table.
SNMP Support over VPNs—Context-Based Access Control
The SNMP Support for VPNs—Context-Based Access Control feature provides configuration commands
that allow users to associate SNMP agents and managers with specific VRFs. The associated VRF is used for
the sending of SNMP notifications (traps and informs) and responses between agents and managers. If a VRF
is not specified, the default routing table for the VPN is used.
VPN-Aware SNMP
The SNMP Support for VPNs—Context-Based Access Control feature extends the capabilities of the SNMP
Notification Support for VPNs feature and enables SNMP to differentiate between incoming packets from
different VPNs.
When the SNMP Support for VPNs—Context-Based Access Control feature is configured, SNMP accepts
requests on any configured VRF and returns responses to the same VRF. A trap host also can be associated
with a specific VRF. The configured VRF is then used for sending out traps; otherwise, the default routing
table is used. You also can associate a remote user with a specific VRF. You also can configure the VRFs
from which SNMP should accept requests. Any requests coming from VRFs that are not specified are dropped.
IP access lists can be configured and associated with SNMP community strings. This feature enables you to
configure an association between VRF instances with SNMP community strings. When a VRF instance is
associated with an SNMP community string, SNMP processes the requests coming in for a particular community
string only if the requests are received from the configured VRF. If the community string contained in the
incoming packet does not have a VRF associated with it, the community string will be processed only if it
came in through a non-VRF interface.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
70
Page 83
SNMP Support over VPNs—Context-Based Access Control
You also can enable or disable authentication traps for SNMP packets dropped due to VRF mismatches. By
default if SNMP authentication traps are enabled, VRF authentication traps are also enabled.
VPN Route Distinguishers
A route distinguisher (RD) creates routing and forwarding tables and specifies the default route distinguisher
for a VPN. The RD is added to the beginning of the customer’s IPv4 prefixes to change them into globally
unique VPN-IPv4 prefixes.
The RD is either an autonomous system number (ASN)-relative RD, in which case it comprises an autonomous
system number and an arbitrary number, or it is an IP-address-relative RD, in which case it comprises an IP
address and an arbitrary number.
You can enter an RD in either of these formats:
16-bit ASN: your 16-bit number: For example, 101:3.
•
32-bit IP address: your 32-bit number: For example, 192.168.122.15:1.
•
SNMP Contexts
SNMP Contexts
SNMP contexts provide VPN users with a secure way of accessing MIB data. When a VPN is associated with
a context, that VPN’s specific MIB data exists in that context. Associating a VPN with a context enables
service providers to manage networks with multiple VPNs. Creating and associating a context with a VPN
enables a provider to prevent the users of one VPN from accessing information about other VPN userss on
the same networking device.
VPN-aware SNMP requires an agreement between SNMP manager and agent entities operating in a VPN
environment on a mapping between the SNMP security name and the VPN ID. This mapping is created by
using multiple contexts for the SNMP data of different VPNs through the configuration of the
SNMP-VACM-MIB. The SNMP-VACM-MIB is configured with views so that a user on a VPN with a security
name is allowed access to the restricted object space associated with a user’s access type in the context
associated with the user of that VPN.
SNMP request messages undergo three phases of security and access control before a response message is
sent back with the object values in the context of a VPN:
In the first phase, the username is authenticated. This phase ensures that the user is authenticated and
•
authorized for SNMP access.
In the second phase, the user is authorized for the SNMP access requested to the group objects under
•
consideration of the configured SNMP context. This phase is called the access control phase.
In the third phase, access is made to a particular instance of a table entry. With this third phase, complete
•
retrieval can be based on the SNMP context name.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
71
Page 84
SNMP Support over VPNs—Context-Based Access Control
How to Configure SNMP Support over VPNs—Context-Based Access Control
How to Configure SNMP Support over VPNs—Context-Based
Access Control
Configuring an SNMP Context and Associating the SNMP Context with a VPN
Perform this task to configure an SNMP context and to associate the SNMP context with a VPN.
Note
DETAILED STEPS
Step 1
Step 2
Only the following MIBs are context-aware. All the tables in these MIBs can be polled:
•
Only two SNMP variables in the IP-FORWARD-MIB can be polled: 1.3.6.1.2.1.4.24.3
•
(ipCidrRouteNumber - Scalar) and 1.3.6.1.2.1.4.24.4.1 (ipCidrRouteEntry - Table).
Example:
Device> enable
CISCO-IPSEC-FLOW-MONITOR-MIB
◦
CISCO-IPSEC-MIB
◦
CISCO-PING-MIB
◦
IP-FORWARD-MIB
◦
MPLS-LDP-MIB
◦
PurposeCommand or Action
Enables privileged EXEC mode.enable
Enter your password if prompted.
•
Enters global configuration mode.configure terminal
Step 3
72
Example:
Device# configure terminal
snmp-server context context-name
Example:
Device(config)# snmp-server context context1
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
Creates and names an SNMP context.
Page 85
SNMP Support over VPNs—Context-Based Access Control
Configuring SNMP Support and Associating an SNMP Context
PurposeCommand or Action
Step 4
Step 5
Step 6
Step 7
Step 8
vrf definition vrf-name
Example:
Device(config)# vrf definition vrf1
rd route-distinguisher
Example:
Device(config-vrf)# rd 100:120
context context-name
Example:
Device(config-vrf)# context context1
route-target {import | export | both}
route-target-ext-community
Example:
Device(config-vrf)# route-target export
100:1000
Configures a VRF routing table and enters VRF
configuration mode.
Creates a VPN route distinguisher.
Associates an SNMP context with a particular VRF.
Note
Depending on your release, the context command
is replaced by the snmp context command. See
the Cisco IOS Network Management Command
Reference for more information.
(Optional) Creates a route-target extended community for
a VRF.
Exits interface mode and enters global configuration mode.end
Example:
Device(config-vrf)# end
Step 9
Example:
Device(config)# end
Exits global configuration mode.end
Configuring SNMP Support and Associating an SNMP Context
Perform this task to configure SNMP support and associate it with an SNMP context.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
73
Page 86
Configuring SNMP Support and Associating an SNMP Context
SUMMARY STEPS
enable
1.
configure terminal
2.
snmp-server user username group-name [remote host [udp-port port] [vrf vrf-name]] {v1 | v2c | v3
3.
[encrypted] [auth {md5 | sha} auth-password]} [access [ipv6 nacl] [priv {des | 3des | aes {128 | 192 |
256}} privpassword] {acl-number | acl-name}]
snmp-server group group-name {v1 | v2c | v3 {auth | noauth | priv}} [context context-name] [read
4.
read-view] [write write-view] [notify notify-view] [access [ipv6 named-access-list] [acl-number| acl-name]]
snmp-server view view-name oid-tree {included | excluded}
5.
snmp-server enable traps [notification-type] [vrrp]
6.
snmp-server community string [view view-name] [ro | rw] [ipv6 nacl] [access-list-number |
7.
extended-access-list-number | access-list-name]
snmp-server host {hostname | ip-address} [vrf vrf-name] [traps | informs] [version {1 | 2c | 3 [auth |
8.
noauth | priv]}] community-string [udp-port port] [notification-type]
snmp mib community-map community-name [context context-name] [engineid engine-id]
9.
[security-name security-name][target-list upn-list-name]
snmp mib target list vpn-list-name {vrf vrf-name | host ip-address}
10.
no snmp-server trap authentication vrf
11.
SNMP Support over VPNs—Context-Based Access Control
DETAILED STEPS
Step 1
Example:
Device> enable
Step 2
Example:
Device# configure terminal
Step 3
snmp-server user username group-name [remote host
[udp-port port] [vrf vrf-name]] {v1 | v2c | v3 [encrypted] [auth
{md5 | sha} auth-password]} [access [ipv6 nacl] [priv {des | 3des
| aes {128 | 192 | 256}} privpassword] {acl-number | acl-name}]
Example:
Device(config)# snmp-server user customer1 group1 v1
Step 4
snmp-server group group-name {v1 | v2c | v3 {auth | noauth |
priv}} [context context-name] [read read-view] [write write-view]
[notify notify-view] [access [ipv6 named-access-list] [acl-number|
acl-name]]
PurposeCommand or Action
Enables privileged EXEC mode.enable
Enter your password if prompted.
•
Enters global configuration mode.configure terminal
Configures a new user to an SNMP group.
Configures a new SNMP group or a table that maps
SNMP users to SNMP views.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
74
Page 87
SNMP Support over VPNs—Context-Based Access Control
Example:
Device(config)# snmp-server group group1 v1 context
context1 read view1 write view1 notify view1
Configuring SNMP Support and Associating an SNMP Context
PurposeCommand or Action
Use the context context-name keyword
•
argument pair to associate the specified
SNMP group with a configured SNMP
context.
Step 5
Step 6
Step 7
Step 8
snmp-server view view-name oid-tree {included | excluded}
Example:
Device(config)# snmp-server view view1 ipForward included
snmp-server enable traps [notification-type] [vrrp]
Example:
Device(config)# snmp-server enable traps
snmp-server community string [view view-name] [ro | rw] [ipv6
nacl] [access-list-number | extended-access-list-number |
access-list-name]
Example:
Device(config)# snmp-server community public view view1
rw
snmp-server host {hostname | ip-address} [vrf vrf-name] [traps
| informs] [version {1 | 2c | 3 [auth | noauth | priv]}]
community-string [udp-port port] [notification-type]
Example:
Creates or updates a view entry.
Enables all SNMP notifications (traps or informs)
available on your system.
Sets up the community access string to permit
access to the SNMP.
Specifies the recipient of an SNMP notification
operation.
Step 9
Step 10
Device(config)# snmp-server host 10.0.0.1 vrf vrf1 public
udp-port 7002
snmp mib community-map community-name [context
context-name] [engineid engine-id] [security-name
security-name][target-list upn-list-name]
Example:
Device(config)# snmp mib community-map community1 context
context1 target-list commAVpn
snmp mib target list vpn-list-name {vrf vrf-name | host
ip-address}
Example:
Device(config)# snmp mib target list commAVpn vrf vrf1
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
Associates an SNMP community with an SNMP
context, Engine ID, or security name.
Creates a list of target VRFs and hosts to associate
with an SNMP community.
for Cisco IOS XE Fuji 16.8.x
75
Page 88
Configuration Examples for SNMP Support over VPNs—Context-Based Access Control
SNMP Support over VPNs—Context-Based Access Control
PurposeCommand or Action
Step 11
no snmp-server trap authentication vrf
(Optional) Disables all SNMP authentication
notifications (traps and informs) generated for
Example:
Device(config)# no snmp-server trap authentication vrf
packets received on VRF interfaces.
Use this command to disable authentication
•
traps only for those packets on VRF interfaces
with incorrect community associations.
Configuration Examples for SNMP Support over
VPNs—Context-Based Access Control
Example: Configuring Context-Based Access Control
The following configuration example shows how to configure the SNMP Support over VPNs—Context-Based
Access Control feature for SNMPv1 or SNMPv2:
Note
Depending on your releases, the context command is replaced by the snmp context command. See the
Cisco IOS Network Management Command Reference for more information.
snmp-server context A
snmp-server context B
ip vrf Customer_A
rd 100:110
context A
route-target export 100:1000
route-target import 100:1000
!
ip vrf Customer_B
rd 100:120
context B
route-target export 100:2000
route-target import 100:2000
!
interface TenGigabitEthernet4/1/0
description Belongs to VPN A
ip vrf forwarding CustomerA
ip address 192.168.2.1 255.255.255.0
interface TenGigabitEthernet4/1/1
description Belongs to VPN B
ip vrf forwarding CustomerB
ip address 192.168.2.2 255.255.255.0
snmp-server user commA grp1A v1
snmp-server user commA grp2A v2c
snmp-server user commB grp1B v1
snmp-server user commB grp2B v2c
snmp-server group grp1A v1 context A read viewA write viewA notify viewA
snmp-server group grp1B v1 context B read viewB write viewB notify viewB
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
76
Page 89
SNMP Support over VPNs—Context-Based Access Control
snmp-server view viewA ipForward included
snmp-server view viewA ciscoPingMIB included
snmp-server view viewB ipForward included
snmp-server view viewB ciscoPingMIB included
snmp-server enable traps
snmp-server host 192.168.2.3 vrf CustomerA commA udp-port 7002
snmp-server host 192.168.2.4 vrf CustomerB commB udp-port 7002
snmp mib community-map commA context A target-list commAvpn
! Configures source address validation
snmp mib community-map commB context B target-list commBvpn
! Configures source address validation
snmp mib target list commAvpn vrf CustomerA
! Configures a list of VRFs or from which community commA is valid
snmp mib target list commBvpn vrf CustomerB
! Configures a list of VRFs or from which community commB is valid
Additional References
Related Documents
Additional References
Document TitleRelated Topic
Cisco Network Management commands
SNMP configuration
Standards
MIBs
CISCO-PING-MIB
•
IP-FORWARD-MIB
•
SNMP-VACM-MIB, The View-based Access
•
Control Model (ACM) MIB for SNMP
Cisco IOS Master Command List, All ReleasesCisco software commands
Cisco IOS Network Management Command Reference
“ Configuring SNMP Support ” chapter in the Cisco
Network Management Configuration Guide
SNMP Notification Support for VPNsSNMP Support for VPNs
TitleStandard
--None
MIBs LinkMIB
To locate and download MIBs for selected platforms,
Cisco software releases, and feature sets, use Cisco
MIB Locator found at the following URL:
http://www.cisco.com/go/mibs
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
77
Page 90
Additional References
SNMP Support over VPNs—Context-Based Access Control
RFCs
TitleRFC
RFC 1441
RFC 1442
RFC 1443
RFC 1444
RFC 1445
RFC 1446
RFC 1447
RFC 1448
Introduction to version 2 of the Internet-standard
Network Management Framework
Structure of Management Information for version 2
of the Simple Network Management Protocol
(SNMPv2)
Textual Conventions for version 2 of the Simple
Network Management Protocol (SNMPv2)
Conformance Statements for version 2 of the Simple
Network Management Protocol (SNMPv2)
Administrative Model for version 2 of the Simple
Network Management Protocol (SNMPv2)
Security Protocols for version 2 of the Simple Network
Management Protocol (SNMPv2)
Party MIB for version 2 of the Simple Network
Management Protocol (SNMPv2)
Protocol Operations for version 2 of the Simple
Network Management Protocol (SNMPv2)
RFC 1449
RFC 1450
RFC 2571
RFC 2576
Transport Mappings for version 2 of the Simple
Network Management Protocol (SNMPv2)
Management Information Base for version 2 of the
Simple Network Management Protocol (SNMPv2)
An Architecture for Describing SNMP Management
Frameworks
Coexistence between Version 1, Version 2, and
Version 3 of the Internet-standard Network
Management Framework
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
78
Page 91
SNMP Support over VPNs—Context-Based Access Control
Technical Assistance
Feature Information for SNMP Support over VPNs—Context-Based Access Control
LinkDescription
The Cisco Support and Documentation website
provides online resources to download documentation,
software, and tools. Use these resources to install and
configure the software and to troubleshoot and resolve
technical issues with Cisco products and technologies.
Access to most tools on the Cisco Support and
Documentation website requires a Cisco.com user ID
and password.
http://www.cisco.com/cisco/web/support/index.html
Feature Information for SNMP Support over
VPNs—Context-Based Access Control
Use Cisco Feature Navigator to find information about the platform support and software image support.
Cisco Feature Navigator enables you to determine which software images support a specific software release,
feature set, or platform. To access Cisco Feature Navigator, go to the http://www.cisco.com/go/cfn link. An
account on the Cisco.com page is not required.
Note
The following table lists only the software release that introduced support for a given feature in a given
software release train. Unless noted otherwise, subsequent releases of that software release train also
support that feature.
Table 13: Feature Information for SNMP Support over VPNs—Context-Based Access Control
Feature InformationReleasesFeature Name
Cisco IOS XE Everest 16.6.1SNMP Support over
VPNs—Context-Based Access
Control
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
This feature was integrated into
Cisco IOS XE Everest 16.6.1 on
the Cisco cBR Series Converged
Broadband Routers.
for Cisco IOS XE Fuji 16.8.x
79
Page 92
Feature Information for SNMP Support over VPNs—Context-Based Access Control
SNMP Support over VPNs—Context-Based Access Control
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
80
Page 93
CHAPTER 3
SNMP Engine Enhancement
The SNMP Cache Engine Enhancement feature caches the SNMP information on the Supervisor.
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 81
•
Restrictions for SNMP Cache Engine Enhancement, page 82
•
Information About SNMP Cache Engine Enhancement, page 82
•
How to Configure SNMP Cache Engine Enhancement, page 83
•
Verifying the SNMP Cache Engine Status, page 84
•
Additional References, page 85
•
Feature Information for SNMP Cache Engine Enhancement, page 85
•
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.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
81
Page 94
Restrictions for SNMP Cache Engine Enhancement
Table 14: Hardware Compatibility Matrix for the Cisco cBR Series Routers
SNMP Engine Enhancement
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
Cisco cBR-8 Upstream PHY
Modules:
• PID—CBR-D30-US-MOD
• PID—CBR-D31-US-MOD
Restrictions for SNMP Cache Engine Enhancement
The time interval for which the cached information is available on the Supervisor is 5 seconds.
Information About SNMP Cache Engine Enhancement
The SNMP Cache Engine Enhancement feature caches the information on the Supervisor for the MIB tables,
which need to retrieve the data from the interface cards. When a MIB table item is queried from the interface
card, the next N items are retrieved and cached on the Supervisor.
For example, if SNMP client queries the docsIf3CmtsCmRegStatusMacAddr.1, the interface card bundles
docsIf3CmtsCmRegStatusMacAddr.1, docsIf3CmtsCmRegStatusMacAddr.2,
docsIf3CmtsCmRegStatusMacAddr.3, to docsIf3CmtsCmRegStatusMacAddr.N together in one IPC response,
and sends it to the Supervisor. The Supervisor caches all the items locally. When the SNMP client queries
the docsIf3CmtsCmRegStatusMacAddr.2 later, the information is available in the Supervisor cache directly
instead of sending another IPC message to interface card. The number N depends on the single MIB item size
and maximum IPC message buffer size.
The MIB table information for following MIBs are retrieved and cached on the Supervisor:
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
82
Page 95
SNMP Engine Enhancement
DOCS-IF-MIB
•
DOCS-IFEXT2-MIB
•
DOCS-QOS-MIB
•
DOCS-IF3-MIB
•
DOCS-IF31-MIB
•
DOCS-QOS3-MIB
•
DOCS-IETF-QOS-MIB
•
DOCS-BPI-PLUS-MIB
•
DOCS-LOADBALANCING-MIB
•
DOCS-LOADBAL3-MIB
•
DOCS-DSG-IF-MIB
•
CISCO-DOCS-EXT-MIB
•
How to Configure SNMP Cache Engine Enhancement
CISCO-CABLE-WIDEBAND-MIB
•
CISCO-CABLE-SPECTRUM-MIB
•
This feature is enabled by default on the Cisco cBR routers. The time interval for which the SNMP cache
information is stored on the Supervisor is known as age and set to 5 seconds.
How to Configure SNMP Cache Engine Enhancement
Before You Begin
You must configure the service internal command in global configuration mode to enable or disable SNMP
Cache Engine Enhancement.
DETAILED STEPS
PurposeCommand or Action
Step 1
Example:
Router> enable
Step 2
Enables privileged EXEC mode.enable
Enter your password, if prompted.
•
Enters global configuration mode.configure terminal
Step 3
Example:
Router# configure terminal
Example:
Router(config)# cable snmp cache active
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
Sets the SNMP cache status to active.cable snmp cache active
Note
Use the no form of the command to disable the SNMP
cache status.
for Cisco IOS XE Fuji 16.8.x
83
Page 96
Verifying the SNMP Cache Engine Status
SNMP Engine Enhancement
PurposeCommand or Action
Step 4
exit
Exits the global configuration mode and enters the privileged
EXEC mode.
Example:
Router(config)# exit
Verifying the SNMP Cache Engine Status
Use the show cable snmp cache-status command to display the current SNMP cache engine status.
Important
You must configure the service internal command in global configuration mode to verify the SNMP
cache engine status.
Following is a sample output of the command.
Router# show cable snmp cache-status
Cache engine is ON, age: 5 seconds
Use the test cable snmp counter-show command to display the cache counters information.
Router# test cable snmp counter-show
========== cache counters ==========
ubrcce_snmp_cache_hit_counter:0.
ubrcce_snmp_cache_get_from_lc_counter:1.
ubrcce_snmp_cache_miss_counter:0.
ubrcce_snmp_cache_ipc_fail_counter:0.
ubrcce_snmp_cache_buffer_full_counter:0.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
84
hit and mis are the historic information for the SNMP cache after the system bootup. hit indicates the number
of times the SNMP queries are hit in the cache and mis indicates the number of times the SNMP queries are
missed in the SNMP cache.
Page 97
SNMP Engine Enhancement
Additional References
Technical Assistance
Additional References
LinkDescription
The Cisco Support website provides extensive online
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter,
and Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
http://www.cisco.com/support
Feature Information for SNMP Cache Engine Enhancement
Use Cisco Feature Navigator to find information about the platform support and software image support.
Cisco Feature Navigator enables you to determine which software images support a specific software release,
feature set, or platform. To access Cisco Feature Navigator, go to the http://www.cisco.com/go/cfn link. An
account on the Cisco.com page is not required.
Note
The following table lists only the software release that introduced support for a given feature in a given
software release train. Unless noted otherwise, subsequent releases of that software release train also
support that feature.
Table 15: Feature Information for SNMP Cache Engine Enhancement
Feature InformationReleasesFeature Name
Cisco IOS XE Everest 16.6.1SNMP Cache Engine Enhancement
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
This feature was integrated into
Cisco IOS XE Everest 16.6.1 on
the Cisco cBR Series Converged
Broadband Routers.
for Cisco IOS XE Fuji 16.8.x
85
Page 98
Feature Information for SNMP Cache Engine Enhancement
SNMP Engine Enhancement
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
86
Page 99
CHAPTER 4
Onboard Failure Logging
Onboard Failure Logging (OBFL) captures and stores hardware failure and environmental information into
nonvolatile memory. OBFL permits improved accuracy in hardware troubleshooting and root cause isolation
analysis. Stored OBFL data can be retrieved in the event of a router crash or failure.
Finding Feature Information, page 87
•
Hardware Compatibility Matrix for the Cisco cBR Series Routers, page 88
•
Understanding OBFL, page 88
•
Configuring OBFL, page 89
•
Displaying OBFL Logging Information, page 89
•
Clearing OBFL Logging, page 89
•
Configuration and Verification Examples, page 90
•
Feature Information for Onboard Failure Logging, page 95
•
Finding Feature Information
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.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide
for Cisco IOS XE Fuji 16.8.x
87
Page 100
Onboard Failure Logging
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 16: 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
Understanding OBFL
OBFL provides a mechanism to store hardware, software, and environment related critical data in a non-volatile
memory, such as flash EPROM or EEPROM on routers. The logging information is used by the TAC team
to troubleshoot and fix hardware issues.
OBFL collects data like temperatures and voltages. It stores the data in a dedicated area of the flash memory
of the router. This data is retrieved by TAC personnel to troubleshoot routers. It can also be analyzed by
back-end software to detect failure patterns, and possibly to recommend specific quality improvements.
Cisco cBR Series Converged Broadband Routers Troubleshooting and Network Management Configuration
Guide for Cisco IOS XE Fuji 16.8.x
88
Cisco cBR-8 Upstream PHY
Modules:
• PID—CBR-D30-US-MOD
• PID—CBR-D31-US-MOD
Loading...