To configure the message destination parameters in a profile for Call Home, use the destination (call home) command in call home profile configuration mode. To remove the destination parameters, use the no form of this command.
destination {address {email address | http url} | message-size-limit size | preferred-msg-format {long-text | short-text | xml} | transport-method {email | http}}
no destination {address {email address | http url} | message-size-limit size | preferred-msg-format {long-text | short-text | xml} | transport-method {email | http}}
Syntax Description
|
address
{email address | http url
|
Configures the address type and location to which Call Home messages are sent, where:
-
email
address
--Email address, up to 200 characters.
-
http
url
--URL, up to 200 characters.
Starting from Cisco IOS XE 17.1, only a single URL is permitted for a profile. If you add a new URL, the old URL is replaced.
|
|
message-size-limit
size
|
Displays maximum Call Home message size for this profile, in bytes. The range is from 50 to 3145728. The default is 3145728.
|
|
preferred-msg-format
{long-text | short-text | xml }
|
Specifies the message format for this profile, where:
-
long-text
--Format for use in standard e-mail providing a complete set of information in message.
-
short-text
--Format for use with text pagers providing a smaller set of information in the message, including host name, timestamp, error
message trigger, and severity level.
-
xml
--Format that includes a complete set of information in the message, including XML tags. This is the default.
|
|
transport-method
|
Specifies the transport method for this profile, where:
|
Command Default
No destination address type is configured. If you do not configure the destination (call home) command, the following defaults are configured for the profile:
-
message-size-limit
--3,145,728 bytes
-
preferred-msg-format
--XML
-
transport-method
--E-mail
Command Modes
Call home profile configuration (cfg-call-home-profile)
Command History
|
Release
|
Modification
|
|
12.2(33)SXH
|
This command was introduced.
|
|
12.2(33)SRC
|
This command was integrated into Cisco IOS Release 12.2(33)SRC.
|
|
12.4(24)T
|
This command was integrated into Cisco IOS Release 12.4(24)T.
|
|
12.2(52)SG
|
This command was integrated into Cisco IOS Release 12.2(52)SG.
|
|
Cisco IOS XE Release 2.6
|
This command was integrated into Cisco IOS XE Release 2.6.
|
Usage Guidelines
You can repeat the destination (call home) command in call home profile configuration mode to configure different message parameters for a profile. There is no default
for the destination address form of the command, and an address must be configured for every profile.
For a user-defined profile, you can enable both e-mail and HTTP as accepted transport methods, by entering the destination transport-method email command and also the destination transport-method http command for the profile.
For the CiscoTAC-1 predefined profile, only one transport method can be enabled at a time. If you enable a second transport
method, the existing method is automatically disabled. By default, e-mail can be used to send information to the Cisco Smart
Call Home backend server, but if you want to use a secure HTTPS transport, you need to configure HTTP.
Examples
The following examples shows configuration of both transport methods for a user profile:
Router(config)# call-home
Router(cfg-call-home)# profile example
Router(cfg-call-home-profile)# destination transport-method email
Router(cfg-call-home-profile)# destination transport-method http
The following example shows a profile configuration for e-mail messaging using long-text format:
Router(config)# call-home
Router(cfg-call-home)# profile example
Router(cfg-call-home-profile)# destination address email username@example.com
Router(cfg-call-home-profile)# destination preferred-msg-format long-text
The following example shows part of a Syslog alert notification (when subscribed to receive syslog alerts) using long-text
format on a Cisco ASR 1006 router:
TimeStamp : 2009-12-03 12:26 GMT+05:00
Message Name : syslog
Message Type : Call Home
Message Group : reactive
Severity Level : 2
Source ID : ASR1000
Device ID : ASR1006@C@FOX105101DH
Customer ID : username@example.com
Contract ID : 123456789
Site ID : example.com
Server ID : ASR1006@C@FOX105101DH
Event Description : *Dec 3 12:26:02.319 IST: %CLEAR-5-COUNTERS: Clear counter on all interfaces by console
System Name : mcp-6ru-3
Contact Email : username@example.com
Contact Phone : +12223334444
Street Address : 1234 Any Street Any City Any State 12345
Affected Chassis : ASR1006
Affected Chassis Serial Number : FOX105101DH
Affected Chassis Part No : 68-2584-05
Affected Chassis Hardware Version : 2.1
Command Output Name : show logging
Attachment Type : command output
MIME Type : text/plain
Command Output Text :
Syslog logging: enabled (1 messages dropped, 29 messages rate-limited, 0 flushes, 0 overruns, xml disabled, filtering disabled)
No Active Message Discriminator.
No Inactive Message Discriminator.
Console logging: disabled
Monitor logging: level debugging, 0 messages logged, xml disabled,
filtering disabled
Buffer logging: level debugging, 112 messages logged, xml disabled,
filtering disabled
Exception Logging: size (4096 bytes)
Count and timestamp logging messages: disabled
Persistent logging: disabled
No active filter modules.
Trap logging: level informational, 104 message lines logged
Log Buffer (1000000 bytes):
*Dec 3 07:16:55.020: ASR1000-RP HA: RF status CID 1340, seq 93, status RF_STATUS_REDUNDANCY_MODE_CHANGE, op 0, state DISABLED, peer DISABLED
*Dec 3 07:17:00.379: %ASR1000_MGMTVRF-6-CREATE_SUCCESS_INFO: Management vrf Mgmt-intf created with ID 4085, ipv4 table-id 0xFF5, ipv6 table-id 0x1E000001
*Dec 3 07:17:00.398: %NETCLK-5-NETCLK_MODE_CHANGE: Network clock source not available. The network clock has changed to freerun
*Dec 3 07:17:00.544: %LINEPROTO-5-UPDOWN: Line protocol on Interface LI-Null0, changed state to up
*Dec 3 07:17:00.545: %LINK-3-UPDOWN: Interface EOBC0, changed state to up
*Dec 3 07:17:00.545: %LINK-3-UPDOWN: Interface Lsmpi0, changed state to up
*Dec 3 07:17:00.546: %LINK-3-UPDOWN: Interface LIIN0, changed state to up
*Dec 3 07:17:00.546: %LINK-3-UPDOWN: Interface GigabitEthernet0, changed state to down
*Dec 3 07:17:01.557: %LINEPROTO-5-UPDOWN: Line protocol on Interface EOBC0, changed state to up
*Dec 3 07:17:01.557: %LINEPROTO-5-UPDOWN: Line protocol on Interface Lsmpi0, changed state to up
*Dec 3 07:17:01.558: %LINEPROTO-5-UPDOWN: Line protocol on Interface LIIN0, changed state to up
*Dec 3 07:17:01.558: %LINEPROTO-5-UPDOWN: Line protocol on Interface GigabitEthernet0, changed state to down
*Dec 3 07:17:01.818: %DYNCMD-7-CMDSET_LOADED: The Dynamic Command set has been loaded from the Shell Manager
*Dec 3 07:16:30.926: %CMRP-5-PRERELEASE_HARDWARE: R0/0: cmand: 2 is pre-release hardware
*Dec 3 07:16:24.147: %HW_IDPROM_ENVMON-3-HW_IDPROM_CHECKSUM_INVALID: F1: cman_fp: The idprom contains an invalid checksum in a sensor entry. Expected: 63, calculated: fe
*Dec 3 07:16:24.176: %CMFP-3-IDPROM_SENSOR: F1: cman_fp: One or more sensor fields from the idprom failed to parse properly because Success.
*Dec 3 07:16:27.669: %CPPHA-7-START: F1: cpp_ha: CPP 0 preparing image /tmp/sw/fp/1/0/fp/mount/usr/cpp/bin/cpp-mcplo-ucode
*Dec 3 07:16:27.839: %CPPHA-7-START: F1: cpp_ha: CPP 0 startup init image /tmp/sw/fp/1/0/fp/mount/usr/cpp/bin/cpp-mcplo-ucode
*Dec 3 07:16:28.659: %CPPHA-7-START: F0: cpp_ha: CPP 0 preparing image /tmp/sw/fp/0/0/fp/mount/usr/cpp/bin/cpp-mcplo-ucode
*Dec 3 07:16:28.799: %CPPHA-7-START: F0: cpp_ha: CPP 0 startup init image /tmp/sw/fp/0/0/fp/mount/usr/cpp/bin/cpp-mcplo-ucode
*Dec 3 07:16:32.557: %CPPHA-7-START: F1: cpp_ha: CPP 0 running init image /tmp/sw/fp/1/0/fp/mount/usr/cpp/bin/cpp-mcplo-ucode
*Dec 3 07:16:32.812: %CPPHA-7-READY: F1: cpp_ha: CPP 0 loading and initialization complete
*Dec 3 07:16:33.532: %CPPHA-7-START: F0: cpp_ha: CPP 0 running init image /tmp/sw/fp/0/0/fp/mount/usr/cpp/bin/cpp-mcplo-ucode
*Dec 3 07:16:33.786: %CPPHA-7-READY: F0: cpp_ha: CPP 0 loading and initialization complete
.
.
.
Examples
The following example shows part of a Syslog alert notification using XML format on a Cisco ASR 1006 router when the destination preferred-msg-format xml command for a profile is configured:
<?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>M0:FOX105101DH:CEC1E73E</aml-session:MessageId>
</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>2009-12-03 12:29:02 GMT+05:00</aml-block:CreationDate>
<aml-block:Builder>
<aml-block:Name>ASR1000</aml-block:Name>
<aml-block:Version>2.0</aml-block:Version>
</aml-block:Builder>
<aml-block:BlockGroup>
<aml-block:GroupId>G1:FOX105101DH:CEC1E73E</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>2</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>2009-12-03 12:29:01 GMT+05:00</ch:EventTime>
<ch:MessageDescription>*Dec 3 12:29:01.017 IST: %CLEAR-5-COUNTERS: Clear counter on all interfaces by console</ch:MessageDescription>
<ch:Event>
<ch:Type>syslog</ch:Type>
<ch:SubType></ch:SubType>
<ch:Brand>Cisco Systems</ch:Brand>
<ch:Series>ASR1000 Series Routers</ch:Series>
</ch:Event>
<ch:CustomerData>
<ch:UserData>
<ch:Email>username@example.com</ch:Email>
</ch:UserData>
<ch:ContractData>
<ch:CustomerId>username@example.com</ch:CustomerId>
<ch:SiteId>example.com</ch:SiteId>
<ch:ContractId>123456789</ch:ContractId>
<ch:DeviceId>ASR1006@C@FOX105101DH</ch:DeviceId>
</ch:ContractData>
<ch:SystemInfo>
<ch:Name>mcp-6ru-3</ch:Name>
<ch:Contact></ch:Contact>
<ch:ContactEmail>username@example.com</ch:ContactEmail>
<ch:ContactPhoneNumber>+12223334444</ch:ContactPhoneNumber>
<ch:StreetAddress>1234 Any Street Any City Any State 12345</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>ASR1006</rme:Model>
<rme:HardwareVersion>2.1</rme:HardwareVersion>
<rme:SerialNumber>FOX105101DH</rme:SerialNumber>
<rme:AdditionalInformation>
<rme:AD name="PartNumber" value="68-2584-05" />
<rme:AD name="SoftwareVersion" value="" />
<rme:AD name="SystemObjectId" value="1.3.6.1.4.1.9.1.925" />
<rme:AD name="SystemDescription" value="Cisco IOS Software, IOS-XE Software (PPC_LINUX_IOSD-ADVENTERPRISEK9-M), Experimental Version 12.2(20091118:075558) [v122_33_xnf_asr_rls6_throttle-mcp_dev_rls6 102]
Copyright (c) 1986-2009 by Cisco Systems, Inc.
Compiled Wed 18-Nov-09 01:14 by " />
</rme:AdditionalInformation>
</rme:Chassis>
</ch:Device>
</ch:CallHome>
</aml-block:Content>
<aml-block:Attachments>
<aml-block:Attachment type="inline">
<aml-block:Name>show logging</aml-block:Name>
<aml-block:Data encoding="plain">
<
Feedback