Cisco IOS Network Management Configuration Guide Release 12.2SR 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 THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public domain version of the UNIX operating system All rights reserved Copyright © 1981, Regents of the University of California NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH ALL FAULTS CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES CCDE, CCENT, CCSI, Cisco Eos, Cisco HealthPresence, Cisco IronPort, the Cisco logo, Cisco Nurse Connect, Cisco Pulse, Cisco SensorBase, Cisco StackPower, Cisco StadiumVision, Cisco TelePresence, Cisco Unified Computing System, Cisco WebEx, DCE, Flip Channels, Flip for Good, Flip Mino, Flipshare (Design), Flip Ultra, Flip Video, Flip Video (Design), Instant Broadband, and Welcome to the Human Network are trademarks; Changing the Way We Work, Live, Play, and Learn, Cisco Capital, Cisco Capital (Design), Cisco:Financed (Stylized), Cisco Store, Flip Gift Card, and One Million Acts of Green are service marks; and Access Registrar, Aironet, AllTouch, AsyncOS, Bringing the Meeting To You, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, CCVP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Lumin, Cisco Nexus, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Collaboration Without Limitation, Continuum, EtherFast, EtherSwitch, Event Center, Explorer, Follow Me Browsing, GainMaker, iLYNX, IOS, iPhone, IronPort, the IronPort logo, Laser Link, LightStream, Linksys, MeetingPlace, MeetingPlace Chime Sound, MGX, Networkers, Networking Academy, PCNow, PIX, PowerKEY, PowerPanels, PowerTV, PowerTV (Design), PowerVu, Prisma, ProConnect, ROSA, SenderBase, SMARTnet, Spectrum Expert, StackWise, WebEx, and the WebEx logo are registered trademarks of Cisco Systems, Inc and/or its affiliates in the United States and certain other countries All other trademarks mentioned in this document or website are the property of their respective owners The use of the word partner does not imply a partnership relationship between Cisco and any other company (0910R) Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental Cisco IOS Network Management Configuration Guide © 2009 Cisco Systems, Inc All rights reserved About Cisco IOS Software Documentation Last Updated: November 20, 2009 This document describes the objectives, audience, conventions, and organization used in Cisco IOS software documentation Also included are resources for obtaining technical assistance, additional documentation, and other information from Cisco This document is organized into the following sections: • Documentation Objectives, page i • Audience, page i • Documentation Conventions, page i • Documentation Organization, page iii • Additional Resources and Documentation Feedback, page xii Documentation Objectives Cisco IOS documentation describes the tasks and commands available to configure and maintain Cisco networking devices Audience The Cisco IOS documentation set is intended for users who configure and maintain Cisco networking devices (such as routers and switches) but who may not be familiar with the configuration and maintenance tasks, the relationship among tasks, or the Cisco IOS commands necessary to perform particular tasks The Cisco IOS documentation set is also intended for those users experienced with Cisco IOS software who need to know about new features, new configuration options, and new software characteristics in the current Cisco IOS release Documentation Conventions In Cisco IOS documentation, the term router may be used to refer to various Cisco products; for example, routers, access servers, and switches These and other networking devices that support Cisco IOS software are shown interchangeably in examples and are used only for illustrative purposes An example that shows one product does not necessarily mean that other products are not supported i About Cisco IOS Software Documentation Documentation Conventions This section contains the following topics: • Typographic Conventions, page ii • Command Syntax Conventions, page ii • Software Conventions, page iii • Reader Alert Conventions, page iii Typographic Conventions Cisco IOS documentation uses the following typographic conventions: Convention Description ^ or Ctrl Both the ^ symbol and Ctrl represent the Control (Ctrl) key on a keyboard For example, the key combination ^D or Ctrl-D means that you hold down the Control key while you press the D key (Keys are indicated in capital letters but are not case sensitive.) string A string is a nonquoted set of characters shown in italics For example, when setting a Simple Network Management Protocol (SNMP) community string to public, not use quotation marks around the string; otherwise, the string will include the quotation marks Command Syntax Conventions Cisco IOS documentation uses the following command syntax conventions: ii Convention Description bold Bold text indicates commands and keywords that you enter as shown italic Italic text indicates arguments for which you supply values [x] Square brackets enclose an optional keyword or argument An ellipsis (three consecutive nonbolded periods without spaces) after a syntax element indicates that the element can be repeated | A vertical line, called a pipe, that is enclosed within braces or square brackets indicates a choice within a set of keywords or arguments [x | y] Square brackets enclosing keywords or arguments separated by a pipe indicate an optional choice {x | y} Braces enclosing keywords or arguments separated by a pipe indicate a required choice [x {y | z}] Braces and a pipe within square brackets indicate a required choice within an optional element About Cisco IOS Software Documentation Documentation Organization Software Conventions Cisco IOS software uses the following program code conventions: Convention Description Courier font Courier font is used for information that is displayed on a PC or terminal screen Bold Courier font Bold Courier font indicates text that the user must enter < > ! [ Angle brackets enclose text that is not displayed, such as a password Angle brackets also are used in contexts in which the italic font style is not supported; for example, ASCII text An exclamation point at the beginning of a line indicates that the text that follows is a comment, not a line of code An exclamation point is also displayed by Cisco IOS software for certain processes ] Square brackets enclose default responses to system prompts Reader Alert Conventions Cisco IOS documentation uses the following conventions for reader alerts: Caution Note Timesaver Means reader be careful In this situation, you might something that could result in equipment damage or loss of data Means reader take note Notes contain helpful suggestions or references to material not covered in the manual Means the described action saves time You can save time by performing the action described in the paragraph Documentation Organization This section describes the Cisco IOS documentation set, how it is organized, and how to access it on Cisco.com It also lists the configuration guides, command references, and supplementary references and resources that comprise the documentation set It contains the following topics: • Cisco IOS Documentation Set, page iv • Cisco IOS Documentation on Cisco.com, page iv • Configuration Guides, Command References, and Supplementary Resources, page v iii About Cisco IOS Software Documentation Documentation Organization Cisco IOS Documentation Set The Cisco IOS documentation set consists of the following: • Release notes and caveats provide information about platform, technology, and feature support for a release and describe severity (catastrophic), severity (severe), and select severity (moderate) defects in released Cisco IOS software Review release notes before other documents to learn whether updates have been made to a feature • Sets of configuration guides and command references organized by technology and published for each standard Cisco IOS release – Configuration guides—Compilations of documents that provide conceptual and task-oriented descriptions of Cisco IOS features – Command references—Compilations of command pages in alphabetical order that provide detailed information about the commands used in the Cisco IOS features and the processes that comprise the related configuration guides For each technology, there is a single command reference that supports all Cisco IOS releases and that is updated at each standard release • Lists of all the commands in a specific release and all commands that are new, modified, removed, or replaced in the release • Command reference book for debug commands Command pages are listed in alphabetical order • Reference book for system messages for all Cisco IOS releases Cisco IOS Documentation on Cisco.com The following sections describe the organization of the Cisco IOS documentation set and how to access various document types Use Cisco Feature Navigator to find information about platform support and Cisco IOS and Catalyst OS software image support To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn An account on Cisco.com is not required New Features List The New Features List for each release provides a list of all features in the release with hyperlinks to the feature guides in which they are documented Feature Guides Cisco IOS features are documented in feature guides Feature guides describe one feature or a group of related features that are supported on many different software releases and platforms Your Cisco IOS software release or platform may not support all the features documented in a feature guide See the Feature Information table at the end of the feature guide for information about which features in that guide are supported in your software release Configuration Guides Configuration guides are provided by technology and release and comprise a set of individual feature guides relevant to the release and technology iv About Cisco IOS Software Documentation Documentation Organization Command References Command reference books contain descriptions of Cisco IOS commands that are supported in many different software releases and on many different platforms The books are organized by technology For information about all Cisco IOS commands, use the Command Lookup Tool at http://tools.cisco.com/Support/CLILookup or the Cisco IOS Master Command List, All Releases, at http://www.cisco.com/en/US/docs/ios/mcl/allreleasemcl/all_book.html Cisco IOS Supplementary Documents and Resources Supplementary documents and resources are listed in Table on page xi Configuration Guides, Command References, and Supplementary Resources Table lists, in alphabetical order, Cisco IOS software configuration guides and command references, including brief descriptions of the contents of the documents The Cisco IOS command references contain commands for Cisco IOS software for all releases The configuration guides and command references support many different software releases and platforms Your Cisco IOS software release or platform may not support all these technologies Table lists documents and resources that supplement the Cisco IOS software configuration guides and command references These supplementary resources include release notes and caveats; master command lists; new, modified, removed, and replaced command lists; system messages; and the debug command reference For additional information about configuring and operating specific networking devices, and to access Cisco IOS documentation, go to the Product/Technologies Support area of Cisco.com at the following location: http://www.cisco.com/go/techdocs Table Cisco IOS Configuration Guides and Command References Configuration Guide and Command Reference Titles • Cisco IOS AppleTalk Configuration Guide • Cisco IOS AppleTalk Command Reference • Cisco IOS Asynchronous Transfer Mode Configuration Guide • Cisco IOS Asynchronous Transfer Mode Command Reference Features/Protocols/Technologies AppleTalk protocol LAN ATM, multiprotocol over ATM (MPoA), and WAN ATM v About Cisco IOS Software Documentation Documentation Organization Table Cisco IOS Configuration Guides and Command References (continued) Configuration Guide and Command Reference Titles • Cisco IOS Bridging and IBM Networking Configuration Guide • Cisco IOS Bridging Command Reference • Cisco IOS IBM Networking Command Reference • Cisco IOS Broadband Access Aggregation and DSL Configuration Guide • Cisco IOS Broadband Access Aggregation and DSL Command Reference • Cisco IOS Carrier Ethernet Configuration Guide • Cisco IOS Carrier Ethernet Command Reference • Cisco IOS Configuration Fundamentals Configuration Guide • Cisco IOS Configuration Fundamentals Command Reference • Cisco IOS DECnet Configuration Guide • Cisco IOS DECnet Command Reference • Cisco IOS Dial Technologies Configuration Guide • Cisco IOS Dial Technologies Command Reference • Cisco IOS Flexible NetFlow Configuration Guide • Cisco IOS Flexible NetFlow Command Reference vi Features/Protocols/Technologies Transparent and source-route transparent (SRT) bridging, source-route bridging (SRB), Token Ring Inter-Switch Link (TRISL), and token ring route switch module (TRRSM) Data-link switching plus (DLSw+), serial tunnel (STUN), block serial tunnel (BSTUN); logical link control, type (LLC2), synchronous data link control (SDLC); IBM Network Media Translation, including Synchronous Data Logical Link Control (SDLLC) and qualified LLC (QLLC); downstream physical unit (DSPU), Systems Network Architecture (SNA) service point, SNA frame relay access, advanced peer-to-peer networking (APPN), native client interface architecture (NCIA) client/server topologies, and IBM Channel Attach PPP over ATM (PPPoA) and PPP over Ethernet (PPPoE) Operations, Administration, and Maintenance (OAM); Ethernet connectivity fault management (CFM); ITU-T Y.1731 fault management functions; Ethernet Local Management Interface (ELMI); MAC address support on service instances, bridge domains, and pseudowire; IEEE 802.3ad Link Bundling; Link Aggregation Control Protocol (LACP) support for Ethernet and Gigabit Ethernet links and EtherChannel bundles; LACP support for stateful switchover (SSO), in service software upgrade (ISSU), Cisco nonstop forwarding (NSF), and nonstop routing (NSR) on Gigabit EtherChannel bundles; and Link Layer Discovery Protocol (LLDP) and media endpoint discovery (MED) Autoinstall, Setup, Cisco IOS command-line interface (CLI), Cisco IOS file system (IFS), Cisco IOS web browser user interface (UI), basic file transfer services, and file management DECnet protocol Asynchronous communications, dial backup, dialer technology, dial-in terminal services and AppleTalk remote access (ARA), dial-on-demand routing, dial-out, ISDN, large scale dial-out, modem and resource pooling, Multilink PPP (MLP), PPP, and virtual private dialup network (VPDN) Flexible NetFlow About Cisco IOS Software Documentation Documentation Organization Table Cisco IOS Configuration Guides and Command References (continued) Configuration Guide and Command Reference Titles Features/Protocols/Technologies • Cisco IOS High Availability Configuration Guide • Cisco IOS High Availability Command Reference • Cisco IOS Integrated Session Border Controller Command Reference A VoIP-enabled device that is deployed at the edge of networks An SBC is a toolkit of functions, such as signaling interworking, network hiding, security, and quality of service (QoS) • Cisco IOS Intelligent Services Gateway Configuration Guide • Cisco IOS Intelligent Services Gateway Command Reference Subscriber identification, service and policy determination, session creation, session policy enforcement, session life-cycle management, accounting for access and service usage, and session state monitoring • Cisco IOS Interface and Hardware Component Configuration Guide LAN interfaces, logical interfaces, serial interfaces, virtual interfaces, and interface configuration • Cisco IOS Interface and Hardware Component Command Reference • Cisco IOS IP Addressing Services Configuration Guide • Cisco IOS IP Addressing Services Command Reference • Cisco IOS IP Application Services Configuration Guide • Cisco IOS IP Application Services Command Reference • Cisco IOS IP Mobility Configuration Guide • Cisco IOS IP Mobility Command Reference • Cisco IOS IP Multicast Configuration Guide • Cisco IOS IP Multicast Command Reference • Cisco IOS IP Routing: BFD Configuration Guide Bidirectional forwarding detection (BFD) • Cisco IOS IP Routing: BGP Configuration Guide • Cisco IOS IP Routing: BGP Command Reference Border Gateway Protocol (BGP), multiprotocol BGP, multiprotocol BGP extensions for IP multicast • Cisco IOS IP Routing: EIGRP Configuration Guide Enhanced Interior Gateway Routing Protocol (EIGRP) • Cisco IOS IP Routing: EIGRP Command Reference • Cisco IOS IP Routing: ISIS Configuration Guide • Cisco IOS IP Routing: ISIS Command Reference A variety of high availability (HA) features and technologies that are available for different network segments (from enterprise access to service provider core) to facilitate creation of end-to-end highly available networks Cisco IOS HA features and technologies can be categorized in three key areas: system-level resiliency, network-level resiliency, and embedded management for resiliency Address Resolution Protocol (ARP), Network Address Translation (NAT), Domain Name System (DNS), Dynamic Host Configuration Protocol (DHCP), and Next Hop Address Resolution Protocol (NHRP) Enhanced Object Tracking (EOT), Gateway Load Balancing Protocol (GLBP), Hot Standby Router Protocol (HSRP), IP Services, Server Load Balancing (SLB), Stream Control Transmission Protocol (SCTP), TCP, Web Cache Communication Protocol (WCCP), User Datagram Protocol (UDP), and Virtual Router Redundancy Protocol (VRRP) Mobile ad hoc networks (MANet) and Cisco mobile networks Protocol Independent Multicast (PIM) sparse mode (PIM-SM), bidirectional PIM (bidir-PIM), Source Specific Multicast (SSM), Multicast Source Discovery Protocol (MSDP), Internet Group Management Protocol (IGMP), and Multicast VPN (MVPN) Intermediate System-to-Intermediate System (IS-IS) vii About Cisco IOS Software Documentation Documentation Organization Table Cisco IOS Configuration Guides and Command References (continued) Configuration Guide and Command Reference Titles Features/Protocols/Technologies • Cisco IOS IP Routing: ODR Configuration Guide • Cisco IOS IP Routing: ODR Command Reference • Cisco IOS IP Routing: OSPF Configuration Guide • Cisco IOS IP Routing: OSPF Command Reference • Cisco IOS IP Routing: Protocol-Independent Configuration Guide • Cisco IOS IP Routing: Protocol-Independent Command Reference • Cisco IOS IP Routing: RIP Configuration Guide • Cisco IOS IP Routing: RIP Command Reference • Cisco IOS IP SLAs Configuration Guide • Cisco IOS IP SLAs Command Reference • Cisco IOS IP Switching Configuration Guide • Cisco IOS IP Switching Command Reference • Cisco IOS IPv6 Configuration Guide • Cisco IOS IPv6 Command Reference For IPv6 features, protocols, and technologies, go to the IPv6 “Start Here” document • Cisco IOS ISO CLNS Configuration Guide ISO Connectionless Network Service (CLNS) • Cisco IOS ISO CLNS Command Reference • Cisco IOS LAN Switching Configuration Guide • Cisco IOS LAN Switching Command Reference • Cisco IOS Mobile Wireless Gateway GPRS Support Node Configuration Guide • Cisco IOS Mobile Wireless Gateway GPRS Support Node Command Reference • Cisco IOS Mobile Wireless Home Agent Configuration Guide • Cisco IOS Mobile Wireless Home Agent Command Reference On-Demand Routing (ODR) Open Shortest Path First (OSPF) IP routing protocol-independent features and commands Generic policy-based routing (PBR) features and commands are included Routing Information Protocol (RIP) Cisco IOS IP Service Level Agreements (IP SLAs) Cisco Express Forwarding, fast switching, and Multicast Distributed Switching (MDS) VLANs, Inter-Switch Link (ISL) encapsulation, IEEE 802.10 encapsulation, IEEE 802.1Q encapsulation, and multilayer switching (MLS) Cisco IOS Gateway GPRS Support Node (GGSN) in a 2.5-generation general packet radio service (GPRS) and 3-generation universal mobile telecommunication system (UMTS) network Cisco Mobile Wireless Home Agent, an anchor point for mobile terminals for which mobile IP or proxy mobile IP services are provided Cisco IOS Mobile Wireless Packet Data Serving Node Cisco Packet Data Serving Node (PDSN), a wireless gateway that is between the mobile infrastructure and standard IP networks and Configuration Guide that enables packet data services in a code division multiple access • Cisco IOS Mobile Wireless Packet Data Serving Node (CDMA) environment Command Reference • • Cisco IOS Mobile Wireless Radio Access Networking Configuration Guide • Cisco IOS Mobile Wireless Radio Access Networking Command Reference viii Cisco IOS radio access network products XML-PI How to Use XML-PI • brief—Configuration without certificate data • full—Full configuration • interface interface-name—Specified interface output only A full interface specification (interface fastethernet0/0, for example) is required If the interface name does not match one that is supported on the network device, an error is returned The following is a sample command: Router# show running-config brief | format Generating XSD Format for Commands The show xsd-format command is used to display the XSD to which the XML output conforms This section describes how to use this command For example of command output, see “Generating show Command XSD Format: Example” section on page 21 SUMMARY STEPS show xsd-format [location:local-filename] cli command DETAILED STEPS Step show xsd-format [location:local-filename] cli command The location and local-filename arguments are the location and filename of the ODM spec file Valid location keywords are bootflash:, flash:, nvram:, and any valid disk or slot number (for example: disk0: or slot1:) ODM spec files have a odm suffix These arguments are not required if you want to use a default ODM file defined with the format global command The first of the following two examples, displays XSD output from a defined default ODM spec file: Router# show xsd-format cli show arp Router# show xsd-format disk2:spec3.3.odm cli show arp Note When the user is entering command names, the full command name must be entered; not use command truncation Troubleshooting ODM Errors This section describes use of the debug format all command to troubleshoot spec file errors SUMMARY STEPS 14 enable debug format all show-command | format [location:local-filename] XML-PI How to Use XML-PI no debug format all DETAILED STEPS Step enable Enter this command to enable the privileged EXEC mode required to run debug commands Step debug format all Enter this command to enable a verbose debugging mode that displays all ODM errors Step show-command | format [location:local-filename] Enter this command to generate XML output for the show interfaces command The following is sample output: Router# show interfaces | format slot0:spec3.3.odm Selected debug data is displayed with comments followed by the full debug output The debug format statements are read in groups of two lines As the following example shows, the first line describes what the attempted match was; the second line provides the offset and the byte count from the beginning of the show interfaces command output that the cursor of the screen scraper is currently at: *May *May 01:20:35.279: ODM: Could not match Property mcast 01:20:35.279: offset 703: minute output rate bits/sec, packets/sec The following example shows where the SFE caused the ODM algorithm to return a truncated XML Notice how the offset jumps from 703 to 3001 This is a large jump that implies a search between multicast and IP multicast probably caused the screen scraper to jump too far into the text Because the cursor is not at a buffer, this condition is the likely candidate for the error Looking at the spec file entry and doing a manual search through the show command output will confirm this suspicion *May 01:20:35.279: offset 703: minute output rate bits/sec, packets/sec 786 pa *May 01:20:35.279: ODM: Could not match Property mcast *May 01:20:35.279: offset 703: minute output rate bits/sec, packets/sec 786 pa *May 01:20:35.279: ODM: Could not match Property IP multicasts *May 01:20:35.279: offset 3001: no buffer Received broadcasts, runts, giants, *May 01:20:35.279: ODM: Could not match Property watchdog *May 01:20:35.279: offset 3122: ignored, abort packets output, bytes, underru *May 01:20:35.279: ODM: Could not match Property input packets with dribble condition detected Step no debug format all Disable the debug command when troubleshooting is complete Managing Files This section provides the following procedures for managing files in XML-PI: • Displaying Files on a Cisco IOS Filesystem: Example, page 16 15 XML-PI How to Use XML-PI • Managing Spec Files, page 16 • Validating Spec Files, page 17 Displaying Files on a Cisco IOS Filesystem: Example The following example shows how to display a list of files: Router# show format slot0:? slot0:spec3.3.odm Note slot0:spec3.ALR.odm slot0:spec3.empty.odm The question mark (?) command can be used following any of the location keywords (bootflash, slot, and so on) in the show format and show xsd-format commands, to list all files Spec files have a odm file extension Managing Spec Files Use the spec-file install privileged EXEC command to manage the spec files The following commands allow you to make backup copies of the built-in spec file before changing the contents of the file, and to restore the contents of a previous spec file You can also copy and remove SFEs from one spec file to another Valid locations for local files are bootflash:, flash:, nvram:, and any valid disk or slot number (example: disk0: or slot1:) Valid URLs for remote files are archive:, bootflash:, cns:, flash:, ftp:, http:, null:, nvram:, pram:, rcp:, scp:, system:, tar:, tftp:, tmpsys: and any valid disk or slot number (for example, disk0: or slot1:) In all cases, the force keyword performs the command without prompting you to verify the file operation by entering a “yes” or “no” response SUMMARY STEPS 16 spec-file install [force] location:local-filename add-entry url:remote-filename command spec-file install [force] location:local-filename built-in spec-file install [force] location:local-filename file url:remote-filename spec-file install [force] location:local-filename remove-entry command spec-file install [force] location:local-filename restore XML-PI How to Use XML-PI DETAILED STEPS Step Command or Action Purpose spec-file install [force] location:local-filename add-entry url:remote-filename command Copies an SFE from a remote location and adds it to a local spec file • A check is performed on the loaded SFE to ensure that the command is not already present in the spec file, and that the SFE can be parsed correctly in XML • If the spec file does not exist, you will be prompted before the file is created • If the command SFE already exists in the spec file, you will be prompted before the command SFE is replaced • A backup copy of the local spec file is created before the remote SFE is added Example: Router# spec-file install slot0:spec_file.odm add-entry tftp://system1/user1/show_arp.odm show arp Step spec-file install [force] location:local-filename built-in Replaces the current spec file with the built-in spec file • You will be prompted before the current file is replaced and filename.bak will be created Example: Router# spec-file install slot0:spec_file.odm built-in Step spec-file install [force] location:local-filename file url:remote-filename Replaces a local spec file with a remote spec file • Example: A check of the loaded file is performed to ensure that each specified command is included only once, and that the SFE can be parsed correctly in XML Router# spec-file install slot0:spec_file.odm file tftp://system1/user1/spec_file.odm Step spec-file install [force] location:local-filename remove-entry command Example: Router# spec-file install slot0:spec_file.odm remove-entry show arp Step spec-file install [force] location:local-filename restore Removes an SFE from a spec file • A check is performed to ensure that the command SFE is present in the spec file • If the spec file does not exist, this command fails • A backup copy of the spec file is created before the SFE is removed Restores a spec file to its original contents using a backup (.bak) file • If the bak file does not exist, this command fails Example: Router# spec-file install slot0:spec_file.odm restore Validating Spec Files This section describes use of the show format command to validate a spec file The show format built-in validate form of the command is used to validate the built-in spec file The show format location:local-filename validate form of the command is used to validate a specific spec file 17 XML-PI Configuration Examples for XML-PI Restrictions Spec files must reside locally on the network device Using spec files from a remote filesystem is not supported SUMMARY STEPS enable show format [built-in | location:local-filename] [cli command | validate] DETAILED STEPS Step Command or Action Purpose enable Enables privileged EXEC mode • Enter your password if prompted Example: Router> enable Step show format [built-in | location:local-filename] [cli command | validate] Validates the built-in spec file Example: Router# show format built-in validate Configuration Examples for XML-PI This section provides the following configuration examples: • Configuring NETCONF for XML-PI: Example, page 18 • Generating show Command XML Format: Examples, page 19 • Generating show running-config XML Format: Examples, page 20 • Generating show Command XSD Format: Example, page 21 • Displaying the SFEs: Example, page 21 • Displaying Spec File Tag Hierarchy: Example, page 22 • Validating a Spec File: Example, page 23 Configuring NETCONF for XML-PI: Example The following example shows how to configure a secure login environment Cisco recommends that you define a default ODM file to be used for all requests using the format global command You can associate that file with NETCONF for all XML-formatted requests using the netconf format command If no file is specified, the built-in spec file is used for all requests See the format global and netconf format command reference pages for more information The netconf ssh configuration command enables NETCONF over SSHv2, which terminates the session layer and provides a secure connection ip domain-name cisco.com crypto key generate rsa ip ssh timeout 60 18 XML-PI Configuration Examples for XML-PI ip ssh authentication-retries ip ssh version line vty login local transport input ssh exit username me privilege 15 password mypassword format global disk2:spec3.3.odm netconf format disk2:spec3.3.odm netconf ssh end Generating show Command XML Format: Examples The following examples show how to generate XML format of standard Cisco IOS show command output Standard show Command Output Following is an example of the Cisco IOS show arp command output: Router# show arp Protocol Internet Internet Internet Address 10.1.1.1 10.3.1.2 10.4.0.5 Age (min) 67 - Hardware Addr 0001.42df.59e2 0002.55c6.19a0 000b.60dc.9408 Type ARPA ARPA ARPA Interface FastEthernet0/0 FastEthernet0/0 FastEthernet0/0 Generating XML Following is an example of generating XML output of the show arp command from a default ODM file: Router# show arp | format Internet 10.1.1.1 67 0001.42df.59e2 ARPA FastEthernet0/0 Internet 10.3.1.2 8 0002.55c6.19a0 ARPA FastEthernet0/0 Internet 10.4.0.5 000b.60dc.9408 ARPA FastEthernet0/0 19 XML-PI Configuration Examples for XML-PI Generating show running-config XML Format: Examples The following examples show the mapping between actual show running-config command output and the XSD format generated by piping the output through the spec3.3.odm spec file (For sake of brevity, output from each command has been truncated.) show running-config Command Router# show running-config Building configuration Current configuration : 1190 bytes ! upgrade fpd auto version 12.4 service timestamps debug datetime msec service timestamps log datetime msec no service password-encryption service internal ! hostname Router1 ! boot-start-marker boot system flash:c7200-js-mz.123-5.9.T boot-end-marker ! logging message-counter syslog enable password secret ! no aaa new-model ip cef ! no ip domain lookup ip domain name cisco.com ip host host1 10.66.152.11 ip host host2 10.2.2.2 multilink bundle-name authenticated Piped Output to Generate XML Router# show running-config | format Building configuration 12.4 Router1 flash:c7200-js-mz.123-5.9.T secret 20 XML-PI Configuration Examples for XML-PI cisco.com host1 10.66.152.11 host2 10.2.2.2 The returned data is the requested configuration converted using the C2X algorithm Generating show Command XSD Format: Example The following example shows how to generate XSD for the show arp command: Router# show xsd-format disk2:spec3.3.odm cli show arp Displaying the SFEs: Example The following example shows how to display the SFE for the show arp command: Router# show format disk2:spec3.3.odm cli show arp show arp 21 XML-PI Configuration Examples for XML-PI ios The following example shows a list of fully expanded command names that have spec files in the default ODM file: Router# show format The following CLI are supported in slot0:spec3.3.odm show arp show cdp neighbors detail show context show flash: show interfaces* show inventory show ip interface brief show ip nat translations show line value show line show processes cpu show processes memory show region show spanning-tree show stacks show vlans Displaying Spec File Tag Hierarchy: Example The show odm-format command displays the spec file structure in a fixed output that you can refer to in order to understand the spec file tag hierarchy The following example shows the fixed output from the show odm-format command Refer to the Programmer’s Guide for Cisco Enhanced Device Interface 2.2 for more information about the ODM tool and tag hierarchy Router# show odm format New Name Space '' Either or allowed Exactly required Exactly required Exactly required Either or allowed At least required Either or allowed Exactly required Exactly required or more is allowed 22 XML-PI Configuration Examples for XML-PI At least required or more is allowed Either or allowed or more is allowed or more is allowed or more is allowed or more is allowed At least required or more is allowed Either or allowed or more is allowed or more is allowed or more is allowed or more is allowed At least required or more is allowed At least required or more is allowed At least required or more is allowed At least required Validating a Spec File: Example The following example shows how to validate a built-in spec file: Router# show format built-in validate The file built-in has been validated 23 XML-PI Additional References Additional References The following sections provide references related to using XML-PI Related Documents Related Topic Document Title Cisco IOS commands Cisco IOS Master Commands List, All Releases Cisco IOS network management commands Cisco IOS Network Management Command Reference NETCONF Network Configuration Protocol ODM tool Programmer’s Guide for Cisco Enhanced Device Interface 2.2 Standards Standard XML-PI based on NETCONF standards Title • User Guide for Cisco Enhanced Device Interface 2.2 • Programmer’s Guide for Cisco Enhanced Device Interface 2.2 MIBs MIB MIBs Link None 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 RFCs RFC Title RFC 4741 NETCONF Configuration Protocol RFC 4742 Using the NETCONF Configuration Protocol over Secure SHell (SSH) 24 XML-PI Additional References Technical Assistance Description Link The Cisco Support website provides extensive online resources, including documentation and tools for troubleshooting and resolving technical issues with Cisco products and technologies http://www.cisco.com/cisco/web/support/index.html 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 25 XML-PI Feature Information for XML-PI Feature Information for XML-PI Table lists the release history for this feature Not all commands may be available in your Cisco IOS software release For release information about a specific command, see the command reference documentation Cisco IOS software images are specific to a Cisco IOS software release, a feature set, and a platform Use Cisco Feature Navigator to find information about platform support and software image support Cisco Feature Navigator enables you to determine which Cisco IOS and Catalyst OS software images support a specific software release, feature set, or platform To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn An account on Cisco.com is not required Note Table Table lists only the Cisco IOS software release that introduced support for a given feature in a given Cisco IOS software release train Unless noted otherwise, subsequent releases of that Cisco IOS software release train also support that feature Feature Information for XML-PI Feature Name Releases Feature Information XML-PI 12.4(20)T 12.2(33)SRE The eXtensible Markup Language Programmatic Interface (XML-PI) Release 1.0 leverages the Network Configuration Protocol (NETCONF) and offers new data models that collect show command output down to the keyword level and running configurations without the complexity and expense of screen-scraping technologies or external XML-to-CLI gateways XML-PI allows you to quickly develop XML-based network management applications The following commands were introduced or modified by this feature: debug format, format global, netconf format, show format, show odm-format, show xsd-format, spec-file install add-entry, spec-file install built-in, spec-file install file, spec-file install remove-entry, and spec-file install restore This feature was integrated into Cisco IOS Release 12.2(33)SRE The following command was introduced or modified by this feature: show format 26 XML-PI Glossary Glossary C2X—CLI to XML CLI—command-line interface An interface that allows the user to interact with the operating system by entering commands and optional arguments E-DI—Enhanced Device Interface NETCONF—Network Configuration Protocol ODM—Operational Data Model RSA—Rivest, Shamir, and Adelman, the inventors of the technique Public-key cryptographic system that can be used for encryption and authentication SSH—Secure Shell X2C—XML to CLI XML—eXtensible Markup Language XSD—XML Schema Definition CCDE, CCENT, CCSI, Cisco Eos, Cisco HealthPresence, Cisco IronPort, the Cisco logo, Cisco Nurse Connect, Cisco Pulse, Cisco SensorBase, Cisco StackPower, Cisco StadiumVision, Cisco TelePresence, Cisco Unified Computing System, Cisco WebEx, DCE, Flip Channels, Flip for Good, Flip Mino, Flipshare (Design), Flip Ultra, Flip Video, Flip Video (Design), Instant Broadband, and Welcome to the Human Network are trademarks; Changing the Way We Work, Live, Play, and Learn, Cisco Capital, Cisco Capital (Design), Cisco:Financed (Stylized), Cisco Store, Flip Gift Card, and One Million Acts of Green are service marks; and Access Registrar, Aironet, AllTouch, AsyncOS, Bringing the Meeting To You, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, CCVP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Lumin, Cisco Nexus, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Collaboration Without Limitation, Continuum, EtherFast, EtherSwitch, Event Center, Explorer, Follow Me Browsing, GainMaker, iLYNX, IOS, iPhone, IronPort, the IronPort logo, Laser Link, LightStream, Linksys, MeetingPlace, MeetingPlace Chime Sound, MGX, Networkers, Networking Academy, PCNow, PIX, PowerKEY, PowerPanels, PowerTV, PowerTV (Design), PowerVu, Prisma, ProConnect, ROSA, SenderBase, SMARTnet, Spectrum Expert, StackWise, WebEx, and the WebEx logo are registered trademarks of Cisco Systems, Inc and/or its affiliates in the United States and certain other countries All other trademarks mentioned in this document or website are the property of their respective owners The use of the word partner does not imply a partnership relationship between Cisco and any other company (0910R) Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses Any examples, command display output, and figures included in the document are shown for illustrative purposes only Any use of actual IP addresses in illustrative content is unintentional and coincidental © 2008–2009 Cisco Systems, Inc All rights reserved 27 XML-PI Glossary 28 ... removed, or replaced in the release • Command reference book for debug commands Command pages are listed in alphabetical order • Reference book for system messages for all Cisco IOS releases Cisco... References Command reference books contain descriptions of Cisco IOS commands that are supported in many different software releases and on many different platforms The books are organized by technology... Without Limitation, Continuum, EtherFast, EtherSwitch, Event Center, Explorer, Follow Me Browsing, GainMaker, iLYNX, IOS, iPhone, IronPort, the IronPort logo, Laser Link, LightStream, Linksys, MeetingPlace,